NAME

scribo — email-based gopherlog generator

SYNOPSIS

DESCRIPTION

scribo turns emails into a gopherlog, (also named "rlog", or "phlog").

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.

Emails are read from stdin by default, or file if specified.

-h

Print a quick usage text.

-a address

Only process emails originated from address. This will be checked against the address found in the rfc5322 "From" header field.

-b basedir

Specify directory where log entries and gopher map should be written. scribo will try to change to this directory, and stop processing if it cannot change to this directory, or write files into it.

-d datefmt

Change the date format appended to each entry. Format specified should be a valid format to pass to strftime(3).

-x command

Pass email body through command before writing it on disk. Note that this will only affect the email body, not the title or date.

EXAMPLES

Call scribo from an aliases(5) file:

  name+rlog@domain.tld |/usr/local/bin/scribo -b /var/gopher/rlog -a name@domain.tld -x "fmt -w 69"

Every mail received at name+rlog@domain.tld will update the gopher log in /var/gopher/rlog. Every entry will be filtered through fmt(1) to limit text width at 69 chars (for sweet gopher rendering).

To write logs as a specific user, configure the forward(5) file of that user. In aliases(5):

  rlog@domain.tld user

Then call scribo from the user's .forward file, located at ~user/.forward :

  "|/usr/local/bin/scribo -b ~/public_gopher"

ENVIRONMENT

SHELL

This variable defines the shell used to interpret the filter command. The shell must accept the POSIX compliant -c flag to pass the command string.

SEE ALSO

aliases(5), forward(5), smtpd(8)

AUTHORS

Willy Goiffon <dev@z3bra.org>