diff options
author | Hiltjo Posthuma <hiltjo@codemadness.org> | 2019-01-25 13:50:43 +0100 |
---|---|---|
committer | Hiltjo Posthuma <hiltjo@codemadness.org> | 2019-01-25 13:50:43 +0100 |
commit | e46d200e0cb2ffb79a7d542f65809e1bb14c445c (patch) | |
tree | 0438b9ec357fdcc20dd109d80ce2ff6cbde9b2ea /sfeed_update.1 | |
parent | 69459b1ef6af55ea1c6e83947e939baacb3e93c8 (diff) |
documentation improvements
Man pages:
- sfeed_update: fix: fetchfeed parameter documentation.
- sfeed_update: fix/update: urls in sfeedrc.example.
- sfeed_update: document maxjobs variable.
- sfeedrc: document filter and order functions here.
- more semantic keywords: function arguments and some Nm.
README:
- Document more clearly sfeedrc is a shellscript at the first usage "steps".
- Add newsboat OPML export and import to sfeed_update example.
- Document the Makefile is POSIX (not some GNU/Makefile).
- Add reference to my tool hurl: a HTTP/HTTPS/Gopher file grab client.
- Describe the reason/usefulness of the filter example.
- Describe how to override curl(1), an optional dependency.
With feedback from lich, thanks!
Diffstat (limited to 'sfeed_update.1')
-rw-r--r-- | sfeed_update.1 | 30 |
1 files changed, 21 insertions, 9 deletions
diff --git a/sfeed_update.1 b/sfeed_update.1 index 2260de0..9a27c7f 100644 --- a/sfeed_update.1 +++ b/sfeed_update.1 @@ -1,4 +1,4 @@ -.Dd September 28, 2018 +.Dd January 25, 2019 .Dt SFEED_UPDATE 1 .Os .Sh NAME @@ -32,33 +32,45 @@ This file is evaluated as a shellscript in .Pp Atleast the following functions can be overridden per feed: .Bl -tag -width 17n -.It fetchfeed +.It Fn fetchfeed to use .Xr wget 1 , OpenBSD .Xr ftp 1 or an other download program. -.It merge +.It Fn merge to change the merge logic. -.It filter +.It Fn filter to filter on fields. -.It order +.It Fn order to change the sort order. .El .Pp -The function feeds() is called to fetch the feeds. -The function feed() can safely be executed concurrently as a background job in +The function +.Fn feeds +is called to process the feeds. +The default +.Fn feed +is executed concurrently as a background job in your .Xr sfeedrc 5 config file to make updating faster. +The variable +.Va maxjobs +can be changed to limit or increase the amount of concurrent jobs (8 by +default). .El .Sh FILES WRITTEN .Bl -tag -width 17n .It feedname TAB-separated format containing all items per feed. -The sfeed_update script merges new items with this file. +The +.Nm +script merges new items with this file. .It feedname.new -Temporary file used by sfeed_update to merge items. +Temporary file used by +.Nm +to merge items. .El .Sh EXAMPLES To update your feeds and format them in various formats: |