summaryrefslogtreecommitdiffstats
path: root/doc/xhtml/newsbeuter.html
blob: 4759fdc8e9a5fc55fc3c9e24b40c2cee4cb24de7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
<?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="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="#id2504233">Example Configuration</a></span></dt><dt><span class="section"><a href="#id2504259">Configuring Colors</a></span></dt></dl></dd><dt><span class="section"><a href="#id2504518">Advanced Features</a></span></dt><dd><dl><dt><span class="section"><a href="#id2504524">Tagging</a></span></dt><dt><span class="section"><a href="#id2504584">Podcast Support</a></span></dt></dl></dd><dt><span class="section"><a href="#id2504976">Feedback</a></span></dt><dt><span class="section"><a href="#id2505009">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
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="id2458057"></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="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
<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="id2494644"></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>
Libidn: <a href="http://www.gnu.org/software/libidn/" target="_top">http://www.gnu.org/software/libidn/</a>
</li><li>
STFL: <a href="http://www.clifford.at/stfl/" target="_top">http://www.clifford.at/stfl/</a>
</li><li>
SQLite 3: <a href="http://www.sqlite.org/" target="_top">http://www.sqlite.org/</a>
</li><li>
libmRss: <a href="http://www2.autistici.org/bakunin/libmrss/" target="_top">http://www2.autistici.org/bakunin/libmrss/</a>
</li><li>
libnXml: <a href="http://www2.autistici.org/bakunin/libnxml/" target="_top">http://www2.autistici.org/bakunin/libnxml/</a>
</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
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="id2494744"></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.3
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;
        -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".</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><div class="table"><a id="id2456331"></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