OpenBSD manual page server

Manual Page Search Parameters
FS(1) General Commands Manual FS(1)

fs — Manage AFS directories

fs [command] [args]

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

The fs utility provides several commands:

locate commands by keyword
tweek arla-debugging flags
check if servers are up
check that all volume mapping are correct
not yet implemented
not yet implemented
show free partition space
examine volume status
remove file from cache
remove volumedata (and files in volume) from cache
garbage collect pags
get cache usage
get encrypt status
get suid cell status
get fid
not yet implemented
get statistics from the cache manager
get priority of a file/dir
shorthand for the getpriority command
get max priority for a file gc
shorthand for the getmaxpriority command
get help for fs
report interface of the pioctl interface
show acl
shorthand for the listacl command
list cells that the cache handler can communicate with
show volume quota
shorthand for the listquota command
shorthand for the listquota command
show a mount point
not yet implemented
create mount point
shorthand of the mkmount command
connect mode
set remote logging host
add new cell
do a pioctl-nop
leave interactive mode
leave interactive mode
delete a mount point
remove priority from file/directory
shorthand for the removepriority command
add an acl entry on a directory
shorthand for the setacl command
change disk cache size
change cell status
set priority of a file/directory
shorthand for the setpriority command
set upper limit of prio gc
shorthand for the setmaxpriority command.
change quota on a volume
shorthand for the setquota command
not yet implemented
set encryption on/off
not yet implemented
list status of cells
read/change sysname
get version of fs and fs_lib
make arlad print status
show server(s) of file
show cell of file
display cell of workstation
tweek nnpfs-debugging flags
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 mode - this is the normal operating mode.
Fetch only mode - files are retrieved from fileserver but are not stored back.
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:
read the files
list the files
insert new files
delete files
write (change) the files
lock files
administer the acl, that is, to change the acl

There are also a few convinience strings recognized by fs setacl:

removes all permissions.
adds 'rl' permissions, which are suitable for a read-only directory.
adds all permissions except 'a', that is, the user/group can read, write, delete etc. but not change the acl of the directory.
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.

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

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

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

Some commands are not implemented yet.

March 29, 2000 The Arla Project