mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-02-05 14:10:53 +08:00
Code Issues Packages Projects Releases Wiki Activity
f5c14c6322
openssl/doc/man1/openssl-rand.pod

78 lines
1.6 KiB
Plaintext
Raw Normal View History

Document the 'rand' application.
2000-03-01 15:57:25 +08:00
=pod
=head1 NAME
Deprecate unprefixed manual entries for openssl commands Initially, the manual page entry for the 'openssl cmd' command used to be available at 'cmd(1)'. Later, the aliases 'openssl-cmd(1)' was introduced, which made it easier to group the openssl commands using the 'apropos(1)' command or the shell's tab completion. In order to reduce cluttering of the global manual page namespace, the manual page entries without the 'openssl-' prefix have been deprecated in OpenSSL 3.0 and will be removed in OpenSSL 4.0. Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9666)
2019-08-22 07:04:41 +08:00
openssl-rand - generate pseudo-random bytes
Document the 'rand' application.
2000-03-01 15:57:25 +08:00
=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-06 00:58:45 +08:00
[B<-help>]
Document the 'rand' application.
2000-03-01 15:57:25 +08:00
[B<-out> I<file>]
Command docs: remove ellipses for '-rand' Ellipses were used to express that the '-rand' value can specify multiple files, like this: B<-rand> I<file...> Because there are conventions around ellipses, this becomes confusing, because '-rand file...' is normally intepreted to mean that '-rand file1 file2 file3' would be processed as three randomness files, which makes no sense. Rather than making things complicated with more elaborate syntax, we change it to: B<-rand> I<files> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10065)
2019-10-01 16:00:14 +08:00
[B<-rand> I<files>]
Consistent formatting of flags with args For documentation of all commands with "-flag arg" format them consistently: "B<-flag> I<arg>", except when arg is literal (for example "B<-inform> B<PEM>|B<DER>") Update find-doc-nits to complain if badly formatted strings are found. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10022)
2019-09-26 03:20:11 +08:00
[B<-writerand> I<file>]
Document the 'rand' application.
2000-03-01 15:57:25 +08:00
[B<-base64>]
-hex option for openssl rand PR: 1831 Submitted by: Damien Miller
2009-02-02 08:01:28 +08:00
[B<-hex>]
Document the 'rand' application.
2000-03-01 15:57:25 +08:00
I<num>
Add '=for comment ifdef' to pod pages Make find-doc-nits understand that =for comment ifdef ssl3 ... in a POD page means that the "-ssl3" flag might be ifdef'd out in the local environment, and not to complain about it. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9974)
2019-09-23 07:49:25 +08:00
=for comment ifdef engine
Document the 'rand' application.
2000-03-01 15:57:25 +08:00
=head1 DESCRIPTION
Command docs: fix up command references Almost all OpenSSL commands are in reality 'openssl cmd', so make sure they are refered to like that and not just as the sub-command. Self-references are avoided as much as is possible, and replaced with "this command". In some cases, we even avoid that with a slight rewrite of the sentence or paragrah they were in. However, in the few cases where a self-reference is still admissible, they are done in bold, i.e. openssl-speed.pod references itself like this: B<openssl speed> References to other commands are done as manual links, i.e. CA.pl.pod references 'openssl req' like this: L<openssl-req(1)> Some commands are examples rather than references; we enclose those in C<>. While we are it, we abolish "utility", replacing it with "command", or remove it entirely in some cases. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10065)
2019-10-02 01:43:36 +08:00
This command outputs I<num> pseudo-random bytes after seeding
ispell
2001-09-07 14:13:40 +08:00
the random number generator once. As in other B<openssl> command
Document the 'rand' application.
2000-03-01 15:57:25 +08: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-06 00:58:45 +08:00
=item B<-help>
Print out a usage message.
Consistent formatting of flags with args For documentation of all commands with "-flag arg" format them consistently: "B<-flag> I<arg>", except when arg is literal (for example "B<-inform> B<PEM>|B<DER>") Update find-doc-nits to complain if badly formatted strings are found. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10022)
2019-09-26 03:20:11 +08:00
=item B<-out> I<file>
Document the 'rand' application.
2000-03-01 15:57:25 +08:00
Write to I<file> instead of standard output.
Command docs: remove ellipses for '-rand' Ellipses were used to express that the '-rand' value can specify multiple files, like this: B<-rand> I<file...> Because there are conventions around ellipses, this becomes confusing, because '-rand file...' is normally intepreted to mean that '-rand file1 file2 file3' would be processed as three randomness files, which makes no sense. Rather than making things complicated with more elaborate syntax, we change it to: B<-rand> I<files> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10065)
2019-10-01 16:00:14 +08:00
=item B<-rand> I<files>
Document the 'rand' application.
2000-03-01 15:57:25 +08:00
Command docs: remove ellipses for '-rand' Ellipses were used to express that the '-rand' value can specify multiple files, like this: B<-rand> I<file...> Because there are conventions around ellipses, this becomes confusing, because '-rand file...' is normally intepreted to mean that '-rand file1 file2 file3' would be processed as three randomness files, which makes no sense. Rather than making things complicated with more elaborate syntax, we change it to: B<-rand> I<files> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10065)
2019-10-01 16:00:14 +08:00
The 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-20 00:28:58 +08:00
Multiple files can be specified separated by an OS-dependent character.
OpenVMS, not OpenVSM...
2000-04-13 00:48:20 +08:00
The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
Document the 'rand' application.
2000-03-01 15:57:25 +08:00
all others.
Consistent formatting of flags with args For documentation of all commands with "-flag arg" format them consistently: "B<-flag> I<arg>", except when arg is literal (for example "B<-inform> B<PEM>|B<DER>") Update find-doc-nits to complain if badly formatted strings are found. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10022)
2019-09-26 03:20:11 +08:00
=item B<-writerand> 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 22:58:48 +08:00
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 15:57:25 +08:00
=item B<-base64>
Perform base64 encoding on the output.
-hex option for openssl rand PR: 1831 Submitted by: Damien Miller
2009-02-02 08:01:28 +08:00
=item B<-hex>
Show the output as a hex string.
Document the 'rand' application.
2000-03-01 15:57:25 +08:00
=back
'rand'/'-rand' documentation.
2000-03-01 19:45:53 +08:00
=head1 SEE ALSO
Deprecate unprefixed manual entries for openssl commands Initially, the manual page entry for the 'openssl cmd' command used to be available at 'cmd(1)'. Later, the aliases 'openssl-cmd(1)' was introduced, which made it easier to group the openssl commands using the 'apropos(1)' command or the shell's tab completion. In order to reduce cluttering of the global manual page namespace, the manual page entries without the 'openssl-' prefix have been deprecated in OpenSSL 3.0 and will be removed in OpenSSL 4.0. Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9666)
2019-08-22 07:04:41 +08:00
L<openssl(1)>,
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-18 03:21:33 +08:00
L<RAND_bytes(3)>
'rand'/'-rand' documentation.
2000-03-01 19:45:53 +08:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
=head1 COPYRIGHT
Deprecate unprefixed manual entries for openssl commands Initially, the manual page entry for the 'openssl cmd' command used to be available at 'cmd(1)'. Later, the aliases 'openssl-cmd(1)' was introduced, which made it easier to group the openssl commands using the 'apropos(1)' command or the shell's tab completion. In order to reduce cluttering of the global manual page namespace, the manual page entries without the 'openssl-' prefix have been deprecated in OpenSSL 3.0 and will be removed in OpenSSL 4.0. Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9666)
2019-08-22 07:04:41 +08:00
Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
Following the license change, modify the boilerplates in doc/man1/ [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7828)
2018-12-06 21:04:11 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
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 New Issue Copy Permalink