openssl/doc/man1/openssl-srp.pod.in
Rich Salz 9fcb9702fb 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-31 14:19:29 +01:00

92 lines
1.9 KiB
Plaintext

=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