jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: XGETTEXT jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68:

XGETTEXT

jpayne@68: jpayne@68: NAME
jpayne@68: SYNOPSIS
jpayne@68: DESCRIPTION
jpayne@68: AUTHOR
jpayne@68: REPORTING BUGS
jpayne@68: COPYRIGHT
jpayne@68: SEE ALSO
jpayne@68: jpayne@68:
jpayne@68: jpayne@68: jpayne@68:

NAME jpayne@68: jpayne@68:

jpayne@68: jpayne@68: jpayne@68:

xgettext jpayne@68: - extract gettext strings from source

jpayne@68: jpayne@68:

SYNOPSIS jpayne@68: jpayne@68:

jpayne@68: jpayne@68: jpayne@68: jpayne@68:

xgettext jpayne@68: [OPTION] [INPUTFILE]...

jpayne@68: jpayne@68:

DESCRIPTION jpayne@68: jpayne@68:

jpayne@68: jpayne@68: jpayne@68:

Extract jpayne@68: translatable strings from given input files.

jpayne@68: jpayne@68:

Mandatory jpayne@68: arguments to long options are mandatory for short options jpayne@68: too. Similarly for optional arguments.

jpayne@68: jpayne@68:

Input file jpayne@68: location:
jpayne@68: INPUTFILE ...

jpayne@68: jpayne@68:

input files

jpayne@68: jpayne@68:

-f, jpayne@68: --files-from=FILE

jpayne@68: jpayne@68:

get list of input files from jpayne@68: FILE

jpayne@68: jpayne@68:

-D, jpayne@68: --directory=DIRECTORY

jpayne@68: jpayne@68:

add DIRECTORY to list for input jpayne@68: files search

jpayne@68: jpayne@68:

If input file jpayne@68: is -, standard input is read.

jpayne@68: jpayne@68:

Output file jpayne@68: location:
jpayne@68: -d
, jpayne@68: --default-domain=NAME

jpayne@68: jpayne@68:

use NAME.po for output (instead jpayne@68: of messages.po)

jpayne@68: jpayne@68:

-o, jpayne@68: --output=FILE

jpayne@68: jpayne@68:

write output to specified jpayne@68: file

jpayne@68: jpayne@68:

-p, jpayne@68: --output-dir=DIR

jpayne@68: jpayne@68:

output files will be placed in jpayne@68: directory DIR

jpayne@68: jpayne@68:

If output file jpayne@68: is -, output is written to standard output.

jpayne@68: jpayne@68:

Choice of jpayne@68: input file language:
jpayne@68: -L
, --language=NAME

jpayne@68: jpayne@68:

recognise the specified jpayne@68: language (C, C++, ObjectiveC, PO, Shell, Python, Lisp, jpayne@68: EmacsLisp, librep, Scheme, Smalltalk, Java, JavaProperties, jpayne@68: C#, awk, YCP, Tcl, Perl, PHP, Ruby, GCC-source, jpayne@68: NXStringTable, RST, RSJ, Glade, Lua, JavaScript, Vala, jpayne@68: Desktop)

jpayne@68: jpayne@68:

-C, jpayne@68: --c++

jpayne@68: jpayne@68:

shorthand for jpayne@68: --language=C++

jpayne@68: jpayne@68:

By default the jpayne@68: language is guessed depending on the input file name jpayne@68: extension.

jpayne@68: jpayne@68:

Input file jpayne@68: interpretation:
jpayne@68: --from-code
=NAME

jpayne@68: jpayne@68:

encoding of input files (except jpayne@68: for Python, Tcl, Glade)

jpayne@68: jpayne@68:

By default the jpayne@68: input files are assumed to be in ASCII.

jpayne@68: jpayne@68:

Operation jpayne@68: mode:
jpayne@68: -j
, --join-existing

jpayne@68: jpayne@68:

join messages with existing jpayne@68: file

jpayne@68: jpayne@68:

-x, jpayne@68: --exclude-file=FILE.po

jpayne@68: jpayne@68:

entries from FILE.po are not jpayne@68: extracted

jpayne@68: jpayne@68:

-cTAG, jpayne@68: --add-comments=TAG

jpayne@68: jpayne@68:

place comment blocks starting jpayne@68: with TAG and preceding keyword lines in output file

jpayne@68: jpayne@68:

-c, jpayne@68: --add-comments

jpayne@68: jpayne@68:

place all comment blocks jpayne@68: preceding keyword lines in output file

jpayne@68: jpayne@68: jpayne@68:

--check=NAME

jpayne@68: jpayne@68:

perform syntax check on jpayne@68: messages (ellipsis-unicode, space-ellipsis,

jpayne@68: jpayne@68: jpayne@68:

quote-unicode, jpayne@68: bullet-unicode)

jpayne@68: jpayne@68: jpayne@68:

--sentence-end=TYPE

jpayne@68: jpayne@68:

type describing the end of jpayne@68: sentence (single-space, which is the default,

jpayne@68: jpayne@68:

or jpayne@68: double-space)

jpayne@68: jpayne@68:

Language jpayne@68: specific options:
jpayne@68: -a
, --extract-all

jpayne@68: jpayne@68:

extract all strings (only jpayne@68: languages C, C++, ObjectiveC, Shell, Python, Lisp, jpayne@68: EmacsLisp, librep, Scheme, Java, C#, awk, Tcl, Perl, PHP, jpayne@68: GCC-source, Glade, Lua, JavaScript, Vala)

jpayne@68: jpayne@68:

-kWORD, jpayne@68: --keyword=WORD

jpayne@68: jpayne@68:

look for WORD as an additional jpayne@68: keyword

jpayne@68: jpayne@68:

-k, jpayne@68: --keyword

jpayne@68: jpayne@68:

do not to use default keywords jpayne@68: (only languages C, C++, ObjectiveC, Shell, Python, Lisp, jpayne@68: EmacsLisp, librep, Scheme, Java, C#, awk, Tcl, Perl, PHP, jpayne@68: GCC-source, Glade, Lua, JavaScript, Vala, Desktop)

jpayne@68: jpayne@68: jpayne@68:

--flag=WORD:ARG:FLAG

jpayne@68: jpayne@68:

additional flag for strings jpayne@68: inside the argument number ARG of keyword WORD

jpayne@68: jpayne@68:

(only languages C, C++, jpayne@68: ObjectiveC, Shell,

jpayne@68: jpayne@68:

Python, Lisp, EmacsLisp, jpayne@68: librep, Scheme, Java, C#, awk, YCP, Tcl, Perl, PHP, jpayne@68: GCC-source, Lua, JavaScript, Vala)

jpayne@68: jpayne@68:

-T, jpayne@68: --trigraphs

jpayne@68: jpayne@68:

understand ANSI C trigraphs for jpayne@68: input (only languages C, C++, ObjectiveC)

jpayne@68: jpayne@68: jpayne@68:

--its=FILE

jpayne@68: jpayne@68:

apply ITS rules from FILE (only jpayne@68: XML based languages)

jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68: jpayne@68:
jpayne@68: jpayne@68: jpayne@68:

--qt

jpayne@68: jpayne@68: jpayne@68:

recognize Qt format strings (only language C++)

jpayne@68:
jpayne@68: jpayne@68: jpayne@68:

--kde

jpayne@68: jpayne@68: jpayne@68:

recognize KDE 4 format strings (only language C++)

jpayne@68:
jpayne@68: jpayne@68:

--boost

jpayne@68: jpayne@68:

recognize Boost format strings jpayne@68: (only language C++)

jpayne@68: jpayne@68:

--debug

jpayne@68: jpayne@68:

more detailed formatstring jpayne@68: recognition result

jpayne@68: jpayne@68:

Output jpayne@68: details:
jpayne@68: --color

jpayne@68: jpayne@68:

use colors and other text jpayne@68: attributes always

jpayne@68: jpayne@68: jpayne@68:

--color=WHEN

jpayne@68: jpayne@68:

use colors and other text jpayne@68: attributes if WHEN. WHEN may be ’always’, jpayne@68: ’never’, ’auto’, or jpayne@68: ’html’.

jpayne@68: jpayne@68: jpayne@68:

--style=STYLEFILE

jpayne@68: jpayne@68:

specify CSS style rule file for jpayne@68: --color

jpayne@68: jpayne@68:

-e, jpayne@68: --no-escape

jpayne@68: jpayne@68:

do not use C escapes in output jpayne@68: (default)

jpayne@68: jpayne@68:

-E, jpayne@68: --escape

jpayne@68: jpayne@68:

use C escapes in output, no jpayne@68: extended chars

jpayne@68: jpayne@68: jpayne@68:

--force-po

jpayne@68: jpayne@68:

write PO file even if empty

jpayne@68: jpayne@68:

-i, jpayne@68: --indent

jpayne@68: jpayne@68:

write the .po file using jpayne@68: indented style

jpayne@68: jpayne@68: jpayne@68:

--no-location

jpayne@68: jpayne@68:

do not write ’#: jpayne@68: filename:line’ lines

jpayne@68: jpayne@68:

-n, jpayne@68: --add-location

jpayne@68: jpayne@68:

generate ’#: jpayne@68: filename:line’ lines (default)

jpayne@68: jpayne@68: jpayne@68:

--strict

jpayne@68: jpayne@68:

write out strict Uniforum jpayne@68: conforming .po file

jpayne@68: jpayne@68: jpayne@68:

--properties-output

jpayne@68: jpayne@68:

write out a Java .properties jpayne@68: file

jpayne@68: jpayne@68: jpayne@68:

--stringtable-output

jpayne@68: jpayne@68:

write out a NeXTstep/GNUstep jpayne@68: .strings file

jpayne@68: jpayne@68: jpayne@68:

--itstool

jpayne@68: jpayne@68:

write out itstool comments

jpayne@68: jpayne@68:

-w, jpayne@68: --width=NUMBER

jpayne@68: jpayne@68:

set output page width

jpayne@68: jpayne@68: jpayne@68:

--no-wrap

jpayne@68: jpayne@68:

do not break long message jpayne@68: lines, longer than the output page width, into several jpayne@68: lines

jpayne@68: jpayne@68:

-s, jpayne@68: --sort-output

jpayne@68: jpayne@68:

generate sorted output jpayne@68: (deprecated)

jpayne@68: jpayne@68:

-F, jpayne@68: --sort-by-file

jpayne@68: jpayne@68:

sort output by file jpayne@68: location

jpayne@68: jpayne@68: jpayne@68:

--omit-header

jpayne@68: jpayne@68:

don’t write header with jpayne@68: ’msgid ""’ entry

jpayne@68: jpayne@68: jpayne@68:

--copyright-holder=STRING

jpayne@68: jpayne@68:

set copyright holder in jpayne@68: output

jpayne@68: jpayne@68: jpayne@68:

--foreign-user

jpayne@68: jpayne@68:

omit FSF copyright in output jpayne@68: for foreign user

jpayne@68: jpayne@68: jpayne@68:

--package-name=PACKAGE

jpayne@68: jpayne@68:

set package name in output

jpayne@68: jpayne@68: jpayne@68:

--package-version=VERSION

jpayne@68: jpayne@68:

set package version in jpayne@68: output

jpayne@68: jpayne@68: jpayne@68:

--msgid-bugs-address=EMAIL@ADDRESS

jpayne@68: jpayne@68:

set report address for msgid jpayne@68: bugs

jpayne@68: jpayne@68:

-m[STRING], jpayne@68: --msgstr-prefix[=STRING]

jpayne@68: jpayne@68:

use STRING or "" as jpayne@68: prefix for msgstr values

jpayne@68: jpayne@68:

-M[STRING], jpayne@68: --msgstr-suffix[=STRING]

jpayne@68: jpayne@68:

use STRING or "" as jpayne@68: suffix for msgstr values

jpayne@68: jpayne@68:

Informative jpayne@68: output:
jpayne@68: -h
, --help

jpayne@68: jpayne@68:

display this help and exit

jpayne@68: jpayne@68:

-V, jpayne@68: --version

jpayne@68: jpayne@68:

output version information and jpayne@68: exit

jpayne@68: jpayne@68:

-v, jpayne@68: --verbose

jpayne@68: jpayne@68:

increase verbosity level

jpayne@68: jpayne@68:

AUTHOR jpayne@68: jpayne@68:

jpayne@68: jpayne@68: jpayne@68:

Written by jpayne@68: Ulrich Drepper.

jpayne@68: jpayne@68:

REPORTING BUGS jpayne@68: jpayne@68:

jpayne@68: jpayne@68: jpayne@68:

Report bugs in jpayne@68: the bug tracker at jpayne@68: <https://savannah.gnu.org/projects/gettext> or by jpayne@68: email to <bug-gettext@gnu.org>.

jpayne@68: jpayne@68:

COPYRIGHT jpayne@68: jpayne@68:

jpayne@68: jpayne@68: jpayne@68:

Copyright jpayne@68: © 1995-2023 Free Software Foundation, Inc. jpayne@68: License GPLv3+: GNU GPL version 3 or later jpayne@68: <https://gnu.org/licenses/gpl.html>
jpayne@68: This is free software: you are free to change and jpayne@68: redistribute it. There is NO WARRANTY, to the extent jpayne@68: permitted by law.

jpayne@68: jpayne@68:

SEE ALSO jpayne@68: jpayne@68:

jpayne@68: jpayne@68: jpayne@68:

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

jpayne@68: jpayne@68:

info jpayne@68: xgettext

jpayne@68: jpayne@68:

should give you jpayne@68: access to the complete manual.

jpayne@68:
jpayne@68: jpayne@68: