NAME

xgettext - extract gettext strings from source

SYNOPSIS

xgettext [_O_P_T_I_O_N] [_I_N_P_U_T_F_I_L_E]...

DESCRIPTION

Extract translatable strings from given input files.

Mandatory arguments to long options are mandatory for short options too. Similarly for optional arguments.

Input file location:

INPUTFILE ...
input files
--ff, ----ffiilleess--ffrroomm=_F_I_L_E
get list of input files from FILE
--DD, ----ddiirreeccttoorryy=_D_I_R_E_C_T_O_R_Y
add DIRECTORY to list for input files search

If input file is -, standard input is read.

Output file location:

--dd, ----ddeeffaauulltt--ddoommaaiinn=_N_A_M_E
use NAME.po for output (instead of messages.po)
--oo, ----oouuttppuutt=_F_I_L_E
write output to specified file
--pp, ----oouuttppuutt--ddiirr=_D_I_R
output files will be placed in directory DIR

If output file is -, output is written to standard output.

Choice of input file language:

--LL, ----llaanngguuaaggee=_N_A_M_E
recognise the specified language (C, C++, ObjectiveC, PO, Shell, Python, Lisp, EmacsLisp, librep, Scheme, Smalltalk, Java, JavaProperties, C#, awk, YCP, Tcl, Perl, PHP, GCC-source, NXStringTable, RST, Glade)
--CC, ----cc++
shorthand for ----llaanngguuaaggee=_C++

By default the language is guessed depending on the input file name extension.

Input file interpretation:

----ffrroomm--ccooddee=_N_A_M_E
encoding of input files (except for Python, Tcl, Glade)

By default the input files are assumed to be in ASCII.

Operation mode:

--jj, ----jjooiinn--eexxiissttiinngg
join messages with existing file
--xx, ----eexxcclluuddee--ffiillee=_F_I_L_E.po
entries from FILE.po are not extracted
--cc, ----aadddd--ccoommmmeennttss[=_T_A_G]
place comment block with TAG (or those preceding keyword lines) in output file

Language specific options:

--aa, ----eexxttrraacctt--aallll
extract all strings (only languages C, C++, ObjectiveC, Shell, Python, Lisp, EmacsLisp, librep, Scheme, Java, C#, awk, Tcl, Perl, PHP, GCC-source, Glade)
--kk, ----kkeeyywwoorrdd[=_W_O_R_D]
additional keyword to be looked for (without WORD means not to use default keywords)
(only languages C, C++, ObjectiveC, Shell,
Python, Lisp, EmacsLisp, librep, Scheme, Java, C#, awk, Tcl, Perl, PHP, GCC-source, Glade)
----ffllaagg=_W_O_R_D:ARG:FLAG
additional flag for strings inside the argument number ARG of keyword WORD
(only languages C, C++, ObjectiveC, Shell,
Python, Lisp, EmacsLisp, librep, Scheme, Java, C#, awk, YCP, Tcl, Perl, PHP, GCC-source)
--TT, ----ttrriiggrraapphhss
understand ANSI C trigraphs for input (only languages C, C++, ObjectiveC)
----qqtt
recognize Qt format strings (only language C++)
----ddeebbuugg
more detailed formatstring recognition result

Output details:

--ee, ----nnoo--eessccaappee
do not use C escapes in output (default)
--EE, ----eessccaappee
use C escapes in output, no extended chars
----ffoorrccee--ppoo
write PO file even if empty
--ii, ----iinnddeenntt
write the .po file using indented style
----nnoo--llooccaattiioonn
do not write '#: filename:line' lines
--nn, ----aadddd--llooccaattiioonn
generate '#: filename:line' lines (default)
----ssttrriicctt
write out strict Uniforum conforming .po file
----pprrooppeerrttiieess--oouuttppuutt
write out a Java .properties file
----ssttrriinnggttaabbllee--oouuttppuutt
write out a NeXTstep/GNUstep .strings file
--ww, ----wwiiddtthh=_N_U_M_B_E_R
set output page width
----nnoo--wwrraapp
do not break long message lines, longer than the output page width, into several lines
--ss, ----ssoorrtt--oouuttppuutt
generate sorted output
--FF, ----ssoorrtt--bbyy--ffiillee
sort output by file location
----oommiitt--hheeaaddeerr
don't write header with `msgid ""' entry
----ccooppyyrriigghhtt--hhoollddeerr=_S_T_R_I_N_G
set copyright holder in output
----ffoorreeiiggnn--uusseerr
omit FSF copyright in output for foreign user
----mmssggiidd--bbuuggss--aaddddrreessss=_E_M_A_I_L@ADDRESS
set report address for msgid bugs
--mm, ----mmssggssttrr--pprreeffiixx[=_S_T_R_I_N_G]
use STRING or "" as prefix for msgstr entries
--MM, ----mmssggssttrr--ssuuffffiixx[=_S_T_R_I_N_G]
use STRING or "" as suffix for msgstr entries

Informative output:

--hh, ----hheellpp
display this help and exit
--VV, ----vveerrssiioonn
output version information and exit

AUTHOR

Written by Ulrich Drepper.

REPORTING BUGS

Report bugs to . Copyright © 1995-1998, 2000-2005 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

SEE ALSO

The full documentation for xgettext is maintained as a Texinfo manual. If the info and xgettext programs are properly installed at your site, the command
info xgettext

should give you access to the complete manual.