jpayne@68: .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
jpayne@68: .TH XGETTEXT "1" "February 2024" "GNU gettext-tools 0.22.5" "User Commands"
jpayne@68: .SH NAME
jpayne@68: xgettext \- extract gettext strings from source
jpayne@68: .SH SYNOPSIS
jpayne@68: .B xgettext
jpayne@68: [\fI\,OPTION\/\fR] [\fI\,INPUTFILE\/\fR]...
jpayne@68: .SH DESCRIPTION
jpayne@68: .\" Add any additional description here
jpayne@68: .PP
jpayne@68: Extract translatable strings from given input files.
jpayne@68: .PP
jpayne@68: Mandatory arguments to long options are mandatory for short options too.
jpayne@68: Similarly for optional arguments.
jpayne@68: .SS "Input file location:"
jpayne@68: .TP
jpayne@68: INPUTFILE ...
jpayne@68: input files
jpayne@68: .TP
jpayne@68: \fB\-f\fR, \fB\-\-files\-from\fR=\fI\,FILE\/\fR
jpayne@68: get list of input files from FILE
jpayne@68: .TP
jpayne@68: \fB\-D\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
jpayne@68: add DIRECTORY to list for input files search
jpayne@68: .PP
jpayne@68: If input file is \-, standard input is read.
jpayne@68: .SS "Output file location:"
jpayne@68: .TP
jpayne@68: \fB\-d\fR, \fB\-\-default\-domain\fR=\fI\,NAME\/\fR
jpayne@68: use NAME.po for output (instead of messages.po)
jpayne@68: .TP
jpayne@68: \fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
jpayne@68: write output to specified file
jpayne@68: .TP
jpayne@68: \fB\-p\fR, \fB\-\-output\-dir\fR=\fI\,DIR\/\fR
jpayne@68: output files will be placed in directory DIR
jpayne@68: .PP
jpayne@68: If output file is \-, output is written to standard output.
jpayne@68: .SS "Choice of input file language:"
jpayne@68: .TP
jpayne@68: \fB\-L\fR, \fB\-\-language\fR=\fI\,NAME\/\fR
jpayne@68: recognise the specified language
jpayne@68: (C, C++, ObjectiveC, PO, Shell, Python, Lisp,
jpayne@68: EmacsLisp, librep, Scheme, Smalltalk, Java,
jpayne@68: JavaProperties, C#, awk, YCP, Tcl, Perl, PHP,
jpayne@68: Ruby, GCC\-source, NXStringTable, RST, RSJ,
jpayne@68: Glade, Lua, JavaScript, Vala, Desktop)
jpayne@68: .TP
jpayne@68: \fB\-C\fR, \fB\-\-c\fR++
jpayne@68: shorthand for \fB\-\-language\fR=\fI\,C\/\fR++
jpayne@68: .PP
jpayne@68: By default the language is guessed depending on the input file name extension.
jpayne@68: .SS "Input file interpretation:"
jpayne@68: .TP
jpayne@68: \fB\-\-from\-code\fR=\fI\,NAME\/\fR
jpayne@68: encoding of input files
jpayne@68: (except for Python, Tcl, Glade)
jpayne@68: .PP
jpayne@68: By default the input files are assumed to be in ASCII.
jpayne@68: .SS "Operation mode:"
jpayne@68: .TP
jpayne@68: \fB\-j\fR, \fB\-\-join\-existing\fR
jpayne@68: join messages with existing file
jpayne@68: .TP
jpayne@68: \fB\-x\fR, \fB\-\-exclude\-file\fR=\fI\,FILE\/\fR.po
jpayne@68: entries from FILE.po are not extracted
jpayne@68: .TP
jpayne@68: \fB\-cTAG\fR, \fB\-\-add\-comments\fR=\fI\,TAG\/\fR
jpayne@68: place comment blocks starting with TAG and
jpayne@68: preceding keyword lines in output file
jpayne@68: .TP
jpayne@68: \fB\-c\fR, \fB\-\-add\-comments\fR
jpayne@68: place all comment blocks preceding keyword lines
jpayne@68: in output file
jpayne@68: .TP
jpayne@68: \fB\-\-check\fR=\fI\,NAME\/\fR
jpayne@68: perform syntax check on messages
jpayne@68: (ellipsis\-unicode, space\-ellipsis,
jpayne@68: .IP
jpayne@68: quote\-unicode, bullet\-unicode)
jpayne@68: .TP
jpayne@68: \fB\-\-sentence\-end\fR=\fI\,TYPE\/\fR
jpayne@68: type describing the end of sentence
jpayne@68: (single\-space, which is the default,
jpayne@68: .IP
jpayne@68: or double\-space)
jpayne@68: .SS "Language specific options:"
jpayne@68: .TP
jpayne@68: \fB\-a\fR, \fB\-\-extract\-all\fR
jpayne@68: extract all strings
jpayne@68: (only languages C, C++, ObjectiveC, Shell,
jpayne@68: Python, Lisp, EmacsLisp, librep, Scheme, Java,
jpayne@68: C#, awk, Tcl, Perl, PHP, GCC\-source, Glade,
jpayne@68: Lua, JavaScript, Vala)
jpayne@68: .TP
jpayne@68: \fB\-kWORD\fR, \fB\-\-keyword\fR=\fI\,WORD\/\fR
jpayne@68: look for WORD as an additional keyword
jpayne@68: .TP
jpayne@68: \fB\-k\fR, \fB\-\-keyword\fR
jpayne@68: do not to use default keywords
jpayne@68: (only languages C, C++, ObjectiveC, Shell,
jpayne@68: Python, Lisp, EmacsLisp, librep, Scheme, Java,
jpayne@68: C#, awk, Tcl, Perl, PHP, GCC\-source, Glade,
jpayne@68: Lua, JavaScript, Vala, Desktop)
jpayne@68: .TP
jpayne@68: \fB\-\-flag\fR=\fI\,WORD\/\fR:ARG:FLAG
jpayne@68: additional flag for strings inside the argument
jpayne@68: number ARG of keyword WORD
jpayne@68: .TP
jpayne@68: (only languages C, C++, ObjectiveC, Shell,
jpayne@68: Python, Lisp, EmacsLisp, librep, Scheme, Java,
jpayne@68: C#, awk, YCP, Tcl, Perl, PHP, GCC\-source,
jpayne@68: Lua, JavaScript, Vala)
jpayne@68: .TP
jpayne@68: \fB\-T\fR, \fB\-\-trigraphs\fR
jpayne@68: understand ANSI C trigraphs for input
jpayne@68: (only languages C, C++, ObjectiveC)
jpayne@68: .TP
jpayne@68: \fB\-\-its\fR=\fI\,FILE\/\fR
jpayne@68: apply ITS rules from FILE
jpayne@68: (only XML based languages)
jpayne@68: .TP
jpayne@68: \fB\-\-qt\fR
jpayne@68: recognize Qt format strings
jpayne@68: (only language C++)
jpayne@68: .TP
jpayne@68: \fB\-\-kde\fR
jpayne@68: recognize KDE 4 format strings
jpayne@68: (only language C++)
jpayne@68: .TP
jpayne@68: \fB\-\-boost\fR
jpayne@68: recognize Boost format strings
jpayne@68: (only language C++)
jpayne@68: .TP
jpayne@68: \fB\-\-debug\fR
jpayne@68: more detailed formatstring recognition result
jpayne@68: .SS "Output details:"
jpayne@68: .TP
jpayne@68: \fB\-\-color\fR
jpayne@68: use colors and other text attributes always
jpayne@68: .TP
jpayne@68: \fB\-\-color\fR=\fI\,WHEN\/\fR
jpayne@68: use colors and other text attributes if WHEN.
jpayne@68: WHEN may be 'always', 'never', 'auto', or 'html'.
jpayne@68: .TP
jpayne@68: \fB\-\-style\fR=\fI\,STYLEFILE\/\fR
jpayne@68: specify CSS style rule file for \fB\-\-color\fR
jpayne@68: .TP
jpayne@68: \fB\-e\fR, \fB\-\-no\-escape\fR
jpayne@68: do not use C escapes in output (default)
jpayne@68: .TP
jpayne@68: \fB\-E\fR, \fB\-\-escape\fR
jpayne@68: use C escapes in output, no extended chars
jpayne@68: .TP
jpayne@68: \fB\-\-force\-po\fR
jpayne@68: write PO file even if empty
jpayne@68: .TP
jpayne@68: \fB\-i\fR, \fB\-\-indent\fR
jpayne@68: write the .po file using indented style
jpayne@68: .TP
jpayne@68: \fB\-\-no\-location\fR
jpayne@68: do not write '#: filename:line' lines
jpayne@68: .TP
jpayne@68: \fB\-n\fR, \fB\-\-add\-location\fR
jpayne@68: generate '#: filename:line' lines (default)
jpayne@68: .TP
jpayne@68: \fB\-\-strict\fR
jpayne@68: write out strict Uniforum conforming .po file
jpayne@68: .TP
jpayne@68: \fB\-\-properties\-output\fR
jpayne@68: write out a Java .properties file
jpayne@68: .TP
jpayne@68: \fB\-\-stringtable\-output\fR
jpayne@68: write out a NeXTstep/GNUstep .strings file
jpayne@68: .TP
jpayne@68: \fB\-\-itstool\fR
jpayne@68: write out itstool comments
jpayne@68: .TP
jpayne@68: \fB\-w\fR, \fB\-\-width\fR=\fI\,NUMBER\/\fR
jpayne@68: set output page width
jpayne@68: .TP
jpayne@68: \fB\-\-no\-wrap\fR
jpayne@68: do not break long message lines, longer than
jpayne@68: the output page width, into several lines
jpayne@68: .TP
jpayne@68: \fB\-s\fR, \fB\-\-sort\-output\fR
jpayne@68: generate sorted output (deprecated)
jpayne@68: .TP
jpayne@68: \fB\-F\fR, \fB\-\-sort\-by\-file\fR
jpayne@68: sort output by file location
jpayne@68: .TP
jpayne@68: \fB\-\-omit\-header\fR
jpayne@68: don't write header with 'msgid ""' entry
jpayne@68: .TP
jpayne@68: \fB\-\-copyright\-holder\fR=\fI\,STRING\/\fR
jpayne@68: set copyright holder in output
jpayne@68: .TP
jpayne@68: \fB\-\-foreign\-user\fR
jpayne@68: omit FSF copyright in output for foreign user
jpayne@68: .TP
jpayne@68: \fB\-\-package\-name\fR=\fI\,PACKAGE\/\fR
jpayne@68: set package name in output
jpayne@68: .TP
jpayne@68: \fB\-\-package\-version\fR=\fI\,VERSION\/\fR
jpayne@68: set package version in output
jpayne@68: .TP
jpayne@68: \fB\-\-msgid\-bugs\-address\fR=\fI\,EMAIL\/\fR@ADDRESS
jpayne@68: set report address for msgid bugs
jpayne@68: .TP
jpayne@68: \fB\-m[STRING]\fR, \fB\-\-msgstr\-prefix\fR[=\fI\,STRING\/\fR]
jpayne@68: use STRING or "" as prefix for msgstr
jpayne@68: values
jpayne@68: .TP
jpayne@68: \fB\-M[STRING]\fR, \fB\-\-msgstr\-suffix\fR[=\fI\,STRING\/\fR]
jpayne@68: use STRING or "" as suffix for msgstr
jpayne@68: values
jpayne@68: .SS "Informative output:"
jpayne@68: .TP
jpayne@68: \fB\-h\fR, \fB\-\-help\fR
jpayne@68: display this help and exit
jpayne@68: .TP
jpayne@68: \fB\-V\fR, \fB\-\-version\fR
jpayne@68: output version information and exit
jpayne@68: .TP
jpayne@68: \fB\-v\fR, \fB\-\-verbose\fR
jpayne@68: increase verbosity level
jpayne@68: .SH AUTHOR
jpayne@68: Written by Ulrich Drepper.
jpayne@68: .SH "REPORTING BUGS"
jpayne@68: Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext>
jpayne@68: or by email to <bug\-gettext@gnu.org>.
jpayne@68: .SH COPYRIGHT
jpayne@68: Copyright \(co 1995\-2023 Free Software Foundation, Inc.
jpayne@68: License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
jpayne@68: .br
jpayne@68: This is free software: you are free to change and redistribute it.
jpayne@68: There is NO WARRANTY, to the extent permitted by law.
jpayne@68: .SH "SEE ALSO"
jpayne@68: The full documentation for
jpayne@68: .B xgettext
jpayne@68: is maintained as a Texinfo manual.  If the
jpayne@68: .B info
jpayne@68: and
jpayne@68: .B xgettext
jpayne@68: programs are properly installed at your site, the command
jpayne@68: .IP
jpayne@68: .B info xgettext
jpayne@68: .PP
jpayne@68: should give you access to the complete manual.