usr.bin/uuidgen/uuidgen.1

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