1PO4A-TRANSLATE(1p)                Po4a Tools                PO4A-TRANSLATE(1p)
2
3
4

NAME

6       po4a-translate - convert a PO file back to documentation format
7

SYNOPSIS

9       po4a-translate -f fmt -m master.doc -p XX.po -l XX.doc
10
11       (XX.doc is the output, all others are inputs)
12

DESCRIPTION

14       The po4a (PO for anything) project goal is to ease translations (and
15       more interestingly, the maintenance of translations) using gettext
16       tools on areas where they were not expected like documentation.
17
18       The po4a-translate script is in charge of converting the translation
19       (which was done in a PO file) back into the documentation format. The
20       provided PO file should be the translation of the POT file which was
21       produced by po4a-gettextize(1).
22

OPTIONS

24       -f, --format
25           Format of the documentation you want to handle. Use the
26           --help-format option to see the list of available formats.
27
28       -a, --addendum
29           Add a file to the resulting file (to put translator's name or a
30           section "About this translation", for example). The first line of
31           the file to insert should be a PO4A header indicating where it
32           should be added (see section HOWTO add extra text to translations
33           in po4a(7)).
34
35       -A, --addendum-charset
36           Charset of the addenda. Note that all the addenda should be in the
37           same charset.
38
39       -m, --master
40           File containing the master document to translate.
41
42       -M, --master-charset
43           Charset of the file containing the document to translate.
44
45       -l, --localized
46           File where the localized (translated) document should be written.
47
48       -L, --localized-charset
49           Charset of the file containing the localized document.
50
51       -p, --po
52           File from which the message catalog should be read.
53
54       -o, --option
55           Extra option(s) to pass to the format plugin. Specify each option
56           in the 'name=value' format. See the documentation of each plugin
57           for more information about the valid options and their meanings.
58
59       -k, --keep
60           Minimal threshold for translation percentage to keep (i.e. write)
61           the resulting file (default: 80). I.e. by default, files have to be
62           translated at least at 80% to get written.
63
64       -w, --width
65           Column at which we should wrap the resulting file.
66
67       -h, --help
68           Show a short help message.
69
70       --help-format
71           List the documentation formats understood by po4a.
72
73       -V, --version
74           Display the version of the script and exit.
75
76       -v, --verbose
77           Increase the verbosity of the program.
78
79       -d, --debug
80           Output some debugging information.
81

Adding content (beside translations) to generated files

83       To add some extra content to the generated document beside what you
84       translated (like the name of the translator, or an "About this
85       translation" section), you should use the --addendum option.
86
87       The first line of the addendum must be a header indicating where to put
88       it in the document (it can be before or after a given part of the
89       document).  The rest of the file will be added verbatim to the
90       resulting file without further processing.
91
92       Note that if po4a-translate fails to add one of the given files, it
93       discards the whole translation (because the missing file could be the
94       one indicating the author, what would prevent the users to contact him
95       to report bugs in the translation).
96
97       The header has a pretty rigid syntax. For more information on how to
98       use this feature and how it works, please refer to the po4a(7) man
99       page.
100

SEE ALSO

102       po4a-gettextize(1), po4a-normalize(1), po4a-updatepo(1), po4a(7)
103

AUTHORS

105        Denis Barbier <barbier@linuxfr.org>
106        Nicolas François <nicolas.francois@centraliens.net>
107        Martin Quinson (mquinson#debian.org)
108
110       Copyright 2002-2012 by SPI, inc.
111
112       This program is free software; you may redistribute it and/or modify it
113       under the terms of GPL (see the COPYING file).
114
115
116
117Po4a Tools                        2019-02-02                PO4A-TRANSLATE(1p)
Impressum