gettext-tools/man/xgettext.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.24.
   2 .TH XGETTEXT "1" "December 2015" "GNU gettext-tools 0.19.7" 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)
  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\-\-qt\fR
 120 recognize Qt format strings
 121 (only language C++)
 122 .TP
 123 \fB\-\-kde\fR
 124 recognize KDE 4 format strings
 125 (only language C++)
 126 .TP
 127 \fB\-\-boost\fR
 128 recognize Boost format strings
 129 (only language C++)
 130 .TP
 131 \fB\-\-debug\fR
 132 more detailed formatstring recognition result
 133 .SS "Output details:"
 134 .TP
 135 \fB\-\-color\fR
 136 use colors and other text attributes always
 137 .TP
 138 \fB\-\-color\fR=\fIWHEN\fR
 139 use colors and other text attributes if WHEN.
 140 WHEN may be 'always', 'never', 'auto', or 'html'.
 141 .TP
 142 \fB\-\-style\fR=\fISTYLEFILE\fR
 143 specify CSS style rule file for \fB\-\-color\fR
 144 .TP
 145 \fB\-e\fR, \fB\-\-no\-escape\fR
 146 do not use C escapes in output (default)
 147 .TP
 148 \fB\-E\fR, \fB\-\-escape\fR
 149 use C escapes in output, no extended chars
 150 .TP
 151 \fB\-\-force\-po\fR
 152 write PO file even if empty
 153 .TP
 154 \fB\-i\fR, \fB\-\-indent\fR
 155 write the .po file using indented style
 156 .TP
 157 \fB\-\-no\-location\fR
 158 do not write '#: filename:line' lines
 159 .TP
 160 \fB\-n\fR, \fB\-\-add\-location\fR
 161 generate '#: filename:line' lines (default)
 162 .TP
 163 \fB\-\-strict\fR
 164 write out strict Uniforum conforming .po file
 165 .TP
 166 \fB\-\-properties\-output\fR
 167 write out a Java .properties file
 168 .TP
 169 \fB\-\-stringtable\-output\fR
 170 write out a NeXTstep/GNUstep .strings file
 171 .TP
 172 \fB\-\-its\fR=\fIFILE\fR
 173 apply ITS rules from FILE
 174 .TP
 175 \fB\-\-itstool\fR
 176 write out itstool comments
 177 .TP
 178 \fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
 179 set output page width
 180 .TP
 181 \fB\-\-no\-wrap\fR
 182 do not break long message lines, longer than
 183 the output page width, into several lines
 184 .TP
 185 \fB\-s\fR, \fB\-\-sort\-output\fR
 186 generate sorted output
 187 .TP
 188 \fB\-F\fR, \fB\-\-sort\-by\-file\fR
 189 sort output by file location
 190 .TP
 191 \fB\-\-omit\-header\fR
 192 don't write header with 'msgid ""' entry
 193 .TP
 194 \fB\-\-copyright\-holder\fR=\fISTRING\fR
 195 set copyright holder in output
 196 .TP
 197 \fB\-\-foreign\-user\fR
 198 omit FSF copyright in output for foreign user
 199 .TP
 200 \fB\-\-package\-name\fR=\fIPACKAGE\fR
 201 set package name in output
 202 .TP
 203 \fB\-\-package\-version\fR=\fIVERSION\fR
 204 set package version in output
 205 .TP
 206 \fB\-\-msgid\-bugs\-address\fR=\fIEMAIL\fR@ADDRESS
 207 set report address for msgid bugs
 208 .TP
 209 \fB\-m[STRING]\fR, \fB\-\-msgstr\-prefix\fR[=\fISTRING\fR]
 210 use STRING or "" as prefix for msgstr
 211 values
 212 .TP
 213 \fB\-M[STRING]\fR, \fB\-\-msgstr\-suffix\fR[=\fISTRING\fR]
 214 use STRING or "" as suffix for msgstr
 215 values
 216 .SS "Informative output:"
 217 .TP
 218 \fB\-h\fR, \fB\-\-help\fR
 219 display this help and exit
 220 .TP
 221 \fB\-V\fR, \fB\-\-version\fR
 222 output version information and exit
 223 .SH AUTHOR
 224 Written by Ulrich Drepper.
 225 .SH "REPORTING BUGS"
 226 Report bugs to <bug-gnu-gettext@gnu.org>.
 227 .SH COPYRIGHT
 228 Copyright \(co 1995-1998, 2000-2013 Free Software Foundation, Inc.
 229 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
 230 .br
 231 This is free software: you are free to change and redistribute it.
 232 There is NO WARRANTY, to the extent permitted by law.
 233 .SH "SEE ALSO"
 234 The full documentation for
 235 .B xgettext
 236 is maintained as a Texinfo manual.  If the
 237 .B info
 238 and
 239 .B xgettext
 240 programs are properly installed at your site, the command
 241 .IP
 242 .B info xgettext
 243 .PP
 244 should give you access to the complete manual.