Doc fixes
[openssl.git] / doc / man1 / srp.pod
1 =pod
2
3 =head1 NAME
4
5 srp - maintain SRP password file
6
7 =head1 SYNOPSIS
8
9 B<openssl srp>
10 [B<-help>]
11 [B<-verbose>]
12 [B<-add>]
13 [B<-modify>]
14 [B<-delete>]
15 [B<-list>]
16 [B<-name section>]
17 [B<-config file>]
18 [B<-srpvfile file>]
19 [B<-gn identifier>]
20 [B<-userinfo text...>]
21 [B<-passin arg>]
22 [B<-passout arg>]
23 [I<user...>]
24
25 =head1 DESCRIPTION
26
27 The B<srp> command is user to maintain an SRP (secure remote password)
28 file.
29 At most one of the B<-add>, B<-modify>, B<-delete>, and B<-list> options
30 can be specified.
31 These options take zero or more usernames as parameters and perform the
32 appropriate operation on the SRP file.
33 For B<-list>, if no B<user> is given then all users are displayed.
34
35 The configuration file to use, and the section within the file, can be
36 specified with the B<-config> and B<-name> flags, respectively.
37 If the config file is not specified, the B<-srpvfile> can be used to
38 just specify the file to operate on.
39
40 The B<-userinfo> option specifies additional information to add when
41 adding or modifying a user.
42
43 The B<-gn> flag specifies the B<g> and B<N> values, using one of
44 the strengths defined in IETF RFC 5054.
45
46 The B<-passin> and B<-passout> arguments are parsed as described in
47 the L<openssl(1)> command.
48
49 =head1 OPTIONS
50
51 =over 4
52
53 =item [B<-help>]
54
55 Display an option summary.
56
57 =item [B<-verbose>]
58
59 Generate verbose output while processing.
60
61 =back
62
63 =head1 COPYRIGHT
64
65 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
66
67 Licensed under the OpenSSL license (the "License").  You may not use
68 this file except in compliance with the License.  You can obtain a copy
69 in the file LICENSE in the source distribution or at
70 L<https://www.openssl.org/source/license.html>.
71
72 =cut