gettext-tools/man/xgettext.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.24.
   2 .TH XGETTEXT "1" "January 2014" "GNU gettext-tools 0.18.3" 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)
  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 .SS "Language specific options:"
  76 .TP
  77 \fB\-a\fR, \fB\-\-extract\-all\fR
  78 extract all strings
  79 (only languages C, C++, ObjectiveC, Shell,
  80 Python, Lisp, EmacsLisp, librep, Scheme, Java,
  81 C#, awk, Tcl, Perl, PHP, GCC-source, Glade,
  82 Lua, JavaScript, Vala)
  83 .TP
  84 \fB\-kWORD\fR, \fB\-\-keyword\fR=\fIWORD\fR
  85 look for WORD as an additional keyword
  86 .TP
  87 \fB\-k\fR, \fB\-\-keyword\fR
  88 do not to use default keywords
  89 (only languages C, C++, ObjectiveC, Shell,
  90 Python, Lisp, EmacsLisp, librep, Scheme, Java,
  91 C#, awk, Tcl, Perl, PHP, GCC-source, Glade,
  92 Lua, JavaScript, Vala)
  93 .TP
  94 \fB\-\-flag\fR=\fIWORD\fR:ARG:FLAG
  95 additional flag for strings inside the argument
  96 number ARG of keyword WORD
  97 .IP
  98 (only languages C, C++, ObjectiveC, Shell,
  99 Python, Lisp, EmacsLisp, librep, Scheme, Java,
 100 C#, awk, YCP, Tcl, Perl, PHP, GCC-source,
 101 Lua, JavaScript, Vala)
 102 .TP
 103 \fB\-T\fR, \fB\-\-trigraphs\fR
 104 understand ANSI C trigraphs for input
 105 (only languages C, C++, ObjectiveC)
 106 .TP
 107 \fB\-\-qt\fR
 108 recognize Qt format strings
 109 (only language C++)
 110 .TP
 111 \fB\-\-kde\fR
 112 recognize KDE 4 format strings
 113 (only language C++)
 114 .TP
 115 \fB\-\-boost\fR
 116 recognize Boost format strings
 117 (only language C++)
 118 .TP
 119 \fB\-\-debug\fR
 120 more detailed formatstring recognition result
 121 .SS "Output details:"
 122 .TP
 123 \fB\-\-color\fR
 124 use colors and other text attributes always
 125 .TP
 126 \fB\-\-color\fR=\fIWHEN\fR
 127 use colors and other text attributes if WHEN.
 128 WHEN may be 'always', 'never', 'auto', or 'html'.
 129 .TP
 130 \fB\-\-style\fR=\fISTYLEFILE\fR
 131 specify CSS style rule file for \fB\-\-color\fR
 132 .TP
 133 \fB\-e\fR, \fB\-\-no\-escape\fR
 134 do not use C escapes in output (default)
 135 .TP
 136 \fB\-E\fR, \fB\-\-escape\fR
 137 use C escapes in output, no extended chars
 138 .TP
 139 \fB\-\-force\-po\fR
 140 write PO file even if empty
 141 .TP
 142 \fB\-i\fR, \fB\-\-indent\fR
 143 write the .po file using indented style
 144 .TP
 145 \fB\-\-no\-location\fR
 146 do not write '#: filename:line' lines
 147 .TP
 148 \fB\-n\fR, \fB\-\-add\-location\fR
 149 generate '#: filename:line' lines (default)
 150 .TP
 151 \fB\-\-strict\fR
 152 write out strict Uniforum conforming .po file
 153 .TP
 154 \fB\-\-properties\-output\fR
 155 write out a Java .properties file
 156 .TP
 157 \fB\-\-stringtable\-output\fR
 158 write out a NeXTstep/GNUstep .strings file
 159 .TP
 160 \fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
 161 set output page width
 162 .TP
 163 \fB\-\-no\-wrap\fR
 164 do not break long message lines, longer than
 165 the output page width, into several lines
 166 .TP
 167 \fB\-s\fR, \fB\-\-sort\-output\fR
 168 generate sorted output
 169 .TP
 170 \fB\-F\fR, \fB\-\-sort\-by\-file\fR
 171 sort output by file location
 172 .TP
 173 \fB\-\-omit\-header\fR
 174 don't write header with 'msgid ""' entry
 175 .TP
 176 \fB\-\-copyright\-holder\fR=\fISTRING\fR
 177 set copyright holder in output
 178 .TP
 179 \fB\-\-foreign\-user\fR
 180 omit FSF copyright in output for foreign user
 181 .TP
 182 \fB\-\-package\-name\fR=\fIPACKAGE\fR
 183 set package name in output
 184 .TP
 185 \fB\-\-package\-version\fR=\fIVERSION\fR
 186 set package version in output
 187 .TP
 188 \fB\-\-msgid\-bugs\-address\fR=\fIEMAIL\fR@ADDRESS
 189 set report address for msgid bugs
 190 .TP
 191 \fB\-m[STRING]\fR, \fB\-\-msgstr\-prefix\fR[=\fISTRING\fR]
 192 use STRING or "" as prefix for msgstr
 193 values
 194 .TP
 195 \fB\-M[STRING]\fR, \fB\-\-msgstr\-suffix\fR[=\fISTRING\fR]
 196 use STRING or "" as suffix for msgstr
 197 values
 198 .SS "Informative output:"
 199 .TP
 200 \fB\-h\fR, \fB\-\-help\fR
 201 display this help and exit
 202 .TP
 203 \fB\-V\fR, \fB\-\-version\fR
 204 output version information and exit
 205 .SH AUTHOR
 206 Written by Ulrich Drepper.
 207 .SH "REPORTING BUGS"
 208 Report bugs to <bug-gnu-gettext@gnu.org>.
 209 .SH COPYRIGHT
 210 Copyright \(co 1995-1998, 2000-2013 Free Software Foundation, Inc.
 211 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
 212 .br
 213 This is free software: you are free to change and redistribute it.
 214 There is NO WARRANTY, to the extent permitted by law.
 215 .SH "SEE ALSO"
 216 The full documentation for
 217 .B xgettext
 218 is maintained as a Texinfo manual.  If the
 219 .B info
 220 and
 221 .B xgettext
 222 programs are properly installed at your site, the command
 223 .IP
 224 .B info xgettext
 225 .PP
 226 should give you access to the complete manual.