diff options
Diffstat (limited to 'sfeed_update.1')
| -rw-r--r-- | sfeed_update.1 | 79 |
1 files changed, 27 insertions, 52 deletions
diff --git a/sfeed_update.1 b/sfeed_update.1 index 96d5904..3632c5a 100644 --- a/sfeed_update.1 +++ b/sfeed_update.1 @@ -9,80 +9,55 @@ .Op Ar configfile .Sh DESCRIPTION .Nm -updates feeds and merges the new data with the previous feeds. This is the file -$HOME/.sfeed/feeds by default. +updates feeds files and merges the new data with the previous files. These +are the files in the directory +.Pa $HOME/.sfeed/feeds +by default. .Sh OPTIONS .Bl -tag -width 17n .It Ar configfile -config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default -see the +config file, if not specified uses the path +.Pa $HOME/.sfeed/sfeedrc +by default. See the .Sx FILES READ section for more information. .El -.Sh TAB-SEPARATED FORMAT FIELDS -The items are saved in a TSV-like format except newlines, tabs and -backslash are escaped with \\ (\\n, \\t and \\\\). Carriage returns (\\r) are -removed. -.Pp -The order and format of the fields are: -.Bl -tag -width 17n -.It Ar item timestamp -string, UNIX timestamp in GMT+0 -.It Ar item timestamp -string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[[+-][HHMM]] -.It Ar item title -string -.It Ar item link -string -.It Ar item content -string -.It Ar item content\-type -string, "html" or "plain" -.It Ar item id -string -.It Ar item author -string -.It Ar feed type -string, "rss" or "atom" -.El -.Sh EXTRA FIELDS -Extra fields added by sfeed_update: -.Bl -tag -width 17n -.It Ar feed name -string -.It Ar feed url -string -.It Ar item baseurl site -string -.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 sfeed_update. +This file is evaluated as a shellscript in +.Nm . You can for example override the fetchfeed() function to -use wget, fetch or an other download program or you can -override the merge() function to change the merge logic. -The function feeds() is called to fetch the feeds. By -default the function feed() is executed as a parallel -job to speedup updating. +use +.Xr curl 1 , +.Xr wget 1 , +or an other network downloader or you can override the merge() function to +change the merge logic. The function feeds() is called to fetch the feeds. By +default the function feed() is executed as a parallel job to speedup updating. .El .Sh FILES WRITTEN .Bl -tag -width 17n -.It Ar feeds -Tab-separated format containing all feeds. +.It Ar feedname +Tab-separated format containing all items per feed. The sfeed_update script merges new items with this file. -.It Ar feeds.new +.It Ar feedname.new Temporary file used by sfeed_update to merge items. .El .Sh EXAMPLES -To update feeds and format the feeds file: +To update your feeds and format them in various formats: .Bd -literal +# Update sfeed_update "configfile" -sfeed_plain < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.txt -sfeed_html < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.html +# Plain-text list +sfeed_plain $HOME/.sfeed/feeds/* > $HOME/.sfeed/feeds.txt +# HTML +sfeed_html $HOME/.sfeed/feeds/* > $HOME/.sfeed/feeds.html +# HTML with frames +mkdir somedir && cd somedir && sfeed_frames $HOME/.sfeed/feeds/* .Ed .Sh SEE ALSO +.Xr sfeed 1 , .Xr sfeed_html 1 , .Xr sfeed_plain 1 , .Xr sh 1 |