1 # Filename: ~/.rawdog/config
2 # Purpose: config file for rawdog
3 # Authors: grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
4 # Bug-Reports: see http://grml.org/bugs/
5 # License: This file is licensed under the GPL v2.
6 # Latest change: Don Dez 16 15:30:09 CET 2004 [mika]
7 ################################################################################
9 # All paths in this file should be either absolute, or relative to your .rawdog
11 # If you want to include another config file, then use "include FILENAME".
13 # Times in this file are specified as a value and a unit (for instance,
14 # "4h"). Units available are "s" (seconds), "m" (minutes), "h" (hours),
15 # "d" (days) and "w" (weeks). If no unit is specified, rawdog will
17 # Boolean (yes/no) values in this file are specified as "true" or "false".
19 # The maximum number of articles to show on the generated page.
20 # Set this to 0 for no limit.
23 # The maximum age of articles to show on the generated page.
24 # Set this to 0 for no limit.
27 # The age after which articles will be discarded if they do not appear
28 # in a feed. Set this to a larger value if you want your rawdog output
29 # to cover more than a day's worth of articles.
32 # Whether to only display articles that are currently included in a feed
33 # (useful for "planet" pages where you only want to display the current
34 # articles from several feeds). If this is false, rawdog will keep a
35 # history of older articles.
38 # Whether to divide the articles up by day, writing a "dayformat" heading
42 # The format to write day headings in. See "man strftime" for more
43 # information; for example:
44 # %A, %d %B Wednesday, 21 January
45 # %Y-%m-%d 2004-01-21 (ISO 8601 format)
48 # Whether to divide the articles up by time, writing a "timeformat" heading
52 # The format to write time headings in. For example:
53 # %H:%M 06:07 (ISO 8601 format)
57 # The format to display feed update and article times in. For example:
58 # %H:%M, %A, %d %B 18:07, Wednesday, 21 January
59 # %Y-%m-%d %H:%M 2004-01-21 18:07 (ISO 8601 format)
60 datetimeformat %H:%M, %A, %d %B
62 # The template file to use, or "default" to use the built-in template
63 # (which is probably sufficient for most users). Use "rawdog -t" to show
64 # the template currently in use as a starting-point for customisation.
65 # The following strings will be replaced in the output:
66 # __version__ The rawdog version in use
67 # __refresh__ The HTML 4 <meta http-equiv="refresh" ...> header
68 # __items__ The aggregated items
69 # __num_items__ The number of items on the page
70 # __feeds__ The listing of feeds
71 # __num_feeds__ The number of feeds listed
74 # Similarly, the template used for each item shown. Use "rawdog -T" to
75 # show the template currently in use as a starting-point for
76 # customisation. The following strings will be replaced in the output:
77 # __title__ The item title (as an HTML link, if possible)
78 # __title_no_link__ The item title (as text)
79 # __url__ The item's URL, or the empty string if it doesn't
81 # __description__ The item's descriptive text, or the empty string
82 # if it doesn't have a description
83 # __date__ The item's date as provided by the feed
84 # __added__ The date the article was received by rawdog
85 # __hash__ A hash of the article (useful for summary pages)
86 # __feed_title__ The feed title (as an HTML link, if possible)
87 # __feed_title_no_link__
88 # The feed title (as text)
89 # __feed_url__ The feed URL
90 # __feed_hash__ A hash of the feed URL (useful for per-feed styles)
91 # Simple conditional expansion is possible by saying something like
92 # "__if_items__ hello __endif__"; the text between the if and endif will
93 # only be included if __items__ would expand to something other than
94 # the empty string. Ifs can be nested, and __else__ is supported. (This also
95 # works for the "template" option, but it's only really useful for item
99 # Where to write the output HTML to. You should place style.css in the same
100 # directory. Specify this as "-" to write the HTML to stdout.
101 outputfile /home/mika/rawdog.html
103 # Whether to use a <meta http-equiv="Refresh" ...> tag in the generated
104 # HTML to indicate that the page should be refreshed automatically. If
105 # this is turned on, then the page will refresh every N minutes, where N
106 # is the shortest feed period value specified below.
107 # (This works by controlling whether the default template includes
108 # __refresh__; if you use a custom template, __refresh__ is always
112 # Whether to show the list of active feeds in the generated HTML.
113 # (This works by controlling whether the default template includes
114 # __feeds__; if you use a custom template, __feeds__ is always
118 # The time that rawdog will wait before considering a feed unreachable
119 # when trying to connect. If you're getting lots of timeout errors and
120 # are on a slow connection, increase this.
121 # (Unlike other times in this file, this will be assumed to be in
122 # seconds if no unit is specified.)
125 # Whether to ignore timeouts. If this is false, timeouts will be reported as
126 # errors; if this is true, rawdog will silently ignore them.
129 # Whether to display verbose status messages saying what rawdog's doing
130 # while it runs. Specifying -v or --verbose on the command line is
131 # equivalent to saying "verbose true" here.
134 # Whether to attempt to turn feed-provided HTML into valid HTML.
135 # The most common problem that this solves is a non-closed element in an
136 # article causing formatting problems for the rest of the page.
137 # If this option is turned on, you must have the mx.Tidy Python module
141 # Whether the articles displayed should be sorted first by the date
142 # provided in the feed (useful for "planet" pages, where you're
143 # displaying several feeds and want new articles to appear in the right
144 # chronological place). If this is false, then articles will first be
145 # sorted by the time that rawdog first saw them.
148 # The fields to use when detecting duplicate articles: "id" is the article's
149 # unique ID or GUID; "link" is the article's link. rawdog will find the first
150 # one of these that's present in the article, and ignore the article if it's
151 # seen an article before (in any feed) that had the same value. For example,
152 # specifying "hideduplicates id link" will first look for id/guid, then for
154 # Note that some feeds use the same link for all their articles; if you specify
155 # "link" here, you will probably want to specify the "allowduplicates" feed
156 # argument (see below) for those feeds.
159 # The period to use for new feeds added to the config file via the -a|--add
163 # Whether rawdog should automatically update this config file (and its
164 # internal state) if feed URLs change (for instance, if a feed URL
165 # results in a permanent HTTP redirect). If this is false, then rawdog
166 # will ask you to make the necessary change by hand.
169 # The feeds you want to watch, in the format "feed period url [args]".
170 # The period is the minimum time between updates; if less than period
171 # minutes have passed, "rawdog update" will skip that feed. Specifying
172 # a period less than 30 minutes is considered to be bad manners; it is
173 # suggested that you make the period as long as possible.
174 # Arguments are optional, and are of the form "key=value", seperated by spaces;
175 # possible arguments are:
176 # user User for HTTP basic authentication
177 # password Password for HTTP basic authentication
178 # format "text" to indicate that the descriptions in this feed
179 # are unescaped plain text (rather than the usual HTML),
180 # and should be escaped and wrapped in a <pre> element
181 # X_proxy Proxy URL for protocol X (for instance, "http_proxy")
182 # proxyuser User for proxy basic authentication
183 # proxypassword Password for proxy basic authentication
184 # allowduplicates "true" to disable duplicate detection for this feed
185 # You can specify as many feeds as you like.
186 #feed 1h http://www.advogato.org/rss/articles.xml
187 #feed 30m http://news.bbc.co.uk/rss/newsonline_uk_edition/front_page/rss091.xml
188 #feed 3h http://diveintomark.org/xml/rss.xml
189 #feed 3h http://secretfeed.example.com/secret.rss user=bob password=secret
190 #feed 3h http://brokenfeeds.com/my.rss format=text
191 #feed 3h http://proxyfeed.example.com/proxied.rss http_proxy=http://localhost:1234/
192 #feed 3h http://dupsfeed.example.com/duplicated.rss allowduplicates=true
193 feed 12h http://www.grml.org/index.rss