doc/COPYING: add one to state the "or later" bit

[untangle-https-backup.git] / doc / man8 / untangle-https-backup.8

diff --git a/doc/man8/untangle-https-backup.8 b/doc/man8/untangle-https-backup.8
index eb1ae458f8ee6e88c072a9989724d7685c56beb1..04170df90f61bdc88ada749c81874534d6f68bd7 100644 (file)
--- a/doc/man8/untangle-https-backup.8
+++ b/doc/man8/untangle-https-backup.8
@@ -1 +1,80 @@
-...
+.TH untangle\-https\-backup 8
+
+.SH NAME
+untangle\-https\-backup \- Back up Untangle configurations via the web admin UI
+.SH SYNOPSIS
+\fBuntangle\-https\-backup\fR [\fB\-\-config\-file <INI file>\fR]
+.SH INPUT
+.P
+None; the program's behavior is entirely determined by its
+configuration (INI) file.
+.SH OUTPUT
+.P
+Errors are output to \fIstderr\fR; otherwise, silence is golden.
+.SH DESCRIPTION
+.P
+The Untangle web UI provides a way to create backups of the local
+configuration. However, if you manage enough Untangle installations,
+it becomes impractical to log in to each one and navigate to the
+backups in a browser. The untangle\-https\-backup program automates that
+process for a list of installations contained in a configuration file.
+.P
+By default, the INI-style configuration file is located at
+/etc/untangle\-https\-backup.ini, but that can be overridden by the
+\fB\-\-config\-file\fR option.
+.SH CONFIGURATION FILE
+The configuration file is an INI-style list of Untangle installations
+to back up. An example entry is,
+
+.nf
+[Test installation]
+host = 192.168.1.100
+username = testuser
+password = hunter2
+.fi
+
+There are currently five parameters that may be set for each
+installation:
+
+.IP \fBhost\fR\ (required)
+The hostname or IP address where the Untangle web UI is available.
+.IP \fBusername\fR\ (default:\ \fIadmin\fR)
+The Untangle admin username.
+.IP \fBpassword\fR\ (required)
+The Untangle admin password.
+.IP \fBversion\fR\ (default:\ \fI14.1\fR)
+The major version of Untangle running on this host. Versions \fI9\fR,
+\fI10\fR, \fI11\fR, \fI12\fR, \fI13\fR, \fI13.1\fR, \fI14\fR, and
+\fI14.1\fR are supported.
+.IP \fBverify_cert\fR\ (default:\ \fIFalse\fR)
+Whether or not to verify the site's SSL certificate, either
+\fITrue\fR or \fIFalse\fR.
+.IP \fBtimeout\fR\ (default:\ \fI300\fR)
+How long to wait for socket operations to complete, in seconds.
+.SH EXAMPLES
+.P
+It is difficult to invoke untangle-https-backup incorrectly:
+
+.nf
+.I $ untangle\-https\-backup
+.fi
+
+Show the usage information:
+
+.nf
+.I $ untangle\-https\-backup \-\-help
+.fi
+
+Specify an alternate configuration file:
+
+.nf
+.I $ untangle\-https\-backup \-\-config\-file /etc/foo.ini
+.fi
+.SH OPTIONS
+
+.IP \fB\-\-config\-file\fR,\ \fB\-c\fR\ (default:\ \fI/etc/untangle\-https\-backup.ini\fR)
+Path to the configuration file.
+.
+.SH BUGS
+.P
+Send bugs to michael@orlitzky.com.