freebsd-dev/crypto/heimdal/appl/afsutil/afslog.1

153 lines
4.0 KiB
Groff
Raw Normal View History

2011-10-05 07:23:29 +00:00
.\" Copyright (c) 2002 - 2007 Kungliga Tekniska Högskolan
.\" (Royal Institute of Technology, Stockholm, Sweden).
.\" All rights reserved.
2003-10-09 19:36:20 +00:00
.\"
2011-10-05 07:23:29 +00:00
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
2003-10-09 19:36:20 +00:00
.\"
2011-10-05 07:23:29 +00:00
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
2003-10-09 19:36:20 +00:00
.\"
2011-10-05 07:23:29 +00:00
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
2003-10-09 19:36:20 +00:00
.\"
2011-10-05 07:23:29 +00:00
.\" 3. Neither the name of the Institute nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
2003-10-09 19:36:20 +00:00
.\"
2011-10-05 07:23:29 +00:00
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id$
2003-10-09 19:36:20 +00:00
.\"
.Dd November 26, 2002
.Dt AFSLOG 1
.Os HEIMDAL
.Sh NAME
.Nm afslog
2011-10-05 07:23:29 +00:00
.Nd obtain AFS tokens
2003-10-09 19:36:20 +00:00
.Sh SYNOPSIS
.Nm
2011-10-05 07:23:29 +00:00
.Op Fl h | Fl Fl help
.Op Fl Fl no-v4
.Op Fl Fl no-v5
.Op Fl u | Fl Fl unlog
.Op Fl v | Fl Fl verbose
.Op Fl Fl version
2003-10-09 19:36:20 +00:00
.Oo Fl c Ar cell \*(Ba Xo
2011-10-05 07:23:29 +00:00
.Fl Fl cell= Ns Ar cell
2003-10-09 19:36:20 +00:00
.Xc
.Oc
.Oo Fl k Ar realm \*(Ba Xo
2011-10-05 07:23:29 +00:00
.Fl Fl realm= Ns Ar realm
2003-10-09 19:36:20 +00:00
.Xc
.Oc
2008-05-07 13:39:42 +00:00
.Oo Fl P Ar principal \*(Ba Xo
2011-10-05 07:23:29 +00:00
.Fl Fl principal= Ns Ar principal
2008-05-07 13:39:42 +00:00
.Xc
.Oc
.Bk -words
.Oo Fl p Ar path \*(Ba Xo
2011-10-05 07:23:29 +00:00
.Fl Fl file= Ns Ar path
2008-05-07 13:39:42 +00:00
.Xc
.Oc
.Ek
2003-10-09 19:36:20 +00:00
.Op Ar cell | path ...
.Sh DESCRIPTION
.Nm
obtains AFS tokens for a number of cells. What cells to get tokens for
can either be specified as an explicit list, as file paths to get
tokens for, or be left unspecified, in which case
.Nm
2011-10-05 07:23:29 +00:00
will use whatever magic
2003-10-09 19:36:20 +00:00
.Xr krb_afslog 3
decides upon.
.Pp
Supported options:
.Bl -tag -width Ds
2011-10-05 07:23:29 +00:00
.It Fl Fl no-v4
2003-10-09 19:36:20 +00:00
This makes
.Nm
not try using Kerberos 4.
2011-10-05 07:23:29 +00:00
.It Fl Fl no-v5
2003-10-09 19:36:20 +00:00
This makes
.Nm
not try using Kerberos 5.
.It Xo
2008-05-07 13:39:42 +00:00
.Fl P Ar principal ,
2011-10-05 07:23:29 +00:00
.Fl Fl principal Ar principal
2008-05-07 13:39:42 +00:00
.Xc
select what Kerberos 5 principal to use.
2011-10-05 07:23:29 +00:00
.It Fl Fl cache Ar cache
2008-05-07 13:39:42 +00:00
select what Kerberos 5 credential cache to use.
2011-10-05 07:23:29 +00:00
.Fl Fl principal
2008-05-07 13:39:42 +00:00
overrides this option.
.It Xo
2003-10-09 19:36:20 +00:00
.Fl u ,
2011-10-05 07:23:29 +00:00
.Fl Fl unlog
2003-10-09 19:36:20 +00:00
.Xc
Destroy tokens instead of obtaining new. If this is specified, all
other options are ignored (except for
2011-10-05 07:23:29 +00:00
.Fl Fl help
2003-10-09 19:36:20 +00:00
and
2011-10-05 07:23:29 +00:00
.Fl Fl version ) .
2003-10-09 19:36:20 +00:00
.It Xo
.Fl v ,
2011-10-05 07:23:29 +00:00
.Fl Fl verbose
2003-10-09 19:36:20 +00:00
.Xc
Adds more verbosity for what is actually going on.
2008-05-07 13:39:42 +00:00
.It Xo
.Fl c Ar cell,
2011-10-05 07:23:29 +00:00
.Fl Fl cell= Ns Ar cell
2008-05-07 13:39:42 +00:00
.Xc
This specified one or more cell names to get tokens for.
.It Xo
.Fl k Ar realm ,
2011-10-05 07:23:29 +00:00
.Fl Fl realm= Ns Ar realm
2008-05-07 13:39:42 +00:00
.Xc
This is the Kerberos realm the AFS servers live in, this should
normally not be specified.
.It Xo
.Fl p Ar path ,
2011-10-05 07:23:29 +00:00
.Fl Fl file= Ns Ar path
2008-05-07 13:39:42 +00:00
.Xc
This specified one or more file paths for which tokens should be
obtained.
2003-10-09 19:36:20 +00:00
.El
2008-05-07 13:39:42 +00:00
.Pp
2003-10-09 19:36:20 +00:00
Instead of using
.Fl c
and
.Fl p ,
you may also pass a list of cells and file paths after any other
2011-10-05 07:23:29 +00:00
options. These arguments are considered files if they are either
2003-10-09 19:36:20 +00:00
the strings
.Do . Dc
or
2011-10-05 07:23:29 +00:00
.Dq ..
2003-10-09 19:36:20 +00:00
or they contain a slash, or if there exists a file by that name.
.Sh EXAMPLES
2011-10-05 07:23:29 +00:00
Assuming that there is no file called
2003-10-09 19:36:20 +00:00
.Dq openafs.org
2011-10-05 07:23:29 +00:00
in the current directory, and that
2003-10-09 19:36:20 +00:00
.Pa /afs/openafs.org
points to that cell, the follwing should be identical:
.Bd -literal -offset indent
$ afslog -c openafs.org
$ afslog openafs.org
$ afslog /afs/openafs.org/some/file
2011-10-05 07:23:29 +00:00
.Ed
2003-10-09 19:36:20 +00:00
.Sh SEE ALSO
.Xr krb_afslog 3