xref: /dflybsd-src/bin/uuidgen/uuidgen.1 (revision dadd6466537293dd1209630ad0a11746c2482d55)
1*dadd6466SFrançois Tigeot.\" Copyright (c) 2002 Marcel Moolenaar
2*dadd6466SFrançois Tigeot.\" All rights reserved.
3*dadd6466SFrançois Tigeot.\"
4*dadd6466SFrançois Tigeot.\" Redistribution and use in source and binary forms, with or without
5*dadd6466SFrançois Tigeot.\" modification, are permitted provided that the following conditions
6*dadd6466SFrançois Tigeot.\" are met:
7*dadd6466SFrançois Tigeot.\"
8*dadd6466SFrançois Tigeot.\" 1. Redistributions of source code must retain the above copyright
9*dadd6466SFrançois Tigeot.\"    notice, this list of conditions and the following disclaimer.
10*dadd6466SFrançois Tigeot.\" 2. Redistributions in binary form must reproduce the above copyright
11*dadd6466SFrançois Tigeot.\"    notice, this list of conditions and the following disclaimer in the
12*dadd6466SFrançois Tigeot.\"    documentation and/or other materials provided with the distribution.
13*dadd6466SFrançois Tigeot.\"
14*dadd6466SFrançois Tigeot.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15*dadd6466SFrançois Tigeot.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16*dadd6466SFrançois Tigeot.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17*dadd6466SFrançois Tigeot.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18*dadd6466SFrançois Tigeot.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19*dadd6466SFrançois Tigeot.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20*dadd6466SFrançois Tigeot.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21*dadd6466SFrançois Tigeot.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22*dadd6466SFrançois Tigeot.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23*dadd6466SFrançois Tigeot.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24*dadd6466SFrançois Tigeot.\"
25*dadd6466SFrançois Tigeot.\" $FreeBSD: src/usr.bin/uuidgen/uuidgen.1,v 1.7 2005/09/07 07:49:21 rse Exp $
26*dadd6466SFrançois Tigeot.\"
27*dadd6466SFrançois Tigeot.Dd September 7, 2005
28*dadd6466SFrançois Tigeot.Dt UUIDGEN 1
29*dadd6466SFrançois Tigeot.Os
30*dadd6466SFrançois Tigeot.Sh NAME
31*dadd6466SFrançois Tigeot.Nm uuidgen
32*dadd6466SFrançois Tigeot.Nd generate universally unique identifiers
33*dadd6466SFrançois Tigeot.Sh SYNOPSIS
34*dadd6466SFrançois Tigeot.Nm
35*dadd6466SFrançois Tigeot.Op Fl 1
36*dadd6466SFrançois Tigeot.Op Fl n Ar count
37*dadd6466SFrançois Tigeot.Op Fl o Ar filename
38*dadd6466SFrançois Tigeot.Sh DESCRIPTION
39*dadd6466SFrançois TigeotThe
40*dadd6466SFrançois Tigeot.Nm
41*dadd6466SFrançois Tigeotutility by default generates a single DCE version 1
42*dadd6466SFrançois Tigeotuniversally unique identifier (UUID),
43*dadd6466SFrançois Tigeotalso known as a globally unique identifier (GUID).
44*dadd6466SFrançois TigeotThe UUID is written to stdout by default.
45*dadd6466SFrançois TigeotThe following options can be used to change the behaviour of
46*dadd6466SFrançois Tigeot.Nm :
47*dadd6466SFrançois Tigeot.Bl -tag -width indent
48*dadd6466SFrançois Tigeot.It Fl 1
49*dadd6466SFrançois TigeotThis option only has effect if multiple identifiers are to be generated and
50*dadd6466SFrançois Tigeotinstructs
51*dadd6466SFrançois Tigeot.Nm
52*dadd6466SFrançois Tigeotto not generate them in batch, but one at a time.
53*dadd6466SFrançois Tigeot.It Fl n
54*dadd6466SFrançois TigeotThis option controls the number of identifiers generated.
55*dadd6466SFrançois TigeotBy default, multiple
56*dadd6466SFrançois Tigeotidentifiers are generated in batch.
57*dadd6466SFrançois Tigeot.It Fl o
58*dadd6466SFrançois TigeotRedirect output to
59*dadd6466SFrançois Tigeot.Ar filename
60*dadd6466SFrançois Tigeotinstead of stdout.
61*dadd6466SFrançois Tigeot.El
62*dadd6466SFrançois Tigeot.Pp
63*dadd6466SFrançois TigeotBatched generation yields a dense set of identifiers in such a way that there
64*dadd6466SFrançois Tigeotis no identifier that is larger than the smallest identifier in the set and
65*dadd6466SFrançois Tigeotsmaller than the largest identifier in the set and that is not already in the
66*dadd6466SFrançois Tigeotset.
67*dadd6466SFrançois Tigeot.Pp
68*dadd6466SFrançois TigeotWhen generating the identifiers one at a time, the identifiers will be close
69*dadd6466SFrançois Tigeotto each other, but operating system latency and processing time will be
70*dadd6466SFrançois Tigeotreflected in the distance between two successive identifiers.
71*dadd6466SFrançois Tigeot.Sh EXIT STATUS
72*dadd6466SFrançois Tigeot.Ex -std
73*dadd6466SFrançois Tigeot.Sh SEE ALSO
74*dadd6466SFrançois Tigeot.Xr uuidgen 2 ,
75*dadd6466SFrançois Tigeot.Xr uuid 3
76*dadd6466SFrançois Tigeot.Sh HISTORY
77*dadd6466SFrançois TigeotThe
78*dadd6466SFrançois Tigeot.Nm
79*dadd6466SFrançois Tigeotcommand first appeared in
80*dadd6466SFrançois Tigeot.Fx 5.0 .
81