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.
110 Adding Feeds
112 To add feeds to Newsboat, you can simply add one feed URL per line to
113 the ~/.newsboat/urls configuration file:
114 http://rss.cnn.com/rss/cnn_topstories.rss
116 http://newsrss.bbc.co.uk/rss/newsonline_world_edition/front_page/rss.xml
117 You can also import an OPML file by running newsboat -i blogroll.opml
119 Adding comments Lines that start with # can contain anything you
122 want. Comments are ignored by Newsboat, but can serve as
123 documentation for you. Please note, that commenting out URLs for
124 debugging purposes might lead to unexpected data loss, see
125 cleanup-on-quit for more details.
126 Feeds with restricted access
128 If you need to add URLs that have restricted access, simply provide
130 username/password:
131 https://username:password@hostname.domain.tld/feed.rss
133 In case there is a @ in the username, you need to write it as %40.
135 In order to protect usernames and passwords, make sure to restrict read
137 access for ~/.newsboat/urls to you and optionally your group:
138 $ chmod u=rw,g=r,o= ~/.newsboat/urls
140 Newsboat makes sure to not display usernames and passwords in its user
142 interface.
143 Local files as feeds
145 You can also configure local files as feeds, by prefixing the local
147 path with file:// and adding it to the urls file:
148 file:///var/log/rss_eventlog.xml
150 First UI Interaction
152 The main UI of Newsboat consists of three views
153 Feed List View → Article List View → Article View
155 You can drill down those views by pressing Enter and move to the
157 previous one by pressing Q. Pressing Q on the Feed List View — or
158 pressing Shift + Q from anywhere — closes Newsboat.
159 You can also search articles' title or content by pressing / on the
161 Feed List View or the Article List View. On the Feed List View all
162 articles of all feeds are taken into account. On the Article List View
163 the articles of the current feed are taken into account. When opening
164 an article from a search result dialog, the search phrase is
165 highlighted.
166 Search history The history of all your searches is saved to the
169 filesystem, to the history.search file (stored next to the cache.db
170 file). By default, the last 100 search phrases are stored.
171 You can influence how many search phrases are stored by configuring
173 history-limit.
174 Feed List View
176 When you start Newsboat, it presents you with a list of feeds that you
178 added previously.
179 You can now:
181 • Press Shift + R to download articles for all feeds.
183 • Press R to download articles for the selected feed.
185 • Press / to search all articles in all feeds.
187 • Press Enter to go to the article list of a selected feed.
189 • Press Q to close Newsboat.
191 Local articles Newsboat keeps the articles that it downloads. When
194 you start Newsboat again and reload a feed, old articles can still
195 be read even if they aren’t in the current RSS feeds anymore.
196 You can configure how many articles are kept per feed so that the
198 article backlog doesn’t grow endlessly by configuring max-items.
199 Caching Newsboat uses a number of measures to preserve the users'
202 and feed providers' bandwidth through the use of conditional HTTP
203 downloading. It saves every feed’s "Last-Modified" and "ETag"
204 response header values (if present) and advises the feed’s HTTP
205 server to only send data if the feed has been updated. This doesn’t
206 only make feed downloads for RSS feeds with no new updates faster,
207 it also reduces the amount of transferred data per request.
208 You can disable conditional HTTP downloading per feed by
210 configuring always-download.
211 Article List View
213 After you entered a feed, you can see the list of available articles by
215 their title. A N on the left indicates that an article wasn’t read yet.
216 You can now:
218 • Press Q to go back to the Feed List View.
220 • Press / to search all articles of this feed.
222 • Press Enter to read a selected article.
224 Article View
226 On an article you can scroll through the text and read it. Each link in
228 the article has a number next to it.
229 You can now:
231 • Press any number to open an article link in the browser. For
233 numbers larger than 9 type #, then the number and press Enter.
234 • Press O to open the article in the browser.
236 • Press Q to go back to the Article List View.
238 Browser view Sometimes the content of an article is empty or just
241 an abstract or short description. You can always press O to view
242 the complete article in a browser. The default browser is lynx.
243 You can use your browser of choice by configuring browser.
245
247 Several aspects of Newsboat can be configured via a config file, which
248 is stored next to the urls file. A configuration line looks like this
249 in general:
250 <config-command> <arg1> ...
252 The configuration file can contain comments, which start with the #
254 character and go as far as the end of line.
255 User contrib Newsboat also comes with user contributed content like
258 scripts and color themes. The user contributed content can be found
259 in /usr/share/doc/newsboat/contrib/. End users are encouraged to
260 take a look as they may find something useful.
261 Example
263 An example configuration looks like this
264 # a comment
266 max-items 100 # such comments are possible, too
267 browser links
268 show-read-feeds no
269 unbind-key R
271 bind-key ^R reload-all
272 Splitting long lines into multiple ones
274 Configuration items, such as macros defined in config files which are
275 long can be split up into multiple ones using backslashes; these must
276 be the last character on the line and will immediately concatenate it
277 with the following line. It’s important that nothing follows the \ on
278 the same line, otherwise the \ character is treated "as is".
279 Dummy example:
281 macro p open; \
283 reload; quit; \
284 quit; \
285 quit -- "Opens, reloads then makes sure to quit newsboat"
286 Using Double Quotes
288 TL;DR Use double quotes for strings that contain spaces or double
289 quotes. Escape double quotes (use \") and backslashes (use \\).
290 Don’t escape stuff outside of double quotes, and don’t use single
291 quotes for quoting — Newsboat doesn’t support that.
292 Many of Newsboat’s options expect strings as arguments, be it commands,
294 passwords, dialog titles, URLs etc. Some options even take multiple
295 strings at once. These strings can contain spaces, which might confuse
296 Newsboat since it already uses spaces to separate option names from
297 option arguments.
298 To help Newsboat understand your intent, put such strings into double
300 quotes:
301 browser "firefox --new-tab %u"
303 What if you need a double quote inside a string? Escape it with a
305 backslash:
306 ocnews-password "UnbalancedQuotes\"AreSoFun!"
308 And what about the backslash itself? Escape it, too! Suppose you have a
310 program called my favourite pager, and you want to view articles with
311 it. Newsboat ultimately passes commands to the shell, and shell expects
312 spaces to be escaped if you want them preserved. But since Newsboat
313 interprets backslashes, you have to add another layer of escaping.
314 Thus, you end up with a command like this:
315 pager "/usr/bin/my\\ favourite\\ pager"
317 Shell Evaluation
319 It is also possible to integrate the output of external commands into
320 the configuration. The text between two ` backticks is evaluated as
321 shell command, and its output is used. This works like backtick
322 evaluation in Bourne-compatible shells and allows users to use external
323 information from the system within the configuration.
324 Escaping
326 Backticks and # characters can be escaped with a backslash (e.g. \` and
327 \#). In this case, they are replaced with literal ` or # in the
328 configuration.
329 Key Bindings
331 You can bind a key to an operation with the bind-key configuration
332 command. You can specify an optional dialog. This is the context in
333 which the key binding is active.
334 The syntax for a key binding looks like this:
336 bind-key <key> <operation> [<dialog>]
338 Key
340 Lowercase keys, uppercase keys and special characters are written
342 literally.
343 Key combinations with Ctrl are written using the caret ^. For instance
345 Ctrl + R equals to ^R. Please be aware that all Ctrl-related key
346 combinations need to be written in uppercase.
347 The following identifiers for special keys are supported:
349 • ENTER (Enter key)
351 • BACKSPACE (backspace key)
353 • LEFT (left cursor)
355 • RIGHT (right cursor)
357 • UP (up cursor)
359 • DOWN (down cursor)
361 • PPAGE (page up cursor)
363 • NPAGE (page down cursor)
365 • HOME (cursor to beginning of list/article)
367 • END (cursor to end of list/article)
369 • ESC (Esc key)
371 • TAB (Tab key)
373 • F1 to F12 (F1 key to F12 key)
375 Operation
377 An operation gets executed when pressing the corresponding key. For a
379 complete list of available operations see [_newsboat_operations] and
380 [_podboat_operations].
381 Dialog
383 A dialog is a context in which the key binding is active. Available
385 dialogs are:
386 • all (default if not specified)
388 • feedlist
390 • filebrowser
392 • help
394 • articlelist
396 • article
398 • tagselection
400 • filterselection
402 • urlview
404 • podboat
406 • dirbrowser
408 • searchresultslist
410 Colors
412 It is possible to configure custom color settings in Newsboat. The
413 basic configuration syntax is:
414 color <element> <foreground color> <background color> [<attribute> ...]
416 This means that if you configure colors for a certain element, you need
418 to provide a foreground color and a background color as a minimum. The
419 following colors are supported:
420 • black
422 • red
424 • green
426 • yellow
428 • blue
430 • magenta
432 • cyan
434 • white
436 • default
438 • color<n>, e.g. color123
440 The default color means that the terminal’s default color will be used.
442 The color<n> color name (where <n> is a decimal number not starting
443 with zero) can be used if your terminal supports 256 colors (e.g.
444 gnome-terminal, or xterm with TERM set to xterm-256color). Newsboat
445 contains support for 256 color terminals since version 2.1. For a
446 complete chart of colors and their corresponding numbers, please see
447 https://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html.
448 Optionally, you can also add one or more attributes. The following
450 attributes are supported:
451 • standout
453 • underline
455 • reverse
457 • blink
459 • dim
461 • bold
463 • protect
465 • invis
467 Currently, the following elements are supported:
469 • background: the application background
471 • listnormal: a normal list item
473 • listfocus: the currently selected list item
475 • listnormal_unread: an unread list item
477 • listfocus_unread: the currently selected unread list item
479 • title (added in 2.25): current dialog’s title, which is usually at
481 the top of the screen (but see show-title-bar and
482 swap-title-and-hints). If you don’t specify a style for this
483 element, then the info style is used
484 • info: the hints bar, which is usually at the bottom of the screen
486 (but see show-keymap-hint and swap-title-and-hints)
487 • hint-key (added in 2.25): a key in the hints bar. If you don’t
489 specify a style for this element, then the info style is used
490 • hint-keys-delimiter (added in 2.25): the comma that separates keys
492 in the hints bar. If you don’t specify a style for this element,
493 then the info style is used
494 • hint-separator (added in 2.25): the colon separating keys from
496 their descriptions in the hints bar. If you don’t specify a style
497 for this element, then the info style is used
498 • hint-description (added in 2.25): a description of a key in the
500 hints bar. If you don’t specify a style for this element, then the
501 info style is used
502 • article: the article text
504 • end-of-text-marker: filler lines (~) below blocks of text
506 The default color configuration of Newsboat looks like this:
508 color background white black
510 color listnormal white black
511 color listfocus yellow blue bold
512 color listnormal_unread magenta black
513 color listfocus_unread magenta blue bold
514 color title yellow blue bold
515 color info yellow blue bold
516 color hint-key yellow blue bold
517 color hint-keys-delimiter yellow white
518 color hint-separator yellow white bold
519 color hint-description yellow white
520 color article white black
521
523 always-display-description (parameters: [yes/no]; default value: no)
524 If set to yes, then the description will always be displayed even
525 if e.g. a <content:encoded> tag has been found. (example:
526 always-display-description yes)
527 always-download (parameters: <url> [<url>...]; default value: n/a)
529 Specifies one or more feed URLs that should always be downloaded,
530 regardless of their Last-Modified timestamp and ETag header. This
531 option can be specified multiple times. (example: always-download
532 "https://www.n-tv.de/23.rss")
533 article-sort-order (parameters: <sortfield>[-<direction>]; default
535 value: date-asc)
536 The <sortfield> specifies which article property shall be used for
537 sorting. Currently available are: date, title, flags, author, link,
538 guid, and random. The optional <direction> can be either asc for
539 ascending order, or desc for descending order. Note that direction
540 does not affect the random sorting. For date, desc order is the
541 default, i.e. date is the same as date-desc; for all others, asc is
542 the default. Also, the directions for date are reversed: desc means
543 the newest items are first, whereas asc means the oldest items are
544 first. These inconsistencies will be fixed in a future major
545 version of Newsboat. (example: article-sort-order author-desc)
546 articlelist-format (parameters: <format>; default value: "%4i %f %D %6L
548 %?T?|%-17T| ?%t")
549 This variable defines the format of entries in the article list.
550 See the respective section in the documentation for more
551 information on format strings. (example: articlelist-format "%4i %f
552 %D %?T?|%-17T| ?%t")
553 articlelist-title-format (parameters: <format>; default value: "%N %V -
555 Articles in feed '%T' (%u unread, %t total)%?F? matching filter '%F'&?
556 - %U" (localized))
557 Format of the title in article list. See "Format Strings" section
558 of Newsboat manual for details on available formats. (example:
559 articlelist-title-format "Articles in feed '%T' (%u unread)")
560 auto-reload (parameters: [yes/no]; default value: no)
562 If set to yes, all feeds will be automatically reloaded at start up
563 and then continuously after a certain time has passed (see
564 reload-time). See also refresh-on-startup to only reload the feeds
565 at start up, but not continuously. Enabling suppress-first-reload
566 omits the reload on start up. (example: auto-reload yes)
567 bind-key (parameters: <key> <operation> [<dialog>]; default value: n/a)
569 Bind key <key> to <operation>. This means that whenever <key> is
570 pressed, then <operation> is executed (if applicable in the current
571 dialog). For more information see Key Bindings. See also unbind-key
572 to remove a key binding. (example: bind-key ^R reload-all)
573 bookmark-autopilot (parameters: [yes/no]; default value: no)
575 If set to yes, the configured bookmark command is executed without
576 any further input asked from user, unless the url or the title
577 cannot be found/guessed. (example: bookmark-autopilot yes)
578 bookmark-cmd (parameters: <command>; default value: "")
580 If set, then <command> will be used as bookmarking plugin. See the
581 documentation on bookmarking for further information. (example:
582 bookmark-cmd "~/bin/delicious-bookmark.sh")
583 bookmark-interactive (parameters: [yes/no]; default value: no)
585 If set to yes, then the configured bookmark command is an
586 interactive program. (example: bookmark-interactive yes)
587 browser (parameters: <command>; default value: %BROWSER, otherwise
589 lynx)
590 Set the browser command to use when opening an article in the
591 browser. If the BROWSER environment variable is set, it will be
592 used as the default browser, otherwise lynx will be used. For more
593 information, see Using Browser. (example: browser "w3m %u")
594 cache-file (parameters: <path>; default value: "~/.newsboat/cache.db"
596 or "~/.local/share/cache.db" (see "Files" section))
597 This configuration option sets the cache file. This is especially
598 useful if the filesystem of your home directory doesn’t support
599 proper locking (e.g. NFS). (example: cache-file
600 "/tmp/testcache.db")
601 cleanup-on-quit (parameters: [yes/no]; default value: yes)
603 If set to yes, then the cache gets locked and superfluous feeds and
604 items are removed, such as feeds that can’t be found in the urls
605 configuration file anymore. Run newsboat --cleanup to do this
606 manually. If you encounter a warning about unreachable feeds having
607 been found, you may see the feed urls listed by creating a log file
608 via the error-log option. (example: cleanup-on-quit no)
609 color (parameters: <element> <fgcolor> <bgcolor> [<attribute> ...];
611 default value: n/a)
612 Set the foreground color, background color and optional attributes
613 for a certain element. (example: color background white black)
614 confirm-delete-all-articles (parameters: [yes/no]; default value: yes)
616 If set to yes, then Newsboat will ask for confirmation whether the
617 user wants to delete all articles. (example:
618 confirm-delete-all-articles no)
619 confirm-exit (parameters: [yes/no]; default value: no)
621 If set to yes, then Newsboat will ask for confirmation whether the
622 user really wants to quit Newsboat. (example: confirm-exit yes)
623 confirm-mark-all-feeds-read (parameters: [yes/no]; default value: yes)
625 If set to yes, then Newsboat will ask for confirmation whether the
626 user wants to mark all feeds as read. (example:
627 confirm-mark-all-feeds-read no)
628 confirm-mark-feed-read (parameters: [yes/no]; default value: yes)
630 If set to yes, then Newsboat will ask for confirmation on whether
631 the user wants to mark a feed as read. (example:
632 confirm-mark-feed-read no)
633 cookie-cache (parameters: <path>; default value: "")
635 Set a cookie cache. If set, cookies will be cached in (i.e. read
636 from and written to) this file, using Netscape format
637 <http://www.cookiecentral.com/faq/#3.5>. (example: cookie-cache
638 "~/.newsboat/cookies.txt")
639 datetime-format (parameters: <date/time format>; default value: %b %d)
641 This format specifies the date/time format in the article list. For
642 a detailed documentation on most of the allowed formats, consult
643 the manpage of strftime(3). %L is a custom format not available in
644 strftime which lists the days since the article was published (e.g.
645 "2 days ago"). (example: datetime-format "%D, %R")
646 define-filter (parameters: <name> <filterexpr>; default value: n/a)
648 With this command, you can predefine filters, which you can later
649 select from a list, and which are then applied after selection.
650 This is especially useful for filters that you need often and you
651 don’t want to enter them every time you need them. (example:
652 define-filter "all feeds with 'fun' tag" "tags # \"fun\"")
653 delete-read-articles-on-quit (parameters: [yes/no]; default value: no)
655 If set to yes, all read articles will be deleted when quiting
656 Newsboat. This option only applies if cleanup-on-quit is set to yes
657 or if the —cleanup argument is passed. (example:
658 delete-read-articles-on-quit yes)
659 dialogs-title-format (parameters: <format>; default value: "%N %V -
661 Dialogs" (localized))
662 Format of the title in dialog list. See "Format Strings" section of
663 Newsboat manual for details on available formats. (example:
664 dialogs-title-format "%N %V - Dialogs")
665 dirbrowser-title-format (parameters: <format>; default value: "%N %V -
667 %?O?Open Directory&Save File? - %f" (localized))
668 Format of the title in directory browser. See "Format Strings"
669 section of Newsboat manual for details on available formats.
670 (example: dirbrowser-file-format "%?O?Open Directory&Save File? -
671 %f")
672 display-article-progress (parameters: [yes/no]; default value: yes)
674 If set to yes, then a read progress (in percent) is displayed in
675 the article view. Otherwise, no read progress is displayed.
676 (example: display-article-progress no)
677 download-full-page (parameters: [yes/no]; default value: no)
679 If set to yes, then for all feed items with no content but with a
680 link, the link is downloaded and the result used as content
681 instead. This may significantly increase the download times of
682 "empty" feeds. (example: download-full-page yes)
683 download-retries (parameters: <number>; default value: 1)
685 How many times Newsboat shall try to successfully download a feed
686 before giving up. This is an option to improve the success of
687 downloads on slow and shaky connections such as via a TOR proxy.
688 (example: download-retries 4)
689 download-timeout (parameters: <number>; default value: 30)
691 The number of seconds Newsboat shall wait when downloading a feed
692 before giving up. This is an option to improve the success of
693 downloads on slow and shaky connections such as via a TOR proxy.
694 (example: download-timeout 60)
695 error-log (parameters: <path>; default value: "")
697 If set, then user errors (e.g. errors regarding defunct RSS feeds)
698 will be logged to this file. (example: error-log
699 "~/.newsboat/error.log")
700 external-url-viewer (parameters: <command>; default value: "")
702 If set, then show-urls will pipe the current article to a specific
703 external tool instead of using the internal URL viewer. This can be
704 used to integrate tools such as urlview. (example:
705 external-url-viewer "urlview")
706 feed-sort-order (parameters: <sortfield>[-<direction>]; default value:
708 none)
709 The <sortfield> specifies which feed property shall be used for
710 sorting; currently available are: firsttag, title, articlecount,
711 unreadarticlecount, lastupdated and none. The optional <direction>
712 specifies the sort direction. asc specifies ascending sorting, desc
713 specifies descending sorting. desc is the default. (example:
714 feed-sort-order firsttag)
715 feedhq-flag-share (parameters: <flag>; default value: "")
717 If set and FeedHQ support is used, then all articles that are
718 flagged with the specified flag are being "shared" in FeedHQ so
719 that people that follow you can see it. (example: feedhq-flag-share
720 "a")
721 feedhq-flag-star (parameters: <flag>; default value: "")
723 If set and FeedHQ support is used, then all articles that are
724 flagged with the specified flag are being "starred" in FeedHQ and
725 appear in the list of "Starred items". (example: feedhq-flag-star
726 "b")
727 feedhq-login (parameters: <login>; default value: "")
729 This variable sets your FeedHQ login for FeedHQ support. (example:
730 feedhq-login "your-login")
731 feedhq-min-items (parameters: <number>; default value: 20)
733 This variable sets the number of articles that are loaded from
734 FeedHQ per feed. (example: feedhq-min-items 100)
735 feedhq-password (parameters: <password>; default value: "")
737 This variable sets your FeedHQ password for FeedHQ support. Double
738 quotes and backslashes within it should be escaped. (example:
739 feedhq-password "here_goesAquote:\"")
740 feedhq-passwordeval (parameters: <command>; default value: "")
742 A more secure alternative to the above, is providing your password
743 from an external command that is evaluated during login. This can
744 be used to read your password from a gpg encrypted file or your
745 system keyring. (example: feedhq-passwordeval "gpg --decrypt
746 ~/.newsboat/feedhq-password.gpg")
747 feedhq-passwordfile (parameters: <path>; default value: "")
749 Another alternative, by storing your plaintext password elsewhere
750 in your system. (example: feedhq-passwordfile
751 "~/.newsboat/feedhq-pw.txt")
752 feedhq-show-special-feeds (parameters: [yes/no]; default value: yes)
754 If set and FeedHQ support is used, then "special feeds" like
755 "People you follow" (articles shared by people you follow),
756 "Starred items" (your starred articles) and "Shared items" (your
757 shared articles) appear in your subscription list. (example:
758 feedhq-show-special-feeds "no")
759 feedhq-url (parameters: <url>; default value: "https://feedhq.org/")
761 Configures the URL where your FeedHQ instance resides. (example:
762 feedhq-url "https://feedhq.example.com/")
763 feedlist-format (parameters: <format>; default value: "%4i %n %11u %t")
765 This variable defines the format of entries in the feed list. See
766 the respective section in the documentation for more information on
767 format strings. (example: feedlist-format " %n %4i - %11u -%> %t")
768 feedlist-title-format (parameters: <format>; default value: "%N %V -
770 %?F?Feeds&Your feeds? (%u unread, %t total)%?F? matching filter
771 '%F'&?%?T? - tag '%T'&?" (localized))
772 Format of the title in feed list. See "Format Strings" section of
773 Newsboat manual for details on available formats. (example:
774 feedlist-title-format "Feeds (%u unread, %t total)")
775 filebrowser-title-format (parameters: <format>; default value: "%N %V -
777 %?O?Open File&Save File? - %f" (localized))
778 Format of the title in file browser. See "Format Strings" section
779 of Newsboat manual for details on available formats. (example:
780 filebrowser-title-format "%?O?Open File&Save File? - %f")
781 freshrss-flag-star (parameters: <flag>; default value: "")
783 If set and FreshRSS support is used, then all articles that are
784 flagged with the specified flag are being "starred" in FreshRSS and
785 appear in the list of "Starred items". (example: freshrss-flag-star
786 "b")
787 freshrss-login (parameters: <login>; default value: "")
789 This variable sets your FreshRSS login for FreshRSS support.
790 (example: freshrss-login "your-login")
791 freshrss-min-items (parameters: <number>; default value: 20)
793 This variable sets the number of articles that are loaded from
794 FreshRSS per feed. (example: freshrss-min-items 100)
795 freshrss-password (parameters: <password>; default value: "")
797 This variable sets your FreshRSS password for FreshRSS support.
798 Double quotes and backslashes within it should be escaped.
799 (example: freshrss-password "here_goesAquote:\"")
800 freshrss-passwordeval (parameters: <command>; default value: "")
802 A more secure alternative to the above, is providing your password
803 from an external command that is evaluated during login. This can
804 be used to read your password from a gpg encrypted file or your
805 system keyring. (example: freshrss-passwordeval "gpg --decrypt
806 ~/.newsboat/freshrss-password.gpg")
807 freshrss-passwordfile (parameters: <path>; default value: "")
809 Another alternative, by storing your plaintext password elsewhere
810 in your system. (example: freshrss-passwordfile
811 "~/.newsboat/freshrss-pw.txt")
812 freshrss-show-special-feeds (parameters: [yes/no]; default value: yes)
814 If set and FreshRSS support is used, then a "Starred items" feed
815 (containing your starred/favourited articles) appears in your
816 subscription list. (example: freshrss-show-special-feeds "no")
817 freshrss-url (parameters: <url>; default value: "")
819 Configures the URL for the Google Reader API endpoint of your
820 FreshRSS instance. (example: freshrss-url
821 "https://freshrss.example.com/api/greader.php")
822 goto-first-unread (parameters: [yes/no]; default value: yes)
824 If set to yes, then the first unread article will be selected
825 whenever a feed is entered. (example: goto-first-unread no)
826 goto-next-feed (parameters: [yes/no]; default value: yes)
828 If set to yes, then the next-unread, prev-unread and random-unread
829 keys will search in other feeds for unread articles if all articles
830 in the current feed are read. If set to no, then these keys will
831 stop in the current feed. (example: goto-next-feed no)
832 help-title-format (parameters: <format>; default value: "%N %V - Help"
834 (localized))
835 Format of the title in help window. See "Format Strings" section of
836 Newsboat manual for details on available formats. (example:
837 help-title-format "%N %V - Help")
838 highlight (parameters: <target> <regex> <fgcolor> [<bgcolor>
840 [<attribute> ...]]; default value: n/a)
841 With this command, you can highlight text parts in the feed list,
842 the article list and the article view. (example: highlight all
843 "newsboat" red)
844 highlight-article (parameters: <filterexpr> <fgcolor> <bgcolor>
846 [<attribute> ...]; default value: n/a)
847 With this command, you can highlight articles in the article list
848 if they match a filter expression. (example: highlight-article
849 "author =~ \"Andreas Krennmair\"" white red bold)
850 highlight-feed (parameters: <filterexpr> <fgcolor> <bgcolor>
852 [<attribute> ...]; default value: n/a)
853 With this command, you can highlight feeds in the feed list if they
854 match a filter expression. (example: highlight-feed unread › 100
855 white red bold)
856 history-limit (parameters: <number>; default value: 100)
858 Defines the maximum number of entries of commandline resp. search
859 history to be saved. To disable history saving, set it to 0.
860 (example: history-limit 0)
861 html-renderer (parameters: <command>; default value: internal)
863 If set to internal, then the internal HTML renderer will be used.
864 Otherwise, the specified command will be executed, the HTML to be
865 rendered will be written to the command’s stdin, and the program’s
866 output will be displayed. This makes it possible to use other,
867 external programs, such as w3m, links or lynx, to render HTML.
868 (example: html-renderer "w3m -dump -T text/html")
869 http-auth-method (parameters: <method>; default value: any)
871 Set HTTP authentication method. Allowed values: any, basic, digest,
872 digest_ie (only available with libcurl 7.19.3 and newer),
873 gssnegotiate, ntlm and anysafe. (example: http-auth-method digest)
874 ignore-article (parameters: <feed> <filterexpr>; default value: n/a)
876 If a downloaded article from <feed> matches <filterexpr>, then it
877 is ignored and not presented to the user. This command is further
878 explained in the "kill file" section below. (example:
879 ignore-article "*" "title =~ \"Windows\"")
880 ignore-mode (parameters: [download/display]; default value: download)
882 This configuration option defines in what way an article is ignored
883 (see ignore-article). If set to download, then it is ignored in the
884 download/parsing phase and thus never written to the cache, if it
885 set to display, it is ignored when displaying articles but is kept
886 in the cache. (example: ignore-mode "display")
887 include (parameters: <path>; default value: n/a)
889 With this command, you can include other files to be interpreted as
890 configuration files. This is especially useful to separate your
891 configuration into several files, e.g. key configuration, color
892 configuration, ... (example: include "~/.newsboat/colors")
893 inoreader-app-id (parameters: <string>; default value: "")
895 Unique application ID issued by Inoreader. See "Inoreader" section.
896 (example: inoreader-app-id "123456789")
897 inoreader-app-key (parameters: <string>; default value: "")
899 Application key issued by Inoreader. See "Inoreader" section.
900 (example: inoreader-app-key "TmV3c2JvYXQgcm9ja3MgOikK")
901 inoreader-flag-share (parameters: <flag>; default value: "")
903 If set and Inoreader support is used, then all articles that are
904 flagged with the specified flag are being "shared" in Inoreader so
905 that people that follow you can see it. (example:
906 inoreader-flag-share "a")
907 inoreader-flag-star (parameters: <flag>; default value: "")
909 If set and Inoreader support is used, then all articles that are
910 flagged with the specified flag are being "starred" in Inoreader
911 and appear in the list of "Starred items". (example:
912 inoreader-flag-star "b")
913 inoreader-login (parameters: <login>; default value: "")
915 This variable sets your Inoreader login for Inoreader support.
916 (example: inoreader-login "your-login")
917 inoreader-min-items (parameters: <number>; default value: 20)
919 This variable sets the number of articles that are loaded from
920 Inoreader per feed. (example: inoreader-min-items 100)
921 inoreader-password (parameters: <password>; default value: "")
923 This variable sets your Inoreader password for Inoreader support.
924 Double quotes and backslashes within it should be escaped.
925 (example: inoreader-password "here_goesAquote:\"")
926 inoreader-passwordeval (parameters: <command>; default value: "")
928 A more secure alternative to the above, is providing your password
929 from an external command that is evaluated during login. This can
930 be used to read your password from a gpg encrypted file or your
931 system keyring. (example: inoreader-passwordeval "gpg --decrypt
932 ~/.newsboat/inoreader-password.gpg")
933 inoreader-passwordfile (parameters: <path>; default value: "")
935 Another alternative, by storing your plaintext password elsewhere
936 in your system. (example: inoreader-passwordfile
937 "~/.newsboat/inoreader-pw.txt")
938 inoreader-show-special-feeds (parameters: [yes/no]; default value: yes)
940 If set and Inoreader support is used, then "special feeds" like
941 "Starred items" (your starred articles) and "Shared items" (your
942 shared articles) appear in your subscription list. (example:
943 inoreader-show-special-feeds "no")
944 itemview-title-format (parameters: <format>; default value: "%N %V -
946 Article '%T' (%u unread, %t total)" (localized))
947 Format of the title in article view. See "Format Strings" section
948 of Newsboat manual for details on available formats. (example:
949 itemview-title-format "Article '%T'")
950 keep-articles-days (parameters: <number>; default value: 0)
952 If set to a number greater than 0, only articles that were
953 published within the last <number> days are kept, and older
954 articles are deleted. If set to 0, this option is not active. Note
955 that changing this setting won’t bring back the articles that were
956 deleted earlier; currently, there’s no non-hacky way to bring back
957 deleted articles. (example: keep-articles-days 30)
958 macro (parameters: <macro key> <command list> [-- "<macro
960 description>"]; default value: n/a)
961 With this command, you can define a macro key and specify a list of
962 commands that shall be executed when the macro prefix and the macro
963 key are pressed. Optionally, a description can be added. If
964 present, the description is shown in the help form. (example: macro
965 k open; reload; quit -- "enter feed to reload it")
966 mark-as-read-on-hover (parameters: [yes/no]; default value: no)
968 If set to yes, then all articles that get selected in the article
969 list are marked as read. (example: mark-as-read-on-hover yes)
970 max-browser-tabs (parameters: <number>; default value: 10)
972 Set the maximum number of articles to open in a browser when using
973 the open-all-unread-in-browser or
974 open-all-unread-in-browser-and-mark-read commands. (example:
975 max-browser-tabs 4)
976 max-download-speed (parameters: <number>; default value: 0)
978 If set to a number greater than 0, the download speed per download
979 is set to that limit (in KB/s). (example: max-download-speed 50)
980 max-items (parameters: <number>; default value: 0)
982 Set the number of articles to maximally keep per feed. If the
983 number is set to 0, then all articles are kept. (example: max-items
984 100)
985 miniflux-login (parameters: <username>; default value: "")
987 Sets the username for use with Miniflux. (example: miniflux-login
988 "admin")
989 miniflux-min-items (parameters: <number>; default value: 100)
991 This variable sets the number of articles that are loaded from
992 Miniflux per feed. (example: miniflux-min-items 20)
993 miniflux-password (parameters: <password>; default value: "")
995 Configures the password for use with Miniflux. Double quotes and
996 backslashes within it should be escaped. (example:
997 miniflux-password "here_goesAquote:\"")
998 miniflux-passwordeval (parameters: <command>; default value: "")
1000 A more secure alternative to the above, is providing your password
1001 from an external command that is evaluated during login. This can
1002 be used to read your password from a gpg encrypted file or your
1003 system keyring. (example: miniflux-passwordeval "gpg --decrypt
1004 ~/.newsboat/miniflux-password.gpg")
1005 miniflux-passwordfile (parameters: <path>; default value: "")
1007 Another alternative, by storing your plaintext password elsewhere
1008 in your system. (example: miniflux-passwordfile
1009 "~/.newsboat/miniflux-pw.txt")
1010 miniflux-token (parameters: <API Token>; default value: "")
1012 Sets the API Token for use with Miniflux. (example: miniflux-token
1013 "E-uTqU8r55KucuHz26tJbXfrZVRndwY_mZAsEfcC8Bg=")
1014 miniflux-tokeneval (parameters: <command>; default value: "")
1016 A more secure alternative to the above, is providing your API token
1017 from an external command that is evaluated during login. This can
1018 be used to read your token from a gpg encrypted file or your system
1019 keyring. (example: miniflux-tokeneval "gpg --decrypt
1020 ~/.newsboat/miniflux-token.gpg")
1021 miniflux-tokenfile (parameters: <API Token>; default value: "")
1023 Another alternative, by storing your plaintext token elsewhere in
1024 your system. (example: miniflux-tokenfile
1025 "~/.newsboat/miniflux-token.txt")
1026 miniflux-url (parameters: <url>; default value: "")
1028 Configures the URL where the Miniflux installation you want to use
1029 resides. (example: miniflux-url "https://example.com/miniflux/")
1030 newsblur-login (parameters: <login>; default value: "")
1032 This variable sets your NewsBlur login for NewsBlur support.
1033 (example: newsblur-login "your-login")
1034 newsblur-min-items (parameters: <number>; default value: 20)
1036 This variable sets the number of articles that are loaded from
1037 NewsBlur per feed. (example: newsblur-min-items 100)
1038 newsblur-password (parameters: <password>; default value: "")
1040 This variable sets your NewsBlur password for NewsBlur support.
1041 Double quotes and backslashes within it should be escaped.
1042 (example: newsblur-password "here_goesAquote:\"")
1043 newsblur-passwordeval (parameters: <command>; default value: "")
1045 A more secure alternative to the above, is providing your password
1046 from an external command that is evaluated during login. This can
1047 be used to read your password from a gpg encrypted file or your
1048 system keyring. (example: newsblur-passwordeval "gpg --decrypt
1049 ~/.newsboat/newsblur-password.gpg")
1050 newsblur-passwordfile (parameters: <path>; default value: "")
1052 Another alternative, by storing your plaintext password elsewhere
1053 in your system. (example: newsblur-passwordfile
1054 "~/.newsboat/newsblur-pw.txt")
1055 newsblur-url (parameters: <url>; default value: "https://newsblur.com")
1057 Configures the URL where the NewsBlur instance resides. (example:
1058 newsblur-url "https://localhost")
1059 notify-always (parameters: [yes/no]; default value: no)
1061 If set to no, notifications will only be made when there are new
1062 feeds or articles. If set to yes, notifications will be made
1063 regardless. (example: notify-always yes)
1064 notify-beep (parameters: [yes/no]; default value: no)
1066 If set to yes, then the speaker will beep on new articles.
1067 (example: notify-beep yes)
1068 notify-format (parameters: <string>; default value: "Newsboat: finished
1070 reload, %f unread feeds (%n unread articles total)" (localized))
1071 Format string that is used for formatting notifications. (example:
1072 notify-format "%d new articles (%n unread articles, %f unread
1073 feeds)")
1074 notify-program (parameters: <command>; default value: "")
1076 If set, then the configured program will be executed if new
1077 articles arrived (through a reload) or if notify-always is yes. The
1078 first parameter of the called program contains the notification
1079 message. In order to pass other hard-coded arguments to the
1080 program, write an appropriate wrapper shell script and use it as
1081 <command> instead. (example: notify-program "~/bin/my-notifier")
1082 notify-screen (parameters: [yes/no]; default value: no)
1084 If set to yes, then a "privacy message" will be sent to the
1085 terminal, containing a notification message about new articles.
1086 This is especially useful if you use terminal emulations such as
1087 GNU screen which implement privacy messages. (example:
1088 notify-screen yes)
1089 notify-xterm (parameters: [yes/no]; default value: no)
1091 If set to yes, then the xterm window title will be set to a
1092 notification message about new articles. (example: notify-xterm
1093 yes)
1094 ocnews-flag-star (parameters: <character>; default value: "")
1096 If set and ownCloud News support is used, then all articles that
1097 are flagged with the specified flag are being "starred" in ownCloud
1098 News. (example: ocnews-flag-star "s")
1099 ocnews-login (parameters: <username>; default value: "")
1101 Sets the username to use with the ownCloud instance. (example:
1102 ocnews-login "user")
1103 ocnews-password (parameters: <password>; default value: "")
1105 Configures the password to use with the ownCloud instance. Double
1106 quotes and backslashes within it should be escaped. (example:
1107 ocnews-password "here_goesAquote:\"")
1108 ocnews-passwordeval (parameters: <command>; default value: "")
1110 A more secure alternative to the above, is providing your password
1111 from an external command that is evaluated during login. This can
1112 be used to read your password from a gpg encrypted file or your
1113 system keyring. (example: ocnews-passwordeval "gpg --decrypt
1114 ~/.newsboat/ocnews-password.gpg")
1115 ocnews-passwordfile (parameters: <path>; default value: "")
1117 Another alternative, by storing your plaintext password elsewhere
1118 in your system. (example: ocnews-passwordfile
1119 "~/.newsboat/ocnews-pw.txt")
1120 ocnews-url (parameters: <url>; default value: "")
1122 Configures the URL where the ownCloud instance resides. (example:
1123 ocnews-url "https://localhost/owncloud")
1124 oldreader-flag-share (parameters: <flag>; default value: "")
1126 If set and The Old Reader support is used, then all articles that
1127 are flagged with the specified flag are being "shared" in The Old
1128 Reader so that people that follow you can see it. (example:
1129 oldreader-flag-share "a")
1130 oldreader-flag-star (parameters: <flag>; default value: "")
1132 If set and The Old Reader support is used, then all articles that
1133 are flagged with the specified flag are being "starred" in The Old
1134 Reader and appear in the list of "Starred items". (example:
1135 oldreader-flag-star "b")
1136 oldreader-login (parameters: <login>; default value: "")
1138 This variable sets your The Old Reader login for The Older Reader
1139 support. (example: oldreader-login "your-login")
1140 oldreader-min-items (parameters: <number>; default value: 20)
1142 This variable sets the number of articles that are loaded from The
1143 Old Reader per feed. (example: oldreader-min-items 100)
1144 oldreader-password (parameters: <password>; default value: "")
1146 This variable sets your The Old Reader password for The Old Reader
1147 support. Double quotes and backslashes within it should be escaped.
1148 (example: oldreader-password "here_goesAquote:\"")
1149 oldreader-passwordeval (parameters: <command>; default value: "")
1151 A more secure alternative to the above, is providing your password
1152 from an external command that is evaluated during login. This can
1153 be used to read your password from a gpg encrypted file or your
1154 system keyring. (example: oldreader-passwordeval "gpg --decrypt
1155 ~/.newsboat/oldreader-password.gpg")
1156 oldreader-passwordfile (parameters: <path>; default value: "")
1158 Another alternative, by storing your plaintext password elsewhere
1159 in your system. (example: oldreader-passwordfile
1160 "~/.newsboat/oldreader-pw.txt")
1161 oldreader-show-special-feeds (parameters: [yes/no]; default value: yes)
1163 If set and The Old reader support is used, then "special feeds"
1164 like "People you follow" (articles shared by people you follow),
1165 "Starred items" (your starred articles) and "Shared items" (your
1166 shared articles) appear in your subscription list. (example:
1167 oldreader-show-special-feeds "no")
1168 openbrowser-and-mark-jumps-to-next-unread (parameters: [yes/no];
1170 default value: no)
1171 If set to yes, jump to the next unread item when an item is opened
1172 in the browser and marked as read. (example:
1173 openbrowser-and-mark-jumps-to-next-unread yes)
1174 opml-url (parameters: <url> ...; default value: "")
1176 If the OPML online subscription mode is enabled, then the list of
1177 feeds will be taken from the OPML file found on this location.
1178 Optionally, you can specify more than one URL. All the listed OPML
1179 URLs will then be taken into account when loading the feed list.
1180 (example: opml-url "https://host.domain.tld/blogroll.opml"
1181 "https://example.com/anotheropmlfile.opml")
1182 pager (parameters: [<command>/internal]; default value: internal)
1184 If set to internal, then the internal pager will be used.
1185 Otherwise, the article to be displayed will be rendered to be a
1186 temporary file and then displayed with the configured pager. If the
1187 command is set to an empty string, the content of the PAGER
1188 environment variable will be used. If the command contains a
1189 placeholder %f, it will be replaced with the temporary filename.
1190 (example: pager "less %f")
1191 podcast-auto-enqueue (parameters: [yes/no]; default value: no)
1193 If set to yes, then all podcast URLs that are found in articles are
1194 added to the podcast download queue. See the respective section in
1195 the documentation for more information on podcast support in
1196 Newsboat. (example: podcast-auto-enqueue yes)
1197 prepopulate-query-feeds (parameters: [yes/no]; default value: no)
1199 If set to yes, then all query feeds are prepopulated with articles
1200 on startup. (example: prepopulate-query-feeds yes)
1201 proxy (parameters: <server:port>; default value: n/a)
1203 Set the proxy to use for downloading RSS feeds. (Don’t forget to
1204 actually enable the proxy with use-proxy yes.) Note that the
1205 NO_PROXY environment variable can disable the proxy for certain
1206 sites. (example: proxy localhost:3128)
1207 proxy-auth (parameters: <auth>; default value: n/a)
1209 Set the proxy authentication string. (example: proxy-auth
1210 user:password)
1211 proxy-auth-method (parameters: <method>; default value: any)
1213 Set proxy authentication method. Allowed values: any, basic,
1214 digest, digest_ie (only available with libcurl 7.19.3 and newer),
1215 gssnegotiate, ntlm and anysafe. (example: proxy-auth-method ntlm)
1216 proxy-type (parameters: <type>; default value: http)
1218 Set proxy type. Allowed values: http, socks4, socks4a, socks5 and
1219 socks5h. (example: proxy-type socks5)
1220 refresh-on-startup (parameters: [yes/no]; default value: no)
1222 If set to yes, then all feeds will be reloaded when Newsboat starts
1223 up. This is equivalent to the -r commandline option. See also
1224 auto-reload to additionally reload the feeds continuously.
1225 (example: refresh-on-startup yes)
1226 reload-only-visible-feeds (parameters: [yes/no]; default value: no)
1228 If set to yes, then manually reloading all feeds will only reload
1229 the currently visible feeds, e.g. if a filter or a tag is set.
1230 (example: reload-only-visible-feeds yes)
1231 reload-threads (parameters: <number>; default value: 1)
1233 The number of parallel reload threads that shall be started when
1234 all feeds are reloaded. (example: reload-threads 3)
1235 reload-time (parameters: <number>; default value: 60)
1237 The number of minutes between automatic reloads. (example:
1238 reload-time 120)
1239 reset-unread-on-update (parameters: <url> [<url>...]; default value:
1241 n/a)
1242 Specifies one or more feed URLs for whose articles the unread flag
1243 will be reset if an article has been updated, i.e. its content has
1244 been changed. This is especially useful for RSS feeds where single
1245 articles are updated after publication, and you want to be notified
1246 of the updates. This option can be specified multiple times.
1247 (example: reset-unread-on-update
1248 "https://blog.fefe.de/rss.xml?html")
1249 restrict-filename (parameters: [yes/no]; default value: yes)
1251 If set to no, Newsboat will not limit saved article filenames to
1252 ASCII characters. (example: restrict-filename no)
1253 run-on-startup (parameters: <list of operations>; default value: n/a)
1255 Specifies one or more Newsboat operations, separated by semicolons,
1256 which are executed on Newsboat startup. (example: run-on-startup
1257 next-unread; open; random-unread; open)
1258 save-path (parameters: <path-to-directory>; default value: ~/)
1260 The default path where articles shall be saved to. If an invalid
1261 path is specified, the current directory is used. (example:
1262 save-path "~/Saved Articles")
1263 scrolloff (parameters: <number>; default value: 0)
1265 Keep the configured number of lines above and below the selected
1266 item in lists. Configure a high number to keep the selected item in
1267 the center of the screen. (example: scrolloff 5)
1268 search-highlight-colors (parameters: <fgcolor> <bgcolor> [<attribute>
1270 ...]; default value: black yellow bold)
1271 This configuration command specifies the highlighting colors when
1272 searching for text from the article view. (example:
1273 search-highlight-colors white black bold)
1274 searchresult-title-format (parameters: <format>; default value: "%N %V
1276 - Search results for '%s' (%u unread, %t total)%?F? matching filter
1277 '%F'&?" (localized))
1278 Format of the title in search result. See "Format Strings" section
1279 of Newsboat manual for details on available formats. (example:
1280 searchresult-title-format "Search result")
1281 selectfilter-title-format (parameters: <format>; default value: "%N %V
1283 - Select Filter" (localized))
1284 Format of the title in filter selection dialog. See "Format
1285 Strings" section of Newsboat manual for details on available
1286 formats. (example: selectfilter-title-format "Select Filter")
1287 selecttag-format (parameters: <format>; default value: "%4i %T (%u)")
1289 Format of the lines in "Select tag" dialog. See the respective
1290 section in the documentation for more information on format
1291 strings. (example: selecttag-format "[%2i] %T (%n unread articles
1292 in %f feeds, %u feeds total)")
1293 selecttag-title-format (parameters: <format>; default value: "%N %V -
1295 Select Tag" (localized))
1296 Format of the title in tag selection dialog. See "Format Strings"
1297 section of Newsboat manual for details on available formats.
1298 (example: selecttag-title-format "Select Tag")
1299 show-keymap-hint (parameters: [yes/no]; default value: yes)
1301 If set to no, then the keymap hints will not be displayed. (The
1302 keymap hints are usually at the bottom of the screen, but see
1303 swap-title-and-hints setting.) (example: show-keymap-hint no)
1304 show-read-articles (parameters: [yes/no]; default value: yes)
1306 If set to yes, then all articles of a feed are listed in the
1307 article list. If set to no, then only unread articles are listed.
1308 (example: show-read-articles no)
1309 show-read-feeds (parameters: [yes/no]; default value: yes)
1311 If set to yes, then all feeds, including those without unread
1312 articles, are listed. If set to no, then only feeds with one or
1313 more unread articles are list. (example: show-read-feeds no)
1314 show-title-bar (parameters: [yes/no]; default value: yes)
1316 If set to no, then the title bar will not be displayed. (The title
1317 bar is usually at the top of the screen, but see
1318 swap-title-and-hints setting.) (example: show-title-bar no)
1319 ssl-verifyhost (parameters: [yes/no]; default value: yes)
1321 If set to no, skip verification of the certificate’s name against
1322 host. (example: ssl-verifyhost no)
1323 ssl-verifypeer (parameters: [yes/no]; default value: yes)
1325 If set to no, skip verification of the peer’s SSL certificate.
1326 (example: ssl-verifypeer no)
1327 suppress-first-reload (parameters: [yes/no]; default value: no)
1329 If set to yes, then the first automatic reload will be suppressed
1330 if auto-reload is set to yes. (example: suppress-first-reload yes)
1331 swap-title-and-hints (parameters: [yes/no]; default value: no)
1333 If set to yes, then the title (which is usually at the top of the
1334 screen) and the keymap hints (usually at the bottom) will exchange
1335 places. These bars can be hidden entirely, via the
1336 show-keymap-hints and show-title-bar settings. (example:
1337 swap-title-and-hints yes)
1338 text-width (parameters: <number>; default value: 0)
1340 If set to a number greater than 0, all HTML will be rendered to
1341 this maximum line length or the terminal width (whichever is
1342 smaller). If set to 0, the terminal width will always be used in
1343 the article view, while pipe-to, save, and save-all will wrap at 80
1344 columns instead. Does not apply when using external renderer or
1345 viewing the source. Also note that "Link" header and "Links"
1346 section won’t be affected by it—they contain URLs which are better
1347 not wrapped. (example: text-width 72)
1348 toggleitemread-jumps-to-next-unread (parameters: [yes/no]; default
1350 value: no)
1351 If set to yes, jump to the next unread item when an item’s read
1352 status is toggled in the article list. (example:
1353 toggleitemread-jumps-to-next-unread yes)
1354 ttrss-flag-publish (parameters: <character>; default value: "")
1356 If set and Tiny Tiny RSS support is used, then all articles that
1357 are flagged with the specified flag are being marked as "published"
1358 in Tiny Tiny RSS. (example: ttrss-flag-publish "b")
1359 ttrss-flag-star (parameters: <character>; default value: "")
1361 If set and Tiny Tiny RSS support is used, then all articles that
1362 are flagged with the specified flag are being "starred" in Tiny
1363 Tiny RSS. (example: ttrss-flag-star "a")
1364 ttrss-login (parameters: <username>; default value: "")
1366 Sets the username for use with Tiny Tiny RSS. (example: ttrss-login
1367 "admin")
1368 ttrss-mode (parameters: [multi/single]; default value: multi)
1370 Configures the mode in which Tiny Tiny RSS is used. In single-user
1371 mode, login and password are used for HTTP authentication, while in
1372 multi-user mode, they are used for authenticating with Tiny Tiny
1373 RSS. (example: ttrss-mode "single")
1374 ttrss-password (parameters: <password>; default value: "")
1376 Configures the password for use with Tiny Tiny RSS. Double quotes
1377 and backslashes within it should be escaped. (example:
1378 ttrss-password "here_goesAquote:\"")
1379 ttrss-passwordeval (parameters: <command>; default value: "")
1381 A more secure alternative to the above, is providing your password
1382 from an external command that is evaluated during login. This can
1383 be used to read your password from a gpg encrypted file or your
1384 system keyring. (example: ttrss-passwordeval "gpg --decrypt
1385 ~/.newsboat/ttrss-password.gpg")
1386 ttrss-passwordfile (parameters: <path>; default value: "")
1388 Another alternative, by storing your plaintext password elsewhere
1389 in your system. (example: ttrss-passwordfile
1390 "~/.newsboat/ttrss-pw.txt")
1391 ttrss-url (parameters: <url>; default value: "")
1393 Configures the URL where the Tiny Tiny RSS installation you want to
1394 use resides. (example: ttrss-url "https://example.com/ttrss/")
1395 unbind-key (parameters: <key> [<dialog>]; default value: n/a)
1397 Unbind key <key>. This means that no operation is called when <key>
1398 is pressed. If you provide "-a" as <key>, all currently bound keys
1399 will become unbound. Optionally, you can specify a dialog (for a
1400 list of available dialogs, see bind-key above). If you specify one,
1401 the key binding will only be unbound for the specified dialog.
1402 (example: unbind-key R)
1403 urls-source (parameters: <source>; default value: "local")
1405 This configuration command sets the source where URLs shall be
1406 retrieved from. By default, this is the urls file. Alternatively,
1407 you can set it to opml, which enables Newsboat’s OPML online
1408 subscription mode, to ttrss which enables Newsboat’s Tiny Tiny RSS
1409 support, to oldreader, which enables Newsboat’s The Old Reader
1410 support, to newsblur, which enables NewsBlur support, to feedhq for
1411 FeedHQ support, to freshrss for FreshRSS support, to ocnews for
1412 ownCloud News support, to inoreader for Inoreader support, or to
1413 miniflux for Miniflux support. Query feed specifications will be
1414 read from the local urls file regardless of this setting. (example:
1415 urls-source "oldreader")
1416 urlview-title-format (parameters: <format>; default value: "%N %V -
1418 URLs" (localized))
1419 Format of the title in URL view. See "Format Strings" section of
1420 Newsboat manual for details on available formats. (example:
1421 urlview-title-format "URLs")
1422 use-proxy (parameters: [yes/no]; default value: no)
1424 If set to yes, then the configured proxy will be used for
1425 downloading the RSS feeds. (example: use-proxy yes)
1426 user-agent (parameters: <string>; default value: "")
1428 If set to a non-zero-length string, this value will be used as HTTP
1429 User-Agent header for all HTTP requests. (example: user-agent
1430 "Lynx/2.8.5rel.1 libwww-FM/2.14")
1431 wrap-scroll (parameters: [yes/no]; default value: no)
1433 If set to yes, moving down while on the last item in a list will
1434 wrap around to the top and vice versa. (example: wrap-scroll yes)
1435
1437 open (default key: ENTER)
1438 Open the currently selected feed or article.
1439 quit (default key: Q)
1441 Quit the program or return to the previous dialog (depending on the
1442 context).
1443 hard-quit (default key: Shift + Q)
1445 Quit the program without confirmation.
1446 reload (default key: R)
1448 Reload the currently selected feed.
1449 reload-all (default key: Shift + R)
1451 Reload all feeds.
1452 mark-feed-read (default key: Shift + A)
1454 Mark all articles in the currently selected feed read.
1455 mark-all-feeds-read (default key: Shift + C)
1457 Mark articles in all feeds read.
1458 mark-all-above-as-read (default key: n/a)
1460 Mark all above as read.
1461 save (default key: S)
1463 Export the currently selected article to a plain text file,
1464 word-wrapped according to the text-width setting.
1465 save-all (default key: n/a)
1467 Export all articles from the currently selected feed to plain text
1468 files, word-wrapped according to the text-width setting.
1469 next-unread (default key: N)
1471 Jump to the next unread article.
1472 prev-unread (default key: P)
1474 Jump to the previous unread article.
1475 next (default key: Shift + J)
1477 Jump to next list entry.
1478 prev (default key: Shift + K)
1480 Jump to previous list entry.
1481 random-unread (default key: Ctrl + K)
1483 Jump to a random unread article.
1484 open-in-browser (default key: O)
1486 Use browser to open the URL associated with the current article,
1487 feed, or entry in the URL view.
1488 open-in-browser-noninteractively (default key: n/a)
1490 Use browser to open the URL associated with the current article,
1491 feed, or entry in the URL view. This operation works similar to
1492 open-in-browser, but the output of the browser (stdout and stderr)
1493 is not shown, and the browser doesn’t receive keyboard input. You
1494 would probably add & at the end of the browser command to put it
1495 into background, too.
1496 open-in-browser-and-mark-read (default key: Shift + O)
1498 Use browser to open the URL associated with the current article, or
1499 entry in the URL view. When used in the article list, it will also
1500 mark the article as read.
1501 open-all-unread-in-browser (default key: n/a)
1503 Open all the unread URLs in the current feed.
1504 open-all-unread-in-browser-and-mark-read (default key: n/a)
1506 Open all the unread URLs in the current feed and mark them as read.
1507 help (default key: ?)
1509 Run the help screen.
1510 toggle-source-view (default key: Ctrl + U)
1512 Toggle between the HTML view and the source view in the article
1513 view.
1514 toggle-article-read (default key: Shift + N)
1516 Toggle the read flag for the currently selected article, and clear
1517 the delete flag if set.
1518 toggle-show-read-feeds (default key: L)
1520 Toggle whether read feeds should be shown in the feed list.
1521 show-urls (default key: U)
1523 Show all URLs in the article in a list (similar to urlview).
1524 clear-tag (default key: Ctrl + T)
1526 Clear current tag.
1527 set-tag (default key: T)
1529 Select tag.
1530 open-search (default key: /)
1532 Open the search dialog. When a search is done in the article list,
1533 then the search operation only applies to the articles of the
1534 current feed, otherwise to all articles.
1535 goto-url (default key: #)
1537 Open the URL dialog and then open a specified URL in the browser.
1538 one (default key: 1)
1540 Open URL 1 in the browser.
1541 two (default key: 2)
1543 Open URL 2 in the browser.
1544 three (default key: 3)
1546 Open URL 3 in the browser.
1547 four (default key: 4)
1549 Open URL 4 in the browser.
1550 five (default key: 5)
1552 Open URL 5 in the browser.
1553 six (default key: 6)
1555 Open URL 6 in the browser.
1556 seven (default key: 7)
1558 Open URL 7 in the browser.
1559 eight (default key: 8)
1561 Open URL 8 in the browser.
1562 nine (default key: 9)
1564 Open URL 9 in the browser.
1565 zero (default key: 0)
1567 Open URL 10 in the browser.
1568 enqueue (default key: E)
1570 Add the podcast download URL of the current article (if any is
1571 found) to the podcast download queue (see the respective section in
1572 the documentation for more information on podcast support).
1573 edit-urls (default key: Shift + E)
1575 Edit the list of subscribed URLs. Newsboat will start the editor
1576 configured through the VISUAL environment variable (if unset,
1577 EDITOR is used; fallback: vi). When editing is finished, Newsboat
1578 will reload the URLs file.
1579 reload-urls (default key: Ctrl + R)
1581 Reload the URLs configuration file.
1582 redraw (default key: Ctrl + L)
1584 Redraw the screen.
1585 cmdline (default key: :)
1587 Open the command line.
1588 set-filter (default key: Shift + F)
1590 Set a filter.
1591 select-filter (default key: F)
1593 Select a predefined filter.
1594 clear-filter (default key: Ctrl + F)
1596 Clear currently set filter.
1597 bookmark (default key: Ctrl + B)
1599 Bookmark currently selected article or URL.
1600 edit-flags (default key: Ctrl + E)
1602 Edit the flags of the currently selected article.
1603 next-unread-feed (default key: Ctrl + N)
1605 Go to the next feed with unread articles. This only works from the
1606 article list.
1607 prev-unread-feed (default key: Ctrl + P)
1609 Go to the previous feed with unread articles. This only works from
1610 the article list.
1611 next-feed (default key: J)
1613 Go to the next feed. This only works from the article list.
1614 prev-feed (default key: K)
1616 Go to the previous feed. This only works from the article list.
1617 delete-article (default key: Shift + D)
1619 Delete the currently selected article.
1620 delete-all-articles (default key: Ctrl + D)
1622 Delete all articles in the articlelist. Note that the articlelist
1623 might contain a subset of feed’s articles (because of filters or
1624 show-read-articles no), or it might contain a mix of articles from
1625 different feeds (if you’re viewing a query feed) — in either case,
1626 delete-all-articles affects just those articles, not all articles
1627 of the respective feed(s).
1628 purge-deleted (default key: $)
1630 Purge all articles that are marked as deleted from the article
1631 list.
1632 view-dialogs (default key: V)
1634 View list of open dialogs.
1635 close-dialog (default key: Ctrl + X)
1637 Close currently selected dialog.
1638 next-dialog (default key: Ctrl + V)
1640 Go to next dialog.
1641 prev-dialog (default key: Ctrl + G)
1643 Go to previous dialog.
1644 pipe-to (default key: |)
1646 Pipe article to command. The text will be word-wrapped according to
1647 the text-width setting.
1648 sort (default key: G)
1650 Sort feeds/articles by interactively choosing the sort method.
1651 rev-sort (default key: Shift + G)
1653 Sort feeds/articles by interactively choosing the sort method
1654 (reversed).
1655 up (default key: UP)
1657 Go up one item in the list.
1658 down (default key: DOWN)
1660 Go down one item in the list.
1661 pageup (default key: PPAGE)
1663 Go up one page in the list.
1664 pagedown (default key: NPAGE)
1666 Go down one page in the list.
1667 home (default key: HOME)
1669 Go to the first item in the list.
1670 end (default key: END)
1672 Go to the last item in the list.
1673 macro-prefix (default key: ,)
1675 Initiate macro execution. The next key press selects the actual
1676 macro and runs it.
1677 switch-focus (default key: TAB)
1679 Switch focus between widgets. This is currently only applicable to
1680 the filebrowser and dirbrowser contexts.
1681 goto-title (default key: n/a)
1683 Go to item whose title contains the specified string
1684 (case-insensitive).
1685 prevsearchresults (default key: Z)
1687 Return to previous search results (if any). This only works from
1688 searchresultslist.
1689 article-feed (default key: n/a)
1691 Go to the feed of the currently selected article.
1692
1694 Newsboat comes with the possibility to categorize or "tag", as we call
1695 it, RSS feeds. Every RSS feed can be assigned 0 or more tags. Within
1696 Newsboat, you can then select to only show RSS feeds that match a
1697 certain tag. That makes it easy to categorize your feeds in a flexible
1698 and powerful way.
1699 Usually, the urls file contains one RSS feed URL per line. To assign a
1701 tag to an RSS feed, simply attach it as a single word, separated by
1702 blanks such as space or tab. If the tag needs to contain spaces, you
1703 must use quotes (") around the tag (see example below). An example urls
1704 file may look like this:
1705 https://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
1707 https://rss.orf.at/news.xml news orf
1708 https://www.heise.de/newsticker/heise.rdf news interesting
1709 When you now start Newsboat with this configuration, you can press T to
1711 select a tag. When you select the tag "news", you will see all three
1712 RSS feeds. Pressing T again and e.g. selecting the "conspiracy" tag,
1713 you will only see the https://blog.fefe.de/rss.xml?html RSS feed.
1714 Pressing Ctrl + T clears the current tag, and again shows all RSS
1715 feeds, regardless of their assigned tags.
1716 A special type of tag are tags that start with the tilde character (~).
1718 When such a tag is found, the feed title is set to the tag name
1719 (excluding the ~ character). These type of tags are ignored when any
1720 kind of "first tag" property is used. With this feature, you can give
1721 feeds any title you want in your feed list:
1722 https://rss.orf.at/news.xml "~ORF News"
1724 Another special type of tag are tags that start with the exclamation
1726 mark (!). When such a tag is found, the feed is hidden from the regular
1727 list of feeds and its content can only be found through a query feed.
1728 https://rss.orf.at/news.xml ! news
1730 http://feeds.bbci.co.uk/news/world/rss.xml ! news
1731 "query:News from around the globe:tags # \"news\""
1732 In this example, the first two feeds won’t appear in the feedlist, but
1734 their articles will still be accessible through the query feed titled
1735 "News from around the globe". The "hidden" tags in this example don’t
1736 even have names, because their only use is to hide the feed that
1737 they’re tagging.
1738
1740 Newsboat contains support for Snownews extensions. The RSS feed readers
1741 Snownews and Liferea share a common way of extending the readers with
1742 custom scripts. Two mechanisms, namely "execurl" and "filter" type
1743 scripts, are available and supported by Newsboat.
1744 An "execurl" script can be any program that gets executed and whose
1746 output is interpreted as RSS feed, while "filter" scripts are fed with
1747 the content of a configured URL and whose output is interpreted as RSS
1748 feed.
1749 The configuration is simple and straight-forward. Just add to your urls
1751 file configuration lines like the following ones:
1752 exec:~/bin/execurl-script
1754 filter:~/bin/filter-script:https://some.test/url
1755 The first line shows how to add an execurl script to your
1757 configuration: start the line with exec: and then immediately append
1758 the path of the script that shall be executed. If this script requires
1759 additional parameters, simply use quotes (see Using Double Quotes for
1760 details):
1761 "exec:~/bin/execurl-script param1 param2"
1763 The second line shows how to add a filter script to your configuration:
1765 start the line with filter:, then immediately append the path of the
1766 script, then append a colon (:), and then append the URL of the file
1767 that shall be fed to the script. Again, if the script requires any
1768 parameters, simply quote the whole thing:
1769 "filter:~/bin/filter-script param1 param2:https://url/foobar"
1771 In both cases, the tagging feature as described above is still
1773 available:
1774 exec:~/bin/execurl-script tag1 tag2 "quoted tag"
1776 filter:~/bin/filter-script:https://some.test/url tag3 tag4 tag5
1777 If you need to write your own extension, see this
1779 <https://web.archive.org/web/20090724045314/http://kiza.kcore.de/software/snownews/snowscripts/writing>
1780 short guide" for an introduction. A collection of existing scripts
1781 <https://github.com/msharov/snownews/tree/de3bd8b28191c4d4bc1be18275786613bcbc0c94/docs/untested>
1782 and filters
1783 <https://github.com/msharov/snownews/tree/9fb45e4cdf1cf9dea55b9af66c13a4c238809851/docs/filters>
1784 might help, too.
1785 Newsboat comes with an example exec script which shows one way to
1787 generate an RSS channel. It also includes a way to see which exact
1788 arguments are passed to the script by Newsboat. This example can be
1789 found in the doc/examples subdirectory.
1790
1792 Like other text-oriented software, Newsboat contains an internal
1793 commandline to modify configuration variables ad hoc and to run own
1794 commands. It provides a flexible access to the functionality of
1795 Newsboat which is especially useful for advanced users.
1796 To start the commandline, type :. You will see a ":" prompt at the
1798 bottom of the screen, similar to tools like vi(m) or mutt. You can now
1799 enter commands. Pressing the Enter key executes the command (possibly
1800 giving feedback to the user) and closes the commandline. You can cancel
1801 entering commands by pressing the Esc key. The history of all the
1802 commands that you enter will be saved to the history.cmdline file,
1803 stored next to the cache.db file. The backlog is limited to 100 entries
1804 by default, but can be influenced by setting the history-limit
1805 configuration variable. To disable history saving, set the
1806 history-limit to 0.
1807 The commandline provides you with some help if you can’t remember the
1809 full names of commandline commands. By pressing the Tab key, Newsboat
1810 will try to automatically complete your command. If there is more than
1811 one possible completion, you can subsequently press the Tab key to
1812 cycle through all results. If no match is found, no suggestion will be
1813 inserted into the commandline. For the set command, the completion also
1814 works for configuration variable names.
1815 In addition, some common key combination such as Ctrl + G (to cancel
1817 input), Ctrl + K (to delete text from the cursor position to the end of
1818 line), Ctrl + U (to clear the whole line) and Ctrl + W (to delete the
1819 word before the current cursor position) were added.
1820 Please be aware that the input history of both the command line and the
1822 search functions are saved to the filesystems, to the files
1823 history.cmdline resp. history.search (stored next to the cache.db
1824 file). By default, the last 100 entries are saved, but this can be
1825 configured (configuration variable history-limit) and also totally
1826 disabled (by setting said variable to 0).
1827 Currently, the following command line commands are available:
1829 quit
1831 Quit Newsboat
1832 q
1834 Alias for quit
1835 save <filename>
1837 Save current article to <filename>
1838 set <variable>[=<value>|&|!]
1840 Set (or get) configuration variable value. Specifying a ! after the
1841 name of a boolean configuration variable toggles their values, a &
1842 directly after the name of a configuration variable of any type
1843 resets its value to the documented default value.
1844 tag <tagname>
1846 Select a certain tag
1847 goto <case-insensitive substring>
1849 Go to the next feed whose name contains the case-insensitive
1850 substring.
1851 source <filename> [...]
1853 Load the specified configuration files. This allows it to load
1854 alternative configuration files or reload already loaded
1855 configuration files on-the-fly from the filesystem.
1856 dumpconfig <filename>
1858 Save current internal state of configuration to file, so that it
1859 can be instantly reused as configuration file.
1860 <number>
1862 Jump to the <number>th entry in the current dialog
1863
1865 By default, Newsboat stores all the files in a traditional Unix
1866 fashion, i.e. in a "dotdir" located at ~/.newsboat. However, it also
1867 supports a modern way, XDG Base Directory Specification
1868 <https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>,
1869 which splits the files between the following locations:
1870 1. $XDG_CONFIG_HOME/newsboat/ (XDG_CONFIG_HOME defaults to ~/.config)
1872 2. $XDG_DATA_HOME/newsboat/ (XDG_DATA_HOME defaults to ~/.local/share)
1874 If the newsboat directory exists under XDG_CONFIG_HOME, then Newsboat
1876 will use XDG directories (creating the data directory if necessary).
1877 Otherwise, Newsboat will default to ~/.newsboat.
1878 If you’re currently using ~/.newsboat/ but wish to migrate to XDG
1880 directories, you should move the files as follows:
1881 config, urls
1883 to $XDG_CONFIG_HOME/newsboat/
1884 cache.db, history.search, history.cmdline, queue
1886 to $XDG_DATA_HOME/newsboat/
1887 Newsboat and Podboat also create "lock files". These prevent you from
1889 starting two instances of the same program, and thus from corrupting
1890 your data. Newsboat and Podboat remove these files when you quit the
1891 program, so there is no need to copy them anywhere — just be aware of
1892 them in case you write scripts that work with cache.db or queue. By
1893 default, lock files are located as follows:
1894 ┌─────────┬───────────────────────────┬───────────────────────────────────────┐
1896 │ │ │ │
1897 │ │ dotdir │ XDG │
1898 ├─────────┼───────────────────────────┼───────────────────────────────────────┤
1899 │ │ │ │
1900 │Newsboat │ ~/.newsboat/cache.db.lock │ $XDG_DATA_HOME/newsboat/cache.db.lock │
1901 ├─────────┼───────────────────────────┼───────────────────────────────────────┤
1902 │ │ │ │
1903 │Podboat │ ~/.newsboat/pb-lock.pid │ $XDG_DATA_HOME/newsboat/.lock │
1904 └─────────┴───────────────────────────┴───────────────────────────────────────┘
1905 Newsboat places the lock file next to the cache file, so if you specify
1907 cache-file setting or pass —cache-file command-line argument, the path
1908 to the lock file will change too. Podboat, on the other hand, always
1909 places its lock file as shown above.
1910 dotfiles
1912 ~/.newsboat/config
1913 ~/.newsboat/urls
1915 XDG
1917 $XDG_CONFIG_HOME/newsboat/config
1918 $XDG_CONFIG_HOME/newsboat/urls
1920 Note: if the XDG_CONFIG_HOME environment variable is not set,
1922 Newsboat behaves as if it was set to ~/.config.
1923
1925 BROWSER
1926 Tells Newsboat what browser to use if there is no browser setting
1927 in the config file. If this variable doesn’t exist, a default of
1928 lynx(1) will be used.
1929 CURL_CA_BUNDLE
1931 Tells Newsboat to use the specified certificate file to verify the
1932 peer. The file may contain multiple certificates. The
1933 certificate(s) must be in PEM format.
1934 This option is useful if your libcurl is built without useful
1936 certificate information, and you can’t rebuild the library
1937 yourself.
1938 EDITOR
1940 Tells Newsboat what fallback editor to use when editing the urls
1941 file via the edit-urls operation and no VISUAL environment variable
1942 is set. If this variable doesn’t exist either, a default of vi(1)
1943 will be used.
1944 NO_PROXY
1946 Tells Newsboat to ignore proxy setting for certain sites.
1947 This variable contains a comma-separated list of hostnames, domain
1949 names, and IP addresses.
1950 Domain names match subdomains, i.e. "example.com" also matches
1952 "foo.example.com". Domain names that start with a dot only match
1953 subdomains, e.g. ".example.com" matches "bar.example.com" but not
1954 "example.com" itself.
1955 IPv6 addresses are written without square brackets, and are matched
1957 as strings. Thus "::1" doesn’t match "::0:1" even though this is
1958 the same address.
1959 PAGER
1961 Tells Newsboat what pager to use if the pager setting in the config
1962 file is explicitly set to an empty string.
1963 TMPDIR
1965 Tells Newsboat to use the specified directory for storing temporary
1966 files. If this variable doesn’t exist, a default of /tmp will be
1967 used.
1968 VISUAL
1970 Tells Newsboat what editor to use when editing the urls file via
1971 the edit-urls operation. If this variable doesn’t exist, the EDITOR
1972 environment variable will be used.
1973 XDG_CONFIG_HOME
1975 Tells Newsboat which base directory to use for the configuration
1976 files. See also the section on files for more information.
1977 XDG_DATA_HOME
1979 Tells Newsboat which base directory to use for the data files. See
1980 also the section on files for more information.
1981
1983 podboat(1)
1984
1986 Alexander Batischev
1987 2023-01-04 NEWSBOAT(1)