Skip to content

GitLab

Commit 04b8da49 authored by Nigel Kukard's avatar Nigel Kukard
Browse files

Improved on manpage

parent d18b8209
Hide whitespace changes
Inline Side-by-side
docs/dbackup.sgml
View file @ 04b8da49
......@@ -20,13 +20,13 @@ manpage.1: manpage.sgml
<!ENTITY dhfirstname "<firstname>Nigel</firstname>">
<!ENTITY dhsurname "<surname>Kukard</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>2012-09-28 09:29</date>">
<!ENTITY dhdate "<date>2014-09-11 08:17</date>">
<!-- 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">
<!ENTITY dhucpackage "<refentrytitle>DBACKUP</refentrytitle>">
<!ENTITY dhucpackage "<refentrytitle>AWIT-DBACKUP</refentrytitle>">
<!ENTITY dhpackage "dbackup">
<!ENTITY author "Nigel Kukard">
......@@ -46,7 +46,7 @@ manpage.1: manpage.sgml
&dhsurname;
</author>
<copyright>
<year>2012</year>
<year>2010</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
......@@ -59,151 +59,216 @@ manpage.1: manpage.sgml
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>DBackup is a powerful per-directory backup utility.</refpurpose>
<refpurpose>AWIT-DBackup is a powerful per-directory backup utility.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>--help</option></arg>
<arg><option>--config <replaceable>path</replaceable></option></arg>
<arg><option>--log-level <replaceable>level</replaceable></option></arg>
<arg><option>--tar <replaceable>path</replaceable></option></arg>
<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>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<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>
<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>
</refsect1>
<refsect1>
<title>GENERAL OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
<term><option>--config <replaceable>FILE</replaceable></option></term>
<listitem>
<para>What you're seeing now.</para>
<para>Configuration file to use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--config=file</option></term>
<term><option>--log-level</option></term>
<listitem>
<para>Configuration file to use.</para>
<para>5 = debug, 4 = info, 3 = notice, 2 = warning, 1 = error</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--log-level</option></term>
<term><option>--backup</option></term>
<listitem>
<para>5 = debug, 4 = info, 3 = notice, 2 = warning, 1 = error</para>
<para>Perform a backup operation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--restore</option></term>
<listitem>
<para>Perform a restore operation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--tar</option></term>
<listitem>
<para>Path to tar binary.</para>
<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>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>BACKING OPTIONS</title>
<title>BACKUP OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>--backup</option></term>
<term><option>--backup-upgrade</option></term>
<listitem>
<para>Backup src to dst.</para>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--backup-upgrade</option></term>
<term><option>--compress</option> &lt;gzip|bzip2|xz|lz|none&gt;</term>
<listitem>
<para>Upgrade backup to new dbackup version.</para>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--compress=&lt;xz|bz2|gzip|none&gt;</option></term>
<term><option>--exclude-data</option></term>
<listitem>
<para>Compression method to use. Defaults
to using xz, or bzip2 if xz is unavailable.</para>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--exclude-data</option></term>
<term><option>--exclude-system</option></term>
<listitem>
<para>Exclude all data directories listed below.</para>
<para>
Exclude the most common system directories including /dev, /proc/, /sys, /run, for the complete list see
<command>dbackup --help</command>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--exclude-system</option></term>
<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>
<listitem>
<para>Exclude system directories listed below.</para>
<para>
Exclude files based on a regular expression, this should include separators and can be specified multiple times.
eg. --exclude-file='/\.bak$/'
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--exclude-path=pcre</option></term>
<term><option>--exclude-fs <replaceable>FSTYPE</replaceable></option></term>
<listitem>
<para>PCRE to exclude paths from backup.</para>
<para>
Exclude filesystem types from being transversed for backup. This can be specified multiple times. eg. --exclude-fs=shm
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--exclude-file</option></term>
<term><option>--system-dir <replaceable>PATH</replaceable></option></term>
<listitem>
<para>PCRE to exclude files from backup.</para>
<para>
Add an additional system directory to exclude. The system defaults already include /dev, /run, /tmp... etc. This can be
specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--exclude-fs-type=fstype</option></term>
<term><option>--data-dir <replaceable>PATH</replaceable></option></term>
<listitem>
<para>Filesystem type to exclude.</para>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--data-dir=dir</option></term>
<term><option>--system-base <replaceable>PATH</replaceable></option></term>
<listitem>
<para>Add an additional data directory.</para>
<para>System base to apply the exclusions to. This can be specified multiple times.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--system-dir=dir</option></term>
<term><option>--tar-ignore-failed-read</option></term>
<listitem>
<para>Add an additional system directory.</para>
<para>This is passed to tar only. It will not cause errors if files that cannot be read.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RESTORE OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>--system-base=path</option></term>
<term><option>--tar-keep-newer</option></term>
<listitem>
<para>Add a system base. This defaults to /
and this option will override that.</para>
<para>Pass --keep-newer to tar. Don't replace existing files that are newer than their archive copies.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--tar-ignore-failed-read=path</option></term>
<term><option>--tar-keep-old-files</option></term>
<listitem>
<para>This is passed to tar only. It will
not cause errors of files that cannot
be read for the path matched.</para>
<para>Pass --keep-old-files to tar. Don't replace existing files when extracting, rather throw an error.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>tar(1).</para>
</refsect1>
<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,
Version 2 any later version published by the Free Software
Version 3 any later version published by the Free Software
Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.
License can be found in /usr/share/common-licenses/GPL-3.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment