Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man1/xgettext.1 @ 68:5028fdace37b

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