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