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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
|
<?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" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div xml:lang="en" class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp49817008"></a>The Newsbeuter RSS Feedreader</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Andreas</span> <span class="surname">Krennmair</span></h3><code class="email"><<a class="email" href="mailto:ak@newsbeuter.org">ak@newsbeuter.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="#_introduction">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#_platforms">1.1. Platforms</a></span></dt><dt><span class="section"><a href="#_why_newsbeuter">1.2. Why "Newsbeuter"?</a></span></dt></dl></dd><dt><span class="section"><a href="#_installation">2. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#_downloading_newsbeuter">2.1. Downloading Newsbeuter</a></span></dt><dt><span class="section"><a href="#_dependencies">2.2. Dependencies</a></span></dt><dt><span class="section"><a href="#_compiling_and_installing">2.3. Compiling and Installing</a></span></dt></dl></dd><dt><span class="section"><a href="#_first_steps">3. First Steps</a></span></dt><dd><dl><dt><span class="section"><a href="#_example_configuration">3.1. Example Configuration</a></span></dt><dt><span class="section"><a href="#_configuring_colors">3.2. Configuring Colors</a></span></dt><dt><span class="section"><a href="#_migrating_from_other_rss_feed_readers">3.3. Migrating from other RSS Feed Readers</a></span></dt></dl></dd><dt><span class="section"><a href="#_advanced_features">4. Advanced Features</a></span></dt><dd><dl><dt><span class="section"><a href="#_tagging">4.1. Tagging</a></span></dt><dt><span class="section"><a href="#_scripts_and_filters_snownews_extensions">4.2. Scripts and Filters (Snownews Extensions)</a></span></dt><dt><span class="section"><a href="#_bookmarking">4.3. Bookmarking</a></span></dt><dt><span class="section"><a href="#_command_line">4.4. Command Line</a></span></dt><dt><span class="section"><a href="#_filter_language">4.5. Filter Language</a></span></dt><dt><span class="section"><a href="#_killfiles">4.6. Killfiles</a></span></dt><dt><span class="section"><a href="#_query_feeds">4.7. Query Feeds</a></span></dt><dt><span class="section"><a href="#_google_reader_support">4.8. Google Reader Support</a></span></dt><dt><span class="section"><a href="#_the_old_reader_support">4.9. The Old Reader Support</a></span></dt><dt><span class="section"><a href="#_newsblur_support">4.10. NewsBlur Support</a></span></dt><dt><span class="section"><a href="#_feedhq_support">4.11. FeedHQ Support</a></span></dt><dt><span class="section"><a href="#_bloglines_synchronization">4.12. Bloglines Synchronization</a></span></dt><dt><span class="section"><a href="#_tiny_tiny_rss_synchronization">4.13. Tiny Tiny RSS Synchronization</a></span></dt><dt><span class="section"><a href="#_opml_online_subscription_mode">4.14. OPML Online Subscription Mode</a></span></dt><dt><span class="section"><a href="#_flagging_articles">4.15. Flagging Articles</a></span></dt><dt><span class="section"><a href="#_macro_support">4.16. Macro Support</a></span></dt><dt><span class="section"><a href="#_commandline_commands">4.17. Commandline Commands</a></span></dt><dt><span class="section"><a href="#_format_strings">4.18. Format Strings</a></span></dt><dt><span class="section"><a href="#_highlighting_text">4.19. Highlighting Text</a></span></dt><dt><span class="section"><a href="#_advanced_dialog_management">4.20. Advanced Dialog Management</a></span></dt><dt><span class="section"><a href="#_xdg_base_directory_support">4.21. XDG Base Directory Support</a></span></dt><dt><span class="section"><a href="#_podcast_support">4.22. Podcast Support</a></span></dt><dt><span class="section"><a href="#_using_sqlite_triggers_with_newsbeuter">4.23. Using SQLite Triggers with newsbeuter</a></span></dt></dl></dd><dt><span class="section"><a href="#_feedback">5. Feedback</a></span></dt><dt><span class="section"><a href="#_license">6. License</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_introduction"></a>1. Introduction</h2></div></div></div><p>Newsbeuter is an RSS/Atom feedreader. RSS and Atom are 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, FreeBSD or Mac OS X.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_platforms"></a>1.1. Platforms</h3></div></div></div><p>Newsbeuter has been tested on Linux, FreeBSD and Mac OS X, and is available in
the form of pre-built packages for many popular Linux distributions. For a current
list of distributions with newsbeuter packages, consult <a class="ulink" href="http://www.newsbeuter.org/download.html" target="_top">this list on the newsbeuter website</a>.</p><p>OpenBSD is currently unsupported, as it lacks even the most basic support for
internationalization and localization.</p><p>NetBSD is currently not supported, due to technical limitations in the iconv()
implementation.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_why_newsbeuter"></a>1.2. 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 competition that was
started when I got aware that the original name would violate French and
European registered trademarks.</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_installation"></a>2. Installation</h2></div></div></div><p>This chapter describes how to compile and install newsbeuter from source.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_downloading_newsbeuter"></a>2.1. Downloading Newsbeuter</h3></div></div></div><p>Newsbeuter is available as source package. Simply go to
<a class="ulink" href="http://www.newsbeuter.org/" target="_top">http://www.newsbeuter.org/</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 Git repository (hosted on GitHub)
by running the following command on the commandline:</p><pre class="literallayout">git clone git://github.com/akrennmair/newsbeuter.git</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_dependencies"></a>2.2. 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 class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
STFL (version 0.21 or newer): <a class="ulink" href="http://www.clifford.at/stfl/" target="_top">http://www.clifford.at/stfl/</a>
</li><li class="listitem">
SQLite 3 (version 3.5 or newer): <a class="ulink" href="http://www.sqlite.org/" target="_top">http://www.sqlite.org/</a>
</li><li class="listitem">
libcurl: <a class="ulink" href="http://curl.haxx.se/download.html" target="_top">http://curl.haxx.se/download.html</a>
</li><li class="listitem">
GNU gettext (on systems that don’t provide gettext in the libc): <a class="ulink" href="ftp://ftp.gnu.org/gnu/gettext/" target="_top">ftp://ftp.gnu.org/gnu/gettext/</a>
</li><li class="listitem">
pkg-config: <a class="ulink" href="http://pkg-config.freedesktop.org/wiki/" target="_top">http://pkg-config.freedesktop.org/wiki/</a>
</li><li class="listitem">
libxml2: <a class="ulink" href="http://xmlsoft.org/" target="_top">http://xmlsoft.org/</a>
</li></ul></div><p>If you intend to modify and regenerate the filter language parser, you will also
need Coco/R for C++, which you can download from
<a class="ulink" 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
"cococpp" in your PATH. Debian users only need to install the package
"coco-cpp". Use the "regenerate-parser" make target to regenerate the necessary
files.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_compiling_and_installing"></a>2.3. 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"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_first_steps"></a>3. 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 /home/ak/.newsbeuter/urls with RSS feed URLs or import an OPML file.</pre><pre class="literallayout">newsbeuter 2.4
usage: ./newsbeuter [-i <file>|-e] [-u <urlfile>] [-c <cachefile>] [-x <command> ...] [-h]
-e export OPML feed to stdout
-r refresh feeds on start
-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>
-X clean up cache thoroughly
-x <command>... execute list of commands
-o activate offline mode (only applies to Google Reader synchronization mode)
-q quiet startup
-v get version information
-l <loglevel> write a log with a certain loglevel (valid values: 1 to 6)
-d <logfile> use <logfile> as output log file
-E <file> export list of read articles to <file>
-I <file> import list of read articles from <file>
-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. Newsbeuter also makes
sure that usernames and passwords within URLs aren’t displayed in its user
interface. In case there is a <span class="emphasis"><em>@</em></span> in the username, you need to write it as
<span class="emphasis"><em>%40</em></span> instead so that it can be distinguished from the <span class="emphasis"><em>@</em></span> that separates the
username/password part from the hostname part.</p><p>You can also configure local files as feeds, by prefixing the local path with
"file://" and adding it to the $HOME/.newsbeuter/urls file:</p><pre class="literallayout">file:///var/log/rss_eventlog.xml</pre><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 "max-items" below).</p><p>Newsbeuter also uses a number of measures to preserve the users' and feed
providers' bandwidth, by trying to avoid unnecessary feed downloads through the
use of conditional HTTP downloading. It saves every feed’s "Last-Modified" and
"ETag" response header values (if present) and advises the feed’s HTTP server
to only send data if the feed has been updated by modification date/time or
"ETag" header. This doesn’t only make feed downloads for RSS feeds with no new
updates faster, it also reduces the amount of transferred data per request.
Conditional HTTP downloading can be optionally disabled per feed by using the
"always-download" configuration command.</p><p>Several aspects of newsbeuter’s behaviour can be configured via a configuration
file, by default $HOME/.newsbeuter/config. This configuration file contains
lines in the form "<config-command> <arg1> …". 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. It’s even possible to
integrate the output of external commands into the configuration. The text
between two backticks ("`") is evaluated as shell command, and its output is
put on its place instead. This works like backtick evaluation in
Bourne-compatible shells and allows users to use external information from the
system within the configuration.</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. When opening
an article from a search result dialog, the search phrase is highlighted.</p><p>The history of all your searches is saved to the filesystem, to
\~/.newsbeuter/history.search. By default, the last 100 search phrases are
stored, but this limited can be influenced through the "history-limit"
configuration variable. To disable search history saving, simply set the
history-limit to 0.</p><div class="table"><a id="idp49768544"></a><p class="title"><strong>Table 1. Configuration Commands</strong></p><div class="table-contents"><table summary="Configuration Commands" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px 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 #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Configuration Command
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Argument(s)
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Default
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Description
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Example
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
always-display-description
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[true/false]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
false
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
always-display-description true
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
always-download
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<rssurl> [<rssurl>]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
The parameters of this configuration command are one or more RSS URLs. These URLs will always get downloaded, regardless of their Last-Modified timestamp and ETag header.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
always-download "http://www.n-tv.de/23.rss"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article-sort-order
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<sortfield>[-<direction>]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
date
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
The sortfield specifies which article property shall be used for sorting (currently available: date, title, flags, author, link, guid). The optional direction specifies the sort direction ("asc" specifies ascending sorting, "desc" specifies descending sorting. for date, "desc" is default, for all others, "asc" is default).
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
article-sort-order author-desc
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
articlelist-format
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<format>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
"%4i %f %D %6L %?T?;%-17T; ?%t"
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
This variable defines the format of entries in the article list. See the respective section in the documentation 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 #527bbd; " align="left">
articlelist-format "%4i %f %D %?T?;%-17T; ?%t"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
auto-reload
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
auto-reload yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
bind-key
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<key> <operation> [<dialog>]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Bind key <key> to <operation>. This means that whenever <key> is pressed, then <operation> is executed (if applicable in the current dialog). A list of available operations can be found below. Optionally, you can specify a dialog. If you specify one, the key binding will only be added to the specified dialog. Available dialogs are "all" (default if none is specified), "feedlist", "filebrowser", "help", "articlelist", "article", "tagselection", "filterselection", "urlview" and "podbeuter".
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
bind-key ^R reload-all
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
bookmark-cmd
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<bookmark-command>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set, then <bookmark-command> will be used as bookmarking plugin. See the documentation on bookmarking for further information.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
bookmark-cmd "~/bin/delicious-bookmark.sh"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
bookmark-interactive
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to yes, then the configured bookmark command is an interactive program.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
bookmark-interactive yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
bookmark-autopilot
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to yes, the configured bookmark command is executed without any further input asked from user, uless the url or the title cannot be found/guessed.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
bookmark-autopilot yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
browser
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<browser-command>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
lynx
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Set the browser command to use when opening an article in the browser. If <browser-command> contains %u, it will be used as complete commandline and %u will be replaced with the URL that shall be opened.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
browser "w3m %u"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
cache-file
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<path>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
"~/.newsbeuter/cache.db"
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
cache-file "/tmp/testcache.db"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
cleanup-on-quit
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
yes
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
cleanup-on-quit no
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
color
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<element> <fgcolor> <bgcolor> [<attr> …]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Set the foreground color, background color and optional attributes for a certain element
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
color background white black
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
confirm-exit
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
confirm-exit yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
cookie-cache
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<file>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Set a cookie cache. If set, then cookies will be cached (i.e. read from and written to) in this file.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
cookie-cache "~/.newsbeuter/cookies.txt"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
datetime-format
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<date/time format>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
%b %d
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
datetime-format "%D, %R"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
define-filter
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<name> <filter>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
With this command, you can predefine filters, which you can 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 #527bbd; " 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 #527bbd; border-bottom: 1px solid #527bbd; " align="left">
delete-read-articles-on-quit
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
"no"
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to "yes", then all read articles will be deleted when you quit newsbeuter.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
delete-read-articles-on-quit yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
display-article-progress
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
yes
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to yes, then a read progress (in percent) is displayed in the article view. Otherwise, no read progress is displayed.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
display-article-progress no
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
download-retries
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<number retries>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
1
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
How many times newsbeuter shall try to successfully download a feed before giving up. This is an option to improve the success of downloads on slow and shaky connections such as via a TOR proxy.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
download-retries 4
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
download-full-page
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to yes, then for all feed items with no content but with a link, the link is downloaded and the result used as content instead. This may significantly increase the download times of "empty" feeds.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
download-full-page yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
download-timeout
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<seconds>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
30
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
The number of seconds newsbeuter shall wait when downloading a feed before giving up. This is an option to improve the success of downloads on slow and shaky connections such as via a TOR proxy.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
download-timeout 60
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
error-log
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<path>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
error-log "~/.newsbeuter/error.log"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
external-url-viewer
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<command>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set, then "show-urls" will pipe the current article to a specific external tool instead of using the internal URL viewer. This can be used to integrate tools such as urlview.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
external-url-viewer "urlview"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feed-sort-order
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<sortorder>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
none
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to "firsttag", the feeds in the feed list will be sorted by their first tag in the urls file.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
feed-sort-order firsttag
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedlist-format
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<format>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
"%4i %n %11u %t"
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
This variable defines the format of entries in the feed list. See the respective section in the documentation for more information on format strings.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
feedlist-format " %n %4i - %11u -%> %t"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
oldreader-flag-share
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<flag>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If this is set and The Old Reader support is used, then all articles that are flagged with the specified flag are being "shared" in The Old Reader so that people that follow you can see it.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
oldreader-flag-share "a"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
oldreader-flag-star
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<flag>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If this is set and The Old Reader support is used, then all articles that are flagged with the specified flag are being "starred" in The Old Reader and appear in the list of "Starred items".
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
oldreader-flag-star "b"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
oldreader-login
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<login>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
This variable sets your The Old Reader login for The Older Reader support.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
oldreader-login "your-login"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
oldreader-min-items
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<number>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
20
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
This variable sets the number of articles that are loaded from The Old Reader per feed.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
oldreader-min-items 100
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
oldreader-password
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<password>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
This variable sets your The Old Reader password for The Old Reader support.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
oldreader-password "your-password"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
oldreader-passwordfile
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<path-to-file
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
A more secure alternative to the above, by storing your password elsewhere in your system.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
oldreader-passwordfile "path-to-file"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
oldreader-show-special-feeds
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
yes
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If this is set, then "special feeds" like "People you follow" (articles shared by people you follow), "Starred items" (your starred articles) and "Shared items" (your shared articles) appear in your subscription list.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
oldreader-show-special-feeds "no"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedhq-flag-share
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<flag>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If this is set and FeedHQ support is used, then all articles that are flagged with the specified flag are being "shared" in FeedHQ so that people that follow you can see it.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
feedhq-flag-share "a"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedhq-flag-star
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<flag>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If this is set and FeedHQ support is used, then all articles that are flagged with the specified flag are being "starred" in FeedHQ and appear in the list of "Starred items".
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
feedhq-flag-star "b"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedhq-login
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<login>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
This variable sets your FeedHQ login for FeedHQ support.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
feedhq-login "your-login"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedhq-min-items
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<number>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
20
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
This variable sets the number of articles that are loaded from FeedHQ per feed.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
feedhq-min-items 100
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedhq-password
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<password>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
This variable sets your FeedHQ password for FeedHQ support.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
feedhq-password "your-password"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedhq-passwordfile
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<path-to-file
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
A more secure alternative to the above, by storing your password elsewhere in your system.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
feedhq-passwordfile "path-to-file"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedhq-show-special-feeds
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
yes
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If this is set, then "special feeds" like "People you follow" (articles shared by people you follow), "Starred items" (your starred articles) and "Shared items" (your shared articles) appear in your subscription list.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
feedhq-show-special-feeds "no"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
goto-first-unread
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
yes
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to yes (the default), then the first unread article will be selected whenever a feed is entered.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
goto-first-unread no
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
goto-next-feed
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
yes
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to yes, then the next-unread and prev-unread keys will search in other feeds for unread articles if all articles in the current feed are read. If set to no, then the next-unread and prev-unread keys will stop in the current feed.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
goto-next-feed no
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
highlight
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<target> <regex> <fgcolor> [<bgcolor> [<attribute> …]]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
With this command, you can highlight text parts in the feed list, the article list and the article view. For a detailed documentation, see the chapter on highlighting.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
highlight all "newsbeuter" red
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
highlight-article
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<filterexpr> <fgcolor> <bgcolor> [<attribute> …]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
With this command, you can highlight articles in the article list if they match a filter expression. For a detailed documentation, see the chapter on highlighting.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
highlight-article "author =~ \"Andreas Krennmair\"" white red bold
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
history-limit
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<number>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
100
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Defines the maximum number of entries of commandline resp. search history to be saved. To disable history saving, set history-limit to 0.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
history-limit 0
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
html-renderer
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<path>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
internal
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
html-renderer "w3m -dump -T text/html"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
http-auth-method
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<method>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
any
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Set HTTP authentication method. Allowed values: any, basic, digest, digest_ie (only available with libcurl 7.19.3 and newer), gssnegotiate, ntlm, anysafe.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
http-auth-method digest
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
ignore-article
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<feed> <filterexpr>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
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.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
ignore-article "*" "title =~ \"Windows\""
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
ignore-mode
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[download/display]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
download
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
This configuration option defines in what way an article is ignored (see ignore-article). If set to "download", then it is ignored in the download/parsing phase (which is the default) and thus never written to the cache, if it set to "display", it is ignored when displaying articles but is kept in the cache.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
ignore-mode "display"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
include
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<path>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
include "~/.newsbeuter/colors"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
keep-articles-days
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<days>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
0
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set the a number greater than 0, only articles that are were published within the last <n> days are kept, and older articles are deleted. If set to 0 (default value), this option is not active.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
keep-articles-days 30
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
macro
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<macro key> <command list>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
macro k open ; reload ; quit
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
mark-as-read-on-hover
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to yes, then all articles that get selected in the article list are marked as read.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
mark-as-read-on-hover yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
max-download-speed
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<number>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
0
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to a number great than 0, the download speed per download is set to that limit (in kB).
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
max-download-speed 50
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
max-items
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<number>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
0
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
max-items 100
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
notify-format
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<string>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
"newsbeuter: finished reload, %f unread feeds (%n unread articles total)"
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Format string that is used for formatting notifications. See the chapter on format strings for more information.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
notify-format "%d new articles (%n unread articles, %f unread feeds)"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
notify-program
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<path>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set, then the configured program will be executed if new articles arrived (through a reload) or if notify-always is true. The first parameter of the called program contains the notification message.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
notify-program "~/bin/my-notifier"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
notify-always
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If no, notifications will only be made when there are new feeds or articles. If yes, notifications will be made regardless.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
notify-always yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
notify-screen
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
notify-screen yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
notify-xterm
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
notify-xterm yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
notify-beep
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If yes, then the speaker beep on new articles.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
notify-beep yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
opml-url
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<url> …
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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. Optionally, you can specify more than one URL. All the listed OPML URLs will then be taken into account when loading the feed list.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
opml-url "http://host.domain.tld/blogroll.opml" "http://example.com/anotheropmlfile.opml"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
pager
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[<path>/internal]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
internal
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If set to "internal", then the internal pager will be used. Otherwise, the article to be displayed will be rendered to be a temporary file and then displayed with the configured pager. If the pager path is set to an empty string, the content of the "PAGER" environment variable will be used. If the pager path contains a placeholder "%f", it will be replaced with the temporary filename.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
less %f
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
podcast-auto-enqueue
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If yes, then all podcast URLs that are found in articles are added to the podcast download queue. See the respective section in the documentation for more information on podcast support in newsbeuter.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
podcast-auto-enqueue yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
prepopulate-query-feeds
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If yes, then all query feeds are prepopulated with articles on startup.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
prepopulate-query-feeds yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
proxy
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<server:port>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Set the proxy to use for downloading RSS feeds.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
proxy localhost:3128
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
proxy-auth
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<auth>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Set the proxy authentication string.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
proxy-auth user:password
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
proxy-auth-method
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<method>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
any
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Set proxy authentication method. Allowed values: any, basic, digest, digest_ie (only available with libcurl 7.19.3 and newer), gssnegotiate, ntlm, anysafe.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
proxy-auth-method ntlm
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
proxy-type
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<type>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
http
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Set proxy type. Allowed values: http, socks4, socks4a, socks5.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
proxy-type socks5
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
refresh-on-startup
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
refresh-on-startup yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
reload-only-visible-feeds
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If yes, then manually reloading all feeds will only reload the currently visible feeds, e.g. if a filter or a tag is set.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
reload-only-visible-feeds yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
reload-time
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<number>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
60
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
The number of minutes between automatic reloads.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
reload-time 120
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
reload-threads
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<number>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
1
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
The number of parallel reload threads that shall be started when all feeds are reloaded.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
reload-threads 3
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
reset-unread-on-update
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<url> …
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
With this configuration command, you can provide a list of RSS feed URLs for whose articles the unread flag will be reset if an article has been updated, i.e. its content has been changed. This is especially useful for RSS feeds where single articles are updated after publication, and you want to be notified of the updates.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
reset-unread-on-update "http://blog.fefe.de/rss.xml?html"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
save-path
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<path>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
~/
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
save-path "~/Saved Articles"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
search-highlight-colors
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<fgcolor> <bgcolor> [<attribute> …]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
black yellow bold
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
This configuration command specifies the highlighting colors when searching for text from the article view.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
search-highlight-colors white black bold
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
show-keymap-hint
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
yes
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If no, then the keymap hints on the bottom of screen will not be displayed.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
show-keymap-hint no
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
show-read-feeds
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
yes
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
show-read-feeds no
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
show-read-articles
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
yes
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If yes, then all articles of a feed are listed in the article list. If no, then only unread articles are listed.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
show-read-articles no
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
suppress-first-reload
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
suppress-first-reload yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
swap-title-and-hints
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If yes, then the title at the top of screen and keymap hints at the bottom of screen will be swapped.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
swap-title-and-hints yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
text-width
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<number>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
0
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
text-width 72
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
ttrss-flag-publish
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<character>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If this is set and Tiny Tiny RSS support is used, then all articles that are flagged with the specified flag are being marked as "published" in Tiny Tiny RSS.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
ttrss-flag-publish "b"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
ttrss-flag-star
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<character>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If this is set and Tiny Tiny RSS support is used, then all articles that are flagged with the specified flag are being "starred" in Tiny Tiny RSS.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
ttrss-flag-star "a"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
ttrss-login
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<username>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Sets the username for use with Tiny Tiny RSS.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
ttrss-login "admin"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
ttrss-mode
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[multi/single]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
multi
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Configures the mode in which Tiny Tiny RSS is used. In single-user mode, login and password are used for HTTP authentication, while in multi-user mode, they are used for authenticating with Tiny Tiny RSS.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
ttrss-mode "single"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
ttrss-password
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<password>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Configures the password for use with Tiny Tiny RSS.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
ttrss-password "mypassword"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
ttrss-passwordfile
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<path-to-file
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
A more secure alternative to the above, by storing your password elsewhere in your system.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
ttrss-passwordfile "path-to-file"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
ttrss-url
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<url>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Configures the URL where the Tiny Tiny RSS installation you want to use resides.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
ttrss-url "http://example.com/ttrss/"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
unbind-key
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<key> [<dialog>]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Unbind key <key>. This means that no operation is called when <key> is pressed. Optionally, you can specify a dialog (for a list of available dialogs, see "bind-key" above). If you specify one, the key binding will only be unbound for the specified dialog.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
unbind-key R
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
urls-source
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<source>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
"local"
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 "opml", which enables newsbeuter’s OPML online subscription mode, to "ttrss" which enables newsbeuter’s Tiny Tiny RSS support, to "oldreader", which enables newsbeuter’s The Old Reader support, to "newsblur", which enables NewsBlur support, or "feedhq" for FeedHQ support.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
urls-source "oldreader"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
use-proxy
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
[yes/no]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
no
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
If yes, then the configured proxy will be used for downloading the RSS feeds.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
use-proxy yes
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
user-agent
</td><td style="border-right: 1px solid #527bbd; " align="left">
<user agent string>
</td><td style="border-right: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; " 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><br class="table-break" /><div class="table"><a id="idp56740448"></a><p class="title"><strong>Table 2. Available Operations</strong></p><div class="table-contents"><table summary="Available Operations" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Operation
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Default key
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Description
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
open
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
ENTER
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Open the currently selected feed or article.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
quit
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
q
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Quit the program or return to the previous dialog (depending on the context).
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
reload
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
r
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Reload the currently selected feed.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
reload-all
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
R
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Reload all feeds.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
mark-feed-read
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
A
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Mark all articles in the currently selected feed read.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
mark-all-feeds-read
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
C
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Mark articles in all feeds read.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
save
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
s
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Save the currently selected article to a file.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
next-unread
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Jump to the next unread article.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
prev-unread
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
p
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Jump to the previous unread article.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
next
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
J
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Jump to next article.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
prev
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
K
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Jump to previous article.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
random-unread
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^K
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Jump to a random unread article.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
open-in-browser
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
o
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Opens the URL associated with the current article.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
open-in-browser-and-mark-read
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
O
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Opens the URL associated with the current article and marks the article as read.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
help
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
?
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Runs the help screen.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
toggle-source-view
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^U
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Toggles between the HTML view and the source view in the article view.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
toggle-article-read
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
N
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Toggle the read flag for the currently selected article.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
toggle-show-read-feeds
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
l
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Toggle whether read feeds should be shown in the feed list.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
show-urls
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
u
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Show all URLs in the article in a list (similar to urlview).
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
clear-tag
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^T
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Clear current tag.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
set-tag
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
t
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Select tag.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
open-search
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
/
</td><td style="border-bottom: 1px solid #527bbd; " 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 #527bbd; border-bottom: 1px solid #527bbd; " align="left">
goto-url
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
#
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Open the URL dialog and then opens specified URL.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
enqueue
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
e
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Add the podcast download URL of the current article (if any is found) to the podcast download queue (see the respective section in the documentation for more information on podcast support).
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
edit-urls
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
E
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Edit the list of subscribed URLs. newsbeuter will start the editor configured through the $VISUAL environment variable (if unset, $EDITOR is used; fallback
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
reload-urls
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^R
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Reload the URLs configuration file.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
redraw
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^L
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Redraw the screen.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
cmdline
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<colon>
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Open the command line.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
set-filter
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
F
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Set a filter.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
select-filter
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
f
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Select a predefined filter.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
clear-filter
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^F
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Clear currently set filter.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
bookmark
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^B
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Bookmark currently selected article or URL.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
edit-flags
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^E
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Edit the flags of the currently selected article.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
next-unread-feed
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^N
</td><td style="border-bottom: 1px solid #527bbd; " 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 #527bbd; border-bottom: 1px solid #527bbd; " align="left">
prev-unread-feed
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^P
</td><td style="border-bottom: 1px solid #527bbd; " 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 #527bbd; border-bottom: 1px solid #527bbd; " align="left">
next-feed
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
j
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Go to the next feed. This only works from the article list.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
prev-feed
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
k
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Go to the previous feed. This only works from the article list.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
delete-article
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
D
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Delete the currently selected article.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
purge-deleted
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
$
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Purge all article that are marked as deleted from the article list.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
view-dialogs
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
v
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
View list of open dialogs.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
close-dialog
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^X
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Close currently selected dialog.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
next-dialog
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^V
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Go to next dialog.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
prev-dialog
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
^G
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Go to previous dialog.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
pipe-to
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
|
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Pipe article to command.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
sort
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
g
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Sort feeds/articles by interactively choosing the sort method.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
revsort
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
G
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Sort feeds/articles by interactively choosing the sort method (reversed).
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
up
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
UP
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Goes up one item in the list.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
down
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
DOWN
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Goes down one item in the list.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
pageup
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
PPAGE
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Goes up one page in the list.
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
pagedown
</td><td style="border-right: 1px solid #527bbd; " align="left">
NPAGE
</td><td style="" align="left">
Goes down one page in the list.
</td></tr></tbody></table></div></div><br class="table-break" /><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 class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
ENTER (Enter key)
</li><li class="listitem">
BACKSPACE (backspace key)
</li><li class="listitem">
LEFT (left cursor)
</li><li class="listitem">
RIGHT (right cursor)
</li><li class="listitem">
UP (up cursor)
</li><li class="listitem">
PPAGE (page up cursor)
</li><li class="listitem">
NPAGE (page down cursor)
</li><li class="listitem">
DOWN (down cursor)
</li><li class="listitem">
ESC (Esc key)
</li></ul></div><p>The "Tab" key can’t be bound due to technical limitations of STFL.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_example_configuration"></a>3.1. 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"><div class="titlepage"><div><div><h3 class="title"><a id="_configuring_colors"></a>3.2. 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 <element> <foreground color> <background color> [<attribute> ...]</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 class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
black
</li><li class="listitem">
red
</li><li class="listitem">
green
</li><li class="listitem">
yellow
</li><li class="listitem">
blue
</li><li class="listitem">
magenta
</li><li class="listitem">
cyan
</li><li class="listitem">
white
</li><li class="listitem">
default
</li><li class="listitem">
color<n>, e.g. color123
</li></ul></div><p>The "default" color means that the terminal’s default color will be used. The
"color<n>" color name can be used if your terminal support 256 colors (e.g.
gnome-terminal, xterm with $TERM set to xterm-256color). Newsbeuter contains
support for 256 color terminals since version 2.1. For a complete chart of
colors and their corresponding numbers, please see
<a class="ulink" href="http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html" target="_top">http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html</a>.</p><p>Optionally, you can also add one or more attributes. The following attributes are
supported:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
standout
</li><li class="listitem">
underline
</li><li class="listitem">
reverse
</li><li class="listitem">
blink
</li><li class="listitem">
dim
</li><li class="listitem">
bold
</li><li class="listitem">
protect
</li><li class="listitem">
invis
</li></ul></div><p>Currently, the following elements are supported:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
<span class="strong"><strong>listnormal</strong></span>: a normal list item
</li><li class="listitem">
<span class="strong"><strong>listfocus</strong></span>: the currently selected list item
</li><li class="listitem">
<span class="strong"><strong>listnormal_unread</strong></span>: an unread list item
</li><li class="listitem">
<span class="strong"><strong>listfocus_unread</strong></span>: the currently selected and unread list item
</li><li class="listitem">
<span class="strong"><strong>info</strong></span>: the info bars on top and bottom
</li><li class="listitem">
<span class="strong"><strong>background</strong></span>: the application background
</li><li class="listitem">
<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
listnormal_unread magenta black
listfocus_unread magenta blue bold
info yellow blue bold
article white black</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_migrating_from_other_rss_feed_readers"></a>3.3. 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 items 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 > ~/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"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_advanced_features"></a>4. Advanced Features</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_tagging"></a>4.1. Tagging</h3></div></div></div><p>Newsbeuter comes with the possibility to categorize or "tag", as we 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 ~/.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:</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
<a class="ulink" href="http://blog.fefe.de/rss.xml?html" target="_top">http://blog.fefe.de/rss.xml?html</a> 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 ("~"). 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:</p><pre class="literallayout">http://rss.orf.at/news.xml "~ORF News"</pre><p>Another special type of tag are tags that start with the exclamation mark. When
such a tag is found, the feed is hidden from the regular list of feeds and its
content can only be found through a query feed.</p><pre class="literallayout">http://rss.orf.at/news.xml "!ORF News (hidden)"</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_scripts_and_filters_snownews_extensions"></a>4.2. 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 class="ulink" 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 class="ulink" 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"><div class="titlepage"><div><div><h3 class="title"><a id="_bookmarking"></a>4.3. 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"><div class="titlepage"><div><div><h3 class="title"><a id="_command_line"></a>4.4. 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. The history of all the commands that you enter will be saved to
\~/.newsbeuter/history.cmdline. The backlog is limited to 100 entries by default,
but can be influenced by setting the "history-limit" configuration variable.
To disable history saving, set the history-limit to 0.</p><p>Starting with newsbeuter 2.0, the commandline provides you with some help if
you can’t remember the full names of commandline commands. By pressing the TAB
key, newsbeuter will try to automatically complete your command. If there is
more than one possible completion, you can subsequently press the TAB key to
cycle through all results. If no match is found, no suggestion will be inserted
into the commandline. For the "set" command, the completion also works for
configuration variable names.</p><p>In addition, some common key combination such as Ctrl-G (to cancel input),
Ctrl-K (to delete text from the cursor position to the end of line), Ctrl-U (to
clear the whole line) and Ctrl-W (to delete the word before the current cursor
position) were added.</p><p>Please be aware that the input history of both the command line and the search
functions are saved to the filesystems, to the files
~/.newsbeuter/history.cmdline resp. \~/.newsbeuter/history.search. By default,
the last 100 entries are saved, but this can be configured (configuration
variable history-limit) and also totally disabled (by setting said variable to
0).</p><p>Currently, the following command line commands are available:</p><div class="table"><a id="idp56927968"></a><p class="title"><strong>Table 3. Available Commandline Commands</strong></p><div class="table-contents"><table summary="Available Commandline Commands" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Command
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Syntax
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Description
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Example
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
quit
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
quit
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Quit newsbeuter.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
quit
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
save
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
save <filename>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
save ~/important.txt
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
set
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
set <variable>[=<value>|&|!]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Set configuration variable <variable> to <value>. If no value is specified, the current value is printed out. Specifying a <span class="emphasis"><em>!</em></span> after the name of boolean configuration variables toggles their values, a <span class="emphasis"><em>&</em></span> directly after the name of a configuration variable of any type resets its value to the documented default value.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
set reload-time=15
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
tag
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
tag <tagname>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Only display feeds with the tag <tagname>.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
tag news
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
goto
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
goto <case-insensitive substring>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Go to the next feed whose name contains the case-insensitive substring.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
goto foo
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
source
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
source <filename> […]
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Load the specified configuration files. This allows it to load alternative configuration files or reload already loaded configuration files on-the-fly from the filesystem.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
source ~/.newsbeuter/colors
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
dumpconfig
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
dumpconfig <filename>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Save current internal state of configuration to file, so that it can be instantly reused as configuration file.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
dumpconfig ~/.newsbeuter/config.saved
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
dumpform
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
dumpform
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Dump current dialog to text file. This is meant for debugging purposes only.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
dumpform
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
n/a
</td><td style="border-right: 1px solid #527bbd; " align="left">
<number>
</td><td style="border-right: 1px solid #527bbd; " align="left">
Jump to the entry with the index <number> (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><br class="table-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_filter_language"></a>4.5. 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 > 0
rssurl =~ "^https:"
age between 0:10</pre><p>Logically connecting and grouping such expressions looks like in the
following examples:</p><pre class="literallayout">( unread_count > 0 and unread_count < 10 ) or total_count > 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="idp56964240"></a><p class="title"><strong>Table 4. Available Comparison Operators</strong></p><div class="table-contents"><table summary="Available Comparison Operators" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Operator
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Meaning
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
=
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
test for equality ("==" works, too)
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
!=
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
test for inequality; logical negation of = operator
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
=~
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
test whether regular expression matches
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
!~
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
logical negation of the =~ operator
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
less than
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
>
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
greater than
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
⇐
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
less than or equal
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
>=
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
greater than or equal
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
between
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
within a range of integer values, where the two integer values are separated by a colon (see above for an example)
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
#
</td><td style="border-bottom: 1px solid #527bbd; " 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 #527bbd; " align="left">
!#
</td><td style="" align="left">
contains not; the negation of the # operator
</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idp56983984"></a><p class="title"><strong>Table 5. Available Attributes</strong></p><div class="table-contents"><table summary="Available Attributes" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Attribute
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Context
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Meaning
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
title
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
article title
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
link
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
article link
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
author
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
article author
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
content
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
article body
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
date
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
publication date of the article
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
guid
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
a unique identifier of the article
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
unread
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
indicates whether the article has been read
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
enclosure_url
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
the URL of a possible enclosure (e.g. podcast file)
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
enclosure_type
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
the MIME type of the enclosure URL
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
flags
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
The set of flags of the article
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
age
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Age of an article (in days)
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
articleindex
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Index of an article in an article list
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedtitle
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feed, article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
title of the feed
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
description
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feed, article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
feed description
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedlink
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feed, article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
link to the feed
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feeddate
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feed, article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
publication date of the feed
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
rssurl
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feed, article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
RSS URL of the feed
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
unread_count
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feed, article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
number of unread articles in the feed
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
total_count
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feed, article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
total number of articles in the feed
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
tags
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feed, article
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
all tags that are associated with the feed
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
feedindex
</td><td style="border-right: 1px solid #527bbd; " align="left">
feed, article
</td><td style="" align="left">
Index of a feed in the feed list
</td></tr></tbody></table></div></div><br class="table-break" /><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"><div class="titlepage"><div><div><h3 class="title"><a id="_killfiles"></a>4.6. 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><p>Since newsbeuter 2.2, you can specify the way an article is ignored. There are
two ways available:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
During download: articles are ignored when a feed is downloaded and parsed,
and thus won’t be written to the local cache.
</li><li class="listitem">
During display: articles are downloaded and written to the local cache, but
are ignored when a feed is displayed.
</li></ul></div><p>Both modes have their advantages and disadvantages: while the download ignore
mode saves some storage, you cannot simply "undo" the ignore by removing it
from the configuration file: if an ignored article has already vanished from a
feed, it won’t reappear. On the other hand, the display ignore mode requires
some more space, but has the advantage that an ignore can be "undone" by
removing the ignore-article configuration command from the configuration.</p><p>The default ignore mode is "download". You can set the ignore mode in the
configuration file:</p><pre class="literallayout">ignore-mode "display"</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_query_feeds"></a>4.7. 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:<name of feed>:<filter expression> [<tag> ...]</pre><p>The "query:" in the beginning tells newsbeuter that it’s a query feed, "<name of
feed>" specifies the name under which the query feed shall be displayed in the
feed list, and "<filter expression>" 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 <a class="ulink" href="http://domain1.tld/feed.xml" target="_top">http://domain1.tld/feed.xml</a> and
<a class="ulink" href="http://domain2.tld/?feed.rss" target="_top">http://domain2.tld/?feed.rss</a> are aggregated into the query feed named "tag1
Articles", but the feed <a class="ulink" href="http://domain3.tld/feeds.rss" target="_top">http://domain3.tld/feeds.rss</a> 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"><div class="titlepage"><div><div><h3 class="title"><a id="_google_reader_support"></a>4.8. Google Reader Support</h3></div></div></div><p>Since version 2.2, newsbeuter contained support for Google Reader. After Google
Reader was discontinued by Google, Google Reader support was subsequently
removed from newsbeuter and replaced with support for alternatives such as The
Old Reader, NewsBlur and FeedHQ.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_the_old_reader_support"></a>4.9. The Old Reader Support</h3></div></div></div><p><a class="ulink" href="http://theoldreader.com/" target="_top">The Old Reader</a> is a successor to Google Reader.
Newsbeuter provides functionality to use The Old Reader as its
backend: people can use The Old Reader to manage their subscriptions, and in
addition, use newsbeuter to download and read articles. Newsbeuter will keep
the information which articles have already been read synchronized with The Old
Reader, so that users usually won’t see articles more than once. In addition, it
will only ever download unread articles from The Old Reader.</p><p>In order to use The Old Reader support, you first need to configure the proper URL source:</p><pre class="literallayout">urls-source "oldreader"</pre><p>In addition, newsbeuter needs to know your The Old Reader username and password
so that it can authenticate with The Old Reader:</p><pre class="literallayout">oldreader-login "your-oldreader-account"
oldreader-password "your-password"</pre><p>After setting these configuration values, you can start newsbeuter, it will
authenticate with The Old Reader and download your subscription list. If you use
"folders" in The Old Reader to organize your feeds, newsbeuter will regard them
and make them available via its "tags" capability: each feed is tagged with the
name of the folder in which it resides.</p><p>When you mark single items or complete feeds as read, newsbeuter will
synchronize this information directly to The Old Reader. This, of course,
includes opening articles. Toggling read articles back to "unread" is also
communicated to The Old Reader.</p><p>In addition, The Old Reader provides the ability to "star" and to "share"
articles. Starred articles are basically bookmarks, while shared articles are
shown to people that follow your The Old Reader account. Newsbeuter allows the
use of this feature by mapping its powerful "flags" to the "star"/"unstar"
resp. "share"/"unshare" operations.</p><p>In order to use this mapping, all you need to do is to configure the flags
that shall be used:</p><pre class="literallayout">oldreader-flag-share "a"
oldreader-flag-star "b"</pre><p>After that, use these flags when you edit flags for an article, and these
articles will be starred resp. shared.</p><p>By default, newsbeuter also shows The Old Reader "special feeds":
- People you follow: articles shared by people that you follow.
- Starred items: articles that you starred.
- Shared items: articles that you shared.</p><p>You can disable these feeds by setting the following configuration variable:</p><pre class="literallayout">oldreader-show-special-feeds no</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_newsblur_support"></a>4.10. NewsBlur Support</h3></div></div></div><p>Newsbeuter also supports NewsBlur, another alternative to Google Reader.
Configuration basically works the same as with The Old Reader.</p><p>First, set your urls-source:</p><pre class="literallayout">urls-source "newsblur"</pre><p>Then, configure your NewsBlur credentials:</p><pre class="literallayout">newsblur-login "your-newsblur-account"
newsblur-password "your-password"</pre><p>When you start newsbeuter, it will download the feeds that you configured
in NewsBlur. Please take a closer look at the configuration commands for what
you can configure in newsbeuter regarding NewsBlur.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_feedhq_support"></a>4.11. FeedHQ Support</h3></div></div></div><p>Newsbeuter also supports FeedHQ, another alternative to Google Reader.
Configuration basically works the same as with The Old Reader.</p><p>First, set your urls-source:</p><pre class="literallayout">urls-source "feedhq"</pre><p>Then, configure your FeedHQ credentials:</p><pre class="literallayout">feedhq-login "your-feedhq-account"
feedhq-password "your-password"</pre><p>When you start newsbeuter, it will download the feeds that you configured
in FeedHQ. Please take a closer look at the configuration commands for what
you can configure in newsbeuter regarding FeedHQ.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_bloglines_synchronization"></a>4.12. Bloglines Synchronization</h3></div></div></div><p>Up to and including version 2.3, newsbeuter contained support for synchronization
with Bloglines. On October 1, 2010, Bloglines was discontinued, and newsbeuter’s
support for Bloglines was subsequently removed.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_tiny_tiny_rss_synchronization"></a>4.13. Tiny Tiny RSS Synchronization</h3></div></div></div><p>Since version 2.5, newsbeuter can be used to synchronize with Tiny Tiny RSS
installations. Tiny Tiny RSS is a web-based and (optionally) multi-user feed
reader. By providing the ability to use Tiny Tiny RSS as its backend, it’s
possible for users to manage their subscriptions centrally within Tiny Tiny RSS
while reading them wherever they are using newsbeuter.</p><p>If you want to use Tiny Tiny RSS support, don’t forget to activate the external
API support in your preferences.</p><p>To use Tiny Tiny RSS support, you need to configure a few things. First of all,
newsbeuter needs to know that you want to use Tiny Tiny RSS and which
installation exactly:</p><pre class="literallayout">urls-source "ttrss"
ttrss-url "http://example.com/ttrss/"</pre><p>In addition, it requires username and password for authentication:</p><pre class="literallayout">ttrss-login "myusername"
ttrss-password "mypassword"</pre><p>Tiny Tiny RSS provides two modes of usage, single-user mode and multi-user
mode. newsbeuter needs to know about this, too: In single-user mode,
authentication is done via Basic HTTP authentication, while in multi-user mode,
authentication is done against Tiny Tiny RSS itself.</p><pre class="literallayout">ttrss-mode "single" # "multi" is default</pre><p>With these settings, newsbeuter should be able to connect to Tiny Tiny RSS and
download your subscribed feeds. Articles or even complete feeds that you marked
as read are synchronized directly to Tiny Tiny RSS.</p><p>Tiny Tiny RSS provides the ability to "star" and to "publish" articles. Starred
articles are basically bookmarks, while published articles can be retrieved via
a pubic RSS feed. Newsbeuter allows the use of these features by mapping its
flags to the "star" and "publish" operations.</p><p>In order to use this mapping, you need to configure the flags that shall be used:</p><pre class="literallayout">ttrss-flag-star "s"
ttrss-flag-publish "p"</pre><p>After that, use these flags when you edit flags for an article, and these articles
will be starred resp. published.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_opml_online_subscription_mode"></a>4.14. OPML Online Subscription Mode</h3></div></div></div><p>The OPML online subscription mode works similar to the Google Reader
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 one or more OPML files that are 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 "<opml url>" ["<opml url>" ...]</pre><p>"opml" must be specified as source for the feed URLs, and the URLs of the OPML
file needs to be specified, too. As with Google Reader synchronization mode, the offline
mode via "newsbeuter -o" also works with OPML online subscription mode.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_flagging_articles"></a>4.15. 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"><div class="titlepage"><div><div><h3 class="title"><a id="_macro_support"></a>4.16. 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
macro o open-in-browser ; toggle-article-read "read"</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><p>It is also possible to modify configuration variables within macros, which can
e.g. be used to temporarily modify the browser configuration variable to do
something else, such as running an image viewer from the URLs view:</p><pre class="literallayout">macro i set browser "feh %u"; open ; set browser "elinks %u"</pre><p>You can even use this feature to enqueue any of the URLs from the URLs view to
podbeuter’s download queue:</p><pre class="literallayout">macro E set browser "echo %u >> ~/.newsbeuter/queue" ; open ; set browser "elinks %u"</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_commandline_commands"></a>4.17. Commandline Commands</h3></div></div></div><p>Newsbeuter comes with a -x option that indicates that commands added as arguments
to the command line shall be executed. Currently, the following commands are
available:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
reload: this option reloads all feeds, and quits newsbeuter without printing any output.
This is useful if a user wants to periodically reload all feeds without always having
a running newsbeuter instance, e.g. from cron.
</li><li class="listitem">
print-unread: this option prints the number of unread articles and quits newsbeuter.
This is useful for users who want to integrate this number into some kind of monitoring
system.
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_format_strings"></a>4.18. 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
"%>[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 format is the
conditional sequence, "%?[char]?[format 1]&[format 2]?": if the text of the
sequence identifier "[char]" is non-empty, then "[format 1]" will be evaluated
and inserted, otherwise "[format 2]" will be evaluated and inserted. The "&" 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="idp57111456"></a><p class="title"><strong>Table 6. Available Identifiers for feedlist-format</strong></p><div class="table-contents"><table summary="Available Identifiers for feedlist-format" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Identifier
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Meaning
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
d
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Feed description
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
i
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Feed index
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
l
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Feed link
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
L
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Feed RSS URL
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
"unread" flag field
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
S
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
download status
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
t
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Feed title
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
T
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
First tag of a feed in the URLs file
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
u
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
"unread/total" field
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
U
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
"unread" field
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
c
</td><td style="" align="left">
"total" field
</td></tr></tbody></table></div></div><br class="table-break" /><p>While a reload-all operation is running, the download status indicates the
download status of a feed, which can be "to be downloaded" (indicated by "_"),
"currently downloading" (indicated by "."), successfully downloaded (indicated
by " ") and "download error" (indicated by "x").</p><div class="table"><a id="idp57130848"></a><p class="title"><strong>Table 7. Available Identifiers for articlelist-format</strong></p><div class="table-contents"><table summary="Available Identifiers for articlelist-format" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Identifier
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Meaning
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
a
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Article author
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
D
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Publication date
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
f
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Article flags
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
i
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Article index
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
t
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Article title
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
T
</td><td style="border-bottom: 1px solid #527bbd; " 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><tr><td style="border-right: 1px solid #527bbd; " align="left">
L
</td><td style="" align="left">
Article length
</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idp57144976"></a><p class="title"><strong>Table 8. Available Identifiers for notify-format</strong></p><div class="table-contents"><table summary="Available Identifiers for notify-format" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Identifier
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Meaning
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
n
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Number of unread articles
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
f
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Number of unread feeds
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
d
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Number of new unread articles (i.e. that were added through the last reload)
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
D
</td><td style="" align="left">
Number of new unread feeds (i.e. that were added through the last reload)
</td></tr></tbody></table></div></div><br class="table-break" /><p>Examples:</p><pre class="literallayout">feedlist-format "%4i %n %11u %t"
articlelist-format "%4i %f %D %?T?|%-17T| ?%t"
notify-format "%d new articles (%n unread articles, %f unread feeds)"</pre><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_dialog_titles"></a>Dialog Titles</h4></div></div></div><p>Starting with newsbeuter 2.0, it is now officially supported to customize
the title format of all available dialogs. Here is a list of dialogs with their
respective title format configuration variables, and a list of available formats
and their meaning. Please note taht the title formats are localized, so if you
work on a different locale that is supported by newsbeuter, the actually displayed
title text may vary unless you customize it.</p><div class="table"><a id="idp57159344"></a><p class="title"><strong>Table 9. Dialog Title Formats</strong></p><div class="table-contents"><table summary="Dialog Title Formats" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Dialog
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Configuration Variable
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Default Value
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Feed List
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
feedlist-title-format
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
%N %V - Your feeds (%u unread, %t total)%?T? - tag ‘%T’&?
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Article List
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
articlelist-title-format
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
%N %V - Articles in feed <span class="emphasis"><em>%T</em></span> (%u unread, %t total) - %U
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Search Result
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
searchresult-title-format
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
%N %V - Search result (%u unread, %t total)
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
File Browser
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
filebrowser-title-format
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
%N %V - %?O?Open File&Save File? - %f
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Help
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
help-title-format
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
%N %V - Help
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Select Tag Dialog
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
selecttag-title-format
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
%N %V - Select Tag
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Select Filter Dialog
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
selectfilter-title-format
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
%N %V - Select Filter
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Article View
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
itemview-title-format
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
%N %V - Article <span class="emphasis"><em>%T</em></span> (%u unread, %t total)
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
URL View
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
urlview-title-format
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
%N %V - URLs
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
Dialog List
</td><td style="border-right: 1px solid #527bbd; " align="left">
dialogs-title-format
</td><td style="" align="left">
%N %V - Dialogs
</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idp57183808"></a><p class="title"><strong>Table 10. Common Title Format Identifiers</strong></p><div class="table-contents"><table summary="Common Title Format Identifiers" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Identifier
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Meaning
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
N
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Name of the program, i.e. "newsbeuter"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
V
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Program version
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
u
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Number of unread articles (if applicable)
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
t
</td><td style="" align="left">
Number of total articles (if applicable)
</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idp57194496"></a><p class="title"><strong>Table 11. Feed List Title Format Identifiers</strong></p><div class="table-contents"><table summary="Feed List Title Format Identifiers" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Identifier
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Meaning
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; " align="left">
T
</td><td style="" align="left">
Currently selected tag (empty if none selected)
</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idp57201520"></a><p class="title"><strong>Table 12. Article List Title Format Identifiers</strong></p><div class="table-contents"><table summary="Article List Title Format Identifiers" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Identifier
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Meaning
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
T
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Feed title
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
U
</td><td style="" align="left">
Feed URL
</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idp57209568"></a><p class="title"><strong>Table 13. File Browser Title Format Identifiers</strong></p><div class="table-contents"><table summary="File Browser Title Format Identifiers" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Identifier
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Meaning
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
f
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Filename
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
O
</td><td style="" align="left">
Non-empty if file browser is in open mode, empty if in save mode
</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idp57217776"></a><p class="title"><strong>Table 14. Article View Title Format Identifiers</strong></p><div class="table-contents"><table summary="Article View Title Format Identifiers" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Identifier
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Meaning
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; " align="left">
T
</td><td style="" align="left">
Article title
</td></tr></tbody></table></div></div><br class="table-break" /></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_highlighting_text"></a>4.19. Highlighting Text</h3></div></div></div><p>Since version 1.0, newsbeuter supports the highlighting of text in the feed
list, the article list and the article view, using regular expressions to
describe patterns to be highlighted. The command syntax goes like this:</p><pre class="literallayout">highlight <target> <regex> <fgcolor> [<bgcolor> [<attribute> ...]]</pre><p>Valid values for <target> are "feedlist", "articlelist", "article" and "all".
When specifying "all", the matching will be done in all three views. The
<regex> must be regular expression, which will be matched case-insensitive
against the text. <fgcolor> and <bgcolor> specify the foreground color resp.
the background color of the matches. You can also specify 0 or more attributes.
You can find a list of valid colors and attributes in the "Configuring Colors"
section.</p><p>Examples for possible highlighting configurations are:</p><pre class="literallayout">highlight all "newsbeuter" red
highlight article "^(Feed|Title|Author|Link|Date):" default default underline
highlight feedlist "https?://[^ ]+" yellow red bold</pre><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_highlighting_articles_in_the_article_list"></a>Highlighting Articles in the Article List</h4></div></div></div><p>In addition to generally highlighting text, there is also a specific way to
highlight articles in the article list based on whether they match a certain
filter expression. This means that you can highlight items in the article list
based on their content. This is done using the "highlight-article" configuration
command.</p><p>The syntax is similar to the "highlight" configuration command, with the difference
that there’s no need to specify a target (since it only applies in the article list),
and instead of a regular expression, a filter expression is used. After the filter
expression, the colors and attributes are specified in the same way.</p><p>Example:</p><pre class="literallayout">highlight-article "author =~ \"Andreas Krennmair\"" white red bold</pre></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_advanced_dialog_management"></a>4.20. Advanced Dialog Management</h3></div></div></div><p>Since version 2.0, newsbeuter supports an advanced concept of dialogs.
Previously, all dialogs (feed list, article list, article view) were internally
laid out as a pure stack. In 2.0, this changed: all dialogs are managed in a
list, and the user can jump to another, previously opened dialog from
everywhere. This allows a user to open more than one article list, more than one
article view, etc., and switch between them without closing them.</p><p>The main dialog for this feature can be reached by pressing the "v" key. This
opens the list of open dialogs. From there, the user can switch to another
dialog by selecting the appropriate entry and pressing "ENTER", or can close
open dialogs by selecting them and pressing Ctrl-X.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_xdg_base_directory_support"></a>4.21. XDG Base Directory Support</h3></div></div></div><p>Newsbeuter implements limited support for the
<a class="ulink" href="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html" target="_top">XDG Base
Directory Specification</a>. It needs to be set up manually by creating the
following directories:</p><pre class="literallayout">~/.local/share/newsbeuter/
~/.config/newsbeuter/</pre><p>If these directories exist or the environment variables $XDG_CONFIG_HOME and
$XDG_DATA_HOME are set, newsbeuter will use these directories, otherwise it
will default to ~/.newsbeuter as its configuration directory.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_podcast_support"></a>4.22. 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. Since version 2.0,
it also recognizes and handles the Yahoo Media RSS extensions. 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><p>Podcasts that have been downloaded but haven’t been played yet remain in the
queue but are marked as downloaded. You can remove them by purging them from
the queue with the <span class="emphasis"><em>P</em></span> key. After you’ve played a file and close podbeuter, it
will be removed from the queue. The downloaded file remains on the
filesystem.</p><div class="table"><a id="idp57246240"></a><p class="title"><strong>Table 15. Podbeuter Configuration Commands</strong></p><div class="table-contents"><table summary="Podbeuter Configuration Commands" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px 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 #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Configuration Command
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Argument(s)
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Default
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Description
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Example
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
download-path
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<path>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
~/
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Specifies the directory where podbeuter shall download the files to. Optionally, the placeholders "%n" (for the podcast feed’s name) and "%h" (for the podcast feed’s hostname) can be used to place downloads in a directory structure.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
download-path "~/Downloads/%h/%n"
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
max-downloads
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
<number>
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
1
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Specifies the maximum number of parallel downloads when automatic download is enabled.
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
max-downloads 3
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
player
</td><td style="border-right: 1px solid #527bbd; " align="left">
<player command>
</td><td style="border-right: 1px solid #527bbd; " align="left">
""
</td><td style="border-right: 1px solid #527bbd; " 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><br class="table-break" /><div class="table"><a id="idp57263184"></a><p class="title"><strong>Table 16. Available Operations in Podbeuter</strong></p><div class="table-contents"><table summary="Available Operations in Podbeuter" cellpadding="4px" style="border-collapse: collapse;border-top: 3px solid #527bbd; border-bottom: 3px solid #527bbd; border-left: 3px solid #527bbd; border-right: 3px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Operation
</th><th style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
Default key
</th><th style="border-bottom: 1px solid #527bbd; " align="left">
Description
</th></tr></thead><tbody><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
quit
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
q
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Quit the program.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
pb-download
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
d
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Download the currently selected URL.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
pb-cancel
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
c
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Cancel the currently selected download.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
pb-play
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
p
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Start player with currently selected download.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
pb-delete
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
D
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Delete the currently selected URL from the queue.
</td></tr><tr><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
pb-purge
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
P
</td><td style="border-bottom: 1px solid #527bbd; " 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 #527bbd; border-bottom: 1px solid #527bbd; " align="left">
pb-toggle-download-all
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
a
</td><td style="border-bottom: 1px solid #527bbd; " 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 #527bbd; border-bottom: 1px solid #527bbd; " align="left">
pb-increase-max-dls
</td><td style="border-right: 1px solid #527bbd; border-bottom: 1px solid #527bbd; " align="left">
+
</td><td style="border-bottom: 1px solid #527bbd; " align="left">
Increase the "max-downloads" option by 1.
</td></tr><tr><td style="border-right: 1px solid #527bbd; " align="left">
pb-decrease-max-dls
</td><td style="border-right: 1px solid #527bbd; " 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></div><br class="table-break" /><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"><div class="titlepage"><div><div><h3 class="title"><a id="_using_sqlite_triggers_with_newsbeuter"></a>4.23. Using SQLite Triggers with newsbeuter</h3></div></div></div><p>This section was kindly provided by <a class="ulink" 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"><div class="titlepage"><div><div><h4 class="title"><a id="_example"></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 class="orderedlist" type="1"><li class="listitem">
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 class="listitem"><p class="simpara">
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></pre></li><li class="listitem"><p class="simpara">
Create the trigger:
</p><pre class="literallayout">sqlite> create trigger update_item_title update of title on rss_item
> for each row when old.title != new.title
> begin
> update rss_item set unread = 1 where rowid == new.rowid;
> end;</pre></li><li class="listitem">
Leave sqlite3 with <Ctrl-D> 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"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_feedback"></a>5. Feedback</h2></div></div></div><p>If you want to tell us something related to newsbeuter, don’t hesitate to send
an email: <a class="ulink" href="mailto:ak@newsbeuter.org" target="_top">ak@newsbeuter.org</a></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 class="ulink" 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"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_license"></a>6. License</h2></div></div></div><p>MIT/X Consortium License</p><p>©opyright 2006-2011 Andreas Krennmair <<a class="ulink" href="mailto:ak@newsbeuter.org" target="_top">ak@newsbeuter.org</a>></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>
|