diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/sfeed.1 | 57 | ||||
-rw-r--r-- | doc/man/sfeed_frames.1 | 44 | ||||
-rw-r--r-- | doc/man/sfeed_html.1 | 21 | ||||
-rw-r--r-- | doc/man/sfeed_opml_export.1 | 24 | ||||
-rw-r--r-- | doc/man/sfeed_opml_import.1 | 16 | ||||
-rw-r--r-- | doc/man/sfeed_plain.1 | 22 | ||||
-rw-r--r-- | doc/man/sfeed_stats.1 | 22 | ||||
-rw-r--r-- | doc/man/sfeed_update.1 | 101 | ||||
-rw-r--r-- | doc/man/sfeed_web.1 | 40 | ||||
-rw-r--r-- | doc/man/sfeed_xmlenc.1 | 25 |
10 files changed, 0 insertions, 372 deletions
diff --git a/doc/man/sfeed.1 b/doc/man/sfeed.1 deleted file mode 100644 index f3eb62f..0000000 --- a/doc/man/sfeed.1 +++ /dev/null @@ -1,57 +0,0 @@ -.TH "SFEED" "1" "December 25, 2014" "" "General Commands Manual" -.nh -.if n .ad l -.SH "NAME" -\fBsfeed\fR -\- simple RSS and Atom parser -.SH "SYNOPSIS" -.HP 6n -\fBsfeed\fR -[\fIsuffix\ string\fR\ |\ \fB\-\fR\fIv\fR] -.SH "DESCRIPTION" -\fBsfeed\fR -reads RSS or Atom feed data (XML) from stdin. It writes the feed data in a -tab-separated format to stdout. -.SH "OPTIONS" -.TP 19n -\fB\-v\fR -show program version -.SH "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. -.PP -The order and format of the fields are: -.TP 19n -\fIitem timestamp\fR -string, UNIX timestamp in GMT+0 -.TP 19n -\fIitem timestamp\fR -string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[[+-][HHMM]] -.TP 19n -\fIitem title\fR -string -.TP 19n -\fIitem link\fR -string -.TP 19n -\fIitem content\fR -string -.TP 19n -\fIitem content\-type\fR -.br -string, "html" or "plain" -.TP 19n -\fIitem id\fR -string -.TP 19n -\fIitem author\fR -string -.TP 19n -\fIfeed type\fR -string, "rss" or "atom" -.SH "SEE ALSO" -sfeed_update(1), -sh(1) -.SH "AUTHORS" -Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_frames.1 b/doc/man/sfeed_frames.1 deleted file mode 100644 index 52e7a18..0000000 --- a/doc/man/sfeed_frames.1 +++ /dev/null @@ -1,44 +0,0 @@ -.TH "SFEED_FRAMES" "1" "December 25, 2014" "" "General Commands Manual" -.nh -.if n .ad l -.SH "NAME" -\fBsfeed_frames\fR -\- formats a feeds file to HTML with frames -.SH "SYNOPSIS" -.HP 13n -\fBsfeed_frames\fR -[\fIdirectory\ path\fR] -.SH "DESCRIPTION" -\fBsfeed_frames\fR -formats a feeds file (TSV) from -sfeed_update(1) -to HTML. It reads TSV data from stdin and writes HTML to the specified -directory. For the exact TSV format see -sfeed_update(1). -.SH "OPTIONS" -.TP 16n -\fIdirectory path\fR -Path to write files to, default is ".". On success the specified directory will -contain the files: -.TP 15n -\fIindex.html:\fR -this is the main HTML file referencing to the frames (items.html and -menu.html). -.TP 15n -\fIitems.html:\fR -this contains all the items as HTML links to the local content. -.TP 15n -\fImenu.html:\fR -menu frame which contains navigation "anchor" links to the feed names -(in items.html). -.SH "FILE STRUCTURE" -Directory for each feed category in the format: path/feedname/itemname.html. -The feedname and item names are normalized, whitespace characters are replaced -with a \-, multiple whitespaces are replaced by a single \- and trailing -whitespace will be removed. -.SH "SEE ALSO" -sfeed(1), -sfeed_plain(1), -sfeed_update(1) -.SH "AUTHORS" -Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_html.1 b/doc/man/sfeed_html.1 deleted file mode 100644 index d539a9d..0000000 --- a/doc/man/sfeed_html.1 +++ /dev/null @@ -1,21 +0,0 @@ -.TH "SFEED_HTML" "1" "December 25, 2014" "" "General Commands Manual" -.nh -.if n .ad l -.SH "NAME" -\fBsfeed_html\fR -\- formats a feeds file to HTML -.SH "SYNOPSIS" -.HP 11n -\fBsfeed_html\fR -.SH "DESCRIPTION" -\fBsfeed_html\fR -formats a feeds file (TSV) from -sfeed_update(1) -to HTML. It reads TSV data from stdin and writes HTML to stdout. For the exact TSV format see -sfeed_update(1). -.SH "SEE ALSO" -sfeed(1), -sfeed_plain(1), -sfeed_update(1) -.SH "AUTHORS" -Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_opml_export.1 b/doc/man/sfeed_opml_export.1 deleted file mode 100644 index 7561ae1..0000000 --- a/doc/man/sfeed_opml_export.1 +++ /dev/null @@ -1,24 +0,0 @@ -.TH "SFEED_OPML_EXPORT" "1" "December 25, 2014" "" "General Commands Manual" -.nh -.if n .ad l -.SH "NAME" -\fBsfeed_opml_export\fR -\- generate an OPML file based on a sfeedrc config file -.SH "SYNOPSIS" -.HP 18n -\fBsfeed_opml_export\fR -[\fIconfig\ file\fR] -.SH "DESCRIPTION" -\fBsfeed_opml_export\fR -parses the specified config file and output OPML XML data to stdout. -.SH "OPTIONS" -.TP 19n -[config file] -default: "$HOME/.sfeed/sfeedrc", see the -sfeed_update(1) -\fIFILES READ\fR -section for more information. -.SH "SEE ALSO" -sfeed_update(1) -.SH "AUTHORS" -Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_opml_import.1 b/doc/man/sfeed_opml_import.1 deleted file mode 100644 index f589bb5..0000000 --- a/doc/man/sfeed_opml_import.1 +++ /dev/null @@ -1,16 +0,0 @@ -.TH "SFEED_OPML_IMPORT" "1" "December 25, 2014" "" "General Commands Manual" -.nh -.if n .ad l -.SH "NAME" -\fBsfeed_opml_import\fR -\- generate a sfeedrc config file based on an OPML file -.SH "SYNOPSIS" -.HP 18n -\fBsfeed_opml_import\fR -.SH "DESCRIPTION" -\fBsfeed_opml_import\fR -reads the OPML XML data from stdin and writes the config file text to stdout. -.SH "SEE ALSO" -sfeed_update(1) -.SH "AUTHORS" -Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_plain.1 b/doc/man/sfeed_plain.1 deleted file mode 100644 index 2bae1a4..0000000 --- a/doc/man/sfeed_plain.1 +++ /dev/null @@ -1,22 +0,0 @@ -.TH "SFEED_PLAIN" "1" "December 25, 2014" "" "General Commands Manual" -.nh -.if n .ad l -.SH "NAME" -\fBsfeed_plain\fR -\- formats a feeds file to plain text -.SH "SYNOPSIS" -.HP 12n -\fBsfeed_plain\fR -.SH "DESCRIPTION" -\fBsfeed_plain\fR -formats a feeds file (TSV) from -sfeed_update(1) -to plain text. It reads TSV data from stdin and writes formatted plain text to -stdout. For the exact TSV format see -sfeed_update(1). -.SH "SEE ALSO" -sfeed(1), -sfeed_html(1), -sfeed_update(1) -.SH "AUTHORS" -Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_stats.1 b/doc/man/sfeed_stats.1 deleted file mode 100644 index 275fed6..0000000 --- a/doc/man/sfeed_stats.1 +++ /dev/null @@ -1,22 +0,0 @@ -.TH "SFEED_STATS" "1" "January 3, 2015" "" "General Commands Manual" -.nh -.if n .ad l -.SH "NAME" -\fBsfeed_stats\fR -\- formats a feeds file to show a summary in plain text -.SH "SYNOPSIS" -.HP 12n -\fBsfeed_stats\fR -.SH "DESCRIPTION" -\fBsfeed_stats\fR -formats a feeds file (TSV) from -sfeed_update(1) -to a summary in plain text containing: the total amount of items, amount of new -items, the timestamp of the last item per feed. It reads TSV data from stdin -and writes formatted plain text to stdout. For the exact TSV format see -sfeed_update(1). -.SH "SEE ALSO" -sfeed(1), -sfeed_update(1) -.SH "AUTHORS" -Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_update.1 b/doc/man/sfeed_update.1 deleted file mode 100644 index 3f0a451..0000000 --- a/doc/man/sfeed_update.1 +++ /dev/null @@ -1,101 +0,0 @@ -.TH "SFEED_UPDATE" "1" "December 25, 2014" "" "General Commands Manual" -.nh -.if n .ad l -.SH "NAME" -\fBsfeed_update\fR -\- update feeds and merge with old feeds -.SH "SYNOPSIS" -.HP 13n -\fBsfeed_update\fR -[\fIconfigfile\fR] -.SH "DESCRIPTION" -\fBsfeed_update\fR -updates feeds and merges the new data with the previous feeds. This is the file -$HOME/.sfeed/feeds by default. -.SH "OPTIONS" -.TP 19n -\fIconfigfile\fR -config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default -see the -\fIFILES READ\fR -section for more information. -.SH "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. -.PP -The order and format of the fields are: -.TP 19n -\fIitem timestamp\fR -string, UNIX timestamp in GMT+0 -.TP 19n -\fIitem timestamp\fR -string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[[+-][HHMM]] -.TP 19n -\fIitem title\fR -string -.TP 19n -\fIitem link\fR -string -.TP 19n -\fIitem content\fR -string -.TP 19n -\fIitem content\-type\fR -.br -string, "html" or "plain" -.TP 19n -\fIitem id\fR -string -.TP 19n -\fIitem author\fR -string -.TP 19n -\fIfeed type\fR -string, "rss" or "atom" -.SH "EXTRA FIELDS" -Extra fields added by sfeed_update: -.TP 19n -\fIfeed name\fR -string -.TP 19n -\fIfeed url\fR -string -.TP 19n -\fIitem baseurl site\fR -string -.SH "FILES READ" -.TP 19n -\fIsfeedrc\fR -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. -.SH "FILES WRITTEN" -.TP 19n -\fIfeeds\fR -Tab-separated format containing all feeds. -The sfeed_update script merges new items with this file. -.TP 19n -\fIfeeds.new\fR -Temporary file used by sfeed_update to merge items. -.SH "EXAMPLES" -To update feeds and format the feeds file: -.nf -.sp -.RS 0n -sfeed_update "configfile" -sfeed_plain < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.txt -sfeed_html < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.html -.RE -.fi -.SH "SEE ALSO" -sfeed_html(1), -sfeed_plain(1), -sh(1) -.SH "AUTHORS" -Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_web.1 b/doc/man/sfeed_web.1 deleted file mode 100644 index bc3c24a..0000000 --- a/doc/man/sfeed_web.1 +++ /dev/null @@ -1,40 +0,0 @@ -.TH "SFEED_WEB" "1" "December 25, 2014" "" "General Commands Manual" -.nh -.if n .ad l -.SH "NAME" -\fBsfeed_web\fR -\- finds urls to feeds from a HTML webpage -.SH "SYNOPSIS" -.HP 10n -\fBsfeed_web\fR -[\fIbaseurl\fR] -.SH "DESCRIPTION" -\fBsfeed_web\fR -reads the HTML website as XML or HTML data from stdin and writes the found -urls to stdout. -.SH "OPTIONS" -.TP 10n -\fIbaseurl\fR -optional base url to use for found feed urls that are relative. -.SH "OUTPUT FORMAT" -content\-type<space>url<newline> -.TP 15n -\fIcontent\-type\fR -Usually application/atom+xml or application/rss+xml. -.TP 15n -\fIurl\fR -Found url to the feed. If the url is relative and the baseurl option is -specified then the url is changed accordingly. -.SH "EXAMPLES" -Get urls from xkcd website: -.nf -.sp -.RS 0n -wget http://www.xkcd.com -q -O - | sfeed_web "http://www.xkcd.com/" -.RE -.fi -.SH "SEE ALSO" -sfeed_update(1), -sh(1) -.SH "AUTHORS" -Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_xmlenc.1 b/doc/man/sfeed_xmlenc.1 deleted file mode 100644 index 21eabb9..0000000 --- a/doc/man/sfeed_xmlenc.1 +++ /dev/null @@ -1,25 +0,0 @@ -.TH "SFEED_XMLENC" "1" "December 25, 2014" "" "General Commands Manual" -.nh -.if n .ad l -.SH "NAME" -\fBsfeed_xmlenc\fR -\- get text\-encoding from XML -.SH "SYNOPSIS" -.HP 13n -\fBsfeed_xmlenc\fR -.SH "DESCRIPTION" -\fBsfeed_xmlenc\fR -reads XML data from stdin and writes the found text\-encoding to stdout. -.SH "EXAMPLES" -Get text\-encoding from xkcd Atom feed: -.nf -.sp -.RS 0n -wget http://www.xkcd.com/atom.xml -q -O - | sfeed_xmlenc -.RE -.fi -.SH "SEE ALSO" -sfeed_update(1), -sh(1) -.SH "AUTHORS" -Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> |