lib/tdb/man/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 <refentry id="tdbbackup.8">
   4 <refentryinfo><date>2015-04-25</date></refentryinfo>
   5
   6 <refmeta>
   7         <refentrytitle>tdbbackup</refentrytitle>
   8         <manvolnum>8</manvolnum>
   9         <refmiscinfo class="source">Samba</refmiscinfo>
  10         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  11         <refmiscinfo class="version">3.6</refmiscinfo>
  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                 <arg choice="opt">-l</arg>
  27         </cmdsynopsis>
  28 </refsynopsisdiv>
  29
  30 <refsect1>
  31         <title>DESCRIPTION</title>
  32
  33         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  34         <manvolnum>1</manvolnum></citerefentry> suite.</para>
  35
  36         <para><command>tdbbackup</command> is a tool that may be used to backup samba .tdb
  37         files. This tool may also be used to verify the integrity of the .tdb files prior
  38         to samba startup or during normal operation. If it finds file damage and it finds
  39         a prior backup the backup file will be restored.
  40         </para>
  41 </refsect1>
  42
  43
  44 <refsect1>
  45         <title>OPTIONS</title>
  46
  47         <variablelist>
  48
  49                 <varlistentry>
  50                 <term>-h</term>
  51                 <listitem><para>
  52                 Get help information.
  53                 </para></listitem>
  54                 </varlistentry>
  55
  56                 <varlistentry>
  57                 <term>-s suffix</term>
  58                 <listitem><para>
  59                 The <command>-s</command> option allows the administrator to specify a file
  60                 backup extension. This way it is possible to keep a history of tdb backup
  61                 files by using a new suffix for each backup.
  62                 </para> </listitem>
  63                 </varlistentry>
  64
  65                 <varlistentry>
  66                 <term>-v</term>
  67                 <listitem><para>
  68                 The <command>-v</command> will check the database for damages (corrupt data)
  69                 which if detected causes the backup to be restored.
  70                 </para></listitem>
  71                 </varlistentry>
  72
  73                 <varlistentry>
  74                 <term>-l</term>
  75                 <listitem><para>
  76                 This options disables any locking, by passing TDB_NOLOCK
  77                 to tdb_open_ex(). Only use this for database files which
  78                 are not used by any other process! And also only if it is otherwise not
  79                 possible to open the database, e.g. databases which were created with
  80                 mutex locking.
  81                 </para></listitem>
  82                 </varlistentry>
  83
  84         </variablelist>
  85 </refsect1>
  86
  87
  88 <refsect1>
  89         <title>COMMANDS</title>
  90
  91         <para><emphasis>GENERAL INFORMATION</emphasis></para>
  92
  93         <para>
  94         The <command>tdbbackup</command> utility can safely be run at any time. It was designed so
  95         that it can be used at any time to validate the integrity of tdb files, even during Samba
  96         operation. Typical usage for the command will be:
  97         </para>
  98
  99         <para>tdbbackup [-s suffix] *.tdb</para>
 100
 101         <para>
 102         Before restarting samba the following command may be run to validate .tdb files:
 103         </para>
 104
 105         <para>tdbbackup -v [-s suffix] *.tdb</para>
 106
 107         <para>
 108         Samba .tdb files are stored in various locations, be sure to run backup all
 109         .tdb file on the system. Important files includes:
 110         </para>
 111
 112         <itemizedlist>
 113                 <listitem><para>
 114                 <command>secrets.tdb</command> - usual location is in the /usr/local/samba/private
 115                 directory, or on some systems in /etc/samba.
 116                 </para></listitem>
 117
 118                 <listitem><para>
 119                 <command>passdb.tdb</command> - usual location is in the /usr/local/samba/private
 120                 directory, or on some systems in /etc/samba.
 121                 </para></listitem>
 122
 123                 <listitem><para>
 124                 <command>*.tdb</command> located in the /usr/local/samba/var directory or on some
 125                 systems in the /var/cache or /var/lib/samba directories.
 126                 </para></listitem>
 127         </itemizedlist>
 128
 129 </refsect1>
 130
 131 <refsect1>
 132         <title>VERSION</title>
 133
 134         <para>This man page is correct for version 3 of the Samba suite.</para>
 135 </refsect1>
 136
 137 <refsect1>
 138         <title>AUTHOR</title>
 139
 140         <para>
 141         The original Samba software and related utilities were created by Andrew Tridgell.
 142         Samba is now developed by the Samba Team as an Open Source project similar to the way
 143         the Linux kernel is developed.
 144         </para>
 145
 146         <para>The tdbbackup man page was written by John H Terpstra.</para>
 147 </refsect1>
 148
 149 </refentry>