scribo

Email-based phlog generator
git clone git://git.z3bra.org/scribo.git
Log | Files | Refs | README | LICENSE

commit 49c25453ccde39839366648f12f842f1747f6ef6
parent 7a95d651ef1c093906203e2167c7c9e60ddf3e11
Author: Willy Goiffon <dev@z3bra.org>
Date:   Sun, 20 Sep 2020 00:23:32 +0200

Update manpage to remove parts about the gopher log

Diffstat:
Mscribo.1 | 39++++++++++++++++++++++++---------------
1 file changed, 24 insertions(+), 15 deletions(-)

diff --git a/scribo.1 b/scribo.1 @@ -12,8 +12,8 @@ .Op Fl a Ar address .Op Fl b Ar basedir .Op Fl d Ar datefmt -.Op Fl io Ar file .Op Fl x Ar command +.Op Ar file .Sh DESCRIPTION .Nm @@ -23,9 +23,11 @@ Each mail will be parsed, and written out in plain text. The subject and date of the email are extracted from the headers (according to rfc5322), and used to add a title, and date to each entry. .Pp -After processing the email, a gph file will be generated -from the list of existing entries in the directory -.Ar basedir . +Emails are read from +.Ar stdin +by default, or +.Pa file +if specified. .Bl -tag -width Ds .It Fl h Print a quick usage text. @@ -43,16 +45,6 @@ change to this directory, or write files into it. Change the date format appended to each entry. Format specified should be a valid format to pass to .Xr strftime 3 . -.It Fl i Ar file -Read email from -.Ar file -rather than -.Pa stdin . -.It Fl o Ar file -Write gopher map to -.Ar file -rather than -.Pa stdout . .It Fl x Ar command Pass email body through .Ar command @@ -67,7 +59,7 @@ from an .Xr aliases 5 file: .Bd -literal - name+rlog@domain.tld |/usr/local/bin/scribo -b /var/gopher/rlog -o index.gph -a name@domain.tld -x "fmt -w 69" + name+rlog@domain.tld |/usr/local/bin/scribo -b /var/gopher/rlog -a name@domain.tld -x "fmt -w 69" .Ed .Pp Every mail received at @@ -77,6 +69,23 @@ will update the gopher log in Every entry will be filtered through .Xr fmt 1 to limit text width at 69 chars (for sweet gopher rendering). +.Pp +To write logs as a specific user, configure the +.Xr forward 5 +file of that user. In +.Xr aliases 5 : +.Bd -literal + rlog@domain.tld user +.Ed +.Pp +Then call +.Nm +from the user's .forward file, located at +.Pa ~user/.forward +: +.Bd -literal + "|/usr/local/bin/scribo -b ~/public_gopher" +.Ed .Sh ENVIRONMENT .Bl -tag -width "SHELL"