release/src/router/gettext/gettext-tools/doc/msgattrib.texi

   1 @pindex msgattrib
   2 @cindex @code{msgattrib} program, usage
   3 @example
   4 msgattrib [@var{option}] [@var{inputfile}]
   5 @end example
   6
   7 @cindex filter messages according to attributes
   8 @cindex attribute manipulation
   9 The @code{msgattrib} program filters the messages of a translation catalog
  10 according to their attributes, and manipulates the attributes.
  11
  12 @subsection Input file location
  13
  14 @table @samp
  15 @item @var{inputfile}
  16 Input PO file.
  17
  18 @item -D @var{directory}
  19 @itemx --directory=@var{directory}
  20 @opindex -D@r{, @code{msgattrib} option}
  21 @opindex --directory@r{, @code{msgattrib} option}
  22 Add @var{directory} to the list of directories.  Source files are
  23 searched relative to this list of directories.  The resulting @file{.po}
  24 file will be written relative to the current directory, though.
  25
  26 @end table
  27
  28 If no @var{inputfile} is given or if it is @samp{-}, standard input is read.
  29
  30 @subsection Output file location
  31
  32 @table @samp
  33 @item -o @var{file}
  34 @itemx --output-file=@var{file}
  35 @opindex -o@r{, @code{msgattrib} option}
  36 @opindex --output-file@r{, @code{msgattrib} option}
  37 Write output to specified file.
  38
  39 @end table
  40
  41 The results are written to standard output if no output file is specified
  42 or if it is @samp{-}.
  43
  44 @subsection Message selection
  45
  46 @table @samp
  47 @item --translated
  48 @opindex --translated@r{, @code{msgattrib} option}
  49 Keep translated messages, remove untranslated messages.
  50
  51 @item --untranslated
  52 @opindex --untranslated@r{, @code{msgattrib} option}
  53 Keep untranslated messages, remove translated messages.
  54
  55 @item --no-fuzzy
  56 @opindex --no-fuzzy@r{, @code{msgattrib} option}
  57 Remove `fuzzy' marked messages.
  58
  59 @item --only-fuzzy
  60 @opindex --only-fuzzy@r{, @code{msgattrib} option}
  61 Keep `fuzzy' marked messages, remove all other messsages.
  62
  63 @item --no-obsolete
  64 @opindex --no-obsolete@r{, @code{msgattrib} option}
  65 Remove obsolete #~ messages.
  66
  67 @item --only-obsolete
  68 @opindex --only-obsolete@r{, @code{msgattrib} option}
  69 Keep obsolete #~ messages, remove all other messages.
  70
  71 @end table
  72
  73 @subsection Attribute manipulation
  74
  75 @cindex modify message attrributes
  76 Attributes are modified after the message selection/removal has been
  77 performed.  If the @samp{--only-file} or @samp{--ignore-file} option is
  78 specified, the attribute modification is applied only to those messages
  79 that are listed in the @var{only-file} and not listed in the
  80 @var{ignore-file}.
  81
  82 @table @samp
  83 @item --set-fuzzy
  84 @opindex --set-fuzzy@r{, @code{msgattrib} option}
  85 Set all messages `fuzzy'.
  86
  87 @item --clear-fuzzy
  88 @opindex --clear-fuzzy@r{, @code{msgattrib} option}
  89 Set all messages non-`fuzzy'.
  90
  91 @item --set-obsolete
  92 @opindex --set-obsolete@r{, @code{msgattrib} option}
  93 Set all messages obsolete.
  94
  95 @item --clear-obsolete
  96 @opindex --clear-obsolete@r{, @code{msgattrib} option}
  97 Set all messages non-obsolete.
  98
  99 @item --only-file=@var{file}
 100 @opindex --only-file@r{, @code{msgattrib} option}
 101 Limit the attribute changes to entries that are listed in @var{file}.
 102 @var{file} should be a PO or POT file.
 103
 104 @item --ignore-file=@var{file}
 105 @opindex --ignore-file@r{, @code{msgattrib} option}
 106 Limit the attribute changes to entries that are not listed in @var{file}.
 107 @var{file} should be a PO or POT file.
 108
 109 @item --fuzzy
 110 @opindex --fuzzy@r{, @code{msgattrib} option}
 111 Synonym for @samp{--only-fuzzy --clear-fuzzy}: It keeps only the fuzzy
 112 messages and removes their `fuzzy' mark.
 113
 114 @item --obsolete
 115 @opindex --obsolete@r{, @code{msgattrib} option}
 116 Synonym for @samp{--only-obsolete --clear-obsolete}: It keeps only the
 117 obsolete messages and makes them non-obsolete.
 118
 119 @end table
 120
 121 @subsection Input file syntax
 122
 123 @table @samp
 124 @item -P
 125 @itemx --properties-input
 126 @opindex -P@r{, @code{msgattrib} option}
 127 @opindex --properties-input@r{, @code{msgattrib} option}
 128 Assume the input file is a Java ResourceBundle in Java @code{.properties}
 129 syntax, not in PO file syntax.
 130
 131 @item --stringtable-input
 132 @opindex --stringtable-input@r{, @code{msgattrib} option}
 133 Assume the input file is a NeXTstep/GNUstep localized resource file in
 134 @code{.strings} syntax, not in PO file syntax.
 135
 136 @end table
 137
 138 @subsection Output details
 139
 140 @c --no-escape and --escape omitted on purpose.  They are not useful.
 141
 142 @table @samp
 143 @item --force-po
 144 @opindex --force-po@r{, @code{msgattrib} option}
 145 Always write an output file even if it contains no message.
 146
 147 @item -i
 148 @itemx --indent
 149 @opindex -i@r{, @code{msgattrib} option}
 150 @opindex --indent@r{, @code{msgattrib} option}
 151 Write the .po file using indented style.
 152
 153 @item --no-location
 154 @opindex --no-location@r{, @code{msgattrib} option}
 155 Do not write @samp{#: @var{filename}:@var{line}} lines.
 156
 157 @item -n
 158 @itemx --add-location
 159 @opindex -n@r{, @code{msgattrib} option}
 160 @opindex --add-location@r{, @code{msgattrib} option}
 161 Generate @samp{#: @var{filename}:@var{line}} lines (default).
 162
 163 @item --strict
 164 @opindex --strict@r{, @code{msgattrib} option}
 165 Write out a strict Uniforum conforming PO file.  Note that this
 166 Uniforum format should be avoided because it doesn't support the
 167 GNU extensions.
 168
 169 @item -p
 170 @itemx --properties-output
 171 @opindex -p@r{, @code{msgattrib} option}
 172 @opindex --properties-output@r{, @code{msgattrib} option}
 173 Write out a Java ResourceBundle in Java @code{.properties} syntax.  Note
 174 that this file format doesn't support plural forms and silently drops
 175 obsolete messages.
 176
 177 @item --stringtable-output
 178 @opindex --stringtable-output@r{, @code{msgattrib} option}
 179 Write out a NeXTstep/GNUstep localized resource file in @code{.strings} syntax.
 180 Note that this file format doesn't support plural forms.
 181
 182 @item -w @var{number}
 183 @itemx --width=@var{number}
 184 @opindex -w@r{, @code{msgattrib} option}
 185 @opindex --width@r{, @code{msgattrib} option}
 186 Set the output page width.  Long strings in the output files will be
 187 split across multiple lines in order to ensure that each line's width
 188 (= number of screen columns) is less or equal to the given @var{number}.
 189
 190 @item --no-wrap
 191 @opindex --no-wrap@r{, @code{msgattrib} option}
 192 Do not break long message lines.  Message lines whose width exceeds the
 193 output page width will not be split into several lines.  Only file reference
 194 lines which are wider than the output page width will be split.
 195
 196 @item -s
 197 @itemx --sort-output
 198 @opindex -s@r{, @code{msgattrib} option}
 199 @opindex --sort-output@r{, @code{msgattrib} option}
 200 Generate sorted output.  Note that using this option makes it much harder
 201 for the translator to understand each message's context.
 202
 203 @item -F
 204 @itemx --sort-by-file
 205 @opindex -F@r{, @code{msgattrib} option}
 206 @opindex --sort-by-file@r{, @code{msgattrib} option}
 207 Sort output by file location.
 208
 209 @end table
 210
 211 @subsection Informative output
 212
 213 @table @samp
 214 @item -h
 215 @itemx --help
 216 @opindex -h@r{, @code{msgattrib} option}
 217 @opindex --help@r{, @code{msgattrib} option}
 218 Display this help and exit.
 219
 220 @item -V
 221 @itemx --version
 222 @opindex -V@r{, @code{msgattrib} option}
 223 @opindex --version@r{, @code{msgattrib} option}
 224 Output version information and exit.
 225
 226 @end table