add-afs-man-pages-20010716
authorDerrick Brashear <shadow@dementia.org>
Mon, 16 Jul 2001 19:48:32 +0000 (19:48 +0000)
committerDerrick Brashear <shadow@dementia.org>
Mon, 16 Jul 2001 19:48:32 +0000 (19:48 +0000)
documentation from afs command reference

119 files changed:
src/man/afs_ftpd.1 [new file with mode: 0644]
src/man/afs_inetd.1 [new file with mode: 0644]
src/man/afs_login.1 [new file with mode: 0644]
src/man/afs_rcp.1 [new file with mode: 0644]
src/man/afs_rlogind.1 [new file with mode: 0644]
src/man/afs_rsh.1 [new file with mode: 0644]
src/man/afsd.1 [new file with mode: 0644]
src/man/dkload.1 [new file with mode: 0644]
src/man/fileserver.1 [new file with mode: 0644]
src/man/fs.1 [new file with mode: 0644]
src/man/fs_apropos.1 [new file with mode: 0644]
src/man/fs_checkservers.1 [new file with mode: 0644]
src/man/fs_checkvolumes.1 [new file with mode: 0644]
src/man/fs_cleanacl.1 [new file with mode: 0644]
src/man/fs_copyacl.1 [new file with mode: 0644]
src/man/fs_debug.1 [new file with mode: 0644]
src/man/fs_diskfree.1 [new file with mode: 0644]
src/man/fs_examine.1 [new file with mode: 0644]
src/man/fs_exportafs.1 [new file with mode: 0644]
src/man/fs_flush.1 [new file with mode: 0644]
src/man/fs_flushvolume.1 [new file with mode: 0644]
src/man/fs_getcacheparms.1 [new file with mode: 0644]
src/man/fs_getcellstatus.1 [new file with mode: 0644]
src/man/fs_getserverprefs.1 [new file with mode: 0644]
src/man/fs_help.1 [new file with mode: 0644]
src/man/fs_listacl.1 [new file with mode: 0644]
src/man/fs_listcells.1 [new file with mode: 0644]
src/man/fs_listquota.1 [new file with mode: 0644]
src/man/fs_lsmount.1 [new file with mode: 0644]
src/man/fs_mkmount.1 [new file with mode: 0644]
src/man/fs_monitor.1 [new file with mode: 0644]
src/man/fs_newcell.1 [new file with mode: 0644]
src/man/fs_quota.1 [new file with mode: 0644]
src/man/fs_rmmount.1 [new file with mode: 0644]
src/man/fs_setacl.1 [new file with mode: 0644]
src/man/fs_setcachesize.1 [new file with mode: 0644]
src/man/fs_setcell.1 [new file with mode: 0644]
src/man/fs_setquota.1 [new file with mode: 0644]
src/man/fs_setserverprefs.1 [new file with mode: 0644]
src/man/fs_setvol.1 [new file with mode: 0644]
src/man/fs_sysname.1 [new file with mode: 0644]
src/man/fs_whereis.1 [new file with mode: 0644]
src/man/fs_whichcell.1 [new file with mode: 0644]
src/man/fs_wscell.1 [new file with mode: 0644]
src/man/kas.1 [new file with mode: 0644]
src/man/kas_apropos.1 [new file with mode: 0644]
src/man/kas_create.1 [new file with mode: 0644]
src/man/kas_debuginfo.1 [new file with mode: 0644]
src/man/kas_delete.1 [new file with mode: 0644]
src/man/kas_examine.1 [new file with mode: 0644]
src/man/kas_forgetticket.1 [new file with mode: 0644]
src/man/kas_getpassword.1 [new file with mode: 0644]
src/man/kas_getrandomkey.1 [new file with mode: 0644]
src/man/kas_getticket.1 [new file with mode: 0644]
src/man/kas_help.1 [new file with mode: 0644]
src/man/kas_interactive.1 [new file with mode: 0644]
src/man/kas_list.1 [new file with mode: 0644]
src/man/kas_listtickets.1 [new file with mode: 0644]
src/man/kas_noauthentication.1 [new file with mode: 0644]
src/man/kas_quit.1 [new file with mode: 0644]
src/man/kas_setfields.1 [new file with mode: 0644]
src/man/kas_setkey.1 [new file with mode: 0644]
src/man/kas_setpassword.1 [new file with mode: 0644]
src/man/kas_statistics.1 [new file with mode: 0644]
src/man/kas_stringtokey.1 [new file with mode: 0644]
src/man/klog.1 [new file with mode: 0644]
src/man/knfs.1 [new file with mode: 0644]
src/man/kpasswd.1 [new file with mode: 0644]
src/man/package.1 [new file with mode: 0644]
src/man/pagsh.1 [new file with mode: 0644]
src/man/runntp.1 [new file with mode: 0644]
src/man/salvager.1 [new file with mode: 0644]
src/man/scout.1 [new file with mode: 0644]
src/man/tokens.1 [new file with mode: 0644]
src/man/unlog.1 [new file with mode: 0644]
src/man/upclient.1 [new file with mode: 0644]
src/man/upserver.1 [new file with mode: 0644]
src/man/uss.1 [new file with mode: 0644]
src/man/uss_add.1 [new file with mode: 0644]
src/man/uss_apropos.1 [new file with mode: 0644]
src/man/uss_bulk.1 [new file with mode: 0644]
src/man/uss_d_line.1 [new file with mode: 0644]
src/man/uss_delete.1 [new file with mode: 0644]
src/man/uss_e_line.1 [new file with mode: 0644]
src/man/uss_f_line.1 [new file with mode: 0644]
src/man/uss_g_line.1 [new file with mode: 0644]
src/man/uss_help.1 [new file with mode: 0644]
src/man/uss_l_line.1 [new file with mode: 0644]
src/man/uss_s_line.1 [new file with mode: 0644]
src/man/uss_v_line.1 [new file with mode: 0644]
src/man/uss_x_line.1 [new file with mode: 0644]
src/man/vldb_convert.1 [new file with mode: 0644]
src/man/vos.1 [new file with mode: 0644]
src/man/vos_addsite.1 [new file with mode: 0644]
src/man/vos_apropos.1 [new file with mode: 0644]
src/man/vos_backup.1 [new file with mode: 0644]
src/man/vos_backupsys.1 [new file with mode: 0644]
src/man/vos_create.1 [new file with mode: 0644]
src/man/vos_delentry.1 [new file with mode: 0644]
src/man/vos_dump.1 [new file with mode: 0644]
src/man/vos_examine.1 [new file with mode: 0644]
src/man/vos_help.1 [new file with mode: 0644]
src/man/vos_listpart.1 [new file with mode: 0644]
src/man/vos_listvldb.1 [new file with mode: 0644]
src/man/vos_listvol.1 [new file with mode: 0644]
src/man/vos_lock.1 [new file with mode: 0644]
src/man/vos_move.1 [new file with mode: 0644]
src/man/vos_partinfo.1 [new file with mode: 0644]
src/man/vos_release.1 [new file with mode: 0644]
src/man/vos_remove.1 [new file with mode: 0644]
src/man/vos_remsite.1 [new file with mode: 0644]
src/man/vos_rename.1 [new file with mode: 0644]
src/man/vos_restore.1 [new file with mode: 0644]
src/man/vos_status.1 [new file with mode: 0644]
src/man/vos_syncserv.1 [new file with mode: 0644]
src/man/vos_syncvldb.1 [new file with mode: 0644]
src/man/vos_unlock.1 [new file with mode: 0644]
src/man/vos_unlockvldb.1 [new file with mode: 0644]
src/man/vos_zap.1 [new file with mode: 0644]

diff --git a/src/man/afs_ftpd.1 b/src/man/afs_ftpd.1
new file mode 100644 (file)
index 0000000..024d39a
--- /dev/null
@@ -0,0 +1,69 @@
+ftpd (AFS version)         AFS Commands      ftpd (AFS version)
+
+
+NAME
+
+   ftpd  (AFS  version) -- initialize  Internet  File Transfer
+
+                       Protocol server.
+
+
+   /usr/etc/ftpd  [-d]  [-l]  [-ttimeout]
+
+DESCRIPTION
+
+   Functions like the standard UNIX ftpd, except that  it  also
+   authenticates   the  issuer  of  the  ftp  command  (who  is
+   presumably  working  on   a   remote   machine)   with   the
+   Authentication  Server  in  the local cell (the home cell of
+   the machine where ftpd is running).  The  authentication  is
+   based  on  the  user  name  and password provided at the ftp
+   prompts on the remote machine.  The  Cache  Manager  on  the
+   machine   running  ftpd  stores  the  newly  created  token,
+   identifying it by PAG rather than by the user's UNIX UID.
+
+   The issuer of ftp may be working in a foreign cell, as  long
+   as the user name and password provided are valid in the cell
+   where ftpd is running.
+
+   If the user name under which ftp is issued does not exist in
+   the  Authentication  Database  for  the  cell  where ftpd is
+   running, or the issuer provides  the  wrong  password,  then
+   ftpd  logs the user into the UNIX file system of the machine
+   where ftpd is running.  The  success  of  this  local  login
+   depends  on  the  user  name appearing in the local password
+   file and on the user providing the correct  local  password.
+   In  the case of a local login, AFS server processes consider
+   the issuer of ftp to be anonymous.
+
+   In the configuration recommended  by  Transarc  Corporation,
+   the  AFS  version  of  ftpd  is substituted for the standard
+   version (only one of the versions can run at  a  time).  The
+   administrator then has two choices:
+
+      - name the binary for the AFS version something like
+        ftpd.afs, leaving the standard  version  as  ftpd.
+        Change   inetd.conf  to  refer  to  ftpd.afs;  the
+        standard version is not referenced.
+
+      - name the binary  for  the  AFS  version  ftpd  and
+        rename  the  binary  for  the  standard version to
+        something like ftpd.old.  No change to  inetd.conf
+        is  necessary,  but  it is not as obvious that the
+        standard version of ftpd is no longer in use.
+
+ARGUMENTS
+
+   See the UNIX manual page for ftpd.
+
+
+
+PRIVILEGE REQUIRED
+
+   See the UNIX manual page for ftpd.
+
+MORE INFORMATION
+
+   UNIX manual page for ftp
+
+   UNIX manual page for ftpd
diff --git a/src/man/afs_inetd.1 b/src/man/afs_inetd.1
new file mode 100644 (file)
index 0000000..503cc5e
--- /dev/null
@@ -0,0 +1,163 @@
+inetd (AFS version)        AFS Commands     inetd (AFS version)
+
+
+NAME
+
+   inetd (AFS version) -- initialize Internet service daemon.
+
+
+   /etc/inetd  [-d]  [<configfile>]
+
+DESCRIPTION
+
+   Functions  like  the  standard  UNIX  inetd  in  invoking an
+   Internet service daemon (itself called "inetd") that handles
+   remotely-issued  commands.    The AFS inetd enables users of
+   the remote services it supports to access those services  as
+   authenticated   AFS   users,  provided  that  the  supported
+   services are also AFS versions capable of passing AFS tokens
+   (authentication   information).      Examples  of  supported
+   services are rcp and rsh.
+
+   AFS inetd can service the  standard  UNIX  versions  of  the
+   remote  services,  but  it  is  instead recommended that the
+   standard UNIX version of inetd be run in parallel  with  the
+   AFS  version.  Name the AFS version something like inetd.afs
+   and use it to service requests from  AFS-modified  programs;
+   use  standard  inetd  to service requests from standard UNIX
+   programs.  This  separation  requires  using  two  different
+   inetd.conf      files,      as      described     in     the
+   REQUIREMENTS/RESTRICTIONS section.
+
+REQUIREMENTS/RESTRICTIONS
+
+   Several  configuration  changes  are  necessary  for   token
+   passing  to  work  correctly  with the AFS version of inetd.
+   There may be other UNIX-based requirements/restrictions  not
+   mentioned   here;  consult  the  UNIX  manual  page.    (One
+   important restriction is that there can be no blank lines in
+   the configuration file other than at the end.)
+
+   The  requirements/restrictions  include the following.  They
+   assume that inetd.afs is running in parallel  with  standard
+   inetd.
+
+      - For  token  passing to work, the request must come
+        from the AFS version of the remote  service  (such
+        as  AFS rcp or AFS rsh).  If the remote service is
+        the  standard  UNIX  version,  it  will  not  pass
+        tokens.    The  issuer  of  the  remote command is
+        authenticated only in the local UNIX file  system,
+        not  with  AFS, so the AFS server processes in the
+        local cell consider the issuer to be anonymous.
+
+      - The machine's reboot configuration  file  (/etc/rc
+        or equivalent) should be altered so that it starts
+        both standard inetd and inetd.afs.
+
+      - An AFS-specific inetd.conf  file,  perhaps  called
+        inetd.conf.afs,   should   exist   alongside   the
+        standard  one.    When   initializing   inetd.afs,
+        specify  this  configuration  file rather than the
+        standard one.
+
+        Each line in the inetd.conf.afs file must  include
+
+
+
+        an  additional  field,  fifth  from  the  left, to
+        specify the identity under which the program is to
+        run.   The normal choice is "root."  The following
+        sample shows the only lines that should appear  in
+        this file:
+
+            ta-rauth stream tcp nowait root internal
+            shell    stream tcp nowait root /usr/etc/r
+            login    stream tcp nowait root /usr/etc/r
+
+        Substitute   appropriate  values  for  the  binary
+        locations and names on the shell and login  lines.
+        Include  the login line only if the AFS version of
+        login is also in use in the cell; otherwise, refer
+        to  login  in the standard inetd.conf instead.  In
+        addition, if the inetd.cond.afs file is used on  a
+        machine  with  a  Sun  system type, change rshd to
+        in.rshd and change rlogind.afs  to  in.rlogind.afs
+        on the shell and login lines, respectively.
+
+      - The   standard  inetd.conf  (referred  to  by  the
+        standard inetd) should be altered: comment out the
+        shell  line and, if the AFS version of login is in
+        use in the cell, the login line.    References  to
+        these  programs  appear in inetd.conf.afs instead.
+        Retain the login line if AFS login  is  not  being
+        used.    Alter  the  ftp  line to refer to the AFS
+        version of ftpd, if it  was  substituted  for  the
+        standard  version.   Do not insert the extra fifth
+        column into standard inetd.conf  if  it  does  not
+        already  appear  there.    See the EXAMPLE section
+        below for an illustration.
+
+      - The  following  two  lines  must  appear  in   the
+        /etc/services  file  on  the machine running inetd
+        (as well as on the machine running modified rcp or
+        rsh).    On  NeXT  machines, this information must
+        appear in the  NetInfo  database  rather  than  in
+        /etc/services.
+
+           auth 113/tcp authentication
+           ta-rauth 601/tcp rauth
+
+ARGUMENTS
+
+   See the UNIX manual page for inetd.
+
+EXAMPLE
+
+   The  following  are  sample  inetd.conf.afs  and  inetd.conf
+   files, appropriate for use  when  inetd.afs  is  running  in
+   parallel  with standard inetd and AFS login is being used in
+   the  cell.    Changes   to   standard   inetd.conf   include
+   referencing   the   AFS  version  of  the  ftpd  binary  and
+   commenting out shell and login.  The example inetd.conf does
+   not  include  the  extra  fifth  column.    Do not use these
+   examples without modifying them appropriately for the  local
+   machine type or cell.
+
+
+
+       # AFS version of Internet server configuration datab
+       #(EXAMPLE ONLY)
+       #
+       ta-rauth stream tcp nowait root internal
+       shell    stream tcp nowait root /usr/etc/rshd
+       login    stream tcp nowait root /usr/etc/rlogind.afs
+
+
+
+       # Standard version of Internet server configuration
+       #(EXAMPLE ONLY)
+       #
+       ftp     stream  tcp     nowait  /etc/ftpd.afs   ftpd
+       telnet  stream  tcp     nowait  /etc/telnetd    teln
+       #shell  stream  tcp     nowait  /etc/rshd       rshd
+       #login  stream  tcp     nowait  /etc/rlogind    rlog
+       finger  stream  tcp     nowait  /usr/etc/fingd  fing
+       uucp    stream  tcp     nowait  /etc/uucpd      uucp
+       exec    stream  tcp     nowait  /etc/rexecd     rexe
+       comsat  dgram   udp     wait    /etc/comsat     coms
+       talk    dgram   udp     wait    /etc/talkd      talk
+       ntalk   dgram   udp     wait    /usr/etc/ntalkd talk
+       time    dgram   udp     wait    /etc/miscd      time
+
+PRIVILEGE REQUIRED
+
+   See the UNIX manual page for inetd.
+
+MORE INFORMATION
+
+   rcp (AFS version)
+
+   rsh (AFS version)
+
+   UNIX manual page for inetd
diff --git a/src/man/afs_login.1 b/src/man/afs_login.1
new file mode 100644 (file)
index 0000000..8a7bf1f
--- /dev/null
@@ -0,0 +1,204 @@
+login (AFS version)        AFS Commands     login (AFS version)
+
+
+NAME
+
+   login (AFS version) -- login to AFS and UNIX file systems.
+
+
+   login [<user name>]
+
+   Authenticates  the issuer with the AFS Authentication Server
+   in the local cell  and  logs  him  or  her  into  the  local
+   machine's UNIX file system.  More precisely, AFS login:
+
+      - creates a new "process authentication group" (PAG)
+        associated with the issuer and the  command  shell
+        where  the  command  is issued.  A PAG is a number
+        guaranteed to identify the issuer uniquely to  the
+        local  Cache  Manager.  The Cache Manager uses the
+        PAG, instead of the issuer's UNIX UID, to identify
+        him  or  her  in  the credential structure that it
+        creates to track each user.
+
+      - authenticates the user with the AFS Authentication
+        Server and obtains a "token"; the other AFS server
+        processes in the cell accept the token as  partial
+        proof that the user is a legitimate AFS user.  The
+        Cache Manager stores the token in  the  credential
+        structure  along  with the PAG, and presents it to
+        AFS server processes as necessary.
+
+      - logs the user into the local UNIX file system
+
+   The lifetime of the token resulting from this command is the
+   smallest of the following:
+
+      - the  "maximum  ticket  lifetime"  recorded  in the
+        "afs" entry in the Authentication Database.    The
+        default  is 100 hours.  Administrators can inspect
+        this value using kas examine, and change it  using
+        kas setfields.
+
+      - the  "maximum  ticket  lifetime"  recorded  in the
+        issuer's  Authentication  Database  entry.     The
+        default  is  25  hours for user entries created by
+        the AFS 3.1 or later version of the Authentication
+        Server,  and 100 hours for user entries created by
+        the AFS 3.0 version of the Authentication  Server.
+        Administrators  and  the  user himself/herself can
+        inspect  this   value   using   kas examine,   and
+        administrators can change it using kas setfields.
+
+      - the  "maximum  ticket  lifetime"  recorded  in the
+        "krbtgt.CELLNAME"  entry  in  the   Authentication
+        Database;  this  entry  corresponds to the ticket-
+        granting ticket used internally in generating  the
+        token.  The default is 720 hours (30 days).
+
+   If  none  of  these  defaults  have  been  changed, then the
+   standard  token  lifetime  is  25  hours  for  users   whose
+   Authentication  Database entries were created by the AFS 3.1
+   or later version of the Authentication Server, and 100 hours
+   for users whose Authentication Database entries were created
+   by the AFS 3.0 version of the Authentication  Server.    The
+
+
+
+   user  can  issue  klog  to  request a token with a different
+   lifetime.
+
+   Using a PAG instead of the UNIX UID to distinguish users has
+   two advantages.
+
+      - It  means  that  processes  spawned  by  the  user
+        inherit the PAG and so share the token; thus  they
+        gain  access  to  AFS  as  the authenticated user.
+        This is important in many environments where,  for
+        example,  printer  and  other  daemons  run  under
+        identities (such as "root") that  the  AFS  server
+        processes  recognize  only  as  anonymous.  Unless
+        PAGs  are  used,  such   daemons   cannot   access
+        information   in   directories  protected  against
+        system:anyuser.
+
+      - It closes  a  potential  security  loophole:  UNIX
+        allows  anyone  already  logged  in as "root" on a
+        machine to assume any other  identity  by  issuing
+        su.    If the credential structure were identified
+        by a UNIX UID rather than a PAG, then assuming the
+        same  UID  would mean being able to use the token,
+        too.  Use of a PAG  as  an  identifier  eliminates
+        that possibility.
+
+   The  process  of  authenticating with the AFS Authentication
+   Server is as follows:
+
+      1. The login program checks the user's entry in  the
+         local /etc/passwd file.
+
+         If  no  entry  exists,  or  if  an asterisk ( * )
+         appears in the password field, the login  attempt
+         fails.
+
+         If the entry exists, the attempt proceeds to step
+         LOGIN.PAG.
+
+      2. The  login  program  invokes  the  command   that
+         creates a PAG.
+
+      3. The  login program converts the password provided
+         by the user into an encryption key and encrypts a
+         packet of data with the key.  It sends the packet
+         to   an   AFS   Authentication   Server.      The
+         Authentication  Server  decrypts  the packet and,
+         depending  on  the  success  of  the  decryption,
+         judges  the  password to be correct or incorrect.
+         (Consult the AFS System Administrator's Guide for
+         more  information  on the "mutual authentication"
+         procedure used to verify  the  password  in  this
+         step.)
+
+         If  the Authentication Server judges the password
+         incorrect, the  user  does  not  receive  an  AFS
+         token.  The attempt proceeds to step LOGIN.LOCAL.
+         If the Authentication Server judges the  password
+         correct,  it  issues a token to the user as proof
+         of AFS authentication.  The  login  program  also
+         logs  the  user  into the local UNIX file system.
+
+
+
+         Step LOGIN.LOCAL is skipped.
+
+      4. If no AFS token was granted in step 3, the  login
+         programattempts  to  log  the user into the local
+         UNIX  file  system,  by  comparing  the  password
+         provided to the local password file (/etc/passwd,
+         for instance).
+
+         If the provided password  is  incorrect,  or  the
+         password   field   in  the  local  password  file
+         contains  anything  other  than  a   13-character
+         UNIX-encrypted  password  string,  then the login
+         attempt fails.
+
+         If the password is correct, the  user  is  logged
+         into  the  local  UNIX  file  system  only.  (The
+         success of this attempt and the  failure  of  the
+         AFS authentication implies that the AFS and local
+         passwords  are  different  and  that  the  issuer
+         provided the latter.)
+
+WARNINGS
+
+   Each  PAG  uses two of the memory slots that the kernel uses
+   to record the UNIX groups associated with a user.   If  none
+   of  these  slots are available, the PAG creation fails.  The
+   use of two group slots per PAG does not  present  a  problem
+   with  most  operating  systems, which make at least 16 slots
+   available.
+
+   The AFS version of  login  is  based  on  the  Berkeley  4.3
+   Distribution  and  does  not  include  the modified features
+   included in some proprietary versions of login.
+
+   The AFS version of login works only on  machines  that  have
+   run afsd.
+
+ARGUMENTS
+
+   See  the  UNIX  manual page for login.  The AFS version does
+   not impose any  stronger  restrictions  on  acceptable  user
+   names than does the UNIX file system.
+
+OUTPUT
+
+   To distinguish the AFS version of login from other versions,
+   one  of  the  following  banners  appears  on  standard  out
+   (stdout) when the command executes successfully.
+
+      AFS 3.0 Login
+
+   or
+
+      AFS 3.2 (R) Login
+
+   Various  error  messages  appear if the login attempt is not
+   successful.  The "login:" prompt normally returns  following
+   the  error  messages, giving the user another chance to type
+   the password correctly.
+
+PRIVILEGE REQUIRED
+
+
+
+   None.
+
+
+
+MORE INFORMATION
+
+   rlogind (AFS version)
+
+   UNIX manual page for login
diff --git a/src/man/afs_rcp.1 b/src/man/afs_rcp.1
new file mode 100644 (file)
index 0000000..947f6d7
--- /dev/null
@@ -0,0 +1,134 @@
+rcp (AFS version)          AFS Commands       rcp (AFS version)
+
+
+NAME
+
+   rcp (AFS version) -- copy file on remote machine.
+
+
+                                                 +
+   rcp [-p] <file1> <file2>  rcp [-r] [-p] <file>  <directory>
+
+DESCRIPTION
+
+   Functions  like  the standard UNIX rcp, except it allows the
+   issuer to use the remote machine's Cache Manager  to  access
+   AFS  files as an authenticated AFS user.  The command passes
+   a copy of the AFS token which the  issuer  obtained  on  the
+   local  machine  to  the remote machine's Cache Manager.  The
+   remote Cache Manager can use the token to gain authenticated
+   access to AFS.
+
+   Token  passing  is most effective if both the remote machine
+   and local machine belong to the same cell, because  rcp  can
+   pass  only  one token even if the user has several tokensMit
+   passes the token that is marked [1] in the output  from  the
+   tokens  command.  If the remote and local machine are not in
+   the same cell, the possibilities are:
+
+      - the token passed is for  the  cell  to  which  the
+        remote  machine  belongs.  The issuer accesses the
+        remote cell's AFS file tree  as  an  authenticated
+        AFS user, but is considered anonymous in the local
+        cell.    This  means  that  the  issuer  can  only
+        exercise    the    access    rights   granted   to
+        system:anyuser in the local AFS file  tree.    For
+        instance,  a file being copied into the local cell
+        can only be copied into a UNIX directory or an AFS
+        directory  where  system:anyuser  has  the  INSERT
+        right.
+
+      - the token passed is for  the  cell  to  which  the
+        local  machine  belongs.   The issuer accesses the
+        remote cell's AFS file tree as anonymous,  and  so
+        can  only  exercise  the  access rights granted to
+        system:anyuser.
+
+   In addition to running the AFS version of the rcp binary  on
+   the   machine   where  the  rcp  command  is  issued,  other
+   configuration changes are necessary  for  token  passing  to
+   work  properly.    See the REQUIREMENTS/RESTRICTIONS section
+   for a list.
+
+   The AFS version of  rcp  is  compatible  with  the  standard
+   inetd,  but  token passing works only if the AFS versions of
+   both programs are being used.    If  only  one  of  them  is
+   modified,  the  issuer  will  access  AFS  files through the
+   remote machine as anonymous.
+
+WARNINGS
+
+   AFS rcp does  not  allow  "third  party  copies",  in  which
+   neither  source  nor  target file is on the current machine.
+   Standard UNIX rcp claims to provide this functionality.
+
+   The protections required on the .rhosts file  in  order  for
+
+
+
+   token   passing   to   work   with  this  command  (see  the
+   REQUIREMENTS/RESTRICTIONS section) are the opposite of those
+   necessary for token creation to work with the AFS version of
+   rlogind.
+
+   For security's sake, use the AFS  version  of  rcp  only  in
+   conjunction  with  PAGs,  either by using the AFS version of
+   login or always issuing pagsh before obtaining tokens.
+
+REQUIREMENTS/RESTRICTIONS
+
+   Several  configuration  requirements  and  restrictions  are
+   necessary  for  token passing to work correctly with the AFS
+   version of rcp.  Some of these are also necessary  with  the
+   standard  UNIX  version,  but  are included here because the
+   issuer accustomed to AFS protections may not consider  them.
+   There  may be other UNIX-based requirements/restrictions not
+   mentioned  here;  consult  the  UNIX  manual  page.     (One
+   important  one  is  that  no stty commands may appear in the
+   issuer's shell initialization file, such as .cshrc.)
+
+   The requirements/restrictions for token passing include  the
+   following.
+
+      - The  local machine must be running the AFS version
+        of rcp, with the rcp binary file locally installed
+        to grant setuid privilege to the owner, "root".
+
+      - The remote machine must be running the AFS version
+        of inetd.
+
+      - The  following  two  lines  must  appear  in   the
+        /etc/services  file  on the local machine (as well
+        as on the remote machine running modified  inetd).
+        On  NeXT machines, this information must appear in
+        the NetInfo database rather than in /etc/services.
+
+           auth 113/tcp authentication
+           ta-rauth 601/tcp rauth
+
+      - If rcp is to consult an .rhosts file on the remote
+        machine,  the  file  must have UNIX protections no
+        more liberal than -rw-r--r--.  If .rhosts  resides
+        in   a  user  home  directory  in  AFS,  the  home
+        directory must also  grant  the  LOOKUP  and  READ
+        rights to system:anyuser.
+
+ARGUMENTS
+
+   Consult the UNIX manual page for rcp.
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   inetd (AFS version)
+
+   UNIX manual page for rcp
+
+   rlogind (AFS version)
+
+
+
+   tokens
diff --git a/src/man/afs_rlogind.1 b/src/man/afs_rlogind.1
new file mode 100644 (file)
index 0000000..f18b950
--- /dev/null
@@ -0,0 +1,91 @@
+rlogind (AFS version)      AFS Commands   rlogind (AFS version)
+
+
+NAME
+
+   rlogind (AFS version) -- initialize remote login server.
+
+
+   /etc/rlogind
+
+DESCRIPTION
+
+   Functions  like the standard UNIX rlogind, except that it is
+   appropriate only for cells using  the  AFS  version  of  the
+   login program supplied by Transarc Corporation.
+
+   The  AFS  modifications to rlogind are strictly internal and
+   are necessary so that remote AFS authentication is  possible
+   with the rlogin command.  When a user issues rlogin, the AFS
+   version of rlogind running on the remote machine invokes the
+   AFS  version of login; the user therefore obtains AFS tokens
+   on the remote machine.
+
+   In the configuration recommended  by  Transarc  Corporation,
+   the  AFS  version of rlogind is substituted for the standard
+   versionMbut only if the AFS version of login is  also  being
+   used  in the cell. (Only one version of rlogind can run on a
+   machine at a time.)  The administrator then has two choices:
+
+      - name the binary for the AFS version something like
+        rlogind.afs,   leaving  the  standard  version  as
+        rlogind.  Refer to rlogind.afs  in  inetd.conf.afs
+        (the  AFS  version of inetd.conf), and comment out
+        the reference  to  standard  rlogind  in  standard
+        inetd.conf.
+
+      - name  the  binary  for the AFS version rlogind and
+        rename the binary  for  the  standard  version  to
+        something  like  rlogind.old.  Refer to rlogind in
+        inetd.conf.afs (the AFS  version  of  inetd.conf),
+        and  comment  out  the  reference  to  rlogind  in
+        standard inetd.conf.
+
+WARNINGS
+
+   The AFS version of rlogind is  not  available  for  the  AIX
+   2.2.1  operating  system.  (AIX  2.2.1  does not include the
+   standard rlogind either.)
+
+   Do not install the AFS version of rlogind if the AFS version
+   of login is not being used in the cell.
+
+   Remote AFS authentication is possible with rlogin only if
+
+   EITHER no .rhosts file exists on the machine where rlogind
+   is running
+
+   OR .rhosts exists on the machine where rlogind is running, b
+   has mode bits more liberal than -rw-r--r--.  If .rhosts has
+   mode bits as restrictive as -rw-r--r--, then rlogind logs th
+   issuer of the remote rlogin command into the local UNIX file
+   system without prompting for a password.  The issuer does no
+   tokens (authenticate with AFS), because that requires provid
+   password.  The user can, however, obtain tokens by issuing p
+
+
+
+   and klog after establishing the connection.
+
+   The  protection  required  on  .rhosts for token creation to
+   work properly are exactly opposite those necessary  for  the
+   AFS  versions of rcp and rsh to handle tokens properly.  The
+   recommended solution is to configure .rhosts so that rcp and
+   rsh work properly and to use telnet instead of rlogin.
+
+   No  modifications  to  rlogin  itself  are necessary for AFS
+   authentication to work.
+
+PRIVILEGE REQUIRED
+
+   See the UNIX manual page for rlogind.
+
+MORE INFORMATION
+
+   login (AFS version)
+
+   rcp (AFS version)
+
+   UNIX manual page for rlogind
+
+   rsh (AFS version)
diff --git a/src/man/afs_rsh.1 b/src/man/afs_rsh.1
new file mode 100644 (file)
index 0000000..98ccaf9
--- /dev/null
@@ -0,0 +1,109 @@
+rsh (AFS version)          AFS Commands       rsh (AFS version)
+
+
+NAME
+
+   rsh (AFS version) -- open shell on remote machine.
+
+
+   rsh host [-l <username>] [-n] <command>  host [-l
+   <username>] [-n] <command>
+
+DESCRIPTION
+
+   Functions  like the standard UNIX rsh, except that it allows
+   the issuer to execute commands on the remote machine  as  an
+   authenticated  AFS  user.   The command passes a copy of the
+   AFS token that the issuer has obtained on the local  machine
+   to  the  remote  machine's  Cache Manager.  The remote Cache
+   Manager can use the token to have the issuer  recognized  as
+   an authenticated AFS user.
+
+   Token  passing  is most effective if both the remote machine
+   and local machine belong to the same cell, because  rsh  can
+   pass  only  one token even if the user has severalMit passes
+   the token that is marked [1] in the output from  the  tokens
+   command.    If  the  remote and local machine are not in the
+   same cell, the token should be for the  cell  to  which  the
+   remote  machine  belongs,  so  that the remote cell's server
+   processes will recognize the issuer as authenticated.
+
+   In addition to running the AFS version of the rsh binary  on
+   the   machine   where  the  rsh  command  is  issued,  other
+   configuration changes are necessary  for  token  passing  to
+   work  properly.    See the REQUIREMENTS/RESTRICTIONS section
+   for a list.
+
+   The AFS version of  rsh  is  compatible  with  the  standard
+   inetd,  but  token passing only works if the AFS versions of
+   both programs are being used.    If  only  one  of  them  is
+   modified,  the  issuer  will  access  AFS  files through the
+   remote machine as anonymous.
+
+WARNINGS
+
+   The protections required  on  the  .rhosts  file  for  token
+   passing  to  work  correctly  with  this  command  (see  the
+   REQUIREMENTS/RESTRICTIONS section) are the opposite of those
+   necessary  for token creation to work correctly with the AFS
+   version of rlogind.
+
+   For security's sake, use the AFS  version  of  rsh  only  in
+   conjunction  with  PAGs,  either by using the AFS version of
+   login or always issuing pagsh before obtaining tokens.
+
+REQUIREMENTS/RESTRICTIONS
+
+   Several  configuration  requirements  and  restrictions  are
+   necessary  for  token passing to work correctly with the AFS
+   version of rsh.  Some of these are also necessary  with  the
+   standard  UNIX  version,  but  are included here because the
+   issuer used to AFS protections may not be inclined to  think
+   of    them.        There    may    be    other    UNIX-based
+   requirements/restrictions not mentioned  here;  consult  the
+   UNIX  manual  page.    (One  important  one  is that no stty
+
+
+
+   commands may appear in  the  issuer's  shell  initialization
+   file, such as .cshrc.)
+
+   The  requirements/restrictions for token passing include the
+   following.
+
+      - The local machine must be running the AFS  version
+        of  rsh, with the binary file locally installed to
+        grant setuid privilege to the owner, "root".
+
+      - The remote machine must be running the AFS version
+        of inetd.
+
+      - The   following  two  lines  must  appear  in  the
+        /etc/services file on the local machine  (as  well
+        as  on the remote machine running modified inetd).
+        On NeXT machines, this information must appear  in
+        the NetInfo database rather than in /etc/services.
+
+           auth 113/tcp authentication
+           ta-rauth 601/tcp rauth
+
+      - If rsh is to consult an .rhosts file on the remote
+        machine, the file must have  UNIX  protections  no
+        more  liberal than -rw-r--r--.  If .rhosts resides
+        in  a  user  home  directory  in  AFS,  the   home
+        directory  must  also  grant  the  LOOKUP and READ
+        rights to system:anyuser.
+
+ARGUMENTS
+
+   Consult the UNIX manual page for rsh.
+
+MORE INFORMATION
+
+   inetd (AFS version)
+
+   UNIX manual page for rsh
+
+   rlogind (AFS version)
+
+   tokens
diff --git a/src/man/afsd.1 b/src/man/afsd.1
new file mode 100644 (file)
index 0000000..e9d44c8
--- /dev/null
@@ -0,0 +1,462 @@
+afsd                       AFS Commands                   afsd
+
+
+NAME
+
+   afsd  -- initialize   Cache   Manager   and  start  related
+
+                       daemons.
+
+
+   afsd  [-blocks <number of cache blocks>] [-files <number of
+   cache files>]
+   [-stat <number of status cache entries>] [-rootvol <root
+   volume>]
+   [-cachedir <cache directory>]  [-mountdir <AFS mount
+   directory>]
+   [-verbose]  [-debug]  [-nosettime]
+   [-daemons <number of background daemons>]  [-rmtsys]
+   [-memcache]  [-dcache <# entries>]  [-chunksize <chunk
+   exponent>]
+
+ACCEPTABLE ABBREVIATIONS
+
+   This command does not use the syntax conventions of the  AFS
+   command  suites.    Therefore,  "afsd"  and all switches and
+   flags must be typed in full.
+
+DESCRIPTION
+
+   Initializes the Cache Manager on an AFS  client  machine  by
+   transferring   AFS-related  configuration  information  into
+   kernel  memory  and  starting   several   daemons.      More
+   specifically, afsd
+
+      - sets  a  field in kernel memory that defines which
+        cell  the  machine  belongs  to.      Some   Cache
+        Manager-internal   operations   and  system  calls
+        consult this field to learn which cell to  execute
+        in.    (The  AFS  command  interpreters  refer  to
+        /usr/vice/etc/ThisCell instead.)
+
+        This information is transferred  into  the  kernel
+        from the file /usr/vice/etc/ThisCell and cannot be
+        changed until afsd runs again.
+
+      - places in kernel memory  the  names  and  Internet
+        addresses  of  the database server machines in the
+        local cell and (optionally) foreign  cells.    The
+        appearance of a cell's database server machines in
+        this list enables the  Cache  Manager  to  contact
+        them and so to access files in the cell.  Omission
+        of a cell from this list, or incorrect information
+        about  its  database server machines, prevents the
+        Cache Manager from accessing files in it.
+
+        This information is transferred  into  the  kernel
+        from  the  file  /usr/vice/etc/CellServDB.   After
+        initialization, use the  fs   newcell  command  to
+        change  the kernel-resident list without having to
+        reboot.
+
+      - determines whether the cache  is  on  disk  or  in
+        machine  memory.    The  default  is to use a disk
+        cache.  If the  -memcache  argument  is  provided,
+
+
+
+        space  is allocated in machine memory for caching,
+        and disk space is not used even if the machine has
+        a disk.
+
+      - defines  the  name  of  the  local  disk directory
+        devoted to caching, when -memcache  is  not  used.
+        If  necessary, afsd creates the directory (as long
+        as its parent directory  exists).    It  does  not
+        remove  from  the disk the directory that formerly
+        served this function, if any.
+
+        The     second     field     in      the      file
+        /usr/vice/etc/cacheinfo  is  the  source  for this
+        name, and the standard value  is  /usr/vice/cache.
+        Use  the  -cachedir argument to override the value
+        from cacheinfo.
+
+      - sets the size of the  cache,  for  both  disk  and
+        memory caches.
+
+        The  afsd  program consults the third field in the
+        file /usr/vice/etc/cacheinfo to learn the  default
+        cache  size  in kilobyte blocks.  The value should
+        not exceed 90% to 95% of the disk space  available
+        on  the  cache partition (with a disk cache) or of
+        the machine's memory (with a memory cache).   This
+        is   because   the   cache  implementation  itself
+        requires a small amount of disk or machine memory.
+
+        For either a disk or memory cache, use the -blocks
+        argument to override the value from cacheinfo.
+
+        For  a  memory cache, the issuer can also override
+        the cacheinfo value by providing either
+
+           * both -dcache  and  -chunksize,  to  set  both
+             number  of dcache entries and chunk size (see
+             below for definition  of  these  parameters).
+             In   this   case,  afsd  derives  cache  size
+             (overriding   the   cacheinfo    value)    by
+             multiplying  the  two  values.    Using  this
+             combination  is  not   recommended,   as   it
+             requires    the   issuer   to   perform   the
+             calculation  beforehand  to   determine   the
+             resulting cache size.
+
+           * -dcache by itself. In this case, afsd derives
+             cache size (overriding the  cacheinfo  value)
+             by  multiplying  -dcache by the default chunk
+             size of 8 kilobytes.  Using this argument  is
+             not recommended, as it requires the issuer to
+             perform   the   calculation   beforehand   to
+             determine the resulting cache size.
+
+        For  a  disk cache, the value defined in cacheinfo
+        or with -blocks is  an  absolute  upper  limit  on
+        cache  size;  values  provided for other arguments
+        cannot result in a larger cache.
+
+        After  initialization,  use   fs setcachesize   to
+        change  the size of a disk cache without having to
+
+
+
+        reboot;  the  value  set  with  that  command   is
+        overridden   the   next   time  afsd  runs.    The
+        fs setcachesize command does not work  for  memory
+        caches.  Instead, the machine must be rebooted.
+
+      - sets  the  size  of  each  "chunk"  of data in the
+        cache, and by implication the amount of data  that
+        the Cache Manager requests at a time from the File
+        Server (how much data per "fetch" RPC,  since  AFS
+        uses partial file transfer).
+
+        For a disk cache, each chunk is called a "V file",
+        so this parameter sets the maximum size of each  V
+        file;  the default is 64 kilobytes.  See below for
+        more on V files.
+
+        For a memory cache, each chunk is a collection  of
+        memory blocks allocated together, so this sets the
+        size  of  each  collection;  the  default   is   8
+        kilobytes.
+
+        For  both  types  of  cache,  use  the  -chunksize
+        argument to change the default  chunk  size.    To
+        guarantee proper chunk sizes, the integer provided
+        is used as an exponent on the number  2;  see  the
+        ARGUMENTS  section  for  details.    For  a memory
+        cache, if total cache size divided by  chunk  size
+        leaves a remainder, afsd rounds down the number of
+        dcache entries. resulting in  a  slightly  smaller
+        cache (see below for more on dcache entries).
+
+      - sets  the number of empty "V files" created in the
+        cache directory for a disk cache.  Each file is  a
+        cache  chunk, and the Cache Manager caches data in
+        them as needed.  By default,  each  "V"  file  can
+        accommodate  up  to 64 kilobytes of data, since 64
+        kilobytes is the default  size  of  a  disk  cache
+        chunk.
+
+        A  memory cache cannot use V files because it does
+        not use disk memory; instead the number of  chunks
+        is  equivalent  to  the number of "dcache entries"
+        (see below).
+
+        The default number of V files  is  1000;  use  the
+        -files  argument to override it.  Since by default
+        each V file can accommodate 64 kilobytes, the only
+        reason  to increase from the default of 1000 is if
+        the cache size is greater than about 64  megabytes
+        (or  the  chunk  size  has  been  changed with the
+        -chunksize argument discussed above).
+
+      - sets the number of "dcache entries"  allocated  in
+        machine  memory  for storing information about the
+        chunks in the cache.
+
+        With     a     disk      cache,      the      file
+        /usr/vice/cache/CacheItems  on  disk  contains one
+        entry for each V file.   Some  of  the  CacheItems
+        entries,  by default 100, are duplicated as dcache
+        entries in machine memory for quicker access.
+
+
+
+        With a memory cache, there is no CacheItems  file,
+        so  all  information about cache chunks must be in
+        memory as dcache  entries.    There  must  be  one
+        dcache entry for each cache chunk, so for a memory
+        cache number of dcache entries  equals  number  of
+        cache  chunks.    There  is  no  default number of
+        dcache entries for a memory cache;  instead,  afsd
+        derives it by dividing cache size by chunk size.
+
+        Use  the  -dcache  argument  to  set the number of
+        dcache entries.    This  is  not  recommended  for
+        either  type  of  cache.  Increasing the number of
+        dcache  entries  for  a  disk  cache  may  improve
+        performance  marginally  because  more entries are
+        retrieved from memory rather than from  disk,  but
+        is  not  generally necessary.  Using this argument
+        is not recommended for a memory cache  because  it
+        requires the issuer to pre-calculate cache size by
+        multiplying this value times  chunk  size  (either
+        the   default   8   kilobytes   or  the  value  of
+        -chunksize).
+
+      - sets the number of  "stat"  entries  available  in
+        machine  memory  for  caching  status  information
+        about cached AFS files.
+
+        The default is 300;  use  the  -stat  argument  to
+        override the default.
+
+      - defines  the  directory in the machine's file name
+        space at which the AFS file tree is mounted.
+
+        The     first     field      in      the      file
+        /usr/vice/etc/cacheinfo  is  the  source  for  the
+        default directory name.   The  standard  value  is
+        /afs.   Use the -mountdir argument to override the
+        value from cacheinfo.
+
+      - defines which volume corresponds to  the  root  of
+        the AFS file tree.
+
+        The default is root.afs; use the -rootvol argument
+        to override it.  Note  that  although  the  volume
+        name  should  be  given  in the "base" (ReadWrite)
+        form, the  Cache  Manager  retains  its  bias  for
+        accessing  the  ReadOnly  version of the volumeMin
+        the  default  case,  root.afs.readonlyMif  it   is
+        available.
+
+      - randomly  selects  a  file  server  machine in the
+        local cell as the source for the  "correct"  time.
+        Every  five minutes thereafter, the local clock is
+        adjusted (if necessary) to match the  file  server
+        machine's clock.
+
+        Use  the  -nosettime  flag  to  prevent  afsd from
+        selecting a time standard.   This  is  recommended
+        only  on file server machines that are also acting
+        as clients.  File  server  machines  maintain  the
+        correct  time  using  the  Network  Time  Protocol
+        Daemon instead.
+
+
+
+   In addition to setting cache configuration parameters,  afsd
+   starts  up  the  following  three types of daemons.  On most
+   system types, these daemons appear as  nameless  entries  in
+   the output of the ps command:
+
+      - a  "callback"  daemon  that handles callbacks.  It
+        also  responds  to  the  File  Server's   periodic
+        probes,  which  check  that  the client machine is
+        still alive.
+
+      - a  "maintenance"  daemon  that  performs   routine
+        periodic maintenance tasks, including
+
+           * performing garbage collection
+
+           * synchronizing files
+
+           * probing the fileserver process on file server
+             machines every few minutes
+
+           * refreshing information from ReadOnly  volumes
+             once per hour
+
+           * doing  delayed  writes for NFS clients if the
+             machine is running the NFS/AFS Translator
+
+           * keeping the machine's clock synchronized with
+             the chosen file server machine's
+
+      - "background"  daemons  that improve performance by
+        pre-fetching  files  and   performing   background
+        (delayed) writes of saved data into AFS.
+
+        The  default  number  of  background daemons is 2,
+        usually enough to  handle  up  to  5  simultaneous
+        users  of  the machine.  Use the -daemons argument
+        to increase the number of background  daemons,  if
+        the  machine  serves  more  users.  No more than 6
+        background daemons should ever be necessary.
+
+   The default number of daemons is four (one callback  daemon,
+   one  maintenance  daemon,  and two background daemons).  The
+   issuer can alter only the number of background daemons; afsd
+   always  initializes  one callback daemon and one maintenance
+   daemon.
+
+   AFS includes three configuration scripts that can be used to
+   modify  some  Cache  Manager  parameters on a client machine
+   that uses a disk cache.  Named  rc.afsd.small,  rc.afsd.med,
+   and   rc.afsd.large,   the   configuration  scripts  specify
+   suitable, predefined values for the  afsd  command's  -stat,
+   -dcache,  -daemons,  and  -volumes  switches.    They define
+   increasingly greater values for these switches according  to
+   the  configuration  and usage patterns of the client machine
+   on which the afsd command is run.  Refer to the  AFS  System
+   Administrator's Guide for more information about the scripts
+   and how to use them.
+
+ARGUMENTS
+
+   -blocks   specifies the number of kilobyte blocks to be made
+
+
+
+             available  for  caching  in  the  machine's  cache
+             directory (for a disk  cache)  or  memory  (for  a
+             memory  cache),  overriding the default defined in
+             the third field of  /usr/vice/etc/cacheinfo.    It
+             should  not  exceed 90% to 95% of the actual space
+             available.   If  using  a  memory  cache,  do  not
+             combine this argument with -dcache, since doing so
+             could result in a  chunk  size  that  was  not  an
+             exponent of 2.
+
+   -files    specifies  the  number of V files to be created in
+             the cache directory for a disk  cache,  overriding
+             the  default of 1000.  Each V file can accommodate
+             a "chunk" of data, which for a disk  cache  is  64
+             kilobytes by default.  Thus the default of 1000 is
+             adequate for any cache smaller than  64  megabytes
+             (unless  chunk  size  is changed with -chunksize).
+             Do not combine this argument with -memcache.
+
+   -stat     specifies the number of entries in  the  machine's
+             memory  for recording status information about the
+             AFS files in the cache.  This value overrides  the
+             default of 300.
+
+   -rootvol  names  the  Read Write volume corresponding to the
+             root directory for the AFS  file  tree  (which  is
+             usually  /afs).   This value overrides the default
+             of root.afs.
+
+   -cachedir names the local disk directory to be used  as  the
+             cache.    This value overrides the default defined
+             in the  second  field  of  /usr/vice/etc/cacheinfo
+             (typically, /usr/vice/cache).
+
+   -mountdir names  the  local disk directory on which to mount
+             the AFS file  tree.    This  value  overrides  the
+             default    defined   in   the   first   field   of
+             /usr/vice/etc/cacheinfo  (typically,  /afs).    If
+             /afs  is  not  used, the machine cannot access the
+             AFS global name space.
+
+   -daemons  specifies the number of  "background"  daemons  to
+             run   on  the  machine.    These  daemons  improve
+             efficiency by doing  pre-fetching  and  background
+             writing  of  saved data.  This value overrides the
+             default of 2, which  is  adequate  for  a  machine
+             serving  up to five users.  It does not change the
+             number of  "callback"  or  "maintenance"  daemons,
+             which is always one each.
+
+   -verbose  causes  afsd  to  produce a more detailed trace of
+             its activities than the default one.    The  trace
+             displays  on  standard  out  (stdout) unless it is
+             piped into a file.
+
+   -debug    causes afsd to produce a highly detailed trace  of
+             its  activities, potentially useful to a developer
+             for  debugging  purposes.    The  trace  goes   to
+             standard output (stdout) by default.
+
+   -nosettime
+
+
+
+             prevents the machine from selecting  at  random  a
+             local  file  server machine to act as a source for
+             the "correct" time.  If this flag is omitted,  the
+             machine  selects  a  file server machine as a time
+             standard,  and  every  five   minutes   thereafter
+             adjusts  its  clock  to  avoid  drifting  from the
+             standard.
+
+   -rmtsys   initializes an additional  "remote-system"  daemon
+             to  execute AFS-specific system calls on behalf of
+             NFS client machines.  This flag is necessary  only
+             if  the  machine is an NFS/AFS translator machine,
+             and if users on its NFS clients  want  to  execute
+             AFS commands.
+
+   -memcache causes  afsd  to  initialize a memory cache rather
+             than a disk cache.  Do not combine this flag  with
+             -files.
+
+   -dcache   sets  the  number  of  "dcache entries" in memory,
+             which are used to store  information  about  cache
+             chunks.    For  a  disk  cache, this overrides the
+             default of 100.  For a memory cache, this argument
+             effectively  sets the number of cache chunks.  Use
+             of this argument is not recommended for  a  memory
+             cache,   because   it   requires   the  issuer  to
+             pre-calculate  the  resulting  total  cache   size
+             (derived by multiplying this value by chunk size).
+             Do not combine this argument with  -blocks,  since
+             doing so could result in a chunk size that was not
+             an exponent of 2.
+
+   -chunksize
+             sets  the  size  of each cache chunk.  The integer
+             provided, which should be between  0  and  20,  is
+             used as an exponent on the number 2.  It overrides
+                                                     16
+             the default of 16 for a  disk  cache  (2    is  64
+                                                        13
+             kilobytes)  and  13  for  a memory cache (2   is 8
+             kilobytes).  A value of 0 or less, or greater than
+             20,  sets  chunk  size to the appropriate default.
+             Values less than 10 (which sets chunk  size  to  a
+                         10
+             kilobyte,  2  )  are  not  recommended.  Combining
+             this argument  with  -dcache  is  not  recommended
+             because  it requires that the issuer pre-calculate
+             the cache size that results.
+
+EXAMPLE
+
+   This command is normally included in an initialization  file
+   such  as  /etc/rc,  rather  than  typed at the command shell
+   prompt.  For most disk caches, the appropriate form is
+
+   /usr/vice/etc/afsd
+
+   The following is appropriate when enabling a machine to  act
+   as  an  NFS/AFS  Translator  machine  serving more than five
+   users.
+
+   /usr/vice/etc/afsd -daemons 4 -rmtsys
+
+
+
+   The following initializes a memory cache and sets chunk size
+                     14
+   to 16 kilobytes (2  ).
+
+   /usr/vice/etc/afsd -memcache -chunksize 14
+
+PRIVILEGE REQUIRED
+
+   Issuer must be logged into the machine's UNIX file system as
+   "root."
diff --git a/src/man/dkload.1 b/src/man/dkload.1
new file mode 100644 (file)
index 0000000..9bb3356
--- /dev/null
@@ -0,0 +1,198 @@
+dkload                     AFS Commands                  dkload
+
+
+NAME
+
+   dkload -- incorporate   external   libraries   into  kernel
+
+                       without rebooting.
+
+
+   dkload  [-readonly]  [-quiet]  [-verbose]  [-syscallResult
+   <number>]
+   [-path <object path>]  [-ld_cmd <loader path>]
+   [-as_cmd <assembler path>]  [-nm_cmd <nm path>]
+   [-libcommon <path>] [-kernel_alloc <path>]
+                                                    +
+   [-name <library name>]  [<library to incorporate> ]
+
+ACCEPTABLE ABBREVIATIONS
+
+   This command does not use the syntax conventions of the  AFS
+   command  suites.   Therefore, "dkload" must be typed in full
+   and switches must always be included,  though  they  may  be
+   shortened as indicated.
+
+   dkload  [-r]  [-q]  [-v]  [-s <number>] [-p <object path>]
+   [-ld <loader path>]
+   [-a <assembler path>]  [-nm <nm path>]  [-li <path>] [-k
+   <path>]
+                                                  +
+   [-na <library name>]  [<library to incorporate> ]
+
+DESCRIPTION
+
+   Loads  one  or more libraries into the memory version of the
+   local machine's kernel.  It does not alter the disk  version
+   of  the kernel (/vmunix or equivalent).  Its intended use is
+   loading the AFS routine library, lib.afs, into the kernel on
+   client machines.
+
+   The  dynamic  loader  begins by requesting (from a low-level
+   kernel routine) allocation of a certain amount of memory  in
+   which  to  load the libraries.  It resolves cross-references
+   between  procedures  in  the  existing  kernel  and  in  the
+   libraries (referred to as "linking" the two).  The result is
+   a  list  of  memory  addresses  for   the   cross-referenced
+   procedures,  which the dynamic loader stores in a table.  It
+   generates  an  executable  version  of  the  libraries  with
+   correct  addresses  inserted for all of the necessary kernel
+   variables and procedures, and loads the executable into  the
+   memory space allocated in the first phase.
+
+REQUIREMENTS
+
+   The  dkload  binary  file should be available in the current
+   working directory, or the issuer must specify a pathname  in
+   the    command    name.      The   standard   directory   is
+   /usr/vice/etc/dkload     on     client     machines      and
+   /usr/afs/bin/dkload on file server machines.
+
+   The file kalloc.o should be available in the current working
+   directory, or the issuer must specify a pathname with either
+   the -kernel_alloc or -path argument.  This file helps in the
+   first phase of dynamic loading:   allocating  kernel  memory
+
+
+
+   for the libraries.  It is generated automatically during the
+   compilation of the dkload program.
+
+   The file libcommon.a should  be  available  in  the  current
+   working  directory,  or  the  issuer must specify a pathname
+   with either the -libcommon or -path  argument.    This  file
+   helps  in  the  second  phase  of dynamic loading: resolving
+   cross-references.  It is generated automatically during  the
+   compilation of the dkload program.
+
+   The library file(s) to be loaded (such as lib.afs) should be
+   available in the current working directory,  or  the  issuer
+   must use the -path argument to specify the correct path.
+
+   The  binary  files for the standard UNIX commands ld, as and
+   nm should be available in a local disk directory included in
+   the  issuer's  $PATH  environment  variable.  Otherwise, the
+   issuer needs to use  the  -ld_cmd,  -as_cmd  and/or  -nm_cmd
+   arguments to specify the correct pathname.
+
+ARGUMENTS
+
+   -readonly       directs  the  command  interpreter to report
+                   the actions it would  perform  if  executing
+                   the command, rather than actually performing
+                   it.
+
+   -quiet          suppresses the  trace  of  actions  that  by
+                   default appears on standard output (stdout).
+
+   -verbose        increases  the  amount of information in the
+                   trace  that  appears  on   standard   output
+                   (stdout).    Multiple instances of this flag
+                   may be provided, resulting (up to a  certain
+                   point)  in  a  increasing level of detail in
+                   the trace.
+
+   -syscallResult  specifies  the  memory  address   at   which
+                   allocation begins when the -readonly flag is
+                   provided.  This is useful  when  the  issuer
+                   wants  to  specify a memory address obtained
+                   during a previous aborted run of dkload.
+
+                   Provide  this  argument  only   when   using
+                   -readonly.   The value may be either a large
+                   decimal or hexidecimal  number  (the  latter
+                   beginning  with  0x).    If this flag is not
+                   provided, the value defaults to  0xc1456780,
+                   which  may  not be acceptable on all machine
+                   types but has the advantage that  it  causes
+                   allocation to begin well above the addresses
+                   used by standard libraries.
+
+   -path           specifies the directory in which the command
+                   interpreter  can  find kalloc.o, libcommon.a
+                   and each library to be loaded, if  they  are
+                   not  in  the current working directory.  The
+                   value of  this  argument  is  overridden  by
+                   -kernel_alloc   and   -libcommon,   or   the
+                   pathnames  given   for   each   library   to
+                   incorporate.
+
+
+
+   -ld_cmd         specifies the pathname to the binary for the
+                   UNIX ld command, which  the  kernel  dynamic
+                   loader uses during the linking phase.
+
+                   This  argument  is  necessary  only  if  the
+                   issuer's $PATH environment variable will not
+                   lead to the correct binary file.  The binary
+                   file cannot be in AFS, for  instance,  since
+                   the  dynamic  loader runs before the machine
+                   can access AFS.
+
+   -as_cmd         specifies the pathname to the binary for the
+                   UNIX  as  command,  which the kernel dynamic
+                   loader uses during the linking phase.
+
+                   This  argument  is  necessary  only  in  the
+                   conditions specified under -ld_cmd.
+
+   -nm_cmd         specifies the pathname to the binary for the
+                   UNIX nm command, which  the  kernel  dynamic
+                   loader uses during the linking phase.
+
+                   This  argument  is  necessary  only  in  the
+                   conditions specified under -ld_cmd.
+
+   -libcommon      specifies the pathname  of  the  libcommon.a
+                   file.
+
+                   This  argument is necessary only if the file
+                   does  not  reside  in  the  current  working
+                   directory  or if the -path argument does not
+                   indicate the correct directory for it.
+
+   -kernel_alloc   specifies the pathname of the kalloc.o file.
+
+                   This  argument  is  necessary  only  in  the
+                   conditions specified under -libcommon.
+
+   -name           specifies  the  variable part of the library
+                   name to be loaded: the  command  interpreter
+                   loads        the        library       called
+                   "lib<library name>.a".    For  example,   if
+                   <library  name>  is  afs, then libafs.a gets
+                   loaded.
+
+                   Provide  this   argument   OR   library   to
+                   incorporate.
+
+   library to incorporate names each library to be incorporated
+                   into the kernel.
+
+                   Provide this argument OR -name.
+
+EXAMPLE
+
+   The following loads in the AFS libraries.  It  assumes  that
+   all  files  can  be  found in the current directory or other
+   expected place.  The issuer desires extra trace information.
+
+   % dkload -verbose -name afs
+
+
+
+PRIVILEGE REQUIRED
+
+   Issuer must be logged into the machine's UNIX file system as
+   "root" or at least have w access to /dev/mem and /dev/kmem.
diff --git a/src/man/fileserver.1 b/src/man/fileserver.1
new file mode 100644 (file)
index 0000000..f83cad7
--- /dev/null
@@ -0,0 +1,177 @@
+fileserver                 AFS Commands              fileserver
+
+
+NAME
+
+   fileserver -- initialize   File   Server  component  of  fs
+
+                       process.
+
+
+   /usr/afs/bin/fileserver [-b <buffers>]  [-banner]  [-cb
+   <callbacks>]
+   [-d <debug level>]  [-k <stack size>]  [-l <large vnodes>]
+            [-oldvldb]  [-pctspare <percent>]  [-rxdbg]
+   [-rxdbge]  [-rxpck]
+   [-s <small vnodes>]  [-spare <kilobyte blocks>]
+   [-w <callback wait interval>]
+   [-c <check interval>]  [-ftpck <r ftp packets>]  [-noauth]
+            [-p <LWPs>]  [-r <r retry count>]  [-rpck <r
+   packets
+
+DESCRIPTION
+
+   Initializes the File Server component of the fs process.
+
+   The arguments on fileserver allow the issuer to control many
+   aspects  of  its  behavior,  as  detailed  in  the ARGUMENTS
+   section.
+
+   Perhaps  the  most  important  aspect  to  control  from  an
+   administrative standpoint is that by default the File Server
+   allows users to store up to a megabyte (1024  kilobytes)  of
+   data  in a volume after the volume's quota is exceeded.  The
+   user still cannot create new files after quota is  exceeded.
+   The  issuer  of this command can change the default with the
+   -spare or -pctspare arguments:
+
+      - -spare specifies  the  number  of  kilobytes  over
+        quota  the  File Server will allow.  To make users
+        unable to store files after the quota is exceeded,
+        specify a value of 0.
+
+      - -pctspare  expresses the amount of excess the File
+        Server will allow as a percentage of the  volume's
+        quota.
+
+WARNING
+
+   This  command  is  not  normally issued at the command shell
+   prompt, but rather  placed  into  a  file  server  machine's
+   /usr/afs/local/BosConfig with the bos create command.  If it
+   is ever issued at the command shell prompt, the issuer  must
+   be working on a file server machine.
+
+   Several  of this command's arguments are intended for use by
+   AFS developers only.    Changing  them  from  their  default
+   values   is   strongly   discouraged   and   may  result  in
+   unpredictable File Server behavior.  The relevant  arguments
+   are marked in the ARGUMENTS section.
+
+   This  command does not use the syntax conventions of the AFS
+   command suites, so the command  and  switch  names  must  be
+   typed in full.
+
+   Do  not  specify both -spare and -pctspare.  Doing so causes
+
+
+
+   the File  Server  to  exit,  leaving  an  error  message  in
+   /usr/afs/logs/FileLog.
+
+ARGUMENTS
+
+   -b           sets the number of directory buffers, which are
+                2 kilobytes each.  Provide a positive  integer.
+                The default is 70.
+
+   -banner      causes  the File Server to prints the following
+                banner to /dev/console about every 10 minutes.
+
+                    File Server is running at time.
+
+   -cb          sets the number of callbacks  the  File  Server
+                can  track.    Provide a positive integer.  The
+                default is 20,000.
+
+   -d           sets the detail level for the  debugging  trace
+                the      File      Server      produces      in
+                /usr/afs/logs/FileLog.    Provide  a   positive
+                integer;  higher values (up to a point) produce
+                greater  detail.    The  default  level  of   0
+                produces no trace.
+
+   -k           sets the LWP stack size in units of 1 kilobyte.
+                Provide a positive integer.  The default is  24
+                (kilobytes).    Do  not set this argument lower
+                than the default.
+
+   -l           sets the number of large  vnodes  to  use  (for
+                tracking   directory   elements).    Provide  a
+                positive integer.  The default is 200.
+
+   -oldvldb     directs the File Server to use  the  pre-AFS  3
+                volume  location  facility rather than the VLDB
+                and VL Server.
+
+   -pctspare    specifies the amount by which the  File  Server
+                will  allow  a volume to exceed its quota, as a
+                percentage of the quota.   Provide  an  integer
+                between  0  and  99.  A value of 0 prevents the
+                volume from ever exceeding its quota.   Do  not
+                combine this argument with -spare.
+
+   -rxdbg       sends  an Rx debugging trace to the rx_dbg file
+                in the current working directory.
+
+   -rxdbge      sends an Rx event debugging trace to the rx_dbg
+                file in the current working directory.
+
+   -rxpck       sets the number of extra Rx packets to reserve.
+                Provide a positive integer.    The  default  is
+                100.    Do  not use this argument; changing its
+                default may cause unpredictable behavior.
+
+   -s           sets the number of small  vnodes  to  use  (for
+                tracking  file  elements).   Provide a positive
+                integer. The default is 200.
+
+   -spare       specifies the number  of  extra  kilobytes  the
+
+
+
+                File  Server  will  allow  users  to store in a
+                volume after its quota is exceeded.  Provide  a
+                positive  integer.    A value of 0 prevents the
+                volume from ever exceeding its quota.   Do  not
+                combine this argument with -pctspare.
+
+   -w           sets  the  interval at which daemons spawned by
+                the  File  Server  perform  their   maintenance
+                tasks.  The default is 300 seconds (5 minutes).
+                Do not use this argument; changing its  default
+                may cause unpredictable behavior.
+
+   -c           is not implemented.
+
+   -ftpck       is obsolete.
+
+   -noauth      is obsolete.
+
+   -p           is obsolete.
+
+   -r           is obsolete.
+
+   -rpck        is obsolete.
+
+EXAMPLES
+
+   The  following  bos create  command creates an fs process on
+   fs2.transarc.com that allows volumes to exceed  their  quota
+   by 10%.
+
+   Type the command on a single line.
+
+   % bos create fs2.transarc.com fs fs "/usr/afs/bin/fileserver
+   -pctspare 10"
+   /usr/afs/bin/volserver  /usr/afs/bin/salvager
+
+PRIVILEGE REQUIRED
+
+   Issuer must be listed in /usr/afs/etc/UserList to place this
+   command in /usr/afs/local/BosConfig,  because  that  is  the
+   privilege required to issue bos create.
+
+MORE INFORMATION
+
+   bos create
diff --git a/src/man/fs.1 b/src/man/fs.1
new file mode 100644 (file)
index 0000000..8cb5aac
--- /dev/null
@@ -0,0 +1,68 @@
+                           AFS Commands
+
+   1. The fs Commands
+
+   ------------------------------------------------------------
+
+   This  command  defines the fs commands that users and system
+   administrators employ to contact  the  File  Server  and  to
+   configure  the  Cache  Manager.    It  assumes the reader is
+   familiar with the  concepts  described  in  the  AFS  System
+   Administrator's Guide.
+
+   Some  fs  commands  extend  UNIX  file  system  semantics by
+   invoking file-related functions that UNIX does  not  provide
+   (setting  access  control  lists,  for  example).   Other fs
+   commands help users control the  performance  of  the  Cache
+   Manager  running  on  their  local client workstation.  When
+   using fs commands, pay particular attention to the  kind  of
+   privilege required, as it varies from command to command.
+
+   Refer to the Command Summary at the end of this document for
+   a complete list of fs commands and their syntax.
+
+   1.1 Common Arguments and Flags
+   All fs commands accept the following optional flag.   It  is
+   listed  in  the  command  descriptions  and  is described in
+   detail here:
+
+   [-help]
+
+   This flag has the same function as the fs help command:   It
+   prints  a  command's  online help message on the screen.  No
+   other arguments or flags should be provided at the same time
+   as  this  flag.   If they are, this flag overrides them, and
+   the only effect of issuing the  command  is  that  the  help
+   message appears.
+   AFS Command Reference Manual              The fs Commands  2
+
+
+   1.2 The Privileges Required for fs Commands
+   The privileges required for fs commands vary more than those
+   required  for  commands  in  other  suites.    Pay   special
+   attention  to the PRIVILEGE REQUIRED section of each command
+   description.
+
+   The various types of necessary privilege include
+
+
+      - Having certain  rights  on  a  directory's  access
+        control  list.  For example, creating and removing
+        mount  points  requires  ADMINISTER,  INSERT,  and
+        DELETE rights for the directory in which the mount
+        point  resides.    Setting  a  directory's  access
+        control list requires certain rights, too.
+
+      - Being  logged  in  as the super-user "root" in the
+        UNIX file system  of  the  machine  on  which  the
+        command  is  being issued.  This is necessary when
+        issuing  commands  that   affect   Cache   Manager
+        configuration.
+
+      - Belonging  to  the  system:administrators group in
+        the  Protection  Database.    See  the   fs setvol
+        command for an example.
+
+      - No  privilege.    Many  fs  commands  simply  list
+        information and so  do  not  require  any  special
+        privilege.
diff --git a/src/man/fs_apropos.1 b/src/man/fs_apropos.1
new file mode 100644 (file)
index 0000000..16dc263
--- /dev/null
@@ -0,0 +1,66 @@
+fs apropos                 AFS Commands              fs apropos
+
+
+NAME
+
+   fs apropos -- show each help entry containing keyword.
+
+
+   fs apropos  -topic <help string>  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs ap  -t <help string>  [-h]
+
+DESCRIPTION
+
+   Displays  the first line of the online help entry for any fs
+   command  that  has  help  string  in  its  name   or   short
+   description.
+
+ARGUMENTS
+
+   -topic
+         specifies the keyword string for which to search.   If
+         it is more than a single word, surround it with double
+         quotes  or  other  delimiters.    This   argument   is
+         case-sensitive;  type  help strings for fs commands in
+         lowercase letters.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+OUTPUT
+
+   The  first  line  of a command's online help entry names the
+   command and briefly describes what it does.  The  fs apropos
+   command  displays  that  first line for any fs command where
+   help string is part of the command name or first line.
+
+   To see the remaining lines in a help  entry,  which  provide
+   the  command's  alias  (if  any) and syntax, use the fs help
+   command.
+
+EXAMPLES
+
+   The following lists all  fs  commands  that  have  the  word
+   "cache"   in   their   operation   codes   or  short  online
+   descriptions:
+
+       % fs apropos -topic cache
+       setcachesize: set cache size
+       flush: flush file from cache
+       getcacheparms: get cache usage info
+       monitor: set cache monitor host address
+
+
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs help
diff --git a/src/man/fs_checkservers.1 b/src/man/fs_checkservers.1
new file mode 100644 (file)
index 0000000..e0433c9
--- /dev/null
@@ -0,0 +1,153 @@
+fs checkservers            AFS Commands         fs checkservers
+
+
+NAME
+
+   fs checkservers -- check status of file server machines.
+
+
+   fs checkservers  [-cell <cell to check>]  [-all]  [-fast]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs checks  [-c <cell to check>]  [-a]  [-f]  [-h]
+
+DESCRIPTION
+
+   Lists any file server machines in the indicated cell(s) that
+   meet two conditions:
+
+      1. The Cache Manager has been in  contact  with  the
+         fileserver process running on the machine, and/or
+         may need to contact it in future.   (Reasons  for
+         wanting  to  contact  a file server machine might
+         include holding a callback from that  machine  or
+         having locked files on it.)
+
+      2. The  fileserver  process  on  the  machine is not
+         currently  responding  to  Cache  Manager  probes
+         (implying  that  it  is  not  responding to Cache
+         Manager file requests either).
+
+   The Cache Manager constantly maintains a list of file server
+   machines  that  meet  the first condition, updating it every
+   four to ten minutes by attempting to contact the  fileserver
+   process  on  each  machine in the list.  When a process does
+   not respond to the probe, the  Cache  Manager  marks  it  as
+   non-functioning.    If  a  machine  that  previously did not
+   respond begins to respond again, the  Cache  Manager  erases
+   the "not functioning" mark.
+
+   This   command  forces  the  Cache  Manager  to  update  its
+   information immediately (rather than  waiting  the  standard
+   interval).   The Cache Manager probes the fileserver process
+   on the machines in the specified cell that  meet  the  first
+   condition  above,  records  those  that  do not respond, and
+   reports the result.  If the issuer includes the -fast  flag,
+   the  Cache  Manager  outputs  the list it already has at the
+   time the command is issued instead of probing  the  machines
+   again.
+
+   By  default,  the Cache Manager probes machines in the local
+   cell only.  If the -all flag is used, it probes all machines
+   (from  all  cells) that meet the first condition.  If a cell
+   name is specified with -cell, The Cache Manager  probes  the
+   machines in that cell only.
+
+WARNING
+
+   It  can  take  quite a while for this command to produce its
+   entire output if a number of machines in the Cache Manager's
+   list are in fact down when the command is issued.  The delay
+   is because after issuing the probe the Cache Manager waits a
+   standard   timeout   period   before   concluding  that  the
+
+
+
+   fileserver  is  not  responding;   this   allows   for   the
+   possibility  of  slow cross-network communication.  If it is
+   important that the command shell prompt return quickly,  the
+   issuer  may  wish to put this command in the background.  It
+   is harmless to interrupt the command (with Ctrl-C or another
+   interrupt signal).
+
+   This  command  is  not guaranteed to check the status of all
+   file server machines in a cell.  The  Cache  Manager  probes
+   only  those machines that meet the first condition mentioned
+   above.
+
+ARGUMENTS
+
+   -cell specifies the complete name of  the  cell  whose  file
+         server   machines   the  Cache  manager  should  probe
+         (shortened forms are not acceptable).    Provide  this
+         argument OR -all; it may be combined with -fast.
+
+   -all  causes  the  Cache  Manager to probe all machines that
+         meet the first condition  mentioned  above.    Provide
+         this argument OR -cell; it may be combined with -fast.
+
+   -fast tells the Cache Manager to display its current list of
+         down machines, rather than probing any machines.   The
+         displayed output may be up to 10 minutes old.
+
+   -dir  is   obsolete,  but  can  still  be  provided  on  the
+         command-line.    Previous  versions  of  this  command
+         required a directory argument.  If the issuer includes
+         it by accident, a warning  message  appears,  but  the
+         command still executes correctly.
+
+   -help prints the online help entry for this command.  Do not
+         provide any other arguments or flags  with  this  one.
+         See  section  3.1  in  the  Reference  Manual for more
+         details.
+
+OUTPUT
+
+   If the Cache  Manager  gets  a  response  from  all  of  the
+   machines  that  it  probes  (i.e.,  all  such  machines  are
+   functioning normally), the output is
+
+       All servers are running.
+
+   (Remember that this message does not  imply  that  all  file
+   server  machines  in  the  cell are running.  It reports the
+   status of only those that the Cache Manager tries to probe.)
+
+   If a machine fails to respond to the Cache  Manager's  probe
+   within  the  timeout  period,  the output displays its name.
+   The format of a machine name (name  in  uppercase,  name  in
+   lowercase,  or  Internet address in four-field decimal form)
+   depends on the state of the local cell's name server at  the
+   time the command is issued.
+
+EXAMPLES
+
+   In  the  following  example,  the  issuer chooses to see the
+   Cache Manager's current list of down machines that belong to
+
+
+
+   the  local  cell,  rather  than waiting for it to probe them
+   again.  The output indicates that all machines responded  to
+   the previous probe.
+
+   % fs checks -f  All servers are running.
+
+   The  following  example  checks  file server machines in all
+   cells that the Cache Manager has previously contacted.    It
+   reports    that    the    machines    fs1.transarc.com   and
+   vice3.andrew.cmu.edu did not respond to the machine's probe.
+
+   % fs checkservers -all &  These servers are still down:
+   fs1.transarc.com               VICE3.ANDREW.CMU.EDU
+
+   The following example checks machines in the  athena.mit.edu
+   cell only:
+
+   % fs checks athena.mit.edu &  %All servers are running.
+
+PRIVILEGE REQUIRED
+
+   None.
diff --git a/src/man/fs_checkvolumes.1 b/src/man/fs_checkvolumes.1
new file mode 100644 (file)
index 0000000..adf310e
--- /dev/null
@@ -0,0 +1,44 @@
+fs checkvolumes            AFS Commands         fs checkvolumes
+
+
+NAME
+
+   fs  checkvolumes -- force  Cache  Manager to update volume-
+
+                       related information.
+
+
+   fs checkvolumes  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs checkv  [-h]
+
+DESCRIPTION
+
+   Forces the Cache Manager to discard its  table  of  mappings
+   between  volume  names  and  volumeID  numbers.    The Cache
+   Manager needs the information in the table to  fetch  files,
+   so  this  command  will  force  it to fetch the most current
+   information available at the File Server  about  a  volume's
+   contents before it can fetch any more files.
+
+   This  command  is  most  useful  if  the issuer knows that a
+   volume's name has changed, or that there has been a  release
+   of  new  ReadOnly  replicas,  because  issuing it forces the
+   Cache Manager to reference the volume with the new name,  or
+   the new ReadOnly replica.
+
+   Normally  the Cache Manager flushes the table and constructs
+   a new one once per hour anyway.
+
+ARGUMENTS
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+PRIVILEGE REQUIRED
+
+   None.
diff --git a/src/man/fs_cleanacl.1 b/src/man/fs_cleanacl.1
new file mode 100644 (file)
index 0000000..2e6643c
--- /dev/null
@@ -0,0 +1,83 @@
+fs cleanacl                AFS Commands             fs cleanacl
+
+
+NAME
+
+   fs  cleanacl -- remove obsolete entries from access control
+
+                       list.
+
+
+                                      +
+   fs cleanacl  [-path <dir/file path> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                             +
+   fs cl  [-p <dir/file path> ]  [-h]
+
+DESCRIPTION
+
+   Removes from the  access  control  list  of  each  specified
+   directory  or  file any entries that specify a user or group
+   no  longer  found  in  the  Protection  Database.    When  a
+   user/group  is removed from the Protection Database, its AFS
+   UID appears on access control lists rather  than  its  name.
+   This  command  removes such "abandoned" AFS UIDs from access
+   control lists.
+
+   Cleaning access control lists in this  way  not  only  keeps
+   them  from becoming crowded with irrelevant information, but
+   also prevents the new possessor of a recycled AFS  UID  from
+   obtaining  access  intended  for the former possessor of the
+   ID.  (Note that recycling IDs  is  not  recommended  in  any
+   case.)
+
+ARGUMENTS
+
+   -path specifies a file or directory for which the associated
+         access control list is to be cleaned.  If  a  filename
+         is  specified,  the ACL of the file's parent directory
+         is cleaned.  If the  issuer  omits  this  switch,  the
+         current working directory is assumed.
+
+   -help prints the online help entry for this command.  Do not
+         provide any other arguments or flags  with  this  one.
+         See  section  3.1  in  the  Reference  Manual for more
+         details.
+
+OUTPUT
+
+   If there are no obsolete AFS UIDs on the ACL, the  following
+   message appears:
+
+       Access list for directory is fine.
+
+   Otherwise,  the  output  reports  the resulting state of the
+   ACL, following the header
+
+       Access list for directory is now
+
+
+
+EXAMPLES
+
+   In the following example, the user pat cleans the ACL on the
+   current  directory and its subdirectories called reports and
+   sources.  The ACLs for the first two have  no  obsolete  AFS
+   UIDs on them, but sources does.
+
+   % fs cl . ./reports ./sources  Access list for . is fine.
+   Access list for ./reports is fine.  Access list for
+   ./sources is now  Normal rights:     system:authuser rl
+   pat rlidwka
+
+PRIVILEGE REQUIRED
+
+   Issuer  must  have  ADMINISTER  rights  to the directory; by
+   default,  the  owner  of  the  directory  and   members   of
+   system:administrators do.
+
+MORE INFORMATION
+
+   fs listacl
diff --git a/src/man/fs_copyacl.1 b/src/man/fs_copyacl.1
new file mode 100644 (file)
index 0000000..42570e2
--- /dev/null
@@ -0,0 +1,137 @@
+fs copyacl                 AFS Commands              fs copyacl
+
+
+NAME
+
+   fs copyacl -- copy access control list from one directory
+
+                       to one or more other directories.
+
+
+   fs copyacl -fromdir <source directory>
+                                 +
+   -todir <destination directory> 
+   [-clear]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                                                           +
+   fs co  -f <source directory>  -t <destination directory> 
+   [-c]  [-h]
+
+DESCRIPTION
+
+   Copies  the  access  control  list  (ACL)  from  the  source
+   directory to each destination directory.  The  command  does
+   not  affect  entries on the ACL of the source directory.  It
+   affects entries on the ACL of each destination directory  as
+   follows:
+
+      - If  an  entry  is  unique to the ACL of the source
+        directory,  it  is  copied  to  the  ACL  of   the
+        destination directory.
+
+      - If   an   entry   exists   on  the  ACLs  of  both
+        directories, it is  changed  on  the  ACL  of  the
+        destination  directory to match the rights granted
+        on the ACL of the source directory.
+
+      - If  an  entry  is  unique  to  the  ACL   of   the
+        destination  directory  and  the  -clear  flag  is
+        omitted, the entry is not affected.
+
+      - If  an  entry  is  unique  to  the  ACL   of   the
+        destination  directory  and  the  -clear  flag  is
+        included, the entry is removed.
+
+   Use the -clear flag to completely replace the  ACL  of  each
+   destination directory with that of the source directory.
+
+ARGUMENTS
+
+   -fromdir
+         specifies the source directory  whose  ACL  is  to  be
+         copied  to  each  destination  directory.  Abbreviated
+         pathnames are interpreted relative to the directory in
+         which  the  command  is  issued.    If  a  filename is
+         provided, the file's parent directory is used  as  the
+         source directory.
+
+   -todir
+         specifies  one  or  more  destination  directories  to
+         receive   the   ACL   from   the   source   directory.
+         Abbreviated pathnames are interpreted relative to  the
+         directory  in which the command is issued.  A filename
+
+
+
+         cannot be specified with this switch.
+
+   -clear
+         removes  all  existing  entries  from  the ACL of each
+         destination directory before copying the ACL from  the
+         source   directory.    The  ACL  of  each  destination
+         directory is thus completely replaced with the ACL  of
+         the  source directory.  If the issuer omits this flag,
+         entries  that  exist  on  the  ACL  of  a  destination
+         directory  but  not on the ACL of the source directory
+         are not affected.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+EXAMPLES
+
+   The  following  example  uses the fs copyacl command to copy
+   the ACL from the current directory to the subdirectory named
+   reports.    Entries  on the ACL of the current directory are
+   not affected.   Because  the  -clear  option  is  not  used,
+   entries  on the ACL of the reports directory that are not on
+   the ACL of the current directory remain unaffected as well.
+
+       % fs la . reports
+       Access list for . is
+       Normal rights:
+          pat rlidwka
+          smith rlidwk
+
+       Access list for reports is
+       Normal rights:
+          pat rl
+          pat:friends rl
+       Negative rights
+          jones rlidwka
+
+       % fs co . reports
+
+       % fs la . reports
+       Access list for . is
+       Normal rights:
+          pat rlidwka
+          smith rlidwk
+
+       Access list for reports is
+       Normal rights:
+          pat rlidwka
+          pat:friends rl
+          smith rlidwk
+       Negative rights
+          jones rlidwka
+
+
+
+PRIVILEGE REQUIRED
+
+   Issuer must have LOOKUP right to the  source  directory  and
+   ADMINISTER  right  to  each destination directory.  To issue
+   the command with a filename used for source  directory,  the
+   issuer  must have both the LOOKUP and READ rights on the ACL
+   of the file's parent directory.
+
+MORE INFORMATION
+
+   fs listacl
+
+   fs setacl
diff --git a/src/man/fs_debug.1 b/src/man/fs_debug.1
new file mode 100644 (file)
index 0000000..774b811
--- /dev/null
@@ -0,0 +1,110 @@
+fs debug                   AFS Commands                fs debug
+
+
+NAME
+
+   fs debug -- enable/disable Cache Manager debugging trace.
+
+
+   fs debug  -debug <'on' or 'off'>  [-dafs <afs debug level>]
+           [-dnet <network debug level>]  [-syslog]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs de  -de <on> or <off>  [-da <afs debug level>]
+   [-dn <network debug level>]  [-s]  [-h]
+
+DESCRIPTION
+
+   Determines  whether  the  Cache  Manager records information
+   about its activities that may prove helpful in debugging  or
+   other  trouble-shooting.    The  output  goes  into the file
+   /usr/vice/etc/AFSLog (unless an alternate directory or  name
+   is  specified  for  the file with the -logfile switch of the
+   afsd command).  See the ARGUMENTS  section  for  information
+   about  the  different  types of debugging output that can be
+   written to the file.
+
+   You can use the more command (or an equivalent command  such
+   as  the  pg  command  on  AIX systems) to read the debugging
+   output recorded in the AFSLog file.  You must be  logged  in
+   as  root  on the machine on which the AFSLog file resides to
+   read the file.  Interpreting the output requires familiarity
+   with the AFS source code.
+
+ARGUMENTS
+
+   -debug
+         controls whether debugging  information  is  produced.
+         The  legal  values  are  on,  which  directs debugging
+         information into the AFSLog file, and off, which stops
+         the recording of information in the file.
+
+   -dafs determines  the  types  of  debugging  information the
+         Cache Manager produces  about  its  activities.    The
+         following  list  describes  the  legal values for this
+         switch and the type of debugging  output  each  causes
+         the Cache Manager to write to the AFSLog file:
+
+            - 1,  which  causes the Cache Manager to write
+              standard debugging information.  Using  this
+              value   provides  a  good  deal  of  general
+              output.
+
+            - 2, which causes the Cache Manager  to  write
+              low-level  debugging  information  about the
+              AFS network.  Use this value only if you are
+              convinced that network problems exist.
+
+            - 4,  which  causes the Cache Manager to write
+              debugging information about the RX protocol.
+
+            - 8, which causes the Cache Manager  to  write
+              debugging  information  about  the interface
+              layer to AFS.  This value is not  useful  on
+
+
+
+              machines running a Sun operating system.
+
+         In  addition,  if  a value of 1, 4, or 8 is specified,
+         the Cache Manager also records in the AFSLog file  the
+         AFS  UID  of  each  user who accesses data from a file
+         server machine.  It records the  appropriate  AFS  UID
+         with each operation that accesses data.
+
+         The  legal  values  can  be added to specify different
+         combinations of output.  For example, a  value  of  15
+         specifies  that all possible types of output are to be
+         provided.  The default value of 1 is used if no  value
+         is specified.
+
+         Note:  The AFSLog file also records the type of volume
+         (ReadWrite, ReadOnly, or Backup) accessed from a  file
+         server  machine.   The type of the volume is displayed
+         along with the volumeID in the "state" flag in  bitmap
+         form.  If a ReadWrite volume is accessed, the bits are
+         clear; if a ReadOnly volume is accessed, the 1 bit  is
+         set; if a Backup volume is accessed, the 4 bit is set.
+
+   -dnet is not currently implemented and should not be used.
+
+   -syslog
+         specifies that debugging output is to be redirected to
+         the  syslogd  daemon.    This flag can be used only on
+         machines running Sun OS 4.1 or higher.
+
+EXAMPLES
+
+   The following turns on debugging using the default debugging
+   level of 1:
+
+   % fs de on
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   afsd
diff --git a/src/man/fs_diskfree.1 b/src/man/fs_diskfree.1
new file mode 100644 (file)
index 0000000..23f3368
--- /dev/null
@@ -0,0 +1,88 @@
+fs diskfree                AFS Commands             fs diskfree
+
+
+NAME
+
+   fs diskfree -- show information about the partition housing
+
+                       a directory/file.
+
+
+                                     +
+   fs diskfree [-path <dir/file path> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                             +
+   fs df  [-p <dir/file path> ]  [-h]
+
+DESCRIPTION
+
+   Provides information about the  partition  that  houses  the
+   volume  containing the specified directory or file.  See the
+   OUTPUT section for a complete explanation of the information
+   provided.  To learn more about the volume itself, use the fs
+   examine command.
+
+ARGUMENTS
+
+   -path specifies  a  file  or  directory  about  whose   host
+         partition information is desired.  If the issuer omits
+         this  argument,  the  current  working  directory   is
+         assumed.
+
+   -help prints the online help entry for this command.  Do not
+         provide any other arguments or flags  with  this  one.
+         See  section  3.1  in  the  Reference  Manual for more
+         details.
+
+OUTPUT
+
+   Note: The numbers that appear in this output may not  always
+   agree  with  the  corresponding numbers in the output of the
+   standard UNIX df command.  The main reason is  that  the  df
+   output  reflects  the  state  of partitions exactly when the
+   command is issued.  The numbers in this command's output may
+   be  up to 5 minutes old, as the Cache Manager polls the File
+   Server for partition information at that frequency.  Another
+   potential  difference:  the  partition  size reported by the
+   UNIX df command includes some reserved space that  does  not
+   show  up  in this report of partition size, and so is likely
+   to be about 10% larger.
+
+   The output reports  the  following  information  about  each
+   partition that houses a specified directory or file:
+
+      - the name of the volume that contains the directory
+        or file
+
+      - the total size in kilobyte blocks of the partition
+        that stores the named volume
+
+      - the   number   of  kilobyte  blocks  used  on  the
+        partition
+
+      - the number of kilobyte  blocks  available  on  the
+
+
+
+        partition
+
+      - the percentage of the partition's total space used
+
+EXAMPLES
+
+   The following shows the output for the partition housing the
+   volume user.smith in the Transarc Corporation cell:
+
+       % fs df /afs/transarc.com/usr/smith
+       Volume Name    kbytes  used     avail     %used
+       user.smith     333305  286710   46595       86%
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs examine
diff --git a/src/man/fs_examine.1 b/src/man/fs_examine.1
new file mode 100644 (file)
index 0000000..4734061
--- /dev/null
@@ -0,0 +1,109 @@
+fs examine                 AFS Commands              fs examine
+
+
+NAME
+
+   fs  examine -- show  information  about  volume  containing
+
+                       specified directory.
+
+
+                                     +
+   fs examine  [-path <dir/file path> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                              +
+   fs exa  [-p <dir/file path> ]  [-h]
+                                  +
+   fs listvol  [-p <dir/file path> ]  [-h]
+                             +
+   fs lv  [-p <dir/file path> ]  [-h]
+
+DESCRIPTION
+
+   Displays  information  about  the  volume  containing   each
+   specified  directory  or file.  The information includes the
+   file's quota and current size.  See the OUTPUT section for a
+   complete  explanation  of  the  information provided.  While
+   this command provides the most information about  a  volume,
+   the fs listquota and fs quota commands are also available to
+   display information about a volume.
+
+ARGUMENTS
+
+   -path specifies  each  file  and/or  directory   for   which
+         information  about  the  host volume is desired.  Omit
+         this switch to display information  about  the  volume
+         that contains the current working directory.
+
+   -help prints the online help entry for this command.  Do not
+         provide any other arguments or flags  with  this  one.
+         See  section  3.1  in  the  Reference  Manual for more
+         details.
+
+OUTPUT
+
+   Note: The partition-related  numbers  that  appear  in  this
+   output  may  not always agree with the corresponding numbers
+   in the output of the standard UNIX df  command.    The  main
+   reason   is  that  the  df  output  reflects  the  state  of
+   partitions exactly when the command is issued.  The  numbers
+   in  this command's output may be up to 5 minutes old, as the
+   Cache  Manager  polls  the   File   Server   for   partition
+   information   at   that   frequency.      Another  potential
+   difference: the partition  size  reported  by  the  UNIX  df
+   command  includes  some reserved space that does not show up
+   in this report of partition size, and so  is  likely  to  be
+   about 10% larger.
+
+
+
+   The  output  reports  the  following  information about each
+   volume that contains a specified directory or file:
+
+      - the volumeID number (abbreviated in the output  as
+        "vid") of the volume
+
+      - the volume's name
+
+      - the  current "offline" message associated with the
+        volume, as set by a system administrator using the
+        fs setvol command
+
+      - the  current  "message of the day" associated with
+        the volume, as set by a system administrator using
+        the fs setvol command
+
+      - the  volume's  maximum  size  quota,  in  kilobyte
+        blocks
+
+      - its current size, in kilobyte blocks
+
+      - the number of kilobyte blocks still  available  on
+        the  disk partition that houses the volume and the
+        partition's total size
+
+EXAMPLES
+
+   The following shows the output  for  the  volume  user.smith
+   (and  the  partition housing it) in the Transarc Corporation
+   cell:
+
+       % fs exa /afs/transarc.com/usr/smith
+       Volume status for vid = 50489902 named user.smith
+       Current maximum quota is 15000
+       Current blocks used are 5073
+       The partition has 46383 blocks available out of 333305
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs listquota
+
+   fs quota
+
+   fs setquota
diff --git a/src/man/fs_exportafs.1 b/src/man/fs_exportafs.1
new file mode 100644 (file)
index 0000000..8a50e23
--- /dev/null
@@ -0,0 +1,93 @@
+fs exportafs               AFS Commands            fs exportafs
+
+
+NAME
+
+   fs  exportafs -- report  or  set whether machine can export
+
+                       AFS  to  clients   of   alternate   file
+                       systems.
+
+
+   fs exportafs   -type <exporter name>  [-state <'on' or
+   'off'>]        [-noconvert]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs exp  -t <exporter name>  [-s <'on' or 'off'>]  [-n]  [-h]
+
+DESCRIPTION
+
+   This  command  performs  one  of the following, depending on
+   whether the issuer provides the -state argument:
+
+      - It sets whether the machine  is  accessible  as  a
+        server  of  the non-AFS file system exporter name,
+        able to be mounted by clients of that file system.
+
+      - It reports on the current status of the machine.
+
+   The command's  -noconvert  flag  can  be  used  to  indicate
+   whether  mode  bits of exported directories and files are to
+   be converted.  By default, the group and other mode bits  of
+   exported directories and files are changed to match the user
+   bits.
+
+ARGUMENTS
+
+   -type names the alternate file system for which the  setting
+         is  to be changed or reported.  Only lowercase letters
+         are acceptable.  The only legal value is nfs.
+
+   -state
+         controls  whether  the  workstation is accessible as a
+         server of the non-AFS file system or not.   The  legal
+         values  are  on,  which  enables  the workstation as a
+         server, and off, which  makes  it  inaccessible  as  a
+         server.  If the issuer omits this argument, the output
+         reports the current setting.
+
+   -noconvert
+         determines   whether  the  group  and  other  bits  on
+         exported files and directories are converted to  match
+         the  user  bits.  By default, the group and other bits
+         on exported files and directories are  made  to  match
+         the user bits.  Specify this flag to leave the bits as
+         they are in AFS.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+
+
+OUTPUT
+
+   When  the -state argument is omitted, the output reports the
+   name of the non-AFS file system and whether the  workstation
+   is enabled as a server of it.
+
+EXAMPLES
+
+   The  following  shows that this machine is enabled as an NFS
+   server (i.e., it is running the AFS/NFS Translator):
+
+   %  fs exportafs nfs  Exporter type: nfs is currently enabled
+   for AFS
+
+   The following shows that the machine is not  enabled  as  an
+   NFS server:
+
+   %  fs exportafs nfs  Sorry, the nfs-exporter type is
+   currently not supported on      this AFS client
+
+   The  following  prevents  the  machine from acting as an NFS
+   server:
+
+   % fs exp nfs off
+
+PRIVILEGE REQUIRED
+
+   Issuer must be logged in as "root" in the UNIX  file  system
+   of the machine on which the command is being issued.
diff --git a/src/man/fs_flush.1 b/src/man/fs_flush.1
new file mode 100644 (file)
index 0000000..6ac3bb7
--- /dev/null
@@ -0,0 +1,63 @@
+fs flush                   AFS Commands                fs flush
+
+
+NAME
+
+   fs   flush -- force  Cache  Manager  to  discard  a  cached
+
+                       file/directory.
+
+
+                                   +
+   fs flush  [-path <dir/file path> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                                +
+   fs flush  [-p <dir/file path> ]  [-h]
+
+DESCRIPTION
+
+   Forces the Cache Manager to remove each specified  directory
+   or file from its caches of data and status information.  The
+   result is that the next time data from a  flushed  directory
+   or  file  is  requested, the Cache Manager contacts the File
+   Server for the  most  current  version,  along  with  a  new
+   callback  (if  necessary) and associated status information.
+   This command does not discard data from application  program
+   buffers  or  data that has been altered in the cache but not
+   yet written back to the central copy maintained by the  File
+   Server.
+
+   The  fs  flushvolume  command  can be used to flush all data
+   that resides in the same  volume  as  a  specified  file  or
+   directory.
+
+ARGUMENTS
+
+   -path specifies  each  file  or directory to be flushed.  In
+         the case of a  directory  element,  only  the  element
+         itself  is  flushed,  not  data  cached  from files or
+         subdirectories that reside in it.  If this argument is
+         omitted, the current directory is flushed.
+
+   -help prints the online help entry for this command.  Do not
+         provide any other arguments or flags  with  this  one.
+         See  section  3.1  in  the  Reference  Manual for more
+         details.
+
+EXAMPLES
+
+   The following flushes from the cache the  file  projectnotes
+   in  the  current  working  directory  and  all data from the
+   subdirectory plans:
+
+   %  fs flush projectnotes ./plans/*
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs flushvolume
diff --git a/src/man/fs_flushvolume.1 b/src/man/fs_flushvolume.1
new file mode 100644 (file)
index 0000000..fea28a1
--- /dev/null
@@ -0,0 +1,65 @@
+fs flushvolume             AFS Commands          fs flushvolume
+
+
+NAME
+
+   fs flushvolume -- force Cache Manager to discard any cached
+
+                       data   from   the   volume    containing
+                       specified file/directory.
+
+
+                                         +
+   fs flushvolume  [-path <dir/file path> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                                 +
+   fs flushv  [-p <dir/file path> ]  [-h]
+
+DESCRIPTION
+
+   Forces  the Cache Manager to remove cached data (but not the
+   cached status information) for  all  files  and  directories
+   that  reside  in the same volume as each specified directory
+   or file.  The result is that the next time the Cache Manager
+   needs  anything  from a flushed volume, it contacts the File
+   Server for the  most  current  version,  along  with  a  new
+   callback (if necessary).  This command does not discard data
+   from application program  buffers  or  data  that  has  been
+   altered in the cache but not yet written back to the central
+   copy maintained by the File Server.
+
+   The fs flush command can be used to flush  individual  files
+   and directories.
+
+ARGUMENTS
+
+   -path specifies  one file or directory from each volume that
+         the Cache Manager is  to  flush  completely  from  its
+         cache.  If this argument is omitted, all data from the
+         volume that contains the current directory is flushed.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+EXAMPLES
+
+   The  following  flushes  from  the cache all data that comes
+   from the volume that contains the current working  directory
+   and  the  directory  reports  at  the same level in the file
+   tree:
+
+   %  fs flushv . ../reports
+
+PRIVILEGE REQUIRED
+
+   None.
+
+
+
+MORE INFORMATION
+
+   fs flush
diff --git a/src/man/fs_getcacheparms.1 b/src/man/fs_getcacheparms.1
new file mode 100644 (file)
index 0000000..73be426
--- /dev/null
@@ -0,0 +1,67 @@
+fs getcacheparms           AFS Commands        fs getcacheparms
+
+
+NAME
+
+   fs  getcacheparms -- show  current  size  of data cache and
+
+                       amount being used.
+
+
+   fs getcacheparms  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs getca  [-h]
+
+DESCRIPTION
+
+   Displays the current  size  of  the  cache  that  the  Cache
+   Manager  has  at its disposal, and the amount it is using at
+   the moment the command is issued.  The command works both on
+   machines  using  a memory cache and on machines using a disk
+   cache.
+
+   This information comes from the kernel of the workstation on
+   which  the  command  is  issued.    On machines using a disk
+   cache, the current cache size may disagree with the  default
+   setting  specified  in  the file /usr/vice/etc/cacheinfo, if
+   someone has set it with the fs setcachesize command.
+
+ARGUMENTS
+
+   -help           prints  the  online  help  entry  for   this
+                   command.  Do not provide any other arguments
+                   or flags with this one.  See section 3.1  in
+                   the Reference Manual for more details.
+
+OUTPUT
+
+   The output is of the form
+
+       AFS using <amount> of the cache's available <size> 1
+          blocks.
+
+   where  <amount>  is  the  number of 1K byte blocks the Cache
+   Manager is currently using, and <size> the total  number  of
+   blocks  available  to  the  Cache Manager (the current cache
+   size).
+
+EXAMPLES
+
+   The following shows the output on a  machine  with  a  25000
+   kilobyte cache.
+
+       % fs getca
+       AFS using 22876 of the cache's available 25000 1K by
+          blocks.
+
+
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs setcachesize
diff --git a/src/man/fs_getcellstatus.1 b/src/man/fs_getcellstatus.1
new file mode 100644 (file)
index 0000000..abb1054
--- /dev/null
@@ -0,0 +1,74 @@
+fs getcellstatus           AFS Commands        fs getcellstatus
+
+
+NAME
+
+   fs getcellstatus -- show whether workstation can run setuid
+
+                       programs
+                       from specified cell(s), and whether cell
+                       is using the old VLDB.
+
+
+                                     +
+   fs getcellstatus -cell <cell name>   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                           +
+   fs getce  -c <cell name>   [-h]
+
+DESCRIPTION
+
+   Reports whether the workstation allows programs fetched from
+   the specified cell(s) to run with setuid privilege.   System
+   administrators   set   a   cell's   setuid   status   on   a
+   per-workstation basis with the fs setcell command.
+
+   If a cell is using the AFS 2.0 method  for  tracking  volume
+   location  rather than the VLDB, the output reports this also
+   (see the OUTPUT section).
+
+ARGUMENTS
+
+   -cell names the cell(s) for which setuid status is  desired.
+         Provide the complete Internet-style name for each cell
+         (unlike the common -cell  argument  in  other  command
+         suites, it is not possible to abbreviate this one).
+
+   -help prints the online help entry for this command.  Do not
+         provide any other arguments or flags  with  this  one.
+         See  section  3.1  in  the  Reference  Manual for more
+         details.
+
+OUTPUT
+
+   Possible output values are
+
+      - no setuid allowed, indicating that  programs  from
+        the cell may not run with setuid privilege.
+
+      - setuid  allowed, indicating that programs from the
+        cell may run with setuid privilege.
+
+      - using old VLDB, indicating that the cell is  still
+        using the AFS 2.0 volume location method.
+
+
+
+EXAMPLES
+
+   The   following   indicates  that  programs  from  the  cell
+   oldcell.com may not run with setuid privilege and  that  the
+   cell is still using the old volume location method:
+
+   %  fs getce oldcell.com  Cell oldcell.com status: no setuid
+   allowed, using old VLDB
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs setcell
diff --git a/src/man/fs_getserverprefs.1 b/src/man/fs_getserverprefs.1
new file mode 100644 (file)
index 0000000..017059b
--- /dev/null
@@ -0,0 +1,147 @@
+fs getserverprefs          AFS Commands       fs getserverprefs
+
+
+NAME
+
+   fs  getserverprefs -- display  Cache  Manager's preferences
+
+                       for file server machines.
+
+
+   fs getserverprefs  [-file <dir/file path>]  [-numeric]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs gets  [-f <dir/file path>]  [-n]  [-h]
+
+   fs gp  [-f <dir/file path>]  [-n]  [-h]
+
+DESCRIPTION
+
+   Displays the Cache Manager's  preferences  for  file  server
+   machines.    A preference consists of the name or IP address
+   of a file server machine followed by its "rank."   The  rank
+   is a positive integer in the range from 1 to 65,534.
+
+   A  file server machine's rank determines the Cache Manager's
+   preference for selecting it  when  the  Cache  Manager  must
+   access  a  ReadOnly  replica  that resides on it.  The Cache
+   Manager compares the rank of the  server  machine  with  the
+   ranks  of  other server machines that house the replica.  It
+   then attempts to access the replica on  the  server  machine
+   that has the lowest integer rank.
+
+   If  it  cannot  access  the  replica on the machine with the
+   lowest rank (possibly because the machine or the network  on
+   which  the  machine  is  located is down), the Cache Manager
+   attempts to access the replica from the server machine  with
+   the  next lowest rank.  It continues in this manner until it
+   either accesses the replica or determines that  all  of  the
+   file  server  machines  on  which  the  replica  resides are
+   unavailable.
+
+   The Cache Manager records addresses and ranks for all  local
+   file  server  machines.  It also records addresses and ranks
+   for all foreign file server machines that house a volume  it
+   has accessed or for which a rank has been specified with the
+   fs setserverprefs command.   It  stores  the  addresses  and
+   ranks in the kernel of the client machine.
+
+   Information displayed with this command is sent to stdout by
+   default.  The -file switch can be used to direct the  output
+   to a file.
+
+
+
+ARGUMENTS
+
+   -file           specifies  the  pathname  of a file to which
+                   the file server machine names and ranks  are
+                   to  be written.  Omit this switch to display
+                   the machine names and ranks on stdout.
+
+   -numeric        specifies that the IP addresses of the  file
+                   server  machines  are to be displayed.  Omit
+                   this flag to display the names of  the  file
+                   server  machines.    Because  including this
+                   flag skips the resolution of IP addresses to
+                   machine names, information is displayed more
+                   quickly  than  if  the  option  is  omitted.
+                   (This  flag  is  especially  useful  if  the
+                   output is intended to be used  as  input  to
+                   the fs setserverprefs command, in which case
+                   it  does  not  matter   whether   names   or
+                   addresses are used.)
+
+   -help           prints   the  online  help  entry  for  this
+                   command.  Do not provide any other arguments
+                   or  flags with this one.  See section 3.1 in
+                   the Reference Manual for more details.
+
+OUTPUT
+
+   The output displays a separate line  for  each  file  server
+   machine  that  has  a  rank  in the kernel of the machine on
+   which the command is issued.  Each line displays the name of
+   a file server machine followed by its rank, as follows:
+
+       first machine name            rank
+       second machine name           rank
+         .  .  .  .                  . .
+
+   If  the  -numeric  flag  is  included  with the command, the
+   output displays the IP addresses of the file server machines
+   instead  of  their  names.  The address of a machine is also
+   displayed if the Cache Manager cannot resolve a file  server
+   machine's  name  based  on the machine's address at the time
+   the command is issued.
+
+EXAMPLES
+
+   The following displays the preferences  (the  list  of  file
+   server  machines and their respective ranks) associated with
+   a Cache Manager.  The output in the  example  truncates  the
+   complete  list of server machine names and ranks.  Note that
+   the IP addresses,  not  the  names,  of  some  machines  are
+   displayed because their addresses cannot be resolved.
+
+
+
+       % fs gets
+       fs5.transarc.com              20000
+       fs1.transarc.com              40000
+       fs3.transarc.com              20001
+       fs4.transarc.com              40001
+       fs2.transarc.com              25000
+       121.86.3.37                   40002
+       fserver1.andrew.cmu.edu       40000
+       121.86.3.34                   40001
+       server1.athena.mit.edu        1000
+          .   .   .   .   .           . .
+
+   The following displays the same Cache Manager's preferences,
+   but the -numeric flag is included to  display  only  the  IP
+   addresses of the file server machines, not their names.  The
+   example output again truncates the complete list  of  server
+   machine names and ranks.
+
+       % fs gets -n
+       128.21.6.214                  20000
+       128.2.11.9                    40000
+       128.2.11.12                   20001
+       128.2.11.13                   40001
+       128.2.11.11                   25000
+       121.86.3.37                   40002
+       121.86.3.31                   40000
+       121.86.3.34                   40001
+       145.2.50.121                  1000
+         .  .  .                      . .
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs setserverprefs
diff --git a/src/man/fs_help.1 b/src/man/fs_help.1
new file mode 100644 (file)
index 0000000..e5cec0a
--- /dev/null
@@ -0,0 +1,80 @@
+fs help                    AFS Commands                 fs help
+
+
+NAME
+
+   fs  help -- show  syntax  of  specified fs commands or list
+
+                       functional  descriptions   of   all   fs
+                       commands.
+
+
+                                 +
+   fs help  [-topic <help string> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                          +
+   fs h  [-t <help string> ]  [-h]
+
+DESCRIPTION
+
+   Displays  the  first  line  (name  and short description) of
+   every fs command's online help entry if no  help  string  is
+   provided.  For each operation code specified with -topic, it
+   outputs the entire help entry.  See the OUTPUT section.
+
+ARGUMENTS
+
+   -topic          specifies  the  operation  codes  for  which
+                   syntax  is  to  be  provided.  If the issuer
+                   omits  this  argument,  the  output  instead
+                   provides  a  short  description  of  all  fs
+                   commands.
+
+   -help           prints  the  online  help  entry  for   this
+                   command.  Do not provide any other arguments
+                   or flags with this one.  See section 3.1  in
+                   the Reference Manual for more details.
+
+OUTPUT
+
+   The online help entry for each fs command consists of two or
+   three lines:
+
+      - The first  line  names  the  command  and  briefly
+        describes what it does.
+
+      - The  second  line displays any aliases the command
+        has (this line does not appear for every command).
+
+      - The final line, which begins with "Usage:",  lists
+        the   command's   arguments   and   flags  in  the
+        prescribed order.  Online  help  entries  use  the
+        same   symbols  (for  example,  brackets)  as  the
+        command  definitions  in  this  manual.    For  an
+        explanation  of  their  meaning, see page v of the
+        introductory About This Manual chapter.
+
+
+
+EXAMPLES
+
+   The  following  displays  the  online  help  entry  for  the
+   fs setacl command:
+
+       % fs help setacl
+       fs setacl: set access control list
+       aliases: sa
+                                        +
+       Usage: fs setacl -dir <directory> 
+                                 +
+       -acl <access list entries>  [-clear] [-negative] [-help]
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs apropos
diff --git a/src/man/fs_listacl.1 b/src/man/fs_listacl.1
new file mode 100644 (file)
index 0000000..5a18b6f
--- /dev/null
@@ -0,0 +1,128 @@
+fs listacl                 AFS Commands              fs listacl
+
+
+NAME
+
+   fs listacl -- show access control list.
+
+
+                                    +
+   fs listacl [-path <dir/file path> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                             +
+   fs la  [-p <dir/file path> ]  [-h]
+
+DESCRIPTION
+
+   Displays  the access control list (ACL) associated with each
+   directory.  It is legal to provide a filename rather than  a
+   directory  name  for directory, in which case the ACL of the
+   file's parent directory is  displayed  (because  it  is  not
+   possible  to  set an ACL for an individual file, the file is
+   inheriting the ACL from its parent directory).    Omit  this
+   switch to display the ACL of the current working directory.
+
+   Users  who possess the ADMINISTER right on an ACL may change
+   the ACL with the fs setacl command or copy the  ACL  from  a
+   different directory to it with the fs copyacl command.
+
+WARNING
+
+   The  appearance  of a user/group on the Negative rights list
+   does not guarantee that the person is denied  those  rights.
+   If system:anyuser is granted any rights on the Normal rights
+   list, a user need only unlog to obtain those rights.
+
+ARGUMENTS
+
+   -path           specifies each  file  and/or  directory  for
+                   which  to  display  the  associated ACL.  If
+                   this  argument  is   omitted,   the   output
+                   displays the ACL associated with the current
+                   working directory.  If it is a filename, the
+                   ACL  displayed is associated with the file's
+                   parent directory.
+
+   -help           prints  the  online  help  entry  for   this
+                   command.  Do not provide any other arguments
+                   or flags with this one.  See section 3.1  in
+                   the Reference Manual for more details.
+
+OUTPUT
+
+   The  first line of the output names the directory associated
+   with the access control list.  If the issuer used  shorthand
+   notation  (such  as  "."  for  the  current  directory) when
+   indicating the directory, it may appear here rather than the
+   full pathname of the directory.
+
+
+
+   The  "Normal rights:" header indicates the list of users who
+   have normal rights to the directory.   Each  following  line
+   lists a user/group name and the set of rights the user/group
+   may exercise.  The possible rights and their meanings are
+
+
+      - r = READ the contents of files in the directory
+
+      - w = WRITE (modify) the contents of  files  in  the
+        directory
+
+      - l  =  LOOKUP status information about the files in
+        the directory
+
+      - d = DELETE files from the directory
+
+      - i = INSERT new files into the directory
+
+      - k = LOCK; set read or write locks on the files  in
+        the directory
+
+      - a  =  ADMINISTER;  change the rights on the access
+        control list
+
+      - A, B, C, D, E, F, G, H; by default, these have  no
+        meaning  to  AFS server processes.  Administrators
+        and application programs may  assign  meanings  to
+        them  and  place them on ACLs to control access to
+        the directory's contents in new ways.  The letters
+        must be uppercase.
+
+   A "Negative rights:" header may appear next, if any negative
+   rights have been specified for this directory.   The  format
+   of  this list is the same as that of the Normal rights list.
+   The difference  is  that  the  user(s)/group(s)  listed  are
+   denied rather than granted the specified rights.
+
+EXAMPLES
+
+   The  following  displays  the ACL associated with user pat's
+   home  directory  and  its  private  subdirectory  when   the
+   fs listacl command is issued in the home directory:
+
+   % fs la . private  Access list for . is  Normal rights:
+   system:authuser rl     pat rlidwka     pat:friends rlid
+   Negative rights:     smith rlidwka
+
+   Access list for private is  Normal rights:     pat rlidwka
+
+
+
+PRIVILEGE REQUIRED
+
+   To issue this command with a directory name argument, issuer
+   must have the LOOKUP right on the directory's ACL.  To issue
+   command  with a filename argument, the issuer must have both
+   the LOOKUP and READ rights on the ACL of the  file's  parent
+   directory.
+
+MORE INFORMATION
+
+   fs cleanacl
+
+   fs copyacl
+
+   fs setacl
diff --git a/src/man/fs_listcells.1 b/src/man/fs_listcells.1
new file mode 100644 (file)
index 0000000..110d195
--- /dev/null
@@ -0,0 +1,64 @@
+fs listcells               AFS Commands            fs listcells
+
+
+NAME
+
+   fs  listcells -- show  database  server machines in cell(s)
+
+                       known to Cache Manager.
+
+
+   fs listcells  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs listc  [-h]
+
+DESCRIPTION
+
+   Formats and displays  the  Cache  Manager's  kernel-resident
+   list  of  the  database server machines in its home cell and
+   foreign cells.
+
+   At each reboot of the workstation, the Cache Manager  copies
+   the contents of /usr/vice/etc/CellServDB into the kernel. It
+   is possible  to  modify  the  kernel-resident  list  between
+   reboots using fs newcell.
+
+ARGUMENTS
+
+   -help prints the online help entry for this command.  Do not
+         provide any other arguments or flags  with  this  one.
+         See  section  3.1  in  the  Reference  Manual for more
+         details.
+
+OUTPUT
+
+   The output contains a line  for  each  cell  for  which  the
+   kernel  has  a  list  of database server machines.  The cell
+   name is followed by a list of its database  server  machines
+   (referred to as "hosts").
+
+   The  format of each machine name (name in uppercase, name in
+   lowercase, or Internet address in four-field  decimal  form)
+   depends  on the state of the local cell's name server at the
+   time the command is issued.
+
+EXAMPLES
+
+   The  following   shows   output   for   several   cells   as
+   illustrations of the different formats for machine names:
+
+       % fs listc
+       Cell transarc.com on hosts fs1.transarc.com fs2.transarc
+       Cell andrew.cmu.edu on hosts VICE11.FS.ANDREW.CMU.EDU
+          VICE2.FS.ANDREW.CMU.EDU VICE7.FS.ANDREW.CMU.EDU.
+       Cell athena.mit.edu on hosts 18.80.0.2 orf.mit.edu
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs newcell
diff --git a/src/man/fs_listquota.1 b/src/man/fs_listquota.1
new file mode 100644 (file)
index 0000000..d1b5b8d
--- /dev/null
@@ -0,0 +1,84 @@
+fs listquota               AFS Commands            fs listquota
+
+
+NAME
+
+   fs  listquota -- show  quota  information  for  the  volume
+
+                       containing a file/directory.
+
+
+                                       +
+   fs listquota  [-path <dir/file path> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                             +
+   fs lq  [-p <dir/file path> ]  [-h]
+
+DESCRIPTION
+
+   Displays information about the size and quota of the  volume
+   containing each specified directory or file.  See the OUTPUT
+   section  for  a  complete  explanation  of  the  information
+   provided.
+
+ARGUMENTS
+
+   -path specifies   each   file  and/or  directory  for  which
+         information about the host volume is desired.  If  the
+         issuer  omits  this argument, the current directory is
+         assumed.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+OUTPUT
+
+   The  output  reports  the  following  information about each
+   volume that contains a specified directory or file:
+
+      - the name of the volume
+
+      - its maximum size quota, in kilobytes
+
+      - its current size, in kilobytes
+
+      - the percentage of its quota that its current  size
+        represents
+
+      - the percentage of the volume's disk partition that
+        is full.  This is usually unrelated to how much of
+        the  user's quota is used, since it depends on all
+        the volumes on the partition.  A large  value  may
+        nevertheless  prevent  a  user  from being able to
+        store more data on the partition.
+
+
+
+EXAMPLES
+
+   The following shows the output for the volume user.smith  in
+   the Transarc Corporation cell:
+
+       % fs lq /afs/transarc.com/usr/smith
+       Volume Name     Quota    Used    % Used   Partition
+       user.smith      15000    5071       34%         86%
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs diskfree
+
+   fs examine
+
+   fs quota
+
+   fs setquota
+
+   fs setvol
diff --git a/src/man/fs_lsmount.1 b/src/man/fs_lsmount.1
new file mode 100644 (file)
index 0000000..3404c96
--- /dev/null
@@ -0,0 +1,96 @@
+fs lsmount                 AFS Commands              fs lsmount
+
+
+NAME
+
+   fs  lsmount -- show  volume  for which directory is a mount
+
+                       point.
+
+
+                               +
+   fs lsmount  -dir <directory>   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                        +
+   fs ls  -d <directory>   [-h]
+
+DESCRIPTION
+
+   Outputs the name of the volume(s) for which  each  directory
+   is the root directory.  If directory is not a mount point or
+   is not in AFS, an error message appears.
+
+   The association between directory  and  a  volume  name  was
+   created with the fs mkmount command.
+
+ARGUMENTS
+
+   -dir  names the directory that serves as a mount point for a
+         volume.  The last element in  the  pathname  that  the
+         issuer  provides must be an actual name, not "dot" (.)
+         or "dot dot" (. .), which the fs  command  interpreter
+         does not understand in this case.
+
+   -help prints the online help entry for this command.  Do not
+         provide any other arguments or flags  with  this  one.
+         See  section  3.1  in  the  Reference  Manual for more
+         details.
+
+OUTPUT
+
+   The output is of the form:
+
+   'directory' is a mount point for volume 'volume name'
+
+   A  hash  sign  (#)  preceding  volume  name  indicates  that
+   directory is a regular mount point.
+
+   A  percent  sign  (%)  preceding  volume name indicates that
+   directory is a ReadWrite mount point.
+
+   If directory is a cellular mount point, then a cell name and
+   colon  precede  volume  name in addition to the hash sign or
+   percent sign.
+
+
+
+   If directory is not a mount point, the output reads:
+
+   'directory' is not a mount point.
+
+EXAMPLES
+
+   The following shows the mount point for the  home  directory
+   of user smith in the Transarc Corporation cell:
+
+       % fs ls /afs/transarc.com/usr/smith
+       '/afs/transarc.com/usr/smith' is a mount point for
+           volume '#user.smith'
+
+   The  following  shows  both  the regular and ReadWrite mount
+   points for the Transarc Corporation cell's root.cell volume.
+
+       % fs ls /afs/transarc.com
+       '/afs/transarc.com' is a mount point for volume '#ro
+
+       % fs ls /afs/.transarc.com
+       '/afs/.transarc.com' is a mount point for volume
+           '%root.cell'
+
+   The following shows  a  cellular  mount  point:  the  Andrew
+   cell's   root.cell   volume   as  mounted  in  the  Transarc
+   Corporation cell's tree.
+
+       % fs ls /afs/andrew.cmu.edu
+       '/afs/andrew.cmu.edu' is a mount point for volume
+           '#andrew.cmu.edu:root.cell'
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs mkmount fs rmmount
diff --git a/src/man/fs_mkmount.1 b/src/man/fs_mkmount.1
new file mode 100644 (file)
index 0000000..732b0df
--- /dev/null
@@ -0,0 +1,297 @@
+fs mkmount                 AFS Commands              fs mkmount
+
+
+NAME
+
+   fs mkmount -- create a mount point for a volume.
+
+
+   fs mkmount -dir <directory> -vol <volume name>  [-cell <cell
+   name>]    [-rw]  [-fast]  [-root]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs mk -d <directory> -v <volume name> [-c <cell name>]
+   [-rw]  [-f]  [-ro]  [-h]
+
+DESCRIPTION
+
+   Creates a mount point called directory for the volume volume
+   name.  The volume's root directory is also named  directory.
+   Mount  points look and act just like standard UNIX directory
+   structures, because when  the  Cache  Manager  encounters  a
+   mount point directory in a pathname, it knows to look in the
+   indicated volume for the elements listed under directory.
+
+   It is possible, although not  recommended,  to  create  more
+   than one mount point to a volume.
+
+   Types of mount points
+
+   There  are  several  types  of  mount  points, because mount
+   points can vary along three dimensions.  The following  will
+   discuss  the  three  dimensions in turn, explaining how they
+   affect the  Cache  Manager's  interpretation  of  the  mount
+   point.
+
+   Dimension 1: Volume Type
+
+   The   first   dimension   concerns   which  type  of  volume
+   (ReadWrite, ReadOnly or Backup) is named in the mount point.
+   ReadOnly and Backup volumes are distinguished by a .readonly
+   or .backup extension, respectively.    When  a  mount  point
+   names  a  volume  with  either  extension, the Cache Manager
+   accesses the specified volume  only,  ignoring  Dimension  2
+   (the mount point's type).  In other words, the Cache Manager
+   will never access the ReadWrite version of a volume  if  the
+   mount point explicitly names the ReadOnly or Backup version.
+   If the named ReadOnly or Backup volume is inaccessible,  the
+   Cache Manager reports an error.
+
+   If  the  volume name does not include a .backup or .readonly
+   extension, then the volume is ReadWrite.  The Cache  Manager
+   considers Dimension 2.
+
+   Dimension 2: Mount Point Type
+
+   Note:   This  dimension  is  relevant  only  if  the  volume
+   indicated in the mount point is ReadWrite.  Only Dimension 1
+   is relevant if the named volume is ReadOnly or Backup.
+
+   The second dimension concerns whether the mount point itself
+   is "regular" or "ReadWrite":
+
+      - When the Cache Manager encounters a regular  mount
+
+
+
+        point (one naming a ReadWrite volume), it tries to
+        access a copy of the volume that is of  same  type
+        (ReadWrite or ReadOnly) as the volume which houses
+        the mount point.  If there is  no  volume  of  the
+        same  type,  it  will  access  the  type  that  is
+        available.
+
+        Almost all mount points are of  this  type.    Its
+        advantage  is  that  the  Cache Manager is free to
+        access the most  readily  available  form  of  the
+        volume.    When  the  Cache  Manager  starts  in a
+        ReadOnly volume, this type of  mount  point  means
+        that  it traverses a "ReadOnly path," which can be
+        efficient because no callbacks are necessary.
+
+        The  issuer  creates  a  regular  mount  point  by
+        providing   only   the   required  -dir  and  -vol
+        arguments.
+
+      - When the  Cache  Manager  encounters  a  ReadWrite
+        mount   point,  it  accesses  only  the  ReadWrite
+        version of the indicated volume.    (This  assumes
+        that  the  volume  does  not  have  a  .backup  or
+        .readonly  extension.    Mounting  a   Backup   or
+        ReadOnly  volume  with  a ReadWrite mount point is
+        possible but unnecessary,  as  the  Cache  Manager
+        handles those volume types in the same way whether
+        their mount point is regular or  ReadWrite.    See
+        Dimension 1.)
+
+        A ReadWrite mount point is generally used to mount
+        only one volume in a cell: its root.cell volume at
+        the  second  level  in  the  file tree, just below
+        /afs.  Conventionally, root.cell is  also  mounted
+        with  a regular mount point at the same level. The
+        two  mount  points  are   distinguished   by   the
+        placement   of  a  period  at  the  start  of  the
+        ReadWrite mount point's  name  (see  the  EXAMPLES
+        section).    The  existence  of  a ReadWrite mount
+        point   for   root.cell    allows    the    system
+        administrator  to  switch  onto a "ReadWrite" path
+        and thus be  sure  he  or  she  is  accessing  the
+        ReadWrite   version  of  a  volume  when  that  is
+        important.
+
+        The issuer creates  a  ReadWrite  mount  point  by
+        adding the -rw flag.
+
+   Dimension 3: Cellular versus Local
+
+   The  third  dimension concerns which cell the volume resides
+   in.  A cellular mount point indicates to the  Cache  Manager
+   that  the  volume  resides  in a foreign cell (and specifies
+   which one).  If the mount point is not  cellular,  then  the
+   Cache  Manager  assumes  that the volume resides in the same
+   cell as the mount point does.
+
+   Normally, cellular mount points are used only at the  second
+   level  in a cell's file tree (i.e., at the "cell" level just
+   below /afs), to mount  the  root.cell  volumes  for  foreign
+   cells  that  are  to  be  visible  in the local cell.  It is
+
+
+
+   possible to create  cellular  mount  points  (mount  foreign
+   volumes)  at  other  levels  in  the  tree.  Doing so is not
+   recommended,  however,  as  it  can  make  it  difficult  to
+   determine which cell a given pathname leads to.
+
+   Cellular mount points can be either regular or ReadWrite:
+
+      - A  regular cellular mount point not only tells the
+        Cache Manager to cross into a  foreign  cell,  but
+        also   to  access  the  ReadOnly  version  of  the
+        indicated volume if possible.   The  advantage  is
+        that the Cache Manager traverses a "ReadOnly path"
+        in the foreign cell, even if the mount  point  for
+        the   indicated  volume  resides  in  a  ReadWrite
+        volume.  This is particularly useful when crossing
+        into foreign cells that are too small to replicate
+        their root.afs volume.
+
+        To create a  regular  cellular  mount  point,  the
+        issuer uses the -cell argument to specify the cell
+        name, and adds the -root flag.
+
+      - A ReadWrite cellular mount point tells  the  Cache
+        Manager  to  cross  into a foreign cell and access
+        the ReadWrite version of the volume (assuming that
+        the  volume  does  not have a .backup or .readonly
+        extension).  Use of this type of  mount  point  is
+        discouraged,  because  accessing ReadWrite volumes
+        means the File Server has to issue  callbacks,  an
+        extra  load  it is not fair to impose from outside
+        the  cell.    In  general,  only  a   cell's   own
+        administrators   need   to  access  the  ReadWrite
+        version of a volume.
+
+        To create a ReadWrite cellular  mount  point,  the
+        issuer uses the -cell argument to specify the cell
+        name, and adds  both  the  -root  and  -rw  flags.
+        Because  this is not recommended, no example of it
+        appears below.
+
+   Mounting foreign volumes in foreign cells
+
+   In addition to mounting  volumes  in  the  local  cell,  the
+   fs mkmount  allows a user who possesses the necessary access
+   rights in a foreign cell to create a  regular,  non-cellular
+   mount point in a foreign cell's file tree while working on a
+   machine in his or her local  cell.    In  other  words,  the
+   issuer can mount a volume from a foreign cell in that cell's
+   file space as though he or she were working at a machine  in
+   that cell.
+
+   To  mount a foreign volume in foreign cell, specify the cell
+   name with -cell, but do not use the -root flag.
+
+
+
+   Distinguishing the types of mount points
+
+   The output of fs lsmount uses various symbols to distinguish
+   the different types of mount points.  See the Output section
+   of that command's description.
+
+ARGUMENTS
+
+   -dir  names the directory to be created as a mount point  to
+         the  named  volume.   It should not already exist.  If
+         the issuer does not  specify  a  pathname,  the  mount
+         point  is  created  as  a  subdirectory of the current
+         working directory.
+
+   -vol  names the volume to be mounted.  Add the .readonly  or
+         .backup  extension  if  appropriate.   The volumeID is
+         also acceptable.
+
+         Note: When creating a cellular  mount  point,  do  not
+         specify the cell name as part of this argument, as was
+         necessary in previous versions of  AFS  that  did  not
+         have  the -root flag.  Instead, include the -root flag
+         and use the -cell argument to specify the  cell  name;
+         the command interpreter will automatically prepend the
+         cell name to the volume name, separating them  with  a
+         colon.
+
+   -cell names  the  cell  in  which  the volume resides.  When
+         creating a cellular mount point, combine this argument
+         with  the  -root flag.  When mounting a foreign volume
+         in a foreign cell, use this argument alone.
+
+   -rw   designates the mount point as ReadWrite, which  forces
+         the Cache Manager to access only the ReadWrite copy of
+         a volume that does not have  a  .backup  or  .readonly
+         extension.    Without  this  flag,  the mount point is
+         regular.
+
+   -fast indicates that the VL Server  should  not  check  that
+         there  is  a  VLDB entry for the volume to be mounted.
+         By default, the VL Server  does  check  and  prints  a
+         warning  message  if there is no VLDB entry; the mount
+         point is created in any case.
+
+   -root creates a cellular mount point.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+EXAMPLES
+
+   Note:    These  examples  illustrate  only  the  recommended
+   combinations and use of arguments.  The  OUTPUT  section  of
+   fs lsmount's  description  shows what each mount point looks
+   like.
+
+   The following creates a regular  mount  point.    It  mounts
+   user.smith at /afs/transarc.com/usr/smith.
+
+
+
+   % cd /afs/transarc.com/usr  % fs mk smith user.smith
+
+
+
+   The  following  creates  both  a ReadWrite and regular mount
+   point for the Transarc Corporation cell's root.cell  volume,
+   in  that  cell's  file  tree.   It follows the convention of
+   putting a period at the beginning  of  the  ReadWrite  mount
+   point's name.
+
+   % fs mk /afs/transarc.com root.cell  % fs mk
+   /afs/.transarc.com root.cell -rw
+
+   The  following  mounts  the  root.cell  volume  belonging to
+   Carnegie Mellon University's Andrew  cell  in  the  Transarc
+   Corporation  cell's  file tree, creating a regular, cellular
+   mount  point  called  andrew.cmu.edu.    When   a   Transarc
+   Corporation  Cache  Manager  encounters this mount point, it
+   will cross into the Andrew cell on a ReadOnly path.
+
+   % fs mk /afs/andrew.cmu.edu root.cell -c andrew.cmu.edu
+   -root
+
+   The following illustrates the creation of a mount point in a
+   foreign  cell,  using  Transarc  Corporation's  regular cell
+   (transarc.com)  as  the  local  cell  and  its   test   cell
+   (test.transarc.com) as the foreign cell.  Suppose that while
+   working on a machine belonging to the transarc.com  cell,  a
+   Transarc Corporation user wants to mount a test.transarc.com
+   volume            called            user.test5            at
+   /afs/test.transarc.com/usr/test5.    She  has the INSERT and
+   ADMINISTER rights for /afs/test.transarc.com/usr.  Note that
+   the effect is just the same as if the issuer were working on
+   a  machine  belonging  to  the  test.transarc.com  cell  and
+   omitted the -c test.transarc.com part of the command.
+
+   % cd /afs/test.transarc.com/usr  % fs mk test5 user.test5 -c
+   test.transarc.com
+
+PRIVILEGE REQUIRED
+
+   Issuer  must  have  INSERT  and  ADMINISTER  access  for the
+   directory that is to contain the mount point.
+
+MORE INFORMATION
+
+   fs lsmount fs rmmount
diff --git a/src/man/fs_monitor.1 b/src/man/fs_monitor.1
new file mode 100644 (file)
index 0000000..4dc55dd
--- /dev/null
@@ -0,0 +1,125 @@
+fs monitor                 AFS Commands              fs monitor
+
+
+NAME
+
+   fs  monitor -- direct  reports  on  file system activity to
+
+                       specified  machine,  or  report  current
+                       monitoring machine.
+
+
+   fs monitor [-server <host name> or <off>]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs mo [-s <host name> or <off>]  [-h]
+
+DESCRIPTION
+
+   Depending   on  whether  the  issuer  provides  the  -server
+   argument, and its value when provided:
+
+   EITHER sets where the Cache Manager sends messages about
+   file system activity (including its transactions with the Fi
+
+   OR disables message sending
+
+   OR reports the current destination for messages.
+
+   The messages are of  a  less  technical  nature  than  those
+   generated by the fs debug command.  They are at the level of
+   file fetches and stores.
+
+   In order for the messages to  be  displayed,  the  specified
+   destination  machine  must  be  running a monitoring program
+   that "listens" to the correct UDP socket. If the destination
+   machine is not running such a program, then the messages are
+   lost.
+
+WARNING
+
+   The effect of this command endures  even  after  the  issuer
+   logs out.  See the EXAMPLE section below.
+
+   Transarc  Corporation  does not provide a monitoring program
+   appropriate for use with this command, but such  a  program,
+   called "Console", is available as part of the Andrew Toolkit
+   developed  at  Carnegie  Mellon   University's   Information
+   Technology Center.
+
+   If no monitoring program is available, it is best to provide
+   a value of off for -server.
+
+
+
+ARGUMENTS
+
+   -server has two legal values: off or  a  machine  name  host
+           name.
+
+           If  set  to  off,  then  the  Cache Manager does not
+           generate any reports on  its  role  in  file  system
+           activities.    This  setting  is  recommended if the
+           machine is not running a monitoring program  capable
+           of   intercepting   and   displaying   the  messages
+           produced.
+
+           The issuer may otherwise specify a machine name host
+           name  to which the Cache Manager will send messages.
+           The host name  must  be  a  complete  Internet-style
+           machine  name,  and  a  monitoring program should be
+           running on the machine.    If  no  such  program  is
+           running, the messages will simply be lost.
+
+           If  the  issuer  does not provide this argument, the
+           current monitor setting is displayed.
+
+   -help   prints the online help entry for this command.    Do
+           not  provide  any other arguments or flags with this
+           one.  See section 3.1 in the  Reference  Manual  for
+           more details.
+
+OUTPUT
+
+   When  no  arguments are provided, the output will report the
+   name of the machine to which monitoring messages  are  being
+   sent:
+
+       Using host machine for monitor services.
+
+   If monitoring is disabled, the output reports
+
+       Cache monitoring is currently disabled.
+
+EXAMPLES
+
+   The  following shows that monitoring messages are being sent
+   to machineQ.transarc.com.
+
+       % fs mo
+       Using host machineQ.transarc.com for monitor service
+
+   The following  sets  the  machine's  monitoring  machine  to
+   machineB.transarc.com.
+
+       % fs monitor machineB.transarc.com
+       fs: new monitor host set.
+
+   As  an  example  of  the "lingering" effect of this command,
+   suppose that a user working on machineA.transarc.com  issues
+   the  example  command, and then logs out.  When another user
+   logs on to machineA, he or she will  not  see  any  messages
+   about  file system activity; instead, users of machineB will
+   continue to see messages from  both  machineB  (their  local
+   machine)  and machineA (the remote machine).  To avoid this,
+   the original user on machineA should  issue  the  fs monitor
+
+
+
+   command again before logging out, specifying host name to be
+   machineA.transarc.com.
+
+PRIVILEGE REQUIRED
+
+   None.
diff --git a/src/man/fs_newcell.1 b/src/man/fs_newcell.1
new file mode 100644 (file)
index 0000000..7e0e217
--- /dev/null
@@ -0,0 +1,87 @@
+fs newcell                 AFS Commands              fs newcell
+
+
+NAME
+
+   fs   newcell -- change   list  of  cell's  database  server
+
+                       machines in kernel.
+
+
+                                                          +
+   fs newcell -name <cell name> -servers <primary servers> 
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                                           +
+   fs n -n <cell name> -s <primary servers>   [-h]
+
+DESCRIPTION
+
+   Removes the Cache Manager's kernel-resident list of database
+   server  machines  for  the cell cell name, replacing it with
+   primary servers.
+
+   This  command  does  not  make  permanent  changes  in   the
+   workstation's /afs/vice/etc/CellServDB file, the contents of
+   which are transferred into the kernel at each  reboot.    In
+   other  words,  rebooting  the workstation will overwrite the
+   changes made with this command, unless  the  issuer  changes
+   CellServDB in the same way.
+
+   Changes  made  with  this command do appear in the output of
+   fs listcells, since that command consults the in-kernel list
+   rather than CellServDB.
+
+   This  command may be used to introduce a completely new cell
+   into the kernel-resident list, but it  is  not  possible  to
+   make  a cell inaccessible with this command (i.e., remove it
+   from the kernel-resident list by not providing any instances
+   for  -server).    To do that, the user must alter CellServDB
+   and reboot the machine.
+
+WARNING
+
+   Some commands work correctly only when both  CellServDB  and
+   the  kernel-resident  list  correctly list a cell's database
+   server machines.  The need  of  such  commands  for  correct
+   information  in  CellServDB  precludes  use of this command.
+   The klog command is a prominent example.
+
+ARGUMENTS
+
+   -name   is the complete Internet-style name of the cell  for
+           which the in-kernel list of database server machines
+           will change.  It may be the local cell or a  foreign
+           cell.
+
+   -servers
+           names the database server machine(s) for the cell in
+           question.     Provide  the  complete  Internet-style
+           machine name for each machine.
+
+   -help   prints the online help entry for this command.    Do
+
+
+
+           not  provide  any other arguments or flags with this
+           one.  See section 3.1 in the  Reference  Manual  for
+           more details.
+
+EXAMPLES
+
+   The  following changes the machine's kernel-resident list of
+   database server machines for the Transarc  Corporation  cell
+   to include fs1.transarc.com and fs2.transarc.com.
+
+   % fs n transarc.com fs1.transarc.com fs2.transarc.com
+
+PRIVILEGE REQUIRED
+
+   Issuer  must  be logged in as "root" in the UNIX file system
+   of the machine on which the command is being issued.
+
+MORE INFORMATION
+
+   fs listcells
diff --git a/src/man/fs_quota.1 b/src/man/fs_quota.1
new file mode 100644 (file)
index 0000000..9c61fce
--- /dev/null
@@ -0,0 +1,78 @@
+fs quota                   AFS Commands                fs quota
+
+
+NAME
+
+   fs   quota -- show   percent   of  quota  used  for  volume
+
+                       containing directory/file.
+
+
+                                   +
+   fs quota  [-path <dir/file path> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                            +
+   fs q  [-p <dir/file path> ]  [-h]
+
+DESCRIPTION
+
+   Displays the percent of maximum quota currently used by  the
+   volume that contains each specified directory or file.  This
+   is the  least  informative  but  quickest  fs  command  that
+   provides  quota  information about a volume.  The fs examine
+   and fs listquota commands provide more complete information.
+
+   The system administrator may set quota with the fs  setquota
+   or fs setvol command.
+
+ARGUMENTS
+
+   -path specifies  each  file and/or directory for which quota
+         information about the host volume is desired.  If  the
+         issuer  omits  this argument, the current directory is
+         assumed.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+OUTPUT
+
+   The  output  reports the percent of quota used.  It does not
+   name the host volume.
+
+EXAMPLES
+
+   The following lists the percent quota  used  of  the  volume
+   housing the current working directory:
+
+       % fs quota
+       17% of quota used.
+
+
+
+   The  following  lists  the  percent  quota  used of both the
+   volume  housing  the  current  working  directory's   parent
+   directory   and  the  volume  housing  the  directory  named
+   /afs/transarc.com/usr/smith:
+
+       % fs quota .. /afs/transarc.com/usr/smith
+       43% of quota used.
+       92% of quota used.
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs examine
+
+   fs listquota
+
+   fs setquota
+
+   fs setvol
diff --git a/src/man/fs_rmmount.1 b/src/man/fs_rmmount.1
new file mode 100644 (file)
index 0000000..b465c4b
--- /dev/null
@@ -0,0 +1,52 @@
+fs rmmount                 AFS Commands              fs rmmount
+
+
+NAME
+
+   fs rmmount -- destroy mount point.
+
+
+                              +
+   fs rmmount -dir <directory>   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                        +
+   fs rm  -d <directory>   [-h]
+
+DESCRIPTION
+
+   Removes  the  mount  point  called  directory  from the file
+   system.  The corresponding volume remains in the system, but
+   will  be inaccessible if there are no other mount points for
+   it.
+
+ARGUMENTS
+
+   -dir  names the mount point to  be  deleted  from  the  file
+         system.  The  last  element  in  the pathname that the
+         issuer provides must be an actual name, not "dot"  (.)
+         or  "dot  dot" (. .), which the fs command interpreter
+         does not understand in this case.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+EXAMPLES
+
+   The  following removes the mount points jones and terry from
+   the   current    working    directory    (assume    it    is
+   /afs/transarc.com/usr).
+
+   % fs rm jones terry
+
+PRIVILEGE REQUIRED
+
+   Issuer  must have DELETE access for the directory containing
+   the mount point.
+
+MORE INFORMATION
+
+   fs lsmount fs mkmount
diff --git a/src/man/fs_setacl.1 b/src/man/fs_setacl.1
new file mode 100644 (file)
index 0000000..b016c98
--- /dev/null
@@ -0,0 +1,204 @@
+fs setacl                  AFS Commands               fs setacl
+
+
+NAME
+
+   fs setacl -- sets access control list for a directory.
+
+
+                              +                           +
+   fs setacl  -dir <directory>  -acl <access list entries> 
+   [-clear]
+   [-negative]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                       +                         +
+   fs sa -d <directory>  -a <access list entries>  [-c] [-n]
+   [-h]
+
+DESCRIPTION
+
+   Puts the specified access list entries on the access control
+   list (ACL) of each specified directory.
+
+WARNING
+
+   If the ACL already grants certain rights to a user or group,
+   the  rights specified with access list entries replace them,
+   rather than just being added to them.
+
+   Setting negative rights is  generally  unnecessary  and  not
+   recommended.    Simply  omitting  a  user  or group from the
+   Normal rights list is normally adequate to  prevent  access.
+   In  particular,  note  that it is futile to deny rights that
+   are granted to system:anyuser on the same ACL; all the  user
+   needs to do is issue the unlog command to receive the denied
+   rights.
+
+ARGUMENTS
+
+   -dir            specifies  each  directory  for  which   the
+                   access    control   list   is   to   change.
+                   Abbreviated   pathnames   are    interpreted
+                   relative  to  the  directory  in  which  the
+                   command is issued.
+
+   -acl            defines a list of one or more entries,  each
+                   of which specifies
+
+                      - a user name or group name (letters
+                        all lowercase)
+
+                      - the   access   right(s)   to    be
+                        associated with the user/group
+
+                   in  that  order, separated by a space.  This
+                   argument is unusual in requiring  two  parts
+                   for    each    instance.      The   accepted
+                   abbreviation of each right and  the  meaning
+                   of the right follows:
+
+                   r    READ.  Allows the possessor to read the
+                        contents of files in the directory  and
+                        to  "stat"  (issue  ls -l for) file and
+
+
+
+                        subdirectory elements in the directory.
+
+                   w    WRITE.   Allows the possessor to modify
+                        the contents of files in the  directory
+                        and to change their UNIX mode bits with
+                        chmod.
+
+                   l    LOOKUP.  Allows the possessor  to  list
+                        the  names  of files and subdirectories
+                        in  the  directory  (for  example,   by
+                        issuing  ls).  The possessor may "stat"
+                        (issue ls -l for) the directory  itself
+                        (but  not  for files and subdirectories
+                        in it) and may examine the  directory's
+                        ACL.
+
+                   d    DELETE.  Allows the possessor to remove
+                        files from the directory.
+
+                   i    INSERT.  Allows the possessor to create
+                        new  files  in  the  directory  or move
+                        existing files into it.
+
+                   k    LOCK.   Allows  the  possessor  to  run
+                        programs that need to issue the "flock"
+                        system call on files in the  directory.
+
+                   a    ADMINISTER.    Allows  the possessor to
+                        change the directory's ACL.
+
+                   A, B, C, D, E, F, G, H;  by  default,  these
+                        have   no   meaning   to   AFS   server
+                        processes.        Administrators    and
+                        application    programs    may   assign
+                        meanings to them and place them on ACLs
+                        to  control  access  to the directory's
+                        contents in new ways.  The letters must
+                        be uppercase.
+
+                   all  all seven standard rights (rlidwka).
+
+                   none no rights.  Removes the user/group from
+                        the ACL, but  may  not  guarantee  they
+                        have no rights if they belong to groups
+                        that remain on the ACL.
+
+                   read both r and l.
+
+                   write
+                        all  rights except ADMINISTER (rlidwk).
+
+                   It is legal to mix  the  individual  letters
+                   and  the  words  within access list entries,
+                   but not  within  an  individual  pairing  of
+                   user/group and rights.
+
+   -clear          removes  all existing entries on each access
+                   control  list  before  placing  access  list
+                   entries  on  it.    This should be used with
+                   caution:  if access list  entries  does  not
+                   grant   all  rights  to  the  owner  of  the
+
+
+
+                   directory, it can  become  awkward  for  the
+                   owner  to access items in the directory.  In
+                   particular,  not  having  the  LOOKUP  right
+                   makes it impossible to resolve the "dot" ( .
+                   ) and "dot dot"  (  .  .  )  shorthand  from
+                   within the directory.
+
+   -negative       puts  the  specified  access list entries in
+                   the Negative rights section of  each  access
+                   control   list.    The  user/group  is  thus
+                   explicitly denied the indicated rights, even
+                   if entries on the accompanying Normal rights
+                   section of the  access  control  list  grant
+                   them  rights.    However,  it is possible to
+                   unlog   to   obtain   rights   granted    to
+                   system:anyuser  on the Normal rights section
+                   of the same ACL; see the WARNING above.
+
+                   This flag affects all directories and access
+                   list  entries  specified.    Its  use is not
+                   recommended; see the WARNING section  above.
+                   If  the  issuer  omits this flag, the access
+                   list  entries  go  into  the   Normal rights
+                   section of the access control list.
+
+   -help           prints   the  online  help  entry  for  this
+                   command.  Do not provide any other arguments
+                   or  flags with this one.  See section 3.1 in
+                   the Reference Manual for more details.
+
+EXAMPLES
+
+   The following example adds two entries to the  Normal rights
+   part of the current working directory's ACL: the first entry
+   grants READ and LOOKUP  rights  to  pat:friends,  while  the
+   other  (using  the  write shorthand) gives all rights except
+   ADMINISTER to smith.
+
+   % fs sa . pat:friends rl smith write
+
+   The following shows the effect of the -clear flag on the ACL
+   of  the  subdirectory  reports by showing the ACL before and
+   after the command is issued:
+
+   % fs la reports  Access list for reports is  Normal rights:
+   system:authuser rl     pat:friends rlid     smith rlidwk
+   pat rlidwka  Negative rights:     terry rl
+
+   % fs sa -clear reports pat all smith write system:anyuser rl
+   % fs la reports  Access list for reports is  Normal rights:
+   system:anyuser rl     smith rlidwk     pat rlidwka
+
+
+
+   The following shows how  the  -dir  and  -acl  switches  are
+   necessary  when  more  than one directory is specified.  The
+   new entry  granting  READ,  LOOKUP,  and  INSERT  rights  to
+   pat:friends  is  added  to  the  ACL  for  both  the current
+   directory and its public subdirectory.
+
+   % fs sa -d . public -a pat:friends rli
+
+PRIVILEGE REQUIRED
+
+   Issuer must have ADMINISTER rights  to  the  directory;  the
+   directory's   owner  and  members  of  system:administrators
+   always do.
+
+MORE INFORMATION
+
+   fs copyacl
+
+   fs listacl
diff --git a/src/man/fs_setcachesize.1 b/src/man/fs_setcachesize.1
new file mode 100644 (file)
index 0000000..1e84e94
--- /dev/null
@@ -0,0 +1,97 @@
+fs setcachesize            AFS Commands         fs setcachesize
+
+
+NAME
+
+   fs setcachesize -- set size of disk cache.
+
+
+   fs setcachesize [-blocks <size in 1K byte blocks>]  [-reset]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs setca [-b <size in 1K byte blocks>]  [-r]  [-h]
+
+   fs cachesize [-b <size in 1K byte blocks>]  [-r]  [-h]
+
+DESCRIPTION
+
+   On  machines using a disk cache, changes the amount of local
+   disk space that the Cache  Manager  may  use  for  its  data
+   cache.  Specify the number in kilobyte blocks.  This command
+   is not operative on machines using memory caching.
+
+   To return the cache size to the default value  specified  in
+   /usr/vice/etc/cacheinfo  on the client's local disk, specify
+   0 as the number of kilobyte blocks.  The cacheinfo  file  is
+   human-readable  and visible with the cat command.  The third
+   and final field is the number of kilobyte  blocks  allocated
+   to  the  cache  at  reboot.    The chapter in the AFS System
+   Administrator's  Guide  on  client   machine   configuration
+   further describes the contents of cacheinfo.
+
+   To  return  the cache size to the value set when the machine
+   was last booted, use the -reset flag instead of the  -blocks
+   argument.     This  is  normally  the  amount  specified  in
+   cacheinfo, unless the -blocks argument was used on  afsd  to
+   override the cacheinfo value.
+
+   The  fs getcacheparms  command  displays  the current actual
+   cache size and the amount of space in use, both for disk and
+   memory caches.
+
+WARNINGS
+
+   This  command  is  not  operative  on  machines using memory
+   caching, and will result in an error message.
+
+   On machines using a disk cache, do not set the cache size to
+   exceed  90% of the actual disk space available for the cache
+   directory.  The cache implementation itself requires a small
+   amount of room on the partition.
+
+ARGUMENTS
+
+   -blocks
+         specifies the number of 1 kilobyte  blocks  the  Cache
+         Manager  may  devote to the cache.  Specifying a value
+         of "0" sets cache size to  the  default  specified  in
+         cacheinfo.    This  implies that the smallest possible
+         cache size is 1 kilobyte, not 0.
+
+   -reset
+         returns  the  cache  size  to  the  value set when the
+
+
+
+         machine was last booted.  This agrees with  the  value
+         in  cacheinfo  unless the -blocks argument was used on
+         afsd.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+EXAMPLES
+
+   The  following  sets  the  disk cache size to 25000 kilobyte
+   blocks.
+
+   %  fs setca 25000
+
+   Both of the following reset the disk cache size to the value
+   in cacheinfo, assuming that the -blocks argument on afsd was
+   not used.
+
+   %  fs setcachesize 0  %  fs setca -r
+
+PRIVILEGE REQUIRED
+
+   Issuer must be logged in as "root" in the UNIX  file  system
+   of the machine on which the command is being issued.
+
+MORE INFORMATION
+
+   fs getcacheparms
diff --git a/src/man/fs_setcell.1 b/src/man/fs_setcell.1
new file mode 100644 (file)
index 0000000..9dc66be
--- /dev/null
@@ -0,0 +1,81 @@
+fs setcell                 AFS Commands              fs setcell
+
+
+NAME
+
+   fs  setcell -- allow or disallow running of setuid programs
+
+                       from specified cells.
+
+
+                                +
+   fs setcell  -cell <cell name>   [-suid]  [-nosuid]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                           +
+   fs setce  -c <cell name>   [-s]  [-n]  [-h]
+
+DESCRIPTION
+
+   Determines whether the  workstation  allows  programs  whose
+   binary  files  reside in the indicated cells to execute with
+   setuid privilege.  By default, programs originating  in  the
+   local cell (as determined by /usr/vice/etc/ThisCell) may run
+   with setuid privilege, but programs originating  in  foreign
+   cells may not.  Use the fs getcellstatus command to displays
+   a cell's current status in this respect.
+
+   Include the -suid flag with the command  to  allow  programs
+   from  the  specified cells to execute with setuid privilege;
+   include the  -nosuid  flag  with  the  command  to  prohibit
+   programs from the specified cells from executing with setuid
+   privilege.  Use either the -suid flag or the  -nosuid  flag.
+   Omit both flags to prevent programs from the specified cells
+   from executing with setuid privilege.
+
+ARGUMENTS
+
+   -cell           names each  cell  from  which  to  allow  or
+                   disallow  programs  to  execute  with setuid
+                   privilege.  Provide the  complete  Internet-
+                   style  cell  name  of  each cell (unlike the
+                   -cell argument common to many commands,  the
+                   cell  argument  of  this  command  does  not
+                   accept abbreviated cell names).
+
+   -suid           allows programs from cell  name  to  execute
+                   with   setuid  privilege.    Provide  it  or
+                   provide -nosuid.  Omit both flags to prevent
+                   programs  from cell name from executing with
+                   setuid privilege.
+
+   -nosuid         prevents  programs  from  cell   name   from
+                   executing with setuid privilege.  Provide it
+                   or  provide  -suid.    Omit  both  flags  to
+                   prevent   programs   from   cell  name  from
+                   executing with setuid privilege.
+
+   -help           prints  the  online  help  entry  for   this
+                   command.  Do not provide any other arguments
+                   or flags with this one.  See section 3.1  in
+                   the Reference Manual for more details.
+
+EXAMPLES
+
+
+
+   The  following enables programs whose binary files reside in
+   the Transarc Cell to execute with setuid  privilege  in  the
+   local cell:
+
+   % fs setc transarc.com -s
+
+PRIVILEGE REQUIRED
+
+   Issuer  must  be logged in as "root" in the UNIX file system
+   of the machine on which the command is issued.
+
+MORE INFORMATION
+
+   fs getcellstatus
diff --git a/src/man/fs_setquota.1 b/src/man/fs_setquota.1
new file mode 100644 (file)
index 0000000..70e1e3b
--- /dev/null
@@ -0,0 +1,73 @@
+fs setquota                AFS Commands             fs setquota
+
+
+NAME
+
+   fs  setquota -- sets  maximum  quota  for volume containing
+
+                       specified directory.
+
+
+   fs setquota  [-path <dir/file path>]  -max <max quota in
+   kbytes>  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs sq  [-p <dir/file path>]  -m <max quota in kbytes>  [-h]
+
+DESCRIPTION
+
+   Sets the maximum size quota for the volume that contains the
+   specified  directory  or  file.    The  fs  examine  and  fs
+   listquota commands show the current maximum quota.   The  fs
+   quota command shows the percent of maximum quota used.
+
+   The  fs  setvol  command  can  be  used  to set the quota on
+   multiple volumes at once.  It can also  be  used  to  create
+   messages associated with the volumes.
+
+ARGUMENTS
+
+   -path           names  the directory or file for which quota
+                   on the host volume is to be set.    If  this
+                   argument  is  omitted,  the  current working
+                   directory is used; in this  case,  the  -max
+                   switch must be used.
+
+   -max            specifies  the  maximum amount of disk space
+                   the volume can use.  Express it in  kilobyte
+                   blocks (a value of 1024 is one megabyte).  A
+                   value of 0 grants an  unlimited  quota,  but
+                   the  size  of the disk partition that houses
+                   the volume places an absolute limit  on  the
+                   volume's maximum size.
+
+   -help           prints   the  online  help  entry  for  this
+                   command.  Do not provide any other arguments
+                   or  flags with this one.  See section 3.1 in
+                   the Reference Manual for more details.
+
+EXAMPLES
+
+   The following imposes a maximum quota of 3000  kilobytes  on
+   the      volume      that      houses      the     directory
+   /afs/transarc.com/usr/smith:
+
+   % fs sq /afs/transarc.com/usr/smith 3000
+
+PRIVILEGE REQUIRED
+
+   Issuer must belong to the system:administrators group in the
+   Protection Database.
+
+MORE INFORMATION
+
+
+
+   fs examine
+
+   fs listquota
+
+   fs quota
+
+   fs setvol
diff --git a/src/man/fs_setserverprefs.1 b/src/man/fs_setserverprefs.1
new file mode 100644 (file)
index 0000000..ced4a6c
--- /dev/null
@@ -0,0 +1,232 @@
+fs setserverprefs          AFS Commands       fs setserverprefs
+
+
+NAME
+
+   fs  setserverprefs -- set  Cache  Manager's preferences for
+
+                       file server machines.
+
+
+                                                       +
+   fs setserverprefs  [-servers <machine name and rank> ]
+   [-file <dir/file path>]  [-stdin]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                                        +
+   fs sets  [-se <machine name and rank> ]  [-f <dir/file
+   path>]
+   [-st]  [-h]
+                                      +
+   fs sp  [-se <machine name and rank> ]  [-f <dir/file path>]
+        [-st]  [-h]
+
+DESCRIPTION
+
+   Sets the Cache Manager's preference for  one  or  more  file
+   server  machines.  Each Cache Manager stores a table of file
+   server machines and their respective "ranks."  A file server
+   machine's  rank  is an integer in the range from 1 to 65,534
+   that determines the Cache Manager's preference for selecting
+   the  server  machine  when  the  Cache Manager must access a
+   ReadOnly replica that resides on it.  Ranks bias  the  Cache
+   Manager  to  prefer  to  access  replicas  on  "near" server
+   machines rather than those on "distant" server machines.
+
+   When the Cache Manager needs to access a  ReadOnly  replica,
+   it  first  contacts  the  Volume  Location  (VL)  Server  to
+   ascertain the names of the file server machines on which the
+   replica  resides.    It  then  checks  its internal table to
+   determine the rank associated with each of the  file  server
+   machines.    After  comparing  the ranks of the machines, it
+   attempts to access the replica on the  server  machine  that
+   has the lowest integer rank.
+
+   If  the  Cache  Manager  cannot  access  the  replica on the
+   machine with the lowest rank (possibly because of  a  server
+   process,  machine, or network outage), it attempts to access
+   the replica on the machine with the next lowest  rank.    It
+   continues  in  this way until it either accesses the replica
+   or determines that all of the file server machines on  which
+   the replica is housed are unavailable.
+
+   Each time it is initialized with the afsd command, the Cache
+   Manager assigns preferences to any database server  machines
+   listed  in  the local /usr/vice/etc/CellServDB file that are
+   also file server machines.  It  stores  the  preferences  as
+   machine  IP  addresses and associated ranks in the kernel of
+   the  client  machine.    (See  the  DETERMINING  PREFERENCES
+   section  for  more  information  about how the Cache Manager
+   determines actual file server machine ranks.)  Because  they
+   are  stored  in the kernel, the preferences are recalculated
+   when the client machine is rebooted.
+
+   The Cache Manager assigns ranks to file server  machines  in
+
+
+
+   the local cell and from foreign cells as necessary.  When it
+   needs to access a ReadOnly volume, it first  determines  the
+   machines  on  which  the  replica  resides.  It then assigns
+   ranks to any of the machines that do not already  have  them
+   and  stores the ranks in the kernel, after which it uses the
+   ranks as the basis of  its  selection  of  the  file  server
+   machine from which to access the replica.
+
+   The  fs  setserverprefs  command  can  be  used to define or
+   change the rank associated with  a  local  or  foreign  file
+   server  machine.    If the Cache Manager has no rank for the
+   machine, the command defines the machine's initial rank.  If
+   the  Cache  Manager  already has a rank for the machine, the
+   command changes the rank to match the one specified  by  the
+   issuer; the old rank is overwritten.
+
+   Preferences  are  specified  as  pairs of values.  The first
+   value is the file server machine, the second  the  machine's
+   rank.    File server machines can be specified by name or by
+   IP address.  Depending on the naming  service  available  at
+   the time the command is issued, abbreviated forms of machine
+   names may be allowed.    See  the  introductory  About  This
+   Manual chapter for more information.
+
+   Pairs  of  file  server  machines  and  their  ranks  can be
+   specified
+
+      - on the command line with the -servers switch
+
+      - from a file with the -file switch
+
+      - from stdin with the -stdin flag
+
+   The -file switch and -stdin flag are especially  useful  for
+   configuring  multiple Cache Managers in a cell with the same
+   preferences.  The -file switch can be  used  to  indicate  a
+   file created manually or generated automatically with the fs
+   getserverprefs command.  Similarly, the -stdin flag  can  be
+   used  to  accept  preferences  piped  directly  from another
+   process (possibly from another Cache  Manager  with  the  fs
+   getserverprefs  command).    The -servers, -file, and -stdin
+   switches and flag are not mutually  exclusive,  so  multiple
+   sources of preferences are permitted.
+
+   It is possible for the Cache Manager or a user to assign the
+   same rank to multiple file server machines housing a replica
+   of  the  same  volume.  In this case, the Cache Manager uses
+   methods  described  in  the  following  section,   ASSIGNING
+   PREFERENCES, to break the tie.  It then increments the ranks
+   of the file server machines from which it  does  not  access
+   the replica.
+
+ASSIGNING PREFERENCES
+
+   When  initially  assigning  preferences,  the  Cache Manager
+   bases the ranks on  IP  addresses,  rather  than  on  actual
+   physical  considerations  such  as location or distance.  It
+   calculates  file  server  machine  ranks  according  to  the
+   following heuristic:
+
+      - If  the  client  machine  is  also  a  file server
+
+
+
+        machine, the machine receives a rank of 5000.
+
+      - If the client machine is in  a  subnet,  all  file
+        server  machines  in the same subnet as the client
+        machine receive an initial rank of 20000.
+
+      - All file server machines in the  same  network  as
+        the  client  machine  receive  an  initial rank of
+        30000.
+
+      - All file server machines on the  distant  ends  of
+        point-to-point   links  from  the  client  machine
+        receive an initial rank of 30000.
+
+      - All file server machines on networks not  directly
+        connected  to the client machine receive a rank of
+        40000.
+
+      - All file server  machines  for  which  no  network
+        locality  information  can be determined receive a
+        default rank of 40000.
+
+   The  Cache  Manager  also   considers   additional   metrics
+   associated  with  networks,  subnets, and interfaces when it
+   determines ranks.
+
+   If the same ReadOnly replica  is  stored  on  multiple  file
+   server  machines  that have the same rank, the Cache Manager
+   employs the metrics  mentioned  previously  to  resolve  the
+   duplicate  rank collisions.  If necessary, the Cache Manager
+   randomizes its ranking of the tied machines.    It  resolves
+   the  ties internally by incrementing by one the ranks of the
+   machines from which it chooses not to access the replica.
+
+NOTE
+
+   The Cache Manager consults preferences only  when  accessing
+   ReadOnly  replicas  of  volumes.    It does not consider the
+   preferences when contacting the  VL  Server  on  a  database
+   server  machine  to determine the location of a volume.  Its
+   access of database server machines is still random.
+
+ARGUMENTS
+
+   -servers        specifies one or more pairs of  file  server
+                   machines   and   their   respective   ranks.
+                   Identify file server machines by name or  by
+                   IP address.  See the DESCRIPTION section for
+                   more information on specifying  file  server
+                   machines and their ranks.
+
+   -file           specifies   the  pathname  of  a  file  that
+                   contains pairs of file server  machines  and
+                   their   respective  ranks.    Identify  file
+                   server machines by name or  by  IP  address.
+                   See   the   DESCRIPTION   section  for  more
+                   information  on   specifying   file   server
+                   machines and their ranks.
+
+   -stdin          indicates that pairs of file server machines
+                   and their respective ranks are  to  be  read
+
+
+
+                   from  stdin.   Identify file server machines
+                   by  name  or  by  IP  address.     See   the
+                   DESCRIPTION  section for more information on
+                   specifying file server  machines  and  their
+                   ranks.
+
+   -help           prints   the  online  help  entry  for  this
+                   command.  Do not provide any other arguments
+                   or  flags with this one.  See section 3.1 in
+                   the Reference Manual for more details.
+
+EXAMPLES
+
+   The following sets preference ranks for  three  file  server
+   machines.    In  this  example,  the server machines have no
+   replicas  in  common,  so  no   potential   collisions   are
+   associated with their all having the same rank.
+
+   % fs sets -se fs1.transarc.com 10000 fs2.transarc.com 10000
+   \     128.2.11.12 10000
+
+   The  following  defines  a  rank for one file server machine
+   from the command line and reads ranks  for  additional  file
+   server  machines  from a file named prefs.txt in the current
+   directory:
+
+   % fs sets -se fs4.transarc.com 10010 -f prefs.txt
+
+PRIVILEGE REQUIRED
+
+   Issuer must be logged in as "root" in the UNIX  file  system
+   of the machine on which the command is issued.
+
+MORE INFORMATION
+
+   fs getserverprefs
diff --git a/src/man/fs_setvol.1 b/src/man/fs_setvol.1
new file mode 100644 (file)
index 0000000..bd589f0
--- /dev/null
@@ -0,0 +1,94 @@
+fs setvol                  AFS Commands               fs setvol
+
+
+NAME
+
+   fs setvol -- set maximum quota and messages for each volume
+
+                       containing specified directory.
+
+
+                                    +
+   fs setvol  [-path <dir/file path>   [-max <disk space quota
+   in 1K units>]
+   [-motd <message of the day>]  [-offlinemsg <offline
+   message>]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                             +
+   fs sv  [-p <dir/file path> ]  [-ma <disk space quota in 1K
+   units>]
+   [-mo <message of the day>]  [-o <offline message>]  [-h]
+
+DESCRIPTION
+
+   Sets  maximum  quota  for  the  volumes  that  contain  each
+   specified  directory  or  file.   It is also possible to use
+   -motd and -offlinemsg to create messages associated with the
+   volume, which appear when the fs examine command is issued.
+
+   The fs examine command displays all the information that can
+   be altered with this  command.    The  fs listquota  command
+   displays  maximum  quota,  and the fs quota command displays
+   the percent quota used.
+
+   The fs setquota command sets maximum quota on one volume  at
+   a time.
+
+ARGUMENTS
+
+   -path           names  each  file and/or directory for which
+                   quota and messages on the host  volumes  are
+                   to  be  set.  Omit this switch to affect the
+                   volume that  contains  the  current  working
+                   directory.
+
+   -max            specifies  the  maximum amount of disk space
+                   the volume can use.  Express it in  kilobyte
+                   blocks (a value of 1024 is one megabyte).  A
+                   value of 0 grants an  unlimited  quota,  but
+                   the  size  of the disk partition housing the
+                   volume  places  an  absolute  limit  on  the
+                   volume's maximum size.
+
+   -motd           specifies  a  "message of the day" displayed
+                   with the fs examine command.  It can be used
+                   to  alert  users  to  anything  of  interest
+                   concerning the volume.
+
+   -offlinemsg     specifies a message displayed  with  the  fs
+                   examine  command.  It can be used to explain
+                   why the volume is currently offline.
+
+   -help           prints  the  online  help  entry  for   this
+
+
+
+                   command.  Do not provide any other arguments
+                   or flags with this one.  See section 3.1  in
+                   the Reference Manual for more details.
+
+EXAMPLES
+
+   The  following  imposes a 6500 kilobyte quota on the volumes
+   housing      the       /afs/transarc.com/usr/smith       and
+   /afs/transarc.com/usr/pat home directories:
+
+   % cd /afs/transarc.com/usr  % fs sv -p smith pat -ma 6500
+
+PRIVILEGE REQUIRED
+
+   Issuer must belong to the system:administrators group in the
+   Protection Database.
+
+MORE INFORMATION
+
+   fs examine
+
+   fs listquota
+
+   fs quota
+
+   fs setquota
diff --git a/src/man/fs_sysname.1 b/src/man/fs_sysname.1
new file mode 100644 (file)
index 0000000..5ff74c7
--- /dev/null
@@ -0,0 +1,112 @@
+fs sysname                 AFS Commands              fs sysname
+
+
+NAME
+
+   fs sysname -- report or set CPU/operating system type.
+
+
+   fs sysname [-newsys <new sysname>]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs sy [-n <new sysname>]  [-h]
+
+DESCRIPTION
+
+   Depending   on  whether  the  issuer  provides  the  -newsys
+   argument,
+
+   EITHER sets the indicator of CPU/operating system type in th
+   the machine on which the command is issued
+
+   OR reports the current setting.
+
+   If the command is issued on an AFS client machine, the value
+   is set/reported for the machine itself.
+
+   If  the command is issued on an NFS client machine accessing
+   AFS via the NFS/AFS Translator, then  the  specified  CPU/OS
+   value  is  set/reported  for  the  NFS  client machine.  The
+   information is in a record  maintained  by  the  AFS  client
+   machine  serving  as  the  NFS  client's  NFS/AFS translator
+   machine.  The translator machine maintains a separate record
+   for each user logged into the NFS client.  This implies that
+   if a user adopts a new identity (UNIX UID)  during  a  login
+   session  on  the  NFS clientMperhaps using suMhe or she must
+   issue this command again.  Setting this indicator allows the
+   translator machine to provide the NFS client with the proper
+   version of program binaries when the  user  issues  commands
+   for which the binaries are kept in the AFS file tree.
+
+   The Cache Manager's main use of this indicator is as a value
+   for the "@sys" variable which can occur  in  AFS  pathnames.
+   As  the  Cache  Manager interprets pathnames, it substitutes
+   the indicator's value for any occurrence of @sys.   See  the
+   EXAMPLES  section for an example.  (Note that @sys should be
+   used sparingly, as  it  can  make  the  effect  of  changing
+   directories    unpredictable;    see    the    AFS    System
+   Administrator's Guide for further information.)
+
+ARGUMENTS
+
+   -newsys   specifies the new  setting  of  the  CPU/operating
+             system  indicator  for  the machine on which it is
+             issued.  If the issuer omits it, the output  shows
+             the  current  setting.    Consult  the  AFS System
+             Administrator's Guide for a complete list  of  the
+             legal values and the CPU/OS types they represent.
+
+   -help     prints the online help entry for this command.  Do
+             not provide any other arguments or flags with this
+             one.   See section 3.1 in the Reference Manual for
+             more details.
+
+
+
+OUTPUT
+
+   The output reports the machine's system type in the format
+
+       Current sysname is 'system type'
+
+EXAMPLES
+
+   The  following  shows  the  output   produced   on   a   Sun
+   SPARCStation running SunOS 4.1:
+
+   % fs sy  Current sysname is 'sun4c_41'
+
+   The  following  defines a machine to be a DECStation running
+   Ultrix 4.1:
+
+   % fs sysname pmax_ul4
+
+   When the Cache Manager on the machine encounters a  pathname
+   with  the  @sys  variable in it, it substitutes pmax_ul4 for
+   the variable.  For instance, this  machine  would  interpret
+   the pathname
+
+      /afs/transarc.com/@sys/usr/bin
+   as
+      /afs/transarc.com/pmax_ul4/usr/bin
+   and would access the volume corresponding to that directory.
+   A machine whose CPU/OS type was rt_aos4 would interpret  the
+   same pathname as
+
+      /afs/transarc.com/rt_aos4/usr/bin
+
+   and so would access a volume different from that accessed by
+   the DECStation.
+
+PRIVILEGE REQUIRED
+
+   None, if the machine is an NFS client.  If the machine is an
+   AFS  client,  the  issuer must be logged into the local UNIX
+   file system as "root."
+
+
+
+MORE INFORMATION
+
+   fs exportafs
diff --git a/src/man/fs_whereis.1 b/src/man/fs_whereis.1
new file mode 100644 (file)
index 0000000..534a6fd
--- /dev/null
@@ -0,0 +1,69 @@
+fs whereis                 AFS Commands              fs whereis
+
+
+NAME
+
+   fs whereis -- report name of file server machine(s) housing
+
+                       specified file/directory.
+
+
+                                     +
+   fs whereis  [-path <dir/file path> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                              +
+   fs whe  [-p <dir/file path> ]  [-h]
+
+DESCRIPTION
+
+   Returns the name of the file server machines that house each
+   specified  directory  or file.  See the OUTPUT section for a
+   description of the information displayed.
+
+ARGUMENTS
+
+   -path specifies each file or directory whose location is  to
+         be  returned.    Each specified file or directory must
+         reside in AFS (not on a local disk).   If  the  issuer
+         omits  this  argument,  the  location  of  the working
+         directory is returned.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+OUTPUT
+
+   The  output  includes a line for each specified directory or
+   file.  It names the file server machine on which the  volume
+   that houses the specified directory or file resides.  A list
+   of multiple machines indicates that the directory or file is
+   in a replicated volume.
+
+   Machine  names  usually  have a suffix indicating their cell
+   membership.  If some  question  remains,  the  fs  whichcell
+   command names the cell in which a directory or file resides.
+
+EXAMPLES
+
+   The following indicates that the directory /afs/transarc.com
+   resides   in   a   replicated   volume   located   on   both
+   fs1.transarc.com and fs3.transarc.com:
+
+   % fs whe /afs/transarc.com  File /afs/transarc.com is on
+   hosts fs1.transarc.com     fs3.transarc.com
+
+
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs whichcell
+
+   fs wscell
diff --git a/src/man/fs_whichcell.1 b/src/man/fs_whichcell.1
new file mode 100644 (file)
index 0000000..ca9714d
--- /dev/null
@@ -0,0 +1,61 @@
+fs whichcell               AFS Commands            fs whichcell
+
+
+NAME
+
+   fs  whichcell -- return  name  of  cell  to which specified
+
+                       file/directory belongs.
+
+
+                                       +
+   fs whichcell  [-path <dir/file path> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                              +
+   fs whi  [-p <dir/file path> ]  [-h]
+
+DESCRIPTION
+
+   Returns the name of the cell in which the volume that houses
+   each  indicated  directory  or file resides.  See the OUTPUT
+   section for a description of the information displayed.
+
+ARGUMENTS
+
+   -path specifies  each  file  and/or  directory  whose   cell
+         membership   is   to  be  returned.    Each  specified
+         directory or file must reside in AFS (not on  a  local
+         disk).  If the issuer omits this argument, the cell of
+         the working directory is returned.
+
+   -help prints the online help entry for this command.  Do not
+         provide  any  other  arguments or flags with this one.
+         See section 3.1  in  the  Reference  Manual  for  more
+         details.
+
+OUTPUT
+
+   The  output  includes a line for each specified directory or
+   file, naming  the  cell  in  which  the  directory  or  file
+   resides.
+
+EXAMPLES
+
+   The  following shows that the current directory resides in a
+   volume in the Transarc Corporation cell:
+
+   % fs whi  File . lives in cell 'transarc.com'
+
+PRIVILEGE REQUIRED
+
+   None.
+
+
+
+MORE INFORMATION
+
+   fs whereis
+
+   fs wscell
diff --git a/src/man/fs_wscell.1 b/src/man/fs_wscell.1
new file mode 100644 (file)
index 0000000..95d0115
--- /dev/null
@@ -0,0 +1,50 @@
+fs wscell                  AFS Commands               fs wscell
+
+
+NAME
+
+   fs  wscell -- return  name  of  cell  to  which workstation
+
+                       belongs.
+
+
+   fs wscell  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   fs ws  [-h]
+
+DESCRIPTION
+
+   Returns the name of the home cell for the  workstation  from
+   which the command is issued.
+
+ARGUMENTS
+
+   -help           prints   the  online  help  entry  for  this
+                   command.  Do not provide any other arguments
+                   or  flags with this one.  See section 3.1 in
+                   the Reference Manual for more details.
+
+OUTPUT
+
+   The   reported   cell   name    comes    from    the    file
+   /usr/vice/etc/ThisCell on the workstation's local disk.
+
+EXAMPLES
+
+   The  following  results  when  the  fs wscell is issued on a
+   machine in the Transarc Corporation cell:
+
+       % fs wscell
+       This workstation belongs to cell 'transarc.com'
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   fs whereis
+
+   fs whichcell
diff --git a/src/man/kas.1 b/src/man/kas.1
new file mode 100644 (file)
index 0000000..1daec09
--- /dev/null
@@ -0,0 +1,207 @@
+                           AFS Commands
+
+
+NAME
+                             AFS Commands
+
+
+   1. The kas Commands
+
+   ------------------------------------------------------------
+
+   This   chapter   defines   the   kas  commands  that  system
+   administrators use to contact the Authentication Server.  It
+   assumes  the  reader is familiar with the concepts described
+   in the AFS System Administrator's Guide.
+
+   The kas command interface allows  system  administrators  to
+   create,   modify,   examine   and   delete  entries  in  the
+   Authentication Database  maintained  by  the  Authentication
+   Server.    Individual  users  may  use  the  kas setpassword
+   command to change their own password (as well  as  the  more
+   standard, non-kas command, kpasswd).
+
+   Refer to the Command Summary at the end of this document for
+   a complete list of kas commands and their syntax.
+   AFS Command Reference Manual             The kas Commands  2
+
+
+   1.1 The kas Interface
+   The kas command interface differs slightly from  the  others
+   described   in  this  manual.    The  Authentication  Server
+   authenticates issuers of kas commands directly  rather  than
+   accepting  a ticket from the Ticket Granting Service as most
+   other servers do.   Thus  most  commands  require  that  the
+   issuer provide his or her password at the time of issue.
+
+
+
+   1.1.1 Interactive Mode
+   Providing  the  password  each time could get tedious if the
+   user needed to execute a  whole  set  of  commands,  so  kas
+   provides  an "interactive" mode in which it is not necessary
+   to provide a password repeatedly.
+
+
+   1.1.1.1 Entering Interactive Mode
+   There are several ways to enter interactive mode:
+
+      - Use the kas interactive command.
+
+      - Type kas without any operation code.  By  default,
+        the  command  interpreter establishes a connection
+        with each Authentication Server in the local cell.
+        They  attempt to authenticate the user logged into
+        the machine from  which  the  command  is  issued,
+        based  on  the password the issuer provides at the
+        prompt.  The  issuer  may  specify  an   alternate
+        identity,  password,  cell  name  and/or  list  of
+        Authentication Servers by  using  the  first  four
+        common  arguments  described in section 4.3 in the
+        Reference Manual .  Type kas followed  by  a  user
+        name  and  cell  name,  separated  by  an "@" sign
+        (example:   kas    smith@transarc.com).        The
+        Authentication Server attempts to authenticate the
+        specified user in the specified cell, and  prompts
+        for  his  or  her  password in the specified cell.
+        This method is most useful when the issuer  wishes
+        to   enter   interactive  mode  with  a  different
+        identity in a different cell.
+
+
+   1.1.1.2 Effects of Entering Interactive Mode
+   While in interactive mode:
+
+
+      - The "ka>" prompt  replaces  the  issuer's  regular
+        prompt.
+
+      - It  is no longer necessary or legal to type kas at
+        the beginning of a command.   Type  the  operation
+        code as the first part of the command.
+
+      - The  Authentication Server does not prompt for the
+        issuer's password at each command.   This  is  the
+        mode's main advantage.
+
+      - The  issuer's identity and cell are set and cannot
+        be changed without leaving interactive mode, so it
+        is   not  legal  to  provide  any  of  the  common
+   AFS Command Reference Manual             The kas Commands  3
+
+
+        arguments described fully in section  4.3  in  the
+        Reference Manual , except for -help.
+
+   1.2 Information in the Authentication Database
+   Both  individual  users  and  servers  have  entries  in the
+   Authentication Database.  The two most important  fields  in
+   an entry are:
+
+      - the name
+
+      - the  key  (a  scrambled  form  of name's password,
+        suitable for use as an encryption key)
+
+   For individual users, the name field holds the user name  as
+   typed  at  login,  and  key  holds  a  scrambled form of the
+   password the user has created.
+
+   Server entries are the same as user entries.  The entry name
+   for the AFS server processes is "afs".  A server entry's key
+   field contains the server encryption  key  that  the  Ticket
+   Granting  Service (TGS) uses to seal the tickets it gives to
+   clients so that they may contact the server processes.
+
+   1.3 Common Arguments and Flags
+   When not in interactive mode, most kas commands  accept  the
+   following  optional  arguments and flags.  Some of these are
+   unavailable in interactive mode because the information they
+   provide  is established while entering interactive mode, and
+   cannot be changed from within interactive mode.    They  are
+   listed in the command descriptions where they apply, and are
+   described in detail below:
+
+   [-admin_username <admin principal to use for
+   authentication>]
+
+   This argument allows the issuer to assume  the  identity  of
+   the  specified  user name (which is referred to as an "admin
+   principal").  By default, the Authentication Server attempts
+   to authenticate the user logged into the local workstation.
+
+   [-password_for_admin <admin password>]
+
+   This  argument  provides  the Authentication Server with the
+   password needed to prove that the issuer of the command (the
+   admin  principal) is legitimate (which it will if it matches
+   the password stored in the Authentication Database  for  the
+   issuer).    Note that providing this argument on the command
+   line reveals the password on the screen.  Issuers may prefer
+   to  respond  to the prompt that will appear if this argument
+   is not provided, as the password does not  echo  visibly  in
+   that case.
+
+   [-cell <cell name>]
+
+   This  argument specifies that the command should be run in a
+   different  cell,  specified  by  cell  name.    By  default,
+   commands  are  executed  in  the  local  cell, as defined in
+   /usr/vice/etc/ThisCell on the client machine  on  which  the
+   command  is  issued.  The issuer may abbreviate cell name to
+   the shortest form that distinguishes it from the other cells
+   listed  in /usr/vice/etc/CellServDB on the client machine on
+   AFS Command Reference Manual             The kas Commands  4
+
+
+   which the command is issued.
+
+                                                      +
+   [-servers <explicit list of authentication servers> ]
+
+   This  argument  causes  the  kas  command   interpreter   to
+   establish   a  connection  with  the  Authentication  Server
+   running on each specified database server machine.  It  then
+   chooses  one  of  these at random to execute each subsequent
+   command.  The issuer may abbreviate the machine name to  the
+   extent the cell's name server will accept.
+
+   By  default,  the  kas  command  interpreter  establishes  a
+   connection  with  each   machine   listed   in   the   local
+   workstation's  copy  of  /usr/vice/etc/CellServDB,  and then
+   chooses one of those at random for command execution.
+
+   This option  is  useful  for  testing  specific  servers  if
+   problems are encountered.
+
+   [-noauth]
+
+   This  flag  instructs indicated Authentication Server(s) not
+   to  authenticate  the  issuer  of  the  command,  and   thus
+   establishes an unauthenticated connection between the issuer
+   and the Authentication Server (he or she  is  recognized  as
+   the  unprivileged  user  anonymous).  It is useful only when
+   authorization  checking  is  disabled  on  the  file  server
+   machine (during the installation of a file server machine or
+   when  bos setauth  has  been  used  during   other   unusual
+   circumstances).  In normal circumstances, the Authentication
+   Server allows only authorized (privileged)  users  to  issue
+   most  kas commands, and will refuse to execute the requested
+   actions even if the -noauth flag is used.
+
+   [-help]
+
+   This flag has the same function as the kas help command:  it
+   prints  the command's online help message on the screen.  No
+   other arguments or flags should  be  provided  at  the  same
+   time.    Even if they are, this flag overrides them, and the
+   only effect of issuing the command is that the help  message
+   appears.
+
+   1.4 The Privilege Required for kas Commands
+   The  Authentication  Server considers privileged those users
+   who have the ADMIN flag turned on  in  their  Authentication
+   Database  entry.  See the kas setfields command to learn how
+   to turn on the ADMIN flag.  Most kas commands  require  that
+   the  issuer  be  privileged.  All commands will prompt for a
+   password, unless the issuer has entered interactive mode.
diff --git a/src/man/kas_apropos.1 b/src/man/kas_apropos.1
new file mode 100644 (file)
index 0000000..9038eaa
--- /dev/null
@@ -0,0 +1,64 @@
+kas apropos                AFS Commands             kas apropos
+
+
+NAME
+
+   kas apropos -- show each help entry containing keyword.
+
+
+   kas apropos  -topic <help string>  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas a  -t <help string>  [-h]
+
+DESCRIPTION
+
+   Displays  the  first  line  of  the  help  entry for any kas
+   command  that  has  help  string  in  its  name   or   short
+   description.
+
+ARGUMENTS
+
+   -topic
+         specifies the keyword string to search for.  If it  is
+         more  than  a  single  word,  surround  it with double
+         quotes or other delimiters.  Type all help strings for
+         kas commands in all lowercase letters, except the word
+         "AuthServer."
+
+   -help prints the online help  for  this  command.    Do  not
+         provide  any  other  arguments or flags with this one.
+         See section 4.3  in  the  Reference  Manual  for  more
+         details.
+
+OUTPUT
+
+   The  first  line  of a command's online help entry names the
+   command and briefly describes what it does.  The kas apropos
+   command  displays  that first line for any kas command where
+   help string is part of the command name or first line.
+
+   To see the remaining lines in a help  entry,  which  provide
+   the  command's  alias  (if any) and syntax, use the kas help
+   command.
+
+EXAMPLE
+
+   The following lists all kas  commands  that  have  the  word
+   "key" in their operation code or short online description.
+
+       % kas a key
+       getrandomkey: get a random key
+       setkey: set a user's key
+       stringtokey: convert a string to a key
+
+
+
+PRIVILEGE REQUIRED
+
+   None.  No password will be prompted for.
+
+MORE INFORMATION
+
+   kas help
diff --git a/src/man/kas_create.1 b/src/man/kas_create.1
new file mode 100644 (file)
index 0000000..7507442
--- /dev/null
@@ -0,0 +1,107 @@
+kas create                 AFS Commands              kas create
+
+
+NAME
+
+   kas   create -- create   an  entry  in  the  Authentication
+
+                       Database.
+
+
+   kas create  -name <name of user>  [-initial_password
+   <initial password>]
+   [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>] [-cell <cell name>]
+             [-servers <explicit list of authentication
+           +
+   servers> ]  [-noauth]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas c -na <name of user>  [-i <initial password>]
+   [-a <admin principal to use for authentication>]  [-p <admin
+   password>]
+   [-c <cell name>]  [-s <explicit list of authentication
+           +
+   servers> ]  [-no]  [-h]
+
+DESCRIPTION
+
+   Creates an entry in  Authentication  Database  for  name  of
+   user.    The Authentication Server converts initial password
+   into a form suitable for  use  as  an  encryption  key,  and
+   places it in the entry's key field.
+
+ARGUMENTS
+
+   -name             specifies    the    name    of   the   new
+                     Authentication Database entry.  It will be
+                     the user name under which the user logs in
+                     to the system.
+
+   -initial_password specifies a  character  string  that  will
+                     become   the   user's   password.      The
+                     Authentication Server scrambles it into an
+                     octal  key  and places it in the key field
+                     of the Database entry.  If the issuer does
+                     not  provide  it,  it will be prompted for
+                     (if it is not provided at the  prompt  the
+                     create operation fails).  The advantage of
+                     waiting  for  the  prompt  is   that   the
+                     password does not echo on the screen.
+
+   -admin_username   specifies  the  user  name under which the
+                     issuer wishes to perform the command.  See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -password_for_admin
+                     specifies   the  issuer's  password.    If
+                     provided here, the password is visible  on
+                     the  screen.    If  the  issuer  does  not
+                     provide it, it will be  prompted  for  and
+                     not be visible on the screen.  See section
+                     4.3  in  the  Reference  Manual  for  more
+
+
+
+                     details.  -cell
+                     specifies the cell in  which  to  run  the
+                     command,  if  not  the  local  cell.   See
+                     section 4.3 in the  Reference  Manual  for
+                     more details.  -servers
+                     specifies the database  server  machine(s)
+                     with which to establish a connection.  See
+                     section 4.3 in the  Reference  Manual  for
+                     more details.  -noauth
+                     establishes an unauthenticated  connection
+                     between  the  Authentication  Servers  and
+                     issuer, whom they assign the  unprivileged
+                     identity  anonymous rather than attempting
+                     mutual authentication.  See section 4.3 in
+                     the  Reference  Manual  for  more details.
+                     -help
+                     prints  the  online help for this command.
+                     Do not  provide  any  other  arguments  or
+                     flags  with  this one.  See section 4.3 in
+                     the Reference Manual for more details.
+
+EXAMPLE
+
+   The following shows the prompts  that  appear  when  someone
+   authenticated  as  admin  creates an Authentication Database
+   entry for the user  smith,  and  does  not  specify  smith's
+   initial  password  on the command line.  The passwords typed
+   at the prompts do not echo visibly.
+
+   % kas cr smith  Password for admin:   initial_password:
+   Verifying, please re-enter initial_password:
+
+PRIVILEGE REQUIRED
+
+   Issuer  must  have  the  ADMIN  flag  set  in  his  or   her
+   Authentication Database entry.
+
+MORE INFORMATION
+
+   kas examine
diff --git a/src/man/kas_debuginfo.1 b/src/man/kas_debuginfo.1
new file mode 100644 (file)
index 0000000..7aecfe7
--- /dev/null
@@ -0,0 +1,88 @@
+kas debuginfo              AFS Commands           kas debuginfo
+
+
+NAME
+
+   kas    debuginfo -- produce   debugging   trace   for   the
+
+                       Authentication Server.
+
+
+   kas debuginfo  [-hostname <authentication server host name>]
+          [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+                                                             +
+          [-servers <explicit list of authentication servers> ]
+   [-noauth]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas deb  [-ho <authentication server host name>]
+   [-a <admin principal to use for authentication>]
+   [-p <admin password>]  [-c <cell name>]
+                                                +
+   [-s <explicit list of authentication servers> ]  [-n]  [-he]
+
+DESCRIPTION
+
+   Displays information on the standard output device  (stdout)
+   which  is  helpful  in  debugging the Authentication Server.
+   This information is useful only for  someone  familiar  with
+   the  implementation  of  the  Authentication  Server and the
+   internal structure of the  Authentication  Database.    Most
+   system administrators will not find it helpful.
+
+ARGUMENTS
+
+   -hostname         names  the  database  server  machine  for
+                     which  to  display  debugging  information
+                     about  the  Authentication Server instance
+                     it is running.
+
+   -admin_username   specifies the user name  under  which  the
+                     issuer wishes to perform the command.  See
+                     section 4.3 in the  Reference  Manual  for
+                     more details.  -password_for_admin
+                     specifies  the  issuer's  password.     If
+                     provided  here, the password is visible on
+                     the  screen.    If  the  issuer  does  not
+                     provide  it,  it  will be prompted for and
+                     not be visible on the screen.  See section
+                     4.3  in  the  Reference  Manual  for  more
+                     details.  -cell
+                     specifies  the  cell  in  which to run the
+                     command, if  not  the  local  cell.    See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -servers
+                     specifies  the  database server machine(s)
+                     with which to establish a connection.  See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -noauth
+                     establishes  an unauthenticated connection
+                     between  the  Authentication  Servers  and
+
+
+
+                     issuer,  whom they assign the unprivileged
+                     identity anonymous rather than  attempting
+                     mutual authentication.  See section 4.3 in
+                     the Reference  Manual  for  more  details.
+                     -help
+                     prints the online help for  this  command.
+                     Do  not  provide  any  other  arguments or
+                     flags with this one.  See section  4.3  in
+                     the Reference Manual for more details.
+
+PRIVILEGE REQUIRED
+
+   None.    A  password will be prompted for unless the -noauth
+   flag is provided.   The  issuer  must  type  some  character
+   string  at the prompt, but even providing the wrong one does
+   not  prevent  the  command  from  being  executed,   despite
+   possible error messages.
+
+MORE INFORMATION
+
+   kas statistics
diff --git a/src/man/kas_delete.1 b/src/man/kas_delete.1
new file mode 100644 (file)
index 0000000..44d2a1f
--- /dev/null
@@ -0,0 +1,97 @@
+kas delete                 AFS Commands              kas delete
+
+
+NAME
+
+   kas   delete -- delete   entry   from   the  Authentication
+
+                       Database.
+
+
+   kas delete  -name <name of user>
+   [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+             [-servers <explicit list of authentication
+           +
+   servers> ]  [-noauth]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas del  -na <name> [-a <admin principal to use for
+   authentication>]
+   [-p <admin password>]  [-c <cell name>]
+                                                +
+   [-s <explicit list of authentication servers> ]  [-no]  [-h]
+
+   kas rm  -na <name> [-a <admin principal to use for
+   authentication>]
+   [-p <admin password>]  [-c <cell name>]
+                                                +
+   [-s <explicit list of authentication servers> ]  [-no]  [-h]
+
+DESCRIPTION
+
+   Removes the entry  name  of  user  from  the  Authentication
+   Database.    If  name  of  user is a user, he or she becomes
+   unable to log in.  If name of user is a server,  it  becomes
+   unreachable, because the TGS can no longer has anything with
+   which to seal tickets for the server.
+
+ARGUMENTS
+
+   -name             specifies the name of the  Database  entry
+                     to delete
+
+   -admin_username   specifies  the  user  name under which the
+                     issuer wishes to perform the command.  See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -password_for_admin
+                     specifies   the  issuer's  password.    If
+                     provided here, the password is visible  on
+                     the  screen.    If  the  issuer  does  not
+                     provide it, it will be  prompted  for  and
+                     not be visible on the screen.  See section
+                     4.3  in  the  Reference  Manual  for  more
+                     details.
+
+   -cell             specifies  the  cell  in  which to run the
+                     command, if  not  the  local  cell.    See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -servers
+                     specifies  the  database server machine(s)
+                     with which to establish a connection.  See
+
+
+
+                     section  4.3  in  the Reference Manual for
+                     more details.  -noauth
+                     establishes  an unauthenticated connection
+                     between  the  Authentication  Servers  and
+                     issuer,  whom they assign the unprivileged
+                     identity anonymous rather than  attempting
+                     mutual authentication.  See section 4.3 in
+                     the Reference  Manual  for  more  details.
+                     -help
+                     prints the online help for  this  command.
+                     Do  not  provide  any  other  arguments or
+                     flags with this one.  See section  4.3  in
+                     the Reference Manual for more details.
+
+EXAMPLE
+
+   In the following the issuer admin enters interactive mode in
+   order to make it more convenient to delete three accounts at
+   once.    The  password  typed  at  the  prompt does not echo
+   visibly.
+
+   % kas  Password for admin:   ka> del smith  ka> del pat  ka>
+   del terry
+
+PRIVILEGE REQUIRED
+
+   Issuer  must  have  the  ADMIN  flag  set  in  his  or   her
+   Authentication Database entry.
+
+MORE INFORMATION
diff --git a/src/man/kas_examine.1 b/src/man/kas_examine.1
new file mode 100644 (file)
index 0000000..d31c5a5
--- /dev/null
@@ -0,0 +1,220 @@
+kas examine                AFS Commands             kas examine
+
+
+NAME
+
+   kas  examine -- display  information from an Authentication
+
+                       Database entry.
+
+
+   kas examine  -name <name of user>
+   [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+           [-servers <explicit list of authentication
+           +
+   servers> ]  [-noauth]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas e  -na <name of user>  [-a <admin principal to use for
+   authentication>]
+   [-p <admin password>]  [-c <cell name>]
+                                                +
+   [-s <explicit list of authentication servers> ]  [-no]  [-h]
+
+DESCRIPTION
+
+   Formats and displays  information  from  the  Authentication
+   Database  entry  for  name.    See  the  OUTPUT  section for
+   details.
+
+ARGUMENTS
+
+   -name             specifies the Database entry from which to
+                     display information.
+
+   -admin_username   specifies  the  user  name under which the
+                     issuer wishes to perform the command.   If
+                     the   issuer  does  not  provide  it,  the
+                     current identity is used.  See section 4.3
+                     in  the Reference Manual for more details.
+                     -password_for_admin
+                     specifies   the  issuer's  password.    If
+                     provided here, the password is visible  on
+                     the  screen.    If  the  issuer  does  not
+                     provide it, it will be  prompted  for  and
+                     not be visible on the screen.  See section
+                     4.3  in  the  Reference  Manual  for  more
+                     details.  -cell
+                     specifies the cell in  which  to  run  the
+                     command,  if  not  the  local  cell.   See
+                     section 4.3 in the  Reference  Manual  for
+                     more details.  -servers
+                     specifies the database  server  machine(s)
+                     with which to establish a connection.  See
+                     section 4.3 in the  Reference  Manual  for
+                     more details.  -noauth
+                     establishes an unauthenticated  connection
+                     between  the  Authentication  Servers  and
+                     issuer, whom they assign the  unprivileged
+                     identity  anonymous rather than attempting
+                     mutual authentication.  See section 4.3 in
+
+
+
+                     the  Reference  Manual  for  more details.
+                     -help
+                     prints  the  online help for this command.
+                     Do not  provide  any  other  arguments  or
+                     flags  with  this one.  See section 4.3 in
+                     the Reference Manual for more details.
+
+
+
+OUTPUT
+
+   The output reports, in this order:
+
+      - the name of the entry
+
+      - one or more status flags, which will  only  appear
+        if   a   system   administrator   has   used   the
+        kas setfields command to change a  flag  from  its
+        default  value.  A plus sign (+) will separate the
+        flags if more than one appears.   The  non-default
+        values which may appear, and their meanings, are:
+
+           * ADMIN.      the  user  is  allowed  to  issue
+             privileged kas commands (Default: NOADMIN.)
+
+           * NOTGS.   the  Ticket  Granting  Service  will
+             refuse to issue tickets to the user (Default:
+             TGS.)
+
+           * NOSEAL. the Ticket  Granting  Service  cannot
+             use the contents of this entry's key field as
+             an encryption key (Default: SEAL.)
+
+           * NOCPW.  the  user  or  server  cannot  change
+             his/her/its  own  password  or  key (Default:
+             CPW.)
+
+      - the word "key" followed by the key version  number
+        in parentheses.
+
+        The octal key itself appears only if authorization
+        checking  is  disabled  on  the  database   server
+        machine   to  which  the  kas examine  command  is
+        directed  with  the  -servers  argument  (see  the
+        EXAMPLES  section).    The  reasoning  behind this
+        requirement is two-fold.  First, it  implies  that
+        only  someone  authorized to issue the bos setauth
+        command or with  "root"  access  to  the  database
+        server  machine's local disk is able to see actual
+        keys from the Authentication Database.  Second, it
+        makes it clear that the system is in a compromised
+        state of security while keys are  being  displayed
+        on  the  screen.    Both turning off authorization
+        checking and  displaying  keys  on  a  screen  are
+        serious security risks.
+
+        In the normal cases when authorization checking is
+        enabled  on  the  database   server   machine,   a
+        "checksum"  appears instead of the key.  This is a
+        decimal number derived by  encrypting  a  constant
+        with  the key.  In the case of the "afs" key, this
+        number can be compared to the  checksum  with  the
+        corresponding  key version number in the output of
+        the bos listkeys command.
+
+      - the  date  that  the  user  changed  his/her   own
+        password,  indicated  as  "last cpw" (which stands
+        for "last change of password")
+
+      - the date on which the entry expires.  If this is a
+
+
+
+        user   entry,   the   user   will   be  unable  to
+        authenticate with the Authentication Server  after
+        this date.
+
+      - the maximum length of time that tickets issued for
+        this entry may be valid
+
+      - the date of the last modification  to  the  entry,
+        indicated  as "last mod," and the user name of the
+        person who issued the modifying command.  Password
+        changes  made  by  the  user  himself/herself  are
+        recorded as "last cpw" instead.
+
+EXAMPLES
+
+   In each of the examples, the password typed  at  the  prompt
+   does not echo visibly.
+
+   The  following shows the privileged user smith examining her
+   own Authentication Database entry.   Note  the  ADMIN  flag,
+   which shows that smith is privileged.
+
+   % kas e smith
+   Password for smith:
+   User data for smith (ADMIN)
+    key (0) cksum is 3414844392,  last cpw: Wed Jan 3 16:05:44
+    entry expires on never. Max ticket lifetime 100.00 hours.
+    last mod on Thu Dec 21 08:22:29 1989 by admin
+
+   In  the  following  the  regular user terry examines her own
+   entry and tries to examine pat's.
+
+       % kas
+       Password for terry:
+       ka> ex terry
+       User data for terry
+        key (0) cksum is 529538018,  last cpw: Fri Jan 19 9
+        entry expires on never. Max ticket lifetime 100.00
+        last mod on Thu Dec 21 08:43:29 1989 by admin
+       ka> ex pat
+       kas:examine: caller not authorized getting informati
+
+
+   In  the  following  an  administrator  logged  in   as   the
+   privileged   user   admin   uses  bos setauth  to  turn  off
+   authorization  checking  on  the  database  server   machine
+   db1.transarc.com  so  that he can look at the key in the afs
+   entry.  He enters interactive mode to open a connection with
+   the  Authentication Server on db1.transarc.com only and uses
+   the -noauth flag to prevent that server from  attempting  to
+   authenticate him.
+
+       % bos setauth db1.transarc.com off
+       % kas i -servers db1.transarc.com -noauth
+       ka> examine afs -servers db1.transarc.com
+       User data for afs
+        key (12): \357\253\304\352a\236\253\352, last cpw:
+        entry expires on never. Max ticket lifetime 100.00
+        last mod on Thu Jan 11 14:53:29 1990 by admin
+
+PRIVILEGE REQUIRED
+
+
+
+   A user may examine his or her own entry.  To examine others'
+   entries, the issuer must have the ADMIN flag set in  his  or
+   her Authentication Database entry.
+
+   To  look  at  actual  keys,  authorization  checking must be
+   disabled on the database server  machine  with  bos setauth,
+   which  implies  being listed in /usr/afs/etc/UserList; it is
+   not necessary to have the ADMIN flag in addition.
+
+MORE INFORMATION
+
+   bos listkeys
+
+   bos setauth
+
+   kas setfields
diff --git a/src/man/kas_forgetticket.1 b/src/man/kas_forgetticket.1
new file mode 100644 (file)
index 0000000..23a1733
--- /dev/null
@@ -0,0 +1,57 @@
+kas forgetticket           AFS Commands        kas forgetticket
+
+
+NAME
+
+   kas forgetticket -- discard all tickets for the issuer.
+
+
+   kas forgetticket [-name <name of server>]  [-all]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas f [-h]
+
+DESCRIPTION
+
+   Discards  all  tickets  that  the  Authentication Server has
+   registered for the issuer.  This  includes  the  AFS  server
+   ticket  from  each cell in which the user has authenticated,
+   and any tickets that the user may have acquired during  this
+   kas  session  (either  by  virtue of entering the session or
+   using kas getticket).
+
+ARGUMENTS
+
+   -name specifies which ticket should be discarded.    Provide
+         this argument OR the -all flag.
+
+         Note:This  argument  is not currently implemented: all
+         tickets are discarded no  matter  which  ticket  which
+         ticket name is specified here.
+
+   -all  indicates   that  all  tickets  should  be  discarded.
+         Provide this flag OR  the  -name  argument.    In  the
+         current  implementation,  this  flag  is more sensible
+         because it matches what  actually  happens  no  matter
+         which option the issuer chooses.
+
+   -help prints  the  online  help  for  this  command.  Do not
+         provide any other arguments or flags  with  this  one.
+         See  section  4.3  in  the  Reference  Manual for more
+         details.
+
+EXAMPLES
+
+   Both of the following discard all tickets for the issuer.
+
+   % kas forgetticket -all  % kas f
+
+PRIVILEGE REQUIRED
+
+   None.  There is no prompt for a  password,  and  the  issuer
+   does  not  have  to  have  the  ADMIN flag set in his or her
+   Database entry.  The deletion can  affect  only  the  issuer
+   anyway.
+
+MORE INFORMATION
diff --git a/src/man/kas_getpassword.1 b/src/man/kas_getpassword.1
new file mode 100644 (file)
index 0000000..7e20724
--- /dev/null
@@ -0,0 +1,80 @@
+kas getpassword            AFS Commands         kas getpassword
+
+
+NAME
+
+   kas getpassword -- display octal key from an Authentication
+
+                       Database entry.
+
+
+   kas getpassword  -name <name of user>  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas getp  -n <name of user>  [-h]
+
+DESCRIPTION
+
+   Prints out the contents (an octal-format encryption key)  of
+   the key field for the Database entry name of user.
+
+WARNING
+
+   This  command  works  only  if the Authentication Server has
+   been compiled with a special flag;  this  is  normally  done
+   only  for cells in the process of converting from use of AFS
+   2.0-style  authentication   to   AFS   3.0   authentication.
+   Moreover,  this  command  does  not work if issued on an AFS
+   client.  The issuer must be logged into  a  machine  running
+   the  specially-compiled  Authentication  Server  (a database
+   server  machine  or  other  machine  running   an   isolated
+   Authentication Server).
+
+   The  recommended  way  to  examine the octal form of keys is
+   with kas examine when authorization  checking  is  disabled.
+   That  command shows a "checksum" when authorization checking
+   is enabled, which may be suitable for some purposes.
+
+   Even when the other conditions are met,  this  command  does
+   not work for entries where the name includes a period (these
+   entries  are  generally  for  the  Authentication   Server's
+   internal use anyway).
+
+ARGUMENTS
+
+   -name names  the  entry  from  which the key field should be
+         printed out.
+
+   -help prints the online help  for  this  command.    Do  not
+         provide  any  other  arguments or flags with this one.
+         See section 4.3  in  the  Reference  Manual  for  more
+         details.
+
+OUTPUT
+
+   The  output simply prints the key after a "Key:" header.  It
+   does  not  report  the  key  version  number,  but  that  is
+   available from kas examine.
+
+EXAMPLE
+
+   The  following  shows  a  user using this command to examine
+   afs's password.
+
+
+
+       % kas getp afs
+       Key: \020\354\315\310\313\023W\370
+
+PRIVILEGE REQUIRED
+
+   None.  There is no prompt for a  password,  and  the  issuer
+   does  not  have  to  have  the  ADMIN flag set in his or her
+   Database entry.  It is assumed that any machine running  the
+   Authentication  Server  is  secured by having only a limited
+   number of people in its local /etc/passwd file.
+
+MORE INFORMATION
+
+   kas examine
diff --git a/src/man/kas_getrandomkey.1 b/src/man/kas_getrandomkey.1
new file mode 100644 (file)
index 0000000..7098c08
--- /dev/null
@@ -0,0 +1,102 @@
+kas getrandomkey           AFS Commands        kas getrandomkey
+
+
+NAME
+
+   kas getrandomkey -- generate an encryption key at random.
+
+
+   kas getrandomkey
+   [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+                                                             +
+          [-servers <explicit list of authentication servers> ]
+   [-noauth]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas getr  [-a <admin principal to use for authentication>]
+           [-p <admin password>]  [-c <cell name>]
+                                                +
+   [-s <explicit list of authentication servers> ]  [-n]  [-h]
+
+DESCRIPTION
+
+   Returns  a  key  generated at random (i.e., not derived from
+   any known password).  This is useful mainly for testing  and
+   debugging the Authentication Server.
+
+WARNINGS
+
+   The  output  of  this  command  is  visible  on the issuer's
+   screen, making it a potential security risk to use  the  key
+   in  an  actual  Authentication  Database  entry (such as the
+   "afs" entry).
+
+   If  the  -noauth  flag  is  used,  the  connection  to   the
+   Authentication  Server is not authenticated, so the randomly
+   generated  key  crosses  the  network  unencrypted.      The
+   potential  security  risk  in  using  the  key  as an actual
+   encryption key is even greater in this case.
+
+ARGUMENTS
+
+   -admin_username   specifies the user name  under  which  the
+                     issuer  wishes to perform the command.  If
+                     the  issuer  does  not  provide  it,   the
+                     current identity is used.  See section 4.3
+                     in the Reference Manual for more  details.
+                     -password_for_admin
+                     specifies  the  issuer's  password.     If
+                     provided  here, the password is visible on
+                     the  screen.    If  the  issuer  does  not
+                     provide  it,  it  will be prompted for and
+                     not be visible on the screen.  See section
+                     4.3  in  the  Reference  Manual  for  more
+                     details.  -cell
+                     specifies  the  cell  in  which to run the
+                     command, if  not  the  local  cell.    See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -servers
+                     specifies  the  database server machine(s)
+                     with which to establish a connection.  See
+
+
+
+                     section  4.3  in  the Reference Manual for
+                     more details.  -noauth
+                     establishes  an unauthenticated connection
+                     between  the  Authentication  Servers  and
+                     issuer,  whom they assign the unprivileged
+                     identity anonymous rather than  attempting
+                     mutual authentication.  See section 4.3 in
+                     the Reference  Manual  for  more  details.
+                     -help
+                     prints the online help for  this  command.
+                     Do  not  provide  any  other  arguments or
+                     flags with this one.  See section  4.3  in
+                     the Reference Manual for more details.
+
+OUTPUT
+
+   Following a "Key:" header, the output displays the octal and
+   hexadecimal forms of the key.
+
+EXAMPLE
+
+   The following shows terry issuing this command.
+
+       % kas getr
+       Password for terry:
+       Key: \230\206\370v1\334\373\346 (98.86.f8.76 31.dc.f
+
+PRIVILEGE REQUIRED
+
+   None, but the correct  password  must  be  provided  at  the
+   prompt  if  the  key  is  to be encrypted while crossing the
+   network.  If the -noauth flag is used,  a  password  is  not
+   prompted for.
+
+MORE INFORMATION
diff --git a/src/man/kas_getticket.1 b/src/man/kas_getticket.1
new file mode 100644 (file)
index 0000000..97cc402
--- /dev/null
@@ -0,0 +1,101 @@
+kas getticket              AFS Commands           kas getticket
+
+
+NAME
+
+   kas  getticket -- create  a  ticket valid for the specified
+
+                       server.
+
+
+   kas getticket  -name <name of server>
+   [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+                                                             +
+          [-servers <explicit list of authentication servers> ]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas gett  -na <name of server>  [-a <admin principal to use
+   for authentication>]
+   [-p <admin password>]  [-c <cell name>]
+                                                +
+   [-s <explicit list of authentication servers> ]  [-no]  [-h]
+
+DESCRIPTION
+
+   Instructs the Ticket Granting Service to create a ticket for
+   the  issuer  of  the  command,  which  he or she can use for
+   secured communication with name of server.   The  ticket  is
+   sealed  with  the  contents  of  the  key  field  in name of
+   server's Database entry.
+
+   This command is functionally similar to klog.  It is  useful
+   primarily  for debugging purposes, and is not recommended as
+   the normal way  to  obtain  tickets.    Also,  while  it  is
+   possible  to  make name of server an individual user as well
+   as a server process, such a ticket is  useless  because  the
+   user's workstation will not know what to do with it.
+
+ARGUMENTS
+
+   -name             specifies the Database entry from which to
+                     use the  key.    It  may  include  a  cell
+                     specification (example:
+
+                     kas getticket afs@transarc.com
+
+                     gets  a ticket good for all AFS servers in
+                     the Transarc Corporation cell).
+
+   -admin_username   specifies the user name  under  which  the
+                     issuer  wishes to perform the command.  If
+                     the  issuer  does  not  provide  it,   the
+                     current identity is used.  See section 4.3
+                     in the Reference Manual for more  details.
+                     -password_for_admin
+                     specifies  the  issuer's  password.     If
+                     provided  here, the password is visible on
+                     the  screen.    If  the  issuer  does  not
+                     provide  it,  it  will be prompted for and
+                     not be visible on the screen.  See section
+                     4.3  in  the  Reference  Manual  for  more
+
+
+
+                     details.  -cell
+                     specifies  the  cell  in  which to run the
+                     command, if  not  the  local  cell.    See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -servers
+                     specifies  the  database server machine(s)
+                     with which to establish a connection.  See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -noauth
+                     establishes  an unauthenticated connection
+                     between  the  Authentication  Servers  and
+                     issuer,  whom they assign the unprivileged
+                     identity anonymous rather than  attempting
+                     mutual authentication.  See section 4.3 in
+                     the Reference  Manual  for  more  details.
+                     -help
+                     prints the online help for  this  command.
+                     Do  not  provide  any  other  arguments or
+                     flags with this one.  See section  4.3  in
+                     the Reference Manual for more details.
+
+EXAMPLE
+
+   The  following  shows  the  regular  user  terry obtaining a
+   ticket for the AFS server processes in her home cell.
+
+   % kas gett afs  Password for terry:
+
+PRIVILEGE REQUIRED
+
+   None.  However, the issuer must provide his or  her  correct
+   password.
+
+MORE INFORMATION
diff --git a/src/man/kas_help.1 b/src/man/kas_help.1
new file mode 100644 (file)
index 0000000..edc07d1
--- /dev/null
@@ -0,0 +1,82 @@
+kas help                   AFS Commands                kas help
+
+
+NAME
+
+   kas help -- show syntax of specified kas command(s) or list
+
+                       functional description for all of them.
+
+
+                                 +
+   kas help [-topic <help string> ]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+                           +
+   kas h  [-t <help string> ]  [-h]
+
+DESCRIPTION
+
+   Displays the first line  (name  and  short  description)  of
+   every  kas  command's  help  entry,  if  no  help  string is
+   provided.  For each operation code specified with -topic, it
+   outputs  the  entire  help  entry.    See the Output section
+   below.
+
+ARGUMENTS
+
+   -topic
+         specifies the operation code(s) for which syntax is to
+         be provided.  If  the  issuer  omits  it,  the  output
+         instead  provides  a  short  description  of  all  kas
+         commands.
+
+   -help prints the online help  for  this  command.    Do  not
+         provide  any  other  arguments or flags with this one.
+         See section 4.3  in  the  Reference  Manual  for  more
+         details.
+
+OUTPUT
+
+   The  online  help entry for each kas command consists of two
+   or three lines:
+
+      - The first  line  names  the  command  and  briefly
+        describes what it does
+
+      - If  the  command  has aliases, they will appear on
+        the next line
+
+      - The final line, which begins with "Usage:",  lists
+        the   command's   arguments   and   flags  in  the
+        prescribed order.  Online  help  entries  use  the
+        same  symbols  (brackets,  etc.)  as  the  command
+        definitions in this manual.  For an explanation of
+        their  meaning,  see  page  v  of the introductory
+        About This Manual chapter.
+
+
+
+EXAMPLE
+
+   The  following  displays  the  online  help  entry  for  the
+   kas setpassword command.
+
+       % kas help setpassword
+       kas setpassword: set a user's password
+       aliases: sp
+       Usage: kas setpassword -name <name of user> [-new_passwo
+       <new password>] [-kvno <key version number>]
+       [-admin_username <admin principal to use for authenticat
+       [-password_for_admin <password>] [-cell <cell name>]
+                                                          +
+       [-servers <explicit list of authentication servers> ] [-
+
+PRIVILEGE REQUIRED
+
+   None.  No password will be prompted for.
+
+MORE INFORMATION
+
+   kas apropos
diff --git a/src/man/kas_interactive.1 b/src/man/kas_interactive.1
new file mode 100644 (file)
index 0000000..4688e2f
--- /dev/null
@@ -0,0 +1,168 @@
+kas interactive            AFS Commands         kas interactive
+
+
+NAME
+
+   kas     interactive -- enter     interactive    mode    for
+
+                       Authentication Server.
+
+
+   kas interactive
+   [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+            [-servers <explicit list of authentication
+           +
+   servers> ]  [-noauth]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas i  [-a <admin principal to use for authentication>]  [-p
+   <admin password>]
+   [-c <cell name>]  [-s <explicit list of authentication
+           +
+   servers> ]
+   [-n]  [-h]
+
+DESCRIPTION
+
+   Enters interactive mode.  By establishing  an  authenticated
+   connection in this way, the issuer will not have to type his
+   or her password at each command as  would  be  necessary  in
+   regular  mode.    The authenticated connection lasts for one
+   hour unless the maximum ticket lifetime for  the  issuer  or
+   the Authentication Server is shorter.
+
+   It   is   also  possible  to  establish  an  unauthenticated
+   connection under the identity anonymous by using the -noauth
+   flag.    During normal operation, there is no point to doing
+   so,   because   the   Authentication   Server   still   does
+   authorization  checking and will not allow anonymous, who is
+   unprivileged by definition, to perform privileged commands.
+
+   A possible situation in which an issuer might wish to  enter
+   interactive  mode unauthenticated is if he or she knows that
+   attempting to authenticate will cause a problem,  but  wants
+   to  list  some  unprivileged  information.    Attempting  to
+   authenticate could cause a problem,  for  instance,  if  the
+   Authentication  Server  no longer knows the key used to seal
+   the ticket  the  user  has  (perhaps  it  is  no  longer  in
+   /usr/afs/etc/KeyFile).
+
+   The other repercussions of entering interactive mode are:
+
+      - A  "ka>"  prompt  replaces  the  issuer's  regular
+        prompt
+
+      - It is no longer necessary or legal to type kas  at
+        the  beginning  of  a command.  Type the operation
+        code as the first part of the command
+
+      - It is not useful to include the  common  arguments
+        described in section 4.3 in the Reference Manual :
+
+
+
+        -admin_username,    -password_for_admin,    -cell,
+        -servers.  They are ignored, because the variables
+        corresponding to them are set as the issuer enters
+        interactive  mode,  and  cannot be changed without
+        leaving interactive mode.  It is legal to  provide
+        the -help flag.
+
+   There are two additional ways to enter interactive mode:
+
+      1. Type kas without any operation code.  By default,
+         the command interpreter establishes a  connection
+         with  all  of  the  Authentication Servers in the
+         local cell.  They  attempt  to  authenticate  the
+         user  logged  into  the  machine  from  which the
+         command is issued,  based  on  the  password  the
+         issuer  provides  at  the  prompt. The issuer may
+         specify an  alternate  identity,  password,  cell
+         name  and/or  list  of  Authentication Servers by
+         using the first four common  arguments  described
+         in  section  4.3  in the Reference Manual .  Type
+         kas followed  by  a  user  name  and  cell  name,
+         separated   by   an   "@"   sign   (example:  kas
+         smith@transarc.com).  The  Authentication  Server
+         attempts  to  authenticate  the specified user in
+         the specified cell, and prompts for  his  or  her
+         password  in  the specified cell.  This method is
+         most useful  when  the  issuer  wishes  to  enter
+         interactive  mode  with a different identity than
+         the one under which he or she is currently logged
+         on.
+
+ARGUMENTS
+
+   -admin_username   specifies  the  user  name under which the
+                     issuer wishes to perform the command.   If
+                     the   issuer  does  not  provide  it,  the
+                     current identity is used.  See section 4.3
+                     in  the Reference Manual for more details.
+                     -password_for_admin
+                     specifies   the  issuer's  password.    If
+                     provided here, the password is visible  on
+                     the  screen.    If  the  issuer  does  not
+                     provide it, it will be  prompted  for  and
+                     not be visible on the screen.  See section
+                     4.3  in  the  Reference  Manual  for  more
+                     details.  -cell
+                     specifies the cell in  which  to  run  the
+                     command,  if  not  the  local  cell.   See
+                     section 4.3 in the  Reference  Manual  for
+                     more details.  -servers
+                     specifies the database  server  machine(s)
+                     with which to establish a connection.  See
+                     section 4.3 in the  Reference  Manual  for
+                     more details.  -noauth
+                     establishes an unauthenticated  connection
+                     between  the  Authentication  Servers  and
+                     issuer, whom they assign the  unprivileged
+                     identity  anonymous rather than attempting
+                     mutual   authentication.      Using   this
+                     argument  on  this  command is useful only
+                     when authorization checking is disabled on
+
+
+
+                     the   file   server  machine  (during  the
+                     installation of a file server  machine  or
+                     when  bos setauth  has  been  used  during
+                     other  unusual  circumstances).      Under
+                     normal        authorization       checking
+                     circumstances, the Authentication  Servers
+                     will  allow  only  authorized (privileged)
+                     users to issue commands  that  change  the
+                     status  of a server or configuration file,
+                     even if the -noauth  flag  was  used  when
+                     entering  interactive  mode.   See section
+                     4.3  in  the  Reference  Manual  for  more
+                     details.  -help
+                     prints the online help for  this  command.
+                     Do  not  provide  any  other  arguments or
+                     flags with this one.  See section  4.3  in
+                     the Reference Manual for more details.
+
+EXAMPLE
+
+   The  following shows a user entering interactive mode as the
+   privileged user admin.
+
+   % kas i admin  Password for admin:  ka>
+
+PRIVILEGE REQUIRED
+
+   None.  A password will be prompted for, and  something  must
+   be  typed  in  response, but the issuer needs to provide the
+   correct  password  only  if  he  or  she  wishes  to   issue
+   privileged commands while in interactive mode.  If he or she
+   provides  an  wrong  character  string,  the  Authentication
+   Server assigns the unprivileged identity anonymous.
+
+MORE INFORMATION
+
+   (kas) noauthentication (kas) quit
diff --git a/src/man/kas_list.1 b/src/man/kas_list.1
new file mode 100644 (file)
index 0000000..4b74b7e
--- /dev/null
@@ -0,0 +1,88 @@
+kas list                   AFS Commands                kas list
+
+
+NAME
+
+   kas   list -- list   all   entries  in  the  Authentication
+
+                       Database.
+
+
+   kas list  [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+           [-servers <explicit list of authentication
+           +
+   servers> ]
+   [-noauth]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas ls  [-a <admin principal to use for authentication>]
+   [-p <admin password>]  [-c <cell name>]
+                                                +
+   [-s <explicit list of authentication servers> ]  [-n]  [-h]
+
+DESCRIPTION
+
+   Lists the names of all the entries  (server  and  individual
+   user) in the Authentication Database.
+
+ARGUMENTS
+
+   -admin_username   specifies  the  user  name under which the
+                     issuer wishes to perform the command.   If
+                     the   issuer  does  not  provide  it,  the
+                     current identity is used.  See section 4.3
+                     in  the Reference Manual for more details.
+                     -password_for_admin
+                     specifies  the  issuer's  password.   Note
+                     that provided here the password is visible
+                     on  the  screen.    If the issuer does not
+                     provide it, it will be  prompted  for  and
+                     not be visible on the screen.  See section
+                     4.3  in  the  Reference  Manual  for  more
+                     details.  -cell
+                     specifies the cell in  which  to  run  the
+                     command,  if  not  the  local  cell.   See
+                     section 4.3 in the  Reference  Manual  for
+                     more details.  -servers
+                     specifies the database  server  machine(s)
+                     with which to establish a connection.  See
+                     section 4.3 in the  Reference  Manual  for
+                     more details.  -noauth
+                     establishes an unauthenticated  connection
+                     between  the  Authentication  Servers  and
+                     issuer, whom they assign the  unprivileged
+                     identity  anonymous rather than attempting
+                     mutual authentication.  See section 4.3 in
+                     the  Reference  Manual  for  more details.
+                     -help
+                     prints  the  online help for this command.
+                     Do not  provide  any  other  arguments  or
+                     flags  with  this one.  See section 4.3 in
+                     the Reference Manual for more details.
+
+
+
+OUTPUT
+
+   Each entry appears on its own line.  Some entries have  been
+   created  by  the  Authentication Server for its own internal
+   use (for instance, AuthServer.Admin).
+
+EXAMPLE
+
+   The following example is for the cell small.edu,  which  has
+   five   users   in   it   (the  other  entries  are  for  the
+   Authentication Server's internal use).
+
+   % kas list  AuthServer.Admin  krbtgt.SMALL.EDU  afs  admin
+   pat   smith  jones   terry
+
+PRIVILEGE REQUIRED
+
+   Issuer  must  have  the  ADMIN  flag  set  in  his  or   her
+   Authentication Database entry.
+
+MORE INFORMATION
diff --git a/src/man/kas_listtickets.1 b/src/man/kas_listtickets.1
new file mode 100644 (file)
index 0000000..9525ae5
--- /dev/null
@@ -0,0 +1,80 @@
+kas listtickets            AFS Commands         kas listtickets
+
+
+NAME
+
+   kas listtickets -- list all tickets (tokens) for issuer.
+
+
+   kas listtickets  [-name <name of server>]  [-long]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas listt  [-n <name of server>]  [-l]  [-h]
+
+DESCRIPTION
+
+   Lists  all  the  tickets  (tokens)  for  the  issuer,  if no
+   arguments are provided.  If  name  of  server  is  provided,
+   lists only the ticket good for that server process ("afs" is
+   the most common server).  If the -long switch  is  provided,
+   the  output shows octal strings representing the session key
+   and ticket itself.
+
+ARGUMENTS
+
+   -name specifies the  server  name  for  which  to  list  the
+         ticket.
+
+   -long specifies  that  the  output  should display the octal
+         number  strings  constituting  the  session  key   and
+         ticket,  along  with other information (see the OUTPUT
+         section).  The session  key  is  the  one  also  found
+         within the ticket.
+
+   -help prints  the  online  help  for  this  command.  Do not
+         provide any other arguments or flags  with  this  one.
+         See  section  4.3  in  the  Reference  Manual for more
+         details.
+
+OUTPUT
+
+   The output reports for whom the  ticket  is  valid  and  the
+   ticket's expiration date.  If no cell specification appears,
+   then the ticket is valid in the local cell.
+
+   If the -long flag is used, the  output  displays  the  octal
+   numbers making up the session key and ticket, along with the
+   key version number and the number of  bytes  in  the  ticket
+   (this should always be 56).  If a "[>> POSTDATED <<]" marker
+   appears where the expiration date normally does, the  ticket
+   does  not  become  valid  until  the  indicated  time. (Only
+   internal calls can create a postdated ticket;  there  is  no
+   standard interface that allows users to do this.)
+
+
+
+EXAMPLES
+
+   The  following two examples are for a user with AFS UID 1020
+   in  the  transarc.com  cell  and   AFS   UID   35   in   the
+   test.transarc.com  cell.   He is working on a machine in the
+   former cell and is authenticated in both cells.
+
+   % kas listtickets
+
+       User's (AFS ID 1020) tokens for afs [Expires Wed Jan
+       User's (AFS ID 35@test.transarc.com) tokens for afs@
+            [Expires Wed Jan 3 13:54:26 1990]
+
+   % kas listtickets afs -l
+
+       User's (AFS ID 1020) tokens for afs [Expires Wed Jan
+       SessionKey: \375\205\351\227\032\310\263\013
+       Ticket: (kvno = 0, len = 56): \033\005\221S\203d\312
+
+PRIVILEGE REQUIRED
+
+   None. A password is not prompted for.
+
+MORE INFORMATION
diff --git a/src/man/kas_noauthentication.1 b/src/man/kas_noauthentication.1
new file mode 100644 (file)
index 0000000..5bd6045
--- /dev/null
@@ -0,0 +1,62 @@
+kas noauthentication       AFS Commands    kas noauthentication
+
+
+NAME
+
+   kas  noauthentication -- discard  authenticated identity in
+
+                       interactive mode.
+
+
+   (kas) noauthentication  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   (kas) n  [-h]
+
+DESCRIPTION
+
+   Instructs the Authentication Server to close the (presumably
+   authenticated)   connection   established  when  the  issuer
+   entered interactive mode.  It opens  a  new  unauthenticated
+   connection,  assigning  the issuer the unprivileged identity
+   anonymous.  It does not actually  flush  the  user's  tokens
+   from    the    Cache   Manager's   memory   (as   unlog   or
+   kas forgetticket do).
+
+   This command is useful only in interactive  mode,  in  which
+   case  the issuer should omit the kas command suite name.  If
+   issued in non-interactive mode, it has no effect.
+
+   Like the -noauth flag available on a few kas commands (e.g.,
+   kas interactive)  this  command  is  only  useful in unusual
+   circumstances.  During normal operation, there is  no  point
+   to   throwing   away  an  authenticated  identity  (becoming
+   anonymous).   The   Authentication   Server    still    does
+   authorization  checking and will not allow anonymous, who is
+   unprivileged by definition, to perform privileged commands.
+
+ARGUMENTS
+
+   -help           prints the online help for this command.  Do
+                   not  provide  any  other  arguments or flags
+                   with this one.    See  section  4.3  in  the
+                   Reference Manual for more details.
+
+EXAMPLE
+
+   The  following  discards the authentication information with
+   which the user entered interactive mode.
+
+   kas> no
+
+
+
+PRIVILEGE REQUIRED
+
+   None.  Because this command may  be  issued  only  while  in
+   interactive mode, no password is prompted for.
+
+MORE INFORMATION
+
+   kas interactive
diff --git a/src/man/kas_quit.1 b/src/man/kas_quit.1
new file mode 100644 (file)
index 0000000..d036561
--- /dev/null
@@ -0,0 +1,46 @@
+kas quit                   AFS Commands                kas quit
+
+
+NAME
+
+   kas quit -- leave interactive mode.
+
+
+   (kas) quit  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   (kas) q  [-h]
+
+DESCRIPTION
+
+   Leaves  interactive  mode.    This  command  terminates  the
+   authenticated connection, so the Authentication Server  will
+   again require a password when another kas command is issued.
+
+   This  command  is  useful only in interactive mode, in which
+   case the issuer should omit the kas command suite name.   If
+   issued in non-interactive mode, it has no effect.
+
+ARGUMENTS
+
+   -help           prints the online help for this command.  Do
+                   not provide any  other  arguments  or  flags
+                   with  this  one.    See  section  4.3 in the
+                   Reference Manual for more details.
+
+EXAMPLE
+
+   The following shows the return of the normal  command  shell
+   prompt when the issuer leaves interactive mode.
+
+   ka> quit  %
+
+PRIVILEGE REQUIRED
+
+   None.    Because  this  command  may be issued only while in
+   interactive mode, no password is prompted for.
+
+MORE INFORMATION
+
+   kas interactive
diff --git a/src/man/kas_setfields.1 b/src/man/kas_setfields.1
new file mode 100644 (file)
index 0000000..852bd3c
--- /dev/null
@@ -0,0 +1,190 @@
+kas setfields              AFS Commands           kas setfields
+
+
+NAME
+
+   kas  setfields -- set  various  flags,  expiration date and
+
+                       ticket   lifetime   for   Authentication
+                       Database entry.
+
+
+   kas setfields  -name <name of user>
+   [-flags <hex flag value or flag name expression>]
+   [-expiration <date of account expiration>]
+   [-lifetime <maximum ticket lifetime>]
+   [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+            [-servers <explicit list of authentication
+           +
+   servers> ]
+   [-noauth]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas sf  -na <name of user>  [-f <hex flag value or flag name
+   expression>]
+   [-e <date of account expiration>]
+   [-l <maximum ticket lifetime>]
+   [-ad <admin principal to use for authentication>]
+   [-p <admin password>]  [-c <cell name>]
+                                                +
+   [-s <explicit list of authentication servers> ]  [-no]  [-h]
+
+DESCRIPTION
+
+   Changes  the  Authentication Database entry for name of user
+   in the manner specified by the various  optional  arguments,
+   which may occur singly or in combination.  See the ARGUMENTS
+   section for a description of the values that may be set.
+
+   The results of this command are visible in the output of the
+   kas examine command.
+
+ARGUMENTS
+
+   -name     specifies the entry to be affected.
+
+   -flags    sets  any  one  of  four  toggling flags in name's
+             entry.  The default is for none of the flags to be
+             set.  A value of 0 returns all four flags to their
+             defaults.    The  following  explains   the   four
+             non-default  values to set, their meanings and the
+             associated defaults:
+
+           - ADMIN (Hex equivalent: 0x004).  The  name  of
+             user  is  allowed  to  issue  privileged  kas
+             commands (Default: NOADMIN).
+
+           - NOTGS (Hex equivalent: 0x008).    The  Ticket
+             Granting Service will refuse to issue tickets
+             to name of user (Default: TGS).
+
+           - NOSEAL (Hex equivalent: 0x020).   The  Ticket
+
+
+
+             Granting  Service  cannot use the contents of
+             this entry's key field as an  encryption  key
+             (Default: SEAL).
+
+           - NOCPW  (Hex  equivalent: 0x040).  The name of
+             user cannot change his/her/its  own  password
+             or key (Default: CPW).
+
+             Both  upper  and lower-case letters are acceptable
+             in specifying values for the flags.
+
+             To restore the ADMIN flag to its default,  specify
+             NOADMIN.    To  restore  the  other flags to their
+             defaults, omit the NO (i.e.,  type  TGS,  SEAL  or
+             CPW).
+
+             To  set  more  than one flag at once, connect them
+             with plus signs (example:  NOTGS+ADMIN+CPW).    To
+             remove   all  the  current  flag  settings  before
+             setting new ones, precede the whole list  with  an
+             equal sign (example: =NOTGS+ADMIN+CPW).
+
+   -expiration
+             determines when the entry  itself  expires,  which
+             will render an individual user unable to log in to
+             the system, and a server unreachable.  The default
+             is never.
+
+             There are three types of legal values:
+
+                - never, which allows the issuer to return
+                  the expiration time to its default after
+                  having set it to a date.
+
+                - mm/dd/yy  specifies  12:00  a.m.  on the
+                  indicated     date     (month/day/year).
+                  Examples : 1/23/90, 10/7/89.
+
+                - "mm/dd/yy   hh:mm"   specifies   a  time
+                  "hh:mm" (hour:minutes) on the  indicated
+                  date  (month/day/year).  The time should
+                  be in 24-hour format (for example, 20:30
+                  is  8:30  p.m.)  Date format is the same
+                  as for  a  date  alone.    Surround  the
+                  entire  instance  with quotes because it
+                  contains a space.  Examples  :  "1/23/90
+                  22:30", "10/7/89 3:45".
+
+             Legal  values  for yy run from 00 to 37, which are
+             interpreted as the years 2000-2037, and from 70 to
+             99  which  are  interpreted  as  1970-1999.  (This
+             restriction is because the  Authentication  Server
+             converts  the  date  into  the  number  of seconds
+             elapsed since 1 February 1970, to comply with  the
+             standard  UNIX  date  representation;  dates later
+             than  sometime  in  February   2038   exceed   the
+             representation's capacity.)
+
+   -lifetime specifies the upper limit on the validity lifetime
+             that the TGS may stamp on a ticket  issued  to  an
+             individual  or  for a server.  That is, if name of
+
+
+
+             user is an individual, this value is  the  maximum
+             lifetime  of a ticket issued to the user.  If name
+             of user is a server such as "afs," this  value  is
+             the  maximum  lifetime  of  a  ticket that the TGS
+             issues to clients in order to contact the server.
+
+             To specify a number of hours, include a  colon  in
+             the  number  (example:    1:00  means  one  hour).
+             Otherwise, the number is assumed to be in  seconds
+             (so 3600 means one hour).  If this argument is not
+             provided, the  default  setting  is  100:00  hours
+             (360000 seconds).
+
+   -admin_username
+             specifies  the  user  name  under which the issuer
+             wishes to perform the command.  If the issuer does
+             not provide it, the current identity is used.  See
+             section 4.3  in  the  Reference  Manual  for  more
+             details.  -password_for_admin
+             specifies  the  issuer's  password.    If provided
+             here, the password is visible on the screen.    If
+             the  issuer  does  not  provide  it,  it  will  be
+             prompted for and not be  visible  on  the  screen.
+             See  section  4.3 in the Reference Manual for more
+             details.  -cell
+             specifies the cell in which to run the command, if
+             not the local  cell.    See  section  4.3  in  the
+             Reference Manual for more details.  -servers
+             specifies  the  database  server  machine(s)  with
+             which  to establish a connection.  See section 4.3
+             in the Reference Manual for more details.  -noauth
+             establishes  an unauthenticated connection between
+             the Authentication Servers and issuer,  whom  they
+             assign  the unprivileged identity anonymous rather
+             than  attempting  mutual  authentication.      See
+             section  4.3  in  the  Reference  Manual  for more
+             details.
+
+   -help     prints the online help for this command.   Do  not
+             provide  any  other  arguments  or flags with this
+             one.  See section 4.3 in the Reference Manual  for
+             more details.
+
+EXAMPLE
+
+   In  the  following, admin grants administrative privilege to
+   smith, and makes smith's entry  expire  at  midnight  on  31
+   December 1995.
+
+   % kas sf smith ADMIN 12/31/95  Password for admin:
+
+PRIVILEGE REQUIRED
+
+   Issuer   must  have  the  ADMIN  flag  set  in  his  or  her
+   Authentication Database entry.
+
+MORE INFORMATION
+
+   kas examine
diff --git a/src/man/kas_setkey.1 b/src/man/kas_setkey.1
new file mode 100644 (file)
index 0000000..4f003ea
--- /dev/null
@@ -0,0 +1,159 @@
+kas setkey                 AFS Commands              kas setkey
+
+
+NAME
+
+   kas  setkey -- insert  octal key directly into key field of
+
+                       Database entry.
+
+
+   kas setkey  -name <name of user>  -new_key <eight byte new
+   key>    [-kvno <keyversion number>]
+   [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+                                                             +
+          [-servers <explicit list of authentication servers> ]
+          [-noauth]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas setk -na <name of user> -ne <eight byte new key>
+   [-k <key version number>]
+   [-a <admin principal to use for authentication>]  [-p <admin
+   password>]
+   [-c <cell name>]  [-s <explicit list of authentication
+           +
+   servers> ]  [-no]  [-h]
+
+DESCRIPTION
+
+   Accepts the octal number string eight byte new  key,  places
+   it  in  the key field of the Database entry for name of user
+   and marks it with key version  number  key  version  number.
+   This  command makes most sense when name of user is a server
+   process (such as "afs") rather than an individual  user,  as
+   discussed in the Warning section.  For individual users, use
+   the kas setpassword command instead.
+
+   When changing the key in a server entry, remember  to  alter
+   the /usr/afs/etc/KeyFile with the bos addkey command and use
+   the same key version number in both places.
+
+WARNING
+
+   Using this command to change user  passwords  is  needlessly
+   complicating,  for the following reason.  The Authentication
+   Database stores both user passwords and server keys as octal
+   strings,  never  as  character  strings.    When a character
+   string is provided in  the  kas   setpassword  command  (see
+   above),  the  Authentication  Server  calls  an algorithm to
+   convert the string into an octal-form encryption  key,  then
+   stores  the  key  in the key field of the appropriate entry.
+   The kas setkey command (this one)  bypasses  the  conversion
+   algorithm, entering eight byte new key directly into the key
+   field.  If an octal string is simply invented, there  is  no
+   way  to  discover  which character string it corresponds to.
+   To use this command to change a user  password,  the  issuer
+   would  need  to translate the password character string into
+   an  octal  key  using  kas   stringtokey  and  specify   the
+   resulting string as eight byte new key here.  Otherwise, the
+   user would not know what password to type at login.
+
+   The main use for this command is to  set  server  encryption
+
+
+
+   keys,  if  the  system  administrator first executes the bos
+   addkey command to add a  new  key  to  /usr/afs/etc/KeyFile.
+   That  command  accepts  only  strings and converts them into
+   octal keys, just like kas setpassword, but the  output  from
+   the  bos  listkeys  command  will  then reveal the converted
+   octal form of the string, which is the eight  byte  new  key
+   that should be specified here.
+
+ARGUMENTS
+
+   -name             specifies  the  entry for which to replace
+                     the key field.
+
+   -new_key          specifies a string of  eight  bytes,  each
+                     consisting  of  EITHER a three-digit octal
+                     number preceded by a backslash OR a single
+                     ASCII  character.  The issuer must provide
+                     it  on  the  command  line  where  it   is
+                     visible, as there is no prompt for it.
+
+                     Outside    interactive    mode,   surround
+                     octalkey with single quotes, or the  shell
+                     will  throw away the backslashes.  When in
+                     interactive  mode,  do  not  include   the
+                     single quotes.
+
+   -kvno             specifies    the    key   version   number
+                     associated with the new key.  It  must  be
+                     an integer in the range 0 through 255.  In
+                     addition, 999 is reserved for the "bcrypt"
+                     key  used  in  AFS 2.0 authentication.  If
+                     the issuer does not provide this argument,
+                     it  defaults  to  0, which is probably not
+                     desirable for server keys.
+
+   -admin_username   specifies the user name  under  which  the
+                     issuer  wishes to perform the command.  If
+                     the  issuer  does  not  provide  it,   the
+                     current identity is used.  See section 4.3
+                     in the Reference Manual for more  details.
+                     -password_for_admin
+                     specifies  the  issuer's  password.     If
+                     provided  here, the password is visible on
+                     the  screen.    If  the  issuer  does  not
+                     provide  it,  it  will be prompted for and
+                     not be visible on the screen.  See section
+                     4.3  in  the  Reference  Manual  for  more
+                     details.  -cell
+                     specifies  the  cell  in  which to run the
+                     command, if  not  the  local  cell.    See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -servers
+                     specifies  the  database server machine(s)
+                     with which to establish a connection.  See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -noauth
+                     establishes  an unauthenticated connection
+                     between  the  Authentication  Servers  and
+                     issuer,  whom they assign the unprivileged
+                     identity anonymous rather than  attempting
+                     mutual authentication.  See section 4.3 in
+
+
+
+                     the Reference  Manual  for  more  details.
+                     -help
+                     prints the online help for  this  command.
+                     Do  not  provide  any  other  arguments or
+                     flags with this one.  See section  4.3  in
+                     the Reference Manual for more details.
+
+
+
+EXAMPLE
+
+   The  following  shows  admin  setting the "afs" key with key
+   version number 15.
+
+   % kas setk afs \222\260\334\241c\212\274W 15  Password for
+   admin:
+
+PRIVILEGE REQUIRED
+
+   Individual users may use this command to  change  their  own
+   keys,  though  this is not advised for the reasons stated in
+   the WARNING section.  To change server  encryption  keys  or
+   the  key field in another user's entry, issuer must have the
+   ADMIN flag set in his or her Authentication Database entry.
+
+MORE INFORMATION
+
+   bos addkey bos listkeys kas setpassword
diff --git a/src/man/kas_setpassword.1 b/src/man/kas_setpassword.1
new file mode 100644 (file)
index 0000000..ba14c8c
--- /dev/null
@@ -0,0 +1,137 @@
+kas setpassword            AFS Commands         kas setpassword
+
+
+NAME
+
+   kas setpassword -- change key field in Database entry.
+
+
+   kas setpassword  -name <name of user>
+   [-new_password <new password>]
+   [-kvno <key version number>]
+   [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+            [-servers <explicit list of authentication
+           +
+   servers> ]
+   [-noauth]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas sp  -na <name of user> [-ne <new password>]
+   [-k <key version number>]
+   [-a <admin principal to use for authentication>]
+   [-p <admin password>]  [-c <cell name>]
+                                                +
+   [-s <explicit list of authentication servers> ]  [-no]  [-h]
+
+DESCRIPTION
+
+   Accepts a character string new password of unlimited length,
+   scrambles it into a form suitable for use as  an  encryption
+   key, and places it in the key field of name's Authentication
+   Database entry.
+
+   There is little reason to type new password on  the  command
+   line,  where  it is visible.  If the issuer does not provide
+   the password on the command line, a
+
+   new_password:
+
+   prompt appears, followed by a  second  prompt  requesting  a
+   repetition  of the new password.  In both cases the password
+   does not echo visibly.  The second  prompt  guarantees  that
+   the  issuer did not make a typing mistake when responding to
+   the first prompt.
+
+   When adding server keys (such as "afs"), remember to add the
+   new  key  to  the  /usr/afs/etc/KeyFile using the bos addkey
+   command and to use the same  key  version  number  there  as
+   here.     See  the  AFS  System  Administrator's  Guide  for
+   instructions.
+
+
+
+ARGUMENTS
+
+   -name             specifies the entry for which  to  replace
+                     the key field.
+
+   -new_password     is the character string the user will type
+                     when  logging  in.    It   should   be   8
+                     characters   or   less,  as  some  non-AFS
+                     programs cannot handle  longer  passwords.
+                     The  Authentication  Server  scrambles  it
+                     into a  string  of  octal  numbers  before
+                     storing it in the key field.
+
+   -kvno             specifies    the    key   version   number
+                     associated with the new key.  It  must  be
+                     an   integer   between  0  and  255.    In
+                     addition, 999 is reserved for the "bcrypt"
+                     key  used  in  AFS 2.0 authentication.  If
+                     the issuer does not provide this argument,
+                     it  defaults  to  0, which is probably not
+                     desirable for server keys.
+
+   -admin_username   specifies the user name  under  which  the
+                     issuer  wishes to perform the command.  If
+                     the  issuer  does  not  provide  it,   the
+                     current identity is used.  See section 4.3
+                     in the Reference Manual for more  details.
+                     -password_for_admin
+                     specifies  the  issuer's  password.     If
+                     provided  here, the password is visible on
+                     the  screen.    If  the  issuer  does  not
+                     provide  it,  it  will be prompted for and
+                     not be visible on the screen.  See section
+                     4.3  in  the  Reference  Manual  for  more
+                     details.  -cell
+                     specifies  the  cell  in  which to run the
+                     command, if  not  the  local  cell.    See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -servers
+                     specifies  the  database server machine(s)
+                     with which to establish a connection.  See
+                     section  4.3  in  the Reference Manual for
+                     more details.  -noauth
+                     establishes  an unauthenticated connection
+                     between  the  Authentication  Servers  and
+                     issuer,  whom they assign the unprivileged
+                     identity anonymous rather than  attempting
+                     mutual authentication.  See section 4.3 in
+                     the Reference  Manual  for  more  details.
+                     -help
+                     prints the online help for  this  command.
+                     Do  not  provide  any  other  arguments or
+                     flags with this one.  See section  4.3  in
+                     the Reference Manual for more details.
+
+EXAMPLE
+
+   The  following  shows  privileged  user admin changing pat's
+   password (presumably because pat forgot the former  password
+   or got locked out of his account in some other way.
+
+
+
+       % kas sp pat
+       Password for admin:
+       new_password:
+       Verifying, please re-enter new_password:
+
+
+
+PRIVILEGE REQUIRED
+
+   An  individual  user  may  change  his  or her own password,
+   although use of the kpasswd command is recommended  instead.
+   To  change  another  user's password or the password (server
+   encryption key) for server processes such as  "afs",  issuer
+   must  have  the  ADMIN flag set in his or her Authentication
+   Database entry.
+
+MORE INFORMATION
+
+   bos addkey kas setkey
diff --git a/src/man/kas_statistics.1 b/src/man/kas_statistics.1
new file mode 100644 (file)
index 0000000..b4ae547
--- /dev/null
@@ -0,0 +1,124 @@
+kas statistics             AFS Commands          kas statistics
+
+
+NAME
+
+   kas     statistics -- display     statistics    from    one
+
+                       Authentication Server process.
+
+
+   kas statistics
+   [-admin_username <admin principal to use for
+   authentication>]
+   [-password_for_admin <admin password>]  [-cell <cell name>]
+             [-servers <explicit list of authentication
+           +
+   servers> ]
+   [-noauth]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas sta  [-a <admin principal to use for authentication>]
+   [-p <admin password>]  [-c <cell name>]
+                                                +
+   [-s <explicit list of authentication servers> ]  [-n]  [-h]
+
+DESCRIPTION
+
+   Displays statistics from one of the cell's  database  server
+   machines.  It is recommended that the issuer use -servers to
+   specify  one  machine  name.      Otherwise,   the   command
+   interpreter  displays  statistics  for  a  machine chosen at
+   random from all the database server machines with  which  it
+   has established connections.
+
+WARNING
+
+   If  this  command  is  issued in interactive mode, it is not
+   possible to  specify  a  file  server  machine  because  the
+   -servers   argument  is  inoperative.    If  the  issuer  is
+   interested in a particular file server machine, it  is  best
+   to leave interactive mode.
+
+ARGUMENTS
+
+   -admin_username specifies  the  user  name  under  which the
+                   issuer wishes to perform the  command.    If
+                   the  issuer does not provide it, the current
+                   identity is used.  See section  4.3  in  the
+                   Reference    Manual    for   more   details.
+                   -password_for_admin
+                   specifies  the issuer's password.  Note that
+                   provided here the password is visible on the
+                   screen.   If the issuer does not provide it,
+                   it will be prompted for and not  be  visible
+                   on  the  screen.    See  section  4.3 in the
+                   Reference Manual for more details.  -cell
+                   specifies  the  cell  in  which  to  run the
+                   command, if not the local cell.  See section
+                   4.3   in   the  Reference  Manual  for  more
+                   details.  -servers
+                   specifies  the  database  server  machine(s)
+                   with which to establish a connection.  It is
+                   recommended   that   the   issuer  use  this
+
+
+
+                   argument and specify a single machine.
+
+   -noauth         establishes  an  unauthenticated  connection
+                   between   the   Authentication  Servers  and
+                   issuer, whom they  assign  the  unprivileged
+                   identity  anonymous  rather  than attempting
+                   mutual authentication.  See section  4.3  in
+                   the   Reference  Manual  for  more  details.
+                   -help
+                   prints the online help for this command.  Do
+                   not provide any  other  arguments  or  flags
+                   with  this  one.    See  section  4.3 in the
+                   Reference Manual for more details.
+
+OUTPUT
+
+   The information includes:
+
+      - server's network address number and  last  startup
+        date
+
+      - number   of  requests  and  aborted  requests  for
+        various   services:      authentication,    ticket
+        granting, password setting, entry listing, etc
+
+      - number of entries with ADMIN flag
+
+EXAMPLE
+
+   The  following show the output when someone authenticated as
+   the  privileged  user  admin  issues  this   command   about
+   fs1.transarc.com.
+
+       % kas stat -s fs1.transarc.com
+       56 allocs, 46 frees, 0 password changes
+       Hash table utilization = 0.100000%
+       From host c037cf05 started at Tue Mar 20 12:42:02 19
+         of 88 requests for Authenticate, 18 were aborted.
+         of 14 requests for GetTicket, 0 were aborted.
+         of 4 requests for CreateUser, 1 were aborted.
+         of 12 requests for SetFields, 4 were aborted.
+         of 3 requests for DeleteUser, 0 were aborted.
+         of 23 requests for GetEntry, 4 were aborted.
+         of 18 requests for ListEntry, 0 were aborted.
+         of 2 requests for GetStats, 1 were aborted.
+         of 2 requests for GetRandomKey, 0 were aborted.
+       Used 6.015 seconds of CPU time.
+       1 admin accounts
+
+PRIVILEGE REQUIRED
+
+   Issuer   must  have  the  ADMIN  flag  set  in  his  or  her
+   Authentication Database entry.
+
+MORE INFORMATION
+
+   kas debuginfo
diff --git a/src/man/kas_stringtokey.1 b/src/man/kas_stringtokey.1
new file mode 100644 (file)
index 0000000..806d4c5
--- /dev/null
@@ -0,0 +1,70 @@
+kas stringtokey            AFS Commands         kas stringtokey
+
+
+NAME
+
+   kas stringtokey -- convert a character string into an octal
+
+                       string.
+
+
+   kas stringtokey  -string <password string>  [-cell <cell
+   name>]  [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   kas str  -s <password string>  [-c <cell name>]  [-h]
+
+DESCRIPTION
+
+   Converts the character string password string into an  octal
+   string  suitable  for  use  as  an  encryption key.  This is
+   useful for showing what form a given password would take  in
+   the cell.
+
+   The   algorithm  that  the  Authentication  Server  uses  to
+   generate keys combines password string with the cell's  name
+   during the generation, so use of cell name allows the issuer
+   to see what a string would look like when scrambled  into  a
+   key in a certain cell.
+
+ARGUMENTS
+
+   -string         specifies the password-like character string
+                   to be converted into a key.
+
+   -cell           specifies  the  cell  name  to  be  used  in
+                   converting  password  string into a key.  If
+                   the issuer does not provide it, the  default
+                   is  the cell in which the command is issued.
+                   Provide a complete Internet-style name.
+
+   -help           prints the online help for this command.  Do
+                   not  provide  any  other  arguments or flags
+                   with this one.    See  section  4.3  in  the
+                   Reference Manual for more details.
+
+OUTPUT
+
+   The output is of the form:
+
+       Converting password string in realm 'cell name yield
+
+EXAMPLE
+
+   The  following shows a user in the Transarc Corporation cell
+   deriving the octal key equivalent of the string "new_pswd".
+
+       % kas str new_pswd
+       Converting new_pswd in realm 'TRANSARC.COM' yields
+           key='\255\364b\354\221s\235\313'.
+
+
+
+PRIVILEGE REQUIRED
+
+   None.
+
+MORE INFORMATION
+
+   kas getrandomkey kas setkey
diff --git a/src/man/klog.1 b/src/man/klog.1
new file mode 100644 (file)
index 0000000..e329a3b
--- /dev/null
@@ -0,0 +1,319 @@
+klog                       AFS Commands                    klog
+
+
+NAME
+
+   klog -- authenticate  with  Authentication Server to obtain
+
+                       token.
+
+
+   klog [-x]  [-principal <user name>]  [-password <user's
+   password>]
+   [-tmp]  [-cell <cell name>]  [-servers <explicit list of
+           +
+   servers> ]
+   [-pipe]  [-lifetime <ticket lifetime in hh[:mm[:ss]]>]
+   [-help]
+
+ACCEPTABLE ABBREVIATIONS/ALIASES
+
+   klog [-x]  [-pr <user name>]  [-pa <user's password>] [-t]
+   [-c <cell name>]
+                                 +
+   [-s <explicit list of servers> ]  [-pi]
+   [-l <ticket lifetime in hh[:mm[:ss]]>]  [-h]
+
+DESCRIPTION
+
+   Authenticates the issuer in the indicated cell.  The  issuer
+   obtains a token accepted by the AFS server processes in that
+   cell.  The Cache Manager stores the token  in  a  credential
+   structure associated with the issuer.  If the issuer already
+   has a token for the cell,  the  token  resulting  from  this
+   command replaces it in the credential structure.
+
+   By default, the token generated is appropriate for the local
+   cell (the one to  which  the  local  machine  belongs):  the
+   command interpreter contacts an Authentication Server in the
+   local  cell,   chosen   at   random   from   the   list   in
+   /usr/vice/etc/CellServDB,  and  requests  a  token  for  the
+   issuer logged into the local machine.  Use  the  -principal,
+   -cell  and/or  -servers  arguments  to  specify  a different
+   identity,   cell   or   set   of   Authentication    Servers
+   respectively.     See  the  ARGUMENTS  section  for  further
+   explanation.
+
+   This command does not change the identity  under  which  the
+   issuer is logged into the local UNIX file system.
+
+   The issuer (or user indicated with -principal) does not have
+   to  appear  in  the  local  password  file  (/etc/passwd  or
+   equivalent)  to  issue this command; in previous versions of
+   this command, users had to add the -x flag if they  did  not
+   appear in that file.
+
+   During  a  single  login  on  a given machine, a user can be
+   authenticated in multiple cells simultaneously, but can have
+   only  one  token  at  a  time  for each cell (i.e., can only
+   authenticate under one identity per cell).
+
+   The lifetime of the token resulting from this command is the
+   smallest of the following:
+
+      - the  lifetime  requested  by  the  issuer with the
+
+
+
+        -lifetime  argument.    If  the  issuer  does  not
+        include  this  argument, the value defaults to 720
+        hours (30 days).
+
+      - the "maximum  ticket  lifetime"  recorded  in  the
+        "afs"  entry  in the Authentication Database.  The
+        default is 100 hours.  Administrators can  inspect
+        this  value using kas examine, and change it using
+        kas setfields.
+
+      - the "maximum  ticket  lifetime"  recorded  in  the
+        issuer's   Authentication  Database  entry.    The
+        default is 25 hours for user  entries  created  by
+        the AFS 3.1 or later version of the Authentication
+        Server, and 100 hours for user entries created  by
+        the  AFS 3.0 version of the Authentication Server.
+        Administrators and the  user  himself/herself  can
+        inspect   this   value   using   kas examine,  and
+        administrators can change it using kas setfields.
+
+      - the "maximum  ticket  lifetime"  recorded  in  the
+        "krbtgt.CELLNAME"   entry  in  the