summaryrefslogtreecommitdiff
path: root/docs/docbook/manpages/tdbbackup.8.xml
blob: c8c5b7e33db11e845ad062fcc627fd21587cde66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
                  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="tdbbackup.8">

<refmeta>
	<refentrytitle>tdbbackup</refentrytitle>
	<manvolnum>8</manvolnum>
</refmeta>


<refnamediv>
	<refname>tdbbackup</refname>
	<refpurpose>tool for backing up and for validating the integrity of samba .tdb files</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>tdbbackup</command>
		<arg choice="opt">-s suffix</arg>
		<arg choice="opt">-v</arg>
		<arg choice="opt">-h</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry> suite.</para>

	<para><command>tdbbackup</command> is a tool that may be used to backup samba .tdb
	files. This tool may also be used to verify the integrity of the .tdb files prior
	to samba startup, in which case, if it find file damage and it finds a prior backup
	it will restore the backup file.
	</para>
</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<variablelist>

		<varlistentry>
		<term>-h</term>
		<listitem><para>
		Get help information.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-s suffix</term>
		<listitem><para>
		The <command>-s</command> option allows the adminisistrator to specify a file
		backup extension. This way it is possible to keep a history of tdb backup
		files by using a new suffix for each backup.
		</para> </listitem>
		</varlistentry>

		<varlistentry>
		<term>-v</term>
		<listitem><para>
		The <command>-v</command> will check the database for damages (currupt data)
		which if detected causes the backup to be restored.
		</para></listitem>
		</varlistentry>

	</variablelist>
</refsect1>


<refsect1>
	<title>COMMANDS</title>

	<para><emphasis>GENERAL INFORMATION</emphasis></para>

	<para>
	The <command>tdbbackup</command> utility should be run as soon as samba has shut down.
	Do NOT run this command on a live database. Typical usage for the command will be:
	</para>

	<para>tdbbackup [-s suffix] *.tdb</para>

	<para>
	Before restarting samba the following command may be run to validate .tdb files:
	</para>

	<para>tdbbackup -v [-s suffix] *.tdb</para>

	<para>
	Samba .tdb files are stored in various locations, be sure to run backup all
	.tdb file on the system. Imporatant files includes:
	</para>

	<itemizedlist>
		<listitem><para>
		<command>secrets.tdb</command> - usual location is in the /usr/local/samba/private
		directory, or on some systems in /etc/samba.
		</para></listitem>

		<listitem><para>
		<command>passdb.tdb</command> - usual location is in the /usr/local/samba/private
		directory, or on some systems in /etc/samba.
		</para></listitem>

		<listitem><para>
		<command>*.tdb</command> located in the /usr/local/samba/var directory or on some
		systems in the /var/cache or /var/lib/samba directories.
		</para></listitem>
	</itemizedlist>

</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3.0 of the Samba suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>
	The original Samba software and related utilities were created by Andrew Tridgell.
	Samba is now developed by the Samba Team as an Open Source project similar to the way
	the Linux kernel is developed.
	</para> 

	<para>The tdbbackup man page was written by John H Terpstra.</para>
</refsect1>

</refentry>