Plugin symbols can't have '-' in them... Also add example to krb5-plugin.7
[heimdal.git] / kpasswd / kpasswd.1
blob679b38924f3208a34a3c59f9c867116840585d60
1 .\" Copyright (c) 1997, 2000 - 2005 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden).
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\"
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" 3. Neither the name of the Institute nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $Id$
33 .\"
34 .Dd January  5, 2005
35 .Dt KPASSWD 1
36 .Os HEIMDAL
37 .Sh NAME
38 .Nm kpasswd
39 .Nd Kerberos 5 password changing program
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl Fl admin-principal= Ns Ar principal
43 .Oo Fl c Ar cache \*(Ba Xo
44 .Fl Fl cache= Ns Ar cache
45 .Xc
46 .Oc
47 .Op Ar principal ...
48 .Sh DESCRIPTION
49 .Nm
50 is the client for changing passwords.
51 .Pp
52 If administrator principal is given that principal is used to change
53 the password.
54 .Pp
55 Multiple passwords for different users can be changed at the same time,
56 then the administrator principal will be used.
57 If the administrator isn't specified on the command prompt, the
58 principal of the default credential cache will be used.
59 .Pp
60 If a credential cache is given, the
61 .Fl Fl admin-principal
62 flag is ignored and use the default name of the credential cache is
63 used instead.
64 .Sh DIAGNOSTICS
65 If the password quality check fails or some other error occurs, an
66 explanation is printed.
67 .Sh SEE ALSO
68 .Xr kpasswdd 8