manual/util-linux/original/man1/mcookie.1

   1 '\" t
   2 .\"     Title: mcookie
   3 .\"    Author: [see the "AUTHOR(S)" section]
   4 .\" Generator: Asciidoctor 2.0.15
   5 .\"      Date: 2022-02-17
   6 .\"    Manual: User Commands
   7 .\"    Source: util-linux 2.38
   8 .\"  Language: English
   9 .\"
  10 .TH "MCOOKIE" "1" "2022-02-17" "util\-linux 2.38" "User Commands"
  11 .ie \n(.g .ds Aq \(aq
  12 .el       .ds Aq '
  13 .ss \n[.ss] 0
  14 .nh
  15 .ad l
  16 .de URL
  17 \fI\\$2\fP <\\$1>\\$3
  18 ..
  19 .als MTO URL
  20 .if \n[.g] \{\
  21 .  mso www.tmac
  22 .  am URL
  23 .    ad l
  24 .  .
  25 .  am MTO
  26 .    ad l
  27 .  .
  28 .  LINKSTYLE blue R < >
  29 .\}
  30 .SH "NAME"
  31 mcookie \- generate magic cookies for xauth
  32 .SH "SYNOPSIS"
  33 .sp
  34 \fBmcookie\fP [options]
  35 .SH "DESCRIPTION"
  36 .sp
  37 \fBmcookie\fP generates a 128\-bit random hexadecimal number for use with the X authority system. Typical usage:
  38 .RS 3
  39 .ll -.6i
  40 .sp
  41 \fBxauth add :0 . \f(CRmcookie\fP\fP
  42 .br
  43 .RE
  44 .ll
  45 .sp
  46 The "random" number generated is actually the MD5 message digest of random information coming from one of the sources \fBgetrandom\fP(2) system call, \fI/dev/urandom\fP, \fI/dev/random\fP, or the \fIlibc pseudo\-random functions\fP, in this preference order. See also the option \fB\-\-file\fP.
  47 .SH "OPTIONS"
  48 .sp
  49 \fB\-f\fP, \fB\-\-file\fP \fIfile\fP
  50 .RS 4
  51 Use this \fIfile\fP as an additional source of randomness (for example \fI/dev/urandom\fP). When \fIfile\fP is \(aq\-\(aq, characters are read from standard input.
  52 .RE
  53 .sp
  54 \fB\-m\fP, \fB\-\-max\-size\fP \fInumber\fP
  55 .RS 4
  56 Read from \fIfile\fP only this \fInumber\fP of bytes. This option is meant to be used when reading additional randomness from a file or device.
  57 .sp
  58 The \fInumber\fP 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.
  59 .RE
  60 .sp
  61 \fB\-v\fP, \fB\-\-verbose\fP
  62 .RS 4
  63 Inform where randomness originated, with amount of entropy read from each source.
  64 .RE
  65 .sp
  66 \fB\-h\fP, \fB\-\-help\fP
  67 .RS 4
  68 Display help text and exit.
  69 .RE
  70 .sp
  71 \fB\-V\fP, \fB\-\-version\fP
  72 .RS 4
  73 Print version and exit.
  74 .RE
  75 .SH "FILES"
  76 .sp
  77 \fI/dev/urandom\fP
  78 .sp
  79 \fI/dev/random\fP
  80 .SH "BUGS"
  81 .sp
  82 It is assumed that none of the randomness sources will block.
  83 .SH "SEE ALSO"
  84 .sp
  85 \fBmd5sum\fP(1),
  86 \fBX\fP(7),
  87 \fBxauth\fP(1),
  88 \fBrand\fP(3)
  89 .SH "REPORTING BUGS"
  90 .sp
  91 For bug reports, use the issue tracker at \c
  92 .URL "https://github.com/util\-linux/util\-linux/issues" "" "."
  93 .SH "AVAILABILITY"
  94 .sp
  95 The \fBmcookie\fP command is part of the util\-linux package which can be downloaded from \c
  96 .URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."