1NEWSBEUTER(1) NEWSBEUTER(1)
2
6 newsbeuter - an RSS 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
14 newsbeuter is an RSS feed reader for text terminals. RSS is a number of
15 widely-used XML formats to transmit, publish and syndicate articles,
16 for example news or blog articles. Newsbeuter is designed to be used on
17 text terminals on Unix or Unix-like systems such as Linux, BSD or Mac
18 OS X.
19
22 -h
23 Display help
24 -r
26 Refresh feeds on start
27 -e
29 Export feeds as OPML to stdout
30 -X
32 Clean up cache thoroughly (i.e. reduce it in size if possible)
33 -v, -V
35 Get version information about newsbeuter and the libraries it uses
36 -i opmlfile
38 Import an OPML file
39 -u urlfile
41 Use an alternative URL file
42 -c cachefile
44 Use an alternative cache file
45 -C configfile
47 Use an alternative configuration file
48 -x command ...
50 Execute one or more commands to run newsbeuter unattended.
51 Currently available commands are "reload" and "print-unread".
52 -o
54 Active offline reading mode. When bloglines synchronization mode is
55 configured, then the list of feeds will not be loaded from
56 bloglines.com, but instead from the local cache. This makes it
57 possible to read locally cached articles even without internet
58 connection to connect to the bloglines server.
59 -l loglevel
61 Generate a loglevel with a certain loglevel. Valid loglevels are 1
62 to 6. An actual logfile will only be written when you provide a
63 logfile name.
64 -d logfile
66 Use this logfile as output when logging debug messages. Please note
67 that this only works when providing a loglevel.
68 -E file
70 Export a list of read articles (resp. their GUIDs). This can be
71 used to transfer information about read articles between different
72 computers.
73 -I file
75 Import a list of read articles and mark them as read if they are
76 held in the cache. This is to be used in conjunction with the -E
77 commandline parameter.
78
80 After you´ve installed newsbeuter, you can run it for the first time by
81 typing "newsbeuter" on your command prompt. This will bring you the
82 following message:
83 Error: no URLs configured. Please fill the file /home/ak/.newsbeuter/urls with RSS feed URLs or import an OPML file.
86 newsbeuter 2.3
88 usage: ./newsbeuter [-i <file>|-e] [-u <urlfile>] [-c <cachefile>] [-x <command> ...] [-h]
89 -e export OPML feed to stdout
90 -r refresh feeds on start
91 -i <file> import OPML file
92 -u <urlfile> read RSS feed URLs from <urlfile>
93 -c <cachefile> use <cachefile> as cache file
94 -C <configfile> read configuration from <configfile>
95 -X clean up cache thoroughly
96 -x <command>... execute list of commands
97 -o activate offline mode (only applies to bloglines synchronization mode)
98 -v get version information
99 -l <loglevel> write a log with a certain loglevel (valid values: 1 to 6)
100 -d <logfile> use <logfile> as output log file
101 -E <file> export list of read articles to <file>
102 -I <file> import list of read articles from <file>
103 -h this help
104 This means that newsbeuter can´t start without any configured feeds. To
105 add feeds to newsbeuter, you can either add URLs to the configuration
106 file $HOME/.newsbeuter/urls or you can import an OPML file by running
107 "newsbeuter -i blogroll.opml". To manually add URLs, open the file with
108 your favorite text editor and add the URLs, one per line:
109 http://rss.cnn.com/rss/cnn_topstories.rss
112 http://newsrss.bbc.co.uk/rss/newsonline_world_edition/front_page/rss.xml
113 If you need to add URLs that have restricted access via
114 username/password, simply provide the username/password in the
115 following way:
116 http://username:password@hostname.domain.tld/feed.rss
119 In order to protect username and password, make sure that
120 $HOME/.newsbeuter/urls has the appropriate permissions. Newsbeuter also
121 makes sure that usernames and passwords within URLs aren´t displayed in
122 its user interface. In case there is a @ in the username, you need to
123 write it as %40 instead so that it can be distinguished from the @ that
124 separates the username/password part from the hostname part.
125 You can also configure local files as feeds, by prefixing the local
127 path with "file://" and adding it to the $HOME/.newsbeuter/urls file:
128 file:///var/log/rss_eventlog.xml
131 Now you can run newsbeuter again, and it will present you with a
132 controllable list of the URLs that you configured previously. You can
133 now start downloading the feeds, either by pressing "R" to download all
134 feeds, or by pressing "r" to download the currently selected feed. You
135 can then select a feed you want to read, and by pressing "Enter", you
136 can go to the article list for this feed. This works even while the
137 downloading is still in progress. You can now see the list of available
138 articles by their title. A "N" on the left indicates that an article
139 wasn´t read yet. Pressing Enter brings you to the content of the
140 article. You can scroll through this text, and also run a browser
141 (default: lynx) to view the complete article if the content is empty or
142 just an abstract or a short description. Pressing "q" brings you back
143 to the article list, and pressing "q" again brings you back to the feed
144 list. Pressing "q" a third time then closes newsbeuter.
145 Newsbeuter caches the article that it downloads. This means that when
147 you start newsbeuter again and reload a feed, the old articles can
148 still be read even if they aren´t in the current RSS feeds anymore.
149 Optionally you can configure how many articles shall be preserved by
150 feed so that the article backlog doesn´t grow endlessly (see
151 "max-items" below).
152 Newsbeuter also uses a number of measures to preserve the users´ and
154 feed providers´ bandwidth, by trying to avoid unnecessary feed
155 downloads through the use of conditional HTTP downloading. It saves
156 every feed´s "Last-Modified" and "ETag" response header values (if
157 present) and advises the feed´s HTTP server to only send data if the
158 feed has been updated by modification date/time or "ETag" header. This
159 doesn´t only make feed downloads for RSS feeds with no new updates
160 faster, it also reduces the amount of transferred data per request.
161 Conditional HTTP downloading can be optionally disabled per feed by
162 using the "always-download" configuration command.
163 Several aspects of newsbeuter´s behaviour can be configured via a
165 configuration file, by default $HOME/.newsbeuter/config. This
166 configuration file contains lines in the form "<config-command> <arg1>
167 ...". The configuration file can also contain comments, which start
168 with the # character and go as far as the end of line. If you need to
169 enter a configuration argument that contains spaces, use quotes (")
170 around the whole argument. It´s even possible to integrate the output
171 of external commands into the configuration. The text between two
172 backticks ("`") is evaluated as shell command, and its output is put on
173 its place instead. This works like backtick evaluation in
174 Bourne-compatible shells and allows users to use external information
175 from the system within the configuration.
176 Searching for articles is possible in newsbeuter, too. Just press the
178 "/" key, enter your search phrase, and the title and content of all
179 articles are searched for it. When you do a search from the list of
180 feeds, all articles of all feeds will be searched. When you do a search
181 from the article list of a feed, only the articles of the currently
182 viewed feed are searched. When opening an article from a search result
183 dialog, the search phrase is highlighted.
184 The history of all your searches is saved to the filesystem, to
186 ~/.newsbeuter/history.search. By default, the last 100 search phrases
187 are stored, but this limited can be influenced through the
188 "history-limit" configuration variable. To disable search history
189 saving, simply set the history-limit to 0.
190
193 always-display-description (parameters: [true/false]; default value:
194 false)
195 If true, then the description will always displayed even if e.g. a
196 content:encoded tag has been found. (example:
197 always-display-description true)
198 always-download (parameters: <rssurl> [<rssurl>]; default value: n/a)
200 The parameters of this configuration command are one or more RSS
201 URLs. These URLs will always get downloaded, regardless of their
202 Last-Modified timestamp and ETag header. (example: always-download
203 "http://www.n-tv.de/23.rss")
204 article-sort-order (parameters: <sortfield>[-<direction>]; default
206 value: date)
207 The sortfield specifies which article property shall be used for
208 sorting (currently available: date, title, flags, author, link,
209 guid). The optional direction specifies the sort direction ("asc"
210 specifies ascending sorting, "desc" specifies descending sorting.
211 for date, "desc" is default, for all others, "asc" is default).
212 (example: article-sort-order author-desc)
213 articlelist-format (parameters: <format>; default value: "%4i %f %D %6L
215 %?T?;%-17T; ?%t")
216 This variable defines the format of entries in the article list.
217 See the respective section in the documentation for more
218 information on format strings (note that the semicolon should
219 actually be a vertical bar; this is a limitation in AsciiDoc).
220 (example: articlelist-format "%4i %f %D %?T?;%-17T; ?%t")
221 auto-reload (parameters: [yes/no]; default value: no)
223 If enabled, all feeds will be automatically reloaded at start up
224 and then continuously after a certain time has passed (see
225 reload-time). (example: auto-reload yes)
226 bind-key (parameters: <key> <operation> [<dialog>]; default value: n/a)
228 Bind key <key> to <operation>. This means that whenever <key> is
229 pressed, then <operation> is executed (if applicable in the current
230 dialog). A list of available operations can be found below.
231 Optionally, you can specify a dialog. If you specify one, the key
232 binding will only be added to the specified dialog. Available
233 dialogs are "all" (default if none is specified), "feedlist",
234 "filebrowser", "help", "articlelist", "article", "tagselection",
235 "filterselection", "urlview" and "podbeuter". (example: bind-key ^R
236 reload-all)
237 bloglines-auth (parameters: <login>:<password>; default value: "")
239 Set the Bloglines username and password. This is necessary for the
240 Bloglines synchronization mode. (example: bloglines-auth
241 "username@emailaddress.com:mypassword")
242 bloglines-mark-read (parameters: [yes/no]; default value: no)
244 If set to yes, it will mark all articles that are downloaded from
245 Bloglines as read. (example: bloglines-mark-read yes)
246 bookmark-cmd (parameters: <bookmark-command>; default value: "")
248 If set, then <bookmark-command> will be used as bookmarking plugin.
249 See the documentation on bookmarking for further information.
250 (example: bookmark-cmd "~/bin/delicious-bookmark.sh")
251 bookmark-interactive (parameters: [yes/no]; default value: no)
253 If set to yes, then the configured bookmark command is an
254 interactive program. (example: bookmark-interactive yes)
255 browser (parameters: <browser-command>; default value: lynx)
257 Set the browser command to use when opening an article in the
258 browser. If <browser-command> contains %u, it will be used as
259 complete commandline and %u will be replaced with the URL that
260 shall be opened. (example: browser "w3m %u")
261 cache-file (parameters: <path>; default value:
263 "~/.newsbeuter/cache.db")
264 This configuration option sets the cache file. This is especially
265 useful if the filesystem of your home directory doesn´t support
266 proper locking (e.g. NFS). (example: cache-file
267 "/tmp/testcache.db")
268 cleanup-on-quit (parameters: [yes/no]; default value: yes)
270 If yes, then the cache gets locked and superfluous feeds and items
271 are removed, such as feeds that can´t be found in the urls
272 configuration file anymore. (example: cleanup-on-quit no)
273 color (parameters: <element> <fgcolor> <bgcolor> [<attr> ...]; default
275 value: n/a)
276 Set the foreground color, background color and optional attributes
277 for a certain element (example: color background white black)
278 confirm-exit (parameters: [yes/no]; default value: no)
280 If set to yes, then newsbeuter will ask for confirmation whether
281 the user really wants to quit newsbeuter. (example: confirm-exit
282 yes)
283 datetime-format (parameters: <date/time format>; default value: %b %d)
285 This format specifies the date/time format in the article list. For
286 a detailed documentation on the allowed formats, consult the
287 manpage of strftime(3). (example: datetime-format "%D, %R")
288 define-filter (parameters: <name> <filter>; default value: n/a)
290 With this command, you can predefine filters, which can you later
291 select from a list, and which are then applied after selection.
292 This is especially useful for filters that you need often and you
293 don´t want to enter them every time you need them. (example:
294 define-filter "all feeds with fun tag" "tags # \\"fun\\"")
295 display-article-progress (parameters: [yes/no]; default value: yes)
297 If set to yes, then a read progress (in percent) is displayed in
298 the article view. Otherwise, no read progress is displayed.
299 (example: display-article-progress no)
300 download-retries (parameters: <number retries>; default value: 1)
302 How many times newsbeuter shall try to successfully download a feed
303 before giving up. This is an option to improve the success of
304 downloads on slow and shaky connections such as via a TOR proxy.
305 (example: download-retries 4)
306 download-timeout (parameters: <seconds>; default value: 30)
308 The number of seconds newsbeuter shall wait when downloading a feed
309 before giving up. This is an option to improve the success of
310 downloads on slow and shaky connections such as via a TOR proxy.
311 (example: download-timeout 60)
312 error-log (parameters: <path>; default value: "")
314 If set, then user errors (e.g. errors regarding defunct RSS feeds)
315 will be logged to this file. (example: error-log
316 "~/.newsbeuter/error.log")
317 feed-sort-order (parameters: <sortorder>; default value: none)
319 If set to "firsttag", the feeds in the feed list will be sorted by
320 their first tag in the urls file. (example: feed-sort-order
321 firsttag)
322 feedlist-format (parameters: <format>; default value: "%4i %n %11u %t")
324 This variable defines the format of entries in the feed list. See
325 the respective section in the documentation for more information on
326 format strings. (example: feedlist-format " %n %4i - %11u -%> %t")
327 googlereader-flag-share (parameters: <flag>; default value: "")
329 If this is set and Google Reader support is used, then all articles
330 that are flagged with the specified flag are being "shared" in
331 Google Reader so that people that follow you can see it. (example:
332 googlereader-flag-share "a")
333 googlereader-flag-star (parameters: <flag>; default value: "")
335 If this is set and Google Reader support is used, then all articles
336 that are flagged with the specified flag are being "starred" in
337 Google Reader and appear in the list of "Starred items". (example:
338 googlereader-flag-star "b")
339 googlereader-login (parameters: <login>; default value: "")
341 This variable sets your Google Reader login for the Google Reader
342 support. (example: googlereader-login "your-login")
343 googlereader-password (parameters: <password>; default value: "")
345 This variable sets your Google Reader password for the Google
346 Reader support. (example: google-password "your-password")
347 googlereader-show-special-feeds (parameters: [yes/no]; default value:
349 yes)
350 If this is set, then "special feeds" like "People you follow"
351 (articles shared by people you follow), "Starred items" (your
352 starred articles), "Shared items" (your shared articles) and
353 "Popular items" (articles considered to be popular by Google´s
354 magic algorithms) appear in your subscription list. (example:
355 googlereader-show-special-feeds "no")
356 goto-first-unread (parameters: [yes/no]; default value: yes)
358 If set to yes (the default), then the first unread article will be
359 selected whenever a feed is entered. (example: goto-first-unread
360 no)
361 goto-next-feed (parameters: [yes/no]; default value: yes)
363 If set to yes, then the next-unread and prev-unread keys will
364 search in other feeds for unread articles if all articles in the
365 current feed are read. If set to no, then the next-unread and
366 prev-unread keys will stop in the current feed. (example:
367 goto-next-feed no)
368 highlight (parameters: <target> <regex> <fgcolor> [<bgcolor>
370 [<attribute> ...]]; default value: n/a)
371 With this command, you can highlight text parts in the feed list,
372 the article list and the article view. For a detailed
373 documentation, see the chapter on highlighting. (example: highlight
374 all "newsbeuter" red)
375 highlight-article (parameters: <filterexpr> <fgcolor> <bgcolor>
377 [<attribute> ...]; default value: n/a)
378 With this command, you can highlight articles in the article list
379 if they match a filter expression. For a detailed documentation,
380 see the chapter on highlighting. (example: highlight-article
381 "author =~ \\"Andreas Krennmair\\"" white red bold)
382 history-limit (parameters: <number>; default value: 100)
384 Defines the maximum number of entries of commandline resp. search
385 history to be saved. To disable history saving, set history-limit
386 to 0. (example: history-limit 0)
387 html-renderer (parameters: <path>; default value: internal)
389 If set to "internal", then the internal HTML renderer will be used.
390 Otherwise, the specified command will be executed, the HTML to be
391 rendered will be written to the command´s stdin, and the program´s
392 output will be displayed. This makes it possible to use other,
393 external programs, such as w3m, links or lynx, to render HTML.
394 (example: html-renderer "w3m -dump -T text/html")
395 ignore-article (parameters: <feed> <filterexpr>; default value: n/a)
397 If a downloaded article from <feed> matches <filterexpr>, then it
398 is ignored and not presented to the user. This command is further
399 explained in the "kill file" section below. (example:
400 ignore-article "*" "title =~ \\"Windows\\"")
401 ignore-mode (parameters: [download/display]; default value: download)
403 This configuration option defines in what way an article is ignored
404 (see ignore-article). If set to "download", then it is ignored in
405 the download/parsing phase (which is the default) and thus never
406 written to the cache, if it set to "display", it is ignored when
407 displaying articles but is kept in the cache. (example: ignore-mode
408 "display")
409 include (parameters: <path>; default value: n/a)
411 With this command, you can include other files to be interpreted as
412 configuration files. This is especially useful to separate your
413 configuration into several files, e.g. key configuration, color
414 configuration, ... (example: include "~/.newsbeuter/colors")
415 keep-articles-days (parameters: <days>; default value: 0)
417 If set the a number greater than 0, only articles that are were
418 published within the last <n> days are kept, and older articles are
419 deleted. If set to 0 (default value), this option is not active.
420 (example: keep-articles-days 30)
421 macro (parameters: <macro key> <command list>; default value: n/a)
423 With this command, you can define a macro key and specify a list of
424 commands that shall be executed when the macro prefix and the macro
425 key are pressed. (example: macro k open ; reload ; quit)
426 mark-as-read-on-hover (parameters: [yes/no]; default value: no)
428 If set to yes, then all articles that get selected in the article
429 list are marked as read. (example: mark-as-read-on-hover yes)
430 max-items (parameters: <number>; default value: 0)
432 Set the number of articles to maximally keep per feed. If the
433 number is set to 0, then all articles are kept. (example: max-items
434 100)
435 notify-format (parameters: <string>; default value: "newsbeuter:
437 finished reload, %f unread feeds (%n unread articles total)")
438 Format string that is used for formatting notifications. See the
439 chapter on format strings for more information. (example:
440 notify-format "%d new articles (%n unread articles, %f unread
441 feeds)")
442 notify-program (parameters: <path>; default value: "")
444 If set, then the configured program will be executed if new
445 articles arrived (through a reload) or if notify-always is true.
446 The first parameter of the called program contains the notification
447 message. (example: notify-program "~/bin/my-notifier")
448 notify-always (parameters: [yes/no]; default value: no)
450 If no, notifications will only be made when there are new feeds or
451 articles. If yes, notifications will be made regardless. (example:
452 notify-always yes)
453 notify-screen (parameters: [yes/no]; default value: no)
455 If yes, then a "privacy message" will be sent to the terminal,
456 containing a notification message about new articles. This is
457 especially useful if you use terminal emulations such as GNU screen
458 which implement privacy messages. (example: notify-screen yes)
459 notify-xterm (parameters: [yes/no]; default value: no)
461 If yes, then the xterm window title will be set to a notification
462 message about new articles. (example: notify-xterm yes)
463 notify-beep (parameters: [yes/no]; default value: no)
465 If yes, then the speaker beep on new articles. (example:
466 notify-beep yes)
467 opml-url (parameters: <url> ...; default value: "")
469 If the OPML online subscription mode is enabled, then the list of
470 feeds will be taken from the OPML file found on this location.
471 Optionally, you can specify more than one URL. All the listed OPML
472 URLs will then be taken into account when loading the feed list.
473 (example: opml-url "http://host.domain.tld/blogroll.opml"
474 "http://example.com/anotheropmlfile.opml")
475 pager (parameters: [<path>/internal]; default value: internal)
477 If set to "internal", then the internal pager will be used.
478 Otherwise, the article to be displayed will be rendered to be a
479 temporary file and then displayed with the configured pager. If the
480 pager path is set to an empty string, the content of the "PAGER"
481 environment variable will be used. If the pager path contains a
482 placeholder "%f", it will be replaced with the temporary filename.
483 (example: less %f)
484 podcast-auto-enqueue (parameters: [yes/no]; default value: no)
486 If yes, then all podcast URLs that are found in articles are added
487 to the podcast download queue. See the respective section in the
488 documentation for more information on podcast support in
489 newsbeuter. (example: podcast-auto-enqueue yes)
490 prepopulate-query-feeds (parameters: [yes/no]; default value: no)
492 If yes, then all query feeds are prepopulated with articles on
493 startup. (example: prepopulate-query-feeds yes)
494 proxy (parameters: <server:port>; default value: n/a)
496 Set the proxy to use for downloading RSS feeds. (example: proxy
497 localhost:3128)
498 proxy-auth (parameters: <auth>; default value: n/a)
500 Set the proxy authentication string. (example: proxy-auth
501 user:password)
502 proxy-type (parameters: <type>; default value: http)
504 Set proxy type. Allowed values: http, socks4, socks4a, socks5.
505 (example: proxy-type socks5)
506 refresh-on-startup (parameters: [yes/no]; default value: no)
508 If yes, then all feeds will be reloaded when newsbeuter starts up.
509 This is equivalent to the -r commandline option. (example:
510 refresh-on-startup yes)
511 reload-only-visible-feeds (parameters: [yes/no]; default value: no)
513 If yes, then manually reloading all feeds will only reload the
514 currently visible feeds, e.g. if a filter or a tag is set.
515 (example: reload-only-visible-feeds yes)
516 reload-time (parameters: <number>; default value: 60)
518 The number of minutes between automatic reloads. (example:
519 reload-time 120)
520 reload-threads (parameters: <number>; default value: 1)
522 The number of parallel reload threads that shall be started when
523 all feeds are reloaded. (example: reload-threads 3)
524 reset-unread-on-update (parameters: <url> ...; default value: n/a)
526 With this configuration command, you can provide a list of RSS feed
527 URLs for whose articles the unread flag will be reset if an article
528 has been updated, i.e. its content has been changed. This is
529 especially useful for RSS feeds where single articles are updated
530 after publication, and you want to be notified of the updates.
531 (example: reset-unread-on-update
532 "http://blog.fefe.de/rss.xml?html")
533 save-path (parameters: <path>; default value: ~/)
535 The default path where articles shall be saved to. If an invalid
536 path is specified, the current directory is used. (example:
537 save-path "~/Saved Articles")
538 search-highlight-colors (parameters: <fgcolor> <bgcolor> [<attribute>
540 ...]; default value: black yellow bold)
541 This configuration command specifies the highlighting colors when
542 searching for text from the article view. (example:
543 search-highlight-colors white black bold)
544 show-keymap-hint (parameters: [yes/no]; default value: yes)
546 If no, then the keymap hints on the bottom of screen will not be
547 displayed. (example: show-keymap-hint no)
548 show-read-feeds (parameters: [yes/no]; default value: yes)
550 If yes, then all feeds, including those without unread articles,
551 are listed. If no, then only feeds with one or more unread articles
552 are list. (example: show-read-feeds no)
553 show-read-articles (parameters: [yes/no]; default value: yes)
555 If yes, then all articles of a feed are listed in the article list.
556 If no, then only unread articles are listed. (example:
557 show-read-articles no)
558 suppress-first-reload (parameters: [yes/no]; default value: no)
560 If yes, then the first automatic reload will be suppressed if
561 auto-reload is set to yes. (example: suppress-first-reload yes)
562 text-width (parameters: <number>; default value: 0)
564 If set to a number greater than 0, then all HTML will be rendered
565 to this maximum line length. If set to 0, the terminal width will
566 be used. (example: text-width 72)
567 unbind-key (parameters: <key> [<dialog>]; default value: n/a)
569 Unbind key <key>. This means that no operation is called when <key>
570 is pressed. Optionally, you can specify a dialog (for a list of
571 available dialogs, see "bind-key" above). If you specify one, the
572 key binding will only be unbound for the specified dialog.
573 (example: unbind-key R)
574 urls-source (parameters: <source>; default value: "local")
576 This configuration command sets the source where URLs shall be
577 retrieved from. By default, this is ~/.newsbeuter/urls.
578 Alternatively, you can set it to "bloglines", which enables
579 newsbeuter´s Bloglines synchronization mode, to "opml", which
580 enables newsbeuter´s OPML online subscription mode, or to
581 "googlereader", which enables newsbeuter´s Google Reader support.
582 In order to make Google Reader support work correctly, you also
583 need to set googlereader-login and googlereader-password. (example:
584 urls-source "bloglines")
585 use-proxy (parameters: [yes/no]; default value: no)
587 If yes, then the configured proxy will be used for downloading the
588 RSS feeds. (example: use-proxy yes)
589 user-agent (parameters: <user agent string>; default value: "")
591 If set to a non-zero-length string, this value will be used as HTTP
592 User-Agent header for all HTTP requests. (example: user-agent
593 "Lynx/2.8.5rel.1 libwww-FM/2.14")
594
596 open (default key: ENTER)
597 Open the currently selected feed or article.
598 quit (default key: q)
600 Quit the program or return to the previous dialog (depending on the
601 context).
602 reload (default key: r)
604 Reload the currently selected feed.
605 reload-all (default key: R)
607 Reload all feeds.
608 mark-feed-read (default key: A)
610 Mark all articles in the currently selected feed read.
611 mark-all-feeds-read (default key: C)
613 Mark articles in all feeds read.
614 save (default key: s)
616 Save the currently selected article to a file.
617 next-unread (default key: n)
619 Jump to the next unread article.
620 prev-unread (default key: p)
622 Jump to the previous unread article.
623 random-unread (default key: ^K)
625 Jump to a random unred article.
626 open-in-browser (default key: o)
628 Opens the URL associated with the current article.
629 open-in-browser-and-mark-read (default key: O)
631 Opens the URL associated with the current article and marks the
632 article as read.
633 help (default key: ?)
635 Runs the help screen.
636 toggle-source-view (default key: ^U)
638 Toggles between the HTML view and the source view in the article
639 view.
640 toggle-article-read (default key: N)
642 Toggle the read flag for the currently selected article.
643 toggle-show-read-feeds (default key: l)
645 Toggle whether read feeds should be shown in the feed list.
646 show-urls (default key: u)
648 Show all URLs in the article in a list (similar to urlview).
649 clear-tag (default key: ^T)
651 Clear current tag.
652 set-tag (default key: t)
654 Select tag.
655 open-search (default key: /)
657 Opens the search dialog. When a search is done in the article list,
658 then the search operation only applies to the articles of the
659 current feed, otherwise to all articles.
660 goto-url (default key: #)
662 Open the URL dialog and then opens specified URL.
663 enqueue (default key: e)
665 Add the podcast download URL of the current article (if any is
666 found) to the podcast download queue (see the respective section in
667 the documentation for more information on podcast support).
668 edit-urls (default key: E)
670 Edit the list of subscribed URLs. newsbeuter will start the editor
671 configured through the $VISUAL environment variable (if unset,
672 $EDITOR is used; fallback: "vi"). When editing is finished,
673 newsbeuter will reload the URLs file.
674 reload-urls (default key: ^R)
676 Reload the URLs configuration file.
677 redraw (default key: ^L)
679 Redraw the screen.
680 cmdline (default key: <colon>)
682 Open the command line.
683 set-filter (default key: F)
685 Set a filter.
686 select-filter (default key: f)
688 Select a predefined filter.
689 clear-filter (default key: ^F)
691 Clear currently set filter.
692 bookmark (default key: ^B)
694 Bookmark currently selected article or URL.
695 edit-flags (default key: ^E)
697 Edit the flags of the currently selected article.
698 next-unread-feed (default key: ^N)
700 Go to the next feed with unread articles. This only works from the
701 article list.
702 prev-unread-feed (default key: ^P)
704 Go to the previous feed with unread articles. This only works from
705 the article list.
706 delete-article (default key: D)
708 Delete the currently selected article.
709 purge-deleted (default key: $)
711 Purge all article that are marked as deleted from the article list.
712 view-dialogs (default key: v)
714 View list of open dialogs.
715 close-dialog (default key: ^X)
717 Close currently selected dialog.
718 next-dialog (default key: ^V)
720 Go to next dialog.
721 prev-dialog (default key: ^G)
723 Go to previous dialog.
724 pipe-to (default key: |)
726 Pipe article to command.
727 sort (default key: g)
729 Sort feeds/articles by interactively choosing the sort method.
730 revsort (default key: G)
732 Sort feeds/articles by interactively choosing the sort method
733 (reversed).
734 up (default key: UP)
736 Goes up one item in the list.
737 down (default key: DOWN)
739 Goes down one item in the list.
740 pageup (default key: PPAGE)
742 Goes up one page in the list.
743 pagedown (default key: NPAGE)
745 Goes down one page in the list.
746
748 Newsbeuter comes with the possibility to categorize or "tag", as we
749 call it, RSS feeds. Every RSS feed can be assigned 0 or more tags.
750 Within newsbeuter, you can then select to only show RSS feeds that
751 match a certain tag. That makes it easy to categorize your feeds in a
752 flexible and powerful way.
753 Usually, the ~/.newsbeuter/urls file contains one RSS feed URL per
755 line. To assign a tag to an RSS feed, simply attach it as a single
756 word, separated by blanks such as space or tab. If the tag needs to
757 contain spaces, you must use quotes (") around the tag (see example
758 below). An example ~/.newsbeuter/urls file may look like this:
759 http://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
762 http://rss.orf.at/news.xml news orf
763 http://www.heise.de/newsticker/heise.rdf news interesting
764 When you now start newsbeuter with this configuration, you can press
765 "t" to select a tag. When you select the tag "news", you will see all
766 three RSS feeds. Pressing "t" again and e.g. selecting the "conspiracy"
767 tag, you will only see the http://blog.fefe.de/rss.xml?html RSS feed.
768 Pressing "^T" clears the current tag, and again shows all RSS feeds,
769 regardless of their assigned tags.
770 A special type of tag are tags that start with the tilde character
772 ("~"). When such a tag is found, the feed title is set to the tag name
773 (excluding the ~ character). With this feature, you can give feeds any
774 title you want in your feed list:
775 http://rss.orf.at/news.xml "~ORF News"
778
780 From version 0.4 on, newsbeuter contains support for Snownews
781 extensions. The RSS feed readers Snownews and Liferea share a common
782 way of extending the readers with custom scripts. Two mechanisms,
783 namely "execurl" and "filter" type scripts, are available and supported
784 by newsbeuter.
785 An "execurl" script can be any program that gets executed and whose
787 output is interpreted as RSS feed, while "filter" scripts are fed with
788 the content of a configured URL and whose output is interpreted as RSS
789 feed.
790 The configuration is simple and straight-forward. Just add to your
792 ~/.newsbeuter/urls file configuration lines like the following ones:
793 exec:~/bin/execurl-script
796 filter:~/bin/filter-script:http://some.test/url
797 The first line shows how to add an execurl script to your
798 configuration: start the line with "exec:" and then immediately append
799 the path of the script that shall be executed. If this script requires
800 additional parameters, simply use quotes:
801 "exec:~/bin/execurl-script param1 param2"
804 The second line shows how to add a filter script to your configuration:
805 start the line with "filter:", then immediately append the path of the
806 script, then append a colon (":"), and then append the URL of the file
807 that shall be fed to the script. Again, if the script requires any
808 parameters, simply quote:
809 "filter:~/bin/filter-script param1 param2:http://url/foobar"
812 In both cases, the tagging feature as described above is still
813 available:
814 exec:~/bin/execurl-script tag1 tag2 "quoted tag"
817 filter:~/bin/filter-script:http://some.test/url tag3 tag4 tag5
818 A collection of such extension scripts can be found on this website:
819 http://kiza.kcore.de/software/snownews/snowscripts/extensions
820 If you want to write your own extensions, refer to this website for
822 further instructions:
823 http://kiza.kcore.de/software/snownews/snowscripts/writing
824
827 Like other text-oriented software, newsbeuter contains an internal
828 commandline to modify configuration variables ad hoc and to run own
829 commands. It provides a flexible access to the functionality of
830 newsbeuter which is especially useful for advanced users.
831 To start the commandline, type ":". You will see a ":" prompt at the
833 bottom of the screen, similar to tools like vi(m) or mutt. You can now
834 enter commands. Pressing the return key executes the command (possibly
835 giving feedback to the user) and closes the commandline. You can cancel
836 entering commands by pressing the ESC key. The history of all the
837 commands that you enter will be saved to ~/.newsbeuter/history.cmdline.
838 The backlog is limited to 100 entries by default, but can be influenced
839 by setting the "history-limit" configuration variable. To disable
840 history saving, set the history-limit to 0.
841 Starting with newsbeuter 2.0, the commandline provides you with some
843 help if you can´t remember the full names of commandline commands. By
844 pressing the TAB key, newsbeuter will try to automatically complete
845 your command. If there is more than one possible completion, you can
846 subsequently press the TAB key to cycle through all results. If no
847 match is found, no suggestion will be inserted into the commandline.
848 For the "set" command, the completion also works for configuration
849 variable names.
850 In additon, some common key combination such as Ctrl-G (to cancel
852 input), Ctrl-K (to delete text from the cursor position to the end of
853 line), Ctrl-U (to clear the whole line) and Ctrl-W (to delete the word
854 before the current cursor position) were added.
855 Please be aware that the input history of both the command line and the
857 search functions are saved to the filesystems, to the files
858 ~/.newsbeuter/history.cmdline resp. ~/.newsbeuter/history.search. By
859 default, the last 100 entries are saved, but this can be configured
860 (configuratin variable history-limit) and also totally disabled (by
861 setting said variable to 0).
862 Currently, the following command line commands are available:
864 quit
866 Quit newsbeuter
867 save <filename>
869 Save current article to <filename>
870 set <variable>[=<value>|&|!]
872 Set (or get) configuration variable value. Specifying a ! after
873 the name of a boolean configuration variable toggles their values,
874 a & directly after the name of a configuration variable of any type
875 resets its value to the documented default value.
876 tag <tagname>
878 Select a certain tag
879 goto <case-insensitive substring>
881 Go to the next feed whose name contains the case-insensitive
882 substring.
883 source <filename> [...]
885 Load the specified configuration files. This allows it to load
886 alternative configuration files or reload already loaded
887 configuration files on-the-fly from the filesystem.
888 dumpconfig <filename>
890 Save current internal state of configuration to file, so that it
891 can be instantly reused as configuration file.
892 <number>
894 Jump to the <number>th entry in the current dialog
895
897 $HOME/.newsbeuter/config
898 $HOME/.newsbeuter/urls
900
903 podbeuter(1). The documentation that comes with newsbeuter is a good
904 source about the general use and configuration of newsbeuter.
905
908 Andreas Krennmair <ak@newsbeuter.org>, for contributors see AUTHORS
909 file.
910
913 1. ak@newsbeuter.org
914 mailto:ak@newsbeuter.org
915 05/29/2010 NEWSBEUTER(1)