--- platform.pod 2003/09/08 11:16:13 1.1
+++ platform.pod 2003/09/08 11:47:05 1.2
@@ -32,11 +32,109 @@
=head1 SYNOPSIS
-...
+B<platform>
+[B<-F>|B<--format> I<FORMAT>]
+[B<-S>|B<--sep> I<STRING>]
+[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<-V>|B<--version>]
+
+B<platform>
+[B<-h>|B<--help>]
=head1 DESCRIPTION
-...
+B<OSSP platform> is a flexible Unix platform identification program.
+It distinguishes a platform according to its I<hardware architecture>
+and I<operating system>. For both there is a I<class>, I<product> and
+I<technology> identification. For all of those six identifications,
+there is a I<verbose>, I<regular> and I<concise> version. This leads to
+eithteen (2x3x3) available identification strings for each platform,
+from which usually 2 are choosen in a particular situation. This is
+done by assembling the platform identification string using a I<FORMAT>
+string containing one or more identification constructs of the forms
+"C<%xx>", "C<%E<lt>xxE<gt>>". "C<%[xx]>", and "C<%{xx}>".
+
+=head1 OPTIONS
+
+The following command line options are available.
+
+=over 4
+
+=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
+
+=item B<-S>, B<--sep> I<STRING>
+
+=item B<-C>, B<--conc> I<STRING>
+
+=item B<-L>, B<--lower>
+
+=item B<-U>, B<--upper>
+
+=item B<-T>, B<--type> I<TYPE>
+
+=item B<-v>, B<--verbose>
+
+=item B<-c>, B<--concise>
+
+=item B<-n>, B<--newline>
+
+=item B<-d>, B<--debug>
+
+=item B<-V>, B<--version>
+
+=item B<-h>, B<--help>
+
+=back
+
+=head1 EXAMPLES
+
+The following real-life use cases are known:
+
+=over 4
+
+=item B<OpenPKG> build-time decisions
+
+ 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"
+
+=item F<README> files
+
+ platform -v -F "%sp (%ap)"
+ platform -v -F "%sc (%ac)"
+
+=back
=head1 SEE ALSO
@@ -53,6 +151,13 @@
Unix platforms packages are maintained for. It was inspired by B<GNU>
F<config.guess> and older B<GNU shtool> F<guessos> command.
+The major difference to B<GNU> F<config.guess> is that B<OSSP platform>
+does not use a I<vendor> identification (cannot be determined most of
+the time and is not used at all in all projects I've ever seen), is
+a lot more flexible (class, product and technology identifications
+combined with verbose, regular and consise outputs). The drawback of
+B<OSSP platform> is that it (still) knows less particular platforms.
+
=head1 AUTHOR
Ralf S. Engelschall
|
