summaryrefslogtreecommitdiff
path: root/sfeed.1
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2021-07-27 11:25:02 +0200
committerHiltjo Posthuma <hiltjo@codemadness.org>2021-08-03 20:43:54 +0200
commit702fd5193030cae25c199e7c4dba7a9be1ba89cc (patch)
tree0d14b58d285b15724b3d5a643b4425d4f2b51f25 /sfeed.1
parent7199cd10a97e9d648b594cf6327f9ed7fa732527 (diff)
man page improvements
Diffstat (limited to 'sfeed.1')
-rw-r--r--sfeed.123
1 files changed, 9 insertions, 14 deletions
diff --git a/sfeed.1 b/sfeed.1
index ed93775..bb3f074 100644
--- a/sfeed.1
+++ b/sfeed.1
@@ -1,4 +1,4 @@
-.Dd July 6, 2021
+.Dd July 29, 2021
.Dt SFEED 1
.Os
.Sh NAME
@@ -11,21 +11,18 @@
.Nm
reads RSS or Atom feed data (XML) from stdin.
It writes the feed data in a TAB-separated format to stdout.
-A
-.Ar baseurl
-can be specified if the links or enclosures in the feed are relative URLs.
If the
.Ar baseurl
-is a valid absolute URL then the relative links or enclosures will be
-made absolute.
+argument is a valid absolute URL then the relative links or enclosures will be
+made an absolute URL.
.Sh TAB-SEPARATED FORMAT FIELDS
-The items are output per line in a TSV-like format.
+The items are output per line in a TAB-separated format.
.Pp
-The fields: title, id, author are not allowed to have newlines and TABs, all
-whitespace characters are replaced by a single space character.
+For the fields title, id and author each whitespace character is replaced by a
+SPACE character.
Control characters are removed.
.Pp
-The content field can contain newlines and is escaped.
+The content field can contain newlines and these are escaped.
TABs, newlines and '\\' are escaped with '\\', so it becomes: '\\t', '\\n'
and '\\\\'.
Other whitespace characters except spaces are removed.
@@ -66,7 +63,5 @@ curl -s 'https://codemadness.org/atom.xml' | sfeed
.Sh AUTHORS
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
.Sh CAVEATS
-If a timezone is not in the RFC-822 or RFC-3339 format it is not supported and
-the UNIX timestamp is interpreted as UTC+0.
-.Pp
-HTML in titles is treated as plain-text.
+If a timezone for the timestamp field is not in the RFC822 or RFC3339 format it
+is not supported and the timezone is interpreted as UTC+0.