sfeed_update.1 (raw) (1957B)
1 .Dd December 15, 2022 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 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 The feed name cannot contain the '/' character because it is a path separator, 46 they will be replaced with '_'. 47 .El 48 .Sh ENVIRONMENT VARIABLES 49 .Bl -tag -width Ds 50 .It SFEED_UPDATE_INCLUDE 51 When set to "1" 52 .Nm 53 can be sourced as a script, but it won't run the 54 .Fn main 55 entry-point. 56 .El 57 .Sh LOGGING 58 When processing a feed it will log failures to stderr and non-failures to 59 stdout in the format: 60 .Bd -literal 61 [HH:MM:SS] feedname message 62 .Ed 63 .Sh EXIT STATUS 64 .Ex -std 65 If any of the feeds failed to update then the exit status is non-zero. 66 .Sh EXAMPLES 67 To update your feeds and format them in various formats: 68 .Bd -literal 69 # Update feeds 70 sfeed_update "configfile" 71 # Format to a plain-text list 72 sfeed_plain ~/.sfeed/feeds/* > ~/.sfeed/feeds.txt 73 # Format to HTML 74 sfeed_html ~/.sfeed/feeds/* > ~/.sfeed/feeds.html 75 # Format to HTML with frames 76 mkdir -p somedir && cd somedir && sfeed_frames ~/.sfeed/feeds/* 77 .Ed 78 .Sh SEE ALSO 79 .Xr sfeed 1 , 80 .Xr sfeed_frames 1 , 81 .Xr sfeed_html 1 , 82 .Xr sfeed_plain 1 , 83 .Xr sh 1 , 84 .Xr sfeed 5 , 85 .Xr sfeedrc 5 86 .Sh AUTHORS 87 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org