Imported Upstream version 0.18.1.1
[platform/upstream/gettext.git] / gettext-tools / doc / msguniq.texi
1 @pindex msguniq
2 @cindex @code{msguniq} program, usage
3 @example
4 msguniq [@var{option}] [@var{inputfile}]
5 @end example
6
7 @cindex unify duplicate translations
8 @cindex duplicate removal
9 The @code{msguniq} program unifies duplicate translations in a translation
10 catalog.  It finds duplicate translations of the same message ID.  Such
11 duplicates are invalid input for other programs like @code{msgfmt},
12 @code{msgmerge} or @code{msgcat}.  By default, duplicates are merged
13 together.  When using the @samp{--repeated} option, only duplicates are
14 output, and all other messages are discarded.  Comments and extracted
15 comments will be cumulated, except that if @samp{--use-first} is
16 specified, they will be taken from the first translation.  File positions
17 will be cumulated.  When using the @samp{--unique} option, duplicates are
18 discarded.
19
20 @subsection Input file location
21
22 @table @samp
23 @item @var{inputfile}
24 Input PO file.
25
26 @item -D @var{directory}
27 @itemx --directory=@var{directory}
28 @opindex -D@r{, @code{msguniq} option}
29 @opindex --directory@r{, @code{msguniq} option}
30 Add @var{directory} to the list of directories.  Source files are
31 searched relative to this list of directories.  The resulting @file{.po}
32 file will be written relative to the current directory, though.
33
34 @end table
35
36 If no @var{inputfile} is given or if it is @samp{-}, standard input is read.
37
38 @subsection Output file location
39
40 @table @samp
41 @item -o @var{file}
42 @itemx --output-file=@var{file}
43 @opindex -o@r{, @code{msguniq} option}
44 @opindex --output-file@r{, @code{msguniq} option}
45 Write output to specified file.
46
47 @end table
48
49 The results are written to standard output if no output file is specified
50 or if it is @samp{-}.
51
52 @subsection Message selection
53
54 @table @samp
55 @item -d
56 @itemx --repeated
57 @opindex -d@r{, @code{msguniq} option}
58 @opindex --repeated@r{, @code{msguniq} option}
59 Print only duplicates.
60
61 @item -u
62 @itemx --unique
63 @opindex -u@r{, @code{msguniq} option}
64 @opindex --unique@r{, @code{msguniq} option}
65 Print only unique messages, discard duplicates.
66
67 @end table
68
69 @subsection Input file syntax
70
71 @table @samp
72 @item -P
73 @itemx --properties-input
74 @opindex -P@r{, @code{msguniq} option}
75 @opindex --properties-input@r{, @code{msguniq} option}
76 Assume the input file is a Java ResourceBundle in Java @code{.properties}
77 syntax, not in PO file syntax.
78
79 @item --stringtable-input
80 @opindex --stringtable-input@r{, @code{msguniq} option}
81 Assume the input file is a NeXTstep/GNUstep localized resource file in
82 @code{.strings} syntax, not in PO file syntax.
83
84 @end table
85
86 @subsection Output details
87
88 @c --no-escape and --escape omitted on purpose.  They are not useful.
89
90 @table @samp
91 @item -t
92 @itemx --to-code=@var{name}
93 @opindex -t@r{, @code{msguniq} option}
94 @opindex --to-code@r{, @code{msguniq} option}
95 Specify encoding for output.
96
97 @item --use-first
98 @opindex --use-first@r{, @code{msguniq} option}
99 Use first available translation for each message.  Don't merge several
100 translations into one.
101
102 @item --color
103 @itemx --color=@var{when}
104 @opindex --color@r{, @code{msguniq} option}
105 Specify whether or when to use colors and other text attributes.
106 See @ref{The --color option} for details.
107
108 @item --style=@var{style_file}
109 @opindex --style@r{, @code{msguniq} option}
110 Specify the CSS style rule file to use for @code{--color}.
111 See @ref{The --style option} for details.
112
113 @item --force-po
114 @opindex --force-po@r{, @code{msguniq} option}
115 Always write an output file even if it contains no message.
116
117 @item -i
118 @itemx --indent
119 @opindex -i@r{, @code{msguniq} option}
120 @opindex --indent@r{, @code{msguniq} option}
121 Write the .po file using indented style.
122
123 @item --no-location
124 @opindex --no-location@r{, @code{msguniq} option}
125 Do not write @samp{#: @var{filename}:@var{line}} lines.
126
127 @item -n
128 @itemx --add-location
129 @opindex -n@r{, @code{msguniq} option}
130 @opindex --add-location@r{, @code{msguniq} option}
131 Generate @samp{#: @var{filename}:@var{line}} lines (default).
132
133 @item --strict
134 @opindex --strict@r{, @code{msguniq} option}
135 Write out a strict Uniforum conforming PO file.  Note that this
136 Uniforum format should be avoided because it doesn't support the
137 GNU extensions.
138
139 @item -p
140 @itemx --properties-output
141 @opindex -p@r{, @code{msguniq} option}
142 @opindex --properties-output@r{, @code{msguniq} option}
143 Write out a Java ResourceBundle in Java @code{.properties} syntax.  Note
144 that this file format doesn't support plural forms and silently drops
145 obsolete messages.
146
147 @item --stringtable-output
148 @opindex --stringtable-output@r{, @code{msguniq} option}
149 Write out a NeXTstep/GNUstep localized resource file in @code{.strings} syntax.
150 Note that this file format doesn't support plural forms.
151
152 @item -w @var{number}
153 @itemx --width=@var{number}
154 @opindex -w@r{, @code{msguniq} option}
155 @opindex --width@r{, @code{msguniq} option}
156 Set the output page width.  Long strings in the output files will be
157 split across multiple lines in order to ensure that each line's width
158 (= number of screen columns) is less or equal to the given @var{number}.
159
160 @item --no-wrap
161 @opindex --no-wrap@r{, @code{msguniq} option}
162 Do not break long message lines.  Message lines whose width exceeds the
163 output page width will not be split into several lines.  Only file reference
164 lines which are wider than the output page width will be split.
165
166 @item -s
167 @itemx --sort-output
168 @opindex -s@r{, @code{msguniq} option}
169 @opindex --sort-output@r{, @code{msguniq} option}
170 Generate sorted output.  Note that using this option makes it much harder
171 for the translator to understand each message's context.
172
173 @item -F
174 @itemx --sort-by-file
175 @opindex -F@r{, @code{msguniq} option}
176 @opindex --sort-by-file@r{, @code{msguniq} option}
177 Sort output by file location.
178
179 @end table
180
181 @subsection Informative output
182
183 @table @samp
184 @item -h
185 @itemx --help
186 @opindex -h@r{, @code{msguniq} option}
187 @opindex --help@r{, @code{msguniq} option}
188 Display this help and exit.
189
190 @item -V
191 @itemx --version
192 @opindex -V@r{, @code{msguniq} option}
193 @opindex --version@r{, @code{msguniq} option}
194 Output version information and exit.
195
196 @end table