1NEWSBOAT(1) NEWSBOAT(1)
2
6 newsboat - an RSS/Atom feed reader for text terminals
7
9 newsboat [-r] [-e] [-i opmlfile] [-u urlfile] [-c cachefile] [-C
10 configfile] [-X] [-o] [-x <command> ...] [-h]
11
13 Newsboat 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. Newsboat is
16 designed to be used on text terminals on Unix or Unix-like systems such
17 as GNU/Linux, BSD or macOS.
18
20 -h, --help
21 Display help
22 -r, --refresh-on-start
24 Refresh feeds on start
25 -e, --export-to-opml
27 Export feeds as OPML to stdout
28 -X, --vacuum
30 Compact the cache by: 1) reclaiming the space that was left empty
31 when data was deleted; and 2) defragmenting the entries in the
32 cache. This doesn’t delete the entries; for that, see
33 cleanup-on-quit, delete-read-articles-on-quit, keep-articles-days,
34 and max-items settings.
35 --cleanup
37 Remove unreferenced entries from the cache and quit Newsboat. Feeds
38 and their articles will be removed if the feedurl is no longer in
39 the urls file.
40 Additionally, if the delete-read-articles-on-quit configuration is
42 set, all read articles will be deleted (including articles of feeds
43 which are still in the urls file).
44 -v, -V, --version
46 Get version information about Newsboat and the libraries it uses
47 -i opmlfile, --import-from-opml=opmlfile
49 Import an OPML file
50 -u urlfile, --url-file=urlfile
52 Use an alternative URL file
53 -c cachefile, --cache-file=cachefile
55 Use an alternative cache file
56 -C configfile, --config-file=configfile
58 Use an alternative configuration file
59 -x command ..., --execute=command...
61 Execute one or more commands to run Newsboat unattended. Currently
62 available commands are "reload" and "print-unread".
63 -l loglevel, --log-level=loglevel
65 Generate a logfile with a certain loglevel. Valid loglevels are 1
66 to 6. An actual logfile will only be written when you provide a
67 logfile name.
68 -d logfile, --log-file=logfile
70 Use this logfile as output when logging debug messages. Please note
71 that this only works when providing a loglevel.
72 -E file, --export-to-file=file
74 Export a list of read articles (resp. their GUIDs). This can be
75 used to transfer information about read articles between different
76 computers.
77 -I file, --import-from-file=file
79 Import a list of read articles and mark them as read if they are
80 held in the cache. This is to be used in conjunction with the -E
81 commandline parameter.
82
84 After you’ve installed Newsboat, you can run it for the first time by
85 typing newsboat on your command prompt. This will bring you the
86 following message:
87 Error: no URLs configured. Please fill the file /home/ak/.newsboat/urls with RSS feed URLs or import an OPML file.
89 newsboat 2.22
91 usage: ./newsboat [-i <file>|-e] [-u <urlfile>] [-c <cachefile>] [-x <command> ...] [-h]
92 -e, --export-to-opml export OPML feed to stdout
93 -r, --refresh-on-start refresh feeds on start
94 -i, --import-from-opml=<file> import OPML file
95 -u, --url-file=<urlfile> read RSS feed URLs from <urlfile>
96 -c, --cache-file=<cachefile> use <cachefile> as cache file
97 -C, --config-file=<configfile> read configuration from <configfile>
98 -X, --vacuum compact the cache
99 -x, --execute=<command>... execute list of commands
100 -q, --quiet quiet startup
101 -v, --version get version information
102 -l, --log-level=<loglevel> write a log with a certain loglevel (valid values: 1 to 6)
103 -d, --log-file=<logfile> use <logfile> as output log file
104 -E, --export-to-file=<file> export list of read articles to <file>
105 -I, --import-from-file=<file> import list of read articles from <file>
106 -h, --help this help
107 --cleanup remove unreferenced items from cache
108 This means that Newsboat can’t start without any configured feeds. To
110 add feeds to Newsboat, you can either add URLs to the configuration
111 file ~/.newsboat/urls or you can import an OPML file by running
112 newsboat -i blogroll.opml. To manually add URLs, open the file with
113 your favorite text editor and add the URLs, one per line:
114 http://rss.cnn.com/rss/cnn_topstories.rss
116 http://newsrss.bbc.co.uk/rss/newsonline_world_edition/front_page/rss.xml
117 If you need to add URLs that have restricted access via
119 username/password, simply provide the username/password in the
120 following way:
121 https://username:password@hostname.domain.tld/feed.rss
123 In order to protect username and password, make sure that
125 ~/.newsboat/urls is only readable by you and, optionally, your group:
126 $ chmod u=rw,g=r,o= ~/.newsboat/urls
128 Newsboat also makes sure that usernames and passwords within URLs
130 aren’t displayed in its user interface. In case there is a @ in the
131 username, you need to write it as %40 instead so that it can be
132 distinguished from the @ that separates the username/password part from
133 the hostname part.
134 You can also configure local files as feeds, by prefixing the local
136 path with file:// and adding it to the urls file:
137 file:///var/log/rss_eventlog.xml
139 Now you can run Newsboat again, and it will present you with a
141 controllable list of the URLs that you configured previously. You can
142 now start downloading the feeds, either by pressing "R" to download all
143 feeds, or by pressing "r" to download the currently selected feed. You
144 can then select a feed you want to read, and by pressing "Enter", you
145 can go to the article list for this feed. This works even while the
146 downloading is still in progress.
147 You can now see the list of available articles by their title. A "N" on
149 the left indicates that an article wasn’t read yet. Pressing "Enter"
150 brings you to the content of the article. You can scroll through this
151 text, and also run a browser (default: lynx) to view the complete
152 article if the content is empty or just an abstract or a short
153 description. Each URL in the article has a number next to it; to open
154 it, type # and then the number, then press "Enter". For single-digit
155 links, like 3, you can just press that number on the keyboard.
156 Pressing "q" brings you back to the article list, and pressing "q"
158 again brings you back to the feed list. Pressing "q" a third time then
159 closes Newsboat.
160 Newsboat caches the article that it downloads. This means that when you
162 start Newsboat again and reload a feed, the old articles can still be
163 read even if they aren’t in the current RSS feeds anymore. Optionally
164 you can configure how many articles shall be preserved by feed so that
165 the article backlog doesn’t grow endlessly (see max-items below).
166 Newsboat also uses a number of measures to preserve the users' and feed
168 providers' bandwidth, by trying to avoid unnecessary feed downloads
169 through the use of conditional HTTP downloading. It saves every feed’s
170 "Last-Modified" and "ETag" response header values (if present) and
171 advises the feed’s HTTP server to only send data if the feed has been
172 updated by modification date/time or "ETag" header. This doesn’t only
173 make feed downloads for RSS feeds with no new updates faster, it also
174 reduces the amount of transferred data per request. Conditional HTTP
175 downloading can be optionally disabled per feed by using the
176 always-download configuration command.
177 Several aspects of Newsboat’s behaviour can be configured via a
179 configuration file config, which is stored next to the urls file. This
180 configuration file contains lines in the form <config-command> <arg1>
181 .... The configuration file can also contain comments, which start with
182 the # character and go as far as the end of line. If you need to enter
183 a configuration argument that contains spaces, use quotes (") around
184 the whole argument. It’s even possible to integrate the output of
185 external commands into the configuration. The text between two
186 backticks (`) is evaluated as shell command, and its output is put on
187 its place instead. This works like backtick evaluation in
188 Bourne-compatible shells and allows users to use external information
189 from the system within the configuration. Backticks and # characters
190 can be escaped with a backslash (e.g. \` and \#); in that case, they’ll
191 be replaced with literal ` or # in the configuration.
192 Searching for articles is possible in Newsboat, too. Just press the "/"
194 key, enter your search phrase, and the title and content of all
195 articles are searched for it. When you do a search from the list of
196 feeds, all articles of all feeds will be searched. When you do a search
197 from the article list of a feed, only the articles of the currently
198 viewed feed are searched. When opening an article from a search result
199 dialog, the search phrase is highlighted.
200 The history of all your searches is saved to the filesystem, to the
202 history.search file (stored next to the cache.db file). By default, the
203 last 100 search phrases are stored, but this limited can be influenced
204 through the history-limit configuration variable. To disable search
205 history saving, simply set the history-limit to 0.
206 Keys, as used in the bind-key configuration command, use a special
208 syntax. Lowercase keys, uppercase keys and special characters are
209 written literally. The "Enter" key is written as ENTER, "Tab" key as
210 TAB, and the "Esc" key is written as ESC. The function keys "F1" to
211 "F12" are written as F1 to F12. The "Space" key is written as SPACE.
212 Key combinations with the "Ctrl" key, such as "Ctrl-R", are written as
213 ^R. Please be aware that all Ctrl-related key combinations need to be
214 written in uppercase. The following identifiers for keys are supported:
215 • ENTER (Enter key)
217 • BACKSPACE (backspace key)
219 • LEFT (left cursor)
221 • RIGHT (right cursor)
223 • UP (up cursor)
225 • DOWN (down cursor)
227 • PPAGE (page up cursor)
229 • NPAGE (page down cursor)
231 • HOME (cursor to beginning of list/article)
233 • END (cursor to end of list/article)
235 • ESC (Esc key)
237 • TAB (Tab key)
239 Newsboat also comes with user contributed content like scripts and
241 color themes. The user contributed content can be found in
242 /usr/share/doc/newsboat/contrib/. End users are encouraged to take a
243 look as they may find something useful.
244
246 always-display-description (parameters: [yes/no]; default value: no)
247 If set to yes, then the description will always be displayed even
248 if e.g. a <content:encoded> tag has been found. (example:
249 always-display-description yes)
250 always-download (parameters: <url> [<url>...]; default value: n/a)
252 Specifies one or more feed URLs that should always be downloaded,
253 regardless of their Last-Modified timestamp and ETag header. This
254 option can be specified multiple times. (example: always-download
255 "https://www.n-tv.de/23.rss")
256 article-sort-order (parameters: <sortfield>[-<direction>]; default
258 value: date)
259 The <sortfield> specifies which article property shall be used for
260 sorting, currently available are: date, title, flags, author, link,
261 guid and random. The optional <direction> specifies the sort
262 direction. asc specifies ascending sorting, desc specifies
263 descending sorting. Note that direction does not affect random sort
264 order. For date, desc is default, for all others, asc is default.
265 (example: article-sort-order author-desc)
266 articlelist-format (parameters: <format>; default value: "%4i %f %D %6L
268 %?T?|%-17T| ?%t")
269 This variable defines the format of entries in the article list.
270 See the respective section in the documentation for more
271 information on format strings. (example: articlelist-format "%4i %f
272 %D %?T?|%-17T| ?%t")
273 articlelist-title-format (parameters: <format>; default value: "%N %V -
275 Articles in feed '%T' (%u unread, %t total)%?F? matching filter `%F'&?
276 - %U" (localized))
277 Format of the title in article list. See "Format Strings" section
278 of Newsboat manual for details on available formats. (example:
279 articlelist-title-format "Articles in feed '%T' (%u unread)")
280 auto-reload (parameters: [yes/no]; default value: no)
282 If set to yes, all feeds will be automatically reloaded at start up
283 and then continuously after a certain time has passed (see
284 reload-time). (example: auto-reload yes)
285 bind-key (parameters: <key> <operation> [<dialog>]; default value: n/a)
287 Bind key <key> to <operation>. This means that whenever <key> is
288 pressed, then <operation> is executed (if applicable in the current
289 dialog). See [_newsboat_operations] and [_podboat_operations] for
290 lists of available <operation> values. Optionally, you can specify
291 a dialog. If you specify one, the key binding will only be added to
292 the specified dialog. Available dialogs are all (default if none is
293 specified), feedlist, filebrowser, help, articlelist, article,
294 tagselection, filterselection, urlview, podboat, and dirbrowser.
295 (example: bind-key ^R reload-all)
296 bookmark-autopilot (parameters: [yes/no]; default value: no)
298 If set to yes, the configured bookmark command is executed without
299 any further input asked from user, unless the url or the title
300 cannot be found/guessed. (example: bookmark-autopilot yes)
301 bookmark-cmd (parameters: <command>; default value: "")
303 If set, then <command> will be used as bookmarking plugin. See the
304 documentation on bookmarking for further information. (example:
305 bookmark-cmd "~/bin/delicious-bookmark.sh")
306 bookmark-interactive (parameters: [yes/no]; default value: no)
308 If set to yes, then the configured bookmark command is an
309 interactive program. (example: bookmark-interactive yes)
310 browser (parameters: <command>; default value: %BROWSER, otherwise
312 lynx)
313 Set the browser command to use when opening an article in the
314 browser. If the BROWSER environment variable is set, it will be
315 used as the default browser, otherwise lynx will be used. Any
316 occurrences of %u in <command> will be replaced by the URL being
317 opened, enclosed in single quotes. Any occurrences of %F in
318 <command> will be replaced by the feed’s URL in single quotes.
319 (example: browser "w3m %u")
320 cache-file (parameters: <path>; default value: "~/.newsboat/cache.db"
322 or "~/.local/share/cache.db" (see "Files" section))
323 This configuration option sets the cache file. This is especially
324 useful if the filesystem of your home directory doesn’t support
325 proper locking (e.g. NFS). (example: cache-file
326 "/tmp/testcache.db")
327 cleanup-on-quit (parameters: [yes/no]; default value: yes)
329 If set to yes, then the cache gets locked and superfluous feeds and
330 items are removed, such as feeds that can’t be found in the urls
331 configuration file anymore. (example: cleanup-on-quit no)
332 color (parameters: <element> <fgcolor> <bgcolor> [<attribute> ...];
334 default value: n/a)
335 Set the foreground color, background color and optional attributes
336 for a certain element. (example: color background white black)
337 confirm-delete-all-articles (parameters: [yes/no]; default value: yes)
339 If set to yes, then Newsboat will ask for confirmation whether the
340 user wants to delete all articles. (example:
341 confirm-delete-all-articles no)
342 confirm-mark-all-feeds-read (parameters: [yes/no]; default value: yes)
344 If set to yes, then Newsboat will ask for confirmation whether the
345 user wants to mark all feeds as read. (example:
346 confirm-mark-all-feeds-read no)
347 confirm-exit (parameters: [yes/no]; default value: no)
349 If set to yes, then Newsboat will ask for confirmation whether the
350 user really wants to quit Newsboat. (example: confirm-exit yes)
351 cookie-cache (parameters: <path>; default value: "")
353 Set a cookie cache. If set, cookies will be cached in (i.e. read
354 from and written to) this file, using Netscape format
355 <http://www.cookiecentral.com/faq/#3.5>. (example: cookie-cache
356 "~/.newsboat/cookies.txt")
357 datetime-format (parameters: <date/time format>; default value: %b %d)
359 This format specifies the date/time format in the article list. For
360 a detailed documentation on most of the allowed formats, consult
361 the manpage of strftime(3). %L is a custom format not available in
362 strftime which lists the days since the article was published (e.g.
363 "2 days ago"). (example: datetime-format "%D, %R")
364 define-filter (parameters: <name> <filterexpr>; default value: n/a)
366 With this command, you can predefine filters, which you can later
367 select from a list, and which are then applied after selection.
368 This is especially useful for filters that you need often and you
369 don’t want to enter them every time you need them. (example:
370 define-filter "all feeds with 'fun' tag" "tags # \"fun\"")
371 delete-read-articles-on-quit (parameters: [yes/no]; default value: no)
373 If set to yes, all read articles will be deleted when quiting
374 Newsboat. This option only applies if cleanup-on-quit is set to yes
375 or if the --cleanup argument is passed. (example:
376 delete-read-articles-on-quit yes)
377 dialogs-title-format (parameters: <format>; default value: "%N %V -
379 Dialogs" (localized))
380 Format of the title in dialog list. See "Format Strings" section of
381 Newsboat manual for details on available formats. (example:
382 dialogs-title-format "%N %V - Dialogs")
383 dirbrowser-title-format (parameters: <format>; default value: "%N %V -
385 %?O?Open Directory&Save File? - %f" (localized))
386 Format of the title in directory browser. See "Format Strings"
387 section of Newsboat manual for details on available formats.
388 (example: dirbrowser-file-format "%?O?Open Directory&Save File? -
389 %f")
390 display-article-progress (parameters: [yes/no]; default value: yes)
392 If set to yes, then a read progress (in percent) is displayed in
393 the article view. Otherwise, no read progress is displayed.
394 (example: display-article-progress no)
395 download-full-page (parameters: [yes/no]; default value: no)
397 If set to yes, then for all feed items with no content but with a
398 link, the link is downloaded and the result used as content
399 instead. This may significantly increase the download times of
400 "empty" feeds. (example: download-full-page yes)
401 download-retries (parameters: <number>; default value: 1)
403 How many times Newsboat shall try to successfully download a feed
404 before giving up. This is an option to improve the success of
405 downloads on slow and shaky connections such as via a TOR proxy.
406 (example: download-retries 4)
407 download-timeout (parameters: <number>; default value: 30)
409 The number of seconds Newsboat shall wait when downloading a feed
410 before giving up. This is an option to improve the success of
411 downloads on slow and shaky connections such as via a TOR proxy.
412 (example: download-timeout 60)
413 error-log (parameters: <path>; default value: "")
415 If set, then user errors (e.g. errors regarding defunct RSS feeds)
416 will be logged to this file. (example: error-log
417 "~/.newsboat/error.log")
418 external-url-viewer (parameters: <command>; default value: "")
420 If set, then show-urls will pipe the current article to a specific
421 external tool instead of using the internal URL viewer. This can be
422 used to integrate tools such as urlview. (example:
423 external-url-viewer "urlview")
424 feed-sort-order (parameters: <sortfield>[-<direction>]; default value:
426 none)
427 The <sortfield> specifies which feed property shall be used for
428 sorting; currently available are: firsttag, title, articlecount,
429 unreadarticlecount, lastupdated and none. The optional <direction>
430 specifies the sort direction. asc specifies ascending sorting, desc
431 specifies descending sorting. desc is the default. (example:
432 feed-sort-order firsttag)
433 feedhq-flag-share (parameters: <flag>; default value: "")
435 If set and FeedHQ support is used, then all articles that are
436 flagged with the specified flag are being "shared" in FeedHQ so
437 that people that follow you can see it. (example: feedhq-flag-share
438 "a")
439 feedhq-flag-star (parameters: <flag>; default value: "")
441 If set and FeedHQ support is used, then all articles that are
442 flagged with the specified flag are being "starred" in FeedHQ and
443 appear in the list of "Starred items". (example: feedhq-flag-star
444 "b")
445 feedhq-login (parameters: <login>; default value: "")
447 This variable sets your FeedHQ login for FeedHQ support. (example:
448 feedhq-login "your-login")
449 feedhq-min-items (parameters: <number>; default value: 20)
451 This variable sets the number of articles that are loaded from
452 FeedHQ per feed. (example: feedhq-min-items 100)
453 feedhq-password (parameters: <password>; default value: "")
455 This variable sets your FeedHQ password for FeedHQ support. Double
456 quotes and backslashes within it should be escaped. (example:
457 feedhq-password "here_goesAquote:\"")
458 feedhq-passwordfile (parameters: <path>; default value: "")
460 A more secure alternative to the above, by storing your password
461 elsewhere in your system. (example: feedhq-passwordfile
462 "~/.newsboat/feedhq-pw.txt")
463 feedhq-passwordeval (parameters: <command>; default value: "")
465 Another secure alternative, is providing your password from an
466 external command that is evaluated during login. This can be used
467 to read your password from a gpg encrypted file or your system
468 keyring. (example: feedhq-passwordeval "gpg --decrypt
469 ~/.newsboat/feedhq-password.gpg")
470 feedhq-show-special-feeds (parameters: [yes/no]; default value: yes)
472 If set and FeedHQ support is used, then "special feeds" like
473 "People you follow" (articles shared by people you follow),
474 "Starred items" (your starred articles) and "Shared items" (your
475 shared articles) appear in your subscription list. (example:
476 feedhq-show-special-feeds "no")
477 feedhq-url (parameters: <url>; default value: "https://feedhq.org/")
479 Configures the URL where your FeedHQ instance resides. (example:
480 feedhq-url "https://feedhq.example.com/")
481 feedlist-format (parameters: <format>; default value: "%4i %n %11u %t")
483 This variable defines the format of entries in the feed list. See
484 the respective section in the documentation for more information on
485 format strings. (example: feedlist-format " %n %4i - %11u -%> %t")
486 feedlist-title-format (parameters: <format>; default value: "%N %V -
488 %?F?Feeds&Your feeds? (%u unread, %t total)%?F? matching filter
489 `%F'&?%?T? - tag `%T'&?" (localized))
490 Format of the title in feed list. See "Format Strings" section of
491 Newsboat manual for details on available formats. (example:
492 feedlist-title-format "Feeds (%u unread, %t total)")
493 filebrowser-title-format (parameters: <format>; default value: "%N %V -
495 %?O?Open File&Save File? - %f" (localized))
496 Format of the title in file browser. See "Format Strings" section
497 of Newsboat manual for details on available formats. (example:
498 filebrowser-title-format "%?O?Open File&Save File? - %f")
499 goto-first-unread (parameters: [yes/no]; default value: yes)
501 If set to yes, then the first unread article will be selected
502 whenever a feed is entered. (example: goto-first-unread no)
503 goto-next-feed (parameters: [yes/no]; default value: yes)
505 If set to yes, then the next-unread, prev-unread and random-unread
506 keys will search in other feeds for unread articles if all articles
507 in the current feed are read. If set to no, then these keys will
508 stop in the current feed. (example: goto-next-feed no)
509 help-title-format (parameters: <format>; default value: "%N %V - Help"
511 (localized))
512 Format of the title in help window. See "Format Strings" section of
513 Newsboat manual for details on available formats. (example:
514 help-title-format "%N %V - Help")
515 highlight (parameters: <target> <regex> <fgcolor> [<bgcolor>
517 [<attribute> ...]]; default value: n/a)
518 With this command, you can highlight text parts in the feed list,
519 the article list and the article view. For a detailed
520 documentation, see the chapter on highlighting. (example: highlight
521 all "newsboat" red)
522 highlight-article (parameters: <filterexpr> <fgcolor> <bgcolor>
524 [<attribute> ...]; default value: n/a)
525 With this command, you can highlight articles in the article list
526 if they match a filter expression. For a detailed documentation,
527 see the chapter on highlighting. (example: highlight-article
528 "author =~ \"Andreas Krennmair\"" white red bold)
529 history-limit (parameters: <number>; default value: 100)
531 Defines the maximum number of entries of commandline resp. search
532 history to be saved. To disable history saving, set it to 0.
533 (example: history-limit 0)
534 html-renderer (parameters: <command>; default value: internal)
536 If set to internal, then the internal HTML renderer will be used.
537 Otherwise, the specified command will be executed, the HTML to be
538 rendered will be written to the command’s stdin, and the program’s
539 output will be displayed. This makes it possible to use other,
540 external programs, such as w3m, links or lynx, to render HTML.
541 (example: html-renderer "w3m -dump -T text/html")
542 http-auth-method (parameters: <method>; default value: any)
544 Set HTTP authentication method. Allowed values: any, basic, digest,
545 digest_ie (only available with libcurl 7.19.3 and newer),
546 gssnegotiate, ntlm and anysafe. (example: http-auth-method digest)
547 ignore-article (parameters: <feed> <filterexpr>; default value: n/a)
549 If a downloaded article from <feed> matches <filterexpr>, then it
550 is ignored and not presented to the user. This command is further
551 explained in the "kill file" section below. (example:
552 ignore-article "*" "title =~ \"Windows\"")
553 ignore-mode (parameters: [download/display]; default value: download)
555 This configuration option defines in what way an article is ignored
556 (see ignore-article). If set to download, then it is ignored in the
557 download/parsing phase and thus never written to the cache, if it
558 set to display, it is ignored when displaying articles but is kept
559 in the cache. (example: ignore-mode "display")
560 include (parameters: <path>; default value: n/a)
562 With this command, you can include other files to be interpreted as
563 configuration files. This is especially useful to separate your
564 configuration into several files, e.g. key configuration, color
565 configuration, ... (example: include "~/.newsboat/colors")
566 itemview-title-format (parameters: <format>; default value: "%N %V -
568 Article '%T' (%u unread, %t total)" (localized))
569 Format of the title in article view. See "Format Strings" section
570 of Newsboat manual for details on available formats. (example:
571 itemview-title-format "Article '%T'")
572 inoreader-app-id (parameters: <string>; default value: "")
574 Unique application ID issued by Inoreader. See "Inoreader" section.
575 (example: inoreader-app-id "123456789")
576 inoreader-app-key (parameters: <string>; default value: "")
578 Application key issued by Inoreader. See "Inoreader" section.
579 (example: inoreader-app-key "TmV3c2JvYXQgcm9ja3MgOikK")
580 inoreader-flag-share (parameters: <flag>; default value: "")
582 If set and Inoreader support is used, then all articles that are
583 flagged with the specified flag are being "shared" in Inoreader so
584 that people that follow you can see it. (example:
585 inoreader-flag-share "a")
586 inoreader-flag-star (parameters: <flag>; default value: "")
588 If set and Inoreader support is used, then all articles that are
589 flagged with the specified flag are being "starred" in Inoreader
590 and appear in the list of "Starred items". (example:
591 inoreader-flag-star "b")
592 inoreader-login (parameters: <login>; default value: "")
594 This variable sets your Inoreader login for Inoreader support.
595 (example: inoreader-login "your-login")
596 inoreader-min-items (parameters: <number>; default value: 20)
598 This variable sets the number of articles that are loaded from
599 Inoreader per feed. (example: inoreader-min-items 100)
600 inoreader-password (parameters: <password>; default value: "")
602 This variable sets your Inoreader password for Inoreader support.
603 Double quotes and backslashes within it should be escaped.
604 (example: inoreader-password "here_goesAquote:\"")
605 inoreader-passwordfile (parameters: <path>; default value: "")
607 A more secure alternative to the above, by storing your password
608 elsewhere in your system. (example: inoreader-passwordfile
609 "~/.newsboat/inoreader-pw.txt")
610 inoreader-passwordeval (parameters: <command>; default value: "")
612 Another secure alternative, is providing your password from an
613 external command that is evaluated during login. This can be used
614 to read your password from a gpg encrypted file or your system
615 keyring. (example: inoreader-passwordeval "gpg --decrypt
616 ~/.newsboat/inoreader-password.gpg")
617 inoreader-show-special-feeds (parameters: [yes/no]; default value: yes)
619 If set and Inoreader support is used, then "special feeds" like
620 "Starred items" (your starred articles) and "Shared items" (your
621 shared articles) appear in your subscription list. (example:
622 inoreader-show-special-feeds "no")
623 keep-articles-days (parameters: <number>; default value: 0)
625 If set to a number greater than 0, only articles that were
626 published within the last <number> days are kept, and older
627 articles are deleted. If set to 0, this option is not active. Note
628 that changing this setting won’t bring back the articles that were
629 deleted earlier; currently, there’s no non-hacky way to bring back
630 deleted articles. (example: keep-articles-days 30)
631 macro (parameters: <macro key> <command list>; default value: n/a)
633 With this command, you can define a macro key and specify a list of
634 commands that shall be executed when the macro prefix and the macro
635 key are pressed. (example: macro k open; reload; quit)
636 mark-as-read-on-hover (parameters: [yes/no]; default value: no)
638 If set to yes, then all articles that get selected in the article
639 list are marked as read. (example: mark-as-read-on-hover yes)
640 max-download-speed (parameters: <number>; default value: 0)
642 If set to a number greater than 0, the download speed per download
643 is set to that limit (in KB/s). (example: max-download-speed 50)
644 max-browser-tabs (parameters: <number>; default value: 10)
646 Set the maximum number of articles to open in a browser when using
647 the open-all-unread-in-browser or
648 open-all-unread-in-browser-and-mark-read commands. (example:
649 max-browser-tabs 4)
650 max-items (parameters: <number>; default value: 0)
652 Set the number of articles to maximally keep per feed. If the
653 number is set to 0, then all articles are kept. (example: max-items
654 100)
655 miniflux-login (parameters: <username>; default value: "")
657 Sets the username for use with Miniflux. (example: miniflux-login
658 "admin")
659 miniflux-password (parameters: <password>; default value: "")
661 Configures the password for use with Miniflux. Double quotes and
662 backslashes within it should be escaped. (example:
663 miniflux-password "here_goesAquote:\"")
664 miniflux-passwordfile (parameters: <path>; default value: "")
666 A more secure alternative to the above, by storing your password
667 elsewhere in your system. (example: miniflux-passwordfile
668 "~/.newsboat/miniflux-pw.txt")
669 miniflux-passwordeval (parameters: <command>; default value: "")
671 Another secure alternative, is providing your password from an
672 external command that is evaluated during login. This can be used
673 to read your password from a gpg encrypted file or your system
674 keyring. (example: miniflux-passwordeval "gpg --decrypt
675 ~/.newsboat/miniflux-password.gpg")
676 miniflux-url (parameters: <url>; default value: "")
678 Configures the URL where the Miniflux installation you want to use
679 resides. (example: miniflux-url "https://example.com/miniflux/")
680 newsblur-login (parameters: <login>; default value: "")
682 This variable sets your NewsBlur login for NewsBlur support.
683 (example: newsblur-login "your-login")
684 newsblur-min-items (parameters: <number>; default value: 20)
686 This variable sets the number of articles that are loaded from
687 NewsBlur per feed. (example: newsblur-min-items 100)
688 newsblur-password (parameters: <password>; default value: "")
690 This variable sets your NewsBlur password for NewsBlur support.
691 Double quotes and backslashes within it should be escaped.
692 (example: newsblur-password "here_goesAquote:\"")
693 newsblur-passwordfile (parameters: <path>; default value: "")
695 A more secure alternative to the above, by storing your password
696 elsewhere in your system. (example: newsblur-passwordfile
697 "~/.newsboat/newsblur-pw.txt")
698 newsblur-passwordeval (parameters: <command>; default value: "")
700 Another secure alternative, is providing your password from an
701 external command that is evaluated during login. This can be used
702 to read your password from a gpg encrypted file or your system
703 keyring. (example: newsblur-passwordeval "gpg --decrypt
704 ~/.newsboat/newsblur-password.gpg")
705 newsblur-url (parameters: <url>; default value: "https://newsblur.com")
707 Configures the URL where the NewsBlur instance resides. (example:
708 newsblur-url "https://localhost")
709 notify-always (parameters: [yes/no]; default value: no)
711 If set to no, notifications will only be made when there are new
712 feeds or articles. If set to yes, notifications will be made
713 regardless. (example: notify-always yes)
714 notify-beep (parameters: [yes/no]; default value: no)
716 If set to yes, then the speaker will beep on new articles.
717 (example: notify-beep yes)
718 notify-format (parameters: <string>; default value: "newsboat: finished
720 reload, %f unread feeds (%n unread articles total)" (localized))
721 Format string that is used for formatting notifications. See the
722 chapter on format strings for more information. (example:
723 notify-format "%d new articles (%n unread articles, %f unread
724 feeds)")
725 notify-program (parameters: <command>; default value: "")
727 If set, then the configured program will be executed if new
728 articles arrived (through a reload) or if notify-always is yes. The
729 first parameter of the called program contains the notification
730 message. In order to pass other hard-coded arguments to the
731 program, write an appropriate wrapper shell script and use it as
732 <command> instead. (example: notify-program "~/bin/my-notifier")
733 notify-screen (parameters: [yes/no]; default value: no)
735 If set to yes, then a "privacy message" will be sent to the
736 terminal, containing a notification message about new articles.
737 This is especially useful if you use terminal emulations such as
738 GNU screen which implement privacy messages. (example:
739 notify-screen yes)
740 notify-xterm (parameters: [yes/no]; default value: no)
742 If set to yes, then the xterm window title will be set to a
743 notification message about new articles. (example: notify-xterm
744 yes)
745 ocnews-flag-star (parameters: <character>; default value: "")
747 If set and ownCloud News support is used, then all articles that
748 are flagged with the specified flag are being "starred" in ownCloud
749 News. (example: ocnews-flag-star "s")
750 ocnews-login (parameters: <username>; default value: "")
752 Sets the username to use with the ownCloud instance. (example:
753 ocnews-login "user")
754 ocnews-password (parameters: <password>; default value: "")
756 Configures the password to use with the ownCloud instance. Double
757 quotes and backslashes within it should be escaped. (example:
758 ocnews-password "here_goesAquote:\"")
759 ocnews-passwordfile (parameters: <path>; default value: "")
761 A more secure alternative to the above, by storing your password
762 elsewhere in your system. (example: ocnews-passwordfile
763 "~/.newsboat/ocnews-pw.txt")
764 ocnews-passwordeval (parameters: <command>; default value: "")
766 Another secure alternative, is providing your password from an
767 external command that is evaluated during login. This can be used
768 to read your password from a gpg encrypted file or your system
769 keyring. (example: ocnews-passwordeval "gpg --decrypt
770 ~/.newsboat/ocnews-password.gpg")
771 ocnews-url (parameters: <url>; default value: "")
773 Configures the URL where the ownCloud instance resides. (example:
774 ocnews-url "https://localhost/owncloud")
775 oldreader-flag-share (parameters: <flag>; default value: "")
777 If set and The Old Reader support is used, then all articles that
778 are flagged with the specified flag are being "shared" in The Old
779 Reader so that people that follow you can see it. (example:
780 oldreader-flag-share "a")
781 oldreader-flag-star (parameters: <flag>; default value: "")
783 If set and The Old Reader support is used, then all articles that
784 are flagged with the specified flag are being "starred" in The Old
785 Reader and appear in the list of "Starred items". (example:
786 oldreader-flag-star "b")
787 oldreader-login (parameters: <login>; default value: "")
789 This variable sets your The Old Reader login for The Older Reader
790 support. (example: oldreader-login "your-login")
791 oldreader-min-items (parameters: <number>; default value: 20)
793 This variable sets the number of articles that are loaded from The
794 Old Reader per feed. (example: oldreader-min-items 100)
795 oldreader-password (parameters: <password>; default value: "")
797 This variable sets your The Old Reader password for The Old Reader
798 support. Double quotes and backslashes within it should be escaped.
799 (example: oldreader-password "here_goesAquote:\"")
800 oldreader-passwordfile (parameters: <path>; default value: "")
802 A more secure alternative to the above, by storing your password
803 elsewhere in your system. (example: oldreader-passwordfile
804 "~/.newsboat/oldreader-pw.txt")
805 oldreader-passwordeval (parameters: <command>; default value: "")
807 Another secure alternative, is providing your password from an
808 external command that is evaluated during login. This can be used
809 to read your password from a gpg encrypted file or your system
810 keyring. (example: oldreader-passwordeval "gpg --decrypt
811 ~/.newsboat/oldreader-password.gpg")
812 oldreader-show-special-feeds (parameters: [yes/no]; default value: yes)
814 If set and The Old reader support is used, then "special feeds"
815 like "People you follow" (articles shared by people you follow),
816 "Starred items" (your starred articles) and "Shared items" (your
817 shared articles) appear in your subscription list. (example:
818 oldreader-show-special-feeds "no")
819 openbrowser-and-mark-jumps-to-next-unread (parameters: [yes/no];
821 default value: no)
822 If set to yes, jump to the next unread item when an item is opened
823 in the browser and marked as read. (example:
824 openbrowser-and-mark-jumps-to-next-unread yes)
825 opml-url (parameters: <url> ...; default value: "")
827 If the OPML online subscription mode is enabled, then the list of
828 feeds will be taken from the OPML file found on this location.
829 Optionally, you can specify more than one URL. All the listed OPML
830 URLs will then be taken into account when loading the feed list.
831 (example: opml-url "https://host.domain.tld/blogroll.opml"
832 "https://example.com/anotheropmlfile.opml")
833 pager (parameters: [<command>/internal]; default value: internal)
835 If set to internal, then the internal pager will be used.
836 Otherwise, the article to be displayed will be rendered to be a
837 temporary file and then displayed with the configured pager. If the
838 command is set to an empty string, the content of the PAGER
839 environment variable will be used. If the command contains a
840 placeholder %f, it will be replaced with the temporary filename.
841 (example: pager "less %f")
842 podcast-auto-enqueue (parameters: [yes/no]; default value: no)
844 If set to yes, then all podcast URLs that are found in articles are
845 added to the podcast download queue. See the respective section in
846 the documentation for more information on podcast support in
847 Newsboat. (example: podcast-auto-enqueue yes)
848 prepopulate-query-feeds (parameters: [yes/no]; default value: no)
850 If set to yes, then all query feeds are prepopulated with articles
851 on startup. (example: prepopulate-query-feeds yes)
852 ssl-verifyhost (parameters: [yes/no]; default value: yes)
854 If set to no, skip verification of the certificate’s name against
855 host. (example: ssl-verifyhost no)
856 ssl-verifypeer (parameters: [yes/no]; default value: yes)
858 If set to no, skip verification of the peer’s SSL certificate.
859 (example: ssl-verifypeer no)
860 proxy-auth-method (parameters: <method>; default value: any)
862 Set proxy authentication method. Allowed values: any, basic,
863 digest, digest_ie (only available with libcurl 7.19.3 and newer),
864 gssnegotiate, ntlm and anysafe. (example: proxy-auth-method ntlm)
865 proxy-auth (parameters: <auth>; default value: n/a)
867 Set the proxy authentication string. (example: proxy-auth
868 user:password)
869 proxy-type (parameters: <type>; default value: http)
871 Set proxy type. Allowed values: http, socks4, socks4a, socks5 and
872 socks5h. (example: proxy-type socks5)
873 proxy (parameters: <server:port>; default value: n/a)
875 Set the proxy to use for downloading RSS feeds. (Don’t forget to
876 actually enable the proxy with use-proxy yes.) (example: proxy
877 localhost:3128)
878 refresh-on-startup (parameters: [yes/no]; default value: no)
880 If set to yes, then all feeds will be reloaded when Newsboat starts
881 up. This is equivalent to the -r commandline option. (example:
882 refresh-on-startup yes)
883 reload-only-visible-feeds (parameters: [yes/no]; default value: no)
885 If set to yes, then manually reloading all feeds will only reload
886 the currently visible feeds, e.g. if a filter or a tag is set.
887 (example: reload-only-visible-feeds yes)
888 reload-threads (parameters: <number>; default value: 1)
890 The number of parallel reload threads that shall be started when
891 all feeds are reloaded. (example: reload-threads 3)
892 reload-time (parameters: <number>; default value: 60)
894 The number of minutes between automatic reloads. (example:
895 reload-time 120)
896 reset-unread-on-update (parameters: <url> [<url>...]; default value:
898 n/a)
899 Specifies one or more feed URLs for whose articles the unread flag
900 will be reset if an article has been updated, i.e. its content has
901 been changed. This is especially useful for RSS feeds where single
902 articles are updated after publication, and you want to be notified
903 of the updates. This option can be specified multiple times.
904 (example: reset-unread-on-update
905 "https://blog.fefe.de/rss.xml?html")
906 run-on-startup (parameters: <list of operations>; default value: n/a)
908 Specifies one or more Newsboat operations, separated by semicolons,
909 which are executed on Newsboat startup. (example: run-on-startup
910 next-unread; open; random-unread; open)
911 save-path (parameters: <path-to-directory>; default value: ~/)
913 The default path where articles shall be saved to. If an invalid
914 path is specified, the current directory is used. (example:
915 save-path "~/Saved Articles")
916 scrolloff (parameters: <number>; default value: 0)
918 Keep the configured number of lines above and below the selected
919 item in lists. Configure a high number to keep the selected item in
920 the center of the screen. (example: scrolloff 5)
921 search-highlight-colors (parameters: <fgcolor> <bgcolor> [<attribute>
923 ...]; default value: black yellow bold)
924 This configuration command specifies the highlighting colors when
925 searching for text from the article view. (example:
926 search-highlight-colors white black bold)
927 searchresult-title-format (parameters: <format>; default value: "%N %V
929 - Search results (%u unread, %t total)%?F? matching filter `%F'&?"
930 (localized))
931 Format of the title in search result. See "Format Strings" section
932 of Newsboat manual for details on available formats. (example:
933 searchresult-title-format "Search result")
934 selectfilter-title-format (parameters: <format>; default value: "%N %V
936 - Select Filter" (localized))
937 Format of the title in filter selection dialog. See "Format
938 Strings" section of Newsboat manual for details on available
939 formats. (example: selectfilter-title-format "Select Filter")
940 selecttag-format (parameters: <format>; default value: "%4i %T (%u)")
942 Format of the lines in "Select tag" dialog. See the respective
943 section in the documentation for more information on format
944 strings. (example: selecttag-format "[%2i] %T (%n unread articles
945 in %f feeds, %u feeds total)")
946 selecttag-title-format (parameters: <format>; default value: "%N %V -
948 Select Tag" (localized))
949 Format of the title in tag selection dialog. See "Format Strings"
950 section of Newsboat manual for details on available formats.
951 (example: selecttag-title-format "Select Tag")
952 show-keymap-hint (parameters: [yes/no]; default value: yes)
954 If set to no, then the keymap hints on the bottom of screen will
955 not be displayed. (example: show-keymap-hint no)
956 show-title-bar (parameters: [yes/no]; default value: yes)
958 If set to no, then the title bar on the top of the screen will not
959 be displayed. (example: show-title-bar no)
960 show-read-articles (parameters: [yes/no]; default value: yes)
962 If set to yes, then all articles of a feed are listed in the
963 article list. If set to no, then only unread articles are listed.
964 (example: show-read-articles no)
965 show-read-feeds (parameters: [yes/no]; default value: yes)
967 If set to yes, then all feeds, including those without unread
968 articles, are listed. If set to no, then only feeds with one or
969 more unread articles are list. (example: show-read-feeds no)
970 suppress-first-reload (parameters: [yes/no]; default value: no)
972 If set to yes, then the first automatic reload will be suppressed
973 if auto-reload is set to yes. (example: suppress-first-reload yes)
974 swap-title-and-hints (parameters: [yes/no]; default value: no)
976 If set to yes, then the title at the top of screen and keymap hints
977 at the bottom of screen will be swapped. (example:
978 swap-title-and-hints yes)
979 text-width (parameters: <number>; default value: 0)
981 If set to a number greater than 0, all HTML will be rendered to
982 this maximum line length or the terminal width (whichever is
983 smaller). If set to 0, the terminal width will always be used. Does
984 not apply when using external renderer or viewing the source. Also
985 note that "Link" header and "Links" section won’t be affected by
986 it—they contain URLs which are better not wrapped. (example:
987 text-width 72)
988 toggleitemread-jumps-to-next-unread (parameters: [yes/no]; default
990 value: no)
991 If set to yes, jump to the next unread item when an item’s read
992 status is toggled in the article list. (example:
993 toggleitemread-jumps-to-next-unread yes)
994 ttrss-flag-publish (parameters: <character>; default value: "")
996 If set and Tiny Tiny RSS support is used, then all articles that
997 are flagged with the specified flag are being marked as "published"
998 in Tiny Tiny RSS. (example: ttrss-flag-publish "b")
999 ttrss-flag-star (parameters: <character>; default value: "")
1001 If set and Tiny Tiny RSS support is used, then all articles that
1002 are flagged with the specified flag are being "starred" in Tiny
1003 Tiny RSS. (example: ttrss-flag-star "a")
1004 ttrss-login (parameters: <username>; default value: "")
1006 Sets the username for use with Tiny Tiny RSS. (example: ttrss-login
1007 "admin")
1008 ttrss-mode (parameters: [multi/single]; default value: multi)
1010 Configures the mode in which Tiny Tiny RSS is used. In single-user
1011 mode, login and password are used for HTTP authentication, while in
1012 multi-user mode, they are used for authenticating with Tiny Tiny
1013 RSS. (example: ttrss-mode "single")
1014 ttrss-password (parameters: <password>; default value: "")
1016 Configures the password for use with Tiny Tiny RSS. Double quotes
1017 and backslashes within it should be escaped. (example:
1018 ttrss-password "here_goesAquote:\"")
1019 ttrss-passwordfile (parameters: <path>; default value: "")
1021 A more secure alternative to the above, by storing your password
1022 elsewhere in your system. (example: ttrss-passwordfile
1023 "~/.newsboat/ttrss-pw.txt")
1024 ttrss-passwordeval (parameters: <command>; default value: "")
1026 Another secure alternative, is providing your password from an
1027 external command that is evaluated during login. This can be used
1028 to read your password from a gpg encrypted file or your system
1029 keyring. (example: ttrss-passwordeval "gpg --decrypt
1030 ~/.newsboat/ttrss-password.gpg")
1031 ttrss-url (parameters: <url>; default value: "")
1033 Configures the URL where the Tiny Tiny RSS installation you want to
1034 use resides. (example: ttrss-url "https://example.com/ttrss/")
1035 unbind-key (parameters: <key> [<dialog>]; default value: n/a)
1037 Unbind key <key>. This means that no operation is called when <key>
1038 is pressed. If you provide "-a" as <key>, all currently bound keys
1039 will become unbound. Optionally, you can specify a dialog (for a
1040 list of available dialogs, see bind-key above). If you specify one,
1041 the key binding will only be unbound for the specified dialog.
1042 (example: unbind-key R)
1043 urls-source (parameters: <source>; default value: "local")
1045 This configuration command sets the source where URLs shall be
1046 retrieved from. By default, this is the urls file. Alternatively,
1047 you can set it to opml, which enables Newsboat’s OPML online
1048 subscription mode, to ttrss which enables Newsboat’s Tiny Tiny RSS
1049 support, to oldreader, which enables Newsboat’s The Old Reader
1050 support, to newsblur, which enables NewsBlur support, to feedhq for
1051 FeedHQ support, to ocnews for ownCloud News support, to inoreader
1052 for Inoreader support, or to miniflux for Miniflux support. Query
1053 feed specifications will be read from the local urls file
1054 regardless of this setting. (example: urls-source "oldreader")
1055 urlview-title-format (parameters: <format>; default value: "%N %V -
1057 URLs" (localized))
1058 Format of the title in URL view. See "Format Strings" section of
1059 Newsboat manual for details on available formats. (example:
1060 urlview-title-format "URLs")
1061 use-proxy (parameters: [yes/no]; default value: no)
1063 If set to yes, then the configured proxy will be used for
1064 downloading the RSS feeds. (example: use-proxy yes)
1065 user-agent (parameters: <string>; default value: "")
1067 If set to a non-zero-length string, this value will be used as HTTP
1068 User-Agent header for all HTTP requests. (example: user-agent
1069 "Lynx/2.8.5rel.1 libwww-FM/2.14")
1070 wrap-scroll (parameters: [yes/no]; default value: no)
1072 If set to yes, moving down while on the last item in a list will
1073 wrap around to the top and vice versa. (example: wrap-scroll yes)
1074
1076 open (default key: ENTER)
1077 Open the currently selected feed or article.
1078 quit (default key: q)
1080 Quit the program or return to the previous dialog (depending on the
1081 context).
1082 hard-quit (default key: Q)
1084 Quit the program without confirmation.
1085 reload (default key: r)
1087 Reload the currently selected feed.
1088 reload-all (default key: R)
1090 Reload all feeds.
1091 mark-feed-read (default key: A)
1093 Mark all articles in the currently selected feed read.
1094 mark-all-feeds-read (default key: C)
1096 Mark articles in all feeds read.
1097 mark-all-above-as-read (default key: n/a)
1099 Mark all above as read.
1100 save (default key: s)
1102 Export the currently selected article to a plain text file.
1103 save-all (default key: n/a)
1105 Export all articles from the currently selected feed to plain text
1106 files.
1107 next-unread (default key: n)
1109 Jump to the next unread article.
1110 prev-unread (default key: p)
1112 Jump to the previous unread article.
1113 next (default key: J)
1115 Jump to next list entry.
1116 prev (default key: K)
1118 Jump to previous list entry.
1119 random-unread (default key: ^K)
1121 Jump to a random unread article.
1122 open-in-browser (default key: o)
1124 Use browser to open the URL associated with the current article,
1125 feed, or entry in the URL view.
1126 open-in-browser-noninteractively (default key: o)
1128 Use browser to open the URL associated with the current article,
1129 feed, or entry in the URL view. This operation works similar to
1130 open-in-browser, but the output of the browser (stdout and stderr)
1131 is not shown, and the browser doesn’t receive keyboard input. You
1132 would probably add & at the end of the browser command to put it
1133 into background, too.
1134 open-in-browser-and-mark-read (default key: O)
1136 Use browser to open the URL associated with the current article, or
1137 entry in the URL view. When used in the article list, it will also
1138 mark the article as read.
1139 open-all-unread-in-browser (default key: n/a)
1141 Open all the unread URLs in the current feed.
1142 open-all-unread-in-browser-and-mark-read (default key: n/a)
1144 Open all the unread URLs in the current feed and mark them as read.
1145 help (default key: ?)
1147 Run the help screen.
1148 toggle-source-view (default key: ^U)
1150 Toggle between the HTML view and the source view in the article
1151 view.
1152 toggle-article-read (default key: N)
1154 Toggle the read flag for the currently selected article, and clear
1155 the delete flag if set.
1156 toggle-show-read-feeds (default key: l)
1158 Toggle whether read feeds should be shown in the feed list.
1159 show-urls (default key: u)
1161 Show all URLs in the article in a list (similar to urlview).
1162 clear-tag (default key: ^T)
1164 Clear current tag.
1165 set-tag (default key: t)
1167 Select tag.
1168 open-search (default key: /)
1170 Open the search dialog. When a search is done in the article list,
1171 then the search operation only applies to the articles of the
1172 current feed, otherwise to all articles.
1173 goto-url (default key: #)
1175 Open the URL dialog and then open a specified URL in the browser.
1176 one (default key: 1)
1178 Open URL 1 in the browser.
1179 two (default key: 2)
1181 Open URL 2 in the browser.
1182 three (default key: 3)
1184 Open URL 3 in the browser.
1185 four (default key: 4)
1187 Open URL 4 in the browser.
1188 five (default key: 5)
1190 Open URL 5 in the browser.
1191 six (default key: 6)
1193 Open URL 6 in the browser.
1194 seven (default key: 7)
1196 Open URL 7 in the browser.
1197 eight (default key: 8)
1199 Open URL 8 in the browser.
1200 nine (default key: 9)
1202 Open URL 9 in the browser.
1203 zero (default key: 0)
1205 Open URL 10 in the browser.
1206 enqueue (default key: e)
1208 Add the podcast download URL of the current article (if any is
1209 found) to the podcast download queue (see the respective section in
1210 the documentation for more information on podcast support).
1211 edit-urls (default key: E)
1213 Edit the list of subscribed URLs. Newsboat will start the editor
1214 configured through the VISUAL environment variable (if unset,
1215 EDITOR is used; fallback: vi). When editing is finished, Newsboat
1216 will reload the URLs file.
1217 reload-urls (default key: ^R)
1219 Reload the URLs configuration file.
1220 redraw (default key: ^L)
1222 Redraw the screen.
1223 cmdline (default key: :)
1225 Open the command line.
1226 set-filter (default key: F)
1228 Set a filter.
1229 select-filter (default key: f)
1231 Select a predefined filter.
1232 clear-filter (default key: ^F)
1234 Clear currently set filter.
1235 bookmark (default key: ^B)
1237 Bookmark currently selected article or URL.
1238 edit-flags (default key: ^E)
1240 Edit the flags of the currently selected article.
1241 next-unread-feed (default key: ^N)
1243 Go to the next feed with unread articles. This only works from the
1244 article list.
1245 prev-unread-feed (default key: ^P)
1247 Go to the previous feed with unread articles. This only works from
1248 the article list.
1249 next-feed (default key: j)
1251 Go to the next feed. This only works from the article list.
1252 prev-feed (default key: k)
1254 Go to the previous feed. This only works from the article list.
1255 delete-article (default key: D)
1257 Delete the currently selected article.
1258 delete-all-articles (default key: ^D)
1260 Delete all articles in the articlelist. Note that the articlelist
1261 might contain a subset of feed’s articles (because of filters or
1262 show-read-articles no), or it might contain a mix of articles from
1263 different feeds (if you’re viewing a query feed) — in either case,
1264 delete-all-articles affects just those articles, not all articles
1265 of the respective feed(s).
1266 purge-deleted (default key: $)
1268 Purge all articles that are marked as deleted from the article
1269 list.
1270 view-dialogs (default key: v)
1272 View list of open dialogs.
1273 close-dialog (default key: ^X)
1275 Close currently selected dialog.
1276 next-dialog (default key: ^V)
1278 Go to next dialog.
1279 prev-dialog (default key: ^G)
1281 Go to previous dialog.
1282 pipe-to (default key: _| _)
1284 Pipe article to command.
1285 sort (default key: g)
1287 Sort feeds/articles by interactively choosing the sort method.
1288 rev-sort (default key: G)
1290 Sort feeds/articles by interactively choosing the sort method
1291 (reversed).
1292 up (default key: UP)
1294 Go up one item in the list.
1295 down (default key: DOWN)
1297 Go down one item in the list.
1298 pageup (default key: PPAGE)
1300 Go up one page in the list.
1301 pagedown (default key: NPAGE)
1303 Go down one page in the list.
1304 home (default key: HOME)
1306 Go to the first item in the list.
1307 end (default key: END)
1309 Go to the last item in the list.
1310 macro-prefix (default key: ,)
1312 Initiate macro execution. The next key press selects the actual
1313 macro and runs it.
1314 switch-focus (default key: TAB)
1316 Switch focus between widgets. This is currently only applicable to
1317 the filebrowser and dirbrowser contexts.
1318 goto-title (default key: __)
1320 Go to item whose title contains the specified string
1321 (case-insensitive).
1322
1324 Newsboat comes with the possibility to categorize or "tag", as we call
1325 it, RSS feeds. Every RSS feed can be assigned 0 or more tags. Within
1326 Newsboat, you can then select to only show RSS feeds that match a
1327 certain tag. That makes it easy to categorize your feeds in a flexible
1328 and powerful way.
1329 Usually, the urls file contains one RSS feed URL per line. To assign a
1331 tag to an RSS feed, simply attach it as a single word, separated by
1332 blanks such as space or tab. If the tag needs to contain spaces, you
1333 must use quotes (") around the tag (see example below). An example urls
1334 file may look like this:
1335 https://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
1337 https://rss.orf.at/news.xml news orf
1338 https://www.heise.de/newsticker/heise.rdf news interesting
1339 When you now start Newsboat with this configuration, you can press "t"
1341 to select a tag. When you select the tag "news", you will see all three
1342 RSS feeds. Pressing "t" again and e.g. selecting the "conspiracy" tag,
1343 you will only see the https://blog.fefe.de/rss.xml?html RSS feed.
1344 Pressing "^T" clears the current tag, and again shows all RSS feeds,
1345 regardless of their assigned tags.
1346 A special type of tag are tags that start with the tilde character (~).
1348 When such a tag is found, the feed title is set to the tag name
1349 (excluding the ~ character). These type of tags are ignored when any
1350 kind of "first tag" property is used. With this feature, you can give
1351 feeds any title you want in your feed list:
1352 https://rss.orf.at/news.xml "~ORF News"
1354 Another special type of tag are tags that start with the exclamation
1356 mark (!). When such a tag is found, the feed is hidden from the regular
1357 list of feeds and its content can only be found through a query feed.
1358 https://rss.orf.at/news.xml "!ORF News (hidden)"
1360
1362 Newsboat contains support for Snownews extensions. The RSS feed readers
1363 Snownews and Liferea share a common way of extending the readers with
1364 custom scripts. Two mechanisms, namely "execurl" and "filter" type
1365 scripts, are available and supported by Newsboat.
1366 An "execurl" script can be any program that gets executed and whose
1368 output is interpreted as RSS feed, while "filter" scripts are fed with
1369 the content of a configured URL and whose output is interpreted as RSS
1370 feed.
1371 The configuration is simple and straight-forward. Just add to your urls
1373 file configuration lines like the following ones:
1374 exec:~/bin/execurl-script
1376 filter:~/bin/filter-script:https://some.test/url
1377 The first line shows how to add an execurl script to your
1379 configuration: start the line with exec: and then immediately append
1380 the path of the script that shall be executed. If this script requires
1381 additional parameters, simply use quotes (see [_using_double_quotes]
1382 for details):
1383 "exec:~/bin/execurl-script param1 param2"
1385 The second line shows how to add a filter script to your configuration:
1387 start the line with filter:, then immediately append the path of the
1388 script, then append a colon (:), and then append the URL of the file
1389 that shall be fed to the script. Again, if the script requires any
1390 parameters, simply quote the whole thing:
1391 "filter:~/bin/filter-script param1 param2:https://url/foobar"
1393 In both cases, the tagging feature as described above is still
1395 available:
1396 exec:~/bin/execurl-script tag1 tag2 "quoted tag"
1398 filter:~/bin/filter-script:https://some.test/url tag3 tag4 tag5
1399 If you need to write your own extension, see this
1401 <https://web.archive.org/web/20090724045314/http://kiza.kcore.de/software/snownews/snowscripts/writing>
1402 short guide" for an introduction. A collection
1403 <https://github.com/kouya/snownews/tree/master/contrib> of existing
1404 scripts" might also help.
1405 Newsboat comes with an example exec script which shows one way to
1407 generate an RSS channel. It also includes a way to see which exact
1408 arguments are passed to the script by Newsboat. This example can be
1409 found in the doc/examples subdirectory.
1410
1412 Like other text-oriented software, Newsboat contains an internal
1413 commandline to modify configuration variables ad hoc and to run own
1414 commands. It provides a flexible access to the functionality of
1415 Newsboat which is especially useful for advanced users.
1416 To start the commandline, type ":". You will see a ":" prompt at the
1418 bottom of the screen, similar to tools like vi(m) or mutt. You can now
1419 enter commands. Pressing the "Enter" key executes the command (possibly
1420 giving feedback to the user) and closes the commandline. You can cancel
1421 entering commands by pressing the "Esc" key. The history of all the
1422 commands that you enter will be saved to the history.cmdline file,
1423 stored next to the cache.db file. The backlog is limited to 100 entries
1424 by default, but can be influenced by setting the history-limit
1425 configuration variable. To disable history saving, set the
1426 history-limit to 0.
1427 The commandline provides you with some help if you can’t remember the
1429 full names of commandline commands. By pressing the "Tab" key, Newsboat
1430 will try to automatically complete your command. If there is more than
1431 one possible completion, you can subsequently press the "Tab" key to
1432 cycle through all results. If no match is found, no suggestion will be
1433 inserted into the commandline. For the set command, the completion also
1434 works for configuration variable names.
1435 In addition, some common key combination such as "Ctrl-G" (to cancel
1437 input), "Ctrl-K" (to delete text from the cursor position to the end of
1438 line), "Ctrl-U" (to clear the whole line) and "Ctrl-W" (to delete the
1439 word before the current cursor position) were added.
1440 Please be aware that the input history of both the command line and the
1442 search functions are saved to the filesystems, to the files
1443 history.cmdline resp. history.search (stored next to the cache.db
1444 file). By default, the last 100 entries are saved, but this can be
1445 configured (configuration variable history-limit) and also totally
1446 disabled (by setting said variable to 0).
1447 Currently, the following command line commands are available:
1449 quit
1451 Quit Newsboat
1452 q
1454 Alias for quit
1455 save <filename>
1457 Save current article to <filename>
1458 set <variable>[=<value>|&|!]
1460 Set (or get) configuration variable value. Specifying a ! after the
1461 name of a boolean configuration variable toggles their values, a &
1462 directly after the name of a configuration variable of any type
1463 resets its value to the documented default value.
1464 tag <tagname>
1466 Select a certain tag
1467 goto <case-insensitive substring>
1469 Go to the next feed whose name contains the case-insensitive
1470 substring.
1471 source <filename> [...]
1473 Load the specified configuration files. This allows it to load
1474 alternative configuration files or reload already loaded
1475 configuration files on-the-fly from the filesystem.
1476 dumpconfig <filename>
1478 Save current internal state of configuration to file, so that it
1479 can be instantly reused as configuration file.
1480 <number>
1482 Jump to the <number>th entry in the current dialog
1483
1485 By default, Newsboat stores all the files in a traditional Unix
1486 fashion, i.e. in a "dotdir" located at ~/.newsboat. However, it also
1487 supports a modern way, XDG Base Directory Specification
1488 <https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>,
1489 which splits the files between the following locations:
1490 • $XDG_CONFIG_HOME/newsboat/
1492 • $XDG_DATA_HOME/newsboat/
1494 If the XDG_CONFIG_HOME environment variable is not set, Newsboat
1496 behaves as if it was set to ~/.config. Similarly, XDG_DATA_HOME
1497 defaults to ~/.local/share.
1498 If the XDG config directory exists, Newsboat will use XDG directories,
1500 creating the data directory if necessary. Otherwise, it will default to
1501 ~/.newsboat.
1502 If you’re currently using ~/.newsboat/ but wish to migrate to XDG
1504 directories, you should move the files as follows:
1505 config, urls
1507 to $XDG_CONFIG_HOME/newsboat/
1508 cache.db, history.search, history.cmdline, queue
1510 to $XDG_DATA_HOME/newsboat/
1511 Newsboat and Podboat also create "lock files". These prevent you from
1513 starting two instances of the same program, and thus from corrupting
1514 your data. Newsboat and Podboat remove these files when you quit the
1515 program, so there is no need to copy them anywhere — just be aware of
1516 them in case you write scripts that work with cache.db or queue. By
1517 default, lock files are located as follows:
1518 ┌─────────┬───────────────────────────┬───────────────────────────────────────┐
1520 │ │ │ │
1521 │ │ dotdir │ XDG │
1522 ├─────────┼───────────────────────────┼───────────────────────────────────────┤
1523 │ │ │ │
1524 │Newsboat │ ~/.newsboat/cache.db.lock │ $XDG_DATA_HOME/newsboat/cache.db.lock │
1525 ├─────────┼───────────────────────────┼───────────────────────────────────────┤
1526 │ │ │ │
1527 │Podboat │ ~/.newsboat/pb-lock.pid │ $XDG_DATA_HOME/newsboat/.lock │
1528 └─────────┴───────────────────────────┴───────────────────────────────────────┘
1529 Newsboat places the lock file next to the cache file, so if you specify
1531 cache-file setting or pass --cache-file command-line argument, the path
1532 to the lock file will change too. Podboat, on the other hand, always
1533 places its lock file as shown above.
1534 dotfiles
1536 ~/.newsboat/config
1537 ~/.newsboat/urls
1539 XDG
1541 $XDG_CONFIG_HOME/newsboat/config
1542 $XDG_CONFIG_HOME/newsboat/urls
1544 Note: if the XDG_CONFIG_HOME environment variable is not set,
1546 Newsboat behaves as if it was set to ~/.config.
1547
1549 BROWSER
1550 Tells Newsboat what browser to use if there is no browser setting
1551 in the config file. If this variable doesn’t exist, a default of
1552 lynx(1) will be used.
1553 CURL_CA_BUNDLE
1555 Tells Newsboat to use the specified certificate file to verify the
1556 peer. The file may contain multiple certificates. The
1557 certificate(s) must be in PEM format.
1558 This option is useful if your libcurl is built without useful
1560 certificate information, and you can’t rebuild the library
1561 yourself.
1562 EDITOR
1564 Tells Newsboat what fallback editor to use when editing the urls
1565 file via the edit-urls operation and no VISUAL environment variable
1566 is set. If this variable doesn’t exist either, a default of vi(1)
1567 will be used.
1568 PAGER
1570 Tells Newsboat what pager to use if the pager setting in the config
1571 file is explicitly set to an empty string.
1572 TMPDIR
1574 Tells Newsboat to use the specified directory for storing temporary
1575 files. If this variable doesn’t exist, a default of /tmp will be
1576 used.
1577 VISUAL
1579 Tells Newsboat what editor to use when editing the urls file via
1580 the edit-urls operation. If this variable doesn’t exist, the EDITOR
1581 environment variable will be used.
1582 XDG_CONFIG_HOME
1584 Tells Newsboat which base directory to use for the configuration
1585 files. See also the section on files for more information.
1586 XDG_DATA_HOME
1588 Tells Newsboat which base directory to use for the data files. See
1589 also the section on files for more information.
1590
1592 podboat(1)
1593
1595 Alexander Batischev
1596 2021-03-22 NEWSBOAT(1)