1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
|
<HTML>
<HEAD>
<!-- This HTML file has been created by texi2html 1.52b
from gettext.texi on 11 June 2016 -->
<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
<TITLE>GNU gettext utilities - 10 Producing Binary MO Files</TITLE>
</HEAD>
<BODY>
Go to the <A HREF="gettext_1.html">first</A>, <A HREF="gettext_9.html">previous</A>, <A HREF="gettext_11.html">next</A>, <A HREF="gettext_25.html">last</A> section, <A HREF="gettext_toc.html">table of contents</A>.
<P><HR><P>
<H1><A NAME="SEC156" HREF="gettext_toc.html#TOC156">10 Producing Binary MO Files</A></H1>
<H2><A NAME="SEC157" HREF="gettext_toc.html#TOC157">10.1 Invoking the <CODE>msgfmt</CODE> Program</A></H2>
<P>
<A NAME="IDX975"></A>
<A NAME="IDX976"></A>
<PRE>
msgfmt [<VAR>option</VAR>] <VAR>filename</VAR>.po ...
</PRE>
<P>
<A NAME="IDX977"></A>
The <CODE>msgfmt</CODE> programs generates a binary message catalog from a textual
translation description.
</P>
<H3><A NAME="SEC158" HREF="gettext_toc.html#TOC158">10.1.1 Input file location</A></H3>
<DL COMPACT>
<DT><SAMP>‘<VAR>filename</VAR>.po ...’</SAMP>
<DD>
<DT><SAMP>‘-D <VAR>directory</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--directory=<VAR>directory</VAR>’</SAMP>
<DD>
<A NAME="IDX978"></A>
<A NAME="IDX979"></A>
Add <VAR>directory</VAR> to the list of directories. Source files are
searched relative to this list of directories. The resulting binary
file will be written relative to the current directory, though.
</DL>
<P>
If an input file is <SAMP>‘-’</SAMP>, standard input is read.
</P>
<H3><A NAME="SEC159" HREF="gettext_toc.html#TOC159">10.1.2 Operation mode</A></H3>
<DL COMPACT>
<DT><SAMP>‘-j’</SAMP>
<DD>
<DT><SAMP>‘--java’</SAMP>
<DD>
<A NAME="IDX980"></A>
<A NAME="IDX981"></A>
<A NAME="IDX982"></A>
Java mode: generate a Java <CODE>ResourceBundle</CODE> class.
<DT><SAMP>‘--java2’</SAMP>
<DD>
<A NAME="IDX983"></A>
Like --java, and assume Java2 (JDK 1.2 or higher).
<DT><SAMP>‘--csharp’</SAMP>
<DD>
<A NAME="IDX984"></A>
<A NAME="IDX985"></A>
C# mode: generate a .NET .dll file containing a subclass of
<CODE>GettextResourceSet</CODE>.
<DT><SAMP>‘--csharp-resources’</SAMP>
<DD>
<A NAME="IDX986"></A>
<A NAME="IDX987"></A>
C# resources mode: generate a .NET <TT>‘.resources’</TT> file.
<DT><SAMP>‘--tcl’</SAMP>
<DD>
<A NAME="IDX988"></A>
<A NAME="IDX989"></A>
Tcl mode: generate a tcl/msgcat <TT>‘.msg’</TT> file.
<DT><SAMP>‘--qt’</SAMP>
<DD>
<A NAME="IDX990"></A>
<A NAME="IDX991"></A>
Qt mode: generate a Qt <TT>‘.qm’</TT> file.
<DT><SAMP>‘--desktop’</SAMP>
<DD>
<A NAME="IDX992"></A>
<A NAME="IDX993"></A>
Desktop Entry mode: generate a <TT>‘.desktop’</TT> file.
<DT><SAMP>‘--xml’</SAMP>
<DD>
<A NAME="IDX994"></A>
<A NAME="IDX995"></A>
XML mode: generate an XML file.
</DL>
<H3><A NAME="SEC160" HREF="gettext_toc.html#TOC160">10.1.3 Output file location</A></H3>
<DL COMPACT>
<DT><SAMP>‘-o <VAR>file</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--output-file=<VAR>file</VAR>’</SAMP>
<DD>
<A NAME="IDX996"></A>
<A NAME="IDX997"></A>
Write output to specified file.
<DT><SAMP>‘--strict’</SAMP>
<DD>
<A NAME="IDX998"></A>
Direct the program to work strictly following the Uniforum/Sun
implementation. Currently this only affects the naming of the output
file. If this option is not given the name of the output file is the
same as the domain name. If the strict Uniforum mode is enabled the
suffix <TT>‘.mo’</TT> is added to the file name if it is not already
present.
We find this behaviour of Sun's implementation rather silly and so by
default this mode is <EM>not</EM> selected.
</DL>
<P>
If the output <VAR>file</VAR> is <SAMP>‘-’</SAMP>, output is written to standard output.
</P>
<H3><A NAME="SEC161" HREF="gettext_toc.html#TOC161">10.1.4 Output file location in Java mode</A></H3>
<DL COMPACT>
<DT><SAMP>‘-r <VAR>resource</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--resource=<VAR>resource</VAR>’</SAMP>
<DD>
<A NAME="IDX999"></A>
<A NAME="IDX1000"></A>
Specify the resource name.
<DT><SAMP>‘-l <VAR>locale</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--locale=<VAR>locale</VAR>’</SAMP>
<DD>
<A NAME="IDX1001"></A>
<A NAME="IDX1002"></A>
Specify the locale name, either a language specification of the form <VAR>ll</VAR>
or a combined language and country specification of the form <VAR>ll_CC</VAR>.
<DT><SAMP>‘-d <VAR>directory</VAR>’</SAMP>
<DD>
<A NAME="IDX1003"></A>
Specify the base directory of classes directory hierarchy.
<DT><SAMP>‘--source’</SAMP>
<DD>
<A NAME="IDX1004"></A>
Produce a .java source file, instead of a compiled .class file.
</DL>
<P>
The class name is determined by appending the locale name to the resource name,
separated with an underscore. The <SAMP>‘-d’</SAMP> option is mandatory. The class
is written under the specified directory.
</P>
<H3><A NAME="SEC162" HREF="gettext_toc.html#TOC162">10.1.5 Output file location in C# mode</A></H3>
<DL COMPACT>
<DT><SAMP>‘-r <VAR>resource</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--resource=<VAR>resource</VAR>’</SAMP>
<DD>
<A NAME="IDX1005"></A>
<A NAME="IDX1006"></A>
Specify the resource name.
<DT><SAMP>‘-l <VAR>locale</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--locale=<VAR>locale</VAR>’</SAMP>
<DD>
<A NAME="IDX1007"></A>
<A NAME="IDX1008"></A>
Specify the locale name, either a language specification of the form <VAR>ll</VAR>
or a combined language and country specification of the form <VAR>ll_CC</VAR>.
<DT><SAMP>‘-d <VAR>directory</VAR>’</SAMP>
<DD>
<A NAME="IDX1009"></A>
Specify the base directory for locale dependent <TT>‘.dll’</TT> files.
</DL>
<P>
The <SAMP>‘-l’</SAMP> and <SAMP>‘-d’</SAMP> options are mandatory. The <TT>‘.dll’</TT> file is
written in a subdirectory of the specified directory whose name depends on the
locale.
</P>
<H3><A NAME="SEC163" HREF="gettext_toc.html#TOC163">10.1.6 Output file location in Tcl mode</A></H3>
<DL COMPACT>
<DT><SAMP>‘-l <VAR>locale</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--locale=<VAR>locale</VAR>’</SAMP>
<DD>
<A NAME="IDX1010"></A>
<A NAME="IDX1011"></A>
Specify the locale name, either a language specification of the form <VAR>ll</VAR>
or a combined language and country specification of the form <VAR>ll_CC</VAR>.
<DT><SAMP>‘-d <VAR>directory</VAR>’</SAMP>
<DD>
<A NAME="IDX1012"></A>
Specify the base directory of <TT>‘.msg’</TT> message catalogs.
</DL>
<P>
The <SAMP>‘-l’</SAMP> and <SAMP>‘-d’</SAMP> options are mandatory. The <TT>‘.msg’</TT> file is
written in the specified directory.
</P>
<H3><A NAME="SEC164" HREF="gettext_toc.html#TOC164">10.1.7 Desktop Entry mode operations</A></H3>
<DL COMPACT>
<DT><SAMP>‘--template=<VAR>template</VAR>’</SAMP>
<DD>
<A NAME="IDX1013"></A>
Specify a .desktop file used as a template.
<DT><SAMP>‘-k[<VAR>keywordspec</VAR>]’</SAMP>
<DD>
<DT><SAMP>‘--keyword[=<VAR>keywordspec</VAR>]’</SAMP>
<DD>
<A NAME="IDX1014"></A>
<A NAME="IDX1015"></A>
Specify <VAR>keywordspec</VAR> as an additional keyword to be looked for.
Without a <VAR>keywordspec</VAR>, the option means to not use default keywords.
<DT><SAMP>‘-l <VAR>locale</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--locale=<VAR>locale</VAR>’</SAMP>
<DD>
<A NAME="IDX1016"></A>
<A NAME="IDX1017"></A>
Specify the locale name, either a language specification of the form <VAR>ll</VAR>
or a combined language and country specification of the form <VAR>ll_CC</VAR>.
<DT><SAMP>‘-d <VAR>directory</VAR>’</SAMP>
<DD>
<A NAME="IDX1018"></A>
Specify the directory where PO files are read. The directory must
contain the <SAMP>‘LINGUAS’</SAMP> file.
</DL>
<P>
To generate a <SAMP>‘.desktop’</SAMP> file for a single locale, you can use it
as follows.
</P>
<PRE>
msgfmt --desktop --template=<VAR>template</VAR> --locale=<VAR>locale</VAR> \
-o <VAR>file</VAR> <VAR>filename</VAR>.po ...
</PRE>
<P>
msgfmt provides a special "bulk" operation mode to process multiple
<TT>‘.po’</TT> files at a time.
</P>
<PRE>
msgfmt --desktop --template=<VAR>template</VAR> -d <VAR>directory</VAR> -o <VAR>file</VAR>
</PRE>
<P>
msgfmt first reads the <SAMP>‘LINGUAS’</SAMP> file under <VAR>directory</VAR>, and
then processes all <SAMP>‘.po’</SAMP> files listed there. You can also limit
the locales to a subset, through the <SAMP>‘LINGUAS’</SAMP> environment
variable.
</P>
<P>
For either operation modes, the <SAMP>‘-o’</SAMP> and <SAMP>‘--template’</SAMP>
options are mandatory.
</P>
<H3><A NAME="SEC165" HREF="gettext_toc.html#TOC165">10.1.8 XML mode operations</A></H3>
<DL COMPACT>
<DT><SAMP>‘--template=<VAR>template</VAR>’</SAMP>
<DD>
<A NAME="IDX1019"></A>
Specify an XML file used as a template.
<DT><SAMP>‘-L <VAR>name</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--language=<VAR>name</VAR>’</SAMP>
<DD>
<A NAME="IDX1020"></A>
<A NAME="IDX1021"></A>
<A NAME="IDX1022"></A>
Specifies the language of the input files.
<DT><SAMP>‘-l <VAR>locale</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--locale=<VAR>locale</VAR>’</SAMP>
<DD>
<A NAME="IDX1023"></A>
<A NAME="IDX1024"></A>
Specify the locale name, either a language specification of the form <VAR>ll</VAR>
or a combined language and country specification of the form <VAR>ll_CC</VAR>.
<DT><SAMP>‘-d <VAR>directory</VAR>’</SAMP>
<DD>
<A NAME="IDX1025"></A>
Specify the base directory of <TT>‘.po’</TT> message catalogs.
</DL>
<P>
To generate an XML file for a single locale, you can use it as follows.
</P>
<PRE>
msgfmt --xml --template=<VAR>template</VAR> --locale=<VAR>locale</VAR> \
-o <VAR>file</VAR> <VAR>filename</VAR>.po ...
</PRE>
<P>
msgfmt provides a special "bulk" operation mode to process multiple
<TT>‘.po’</TT> files at a time.
</P>
<PRE>
msgfmt --xml --template=<VAR>template</VAR> -d <VAR>directory</VAR> -o <VAR>file</VAR>
</PRE>
<P>
msgfmt first reads the <SAMP>‘LINGUAS’</SAMP> file under <VAR>directory</VAR>, and
then processes all <SAMP>‘.po’</SAMP> files listed there. You can also limit
the locales to a subset, through the <SAMP>‘LINGUAS’</SAMP> environment
variable.
</P>
<P>
For either operation modes, the <SAMP>‘-o’</SAMP> and <SAMP>‘--template’</SAMP>
options are mandatory.
</P>
<H3><A NAME="SEC166" HREF="gettext_toc.html#TOC166">10.1.9 Input file syntax</A></H3>
<DL COMPACT>
<DT><SAMP>‘-P’</SAMP>
<DD>
<DT><SAMP>‘--properties-input’</SAMP>
<DD>
<A NAME="IDX1026"></A>
<A NAME="IDX1027"></A>
Assume the input files are Java ResourceBundles in Java <CODE>.properties</CODE>
syntax, not in PO file syntax.
<DT><SAMP>‘--stringtable-input’</SAMP>
<DD>
<A NAME="IDX1028"></A>
Assume the input files are NeXTstep/GNUstep localized resource files in
<CODE>.strings</CODE> syntax, not in PO file syntax.
</DL>
<H3><A NAME="SEC167" HREF="gettext_toc.html#TOC167">10.1.10 Input file interpretation</A></H3>
<DL COMPACT>
<DT><SAMP>‘-c’</SAMP>
<DD>
<DT><SAMP>‘--check’</SAMP>
<DD>
<A NAME="IDX1029"></A>
<A NAME="IDX1030"></A>
Perform all the checks implied by <CODE>--check-format</CODE>, <CODE>--check-header</CODE>,
<CODE>--check-domain</CODE>.
<DT><SAMP>‘--check-format’</SAMP>
<DD>
<A NAME="IDX1031"></A>
<A NAME="IDX1032"></A>
Check language dependent format strings.
If the string represents a format string used in a
<CODE>printf</CODE>-like function both strings should have the same number of
<SAMP>‘%’</SAMP> format specifiers, with matching types. If the flag
<CODE>c-format</CODE> or <CODE>possible-c-format</CODE> appears in the special
comment <KBD>#,</KBD> for this entry a check is performed. For example, the
check will diagnose using <SAMP>‘%.*s’</SAMP> against <SAMP>‘%s’</SAMP>, or <SAMP>‘%d’</SAMP>
against <SAMP>‘%s’</SAMP>, or <SAMP>‘%d’</SAMP> against <SAMP>‘%x’</SAMP>. It can even handle
positional parameters.
Normally the <CODE>xgettext</CODE> program automatically decides whether a
string is a format string or not. This algorithm is not perfect,
though. It might regard a string as a format string though it is not
used in a <CODE>printf</CODE>-like function and so <CODE>msgfmt</CODE> might report
errors where there are none.
To solve this problem the programmer can dictate the decision to the
<CODE>xgettext</CODE> program (see section <A HREF="gettext_15.html#SEC252">15.3.1 C Format Strings</A>). The translator should not
consider removing the flag from the <KBD>#,</KBD> line. This "fix" would be
reversed again as soon as <CODE>msgmerge</CODE> is called the next time.
<DT><SAMP>‘--check-header’</SAMP>
<DD>
<A NAME="IDX1033"></A>
Verify presence and contents of the header entry. See section <A HREF="gettext_6.html#SEC44">6.2 Filling in the Header Entry</A>,
for a description of the various fields in the header entry.
<DT><SAMP>‘--check-domain’</SAMP>
<DD>
<A NAME="IDX1034"></A>
Check for conflicts between domain directives and the <CODE>--output-file</CODE>
option
<DT><SAMP>‘-C’</SAMP>
<DD>
<DT><SAMP>‘--check-compatibility’</SAMP>
<DD>
<A NAME="IDX1035"></A>
<A NAME="IDX1036"></A>
<A NAME="IDX1037"></A>
Check that GNU msgfmt behaves like X/Open msgfmt. This will give an error
when attempting to use the GNU extensions.
<DT><SAMP>‘--check-accelerators[=<VAR>char</VAR>]’</SAMP>
<DD>
<A NAME="IDX1038"></A>
<A NAME="IDX1039"></A>
<A NAME="IDX1040"></A>
<A NAME="IDX1041"></A>
Check presence of keyboard accelerators for menu items. This is based on
the convention used in some GUIs that a keyboard accelerator in a menu
item string is designated by an immediately preceding <SAMP>‘&’</SAMP> character.
Sometimes a keyboard accelerator is also called "keyboard mnemonic".
This check verifies that if the untranslated string has exactly one
<SAMP>‘&’</SAMP> character, the translated string has exactly one <SAMP>‘&’</SAMP> as well.
If this option is given with a <VAR>char</VAR> argument, this <VAR>char</VAR> should
be a non-alphanumeric character and is used as keyboard accelerator mark
instead of <SAMP>‘&’</SAMP>.
<DT><SAMP>‘-f’</SAMP>
<DD>
<DT><SAMP>‘--use-fuzzy’</SAMP>
<DD>
<A NAME="IDX1042"></A>
<A NAME="IDX1043"></A>
<A NAME="IDX1044"></A>
Use fuzzy entries in output. Note that using this option is usually wrong,
because fuzzy messages are exactly those which have not been validated by
a human translator.
</DL>
<H3><A NAME="SEC168" HREF="gettext_toc.html#TOC168">10.1.11 Output details</A></H3>
<DL COMPACT>
<DT><SAMP>‘-a <VAR>number</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--alignment=<VAR>number</VAR>’</SAMP>
<DD>
<A NAME="IDX1045"></A>
<A NAME="IDX1046"></A>
Align strings to <VAR>number</VAR> bytes (default: 1).
<DT><SAMP>‘--endianness=<VAR>byteorder</VAR>’</SAMP>
<DD>
<A NAME="IDX1047"></A>
Write out 32-bit numbers in the given byte order. The possible values are
<CODE>big</CODE> and <CODE>little</CODE>. The default is <CODE>little</CODE>.
MO files of any endianness can be used on any platform. When a MO file has
an endianness other than the platform's one, the 32-bit numbers from the MO
file are swapped at runtime. The performance impact is negligible.
This option can be useful to produce MO files that are optimized for one
platform.
<DT><SAMP>‘--no-hash’</SAMP>
<DD>
<A NAME="IDX1048"></A>
Don't include a hash table in the binary file. Lookup will be more expensive
at run time (binary search instead of hash table lookup).
</DL>
<H3><A NAME="SEC169" HREF="gettext_toc.html#TOC169">10.1.12 Informative output</A></H3>
<DL COMPACT>
<DT><SAMP>‘-h’</SAMP>
<DD>
<DT><SAMP>‘--help’</SAMP>
<DD>
<A NAME="IDX1049"></A>
<A NAME="IDX1050"></A>
Display this help and exit.
<DT><SAMP>‘-V’</SAMP>
<DD>
<DT><SAMP>‘--version’</SAMP>
<DD>
<A NAME="IDX1051"></A>
<A NAME="IDX1052"></A>
Output version information and exit.
<DT><SAMP>‘--statistics’</SAMP>
<DD>
<A NAME="IDX1053"></A>
Print statistics about translations. When the option <CODE>--verbose</CODE> is used
in combination with <CODE>--statistics</CODE>, the input file name is printed in
front of the statistics line.
<DT><SAMP>‘-v’</SAMP>
<DD>
<DT><SAMP>‘--verbose’</SAMP>
<DD>
<A NAME="IDX1054"></A>
<A NAME="IDX1055"></A>
Increase verbosity level.
</DL>
<H2><A NAME="SEC170" HREF="gettext_toc.html#TOC170">10.2 Invoking the <CODE>msgunfmt</CODE> Program</A></H2>
<P>
<A NAME="IDX1056"></A>
<A NAME="IDX1057"></A>
<PRE>
msgunfmt [<VAR>option</VAR>] [<VAR>file</VAR>]...
</PRE>
<P>
<A NAME="IDX1058"></A>
The <CODE>msgunfmt</CODE> program converts a binary message catalog to a
Uniforum style .po file.
</P>
<H3><A NAME="SEC171" HREF="gettext_toc.html#TOC171">10.2.1 Operation mode</A></H3>
<DL COMPACT>
<DT><SAMP>‘-j’</SAMP>
<DD>
<DT><SAMP>‘--java’</SAMP>
<DD>
<A NAME="IDX1059"></A>
<A NAME="IDX1060"></A>
<A NAME="IDX1061"></A>
Java mode: input is a Java <CODE>ResourceBundle</CODE> class.
<DT><SAMP>‘--csharp’</SAMP>
<DD>
<A NAME="IDX1062"></A>
<A NAME="IDX1063"></A>
C# mode: input is a .NET .dll file containing a subclass of
<CODE>GettextResourceSet</CODE>.
<DT><SAMP>‘--csharp-resources’</SAMP>
<DD>
<A NAME="IDX1064"></A>
<A NAME="IDX1065"></A>
C# resources mode: input is a .NET <TT>‘.resources’</TT> file.
<DT><SAMP>‘--tcl’</SAMP>
<DD>
<A NAME="IDX1066"></A>
<A NAME="IDX1067"></A>
Tcl mode: input is a tcl/msgcat <TT>‘.msg’</TT> file.
</DL>
<H3><A NAME="SEC172" HREF="gettext_toc.html#TOC172">10.2.2 Input file location</A></H3>
<DL COMPACT>
<DT><SAMP>‘<VAR>file</VAR> ...’</SAMP>
<DD>
Input .mo files.
</DL>
<P>
If no input <VAR>file</VAR> is given or if it is <SAMP>‘-’</SAMP>, standard input is read.
</P>
<H3><A NAME="SEC173" HREF="gettext_toc.html#TOC173">10.2.3 Input file location in Java mode</A></H3>
<DL COMPACT>
<DT><SAMP>‘-r <VAR>resource</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--resource=<VAR>resource</VAR>’</SAMP>
<DD>
<A NAME="IDX1068"></A>
<A NAME="IDX1069"></A>
Specify the resource name.
<DT><SAMP>‘-l <VAR>locale</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--locale=<VAR>locale</VAR>’</SAMP>
<DD>
<A NAME="IDX1070"></A>
<A NAME="IDX1071"></A>
Specify the locale name, either a language specification of the form <VAR>ll</VAR>
or a combined language and country specification of the form <VAR>ll_CC</VAR>.
</DL>
<P>
The class name is determined by appending the locale name to the resource name,
separated with an underscore. The class is located using the <CODE>CLASSPATH</CODE>.
</P>
<H3><A NAME="SEC174" HREF="gettext_toc.html#TOC174">10.2.4 Input file location in C# mode</A></H3>
<DL COMPACT>
<DT><SAMP>‘-r <VAR>resource</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--resource=<VAR>resource</VAR>’</SAMP>
<DD>
<A NAME="IDX1072"></A>
<A NAME="IDX1073"></A>
Specify the resource name.
<DT><SAMP>‘-l <VAR>locale</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--locale=<VAR>locale</VAR>’</SAMP>
<DD>
<A NAME="IDX1074"></A>
<A NAME="IDX1075"></A>
Specify the locale name, either a language specification of the form <VAR>ll</VAR>
or a combined language and country specification of the form <VAR>ll_CC</VAR>.
<DT><SAMP>‘-d <VAR>directory</VAR>’</SAMP>
<DD>
<A NAME="IDX1076"></A>
Specify the base directory for locale dependent <TT>‘.dll’</TT> files.
</DL>
<P>
The <SAMP>‘-l’</SAMP> and <SAMP>‘-d’</SAMP> options are mandatory. The <TT>‘.msg’</TT> file is
located in a subdirectory of the specified directory whose name depends on the
locale.
</P>
<H3><A NAME="SEC175" HREF="gettext_toc.html#TOC175">10.2.5 Input file location in Tcl mode</A></H3>
<DL COMPACT>
<DT><SAMP>‘-l <VAR>locale</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--locale=<VAR>locale</VAR>’</SAMP>
<DD>
<A NAME="IDX1077"></A>
<A NAME="IDX1078"></A>
Specify the locale name, either a language specification of the form <VAR>ll</VAR>
or a combined language and country specification of the form <VAR>ll_CC</VAR>.
<DT><SAMP>‘-d <VAR>directory</VAR>’</SAMP>
<DD>
<A NAME="IDX1079"></A>
Specify the base directory of <TT>‘.msg’</TT> message catalogs.
</DL>
<P>
The <SAMP>‘-l’</SAMP> and <SAMP>‘-d’</SAMP> options are mandatory. The <TT>‘.msg’</TT> file is
located in the specified directory.
</P>
<H3><A NAME="SEC176" HREF="gettext_toc.html#TOC176">10.2.6 Output file location</A></H3>
<DL COMPACT>
<DT><SAMP>‘-o <VAR>file</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--output-file=<VAR>file</VAR>’</SAMP>
<DD>
<A NAME="IDX1080"></A>
<A NAME="IDX1081"></A>
Write output to specified file.
</DL>
<P>
The results are written to standard output if no output file is specified
or if it is <SAMP>‘-’</SAMP>.
</P>
<H3><A NAME="SEC177" HREF="gettext_toc.html#TOC177">10.2.7 Output details</A></H3>
<DL COMPACT>
<DT><SAMP>‘--color’</SAMP>
<DD>
<DT><SAMP>‘--color=<VAR>when</VAR>’</SAMP>
<DD>
<A NAME="IDX1082"></A>
Specify whether or when to use colors and other text attributes.
See section <A HREF="gettext_9.html#SEC150">9.11.1 The <CODE>--color</CODE> option</A> for details.
<DT><SAMP>‘--style=<VAR>style_file</VAR>’</SAMP>
<DD>
<A NAME="IDX1083"></A>
Specify the CSS style rule file to use for <CODE>--color</CODE>.
See section <A HREF="gettext_9.html#SEC152">9.11.3 The <CODE>--style</CODE> option</A> for details.
<DT><SAMP>‘--force-po’</SAMP>
<DD>
<A NAME="IDX1084"></A>
Always write an output file even if it contains no message.
<DT><SAMP>‘-i’</SAMP>
<DD>
<DT><SAMP>‘--indent’</SAMP>
<DD>
<A NAME="IDX1085"></A>
<A NAME="IDX1086"></A>
Write the .po file using indented style.
<DT><SAMP>‘--strict’</SAMP>
<DD>
<A NAME="IDX1087"></A>
Write out a strict Uniforum conforming PO file. Note that this
Uniforum format should be avoided because it doesn't support the
GNU extensions.
<DT><SAMP>‘-p’</SAMP>
<DD>
<DT><SAMP>‘--properties-output’</SAMP>
<DD>
<A NAME="IDX1088"></A>
<A NAME="IDX1089"></A>
Write out a Java ResourceBundle in Java <CODE>.properties</CODE> syntax. Note
that this file format doesn't support plural forms and silently drops
obsolete messages.
<DT><SAMP>‘--stringtable-output’</SAMP>
<DD>
<A NAME="IDX1090"></A>
Write out a NeXTstep/GNUstep localized resource file in <CODE>.strings</CODE> syntax.
Note that this file format doesn't support plural forms.
<DT><SAMP>‘-w <VAR>number</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--width=<VAR>number</VAR>’</SAMP>
<DD>
<A NAME="IDX1091"></A>
<A NAME="IDX1092"></A>
Set the output page width. Long strings in the output files will be
split across multiple lines in order to ensure that each line's width
(= number of screen columns) is less or equal to the given <VAR>number</VAR>.
<DT><SAMP>‘--no-wrap’</SAMP>
<DD>
<A NAME="IDX1093"></A>
Do not break long message lines. Message lines whose width exceeds the
output page width will not be split into several lines. Only file reference
lines which are wider than the output page width will be split.
<DT><SAMP>‘-s’</SAMP>
<DD>
<DT><SAMP>‘--sort-output’</SAMP>
<DD>
<A NAME="IDX1094"></A>
<A NAME="IDX1095"></A>
<A NAME="IDX1096"></A>
Generate sorted output. Note that using this option makes it much harder
for the translator to understand each message's context.
</DL>
<H3><A NAME="SEC178" HREF="gettext_toc.html#TOC178">10.2.8 Informative output</A></H3>
<DL COMPACT>
<DT><SAMP>‘-h’</SAMP>
<DD>
<DT><SAMP>‘--help’</SAMP>
<DD>
<A NAME="IDX1097"></A>
<A NAME="IDX1098"></A>
Display this help and exit.
<DT><SAMP>‘-V’</SAMP>
<DD>
<DT><SAMP>‘--version’</SAMP>
<DD>
<A NAME="IDX1099"></A>
<A NAME="IDX1100"></A>
Output version information and exit.
<DT><SAMP>‘-v’</SAMP>
<DD>
<DT><SAMP>‘--verbose’</SAMP>
<DD>
<A NAME="IDX1101"></A>
<A NAME="IDX1102"></A>
Increase verbosity level.
</DL>
<H2><A NAME="SEC179" HREF="gettext_toc.html#TOC179">10.3 The Format of GNU MO Files</A></H2>
<P>
<A NAME="IDX1103"></A>
<A NAME="IDX1104"></A>
</P>
<P>
The format of the generated MO files is best described by a picture,
which appears below.
</P>
<P>
<A NAME="IDX1105"></A>
The first two words serve the identification of the file. The magic
number will always signal GNU MO files. The number is stored in the
byte order used when the MO file was generated, so the magic number
really is two numbers: <CODE>0x950412de</CODE> and <CODE>0xde120495</CODE>.
</P>
<P>
The second word describes the current revision of the file format,
composed of a major and a minor revision number. The revision numbers
ensure that the readers of MO files can distinguish new formats from
old ones and handle their contents, as far as possible. For now the
major revision is 0 or 1, and the minor revision is also 0 or 1. More
revisions might be added in the future. A program seeing an unexpected
major revision number should stop reading the MO file entirely; whereas
an unexpected minor revision number means that the file can be read but
will not reveal its full contents, when parsed by a program that
supports only smaller minor revision numbers.
</P>
<P>
The version is kept
separate from the magic number, instead of using different magic
numbers for different formats, mainly because <TT>‘/etc/magic’</TT> is
not updated often.
</P>
<P>
Follow a number of pointers to later tables in the file, allowing
for the extension of the prefix part of MO files without having to
recompile programs reading them. This might become useful for later
inserting a few flag bits, indication about the charset used, new
tables, or other things.
</P>
<P>
Then, at offset <VAR>O</VAR> and offset <VAR>T</VAR> in the picture, two tables
of string descriptors can be found. In both tables, each string
descriptor uses two 32 bits integers, one for the string length,
another for the offset of the string in the MO file, counting in bytes
from the start of the file. The first table contains descriptors
for the original strings, and is sorted so the original strings
are in increasing lexicographical order. The second table contains
descriptors for the translated strings, and is parallel to the first
table: to find the corresponding translation one has to access the
array slot in the second array with the same index.
</P>
<P>
Having the original strings sorted enables the use of simple binary
search, for when the MO file does not contain an hashing table, or
for when it is not practical to use the hashing table provided in
the MO file. This also has another advantage, as the empty string
in a PO file GNU <CODE>gettext</CODE> is usually <EM>translated</EM> into
some system information attached to that particular MO file, and the
empty string necessarily becomes the first in both the original and
translated tables, making the system information very easy to find.
</P>
<P>
<A NAME="IDX1106"></A>
The size <VAR>S</VAR> of the hash table can be zero. In this case, the
hash table itself is not contained in the MO file. Some people might
prefer this because a precomputed hashing table takes disk space, and
does not win <EM>that</EM> much speed. The hash table contains indices
to the sorted array of strings in the MO file. Conflict resolution is
done by double hashing. The precise hashing algorithm used is fairly
dependent on GNU <CODE>gettext</CODE> code, and is not documented here.
</P>
<P>
As for the strings themselves, they follow the hash file, and each
is terminated with a <KBD>NUL</KBD>, and this <KBD>NUL</KBD> is not counted in
the length which appears in the string descriptor. The <CODE>msgfmt</CODE>
program has an option selecting the alignment for MO file strings.
With this option, each string is separately aligned so it starts at
an offset which is a multiple of the alignment value. On some RISC
machines, a correct alignment will speed things up.
</P>
<P>
<A NAME="IDX1107"></A>
Contexts are stored by storing the concatenation of the context, a
<KBD>EOT</KBD> byte, and the original string, instead of the original string.
</P>
<P>
<A NAME="IDX1108"></A>
Plural forms are stored by letting the plural of the original string
follow the singular of the original string, separated through a
<KBD>NUL</KBD> byte. The length which appears in the string descriptor
includes both. However, only the singular of the original string
takes part in the hash table lookup. The plural variants of the
translation are all stored consecutively, separated through a
<KBD>NUL</KBD> byte. Here also, the length in the string descriptor
includes all of them.
</P>
<P>
Nothing prevents a MO file from having embedded <KBD>NUL</KBD>s in strings.
However, the program interface currently used already presumes
that strings are <KBD>NUL</KBD> terminated, so embedded <KBD>NUL</KBD>s are
somewhat useless. But the MO file format is general enough so other
interfaces would be later possible, if for example, we ever want to
implement wide characters right in MO files, where <KBD>NUL</KBD> bytes may
accidentally appear. (No, we don't want to have wide characters in MO
files. They would make the file unnecessarily large, and the
<SAMP>‘wchar_t’</SAMP> type being platform dependent, MO files would be
platform dependent as well.)
</P>
<P>
This particular issue has been strongly debated in the GNU
<CODE>gettext</CODE> development forum, and it is expectable that MO file
format will evolve or change over time. It is even possible that many
formats may later be supported concurrently. But surely, we have to
start somewhere, and the MO file format described here is a good start.
Nothing is cast in concrete, and the format may later evolve fairly
easily, so we should feel comfortable with the current approach.
</P>
<PRE>
byte
+------------------------------------------+
0 | magic number = 0x950412de |
| |
4 | file format revision = 0 |
| |
8 | number of strings | == N
| |
12 | offset of table with original strings | == O
| |
16 | offset of table with translation strings | == T
| |
20 | size of hashing table | == S
| |
24 | offset of hashing table | == H
| |
. .
. (possibly more entries later) .
. .
| |
O | length & offset 0th string ----------------.
O + 8 | length & offset 1st string ------------------.
... ... | |
O + ((N-1)*8)| length & offset (N-1)th string | | |
| | | |
T | length & offset 0th translation ---------------.
T + 8 | length & offset 1st translation -----------------.
... ... | | | |
T + ((N-1)*8)| length & offset (N-1)th translation | | | | |
| | | | | |
H | start hash table | | | | |
... ... | | | |
H + S * 4 | end hash table | | | | |
| | | | | |
| NUL terminated 0th string <----------------' | | |
| | | | |
| NUL terminated 1st string <------------------' | |
| | | |
... ... | |
| | | |
| NUL terminated 0th translation <---------------' |
| | |
| NUL terminated 1st translation <-----------------'
| |
... ...
| |
+------------------------------------------+
</PRE>
<P><HR><P>
Go to the <A HREF="gettext_1.html">first</A>, <A HREF="gettext_9.html">previous</A>, <A HREF="gettext_11.html">next</A>, <A HREF="gettext_25.html">last</A> section, <A HREF="gettext_toc.html">table of contents</A>.
</BODY>
</HTML>
|
