ading new files from 3.0
[nivanova/samba-autobuild/.git] / docs / manpages / tdbbackup.8
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "TDBBACKUP" 8 "" "" ""
21 .SH NAME
22 tdbbackup \- tool for backing up and for validating the integrity of samba .tdb files
23 .SH "SYNOPSIS"
24
25 .nf
26 \fBtdbbackup\fR [-s suffix] [-v] [-h]
27 .fi
28
29 .SH "DESCRIPTION"
30
31 .PP
32 This tool is part of the \fBSamba\fR(1) suite\&.
33
34 .PP
35 \fBtdbbackup\fR 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\&.
36
37 .SH "OPTIONS"
38
39 .TP
40 -h
41 Get help information\&.
42
43
44 .TP
45 -s suffix
46 The \fB-s\fR 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\&.
47
48
49 .TP
50 -v
51 The \fB-v\fR will check the database for damages (currupt data) which if detected causes the backup to be restored\&.
52
53
54 .SH "COMMANDS"
55
56 .PP
57 \fBGENERAL INFORMATION\fR
58
59 .PP
60 The \fBtdbbackup\fR 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:
61
62 .PP
63 tdbbackup [-s suffix] *\&.tdb
64
65 .PP
66 Before restarting samba the following command may be run to validate \&.tdb files:
67
68 .PP
69 tdbbackup -v [-s suffix] *\&.tdb
70
71 .PP
72 Samba \&.tdb files are stored in various locations, be sure to run backup all \&.tdb file on the system\&. Imporatant files includes:
73
74 .TP 3
75 \(bu
76 \fBsecrets.tdb\fR - usual location is in the /usr/local/samba/private directory, or on some systems in /etc/samba\&.
77
78 .TP
79 \(bu
80 \fBpassdb.tdb\fR - usual location is in the /usr/local/samba/private directory, or on some systems in /etc/samba\&.
81
82 .TP
83 \(bu
84 \fB*.tdb\fR located in the /usr/local/samba/var directory or on some systems in the /var/cache or /var/lib/samba directories\&.
85
86 .LP
87
88 .SH "VERSION"
89
90 .PP
91 This man page is correct for version 3\&.0 of the Samba suite\&.
92
93 .SH "AUTHOR"
94
95 .PP
96 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\&.
97
98 .PP
99 The tdbbackup man page was written by John H Terpstra\&.
100