|
Check-in Number:
|
3730 | |
| Date: |
2004-Jan-10 21:12:46 (local)
2004-Jan-10 20:12:46 (UTC) |
| User: | rse |
| Branch: | |
| Comment: |
add a bunch of initial documentation |
| Tickets: |
|
| Inspections: |
|
| Files: |
|
ossp-pkg/uuid/README 1.1 -> 1.2
--- README 2004/01/06 20:14:28 1.1
+++ README 2004/01/10 20:12:46 1.2
@@ -9,7 +9,11 @@
ABSTRACT
- OSSP uuid is ...
+ OSSP uuid is a ISO-C application programming interface (API) and
+ corresponding command line interface (CLI) for the generation of DCE
+ 1.1 and ISO/IEC 11578:1996 compliant Universally Unique Identifiers
+ (UUID). It supports DCE 1.1 variant UUIDs of version 1 (time and node
+ based), version 3 (name based) and version 4 (random number based).
COPYRIGHT AND LICENSE
|
|
ossp-pkg/uuid/TODO 1.1 -> 1.2
--- TODO 2004/01/10 19:35:02 1.1
+++ TODO 2004/01/10 20:12:46 1.2
@@ -2,3 +2,4 @@
- write documentation uuid(3) [uuid.pod]
- write documentation uuid(1) [uuid_cli.pod]
- more platform support in uuid_mac.c?!
+- implement uuid -d (uuid_dump): dumping/decoding
|
|
ossp-pkg/uuid/uuid.pod 1.1 -> 1.2
--- uuid.pod 2004/01/06 20:20:12 1.1
+++ uuid.pod 2004/01/10 20:12:46 1.2
@@ -33,11 +33,15 @@
B<OSSP uuid> - B<Universally Unique Identifier>
-=head1 SYNOPSIS
+=head1 DESCRIPTION
-...FIXME...
+B<OSSP uuid> is a ISO-C application programming interface (API) and
+corresponding command line interface (CLI) for the generation of DCE
+1.1 and ISO/IEC 11578:1996 compliant I<Universally Unique Identifiers>
+(UUID). It supports DCE 1.1 variant UUIDs of version 1 (time and node
+based), version 3 (name based) and version 4 (random number based).
-=head1 DESCRIPTION
+This is the ISO-C application programming interface (API).
=head2 Overview
@@ -76,7 +80,57 @@
=head1 APPLICATION PROGRAMMING INTERFACE
-...FIXME...
+=over 4
+
+=item uuid_rc_t B<uuid_create>(uuid_t **I<uuid>);
+
+FIXME
+
+=item uuid_rc_t B<uuid_destroy>(uuid_t *I<uuid>);
+
+FIXME
+
+=item uuid_rc_t B<uuid_nil>(uuid_t *I<uuid>);
+
+FIXME
+
+=item uuid_rc_t B<uuid_compare>(uuid_t *I<uuid>, uuid_t *I<uuid2>, int *I<result>);
+
+FIXME
+
+=item uuid_rc_t B<uuid_isnil>(uuid_t *I<uuid>, int *I<result>);
+
+FIXME
+
+=item uuid_rc_t B<uuid_unpack>(uuid_t *I<uuid>, const void *I<buf>);
+
+FIXME
+
+=item uuid_rc_t B<uuid_pack>(uuid_t *I<uuid>, void **I<buf>);
+
+FIXME
+
+=item uuid_rc_t B<uuid_parse>(uuid_t *I<uuid>, const char *I<str>);
+
+FIXME
+
+=item uuid_rc_t B<uuid_format>(uuid_t *I<uuid>, char **I<str>);
+
+FIXME
+
+=item uuid_rc_t B<uuid_generate>(uuid_t *I<uuid>, unsigned int I<mode>, ...);
+
+FIXME
+
+=item uuid_rc_t B<uuid_dump>(uuid_t *I<uuid>, char **I<str>);
+
+FIXME
+
+=item char *B<uuid_error>(uuid_rc_t I<rc>);
+
+FIXME
+
+=back
=head1 SEE ALSO
|
|
ossp-pkg/uuid/uuid_cli.pod 1.1 -> 1.2
--- uuid_cli.pod 2004/01/06 20:20:12 1.1
+++ uuid_cli.pod 2004/01/10 20:12:46 1.2
@@ -35,15 +35,85 @@
=head1 SYNOPSIS
-...FIXME...
+B<uuid>
+[B<-v> I<version>]
+[B<-n> I<count>]
+[B<-1>]
+[B<-r>]
+[B<-o> I<filename>]
+[I<namespace> I<name>]
+
+B<uuid>
+B<-d>
+[B<-r>]
+[B<-o> I<filename>]
+[I<uuid>]
=head1 DESCRIPTION
-...FIXME...
+B<OSSP uuid> is a ISO-C application programming interface (API) and
+corresponding command line interface (CLI) for the generation of DCE
+1.1 and ISO/IEC 11578:1996 compliant I<Universally Unique Identifiers>
+(UUID). It supports DCE 1.1 variant UUIDs of version 1 (time and node
+based), version 3 (name based) and version 4 (random number based).
+
+This is the command line interface (CLI). For a brief overview of UUIDs
+see the documentation of the application programming interface (API) in
+uuid(3).
=head1 OPTIONS
-...FIXME...
+=over 3
+
+=item B<-v> I<version>
+
+Sets the version of the generated DCE 1.1 variant UUID.
+Supported are I<version> "C<1>", "C<3>" and "C<4>".
+The default is "C<1>".
+
+=item B<-n> I<count>
+
+Generate I<count> UUIDs instead of just a single one (the default).
+
+=item B<-1>
+
+If option B<-n> is used with a I<count> greater than C<1>, then this
+option can enforce the reset the UUID context for each generated UUID.
+This makes no difference for I<version> C<3> and C<4> UUIDs. But
+version C<1> UUIDs are based on the previously generated UUID which is
+remembered in the UUID context of the API. Option B<-1> deletes the
+remembered UUID on each iteration.
+
+=item B<-r>
+
+Output the generated UUID in 128 bit (network byte order) raw binary
+representation format. The default is to output the generated UUID in
+the standardized ASCII string representation.
+
+=item B<-o> I<filename>
+
+Write output to I<filename> instead of to F<stdout>.
+
+=item B<-d>
+
+Decode a given UUID (either on F<stdin> or as an argument on the command
+line) and dump textual information about the UUID.
+
+=back
+
+=head1 EXAMPLES
+
+ # generate DCE 1.1 variant UUID of version 1 (time and node based)
+ $ uuid -v1
+ 1430fcde-43a9-11d8-8000-0090272ff725
+
+ # generate DCE 1.1 variant UUID of version 3 (name based)
+ $ uuid -v3 URL http://www.ossp.org/
+ 02d9e6d5-9467-382e-8f9b-9300a64ac3cd
+
+ # generate DCE 1.1 variant UUID of version 4 (random data based)
+ $ ./uuid -v4
+ eb424026-6f54-4ef8-a4d0-bb658a1fc6cf
=head1 SEE ALSO
|
|
