From: Michael Orlitzky <michael@orlitzky.com>
Date: Fri, 1 Apr 2016 22:35:03 +0000 (-0400)
Subject: Write the man page.
X-Git-Tag: 0.0.1^0
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=db66202834b16d2e09526d068f6f03e5b455a81e;p=untangle-https-backup.git

Write the man page.
---

diff --git a/doc/man8/untangle-https-backup.8 b/doc/man8/untangle-https-backup.8
index eb1ae45..bec7520 100644
--- a/doc/man8/untangle-https-backup.8
+++ b/doc/man8/untangle-https-backup.8
@@ -1 +1,76 @@
-...
+.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] [\fB\-hb\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\ (required)
+The Untangle admin username.
+.IP \fBpassword\fR\ (required)
+The Untangle admin password.
+.IP \fBversion\fR\ (default:\ \fI11\fR)
+The version of Untangle running on this host. Currently only \fI9\fR
+and \fI11\fR are supported.
+.IP \fBverify_cert\fR\ (default:\ False)
+Whether or not to verify the site's SSL certificate, either
+\fITrue\fR or \fIFalse\fR.
+.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.