]> git.ipfire.org Git - thirdparty/util-linux.git/blob - misc-utils/uuidd.8.in
docs: AUTHORS: remove four duplicate entries
[thirdparty/util-linux.git] / misc-utils / uuidd.8.in
1 .\" -*- nroff -*-
2 .\" Copyright 2007 by Theodore Ts'o. All Rights Reserved.
3 .\" This file may be copied under the terms of the GNU Public License.
4 .\"
5 .TH UUIDD 8 "June 2011" "util-linux" "System Administration"
6 .SH NAME
7 uuidd \- UUID generation daemon
8 .SH SYNOPSIS
9 .B uuidd
10 .RI [ options ]
11 .SH DESCRIPTION
12 The
13 .B uuidd
14 daemon is used by the UUID library to generate
15 universally unique identifiers (UUIDs), especially time-based UUIDs,
16 in a secure and guaranteed-unique fashion, even in the face of large
17 numbers of threads running on different CPUs trying to grab UUIDs.
18 .SH OPTIONS
19 .TP
20 .B \-d
21 Run uuidd in debugging mode. This prevents uuidd from running as a daemon.
22 .TP
23 .BR \-h , " \-\-help "
24 Display help screen and exit.
25 .TP
26 .BR \-k , " \-\-kill "
27 If currently a uuidd daemon is running, kill it.
28 .TP
29 .BR \-n , " \-\-uuids " \fInumber\fR
30 When issuing a test request to a running uuidd, request a bulk response
31 of
32 .I number
33 UUIDs.
34 .TP
35 .BR \-p , " \-\-pid " \fIpath\fR
36 Specify the pathname where the pid file should be written. By default,
37 the pid file is written to @localstatedir@/uuidd/uuidd.pid.
38 .TP
39 .BR \-P , " \-\-no-pid "
40 Do not create pid file.
41 .TP
42 .BR \-F , " \-\-no-fork "
43 Do not daemonize using double-fork.
44 .TP
45 .BR \-S , " \-\-socket-activation "
46 Do not create the socket and instead expect it to be provided by the calling
47 process. Implies --no-fork and --no-pid. As of this writing, this option is
48 supposed to be used only with systemd. This option must be enabled with a configure
49 option.
50 .TP
51 .B \-q
52 Suppress some failure messages.
53 .TP
54 .BR \-r , " \-\-random "
55 Test uuidd by trying to connect to a running uuidd daemon and
56 request it to return a random-based UUID.
57 .TP
58 .BR \-s , " \-\-socket " \fIpath\fR
59 Specify the pathname used for the unix-domain socket used by uuidd. By
60 default, the pathname used is @localstatedir@/uuidd/request. This is primarily
61 for debugging purposes, since the pathname is hard-coded in the libuuid
62 library.
63 .TP
64 .BR \-T , " \-\-timeout " \fItimeout\fR
65 Specify a timeout for uuidd. If specified, then uuidd will exit after
66 .I timeout
67 seconds of inactivity.
68 .TP
69 .BR \-t , " \-\-time "
70 Test uuidd by trying to connect to a running uuidd daemon and
71 request it to return a time-based UUID.
72 .TP
73 .BR \-V , " \-\-version "
74 Output version information and exit.
75 .SH EXAMPLE
76 Start up a daemon, print 42 random keys, and then stop the daemon.
77 .PP
78 .RS
79 .nf
80 uuidd -p /tmp/uuidd.pid -s /tmp/uuidd.socket
81 uuidd -d -r -n 42 -s /tmp/uuidd.socket
82 uuidd -d -k -s /tmp/uuidd.socket
83 .nf
84 .RE
85 .SH AUTHOR
86 The
87 .B uuidd
88 daemon was written by Theodore Ts'o <tytso@mit.edu>.
89 .SH AVAILABILITY
90 The uuidd daemon is part of the util-linux package and is available from
91 ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
92 .SH "SEE ALSO"
93 .BR uuid (3),
94 .BR uuidgen (1)