sfeed.1.txt - www.codemadness.org - www.codemadness.org saait content files
 (HTM) git clone git://git.codemadness.org/www.codemadness.org
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
       sfeed.1.txt (3021B)
       ---
            1 SFEED(1)                    General Commands Manual                      SFEED(1)
            2 
            3 NAME
            4      sfeed – RSS and Atom parser
            5 
            6 SYNOPSIS
            7      sfeed [baseurl]
            8 
            9 DESCRIPTION
           10      sfeed reads RSS or Atom feed data (XML) from stdin.  It writes the feed
           11      data in a TAB-separated format to stdout.        If the baseurl argument is a
           12      valid absolute URL then the relative links or enclosures will be made an
           13      absolute URL.
           14 
           15 TAB-SEPARATED FORMAT FIELDS
           16      The items are output per line in a TAB-separated format.
           17 
           18      For the fields title, id and author each whitespace character is replaced
           19      by a SPACE character.  Control characters are removed.
           20 
           21      The content field can contain newlines and these are escaped.  TABs,
           22      newlines and '\' are escaped with '\', so it becomes: '\t', '\n' and
           23      '\\'.  Other whitespace characters except spaces are removed.  Control
           24      characters are removed.
           25 
           26      The order and content of the fields are:
           27 
           28      1. timestamp     UNIX timestamp in UTC+0, empty if missing or on a parse
           29                       failure.
           30 
           31      2. title              Title text, HTML code in titles is ignored and is
           32                       treated as plain-text.
           33 
           34      3. link              Link
           35 
           36      4. content              Content, can have plain-text or HTML code depending on
           37                       the content-type field.
           38 
           39      5. content-type  "html" or "plain" if it has content.
           40 
           41      6. id              RSS item GUID or Atom id.
           42 
           43      7. author              Item, first author.
           44 
           45      8. enclosure     Item, first enclosure.
           46 
           47      9. category      Item, categories, multiple values are separated by the
           48                       '|' character.
           49 
           50 EXIT STATUS
           51      The sfeed utility exits 0 on success, and >0 if an error occurs.
           52 
           53 EXAMPLES
           54      curl -s 'https://codemadness.org/atom.xml' | sfeed
           55 
           56      To convert the character set from a feed that is not UTF-8 encoded the
           57      iconv(1) tool can be used:
           58 
           59      curl -s 'https://codemadness.org/some_iso-8859-1_feed.xml' | \
           60      iconv -f iso-8859-1 -t utf-8 | \
           61      sfeed
           62 
           63 EXAMPLE SETUP
           64      1. Create a directory for the sfeedrc configuration and the feeds:
           65 
           66              mkdir -p ~/.sfeed/feeds
           67 
           68      2. Copy the example sfeedrc(5) configuration:
           69 
           70              cp sfeedrc.example ~/.sfeed/sfeedrc
           71              $EDITOR ~/.sfeed/sfeedrc
           72 
           73      Or import existing OPML subscriptions using sfeed_opml_import(1):
           74 
           75              sfeed_opml_import < file.opml > ~/.sfeed/sfeedrc
           76 
           77      3. To update feeds and merge the new items with existing items:
           78 
           79              sfeed_update
           80 
           81      4. Format feeds to a plain-text list:
           82 
           83              sfeed_plain ~/.sfeed/feeds/*
           84 
           85      Or format feeds to a curses interface:
           86 
           87              sfeed_curses ~/.sfeed/feeds/*
           88 
           89      There are also other formatting programs included.         The README file has
           90      more examples.
           91 
           92 SEE ALSO
           93      sfeed_curses(1), sfeed_opml_import(1), sfeed_plain(1), sfeed_update(1),
           94      sfeed(5), sfeedrc(5)
           95 
           96 AUTHORS
           97      Hiltjo Posthuma <hiltjo@codemadness.org>
           98 
           99 CAVEATS
          100      If a timezone for the timestamp field is not in the RFC822 or RFC3339
          101      format it is not supported and the timezone is interpreted as UTC+0.
          102 
          103 Some OS 1.0                        January 7, 2023                           Some OS 1.0