From 4212b1626a634fcc66b0a14ca7766de93d983b16 Mon Sep 17 00:00:00 2001 From: Ted Unangst Date: Sun, 6 Feb 2022 00:57:36 -0500 Subject: [PATCH] document logging --- docs/changelog.txt | 2 ++ docs/honk.8 | 25 +++++++++++++++++++++---- 2 files changed, 23 insertions(+), 4 deletions(-) diff --git a/docs/changelog.txt b/docs/changelog.txt index 22cf27d..ef435db 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -2,6 +2,8 @@ changelog === next ++ Flexible logging, to file, syslog, null, etc. + + Low key unread counters. + Images in the hooter. diff --git a/docs/honk.8 b/docs/honk.8 index bf1728c..936ff84 100644 --- a/docs/honk.8 +++ b/docs/honk.8 @@ -54,18 +54,36 @@ Even on fast machines, building from source can take several seconds. The following options control where .Nm looks for data. -.Bl -tag -width datadirx -.It Fl datadir +.Bl -tag -width datadirxdirx +.It Fl datadir Ar dir 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 +.It Fl viewdir Ar dir 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 +.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 Run the .Ic init @@ -75,7 +93,6 @@ the initial user. See below about importing existing data. .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