gettext-tools/man/xgettext.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.24.
   2 .TH XGETTEXT "1" "June 2016" "GNU gettext-tools 0.19.8" GNU
   3 .SH NAME
   4 xgettext \- extract gettext strings from source
   5 .SH SYNOPSIS
   6 .B xgettext
   7 [\fIOPTION\fR] [\fIINPUTFILE\fR]...
   8 .SH DESCRIPTION
   9 .\" Add any additional description here
  10 .PP
  11 Extract translatable strings from given input files.
  12 .PP
  13 Mandatory arguments to long options are mandatory for short options too.
  14 Similarly for optional arguments.
  15 .SS "Input file location:"
  16 .TP
  17 INPUTFILE ...
  18 input files
  19 .TP
  20 \fB\-f\fR, \fB\-\-files\-from\fR=\fIFILE\fR
  21 get list of input files from FILE
  22 .TP
  23 \fB\-D\fR, \fB\-\-directory\fR=\fIDIRECTORY\fR
  24 add DIRECTORY to list for input files search
  25 .PP
  26 If input file is -, standard input is read.
  27 .SS "Output file location:"
  28 .TP
  29 \fB\-d\fR, \fB\-\-default\-domain\fR=\fINAME\fR
  30 use NAME.po for output (instead of messages.po)
  31 .TP
  32 \fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
  33 write output to specified file
  34 .TP
  35 \fB\-p\fR, \fB\-\-output\-dir\fR=\fIDIR\fR
  36 output files will be placed in directory DIR
  37 .PP
  38 If output file is -, output is written to standard output.
  39 .SS "Choice of input file language:"
  40 .TP
  41 \fB\-L\fR, \fB\-\-language\fR=\fINAME\fR
  42 recognise the specified language
  43 (C, C++, ObjectiveC, PO, Shell, Python, Lisp,
  44 EmacsLisp, librep, Scheme, Smalltalk, Java,
  45 JavaProperties, C#, awk, YCP, Tcl, Perl, PHP,
  46 GCC-source, NXStringTable, RST, Glade, Lua,
  47 JavaScript, Vala, Desktop)
  48 .TP
  49 \fB\-C\fR, \fB\-\-c\fR++
  50 shorthand for \fB\-\-language\fR=\fIC\fR++
  51 .PP
  52 By default the language is guessed depending on the input file name extension.
  53 .SS "Input file interpretation:"
  54 .TP
  55 \fB\-\-from\-code\fR=\fINAME\fR
  56 encoding of input files
  57 (except for Python, Tcl, Glade)
  58 .PP
  59 By default the input files are assumed to be in ASCII.
  60 .SS "Operation mode:"
  61 .TP
  62 \fB\-j\fR, \fB\-\-join\-existing\fR
  63 join messages with existing file
  64 .TP
  65 \fB\-x\fR, \fB\-\-exclude\-file\fR=\fIFILE\fR.po
  66 entries from FILE.po are not extracted
  67 .TP
  68 \fB\-cTAG\fR, \fB\-\-add\-comments\fR=\fITAG\fR
  69 place comment blocks starting with TAG and
  70 preceding keyword lines in output file
  71 .TP
  72 \fB\-c\fR, \fB\-\-add\-comments\fR
  73 place all comment blocks preceding keyword lines
  74 in output file
  75 .TP
  76 \fB\-\-check\fR=\fINAME\fR
  77 perform syntax check on messages
  78 (ellipsis-unicode, space-ellipsis,
  79 .IP
  80 quote-unicode, bullet-unicode)
  81 .TP
  82 \fB\-\-sentence\-end\fR=\fITYPE\fR
  83 type describing the end of sentence
  84 (single-space, which is the default,
  85 .IP
  86 or double-space)
  87 .SS "Language specific options:"
  88 .TP
  89 \fB\-a\fR, \fB\-\-extract\-all\fR
  90 extract all strings
  91 (only languages C, C++, ObjectiveC, Shell,
  92 Python, Lisp, EmacsLisp, librep, Scheme, Java,
  93 C#, awk, Tcl, Perl, PHP, GCC-source, Glade,
  94 Lua, JavaScript, Vala)
  95 .TP
  96 \fB\-kWORD\fR, \fB\-\-keyword\fR=\fIWORD\fR
  97 look for WORD as an additional keyword
  98 .TP
  99 \fB\-k\fR, \fB\-\-keyword\fR
 100 do not to use default keywords
 101 (only languages C, C++, ObjectiveC, Shell,
 102 Python, Lisp, EmacsLisp, librep, Scheme, Java,
 103 C#, awk, Tcl, Perl, PHP, GCC-source, Glade,
 104 Lua, JavaScript, Vala, Desktop)
 105 .TP
 106 \fB\-\-flag\fR=\fIWORD\fR:ARG:FLAG
 107 additional flag for strings inside the argument
 108 number ARG of keyword WORD
 109 .IP
 110 (only languages C, C++, ObjectiveC, Shell,
 111 Python, Lisp, EmacsLisp, librep, Scheme, Java,
 112 C#, awk, YCP, Tcl, Perl, PHP, GCC-source,
 113 Lua, JavaScript, Vala)
 114 .TP
 115 \fB\-T\fR, \fB\-\-trigraphs\fR
 116 understand ANSI C trigraphs for input
 117 (only languages C, C++, ObjectiveC)
 118 .TP
 119 \fB\-\-its\fR=\fIFILE\fR
 120 apply ITS rules from FILE
 121 (only XML based languages)
 122 .TP
 123 \fB\-\-qt\fR
 124 recognize Qt format strings
 125 (only language C++)
 126 .TP
 127 \fB\-\-kde\fR
 128 recognize KDE 4 format strings
 129 (only language C++)
 130 .TP
 131 \fB\-\-boost\fR
 132 recognize Boost format strings
 133 (only language C++)
 134 .TP
 135 \fB\-\-debug\fR
 136 more detailed formatstring recognition result
 137 .SS "Output details:"
 138 .TP
 139 \fB\-\-color\fR
 140 use colors and other text attributes always
 141 .TP
 142 \fB\-\-color\fR=\fIWHEN\fR
 143 use colors and other text attributes if WHEN.
 144 WHEN may be 'always', 'never', 'auto', or 'html'.
 145 .TP
 146 \fB\-\-style\fR=\fISTYLEFILE\fR
 147 specify CSS style rule file for \fB\-\-color\fR
 148 .TP
 149 \fB\-e\fR, \fB\-\-no\-escape\fR
 150 do not use C escapes in output (default)
 151 .TP
 152 \fB\-E\fR, \fB\-\-escape\fR
 153 use C escapes in output, no extended chars
 154 .TP
 155 \fB\-\-force\-po\fR
 156 write PO file even if empty
 157 .TP
 158 \fB\-i\fR, \fB\-\-indent\fR
 159 write the .po file using indented style
 160 .TP
 161 \fB\-\-no\-location\fR
 162 do not write '#: filename:line' lines
 163 .TP
 164 \fB\-n\fR, \fB\-\-add\-location\fR
 165 generate '#: filename:line' lines (default)
 166 .TP
 167 \fB\-\-strict\fR
 168 write out strict Uniforum conforming .po file
 169 .TP
 170 \fB\-\-properties\-output\fR
 171 write out a Java .properties file
 172 .TP
 173 \fB\-\-stringtable\-output\fR
 174 write out a NeXTstep/GNUstep .strings file
 175 .TP
 176 \fB\-\-itstool\fR
 177 write out itstool comments
 178 .TP
 179 \fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
 180 set output page width
 181 .TP
 182 \fB\-\-no\-wrap\fR
 183 do not break long message lines, longer than
 184 the output page width, into several lines
 185 .TP
 186 \fB\-s\fR, \fB\-\-sort\-output\fR
 187 generate sorted output
 188 .TP
 189 \fB\-F\fR, \fB\-\-sort\-by\-file\fR
 190 sort output by file location
 191 .TP
 192 \fB\-\-omit\-header\fR
 193 don't write header with 'msgid ""' entry
 194 .TP
 195 \fB\-\-copyright\-holder\fR=\fISTRING\fR
 196 set copyright holder in output
 197 .TP
 198 \fB\-\-foreign\-user\fR
 199 omit FSF copyright in output for foreign user
 200 .TP
 201 \fB\-\-package\-name\fR=\fIPACKAGE\fR
 202 set package name in output
 203 .TP
 204 \fB\-\-package\-version\fR=\fIVERSION\fR
 205 set package version in output
 206 .TP
 207 \fB\-\-msgid\-bugs\-address\fR=\fIEMAIL\fR@ADDRESS
 208 set report address for msgid bugs
 209 .TP
 210 \fB\-m[STRING]\fR, \fB\-\-msgstr\-prefix\fR[=\fISTRING\fR]
 211 use STRING or "" as prefix for msgstr
 212 values
 213 .TP
 214 \fB\-M[STRING]\fR, \fB\-\-msgstr\-suffix\fR[=\fISTRING\fR]
 215 use STRING or "" as suffix for msgstr
 216 values
 217 .SS "Informative output:"
 218 .TP
 219 \fB\-h\fR, \fB\-\-help\fR
 220 display this help and exit
 221 .TP
 222 \fB\-V\fR, \fB\-\-version\fR
 223 output version information and exit
 224 .SH AUTHOR
 225 Written by Ulrich Drepper.
 226 .SH "REPORTING BUGS"
 227 Report bugs to <bug-gnu-gettext@gnu.org>.
 228 .SH COPYRIGHT
 229 Copyright \(co 1995-1998, 2000-2016 Free Software Foundation, Inc.
 230 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
 231 .br
 232 This is free software: you are free to change and redistribute it.
 233 There is NO WARRANTY, to the extent permitted by law.
 234 .SH "SEE ALSO"
 235 The full documentation for
 236 .B xgettext
 237 is maintained as a Texinfo manual.  If the
 238 .B info
 239 and
 240 .B xgettext
 241 programs are properly installed at your site, the command
 242 .IP
 243 .B info xgettext
 244 .PP
 245 should give you access to the complete manual.