xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect8 / prdb_check.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="prdb_check8">
3   <refmeta>
4     <refentrytitle>prdb_check</refentrytitle>
5     <manvolnum>8</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>prdb_check</refname>
9     <refpurpose>Checks the integrity of the Protection Database</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Synopsis</title>
13     <para><emphasis role="bold">prdb_check</emphasis> <emphasis role="bold">-database</emphasis> &lt;<emphasis>ptdb file</emphasis>&gt; [<emphasis role="bold">-uheader</emphasis>] [<emphasis role="bold">-pheader</emphasis>]
14         [<emphasis role="bold">-entries</emphasis>] [<emphasis role="bold">-verbose</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
15
16     <para><emphasis role="bold">prdb_check</emphasis> <emphasis role="bold">-d</emphasis> &lt;<emphasis>ptdb file</emphasis>&gt; [<emphasis role="bold">-u</emphasis>] [<emphasis role="bold">-p</emphasis>] [<emphasis role="bold">-e</emphasis>] [<emphasis role="bold">-v</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
17
18   </refsect1>
19   <refsect1>
20     <title>Description</title>
21     <para>The <emphasis role="bold">prdb_check</emphasis> command checks the integrity of the Protection Database,
22     reporting any errors or corruption it finds. If there are problems, do not
23     issue any <emphasis role="bold">pts</emphasis> commands until the database is repaired.</para>
24
25   </refsect1>
26   <refsect1>
27     <title>Cautions</title>
28     <para>The results can be unpredictable if the Protection Server makes changes to
29     the Protection Database while this command is running. Use the <emphasis role="bold">bos
30     shutdown</emphasis> command to shutdown the local <emphasis role="bold">ptserver</emphasis> process before running
31     this command, or before creating a second copy of the <replaceable>prdb.DB0</replaceable> file
32     (with a different name) on which to run the command.</para>
33
34   </refsect1>
35   <refsect1>
36     <title>Options</title>
37     <variablelist>
38       <varlistentry>
39         <term><emphasis role="bold">-database</emphasis> &lt;<emphasis>ptdb file</emphasis>&gt;</term>
40         <listitem>
41           <para>Names the Protection Database (copy of the <replaceable>prdb.DB0</replaceable> file) to check. If
42           the current working directory is not the location of the file, provide a
43           pathname, either full or relative to the current working directory.</para>
44
45         </listitem>
46       </varlistentry>
47       <varlistentry>
48         <term><emphasis role="bold">-uheader</emphasis></term>
49         <listitem>
50           <para>Displays information which Ubik maintains in the database's header.</para>
51
52         </listitem>
53       </varlistentry>
54       <varlistentry>
55         <term><emphasis role="bold">-pheader</emphasis></term>
56         <listitem>
57           <para>Displays information which the Protection Server maintains in the
58           database's header.</para>
59
60         </listitem>
61       </varlistentry>
62       <varlistentry>
63         <term><emphasis role="bold">-entries</emphasis></term>
64         <listitem>
65           <para>Outputs every entry in the database. Some of the information is similar to
66           that returned by the <emphasis role="bold">pts examine</emphasis> command.</para>
67
68         </listitem>
69       </varlistentry>
70       <varlistentry>
71         <term><emphasis role="bold">-verbose</emphasis></term>
72         <listitem>
73           <para>Reports additional information about the database, including the number of
74           entries in the database and a trace of the internal database structures
75           the command is verifying.</para>
76
77         </listitem>
78       </varlistentry>
79       <varlistentry>
80         <term><emphasis role="bold">-help</emphasis></term>
81         <listitem>
82           <para>Prints the online help for this command. All other valid options are
83           ignored.</para>
84
85         </listitem>
86       </varlistentry>
87     </variablelist>
88   </refsect1>
89   <refsect1>
90     <title>Output</title>
91     <para>If there are errors in the database, the output always reports them on the
92     standard error stream. If any options other than <emphasis role="bold">-database</emphasis> or <emphasis role="bold">-help</emphasis>
93     are provided, the output written to the standard output stream includes
94     additional information as described for each option in <link linkend="OPTIONS">OPTIONS</link>.  The
95     output is intended for debugging purposes and is meaningful to someone
96     familiar with the internal structure of the Protection Database.</para>
97
98   </refsect1>
99   <refsect1>
100     <title>Privilege Required</title>
101     <para>The issuer must be logged in as the local superuser <computeroutput>root</computeroutput>.</para>
102
103   </refsect1>
104   <refsect1>
105     <title>See Also</title>
106     <para><link linkend="prdb_DB05">prdb.DB0(5)</link>,
107     <link linkend="bos_shutdown8">bos_shutdown(8)</link>,
108     <link linkend="pts_examine1">pts_examine(1)</link>,
109     <link linkend="ptserver8">ptserver(8)</link></para>
110
111   </refsect1>
112   <refsect1>
113     <title>Copyright</title>
114     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
115
116     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
117     converted from HTML to POD by software written by Chas Williams and Russ
118     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
119
120   </refsect1>
121 </refentry>