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