docs/docbook/manpages/tdbbackup.8.xml

   1 <?xml version="1.0" encoding="iso8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3                   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
   6 ]>
   7 <refentry id="tdbbackup.8">
   8
   9 <refmeta>
  10         <refentrytitle>tdbbackup</refentrytitle>
  11         <manvolnum>8</manvolnum>
  12 </refmeta>
  13
  14
  15 <refnamediv>
  16         <refname>tdbbackup</refname>
  17         <refpurpose>tool for backing up and for validating the integrity of samba .tdb files</refpurpose>
  18 </refnamediv>
  19
  20 <refsynopsisdiv>
  21         <cmdsynopsis>
  22                 <command>tdbbackup</command>
  23                 <arg choice="opt">-s suffix</arg>
  24                 <arg choice="opt">-v</arg>
  25                 <arg choice="opt">-h</arg>
  26         </cmdsynopsis>
  27 </refsynopsisdiv>
  28
  29 <refsect1>
  30         <title>DESCRIPTION</title>
  31
  32         <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
  33         <manvolnum>1</manvolnum></citerefentry> suite.</para>
  34
  35         <para><command>tdbbackup</command> is a tool that may be used to backup samba .tdb
  36         files. This tool may also be used to verify the integrity of the .tdb files prior
  37         to samba startup, in which case, if it find file damage and it finds a prior backup
  38         it will restore the backup file.
  39         </para>
  40 </refsect1>
  41
  42
  43 <refsect1>
  44         <title>OPTIONS</title>
  45
  46         <variablelist>
  47
  48                 <varlistentry>
  49                 <term>-h</term>
  50                 <listitem><para>
  51                 Get help information.
  52                 </para></listitem>
  53                 </varlistentry>
  54
  55                 <varlistentry>
  56                 <term>-s suffix</term>
  57                 <listitem><para>
  58                 The <command>-s</command> option allows the adminisistrator to specify a file
  59                 backup extension. This way it is possible to keep a history of tdb backup
  60                 files by using a new suffix for each backup.
  61                 </para> </listitem>
  62                 </varlistentry>
  63
  64                 <varlistentry>
  65                 <term>-v</term>
  66                 <listitem><para>
  67                 The <command>-v</command> will check the database for damages (currupt data)
  68                 which if detected causes the backup to be restored.
  69                 </para></listitem>
  70                 </varlistentry>
  71
  72         </variablelist>
  73 </refsect1>
  74
  75
  76 <refsect1>
  77         <title>COMMANDS</title>
  78
  79         <para><emphasis>GENERAL INFORMATION</emphasis></para>
  80
  81         <para>
  82         The <command>tdbbackup</command> utility should be run as soon as samba has shut down.
  83         Do NOT run this command on a live database. Typical usage for the command will be:
  84         </para>
  85
  86         <para>tdbbackup [-s suffix] *.tdb</para>
  87
  88         <para>
  89         Before restarting samba the following command may be run to validate .tdb files:
  90         </para>
  91
  92         <para>tdbbackup -v [-s suffix] *.tdb</para>
  93
  94         <para>
  95         Samba .tdb files are stored in various locations, be sure to run backup all
  96         .tdb file on the system. Imporatant files includes:
  97         </para>
  98
  99         <itemizedlist>
 100                 <listitem><para>
 101                 <command>secrets.tdb</command> - usual location is in the /usr/local/samba/private
 102                 directory, or on some systems in /etc/samba.
 103                 </para></listitem>
 104
 105                 <listitem><para>
 106                 <command>passdb.tdb</command> - usual location is in the /usr/local/samba/private
 107                 directory, or on some systems in /etc/samba.
 108                 </para></listitem>
 109
 110                 <listitem><para>
 111                 <command>*.tdb</command> located in the /usr/local/samba/var directory or on some
 112                 systems in the /var/cache or /var/lib/samba directories.
 113                 </para></listitem>
 114         </itemizedlist>
 115
 116 </refsect1>
 117
 118 <refsect1>
 119         <title>VERSION</title>
 120
 121         <para>This man page is correct for version 3.0 of the Samba suite.</para>
 122 </refsect1>
 123
 124 <refsect1>
 125         <title>AUTHOR</title>
 126
 127         <para>
 128         The original Samba software and related utilities were created by Andrew Tridgell.
 129         Samba is now developed by the Samba Team as an Open Source project similar to the way
 130         the Linux kernel is developed.
 131         </para>
 132
 133         <para>The tdbbackup man page was written by John H Terpstra.</para>
 134 </refsect1>
 135
 136 </refentry>