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
   5 <refmeta>
   6         <refentrytitle>tdbbackup</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">3.6</refmiscinfo>
  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                 <arg choice="opt">-l</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 or during normal operation. If it finds file damage and it finds
  38         a prior backup the backup file will be restored.
  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 administrator 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 (corrupt data)
  68                 which if detected causes the backup to be restored.
  69                 </para></listitem>
  70                 </varlistentry>
  71
  72                 <varlistentry>
  73                 <term>-l</term>
  74                 <listitem><para>
  75                 This options disables any locking, by passing TDB_NOLOCK
  76                 to tdb_open_ex(). Only use this for database files which
  77                 are not used by any other process! And also only if it is otherwise not
  78                 possible to open the database, e.g. databases which were created with
  79                 mutex locking.
  80                 </para></listitem>
  81                 </varlistentry>
  82
  83         </variablelist>
  84 </refsect1>
  85
  86
  87 <refsect1>
  88         <title>COMMANDS</title>
  89
  90         <para><emphasis>GENERAL INFORMATION</emphasis></para>
  91
  92         <para>
  93         The <command>tdbbackup</command> utility can safely be run at any time. It was designed so
  94         that it can be used at any time to validate the integrity of tdb files, even during Samba
  95         operation. Typical usage for the command will be:
  96         </para>
  97
  98         <para>tdbbackup [-s suffix] *.tdb</para>
  99
 100         <para>
 101         Before restarting samba the following command may be run to validate .tdb files:
 102         </para>
 103
 104         <para>tdbbackup -v [-s suffix] *.tdb</para>
 105
 106         <para>
 107         Note that Samba 4 can use .ntdb files instead, so you should
 108         use <command>ntdbbackup</command> on those files.
 109         </para>
 110
 111         <para>
 112         Samba .tdb files are stored in various locations, be sure to run backup all
 113         .tdb file on the system. Important files includes:
 114         </para>
 115
 116         <itemizedlist>
 117                 <listitem><para>
 118                 <command>secrets.tdb</command> - usual location is in the /usr/local/samba/private
 119                 directory, or on some systems in /etc/samba.
 120                 </para></listitem>
 121
 122                 <listitem><para>
 123                 <command>passdb.tdb</command> - usual location is in the /usr/local/samba/private
 124                 directory, or on some systems in /etc/samba.
 125                 </para></listitem>
 126
 127                 <listitem><para>
 128                 <command>*.tdb</command> located in the /usr/local/samba/var directory or on some
 129                 systems in the /var/cache or /var/lib/samba directories.
 130                 </para></listitem>
 131         </itemizedlist>
 132
 133 </refsect1>
 134
 135 <refsect1>
 136         <title>VERSION</title>
 137
 138         <para>This man page is correct for version 3 of the Samba suite.</para>
 139 </refsect1>
 140
 141 <refsect1>
 142         <title>AUTHOR</title>
 143
 144         <para>
 145         The original Samba software and related utilities were created by Andrew Tridgell.
 146         Samba is now developed by the Samba Team as an Open Source project similar to the way
 147         the Linux kernel is developed.
 148         </para>
 149
 150         <para>The tdbbackup man page was written by John H Terpstra.</para>
 151 </refsect1>
 152
 153 </refentry>