summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2015-07-31 22:50:12 +0200
committerHiltjo Posthuma <hiltjo@codemadness.org>2015-07-31 22:50:12 +0200
commita3262c7d7d442b2b8af458cf00d1086917d5f65d (patch)
treed9eb712f51cf5e23596f3b52269c6c2d98006d4b
parent0a4281c4599bc46a321f34fc7c5e6695c713c56e (diff)
improve documentation
-rw-r--r--CHANGELOG5
-rw-r--r--README4
-rwxr-xr-xsfeed_opml_export2
-rwxr-xr-xsfeed_update2
-rw-r--r--sfeed_update.13
5 files changed, 9 insertions, 7 deletions
diff --git a/CHANGELOG b/CHANGELOG
index f2318c0..1a6d6bf 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -4,9 +4,10 @@ v0.9
Features:
---------
-* sfeed_update: feeds are now by default updated in parallel for an increase
+* sfeed_update: feeds are now by default updated concurrently for an increase
in performance.
* sfeed_update: Auto-detect XML character set encoding (sfeed_xmlenc).
+* Add sfeed_mbox: format feeds to mbox.
* Add sfeed_web: find RSS/Atom feeds from web-pages.
* Add sfeed_frames, a formatting program to output feeds as a HTML file with
frames. It's optimized to look good in older browsers that don't necesarily
@@ -21,7 +22,7 @@ Bug fixes:
* Fix off-by-one in string_append when reallocating buffer.
* Parsing datetime strings containing timezone suffix to UNIX timestamps
- was wrong. UNIX timestamps are in GMT+0 time. For simplicity sake output
+ was wrong. UNIX timestamps are in UTC+0 time. For simplicity sake output
parsed datetime strings in a formatted manner without converting the
time to the user selected timezone (YYYY-mm-dd HH:mm:ss TZ([-+]offset?).
* Also when determining if an item is new (by comparing the UNIX
diff --git a/README b/README
index 92009f6..d57820e 100644
--- a/README
+++ b/README
@@ -61,8 +61,8 @@ sfeedrc - Config file. This file is evaluated as a shellscript in
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. The function feed() can
- safely be executed as a parallel job in your sfeedrc config file to
- speed up updating.
+ safely be executed concurrently as a background job in your sfeedrc
+ config file to speed up updating.
Files written at runtime by sfeed_update
diff --git a/sfeed_opml_export b/sfeed_opml_export
index d3dea8b..1f9c1cc 100755
--- a/sfeed_opml_export
+++ b/sfeed_opml_export
@@ -41,7 +41,7 @@ cat <<!
!
feeds
-# wait till all items are processed (in parallel).
+# wait till all items are processed (concurrently).
wait
cat <<!
diff --git a/sfeed_update b/sfeed_update
index 7ce2d69..ed5f2e4 100755
--- a/sfeed_update
+++ b/sfeed_update
@@ -114,7 +114,7 @@ trap -- "kill -TERM -$$" "2"
mkdir -p "${sfeeddir}"
# fetch feeds specified in config file.
feeds
-# wait till all feeds are fetched (allows running in parallel).
+# wait till all feeds are fetched (concurrently).
wait
# cleanup temporary files etc.
cleanup
diff --git a/sfeed_update.1 b/sfeed_update.1
index 0a99a5d..4f15592 100644
--- a/sfeed_update.1
+++ b/sfeed_update.1
@@ -34,7 +34,8 @@ use
.Xr wget 1 ,
or an other network downloader 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.
+default the function feed() is executed concurrently as a background job to
+speedup updating.
.El
.Sh FILES WRITTEN
.Bl -tag -width 17n