README.md - zs - Zeitungsschau rss to email converter
 (HTM) git clone git://r-36.net/zs
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
       README.md (1229B)
       ---
            1 # Zeitungsschau RSS to email converter
            2 
            3 ## Build
            4 
            5         ./setup.py
            6 
            7         ./setup.py install
            8 
            9 ## Run
           10 
           11         zs -h
           12 
           13 ## Initial run
           14 
           15         zs cfg email $whererssshouldbesent
           16         zs cfg smtphost $smtphost
           17         zs cfg smtpport $smtpport
           18         zs cfg smtpuser $user
           19         zs cfg smtppassword $password
           20         zs cfg smtpssl True
           21 
           22 This does setup where the articles should be sent to. 
           23 
           24 ## Add some feed
           25 
           26         zs add $URI
           27 
           28 ## Remove some feed
           29 
           30         zs del $URI
           31 
           32 ## Tips for e-mail parsing
           33 
           34 Zeitungsschau  will  add following headers, which can be easily used for
           35 filtering to specific mailboxes:
           36 
           37         X-RSS-URL        (full URI of the article)
           38         X-RSS-Feed        (full URI of the feed)
           39         X-RSS-ID        (article ID)
           40         X-RSS-TAGS        (provided tags in the article or feed)
           41 
           42 ## Import your old feeds from OPML
           43 
           44         zs opmlimport file.opml
           45 
           46 ## Export your feeds to OPML
           47 
           48         zs opmlexport myfeeds.opml
           49 
           50 ## Repetitive run for cron
           51 
           52         zs run >/dev/null
           53 
           54 This  will  output  the stderr to cron and mail it to you.
           55 
           56 ## Exceptions // Bugs
           57 
           58 Zeitungsschau ist written in a conservative way to only handle  the  im‐
           59 portant  exceptions  which are needed. The complexity of  Python   makes
           60 it  impossible  to  know all cases beforehand. Please send in patches in
           61 case you find bugs.
           62 
           63 Please report bugs to 20h@r-36.net.
           64 
           65 Have fun!
           66