summaryrefslogtreecommitdiff
path: root/sfeed_update.1
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2021-01-25 19:35:02 +0100
committerHiltjo Posthuma <hiltjo@codemadness.org>2021-01-27 15:24:02 +0100
commit4d9f922c8396bada73fb0b1e318c8b947f0f606b (patch)
tree2a607d68bfde072dbe3ca910a14677d61308fe0c /sfeed_update.1
parentddda48dac8e373f9bc0884ffeb84605925d988e5 (diff)
sfeed_update: allow to reuse the code more easily as an included script
This adds a main() function. When the environment variable $SFEED_UPDATE_INCLUDE is set then it will not execute the main handler. The other functions are included and can be reused. This is also useful for unit-testing.
Diffstat (limited to 'sfeed_update.1')
-rw-r--r--sfeed_update.111
1 files changed, 10 insertions, 1 deletions
diff --git a/sfeed_update.1 b/sfeed_update.1
index 41a4870..552c81d 100644
--- a/sfeed_update.1
+++ b/sfeed_update.1
@@ -1,4 +1,4 @@
-.Dd September 19, 2020
+.Dd January 24, 2021
.Dt SFEED_UPDATE 1
.Os
.Sh NAME
@@ -44,6 +44,15 @@ The
script merges new items with this file.
The feedname cannot contain '/' characters, they will be replaced with '_'.
.El
+.Sh ENVIRONMENT VARIABLES
+.Bl -tag -width Ds
+.It SFEED_UPDATE_INCLUDE
+When set
+.Nm
+can be sourced as a script, but it won't run the
+.Fn main
+entry-point.
+.El
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES