openafs/doc/man-pages/pod5/VolumeItems.pod
Russ Allbery 03b9fcc883 man1-editing-pass-20051209
Complete an initial editing and cleanup pass for all section one man pages.
Fix various conversion problems, formatting inconsistencies, and obvious
problems.  Please note that no editing for content has yet been done; this
is solely editing for formatting and correct conversion to POD.

Also, add some additional section five man pages that were omitted from the
first conversion run due to unusual file names, and globally replace
CAVEATS with CAUTIONS in the man pages to match the original section name.

The section one man pages should now be in reasonable shape and ready for
additional review and further updates, although there are probably still
remaining obvious problems.

====================
This delta was composed from multiple commits as part of the CVS->Git migration.
The checkin message with each commit was inconsistent.
The following are the additional commit messages.
====================

This file got the wrong name when it was originally committed.  Fix.
2005-12-09 14:48:56 +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 CAUTIONS
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.