[Po4a-devel]Try to clarify --option's documentation
Reading the documentation/man pages, it was not very clear to me how to
use the '--option' command line option. Especially:
* how does one pass more than one option?
(answer: use '--option' more than once)
* how do you specify the option name and its value
(answer: use 'name=value' for each option)
It turns out it works in a pretty standard and reasonable way but it
seemed worth trying to clarify the documentation so I would not have to
read the source code next time around. Hopefully I succeeded in making
things clearer. If not let me know, I'm open to suggestions.
Changelog:
* po4a-gettextize
po4a-normalize
po4a-translate
po4a-updatepo
Francois Gouget <fgouget(a)codeweavers.com>
Clarify the '--option' documentation.
--
Francois Gouget
fgouget(a)codeweavers.com
Index: po4a-gettextize
===================================================================
RCS file: /cvsroot/po4a/po4a/po4a-gettextize,v
retrieving revision 1.30
diff -u -p -r1.30 po4a-gettextize
--- po4a-gettextize 4 Mar 2005 16:40:40 -0000 1.30
+++ po4a-gettextize 24 May 2005 11:47:00 -0000
@@ -88,8 +88,9 @@ catalog will be written to the standard
=item -o, --option
-Pass an extra option to the format plugin. See the documentation of each
-plugin for more information about the valid options and their meanings.
+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
+information about the valid options and their meanings.
=item -h, --help
Index: po4a-normalize
===================================================================
RCS file: /cvsroot/po4a/po4a/po4a-normalize,v
retrieving revision 1.24
diff -u -p -r1.24 po4a-normalize
--- po4a-normalize 4 Mar 2005 16:40:40 -0000 1.24
+++ po4a-normalize 24 May 2005 11:47:00 -0000
@@ -40,8 +40,9 @@ that ;)
=item -o, --option
-Pass an extra option to the format plugin. See the documentation of each
-plugin for more information about the valid options and their meanings.
+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
+information about the valid options and their meanings.
=item -h, --help
Index: po4a-translate
===================================================================
RCS file: /cvsroot/po4a/po4a/po4a-translate,v
retrieving revision 1.36
diff -u -p -r1.36 po4a-translate
--- po4a-translate 4 Mar 2005 16:40:40 -0000 1.36
+++ po4a-translate 24 May 2005 11:47:00 -0000
@@ -76,8 +76,9 @@ File from which the message catalog shou
=item -o, --option
-Pass an extra option to the format plugin. See the documentation of each
-plugin for more information about the valid options and their meanings.
+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
+information about the valid options and their meanings.
=item -k, --keep
Index: po4a-updatepo
===================================================================
RCS file: /cvsroot/po4a/po4a/po4a-updatepo,v
retrieving revision 1.33
diff -u -p -r1.33 po4a-updatepo
--- po4a-updatepo 4 Mar 2005 16:40:41 -0000 1.33
+++ po4a-updatepo 24 May 2005 11:47:00 -0000
@@ -66,8 +66,9 @@ C<po4a-updatepo>.
=item -o, --option
-Pass an extra option to the format plugin. See the documentation of each
-plugin for more information about the valid options and their meanings.
+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
+information about the valid options and their meanings.
=item -h, --help