QuasarApp/openssl
4
0
Fork 0
mirror of https://github.com/QuasarApp/openssl.git synced 2025-05-14 18:39:40 +00:00
Code Issues Projects Releases Wiki Activity
openssl/doc/man1/openssl-rand.pod.in

67 lines
1.1 KiB
Plaintext
Raw Normal View History

Document the 'rand' application.
2000-03-01 07:57:25 +00:00
=pod
Use a function to generate do-not-edit comment Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10316)
2019-10-30 23:35:08 -04:00
{- OpenSSL::safe::output_do_not_edit_headers(); -}
Infrastructure for templated doc in POD files Use new doc-build capabilities Add -i flag to dofile. Add doc/man1 to SUBDIRS for the new templated doc files Rewrite commit a397aca (merged from PR 10118) to use the doc-template stuff. Put template references in common place Template options and text come at the end of command-specific options: opt_x, opt_trust, opt_r (in that order). Refactor xchain options. Do doc-nits after building generated sources. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10159)
2019-10-12 17:45:56 -04:00
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
=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 01:04:41 +02:00
openssl-rand - generate pseudo-random bytes
Document the 'rand' application.
2000-03-01 07:57:25 +00: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-05 11:58:45 -05:00
[B<-help>]
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
[B<-out> I<file>]
[B<-base64>]
-hex option for openssl rand PR: 1831 Submitted by: Damien Miller
2009-02-02 00:01:28 +00:00
[B<-hex>]
Document most missing options Add cmd-nits make target. Listing options should stop when it hits the "parameters" separator. Add missing .pod.in files to doc/man1/build.info Tweak find-doc-nits to try openssl-XXX before XXX for POD files and change an error messavge to be more useful. Fix the following pages: ca, cms, crl, dgst, enc, engine, errstr, gendsa, genrsa, list, ocsp, passwd, pkcs7, pkcs12, rand, rehash, req, rsautil, s_server, speed, s_time, sess_id, smime, srp, ts, x509. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/10873)
2020-01-16 13:40:52 -05:00
{- $OpenSSL::safe::opt_engine_synopsis -}
Infrastructure for templated doc in POD files Use new doc-build capabilities Add -i flag to dofile. Add doc/man1 to SUBDIRS for the new templated doc files Rewrite commit a397aca (merged from PR 10118) to use the doc-template stuff. Put template references in common place Template options and text come at the end of command-specific options: opt_x, opt_trust, opt_r (in that order). Refactor xchain options. Do doc-nits after building generated sources. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10159)
2019-10-12 17:45:56 -04:00
{- $OpenSSL::safe::opt_r_synopsis -}
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
I<num>
Replace '=for comment ifdef' with '=for openssl' Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10151)
2019-10-11 11:52:12 -04:00
=for openssl ifdef engine
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-22 19:49:25 -04:00
Document the 'rand' application.
2000-03-01 07:57:25 +00: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-01 19:43:36 +02:00
This command outputs I<num> pseudo-random bytes after seeding
Refactor many common flags into openssl.pod Options moved: -rand, -writerand, -CApath, -CAfile, -no-CApath, -no-CAfile Added rand to dgst and srp manpages (they were missing them). New sections in openssl.pod: Random State Options, Trusted Certificate Options. Cleanup and add comments to find-doc-nits Remove ".in" file support; unless giving specific arguments, this only runs after configuration Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10118)
2019-10-03 22:28:40 -04:00
the random number generator once.
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
=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 11:58:45 -05: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-25 15:20:11 -04:00
=item B<-out> I<file>
Document the 'rand' application.
2000-03-01 07:57:25 +00:00
Write to I<file> instead of standard output.
=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 most missing options Add cmd-nits make target. Listing options should stop when it hits the "parameters" separator. Add missing .pod.in files to doc/man1/build.info Tweak find-doc-nits to try openssl-XXX before XXX for POD files and change an error messavge to be more useful. Fix the following pages: ca, cms, crl, dgst, enc, engine, errstr, gendsa, genrsa, list, ocsp, passwd, pkcs7, pkcs12, rand, rehash, req, rsautil, s_server, speed, s_time, sess_id, smime, srp, ts, x509. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/10873)
2020-01-16 13:40:52 -05:00
{- $OpenSSL::safe::opt_engine_item -}
Infrastructure for templated doc in POD files Use new doc-build capabilities Add -i flag to dofile. Add doc/man1 to SUBDIRS for the new templated doc files Rewrite commit a397aca (merged from PR 10118) to use the doc-template stuff. Put template references in common place Template options and text come at the end of command-specific options: opt_x, opt_trust, opt_r (in that order). Refactor xchain options. Do doc-nits after building generated sources. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10159)
2019-10-12 17:45:56 -04:00
{- $OpenSSL::safe::opt_r_item -}
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
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 01:04:41 +02: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-17 15:21:33 -04: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 11:44:05 -04: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 01:04:41 +02: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 11:44:05 -04: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 14:04:11 +01: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 11:44:05 -04: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