/bin/uuidgen/uuidgen.1

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 83 lines · 83 code · 0 blank · 0 comment · 0 complexity · 3e11b80aae0b14b1709dfbda4a16c66a MD5 · raw file 

    

  1. .\" Copyright (c) 2002 Marcel Moolenaar
    2. 

  2. .\" All rights reserved.
    3. 

  3. .\"
    4. 

  4. .\" Redistribution and use in source and binary forms, with or without
    5. 

  5. .\" modification, are permitted provided that the following conditions
    6. 

  6. .\" are met:
    7. 

  7. .\"
    8. 

  8. .\" 1. Redistributions of source code must retain the above copyright
    9. 

  9. .\"    notice, this list of conditions and the following disclaimer.
    10. 

  10. .\" 2. Redistributions in binary form must reproduce the above copyright
    11. 

  11. .\"    notice, this list of conditions and the following disclaimer in the
    12. 

  12. .\"    documentation and/or other materials provided with the distribution.
    13. 

  13. .\"
    14. 

  14. .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
    15. 

  15. .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    16. 

  16. .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    17. 

  17. .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
    18. 

  18. .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    19. 

  19. .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    20. 

  20. .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    21. 

  21. .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    22. 

  22. .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    23. 

  23. .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    24. 

  24. .\"
    25. 

  25. .\" $FreeBSD$
    26. 

  26. .\"
    27. 

  27. .Dd May 23, 2012
    28. 

  28. .Dt UUIDGEN 1
    29. 

  29. .Os
    30. 

  30. .Sh NAME
    31. 

  31. .Nm uuidgen
    32. 

  32. .Nd generate universally unique identifiers
    33. 

  33. .Sh SYNOPSIS
    34. 

  34. .Nm
    35. 

  35. .Op Fl 1
    36. 

  36. .Op Fl n Ar count
    37. 

  37. .Op Fl o Ar filename
    38. 

  38. .Sh DESCRIPTION
    39. 

  39. The
    40. 

  40. .Nm
    41. 

  41. utility by default generates a single DCE version 1
    42. 

  42. universally unique identifier (UUID),
    43. 

  43. also known as a globally unique identifier (GUID).
    44. 

  44. The UUID is written to stdout by default.
    45. 

  45. The following options can be used to change the behaviour of
    46. 

  46. .Nm :
    47. 

  47. .Bl -tag -width indent
    48. 

  48. .It Fl 1
    49. 

  49. This option only has effect if multiple identifiers are to be generated and
    50. 

  50. instructs
    51. 

  51. .Nm
    52. 

  52. to not generate them in batch, but one at a time.
    53. 

  53. .It Fl n
    54. 

  54. This option controls the number of identifiers generated.
    55. 

  55. By default, multiple identifiers are generated in batch.
    56. 

  56. The upper hard limit is 2048
    57. 

  57. .Po see
    58. 

  58. .Xr uuidgen 2
    59. 

  59. .Pc .
    60. 

  60. .It Fl o
    61. 

  61. Redirect output to
    62. 

  62. .Ar filename
    63. 

  63. instead of stdout.
    64. 

  64. .El
    65. 

  65. .Pp
    66. 

  66. Batched generation yields a dense set of identifiers in such a way that there
    67. 

  67. is no identifier that is larger than the smallest identifier in the set and
    68. 

  68. smaller than the largest identifier in the set and that is not already in the
    69. 

  69. set.
    70. 

  70. .Pp
    71. 

  71. When generating the identifiers one at a time, the identifiers will be close
    72. 

  72. to each other, but operating system latency and processing time will be
    73. 

  73. reflected in the distance between two successive identifiers.
    74. 

  74. .Sh EXIT STATUS
    75. 

  75. .Ex -std
    76. 

  76. .Sh SEE ALSO
    77. 

  77. .Xr uuidgen 2 ,
    78. 

  78. .Xr uuid 3
    79. 

  79. .Sh HISTORY
    80. 

  80. The
    81. 

  81. .Nm
    82. 

  82. command first appeared in
    83. 

  83. .Fx 5.0 .
    84.