summaryrefslogtreecommitdiff
path: root/sfeed_update.1
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2020-02-04 22:05:06 +0100
committerHiltjo Posthuma <hiltjo@codemadness.org>2020-02-04 22:05:06 +0100
commitff6e334d311e35e330d43c543d0709a619c85655 (patch)
tree235fd0c0a7fff9e4856aa5d1c36a9916d82d356c /sfeed_update.1
parent72e9926a6156f6c9dc465616f4cf73593ab92d03 (diff)
man page improvements
- sfeedrc.5: use the same order as executed in the sfeed_update file. - sfeedrc.5: reference iconv and curl, which are option, but used by default. - sfeedrc.5: use a .Sh VARIABLES section for sfeedpath and maxjobs. - sfeed_update.1: split config format-specific documentation and reference it. - just use the term "url" instead of "uri". - shorten some texts, increasing readability.
Diffstat (limited to 'sfeed_update.1')
-rw-r--r--sfeed_update.157
1 files changed, 17 insertions, 40 deletions
diff --git a/sfeed_update.1 b/sfeed_update.1
index 2ca6c1c..d23842b 100644
--- a/sfeed_update.1
+++ b/sfeed_update.1
@@ -1,4 +1,4 @@
-.Dd July 20, 2019
+.Dd February 4, 2020
.Dt SFEED_UPDATE 1
.Os
.Sh NAME
@@ -9,64 +9,40 @@
.Op Ar sfeedrc
.Sh DESCRIPTION
.Nm
-updates feeds files and merges the new data with the previous files.
-These are the files in the directory
+writes TAB-separated feed files and merges new items with the items in any
+existing files.
+The items are stored in one file per feed in the directory
.Pa $HOME/.sfeed/feeds
by default.
+The directory can be changed in the
+.Xr sfeedrc 5
+file.
.Sh OPTIONS
.Bl -tag -width 17n
.It Ar sfeedrc
-Config file, if not specified uses the path
-.Pa $HOME/.sfeed/sfeedrc
-by default.
-See the
-.Sx FILES READ
-section for more information.
+Config file.
+The default is
+.Pa $HOME/.sfeed/sfeedrc .
.El
.Sh FILES READ
.Bl -tag -width 17n
.It Ar sfeedrc
-Config file, see the sfeedrc.example file for an example.
This file is evaluated as a shellscript in
.Nm .
-.Pp
-Atleast the following functions can be overridden per feed:
-.Bl -tag -width 17n
-.It Fn fetch
-to use
-.Xr wget 1 ,
-OpenBSD
-.Xr ftp 1
-or an other download program.
-.It Fn merge
-to change the merge logic.
-.It Fn filter
-to filter on fields.
-.It Fn order
-to change the sort order.
-.El
-.Pp
-The
-.Fn feeds
-function is called to process the feeds.
-The default
-.Fn feed
-function is executed concurrently as a background job in your
+See also the
.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).
+man page for a detailed description of the format and an example file.
.El
.Sh FILES WRITTEN
.Bl -tag -width 17n
.It feedname
-TAB-separated format containing all items per feed.
+TAB-separated
+.Xr sfeed 5
+format containing all items per feed.
The
.Nm
script merges new items with this file.
-The filename cannot contain '/' characters, they will be replaced with '_'.
+The feedname cannot contain '/' characters, they will be replaced with '_'.
.El
.Sh EXAMPLES
To update your feeds and format them in various formats:
@@ -82,6 +58,7 @@ mkdir -p somedir && cd somedir && sfeed_frames $HOME/.sfeed/feeds/*
.Ed
.Sh SEE ALSO
.Xr sfeed 1 ,
+.Xr sfeed_frames 1 ,
.Xr sfeed_html 1 ,
.Xr sfeed_plain 1 ,
.Xr sh 1 ,