From c61c37abf3b6236cd65690fe8a47bdcd9d66bc13 Mon Sep 17 00:00:00 2001 From: Hiltjo Posthuma Date: Fri, 2 Jan 2015 15:13:12 +0100 Subject: doc: use mandoc as source, pre-generate documentation generate documentation in doc/ . Now there is no hard dependency on mandoc and systems that don't have it can just copy the files for now. --- doc/html/sfeed_update.1.html | 160 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 doc/html/sfeed_update.1.html (limited to 'doc/html/sfeed_update.1.html') diff --git a/doc/html/sfeed_update.1.html b/doc/html/sfeed_update.1.html new file mode 100644 index 0000000..7ed03c5 --- /dev/null +++ b/doc/html/sfeed_update.1.html @@ -0,0 +1,160 @@ + + + + + + + +SFEED_UPDATE(1) + + +
+ + + + + + + + +
+SFEED_UPDATE(1) +General Commands Manual +SFEED_UPDATE(1)
+
+

NAME

sfeed_update — update feeds and merge with old feeds
+
+

SYNOPSIS

+++ + + + + + +
+sfeed_update +[configfile]
+
+
+

DESCRIPTION

sfeed_update updates feeds and merges the new data with the previous feeds. This is the file $HOME/.sfeed/feeds by default.
+
+

OPTIONS

+
+configfile
+
+config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default see the FILES READ section for more information.
+
+
+
+

TAB-SEPARATED FORMAT FIELDS

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.
+
+The order and format of the fields are:
+
+item timestamp
+
+string, UNIX timestamp in GMT+0
+
+item timestamp
+
+string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[+-]HHMM
+
+item title
+
+string
+
+item link
+
+string
+
+item content
+
+string
+
+item content-type
+
+string, "html" or "plain"
+
+item id
+
+string
+
+item author
+
+string
+
+feed type
+
+string, "rss" or "atom"
+
+
+
+

EXTRA FIELDS

Extra fields added by sfeed_update:
+
+feed name
+
+string
+
+feed url
+
+string
+
+item baseurl site
+
+string
+
+
+
+

FILES READ

+
+sfeedrc
+
+Config file, see the sfeedrc.example file for an example. This file is evaluated as a shellscript in sfeed_update. You can for example override the fetchfeed() function to use wget, fetch or an other download program or you can 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.
+
+
+
+

FILES WRITTEN

+
+feeds
+
+Tab-separated format containing all feeds. The sfeed_update script merges new items with this file.
+
+feeds.new
+
+Temporary file used by sfeed_update to merge items.
+
+
+
+

EXAMPLES

To update feeds and format the feeds file:
+
+
+sfeed_update "configfile" 
+sfeed_plain < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.txt 
+sfeed_html < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.html
+
+
+

SEE ALSO

sh(1), sfeed_plain(1), sfeed_html(1)
+
+

AUTHORS

Hiltjo Posthuma <hiltjo@codemadness.org>
+ + + + + + + +
+December 25, 2014 +
+
+ + + -- cgit v1.2.3