145 lines
6.4 KiB
HTML
145 lines
6.4 KiB
HTML
|
<!-- manual page source format generated by PolyglotMan v3.0.3a12, -->
|
||
|
|
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
|
||
|
|
|
||
|
|
<HTML>
|
||
|
|
<HEAD>
|
||
|
|
<TITLE>xgettext(1) manual page</TITLE>
|
||
|
|
</HEAD>
|
||
|
|
<BODY>
|
||
|
|
<A HREF="#toc">Table of Contents</A><P>
|
||
|
|
|
||
|
|
<H2><A NAME="sect0" HREF="#toc0">NAME </A></H2>
|
||
|
|
xgettext - extract gettext call strings from C programs
|
||
|
|
<H2><A NAME="sect1" HREF="#toc1">SYNOPSIS
|
||
|
|
</A></H2>
|
||
|
|
<B>xgettext</B> [ <B>-ns</B> ] [ <B>-a</B> [ <B>-x</B><I> exclude-file</I> ] ] [ <B>-c</B><I> comment-tag</I> ] [ <B>-d</B><I> default-domain</I>
|
||
|
|
] [ <B>-j</B> ] [ <B>-m</B><I> prefix</I> ] [ <B>-M</B><I> suffix</I> ] [ <B>-p</B><I> pathname</I> ] <B>-</B>| <I>filename</I> ... <BR>
|
||
|
|
<B>xgettext</B>
|
||
|
|
<B>-h</B>
|
||
|
|
<H2><A NAME="sect2" HREF="#toc2">DESCRIPTION </A></H2>
|
||
|
|
<P>
|
||
|
|
<B>xgettext</B> is used to automate the creation of portable
|
||
|
|
message files (<B>.po</B>). A <B>.po</B> file contains copies of `C' strings that are found
|
||
|
|
in ANSI C source code in <I>filename</I> or the standard input if `<B>-</B>' is specified
|
||
|
|
on the command line. The <B>.po</B> file can be used as input to the <B><A HREF="http://hoth.stsci.edu/man/man1/msgfmt.html">msgfmt</B>(1)</A>
|
||
|
|
|
||
|
|
utility, which produces a binary form of the message file that can be
|
||
|
|
used by application during run-time. <P>
|
||
|
|
<B>xgettext</B> writes <I>msgid</I> strings from
|
||
|
|
<B><A HREF="http://hoth.stsci.edu/man/man3C/gettext.html">gettext</B>(3C)</A>
|
||
|
|
calls in <I>filename</I> to the default output file <B>messages.po</B>. The
|
||
|
|
default output file name can be changed by <B>-d</B> option. <I>msgid</I> strings in
|
||
|
|
<B>dgettext()</B> calls are written to the output file where <I>domainname</I> is the
|
||
|
|
first parameter to the <B>dgettext()</B> call. <P>
|
||
|
|
By default, <B>xgettext</B> creates a
|
||
|
|
<B>.po</B> file in the current working directory, and each entry is in the same
|
||
|
|
order the strings are extracted from <I>filenames</I>. When the <B>-p</B> option is specified,
|
||
|
|
the <B>.po</B> file is created in the <I>pathname</I> directory. An existing <B>.po</B> file
|
||
|
|
is overwritten. <P>
|
||
|
|
Duplicate <I>msgid</I>s are written to the <B>.po</B> file as comment
|
||
|
|
lines. When the <B>-s </B> option is specified, the <B>.po</B> is sorted by the <I>msgid</I>
|
||
|
|
string, and all duplicated <I>msgid</I>s are removed. All <I>msgstr</I> directives in
|
||
|
|
the <B>.po</B> file are empty unless the <B>-m </B> option is used.
|
||
|
|
<H2><A NAME="sect3" HREF="#toc3">OPTIONS </A></H2>
|
||
|
|
|
||
|
|
<DL>
|
||
|
|
|
||
|
|
<DT><B>-n</B> </DT>
|
||
|
|
<DD>Add comment
|
||
|
|
lines to the output file indicating file name and line number in the source
|
||
|
|
file where each extracted string is encountered. These lines appear before
|
||
|
|
each <I>msgid</I> in the following format: <blockquote><B>#</B> <B># File: </B><I>filename</I><B>, line: </DD>
|
||
|
|
</DL>
|
||
|
|
</B><I>line-number</I>
|
||
|
|
</blockquote>
|
||
|
|
|
||
|
|
<DL>
|
||
|
|
|
||
|
|
<DT><B>-s</B> </DT>
|
||
|
|
<DD>Generate output sorted by <I>msgid</I>s with all duplicate <I>msgid</I>s removed.
|
||
|
|
</DD>
|
||
|
|
|
||
|
|
<DT><B>-a</B> </DT>
|
||
|
|
<DD>Extract all strings, not just those found in <B><A HREF="http://hoth.stsci.edu/man/man3C/gettext.html">gettext</B>(3C)</A>
|
||
|
|
, and <B>dgettext
|
||
|
|
()</B> calls. Only one <B>.po</B> file is created. </DD>
|
||
|
|
|
||
|
|
<DT><B>-c</B><I> comment-tag</I> </DT>
|
||
|
|
<DD>The comment block
|
||
|
|
beginning with <I>comment-tag</I> as the first token of the comment block is
|
||
|
|
added to the output <B>.po</B> file as <I>#</I> delimited comments. For multiple domains,
|
||
|
|
<B>xgettext</B> directs comments and messages to the prevailing text domain. </DD>
|
||
|
|
|
||
|
|
<DT><B>-d</B><I>
|
||
|
|
default-domain</I> </DT>
|
||
|
|
<DD>Rename default output file from <B>messages.po</B> to <I>default-domain</I>
|
||
|
|
<B>.po</B>. </DD>
|
||
|
|
|
||
|
|
<DT><B>-j</B> </DT>
|
||
|
|
<DD>Join messages with existing message files. If a <B>.po</B> file does not
|
||
|
|
exist, it is created. If a <B>.po</B> file does exist, new messages are appended.
|
||
|
|
Any duplicate <B>msgid</B>s are commented out in the resulting <B>.po</B> file. Domain
|
||
|
|
directives in the existing <B>.po</B> file are ignored. Results not guaranteed
|
||
|
|
if the existing message file has been edited. </DD>
|
||
|
|
|
||
|
|
<DT><B>-m</B><I> prefix</I> </DT>
|
||
|
|
<DD>Fill in the <I>msgstr</I>
|
||
|
|
with <I>prefix</I>. This is useful for debugging purposes. To make <I>msgstr</I> identical
|
||
|
|
to <I>msgid</I>, use an empty string (<B>"" </B>) for <I>prefix</I>. </DD>
|
||
|
|
|
||
|
|
<DT><B>-M</B><I> suffix</I> </DT>
|
||
|
|
<DD>Fill in the
|
||
|
|
<I>msgstr</I> with <I>suffix</I>. This is useful for debugging purposes. </DD>
|
||
|
|
|
||
|
|
<DT><B>-p</B><I> pathname</I>
|
||
|
|
</DT>
|
||
|
|
<DD>Specify the directory where the output files will be placed. This option
|
||
|
|
overrides the current working directory. <BR>
|
||
|
|
</DD>
|
||
|
|
|
||
|
|
<DT><B>-x</B><I> exclude-file</I> </DT>
|
||
|
|
<DD>Specify a <B>.po</B>
|
||
|
|
file that contains a list of <I>msgid</I>s that are not to be extracted from
|
||
|
|
the input files. The format of <I>exclude-file</I> is identical to the <B>.po</B> file.
|
||
|
|
However, only the <I>msgid</I> directive line in <I>exclude-file</I> is used. All other
|
||
|
|
lines are simply ignored. The <B>-x</B> option can only be used with the <B>-a</B> option.
|
||
|
|
</DD>
|
||
|
|
|
||
|
|
<DT><B>-h</B> </DT>
|
||
|
|
<DD>Print a help message on the standard output. </DD>
|
||
|
|
</DL>
|
||
|
|
|
||
|
|
<H2><A NAME="sect4" HREF="#toc4">ATTRIBUTES </A></H2>
|
||
|
|
See <B><A HREF="http://hoth.stsci.edu/man/man5/attributes.html">attributes</B>(5)</A>
|
||
|
|
|
||
|
|
for descriptions of the following attributes: <P>
|
||
|
|
<TABLE BORDER=0>
|
||
|
|
<TR> <TD ALIGN=CENTER><B>ATTRIBUTE TYPE</B> </TD> <TD ALIGN=CENTER><B>ATTRIBUTE
|
||
|
|
VALUE</B> </TD> </TR>
|
||
|
|
<TR> <TR> <TD ALIGN=LEFT>Availability </TD> <TD ALIGN=LEFT>SUNWloc </TD> </TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<H2><A NAME="sect5" HREF="#toc5">SEE ALSO </A></H2>
|
||
|
|
<B><A HREF="http://hoth.stsci.edu/man/man1/msgfmt.html">msgfmt</B>(1)</A>
|
||
|
|
, <B><A HREF="http://hoth.stsci.edu/man/man3C/gettext.html">gettext</B>(3C)</A>
|
||
|
|
, <B><A HREF="http://hoth.stsci.edu/man/man5/attributes.html">attributes</B>(5)</A>
|
||
|
|
|
||
|
|
|
||
|
|
<H2><A NAME="sect6" HREF="#toc6">NOTES </A></H2>
|
||
|
|
<B>xgettext</B> is not able to extract cast strings, for example ANSI
|
||
|
|
C casts of literal strings to <B>(const char *)</B>. This is unnecessary anyway,
|
||
|
|
since the prototypes in <B><libintl.h></B> already specify this type. <P>
|
||
|
|
|
||
|
|
<HR><P>
|
||
|
|
<A NAME="toc"><B>Table of Contents</B></A><P>
|
||
|
|
<UL>
|
||
|
|
<LI><A NAME="toc0" HREF="#sect0">NAME</A></LI>
|
||
|
|
<LI><A NAME="toc1" HREF="#sect1">SYNOPSIS</A></LI>
|
||
|
|
<LI><A NAME="toc2" HREF="#sect2">DESCRIPTION</A></LI>
|
||
|
|
<LI><A NAME="toc3" HREF="#sect3">OPTIONS</A></LI>
|
||
|
|
<LI><A NAME="toc4" HREF="#sect4">ATTRIBUTES</A></LI>
|
||
|
|
<LI><A NAME="toc5" HREF="#sect5">SEE ALSO</A></LI>
|
||
|
|
<LI><A NAME="toc6" HREF="#sect6">NOTES</A></LI>
|
||
|
|
</UL>
|
||
|
|
</BODY></HTML>
|