xref: /freebsd/bin/uuidgen/uuidgen.1 (revision 60fc1eb79c59ba880937eb526981fe60adf3798a)
152183d01SMarcel Moolenaar.\" Copyright (c) 2002 Marcel Moolenaar
252183d01SMarcel Moolenaar.\" All rights reserved.
352183d01SMarcel Moolenaar.\"
452183d01SMarcel Moolenaar.\" Redistribution and use in source and binary forms, with or without
552183d01SMarcel Moolenaar.\" modification, are permitted provided that the following conditions
652183d01SMarcel Moolenaar.\" are met:
752183d01SMarcel Moolenaar.\"
852183d01SMarcel Moolenaar.\" 1. Redistributions of source code must retain the above copyright
952183d01SMarcel Moolenaar.\"    notice, this list of conditions and the following disclaimer.
1052183d01SMarcel Moolenaar.\" 2. Redistributions in binary form must reproduce the above copyright
1152183d01SMarcel Moolenaar.\"    notice, this list of conditions and the following disclaimer in the
1252183d01SMarcel Moolenaar.\"    documentation and/or other materials provided with the distribution.
1352183d01SMarcel Moolenaar.\"
1452183d01SMarcel Moolenaar.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
1552183d01SMarcel Moolenaar.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1652183d01SMarcel Moolenaar.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1752183d01SMarcel Moolenaar.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
1852183d01SMarcel Moolenaar.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
1952183d01SMarcel Moolenaar.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2052183d01SMarcel Moolenaar.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2152183d01SMarcel Moolenaar.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2252183d01SMarcel Moolenaar.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2352183d01SMarcel Moolenaar.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2452183d01SMarcel Moolenaar.\"
2552183d01SMarcel Moolenaar.\" $FreeBSD$
2652183d01SMarcel Moolenaar.\"
2760fc1eb7SRalf S. Engelschall.Dd September 7, 2005
2852183d01SMarcel Moolenaar.Dt UUIDGEN 1
2952183d01SMarcel Moolenaar.Os
3052183d01SMarcel Moolenaar.Sh NAME
3152183d01SMarcel Moolenaar.Nm uuidgen
3252183d01SMarcel Moolenaar.Nd generate universally unique identifiers
3352183d01SMarcel Moolenaar.Sh SYNOPSIS
3452183d01SMarcel Moolenaar.Nm
3552183d01SMarcel Moolenaar.Op Fl 1
3652183d01SMarcel Moolenaar.Op Fl n Ar count
3748328654SMarcel Moolenaar.Op Fl o Ar filename
3852183d01SMarcel Moolenaar.Sh DESCRIPTION
3952183d01SMarcel MoolenaarThe
4052183d01SMarcel Moolenaar.Nm
4160fc1eb7SRalf S. Engelschallutility by default generates a single DCE version 1
4260fc1eb7SRalf S. Engelschalluniversally unique identifier (UUID),
4336588206SRuslan Ermilovalso known as a globally unique identifier (GUID).
4448328654SMarcel MoolenaarThe UUID is written to stdout by default.
4548328654SMarcel MoolenaarThe following options can be used to change the behaviour of
4648328654SMarcel Moolenaar.Nm :
4752183d01SMarcel Moolenaar.Bl -tag -width indent
4852183d01SMarcel Moolenaar.It Fl 1
4952183d01SMarcel MoolenaarThis option only has effect if multiple identifiers are to be generated and
5052183d01SMarcel Moolenaarinstructs
5152183d01SMarcel Moolenaar.Nm
5252183d01SMarcel Moolenaarto not generate them in batch, but one at a time.
5352183d01SMarcel Moolenaar.It Fl n
5436588206SRuslan ErmilovThis option controls the number of identifiers generated.
5536588206SRuslan ErmilovBy default, multiple
5652183d01SMarcel Moolenaaridentifiers are generated in batch.
5748328654SMarcel Moolenaar.It Fl o
5848328654SMarcel MoolenaarRedirect output to
5948328654SMarcel Moolenaar.Ar filename
6048328654SMarcel Moolenaarinstead of stdout.
6152183d01SMarcel Moolenaar.El
6252183d01SMarcel Moolenaar.Pp
6352183d01SMarcel MoolenaarBatched generation yields a dense set of identifiers in such a way that there
6452183d01SMarcel Moolenaaris no identifier that is larger than the smallest identifier in the set and
6552183d01SMarcel Moolenaarsmaller than the largest identifier in the set and that is not already in the
6652183d01SMarcel Moolenaarset.
6752183d01SMarcel Moolenaar.Pp
6852183d01SMarcel MoolenaarWhen generating the identifiers one at a time, the identifiers will be close
6952183d01SMarcel Moolenaarto each other, but operating system latency and processing time will be
7052183d01SMarcel Moolenaarreflected in the distance between two successive identifiers.
71a866e170SRuslan Ermilov.Sh EXIT STATUS
7252183d01SMarcel Moolenaar.Ex -std
7352183d01SMarcel Moolenaar.Sh SEE ALSO
749b2f268fSMarcel Moolenaar.Xr uuidgen 2 ,
759b2f268fSMarcel Moolenaar.Xr uuid 3
7652183d01SMarcel Moolenaar.Sh HISTORY
7752183d01SMarcel MoolenaarThe
7852183d01SMarcel Moolenaar.Nm
7952183d01SMarcel Moolenaarcommand first appeared in
8052183d01SMarcel Moolenaar.Fx 5.0 .
81