diff options
| author | Hiltjo Posthuma <hiltjo@codemadness.org> | 2015-08-05 18:41:27 +0200 |
|---|---|---|
| committer | Hiltjo Posthuma <hiltjo@codemadness.org> | 2015-08-05 18:41:27 +0200 |
| commit | c28a8ba769f2c0468436e7a5d42264644711ff51 (patch) | |
| tree | f23ae38b03d175a8068054ff6b3a5e70e0617332 /sfeed_mbox.1 | |
| parent | 1a1bd0e5a3a1a9dbdf20d7afec7c3246c2468e34 (diff) | |
improve man-pages and documentation
Diffstat (limited to 'sfeed_mbox.1')
| -rw-r--r-- | sfeed_mbox.1 | 29 |
1 files changed, 21 insertions, 8 deletions
diff --git a/sfeed_mbox.1 b/sfeed_mbox.1 index 650041d..0b9c6b9 100644 --- a/sfeed_mbox.1 +++ b/sfeed_mbox.1 @@ -1,29 +1,42 @@ -.Dd May 17, 2015 +.Dd August 5, 2015 .Dt SFEED_MBOX 1 .Os .Sh NAME .Nm sfeed_mbox -.Nd formats a feeds file to mbox +.Nd format feed data to mboxrd .Sh SYNOPSIS .Nm +.Op Ar file... .Sh DESCRIPTION .Nm -formats a feeds file (TSV) from +formats feed data (TSV) from .Xr sfeed 1 -to mbox. It reads TSV data from stdin and writes mail in the mbox format -to stdout. These can be further processed by tools like +from stdin or +.Ar file +to stdout in the mboxrd format. +If one or more +.Ar file +are specified, the basename of the +.Ar file +is used as the feed name in the output. +If no +.Ar file +parameters are specified and so the data is read from stdin the feed name +is empty. +Lines starting with "From " will be mangled in the mboxrd-style. The mbox +data can be further processed by tools like .Xr procmail 1 or .Xr fdm 1 -for example. +for example. See the README file for some useful examples. .Sh FORMAT Depending on the original content\-type the mail will be formatted as plain-text (text/plain) or HTML (text/html). .Sh CUSTOM HEADERS -To make filtering simpler some custom headers are set: +To make further filtering simpler some custom headers are set: .Bl -tag -width Ds .It X-Feedname -The feedname (set in sfeedrc). +The feedname (as set in sfeedrc). .El .Sh SEE ALSO .Xr fdm 1 , |