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

document logging

This commit is contained in:
Ted Unangst 2022-02-06 00:57:36 -05:00
parent 7a3bf5bffb
commit 4212b1626a
2 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/changelog.txt
View File

@ -2,6 +2,8 @@ changelog
=== next === next
+ Flexible logging, to file, syslog, null, etc.
+ Low key unread counters. + Low key unread counters.
+ Images in the hooter. + Images in the hooter.

25
docs/honk.8
View File

@ -54,18 +54,36 @@ Even on fast machines, building from source can take several seconds.
The following options control where The following options control where
.Nm .Nm
looks for data. looks for data.
.Bl -tag -width datadirx .Bl -tag -width datadirxdirx
.It Fl datadir .It Fl datadir Ar dir
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. 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 Ar dir
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. The contents of this directory are generally replaced with each release.
Read only. Read only.
Defaults to ".". Defaults to ".".
.El .El
.Pp
The following options control log output.
Acceptable values include "stderr" (the default), "stdout", "null", "syslog",
or a file name.
syslog messages will be sent to the UUCP facility.
.Bl -tag -width errorlogxlogx
.It Fl errorlog Ar log
The error log.
Something bad has happened.
.It Fl infolog Ar log
The informative messages log.
Something has happened, but probably not too bad.
.It Fl debuglog Ar log
The debug log.
There's probably no reason to care.
.It Fl log Ar log
Set all three logs.
.El
.Ss Init .Ss Init
Run the Run the
.Ic init .Ic init
@ -75,7 +93,6 @@ the initial user.
See below about importing existing data. See below about importing existing data.
.Ss Operation .Ss Operation
Run honk. Run honk.
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. 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