1PODEBCONF-REPORT-PO(1) po-debconf PODEBCONF-REPORT-PO(1)
2
6 podebconf-report-po - send outdated debconf PO files to the last
7 translators
8
10 podebconf-report-po [options]
11
13 This program reads a directory with po files to determine which files
14 contain fuzzy or missing translations, launches an editor to allow
15 modifications of mail body and headers, asks confirmation to send
16 mails, and sends them to the last translator requesting updates. The
17 mail will contain the PO file which has to be updated. podebconf-
18 report-po can be called either in the top-level directory, or in debian
19 or debian/po subdirectories (or, for non debconf translations, from the
20 po directory itself or its parent directory).
21 podebconf-report-po can also be used to send a call for translations to
23 a mailing list. In that case, the POT file will be attached.
24 Different templates exist for translation update requests, request to
26 send updated PO files to a bug report (--submit) or for calls for
27 translations (--call). The template can also be provided by the user.
28 See the TEMPLATES section for more information on the templates.
29
31 Many options can be set in a configuration file. See section
32 CONFIGURATION FILE.
33 --addlanguageteam=LANGUAGE:LIST
35 Specify a mailing list for a given language. This mailing list
36 will be added to the CC list for the PO files of this language when
37 --languageteam is used, in addition to the language team specified
38 in the PO file (if these mailing lists differ).
39 This is useful to keep the specified team informed, and allow a
41 faster reaction when a translator is known to be inactive.
42 This option can be specified more than once. The language code and
44 language mailing list are separated by a colon.
45 This option can be specified in the configuration file to define
47 default behavior of podebconf-report-po. See section CONFIGURATION
48 FILE below.
49 --bts=NUMBER
51 After a bug report has been filed (either manually or with the
52 --submit flag) to track down translations, podebconf-report-po can
53 be run again, but this time with the --bts=NUMBER flag.
54 Translators are then requested to respect the Reply-To: header
55 field which is set to this bug report, so that all translations are
56 gathered into a single location.
57 --call[=MAILING_LIST]
59 Send a call for translations. If the optional MAILING_LIST
60 argument is not specified, the call for translations is sent to the
61 Debian Internationalization list (debian-i18n@lists.debian.org).
62 Calls for translations are useful to receive translations in new
64 languages.
65 By default, calls for translation are combined with regular
67 requests for updates sent to translators, for the existing
68 translations. You can disable this default behavior with the
69 --withouttranslators option.
70 --conf=FILE
72 Specify the configuration file. By default, podebconf-report-po
73 reads $HOME/.podebconf-report-po.conf.
74 --noconf
76 Do not read any configuration file.
77 --deadline=DEADLINE
79 Specify the deadline for receiving the updated translations
80 (default is no deadline).
81 This should be a date, which will be prefixed by:
83 The deadline for receiving the updated translation is
84 DEADLINE.
85 If the specified string starts with a '+', it will be interpreted
87 by:
88 LC_ALL=C date -R -d DEADLINE
89 If no deadline is specified (and the --nodeadline option is not
91 used), a deadline will be prompted to the user, proposing a default
92 deadline set to +10days.
93 This option can be specified in the configuration file to define
95 default behavior of podebconf-report-po. See section CONFIGURATION
96 FILE below.
97 --nodeadline
99 Deactivate the deadline indication to translators, and avoid the
100 deadline prompts.
101 This option can be specified in the configuration file to define
103 default behavior of podebconf-report-po. See section CONFIGURATION
104 FILE below.
105 --default
107 Do not open the editor and use the template as is.
108 This option can be specified in the configuration file to define
110 default behavior of podebconf-report-po. See section CONFIGURATION
111 FILE below.
112 --nodefault
114 Open an editor before sending the email(s).
115 -f, --force
117 Send the email(s) without confirmation.
118 This option can be specified in the configuration file to define
120 default behavior of podebconf-report-po. See section CONFIGURATION
121 FILE below.
122 --noforce
124 Ask for confirmation before sending email(s).
125 --from=FROM
127 Specify the name and the email address of the sender (default is
128 taken from the DEBEMAIL and DEBFULLNAME environment variables, or
129 from the EMAIL environment variable, or is set to the package
130 maintainer if these variables are not set).
131 This option can be specified in the configuration file to define
133 default behavior of podebconf-report-po. See section CONFIGURATION
134 FILE below.
135 --gzip
137 Compress PO files in attachment with "gzip".
138 This option can be specified in the configuration file to define
140 default behavior of podebconf-report-po. See section CONFIGURATION
141 FILE below.
142 --nogzip
144 Do not compress PO files.
145 -h, --help
147 Print usage information and exit.
148 --langs=LANGUAGES
150 Specify a list of languages to restrict sending the notification
151 only for these languages. The list of languages is comma
152 separated. The PO files must be named according to these languages,
153 with the .po extension.
154 --languageteam
156 Send the email also to the Language Team as carbon copy.
157 It is enabled by default.
159 This option can be specified in the configuration file to define
161 default behavior of podebconf-report-po. See section CONFIGURATION
162 FILE below.
163 --nolanguageteam
165 Do not send the email(s) to the language teams.
166 This option can be specified in the configuration file to define
168 default behavior of podebconf-report-po. See section CONFIGURATION
169 FILE below.
170 --mutt
172 Send the mails with mutt. This set the --postpone argument to
173 $HOME/postponed.
174 --notdebconf
176 Indicate that it is not a debconf translation. podebconf-report-po
177 will use the translator-po, call-po, or submit-po template (if no
178 other templates are requested in the configuration file or in the
179 command line). These templates do not mention debconf in the
180 subject or mail body and are more suitable for non-debconf
181 translations.
182 This option also changes the default po directory used by
184 podebconf-report-po (i.e. the --podir option is not needed when the
185 call is done from the po directory itself or from its parent
186 directory).
187 By default, a debian/po directory is preferred over a po directory.
189 With this option, only the po directory will be considered.
190 This option is usually not necessary. podebconf-report-po tries to
192 determine the type of translation based on the current directory
193 and the existence of a debian/po or po directory.
194 --package=PACKAGE
196 Specify the name of the package (default is the source package
197 name).
198 --podir=DIR
200 Specify where the PO files are located. By default, podebconf-
201 report-po checks if it is called from a po directory, or it
202 searches for a debian/po directory (this can be disabled with the
203 --notdebconf option), or for a po directory.
204 --postpone=MBOX
206 Do not send emails, append them in MBOX. This file can be used as
207 a postponed mailbox with mutt -p.
208 --potfile=POTFILE
210 Specify the POT file to send to a call for translations (--call).
211 By default, podebconf-report-po uses the POT file of the PO files
212 directory, if there is only one.
213 This file is also used to find the package's name and version, if
215 none were specified with an option, and if no debian/changelog
216 files were found.
217 --sendmessage
219 Only send a message, with no attachments. This can be useful when
220 the translators have a commit access to the package repository.
221 --smtp=SERVER
223 Specify SMTP server for mailing (default is "localhost").
224 This option can be specified in the configuration file to define
226 default behavior of podebconf-report-po. See section CONFIGURATION
227 FILE below.
228 --submit
230 Instead of sending mails to translators, file a bug report against
231 this package to request for translations. This is useful e.g. when
232 preparing non-maintainer uploads to make sure that translations do
233 not get lost.
234 --summary
236 Send a status report to the maintainer with the list of emails sent
237 to translators.
238 This option can be specified in the configuration file to define
240 default behavior of podebconf-report-po. See section CONFIGURATION
241 FILE below.
242 --nosummary
244 Do not send any status report to the maintainer.
245 --utf8
247 Send the email in UTF-8. This allow non-ascii characters in the
248 mail body and mail header. The editor must support UTF-8.
249 This option can be specified in the configuration file to define
251 default behavior of podebconf-report-po. See section CONFIGURATION
252 FILE below.
253 --noutf8
255 Send the email(s) in us-ascii. Non-ascii characters are replaced
256 by a question mark.
257 --version
259 Print version information and exit.
260 -v, --verbose
262 Display additional information while running.
263 This option can be specified in the configuration file to define
265 default behavior of podebconf-report-po. See section CONFIGURATION
266 FILE below.
267 --noverbose
269 Do not use the verbose mode.
270 --templatecall=TEMPLATE
272 Specify a file to use as a template for the call for translations
273 email(s). The default template is
274 /usr/share/po-debconf/templates/call.
275 This option can be specified in the configuration file to define
277 default behavior of podebconf-report-po. See section CONFIGURATION
278 FILE below.
279 --templatesubmit=TEMPLATE
281 Specify a file to use as a template for the email(s) sent to
282 translators when the --submit option is used. The default template
283 is /usr/share/po-debconf/templates/submit.
284 This option can be specified in the configuration file to define
286 default behavior of podebconf-report-po. See section CONFIGURATION
287 FILE below.
288 --templatetranslators=TEMPLATE
290 Specify a file to use as a template for the email(s) sent to
291 translators. The default template is
292 /usr/share/po-debconf/templates/translators.
293 This option can be specified in the configuration file to define
295 default behavior of podebconf-report-po. See section CONFIGURATION
296 FILE below.
297 --template=TEMPLATE
299 Specify file to use it as template for the email(s). If a template
300 is specified with this option, this template will be used rather
301 than a template specified with any of the --templatetranslators,
302 --templatesubmit, or --templatecall options.
303 This option can be specified in the configuration file to define
305 default behavior of podebconf-report-po. See section CONFIGURATION
306 FILE below.
307 --notemplate
309 Use the default template.
310 --withtranslators
312 Send requests for updates to the translators after sending the call
313 for translation.
314 This option is ignored when the --call option is not specified. It
316 is enabled by default.
317 This option can be specified in the configuration file to define
319 default behavior of podebconf-report-po. See section CONFIGURATION
320 FILE below.
321 --withouttranslators
323 Do not send requests for translation update to the translators
324 after a call for translations.
325 This option can be specified in the configuration file to define
327 default behavior of podebconf-report-po. See section CONFIGURATION
328 FILE below.
329
331 By default, podebconf-report-po reads $HOME/.podebconf-report-po.conf.
332 The configuration file can be set with the --conf option. You can also
333 ignore any configuration file by specifying the --noconf option.
334 Command line options can be used to override configuration file
335 settings.
336 The configuration files accept most of the command line options,
338 without the leading --: deadline, nodeadline, smtp, from, verbose,
339 force, templatetranslators, templatesubmit, templatecall, template,
340 default, gzip, languageteam, nolanguageteam, addlanguageteam, summary,
341 utf8, withouttranslators, withtranslators.
342 Lines starting by a number sign (possibly preceded by spaces) are
344 comments and are ignored.
345 Here is an example:
347 # This is a comment
348 smtp smtp.mydomain
349 from = Me Myself <me@mydomain>
350 utf8
351
353 The templates specified with the --template, --templatetranslators,
354 --templatesubmit, or --templatecall options can contain the following
355 tags:
356 <from>, <subject>, <reply-to>
358 Replaced by the corresponding headers of the email(s).
359 <filelist>
361 In the default mode, it is replaced by comments showing the list of
362 translators with outdated translations.
363 In the --submit mode, it is replaced by the list of PO files with
365 outdated translations.
366 And in the --call mode, it is replaced by the list of PO files
368 found in the PO directory.
369 <reply>
371 Replaced by a string that indicates how the translators have to
372 reply (e.g. follow the Reply-To tag or sending the PO to a given
373 bug report).
374 <deadline>
376 Replaced by a string indicating the deadline for the translation
377 (see --deadline).
378 <package>
380 Replaced by the name of the package (if it was detected).
381 <statistics>
383 Replaced by the statistics of the PO files found in the PO
384 directory (in the --call mode only).
385 The /usr/share/po-debconf/templates directory contains the default
387 templates.
388
390 The recommended usage is to call podebconf-report-po from the po
391 directory to be updated:
392 podebconf-report-po --call
394 This will send a call for new translations to the
396 <debian-i18n@lists.debian.org> mailing list and will ask translation
397 updates to the previous translators. The language teams will also be
398 notified and should be able to react if the assigned translator is
399 known to be MIA.
400 A prompt will ask a deadline to the user (the default is to request
402 translations and updates within 10 days).
403 Then an editor will display the message to be sent to the mailing list.
405 When this editor exits, podebconf-report-po will ask confirmation to
406 send the mail to the mailing list.
407 If confirmed, another editor will display the message to be sent to the
409 translators and language teams. podebconf-report-po will ask for
410 another confirmation to send the mails to translators and language
411 teams.
412 You should make a new release with the received translations after the
414 deadline.
415
417 debconf-updatepo(1)
418
420 Fabio Tranchitella <kobold@kobold.it>
421 2021-07-23 PODEBCONF-REPORT-PO(1)