summaryrefslogtreecommitdiff
path: root/sfeed.1
diff options
context:
space:
mode:
Diffstat (limited to 'sfeed.1')
-rw-r--r--sfeed.125
1 files changed, 14 insertions, 11 deletions
diff --git a/sfeed.1 b/sfeed.1
index 3784694..8da28a3 100644
--- a/sfeed.1
+++ b/sfeed.1
@@ -9,21 +9,24 @@
.Op Ar baseurl
.Sh DESCRIPTION
.Nm
-reads RSS or Atom feed data (XML) from stdin. It writes the feed data in a
-TAB-separated format to stdout. A
+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 in the feed are relative urls. It is
-recommended to always have absolute urls in your feeds.
+can be specified if the links in the feed are relative urls.
+It is recommended to always have absolute urls in your feeds.
.Sh TAB-SEPARATED FORMAT FIELDS
The items are saved in a TSV-like 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. Control
-characters are removed.
+whitespace characters are replaced by a single space character.
+Control characters are removed.
.Pp
-The content field can contain newlines and is escaped. TABs, newlines and '\\'
-are escaped with '\\', so it becomes: '\\t', '\\n' and '\\\\'. Other whitespace
-characters except space are removed. Control characters are removed.
+The content field can contain newlines and is escaped.
+TABs, newlines and '\\' are escaped with '\\', so it becomes: '\\t', '\\n'
+and '\\\\'.
+Other whitespace characters except spaces are removed.
+Control characters are removed.
.Pp
The order and content of the fields are:
.Bl -tag -width 17n
@@ -34,8 +37,8 @@ Title text, HTML code in titles is ignored and is treated as plain-text.
.It link
Absolute url, unsafe characters are encoded.
.It content
-Content, can have plain-text or HTML code depending on the content\-type field.
-.It content\-type
+Content, can have plain-text or HTML code depending on the content-type field.
+.It content-type
"html" or "plain".
.It id
RSS item GUID or Atom id.