head 1.29; access; symbols UUID_1_6_2:1.28 UUID_1_6_1:1.27 UUID_1_6_0:1.26 UUID_1_5_1:1.25 UUID_1_5_0:1.25 UUID_1_4_2:1.24 UUID_1_4_1:1.24 UUID_1_4_0:1.24 UUID_1_3_2:1.23 UUID_1_3_1:1.23 UUID_1_3_0:1.23 UUID_1_2_1:1.19 UUID_1_2_0:1.19 UUID_1_1_2:1.18 UUID_1_1_1:1.17 UUID_1_1_0:1.17 UUID_1_0_4:1.15 UUID_1_0_3:1.15 UUID_1_0_2:1.15 UUID_1_0_1:1.15 UUID_1_0_0:1.15 UUID_0_9_7:1.15 UUID_0_9_6:1.13 UUID_0_9_5:1.13 UUID_0_9_4:1.13 UUID_0_9_3:1.10 UUID_0_9_2:1.10 UUID_0_9_1:1.6 UUID_0_9_0:1.2; locks; strict; comment @# @; 1.29 date 2008.07.05.12.58.16; author rse; state dead; branches; next 1.28; commitid XLXN7vUmABwPcC9t; 1.28 date 2008.03.07.13.52.41; author rse; state Exp; branches; next 1.27; commitid G3E9z8xLWjWDmcUs; 1.27 date 2008.01.10.14.18.47; author rse; state Exp; branches; next 1.26; commitid LqMgFGBgTR7clSMs; 1.26 date 2007.01.01.18.14.54; author rse; state Exp; branches; next 1.25; commitid jOXiIO8S8v7xFP0s; 1.25 date 2006.05.11.09.37.28; author rse; state Exp; branches; next 1.24; commitid u4EPMISJDipjmAwr; 1.24 date 2006.01.13.06.44.30; author rse; state Exp; branches; next 1.23; commitid hYfQc9JIMh4bcphr; 1.23 date 2005.09.02.14.00.00; author rse; state Exp; branches; next 1.22; 1.22 date 2005.08.31.20.10.25; author rse; state Exp; branches; next 1.21; 1.21 date 2005.08.30.20.38.10; author rse; state Exp; branches; next 1.20; 1.20 date 2005.08.30.20.34.35; author rse; state Exp; branches; next 1.19; 1.19 date 2005.01.23.11.28.51; author rse; state Exp; branches; next 1.18; 1.18 date 2004.12.31.19.20.34; author rse; state Exp; branches; next 1.17; 1.17 date 2004.11.03.18.28.51; author rse; state Exp; branches; next 1.16; 1.16 date 2004.11.03.18.23.35; author rse; state Exp; branches; next 1.15; 1.15 date 2004.02.13.16.17.07; author rse; state Exp; branches; next 1.14; 1.14 date 2004.02.13.14.29.32; author rse; state Exp; branches; next 1.13; 1.13 date 2004.01.19.14.11.50; author rse; state Exp; branches; next 1.12; 1.12 date 2004.01.19.12.15.57; author rse; state Exp; branches; next 1.11; 1.11 date 2004.01.18.11.32.40; author rse; state Exp; branches; next 1.10; 1.10 date 2004.01.15.16.23.34; author rse; state Exp; branches; next 1.9; 1.9 date 2004.01.15.15.38.09; author rse; state Exp; branches; next 1.8; 1.8 date 2004.01.15.12.55.54; author rse; state Exp; branches; next 1.7; 1.7 date 2004.01.14.16.00.35; author rse; state Exp; branches; next 1.6; 1.6 date 2004.01.13.19.43.15; author rse; state Exp; branches; next 1.5; 1.5 date 2004.01.13.09.20.03; author rse; state Exp; branches; next 1.4; 1.4 date 2004.01.11.12.14.20; author rse; state Exp; branches; next 1.3; 1.3 date 2004.01.11.08.54.18; author rse; state Exp; branches; next 1.2; 1.2 date 2004.01.10.20.12.46; author rse; state Exp; branches; next 1.1; 1.1 date 2004.01.06.20.20.12; author rse; state Exp; branches; next ; desc @@ 1.29 log @remove OSSP uuid from CVS -- it is now versioned controlled in a Monotone repository @ text @## ## OSSP uuid - Universally Unique Identifier ## Copyright (c) 2004-2008 Ralf S. Engelschall ## Copyright (c) 2004-2008 The OSSP Project ## ## This file is part of OSSP uuid, a library for the generation ## of UUIDs which can found at http://www.ossp.org/pkg/lib/uuid/ ## ## Permission to use, copy, modify, and distribute this software for ## any purpose with or without fee is hereby granted, provided that ## the above copyright notice and this permission notice appear in all ## copies. ## ## THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED ## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF ## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. ## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR ## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, ## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT ## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF ## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, ## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT ## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF ## SUCH DAMAGE. ## ## uuid_cli.pod: manual page ## =pod =head1 NAME B - B =head1 VERSION OSSP uuid UUID_VERSION_STR =head1 SYNOPSIS B [B<-v> I] [B<-m>] [B<-n> I] [B<-1>] [B<-F> I] [B<-o> I] [I I] B B<-d> [B<-r>] [B<-o> I] I =head1 DESCRIPTION B is a ISO-C:1999 application programming interface (API) and corresponding command line interface (CLI) for the generation of DCE 1.1, ISO/IEC 11578:1996 and IETF RFC-4122 compliant I (UUID). It supports DCE 1.1 variant UUIDs of version 1 (time and node based), version 3 (name based, MD5), version 4 (random number based) and version 5 (name based, SHA-1). Additional API bindings are provided for the languages ISO-C++:1998, Perl:5 and PHP:4/5. Optional backward compatibility exists for the ISO-C DCE-1.1 and Perl Data::UUID APIs. UUIDs are 128 bit numbers which are intended to have a high likelihood of uniqueness over space and time and are computationally difficult to guess. They are globally unique identifiers which can be locally generated without contacting a global registration authority. UUIDs are intended as unique identifiers for both mass tagging objects with an extremely short lifetime and to reliably identifying very persistent objects across a network. This is the command line interface (CLI) of B. For a detailed description of UUIDs see the documentation of the application programming interface (API) in uuid(3). =head1 OPTIONS =over 3 =item B<-v> I Sets the version of the generated DCE 1.1 variant UUID. Supported are I "C<1>", "C<3>", "C<4>" and "C<5>". The default is "C<1>". For version 3 and version 5 UUIDs the additional command line arguments I and I have to be given. The I is either a UUID in string representation or an identifier for internally pre-defined namespace UUIDs (currently known are "C", "C", "C", and "C"). The I is a string of arbitrary length. =item B<-m> Forces the use of a random multi-cast MAC address when generating version 1 UUIDs. By default the real physical MAC address of the system is used. =item B<-n> I Generate I UUIDs instead of just a single one (the default). =item B<-1> If option B<-n> is used with a I greater than C<1>, then this option can enforce the reset the UUID context for each generated UUID. This makes no difference for I C<3>, C<4> and C<5> 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<-F> I Representation format for importing or exporting an UUID. The following (case insensitive) format identifiers are currently recognized: =over 4 =item C (binary representation) This is the raw 128 bit network byte order binary representation of a UUID. Example is the octet stream C<0xF8 0x1D 0x4F 0xAE 0x7D 0xEC 0x11 0xD0 0xA7 0x65 0x00 0xA0 0xC9 0x1E 0x6B 0xF6>. =item C (string representation) This is the 36 character hexadecimal ASCII string representation of a UUID. Example is the string "C". =item C (single integer value representation) This is the maximum 39 character long single integer value representation of a UUID. Example is the string "C<329800735698586629295641978511506172918>". =back =item B<-o> I Write output to I instead of to F. =item B<-d> Decode a given UUID (given as a command line argument or if the command line argument is "C<->" the UUID is read from F) and dump textual information about the UUID. =back =head1 EXAMPLES # generate DCE 1.1 v1 UUID (time and node based) $ uuid -v1 01c47915-4777-11d8-bc70-0090272ff725 # decode and dump DCE 1.1 v1 UUID (time and node based) $ uuid -d 01c47915-4777-11d8-bc70-0090272ff725 encode: STR: 01c47915-4777-11d8-bc70-0090272ff725 SIV: 2349374037528578887923094374772111141 decode: variant: DCE 1.1, ISO/IEC 11578:1996 version: 1 (time and node based) content: time: 2004-01-15 16:22:26.376322.1 UTC clock: 15472 (usually random) node: 00:90:27:2f:f7:25 (global unicast) # generate DCE 1.1 v3 UUID (name based) $ uuid -v3 ns:URL http://www.ossp.org/ 02d9e6d5-9467-382e-8f9b-9300a64ac3cd # decode and dump DCE 1.1 v3 UUID (name based) $ uuid -d 02d9e6d5-9467-382e-8f9b-9300a64ac3cd encode: STR: 02d9e6d5-9467-382e-8f9b-9300a64ac3cd SIV: 3789866285607910888100818383505376205 decode: variant: DCE 1.1, ISO/IEC 11578:1996 version: 3 (name based, MD5) content: 02:D9:E6:D5:94:67:08:2E:0F:9B:93:00:A6:4A:C3:CD (not decipherable: MD5 message digest only) # generate DCE 1.1 v4 UUID 4 (random data based) $ uuid -v4 eb424026-6f54-4ef8-a4d0-bb658a1fc6cf # decode and dump DCE 1.1 v4 UUID 4 (random data based) $ uuid -d eb424026-6f54-4ef8-a4d0-bb658a1fc6cf encode: STR: eb424026-6f54-4ef8-a4d0-bb658a1fc6cf SIV: 312712571721458096795100956955942831823 decode: variant: DCE 1.1, ISO/IEC 11578:1996 version: 4 (random data based) content: EB:42:40:26:6F:54:0E:F8:24:D0:BB:65:8A:1F:C6:CF (no semantics: random data only) =head1 SEE ALSO uuid(3), OSSP::uuid(3). =cut @ 1.28 log @Consistently annotate "RFC-XXXX" with "IETF" to clearly indicate from which standards body this comes from. @ text @@ 1.27 log @adjust copyright messages for 2008 and bump version in advance @ text @d59 3 a61 3 B is a ISO-C:1999 application programming interface (API) and corresponding command line interface (CLI) for the generation of DCE 1.1, ISO/IEC 11578:1996 and RFC 4122 compliant I ## Copyright (c) 2004-2007 The OSSP Project @ 1.25 log @Add full support for Single Integer Value (SIV) UUID representation for both importing and exporting in C/C++/Perl/PHP APIs. @ text @d3 2 a4 2 ## Copyright (c) 2004-2006 Ralf S. Engelschall ## Copyright (c) 2004-2006 The OSSP Project @ 1.24 log @Adjust copyright messages for new year 2006. @ text @d47 1 a47 1 [B<-r>] d116 12 a127 1 =item B<-r> d129 12 a140 3 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. d162 7 a168 6 UUID: 01c47915-4777-11d8-bc70-0090272ff725 variant: DCE 1.1, ISO/IEC 11578:1996 version: 1 (time and node based) content: time: 2004-01-15 16:22:26.376322.1 UTC clock: 15472 (usually random) node: 00:90:27:2f:f7:25 (global unicast) d176 6 a181 5 UUID: 02d9e6d5-9467-382e-8f9b-9300a64ac3cd variant: DCE 1.1, ISO/IEC 11578:1996 version: 3 (name based) content: 02:D9:E6:D5:94:67:08:2E:0F:9B:93:00:A6:4A:C3:CD (not decipherable, because message digest only) d189 6 a194 5 UUID: eb424026-6f54-4ef8-a4d0-bb658a1fc6cf variant: DCE 1.1, ISO/IEC 11578:1996 version: 4 (random data based) content: EB:42:40:26:6F:54:0E:F8:24:D0:BB:65:8A:1F:C6:CF (no semantics, because random data only) @ 1.23 log @new official description now also mentioning PHP @ text @d3 2 a4 2 ## Copyright (c) 2004-2005 Ralf S. Engelschall ## Copyright (c) 2004-2005 The OSSP Project @ 1.22 log @ok, we now cover C++, too @ text @d59 9 a67 6 B is a ISO-C, ISO-C++ and Perl application programming interface (API) and corresponding command line interface (CLI) for the generation of DCE 1.1, ISO/IEC 11578:1996 and RFC 4122 compliant I (UUID). It supports DCE 1.1 variant UUIDs of version 1 (time and node based), version 3 (name based, MD5), version 4 (random number based) and version 5 (name based, SHA-1). @ 1.21 log @fix wording @ text @d59 6 a64 6 B is a ISO-C and Perl application programming interface (API) and corresponding command line interface (CLI) for the generation of DCE 1.1, ISO/IEC 11578:1996 and RFC 4122 compliant I (UUID). It supports DCE 1.1 variant UUIDs of version 1 (time and node based), version 3 (name based, MD5), version 4 (random number based) and version 5 (name based, SHA-1). @ 1.20 log @Reference the new officially published RFC 4122 @ text @d61 1 a61 1 1.1 and ISO/IEC 11578:1996 and RFC 4122 compliant I (UUID). It supports DCE 1.1 variant UUIDs of version 1 (time and node based), version 3 (name based, MD5), version 4 (random number based) and version 5 (name based, SHA-1). @ 1.18 log @Adjust copyright messages for new year 2005. @ text @d63 2 a64 1 based), version 3 (name based) and version 4 (random number based). d85 1 a85 1 are I "C<1>", "C<3>" and "C<4>". The default is "C<1>". d87 6 a92 6 For version 3 UUIDs the additional command line arguments I and I have to be given. The I is either a UUID in string representation or an identifier for internally pre-defined namespace UUIDs (currently known are "C", "C", "C", and "C"). The I is a string of arbitrary length. d108 1 a108 1 This makes no difference for I C<3> and C<4> UUIDs. But @ 1.17 log @link manpaged together @ text @d3 2 a4 2 ## Copyright (c) 2004 Ralf S. Engelschall ## Copyright (c) 2004 The OSSP Project @ 1.16 log @tell about Perl API now, too @ text @d171 1 a171 1 uuid(3). @ 1.15 log @Add support to uuid(1) CLI for decoding from stdin for both binary and string representations. @ text @d59 2 a60 2 B is a ISO-C application programming interface (API) and corresponding command line interface (CLI) for the generation of DCE @ 1.14 log @Fixed "uuid -h" command. Submitted by: fuyuki@@nigredo.org @ text @d124 3 a126 2 Decode a given UUID (either on F or as an argument on the command line) and dump textual information about the UUID. @ 1.13 log @flush more pending cleanups @ text @d55 1 a55 1 [I] @ 1.12 log @strip trailing whitespaces @ text @d89 3 a91 2 namespace UUIDs (currently known are "C", "C", "C", and "C"). The I is a string of arbitrary length. d145 1 a145 1 $ uuid -v3 URL http://www.ossp.org/ @ 1.11 log @use new hexdump output in examples, too @ text @d156 1 a156 1 $ uuid -v4 @ 1.10 log @use new sample UUIDs with new output @ text @d152 2 a153 1 content: [not decipherable] d164 2 a165 1 content: [no semantics] @ 1.9 log @document uuid_dump function @ text @d132 1 a132 1 ab3734b7-4770-11d8-9753-0090272ff725 d135 2 a136 2 $ uuid -d ab3734b7-4770-11d8-9753-0090272ff725 UUID: ab3734b7-4770-11d8-9753-0090272ff725 d139 3 a141 3 content: time: 2004-01-15 15:37:04.186079.1 UTC clock: 5971 (usually random) node: 00:90:27:2f:f7:25 (real unicast) @ 1.8 log @o Added missing manual page uuid-config(1). o Fixed output of "uuid-config --version" o Fixed typos in uuid.pod @ text @d132 1 a132 1 1430fcde-43a9-11d8-8000-0090272ff725 d135 2 a136 2 $ uuid -d 1430fcde-43a9-11d8-8000-0090272ff725 UUID: 1430fcde-43a9-11d8-8000-0090272ff725 d139 2 a140 2 content: time: 2004-01-10 20:10:47.471843.0 UTC clock: 0 (usually random) @ 1.7 log @Add decoding examples to uuid(1) manual page. @ text @d36 4 @ 1.6 log @Implement uuid_dump() and corresponding uuid CLI "-d" option for dumping a given UUID into clear text. For convinience reasons add uuid_bm.h (bit mask API) and uuid_str (string formatting API) sub-modules. @ text @d126 1 a126 1 # generate DCE 1.1 variant UUID of version 1 (time and node based) d130 10 a139 1 # generate DCE 1.1 variant UUID of version 3 (name based) d142 10 a151 3 # generate DCE 1.1 variant UUID of version 4 (random data based) $ ./uuid -v4 d153 7 @ 1.5 log @Document in uuid(1) [uuid_cli.pod] that for version 3 UUIDs additional arguments are required and what pre-defined namespace ids are known. Submitted by: M.Daniel PR: 31 @ text @d40 1 d87 6 @ 1.4 log @more documentation @ text @d78 8 a85 3 Sets the version of the generated DCE 1.1 variant UUID. Supported are I "C<1>", "C<3>" and "C<4>". The default is "C<1>". @ 1.3 log @use 'Universally Unique Identifier' with plural @ text @d60 11 a70 3 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). @ 1.2 log @add a bunch of initial documentation @ text @d56 1 a56 1 1.1 and ISO/IEC 11578:1996 compliant I @ 1.1 log @add manual page frameworks @ text @d38 13 a50 1 ...FIXME... d54 9 a62 1 ...FIXME... d66 51 a116 1 ...FIXME... @