.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "PO4A-UPDATEPO 1p" .TH PO4A-UPDATEPO 1p "2018-12-09" "Po4a Tools" "Po4a Tools" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" po4a\-updatepo \- update the translation (in PO format) of documentation .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBpo4a\-updatepo\fR \fB\-f\fR \fIfmt\fR (\fB\-m\fR \fImaster.doc\fR)+ (\fB\-p\fR \fI\s-1XX\s0.po\fR)+ .PP (\fI\s-1XX\s0.po\fR are the outputs, all others are inputs) .SH "DESCRIPTION" .IX Header "DESCRIPTION" The po4a (\s-1PO\s0 for anything) project goal is to ease translations (and more interestingly, the maintenance of translations) using gettext tools on areas where they were not expected like documentation. .PP The \fBpo4a\-updatepo\fR script is in charge of updating \s-1PO\s0 files to make them reflect the changes made to the original documentation file. For that, it converts the documentation file to a \s-1POT\s0 file, and call \fBmsgmerge\fR\|(1) on this new \s-1POT\s0 and on the provided \s-1PO\s0 files. .PP It is possible to give more than one \s-1PO\s0 file (if you want to update several languages at once), and several documentation files (if you want to store the translations of several documents in the same \s-1PO\s0 file). .PP If the master document has non-ASCII characters, it will convert the \s-1PO\s0 files to \s-1UTF\-8\s0 (if they weren't already), in order to allow non-standard characters in a culture independent way. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-f\fR, \fB\-\-format\fR" 4 .IX Item "-f, --format" Format of the documentation you want to handle. Use the \fB\-\-help\-format\fR option to see the list of available formats. .IP "\fB\-m\fR, \fB\-\-master\fR" 4 .IX Item "-m, --master" File(s) containing the master document to translate. .IP "\fB\-M\fR, \fB\-\-master\-charset\fR" 4 .IX Item "-M, --master-charset" Charset of the files containing the document to translate. Note that all files must have the same charset. .IP "\fB\-p\fR, \fB\-\-po\fR" 4 .IX Item "-p, --po" \&\s-1PO\s0 file(s) to update. If these files do not exist, they are created by \&\fBpo4a\-updatepo\fR. .IP "\fB\-o\fR, \fB\-\-option\fR" 4 .IX Item "-o, --option" Extra option(s) to pass to the format plugin and other po4a internal modules. Specify each option in the '\fIname\fR\fB=\fR\fIvalue\fR' format. See the documentation of each plugin for more information about the valid options and their meanings. .IP "\fB\-\-no\-previous\fR" 4 .IX Item "--no-previous" This option removes \fB\-\-previous\fR from the options passed to \fBmsgmerge\fR. This permits to support versions of \fBgettext\fR earlier than 0.16. .IP "\fB\-\-previous\fR" 4 .IX Item "--previous" This option adds \fB\-\-previous\fR to the options passed to \fBmsgmerge\fR. It requires \fBgettext\fR 0.16 or later, and is activated by default. .IP "\fB\-\-msgmerge\-opt\fR \fIoptions\fR" 4 .IX Item "--msgmerge-opt options" Extra options for \fBmsgmerge\fR(1). .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Show a short help message. .IP "\fB\-\-help\-format\fR" 4 .IX Item "--help-format" List the documentation formats understood by po4a. .IP "\fB\-V\fR, \fB\-\-version\fR" 4 .IX Item "-V, --version" Display the version of the script and exit. .IP "\fB\-v\fR, \fB\-\-verbose\fR" 4 .IX Item "-v, --verbose" Increase the verbosity of the program. .IP "\fB\-d\fR, \fB\-\-debug\fR" 4 .IX Item "-d, --debug" Output some debugging information. .IP "\fB\-\-porefs\fR \fItype\fR[,\fBwrap\fR|\fBnowrap\fR]" 4 .IX Item "--porefs type[,wrap|nowrap]" Specify the reference format. Argument \fItype\fR can be one of \fBnever\fR to not produce any reference, \fBfile\fR to only specify the file without the line number, \fBcounter\fR to replace line number by an increasing counter, and \fBfull\fR to include complete references (default: full). .Sp Argument can be followed by a comma and either \fBwrap\fR or \fBnowrap\fR keyword. References are written by default on a single line. The \fBwrap\fR option wraps references on several lines, to mimic \fBgettext\fR tools (\fBxgettext\fR and \&\fBmsgmerge\fR). This option will become the default in a future release, because it is more sensible. The \fBnowrap\fR option is available so that users who want to keep the old behavior can do so. .IP "\fB\-\-msgid\-bugs\-address\fR \fIemail@address\fR" 4 .IX Item "--msgid-bugs-address email@address" Set the report address for msgid bugs. By default, the created \s-1POT\s0 files have no Report-Msgid-Bugs-To fields. .IP "\fB\-\-copyright\-holder\fR \fIstring\fR" 4 .IX Item "--copyright-holder string" Set the copyright holder in the \s-1POT\s0 header. The default value is \&\*(L"Free Software Foundation, Inc.\*(R" .IP "\fB\-\-package\-name\fR \fIstring\fR" 4 .IX Item "--package-name string" Set the package name for the \s-1POT\s0 header. The default is \*(L"\s-1PACKAGE\*(R".\s0 .IP "\fB\-\-package\-version\fR \fIstring\fR" 4 .IX Item "--package-version string" Set the package version for the \s-1POT\s0 header. The default is \*(L"\s-1VERSION\*(R".\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBpo4a\-gettextize\fR\|(1), \&\fBpo4a\-normalize\fR\|(1), \&\fBpo4a\-translate\fR\|(1), \&\fBpo4a\fR\|(7) .SH "AUTHORS" .IX Header "AUTHORS" .Vb 3 \& Denis Barbier \& Nicolas François \& Martin Quinson (mquinson#debian.org) .Ve .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2002\-2012 by \s-1SPI,\s0 inc. .PP This program is free software; you may redistribute it and/or modify it under the terms of \s-1GPL\s0 (see the \s-1COPYING\s0 file).