FS(1)

NAME
fs - Manage AFS directories

SYNOPSIS
fs [command] [args]

DESCRIPTION
The fs utility is used to manipulate the AFS filesystem. Note that the fs utility does not modify the traditional UNIX filesystem, only files in AFS.

The fs utility provides several commands:

apropos
    locate commands by keyword
arladebug
    tweek arla-debugging flags
checkservers
    check if servers are up
checkvolumes
    check that all volume mapping are correct
cleanacl
    not yet implemented
copyacl
    not yet implemented
diskfree
    show free partition space
examine
    examine volume status
flush
    remove file from cache
flushvolume
    remove volumedata (and files in volume) from cache
gcpags
    garbage collect pags
getcacheparms
    get cache usage
getcrypt
    get encrypt status
getcellstatus
    get suid cell status
getfid
    get fid
getserverprefs
    not yet implemented
getstatistics
    get statistics from the cache manager
getpriority
    get priority of a file/dir
gp  shorthand for the getpriority command
getmaxpriority
    get max priority for a file gc
gmp shorthand for the getmaxpriority command
help
    get help for fs
incompat
    report interface of the pioctl interface
listacl
    show acl
la  shorthand for the listacl command
listcells
    list cells that the cache handler can communicate with
listquota
    show volume quota
lq  shorthand for the listquota command
quota
    shorthand for the listquota command
lsmount
    show a mount point
messages
    not yet implemented
mkmount
    create mount point
mkm shorthand of the mkmount command
connect
    connect mode
monitor
    set remote logging host
newcell
    add new cell
nop do a pioctl-nop
quit
    leave interactive mode
exit
    leave interactive mode
rmmount
    delete a mount point
removepriority
    remove priority from file/directory
rmp shorthand for the removepriority command
setacl
    add an acl entry on a directory
sa  shorthand for the setacl command
setcachesize
    change disk cache size
setcell
    change cell status
setpriority
    set priority of a file/directory
sp  shorthand for the setpriority command
setmaxpriority
    set upper limit of prio gc
smq shorthand for the setmaxpriority command.
setquota
    change quota on a volume
sq  shorthand for the setquota command
setserverprefs
    not yet implemented
setcrypt
    set encryption on/off
setvol
    not yet implemented
suidcells
    list status of cells
sysname
    read/change sysname
version
    get version of fs and fs_lib
venuslog
    make arlad print status
whereis
    show server(s) of file
whichcell
    show cell of file
wscell
    display cell of workstation
nnpfsdebug
    tweek nnpfs-debugging flags
nnpfsprint
    make nnpfs print debug info

Most fs commands accept the following general arguments:

[-cell cellname] Specifies which AFS cell to use, if the default cell is not to be used.

[-noauth] Specifies that fs 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 -noauth is specified.

The syntax of the fs commands:

fs apropos
Locate commands by keyword

fs arladebug [flags] [-cell cellname] [-noauth]
Tweek arla-debugging flags.

fs checkservers [-cell cellname] [-noauth] [-nopoll]
Check if the servers in a cell are available. If -nopoll is specified, the servers are not contactad; only internal information is printed.

fs checkvolumes
Check that all volume mapping are correct and flush all mountpoints from the cache to force them to be reread.

fs cleanacl
Not yet implemented.

fs copyacl
Not yet implemented.

fs diskfree path
Show free space on the partition where the file or directory path is stored

fs examine [path]
Print detailed information about the volume mounted on the specified path or the current directory.

fs flush file
Flush file from the cache, causing it to be stored on the fileserver.

fs flushvolume file
Flush all the files in the volume where the file is stored, causing them to be stored on the fileserver. Meta information about the volume is also flushed.

fs gcpags
Remove unused PAGs from the kernel.

fs getcacheparms
Print information about cache usage.

fs getcrypt
Display whether traffic between the client and server is encrypted.

fs getcellstatus cellname
Indicate if the setuid bit on executable files are honored for the specified cell.

fs getfid path
Print fid information for a file.

fs getserverprefs
Not yet implemented.

fs getstatistics
Get statistics from the cache manager. Possible type to get statistics for are fetchstatus, fetchdata, storestatus, storedata, bulkstatus.

fs getpriority
Display priority of a file or directory.

fs gp
Shorthand for the getpriority command

fs getmaxpriority
Display max priority for a file.

fs gmp [-cell cellname] [-noauth]
Shorthand for the getmaxpriority command.

fs help [-cell cellname] [-noauth]
Get help for fs

fs incompat
returns what interface of the pioctl interface currently is in use.

fs listacl path
Show acl for the specified path or the current directory.

fs la [-cell cellname] [-noauth]
Shorthand for the listacl command.

fs listcells
List cells that the cache handler can communicate with. These are the cells listed in the file /etc/afs/CellServDB.

fs listquota [path]
Show the quota for the volume of the path specified.

fs lq [path]
Shorthand for the listquota command

fs quota [-cell cellname] [-noauth]
Shorthand for the listquota command.

fs lsmount path
Show a mount point.

fs messages
Not yet implemented.

fs mkmount directory volume [-cell cell] [-rw]
Create a mountpoint point to volume in optional cell. If -rw is given, a mountpoint to the readwrite volume is created.

Note that there must not exist a directory named like the mount point you are creating.

fs connect [mode]
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:
connected
    Connected mode - this is the normal operating mode.
fetch
    Fetch only mode - files are retrieved from fileserver but are not stored back.
disconnected
    Disconnected mode - files are read and written from/to the cache, and no attempt is made to contact a fileserver-

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.

fs monitor
Not yet implemented.

fs newcell -cell cellname -servers vldb-servers [-help]
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 /etc/afs/CellServDB.

fs nop
Do a pioctl-nop. This is useful for debugging.

fs quit
Leave interactive mode.

fs exit
Leave interactive mode.

fs rmmount mountpoint
Delete mountpoint.

fs removepriority path
Remove priority from file or directory path.

fs rmp
Shorthand for the removepriority command.

fs setacl
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:
r   read the files
l   list the files
i   insert new files
d   delete files
w   write (change) the files
k   lock files
a   administer the acl, that is, to change the acl

There are also a few convinience strings recognized by fs setacl:
none
    removes all permissions.
read
    adds 'rl' permissions, which are suitable for a read-only directory.
write
    adds all permissions except 'a', that is, the user/group can read, write, delete etc. but not change the acl of the directory.
all add all permissions.

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.

Of the traditional UNIX permission bits only the user part is honored, and is used for any user permissioned by the directorys acl. The group and world permission bits are ignored, but they are stored.

fs sa
Shorthand for the setacl command

fs setcachesize lowvnodes [highvnodes lowbytes highbytes]
Set the size of the disk cache.

fs setcell
Not yet implemented.

fs setpriority file priority
Set priority of a file/directory.

fs sp
Shorthand for the setpriority command.

fs setmaxpriority priority
Set upper limit of priority.

fs smq
Shorthand for the setmaxpriority command.

fs setquota path quota
Set the quota (in Kbytes) on a volume pointed out by path.

fs sq
Shorthand for the setquota command.

fs setserverprefs
Not yet implemented.

fs setcrypt yes | no
If no is specified, encryption of the traffic to/from fileservers is disabled, and if yes is specified, it is enabled.

fs setvol
Not yet implemented.

fs suidcells
Print cells and whether setuid execution is allowed for them.

fs sysname [sysname]
Get or set the value of the '@sys' value.

fs version
Print version of fs and fs_lib.

fs venuslog
Make arlad print status.

fs whereis [path]
Show server(s) of the specified file or the current directory.

fs whichcell [path]
Show cell of a file or the current directory.

fs wscell
Display default cell of the client.

fs nnpfsdebug
Tweek nnpfs-debugging flags

fs nnpfsprint [flags]
Make nnpfs print debug info.

SEE ALSO
pts(1), afsd(8), bos(8), vos(8)

STANDARDS
The Arla authors are trying to mimic the behaviour of the original AFS utilities.

AUTHORS
The Arla project <http://www.stacken.kth.se/project/arla/>.

BUGS
Some commands are not implemented yet.