Fix missing va_end()s
[ccan] / ccan / ntdb / man / ntdbbackup.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="ntdbbackup.8">
4
5 <refmeta>
6         <refentrytitle>ntdbbackup</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.1</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>ntdbbackup</refname>
16         <refpurpose>tool for backing up and for validating the integrity of samba .ntdb files</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>ntdbbackup</command>
22                 <arg choice="opt">-s suffix</arg>
23                 <arg choice="opt">-v</arg>
24                 <arg choice="opt">-h</arg>
25         </cmdsynopsis>
26 </refsynopsisdiv>
27
28 <refsect1>
29         <title>DESCRIPTION</title>
30
31         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
32         <manvolnum>1</manvolnum></citerefentry> suite.</para>
33
34         <para><command>ntdbbackup</command> is a tool that may be used to backup samba .ntdb
35         files. This tool may also be used to verify the integrity of the .ntdb files prior
36         to samba startup or during normal operation. If it finds file damage and it finds
37         a prior backup the backup file will be restored.
38         </para>
39 </refsect1>
40
41
42 <refsect1>
43         <title>OPTIONS</title>
44
45         <variablelist>
46
47                 <varlistentry>
48                 <term>-h</term>
49                 <listitem><para>
50                 Get help information.
51                 </para></listitem>
52                 </varlistentry>
53
54                 <varlistentry>
55                 <term>-s suffix</term>
56                 <listitem><para>
57                 The <command>-s</command> option allows the administrator to specify a file
58                 backup extension. This way it is possible to keep a history of ntdb backup
59                 files by using a new suffix for each backup.
60                 </para> </listitem>
61                 </varlistentry>
62
63                 <varlistentry>
64                 <term>-v</term>
65                 <listitem><para>
66                 The <command>-v</command> will check the database for damages (corrupt data)
67                 which if detected causes the backup to be restored.
68                 </para></listitem>
69                 </varlistentry>
70
71         </variablelist>
72 </refsect1>
73
74
75 <refsect1>
76         <title>COMMANDS</title>
77
78         <para><emphasis>GENERAL INFORMATION</emphasis></para>
79
80         <para>
81         The <command>ntdbbackup</command> utility can safely be run at any time. It was designed so
82         that it can be used at any time to validate the integrity of ntdb files, even during Samba
83         operation. Typical usage for the command will be:
84         </para>
85
86         <para>ntdbbackup [-s suffix] *.ntdb</para>
87
88         <para>
89         Before restarting samba the following command may be run to validate .ntdb files:
90         </para>
91
92         <para>ntdbbackup -v [-s suffix] *.ntdb</para>
93
94         <para>
95         Note that Samba 4 can use .tdb files instead, so you should
96         use <command>tdbbackup</command> on those files.
97         </para>
98
99         <para>
100         Samba .tdb and .ntdb files are stored in various locations, be sure to run backup all
101         .(n)tdb files on the system. Important files includes:
102         </para>
103
104         <itemizedlist>
105                 <listitem><para>
106                 <command>secrets.(n)tdb</command> - usual location is in the /usr/local/samba/private
107                 directory, or on some systems in /etc/samba.
108                 </para></listitem>
109
110                 <listitem><para>
111                 <command>passdb.(n)tdb</command> - usual location is in the /usr/local/samba/private
112                 directory, or on some systems in /etc/samba.
113                 </para></listitem>
114
115                 <listitem><para>
116                 <command>*.tdb</command> and <command>*.ntdb</command> located in the /usr/local/samba/var directory or on some
117                 systems in the /var/cache or /var/lib/samba directories.
118                 </para></listitem>
119         </itemizedlist>
120
121 </refsect1>
122
123 <refsect1>
124         <title>VERSION</title>
125
126         <para>This man page is correct for version 4 of the Samba suite.</para>
127 </refsect1>
128
129 <refsect1>
130         <title>SEE ALSO</title>
131
132     <para>
133       tdbbackup(8), ntdbrestore(8)
134     </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 ntdbbackup man page was written by Rusty Russell,
147         based on the tdbbackup man page by John H Terpstra.</para>
148 </refsect1>
149
150 </refentry>