a few improvements to docs
Ted Unangst tedu@tedunangst.com
Sun, 17 Jan 2021 19:28:39 -0500
3 files changed,
14 insertions(+),
5 deletions(-)
M
docs/honk.1
→
docs/honk.1
@@ -174,10 +174,13 @@ .Ss Account
It's all about you. An avatar may be selected from the .Pa funzone -by adding +meme collection by adding .Dq avatar: filename.png to one's profile info. If truly necessary. +See +.Xr honk 8 +for more about the funzone. .Pp Some options to customize the site appearance: .Bl -tag -width skinny
M
docs/honk.5
→
docs/honk.5
@@ -103,6 +103,9 @@ operator followed by the file name.
.Dl meme: honk.mp4 A full list of emoji and memes may be found in the .Pa funzone . +See +.Xr honk 8 +for more about the funzone. .Pp Custom flag emoji may be generated on the fly by specifying comma separated hexadecimal RGB values, one for each stripe.
M
docs/honk.8
→
docs/honk.8
@@ -57,10 +57,12 @@ looks for data.
.Bl -tag -width datadirx .It Fl datadir The root data directory, where the database and other user data are stored. +This directory contains all user data that persists across upgrades. Requires write access. Defaults to ".". .It Fl viewdir The root view directory, where html and other templates are stored. +The contents of this directory are generally replaced with each release. Read only. Defaults to ".". .El@@ -75,11 +77,11 @@ .Ss Operation
Run honk. Log messages are sent to stderr and should probably be redirected to a file. .Ss Customization +The funzone contains fun flair that users may add to posts and profiles. Add custom memes (stickers) to the .Pa memes data directory. Image and video files are supported. -.Pp Add custom emus (emoji) to the .Pa emus data directory.@@ -100,7 +102,7 @@ Displayed on the home page.
.It about Displayed on the about page. .It login -Displayed about the login form. +Displayed on the login form. .It avatar colors Four 32-bit hex colors (RGBA). .El@@ -122,13 +124,14 @@ .Ss Maintenance
The database may grow large over time. The .Ic cleanup Op Ar days -command exists to purge old data, by default 30 days. +command exists to purge old external data, by default 30 days. This removes unreferenced, unsaved posts and attachments. It does not remove any original content. .Pp Backups may be performed by running .Ic backup dirname . -Backups only include the minimal necessary information. +Backups only include the minimal necessary information, such as user posts +and follower information, but not external posts. .Ss Upgrade Stop the old honk process. Backup the database.