summaryrefslogtreecommitdiff
path: root/sfeed_update.1
diff options
context:
space:
mode:
authorBenjamin Chausse <benjamin@chausse.xyz>2024-08-09 14:11:50 -0400
committerBenjamin Chausse <benjamin@chausse.xyz>2024-08-09 14:11:50 -0400
commit5857d82e8e596d6fda406a0c4d8d68ca7a03c124 (patch)
tree553916894dee907825360580c5d9a05c82c5af16 /sfeed_update.1
parent3574e3cbf9d99546e868aeb995ce2c171cdc36a6 (diff)
parent19957bc272e745af7b56b79fa648e8b6b77113b1 (diff)
Merge remote-tracking branch 'upstream/master'HEADmaster
Diffstat (limited to 'sfeed_update.1')
-rw-r--r--sfeed_update.119
1 files changed, 12 insertions, 7 deletions
diff --git a/sfeed_update.1 b/sfeed_update.1
index 81f2d7d..ed61726 100644
--- a/sfeed_update.1
+++ b/sfeed_update.1
@@ -1,4 +1,4 @@
-.Dd August 3, 2021
+.Dd August 1, 2023
.Dt SFEED_UPDATE 1
.Os
.Sh NAME
@@ -42,8 +42,6 @@ format containing all items per feed.
The
.Nm
script merges new items with this file.
-The feed name cannot contain the '/' character because it is a path separator,
-they will be replaced with '_'.
.El
.Sh ENVIRONMENT VARIABLES
.Bl -tag -width Ds
@@ -54,18 +52,25 @@ can be sourced as a script, but it won't run the
.Fn main
entry-point.
.El
+.Sh LOGGING
+When processing a feed it will log failures to stderr and non-failures to
+stdout in the format:
+.Bd -literal
+[HH:MM:SS] feedname message
+.Ed
.Sh EXIT STATUS
.Ex -std
+If any of the feeds failed to update then the exit status is non-zero.
.Sh EXAMPLES
To update your feeds and format them in various formats:
.Bd -literal
-# Update
+# Update feeds
sfeed_update "configfile"
-# Plain-text list
+# Format to a plain-text list
sfeed_plain ~/.sfeed/feeds/* > ~/.sfeed/feeds.txt
-# HTML
+# Format to HTML
sfeed_html ~/.sfeed/feeds/* > ~/.sfeed/feeds.html
-# HTML with frames
+# Format to HTML with frames
mkdir -p somedir && cd somedir && sfeed_frames ~/.sfeed/feeds/*
.Ed
.Sh SEE ALSO