Imported Upstream version 0.19.7
[platform/upstream/gettext.git] / gettext-tools / man / msgfmt.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.24.
2 .TH MSGFMT "1" "December 2015" "GNU gettext-tools 0.19.7" GNU
3 .SH NAME
4 msgfmt \- compile message catalog to binary format
5 .SH SYNOPSIS
6 .B msgfmt
7 [\fIOPTION\fR] \fIfilename.po \fR...
8 .SH DESCRIPTION
9 .\" Add any additional description here
10 .PP
11 Generate binary message catalog from textual translation description.
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 filename.po ...
18 input files
19 .TP
20 \fB\-D\fR, \fB\-\-directory\fR=\fIDIRECTORY\fR
21 add DIRECTORY to list for input files search
22 .PP
23 If input file is -, standard input is read.
24 .SS "Operation mode:"
25 .TP
26 \fB\-j\fR, \fB\-\-java\fR
27 Java mode: generate a Java ResourceBundle class
28 .TP
29 \fB\-\-java2\fR
30 like \fB\-\-java\fR, and assume Java2 (JDK 1.2 or higher)
31 .TP
32 \fB\-\-csharp\fR
33 C# mode: generate a .NET .dll file
34 .TP
35 \fB\-\-csharp\-resources\fR
36 C# resources mode: generate a .NET .resources file
37 .TP
38 \fB\-\-tcl\fR
39 Tcl mode: generate a tcl/msgcat .msg file
40 .TP
41 \fB\-\-qt\fR
42 Qt mode: generate a Qt .qm file
43 .TP
44 \fB\-\-desktop\fR
45 Desktop Entry mode: generate a .desktop file
46 .TP
47 \fB\-\-xml\fR
48 XML mode: generate XML file
49 .SS "Output file location:"
50 .TP
51 \fB\-o\fR, \fB\-\-output\-file\fR=\fIFILE\fR
52 write output to specified file
53 .TP
54 \fB\-\-strict\fR
55 enable strict Uniforum mode
56 .PP
57 If output file is -, output is written to standard output.
58 .SS "Output file location in Java mode:"
59 .TP
60 \fB\-r\fR, \fB\-\-resource\fR=\fIRESOURCE\fR
61 resource name
62 .TP
63 \fB\-l\fR, \fB\-\-locale\fR=\fILOCALE\fR
64 locale name, either language or language_COUNTRY
65 .TP
66 \fB\-\-source\fR
67 produce a .java file, instead of a .class file
68 .TP
69 \fB\-d\fR DIRECTORY
70 base directory of classes directory hierarchy
71 .PP
72 The class name is determined by appending the locale name to the resource name,
73 separated with an underscore.  The \fB\-d\fR option is mandatory.  The class is
74 written under the specified directory.
75 .SS "Output file location in C# mode:"
76 .TP
77 \fB\-r\fR, \fB\-\-resource\fR=\fIRESOURCE\fR
78 resource name
79 .TP
80 \fB\-l\fR, \fB\-\-locale\fR=\fILOCALE\fR
81 locale name, either language or language_COUNTRY
82 .TP
83 \fB\-d\fR DIRECTORY
84 base directory for locale dependent .dll files
85 .PP
86 The \fB\-l\fR and \fB\-d\fR options are mandatory.  The .dll file is written in a
87 subdirectory of the specified directory whose name depends on the locale.
88 .SS "Output file location in Tcl mode:"
89 .TP
90 \fB\-l\fR, \fB\-\-locale\fR=\fILOCALE\fR
91 locale name, either language or language_COUNTRY
92 .TP
93 \fB\-d\fR DIRECTORY
94 base directory of .msg message catalogs
95 .PP
96 The \fB\-l\fR and \fB\-d\fR options are mandatory.  The .msg file is written in the
97 specified directory.
98 .SS "Desktop Entry mode options:"
99 .TP
100 \fB\-l\fR, \fB\-\-locale\fR=\fILOCALE\fR
101 locale name, either language or language_COUNTRY
102 .TP
103 \fB\-o\fR, \fB\-\-output\-file\fR=\fIFILE\fR
104 write output to specified file
105 .TP
106 \fB\-\-template\fR=\fITEMPLATE\fR
107 a .desktop file used as a template
108 .TP
109 \fB\-d\fR DIRECTORY
110 base directory of .po files
111 .TP
112 \fB\-kWORD\fR, \fB\-\-keyword\fR=\fIWORD\fR
113 look for WORD as an additional keyword
114 .TP
115 \fB\-k\fR, \fB\-\-keyword\fR
116 do not to use default keywords
117 .PP
118 The \fB\-l\fR, \fB\-o\fR, and \fB\-\-template\fR options are mandatory.  If \fB\-D\fR is specified, input
119 files are read from the directory instead of the command line arguments.
120 .SS "XML mode options:"
121 .TP
122 \fB\-l\fR, \fB\-\-locale\fR=\fILOCALE\fR
123 locale name, either language or language_COUNTRY
124 .TP
125 \fB\-L\fR, \fB\-\-language\fR=\fINAME\fR
126 recognise the specified XML language
127 .TP
128 \fB\-o\fR, \fB\-\-output\-file\fR=\fIFILE\fR
129 write output to specified file
130 .TP
131 \fB\-\-template\fR=\fITEMPLATE\fR
132 an XML file used as a template
133 .TP
134 \fB\-d\fR DIRECTORY
135 base directory of .po files
136 .PP
137 The \fB\-l\fR, \fB\-o\fR, and \fB\-\-template\fR options are mandatory.  If \fB\-D\fR is specified, input
138 files are read from the directory instead of the command line arguments.
139 .SS "Input file syntax:"
140 .TP
141 \fB\-P\fR, \fB\-\-properties\-input\fR
142 input files are in Java .properties syntax
143 .TP
144 \fB\-\-stringtable\-input\fR
145 input files are in NeXTstep/GNUstep .strings
146 syntax
147 .SS "Input file interpretation:"
148 .TP
149 \fB\-c\fR, \fB\-\-check\fR
150 perform all the checks implied by
151 \fB\-\-check\-format\fR, \fB\-\-check\-header\fR, \fB\-\-check\-domain\fR
152 .TP
153 \fB\-\-check\-format\fR
154 check language dependent format strings
155 .TP
156 \fB\-\-check\-header\fR
157 verify presence and contents of the header entry
158 .TP
159 \fB\-\-check\-domain\fR
160 check for conflicts between domain directives
161 and the \fB\-\-output\-file\fR option
162 .TP
163 \fB\-C\fR, \fB\-\-check\-compatibility\fR
164 check that GNU msgfmt behaves like X/Open msgfmt
165 .TP
166 \fB\-\-check\-accelerators\fR[=\fICHAR\fR]
167 check presence of keyboard accelerators for
168 menu items
169 .TP
170 \fB\-f\fR, \fB\-\-use\-fuzzy\fR
171 use fuzzy entries in output
172 .SS "Output details:"
173 .TP
174 \fB\-a\fR, \fB\-\-alignment\fR=\fINUMBER\fR
175 align strings to NUMBER bytes (default: 1)
176 .TP
177 \fB\-\-endianness\fR=\fIBYTEORDER\fR
178 write out 32-bit numbers in the given byte order
179 (big or little, default depends on platform)
180 .TP
181 \fB\-\-no\-hash\fR
182 binary file will not include the hash table
183 .SS "Informative output:"
184 .TP
185 \fB\-h\fR, \fB\-\-help\fR
186 display this help and exit
187 .TP
188 \fB\-V\fR, \fB\-\-version\fR
189 output version information and exit
190 .TP
191 \fB\-\-statistics\fR
192 print statistics about translations
193 .TP
194 \fB\-v\fR, \fB\-\-verbose\fR
195 increase verbosity level
196 .SH AUTHOR
197 Written by Ulrich Drepper.
198 .SH "REPORTING BUGS"
199 Report bugs to <bug-gnu-gettext@gnu.org>.
200 .SH COPYRIGHT
201 Copyright \(co 1995-1998, 2000-2010 Free Software Foundation, Inc.
202 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
203 .br
204 This is free software: you are free to change and redistribute it.
205 There is NO WARRANTY, to the extent permitted by law.
206 .SH "SEE ALSO"
207 The full documentation for
208 .B msgfmt
209 is maintained as a Texinfo manual.  If the
210 .B info
211 and
212 .B msgfmt
213 programs are properly installed at your site, the command
214 .IP
215 .B info msgfmt
216 .PP
217 should give you access to the complete manual.