summaryrefslogtreecommitdiff
path: root/sfeed_update.1
diff options
context:
space:
mode:
Diffstat (limited to 'sfeed_update.1')
-rw-r--r--sfeed_update.110
1 files changed, 6 insertions, 4 deletions
diff --git a/sfeed_update.1 b/sfeed_update.1
index 4ffb52a..ad50883 100644
--- a/sfeed_update.1
+++ b/sfeed_update.1
@@ -18,14 +18,13 @@ config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default
see the
.Sx FILES READ
section for more information.
+.El
.Sh TAB-SEPARATED FORMAT FIELDS
-.Pp
The items are saved in a TSV-like format except newlines, tabs and
backslash are escaped with \\ (\\n, \\t and \\\\). Carriage returns (\\r) are
removed.
.Pp
The order and format of the fields are:
-.Pp
.Bl -tag -width 17n
.It Ar item timestamp
string, UNIX timestamp in GMT+0
@@ -45,8 +44,8 @@ string
string
.It Ar feed type
string, "rss" or "atom"
+.El
.Sh EXTRA FIELDS
-.Pp
Extra fields added by sfeed_update:
.Bl -tag -width 17n
.It Ar feed name
@@ -55,6 +54,7 @@ string
string
.It Ar item baseurl site
string
+.El
.Sh FILES READ
.Bl -tag -width 17n
.It Ar sfeedrc
@@ -66,6 +66,7 @@ override the merge() function to change the merge logic.
The function feeds() is called to fetch the feeds. By
default the function feed() is executed as a parallel
job to speedup updating.
+.El
.Sh FILES WRITTEN
.Bl -tag -width 17n
.It Ar feeds
@@ -73,13 +74,14 @@ Tab-separated format containing all feeds.
The sfeed_update script merges new items with this file.
.It Ar feeds.new
Temporary file used by sfeed_update to merge items.
+.El
.Sh EXAMPLES
-.Pp
To update feeds and format the feeds file:
.Bd -literal
sfeed_update "configfile"
sfeed_plain < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.txt
sfeed_html < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.html
+.Ed
.Sh SEE ALSO
.Xr sh 1 ,
.Xr sfeed_plain 1 ,