commit 303416241424af1810810073cce2f729114f68ea
parent c34c9185c09a48abdacfdc1a2c68a60abf06b8b9
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Tue, 6 Jul 2021 18:21:34 +0200
sfeed.{1,5}: number fields in the man page
This makes it slightly easier to lookup fields and map the fields by field
number in scripts (awk, cut) etc.
Diffstat:
| M | sfeed.1 | | | 22 | +++++++++++----------- |
| M | sfeed.5 | | | 22 | +++++++++++----------- |
2 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/sfeed.1 b/sfeed.1
@@ -1,4 +1,4 @@
-.Dd April 27, 2021
+.Dd July 6, 2021
.Dt SFEED 1
.Os
.Sh NAME
@@ -32,24 +32,24 @@ Other whitespace characters except spaces are removed.
Control characters are removed.
.Pp
The order and content of the fields are:
-.Bl -tag -width 12n
-.It timestamp
+.Bl -tag -width 15n
+.It 1. timestamp
UNIX timestamp in UTC+0, empty if missing or on parse failure.
-.It title
+.It 2. title
Title text, HTML code in titles is ignored and is treated as plain-text.
-.It link
+.It 3. link
Link
-.It content
+.It 4. content
Content, can have plain-text or HTML code depending on the content-type field.
-.It content-type
+.It 5. content-type
"html" or "plain" if it has content.
-.It id
+.It 6. id
RSS item GUID or Atom id.
-.It author
+.It 7. author
Item author.
-.It enclosure
+.It 8. enclosure
Item, first enclosure.
-.It category
+.It 9. category
Item, categories, multiple values are separated by |.
.El
.Sh EXIT STATUS
diff --git a/sfeed.5 b/sfeed.5
@@ -1,4 +1,4 @@
-.Dd April 27, 2021
+.Dd July 6, 2021
.Dt SFEED 5
.Os
.Sh NAME
@@ -23,24 +23,24 @@ Other whitespace characters except spaces are removed.
Control characters are removed.
.Pp
The order and content of the fields are:
-.Bl -tag -width 12n
-.It timestamp
+.Bl -tag -width 15n
+.It 1. timestamp
UNIX timestamp in UTC+0, empty if missing or on parse failure.
-.It title
+.It 2. title
Title text, HTML code in titles is ignored and is treated as plain-text.
-.It link
+.It 3. link
Link
-.It content
+.It 4. content
Content, can have plain-text or HTML code depending on the content-type field.
-.It content-type
+.It 5. content-type
"html" or "plain" if it has content.
-.It id
+.It 6. id
RSS item GUID or Atom id.
-.It author
+.It 7. author
Item author.
-.It enclosure
+.It 8. enclosure
Item, first enclosure.
-.It category
+.It 9. category
Item, categories, multiple values are separated by |.
.El
.Sh SEE ALSO
