← Back to branch summary

~ubuntu-branches/ubuntu/maverick/newsbeuter/maverick

« back to all changes in this revision

Viewing changes to doc/xhtml/newsbeuter.html

  • Committer: Bazaar Package Importer
  • Author(s): Nico Golde
  • Date: 2007-04-21 19:44:35 UTC
  • Revision ID: james.westby@ubuntu.com-20070421194435-21g6134ws2yvarlt
Tags: upstream-0.3
Import upstream version 0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xhtml/newsbeuter.html
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
<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="id2408942"></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="#id2458043">Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#id2458057">Why "Newsbeuter"?</a></span></dt></dl></dd><dt><span class="section"><a href="#id2458081">Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#id2458091">Downloading Newsbeuter</a></span></dt><dt><span class="section"><a href="#id2494644">Dependencies</a></span></dt><dt><span class="section"><a href="#id2494733">Compiling and Installing</a></span></dt></dl></dd><dt><span class="section"><a href="#id2494744">First Steps</a></span></dt><dd><dl><dt><span class="section"><a href="#id2504231">Example Configuration</a></span></dt><dt><span class="section"><a href="#id2504257">Configuring Colors</a></span></dt></dl></dd><dt><span class="section"><a href="#id2504516">Advanced Features</a></span></dt><dd><dl><dt><span class="section"><a href="#id2504522">Tagging</a></span></dt><dt><span class="section"><a href="#id2504582">Podcast Support</a></span></dt></dl></dd><dt><span class="section"><a href="#id2504973">Feedback</a></span></dt><dt><span class="section"><a href="#id2505006">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="id2458043"></a>Introduction</h2></div></div></div><p>Newsbeuter is an RSS feedreader. RSS is a number of widely-used XML formats to
 
4
transmit, publish and syndicate articles, for example news or blog articles.
 
5
Newsbeuter is designed to be used on text terminals on Unix or Unix-like
 
6
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="id2458057"></a>Why "Newsbeuter"?</h3></div></div></div><p>"Newsbeuter" is a pun on the German word "Wildbeuter", which means
 
7
"hunter-gatherer". During the stone age, people hunted and gathered their food,
 
8
and these days, they hunt and gather news and information. Credits for this
 
9
idea goes to Clifford Wolf, who submitted it to a little competiton that was
 
10
started when I got aware that the original name would violate French and
 
11
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="id2458081"></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="id2458091"></a>Downloading Newsbeuter</h3></div></div></div><p>Newsbeuter is available as source package. Simply go to
 
12
<a href="http://synflood.at/newsbeuter.html" target="_top">http://synflood.at/newsbeuter.html</a> and download the latest source package,
 
13
which is usually in the .tar.gz file format. Alternatively, you can check out
 
14
the latest development source tree from the newsbeuter SVN repository by
 
15
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="id2494644"></a>Dependencies</h3></div></div></div><p>Newsbeuter depends on a number of libraries to function correctly. This table
 
16
lists these dependencies. Please be aware that the list libraries may
 
17
themselves depend on other libraries. These dependencies are not listed here.
 
18
Please also be aware that you need a recent C++ compiler. Currently, newsbeuter
 
19
has only been tested with GCC.</p><div class="itemizedlist"><ul type="disc"><li>
 
20
STFL: <a href="http://www.clifford.at/stfl/" target="_top">http://www.clifford.at/stfl/</a>
 
21
</li><li>
 
22
SQLite 3: <a href="http://www.sqlite.org/" target="_top">http://www.sqlite.org/</a>
 
23
</li><li>
 
24
libcurl: <a href="http://curl.haxx.se/" target="_top">http://curl.haxx.se/</a>
 
25
</li><li>
 
26
libmRss: <a href="http://www2.autistici.org/bakunin/libmrss/" target="_top">http://www2.autistici.org/bakunin/libmrss/</a>
 
27
</li><li>
 
28
libnXml: <a href="http://www2.autistici.org/bakunin/libnxml/" target="_top">http://www2.autistici.org/bakunin/libnxml/</a>
 
29
</li></ul></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2494733"></a>Compiling and Installing</h3></div></div></div><p>After you've downloaded and installed the dependencies mentioned above, you can
 
30
start compiling and installing newsbeuter. To compile newsbeuter, simply run
 
31
"make" in the source tree. After a short time, this should complete
 
32
successfully, and you can go on with installation by running "make install". By
 
33
default, this will install the "newsbeuter" binary to the /usr/local/bin
 
34
directory. You can provide an alternative installation path using the prefix
 
35
parameter, e.g. running "make install prefix=/opt/newsbeuter" will install the
 
36
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="id2494744"></a>First Steps</h2></div></div></div><p>After you've installed newsbeuter, you can run it for the first time by typing
 
37
"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.3
 
38
usage: ./newsbeuter [-i &lt;file&gt;|-e] [-u &lt;urlfile&gt;] [-c &lt;cachefile&gt;] [-h]
 
39
        -r              refresh feeds on start
 
40
        -e              export OPML feed to stdout
 
41
        -i &lt;file&gt;       import OPML file
 
42
        -u &lt;urlfile&gt;    read RSS feed URLs from &lt;urlfile&gt;
 
43
        -c &lt;cachefile&gt;  use &lt;cachefile&gt; as cache file
 
44
        -C &lt;configfile&gt; read configuration from &lt;configfile&gt;
 
45
        -h              this help</pre><p>This means that newsbeuter can't start without any configured feeds. To add
 
46
feeds to newsbeuter, you can either add URLs to the configuration file
 
47
$HOME/.newsbeuter/urls or you can import an OPML file by running "newsbeuter -i
 
48
blogroll.opml".</p><p>Now you can run newsbeuter again, and it will present you with a controllable
 
49
list of the URLs that you configured previously. You can now start downloading
 
50
the feeds, either by pressing "R" to download all feeds, or by pressing "r" to
 
51
download the currently selected feed. You can then select a feed you want to
 
52
read, and by pressing "Enter", you can go to the article list for this feed.
 
53
This works even while the downloading is still in progress.  You can now see
 
54
the list of available articles by their title. A "N" on the left indicates that
 
55
an article wasn't read yet. Pressing Enter brings you to the content of the
 
56
article. You can scroll through this text, and also run a browser (default:
 
57
lynx) to view the complete article if the content is empty or just an abstract
 
58
or a short description. Pressing "q" brings you back to the article list, and
 
59
pressing "q" again brings you back to the feed list. Pressing "q" a third time
 
60
then closes newsbeuter.</p><p>Newsbeuter caches the article that it downloads. This means that when you start
 
61
newsbeuter again and reload a feed, the old articles can still be read even if
 
62
they aren't in the current RSS feeds anymore. Optionally you can configure how
 
63
many articles shall be preserved by feed so that the article backlog doesn't
 
64
grow endlessly (see below).</p><p>Several aspects of newsbeuter's behaviour can be configured via a configuration
 
65
file, by default $HOME/.newsbeuter/config. This configuration files contains
 
66
lines in the form "&lt;config-command&gt; &lt;arg1&gt; …".  The configuration file can
 
67
also contain comments, which start with the <span class="emphasis"><em>#</em></span> character and go as far as the
 
68
end of line. If you need to enter a configuration argument that contains
 
69
spaces, use quotes (") around the whole argument.</p><div class="table"><a id="id2456330"></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">
 
70
    Configuration Command
 
71
    </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
72
    Argument(s)
 
73
    </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
74
    Default
 
75
    </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
76
    Description
 
77
    </th><th style="border-bottom: 1px solid ; " align="left">
 
78
    Example
 
79
    </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
80
    show-read-feeds
 
81
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
82
    [yes/no]
 
83
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
84
    yes
 
85
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
86
    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.
 
87
    </td><td style="border-bottom: 1px solid ; " align="left">
 
88
    show-read-feeds no
 
89
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
90
    browser
 
91
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
92
    &lt;browser-command&gt;
 
93
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
94
    lynx
 
95
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
96
    Set the browser command to use when opening an article in the browser.
 
97
    </td><td style="border-bottom: 1px solid ; " align="left">
 
98
    browser w3m
 
99
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
100
    max-items
 
101
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
102
    &lt;number&gt;
 
103
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
104
    0
 
105
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
106
    Set the number of articles to maximally keep per feed. If the number is set to 0, then all articles are kept.
 
107
    </td><td style="border-bottom: 1px solid ; " align="left">
 
108
    max-items 100
 
109
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
110
    bind-key
 
111
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
112
    &lt;key&gt; &lt;operation&gt;
 
113
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
114
    
 
115
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
116
    Bind key &lt;key&gt; to &lt;operation&gt;. This means that whenever &lt;key&gt; is preseed, then &lt;operation&gt; is executed (if applicable in the current context). A list of available operations can be found below.
 
117
    </td><td style="border-bottom: 1px solid ; " align="left">
 
118
    bind-key ^r reload-all
 
119
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
120
    unbind-key
 
121
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
122
    &lt;key&gt;
 
123
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
124
    
 
125
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
126
    Unbind key &lt;key&gt;. This means that no operation is called when &lt;key&gt; is pressed.
 
127
    </td><td style="border-bottom: 1px solid ; " align="left">
 
128
    unbind-key R
 
129
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
130
    use-proxy
 
131
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
132
    [yes/no]
 
133
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
134
    no
 
135
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
136
    If yes, then the configured proxy will be used for downloading the RSS feeds.
 
137
    </td><td style="border-bottom: 1px solid ; " align="left">
 
138
    use-proxy yes
 
139
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
140
    proxy
 
141
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
142
    &lt;server:port&gt;
 
143
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
144
    
 
145
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
146
    Set the proxy to use for downloading RSS feeds.
 
147
    </td><td style="border-bottom: 1px solid ; " align="left">
 
148
    proxy localhost:3128
 
149
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
150
    proxy-auth
 
151
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
152
    &lt;auth&gt;
 
153
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
154
    
 
155
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
156
    Set the proxy authentication string.
 
157
    </td><td style="border-bottom: 1px solid ; " align="left">
 
158
    proxy-auth user:password
 
159
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
160
    color
 
161
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
162
    &lt;element&gt; &lt;fgcolor&gt; &lt;bgcolor&gt; [&lt;attr&gt; …]
 
163
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
164
    
 
165
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
166
    Set the foreground color, background color and optional attributes for a certain element
 
167
    </td><td style="border-bottom: 1px solid ; " align="left">
 
168
    color background white black
 
169
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
170
    auto-reload
 
171
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
172
    [yes/no]
 
173
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
174
    no
 
175
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
176
    If enabled, all feeds will be automatically reloaded at start up and then continuously after a certain time has passed (see reload-time).
 
177
    </td><td style="border-bottom: 1px solid ; " align="left">
 
178
    auto-reload yes
 
179
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
180
    reload-time
 
181
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
182
    &lt;number&gt;
 
183
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
184
    30
 
185
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
186
    The number of minutes between automatic reloads.
 
187
    </td><td style="border-bottom: 1px solid ; " align="left">
 
188
    reload-time 60
 
189
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
190
    save-path
 
191
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
192
    &lt;path&gt;
 
193
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
194
    ~/
 
195
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
196
    The default path where articles shall be saved to. If an invalid path is specified, the current directory is used.
 
197
    </td><td style="border-bottom: 1px solid ; " align="left">
 
198
    save-path "~/Saved Articles"
 
199
    </td></tr><tr><td style="border-right: 1px solid ; " align="left">
 
200
    podcast-auto-enqueue
 
201
    </td><td style="border-right: 1px solid ; " align="left">
 
202
    [yes/no]
 
203
    </td><td style="border-right: 1px solid ; " align="left">
 
204
    no
 
205
    </td><td style="border-right: 1px solid ; " align="left">
 
206
    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.
 
207
    </td><td style="" align="left">
 
208
    podcast-auto-enqueue yes
 
209
    </td></tr></tbody></table></div><div class="table"><a id="id2457126"></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">
 
210
    Operation
 
211
    </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
212
    Default key
 
213
    </th><th style="border-bottom: 1px solid ; " align="left">
 
214
    Description
 
215
    </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
216
    quit
 
217
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
218
    q
 
219
    </td><td style="border-bottom: 1px solid ; " align="left">
 
220
    Quit the program or return to the previous dialog (depending on the context).
 
221
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
222
    reload
 
223
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
224
    r
 
225
    </td><td style="border-bottom: 1px solid ; " align="left">
 
226
    Reload the currently selected feed.
 
227
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
228
    reload-all
 
229
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
230
    R
 
231
    </td><td style="border-bottom: 1px solid ; " align="left">
 
232
    Reload all feeds.
 
233
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
234
    mark-feed-read
 
235
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
236
    A
 
237
    </td><td style="border-bottom: 1px solid ; " align="left">
 
238
    Mark all articles in the currently selected feed read.
 
239
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
240
    mark-all-feeds-read
 
241
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
242
    C
 
243
    </td><td style="border-bottom: 1px solid ; " align="left">
 
244
    Mark articles in all feeds read.
 
245
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
246
    open
 
247
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
248
    Enter
 
249
    </td><td style="border-bottom: 1px solid ; " align="left">
 
250
    Open the currently selected feed or article.
 
251
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
252
    save
 
253
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
254
    s
 
255
    </td><td style="border-bottom: 1px solid ; " align="left">
 
256
    Save the currently selected article to a file.
 
257
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
258
    next-unread
 
259
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
260
    n
 
261
    </td><td style="border-bottom: 1px solid ; " align="left">
 
262
    Jump to the next unread article.
 
263
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
264
    open-in-browser
 
265
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
266
    o
 
267
    </td><td style="border-bottom: 1px solid ; " align="left">
 
268
    Opens the URL associated with the current article.
 
269
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
270
    toggle-source-view
 
271
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
272
    ^u
 
273
    </td><td style="border-bottom: 1px solid ; " align="left">
 
274
    Toggles between the HTML view and the source view in the article view.
 
275
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
276
    toggle-article-read
 
277
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
278
    N
 
279
    </td><td style="border-bottom: 1px solid ; " align="left">
 
280
    Toggle the read flag for the currently selected article.
 
281
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
282
    toggle-show-read-feeds
 
283
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
284
    l
 
285
    </td><td style="border-bottom: 1px solid ; " align="left">
 
286
    Toggle whether read feeds should be shown in the feed list.
 
287
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
288
    show-urls
 
289
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
290
    u
 
291
    </td><td style="border-bottom: 1px solid ; " align="left">
 
292
    Show all URLs in the article in a list (similar to urlview).
 
293
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
294
    open-search
 
295
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
296
    /
 
297
    </td><td style="border-bottom: 1px solid ; " align="left">
 
298
    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.
 
299
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
300
    select-tag
 
301
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
302
    t
 
303
    </td><td style="border-bottom: 1px solid ; " align="left">
 
304
    Select tag.
 
305
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
306
    clear-tag
 
307
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
308
    ^t
 
309
    </td><td style="border-bottom: 1px solid ; " align="left">
 
310
    Clear current tag.
 
311
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
312
    enqueue
 
313
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
314
    e
 
315
    </td><td style="border-bottom: 1px solid ; " align="left">
 
316
    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).
 
317
    </td></tr><tr><td style="border-right: 1px solid ; " align="left">
 
318
    help
 
319
    </td><td style="border-right: 1px solid ; " align="left">
 
320
    ?
 
321
    </td><td style="" align="left">
 
322
    Runs the help screen.
 
323
    </td></tr></tbody></table></div><p>Keys, as used in the bind-key configuration command, use a special syntax.
 
324
Lowercase keys, uppercase keys and special characters are written literally.
 
325
The Enter key is written as "enter", while the ESC key is written as "esc". The
 
326
function keys F1 to F12 are written as "F1" to "F12". The Space key is written
 
327
as "space". Key combinations with the Ctrl key, such as Ctrl-R, are written as
 
328
^r. Please be aware that all Ctrl-related key combinations need to be written
 
329
in lowercase ^R for Ctrl-Shift-R does not work.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2504231"></a>Example Configuration</h3></div></div></div><pre class="literallayout"># a comment
 
330
max-items        100 # such comments are possible, too
 
331
browser          links
 
332
show-read-feeds  no</pre><pre class="literallayout">unbind-key       R
 
333
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="id2504257"></a>Configuring Colors</h3></div></div></div><p>It is possible to configure custom color settings in newsbeuter. The basic configuration
 
334
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
 
335
a foreground color and a background color as a minimum. The following colors are
 
336
supported:</p><div class="itemizedlist"><ul type="disc"><li>
 
337
black
 
338
</li><li>
 
339
red
 
340
</li><li>
 
341
green
 
342
</li><li>
 
343
yellow
 
344
</li><li>
 
345
blue
 
346
</li><li>
 
347
magenta
 
348
</li><li>
 
349
cyan
 
350
</li><li>
 
351
white
 
352
</li><li>
 
353
default
 
354
</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
 
355
supported:</p><div class="itemizedlist"><ul type="disc"><li>
 
356
standout
 
357
</li><li>
 
358
underline
 
359
</li><li>
 
360
reverse
 
361
</li><li>
 
362
blink
 
363
</li><li>
 
364
dim
 
365
</li><li>
 
366
bold
 
367
</li><li>
 
368
protect
 
369
</li><li>
 
370
invis
 
371
</li></ul></div><p>Currently, the following elements are supported:</p><div class="itemizedlist"><ul type="disc"><li>
 
372
<span class="strong"><strong>listnormal</strong></span>: a normal list item
 
373
</li><li>
 
374
<span class="strong"><strong>listfocus</strong></span>: the currently selected list item
 
375
</li><li>
 
376
<span class="strong"><strong>info</strong></span>: the info bars on top and bottom
 
377
</li><li>
 
378
<span class="strong"><strong>background</strong></span>: the application background
 
379
</li><li>
 
380
<span class="strong"><strong>article</strong></span>: the article text
 
381
</li></ul></div><p>The default color configuration of newsbeuter looks like this:</p><pre class="literallayout">background   white   black
 
382
listnormal   white   black
 
383
listfocus    yellow  blue   bold
 
384
info         yellow  blue   bold
 
385
article      white   black</pre></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2504516"></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="id2504522"></a>Tagging</h3></div></div></div><p>Newsbeuter comes with the possibility to categorize or "tag", as well call it,
 
386
RSS feeds. Every RSS feed can be assigned 0 or more tags. Within newsbeuter, you
 
387
can then select to only show RSS feeds that match a certain tag. That makes it
 
388
easy to categorize your feeds in a flexible and powerful way.</p><p>Usually, the ~/.newsbeuter/urls file contains one RSS feed URL per line. To
 
389
assign a tag to an RSS feed, simply attach it as a single word, separated by
 
390
blanks such as space or tab. If the tag needs to contain spaces, you must use
 
391
quotes (") around the tag (see example below). An example ~/.newsbeuter/urls
 
392
file may look like this:</p><pre class="literallayout">http://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
 
393
http://rss.orf.at/news.xml news orf
 
394
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
 
395
a tag. When you select the tag "news", you will see all three RSS feeds. Pressing
 
396
"t" again and e.g. selecting the "conspiracy" tag, you will only see the
 
397
http://blog.fefe.de/rss.xml?html RSS feed. Pressing "^t" clears the current tag,
 
398
and again shows all RSS feeds, regardless of their assigned tags.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id2504582"></a>Podcast Support</h3></div></div></div><p>A podcast is a media file distributed over the internet using syndication feeds
 
399
such as RSS, for later playback on portable players or computers.  Newsbeuter
 
400
contains support for downloading and saving podcasts. This support differs a bit
 
401
from other podcast aggregators or "podcatchers" in how it is done.</p><p>Podcast content is transported in RSS feeds via special tags called
 
402
"enclosures". Newsbeuter recognizes these enclosures and stores the relevant
 
403
information for every podcast item it finds in an RSS feed. What the user then
 
404
can do is to add the podcast download URL to a download queue. Alternatively,
 
405
newsbeuter can be configured to automatically do that. This queue is stored in
 
406
the file $HOME/.newsbeuter/queue.</p><p>The user can then use the download manager "podbeuter" to download these files
 
407
to a directory on the local filesystem. Podbeuter comes with the newsbeuter
 
408
package, and features a look and feel very close to the one of newsbeuter. It
 
409
also shares the same configuration file.</p><div class="table"><a id="id2504621"></a><p class="title"><b>Table 3. 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">
 
410
    Configuration Command
 
411
    </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
412
    Argument(s)
 
413
    </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
414
    Default
 
415
    </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
416
    Description
 
417
    </th><th style="border-bottom: 1px solid ; " align="left">
 
418
    Example
 
419
    </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
420
    download-path
 
421
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
422
    &lt;path&gt;
 
423
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
424
    ~/
 
425
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
426
    Specifies the directory where podbeuter shall download the files to.
 
427
    </td><td style="border-bottom: 1px solid ; " align="left">
 
428
    download-path "~/Downloads"
 
429
    </td></tr><tr><td style="border-right: 1px solid ; " align="left">
 
430
    max-downloads
 
431
    </td><td style="border-right: 1px solid ; " align="left">
 
432
    &lt;number&gt;
 
433
    </td><td style="border-right: 1px solid ; " align="left">
 
434
    1
 
435
    </td><td style="border-right: 1px solid ; " align="left">
 
436
    Specifies the maximum number of parallel downloads when automatic download is enabled.
 
437
    </td><td style="" align="left">
 
438
    max-downloads 3
 
439
    </td></tr></tbody></table></div><div class="table"><a id="id2504755"></a><p class="title"><b>Table 4. 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">
 
440
    Operation
 
441
    </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
442
    Default key
 
443
    </th><th style="border-bottom: 1px solid ; " align="left">
 
444
    Description
 
445
    </th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
446
    quit
 
447
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
448
    q
 
449
    </td><td style="border-bottom: 1px solid ; " align="left">
 
450
    Quit the program.
 
451
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
452
    pb-download
 
453
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
454
    d
 
455
    </td><td style="border-bottom: 1px solid ; " align="left">
 
456
    Download the currently selected URL.
 
457
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
458
    pb-cancel
 
459
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
460
    c
 
461
    </td><td style="border-bottom: 1px solid ; " align="left">
 
462
    Cancel the currently selected download.
 
463
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
464
    pb-delete
 
465
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
466
    D
 
467
    </td><td style="border-bottom: 1px solid ; " align="left">
 
468
    Delete the currently selected URL from the queue.
 
469
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
470
    pb-purge
 
471
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
472
    P
 
473
    </td><td style="border-bottom: 1px solid ; " align="left">
 
474
    Remove all finished and deleted downloads from the queue and load URLs that were newly added to the queue.
 
475
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
476
    pb-toggle-download-all
 
477
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
478
    a
 
479
    </td><td style="border-bottom: 1px solid ; " align="left">
 
480
    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.
 
481
    </td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
482
    pb-increase-max-dls
 
483
    </td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
 
484
    +
 
485
    </td><td style="border-bottom: 1px solid ; " align="left">
 
486
    Increase the "max-downloads" option by 1.
 
487
    </td></tr><tr><td style="border-right: 1px solid ; " align="left">
 
488
    pb-decrease-max-dls
 
489
    </td><td style="border-right: 1px solid ; " align="left">
 
490
    -
 
491
    </td><td style="" align="left">
 
492
    Decrease the "max-downloads" option by 1. If the option is already 1, no further decrease is possible.
 
493
    </td></tr></tbody></table></div><p>A usual "use case" is to configure newsbeuter to automatically enqueue newly
 
494
found podcast download URLs. Then, the user reloads the podcast RSS feeds in
 
495
newsbeuter, and after that, he/she uses podbeuter to view the current queue, and
 
496
either selectively download certain files or automatically download them all
 
497
together by pressing "a" within podbeuter.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2504973"></a>Feedback</h2></div></div></div><p>If you want to tell us something related to newsbeuter, don't hesitate to send
 
498
an email: ak-newsbeuter@synflood.at</p><p>Alternatively, you can reach the newsbeuter developers on IRC: channel
 
499
#newsbeuter on irc.freenode.net.</p><p>If you want to report newsbeuter bugs, please use this issue tracker:
 
500
<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="id2505006"></a>License</h2></div></div></div><p>MIT/X Consortium License</p><p>©opyright 2006-2007 Andreas Krennmair &lt;ak@synflood.at&gt;</p><p>Permission is hereby granted, free of charge, to any person obtaining a copy of
 
501
this software and associated documentation files (the "Software"), to deal in
 
502
the Software without restriction, including without limitation the rights to
 
503
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 
504
of the Software, and to permit persons to whom the Software is furnished to do
 
505
so, subject to the following conditions:</p><p>The above copyright notice and this permission notice shall be included in all
 
506
copies or substantial portions of the Software.</p><p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
507
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
508
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 
509
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 
510
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 
511
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 
512
SOFTWARE.</p></div></div></body></html>