[Po4a-commits] r2394 - in /branches/0.40.x: po4a po4a-gettextize po4a-normalize po4a-translate po4a-updatepo

taffit-guest at users.alioth.debian.org taffit-guest at users.alioth.debian.org
Sun Nov 28 23:16:25 UTC 2010


Author: taffit-guest
Date: Sun Nov 28 23:16:25 2010
New Revision: 2394

URL: http://svn.debian.org/wsvn/po4a/?sc=1&rev=2394
Log:
manual page conventions for main scripts

Modified:
    branches/0.40.x/po4a
    branches/0.40.x/po4a-gettextize
    branches/0.40.x/po4a-normalize
    branches/0.40.x/po4a-translate
    branches/0.40.x/po4a-updatepo

Modified: branches/0.40.x/po4a
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/po4a?rev=2394&op=diff
==============================================================================
--- branches/0.40.x/po4a (original)
+++ branches/0.40.x/po4a Sun Nov 28 23:16:25 2010
@@ -17,7 +17,7 @@
 
 =head1 SYNOPSIS
 
-po4a [options] E<lt>config_fileE<gt>
+B<po4a> [I<options>] I<config_file>
 
 =head1 DESCRIPTION
 
@@ -107,8 +107,8 @@
 
 =head2 Specifying the template languages
 
-B<Note:> It is recommended to use [po_directory] rather than [po4a_langs]
-and [po4a_paths].
+B<Note:> It is recommended to use B<[po_directory]> rather than B<[po4a_langs]>
+and B<[po4a_paths]>.
 See section B<Autodetection of the paths and languages> below.
 
 This is an optional command that can simplify the whole config file, and will
@@ -122,8 +122,8 @@
 
 =head2 Specifying the paths to translator inputs
 
-B<Note:> It is recommended to use [po_directory] rather than [po4a_langs]
-and [po4a_paths].
+B<Note:> It is recommended to use B<[po_directory]> rather than B<[po4a_langs]>
+and B<[po4a_paths]>.
 See section B<Autodetection of the paths and languages> below.
 
 First, you have to specify where the translator input files (ie, the files
@@ -132,7 +132,7 @@
  [po4a_paths] doc/l10n/project.doc.pot \
               fr:doc/l10n/fr.po de:doc/l10n/de.po
 
-The command is thus 'po4a_paths'. The first argument is the path to the POT
+The command is thus B<[po4a_paths]>. The first argument is the path to the POT
 file to use. All subsequent arguments are of the self-explanatory form:
 
     <lang>:<path to the PO file for this lang>
@@ -153,14 +153,14 @@
 
 Another command can be used to specify the name of a directory where the
 PO and POT files are located.
-When it is used, po4a will detect the POT file as the only "*.pot" file
+When it is used, po4a will detect the POT file as the only F<*.pot> file
 from the specified directory.
-Po4a will also use the list of "*.po" files to define the list of
+Po4a will also use the list of F<*.po> files to define the list of
 languages (by stripping out the extension).
 These languages will be used for the substitution of the $lang variable in
 the rest of the configuration file.
 
-This command should not be used together with the po4a_langs or po4a_paths
+This command should not be used together with the B<[po4a_langs]> or B<[po4a_paths]>
 commands.
 
 When using this command, you have to create an empty POT file on the first
@@ -179,29 +179,29 @@
              add_fr:doc/l10n/script.fr.add
 
 This should be rather self-explanatory also. Note that in the second case,
-doc/l10n/script.fr.add is an addendum to add to the French version of this document.
-Please refer to po4a(7) for more information about the addenda.
+F<doc/l10n/script.fr.add> is an addendum to add to the French version of this document.
+Please refer to L<po4a(7)> for more information about the addenda.
 
 More formally, the format is:
 
  [type: <format>] <master_doc> (<lang>:<localized_doc>)* \
-                  (add_<lang>:<modifiers>*<addendum_path>)*
+                  (add_<lang>:<modifier>*<addendum_path>)*
 
 If there is no modifier, I<addendum_path> is a path to an addendum.
 Modifiers are
 
 =over 2
 
-=item ?
+=item B<?>
 
 Include I<addendum_path> if this file does exist, otherwise do nothing.
 
-=item @
+=item B<@>
 
 I<addendum_path> is not a regular addendum but a file containg a list of
 addenda, one by line.  Each addendum may be preceded by modifiers.
 
-=item !
+=item B<!>
 
 I<addendum_path> is discarded, it is not loaded and will not be loaded by 
 any further addendum specification.
@@ -222,16 +222,16 @@
 
 =head2 Specifying options for the modules
 
-po4a accepts options that will be passed to the module. These options are
-module specific and are specified with the -o switch.
+B<po4a> accepts options that will be passed to the module. These options are
+module specific and are specified with the B<-o> switch.
 
 If you need a specific option for one of the document you want to
 translate, you can also specify it in the configuration file. Options are
-introduced by the I<opt> keyword. The argument of the I<opt> keyword must be
+introduced by the B<opt> keyword. The argument of the B<opt> keyword must be
 quoted with double quotes if it contains a space (e.g. if you specify
 multiple options, or an option with an argument).
 You can also specify options that will only apply to a specific language
-by using the opt_I<lang> keyword.
+by using the B<opt_>I<lang> keyword.
 
 Here is an example:
  [type:man] data-05/test2_man.1 $lang:tmp/test2_man.$lang.1 \
@@ -255,8 +255,8 @@
 
 [po4a_alias:test] man opt:"-k 21" opt_es:"-o debug=splitargs"
 
-This define a module alias named I<test>, based on the I<man> module, with
-the I<-k 21> apply to all the languages and with I<-o debug=splitargs>
+This define a module alias named B<test>, based on the B<man> module, with
+the B<-k 21> apply to all the languages and with B<-o debug=splitargs>
 applied to the Spanish translation.
 
 This module alias can then be use like a regular module:
@@ -268,7 +268,7 @@
 
 =head2 Split mode
 
-The split mode is used when $master is used in the [po4a_paths] line.
+The split mode is used when $master is used in the B<[po4a_paths]> line.
 
 When the split mode is used, a temporary big POT and temporary big POs
 are used. This permits to share the translations between all the POs.
@@ -283,67 +283,67 @@
 
 =over 4
 
-=item -k, --keep
+=item B<-k>, B<--keep>
 
 Minimal threshold for translation percentage to keep (ie, write) the
 resulting file (default: 80). Ie, by default, files have to be translated
 at at least 80% to get written.
 
-=item -h, --help
+=item B<-h>, B<--help>
 
 Show a short help message.
 
-=item -M, --master-charset
+=item B<-M>, B<--master-charset>
 
 Charset of the files containing the documents to translate. Note that all
 master documents must use the same charset for now. This is a known
 limitation, and we are working on solving this.
 
-=item -L, --localized-charset
+=item B<-L>, B<--localized-charset>
 
 Charset of the files containing the localized documents. Note that all
 translated documents will use the same charset for now. This is a known
 limitation, and we are working on solving this.
 
-=item -A, --addendum-charset
+=item B<-A>, B<--addendum-charset>
 
 Charset of the addenda. Note that all the addenda should be in the same
 charset.
 
-=item -V, --version
+=item B<-V>, B<--version>
 
 Display the version of the script and exit.
 
-=item -v, --verbose
+=item B<-v>, B<--verbose>
 
 Increase the verbosity of the program.
 
-=item -q, --quiet
+=item B<-q>, B<--quiet>
 
 Decrease the verbosity of the program.
 
-=item -d, --debug
+=item B<-d>, B<--debug>
 
 Output some debugging information.
 
-=item -o, --option
+=item B<-o>, B<--option>
 
 Extra option(s) to pass to the format plugin. Specify each option in the
-'name=value' format. See the documentation of each plugin for more
+'I<name>B<=>I<value>' format. See the documentation of each plugin for more
 information about the valid options and their meanings.
 
-=item -f, --force
+=item B<-f>, B<--force>
 
 Always generate the POT and PO files, even if po4a considers it is
 not necessary.
 
-The default behavior (when --force is not specified) is the following:
+The default behavior (when B<--force> is not specified) is the following:
 
 =over
 
 If the POT file already exists, it is regenerated if a master document
 or the configuration file is more recent.
-The POT file is also written in a temporary document and po4a verifies
+The POT file is also written in a temporary document and B<po4a> verifies
 that the changes are really needed.
 
 Also, a translation is regenerated only if its master document, the PO file,
@@ -360,86 +360,86 @@
 
 The PO files are always re-generated based on the POT with B<msgmerge -U>.
 
-=item --stamp
+=item B<--stamp>
 
 Tells po4a to create stamp files when a translation is not generated
 because it does not reach the threshold. These stamp files are named
-according to the expected translated document, with the I<.po4a-stamp>
+according to the expected translated document, with the F<.po4a-stamp>
 extension.
 
-Note: This only activates the creation of the I<.po4a-stamp> files. The stamp
+Note: This only activates the creation of the F<.po4a-stamp> files. The stamp
 files are always used if they exist, and they are removed with
 B<--rm-translations> or when the file is finally translated.
 
-=item --no-translations
+=item B<--no-translations>
 
 Do not generate the translated documents, only update the POT and PO files.
 
-=item --rm-translations
-
-Remove the translated files (implies --no-translations).
-
-=item --no-backups
+=item B<--rm-translations>
+
+Remove the translated files (implies B<--no-translations>).
+
+=item B<--no-backups>
 
 Do not generate the .po~ backup files.
 
-=item --rm-backups
+=item B<--rm-backups>
 
 Remove the .po~ backup files (implies --no-backups).
 
-=item --translate-only I<translated-file>
+=item B<--translate-only> I<translated-file>
 
 Translate only the specified file.  It may be useful to speed up
 processing if configuration file contains a lot of files.  Note that this
 option does not update PO and POT files.
 This option can be used multiple times.
 
-=item --variable I<var>=I<value>
+=item B<--variable> I<var>B<=>I<value>
 
 Define a variable that will be expanded in the po4a configuration file.
 Every occurrence of I<$(var)> will be replaced by I<value>.
 This option can be used multiple times.
 
-=item --msgid-bugs-address email at address
+=item B<--msgid-bugs-address> I<email at address>
 
 Set the report address for msgid bugs. By default, the created POT files
 have no Report-Msgid-Bugs-To fields.
 
-=item --copyright-holder string
+=item B<--copyright-holder> I<string>
 
 Set the copyright holder in the POT header. The default value is
 "Free Software Foundation, Inc."
 
-=item --package-name string
+=item B<--package-name> I<string>
 
 Set the package name for the POT header. The default is "PACKAGE".
 
-=item --package-version string
+=item B<--package-version> I<string>
 
 Set the package version for the POT header. The default is "VERSION".
 
-=item --msgmerge-opt options
-
-Extra options for msgmerge.
+=item B<--msgmerge-opt> I<options>
+
+Extra options for B<msgmerge>.
 
 Note: $lang will be extended to the current language.
 
-=item --no-previous
-
-This option removes '--previous' from the options passed to msgmerge.
+=item B<--no-previous>
+
+This option removes B<--previous> from the options passed to msgmerge.
 This permits to support versions of gettext earlier than 0.16.
 
-=item --previous
-
-This option adds '--previous' to the options passed to msgmerge.
+=item B<--previous>
+
+This option adds B<--previous> to the options passed to msgmerge.
 It requires gettext 0.16 or later, and is activated by default.
 
-=item --srcdir I<SRCDIR>
-
-Set the base directory for all input documents specified in the po4a
+=item B<--srcdir> I<SRCDIR>
+
+Set the base directory for all input documents specified in the B<po4a>
 configuration file.
 
-=item --destdir I<DESTDIR>
+=item B<--destdir> I<DESTDIR>
 
 Set the base directory for all the output documents specified in the po4a
 configuration file.
@@ -478,7 +478,7 @@
 the F<man/po4a/po/> directory would include F<de.po>, F<pt.po> and F<sv.po>,
 and the F<man/po4a/add_de/> directory would include F<de.add>.
 
-Note the use of the modifier '?' as only the German translation (F<de.po>) is 
+Note the use of the modifier B<?> as only the German translation (F<de.po>) is 
 accompanied by an addendum.
 
 To actually build the translated man pages you would then (once!) add the

Modified: branches/0.40.x/po4a-gettextize
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/po4a-gettextize?rev=2394&op=diff
==============================================================================
--- branches/0.40.x/po4a-gettextize (original)
+++ branches/0.40.x/po4a-gettextize Sun Nov 28 23:16:25 2010
@@ -17,9 +17,9 @@
 
 =head1 SYNOPSIS
 
-po4a-gettextize -f E<lt>fmtE<gt> -m E<lt>master.docE<gt> [-l E<lt>XX.docE<gt>] -p E<lt>XX.poE<gt>
-
-(XX.po is the output, all others are inputs)
+B<po4a-gettextize> B<-f> I<fmt> B<-m> I<master.doc> [B<-l> I<XX.doc>] B<-p> I<XX.po>
+
+(I<XX.po> is the output, all others are inputs)
 
 =head1 DESCRIPTION
 
@@ -27,19 +27,19 @@
 interestingly, the maintenance of translations) using gettext tools on
 areas where they were not expected like documentation.
 
-The C<po4a-gettextize> script is in charge of converting documentation
-files to PO files.  If you start a new translation, C<po4a-gettextize>
+The B<po4a-gettextize> script is in charge of converting documentation
+files to PO files.  If you start a new translation, B<po4a-gettextize>
 will extract the translatable strings from the documentation file and
 write a POT file from it.
 
-If you already have a translated file, C<po4a-gettextize> will try to
+If you already have a translated file, B<po4a-gettextize> will try to
 extract the translations it contains and put them in place in the written
 PO file. Be warned that very few intelligence is used in this process: the
 Nth string of the translated file is supposed to be the translation of the
 Nth string in the original. If it's not the case, you're dead. That's why
 it is very important that both files share exactly the same structure.
 
-However, C<po4a-gettextize> will diagnose your death by detecting any
+However, B<po4a-gettextize> will diagnose your death by detecting any
 desynchronisation between files, and reporting where they occur. In that
 case, you should edit manually the files to solve the reported
 disparity. Even if no error were reported, you should check carefully that the
@@ -59,76 +59,76 @@
 
 =over 4
 
-=item -f, --format
+=item B<-f>, B<--format>
 
 Format of the documentation you want to handle. Use the --help-format
 option to see the list of available formats.
 
-=item -m, --master
+=item B<-m>, B<--master>
 
 File containing the master document to translate. You can use this option
 multiple times if you want to gettextize multiple documents.
 
-=item -M, --master-charset
+=item B<-M>, B<--master-charset>
 
 Charset of the file containing the document to translate.
 
-=item -l, --localized
+=item B<-l>, B<--localized>
 
 File containing the localized (translated) document. If you provided
 multiple master files, you may wish to provide multiple localized file by
 using this option more than once.
 
-=item -L, --localized-charset
+=item B<-L>, B<--localized-charset>
 
 Charset of the file containing the localized document.
 
-=item -p, --po
+=item B<-p>, B<--po>
 
 File where the message catalog should be written. If not given, the message
 catalog will be written to the standard output.
 
-=item -o, --option
+=item B<-o>, B<--option>
 
 Extra option(s) to pass to the format plugin. Specify each option in the
-'name=value' format. See the documentation of each plugin for more
+'I<name>B<=>I<value>' format. See the documentation of each plugin for more
 information about the valid options and their meanings.
 
-=item -h, --help
+=item B<-h>, B<--help>
 
 Show a short help message.
 
-=item --help-format
+=item B<--help-format>
 
 List the documentation format understood by po4a.
 
-=item -V, --version
+=item B<-V>, B<--version>
 
 Display the version of the script and exit.
 
-=item -v, --verbose
+=item B<-v>, B<--verbose>
 
 Increase the verbosity of the program.
 
-=item -d, --debug
+=item B<-d>, B<--debug>
 
 Output some debugging information.
 
-=item --msgid-bugs-address email at address
+=item B<--msgid-bugs-address> I<email at address>
 
 Set the report address for msgid bugs. By default, the created POT files
 have no Report-Msgid-Bugs-To fields.
 
-=item --copyright-holder string
+=item B<--copyright-holder> I<string>
 
 Set the copyright holder in the POT header. The default value is
 "Free Software Foundation, Inc."
 
-=item --package-name string
+=item B<--package-name> I<string>
 
 Set the package name for the POT header. The default is "PACKAGE".
 
-=item --package-version string
+=item B<--package-version> I<string>
 
 Set the package version for the POT header. The default is "VERSION".
 

Modified: branches/0.40.x/po4a-normalize
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/po4a-normalize?rev=2394&op=diff
==============================================================================
--- branches/0.40.x/po4a-normalize (original)
+++ branches/0.40.x/po4a-normalize Sun Nov 28 23:16:25 2010
@@ -17,7 +17,7 @@
 
 =head1 SYNOPSIS
 
-po4a-normalize -f E<lt>fmtE<gt> E<lt>master.docE<gt>
+B<po4a-normalize> B<-f> I<fmt> I<master.doc>
 
 =head1 DESCRIPTION
 
@@ -25,25 +25,25 @@
 interestingly, the maintenance of translations) using gettext tools on
 areas where they were not expected like documentation.
 
-The C<po4a-normalize> script is a debugging tool used to make sure that
+The B<po4a-normalize> script is a debugging tool used to make sure that
 po4a don't change the document when it's not supposed to. Only use it if
 you're developing a new module, or if you doubt the sanity of the tools.
 
-The generated document will be written to po4a-normalize.output while the
-generated PO file will be written to po4a-normalize.po. No way to change
+The generated document will be written to F<po4a-normalize.output> while the
+generated PO file will be written to F<po4a-normalize.po>. No way to change
 that ;)
 
 =head1 OPTIONS
 
 =over 4
 
-=item -o, --option
+=item B<-o>, B<--option>
 
 Extra option(s) to pass to the format plugin. Specify each option in the
-'name=value' format. See the documentation of each plugin for more
+'I<name>B<=>I<value>' format. See the documentation of each plugin for more
 information about the valid options and their meanings.
 
-=item -b, --blank
+=item B<-b>, B<--blank>
 
 Create an blank translated document.
 The generated translated document will be generated assuming all messages
@@ -51,24 +51,24 @@
 
 This is useful to check what parts of the document cannot be translated.
 
-=item -h, --help
+=item B<-h>, B<--help>
 
 Show a short help message.
 
-=item --help-format
+=item B<--help-format>
 
 List the documentation format understood by po4a.
 
-=item -f, --format
+=item B<-f>, B<--format>
 
 Format of the documentation you want to handle. Use the --help-format
 option to see the list of available formats.
 
-=item -M, --master-charset
+=item B<-M>, B<--master-charset>
 
 Charset of the file containing the document to translate.
 
-=item -V, --version
+=item B<-V>, B<--version>
 
 Display the version of the script and exit.
 

Modified: branches/0.40.x/po4a-translate
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/po4a-translate?rev=2394&op=diff
==============================================================================
--- branches/0.40.x/po4a-translate (original)
+++ branches/0.40.x/po4a-translate Sun Nov 28 23:16:25 2010
@@ -17,9 +17,9 @@
 
 =head1 SYNOPSIS
 
-po4a-translate -f E<lt>fmtE<gt> -m E<lt>master.docE<gt> -p E<lt>XX.poE<gt> -l E<lt>XX.docE<gt>
-
-(XX.doc is the output, all others are inputs)
+B<po4a-translate> B<-f> I<fmt> B<-m> I<master.doc> B<-p> I<XX.po> B<-l> I<XX.doc>
+
+(I<XX.doc> is the output, all others are inputs)
 
 =head1 DESCRIPTION
 
@@ -27,85 +27,85 @@
 interestingly, the maintenance of translations) using gettext tools on
 areas where they were not expected like documentation.
 
-The C<po4a-translate> script is in charge of converting the translation
+The B<po4a-translate> script is in charge of converting the translation
 (which was done in a PO file) under the documentation format back. The
-provided C<PO> file should be the translation of the C<POT> file which were
-produced by po4a-gettextize(1).
+provided PO file should be the translation of the POT file which were
+produced by L<po4a-gettextize(1)>.
 
 =head1 OPTIONS
 
 =over 4
 
-=item -f, --format
-
-Format of the documentation you want to handle. Use the --help-format
+=item B<-f>, B<--format>
+
+Format of the documentation you want to handle. Use the B<--help-format>
 option to see the list of available formats.
 
-=item -a, --addendum
+=item B<-a>, B<--addendum>
 
 Add a file to the resulting file (to put translator's name or a section
 "About this translation", for example). The first line of the file to insert
 should be a PO4A header indicating where it should be added (see section
-I<HOWTO add extra text to translations> in po4a(7)).
-
-=item -A, --addendum-charset
+B<HOWTO add extra text to translations> in L<po4a(7)>).
+
+=item B<-A>, B<--addendum-charset>
 
 Charset of the addenda. Note that all the addenda should be in the same
 charset.
 
-=item -m, --master
+=item B<-m>, B<--master>
 
 File containing the master document to translate.
 
-=item -M, --master-charset
+=item B<-M>, B<--master-charset>
 
 Charset of the file containing the document to translate.
 
-=item -l, --localized
+=item B<-l>, B<--localized>
 
 File where the localized (translated) document should be written.
 
-=item -L, --localized-charset
+=item B<-L>, B<--localized-charset>
 
 Charset of the file containing the localized document.
 
-=item -p, --po
+=item B<-p>, B<--po>
 
 File from which the message catalog should be read.
 
-=item -o, --option
+=item B<-o>, B<--option>
 
 Extra option(s) to pass to the format plugin. Specify each option in the
-'name=value' format. See the documentation of each plugin for more
+'I<name>B<=>I<value>' format. See the documentation of each plugin for more
 information about the valid options and their meanings.
 
-=item -k, --keep
+=item B<-k>, B<--keep>
 
 Minimal threshold for translation percentage to keep (ie, write) the
 resulting file (default: 80). Ie, by default, files have to be translated
 at at least 80% to get written.
 
-=item -w, --width
+=item B<-w>, B<--width>
 
 Column at which we should wrap the resulting file.
 
-=item -h, --help
+=item B<-h>, B<--help>
 
 Show a short help message.
 
-=item --help-format
+=item B<--help-format>
 
 List the documentation format understood by po4a.
 
-=item -V, --version
+=item B<-V>, B<--version>
 
 Display the version of the script and exit.
 
-=item -v, --verbose
+=item B<-v>, B<--verbose>
 
 Increase the verbosity of the program.
 
-=item -d, --debug
+=item B<-d>, B<--debug>
 
 Output some debugging information.
 
@@ -114,8 +114,8 @@
 =head1 Adding content (beside translations) to generated files
 
 To add some extra content to the generated document beside what you
-translated (like the name of the translator, or a "about this translation"
-section), you should use the C<--addendum> option. 
+translated (like the name of the translator, or a "About this translation"
+section), you should use the B<--addendum> option. 
 
 The first line of the addendum must be a header indicating where to put
 it in the document (it can be before or after a given part of the
@@ -128,7 +128,7 @@
 the translation).
 
 The header has a pretty rigid syntax. For more information on how to use
-this feature and how it works, please refer to the po4a(7) man page.
+this feature and how it works, please refer to the L<po4a(7)> man page.
 
 =head1 SEE ALSO
 

Modified: branches/0.40.x/po4a-updatepo
URL: http://svn.debian.org/wsvn/po4a/branches/0.40.x/po4a-updatepo?rev=2394&op=diff
==============================================================================
--- branches/0.40.x/po4a-updatepo (original)
+++ branches/0.40.x/po4a-updatepo Sun Nov 28 23:16:25 2010
@@ -17,9 +17,9 @@
 
 =head1 SYNOPSIS
 
-po4a-updatepo -f E<lt>fmtE<gt> (-m E<lt>master.docE<gt>)+ (-p E<lt>XX.poE<gt>)+
-
-(XX.po are the outputs, all others are inputs)
+B<po4a-updatepo> B<-f> I<fmt> (B<-m> I<master.docE>)+ (B<-p> I<XX.po>)+
+
+(I<XX.po> are the outputs, all others are inputs)
 
 =head1 DESCRIPTION
 
@@ -27,7 +27,7 @@
 interestingly, the maintenance of translations) using gettext tools on
 areas where they were not expected like documentation.
 
-The C<po4a-updatepo> script is in charge of updating PO files to make
+The B<po4a-updatepo> script is in charge of updating PO files to make
 them reflect the changes made to the original documentation file. For that,
 it converts the documentation file to a POT file, and call L<msgmerge(1)>
 on this new POT and on the provided PO files.
@@ -44,80 +44,80 @@
 
 =over 4
 
-=item -f, --format
+=item B<-f>, B<--format>
 
 Format of the documentation you want to handle. Use the --help-format
 option to see the list of available formats.
 
-=item -m, --master
+=item B<-m>, B<--master>
 
 File(s) containing the master document to translate.
 
-=item -M, --master-charset
+=item B<-M>, B<--master-charset>
 
 Charset of the files containing the document to translate. Note that all
 files must have the same charset.
 
-=item -p, --po
+=item B<-p>, B<--po>
 
 PO file(s) to update. If these files do not exist, they are created by
-C<po4a-updatepo>.
-
-=item -o, --option
+B<po4a-updatepo>.
+
+=item B<-o>, B<--option>
 
 Extra option(s) to pass to the format plugin and other po4a internal module.
-Specify each option in the 'name=value' format. See the documentation of
+Specify each option in the 'I<name>B<=>I<value>' format. See the documentation of
 each plugin for more information about the valid options and their meanings.
 
-=item --no-previous
-
-This option removes '--previous' from the options passed to msgmerge.
+=item B<--no-previous>
+
+This option removes B<--previous> from the options passed to msgmerge.
 This permits to support versions of gettext earlier than 0.16.
 
-=item --previous
-
-This option adds '--previous' to the options passed to msgmerge.
+=item B<--previous>
+
+This option adds B<--previous> to the options passed to msgmerge.
 It requires gettext 0.16 or later, and is activated by default.
 
-=item --msgmerge-opt options
+=item B<--msgmerge-opt> I<options>
 
 Extra options for msgmerge.
 
-=item -h, --help
+=item B<-h>, B<--help>
 
 Show a short help message.
 
-=item --help-format
+=item B<--help-format>
 
 List the documentation format handled by po4a.
 
-=item -V, --version
+=item B<-V>, B<--version>
 
 Display the version of the script and exit.
 
-=item -v, --verbose
+=item B<-v>, B<--verbose>
 
 Increase the verbosity of the program.
 
-=item -d, --debug
+=item B<-d>, B<--debug>
 
 Output some debugging information.
 
-=item --msgid-bugs-address email at address
+=item B<--msgid-bugs-address> I<email at address>
 
 Set the report address for msgid bugs. By default, the created POT files
 have no Report-Msgid-Bugs-To fields.
 
-=item --copyright-holder string
+=item B<--copyright-holder> I<string>
 
 Set the copyright holder in the POT header. The default value is
 "Free Software Foundation, Inc."
 
-=item --package-name string
+=item B<--package-name> I<string>
 
 Set the package name for the POT header. The default is "PACKAGE".
 
-=item --package-version string
+=item B<--package-version> I<string>
 
 Set the package version for the POT header. The default is "VERSION".
 




More information about the Po4a-commits mailing list