dirk
/
honk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

a few improvements to docs

This commit is contained in:
Ted Unangst 2021-01-17 19:28:39 -05:00
parent 42d8dc3619
commit 5b88d4d183
3 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/honk.1
View File

@ -174,10 +174,13 @@ posts or actor URLs, in which case their recent outbox is imported.
It's all about you. It's all about you.
An avatar may be selected from the An avatar may be selected from the
.Pa funzone .Pa funzone
by adding meme collection by adding
.Dq avatar: filename.png .Dq avatar: filename.png
to one's profile info. to one's profile info.
If truly necessary. If truly necessary.
See
.Xr honk 8
for more about the funzone.
.Pp .Pp
Some options to customize the site appearance: Some options to customize the site appearance:
.Bl -tag -width skinny .Bl -tag -width skinny

3
docs/honk.5
View File

@ -103,6 +103,9 @@ operator followed by the file name.
.Dl meme: honk.mp4 .Dl meme: honk.mp4
A full list of emoji and memes may be found in the A full list of emoji and memes may be found in the
.Pa funzone . .Pa funzone .
See
.Xr honk 8
for more about the funzone.
.Pp .Pp
Custom flag emoji may be generated on the fly by specifying comma separated Custom flag emoji may be generated on the fly by specifying comma separated
hexadecimal RGB values, one for each stripe. hexadecimal RGB values, one for each stripe.

11
docs/honk.8
View File

@ -57,10 +57,12 @@ looks for data.
.Bl -tag -width datadirx .Bl -tag -width datadirx
.It Fl datadir .It Fl datadir
The root data directory, where the database and other user data are stored. 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. Requires write access.
Defaults to ".". Defaults to ".".
.It Fl viewdir .It Fl viewdir
The root view directory, where html and other templates are stored. The root view directory, where html and other templates are stored.
The contents of this directory are generally replaced with each release.
Read only. Read only.
Defaults to ".". Defaults to ".".
.El .El
@ -75,11 +77,11 @@ See below about importing existing data.
Run honk. Run honk.
Log messages are sent to stderr and should probably be redirected to a file. Log messages are sent to stderr and should probably be redirected to a file.
.Ss Customization .Ss Customization
The funzone contains fun flair that users may add to posts and profiles.
Add custom memes (stickers) to the Add custom memes (stickers) to the
.Pa memes .Pa memes
data directory. data directory.
Image and video files are supported. Image and video files are supported.
.Pp
Add custom emus (emoji) to the Add custom emus (emoji) to the
.Pa emus .Pa emus
data directory. data directory.
@ -100,7 +102,7 @@ Displayed on the home page.
.It about .It about
Displayed on the about page. Displayed on the about page.
.It login .It login
Displayed about the login form. Displayed on the login form.
.It avatar colors .It avatar colors
Four 32-bit hex colors (RGBA). Four 32-bit hex colors (RGBA).
.El .El
@ -122,13 +124,14 @@ command.
The database may grow large over time. The database may grow large over time.
The The
.Ic cleanup Op Ar days .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. This removes unreferenced, unsaved posts and attachments.
It does not remove any original content. It does not remove any original content.
.Pp .Pp
Backups may be performed by running Backups may be performed by running
.Ic backup dirname . .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 .Ss Upgrade
Stop the old honk process. Stop the old honk process.
Backup the database. Backup the database.