.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "FS 1"
.TH FS 1 "2019-10-22" "OpenAFS" "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
fs \- Introduction to the fs command suite
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The commands in the \fBfs\fR command suite constitute the main administrative
interface to the Cache Manager on an \s-1AFS\s0 client machine, which is
responsible for fetching \s-1AFS\s0 data from file server machines on behalf of
applications running on the client machine.
.PP
There are several categories of commands in the \fBfs\fR command suite:
.IP "\(bu" 4
Commands to set and report how the Cache Manager interacts with server
machines:
\&\fBfs checkservers\fR,
\&\fBfs getcellstatus\fR,
\&\fBfs getcrypt\fR,
\&\fBfs getserverprefs\fR,
\&\fBfs getverify\fR,
\&\fBfs listcells\fR,
\&\fBfs newcell\fR,
\&\fBfs setcbaddr\fR,
\&\fBfs setcell\fR,
\&\fBfs setcrypt\fR,
\&\fBfs setserverprefs\fR,
\&\fBfs setverify\fR,
\&\fBfs sysname\fR,
\&\fBfs uuid\fR,
and \fBfs wscell\fR.
.IP "\(bu" 4
Commands to administer access control lists (ACLs):
\&\fBfs cleanacl\fR,
\&\fBfs copyacl\fR,
\&\fBfs getcalleraccess\fR,
\&\fBfs listacl\fR,
and \fBfs setacl\fR.
.IP "\(bu" 4
Commands to administer server machines, volumes or partitions that house a
given file or directory:
\&\fBfs diskfree\fR,
\&\fBfs examine\fR,
\&\fBfs getfid\fR,
\&\fBfs listquota\fR,
\&\fBfs quota\fR,
\&\fBfs setquota\fR,
\&\fBfs setvol\fR,
\&\fBfs whereis\fR,
and \fBfs whichcell\fR.
.IP "\(bu" 4
Commands to administer the local client cache and related information:
\&\fBfs bypassthreshold\fR,
\&\fBfs checkvolumes\fR,
\&\fBfs cscpolicy\fR,
\&\fBfs flush\fR,
\&\fBfs flushall\fR,
\&\fBfs flushvolume\fR,
\&\fBfs getcacheparms\fR,
\&\fBfs listaliases\fR,
\&\fBfs newalias\fR,
and \fBfs setcachesize\fR.
.IP "\(bu" 4
Commands to administer volume mount points:
\&\fBfs lsmount\fR,
\&\fBfs mkmount\fR,
and \fBfs rmmount\fR.
.IP "\(bu" 4
Commands to control monitoring and tracing:
\&\fBfs debug\fR,
\&\fBfs memdump\fR,
\&\fBfs messages\fR,
\&\fBfs minidump\fR,
\&\fBfs monitor\fR,
\&\fBfs rxstatpeer\fR,
\&\fBfs rxstatproc\fR,
and \fBfs trace\fR.
.IP "\(bu" 4
A command to administer the Cache Manager's interaction with other
file systems:
\&\fBfs exportafs\fR.
.IP "\(bu" 4
Commands to obtain help:
\&\fBfs apropos\fR
and \fBfs help\fR.
.IP "\(bu" 4
A command to display the OpenAFS command suite version: \fBfs version\fR.
.PP
The Cache Manager and the fs commands use and maintain the following
configuration files:
.IP "\fI/etc/openafs/CellServDB\fR" 4
.IX Item "/etc/openafs/CellServDB"
Lists the database server machines in the local cell and any foreign cell
to which the administrator wishes to enable \s-1AFS\s0 access for users working
on the machine. The database server machines run the Authentication,
Backup, Protection and Volume Location (\s-1VL\s0) Server processes, which
maintain databases of administrative information. For users to access a
cell, its \f(CW\*(C`root.cell\*(C'\fR volume must also be mounted in the local cell's \s-1AFS\s0
file tree.
.IP "\fI/etc/openafs/ThisCell\fR" 4
.IX Item "/etc/openafs/ThisCell"
Defines the machine's cell membership with respect to the \s-1AFS\s0 command
suites and Cache Manager access to \s-1AFS\s0 data.
.IP "\fI/etc/openafs/cacheinfo\fR" 4
.IX Item "/etc/openafs/cacheinfo"
Defines configuration parameters for the cache, including its size and
whether it is in memory or on disk.
.PP
In addition, the Cache Manager automatically creates files on the cache
partition (by default, \fI/usr/vice/cache\fR for caching and tracking files
fetched from file server machines.
.PP
For more details, see the reference page for each file.
.SH "OPTIONS"
.IX Header "OPTIONS"
The following flag is available on every command in the fs suite. The
reference page for each command also lists it, but it is described here in
greater detail.
.IP "\fB\-help\fR" 4
.IX Item "-help"
Prints a command's online help message on the standard output stream. Do
not combine this flag with any of the command's other options; when it is
provided, the command interpreter ignores all other options, and only
prints the help message.
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The privileges required for fs commands vary more than for other command
suites. Pay special attention to the \s-1PRIVILEGE REQUIRED\s0 section of each
command description.
.PP
The various types of necessary privilege include:
.IP "\(bu" 4
Having permissions on a directory's \s-1ACL.\s0 For example, creating and
removing mount points requires \f(CW\*(C`a\*(C'\fR (administer), \f(CW\*(C`i\*(C'\fR (insert), and \f(CW\*(C`d\*(C'\fR
(delete) permissions on the \s-1ACL\s0 of the directory in which the mount point
resides.
.IP "\(bu" 4
Being logged onto the machine as the local superuser \f(CW\*(C`root\*(C'\fR. This is
necessary when issuing commands that affect Cache Manager configuration.
.IP "\(bu" 4
Belonging to the system:administrators group in the Protection Database.
.IP "\(bu" 4
No privilege. Many \fBfs\fR commands simply list information.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIafs_cache\fR\|(5),
\&\fICellServDB\fR\|(5),
\&\fIThisCell\fR\|(5)
\&\fIcacheinfo\fR\|(5),
\&\fIfs_apropos\fR\|(1),
\&\fIfs_checkservers\fR\|(1),
\&\fIfs_checkvolumes\fR\|(1),
\&\fIfs_cleanacl\fR\|(1),
\&\fIfs_copyacl\fR\|(1),
\&\fIfs_cscpolicy\fR\|(1),
\&\fIfs_diskfree\fR\|(1),
\&\fIfs_examine\fR\|(1),
\&\fIfs_exportafs\fR\|(1),
\&\fIfs_flush\fR\|(1),
\&\fIfs_flushall\fR\|(1),
\&\fIfs_flushmount\fR\|(1),
\&\fIfs_flushvolume\fR\|(1),
\&\fIfs_getcacheparms\fR\|(1),
\&\fIfs_getcalleraccess\fR\|(1),
\&\fIfs_getcellstatus\fR\|(1),
\&\fIfs_getclientaddrs\fR\|(1),
\&\fIfs_getcrypt\fR\|(1),
\&\fIfs_getfid\fR\|(1),
\&\fIfs_getserverprefs\fR\|(1),
\&\fIfs_getverify\fR\|(1),
\&\fIfs_help\fR\|(1),
\&\fIfs_listacl\fR\|(1),
\&\fIfs_listaliases\fR\|(1),
\&\fIfs_listcells\fR\|(1),
\&\fIfs_listquota\fR\|(1),
\&\fIfs_lsmount\fR\|(1),
\&\fIfs_memdump\fR\|(1),
\&\fIfs_messages\fR\|(1),
\&\fIfs_minidump\fR\|(1),
\&\fIfs_mkmount\fR\|(1),
\&\fIfs_monitor\fR\|(1),
\&\fIfs_newalias\fR\|(1),
\&\fIfs_newcell\fR\|(1),
\&\fIfs_quota\fR\|(1),
\&\fIfs_rmmount\fR\|(1),
\&\fIfs_rxstatpeer\fR\|(1),
\&\fIfs_rxstatproc\fR\|(1),
\&\fIfs_setacl\fR\|(1),
\&\fIfs_setcachesize\fR\|(1),
\&\fIfs_setcbaddr\fR\|(1),
\&\fIfs_setcell\fR\|(1),
\&\fIfs_setclientaddrs\fR\|(1),
\&\fIfs_setcrypt\fR\|(1),
\&\fIfs_setquota\fR\|(1),
\&\fIfs_setserverprefs\fR\|(1),
\&\fIfs_setverify\fR\|(1),
\&\fIfs_setvol\fR\|(1),
\&\fIfs_storebehind\fR\|(1),
\&\fIfs_sysname\fR\|(1),
\&\fIfs_trace\fR\|(1),
\&\fIfs_whereis\fR\|(1),
\&\fIfs_whichcell\fR\|(1),
\&\fIfs_wscell\fR\|(1)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
\&\s-1IBM\s0 Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
This documentation is covered by the \s-1IBM\s0 Public License Version 1.0.  It was
converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
