--- platform.pod 2003/09/29 12:53:15 1.4
+++ platform.pod 2003/10/26 11:34:44 1.5
@@ -59,13 +59,16 @@
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}>".
+I<technology> identification. For each 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]>" (verbose), "C<%{xx}>" (regular) and "C<%E<lt>xxE<gt>>"
+(concise).
+
=head1 OPTIONS
@@ -86,18 +89,23 @@
%[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
@@ -145,13 +153,58 @@
=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.
+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:
+
+=over 4
+
+=item B<binary>
+
+Binary Package Id (OpenPKG RPM).
+This is equal to "C<-F '%<ap>-%<sp>' -L -S '' -C '+'>"
+and results in outputs like "C<ix86-freebsd4.9>" and "C<ix86-debian3.0>".
+
+=item B<build>
+
+Build-Time Checking (OpenPKG RPM).
+This is equal to "C<-F '%<at>-%<st>' -L -S '' -C '+'>"
+and results in outputs like "C<i686-freebsd4.9>" and "C<i586-linux2.4>".
+
+=item B<gnu>
+
+GNU F<config.guess> Style Id.
+This is similar to B<build> and is equal to "C<-F '"%<at>-unknown-%<st>' -L -S '' -C '+'>"
+and results in outputs like "C<i686-unknown-freebsd4.9>" and "C<i586-unknown-linux2.4>".
+
+=item B<web>
+
+HTTP Server Header Id.
+This is equal to "C<-F '"%<sp>-%<ac>' -S '/' -C '+'>"
+and results in outputs like "C<FreeBSD/4.9-iX86>" and "C<Debian/3.0-iX86>".
+
+=item B<summary>
+
+Human Readable Verbose Summary Information. This is equal to "C<-F
+'Class: %[sc] (%[ac])\nProduct: %[sp] (%[ap])\nTechnology: %[st]
+(%[at])' -S ' ' -C '/'>" and results in outputs like:
+
+ Class: 4.4BSD (iX86)
+ Product: FreeBSD 4.9-RC (iX86)
+ Technology: FreeBSD 4.9-RC (i686)
+
+and
+
+ Class: LSB (iX86)
+ Product: Debian GNU/Linux 3.0 (iX86)
+ Technology: GNU/Linux 2.2/2.4 (i686)
+
+=item B<all-in-one>
+
+All-In-One Full-Table Information. This just outputs really
+all 2x2x3 identification strings as a table.
+
+=back
=item B<-d>, B<--debug>
@@ -197,7 +250,8 @@
B<OSSP platform> currently knows the following particular Unix platforms
in detail: FreeBSD, NetBSD, OpenBSD, Linux, Sun Solaris, SCO UnixWare,
-QNX Neutrino, SGI IRIX, HP HP-UX, HP Tru64, IBM AIX.
+QNX Neutrino, SGI IRIX, HP HP-UX, HP Tru64, IBM AIX and Apple MacOS X
+Darwin.
All other Unix platforms are recognized through generic uname(1)
information and so usually can be identified sufficiently, although the
@@ -215,15 +269,17 @@
Engelschall> for use in the B<OSSP> and B<OpenPKG> projects. It was
prompted by the need in B<OpenPKG> to have both product (for RPM
filenames) and technology (for build-time decisions) identifiers for the
-Unix platforms packages are maintained for. It was inspired by B<GNU>
-F<config.guess> and older B<GNU shtool> F<guessos> command.
+Unix platforms, OpenPKG packages are maintained for. It was inspired by
+the B<GNU> F<config.guess> and the old 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
+the time and is not used at all in all projects I've ever seen) and
+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.
+B<OSSP platform> is that it (still) knows less particular platforms,
+although the generic platform identification is sufficient enough most
+of the time.
=head1 AUTHOR
|
