sfeed

Simple RSS and Atom feed parser
git clone https://git.sinitax.com/codemadness/sfeed
Log | Files | Refs | README | LICENSE | Upstream | sfeed.txt

sfeed_update.1 (1843B)


      1.Dd August 1, 2023
      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
     12writes TAB-separated feed files and merges new items with the items in any
     13existing files.
     14The items are stored as one file per feed in the directory
     15.Pa $HOME/.sfeed/feeds
     16by default.
     17The directory can be changed in the
     18.Xr sfeedrc 5
     19file.
     20.Sh OPTIONS
     21.Bl -tag -width Ds
     22.It Ar sfeedrc
     23Config file.
     24The default is
     25.Pa $HOME/.sfeed/sfeedrc .
     26.El
     27.Sh FILES READ
     28.Bl -tag -width Ds
     29.It Ar sfeedrc
     30This file is evaluated as a shellscript in
     31.Nm .
     32See also the
     33.Xr sfeedrc 5
     34man 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
     39TAB-separated
     40.Xr sfeed 5
     41format containing all items per feed.
     42The
     43.Nm
     44script merges new items with this file.
     45.El
     46.Sh ENVIRONMENT VARIABLES
     47.Bl -tag -width Ds
     48.It SFEED_UPDATE_INCLUDE
     49When set to "1"
     50.Nm
     51can be sourced as a script, but it won't run the
     52.Fn main
     53entry-point.
     54.El
     55.Sh LOGGING
     56When processing a feed it will log failures to stderr and non-failures to
     57stdout in the format:
     58.Bd -literal
     59[HH:MM:SS] feedname message
     60.Ed
     61.Sh EXIT STATUS
     62.Ex -std
     63If any of the feeds failed to update then the exit status is non-zero.
     64.Sh EXAMPLES
     65To update your feeds and format them in various formats:
     66.Bd -literal
     67# Update feeds
     68sfeed_update "configfile"
     69# Format to a plain-text list
     70sfeed_plain ~/.sfeed/feeds/* > ~/.sfeed/feeds.txt
     71# Format to HTML
     72sfeed_html ~/.sfeed/feeds/* > ~/.sfeed/feeds.html
     73# Format to HTML with frames
     74mkdir -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