summaryrefslogtreecommitdiffstats
path: root/doc/gettext_4.html
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2002-03-12 20:30:44 +0000
committerBruno Haible <bruno@clisp.org>2009-06-23 12:07:49 +0200
commitdbfb2155e1d62ac1d59f1a49f95c111181fe9f2c (patch)
treec7380d4d6feebeb04212695cf60719a49aa77ddb /doc/gettext_4.html
parentc4caaffb18481d0bb0dafbb44d0f16cdefc7a88b (diff)
downloadexternal_gettext-dbfb2155e1d62ac1d59f1a49f95c111181fe9f2c.zip
external_gettext-dbfb2155e1d62ac1d59f1a49f95c111181fe9f2c.tar.gz
external_gettext-dbfb2155e1d62ac1d59f1a49f95c111181fe9f2c.tar.bz2
Regenerated.
Diffstat (limited to 'doc/gettext_4.html')
-rw-r--r--doc/gettext_4.html75
1 files changed, 70 insertions, 5 deletions
diff --git a/doc/gettext_4.html b/doc/gettext_4.html
index bc39311..2b7f289 100644
--- a/doc/gettext_4.html
+++ b/doc/gettext_4.html
@@ -1,17 +1,20 @@
<HTML>
<HEAD>
<!-- This HTML file has been created by texi2html 1.52a
- from gettext.texi on 31 January 2002 -->
+ from gettext.texi on 7 March 2002 -->
<TITLE>GNU gettext utilities - 4 Making the PO Template File</TITLE>
</HEAD>
<BODY>
-Go to the <A HREF="gettext_1.html">first</A>, <A HREF="gettext_3.html">previous</A>, <A HREF="gettext_5.html">next</A>, <A HREF="gettext_16.html">last</A> section, <A HREF="gettext_toc.html">table of contents</A>.
+Go to the <A HREF="gettext_1.html">first</A>, <A HREF="gettext_3.html">previous</A>, <A HREF="gettext_5.html">next</A>, <A HREF="gettext_22.html">last</A> section, <A HREF="gettext_toc.html">table of contents</A>.
<P><HR><P>
<H1><A NAME="SEC19" HREF="gettext_toc.html#TOC19">4 Making the PO Template File</A></H1>
+<P>
+<A NAME="IDX138"></A>
+</P>
<P>
After preparing the sources, the programmer creates a PO template file.
This section explains how to use <CODE>xgettext</CODE> for this purpose.
@@ -22,6 +25,9 @@ This section explains how to use <CODE>xgettext</CODE> for this purpose.
<H2><A NAME="SEC20" HREF="gettext_toc.html#TOC20">4.1 Invoking the <CODE>xgettext</CODE> Program</A></H2>
+<P>
+<A NAME="IDX139"></A>
+<A NAME="IDX140"></A>
<PRE>
xgettext [<VAR>option</VAR>] [<VAR>inputfile</VAR>] ...
@@ -46,6 +52,8 @@ Input files.
<DD>
<DT><SAMP>`--files-from=<VAR>file</VAR>&acute;</SAMP>
<DD>
+<A NAME="IDX141"></A>
+<A NAME="IDX142"></A>
Read the names of the input files from <VAR>file</VAR> instead of getting
them from the command line.
@@ -53,6 +61,8 @@ them from the command line.
<DD>
<DT><SAMP>`--directory=<VAR>directory</VAR>&acute;</SAMP>
<DD>
+<A NAME="IDX143"></A>
+<A NAME="IDX144"></A>
Add <VAR>directory</VAR> to the list of directories. Source files are
searched relative to this list of directories. The resulting <TT>`.po&acute;</TT>
file will be written relative to the current directory, though.
@@ -73,12 +83,16 @@ If <VAR>inputfile</VAR> is <SAMP>`-&acute;</SAMP>, standard input is read.
<DD>
<DT><SAMP>`--default-domain=<VAR>name</VAR>&acute;</SAMP>
<DD>
+<A NAME="IDX145"></A>
+<A NAME="IDX146"></A>
Use <TT>`<VAR>name</VAR>.po&acute;</TT> for output (instead of <TT>`messages.po&acute;</TT>).
<DT><SAMP>`-o <VAR>file</VAR>&acute;</SAMP>
<DD>
<DT><SAMP>`--output=<VAR>file</VAR>&acute;</SAMP>
<DD>
+<A NAME="IDX147"></A>
+<A NAME="IDX148"></A>
Write output to specified file (instead of <TT>`<VAR>name</VAR>.po&acute;</TT> or
<TT>`messages.po&acute;</TT>).
@@ -86,11 +100,14 @@ Write output to specified file (instead of <TT>`<VAR>name</VAR>.po&acute;</TT> o
<DD>
<DT><SAMP>`--output-dir=<VAR>dir</VAR>&acute;</SAMP>
<DD>
+<A NAME="IDX149"></A>
+<A NAME="IDX150"></A>
Output files will be placed in directory <VAR>dir</VAR>.
</DL>
<P>
+<A NAME="IDX151"></A>
If the output <VAR>file</VAR> is <SAMP>`-&acute;</SAMP> or <SAMP>`/dev/stdout&acute;</SAMP>, the output
is written to standard output.
@@ -105,14 +122,20 @@ is written to standard output.
<DD>
<DT><SAMP>`--language=<VAR>name</VAR>&acute;</SAMP>
<DD>
+<A NAME="IDX152"></A>
+<A NAME="IDX153"></A>
+<A NAME="IDX154"></A>
Specifies the language of the input files. The supported languages
-are <CODE>C</CODE>, <CODE>C++</CODE>, <CODE>ObjectiveC</CODE>, <CODE>PO</CODE>, <CODE>Java</CODE>,
-<CODE>YCP</CODE>.
+are <CODE>C</CODE>, <CODE>C++</CODE>, <CODE>ObjectiveC</CODE>, <CODE>PO</CODE>, <CODE>Python</CODE>,
+<CODE>Lisp</CODE>, <CODE>EmacsLisp</CODE>, <CODE>librep</CODE>, <CODE>Java</CODE>, <CODE>awk</CODE>,
+<CODE>YCP</CODE>, <CODE>Tcl</CODE>, <CODE>RST</CODE>, <CODE>Glade</CODE>.
<DT><SAMP>`-C&acute;</SAMP>
<DD>
<DT><SAMP>`--c++&acute;</SAMP>
<DD>
+<A NAME="IDX155"></A>
+<A NAME="IDX156"></A>
This is a shorthand for <CODE>--language=C++</CODE>.
</DL>
@@ -132,12 +155,16 @@ extension.
<DD>
<DT><SAMP>`--join-existing&acute;</SAMP>
<DD>
+<A NAME="IDX157"></A>
+<A NAME="IDX158"></A>
Join messages with existing file.
<DT><SAMP>`-x <VAR>file</VAR>&acute;</SAMP>
<DD>
<DT><SAMP>`--exclude-file=<VAR>file</VAR>&acute;</SAMP>
<DD>
+<A NAME="IDX159"></A>
+<A NAME="IDX160"></A>
Entries from <VAR>file</VAR> are not extracted. <VAR>file</VAR> should be a PO or
POT file.
@@ -145,6 +172,8 @@ POT file.
<DD>
<DT><SAMP>`--add-comments[=<VAR>tag</VAR>]&acute;</SAMP>
<DD>
+<A NAME="IDX161"></A>
+<A NAME="IDX162"></A>
Place comment block with <VAR>tag</VAR> (or those preceding keyword lines)
in output file.
@@ -160,15 +189,20 @@ in output file.
<DD>
<DT><SAMP>`--extract-all&acute;</SAMP>
<DD>
+<A NAME="IDX163"></A>
+<A NAME="IDX164"></A>
Extract all strings.
<DT><SAMP>`-k <VAR>keywordspec</VAR>&acute;</SAMP>
<DD>
<DT><SAMP>`--keyword[=<VAR>keywordspec</VAR>]&acute;</SAMP>
<DD>
+<A NAME="IDX165"></A>
+<A NAME="IDX166"></A>
Additional keyword to be looked for (without <VAR>keywordspec</VAR> means not to
use default keywords).
+<A NAME="IDX167"></A>
If <VAR>keywordspec</VAR> is a C identifer <VAR>id</VAR>, <CODE>xgettext</CODE> looks
for strings in the first argument of each call to the function or macro
<VAR>id</VAR>. If <VAR>keywordspec</VAR> is of the form
@@ -188,10 +222,15 @@ explicitly disabled, are <CODE>gettext</CODE>, <CODE>dgettext:2</CODE>,
<DD>
<DT><SAMP>`--trigraphs&acute;</SAMP>
<DD>
+<A NAME="IDX168"></A>
+<A NAME="IDX169"></A>
+<A NAME="IDX170"></A>
Understand ANSI C trigraphs for input.
<DT><SAMP>`--debug&acute;</SAMP>
<DD>
+<A NAME="IDX171"></A>
+<A NAME="IDX172"></A>
Use the flags <KBD>c-format</KBD> and <KBD>possible-c-format</KBD> to show who was
responsible for marking a message as a format string. The latter form is
used if the <CODE>xgettext</CODE> program decided, the format form is used if
@@ -216,26 +255,33 @@ adjacent strings, and escaped end of lines for continued strings.
<DT><SAMP>`--force-po&acute;</SAMP>
<DD>
+<A NAME="IDX173"></A>
Always write an output file even if no message is defined.
<DT><SAMP>`-i&acute;</SAMP>
<DD>
<DT><SAMP>`--indent&acute;</SAMP>
<DD>
+<A NAME="IDX174"></A>
+<A NAME="IDX175"></A>
Write the .po file using indented style.
<DT><SAMP>`--no-location&acute;</SAMP>
<DD>
+<A NAME="IDX176"></A>
Do not write <SAMP>`#: <VAR>filename</VAR>:<VAR>line</VAR>&acute;</SAMP> lines.
<DT><SAMP>`-n&acute;</SAMP>
<DD>
<DT><SAMP>`--add-location&acute;</SAMP>
<DD>
+<A NAME="IDX177"></A>
+<A NAME="IDX178"></A>
Generate <SAMP>`#: <VAR>filename</VAR>:<VAR>line</VAR>&acute;</SAMP> lines (default).
<DT><SAMP>`--strict&acute;</SAMP>
<DD>
+<A NAME="IDX179"></A>
Write out a strict Uniforum conforming PO file. Note that this
Uniforum format should be avoided because it doesn't support the
GNU extensions.
@@ -244,6 +290,8 @@ GNU extensions.
<DD>
<DT><SAMP>`--width=<VAR>number</VAR>&acute;</SAMP>
<DD>
+<A NAME="IDX180"></A>
+<A NAME="IDX181"></A>
Set the output page width. Long strings in the output files will be
split across multiple lines in order to ensure that each line's width
(= number of screen columns) is less or equal to the given <VAR>number</VAR>.
@@ -252,6 +300,9 @@ split across multiple lines in order to ensure that each line's width
<DD>
<DT><SAMP>`--sort-output&acute;</SAMP>
<DD>
+<A NAME="IDX182"></A>
+<A NAME="IDX183"></A>
+<A NAME="IDX184"></A>
Generate sorted output. Note that using this option makes it much harder
for the translator to understand each message's context.
@@ -259,12 +310,16 @@ for the translator to understand each message's context.
<DD>
<DT><SAMP>`--sort-by-file&acute;</SAMP>
<DD>
+<A NAME="IDX185"></A>
+<A NAME="IDX186"></A>
Sort output by file location.
<DT><SAMP>`--omit-header&acute;</SAMP>
<DD>
+<A NAME="IDX187"></A>
Don't write header with <SAMP>`msgid ""&acute;</SAMP> entry.
+<A NAME="IDX188"></A>
This is useful for testing purposes because it eliminates a source
of variance for generated <CODE>.gmo</CODE> files. With <CODE>--omit-header</CODE>,
two invocations of <CODE>xgettext</CODE> on the same files with the same
@@ -272,6 +327,7 @@ options at different times are guaranteed to produce the same results.
<DT><SAMP>`--copyright-holder=<VAR>string</VAR>&acute;</SAMP>
<DD>
+<A NAME="IDX189"></A>
Set the copyright holder in the output. <VAR>string</VAR> should be the
copyright holder of the surrounding package. (Note that the msgstr
strings, extracted from the package's sources, belong to the copyright
@@ -287,6 +343,7 @@ simply because <CODE>xgettext</CODE> was first used in the GNU project.
<DT><SAMP>`--foreign-user&acute;</SAMP>
<DD>
+<A NAME="IDX190"></A>
Omit FSF copyright in output. This option is equivalent to
<SAMP>`--copyright-holder="&acute;</SAMP>. It can be useful for packages outside the GNU
project that want their translations to be in the public domain.
@@ -295,12 +352,16 @@ project that want their translations to be in the public domain.
<DD>
<DT><SAMP>`--msgstr-prefix[=<VAR>string</VAR>]&acute;</SAMP>
<DD>
+<A NAME="IDX191"></A>
+<A NAME="IDX192"></A>
Use <VAR>string</VAR> (or "" if not specified) as prefix for msgstr entries.
<DT><SAMP>`-M [<VAR>string</VAR>]&acute;</SAMP>
<DD>
<DT><SAMP>`--msgstr-suffix[=<VAR>string</VAR>]&acute;</SAMP>
<DD>
+<A NAME="IDX193"></A>
+<A NAME="IDX194"></A>
Use <VAR>string</VAR> (or "" if not specified) as suffix for msgstr entries.
</DL>
@@ -315,17 +376,21 @@ Use <VAR>string</VAR> (or "" if not specified) as suffix for msgstr entries.
<DD>
<DT><SAMP>`--help&acute;</SAMP>
<DD>
+<A NAME="IDX195"></A>
+<A NAME="IDX196"></A>
Display this help and exit.
<DT><SAMP>`-V&acute;</SAMP>
<DD>
<DT><SAMP>`--version&acute;</SAMP>
<DD>
+<A NAME="IDX197"></A>
+<A NAME="IDX198"></A>
Output version information and exit.
</DL>
<P><HR><P>
-Go to the <A HREF="gettext_1.html">first</A>, <A HREF="gettext_3.html">previous</A>, <A HREF="gettext_5.html">next</A>, <A HREF="gettext_16.html">last</A> section, <A HREF="gettext_toc.html">table of contents</A>.
+Go to the <A HREF="gettext_1.html">first</A>, <A HREF="gettext_3.html">previous</A>, <A HREF="gettext_5.html">next</A>, <A HREF="gettext_22.html">last</A> section, <A HREF="gettext_toc.html">table of contents</A>.
</BODY>
</HTML>