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