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