1PO4A-UPDATEPO.1P(1)   User Contributed Perl Documentation  PO4A-UPDATEPO.1P(1)
2
3
4

NAME

6       po4a-updatepo - update the translation (in PO format) of documentation
7

SYNOPSIS

9       po4a-updatepo -f fmt (-m master.doc)+ (-p XX.po)+
10
11       (XX.po are the outputs, 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-updatepo script is in charge of updating PO files to make them
19       reflect the changes made to the original documentation file. For that,
20       it converts the documentation file to a POT file, and call msgmerge(1)
21       on this new POT and on the provided PO files.
22
23       It is possible to give more than one PO file (if you want to update
24       several languages at once), and several documentation files (if you
25       want to store the translations of several documents in the same PO
26       file).
27
28       If the master document has non-ASCII characters, this script will
29       convert the PO files to UTF-8 (if they weren't already), for a
30       transparent handling of non-standard characters.
31

OPTIONS

33       -f, --format
34           Format of the documentation you want to handle. Use the
35           --help-format option to see the list of available formats.
36
37       -m, --master
38           File(s) containing the master document to translate.
39
40       -M, --master-charset
41           Charset of the files containing the document to translate. Note
42           that all files must have the same charset.
43
44       -p, --po
45           PO file(s) to update. If these files do not exist, they are created
46           by po4a-updatepo.
47
48       -o, --option
49           Extra option(s) to pass to the format plugin. See the documentation
50           of each plugin for more information about the valid options and
51           their meanings. For example, you could pass '-o tablecells' to the
52           AsciiDoc parser, while the text parser would accept '-o
53           tabs=split'.
54
55       --no-previous
56           This option removes --previous from the options passed to msgmerge.
57           This helps supporting old versions of gettext (before v0.16).
58
59       --previous
60           This option adds --previous to the options passed to msgmerge.  It
61           requires gettext 0.16 or later, and is activated by default.
62
63       --msgmerge-opt options
64           Extra options for msgmerge(1).
65
66       -h, --help
67           Show a short help message.
68
69       --help-format
70           List the documentation formats understood by po4a.
71
72       -V, --version
73           Display the version of the script and exit.
74
75       -v, --verbose
76           Increase the verbosity of the program.
77
78       -d, --debug
79           Output some debugging information.
80
81       --porefs type[,wrap|nowrap]
82           Specify the reference format. Argument type can be one of never to
83           not produce any reference, file to only specify the file without
84           the line number, counter to replace line number by an increasing
85           counter, and full to include complete references (default: full).
86
87           Argument can be followed by a comma and either wrap or nowrap
88           keyword.  References are written by default on a single line.  The
89           wrap option wraps references on several lines, to mimic gettext
90           tools (xgettext and msgmerge).  This option will become the default
91           in a future release, because it is more sensible.  The nowrap
92           option is available so that users who want to keep the old behavior
93           can do so.
94
95       --wrap-po no|newlines|number (default: 76)
96           Specify how the po file should be wrapped. This gives the choice
97           between either files that are nicely wrapped but could lead to git
98           conflicts, or files that are easier to handle automatically, but
99           harder to read for humans.
100
101           Historically, the gettext suite has reformatted the po files at the
102           77th column for cosmetics. This option specifies the behavior of
103           po4a. If set to a numerical value, po4a will wrap the po file after
104           this column and after newlines in the content. If set to newlines,
105           po4a will only split the msgid and msgstr after newlines in the
106           content. If set to no, po4a will not wrap the po file at all.  The
107           wrapping of the reference comments is controlled by the --porefs
108           option.
109
110           Note that this option has no impact on how the msgid and msgstr are
111           wrapped, ie on how newlines are added to the content of these
112           strings.
113
114       --msgid-bugs-address email@address
115           Set the report address for msgid bugs. By default, the created POT
116           files have no Report-Msgid-Bugs-To fields.
117
118       --copyright-holder string
119           Set the copyright holder in the POT header. The default value is
120           "Free Software Foundation, Inc."
121
122       --package-name string
123           Set the package name for the POT header. The default is "PACKAGE".
124
125       --package-version string
126           Set the package version for the POT header. The default is
127           "VERSION".
128

SEE ALSO

130       po4a-gettextize(1), po4a-normalize(1), po4a-translate(1), po4a(7)
131

AUTHORS

133        Denis Barbier <barbier@linuxfr.org>
134        Nicolas Fran├žois <nicolas.francois@centraliens.net>
135        Martin Quinson (mquinson#debian.org)
136
138       Copyright 2002-2020 by SPI, inc.
139
140       This program is free software; you may redistribute it and/or modify it
141       under the terms of GPL (see the COPYING file).
142
143
144
145perl v5.38.0                      2023-10-12               PO4A-UPDATEPO.1P(1)
Impressum