Added tdbbackup man page.

(This used to be commit b217373ba8fc167efc8e68b6db1a9e51e670b12a)

diff --git a/docs/docbook/global.ent b/docs/docbook/global.ent
index 2933602e60c99042679b815a29baa4e440661178..efe33c4ff9b5458472060aca0aaf4707826c427a 100644 (file)
--- a/docs/docbook/global.ent
+++ b/docs/docbook/global.ent
@@ -442,6 +442,7 @@ an Active Directory environment.
 <!ENTITY MAN-SMBSTATUS SYSTEM "manpages/smbstatus.1.sgml">
 <!ENTITY MAN-SMBUMOUNT SYSTEM "manpages/smbumount.8.sgml">
 <!ENTITY MAN-SWAT SYSTEM "manpages/swat.8.sgml">
+<!ENTITY MAN-TDBBACKUP SYSTEM "manpages/tdbbackup.8.sgml">
 <!ENTITY MAN-TESTPARM SYSTEM "manpages/testparm.1.sgml">
 <!ENTITY MAN-TESTPRNS SYSTEM "manpages/testprns.1.sgml">
 <!ENTITY MAN-VFSTEST SYSTEM "manpages/vfstest.1.sgml">

diff --git a/docs/docbook/manpages/tdbbackup.8.sgml b/docs/docbook/manpages/tdbbackup.8.sgml
new file mode 100644 (file)
index 0000000..25b2c27
--- /dev/null
+++ b/docs/docbook/manpages/tdbbackup.8.sgml
@@ -0,0 +1,130 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
+<refentry id="tdbbackup.1">
+
+<refmeta>
+       <refentrytitle>tdbbackup</refentrytitle>
+       <manvolnum>1</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+       <refname>tdbbackup</refname>
+       <refpurpose>tool for backing up and for validating the integrity of samba .tdb files</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+       <cmdsynopsis>
+               <command>tdbbackup</command>
+               <arg choice="opt">-s suffix</arg>
+               <arg choice="opt">-v</arg>
+               <arg choice="opt">-h</arg>
+       </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+       <title>DESCRIPTION</title>
+
+       <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
+       <manvolnum>1</manvolnum></citerefentry> suite.</para>
+
+       <para><command>tdbbackup</command> is a tool that may be used to backup samba .tdb
+       files. This tool may also be used to verify the integrity of the .tdb files prior
+       to samba startup, in which case, if it find file damage and it finds a prior backup
+       it will restore the backup file.
+       </para>
+</refsect1>
+
+
+<refsect1>
+       <title>OPTIONS</title>
+
+       <variablelist>
+
+               <varlistentry>
+               <term>-s suffix</term>
+               <listitem><para>
+               The <term>-s</term> option allows the adminisistrator to specify a file
+               backup extension. This way it is possible to keep a history of tdb backup
+               files by using a new suffix for each backup.
+               </para> </listitem>
+               </varlistentry>
+
+               &stdarg.help;
+
+               <varlistentry>
+               <term>-v</term>
+               <listitem><para>
+               The <term>-v</term> will check the database for damages (currupt data)
+               which if detected causes the backup to be restored.
+               </para></listitem>
+               </varlistentry>
+
+               &popt.common.samba;
+
+       </variablelist>
+</refsect1>
+
+
+<refsect1>
+       <title>COMMANDS</title>
+
+       <para><emphasis>GENERAL INFORMATION</emphasis></para>
+
+       <para>
+       The <command>tdbbackup</command> utility should be run as soon as samba has shut down.
+       Do NOT run this command on a live database. Typical usage for the command will be:
+       </para>
+
+       <para>tdbbackup [-s suffix] *.tdb</para>
+
+       <para>
+       Before restarting samba the following command may be run to validate .tdb files:
+       </para>
+
+       <para>tdbbackup -v [-s suffix] *.tdb</para>
+
+       <para>
+       Samba .tdb files are stored in various locations, be sure to run backup all
+       .tdb file on the system. Imporatant files includes:
+
+       <itemistedlist>
+               <listitem><para>
+               <command>secrets.tdb</command> - usual location is in the /usr/local/samba/private
+               directory, or on some systems in /etc/samba.
+               </para></listitem>
+
+               <listitem><para>
+               <command>passdb.tdb</command> - usual location is in the /usr/local/samba/private
+               directory, or on some systems in /etc/samba.
+               </para></listitem>
+
+               <listitem><para>
+               <command>*.tdb</command> located in the /usr/local/samba/var directory or on some
+               systems in the /var/cache or /var/lib/samba directories.
+               </para></listitem>
+
+       </itemizedlist>
+
+</refsect1>
+
+<refsect1>
+       <title>VERSION</title>
+
+       <para>This man page is correct for version 3.0 of the Samba suite.</para>
+</refsect1>
+
+<refsect1>
+       <title>AUTHOR</title>
+
+       <para>
+       The original Samba software and related utilities were created by Andrew Tridgell.
+       Samba is now developed by the Samba Team as an Open Source project similar to the way
+       the Linux kernel is developed.
+       </para> 
+
+       <para>The tdbbackup man page was written by John H Terpstra.</para>
+</refsect1>
+
+</refentry>