misc-utils/uuidd.8.adoc

   1 //po4a: entry man manual
   2 ////
   3 Copyright 2007 by Theodore Ts'o.  All Rights Reserved.
   4 This file may be copied under the terms of the GNU Public License.
   5 ////
   6 = uuidd(8)
   7 :doctype: manpage
   8 :man manual: System Administration
   9 :man source: util-linux {release-version}
  10 :page-layout: base
  11 :command: uuidd
  12
  13 == NAME
  14
  15 uuidd - UUID generation daemon
  16
  17 == SYNOPSIS
  18
  19 *uuidd* [options]
  20
  21 == DESCRIPTION
  22
  23 The *uuidd* daemon is used by the UUID library to generate universally unique identifiers (UUIDs), especially time-based UUIDs, in a secure and guaranteed-unique fashion, even in the face of large numbers of threads running on different CPUs trying to grab UUIDs.
  24
  25 == OPTIONS
  26
  27 *-C*, *--cont-clock*[=_time_]::
  28 Activate continuous clock handling for time based UUIDs. *uuidd* could use all possible clock values, beginning with the daemon's start time. The optional argument can be used to set a value for the max_clock_offset. This gurantees, that a clock value of a UUID will always be within the range of the max_clock_offset.
  29 +
  30 The option *-C* or *--cont-clock* enables the feature with a default max_clock_offset of 2 hours.
  31 +
  32 The option *-C<NUM>[hd]* or *--cont-clock=<NUM>[hd]* enables the feature with a max_clock_offset of NUM seconds. In case of an appended h or d, the NUM value is read in hours or days. The minimum value is 60 seconds, the maximum value is 365 days.
  33
  34 *-d*, *--debug*::
  35 Run *uuidd* in debugging mode. This prevents *uuidd* from running as a daemon.
  36
  37 *-F*, *--no-fork*::
  38 Do not daemonize using a double-fork.
  39
  40 *-k*, *--kill*::
  41 If currently a uuidd daemon is running, kill it.
  42
  43 *-n*, *--uuids* _number_::
  44 When issuing a test request to a running *uuidd*, request a bulk response of _number_ UUIDs.
  45
  46 *-P*, *--no-pid*::
  47 Do not create a pid file.
  48
  49 *-p*, *--pid* _path_::
  50 Specify the pathname where the pid file should be written. By default, the pid file is written to _{runstatedir}/uuidd/uuidd.pid_.
  51 // TRANSLATORS: Don't translate _{runstatedir}_.
  52
  53 *-q*, *--quiet*::
  54 Suppress some failure messages.
  55
  56 *-r*, *--random*::
  57 Test uuidd by trying to connect to a running uuidd daemon and request it to return a random-based UUID.
  58
  59 *-S*, *--socket-activation*::
  60 Do not create a socket but instead expect it to be provided by the calling process. This implies *--no-fork* and *--no-pid*. This option is intended to be used only with *systemd*(1). It needs to be enabled with a configure option.
  61
  62 *-s*, *--socket* _path_::
  63 Make uuidd use this pathname for the unix-domain socket. By default, the pathname used is _{runstatedir}/uuidd/request_. This option is primarily for debugging purposes, since the pathname is hard-coded in the *libuuid* library.
  64 // TRANSLATORS: Don't translate _{runstatedir}_.
  65
  66 *-T*, *--timeout* _number_::
  67 Make *uuidd* exit after _number_ seconds of inactivity.
  68
  69 *-t*, *--time*::
  70 Test *uuidd* by trying to connect to a running uuidd daemon and request it to return a time-based UUID.
  71
  72 include::man-common/help-version.adoc[]
  73
  74 == EXAMPLE
  75
  76 Start up a daemon, print 42 random keys, and then stop the daemon:
  77
  78 ....
  79 uuidd -p /tmp/uuidd.pid -s /tmp/uuidd.socket
  80 uuidd -d -r -n 42 -s /tmp/uuidd.socket
  81 uuidd -d -k -s /tmp/uuidd.socket
  82 ....
  83
  84 == AUTHOR
  85
  86 The *uuidd* daemon was written by mailto:tytso@mit.edu[Theodore Ts'o].
  87
  88 == SEE ALSO
  89
  90 *uuid*(3),
  91 *uuidgen*(1)
  92
  93 include::man-common/bugreports.adoc[]
  94
  95 include::man-common/footer.adoc[]
  96
  97 ifdef::translation[]
  98 include::man-common/translation.adoc[]
  99 endif::[]