summaryrefslogtreecommitdiff
path: root/usr.sbin/afs/fs/fs.1
diff options
context:
space:
mode:
Diffstat (limited to 'usr.sbin/afs/fs/fs.1')
-rw-r--r--usr.sbin/afs/fs/fs.1652
1 files changed, 0 insertions, 652 deletions
diff --git a/usr.sbin/afs/fs/fs.1 b/usr.sbin/afs/fs/fs.1
deleted file mode 100644
index b2a3ad79821..00000000000
--- a/usr.sbin/afs/fs/fs.1
+++ /dev/null
@@ -1,652 +0,0 @@
-.Dd March 29, 2000
-.Dt FS 1
-.Os
-.Sh NAME
-.Nm fs
-.Nd Manage AFS directories
-.Sh SYNOPSIS
-.Nm
-.Op Ar command
-.Op Ar args
-.Sh DESCRIPTION
-The
-.Nm
-utility is used to manipulate the AFS filesystem.
-Note that the
-.Nm
-utility does
-.Em not
-modify the traditional
-.Ux
-filesystem, only files in AFS.
-.Pp
-The
-.Nm
-utility provides several commands:
-.Pp
-.Bl -tag -width setmaxpriority -compact
-.It Cm apropos
-locate commands by keyword
-.It Cm arladebug
-tweek arla-debugging flags
-.It Cm checkservers
-check if servers are up
-.It Cm checkvolumes
-not yet implemented
-.It Cm cleanacl
-not yet implemented
-.It Cm copyacl
-not yet implemented
-.It Cm diskfree
-show free partition space
-.It Cm examine
-examine volume status
-.It Cm flush
-remove file from cache
-.It Cm flushvolume
-remove volumedata (and files in volume) from cache
-.It Cm gcpags
-garbage collect pags
-.It Cm getcacheparms
-get cache usage
-.It Cm getcrypt
-get encrypt status
-.It Cm getcellstatus
-get suid cell status
-.It Cm getfid
-get fid
-.It Cm getserverprefs
-not yet implemented
-.It Cm getpriority
-get priority of a file/dir
-.It Cm gp
-shorthand for the
-.Cm getpriority
-command
-.It Cm getmaxpriority
-get max priority for a file gc
-.It Cm gmp
-shorthand for the
-.Cm getmaxpriority
-command
-.It Cm help
-get help for
-.Nm
-.It Cm listacl
-show acl
-.It Cm la
-shorthand for the
-.Cm listacl
-command
-.It Cm listcells
-list cells that the cache handler can communicate with
-.It Cm listquota
-show volume quota
-.It Cm lq
-shorthand for the
-.Cm listquota
-command
-.It Cm quota
-shorthand for the
-.Cm listquota
-command
-.It Cm lsmount
-show a mount point
-.It Cm messages
-not yet implemented
-.It Cm mkmount
-create mount point
-.It Cm connect
-connect mode
-.It Cm monitor
-set remote logging host
-.It Cm newcell
-add new cell
-.It Cm nop
-do a pioctl-nop
-.It Cm quit
-leave interactive mode
-.It Cm exit
-leave interactive mode
-.It Cm rmmount
-delete a mount point
-.It Cm removepriority
-remove priority from file/directory
-.It Cm rmp
-shorthand for the
-.Cm removepriority
-command
-.It Cm setacl
-add an acl entry on a directory
-.It Cm sa
-shorthand for the
-.Cm setacl
-command
-.It Cm setcachesize
-change disk cache size
-.It Cm setcell
-change cell status
-.It Cm setpriority
-set priority of a file/directory
-.It Cm sp
-shorthand for the
-.Cm setpriority
-command
-.It Cm setmaxpriority
-set upper limit of prio gc
-.It Cm smq
-shorthand for the
-.Cm setmaxpriority
-comand
-.It Cm setquota
-change quota on a volume
-.It Cm sq
-shorthand for the
-.Cm setquota
-command
-.It Cm setserverprefs
-not yet implemented
-.It Cm setcrypt
-set encryption on/off
-.It Cm setvol
-not yet implemented
-.It Cm suidcells
-list status of cells
-.It Cm sysname
-read/change sysname
-.It Cm version
-get version of fs and fs_lib
-.It Cm venuslog
-make arlad print status
-.It Cm whereis
-show server(s) of file
-.It Cm whichcell
-show cell of file
-.It Cm wscell
-display cell of workstation
-.It Cm xfsdebug
-tweek xfs-debugging flags
-.It Cm xfsprint
-make xfs print debug info
-.El
-.Pp
-Most
-.Nm
-commands accept the following general arguments:
-.Pp
-.Bd -filled -offset indent -compact
-.Op Fl cell Ar cellname
-Specifies which AFS cell to use, if the default cell is not to be used.
-.Pp
-.Op Fl noauth
-Specifies that
-.Nm
-should not try to authenticate the connection to the server.
-This may be
-useful with shell scripts, or if there is a problem with the AFS cell.
-Note that the server will reject many commands if
-.Fl noauth
-is specified.
-.Pp
-.Ed
-The syntax of the
-.Nm
-commands:
-.Pp
-.Ic fs apropos
-.Bd -filled -offset indent -compact
-Locate commands by keyword
-.Ed
-.Pp
-.Ic fs arladebug
-.Op Ar flags
-.Op Fl cell Ar cellname
-.Op Fl noauth
-.Bd -filled -offset indent -compact
-Tweek arla-debugging flags.
-.Ed
-.Pp
-.Ic fs checkservers
-.Op Fl cell Ar cellname
-.Op Fl noauth
-.Op Fl nopoll
-.Bd -filled -offset indent -compact
-Check if the server in a cell are up.
-If
-.Fl nopoll
-is specified, the servers are not contactad; only internal information is
-printed.
-.Ed
-.Pp
-.Ic fs checkvolumes
-.Bd -filled -offset indent -compact
-Not implemented yet.
-.Ed
-.Pp
-.Ic fs cleanacl
-.Bd -filled -offset indent -compact
-Not implemented yet.
-.Ed
-.Pp
-.Ic fs copyacl
-.Bd -filled -offset indent -compact
-Not implemented yet.
-.Ed
-.Pp
-.Ic fs diskfree
-.Ar path
-.Bd -filled -offset indent -compact
-show free partition space
-.Ed
-.Pp
-.Ic fs examine
-.Op Ar path
-.Bd -filled -offset indent -compact
-Print detailed information about the volume mounted on the specified path
-or the current directory.
-.Ed
-.Pp
-.Ic fs flush
-.Ar path
-.Bd -filled -offset indent -compact
-Flush the file specified, causing it to be stored on the fileserver.
-.Ed
-.Pp
-.Ic fs flushvolume
-.Ar path
-.Bd -filled -offset indent -compact
-Flush all the files in the volume where the file specified is stored,
-causing them to be stored on the fileserver.
-Meta information about the volume is also flushed.
-.Ed
-.Pp
-.Ic fs gcpags
-.Bd -filled -offset indent -compact
-Remove unused PAGs from the kernel.
-.Ed
-.Pp
-.Ic fs getcacheparms
-.Bd -filled -offset indent -compact
-Print information about cache usage.
-.Ed
-.Pp
-.Ic fs getcrypt
-.Bd -filled -offset indent -compact
-Display wether traffic between the client and server is encrypted.
-.Ed
-.Pp
-.Ic fs getcellstatus
-.Ar cellname
-.Bd -filled -offset indent -compact
-Indicate if setuid files are enabled for the specified cell.
-.Ed
-.Pp
-.Ic fs getfid
-.Ar path
-.Bd -filled -offset indent -compact
-Print fid information for a file.
-.Ed
-.Pp
-.Ic fs getserverprefs
-.Bd -filled -offset indent -compact
-Not implemented yet.
-.Ed
-.Pp
-.Ic fs getpriority
-.Bd -filled -offset indent -compact
-Display priority of a file or directory.
-.Ed
-.Pp
-.Ic fs gp
-.Bd -filled -offset indent -compact
-shorthand for the
-.Cm getpriority
-command
-.Ed
-.Pp
-.Ic fs getmaxpriority
-.Bd -filled -offset indent -compact
-Display max priority for a file.
-.Ed
-.Pp
-.Ic fs gmp
-.Op Fl cell Ar cellname
-.Op Fl noauth
-.Bd -filled -offset indent -compact
-Shorthand for the
-.Cm getmaxpriority
-command.
-.Ed
-.Pp
-.Ic fs help
-.Op Fl cell Ar cellname
-.Op Fl noauth
-.Bd -filled -offset indent -compact
-Get help for
-.Nm
-.Ed
-.Pp
-.Ic fs listacl
-.Ar path
-.Bd -filled -offset indent -compact
-Show acl for the specified path or the current directory.
-.Ed
-.Pp
-.Ic fs la
-.Op Fl cell Ar cellname
-.Op Fl noauth
-.Bd -filled -offset indent -compact
-Shorthand for the
-.Cm listacl
-command.
-.Ed
-.Pp
-.Ic fs listcells
-.Bd -filled -offset indent -compact
-List cells that the cache handler can communicate with.
-These are the cells listed in the file
-.Pa /etc/afs/CellServDB .
-.Ed
-.Pp
-.Ic fs listquota
-.Op Ar path
-.Bd -filled -offset indent -compact
-Show the quota for the volume of the file or directory specified.
-.Ed
-.Pp
-.Ic fs lq
-.Bd -filled -offset indent -compact
-shorthand for the
-.Cm listquota
-command
-.Ed
-.Pp
-.Ic fs quota
-.Op Fl cell Ar cellname
-.Op Fl noauth
-.Bd -filled -offset indent -compact
-Shorthand for the
-.Ic listquota
-command.
-.Ed
-.Pp
-.Ic fs lsmount
-.Bd -filled -offset indent -compact
-.Ar path
-Show a mount point.
-.Ed
-.Pp
-.Ic fs messages
-.Bd -filled -offset indent -compact
-Not implemented yet.
-.Ed
-.Pp
-.Ic fs mkmount
-.Ar directory
-.Ar volume
-.Bd -filled -offset indent -compact
-Create a mountpoint.
-Note that the there must not exist a directory named as
-the mount point you are creating.
-.Ed
-.Pp
-.Ic fs connect
-.Op Ar mode
-.Bd -filled -offset indent -compact
-Set or get connected mode, if a mode is specified, the cache manager will be
-set to that mode.
-If not, the current mode will be printed.
-Valid modes are:
-.Bl -tag -width -Fl -compact
-.It Cm connected
-Connected mode - this is the normal operating mode.
-.It Cm fetch
-Fetch only mode - files are retreived from fileserver but are not stored back.
-.It Cm disconnected
-Disconnected mode - files are read and written from/to the cache, and no
-attempt is made to contact a fileserver-
-.El
-.Pp
-Disconnected mode is very useful for machines that are not connected to
-the network at all times, such as laptops.
-Disconnected mode is to be considered very experimental at this stage.
-.Ed
-.Pp
-.Ic fs monitor
-.Bd -filled -offset indent -compact
-Not implemented yet.
-.Ed
-.Pp
-.Ic fs newcell
-.Fl cell Ar cellname
-.Fl servers Ar vldb-servers
-.Op Fl help
-.Bd -filled -offset indent -compact
-Add a new cell to the running configuration of the cache manager, or update
-already existing information.
-This information should also be entered in the file
-.Pa /etc/afs/CellServDB .
-.Ed
-.Pp
-.Ic fs nop
-.Bd -filled -offset indent -compact
-Do a pioctl-nop.
-This is useful for debugging.
-.Ed
-.Pp
-.Ic fs quit
-.Bd -filled -offset indent -compact
-Leave interactive mode.
-.Ed
-.Pp
-.Ic fs exit
-.Bd -filled -offset indent -compact
-Leave interactive mode.
-.Ed
-.Pp
-.Ic fs rmmount
-.Ar mountpoint
-.Bd -filled -offset indent -compact
-Delete a mount point.
-.Ed
-.Pp
-.Ic fs removepriority
-.Ar file
-.Bd -filled -offset indent -compact
-Remove priority from file/directory.
-.Ed
-.Pp
-.Ic fs rmp
-.Bd -filled -offset indent -compact
-Shorthand for the
-.Cm removepriority
-command.
-.Ed
-.Pp
-.Ic fs setacl
-.Bd -filled -offset indent -compact
-Add an acl entry on a directory.
-Each entry consists of two components:
-a user or group and a character string describing the permissions granted
-for that user or group.
-These characters and the permission they represent are:
-.Bl -tag -width Fl -compact
-.It Cm r
-read the files
-.It Cm l
-list the files
-.It Cm i
-insert new files
-.It Cm d
-delete files
-.It Cm w
-write (change) the files
-.It Cm k
-lock files
-.It Cm a
-administer the acl, that is, to change the acl
-.El
-.Pp
-There are also a few convinience strings recognized by
-.Ic fs setacl :
-.Bl -tag -width Fl -compact
-.It Cm none
-removes all permissions.
-.It Cm read
-adds 'rl' permissions, which are suitable for a read-only directory.
-.It Cm write
-adds all permissions except 'a', that is, the user/group can read, write,
-delete etc. but not change the acl of the directory.
-.It Cm all
-add all permissions.
-.El
-.Pp
-Note that in AFS you set the permissions on a directory, and the permissions
-of a file are those of their directory.
-So, if you move a file from one
-directory to another, you might change the permission of the file, as
-the two directories may have different permissions.
-.Pp
-Of the traditional
-.Ux
-permission bits only the user part is honored, and is used for any
-user permissioned by the directories acl.
-The group and world permission bits are ignored, but they are stored.
-.Ed
-.Pp
-.Ic fs sa
-.Bd -filled -offset indent -compact
-shorthand for the
-.Cm setacl
-command
-.Ed
-.Pp
-.Ic fs setcachesize
-.Ar lowvnodes
-.Op Ar highvnodes Ar lowbytes Ar highbytes
-.Bd -filled -offset indent -compact
-Set the size of the disk cache.
-.Ed
-.Pp
-.Ic fs setcell
-.Bd -filled -offset indent -compact
-Not implemented yet.
-.Ed
-.Pp
-.Ic fs setpriority
-.Ar file
-.Ar priority
-.Bd -filled -offset indent -compact
-Set priority of a file/directory.
-.Ed
-.Pp
-.Ic fs sp
-.Bd -filled -offset indent -compact
-Shorthand for the
-.Cm setpriority
-command.
-.Ed
-.Pp
-.Ic fs setmaxpriority
-.Ar macprio
-.Bd -filled -offset indent -compact
-Set upper limit of priority.
-.Ed
-.Pp
-.Ic fs smq
-.Bd -filled -offset indent -compact
-shorthand for the
-.Cm setmaxpriority
-comand
-.Ed
-.Pp
-.Ic fs setquota
-.Ar path
-.Ar quota
-.Bd -filled -offset indent -compact
-Set the quota (in Kbytes) on a volume.
-.Ed
-.Pp
-.Ic fs sq
-.Bd -filled -offset indent -compact
-Shorthand for the
-.Cm setquota
-command.
-.Ed
-.Pp
-.Ic fs setserverprefs
-.Bd -filled -offset indent -compact
-Not implemented yet.
-.Ed
-.Pp
-.Ic fs setcrypt
-.Ar flag
-.Bd -filled -offset indent -compact
-If 'no' is specified, encryption of the traffic to/from fileservers is
-disabled, and if 'yes' is specified, it is enabled.
-.Ed
-.Pp
-.Ic fs setvol
-.Bd -filled -offset indent -compact
-Not implemented yet.
-.Ed
-.Pp
-.Ic fs suidcells
-.Bd -filled -offset indent -compact
-Print cells and wether setuid execution is allowed for them.
-.Ed
-.Pp
-.Ic fs sysname
-.Op Ar sysname
-.Bd -filled -offset indent -compact
-Get or set the value of the '@sys' value.
-.Ed
-.Pp
-.Ic fs version
-.Bd -filled -offset indent -compact
-Print version of fs and fs_lib.
-.Ed
-.Pp
-.Ic fs venuslog
-.Bd -filled -offset indent -compact
-Make afsd print status.
-.Ed
-.Pp
-.Ic fs whereis
-.Op Ar path
-.Bd -filled -offset indent -compact
-Show server(s) of the specified file or the current directory.
-.Ed
-.Pp
-.Ic fs whichcell
-.Op Ar path
-.Bd -filled -offset indent -compact
-Show cell of a file or the current directory.
-.Ed
-.Pp
-.Ic fs wscell
-.Bd -filled -offset indent -compact
-Display default cell of the client.
-.Ed
-.Pp
-.Ic fs xfsdebug
-.Bd -filled -offset indent -compact
-Tweek xfs-debugging flags
-.Ed
-.Pp
-.Ic fs xfsprint
-.Op Ar flags
-.Bd -filled -offset indent -compact
-Make xfs print debug info.
-.Ed
-.Sh SEE ALSO
-.Xr afsd 8 ,
-.Xr pts 1 ,
-.Xr vos 8
-.Sh STANDARDS
-The Arla authors are trying to mimic the behaviour of the original AFS
-utilities.
-.Sh AUTHORS
-The Arla project <http://www.stacken.kth.se/project/arla/>.
-.Sh BUGS
-Some commands are not implemented yet.