Skip to content

Commit

Permalink
po4a: Add documentation for the new --porefs flag
Browse files Browse the repository at this point in the history
In po4a, rearrange options to better show which options operate on POT and PO
files. Copy the same description of PO flags in po4a, po4a-updatepo and
lib/Locale/Po4a/Po.pm.
  • Loading branch information
Denis Barbier committed Sep 9, 2012
1 parent 0e951a2 commit 2f189b1
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 14 deletions.
27 changes: 23 additions & 4 deletions lib/Locale/Po4a/Po.pm
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,30 @@ from this.
=over 4
=item B<porefs>
=item B<porefs> I<type>
This specifies the reference format. It can be one of B<none> to not produce
any reference, B<noline> to not specify the line number, and B<full> to
include complete references.
Specify the reference format. Argument I<type> can be one of B<none> to not
produce any reference, B<noline> to not specify the line number (more
accurately all line numbers are replaced by 1), and B<full> to include complete
references.
=item B<--msgid-bugs-address> I<email@address>
Set the report address for msgid bugs. By default, the created POT files
have no Report-Msgid-Bugs-To fields.
=item B<--copyright-holder> I<string>
Set the copyright holder in the POT header. The default value is
"Free Software Foundation, Inc."
=item B<--package-name> I<string>
Set the package name for the POT header. The default is "PACKAGE".
=item B<--package-version> I<string>
Set the package version for the POT header. The default is "VERSION".
=back
Expand Down
39 changes: 29 additions & 10 deletions po4a
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,29 @@ Define a variable that will be expanded in the B<po4a> configuration file.
Every occurrence of I<$(var)> will be replaced by I<value>.
This option can be used multiple times.
=item B<--srcdir> I<SRCDIR>
Set the base directory for all input documents specified in the B<po4a>
configuration file.
=item B<--destdir> I<DESTDIR>
Set the base directory for all the output documents specified in the B<po4a>
configuration file.
=back
=head2 OPTIONS WHICH MODIFY POT HEADER
=over 4
=item B<porefs> I<type>
Specify the reference format. Argument I<type> can be one of B<none> to not
produce any reference, B<noline> to not specify the line number (more
accurately all line numbers are replaced by 1), and B<full> to include complete
references.
=item B<--msgid-bugs-address> I<email@address>
Set the report address for msgid bugs. By default, the created POT files
Expand All @@ -420,6 +443,12 @@ Set the package name for the POT header. The default is "PACKAGE".
Set the package version for the POT header. The default is "VERSION".
=back
=head2 OPTIONS TO MODIFY PO FILES
=over 4
=item B<--msgmerge-opt> I<options>
Extra options for B<msgmerge>.
Expand All @@ -436,16 +465,6 @@ This permits to support versions of B<gettext> earlier than 0.16.
This option adds B<--previous> to the options passed to B<msgmerge>.
It requires B<gettext> 0.16 or later, and is activated by default.
=item B<--srcdir> I<SRCDIR>
Set the base directory for all input documents specified in the B<po4a>
configuration file.
=item B<--destdir> I<DESTDIR>
Set the base directory for all the output documents specified in the B<po4a>
configuration file.
=back
=head2 EXAMPLE
Expand Down
7 changes: 7 additions & 0 deletions po4a-updatepo
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,13 @@ Increase the verbosity of the program.
Output some debugging information.
=item B<porefs> I<type>
Specify the reference format. Argument I<type> can be one of B<none> to not
produce any reference, B<noline> to not specify the line number (more
accurately all line numbers are replaced by 1), and B<full> to include complete
references.
=item B<--msgid-bugs-address> I<email@address>
Set the report address for msgid bugs. By default, the created POT files
Expand Down

0 comments on commit 2f189b1

Please sign in to comment.