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