Merge from vendor branch HEIMDAL:
[dragonfly.git] / crypto / heimdal-0.6.3 / appl / afsutil / afslog.1
1 .\" Copyright (c) 2002 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: afslog.1,v 1.3 2003/03/18 04:29:34 lha Exp $
33 .\"
34 .Dd November 26, 2002
35 .Dt AFSLOG 1
36 .Os HEIMDAL
37 .Sh NAME
38 .Nm afslog
39 .Nd
40 obtain AFS tokens
41 .Sh SYNOPSIS
42 .Nm
43 .Oo Fl c Ar cell \*(Ba Xo
44 .Fl -cell= Ns Ar cell
45 .Xc
46 .Oc
47 .Oo Fl p Ar path \*(Ba Xo
48 .Fl -file= Ns Ar path
49 .Xc
50 .Oc
51 .Oo Fl k Ar realm \*(Ba Xo
52 .Fl -realm= Ns Ar realm
53 .Xc
54 .Oc
55 .Op Fl -no-v4
56 .Op Fl -no-v5
57 .Op Fl u | Fl -unlog
58 .Op Fl v | Fl -verbose
59 .Op Fl -version
60 .Op Fl h | Fl -help
61 .Op Ar cell | path ...
62 .Sh DESCRIPTION
63 .Nm
64 obtains AFS tokens for a number of cells. What cells to get tokens for
65 can either be specified as an explicit list, as file paths to get
66 tokens for, or be left unspecified, in which case
67 .Nm
68 will use whatever magic 
69 .Xr krb_afslog 3
70 decides upon.
71 .Pp
72 Supported options:
73 .Bl -tag -width Ds
74 .It Xo
75 .Fl c Ar cell,
76 .Fl -cell= Ns Ar cell
77 .Xc
78 This specified one or more cell names to get tokens for.
79 .It Xo
80 .Fl p Ar path ,
81 .Fl -file= Ns Ar path
82 .Xc
83 This specified one or more file paths for which tokens should be
84 obtained.
85 .It Xo
86 .Fl k Ar realm ,
87 .Fl -realm= Ns Ar realm
88 .Xc
89 This is the Kerberos realm the AFS servers live in, this should
90 normally not be specified.
91 .It Fl -no-v4
92 This makes
93 .Nm
94 not try using Kerberos 4.
95 .It Fl -no-v5
96 This makes
97 .Nm
98 not try using Kerberos 5.
99 .It Xo
100 .Fl u ,
101 .Fl -unlog
102 .Xc
103 Destroy tokens instead of obtaining new. If this is specified, all
104 other options are ignored (except for
105 .Fl -help
106 and
107 .Fl -version ) .
108 .It Xo
109 .Fl v ,
110 .Fl -verbose
111 .Xc
112 Adds more verbosity for what is actually going on.
113 .El
114 Instead of using
115 .Fl c
116 and
117 .Fl p ,
118 you may also pass a list of cells and file paths after any other
119 options. These arguments are considered files if they are either 
120 the strings
121 .Do . Dc
122 or
123 .Dq .. 
124 or they contain a slash, or if there exists a file by that name.
125 .Sh EXAMPLES
126 Assuming that there is no file called 
127 .Dq openafs.org
128 in the current directory, and that 
129 .Pa /afs/openafs.org
130 points to that cell, the follwing should be identical:
131 .Bd -literal -offset indent
132 $ afslog -c openafs.org
133 $ afslog openafs.org
134 $ afslog /afs/openafs.org/some/file
135 .Ed 
136 .Sh SEE ALSO
137 .Xr krb_afslog 3