d6260ee99cac6aa97aad8c04b5cfb1712baa21fc
[openssl.git] / doc / man1 / rand.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-rand,
6 rand - generate pseudo-random bytes
7
8 =head1 SYNOPSIS
9
10 B<openssl rand>
11 [B<-help>]
12 [B<-out> I<file>]
13 [B<-rand file...>]
14 [B<-writerand file>]
15 [B<-base64>]
16 [B<-hex>]
17 I<num>
18
19 =head1 DESCRIPTION
20
21 The B<rand> command outputs I<num> pseudo-random bytes after seeding
22 the random number generator once.  As in other B<openssl> command
23 line tools, PRNG seeding uses the file I<$HOME/>B<.rnd> or B<.rnd>
24 in addition to the files given in the B<-rand> option.  A new
25 I<$HOME>/B<.rnd> or B<.rnd> file will be written back if enough
26 seeding was obtained from these sources.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item B<-help>
33
34 Print out a usage message.
35
36 =item B<-out file>
37
38 Write to I<file> instead of standard output.
39
40 =item B<-rand file...>
41
42 A file or files containing random data used to seed the random number
43 generator.
44 Multiple files can be specified separated by an OS-dependent character.
45 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
46 all others.
47
48 =item [B<-writerand file>]
49
50 Writes random data to the specified I<file> upon exit.
51 This can be used with a subsequent B<-rand> flag.
52
53 =item B<-base64>
54
55 Perform base64 encoding on the output.
56
57 =item B<-hex>
58
59 Show the output as a hex string.
60
61 =back
62
63 =head1 SEE ALSO
64
65 L<RAND_bytes(3)>
66
67 =head1 COPYRIGHT
68
69 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
70
71 Licensed under the Apache License 2.0 (the "License").  You may not use
72 this file except in compliance with the License.  You can obtain a copy
73 in the file LICENSE in the source distribution or at
74 L<https://www.openssl.org/source/license.html>.
75
76 =cut