commit c16ebc65b86d3cf8e76138414665908c71e22cdd
parent 8fa0217dbcc7fa36e08483a28cde7025af988503
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Sun, 10 Apr 2016 15:37:44 +0200
reword some sentences in the documentation/man pages
Diffstat:
2 files changed, 22 insertions(+), 19 deletions(-)
diff --git a/sfeed_frames.1 b/sfeed_frames.1
@@ -16,8 +16,8 @@ to HTML. It reads TSV data from stdin or
and writes HTML files to the current directory.
If no
.Ar file
-parameters are specified and so the data is read from stdin the feed name
-is named "unnamed".
+parameters are specified and therefore the data is read from stdin then the
+feed name is named "unnamed".
.Sh FILES WRITTEN
.Bl -tag -width 13n
.It index.html
@@ -30,12 +30,12 @@ Menu frame which contains navigation "anchor" links to the feed names
in items.html.
.El
.Sh FILE STRUCTURE
-Items for each feed category is in the format: feedname/itemname.html.
+Items for each feed category are in the format: 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. The itemname is based on the title of the items.
-The feedname and title is truncated to a maximum of 128 characters. The
-maximum length of the path is PATH_MAX or filesystem-specific (truncated).
+with a \- character, multiple whitespaces are replaced by a single \- character
+and trailing whitespace will be removed. The itemname is based on the title of
+the items. The feedname and title is truncated to a maximum of 128 bytes.
+The maximum length of the path is PATH_MAX or filesystem-specific (truncated).
.Sh SEE ALSO
.Xr sfeed 1 ,
.Xr sfeed_plain 1
diff --git a/sfeedrc.5 b/sfeedrc.5
@@ -11,7 +11,7 @@ is the configuration file for
.Pp
The variable
.Va sfeedpath
-can be set for the directory to store the feeds files,
+can be set for the directory to store the TAB-separated feed files,
by default this is
.Pa $HOME/.sfeed/feeds .
.
@@ -24,27 +24,30 @@ file:
This function is like a "main" function called from
.Xr sfeed_update 1 .
.It feed
-Function to process the feed, its arguments are in order:
+Function to process the feed, its arguments are in the order:
.Bl -tag -width Ds
.It name
-Name of the feed, this is also used as the filename for the feeds file.
+Name of the feed, this is also used as the filename for the TAB-separated
+feed file.
.It feedurl
-Uri to fetch the RSS/Atom data from, generally a HTTP or HTTPS uri.
+Uri to fetch the RSS/Atom data from, usually a HTTP or HTTPS uri.
.It Op basesiteurl
+Baseurl of the feed links. This argument allows to fix relative item links.
+.Pp
According to the RSS and Atom specification feeds should always have absolute
-urls, however this is not always the case in practise. This option allows to
-specify the base url to fix the relative urls.
+urls, however this is not always the case in practise.
.It Op encoding
-Feeds are decoded from this name to utf-8, the name should be a usable
+Feeds are decoded from this name to UTF-8, the name should be a usable
character-set for the
.Xr iconv 1
tool.
.El
.El
.Sh OVERRIDE FUNCTIONS
-Each function of
+Because
.Xr sfeed_update 1
-can be overridden to change its behaviour, notable functions are:
+is a shellscript each function can be overridden to change its behaviour,
+notable functions are:
.Bl -tag -width Ds
.It fetchfeed
Fetch feed from url and writes data to stdout, its arguments are:
@@ -54,7 +57,7 @@ Uri to fetch.
.It name
Specified name in configuration file (useful for logging).
.It feedfile
-Used feedfile (useful for checking modification times).
+Used feedfile (useful for comparing modification times).
.El
.It merge
Merge data of oldfile with newfile and writes it to stdout, its arguments are:
@@ -75,9 +78,9 @@ To text-encoding.
.El
.El
.Pp
-See the contents of
+See the convertencoding() function in the script
.Xr sfeed_update 1
-for more.
+for more details.
.Sh EXAMPLES
An example configuration file is included named sfeedrc.example and also
shown below:
