diff options
author | Rich Salz <rsalz@akamai.com> | 2019-10-12 17:45:56 -0400 |
---|---|---|
committer | Tomas Mraz <tmraz@fedoraproject.org> | 2019-10-31 14:19:29 +0100 |
commit | 9fcb9702fba8aa135945f96aefddf050a6f4f11d (patch) | |
tree | 5fa0e0061ca70c9b0678636ee68c713653e7dba8 /doc/man1/openssl-srp.pod.in | |
parent | fb1ecf85c9f732e5827771ff243d7a70e06ce112 (diff) |
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)
Diffstat (limited to 'doc/man1/openssl-srp.pod.in')
-rw-r--r-- | doc/man1/openssl-srp.pod.in | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/doc/man1/openssl-srp.pod.in b/doc/man1/openssl-srp.pod.in new file mode 100644 index 0000000000..24990c9148 --- /dev/null +++ b/doc/man1/openssl-srp.pod.in @@ -0,0 +1,91 @@ +=pod + +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + +=head1 NAME + +openssl-srp - maintain SRP password file + +=head1 SYNOPSIS + +B<openssl srp> +[B<-help>] +[B<-verbose>] +[B<-add>] +[B<-modify>] +[B<-delete>] +[B<-list>] +[B<-name> I<section>] +[B<-config> I<file>] +[B<-srpvfile> I<file>] +[B<-gn> I<identifier>] +[B<-userinfo> I<text>] +[B<-passin> I<arg>] +[B<-passout> I<arg>] +{- $OpenSSL::safe::opt_r_synopsis -} +[I<user> ...] + +=for openssl ifdef engine + +=head1 DESCRIPTION + +This command is used to maintain an SRP (secure remote password) file. +At most one of the B<-add>, B<-modify>, B<-delete>, and B<-list> options +can be specified. +These options take zero or more usernames as parameters and perform the +appropriate operation on the SRP file. +For B<-list>, if no I<user> is given then all users are displayed. + +The configuration file to use, and the section within the file, can be +specified with the B<-config> and B<-name> flags, respectively. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Display an option summary. + +=item B<-verbose> + +Generate verbose output while processing. + +=item B<-srpvfile> I<file> + +If the config file is not specified, +B<-srpvfile> can be used to specify the file to operate on. + +=item B<-gn> + +Specifies the B<g> and B<N> values, using one of +the strengths defined in IETF RFC 5054. + +=item B<-userinfo> + +specifies additional information to add when +adding or modifying a user. + +=item B<-passin> I<arg>, B<-passout> I<arg> + +The password source for the input and output file. +For more information about the format of B<arg> +see L<openssl(1)/Pass Phrase Options>. + +{- $OpenSSL::safe::opt_r_synopsis -} + +=back + +=head1 COPYRIGHT + +Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (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 |