arlad/arlad.8

   1 .\" Copyright (c) 2000 - 2006 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 .\"     $OpenBSD: afsd.8,v 1.10 2000/04/27 23:04:36 hin Exp $
  33 .\"     $Id$
  34 .\"
  35 .Dd February 19, 2006
  36 .Dt ARLAD 1
  37 .Os "The Arla Project"
  38 .Sh NAME
  39 .Nm arlad
  40 .Nd AFS cache manager for nnpfs
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Bk -words
  44 .Op Fl t | Fl -test
  45 .Oo Fl c Ar string \*(Ba Xo
  46 .Fl -conffile= Ns Ar string Oc
  47 .Xc
  48 .Oo Fl l Ar string \*(Ba Xo
  49 .Fl -log= Ns Ar string Oc
  50 .Xc
  51 .Op Fl -debug= Ns Ar string
  52 .Oo Fl d Ar string \*(Ba Xo
  53 .Fl -device= Ns Ar string Oc
  54 .Xc
  55 .Op Fl -connected-mode= Ns Ar string
  56 .Op Fl n | Fl -no-fork
  57 .Oo Fl r Ar string \*(Ba Xo
  58 .Fl -rxkad-level= Ns Ar string Oc
  59 .Xc
  60 .Oo Fl s Ar string \*(Ba Xo
  61 .Fl -sysname= Ns Ar string Oc
  62 .Xc
  63 .Op Fl -root-volume= Ns Ar string
  64 .Op Fl -port= Ns Ar number
  65 .Op Fl z | Fl -recover
  66 .Op Fl -cache-dir= Ns Ar string
  67 .Op Fl -tracefile= Ns Ar filename
  68 .Op Fl D | -dynroot
  69 .Op Fl -no-largefile
  70 .Op Fl -workers= Ns Ar number
  71 .Op Fl -cpu-usage
  72 .Op Fl -version
  73 .Op Fl -help
  74 .Op Ar device
  75 .Ek
  76 .Sh DESCRIPTION
  77 .Nm
  78 runs on AFS client machines.
  79 It is used to manage the file cache, fetch files
  80 from AFS servers, handle callbacks and manage the authentication information
  81 for users.
  82 .Pp
  83 In normal cases you will not need to run
  84 .Nm
  85 by yourself, a system startup script will start
  86 .Nm
  87 or you can use startarla.
  88 .Pp
  89 The options are as follows:
  90 .Bl -tag -width Ds
  91 .It Xo
  92 .Fl t Ns ,
  93 .Fl -test
  94 .Xc
  95 Run in test mode.
  96 .It Xo
  97 .Fl c Ar string Ns ,
  98 .Fl -conffile= Ns Ar string
  99 .Xc
 100 Path to configuration file.
 101 .It Xo
 102 .Fl l Ar string Ns ,
 103 .Fl -log= Ns Ar string
 104 .Xc
 105 Where to write log [stderr|syslog|path] (default: stderr).
 106 .It Xo
 107 .Fl -debug= Ns Ar string
 108 .Xc
 109 What to write in the log (default: none).
 110 .It Xo
 111 .Fl d Ar string Ns ,
 112 .Fl -device= Ns Ar string
 113 .Xc
 114 The NNPFS device to use
 115 .Po default: Pa /dev/nnpfs0
 116 .Pc .
 117 .It Xo
 118 .Fl -connected-mode= Ns Ar string
 119 .Xc
 120 Initial connected mode [conncted|fetch-only|disconnected].
 121 .It Xo
 122 .Fl n Ns ,
 123 .Fl -no-fork
 124 .Xc
 125 Don't fork and daemonize.
 126 .It Xo
 127 .Fl r Ar string Ns ,
 128 .Fl -rxkad-level= Ns Ar string
 129 .Xc
 130 The rxkad level to use [clear|auth|crypt] (default: crypt).
 131 .It Xo
 132 .Fl s Ar string Ns ,
 133 .Fl -sysname= Ns Ar string
 134 .Xc
 135 Set the sysname of this system.
 136 .It Xo
 137 .Fl -root-volume= Ns Ar string
 138 .Xc
 139 Name of the root volume.
 140 .It Xo
 141 .Fl -port= Ns Ar number
 142 .Xc
 143 Port number to use.
 144 .It Xo
 145 .Fl z Ns ,
 146 .Fl -recover
 147 .Xc
 148 Don't recover state.
 149 .It Xo
 150 .Fl -cache-dir= Ns Ar string
 151 .Xc
 152 Cache directory
 153 .Po default: Pa /var/spool/afs
 154 .Pc .
 155 .It Xo
 156 .Fl -tracefile= Ns Ar filename
 157 .Xc
 158 Trace all communication on the nnpfs device to the specified file.
 159 The filename is relative to the cache directory.  There is a tool to
 160 read the trace in
 161 .Pa nnpfs/readtrace.py
 162 in the source distribution.
 163 .It Xo
 164 .Fl D Ns ,
 165 .Fl -dynroot
 166 .Xc
 167 Use dynamic root.
 168 .It Xo
 169 .Fl -no-largefile
 170 .Xc
 171 Stop using the O_LARGEFILE flag when opening cache file. This
 172 turns off 64 bit support and lets you use 32-bit file systems\
 173 as cache.
 174 .It Xo
 175 .Fl -workers= Ns Ar number
 176 .Xc
 177 Use the specified number of worker threads.
 178 .It Xo
 179 .Fl -cpu-usage
 180 .Xc
 181 System and userland cpu-usage times is appended at the end line that
 182 is logged.
 183 .It Xo
 184 .Fl -version
 185 .Xc
 186 Print version information.
 187 .It Xo
 188 .Fl -help
 189 .Xc
 190 Print usage information.
 191 .El
 192 .Sh FILES
 193 .Bl -tag -width CellServDB -compact
 194 .It Pa arlad.conf
 195 default configuration for arlad
 196 .It Pa CellServDB
 197 database with all known AFS servers
 198 .It Pa ThisCell
 199 default cell (where we get the root directory)
 200 .El
 201 .Pp
 202 It is highly recommended that the cache directory be a separate
 203 file system.
 204 If enough memory is available the cache directory could be a mfs to
 205 drastically improve performance.
 206 .Sh SEE ALSO
 207 .Xr arlad 1 ,
 208 .Xr fs 1 ,
 209 .Xr pts 1 ,
 210 .Xr AliasDB 5 ,
 211 .Xr CellServDB 5 ,
 212 .Xr DynRootDB 5 ,
 213 .Xr SuidCells 5 ,
 214 .Xr ThisCell 5 ,
 215 .Xr arla.conf 5 ,
 216 .Xr mount_nnpfs 8 ,
 217 .Xr vos 8