sfeed_update.1 - sfeed - RSS and Atom parser
(HTM) git clone git://git.codemadness.org/sfeed
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
sfeed_update.1 (1870B)
---
1 .Dd October 27, 2024
2 .Dt SFEED_UPDATE 1
3 .Os
4 .Sh NAME
5 .Nm sfeed_update
6 .Nd update feeds and merge with old feeds
7 .Sh SYNOPSIS
8 .Nm
9 .Op Ar sfeedrc
10 .Sh DESCRIPTION
11 .Nm
12 writes TAB-separated feed files and merges new items with the items in any
13 existing files.
14 The items are stored as one file per feed in the directory
15 .Pa $HOME/.sfeed/feeds
16 by default.
17 The directory can be changed in the
18 .Xr sfeedrc 5
19 file.
20 .Sh OPTIONS
21 .Bl -tag -width Ds
22 .It Ar sfeedrc
23 Config file.
24 The default is
25 .Pa $HOME/.sfeed/sfeedrc .
26 .El
27 .Sh FILES READ
28 .Bl -tag -width Ds
29 .It Ar sfeedrc
30 This file is evaluated as a shellscript in
31 .Nm .
32 See also the
33 .Xr sfeedrc 5
34 man page for a detailed description of the format and an example file.
35 .El
36 .Sh FILES WRITTEN
37 .Bl -tag -width Ds
38 .It Pa feedname
39 TAB-separated
40 .Xr sfeed 5
41 format containing all items per feed.
42 The
43 .Nm
44 script merges new items with this file.
45 .El
46 .Sh ENVIRONMENT VARIABLES
47 .Bl -tag -width Ds
48 .It SFEED_UPDATE_INCLUDE
49 When set to "1"
50 .Nm
51 can be sourced as a script, but it won't run the
52 .Fn main
53 entry-point.
54 .El
55 .Sh LOGGING
56 When processing a feed it will log failures to stderr and non-failures to
57 stdout in the format:
58 .Bd -literal -offset 4n
59 [HH:MM:SS] feedname message
60 .Ed
61 .Sh EXIT STATUS
62 .Ex -std
63 If any of the feeds failed to update then the exit status is non-zero.
64 .Sh EXAMPLES
65 To update your feeds and format them in various formats:
66 .Bd -literal -offset 4n
67 # Update feeds
68 sfeed_update "configfile"
69 # Format to a plain-text list
70 sfeed_plain ~/.sfeed/feeds/* > ~/.sfeed/feeds.txt
71 # Format to HTML
72 sfeed_html ~/.sfeed/feeds/* > ~/.sfeed/feeds.html
73 # Format to HTML with frames
74 mkdir -p somedir && cd somedir && sfeed_frames ~/.sfeed/feeds/*
75 .Ed
76 .Sh SEE ALSO
77 .Xr sfeed 1 ,
78 .Xr sfeed_frames 1 ,
79 .Xr sfeed_html 1 ,
80 .Xr sfeed_plain 1 ,
81 .Xr sh 1 ,
82 .Xr sfeed 5 ,
83 .Xr sfeedrc 5
84 .Sh AUTHORS
85 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org