openafs/doc/man-pages/pod5/afs_volume_header.pod
Russ Allbery f64a78e701 man5-editing-pass-20051213
This completes the first editing pass of the man pages.  Very little
content editing has been done, but the server and client versions of
various man pages have been combined into a single man page for the
file (affects CellServDB, ThisCell, NetInfo, and NetRestrict), the
descriptions of the various AFS cache files have been combined into one
afs_cache man page, and the descriptions of the two butc log files have
been combined into one butc_logs man page.

For man pages for databases with two files, symlinks are now created on
installation for the secondary file name.

All of the man pages should now be ready for public review, additional
editing and cleanup, and content editing.
2005-12-14 01:30:20 +00:00

27 lines
1.0 KiB
Plaintext

=head1 NAME
afs_volume_header - Represents an AFS volume
=head1 DESCRIPTION
The F<VI<vol_ID>.vol> file is the header file for the AFS volume with
volume ID I<vol_ID>. There is one such file for each volume stored on an
AFS server (F</vicep>) partition. The header file stores information that
includes the volume's name, ID number, type (read/write, read-only, or
backup), size and status (online, offline, or busy). To display
information from the header file, use the B<vos listvol> or B<vos examine>
command.
The header file points to, but does not contain, the actual data in the
volume. It is not possible to access the AFS data except by mounting the
volume in the AFS filespace and reading its contents through the Cache
Manager.
=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.