wbrawner/openssl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openssl/doc/man1/rand.pod

76 lines
1.6 KiB
Text
Raw Normal View History

Document the 'rand' application.
2000-03-01 07:57:25 +00:00
=pod
=head1 NAME
rand - generate pseudo-random bytes
=head1 SYNOPSIS
B<openssl rand>
GH628: Add -help to all apps docs. Signed-off-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org>
2016-02-05 16:58:45 +00:00
[B<-help>]
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
[B<-out> I<file>]
Standardize apps use of -rand, etc. Standardized the -rand flag and added a new one: -rand file... Always reads the specified files -writerand file Always writes to the file on exit For apps that use a config file, the RANDFILE config parameter reads the file at startup (to seed the RNG) and write to it on exit if the -writerand flag isn't used. Ensured that every app that took -rand also took -writerand, and made sure all of that agreed with all the documentation. Fix error reporting in write_file and -rand Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/3862)
2017-07-05 14:58:48 +00:00
[B<-rand file...>]
[B<-writerand file>]
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
[B<-base64>]
-hex option for openssl rand PR: 1831 Submitted by: Damien Miller
2009-02-02 00:01:28 +00:00
[B<-hex>]
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
I<num>
=head1 DESCRIPTION
The B<rand> command outputs I<num> pseudo-random bytes after seeding
ispell
2001-09-07 06:13:40 +00:00
the random number generator once. As in other B<openssl> command
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
line tools, PRNG seeding uses the file I<$HOME/>B<.rnd> or B<.rnd>
in addition to the files given in the B<-rand> option. A new
I<$HOME>/B<.rnd> or B<.rnd> file will be written back if enough
seeding was obtained from these sources.
=head1 OPTIONS
=over 4
GH628: Add -help to all apps docs. Signed-off-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org>
2016-02-05 16:58:45 +00:00
=item B<-help>
Print out a usage message.
Standardize apps use of -rand, etc. Standardized the -rand flag and added a new one: -rand file... Always reads the specified files -writerand file Always writes to the file on exit For apps that use a config file, the RANDFILE config parameter reads the file at startup (to seed the RNG) and write to it on exit if the -writerand flag isn't used. Ensured that every app that took -rand also took -writerand, and made sure all of that agreed with all the documentation. Fix error reporting in write_file and -rand Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/3862)
2017-07-05 14:58:48 +00:00
=item B<-out file>
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
Write to I<file> instead of standard output.
Standardize apps use of -rand, etc. Standardized the -rand flag and added a new one: -rand file... Always reads the specified files -writerand file Always writes to the file on exit For apps that use a config file, the RANDFILE config parameter reads the file at startup (to seed the RNG) and write to it on exit if the -writerand flag isn't used. Ensured that every app that took -rand also took -writerand, and made sure all of that agreed with all the documentation. Fix error reporting in write_file and -rand Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/3862)
2017-07-05 14:58:48 +00:00
=item B<-rand file...>
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
Standardize apps use of -rand, etc. Standardized the -rand flag and added a new one: -rand file... Always reads the specified files -writerand file Always writes to the file on exit For apps that use a config file, the RANDFILE config parameter reads the file at startup (to seed the RNG) and write to it on exit if the -writerand flag isn't used. Ensured that every app that took -rand also took -writerand, and made sure all of that agreed with all the documentation. Fix error reporting in write_file and -rand Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/3862)
2017-07-05 14:58:48 +00:00
A file or files containing random data used to seed the random number
generator.
Fixed a bunch of typos in the docs Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-03-19 16:28:58 +00:00
Multiple files can be specified separated by an OS-dependent character.
OpenVMS, not OpenVSM...
2000-04-12 16:48:20 +00:00
The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
all others.
Standardize apps use of -rand, etc. Standardized the -rand flag and added a new one: -rand file... Always reads the specified files -writerand file Always writes to the file on exit For apps that use a config file, the RANDFILE config parameter reads the file at startup (to seed the RNG) and write to it on exit if the -writerand flag isn't used. Ensured that every app that took -rand also took -writerand, and made sure all of that agreed with all the documentation. Fix error reporting in write_file and -rand Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/3862)
2017-07-05 14:58:48 +00:00
=item [B<-writerand file>]
Writes random data to the specified I<file> upon exit.
This can be used with a subsequent B<-rand> flag.
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
=item B<-base64>
Perform base64 encoding on the output.
-hex option for openssl rand PR: 1831 Submitted by: Damien Miller
2009-02-02 00:01:28 +00:00
=item B<-hex>
Show the output as a hex string.
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
=back
'rand'/'-rand' documentation.
2000-03-01 11:45:53 +00:00
=head1 SEE ALSO
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-17 19:21:33 +00:00
L<RAND_bytes(3)>
'rand'/'-rand' documentation.
2000-03-01 11:45:53 +00:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 15:44:05 +00:00
=head1 COPYRIGHT
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut
Reference in a new issue Copy permalink