]> git.ipfire.org Git - thirdparty/util-linux.git/blame - misc-utils/mcookie.1.adoc
github: fix asciidoctror dependence
[thirdparty/util-linux.git] / misc-utils / mcookie.1.adoc
CommitLineData
295b3979 1//po4a: entry man manual
6c64d12d
MB
2// mcookie.1 --
3// Public Domain 1995 Rickard E. Faith (faith@cs.unc.edu)
4= mcookie(1)
5:doctype: manpage
6:man manual: User Commands
7:man source: util-linux {release-version}
8:page-layout: base
9:command: mcookie
10
11== NAME
12
13mcookie - generate magic cookies for xauth
14
15== SYNOPSIS
16
17*mcookie* [options]
18
19== DESCRIPTION
20
21*mcookie* generates a 128-bit random hexadecimal number for use with the X authority system. Typical usage:
22
23____
24*xauth add :0 . `mcookie`*
25____
26
27The "random" number generated is actually the MD5 message digest of random information coming from one of the sources *getrandom*(2) system call, _/dev/urandom_, _/dev/random_, or the _libc pseudo-random functions_, in this preference order. See also the option *--file*.
28
29== OPTIONS
30
31*-f*, *--file* _file_::
2c646c80 32Use this _file_ as an additional source of randomness (for example _/dev/urandom_). When _file_ is '-', characters are read from standard input.
6c64d12d
MB
33
34*-m*, *--max-size* _number_::
2c646c80
MB
35Read from _file_ only this _number_ of bytes. This option is meant to be used when reading additional randomness from a file or device.
36+
37The _number_ argument may be followed by the multiplicative suffixes KiB=1024, MiB=1024*1024, and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB") or the suffixes KB=1000, MB=1000*1000, and so on for GB, TB, PB, EB, ZB and YB.
6c64d12d
MB
38
39*-v*, *--verbose*::
2c646c80 40Inform where randomness originated, with amount of entropy read from each source.
6c64d12d
MB
41
42*-V*, *--version*::
2c646c80 43Display version information and exit.
6c64d12d
MB
44
45*-h*, *--help*::
2c646c80 46Display help text and exit.
6c64d12d
MB
47
48== FILES
49
2c646c80
MB
50_/dev/urandom_
51
6c64d12d
MB
52_/dev/random_
53
54== BUGS
55
56It is assumed that none of the randomness sources will block.
57
58== SEE ALSO
59
60*md5sum*(1),
61*X*(7),
62*xauth*(1),
63*rand*(3)
64
65include::../man-common/bugreports.adoc[]
66
67include::../man-common/footer.adoc[]
68
69ifdef::translation[]
70include::../man-common/translation.adoc[]
71endif::[]