fixup error messages
[heimdal.git] / kuser / copy_cred_cache.1
blob0a3f46fbe8502ccd2bf65292e234f473c5d3901f
1 .\" Copyright (c) 2004 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 April 24, 2004
35 .Dt COPY_CRED_CACHE 1
36 .Os HEIMDAL
37 .Sh NAME
38 .Nm copy_cred_cache
39 .Nd copy credentials from one cache to another
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl Fl krbtgt-only
43 .Op Fl Fl service= Ns Ar principal
44 .Op Fl Fl enctype= Ns Ar enctype
45 .Op Fl Fl flags= Ns Ar ticketflags
46 .Op Fl Fl valid-for= Ns Ar time
47 .Op Fl Fl fcache-version= Ns Ar integer
48 .Op Aq Ar from-cache
49 .Aq Ar to-cache
50 .Sh DESCRIPTION
51 .Nm
52 copies credentials from
53 .Aq Ar from-cache
54 (or the default cache) to
55 .Aq Ar to-cache .
56 .Pp
57 Supported options:
58 .Bl -tag -width Ds
59 .It Fl Fl krbtgt-only
60 Copies only krbtgt credentials for the client's realm. This is
61 equivalent to
62 .Fl Fl service= Ns Li krbtgt/ Ns Ao Ar CLIENTREALM Ac Ns Li @ Ns Ao Ar CLIENTREALM Ac .
63 .It Fl Fl service= Ns Ar principal
64 Copies only credentials matching this service principal.
65 .It Fl Fl enctype= Ns Ar enctype
66 Copies only credentials a matching enctype.
67 .It Fl Fl flags= Ns Ar ticketflags
68 Copies only credentials with these ticket flags set.
69 .It Fl Fl valid-for= Ns Ar time
70 Copies only credentials that are valid for at least this long. This
71 does not take renewable creds into account.
72 .It Fl Fl fcache-version= Ns Ar integer
73 The created cache, If a standard
74 .Li FILE
75 cache is created, it will have this file format version.
76 .El
77 .\".Sh ENVIRONMENT
78 .\".Sh FILES
79 .Sh EXAMPLES
80 To copy only credentials that are valid for at least one day and with
81 the
82 .Li initial
83 flag set, try something like:
84 .Bd -literal -offset indent
85 $ copy_cred_cache --valid-for=1d --flags=initial FILE:/some/cache
86 .Ed
87 .Sh DIAGNOSTICS
88 The
89 .Nm
90 utility exits 0 on success, and \*[Gt]0 if an error occurs, or if no
91 credentials where actually copied.
92 .\".Sh SEE ALSO
93 .\".Sh STANDARDS
94 .\".Sh HISTORY
95 .\".Sh AUTHORS
96 .\".Sh BUGS