crypto/dist/heimdal/appl/afsutil/afslog.1

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