import cyrus-sasl-2.1.23
[cyrus-sasl.git] / utils / saslpasswd2.8
1 .\" saslpasswd.8 -- saslpasswd man page
2 .\" Rob Earhart
3 .\"
4
5 .\" Copyright (c) 2000 Carnegie Mellon University.  All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\"
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer. 
13 .\"
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in
16 .\"    the documentation and/or other materials provided with the
17 .\"    distribution.
18 .\"
19 .\" 3. The name ""Carnegie Mellon University"" must not be used to
20 .\"    endorse or promote products derived from this software without
21 .\"    prior written permission. For permission or any other legal
22 .\"    details, please contact  
23 .\"      Office of Technology Transfer
24 .\"      Carnegie Mellon University
25 .\"      5000 Forbes Avenue
26 .\"      Pittsburgh, PA  15213-3890
27 .\"      (412) 268-4387, fax: (412) 268-7395
28 .\"      tech-transfer@andrew.cmu.edu
29 .\"
30 .\" 4. Redistributions of any form whatsoever must retain the following
31 .\"    acknowledgment:
32 .\"    ""This product includes software developed by Computing Services
33 .\"     at Carnegie Mellon University (http://www.cmu.edu/computing/).""
34 .\"
35 .\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
36 .\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
37 .\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
38 .\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
39 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
40 .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
41 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
42
43 .\"
44 .TH SASLPASSWD2 8 "Mar 7, 2005" "CMU SASL"
45 .SH NAME
46 saslpasswd2 \- set a user's sasl password
47 .SH SYNOPSIS
48 .B saslpasswd2
49 .RB [ -p ]
50 .RB [ -d ]
51 .RB [ -c ]
52 .RB [ -n ]
53 .RB [ -f\ file ]
54 .RB [ -u\ domain ]
55 .RB [ -a\ appname ]
56 .RB [ -v ]
57 .B userid
58 .SH DESCRIPTION
59 .I saslpasswd2
60 is used by a server administrator to set a user's sasl password for
61 server programs and SASL mechanisms which use the standard libsasl
62 database of user secrets.
63 .SH OPTIONS
64 .TP
65 .B -p
66 Pipe mode \- saslpasswd2 will neither prompt for the password nor
67 verify that it was entered correctly.  This is the default when
68 standard input is not a terminal.
69 .TP
70 .B -c
71 Creates an entry for the user if the user doesn't already exist.  This
72 is mutually exclusive with the
73 .B -d
74 (delete user) flag.
75 .TP
76 .B -d
77 Deletes the entry for the user.  This is mutually exclusive with the
78 .B -c
79 (create user) flag.
80 .TP
81 .B -n
82 Don't set the plaintext \fIuserPassword\fR property for the user.  Only
83 mechanism-specific secrets will be set (e.g. OTP, SRP)
84 .TP
85 .B -u domain
86 use
87 .B domain
88 for user domain (realm).
89 .TP
90 .B -f file
91 use
92 .B file
93 for sasldb
94 .TP
95 .B -a appname
96 use
97 .B appname
98 as application name.
99 .TP
100 .B -v
101 Print libsasl2 version number and exit.
102 .SH SEE ALSO
103 sasldblistusers2(8)
104 .TP
105 rfc2222 \- Simple Authentication and Security Layer (SASL)