--- platform.pod 2003/09/08 11:47:05 1.2
+++ platform.pod 2003/09/08 19:03:03 1.3
@@ -38,13 +38,17 @@
[B<-C>|B<--conc> I<STRING>]
[B<-L>|B<--lower>]
[B<-U>|B<--upper>]
-[B<-T>|B<--type> I<TYPE>]
[B<-v>|B<--verbose>]
[B<-c>|B<--concise>]
[B<-n>|B<--newline>]
[B<-d>|B<--debug>]
B<platform>
+[B<-t>|B<--type> I<TYPE>]
+[B<-n>|B<--newline>]
+[B<-d>|B<--debug>]
+
+B<platform>
[B<-V>|B<--version>]
B<platform>
@@ -71,47 +75,96 @@
=item B<-F>, B<--format> I<FORMAT>
- %[ac] verbose hardware architecture class
- %[ap] verbose hardware architecture product
- %[at] verbose hardware architecture technology
- %[sc] verbose operating system class
- %[sp] verbose operating system product
- %[st] verbose operating system technology
- %{ac} regular hardware architecture class
- %{ap} regular hardware architecture product
- %{at} regular hardware architecture technology
- %{sc} regular operating system class
- %{sp} regular operating system product
- %{st} regular operating system technology
- %<ac> concise hardware architecture class
- %<ap> concise hardware architecture product
- %<at> concise hardware architecture technology
- %<sc> concise operating system class
- %<sp> concise operating system product
- %<st> concise operating system technology
+This option controls the output formatting of this program. It is a
+plain-text string with the "C<%>I<xx>" constructs which expand to the
+various platform information strings. "C<%{>I<xx>C<}>" is the canonical
+regular version of the information. "C<%[>I<xx>C<]>" is the verbose
+version of the information. "C<%E<lt>>I<xx>C<E<gt>>" is the concise
+version of the information. In total, the following constructs
+are available for expansion:
+
+ %[ac] verbose hardware architecture class
+ %{ac} regular hardware architecture class
+ %<ac> concise hardware architecture class
+ %[ap] verbose hardware architecture product
+ %{ap} regular hardware architecture product
+ %<ap> concise hardware architecture product
+ %[at] verbose hardware architecture technology
+ %{at} regular hardware architecture technology
+ %<at> concise hardware architecture technology
+ %[sc] verbose operating system class
+ %{sc} regular operating system class
+ %<sc> concise operating system class
+ %[sp] verbose operating system product
+ %{sp} regular operating system product
+ %<sp> concise operating system product
+ %[st] verbose operating system technology
+ %{st} regular operating system technology
+ %<st> concise operating system technology
+
+The default I<FORMAT> string is "C<%{sp} (%{ap})>", providing the
+regular operating system and hardware architecture product information.
=item B<-S>, B<--sep> I<STRING>
+This option sets the word I<separation> string for the platform
+information strings. By default it is "C< >" (whitespace). It is
+especially used for separating the operating system name and
+the operating system version.
+
=item B<-C>, B<--conc> I<STRING>
+This option sets the word I<concatenation> string for the platform
+information strings. By default it is "C</>". It is especially used to
+concatenate multiple parts in operating system name and version parts.
+
=item B<-L>, B<--lower>
+This options enforces conversion of the output to all I<lower> case.
+
=item B<-U>, B<--upper>
-=item B<-T>, B<--type> I<TYPE>
+This options enforces conversion of the output to all I<upper> case.
=item B<-v>, B<--verbose>
+This option enforces verbose versions of all expansion constructs
+in I<FORMAT> string of option B<-F>. It is equal to specifying all
+expansion constructs as "C<%[>I<xx>C<]>".
+
=item B<-c>, B<--concise>
-=item B<-n>, B<--newline>
+This option enforces concise versions of all expansion constructs
+in I<FORMAT> string of option B<-F>. It is equal to specifying all
+expansion constructs as "C<%E<lt>>I<xx>C<E<gt>>".
+
+=item B<-n>, B<--no-newline>
+
+This option omits the usual trailing newline character in the output.
+
+=item B<-t>, B<--type> I<TYPE>
+
+This option is a meta option which internally sets options B<-F>, B<-S>,
+B<-C>, B<-L>, B<-U>, B<-v> or B<-c> according to I<TYPE>. It can be
+used to easily specify various commonly known outputs. The following
+I<TYPE>s are available: "C<binary>" for binary package id (OpenPKG
+RPM), "C<build>" for build time checking (OpenPKG RPM), "C<gnu> for GNU
+F<config.guess> style id "C<web>" for non-whitespace HTTP Server-header
+id, "C<summary>" for human readable verbose summary information, and
+"C<all-in-one>" for an all-in-one full-table information.
=item B<-d>, B<--debug>
+This option enables some internal debugging messages.
+
=item B<-V>, B<--version>
+This option outputs the version information of B<OSSP platform> only.
+
=item B<-h>, B<--help>
+This option outputs the usage information of B<OSSP platform> only.
+
=back
=head1 EXAMPLES
@@ -122,17 +175,21 @@
=item B<OpenPKG> build-time decisions
- platform -c -L -S "" -C "+" -F "%at-%st"
- platform -c -L -S "" -C "+" -F "%ac-%sc"
+ $ platform -c -L -S "" -C "+" -F "%at-%st"
+ $ platform -c -L -S "" -C "+" -F "%ac-%sc"
=item B<OpenPKG> binary RPM packages
-
- platform -c -L -S "" -C "+" -F "%ap-%sp"
+
+ $ platform -c -L -S "" -C "+" -F "%ap-%sp"
=item F<README> files
-
- platform -v -F "%sp (%ap)"
- platform -v -F "%sc (%ac)"
+
+ $ platform -v -F "%sp (%ap)"
+ $ platform -v -F "%sc (%ac)"
+
+=item Debugging
+
+ $ platform --type=all-in-one
=back
|
