docs/docbook/manpages/tdbbackup.8.xml

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