1NEWSBEUTER(1) NEWSBEUTER(1)
2
6 newsbeuter - an RSS/Atom feed reader for text terminals
7
9 newsbeuter [-r] [-e] [-i opmlfile] [-u urlfile] [-c cachefile] [-C
10 configfile] [-X] [-o] [-x <command> ...] [-h]
11
13 newsbeuter is an RSS/Atom feed reader for text terminals. RSS and Atom
14 are a number of widely-used XML formats to transmit, publish and
15 syndicate articles, for example news or blog articles. Newsbeuter is
16 designed to be used on text terminals on Unix or Unix-like systems such
17 as Linux, BSD or Mac OS X.
18
20 -h
21 Display help
22 -r
24 Refresh feeds on start
25 -e
27 Export feeds as OPML to stdout
28 -X
30 Clean up cache thoroughly (i.e. reduce it in size if possible)
31 -v, -V
33 Get version information about newsbeuter and the libraries it uses
34 -i opmlfile
36 Import an OPML file
37 -u urlfile
39 Use an alternative URL file
40 -c cachefile
42 Use an alternative cache file
43 -C configfile
45 Use an alternative configuration file
46 -x command ...
48 Execute one or more commands to run newsbeuter unattended.
49 Currently available commands are "reload" and "print-unread".
50 -o
52 Active offline reading mode. When Google Reader synchronization
53 mode is configured, then the list of feeds will not be loaded from
54 Google Reader, but instead from the local cache. This makes it
55 possible to read locally cached articles even without internet
56 connection to connect to Google Reader.
57 -l loglevel
59 Generate a loglevel with a certain loglevel. Valid loglevels are 1
60 to 6. An actual logfile will only be written when you provide a
61 logfile name.
62 -d logfile
64 Use this logfile as output when logging debug messages. Please note
65 that this only works when providing a loglevel.
66 -E file
68 Export a list of read articles (resp. their GUIDs). This can be
69 used to transfer information about read articles between different
70 computers.
71 -I file
73 Import a list of read articles and mark them as read if they are
74 held in the cache. This is to be used in conjunction with the -E
75 commandline parameter.
76
78 After you’ve installed newsbeuter, you can run it for the first time by
79 typing "newsbeuter" on your command prompt. This will bring you the
80 following message:
81 Error: no URLs configured. Please fill the file /home/ak/.newsbeuter/urls with RSS feed URLs or import an OPML file.
83 newsbeuter 2.4
85 usage: ./newsbeuter [-i <file>|-e] [-u <urlfile>] [-c <cachefile>] [-x <command> ...] [-h]
86 -e export OPML feed to stdout
87 -r refresh feeds on start
88 -i <file> import OPML file
89 -u <urlfile> read RSS feed URLs from <urlfile>
90 -c <cachefile> use <cachefile> as cache file
91 -C <configfile> read configuration from <configfile>
92 -X clean up cache thoroughly
93 -x <command>... execute list of commands
94 -o activate offline mode (only applies to Google Reader synchronization mode)
95 -q quiet startup
96 -v get version information
97 -l <loglevel> write a log with a certain loglevel (valid values: 1 to 6)
98 -d <logfile> use <logfile> as output log file
99 -E <file> export list of read articles to <file>
100 -I <file> import list of read articles from <file>
101 -h this help
102 This means that newsbeuter can’t start without any configured feeds. To
104 add feeds to newsbeuter, you can either add URLs to the configuration
105 file $HOME/.newsbeuter/urls or you can import an OPML file by running
106 "newsbeuter -i blogroll.opml". To manually add URLs, open the file with
107 your favorite text editor and add the URLs, one per line:
108 http://rss.cnn.com/rss/cnn_topstories.rss
110 http://newsrss.bbc.co.uk/rss/newsonline_world_edition/front_page/rss.xml
111 If you need to add URLs that have restricted access via
113 username/password, simply provide the username/password in the
114 following way:
115 http://username:password@hostname.domain.tld/feed.rss
117 In order to protect username and password, make sure that
119 $HOME/.newsbeuter/urls has the appropriate permissions. Newsbeuter also
120 makes sure that usernames and passwords within URLs aren’t displayed in
121 its user interface. In case there is a @ in the username, you need to
122 write it as %40 instead so that it can be distinguished from the @ that
123 separates the username/password part from the hostname part.
124 You can also configure local files as feeds, by prefixing the local
126 path with "file://" and adding it to the $HOME/.newsbeuter/urls file:
127 file:///var/log/rss_eventlog.xml
129 Now you can run newsbeuter again, and it will present you with a
131 controllable list of the URLs that you configured previously. You can
132 now start downloading the feeds, either by pressing "R" to download all
133 feeds, or by pressing "r" to download the currently selected feed. You
134 can then select a feed you want to read, and by pressing "Enter", you
135 can go to the article list for this feed. This works even while the
136 downloading is still in progress. You can now see the list of available
137 articles by their title. A "N" on the left indicates that an article
138 wasn’t read yet. Pressing Enter brings you to the content of the
139 article. You can scroll through this text, and also run a browser
140 (default: lynx) to view the complete article if the content is empty or
141 just an abstract or a short description. Pressing "q" brings you back
142 to the article list, and pressing "q" again brings you back to the feed
143 list. Pressing "q" a third time then closes newsbeuter.
144 Newsbeuter caches the article that it downloads. This means that when
146 you start newsbeuter again and reload a feed, the old articles can
147 still be read even if they aren’t in the current RSS feeds anymore.
148 Optionally you can configure how many articles shall be preserved by
149 feed so that the article backlog doesn’t grow endlessly (see
150 "max-items" below).
151 Newsbeuter also uses a number of measures to preserve the users' and
153 feed providers' bandwidth, by trying to avoid unnecessary feed
154 downloads through the use of conditional HTTP downloading. It saves
155 every feed’s "Last-Modified" and "ETag" response header values (if
156 present) and advises the feed’s HTTP server to only send data if the
157 feed has been updated by modification date/time or "ETag" header. This
158 doesn’t only make feed downloads for RSS feeds with no new updates
159 faster, it also reduces the amount of transferred data per request.
160 Conditional HTTP downloading can be optionally disabled per feed by
161 using the "always-download" configuration command.
162 Several aspects of newsbeuter’s behaviour can be configured via a
164 configuration file, by default $HOME/.newsbeuter/config. This
165 configuration file contains lines in the form "<config-command> <arg1>
166 ...". The configuration file can also contain comments, which start
167 with the # character and go as far as the end of line. If you need to
168 enter a configuration argument that contains spaces, use quotes (")
169 around the whole argument. It’s even possible to integrate the output
170 of external commands into the configuration. The text between two
171 backticks ("`") is evaluated as shell command, and its output is put on
172 its place instead. This works like backtick evaluation in
173 Bourne-compatible shells and allows users to use external information
174 from the system within the configuration.
175 Searching for articles is possible in newsbeuter, too. Just press the
177 "/" key, enter your search phrase, and the title and content of all
178 articles are searched for it. When you do a search from the list of
179 feeds, all articles of all feeds will be searched. When you do a search
180 from the article list of a feed, only the articles of the currently
181 viewed feed are searched. When opening an article from a search result
182 dialog, the search phrase is highlighted.
183 The history of all your searches is saved to the filesystem, to
185 \~/.newsbeuter/history.search. By default, the last 100 search phrases
186 are stored, but this limited can be influenced through the
187 "history-limit" configuration variable. To disable search history
188 saving, simply set the history-limit to 0.
189
191 always-display-description (parameters: [true/false]; default value:
192 false)
193 If true, then the description will always displayed even if e.g. a
194 content:encoded tag has been found. (example:
195 always-display-description true)
196 always-download (parameters: <rssurl> [<rssurl>]; default value: n/a)
198 The parameters of this configuration command are one or more RSS
199 URLs. These URLs will always get downloaded, regardless of their
200 Last-Modified timestamp and ETag header. (example: always-download
201 "http://www.n-tv.de/23.rss")
202 article-sort-order (parameters: <sortfield>[-<direction>]; default
204 value: date)
205 The sortfield specifies which article property shall be used for
206 sorting (currently available: date, title, flags, author, link,
207 guid). The optional direction specifies the sort direction ("asc"
208 specifies ascending sorting, "desc" specifies descending sorting.
209 for date, "desc" is default, for all others, "asc" is default).
210 (example: article-sort-order author-desc)
211 articlelist-format (parameters: <format>; default value: "%4i %f %D %6L
213 %?T?;%-17T; ?%t")
214 This variable defines the format of entries in the article list.
215 See the respective section in the documentation for more
216 information on format strings (note that the semicolon should
217 actually be a vertical bar; this is a limitation in AsciiDoc).
218 (example: articlelist-format "%4i %f %D %?T?;%-17T; ?%t")
219 auto-reload (parameters: [yes/no]; default value: no)
221 If enabled, all feeds will be automatically reloaded at start up
222 and then continuously after a certain time has passed (see
223 reload-time). (example: auto-reload yes)
224 bind-key (parameters: <key> <operation> [<dialog>]; default value: n/a)
226 Bind key <key> to <operation>. This means that whenever <key> is
227 pressed, then <operation> is executed (if applicable in the current
228 dialog). A list of available operations can be found below.
229 Optionally, you can specify a dialog. If you specify one, the key
230 binding will only be added to the specified dialog. Available
231 dialogs are "all" (default if none is specified), "feedlist",
232 "filebrowser", "help", "articlelist", "article", "tagselection",
233 "filterselection", "urlview" and "podbeuter". (example: bind-key ^R
234 reload-all)
235 bookmark-cmd (parameters: <bookmark-command>; default value: "")
237 If set, then <bookmark-command> will be used as bookmarking plugin.
238 See the documentation on bookmarking for further information.
239 (example: bookmark-cmd "~/bin/delicious-bookmark.sh")
240 bookmark-interactive (parameters: [yes/no]; default value: no)
242 If set to yes, then the configured bookmark command is an
243 interactive program. (example: bookmark-interactive yes)
244 bookmark-autopilot (parameters: [yes/no]; default value: no)
246 If set to yes, the configured bookmark command is executed without
247 any further input asked from user, uless the url or the title
248 cannot be found/guessed. (example: bookmark-autopilot yes)
249 browser (parameters: <browser-command>; default value: lynx)
251 Set the browser command to use when opening an article in the
252 browser. If <browser-command> contains %u, it will be used as
253 complete commandline and %u will be replaced with the URL that
254 shall be opened. (example: browser "w3m %u")
255 cache-file (parameters: <path>; default value:
257 "~/.newsbeuter/cache.db")
258 This configuration option sets the cache file. This is especially
259 useful if the filesystem of your home directory doesn’t support
260 proper locking (e.g. NFS). (example: cache-file
261 "/tmp/testcache.db")
262 cleanup-on-quit (parameters: [yes/no]; default value: yes)
264 If yes, then the cache gets locked and superfluous feeds and items
265 are removed, such as feeds that can’t be found in the urls
266 configuration file anymore. (example: cleanup-on-quit no)
267 color (parameters: <element> <fgcolor> <bgcolor> [<attr> ...]; default
269 value: n/a)
270 Set the foreground color, background color and optional attributes
271 for a certain element (example: color background white black)
272 confirm-exit (parameters: [yes/no]; default value: no)
274 If set to yes, then newsbeuter will ask for confirmation whether
275 the user really wants to quit newsbeuter. (example: confirm-exit
276 yes)
277 cookie-cache (parameters: <file>; default value: "")
279 Set a cookie cache. If set, then cookies will be cached (i.e. read
280 from and written to) in this file. (example: cookie-cache
281 "~/.newsbeuter/cookies.txt")
282 datetime-format (parameters: <date/time format>; default value: %b %d)
284 This format specifies the date/time format in the article list. For
285 a detailed documentation on the allowed formats, consult the
286 manpage of strftime(3). (example: datetime-format "%D, %R")
287 define-filter (parameters: <name> <filter>; default value: n/a)
289 With this command, you can predefine filters, which you can later
290 select from a list, and which are then applied after selection.
291 This is especially useful for filters that you need often and you
292 don’t want to enter them every time you need them. (example:
293 define-filter "all feeds with fun tag" "tags # \\"fun\\"")
294 delete-read-articles-on-quit (parameters: [yes/no]; default value:
296 "no")
297 If set to "yes", then all read articles will be deleted when you
298 quit newsbeuter. (example: delete-read-articles-on-quit yes)
299 display-article-progress (parameters: [yes/no]; default value: yes)
301 If set to yes, then a read progress (in percent) is displayed in
302 the article view. Otherwise, no read progress is displayed.
303 (example: display-article-progress no)
304 download-retries (parameters: <number retries>; default value: 1)
306 How many times newsbeuter shall try to successfully download a feed
307 before giving up. This is an option to improve the success of
308 downloads on slow and shaky connections such as via a TOR proxy.
309 (example: download-retries 4)
310 download-full-page (parameters: [yes/no]; default value: no)
312 If set to yes, then for all feed items with no content but with a
313 link, the link is downloaded and the result used as content
314 instead. This may significantly increase the download times of
315 "empty" feeds. (example: download-full-page yes)
316 download-timeout (parameters: <seconds>; default value: 30)
318 The number of seconds newsbeuter shall wait when downloading a feed
319 before giving up. This is an option to improve the success of
320 downloads on slow and shaky connections such as via a TOR proxy.
321 (example: download-timeout 60)
322 error-log (parameters: <path>; default value: "")
324 If set, then user errors (e.g. errors regarding defunct RSS feeds)
325 will be logged to this file. (example: error-log
326 "~/.newsbeuter/error.log")
327 external-url-viewer (parameters: <command>; default value: "")
329 If set, then "show-urls" will pipe the current article to a
330 specific external tool instead of using the internal URL viewer.
331 This can be used to integrate tools such as urlview. (example:
332 external-url-viewer "urlview")
333 feed-sort-order (parameters: <sortorder>; default value: none)
335 If set to "firsttag", the feeds in the feed list will be sorted by
336 their first tag in the urls file. (example: feed-sort-order
337 firsttag)
338 feedlist-format (parameters: <format>; default value: "%4i %n %11u %t")
340 This variable defines the format of entries in the feed list. See
341 the respective section in the documentation for more information on
342 format strings. (example: feedlist-format " %n %4i - %11u -%> %t")
343 oldreader-flag-share (parameters: <flag>; default value: "")
345 If this is set and The Old Reader support is used, then all
346 articles that are flagged with the specified flag are being
347 "shared" in The Old Reader so that people that follow you can see
348 it. (example: oldreader-flag-share "a")
349 oldreader-flag-star (parameters: <flag>; default value: "")
351 If this is set and The Old Reader support is used, then all
352 articles that are flagged with the specified flag are being
353 "starred" in The Old Reader and appear in the list of "Starred
354 items". (example: oldreader-flag-star "b")
355 oldreader-login (parameters: <login>; default value: "")
357 This variable sets your The Old Reader login for The Older Reader
358 support. (example: oldreader-login "your-login")
359 oldreader-min-items (parameters: <number>; default value: 20)
361 This variable sets the number of articles that are loaded from The
362 Old Reader per feed. (example: oldreader-min-items 100)
363 oldreader-password (parameters: <password>; default value: "")
365 This variable sets your The Old Reader password for The Old Reader
366 support. (example: oldreader-password "your-password")
367 oldreader-passwordfile (parameters: <path-to-file; default value: "")
369 A more secure alternative to the above, by storing your password
370 elsewhere in your system. (example: oldreader-passwordfile
371 "path-to-file")
372 oldreader-show-special-feeds (parameters: [yes/no]; default value: yes)
374 If this is set, then "special feeds" like "People you follow"
375 (articles shared by people you follow), "Starred items" (your
376 starred articles) and "Shared items" (your shared articles) appear
377 in your subscription list. (example: oldreader-show-special-feeds
378 "no")
379 feedhq-flag-share (parameters: <flag>; default value: "")
381 If this is set and FeedHQ support is used, then all articles that
382 are flagged with the specified flag are being "shared" in FeedHQ so
383 that people that follow you can see it. (example: feedhq-flag-share
384 "a")
385 feedhq-flag-star (parameters: <flag>; default value: "")
387 If this is set and FeedHQ support is used, then all articles that
388 are flagged with the specified flag are being "starred" in FeedHQ
389 and appear in the list of "Starred items". (example:
390 feedhq-flag-star "b")
391 feedhq-login (parameters: <login>; default value: "")
393 This variable sets your FeedHQ login for FeedHQ support. (example:
394 feedhq-login "your-login")
395 feedhq-min-items (parameters: <number>; default value: 20)
397 This variable sets the number of articles that are loaded from
398 FeedHQ per feed. (example: feedhq-min-items 100)
399 feedhq-password (parameters: <password>; default value: "")
401 This variable sets your FeedHQ password for FeedHQ support.
402 (example: feedhq-password "your-password")
403 feedhq-passwordfile (parameters: <path-to-file; default value: "")
405 A more secure alternative to the above, by storing your password
406 elsewhere in your system. (example: feedhq-passwordfile
407 "path-to-file")
408 feedhq-show-special-feeds (parameters: [yes/no]; default value: yes)
410 If this is set, then "special feeds" like "People you follow"
411 (articles shared by people you follow), "Starred items" (your
412 starred articles) and "Shared items" (your shared articles) appear
413 in your subscription list. (example: feedhq-show-special-feeds
414 "no")
415 goto-first-unread (parameters: [yes/no]; default value: yes)
417 If set to yes (the default), then the first unread article will be
418 selected whenever a feed is entered. (example: goto-first-unread
419 no)
420 goto-next-feed (parameters: [yes/no]; default value: yes)
422 If set to yes, then the next-unread and prev-unread keys will
423 search in other feeds for unread articles if all articles in the
424 current feed are read. If set to no, then the next-unread and
425 prev-unread keys will stop in the current feed. (example:
426 goto-next-feed no)
427 highlight (parameters: <target> <regex> <fgcolor> [<bgcolor>
429 [<attribute> ...]]; default value: n/a)
430 With this command, you can highlight text parts in the feed list,
431 the article list and the article view. For a detailed
432 documentation, see the chapter on highlighting. (example: highlight
433 all "newsbeuter" red)
434 highlight-article (parameters: <filterexpr> <fgcolor> <bgcolor>
436 [<attribute> ...]; default value: n/a)
437 With this command, you can highlight articles in the article list
438 if they match a filter expression. For a detailed documentation,
439 see the chapter on highlighting. (example: highlight-article
440 "author =~ \\"Andreas Krennmair\\"" white red bold)
441 history-limit (parameters: <number>; default value: 100)
443 Defines the maximum number of entries of commandline resp. search
444 history to be saved. To disable history saving, set history-limit
445 to 0. (example: history-limit 0)
446 html-renderer (parameters: <path>; default value: internal)
448 If set to "internal", then the internal HTML renderer will be used.
449 Otherwise, the specified command will be executed, the HTML to be
450 rendered will be written to the command’s stdin, and the program’s
451 output will be displayed. This makes it possible to use other,
452 external programs, such as w3m, links or lynx, to render HTML.
453 (example: html-renderer "w3m -dump -T text/html")
454 http-auth-method (parameters: <method>; default value: any)
456 Set HTTP authentication method. Allowed values: any, basic, digest,
457 digest_ie (only available with libcurl 7.19.3 and newer),
458 gssnegotiate, ntlm, anysafe. (example: http-auth-method digest)
459 ignore-article (parameters: <feed> <filterexpr>; default value: n/a)
461 If a downloaded article from <feed> matches <filterexpr>, then it
462 is ignored and not presented to the user. This command is further
463 explained in the "kill file" section below. (example:
464 ignore-article "*" "title =~ \\"Windows\\"")
465 ignore-mode (parameters: [download/display]; default value: download)
467 This configuration option defines in what way an article is ignored
468 (see ignore-article). If set to "download", then it is ignored in
469 the download/parsing phase (which is the default) and thus never
470 written to the cache, if it set to "display", it is ignored when
471 displaying articles but is kept in the cache. (example: ignore-mode
472 "display")
473 include (parameters: <path>; default value: n/a)
475 With this command, you can include other files to be interpreted as
476 configuration files. This is especially useful to separate your
477 configuration into several files, e.g. key configuration, color
478 configuration, ... (example: include "~/.newsbeuter/colors")
479 keep-articles-days (parameters: <days>; default value: 0)
481 If set the a number greater than 0, only articles that are were
482 published within the last <n> days are kept, and older articles are
483 deleted. If set to 0 (default value), this option is not active.
484 (example: keep-articles-days 30)
485 macro (parameters: <macro key> <command list>; default value: n/a)
487 With this command, you can define a macro key and specify a list of
488 commands that shall be executed when the macro prefix and the macro
489 key are pressed. (example: macro k open ; reload ; quit)
490 mark-as-read-on-hover (parameters: [yes/no]; default value: no)
492 If set to yes, then all articles that get selected in the article
493 list are marked as read. (example: mark-as-read-on-hover yes)
494 max-download-speed (parameters: <number>; default value: 0)
496 If set to a number great than 0, the download speed per download is
497 set to that limit (in kB). (example: max-download-speed 50)
498 max-items (parameters: <number>; default value: 0)
500 Set the number of articles to maximally keep per feed. If the
501 number is set to 0, then all articles are kept. (example: max-items
502 100)
503 notify-format (parameters: <string>; default value: "newsbeuter:
505 finished reload, %f unread feeds (%n unread articles total)")
506 Format string that is used for formatting notifications. See the
507 chapter on format strings for more information. (example:
508 notify-format "%d new articles (%n unread articles, %f unread
509 feeds)")
510 notify-program (parameters: <path>; default value: "")
512 If set, then the configured program will be executed if new
513 articles arrived (through a reload) or if notify-always is true.
514 The first parameter of the called program contains the notification
515 message. (example: notify-program "~/bin/my-notifier")
516 notify-always (parameters: [yes/no]; default value: no)
518 If no, notifications will only be made when there are new feeds or
519 articles. If yes, notifications will be made regardless. (example:
520 notify-always yes)
521 notify-screen (parameters: [yes/no]; default value: no)
523 If yes, then a "privacy message" will be sent to the terminal,
524 containing a notification message about new articles. This is
525 especially useful if you use terminal emulations such as GNU screen
526 which implement privacy messages. (example: notify-screen yes)
527 notify-xterm (parameters: [yes/no]; default value: no)
529 If yes, then the xterm window title will be set to a notification
530 message about new articles. (example: notify-xterm yes)
531 notify-beep (parameters: [yes/no]; default value: no)
533 If yes, then the speaker beep on new articles. (example:
534 notify-beep yes)
535 opml-url (parameters: <url> ...; default value: "")
537 If the OPML online subscription mode is enabled, then the list of
538 feeds will be taken from the OPML file found on this location.
539 Optionally, you can specify more than one URL. All the listed OPML
540 URLs will then be taken into account when loading the feed list.
541 (example: opml-url "http://host.domain.tld/blogroll.opml"
542 "http://example.com/anotheropmlfile.opml")
543 pager (parameters: [<path>/internal]; default value: internal)
545 If set to "internal", then the internal pager will be used.
546 Otherwise, the article to be displayed will be rendered to be a
547 temporary file and then displayed with the configured pager. If the
548 pager path is set to an empty string, the content of the "PAGER"
549 environment variable will be used. If the pager path contains a
550 placeholder "%f", it will be replaced with the temporary filename.
551 (example: less %f)
552 podcast-auto-enqueue (parameters: [yes/no]; default value: no)
554 If yes, then all podcast URLs that are found in articles are added
555 to the podcast download queue. See the respective section in the
556 documentation for more information on podcast support in
557 newsbeuter. (example: podcast-auto-enqueue yes)
558 prepopulate-query-feeds (parameters: [yes/no]; default value: no)
560 If yes, then all query feeds are prepopulated with articles on
561 startup. (example: prepopulate-query-feeds yes)
562 proxy (parameters: <server:port>; default value: n/a)
564 Set the proxy to use for downloading RSS feeds. (example: proxy
565 localhost:3128)
566 proxy-auth (parameters: <auth>; default value: n/a)
568 Set the proxy authentication string. (example: proxy-auth
569 user:password)
570 proxy-auth-method (parameters: <method>; default value: any)
572 Set proxy authentication method. Allowed values: any, basic,
573 digest, digest_ie (only available with libcurl 7.19.3 and newer),
574 gssnegotiate, ntlm, anysafe. (example: proxy-auth-method ntlm)
575 proxy-type (parameters: <type>; default value: http)
577 Set proxy type. Allowed values: http, socks4, socks4a, socks5.
578 (example: proxy-type socks5)
579 refresh-on-startup (parameters: [yes/no]; default value: no)
581 If yes, then all feeds will be reloaded when newsbeuter starts up.
582 This is equivalent to the -r commandline option. (example:
583 refresh-on-startup yes)
584 reload-only-visible-feeds (parameters: [yes/no]; default value: no)
586 If yes, then manually reloading all feeds will only reload the
587 currently visible feeds, e.g. if a filter or a tag is set.
588 (example: reload-only-visible-feeds yes)
589 reload-time (parameters: <number>; default value: 60)
591 The number of minutes between automatic reloads. (example:
592 reload-time 120)
593 reload-threads (parameters: <number>; default value: 1)
595 The number of parallel reload threads that shall be started when
596 all feeds are reloaded. (example: reload-threads 3)
597 reset-unread-on-update (parameters: <url> ...; default value: n/a)
599 With this configuration command, you can provide a list of RSS feed
600 URLs for whose articles the unread flag will be reset if an article
601 has been updated, i.e. its content has been changed. This is
602 especially useful for RSS feeds where single articles are updated
603 after publication, and you want to be notified of the updates.
604 (example: reset-unread-on-update
605 "http://blog.fefe.de/rss.xml?html")
606 save-path (parameters: <path>; default value: ~/)
608 The default path where articles shall be saved to. If an invalid
609 path is specified, the current directory is used. (example:
610 save-path "~/Saved Articles")
611 search-highlight-colors (parameters: <fgcolor> <bgcolor> [<attribute>
613 ...]; default value: black yellow bold)
614 This configuration command specifies the highlighting colors when
615 searching for text from the article view. (example:
616 search-highlight-colors white black bold)
617 show-keymap-hint (parameters: [yes/no]; default value: yes)
619 If no, then the keymap hints on the bottom of screen will not be
620 displayed. (example: show-keymap-hint no)
621 show-read-feeds (parameters: [yes/no]; default value: yes)
623 If yes, then all feeds, including those without unread articles,
624 are listed. If no, then only feeds with one or more unread articles
625 are list. (example: show-read-feeds no)
626 show-read-articles (parameters: [yes/no]; default value: yes)
628 If yes, then all articles of a feed are listed in the article list.
629 If no, then only unread articles are listed. (example:
630 show-read-articles no)
631 suppress-first-reload (parameters: [yes/no]; default value: no)
633 If yes, then the first automatic reload will be suppressed if
634 auto-reload is set to yes. (example: suppress-first-reload yes)
635 swap-title-and-hints (parameters: [yes/no]; default value: no)
637 If yes, then the title at the top of screen and keymap hints at the
638 bottom of screen will be swapped. (example: swap-title-and-hints
639 yes)
640 text-width (parameters: <number>; default value: 0)
642 If set to a number greater than 0, then all HTML will be rendered
643 to this maximum line length. If set to 0, the terminal width will
644 be used. (example: text-width 72)
645 ttrss-flag-publish (parameters: <character>; default value: "")
647 If this is set and Tiny Tiny RSS support is used, then all articles
648 that are flagged with the specified flag are being marked as
649 "published" in Tiny Tiny RSS. (example: ttrss-flag-publish "b")
650 ttrss-flag-star (parameters: <character>; default value: "")
652 If this is set and Tiny Tiny RSS support is used, then all articles
653 that are flagged with the specified flag are being "starred" in
654 Tiny Tiny RSS. (example: ttrss-flag-star "a")
655 ttrss-login (parameters: <username>; default value: "")
657 Sets the username for use with Tiny Tiny RSS. (example: ttrss-login
658 "admin")
659 ttrss-mode (parameters: [multi/single]; default value: multi)
661 Configures the mode in which Tiny Tiny RSS is used. In single-user
662 mode, login and password are used for HTTP authentication, while in
663 multi-user mode, they are used for authenticating with Tiny Tiny
664 RSS. (example: ttrss-mode "single")
665 ttrss-password (parameters: <password>; default value: "")
667 Configures the password for use with Tiny Tiny RSS. (example:
668 ttrss-password "mypassword")
669 ttrss-passwordfile (parameters: <path-to-file; default value: "")
671 A more secure alternative to the above, by storing your password
672 elsewhere in your system. (example: ttrss-passwordfile
673 "path-to-file")
674 ttrss-url (parameters: <url>; default value: "")
676 Configures the URL where the Tiny Tiny RSS installation you want to
677 use resides. (example: ttrss-url "http://example.com/ttrss/")
678 unbind-key (parameters: <key> [<dialog>]; default value: n/a)
680 Unbind key <key>. This means that no operation is called when <key>
681 is pressed. Optionally, you can specify a dialog (for a list of
682 available dialogs, see "bind-key" above). If you specify one, the
683 key binding will only be unbound for the specified dialog.
684 (example: unbind-key R)
685 urls-source (parameters: <source>; default value: "local")
687 This configuration command sets the source where URLs shall be
688 retrieved from. By default, this is ~/.newsbeuter/urls.
689 Alternatively, you can set it to "opml", which enables newsbeuter’s
690 OPML online subscription mode, to "ttrss" which enables
691 newsbeuter’s Tiny Tiny RSS support, to "oldreader", which enables
692 newsbeuter’s The Old Reader support, to "newsblur", which enables
693 NewsBlur support, or "feedhq" for FeedHQ support. (example:
694 urls-source "oldreader")
695 use-proxy (parameters: [yes/no]; default value: no)
697 If yes, then the configured proxy will be used for downloading the
698 RSS feeds. (example: use-proxy yes)
699 user-agent (parameters: <user agent string>; default value: "")
701 If set to a non-zero-length string, this value will be used as HTTP
702 User-Agent header for all HTTP requests. (example: user-agent
703 "Lynx/2.8.5rel.1 libwww-FM/2.14")
704
706 open (default key: ENTER)
707 Open the currently selected feed or article.
708 quit (default key: q)
710 Quit the program or return to the previous dialog (depending on the
711 context).
712 reload (default key: r)
714 Reload the currently selected feed.
715 reload-all (default key: R)
717 Reload all feeds.
718 mark-feed-read (default key: A)
720 Mark all articles in the currently selected feed read.
721 mark-all-feeds-read (default key: C)
723 Mark articles in all feeds read.
724 save (default key: s)
726 Save the currently selected article to a file.
727 next-unread (default key: n)
729 Jump to the next unread article.
730 prev-unread (default key: p)
732 Jump to the previous unread article.
733 next (default key: J)
735 Jump to next article.
736 prev (default key: K)
738 Jump to previous article.
739 random-unread (default key: ^K)
741 Jump to a random unread article.
742 open-in-browser (default key: o)
744 Opens the URL associated with the current article.
745 open-in-browser-and-mark-read (default key: O)
747 Opens the URL associated with the current article and marks the
748 article as read.
749 help (default key: ?)
751 Runs the help screen.
752 toggle-source-view (default key: ^U)
754 Toggles between the HTML view and the source view in the article
755 view.
756 toggle-article-read (default key: N)
758 Toggle the read flag for the currently selected article.
759 toggle-show-read-feeds (default key: l)
761 Toggle whether read feeds should be shown in the feed list.
762 show-urls (default key: u)
764 Show all URLs in the article in a list (similar to urlview).
765 clear-tag (default key: ^T)
767 Clear current tag.
768 set-tag (default key: t)
770 Select tag.
771 open-search (default key: /)
773 Opens the search dialog. When a search is done in the article list,
774 then the search operation only applies to the articles of the
775 current feed, otherwise to all articles.
776 goto-url (default key: #)
778 Open the URL dialog and then opens specified URL.
779 enqueue (default key: e)
781 Add the podcast download URL of the current article (if any is
782 found) to the podcast download queue (see the respective section in
783 the documentation for more information on podcast support).
784 edit-urls (default key: E)
786 Edit the list of subscribed URLs. newsbeuter will start the editor
787 configured through the $VISUAL environment variable (if unset,
788 $EDITOR is used; fallback: "vi"). When editing is finished,
789 newsbeuter will reload the URLs file.
790 reload-urls (default key: ^R)
792 Reload the URLs configuration file.
793 redraw (default key: ^L)
795 Redraw the screen.
796 cmdline (default key: <colon>)
798 Open the command line.
799 set-filter (default key: F)
801 Set a filter.
802 select-filter (default key: f)
804 Select a predefined filter.
805 clear-filter (default key: ^F)
807 Clear currently set filter.
808 bookmark (default key: ^B)
810 Bookmark currently selected article or URL.
811 edit-flags (default key: ^E)
813 Edit the flags of the currently selected article.
814 next-unread-feed (default key: ^N)
816 Go to the next feed with unread articles. This only works from the
817 article list.
818 prev-unread-feed (default key: ^P)
820 Go to the previous feed with unread articles. This only works from
821 the article list.
822 next-feed (default key: j)
824 Go to the next feed. This only works from the article list.
825 prev-feed (default key: k)
827 Go to the previous feed. This only works from the article list.
828 delete-article (default key: D)
830 Delete the currently selected article.
831 purge-deleted (default key: $)
833 Purge all article that are marked as deleted from the article list.
834 view-dialogs (default key: v)
836 View list of open dialogs.
837 close-dialog (default key: ^X)
839 Close currently selected dialog.
840 next-dialog (default key: ^V)
842 Go to next dialog.
843 prev-dialog (default key: ^G)
845 Go to previous dialog.
846 pipe-to (default key: |)
848 Pipe article to command.
849 sort (default key: g)
851 Sort feeds/articles by interactively choosing the sort method.
852 revsort (default key: G)
854 Sort feeds/articles by interactively choosing the sort method
855 (reversed).
856 up (default key: UP)
858 Goes up one item in the list.
859 down (default key: DOWN)
861 Goes down one item in the list.
862 pageup (default key: PPAGE)
864 Goes up one page in the list.
865 pagedown (default key: NPAGE)
867 Goes down one page in the list.
868
870 Newsbeuter comes with the possibility to categorize or "tag", as we
871 call it, RSS feeds. Every RSS feed can be assigned 0 or more tags.
872 Within newsbeuter, you can then select to only show RSS feeds that
873 match a certain tag. That makes it easy to categorize your feeds in a
874 flexible and powerful way.
875 Usually, the ~/.newsbeuter/urls file contains one RSS feed URL per
877 line. To assign a tag to an RSS feed, simply attach it as a single
878 word, separated by blanks such as space or tab. If the tag needs to
879 contain spaces, you must use quotes (") around the tag (see example
880 below). An example \~/.newsbeuter/urls file may look like this:
881 http://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
883 http://rss.orf.at/news.xml news orf
884 http://www.heise.de/newsticker/heise.rdf news interesting
885 When you now start newsbeuter with this configuration, you can press
887 "t" to select a tag. When you select the tag "news", you will see all
888 three RSS feeds. Pressing "t" again and e.g. selecting the "conspiracy"
889 tag, you will only see the http://blog.fefe.de/rss.xml?html RSS feed.
890 Pressing "^T" clears the current tag, and again shows all RSS feeds,
891 regardless of their assigned tags.
892 A special type of tag are tags that start with the tilde character
894 ("~"). When such a tag is found, the feed title is set to the tag name
895 (excluding the \~ character). With this feature, you can give feeds any
896 title you want in your feed list:
897 http://rss.orf.at/news.xml "~ORF News"
899 Another special type of tag are tags that start with the exclamation
901 mark. When such a tag is found, the feed is hidden from the regular
902 list of feeds and its content can only be found through a query feed.
903 http://rss.orf.at/news.xml "!ORF News (hidden)"
905
907 From version 0.4 on, newsbeuter contains support for Snownews
908 extensions. The RSS feed readers Snownews and Liferea share a common
909 way of extending the readers with custom scripts. Two mechanisms,
910 namely "execurl" and "filter" type scripts, are available and supported
911 by newsbeuter.
912 An "execurl" script can be any program that gets executed and whose
914 output is interpreted as RSS feed, while "filter" scripts are fed with
915 the content of a configured URL and whose output is interpreted as RSS
916 feed.
917 The configuration is simple and straight-forward. Just add to your
919 ~/.newsbeuter/urls file configuration lines like the following ones:
920 exec:~/bin/execurl-script
922 filter:~/bin/filter-script:http://some.test/url
923 The first line shows how to add an execurl script to your
925 configuration: start the line with "exec:" and then immediately append
926 the path of the script that shall be executed. If this script requires
927 additional parameters, simply use quotes:
928 "exec:~/bin/execurl-script param1 param2"
930 The second line shows how to add a filter script to your configuration:
932 start the line with "filter:", then immediately append the path of the
933 script, then append a colon (":"), and then append the URL of the file
934 that shall be fed to the script. Again, if the script requires any
935 parameters, simply quote:
936 "filter:~/bin/filter-script param1 param2:http://url/foobar"
938 In both cases, the tagging feature as described above is still
940 available:
941 exec:~/bin/execurl-script tag1 tag2 "quoted tag"
943 filter:~/bin/filter-script:http://some.test/url tag3 tag4 tag5
944 A collection of such extension scripts can be found on this website:
946 http://kiza.kcore.de/software/snownews/snowscripts/extensions
947 If you want to write your own extensions, refer to this website for
949 further instructions:
950 http://kiza.kcore.de/software/snownews/snowscripts/writing
951
953 Like other text-oriented software, newsbeuter contains an internal
954 commandline to modify configuration variables ad hoc and to run own
955 commands. It provides a flexible access to the functionality of
956 newsbeuter which is especially useful for advanced users.
957 To start the commandline, type ":". You will see a ":" prompt at the
959 bottom of the screen, similar to tools like vi(m) or mutt. You can now
960 enter commands. Pressing the return key executes the command (possibly
961 giving feedback to the user) and closes the commandline. You can cancel
962 entering commands by pressing the ESC key. The history of all the
963 commands that you enter will be saved to
964 \~/.newsbeuter/history.cmdline. The backlog is limited to 100 entries
965 by default, but can be influenced by setting the "history-limit"
966 configuration variable. To disable history saving, set the
967 history-limit to 0.
968 Starting with newsbeuter 2.0, the commandline provides you with some
970 help if you can’t remember the full names of commandline commands. By
971 pressing the TAB key, newsbeuter will try to automatically complete
972 your command. If there is more than one possible completion, you can
973 subsequently press the TAB key to cycle through all results. If no
974 match is found, no suggestion will be inserted into the commandline.
975 For the "set" command, the completion also works for configuration
976 variable names.
977 In addition, some common key combination such as Ctrl-G (to cancel
979 input), Ctrl-K (to delete text from the cursor position to the end of
980 line), Ctrl-U (to clear the whole line) and Ctrl-W (to delete the word
981 before the current cursor position) were added.
982 Please be aware that the input history of both the command line and the
984 search functions are saved to the filesystems, to the files
985 ~/.newsbeuter/history.cmdline resp. \~/.newsbeuter/history.search. By
986 default, the last 100 entries are saved, but this can be configured
987 (configuration variable history-limit) and also totally disabled (by
988 setting said variable to 0).
989 Currently, the following command line commands are available:
991 quit
993 Quit newsbeuter
994 save <filename>
996 Save current article to <filename>
997 set <variable>[=<value>|&|!]
999 Set (or get) configuration variable value. Specifying a ! after
1000 the name of a boolean configuration variable toggles their values,
1001 a & directly after the name of a configuration variable of any type
1002 resets its value to the documented default value.
1003 tag <tagname>
1005 Select a certain tag
1006 goto <case-insensitive substring>
1008 Go to the next feed whose name contains the case-insensitive
1009 substring.
1010 source <filename> [...]
1012 Load the specified configuration files. This allows it to load
1013 alternative configuration files or reload already loaded
1014 configuration files on-the-fly from the filesystem.
1015 dumpconfig <filename>
1017 Save current internal state of configuration to file, so that it
1018 can be instantly reused as configuration file.
1019 <number>
1021 Jump to the <number>th entry in the current dialog
1022
1024 $HOME/.newsbeuter/config
1025 $HOME/.newsbeuter/urls
1027
1029 podbeuter(1). The documentation that comes with newsbeuter is a good
1030 source about the general use and configuration of newsbeuter.
1031
1033 Andreas Krennmair <ak@newsbeuter.org>, for contributors see AUTHORS
1034 file.
1035
1037 Andreas Krennmair <ak@newsbeuter.org>
1038 Author.
1039 02/19/2015 NEWSBEUTER(1)