summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Andreas Krennmair <ak@synflood.at> 2008-03-05 15:22:01 +0000
committerGravatar Andreas Krennmair <ak@synflood.at> 2008-03-05 15:22:01 +0000
commit9639b61039f536ad0d4e71a7134a943ffc705db5 (patch)
tree7467f3607518aa37c6ea3d11639f3488a31a12a0
parentc985b6d92bb0476d18918f6ec129e1207ed29a36 (diff)
downloadnewsboat-9639b61039f536ad0d4e71a7134a943ffc705db5.tar.gz
newsboat-9639b61039f536ad0d4e71a7134a943ffc705db5.tar.zst
newsboat-9639b61039f536ad0d4e71a7134a943ffc705db5.zip
Andreas Krennmair:
newsbeuter 0.8 doc generation.
-rw-r--r--doc/newsbeuter.1398
-rw-r--r--doc/podbeuter.189
-rw-r--r--doc/xhtml/newsbeuter.html1397
3 files changed, 1884 insertions, 0 deletions
diff --git a/doc/newsbeuter.1 b/doc/newsbeuter.1
new file mode 100644
index 00000000..50339f56
--- /dev/null
+++ b/doc/newsbeuter.1
@@ -0,0 +1,398 @@
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "NEWSBEUTER" 1 "" "" ""
+.SH NAME
+newsbeuter \- an RSS feed reader for text terminals
+.SH "SYNOPSIS"
+
+
+\fInewsbeuter\fR [\-r] [\-e] [\-i opmlfile] [\-u urlfile] [\-c cachefile] [\-C configfile] [\-v] [\-o] [\-h]
+
+.SH "DESCRIPTION"
+
+
+\fInewsbeuter\fR is an RSS feed reader for text terminals\&. RSS is a number of widely\-used XML formats to transmit, publish and syndicate articles, for example news or blog articles\&. Newsbeuter is designed to be used on text terminals on Unix or Unix\-like systems such as Linux, BSD or Mac OS X\&.
+
+.SH "OPTIONS"
+
+.TP
+\-h
+Display help
+
+.TP
+\-r
+Refresh feeds on start
+
+.TP
+\-e
+Export feeds as OPML to stdout
+
+.TP
+\-v
+Clean up cache thoroughly (i\&.e\&. reduce it in size if possible)
+
+.TP
+\-V
+Get version information about newsbeuter and the libraries it uses
+
+.TP
+\-i opmlfile
+Import an OPML file
+
+.TP
+\-u urlfile
+Use an alternative URL file
+
+.TP
+\-c cachefile
+Use an alternative cache file
+
+.TP
+\-C configfile
+Use an alternative configuration file
+
+.TP
+\-o
+Active offline reading mode\&. When bloglines synchronization mode is configured, then the list of feeds will not be loaded from bloglines\&.com, but instead from the local cache\&. This makes it possible to read locally cached articles even without internet connection to connect to the bloglines server\&.
+
+.SH "FIRST STEPS"
+
+
+After you've installed newsbeuter, you can run it for the first time by typing "newsbeuter" on your command prompt\&. This will bring you the following message:
+
+.nf
+Error: no URLs configured\&. Please fill the file /Users/ak/\&.newsbeuter/urls with RSS feed URLs or import an OPML file\&.
+.fi
+
+.nf
+newsbeuter 0\&.8
+usage: \&./newsbeuter [\-i <file>|\-e] [\-u <urlfile>] [\-c <cachefile>] [\-h]
+ \-r refresh feeds on start
+ \-e export OPML feed to stdout
+ \-i <file> import OPML file
+ \-u <urlfile> read RSS feed URLs from <urlfile>
+ \-c <cachefile> use <cachefile> as cache file
+ \-C <configfile> read configuration from <configfile>
+ \-v clean up cache thoroughly
+ \-h this help
+.fi
+
+
+This means that newsbeuter can't start without any configured feeds\&. To add feeds to newsbeuter, you can either add URLs to the configuration file $HOME/\&.newsbeuter/urls or you can import an OPML file by running "newsbeuter \-i blogroll\&.opml"\&. To manually add URLs, open the file with your favorite text editor and add the URLs, one per line:
+
+.nf
+http://rss\&.cnn\&.com/rss/cnn_topstories\&.rss
+http://newsrss\&.bbc\&.co\&.uk/rss/newsonline_world_edition/front_page/rss\&.xml
+.fi
+
+
+If you need to add URLs that have restricted access via username/password, simply provide the username/password in the following way:
+
+.nf
+http://username:password@hostname\&.domain\&.tld/feed\&.rss
+.fi
+
+
+In order to protect username and password, make sure that $HOME/\&.newsbeuter/urls has the appropriate permissions\&.
+
+
+Now you can run newsbeuter again, and it will present you with a controllable list of the URLs that you configured previously\&. You can now start downloading the feeds, either by pressing "R" to download all feeds, or by pressing "r" to download the currently selected feed\&. You can then select a feed you want to read, and by pressing "Enter", you can go to the article list for this feed\&. This works even while the downloading is still in progress\&. You can now see the list of available articles by their title\&. A "N" on the left indicates that an article wasn't read yet\&. Pressing Enter brings you to the content of the article\&. You can scroll through this text, and also run a browser (default: lynx) to view the complete article if the content is empty or just an abstract or a short description\&. Pressing "q" brings you back to the article list, and pressing "q" again brings you back to the feed list\&. Pressing "q" a third time then closes newsbeuter\&.
+
+
+Newsbeuter caches the article that it downloads\&. This means that when you start newsbeuter again and reload a feed, the old articles can still be read even if they aren't in the current RSS feeds anymore\&. Optionally you can configure how many articles shall be preserved by feed so that the article backlog doesn't grow endlessly (see below)\&.
+
+
+Several aspects of newsbeuter's behaviour can be configured via a configuration file, by default $HOME/\&.newsbeuter/config\&. This configuration files contains lines in the form "<config\-command> <arg1> ..."\&. The configuration file can also contain comments, which start with the \fI#\fR character and go as far as the end of line\&. If you need to enter a configuration argument that contains spaces, use quotes (") around the whole argument\&.
+
+
+Searching for articles is possible in newsbeuter, too\&. Just press the "/" key, enter your search phrase, and the title and content of all articles are searched for it\&. When you do a search from the list of feeds, all articles of all feeds will be searched\&. When you do a search from the article list of a feed, only the articles of the currently viewed feed are searched\&.
+
+.SH "CONFIGURATION COMMANDS"
+
+.TP
+\fIalways\-display\-description\fR (parameters: [true/false]; default value: \fIfalse\fR)
+If true, then the description will always displayed even if e\&.g\&. a content:encoded tag has been found\&. (example: always\-display\-description true)
+
+.TP
+\fIarticlelist\-format\fR (parameters: <format>; default value: \fI"%4i %f %D %?T?;%\-17T; ?%t"\fR)
+This variable defines the format of entries in the article list\&. See below for more information on format strings (note that the semicolon should actually be a vertical bar; this is a limitation in AsciiDoc)\&. (example: articlelist\-format "%4i %f %D %?T?;%\-17T; ?%t")
+
+.TP
+\fIauto\-reload\fR (parameters: [yes/no]; default value: \fIno\fR)
+If enabled, all feeds will be automatically reloaded at start up and then continuously after a certain time has passed (see reload\-time)\&. (example: auto\-reload yes)
+
+.TP
+\fIbind\-key\fR (parameters: <key> <operation>; default value: \fIn/a\fR)
+Bind key <key> to <operation>\&. This means that whenever <key> is pressed, then <operation> is executed (if applicable in the current context)\&. A list of available operations can be found below\&. (example: bind\-key ^R reload\-all)
+
+.TP
+\fIbookmark\-cmd\fR (parameters: <command>; default value: \fI""\fR)
+If set, the configured command will be used as bookmark plugin\&. Please refer to the documentation for further information on bookmark plugins\&. (example: bookmark\-cmd "~/bin/my\-bookmark\-plugin\&.sh")
+
+.TP
+\fIbloglines\-auth\fR (parameters: <login>:<password>; default value: \fI""\fR)
+Set the Bloglines username and password\&. This is necessary for the Bloglines synchronization mode\&. (example: bloglines\-auth "username@emailaddress\&.com:mypassword")
+
+.TP
+\fIbloglines\-mark\-read\fR (parameters: [yes/no]; default value: \fIno\fR)
+If set to yes, it will mark all articles that are downloaded from Bloglines as read\&. (example: bloglines\-mark\-read yes)
+
+.TP
+\fIbookmark\-cmd\fR (parameters: <bookmark\-command>; default value: \fI""\fR)
+If set, then <bookmark\-command> will be used as bookmarking plugin\&. See the documentation on bookmarking for further information\&. (example: bookmark\-cmd "~/bin/delicious\-bookmark\&.sh")
+
+.TP
+\fIbrowser\fR (parameters: <browser\-command>; default value: \fIlynx\fR)
+Set the browser command to use when opening an article in the browser\&. (example: browser w3m)
+
+.TP
+\fIcache\-file\fR (parameters: <path>; default value: \fI"~/\&.newsbeuter/cache\&.db"\fR)
+This configuration option sets the cache file\&. This is especially useful if the filesystem of your home directory doesn't support proper locking (e\&.g\&. NFS)\&. (example: cache\-file "/tmp/testcache\&.db")
+
+.TP
+\fIcleanup\-on\-quit\fR (parameters: [yes/no]; default value: \fIyes\fR)
+If yes, then the cache gets locked and superfluous feeds and items are removed, such as feeds that can't be found in the urls configuration file anymore\&. (example: cleanup\-on\-quit no)
+
+.TP
+\fIcolor\fR (parameters: <element> <fgcolor> <bgcolor> [<attr> ...]; default value: \fIn/a\fR)
+Set the foreground color, background color and optional attributes for a certain element (example: color background white black)
+
+.TP
+\fIconfirm\-exit\fR (parameters: [yes/no]; default value: \fIno\fR)
+If set to yes, then newsbeuter will ask for confirmation whether the user really wants to quit newsbeuter\&. (example: confirm\-exit yes)
+
+.TP
+\fIdatetime\-format\fR (parameters: <date/time format>; default value: \fI%b %d\fR)
+This format specifies the date/time format in the article list\&. For a detailed documentation on the allowed formats, consult the manpage of strftime(3)\&. (example: datetime\-format "%D, %R")
+
+.TP
+\fIdefine\-filter\fR (parameters: <name> <filter>; default value: \fIn/a\fR)
+With this command, you can predefine filters, which can you later select from a list, and which are then applied after selection\&. This is especially useful for filters that you need often and you don't want to enter them every time you need them\&. (example: define\-filter "all feeds with \fIfun\fR tag" "tags # \\\\"fun\\\\"")
+
+.TP
+\fIerror\-log\fR (parameters: <path>; default value: \fI""\fR)
+If set, then user errors (e\&.g\&. errors regarding defunct RSS feeds) will be logged to this file\&. (example: error\-log "~/\&.newsbeuter/error\&.log")
+
+.TP
+\fIfeedlist\-format\fR (parameters: <format>; default value: \fI"%4i %n %11u %t"\fR)
+This variable defines the format of entries in the feed list\&. See below for more information on format strings\&. (example: feedlist\-format " %n %4i \- %11u \-%> %t")
+
+.TP
+\fIhtml\-renderer\fR (parameters: <path>; default value: \fIinternal\fR)
+If set to "internal", then the internal HTML renderer will be used\&. Otherwise, the specified command will be executed, the HTML to be rendered will be written to the command's stdin, and the program's output will be displayed\&. This makes it possible to use other, external programs, such as w3m, links or lynx, to render HTML\&. (example: html\-renderer "w3m \-dump \-T text/html")
+
+.TP
+\fIignore\-article\fR (parameters: <feed> <filterexpr>; default value: \fIn/a\fR)
+If a downloaded article from <feed> matches <filterexpr>, then it is ignored and not presented to the user\&. This command is further explained in the "kill file" section below\&. (example: ignore\-article "*" "title =~ \\\\"Windows\\\\"")
+
+.TP
+\fIinclude\fR (parameters: <path>; default value: \fIn/a\fR)
+With this command, you can include other files to be interpreted as configuration files\&. This is especially useful to separate your configuration into several files, e\&.g\&. key configuration, color configuration, ... (example: include "~/\&.newsbeuter/colors")
+
+.TP
+\fImacro\fR (parameters: <macro key> <command list>; default value: \fIn/a\fR)
+With this command, you can define a macro key and specify a list of commands that shall be executed when the macro prefix and the macro key are pressed\&. (example: macro k open ; reload ; quit)
+
+.TP
+\fImax\-items\fR (parameters: <number>; default value: \fI0\fR)
+Set the number of articles to maximally keep per feed\&. If the number is set to 0, then all articles are kept\&. (example: max\-items 100)
+
+.TP
+\fInotify\-program\fR (parameters: <path>; default value: \fI""\fR)
+If set, then the configured program will be executed if new articles arrived (through a reload)\&. The first parameter of the called program contains the notification message\&. (example: notify\-program "~/bin/my\-notifier")
+
+.TP
+\fInotify\-screen\fR (parameters: [yes/no]; default value: \fIno\fR)
+If yes, then a "privacy message" will be sent to the terminal, containing a notification message about new articles\&. This is especially useful if you use terminal emulations such as GNU screen which implement privacy messages\&. (example: notify\-screen yes)
+
+.TP
+\fInotify\-xterm\fR (parameters: [yes/no]; default value: \fIno\fR)
+If yes, then the xterm window title will be set to a notification message about new articles\&. (example: notify\-xterm yes)
+
+.TP
+\fIpodcast\-auto\-enqueue\fR (parameters: [yes/no]; default value: \fIno\fR)
+If yes, then all podcast URLs that are found in articles are added to the podcast download queue\&. See below for more information on podcast support in newsbeuter\&. (example: podcast\-auto\-enqueue yes)
+
+.TP
+\fIopml\-url\fR (parameters: <url>; default value: \fI""\fR)
+If the OPML online subscription mode is enabled, then the list of feeds will be taken from the OPML file found on this location\&. (example: opml\-url "http://host\&.domain\&.tld/blogroll\&.opml")
+
+.TP
+\fIproxy\fR (parameters: <server:port>; default value: \fIn/a\fR)
+Set the proxy to use for downloading RSS feeds\&. (example: proxy localhost:3128)
+
+.TP
+\fIproxy\-auth\fR (parameters: <auth>; default value: \fIn/a\fR)
+Set the proxy authentication string\&. (example: proxy\-auth user:password)
+
+.TP
+\fIrefresh\-on\-startup\fR (parameters: [yes/no]; default value: \fIno\fR)
+If yes, then all feeds will be reloaded when newsbeuter starts up\&. This is equivalent to the \-r commandline option\&. (example: refresh\-on\-startup yes)
+
+.TP
+\fIreload\-time\fR (parameters: <number>; default value: \fI60\fR)
+The number of minutes between automatic reloads\&. (example: reload\-time 120)
+
+.TP
+\fIsave\-path\fR (parameters: <path>; default value: \fI~/\fR)
+The default path where articles shall be saved to\&. If an invalid path is specified, the current directory is used\&. (example: save\-path "~/Saved Articles")
+
+.TP
+\fIshow\-read\-feeds\fR (parameters: [yes/no]; default value: \fIyes\fR)
+If yes, then all feeds, including those without unread articles, are listed\&. If no, then only feeds with one or more unread articles are list\&. (example: show\-read\-feeds no)
+
+.TP
+\fItext\-width\fR (parameters: <number>; default value: \fI0\fR)
+If set to a number greater than 0, then all HTML will be rendered to this maximum line length\&. If set to 0, the terminal width will be used\&. (example: text\-width 72)
+
+.TP
+\fIsuppress\-first\-reload\fR (parameters: [yes/no]; default value: \fIno\fR)
+If yes, then the first automatic reload will be suppressed if auto\-reload is set to yes\&. (example: suppress\-first\-reload yes)
+
+.TP
+\fIunbind\-key\fR (parameters: <key>; default value: \fIn/a\fR)
+Unbind key <key>\&. This means that no operation is called when <key> is pressed\&. (example: unbind\-key R)
+
+.TP
+\fIurls\-source\fR (parameters: <source>; default value: \fI"local"\fR)
+This configuration command sets the source where URLs shall be retrieved from\&. By default, this is ~/\&.newsbeuter/urls\&. Alternatively, you can set it to "bloglines", which enables newsbeuter's Bloglines synchronization mode, or to "opml", which enables newsbeuter's OPML online subscription mode\&. (example: urls\-source "bloglines")
+
+.TP
+\fIuse\-proxy\fR (parameters: [yes/no]; default value: \fIno\fR)
+If yes, then the configured proxy will be used for downloading the RSS feeds\&. (example: use\-proxy yes)
+
+.TP
+\fIuser\-agent\fR (parameters: <user agent string>; default value: \fI""\fR)
+If set to a non\-zero\-length string, this value will be used as HTTP User\-Agent header for all HTTP requests\&. (example: user\-agent "Lynx/2\&.8\&.5rel\&.1 libwww\-FM/2\&.14")
+
+.SH "TAGGING"
+
+
+Newsbeuter comes with the possibility to categorize or "tag", as well call it, RSS feeds\&. Every RSS feed can be assigned 0 or more tags\&. Within newsbeuter, you can then select to only show RSS feeds that match a certain tag\&. That makes it easy to categorize your feeds in a flexible and powerful way\&.
+
+
+Usually, the /\&.newsbeuter/urls file contains one RSS feed URL per line\&. To assign a tag to an RSS feed, simply attach it as a single word, separated by blanks such as space or tab\&. If the tag needs to contain spaces, you must use quotes (") around the tag (see example below)\&. An example /\&.newsbeuter/urls file may look like this:
+
+.nf
+http://blog\&.fefe\&.de/rss\&.xml?html interesting conspiracy news "cool stuff"
+http://rss\&.orf\&.at/news\&.xml news orf
+http://www\&.heise\&.de/newsticker/heise\&.rdf news interesting
+.fi
+
+
+When you now start newsbeuter with this configuration, you can press "t" to select a tag\&. When you select the tag "news", you will see all three RSS feeds\&. Pressing "t" again and e\&.g\&. selecting the "conspiracy" tag, you will only see the http://blog\&.fefe\&.de/rss\&.xml?html RSS feed\&. Pressing "^T" clears the current tag, and again shows all RSS feeds, regardless of their assigned tags\&.
+
+
+A special type of tag are tags that start with the tilde character ("")\&. When such a tag is found, the feed title is set to the tag name (excluding the character)\&. With this feature, you can give feeds any title you want in your feed list:
+
+.nf
+http://rss\&.orf\&.at/news\&.xml "~ORF News"
+.fi
+
+.SH "SCRIPTS AND FILTERS"
+
+
+From version 0\&.4 on, newsbeuter contains support for Snownews extensions\&. The RSS feed readers Snownews and Liferea share a common way of extending the readers with custom scripts\&. Two mechanisms, namely "execurl" and "filter" type scripts, are available and supported by newsbeuter\&.
+
+
+An "execurl" script can be any program that gets executed and whose output is interpreted as RSS feed, while "filter" scripts are fed with the content of a configured URL and whose output is interpreted as RSS feed\&.
+
+
+The configuration is simple and straight\-forward\&. Just add to your ~/\&.newsbeuter/urls file configuration lines like the following ones:
+
+.nf
+exec:~/bin/execurl\-script
+filter:~/bin/filter\-script:http://some\&.test/url
+.fi
+
+
+The first line shows how to add an execurl script to your configuration: start the line with "exec:" and then immediately append the path of the script that shall be executed\&. If this script requires additional parameters, simply use quotes:
+
+.nf
+"exec:~/bin/execurl\-script param1 param2"
+.fi
+
+
+The second line shows how to add a filter script to your configuration: start the line with "filter:", then immediately append the path of the script, then append a colon (":"), and then append the URL of the file that shall be fed to the script\&. Again, if the script requires any parameters, simply quote:
+
+.nf
+"filter:~/bin/filter\-script param1 param2:http://url/foobar"
+.fi
+
+
+In both cases, the tagging feature as described above is still available:
+
+.nf
+exec:~/bin/execurl\-script tag1 tag2 "quoted tag"
+filter:~/bin/filter\-script:http://some\&.test/url tag3 tag4 tag5
+.fi
+
+
+A collection of such extension scripts can be found on this website: http://kiza\&.kcore\&.de/software/snownews/snowscripts/extensions
+
+
+If you want to write your own extensions, refer to this website for further instructions: http://kiza\&.kcore\&.de/software/snownews/snowscripts/writing
+
+.SH "COMMAND LINE"
+
+
+Like other text\-oriented software, newsbeuter contains an internal commandline to modify configuration variables ad hoc and to run own commands\&. It provides a flexible access to the functionality of newsbeuter which is especially useful for advanced users\&.
+
+
+To start the commandline, type ":"\&. You will see a ":" prompt at the bottom of the screen, similar to tools like vi(m) or mutt\&. You can now enter commands\&. Pressing the return key executes the command (possibly giving feedback to the user) and closes the commandline\&. You can cancel entering commands by pressing the ESC key\&. Currently, the following commands are available:
+
+.TP
+\fIquit\fR
+Quit newsbeuter
+
+.TP
+\fIsave\fR <filename>
+Save current article to <filename>
+
+.TP
+\fIset\fR <variable>[=<value>]
+Set (or get) configuration variable value
+
+.TP
+\fItag\fR <tagname>
+Select a certain tag
+
+.TP
+\fI<number>\fR
+Jump to the <number>th entry in the current dialog
+
+.SH "FILES"
+
+
+\fI$HOME/\&.newsbeuter/config\fR
+
+
+\fI$HOME/\&.newsbeuter/urls\fR
+
+.SH "SEE ALSO"
+
+
+podbeuter(1)\&. The documentation that comes with newsbeuter is a good source about the general use and configuration of newsbeuter\&.
+
+.SH "AUTHORS"
+
+
+Andreas Krennmair <ak@synflood\&.at>, for contributors see AUTHORS file\&.
+
diff --git a/doc/podbeuter.1 b/doc/podbeuter.1
new file mode 100644
index 00000000..4e4305b0
--- /dev/null
+++ b/doc/podbeuter.1
@@ -0,0 +1,89 @@
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "PODBEUTER" 1 "" "" ""
+.SH NAME
+podbeuter \- a podcast download manage for text terminals
+.SH "SYNOPSIS"
+
+
+\fIpodbeuter\fR [\-C configfile] [\-q queuefile] [\-h|
+
+.SH "DESCRIPTION"
+
+
+\fIpodbeuter\fR is a podcast manager for text terminals\&. It is a helper program to \fInewsbeuter\fR which queues podcast downloads into a file\&. These queued downloads can then be download with \fInewsbeuter\fR\&.
+
+.SH "OPTIONS"
+
+.TP
+\-h
+Display help
+
+.TP
+\-C configfile
+Use an alternative configuration file
+
+.TP
+\-q queuefile
+Use an alternative queue file
+
+.SH "PODCAST SUPPORT"
+
+
+A podcast is a media file distributed over the internet using syndication feeds such as RSS, for later playback on portable players or computers\&. Newsbeuter contains support for downloading and saving podcasts\&. This support differs a bit from other podcast aggregators or "podcatchers" in how it is done\&.
+
+
+Podcast content is transported in RSS feeds via special tags called "enclosures"\&. Newsbeuter recognizes these enclosures and stores the relevant information for every podcast item it finds in an RSS feed\&. What the user then can do is to add the podcast download URL to a download queue\&. Alternatively, newsbeuter can be configured to automatically do that\&. This queue is stored in the file $HOME/\&.newsbeuter/queue\&.
+
+
+The user can then use the download manager "podbeuter" to download these files to a directory on the local filesystem\&. Podbeuter comes with the newsbeuter package, and features a look and feel very close to the one of newsbeuter\&. It also shares the same configuration file\&.
+
+.SH "CONFIGURATION COMMANDS"
+
+.TP
+\fIdownload\-path\fR (parameters: <path>; default value: \fI~/\fR)
+Specifies the directory where podbeuter shall download the files to\&. (example: download\-path "~/Downloads")
+
+.TP
+\fImax\-downloads\fR (parameters: <number>; default value: \fI1\fR)
+Specifies the maximum number of parallel downloads when automatic download is enabled\&. (example: max\-downloads 3)
+
+.TP
+\fIplayer\fR (parameters: <player command>; default value: \fI""\fR)
+Specifies the player that shall be used for playback of downloaded files\&. (example: player "mp3blaster")
+
+.SH "FILES"
+
+
+\fI$HOME/\&.newsbeuter/config\fR
+
+
+\fI$HOME/\&.newsbeuter/queue\fR
+
+.SH "SEE ALSO"
+
+
+newsbeuter(1)\&. The documentation that comes with newsbeuter is a good source about the general use and configuration of newsbeuter's podcast support\&.
+
+.SH "AUTHORS"
+
+
+Andreas Krennmair <ak@synflood\&.at>, for contributors see AUTHORS file\&.
+
diff --git a/doc/xhtml/newsbeuter.html b/doc/xhtml/newsbeuter.html
new file mode 100644
index 00000000..dc1d5991
--- /dev/null
+++ b/doc/xhtml/newsbeuter.html
@@ -0,0 +1,1397 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The Newsbeuter RSS Feedreader</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /></head><body><div class="article" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id2409058"></a>The Newsbeuter RSS Feedreader</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Andreas</span> <span class="surname">Krennmair</span></h3><div class="affiliation"><div class="address"><p><code class="email">&lt;<a href="mailto:ak@synflood.at">ak@synflood.at</a>&gt;</code></p></div></div></div></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2494811">Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#id2494825">Why "Newsbeuter"?</a></span></dt></dl></dd><dt><span class="section"><a href="#id2494849">Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#id2494859">Downloading Newsbeuter</a></span></dt><dt><span class="section"><a href="#id2494878">Dependencies</a></span></dt><dt><span class="section"><a href="#id2456303">Compiling and Installing</a></span></dt></dl></dd><dt><span class="section"><a href="#id2456328">First Steps</a></span></dt><dd><dl><dt><span class="section"><a href="#id2505590">Example Configuration</a></span></dt><dt><span class="section"><a href="#id2505616">Configuring Colors</a></span></dt><dt><span class="section"><a href="#id2505874">Migrating from other RSS Feed Readers</a></span></dt></dl></dd><dt><span class="section"><a href="#id2506021">Advanced Features</a></span></dt><dd><dl><dt><span class="section"><a href="#id2506027">Tagging</a></span></dt><dt><span class="section"><a href="#id2506107">Scripts and Filters (Snownews Extensions)</a></span></dt><dt><span class="section"><a href="#id2506227">Bookmarking</a></span></dt><dt><span class="section"><a href="#id2506264">Command Line</a></span></dt><dt><span class="section"><a href="#id2506478">Filter Language</a></span></dt><dt><span class="section"><a href="#id2507084">Killfiles</a></span></dt><dt><span class="section"><a href="#id2507145">Query Feeds</a></span></dt><dt><span class="section"><a href="#id2507257">Bloglines Synchronization</a></span></dt><dt><span class="section"><a href="#id2507384">OPML Online Subscription Mode</a></span></dt><dt><span class="section"><a href="#id2507429">Flagging Articles</a></span></dt><dt><span class="section"><a href="#id2507487">Macro Support</a></span></dt><dt><span class="section"><a href="#id2507528">Ruby Support</a></span></dt><dt><span class="section"><a href="#id2507594">Format Strings</a></span></dt><dt><span class="section"><a href="#id2507923">Podcast Support</a></span></dt><dt><span class="section"><a href="#id2508339">Using SQLite Triggers with newsbeuter</a></span></dt></dl></dd><dt><span class="section"><a href="#id2508493">Feedback</a></span></dt><dt><span class="section"><a href="#id2508526">License</a></span></dt></dl></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2494811"></a>Introduction</h2></div></div></div><p>Newsbeuter is an RSS feedreader. RSS is a number of widely-used XML formats to
+transmit, publish and syndicate articles, for example news or blog articles.
+Newsbeuter is designed to be used on text terminals on Unix or Unix-like
+systems such as Linux, BSD or Mac OS X.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2494825"></a>Why "Newsbeuter"?</h3></div></div></div><p>"Newsbeuter" is a pun on the German word "Wildbeuter", which means
+"hunter-gatherer". During the stone age, people hunted and gathered their food,
+and these days, they hunt and gather news and information. Credits for this
+idea goes to Clifford Wolf, who submitted it to a little competiton that was
+started when I got aware that the original name would violate French and
+European registered trademarks.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2494849"></a>Installation</h2></div></div></div><p>This chapter describes how to compile and install newsbeuter from source.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2494859"></a>Downloading Newsbeuter</h3></div></div></div><p>Newsbeuter is available as source package. Simply go to
+<a href="http://synflood.at/newsbeuter.html" target="_top">http://synflood.at/newsbeuter.html</a> and download the latest source package,
+which is usually in the .tar.gz file format. Alternatively, you can check out
+the latest development source tree from the newsbeuter SVN repository by
+running the following command on the commandline:</p><p>svn co http://bereshit.synflood.at/svn/noos/trunk</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2494878"></a>Dependencies</h3></div></div></div><p>Newsbeuter depends on a number of libraries to function correctly. This table
+lists these dependencies. Please be aware that the list libraries may
+themselves depend on other libraries. These dependencies are not listed here.
+Please also be aware that you need a recent C++ compiler. Currently, newsbeuter
+has only been tested with GCC.</p><div class="itemizedlist"><ul type="disc"><li>
+STFL (version 0.18 or newer): <a href="http://www.clifford.at/stfl/" target="_top">http://www.clifford.at/stfl/</a>
+</li><li>
+SQLite 3 (version 3.4 or newer): <a href="http://www.sqlite.org/" target="_top">http://www.sqlite.org/</a>
+</li><li>
+libcurl: <a href="http://curlm.haxx.se/download.html" target="_top">http://curlm.haxx.se/download.html</a>
+</li><li>
+GNU gettext (on systems that don't provide gettext in the libc): <a href="ftp://ftp.gnu.org/gnu/gettext/" target="_top">ftp://ftp.gnu.org/gnu/gettext/</a>
+</li><li>
+pkg-config: <a href="http://pkg-config.freedesktop.org/wiki/" target="_top">http://pkg-config.freedesktop.org/wiki/</a>
+</li><li>
+Ruby 1.8 (optional): <a href="http://www.ruby-lang.org/" target="_top">http://www.ruby-lang.org/</a>
+</li><li>
+Swig (optional; required for Ruby support): <a href="http://www.swig.org/" target="_top">http://www.swig.org/</a>
+</li></ul></div><p>If you intend to modify the filter language parser, you will also need Coco/R for C++,
+which you can download from <a href="http://www.ssw.uni-linz.ac.at/coco/" target="_top">http://www.ssw.uni-linz.ac.at/coco/</a>. The Coco/R binary
+must be installed as "coco-cpp" in your PATH. Debian users only need to install
+the package "coco-cpp".</p><p>If you have Ruby 1.8 development libraries installed, the newsbeuter build
+system will attempt to find the appropriate parameters to compile and link
+newsbeuter with Ruby support.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2456303"></a>Compiling and Installing</h3></div></div></div><p>After you've downloaded and installed the dependencies mentioned above, you can
+start compiling and installing newsbeuter. To compile newsbeuter, simply run
+"make" in the source tree. After a short time, this should complete
+successfully, and you can go on with installation by running "make install". By
+default, this will install the "newsbeuter" binary to the /usr/local/bin
+directory. You can provide an alternative installation path using the prefix
+parameter, e.g. running "make install prefix=/opt/newsbeuter" will install the
+binary to the directory /opt/newsbeuter/bin.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2456328"></a>First Steps</h2></div></div></div><p>After you've installed newsbeuter, you can run it for the first time by typing
+"newsbeuter" on your command prompt. This will bring you the following message:</p><pre class="literallayout">Error: no URLs configured. Please fill the file /Users/ak/.newsbeuter/urls with RSS feed URLs or import an OPML file.</pre><pre class="literallayout">newsbeuter 0.8
+usage: ./newsbeuter [-i &lt;file&gt;|-e] [-u &lt;urlfile&gt;] [-c &lt;cachefile&gt;] [-h]
+ -r refresh feeds on start
+ -e export OPML feed to stdout
+ -i &lt;file&gt; import OPML file
+ -u &lt;urlfile&gt; read RSS feed URLs from &lt;urlfile&gt;
+ -c &lt;cachefile&gt; use &lt;cachefile&gt; as cache file
+ -C &lt;configfile&gt; read configuration from &lt;configfile&gt;
+ -v clean up cache thoroughly
+ -h this help</pre><p>This means that newsbeuter can't start without any configured feeds. To add
+feeds to newsbeuter, you can either add URLs to the configuration file
+$HOME/.newsbeuter/urls or you can import an OPML file by running "newsbeuter -i
+blogroll.opml". To manually add URLs, open the file with your favorite text
+editor and add the URLs, one per line:</p><pre class="literallayout">http://rss.cnn.com/rss/cnn_topstories.rss
+http://newsrss.bbc.co.uk/rss/newsonline_world_edition/front_page/rss.xml</pre><p>If you need to add URLs that have restricted access via username/password, simply
+provide the username/password in the following way:</p><pre class="literallayout">http://username:password@hostname.domain.tld/feed.rss</pre><p>In order to protect username and password, make sure that
+$HOME/.newsbeuter/urls has the appropriate permissions.</p><p>Now you can run newsbeuter again, and it will present you with a controllable
+list of the URLs that you configured previously. You can now start downloading
+the feeds, either by pressing "R" to download all feeds, or by pressing "r" to
+download the currently selected feed. You can then select a feed you want to
+read, and by pressing "Enter", you can go to the article list for this feed.
+This works even while the downloading is still in progress. You can now see
+the list of available articles by their title. A "N" on the left indicates that
+an article wasn't read yet. Pressing Enter brings you to the content of the
+article. You can scroll through this text, and also run a browser (default:
+lynx) to view the complete article if the content is empty or just an abstract
+or a short description. Pressing "q" brings you back to the article list, and
+pressing "q" again brings you back to the feed list. Pressing "q" a third time
+then closes newsbeuter.</p><p>Newsbeuter caches the article that it downloads. This means that when you start
+newsbeuter again and reload a feed, the old articles can still be read even if
+they aren't in the current RSS feeds anymore. Optionally you can configure how
+many articles shall be preserved by feed so that the article backlog doesn't
+grow endlessly (see below).</p><p>Several aspects of newsbeuter's behaviour can be configured via a configuration
+file, by default $HOME/.newsbeuter/config. This configuration files contains
+lines in the form "&lt;config-command&gt; &lt;arg1&gt; …". The configuration file can
+also contain comments, which start with the <span class="emphasis"><em>#</em></span> character and go as far as the
+end of line. If you need to enter a configuration argument that contains
+spaces, use quotes (") around the whole argument.</p><p>Searching for articles is possible in newsbeuter, too. Just press the "/" key,
+enter your search phrase, and the title and content of all articles are
+searched for it. When you do a search from the list of feeds, all articles of
+all feeds will be searched. When you do a search from the article list of a
+feed, only the articles of the currently viewed feed are searched.</p><div class="table"><a id="id2456695"></a><p class="title"><b>Table 1. Configuration Commands</b></p><table summary="Configuration Commands" cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Configuration Command
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Argument(s)
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Default
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Description
+ </th><th style="border-bottom: 1px solid ; " align="left">
+ Example
+ </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ always-display-description
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [true/false]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ false
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If true, then the description will always displayed even if e.g. a content:encoded tag has been found.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ always-display-description true
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ articlelist-format
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;format&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ "%4i %f %D %?T?;%-17T; ?%t"
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ This variable defines the format of entries in the article list. See below for more information on format strings (note that the semicolon should actually be a vertical bar; this is a limitation in AsciiDoc).
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ articlelist-format "%4i %f %D %?T?;%-17T; ?%t"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ auto-reload
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ no
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If enabled, all feeds will be automatically reloaded at start up and then continuously after a certain time has passed (see reload-time).
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ auto-reload yes
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ bind-key
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;key&gt; &lt;operation&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Bind key &lt;key&gt; to &lt;operation&gt;. This means that whenever &lt;key&gt; is pressed, then &lt;operation&gt; is executed (if applicable in the current context). A list of available operations can be found below.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ bind-key ^R reload-all
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ bookmark-cmd
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;command&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ""
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If set, the configured command will be used as bookmark plugin. Please refer to the documentation for further information on bookmark plugins.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ bookmark-cmd "~/bin/my-bookmark-plugin.sh"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ bloglines-auth
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;login&gt;:&lt;password&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ""
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Set the Bloglines username and password. This is necessary for the Bloglines synchronization mode.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ bloglines-auth "username@emailaddress.com:mypassword"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ bloglines-mark-read
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ no
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If set to yes, it will mark all articles that are downloaded from Bloglines as read.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ bloglines-mark-read yes
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ bookmark-cmd
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;bookmark-command&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ""
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If set, then &lt;bookmark-command&gt; will be used as bookmarking plugin. See the documentation on bookmarking for further information.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ bookmark-cmd "~/bin/delicious-bookmark.sh"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ browser
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;browser-command&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ lynx
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Set the browser command to use when opening an article in the browser.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ browser w3m
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ cache-file
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;path&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ "~/.newsbeuter/cache.db"
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ This configuration option sets the cache file. This is especially useful if the filesystem of your home directory doesn't support proper locking (e.g. NFS).
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ cache-file "/tmp/testcache.db"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ cleanup-on-quit
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ yes
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If yes, then the cache gets locked and superfluous feeds and items are removed, such as feeds that can't be found in the urls configuration file anymore.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ cleanup-on-quit no
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ color
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;element&gt; &lt;fgcolor&gt; &lt;bgcolor&gt; [&lt;attr&gt; …]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Set the foreground color, background color and optional attributes for a certain element
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ color background white black
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ confirm-exit
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ no
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If set to yes, then newsbeuter will ask for confirmation whether the user really wants to quit newsbeuter.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ confirm-exit yes
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ datetime-format
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;date/time format&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ %b %d
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ This format specifies the date/time format in the article list. For a detailed documentation on the allowed formats, consult the manpage of strftime(3).
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ datetime-format "%D, %R"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ define-filter
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;name&gt; &lt;filter&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ With this command, you can predefine filters, which can you later select from a list, and which are then applied after selection. This is especially useful for filters that you need often and you don't want to enter them every time you need them.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ define-filter "all feeds with <span class="emphasis"><em>fun</em></span> tag" "tags # \"fun\""
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ error-log
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;path&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ""
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If set, then user errors (e.g. errors regarding defunct RSS feeds) will be logged to this file.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ error-log "~/.newsbeuter/error.log"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feedlist-format
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;format&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ "%4i %n %11u %t"
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ This variable defines the format of entries in the feed list. See below for more information on format strings.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ feedlist-format " %n %4i - %11u -%&gt; %t"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ html-renderer
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;path&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ internal
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If set to "internal", then the internal HTML renderer will be used. Otherwise, the specified command will be executed, the HTML to be rendered will be written to the command's stdin, and the program's output will be displayed. This makes it possible to use other, external programs, such as w3m, links or lynx, to render HTML.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ html-renderer "w3m -dump -T text/html"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ignore-article
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;feed&gt; &lt;filterexpr&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If a downloaded article from &lt;feed&gt; matches &lt;filterexpr&gt;, then it is ignored and not presented to the user. This command is further explained in the "kill file" section below.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ ignore-article "*" "title =~ \"Windows\""
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ include
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;path&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ With this command, you can include other files to be interpreted as configuration files. This is especially useful to separate your configuration into several files, e.g. key configuration, color configuration, …
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ include "~/.newsbeuter/colors"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ macro
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;macro key&gt; &lt;command list&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ With this command, you can define a macro key and specify a list of commands that shall be executed when the macro prefix and the macro key are pressed.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ macro k open ; reload ; quit
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ max-items
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;number&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ 0
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Set the number of articles to maximally keep per feed. If the number is set to 0, then all articles are kept.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ max-items 100
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ notify-program
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;path&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ""
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If set, then the configured program will be executed if new articles arrived (through a reload). The first parameter of the called program contains the notification message.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ notify-program "~/bin/my-notifier"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ notify-screen
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ no
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If yes, then a "privacy message" will be sent to the terminal, containing a notification message about new articles. This is especially useful if you use terminal emulations such as GNU screen which implement privacy messages.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ notify-screen yes
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ notify-xterm
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ no
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If yes, then the xterm window title will be set to a notification message about new articles.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ notify-xterm yes
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ podcast-auto-enqueue
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ no
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If yes, then all podcast URLs that are found in articles are added to the podcast download queue. See below for more information on podcast support in newsbeuter.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ podcast-auto-enqueue yes
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ opml-url
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;url&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ""
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If the OPML online subscription mode is enabled, then the list of feeds will be taken from the OPML file found on this location.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ opml-url "http://host.domain.tld/blogroll.opml"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ proxy
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;server:port&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Set the proxy to use for downloading RSS feeds.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ proxy localhost:3128
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ proxy-auth
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;auth&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Set the proxy authentication string.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ proxy-auth user:password
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ refresh-on-startup
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ no
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If yes, then all feeds will be reloaded when newsbeuter starts up. This is equivalent to the -r commandline option.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ refresh-on-startup yes
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ reload-time
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;number&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ 60
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ The number of minutes between automatic reloads.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ reload-time 120
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ save-path
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;path&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ~/
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ The default path where articles shall be saved to. If an invalid path is specified, the current directory is used.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ save-path "~/Saved Articles"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ show-read-feeds
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ yes
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If yes, then all feeds, including those without unread articles, are listed. If no, then only feeds with one or more unread articles are list.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ show-read-feeds no
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ text-width
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;number&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ 0
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If set to a number greater than 0, then all HTML will be rendered to this maximum line length. If set to 0, the terminal width will be used.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ text-width 72
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ suppress-first-reload
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ no
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If yes, then the first automatic reload will be suppressed if auto-reload is set to yes.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ suppress-first-reload yes
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ unbind-key
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;key&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Unbind key &lt;key&gt;. This means that no operation is called when &lt;key&gt; is pressed.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ unbind-key R
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ urls-source
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;source&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ "local"
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ This configuration command sets the source where URLs shall be retrieved from. By default, this is ~/.newsbeuter/urls. Alternatively, you can set it to "bloglines", which enables newsbeuter's Bloglines synchronization mode, or to "opml", which enables newsbeuter's OPML online subscription mode.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ urls-source "bloglines"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ use-proxy
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ [yes/no]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ no
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ If yes, then the configured proxy will be used for downloading the RSS feeds.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ use-proxy yes
+ </td></tr><tr><td style="border-right: 1px solid ; " align="left">
+ user-agent
+ </td><td style="border-right: 1px solid ; " align="left">
+ &lt;user agent string&gt;
+ </td><td style="border-right: 1px solid ; " align="left">
+ ""
+ </td><td style="border-right: 1px solid ; " align="left">
+ If set to a non-zero-length string, this value will be used as HTTP User-Agent header for all HTTP requests.
+ </td><td style="" align="left">
+ user-agent "Lynx/2.8.5rel.1 libwww-FM/2.14"
+ </td></tr></tbody></table></div><div class="table"><a id="id2455930"></a><p class="title"><b>Table 2. Available Operations</b></p><table summary="Available Operations" cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Operation:Default key:Description
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+
+ </th><th style="border-bottom: 1px solid ; " align="left">
+
+ </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ open
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ENTER
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Open the currently selected feed or article.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ quit
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ q
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Quit the program or return to the previous dialog (depending on the context).
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ reload
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ r
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Reload the currently selected feed.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ reload-all
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ R
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Reload all feeds.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ mark-feed-read
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ A
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Mark all articles in the currently selected feed read.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ mark-all-feeds-read
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ C
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Mark articles in all feeds read.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ save
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ s
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Save the currently selected article to a file.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ next-unread
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Jump to the next unread article.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ prev-unread
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ p
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Jump to the previous unread article.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ open-in-browser
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ o
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Opens the URL associated with the current article.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ help
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ?
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Runs the help screen.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ toggle-source-view
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ^U
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Toggles between the HTML view and the source view in the article view.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ toggle-article-read
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ N
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Toggle the read flag for the currently selected article.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ toggle-show-read-feeds
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ l
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Toggle whether read feeds should be shown in the feed list.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ show-urls
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ u
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Show all URLs in the article in a list (similar to urlview).
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ clear-tag
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ^T
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Clear current tag.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ select-tag
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ t
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Select tag.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ open-search
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ /
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Opens the search dialog. When a search is done in the article list, then the search operation only applies to the articles of the current feed, otherwise to all articles.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ enqueue
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ e
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Add the podcast download URL of the current article (if any is found) to the podcast download queue (see below for more information on podcast support).
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ reload-urls
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ^R
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Reload the URLs configuration file.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ redraw
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ^L
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Redraw the screen.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ run
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Run a Ruby function (only available from within macros, see below).
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ cmdline
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ :
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Open the command line.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ set-filter
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ F
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Set a filter.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ select-filter
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ f
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Select a predefined filter.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ clear-filter
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ^F
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Clear currently set filter.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ bookmark
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ^B
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Bookmark currently selected article or URL.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ edit-flags
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ^E
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Edit the flags of the currently selected article.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ next-unread-feed
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ^N
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Go to the next feed with unread articles. This only works from the article list.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ prev-unread-feed
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ^P
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Go to the previous feed with unread articles. This only works from the article list.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ up
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ UP
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Goes up one item in the list.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ down
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ DOWN
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Goes down one item in the list.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ pageup
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ PPAGE
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Goes up one page in the list.
+ </td></tr><tr><td style="border-right: 1px solid ; " align="left">
+ pagedown
+ </td><td style="border-right: 1px solid ; " align="left">
+ NPAGE
+ </td><td style="" align="left">
+ Goes down one page in the list.
+ </td></tr></tbody></table></div><p>Keys, as used in the bind-key configuration command, use a special syntax.
+Lowercase keys, uppercase keys and special characters are written literally.
+The Enter key is written as "ENTER", while the Esc key is written as "ESC". The
+function keys F1 to F12 are written as "F1" to "F12". The Space key is written
+as "SPACE". Key combinations with the Ctrl key, such as Ctrl-R, are written as
+^R. Please be aware that all Ctrl-related key combinations need to be written
+in uppercase. The following identifiers for keys are supported:</p><div class="itemizedlist"><ul type="disc"><li>
+ENTER (Enter key)
+</li><li>
+BACKSPACE (backspace key)
+</li><li>
+LEFT (left cursor)
+</li><li>
+RIGHT (right cursor)
+</li><li>
+UP (up cursor)
+</li><li>
+PPAGE (page up cursor)
+</li><li>
+NPAGE (page down cursor)
+</li><li>
+DOWN (down cursor)
+</li><li>
+ESC (Esc key)
+</li></ul></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2505590"></a>Example Configuration</h3></div></div></div><pre class="literallayout"># a comment
+max-items 100 # such comments are possible, too
+browser links
+show-read-feeds no</pre><pre class="literallayout">unbind-key R
+bind-key ^R reload-all</pre></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2505616"></a>Configuring Colors</h3></div></div></div><p>It is possible to configure custom color settings in newsbeuter. The basic configuration
+syntax is:</p><pre class="literallayout">color &lt;element&gt; &lt;foreground color&gt; &lt;background color&gt; [&lt;attribute&gt; ...]</pre><p>This means that if you configure colors for a certain element, you need to provide
+a foreground color and a background color as a minimum. The following colors are
+supported:</p><div class="itemizedlist"><ul type="disc"><li>
+black
+</li><li>
+red
+</li><li>
+green
+</li><li>
+yellow
+</li><li>
+blue
+</li><li>
+magenta
+</li><li>
+cyan
+</li><li>
+white
+</li><li>
+default
+</li></ul></div><p>The "default" color means that the terminal's default color will be used.</p><p>Optionally, you can also add one or more attributes. The following attributes are
+supported:</p><div class="itemizedlist"><ul type="disc"><li>
+standout
+</li><li>
+underline
+</li><li>
+reverse
+</li><li>
+blink
+</li><li>
+dim
+</li><li>
+bold
+</li><li>
+protect
+</li><li>
+invis
+</li></ul></div><p>Currently, the following elements are supported:</p><div class="itemizedlist"><ul type="disc"><li>
+<span class="strong"><strong>listnormal</strong></span>: a normal list item
+</li><li>
+<span class="strong"><strong>listfocus</strong></span>: the currently selected list item
+</li><li>
+<span class="strong"><strong>info</strong></span>: the info bars on top and bottom
+</li><li>
+<span class="strong"><strong>background</strong></span>: the application background
+</li><li>
+<span class="strong"><strong>article</strong></span>: the article text
+</li></ul></div><p>The default color configuration of newsbeuter looks like this:</p><pre class="literallayout">background white black
+listnormal white black
+listfocus yellow blue bold
+info yellow blue bold
+article white black</pre></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2505874"></a>Migrating from other RSS Feed Readers</h3></div></div></div><p>It is very likely that you have used other RSS feed readers before. In this
+case, it is practical to migrate the previous configuration to newsbeuter. The
+vast amount of RSS feed readers allows the export of subscriptions via OPML
+files. OPML is an XML file format that was designed to save outlines, and has
+found its primary use in the import and export of feed subscriptions between
+different RSS feed readers.</p><p>The best thing to start with is to export your subscriptions from the old
+reader. Usually, RSS feed readers have appropriate menu itmes available to do
+so.</p><p>Snownews provides a script to convert your current subscription file into an
+OPML file:</p><pre class="literallayout">snow2opml &gt; ~/blogroll.opml</pre><p>This command creates from your Snownews configuration a file blogroll.opml in
+your home directory. To export the subscription list from raggle, the
+following command is necessary:</p><pre class="literallayout">raggle --export-opml ~/blogroll.opml</pre><p>When you have exported the subscriptions from your old RSS feed reader, you can
+import them into newsbeuter:</p><pre class="literallayout">newsbeuter -i ~/blogroll.opml</pre><p>Don't worry, newsbeuter won't destroy your existing configuration, or add
+subscriptions more than once: every URL that is added to the subscription list
+is checked before whether it is already in the list, and is only added if not.
+This makes it possible to merge several OPML files into your subscription list.</p><p>If your old RSS feed reader was able to structure your subscriptions in
+hierarchies, and reflected this structure in the exported OPML file, newsbeuter
+doesn't throw away this information (although it doesn't support hierarchies), but
+generates tags from it. Tags are newsbeuter's way of organizing subscriptions
+in a non-hierarchical way. More information on the use of tags can be found below.</p><p>Imagine the following folder hierarchy:</p><pre class="literallayout">|- News
+| |- Europe
+| `- International
+|- IT
+| |- Linux
+| |- Windows
+| `- Programming
+| |- C++
+| |- Ruby
+| `- Erlang
+`- Private</pre><p>Subscriptions found in the folder "Private" will be tagged with "Private",
+subscriptions in the folder "International" will be tagged with "News" and
+"News/International", subscriptions in the folder "Erlang" will be tagged ith
+"IT", "IT/Programming" and "IT/Programming/Erlang", and so on. This means that
+when you select the tag "Programming" in newsbeuter, you will see all
+subscriptions that were in the "Programming" folder or one of its subfolders
+before. This means that you will lose virtually nothing of your previously
+configured structure.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2506021"></a>Advanced Features</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2506027"></a>Tagging</h3></div></div></div><p>Newsbeuter comes with the possibility to categorize or "tag", as well call it,
+RSS feeds. Every RSS feed can be assigned 0 or more tags. Within newsbeuter, you
+can then select to only show RSS feeds that match a certain tag. That makes it
+easy to categorize your feeds in a flexible and powerful way.</p><p>Usually, the <sub>/.newsbeuter/urls file contains one RSS feed URL per line. To
+assign a tag to an RSS feed, simply attach it as a single word, separated by
+blanks such as space or tab. If the tag needs to contain spaces, you must use
+quotes (") around the tag (see example below). An example </sub>/.newsbeuter/urls
+file may look like this:</p><pre class="literallayout">http://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
+http://rss.orf.at/news.xml news orf
+http://www.heise.de/newsticker/heise.rdf news interesting</pre><p>When you now start newsbeuter with this configuration, you can press "t" to select
+a tag. When you select the tag "news", you will see all three RSS feeds. Pressing
+"t" again and e.g. selecting the "conspiracy" tag, you will only see the
+http://blog.fefe.de/rss.xml?html RSS feed. Pressing "^T" clears the current tag,
+and again shows all RSS feeds, regardless of their assigned tags.</p><p>A special type of tag are tags that start with the tilde character ("<sub>"). When such
+a tag is found, the feed title is set to the tag name (excluding the </sub> character).
+With this feature, you can give feeds any title you want in your feed list:</p><pre class="literallayout">http://rss.orf.at/news.xml "~ORF News"</pre></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2506107"></a>Scripts and Filters (Snownews Extensions)</h3></div></div></div><p>From version 0.4 on, newsbeuter contains support for Snownews extensions. The
+RSS feed readers Snownews and Liferea share a common way of extending the
+readers with custom scripts. Two mechanisms, namely "execurl" and "filter" type
+scripts, are available and supported by newsbeuter.</p><p>An "execurl" script can be any program that gets executed and whose output is
+interpreted as RSS feed, while "filter" scripts are fed with the content of a
+configured URL and whose output is interpreted as RSS feed.</p><p>The configuration is simple and straight-forward. Just add to your
+~/.newsbeuter/urls file configuration lines like the following ones:</p><pre class="literallayout">exec:~/bin/execurl-script
+filter:~/bin/filter-script:http://some.test/url</pre><p>The first line shows how to add an execurl script to your configuration: start
+the line with "exec:" and then immediately append the path of the script that
+shall be executed. If this script requires additional parameters, simply use
+quotes:</p><pre class="literallayout">"exec:~/bin/execurl-script param1 param2"</pre><p>The second line shows how to add a filter script to your configuration: start
+the line with "filter:", then immediately append the path of the script, then
+append a colon (":"), and then append the URL of the file that shall be fed to
+the script. Again, if the script requires any parameters, simply quote:</p><pre class="literallayout">"filter:~/bin/filter-script param1 param2:http://url/foobar"</pre><p>In both cases, the tagging feature as described above is still available:</p><pre class="literallayout">exec:~/bin/execurl-script tag1 tag2 "quoted tag"
+filter:~/bin/filter-script:http://some.test/url tag3 tag4 tag5</pre><p>A collection of such extension scripts can be found on this website:
+<a href="http://kiza.kcore.de/software/snownews/snowscripts/extensions" target="_top">http://kiza.kcore.de/software/snownews/snowscripts/extensions</a></p><p>If you want to write your own extensions, refer to this website for further
+instructions: <a href="http://kiza.kcore.de/software/snownews/snowscripts/writing" target="_top">http://kiza.kcore.de/software/snownews/snowscripts/writing</a></p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2506227"></a>Bookmarking</h3></div></div></div><p>Since version 0.7, newsbeuter contains a plugin-based bookmarking system. When a user bookmarks a link (possible
+in the article list, in the article view, and in the URL view), he is asked for the URL to bookmark (already
+preset with the URL of the current selection), the bookmark title (in most cases preset with the
+title of the current selection) and the bookmark description. After the question for the description, an
+external program, configured via the configuration command "bookmark-cmd", is executed with 3 commandline
+parameters. The plugin itself implements the actual bookmark saving (e.g. writing the bookmark to an
+external file, or storing it to a del.icio.us account). When everything went OK, the plugin simply exits.
+In case something goes wrong while saving the bookmark, it writes out an error message as a single line.
+This error message is then presented to the user from within newsbeuter.</p><p>Newsbeuter comes with an example plugin, which implements a simple tab-separated bookmark file. This
+example can be found in the "doc" subdirectory.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2506264"></a>Command Line</h3></div></div></div><p>Like other text-oriented software, newsbeuter contains an internal commandline to
+modify configuration variables ad hoc and to run own commands. It provides a flexible
+access to the functionality of newsbeuter which is especially useful for
+advanced users.</p><p>To start the commandline, type ":". You will see a ":" prompt at the bottom of
+the screen, similar to tools like vi(m) or mutt. You can now enter commands.
+Pressing the return key executes the command (possibly giving feedback to the
+user) and closes the commandline. You can cancel entering commands by pressing
+the ESC key. Currently, the following commands are available:</p><div class="table"><a id="id2506296"></a><p class="title"><b>Table 3. Available Commandline Commands</b></p><table summary="Available Commandline Commands" cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Command
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Syntax
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Description
+ </th><th style="border-bottom: 1px solid ; " align="left">
+ Example
+ </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ quit
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ quit
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Quit newsbeuter.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ quit
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ save
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ save &lt;filename&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Save the currently select article to disk. This works in the article list and in the article view.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ save ~/important.txt
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ set
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ set &lt;variable&gt;[=&lt;value&gt;]
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Set configuration variable &lt;variable&gt; to &lt;value&gt;. If no value is specified, the current value is printed out
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ set reload-time=15
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ tag
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ tag &lt;tagname&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Only display feeds with the tag &lt;tagname&gt;.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ tag news
+ </td></tr><tr><td style="border-right: 1px solid ; " align="left">
+ n/a
+ </td><td style="border-right: 1px solid ; " align="left">
+ &lt;number&gt;
+ </td><td style="border-right: 1px solid ; " align="left">
+ Jump to the entry with the index &lt;number&gt; (usually seen at the left side of the list). This currently works for the feed list and the article list.
+ </td><td style="" align="left">
+ 30
+ </td></tr></tbody></table></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2506478"></a>Filter Language</h3></div></div></div><p>Newsbeuter provides a powerful filter language that enables the user to
+filter the content of many dialogs, such as the feed list or the article
+list. The basic concept is that every feed and every article has a
+number of attributes which can then be compared with user-supplied
+values, and these comparisons and be logically AND'ed, OR'ed and
+grouped.</p><p>Examples for simple filter expressions are:</p><pre class="literallayout">unread_count &gt; 0
+rssurl =~ "^https:"</pre><p>Logically connecting and grouping such expressions looks like in the
+following examples:</p><pre class="literallayout">( unread_count &gt; 0 and unread_count &lt; 10 ) or total_count &gt; 100
+( author =~ "Frank" or author =~ "John" ) and ( title =~ "Linux" or title =~ "FreeBSD" )</pre><p>The possibilities for combining such queries is endless, sky (actually:
+the available memory) is the limit.</p><p>To filter your feeds, press "F" in the feed list, enter your filter expression,
+and press enter. To clear the filter, press Ctrl-F. To filter the articles in the article list,
+press "F", enter your expression, and press enter. Clearing the filter works the same as before.
+Be aware that only certain attributes work in both dialogs. The table below lists all available
+attributes and their context, i.e. an attribute that belongs to a feed can only be matched
+in the feed list, while an attribute that belongs to an article can only be matched in the
+article list.</p><div class="table"><a id="id2506560"></a><p class="title"><b>Table 4. Available Comparison Operators</b></p><table summary="Available Comparison Operators" cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Operator
+ </th><th style="border-bottom: 1px solid ; " align="left">
+ Meaning
+ </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ =
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ test for equality ("==" works, too)
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ !=
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ test for inequality; logical negation of = operator
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ =~
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ test whether regular expression matches
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ !~
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ logical negation of the =~ operator
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ less than
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &gt;
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ greater than
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;=
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ less than or equal
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &gt;=
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ greater than or equal
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ #
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ contains; this operator matches if a word is contained in a list of space-separated words (useful for matching tags, see below)
+ </td></tr><tr><td style="border-right: 1px solid ; " align="left">
+ !#
+ </td><td style="" align="left">
+ contains not; the negation of the # operator
+ </td></tr></tbody></table></div><div class="table"><a id="id2506729"></a><p class="title"><b>Table 5. Available Attributes</b></p><table summary="Available Attributes" cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Attribute
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Context
+ </th><th style="border-bottom: 1px solid ; " align="left">
+ Meaning
+ </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ title
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ article title
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ link
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ article link
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ author
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ article author
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ content
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ article body
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ date
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ publication date of the article
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ guid
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ a unique identifier of the article
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ unread
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ indicates whether the article has been read
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ enclosure_url
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ the URL of a possible enclosure (e.g. podcast file)
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ enclosure_type
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ the MIME type of the enclosure URL
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ flags
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ The set of flags of the article
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feedtitle
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feed, article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ title of the feed
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ description
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feed, article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ feed description
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feedlink
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feed, article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ link to the feed
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feeddate
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feed, article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ publication date of the feed
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ rssurl
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feed, article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ RSS URL of the feed
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ unread_count
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feed, article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ number of unread articles in the feed
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ total_count
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ feed, article
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ total number of articles in the feed
+ </td></tr><tr><td style="border-right: 1px solid ; " align="left">
+ tags
+ </td><td style="border-right: 1px solid ; " align="left">
+ feed, article
+ </td><td style="" align="left">
+ all tags that are associated with the feed
+ </td></tr></tbody></table></div><p>Note that it's also possible to filter for feed attributes when you query for
+article attributes. This is because every article is internally linked to the
+feed from which it was downloaded.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2507084"></a>Killfiles</h3></div></div></div><p>Sometimes, a user is confronted with certain content he doesn't want to read,
+e.g. on topics the user is not interested in or articles from certain people he
+doesn't want to read. In Usenet, such functionality within software is
+traditionally called a "killfile", i.e. based on the content of this "killfile",
+articles that match certain conditions do not get displayed and are not presented
+to the user at all.</p><p>In newsbeuter, such a "killfile" can be implemented on a per-article basis via
+the configuration file. The most important configuration command for this
+is "ignore-article":</p><pre class="literallayout">ignore-article "*" "title =~ \"Gentoo\""
+ignore-article "http://synflood.at/blog/index.php?/feeds/index.rss2" "title =~ \"newsbeuter\""</pre><p>The basic format is that the user specifies an RSS feed for which the ignore
+shall be applied ("*" matches all RSS feeds), and then a filter expression (see
+previous section). If newsbeuter hits an article in the specified RSS feed that
+matches the specified filter expression, then this article is ignored and never
+presented to the user. The configuration itself can contain as many
+ignore-article commands as desired.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2507145"></a>Query Feeds</h3></div></div></div><p>Query feeds are a mechanism of newsbeuter to define custom "meta feeds" by using
+newsbeuter's built-in filter language. A query feed is a feed that is aggregated
+from all currently downloaded articles of all feeds. To narrow down the set of
+articles, the user has to specify a filter. Only articles that match this filter
+are added to the query feed. A query feed is updated whenever it is entered in
+the feed list. When you change the unread flag of an article, this is reflected
+in the feed where the article was originally fetched.</p><p>To define a query feed, the user has to add a line to the file
+~/.newsbeuter/urls in the following format:</p><pre class="literallayout">query:&lt;name of feed&gt;:&lt;filter expression&gt; [&lt;tag&gt; ...]</pre><p>The "query:" in the beginning tells newsbeuter that it's a query feed, "&lt;name of
+feed&gt;" specifies the name under which the query feed shall be displayed in the
+feed list, and "&lt;filter expression&gt;" is the filter expression that shall be
+used. Like every other feed, a query feed can be tagged to organize it like
+a regular feed.</p><p>A good example for the user of this feature is a query feed that contains all
+unread articles:</p><pre class="literallayout">"query:Unread Articles:unread = \"yes\""</pre><p>Note the quotes that are necessary around the complete query "URL" and the
+backslashes that are necessary the escape the quotes in the filter expression.</p><p>If you want to combine several feeds to one single feed, a good solution is to
+tag the feeds that you want to combine with one certain tag, and then create a
+query feed that only displays articles from feeds with that certain tag:</p><pre class="literallayout">http://domain1.tld/feed.xml fun news tag1
+http://domain2.tld/?feed.rss private jokes tag1
+http://domain3.tld/feeds.rss news
+"query:tag1 Articles:tags # \"tag1\""</pre><p>In this example, the feeds http://domain1.tld/feed.xml and
+http://domain2.tld/?feed.rss are aggregated into the query feed named "tag1
+Articles", but the feed http://domain3.tld/feeds.rss is not.</p><p>Basically, the possibility of what can be realized with query feeds is only
+limited by what can be queried from articles and feeds with the filter language
+and by your creativity.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2507257"></a>Bloglines Synchronization</h3></div></div></div><p><a href="http://www.bloglines.com" target="_top">Bloglines</a> is a web-based RSS feed reader. Newsbeuter
+provides a synchronization feature that makes it possible to download unread
+articles from Bloglines (which can then be optionally be marked as read). This
+is useful in cases where you want to use the web frontend e.g. at work, and use
+newsbeuter e.g. when you're at home. It is also possible to use newsbeuter as
+an offline reader for Bloglines.</p><p>To enable Bloglines support, you first need to set the following configuration
+variable:</p><pre class="literallayout">urls-source "bloglines"</pre><p>By default, this is set to "local", which means that the list of configured
+URLs is retrieved from ~/.newsbeuter/urls. By setting it to "bloglines",
+newsbeuter will retrieve the list of retrieved URLs directly from Bloglines.
+This means that you can only either use the locally configured URLs or the URLs
+from Bloglines. Combination of both is not possible.</p><p>After setting the URLs source, you also need to set the Bloglines authentication configuration:</p><pre class="literallayout">bloglines-auth "username@emailaddress.com:yourpassword"</pre><p>In the configuration variable "bloglines-auth", you provide your Bloglines
+login (i.e. your email address) and your password, separated by a colon (":"). Optionally, you can configure that all messages that are downloaded are marked as read in the Bloglines web frontend:</p><pre class="literallayout">bloglines-mark-read "yes"</pre><p>After you've configured newsbeuter for Bloglines, you can start it up. Newsbeuter
+will then download the RSS feed URLs subscribed in Bloglines, which you can then
+reload.</p><p>In this configuration, you need the possibility to connect to Bloglines. In
+case you don't have access to Bloglines (e.g. a temporary network outage, or
+you sit in a location without connectivity, e.g. a train), you can start
+newsbeuter in offline mode:</p><pre class="literallayout">newsbeuter -o</pre><p>With this commandline switch, you can read the articles that you have already
+downloaded without any network connectivity. This functionality makes
+newsbeuter a true offline client for Bloglines.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2507384"></a>OPML Online Subscription Mode</h3></div></div></div><p>The OPML online subscription mode works similar to the Bloglines
+synchronization mode, except that no information about read articles is
+synchronized back. When enabled, all feeds that are listed in the feed list
+will be taken from an OPML that is downloaded from a freely configurable URL.</p><p>To enable this mode, the following configuration needs to be done:</p><pre class="literallayout">urls-source "opml"
+opml-url "&lt;opml url&gt;"</pre><p>"opml" must be specified as source for the feed URLs, and the URL of the OPML
+file needs to be specified, too. As with Bloglines synchronization mode, the offline
+mode via "newsbeuter -o" also works with OPML online subscription mode.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2507429"></a>Flagging Articles</h3></div></div></div><p>To support custom categorization of articles by the user, it is possible to
+flag an article. A valid flag is any character from <span class="emphasis"><em>A</em></span> to <span class="emphasis"><em>Z</em></span> and from <span class="emphasis"><em>a</em></span> to
+<span class="emphasis"><em>z</em></span>. Every article can be flagged with up to 52 different flags, i.e. every
+letter from the Roman alphabet in upper and lower case. Flagging is easy: just
+select an article in the article list, or enter the article view, and press ^E.
+This will start the flag editor. By pressing enter, the new flags are saved.
+You can cancel by pressing the ESC key.</p><p>The flags of an article can be used in every filter expression. The flags of an
+article are always ordered, and when new flags are added, ordering is
+immediately restored. This behaviour can also be relied upon when querying
+articles via the filter language.</p><p>If an article contains one or more flags, it is marked with an "!" in the
+article list. In the article view, all flags (if available) are listed.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2507487"></a>Macro Support</h3></div></div></div><p>In newsbeuter, it's possible to define macros to execute more than one command
+at once. A macro is configured using the "macro" configuration command. The
+first parameter to "macro" is the key, all parameters afterwards are operations
+(as listed in the "Available Operations" table above), optionally with
+parameters on their own, separated by the ";" character. Here's a simple
+example:</p><pre class="literallayout">macro k open ; reload ; quit</pre><p>When the user presses the macro prefix ("," by default) and then the "k" key,
+the three operations "open", "reload" and "quit" will be executed subsequently.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2507528"></a>Ruby Support</h3></div></div></div><p>In order to run Ruby functions from within newsbeuter, you first need to load
+a Ruby file into the embedded Ruby interpreter via the configuration file:</p><pre class="literallayout">load "test.rb"</pre><p>In our example, the file test.rb looks like this:</p><pre class="literallayout">def dotest
+ $ctrl.get_view.set_status("hello world!")
+end</pre><p>To make a Ruby function callable, you need to define a macro:</p><pre class="literallayout">macro x run "dotest"</pre><p>When the macro "x" is run by pressing "," and "x" (see above), the
+(parameter-less) Ruby function "dotest" will be executed, which will display
+"hello world!" in the status line at the bottom of the screen.</p><p>Currently, the available interfaces are (mostly) untested and completely
+undocumented.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2507594"></a>Format Strings</h3></div></div></div><p>Newsbeuter contains a powerful format string system to make it possible for the
+user to configure the format of various aspects of the application, such as
+the format of entries in the feed list or in the article list.</p><p>Format strings are similar to those that are found in the "printf" function in
+the C programming language. A format sequence begins with the <span class="emphasis"><em>%</em></span> character,
+followed by optional alignment indication: positive numbers indicate that the
+text that is inserted for the sequence shall be padded right to a total width
+that is specified by the number, while negative number specify left padding.
+Followed by the padding indication comes the actual sequence identifier, which
+is usually a single letter.</p><p>In addition, newsbeuter provides other, more powerful sequences, such as
+"%&gt;[char]", which indicates that the text right to the sequence will be aligned
+right on the screen, and characters between the text on the left and the text
+on the right will be filled by "[char]". Another powerful is the conditional
+sequence, "%?[char]?[format 1]&amp;[format 2]?": if the text of the sequence
+identifier "[char]" is non-empty, then "[format 1]" will be evaluted and
+inserted, otherwise "[format 2]" will be evaluted and inserted. The "&amp;" and
+"[format 2]" are optional, i.e. if the identifier's text is empty, then an
+empty string will be inserted.</p><p>The following tables show what sequence identifiers are available for which
+format:</p><div class="table"><a id="id2507656"></a><p class="title"><b>Table 6. Available Identifiers for feedlist-format</b></p><table summary="Available Identifiers for feedlist-format" cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Identifier
+ </th><th style="border-bottom: 1px solid ; " align="left">
+ Meaning
+ </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ d
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Feed description
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ i
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Feed index
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ l
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Feed link
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ L
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Feed RSS URL
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ n
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ "unread" flag field
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ t
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Feed title
+ </td></tr><tr><td style="border-right: 1px solid ; " align="left">
+ u
+ </td><td style="" align="left">
+ "unread/total" field
+ </td></tr></tbody></table></div><div class="table"><a id="id2507785"></a><p class="title"><b>Table 7. Available Identifiers for articlelist-format</b></p><table summary="Available Identifiers for articlelist-format" cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Identifier
+ </th><th style="border-bottom: 1px solid ; " align="left">
+ Meaning
+ </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ a
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Article author
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ D
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Publication date
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ f
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Article flags
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ i
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Article index
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ t
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Article title
+ </td></tr><tr><td style="border-right: 1px solid ; " align="left">
+ T
+ </td><td style="" align="left">
+ If the article list displays articles from different feeds, then this identifier contains the title of the feed to which the article belongs.
+ </td></tr></tbody></table></div><p>Examples:</p><pre class="literallayout">feedlist-format "%4i %n %11u %t"
+articlelist-format "%4i %f %D %?T?|%-17T| ?%t"</pre></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2507923"></a>Podcast Support</h3></div></div></div><p>A podcast is a media file distributed over the internet using syndication feeds
+such as RSS, for later playback on portable players or computers. Newsbeuter
+contains support for downloading and saving podcasts. This support differs a bit
+from other podcast aggregators or "podcatchers" in how it is done.</p><p>Podcast content is transported in RSS feeds via special tags called
+"enclosures". Newsbeuter recognizes these enclosures and stores the relevant
+information for every podcast item it finds in an RSS feed. What the user then
+can do is to add the podcast download URL to a download queue. Alternatively,
+newsbeuter can be configured to automatically do that. This queue is stored in
+the file $HOME/.newsbeuter/queue.</p><p>The user can then use the download manager "podbeuter" to download these files
+to a directory on the local filesystem. Podbeuter comes with the newsbeuter
+package, and features a look and feel very close to the one of newsbeuter. It
+also shares the same configuration file.</p><div class="table"><a id="id2507962"></a><p class="title"><b>Table 8. Podbeuter Configuration Commands</b></p><table summary="Podbeuter Configuration Commands" cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Configuration Command
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Argument(s)
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Default
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Description
+ </th><th style="border-bottom: 1px solid ; " align="left">
+ Example
+ </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ download-path
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;path&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ ~/
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Specifies the directory where podbeuter shall download the files to.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ download-path "~/Downloads"
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ max-downloads
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ &lt;number&gt;
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ 1
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Specifies the maximum number of parallel downloads when automatic download is enabled.
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ max-downloads 3
+ </td></tr><tr><td style="border-right: 1px solid ; " align="left">
+ player
+ </td><td style="border-right: 1px solid ; " align="left">
+ &lt;player command&gt;
+ </td><td style="border-right: 1px solid ; " align="left">
+ ""
+ </td><td style="border-right: 1px solid ; " align="left">
+ Specifies the player that shall be used for playback of downloaded files.
+ </td><td style="" align="left">
+ player "mp3blaster"
+ </td></tr></tbody></table></div><div class="table"><a id="id2508122"></a><p class="title"><b>Table 9. Available Operations in Podbeuter</b></p><table summary="Available Operations in Podbeuter" cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Operation
+ </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ Default key
+ </th><th style="border-bottom: 1px solid ; " align="left">
+ Description
+ </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ quit
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ q
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Quit the program.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ pb-download
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ d
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Download the currently selected URL.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ pb-cancel
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ c
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Cancel the currently selected download.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ pb-delete
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ D
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Delete the currently selected URL from the queue.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ pb-purge
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ P
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Remove all finished and deleted downloads from the queue and load URLs that were newly added to the queue.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ pb-toggle-download-all
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ a
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Toggle the "automatic download" feature where all queued URLs are downloaded one after the other. The "max-downloads" configuration option controls how many downloads are done in parallel.
+ </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ pb-increase-max-dls
+ </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
+ +
+ </td><td style="border-bottom: 1px solid ; " align="left">
+ Increase the "max-downloads" option by 1.
+ </td></tr><tr><td style="border-right: 1px solid ; " align="left">
+ pb-decrease-max-dls
+ </td><td style="border-right: 1px solid ; " align="left">
+ -
+ </td><td style="" align="left">
+ Decrease the "max-downloads" option by 1. If the option is already 1, no further decrease is possible.
+ </td></tr></tbody></table></div><p>A usual "use case" is to configure newsbeuter to automatically enqueue newly
+found podcast download URLs. Then, the user reloads the podcast RSS feeds in
+newsbeuter, and after that, he/she uses podbeuter to view the current queue, and
+either selectively download certain files or automatically download them all
+together by pressing "a" within podbeuter.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2508339"></a>Using SQLite Triggers with newsbeuter</h3></div></div></div><p>This section was kindly provided by <a href="mailto:elrond+newsbeuter(at)samba-tng.org" target="_top">Elrond</a>.</p><p>SQLite, the db used by newsbeuter, supports triggers. These are small
+snippets of SQL that get executed inside the database by the database
+engine. They're stored inside the db and the normal user (including
+newsbeuter itself) doesn't see them. Just the db seems to do some magic:
+Like changing some values when you change another value.</p><p>So what is this good for when looking at newsbeuter? Well first of it's a
+hack. The real answer should be to use application logic (do it inside
+newsbeuter, not in the db). So: Don't use this, unless you know, what you're
+doing, and unless you have some sort of backup.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id2508379"></a>Example</h4></div></div></div><p>So after the "don't use it" you still want to know, what one can do? So here's an example.</p><p>Suppose you have a strange feed where the articles become "new" by just
+changing their subject, and nothing else changes. The body is just empty, and
+the URL keeps the same. This feed really exists. It's the "updated software rss
+feed" of some major company and the title just contains the name of the driver
+and version number. And the URL points to the download page. newsbeuter
+considers articles only as new, when they have a new UniqueID (this is good).
+So those articles are never marked as new (unread) ever again.</p><p>So what can we do? We do some magic: We let the db test if newsbeuter
+changes the subject and then let itself mark the article again as unread.</p><div class="orderedlist"><ol type="1"><li>
+You need the sqlite3 command line tool (available via apt-get install sqlite3 on Debian) or some other tool to do direct sql on the sqlite database.
+</li><li><p>
+Start sqlite3 with the newsbeuter db:
+</p><pre class="literallayout">Rivendell:~/.newsbeuter% sqlite3 cache.db
+SQLite version 3.4.2
+Enter ".help" for instructions
+sqlite&gt;</pre></li><li><p>
+Create the trigger:
+</p><pre class="literallayout">sqlite&gt; create trigger update_item_title update of title on rss_item
+ &gt; for each row when old.title != new.title
+ &gt; begin
+ &gt; update rss_item set unread = 1 where rowid == new.rowid;
+ &gt; end;</pre></li><li>
+Leave sqlite3 with &lt;Ctrl-D&gt; or .quit.
+</li></ol></div><p>That's it. newsbeuter (well, its db) now marks articles as unread when their
+title changes. And nicely enough this works all inside newsbeuter, no need to
+restart it so that it rereads the cache, that magically modifies itself. It
+just works.</p></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2508493"></a>Feedback</h2></div></div></div><p>If you want to tell us something related to newsbeuter, don't hesitate to send
+an email: ak-newsbeuter@synflood.at</p><p>Alternatively, you can reach the newsbeuter developers on IRC: channel
+#newsbeuter on irc.freenode.net.</p><p>If you want to report newsbeuter bugs, please use this issue tracker:
+<a href="http://code.google.com/p/newsbeuter/issues/list" target="_top">http://code.google.com/p/newsbeuter/issues/list</a></p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2508526"></a>License</h2></div></div></div><p>MIT/X Consortium License</p><p>©opyright 2006-2008 Andreas Krennmair &lt;ak@synflood.at&gt;</p><p>Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:</p><p>The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.</p><p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.</p></div></div></body></html>