dbackup.sgml 10.2 KB
Newer Older
Nigel Kukard's avatar
Nigel Kukard committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@


	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Nigel</firstname>">
  <!ENTITY dhsurname   "<surname>Kukard</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
Nigel Kukard's avatar
Nigel Kukard committed
23
  <!ENTITY dhdate      "<date>2014-09-11 08:17</date>">
Nigel Kukard's avatar
Nigel Kukard committed
24
25
26
27
28
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
  <!ENTITY dhemail     "<email>nkukard@lbsd.net</email>">
  <!ENTITY dhusername  "nkukard">
Nigel Kukard's avatar
Nigel Kukard committed
29
  <!ENTITY dhucpackage "<refentrytitle>AWIT-DBACKUP</refentrytitle>">
Nigel Kukard's avatar
Nigel Kukard committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
  <!ENTITY dhpackage   "dbackup">

  <!ENTITY author      "Nigel Kukard">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
Nigel Kukard's avatar
Nigel Kukard committed
49
      <year>2010</year>
Nigel Kukard's avatar
Nigel Kukard committed
50
51
52
53
54
55
56
57
58
59
60
61
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

Nigel Kukard's avatar
Nigel Kukard committed
62
    <refpurpose>AWIT-DBackup is a powerful per-directory backup utility.</refpurpose>
Nigel Kukard's avatar
Nigel Kukard committed
63
64
65
66
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
Nigel Kukard's avatar
Nigel Kukard committed
67
68
69
70
71
72
73
      <arg><replaceable>GENERAL_OPTIONS</replaceable></arg>
      <group>
        <arg>--backup <replaceable>BACKUP_OPTIONS</replaceable></arg>
        <arg>--restore <replaceable>RESTORE_OPTIONS</replaceable></arg>
      </group>
      <arg><replaceable>SRC</replaceable></arg>
      <arg><replaceable>DST</replaceable></arg>
Nigel Kukard's avatar
Nigel Kukard committed
74
75
76
77
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
Nigel Kukard's avatar
Nigel Kukard committed
78
79
80
81
82
    <para>
      This is a backup software package which creates one archive per directory it backs up. This makes searching through the
      backup much easier as you can look for which files you're after in the directory hierarchy. It will only backup directories
      which have changed, which makes it rsync friendly.
    </para>
Nigel Kukard's avatar
Nigel Kukard committed
83
84
85
86
87
  </refsect1>
  <refsect1>
    <title>GENERAL OPTIONS</title>
    <variablelist>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
88
        <term><option>--config <replaceable>FILE</replaceable></option></term>
Nigel Kukard's avatar
Nigel Kukard committed
89
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
90
          <para>Configuration file to use.</para>
Nigel Kukard's avatar
Nigel Kukard committed
91
92
93
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
94
        <term><option>--log-level</option></term>
Nigel Kukard's avatar
Nigel Kukard committed
95
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
96
          <para>5 = debug, 4 = info, 3 = notice, 2 = warning, 1 = error</para>
Nigel Kukard's avatar
Nigel Kukard committed
97
98
99
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
100
        <term><option>--backup</option></term>
Nigel Kukard's avatar
Nigel Kukard committed
101
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
102
103
104
105
106
107
108
          <para>Perform a backup operation.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--restore</option></term>
        <listitem>
          <para>Perform a restore operation.</para>
Nigel Kukard's avatar
Nigel Kukard committed
109
110
111
112
113
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--tar</option></term>
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
          <para>
            Path to tar binary. This should almost never need to be specified, it is used to specify a different tar binary to use
            other than the default system binary. Some versions of tar used to have bugs preventing correct operation, this allowed
            specification of an alternative binary to use.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--manifest-format</option></term>
        <listitem>
          <para>
            Manifest format to use, currently the two supported formats is "null" for \\0 (null) termination of entries or "newline"
            for \n (newline) termination of entries. This should not need to be overridden.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help</option></term>
        <listitem>
          <para>Display commandline help.</para>
Nigel Kukard's avatar
Nigel Kukard committed
134
135
136
137
138
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
Nigel Kukard's avatar
Nigel Kukard committed
139
    <title>BACKUP OPTIONS</title>
Nigel Kukard's avatar
Nigel Kukard committed
140
141
    <variablelist>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
142
        <term><option>--backup-upgrade</option></term>
Nigel Kukard's avatar
Nigel Kukard committed
143
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
144
145
146
147
          <para>
            Upgrade backup to new dbackup version. This will cause all archives to be refreshed if they were generated with an
            older version of AWIT DBackup.
          </para>
Nigel Kukard's avatar
Nigel Kukard committed
148
149
150
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
151
        <term><option>--compress</option> &lt;gzip|bzip2|xz|lz|none&gt;</term>
Nigel Kukard's avatar
Nigel Kukard committed
152
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
153
154
155
156
157
          <para>
            Compression method to use. Defaults to using xz, or bzip2 if xz is unavailable. Parallel versions of these Compression
            programs will be used if they exist. Here is the order compression programs are looked for: gzip = pigz > gzip, bzip2
            = pbzip2 > lbzip2 > bzip2, xz = pxz > pixz > xz, lz = plzip > pdlzip > clzip.
          </para>
Nigel Kukard's avatar
Nigel Kukard committed
158
159
160
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
161
        <term><option>--exclude-data</option></term>
Nigel Kukard's avatar
Nigel Kukard committed
162
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
163
164
165
166
          <para>
            Exclude the most common data directories which contain temporary or state information or which is not useful, a list
            of these is displayed by running <command>dbackup --help</command>.
          </para>
Nigel Kukard's avatar
Nigel Kukard committed
167
168
169
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
170
        <term><option>--exclude-system</option></term>
Nigel Kukard's avatar
Nigel Kukard committed
171
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
172
173
174
175
          <para>
            Exclude the most common system directories including /dev, /proc/, /sys, /run, for the complete list see
            <command>dbackup --help</command>.
          </para>
Nigel Kukard's avatar
Nigel Kukard committed
176
177
178
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
179
180
181
182
183
184
185
186
187
188
        <term><option>--exclude-path <replaceable>PCRE</replaceable></option></term>
        <listitem>
          <para>
            Exclude a path based on a Perl regular expression, this should include separators and can be specified multiple times.
            eg. --exclude-path=',/old$,'
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--exclude-file <replaceable>PCRE</replaceable></option></term>
Nigel Kukard's avatar
Nigel Kukard committed
189
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
190
191
192
193
          <para>
            Exclude files based on a regular expression, this should include separators and can be specified multiple times.
            eg. --exclude-file='/\.bak$/'
          </para>
Nigel Kukard's avatar
Nigel Kukard committed
194
195
196
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
197
        <term><option>--exclude-fs <replaceable>FSTYPE</replaceable></option></term>
Nigel Kukard's avatar
Nigel Kukard committed
198
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
199
200
201
          <para>
            Exclude filesystem types from being transversed for backup. This can be specified multiple times. eg. --exclude-fs=shm
          </para>
Nigel Kukard's avatar
Nigel Kukard committed
202
203
204
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
205
        <term><option>--system-dir <replaceable>PATH</replaceable></option></term>
Nigel Kukard's avatar
Nigel Kukard committed
206
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
207
208
209
210
          <para>
            Add an additional system directory to exclude. The system defaults already include /dev, /run, /tmp... etc. This can be
            specified multiple times.
          </para>
Nigel Kukard's avatar
Nigel Kukard committed
211
212
213
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
214
        <term><option>--data-dir <replaceable>PATH</replaceable></option></term>
Nigel Kukard's avatar
Nigel Kukard committed
215
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
216
217
218
219
220
          <para>
            Add an additional data directory to exclude. The data directory defaults already include /var/lib/mysql,
            /var/lib/pgsql, /var/amavis/tmp/, /var/spool/squid, /var/cache/yum, /var/cache/apt/archives ... etc. This can be
            specified multiple times.
          </para>
Nigel Kukard's avatar
Nigel Kukard committed
221
222
223
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
224
        <term><option>--system-base <replaceable>PATH</replaceable></option></term>
Nigel Kukard's avatar
Nigel Kukard committed
225
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
226
          <para>System base to apply the exclusions to. This can be specified multiple times.</para>
Nigel Kukard's avatar
Nigel Kukard committed
227
228
229
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
230
        <term><option>--tar-ignore-failed-read</option></term>
Nigel Kukard's avatar
Nigel Kukard committed
231
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
232
          <para>This is passed to tar only. It will not cause errors if files that cannot be read.</para>
Nigel Kukard's avatar
Nigel Kukard committed
233
234
        </listitem>
      </varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
235
236
237
238
239
    </variablelist>
  </refsect1>
  <refsect1>
    <title>RESTORE OPTIONS</title>
    <variablelist>
Nigel Kukard's avatar
Nigel Kukard committed
240
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
241
        <term><option>--tar-keep-newer</option></term>
Nigel Kukard's avatar
Nigel Kukard committed
242
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
243
          <para>Pass --keep-newer to tar. Don't replace existing files that are newer than their archive copies.</para>
Nigel Kukard's avatar
Nigel Kukard committed
244
245
246
        </listitem>
      </varlistentry>
      <varlistentry>
Nigel Kukard's avatar
Nigel Kukard committed
247
        <term><option>--tar-keep-old-files</option></term>
Nigel Kukard's avatar
Nigel Kukard committed
248
        <listitem>
Nigel Kukard's avatar
Nigel Kukard committed
249
          <para>Pass --keep-old-files to tar. Don't replace existing files when extracting, rather throw an error.</para>
Nigel Kukard's avatar
Nigel Kukard committed
250
251
252
253
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
Nigel Kukard's avatar
Nigel Kukard committed
254
255
256
257
  <refsect1>
    <title>SEE ALSO</title>
    <para>tar(1).</para>
  </refsect1>
Nigel Kukard's avatar
Nigel Kukard committed
258
259
260
261
262
  <refsect1>
    <title>AUTHOR</title>
    <para>This manual page was written by &author; &lt;&dhemail;&gt;.
      Permission is granted to copy, distribute and/or modify this 
      document under the terms of the &gnu; General Public License, 
Nigel Kukard's avatar
Nigel Kukard committed
263
      Version 3 any later version published by the Free Software 
Nigel Kukard's avatar
Nigel Kukard committed
264
265
266
267
      Foundation.
    </para>
    <para>
      On Debian systems, the complete text of the GNU General Public
Nigel Kukard's avatar
Nigel Kukard committed
268
      License can be found in /usr/share/common-licenses/GPL-3.
Nigel Kukard's avatar
Nigel Kukard committed
269
270
    </para>
  </refsect1>
Nigel Kukard's avatar
Nigel Kukard committed
271

Nigel Kukard's avatar
Nigel Kukard committed
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->