docs/manpages-3/tdbbackup.8.xml

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