summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2015-05-24 22:50:33 +0200
committerHiltjo Posthuma <hiltjo@codemadness.org>2015-05-24 22:50:33 +0200
commitfaa268d8e92bd8ac57e36564df7e1fd8886f199c (patch)
treefeec2872c1c2c41be0b212d56ff84ae1b3a804f0 /doc
parentc571234ad3d2fed06016c782e02939cd0eb5d6bc (diff)
doc: fix warnings (mandoc -Tlint)
and regenerate old man-style (make doc-oldman).
Diffstat (limited to 'doc')
-rw-r--r--doc/man/sfeed.16
-rw-r--r--doc/man/sfeed_frames.16
-rw-r--r--doc/man/sfeed_html.16
-rw-r--r--doc/man/sfeed_mail.130
-rw-r--r--doc/man/sfeed_opml_export.12
-rw-r--r--doc/man/sfeed_opml_import.12
-rw-r--r--doc/man/sfeed_plain.16
-rw-r--r--doc/man/sfeed_stats.16
-rw-r--r--doc/man/sfeed_update.16
-rw-r--r--doc/man/sfeed_web.16
-rw-r--r--doc/man/sfeed_xmlenc.16
11 files changed, 56 insertions, 26 deletions
diff --git a/doc/man/sfeed.1 b/doc/man/sfeed.1
index da2ea3c..f3eb62f 100644
--- a/doc/man/sfeed.1
+++ b/doc/man/sfeed.1
@@ -1,4 +1,4 @@
-.TH "SFEED" "1" "December 25, 2014" "" "OpenBSD Reference Manual"
+.TH "SFEED" "1" "December 25, 2014" "" "General Commands Manual"
.nh
.if n .ad l
.SH "NAME"
@@ -51,7 +51,7 @@ string
\fIfeed type\fR
string, "rss" or "atom"
.SH "SEE ALSO"
-sh(1),
-sfeed_update(1)
+sfeed_update(1),
+sh(1)
.SH "AUTHORS"
Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR>
diff --git a/doc/man/sfeed_frames.1 b/doc/man/sfeed_frames.1
index 0009133..52e7a18 100644
--- a/doc/man/sfeed_frames.1
+++ b/doc/man/sfeed_frames.1
@@ -1,4 +1,4 @@
-.TH "SFEED_FRAMES" "1" "December 25, 2014" "" "OpenBSD Reference Manual"
+.TH "SFEED_FRAMES" "1" "December 25, 2014" "" "General Commands Manual"
.nh
.if n .ad l
.SH "NAME"
@@ -37,8 +37,8 @@ The feedname and item names are normalized, whitespace characters are replaced
with a \-, multiple whitespaces are replaced by a single \- and trailing
whitespace will be removed.
.SH "SEE ALSO"
+sfeed(1),
sfeed_plain(1),
-sfeed_update(1),
-sfeed(1)
+sfeed_update(1)
.SH "AUTHORS"
Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR>
diff --git a/doc/man/sfeed_html.1 b/doc/man/sfeed_html.1
index 5bd5229..d539a9d 100644
--- a/doc/man/sfeed_html.1
+++ b/doc/man/sfeed_html.1
@@ -1,4 +1,4 @@
-.TH "SFEED_HTML" "1" "December 25, 2014" "" "OpenBSD Reference Manual"
+.TH "SFEED_HTML" "1" "December 25, 2014" "" "General Commands Manual"
.nh
.if n .ad l
.SH "NAME"
@@ -14,8 +14,8 @@ sfeed_update(1)
to HTML. It reads TSV data from stdin and writes HTML to stdout. For the exact TSV format see
sfeed_update(1).
.SH "SEE ALSO"
+sfeed(1),
sfeed_plain(1),
-sfeed_update(1),
-sfeed(1)
+sfeed_update(1)
.SH "AUTHORS"
Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR>
diff --git a/doc/man/sfeed_mail.1 b/doc/man/sfeed_mail.1
new file mode 100644
index 0000000..df22124
--- /dev/null
+++ b/doc/man/sfeed_mail.1
@@ -0,0 +1,30 @@
+.TH "SFEED_MAIL" "1" "May 17, 2015" "" "General Commands Manual"
+.nh
+.if n .ad l
+.SH "NAME"
+\fBsfeed_mail\fR
+\- formats a feeds file to mail
+.SH "SYNOPSIS"
+.HP 11n
+\fBsfeed_mail\fR
+.SH "DESCRIPTION"
+\fBsfeed_mail\fR
+formats a feeds file (TSV) from
+sfeed_update(1)
+to mail. It reads TSV data from stdin and writes e-mails to stdout. These can
+be further processed by tools like
+procmail(1).
+.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:
+.TP 8n
+X-feedname
+The feedname (set in sfeedrc).
+.SH "SEE ALSO"
+procmail(1),
+sfeed(1),
+sfeed_update(1)
+.SH "AUTHORS"
+Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR>
diff --git a/doc/man/sfeed_opml_export.1 b/doc/man/sfeed_opml_export.1
index 79823b9..7561ae1 100644
--- a/doc/man/sfeed_opml_export.1
+++ b/doc/man/sfeed_opml_export.1
@@ -1,4 +1,4 @@
-.TH "SFEED_OPML_EXPORT" "1" "December 25, 2014" "" "OpenBSD Reference Manual"
+.TH "SFEED_OPML_EXPORT" "1" "December 25, 2014" "" "General Commands Manual"
.nh
.if n .ad l
.SH "NAME"
diff --git a/doc/man/sfeed_opml_import.1 b/doc/man/sfeed_opml_import.1
index 89b9127..f589bb5 100644
--- a/doc/man/sfeed_opml_import.1
+++ b/doc/man/sfeed_opml_import.1
@@ -1,4 +1,4 @@
-.TH "SFEED_OPML_IMPORT" "1" "December 25, 2014" "" "OpenBSD Reference Manual"
+.TH "SFEED_OPML_IMPORT" "1" "December 25, 2014" "" "General Commands Manual"
.nh
.if n .ad l
.SH "NAME"
diff --git a/doc/man/sfeed_plain.1 b/doc/man/sfeed_plain.1
index 91435c4..2bae1a4 100644
--- a/doc/man/sfeed_plain.1
+++ b/doc/man/sfeed_plain.1
@@ -1,4 +1,4 @@
-.TH "SFEED_PLAIN" "1" "December 25, 2014" "" "OpenBSD Reference Manual"
+.TH "SFEED_PLAIN" "1" "December 25, 2014" "" "General Commands Manual"
.nh
.if n .ad l
.SH "NAME"
@@ -15,8 +15,8 @@ to plain text. It reads TSV data from stdin and writes formatted plain text to
stdout. For the exact TSV format see
sfeed_update(1).
.SH "SEE ALSO"
+sfeed(1),
sfeed_html(1),
-sfeed_update(1),
-sfeed(1)
+sfeed_update(1)
.SH "AUTHORS"
Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR>
diff --git a/doc/man/sfeed_stats.1 b/doc/man/sfeed_stats.1
index 0eeff13..275fed6 100644
--- a/doc/man/sfeed_stats.1
+++ b/doc/man/sfeed_stats.1
@@ -1,4 +1,4 @@
-.TH "SFEED_STATS" "1" "January 3, 2015" "" "OpenBSD Reference Manual"
+.TH "SFEED_STATS" "1" "January 3, 2015" "" "General Commands Manual"
.nh
.if n .ad l
.SH "NAME"
@@ -16,7 +16,7 @@ items, the timestamp of the last item per feed. It reads TSV data from stdin
and writes formatted plain text to stdout. For the exact TSV format see
sfeed_update(1).
.SH "SEE ALSO"
-sfeed_update(1),
-sfeed(1)
+sfeed(1),
+sfeed_update(1)
.SH "AUTHORS"
Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR>
diff --git a/doc/man/sfeed_update.1 b/doc/man/sfeed_update.1
index f008509..3f0a451 100644
--- a/doc/man/sfeed_update.1
+++ b/doc/man/sfeed_update.1
@@ -1,4 +1,4 @@
-.TH "SFEED_UPDATE" "1" "December 25, 2014" "" "OpenBSD Reference Manual"
+.TH "SFEED_UPDATE" "1" "December 25, 2014" "" "General Commands Manual"
.nh
.if n .ad l
.SH "NAME"
@@ -94,8 +94,8 @@ sfeed_html < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.html
.RE
.fi
.SH "SEE ALSO"
-sh(1),
+sfeed_html(1),
sfeed_plain(1),
-sfeed_html(1)
+sh(1)
.SH "AUTHORS"
Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR>
diff --git a/doc/man/sfeed_web.1 b/doc/man/sfeed_web.1
index 2e48f15..bc3c24a 100644
--- a/doc/man/sfeed_web.1
+++ b/doc/man/sfeed_web.1
@@ -1,4 +1,4 @@
-.TH "SFEED_WEB" "1" "December 25, 2014" "" "OpenBSD Reference Manual"
+.TH "SFEED_WEB" "1" "December 25, 2014" "" "General Commands Manual"
.nh
.if n .ad l
.SH "NAME"
@@ -34,7 +34,7 @@ wget http://www.xkcd.com -q -O - | sfeed_web "http://www.xkcd.com/"
.RE
.fi
.SH "SEE ALSO"
-sh(1),
-sfeed_update(1)
+sfeed_update(1),
+sh(1)
.SH "AUTHORS"
Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR>
diff --git a/doc/man/sfeed_xmlenc.1 b/doc/man/sfeed_xmlenc.1
index 81aa48a..21eabb9 100644
--- a/doc/man/sfeed_xmlenc.1
+++ b/doc/man/sfeed_xmlenc.1
@@ -1,4 +1,4 @@
-.TH "SFEED_XMLENC" "1" "December 25, 2014" "" "OpenBSD Reference Manual"
+.TH "SFEED_XMLENC" "1" "December 25, 2014" "" "General Commands Manual"
.nh
.if n .ad l
.SH "NAME"
@@ -19,7 +19,7 @@ wget http://www.xkcd.com/atom.xml -q -O - | sfeed_xmlenc
.RE
.fi
.SH "SEE ALSO"
-sh(1),
-sfeed_update(1)
+sfeed_update(1),
+sh(1)
.SH "AUTHORS"
Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR>