From ef507154d5d6d255234bcfddb7ec424a2b79406e Mon Sep 17 00:00:00 2001
From: Ted Unangst <tedu@tedunangst.com>
Date: Wed, 6 Nov 2019 13:26:35 -0500
Subject: [PATCH] imprve admin manual

---
 docs/honk.8 | 43 ++++++++++++++++++++++++++-----------------
 1 file changed, 26 insertions(+), 17 deletions(-)

diff --git a/docs/honk.8 b/docs/honk.8
index 0705bf2..16ead62 100644
--- a/docs/honk.8
+++ b/docs/honk.8
@@ -67,18 +67,10 @@ Defaults to ".".
 Run the
 .Ic init
 command.
-.Dl ./honk init
 This will create the database and ask four questions, as well as creating
 the initial user.
-.Bd -literal -offset indent
-username: (desired username)
-password: (desired password)
-listenaddr: (tcp or unix: localhost:31337, /var/www/honk.sock, etc.)
-servername: (public DNS name: honk.example.com)
-.Ed
 .Ss OPERATION
 Run honk.
-.Dl date; ./honk >> log 2>&1
 Log messages are sent to stderr and should probably be redirected to a file.
 .Ss CUSTOMIZATION
 Add custom memes (stickers) to the
@@ -100,7 +92,6 @@ Custom HTML messages may be added to select pages by using the
 .Ic admin
 command.
 A restart is required after changes.
-.Dl ./honk admin
 .Bl -tag -width tenletters
 .It server
 Displayed on the home page.
@@ -115,30 +106,24 @@ New users can be added with the
 .Ic adduser
 command.
 This is discouraged.
-.Dl ./honk adduser
 .Pp
 Passwords may be reset with the
-.Ic chpass
+.Ic chpass Ar username
 command.
-.Dl ./honk chpass username
 .Ss MAINTENANCE
 The database may grow large over time.
 The
-.Ic cleanup
+.Ic cleanup Op Ar days
 command exists to purge old data, by default 30 days.
 This removes unreferenced, unsaved posts and attachments.
 It does not remove any original content.
 .Ss UPGRADE
 Stop the old honk process.
-.Dl pkill honk
 Backup the database.
-.Dl cp honk.db backup.db
 Perform the upgrade with the
 .Ic upgrade
 command.
-.Dl ./honk upgrade
 Restart.
-.Dl ./honk
 .Pp
 There's also a
 .Pa blob.db
@@ -181,6 +166,30 @@ The view directory contains:
 .It Pa views
 HTML templates and CSS files.
 .El
+.Sh EXAMPLES
+This series of commands creates a new database, sets a friendly
+welcome message, and runs honk.
+.Bd -literal -offset indent
+honk-v98> make
+honk-v98> ./honk -datadir ../honkdata init
+username: puffy
+password: OxychromaticBlowfishSwatDynamite
+listen address: /var/www/honk.sock
+server name: honk.example.com
+honk-v98> ./honk -datadir ../honkdata admin
+honk-v98> date; ./honk -datadir ../honkdata >> log 2>&1
+.Ed
+.Pp
+Upgrade to the next version.
+Clean things up a bit.
+.Bd -literal -offset indent
+datadir> cp honk.db backup.db
+datadir> cd ../honk-v99
+honk-v99> make
+honk-v99> ./honk -datadir ../honkdata upgrade
+honk-v99> ./honk -datadir ../honkdata cleanup
+honk-v99> date; ./honk -datadir ../honkdata >> log 2>&1
+.Ed
 .Sh ENVIRONMENT
 Image processing and scaling requires considerable memory.
 It is recommended to adjust the datasize ulimit to at least 1GB.