Go to main content

man pages section 1: User Commands

Exit Print View

Updated: July 2017

xgettext (1g)


xgettext - extract gettext strings from source


xgettext [OPTION] [INPUTFILE]...


XGETTEXT(1)                           GNU                          XGETTEXT(1)

       xgettext - extract gettext strings from source

       xgettext [OPTION] [INPUTFILE]...

       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

       -f, --files-from=FILE
              get list of input files from FILE

       -D, --directory=DIRECTORY
              add DIRECTORY to list for input files search

       If input file is -, standard input is read.

   Output file location:
       -d, --default-domain=NAME
              use NAME.po for output (instead of messages.po)

       -o, --output=FILE
              write output to specified file

       -p, --output-dir=DIR
              output files will be placed in directory DIR

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

   Choice of input file language:
       -L, --language=NAME
              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)

       -C, --c++
              shorthand for --language=C++

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

   Input file interpretation:
              encoding of input files (except for Python, Tcl, Glade)

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

   Operation mode:
       -j, --join-existing
              join messages with existing file

       -x, --exclude-file=FILE.po
              entries from FILE.po are not extracted

       -c, --add-comments[=TAG]
              place comment block with TAG (or those preceding keyword  lines)
              in output file

   Language specific options:
       -a, --extract-all
              extract  all  strings (only languages C, C++, ObjectiveC, Shell,
              Python, Lisp, EmacsLisp, librep, Scheme,  Java,  C#,  awk,  Tcl,
              Perl, PHP, GCC-source, Glade)

       -k, --keyword[=WORD]
              additional  keyword  to be looked for (without WORD means not to
              use default keywords)

              (only languages C, C++, ObjectiveC, Shell, Python,  Lisp,  Emac-
              sLisp,  librep,  Scheme,  Java,  C#,  awk,  Tcl, Perl, PHP, GCC-
              source, Glade)

              additional flag for strings inside the argument  number  ARG  of
              keyword WORD

              (only  languages  C, C++, ObjectiveC, Shell, Python, Lisp, Emac-
              sLisp, librep, Scheme, Java, C#, awk, YCP, Tcl, Perl, PHP,  GCC-

       -T, --trigraphs
              understand  ANSI  C  trigraphs for input (only languages C, C++,

       --qt   recognize Qt format strings (only language C++)

              recognize Boost format strings (only language C++)

              more detailed formatstring recognition result

   Output details:
       -e, --no-escape
              do not use C escapes in output (default)

       -E, --escape
              use C escapes in output, no extended chars

              write PO file even if empty

       -i, --indent
              write the .po file using indented style

              do not write '#: filename:line' lines

       -n, --add-location
              generate '#: filename:line' lines (default)

              write out strict Uniforum conforming .po file

              write out a Java .properties file

              write out a NeXTstep/GNUstep .strings file

       -w, --width=NUMBER
              set output page width

              do not break long message lines, longer  than  the  output  page
              width, into several lines

       -s, --sort-output
              generate sorted output

       -F, --sort-by-file
              sort output by file location

              don't write header with `msgid ""' entry

              set copyright holder in output

              omit FSF copyright in output for foreign user

              set report address for msgid bugs

       -m, --msgstr-prefix[=STRING]
              use STRING or "" as prefix for msgstr entries

       -M, --msgstr-suffix[=STRING]
              use STRING or "" as suffix for msgstr entries

   Informative output:
       -h, --help
              display this help and exit

       -V, --version
              output version information and exit

       Written by Ulrich Drepper.

       Report bugs to <bug-gnu-gettext@gnu.org>.

       Copyright (C) 1995-1998, 2000-2006 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

       See attributes(5) for descriptions of the following attributes:

       |Availability   | text/gnu-gettext |
       |Stability      | Uncommitted      |
       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.

       This     software     was    built    from    source    available    at
       https://java.net/projects/solaris-userland.   The  original   community
       source  was  downloaded  from   http://ftp.gnu.org/pub/gnu/gettext/get-

       Further information about this software can be found on the open source
       community website at http://www.gnu.org/software/gettext/.

GNU gettext-tools 0.16.1         November 2006                     XGETTEXT(1)