xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect5 / afs_volume_header.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="afs_volume_header5">
3   <refmeta>
4     <refentrytitle>afs_volume_header</refentrytitle>
5     <manvolnum>5</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>afs_volume_header</refname>
9     <refpurpose>Represents an AFS volume</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Description</title>
13     <para>The <replaceable>V</replaceable><emphasis>vol_ID</emphasis><replaceable>.vol</replaceable> file is the header file for the AFS volume with
14     volume ID <emphasis>vol_ID</emphasis>. There is one such file for each volume stored on an
15     AFS server (<replaceable>/vicep</replaceable>) partition. The header file stores information that
16     includes the volume's name, ID number, type (read/write, read-only, or
17     backup), size and status (online, offline, or busy). To display
18     information from the header file, use the <emphasis role="bold">vos listvol</emphasis> or <emphasis role="bold">vos examine</emphasis>
19     command.</para>
20
21     <para>The header file points to, but does not contain, the actual data in the
22     volume. It is not possible to access the AFS data except by mounting the
23     volume in the AFS filespace and reading its contents through the Cache
24     Manager.</para>
25
26   </refsect1>
27   <refsect1>
28     <title>Copyright</title>
29     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
30
31     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
32     converted from HTML to POD by software written by Chas Williams and Russ
33     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
34
35   </refsect1>
36 </refentry>