.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` 
.    ds C' 
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "UUID 1"
.TH UUID 1 "OSSP uuid 1.6.2" 04-Jul-2008 "Universally Unique Identifier"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
uuid \- Universally Unique Identifier Command\-Line Tool
.SH VERSION
.IX Header "VERSION"
OSSP uuid 1.6.2 (04-Jul-2008)
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBuuid\fR
[\fB\-v\fR \fIversion\fR]
[\fB\-m\fR]
[\fB\-n\fR \fIcount\fR]
[\fB\-1\fR]
[\fB\-F\fR \fIformat\fR]
[\fB\-o\fR \fIfilename\fR]
[\fInamespace\fR \fIname\fR]
.PP
\&\fBuuid\fR
\&\fB\-d\fR
[\fB\-r\fR]
[\fB\-o\fR \fIfilename\fR]
\&\fIuuid\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBOSSP uuid\fR 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 \fIUniversally Unique
Identifier\fR (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.
.PP
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.
.PP
This is the command line interface (CLI) of \fBOSSP uuid\fR. For a
detailed description of UUIDs see the documentation of the application
programming interface (API) in \fBuuid\fR\|(3).
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-v\fR \fIversion\fR" 3
.IX Item "-v version"
Sets the version of the generated DCE 1.1 variant UUID. Supported
are \fIversion\fR "\f(CW1\fR", "\f(CW3\fR", "\f(CW4\fR" and "\f(CW5\fR". The default is "\f(CW1\fR".
.Sp
For version 3 and version 5 UUIDs the additional command line arguments
\&\fInamespace\fR and \fIname\fR have to be given. The \fInamespace\fR is either
a UUID in string representation or an identifier for internally
pre-defined namespace UUIDs (currently known are "\f(CW\*(C`ns:DNS\*(C'\fR",
"\f(CW\*(C`ns:URL\*(C'\fR", "\f(CW\*(C`ns:OID\*(C'\fR", and "\f(CW\*(C`ns:X500\*(C'\fR"). The \fIname\fR is a string of
arbitrary length.
.IP \fB\-m\fR 3
.IX Item "-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.
.IP "\fB\-n\fR \fIcount\fR" 3
.IX Item "-n count"
Generate \fIcount\fR UUIDs instead of just a single one (the default).
.IP \fB\-1\fR 3
.IX Item "-1"
If option \fB\-n\fR is used with a \fIcount\fR greater than \f(CW1\fR, then this
option can enforce the reset the UUID context for each generated UUID.
This makes no difference for \fIversion\fR \f(CW3\fR, \f(CW4\fR and \f(CW5\fR UUIDs. But
version \f(CW1\fR UUIDs are based on the previously generated UUID which is
remembered in the UUID context of the API. Option \fB\-1\fR deletes the
remembered UUID on each iteration.
.IP "\fB\-F\fR \fIformat\fR" 3
.IX Item "-F format"
Representation format for importing or exporting an UUID. The
following (case insensitive) format identifiers are currently recognized:
.RS 3
.ie n .IP "\*(C`BIN\*(C' (binary representation)" 4
.el .IP "\f(CW\*(C`BIN\*(C'\fR (binary representation)" 4
.IX Item "BIN (binary representation)"
This is the raw 128 bit network byte order binary representation of a
UUID. Example is the octet stream \f(CW\*(C`0xF8 0x1D 0x4F 0xAE 0x7D 0xEC 0x11
0xD0 0xA7 0x65 0x00 0xA0 0xC9 0x1E 0x6B 0xF6\*(C'\fR.
.ie n .IP "\*(C`STR\*(C' (string representation)" 4
.el .IP "\f(CW\*(C`STR\*(C'\fR (string representation)" 4
.IX Item "STR (string representation)"
This is the 36 character hexadecimal ASCII string representation of a
UUID. Example is the string "\f(CW\*(C`f81d4fae\-7dec\-11d0\-a765\-00a0c91e6bf6\*(C'\fR".
.ie n .IP "\*(C`SIV\*(C' (single integer value representation)" 4
.el .IP "\f(CW\*(C`SIV\*(C'\fR (single integer value representation)" 4
.IX Item "SIV (single integer value representation)"
This is the maximum 39 character long single integer
value representation of a UUID. Example is the string
"\f(CW329800735698586629295641978511506172918\fR".
.RE
.RS 3
.RE
.IP "\fB\-o\fR \fIfilename\fR" 3
.IX Item "-o filename"
Write output to \fIfilename\fR instead of to \fIstdout\fR.
.IP \fB\-d\fR 3
.IX Item "-d"
Decode a given UUID (given as a command line argument or if the command
line argument is "\f(CW\*(C`\-\*(C'\fR" the UUID is read from \fIstdin\fR) and dump textual
information about the UUID.
.SH EXAMPLES
.IX Header "EXAMPLES"
.Vb 3
\& # 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)
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBuuid\fR\|(3), \fBOSSP::uuid\fR\|(3).