openafs/doc/man-pages/pod5/VolumeItems.pod
Russ Allbery e3dfba8e6c man-page-conversion-20051208
This is the initial conversion of the AFS Adminstrators Reference into POD
for use as man pages.  The man pages are now generated via pod2man from
regen.sh so that only those working from CVS have to have pod2man
available.  The Makefile only installs.  The pages have also been sorted
out into pod1, pod5, and pod8 directories, making conversion to the right
section of man page easier without maintaining a separate list and allowing
for names to be duplicated between pod5 and pod1 or pod8 (which will likely
be needed in a few cases).

This reconversion is done with a new script based on work by Chas Williams.
In some cases, the output is worse than the previous POD pages, but this is
a more comprehensive conversion.

This is only the first step, and this initial conversion has various
problems.  In addition, the file man pages that didn't have simple names
have not been converted in this pass and will be added later.  Some of the
man pages have syntax problems and all of them have formatting errors.  The
next editing pass, coming shortly, will clean up most of the remaining
mess.
2005-12-08 12:14:33 +00:00

42 lines
1.4 KiB
Plaintext

=head1 NAME
VolumeItems - Records location mappings for volumes accessed by a Cache Manager using a
disk cache
=head1 DESCRIPTION
The VolumeItems file records the mapping between volume name and
mount point for each volume that the Cache Manager has accessed since it
initialized on a client machine using a disk cache. The Cache Manager
uses the mappings to respond correctly to queries about the current working
directory, which can come from the operating system or commands such as the
UNIX B<pwd> command.
As it initializes, the Cache Manager creates the binary-format
B<VolumeItems> file in the local disk cache directory, and it must
always remain there. The conventional directory name is
B</usr/vice/cache>.
=head1 CAVEATS
Editing or removing the VolumeItems file can cause a kernel
panic. To refresh the contents of the file, instead use the B<fs
checkvolumes> command. If the B<VolumeItems> file is
accidentally modified or deleted, rebooting the machine usually restores
normal performance.
=head1 SEE ALSO
L<CacheItems(1)>,
L<cacheinfo(1)>,
L<afsd(1)>,
L<fs_checkvolumes(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.