commit a335239b1f9803298e42e16535d759856be831b0
parent eabed01f8507fd75bda52d98ac6bc0d82a67d1b2
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Sun, 15 Mar 2020 15:04:56 +0100
man pages (section 1): document exit status
Document it so it can be relied upon in scripts.
Diffstat:
13 files changed, 39 insertions(+), 13 deletions(-)
diff --git a/sfeed.1 b/sfeed.1
@@ -1,4 +1,4 @@
-.Dd May 2, 2019
+.Dd March 15, 2020
.Dt SFEED 1
.Os
.Sh NAME
@@ -47,6 +47,8 @@ Item author.
.It enclosure
Item, first enclosure.
.El
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr sfeed_plain 1 ,
.Xr sfeed 5
diff --git a/sfeed_atom.1 b/sfeed_atom.1
@@ -1,4 +1,4 @@
-.Dd July 20, 2019
+.Dd March 15, 2020
.Dt SFEED_ATOM 1
.Os
.Sh NAME
@@ -30,6 +30,8 @@ is reading from one or more
.Ar file
it will prefix the entry title with the feed name which is the basename of the
input file.
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr sfeed 1 ,
.Xr sfeed_plain 1 ,
diff --git a/sfeed_frames.1 b/sfeed_frames.1
@@ -1,4 +1,4 @@
-.Dd July 20, 2019
+.Dd March 15, 2020
.Dt SFEED_FRAMES 1
.Os
.Sh NAME
@@ -32,6 +32,8 @@ The items frame contains all the item HTML links to the remote content.
The menu frame which contains navigation "anchor" links to the feed names in
items.html.
.El
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr sfeed 1 ,
.Xr sfeed_html 1 ,
diff --git a/sfeed_gopher.1 b/sfeed_gopher.1
@@ -1,4 +1,4 @@
-.Dd January 22, 2020
+.Dd March 15, 2020
.Dt SFEED_GOPHER 1
.Os
.Sh NAME
@@ -44,6 +44,8 @@ The default is "127.0.0.1".
This environment variable can be used as the Gopher Port field.
The default is "70".
.El
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr sfeed 1 ,
.Xr sfeed 5
diff --git a/sfeed_html.1 b/sfeed_html.1
@@ -1,4 +1,4 @@
-.Dd January 22, 2020
+.Dd March 15, 2020
.Dt SFEED_HTML 1
.Os
.Sh NAME
@@ -26,6 +26,8 @@ is empty.
.Pp
Items with a timestamp from the last day compared to the system time at the
time of formatting are counted and marked as new.
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr sfeed 1 ,
.Xr sfeed_frames 1 ,
diff --git a/sfeed_mbox.1 b/sfeed_mbox.1
@@ -1,4 +1,4 @@
-.Dd July 20, 2019
+.Dd March 15, 2020
.Dt SFEED_MBOX 1
.Os
.Sh NAME
@@ -35,6 +35,8 @@ To make further filtering simpler some custom headers are set:
.It X-Feedname
The feedname (as set in sfeedrc).
.El
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr fdm 1 ,
.Xr procmail 1 ,
diff --git a/sfeed_opml_export.1 b/sfeed_opml_export.1
@@ -1,4 +1,4 @@
-.Dd December 25, 2014
+.Dd March 15, 2020
.Dt SFEED_OPML_EXPORT 1
.Os
.Sh NAME
@@ -22,6 +22,8 @@ see the
.Sx FILES READ
section for more information.
.El
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr sfeed_update 1 ,
.Xr sfeedrc 5
diff --git a/sfeed_opml_import.1 b/sfeed_opml_import.1
@@ -1,4 +1,4 @@
-.Dd December 25, 2014
+.Dd March 15, 2020
.Dt SFEED_OPML_IMPORT 1
.Os
.Sh NAME
@@ -9,6 +9,8 @@
.Sh DESCRIPTION
.Nm
reads the OPML XML data from stdin and writes the config file text to stdout.
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr sfeed_update 1 ,
.Xr sfeedrc 5
diff --git a/sfeed_plain.1 b/sfeed_plain.1
@@ -1,4 +1,4 @@
-.Dd July 20, 2019
+.Dd March 15, 2020
.Dt SFEED_PLAIN 1
.Os
.Sh NAME
@@ -38,6 +38,8 @@ per rune, using
.Xr mbtowc 3
and
.Xr wcwidth 3 .
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr sfeed 1 ,
.Xr sfeed_html 1 ,
diff --git a/sfeed_twtxt.1 b/sfeed_twtxt.1
@@ -1,4 +1,4 @@
-.Dd July 20, 2019
+.Dd March 15, 2020
.Dt SFEED_TWTXT 1
.Os
.Sh NAME
@@ -23,6 +23,8 @@ If no
.Ar file
parameters are specified and so the data is read from stdin the feed name
is empty.
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr sfeed 1 ,
.Xr sfeed_plain 1 ,
diff --git a/sfeed_update.1 b/sfeed_update.1
@@ -1,4 +1,4 @@
-.Dd February 4, 2020
+.Dd March 15, 2020
.Dt SFEED_UPDATE 1
.Os
.Sh NAME
@@ -44,6 +44,8 @@ The
script merges new items with this file.
The feedname cannot contain '/' characters, they will be replaced with '_'.
.El
+.Sh EXIT STATUS
+.Ex -std
.Sh EXAMPLES
To update your feeds and format them in various formats:
.Bd -literal
diff --git a/sfeed_web.1 b/sfeed_web.1
@@ -1,4 +1,4 @@
-.Dd December 13, 2017
+.Dd March 15, 2020
.Dt SFEED_WEB 1
.Os
.Sh NAME
@@ -31,6 +31,8 @@ option is specified then it is printed as is.
.It content\-type
Usually application/atom+xml or application/rss+xml.
.El
+.Sh EXIT STATUS
+.Ex -std
.Sh EXAMPLES
Get urls from xkcd website:
.Bd -literal
diff --git a/sfeed_xmlenc.1 b/sfeed_xmlenc.1
@@ -1,4 +1,4 @@
-.Dd December 2, 2018
+.Dd March 15, 2020
.Dt SFEED_XMLENC 1
.Os
.Sh NAME
@@ -10,6 +10,8 @@
.Nm
reads XML data from stdin and writes the found text\-encoding to stdout.
It translates the characters to lowercase and strips control characters.
+.Sh EXIT STATUS
+.Ex -std
.Sh EXAMPLES
Get text\-encoding from xkcd Atom feed:
.Bd -literal
