Correct the title. This also fooled the automatic documentation builder
[openssl.git] / doc / apps / passwd.pod
1 =pod
2
3 =head1 NAME
4
5 passwd - compute password hashes
6
7 =head1 SYNOPSIS
8
9 B<openssl passwd>
10 [B<-crypt>]
11 [B<-1>]
12 [B<-apr1>]
13 [B<-salt> I<string>]
14 [B<-in> I<file>]
15 [B<-stdin>]
16 [B<-quiet>]
17 [B<-table>]
18 {I<password>}
19
20 =head1 DESCRIPTION
21
22 The B<passwd> command computes the hash of a password typed at
23 run-time or the hash of each password in a list.  The password list is
24 taken from the named file for option B<-in file>, from stdin for
25 option B<-stdin>, and from the command line otherwise.
26 The Unix standard algorithm B<crypt> and the MD5-based BSD password
27 algorithm B<1> and its Apache variant B<apr1> are available.
28
29 =head1 OPTIONS
30
31 =over 4
32
33 =item B<-crypt>
34
35 Use the B<crypt> algorithm (default).
36
37 =item B<-1>
38
39 Use the MD5 based BSD password algorithm B<1>.
40
41 =item B<-apr1>
42
43 Use the B<apr1> algorithm (Apache variant of the BSD algorithm).
44
45 =item B<-salt> I<string>
46
47 Use the specified salt.
48
49 =item B<-in> I<file>
50
51 Read passwords from I<file>.
52
53 =item B<-stdin>
54
55 Read passwords from B<stdin>.
56
57 =item B<-quiet>
58
59 Don't output warnings when passwords given at the command line are truncated.
60
61 =item B<-table>
62
63 In the output list, prepend the cleartext password and a TAB character
64 to each password hash.
65
66 =back
67
68 =head1 EXAMPLES
69
70 B<openssl passwd -crypt -salt xx password> prints B<xxj31ZMTZzkVA>.
71
72 B<openssl passwd -1 -salt xxxxxxxx password> prints B<$1$xxxxxxxx$8XJIcl6ZXqBMCK0qFevqT1>.
73
74 B<openssl passwd -apr1 -salt xxxxxxxx password> prints B<$apr1$xxxxxxxx$dxHfLAsjHkDRmG83UXe8K0>.
75
76 =cut