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. This currently outputs OPML 1.0,
28 losing all tag information, but this is subject to change to 2.0 in
29 the future.
30 --export-to-opml2
32 Export feeds as OPML 2.0, including tags, to stdout
33 -X, --vacuum
35 Compact the cache by: 1) reclaiming the space that was left empty
36 when data was deleted; and 2) defragmenting the entries in the
37 cache. This doesn’t delete the entries; for that, see
38 cleanup-on-quit, delete-read-articles-on-quit, keep-articles-days,
39 and max-items settings.
40 --cleanup
42 Remove unreferenced entries from the cache and quit Newsboat. Feeds
43 and their articles will be removed if the feedurl is no longer in
44 the urls file.
45 Additionally, if the delete-read-articles-on-quit configuration is
47 set, all read articles will be deleted (including articles of feeds
48 which are still in the urls file).
49 -v, -V, --version
51 Get version information about Newsboat and the libraries it uses
52 -i opmlfile, --import-from-opml=opmlfile
54 Import an OPML file
55 -u urlfile, --url-file=urlfile
57 Use an alternative URL file
58 -c cachefile, --cache-file=cachefile
60 Use an alternative cache file
61 -C configfile, --config-file=configfile
63 Use an alternative configuration file
64 -x command ..., --execute=command...
66 Execute one or more commands to run Newsboat unattended. Currently
67 available commands are reload and print-unread.
68 -l loglevel, --log-level=loglevel
70 Generate a logfile with a certain loglevel. Valid loglevels are 1
71 to 6. An actual logfile will only be written when you provide a
72 logfile name.
73 -d logfile, --log-file=logfile
75 Use this logfile as output when logging debug messages. Please note
76 that this only works when providing a loglevel.
77 -E file, --export-to-file=file
79 Export a list of read articles (resp. their GUIDs). This can be
80 used to transfer information about read articles between different
81 computers.
82 -I file, --import-from-file=file
84 Import a list of read articles and mark them as read if they are
85 held in the cache. This is to be used in conjunction with the -E
86 commandline parameter.
87
89 After you’ve installed Newsboat, you can run it for the first time by
90 typing newsboat on your command prompt. This will bring you the
91 following message:
92 Error: no URLs configured. Please fill the file /home/ak/.newsboat/urls with RSS feed URLs or import an OPML file.
94 Newsboat 2.22
96 usage: ./newsboat [-i <file>|-e] [-u <urlfile>] [-c <cachefile>] [-x <command> ...] [-h]
97 -e, --export-to-opml export OPML feed to stdout
98 -r, --refresh-on-start refresh feeds on start
99 -i, --import-from-opml=<file> import OPML file
100 -u, --url-file=<urlfile> read RSS feed URLs from <urlfile>
101 -c, --cache-file=<cachefile> use <cachefile> as cache file
102 -C, --config-file=<configfile> read configuration from <configfile>
103 -X, --vacuum compact the cache
104 -x, --execute=<command>... execute list of commands
105 -q, --quiet quiet startup
106 -v, --version get version information
107 -l, --log-level=<loglevel> write a log with a certain loglevel (valid values: 1 to 6)
108 -d, --log-file=<logfile> use <logfile> as output log file
109 -E, --export-to-file=<file> export list of read articles to <file>
110 -I, --import-from-file=<file> import list of read articles from <file>
111 -h, --help this help
112 --cleanup remove unreferenced items from cache
113 This means that Newsboat can’t start without any configured feeds.
115 Adding Feeds
117 To add feeds to Newsboat, you can simply add one feed URL per line to
118 the ~/.newsboat/urls configuration file:
119 http://rss.cnn.com/rss/cnn_topstories.rss
121 http://newsrss.bbc.co.uk/rss/newsonline_world_edition/front_page/rss.xml
122 You can also import an OPML file by running newsboat -i blogroll.opml
124 Adding comments Lines that start with # can contain anything you
127 want. Comments are ignored by Newsboat, but can serve as
128 documentation for you. Please note, that commenting out URLs for
129 debugging purposes might lead to unexpected data loss, see
130 cleanup-on-quit for more details.
131 Feeds with restricted access
133 If you need to add URLs that have restricted access, simply provide
135 username/password:
136 https://username:password@hostname.domain.tld/feed.rss
138 In case there is a @ in the username, you need to write it as %40.
140 In order to protect usernames and passwords, make sure to restrict read
142 access for ~/.newsboat/urls to you and optionally your group:
143 $ chmod u=rw,g=r,o= ~/.newsboat/urls
145 Newsboat makes sure to not display usernames and passwords in its user
147 interface.
148 Local files as feeds
150 You can also configure local files as feeds, by prefixing the local
152 path with file:// and adding it to the urls file:
153 file:///var/log/rss_eventlog.xml
155 First UI Interaction
157 The main UI of Newsboat consists of three views
158 Feed List View → Article List View → Article View
160 You can drill down those views by pressing Enter and move to the
162 previous one by pressing Q. Pressing Q on the Feed List View — or
163 pressing Shift + Q from anywhere — closes Newsboat.
164 You can also search articles' title or content by pressing / on the
166 Feed List View or the Article List View. On the Feed List View all
167 articles of all feeds are taken into account. On the Article List View
168 the articles of the current feed are taken into account. When opening
169 an article from a search result dialog, the search phrase is
170 highlighted.
171 Search history The history of all your searches is saved to the
174 filesystem, to the history.search file (stored next to the cache.db
175 file). By default, the last 100 search phrases are stored.
176 You can influence how many search phrases are stored by configuring
178 history-limit.
179 Feed List View
181 When you start Newsboat, it presents you with a list of feeds that you
183 added previously.
184 You can now:
186 • Press Shift + R to download articles for all feeds.
188 • Press R to download articles for the selected feed.
190 • Press / to search all articles in all feeds.
192 • Press Enter to go to the article list of a selected feed.
194 • Press Q to close Newsboat.
196 Local articles Newsboat keeps the articles that it downloads. When
199 you start Newsboat again and reload a feed, old articles can still
200 be read even if they aren’t in the current RSS feeds anymore.
201 You can configure how many articles are kept per feed so that the
203 article backlog doesn’t grow endlessly by configuring max-items.
204 Caching Newsboat uses a number of measures to preserve the users'
207 and feed providers' bandwidth through the use of conditional HTTP
208 downloading. It saves every feed’s "Last-Modified" and "ETag"
209 response header values (if present) and advises the feed’s HTTP
210 server to only send data if the feed has been updated. This doesn’t
211 only make feed downloads for RSS feeds with no new updates faster,
212 it also reduces the amount of transferred data per request.
213 You can disable conditional HTTP downloading per feed by
215 configuring always-download.
216 Article List View
218 After you entered a feed, you can see the list of available articles by
220 their title. A N on the left indicates that an article wasn’t read yet.
221 You can now:
223 • Press Q to go back to the Feed List View.
225 • Press / to search all articles of this feed.
227 • Press Enter to read a selected article.
229 Article View
231 On an article you can scroll through the text and read it. Each link in
233 the article has a number next to it.
234 You can now:
236 • Press any number to open an article link in the browser. For
238 numbers larger than 9 type #, then the number and press Enter.
239 • Press O to open the article in the browser.
241 • Press Q to go back to the Article List View.
243 Browser view Sometimes the content of an article is empty or just
246 an abstract or short description. You can always press O to view
247 the complete article in a browser. The default browser is lynx.
248 You can use your browser of choice by configuring browser.
250
252 Several aspects of Newsboat can be configured via a config file, which
253 is stored next to the urls file. A configuration line looks like this
254 in general:
255 <config-command> <arg1> ...
257 The configuration file can contain comments, which start with the #
259 character and go as far as the end of line.
260 User contrib Newsboat also comes with user contributed content like
263 scripts and color themes. The user contributed content can be found
264 in /usr/share/doc/newsboat/contrib/. End users are encouraged to
265 take a look as they may find something useful.
266 Example
268 An example configuration looks like this
269 # a comment
271 max-items 100 # such comments are possible, too
272 browser links
273 show-read-feeds no
274 unbind-key R
276 bind-key ^R reload-all
277 Splitting long lines into multiple ones
279 Configuration items, such as macros defined in config files which are
280 long can be split up into multiple ones using backslashes; these must
281 be the last character on the line and will immediately concatenate it
282 with the following line. It’s important that nothing follows the \ on
283 the same line, otherwise the \ character is treated "as is".
284 Dummy example:
286 macro p open; \
288 reload; quit; \
289 quit; \
290 quit -- "Opens, reloads then makes sure to quit newsboat"
291 Using Double Quotes
293 TL;DR Use double quotes for strings that contain spaces or double
294 quotes. Escape double quotes (use \") and backslashes (use \\).
295 Don’t escape stuff outside of double quotes, and don’t use single
296 quotes for quoting — Newsboat doesn’t support that.
297 Many of Newsboat’s options expect strings as arguments, be it commands,
299 passwords, dialog titles, URLs etc. Some options even take multiple
300 strings at once. These strings can contain spaces, which might confuse
301 Newsboat since it already uses spaces to separate option names from
302 option arguments.
303 To help Newsboat understand your intent, put such strings into double
305 quotes:
306 browser "firefox --new-tab %u"
308 What if you need a double quote inside a string? Escape it with a
310 backslash:
311 ocnews-password "UnbalancedQuotes\"AreSoFun!"
313 And what about the backslash itself? Escape it, too! Suppose you have a
315 program called my favourite pager, and you want to view articles with
316 it. Newsboat ultimately passes commands to the shell, and shell expects
317 spaces to be escaped if you want them preserved. But since Newsboat
318 interprets backslashes, you have to add another layer of escaping.
319 Thus, you end up with a command like this:
320 pager "/usr/bin/my\\ favourite\\ pager"
322 Shell Evaluation
324 It is also possible to integrate the output of external commands into
325 the configuration. The text between two ` backticks is evaluated as
326 shell command, and its output is used. This works like backtick
327 evaluation in Bourne-compatible shells and allows users to use external
328 information from the system within the configuration.
329 Escaping
331 Backticks and # characters can be escaped with a backslash (e.g. \` and
332 \#). In this case, they are replaced with literal ` or # in the
333 configuration.
334 Key Bindings
336 You can bind a key to an operation with the bind-key configuration
337 command. You can specify an optional dialog. This is the context in
338 which the key binding is active.
339 The syntax for a key binding looks like this:
341 bind-key <key> <operation> [<dialog>]
343 Key
345 Lowercase keys, uppercase keys and special characters are written
347 literally.
348 Key combinations with Ctrl are written using the caret ^. For instance
350 Ctrl + R equals to ^R. Please be aware that all Ctrl-related key
351 combinations need to be written in uppercase.
352 The following identifiers for special keys are supported:
354 • ENTER (Enter key)
356 • BACKSPACE (backspace key)
358 • LEFT (left cursor)
360 • RIGHT (right cursor)
362 • UP (up cursor)
364 • DOWN (down cursor)
366 • PPAGE (page up cursor)
368 • NPAGE (page down cursor)
370 • HOME (cursor to beginning of list/article)
372 • END (cursor to end of list/article)
374 • ESC (Esc key)
376 • TAB (Tab key)
378 • F1 to F12 (F1 key to F12 key)
380 Operation
382 An operation gets executed when pressing the corresponding key. For a
384 complete list of available operations see [_newsboat_operations] and
385 [_podboat_operations].
386 Dialog
388 A dialog is a context in which the key binding is active. Available
390 dialogs are:
391 • all (default if not specified)
393 • feedlist
395 • filebrowser
397 • help
399 • articlelist
401 • article
403 • tagselection
405 • filterselection
407 • urlview
409 • podboat
411 • dirbrowser
413 • searchresultslist
415 Colors
417 It is possible to configure custom color settings in Newsboat. The
418 basic configuration syntax is:
419 color <element> <foreground color> <background color> [<attribute> ...]
421 This means that if you configure colors for a certain element, you need
423 to provide a foreground color and a background color as a minimum. The
424 following colors are supported:
425 • black
427 • red
429 • green
431 • yellow
433 • blue
435 • magenta
437 • cyan
439 • white
441 • default
443 • color<n>, e.g. color123
445 The default color means that the terminal’s default color will be used.
447 The color<n> color name (where <n> is a decimal number not starting
448 with zero) can be used if your terminal supports 256 colors (e.g.
449 gnome-terminal, or xterm with TERM set to xterm-256color). Newsboat
450 contains support for 256 color terminals since version 2.1. For a
451 complete chart of colors and their corresponding numbers, please see
452 https://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html.
453 Optionally, you can also add one or more attributes. The following
455 attributes are supported:
456 • standout
458 • underline
460 • reverse
462 • blink
464 • dim
466 • bold
468 • protect
470 • invis
472 Currently, the following elements are supported:
474 • background: the application background
476 • listnormal: a normal list item
478 • listfocus: the currently selected list item
480 • listnormal_unread: an unread list item
482 • listfocus_unread: the currently selected unread list item
484 • title (added in 2.25): current dialog’s title, which is usually at
486 the top of the screen (but see show-title-bar and
487 swap-title-and-hints). If you don’t specify a style for this
488 element, then the info style is used
489 • info: the hints bar, which is usually at the bottom of the screen
491 (but see show-keymap-hint and swap-title-and-hints)
492 • hint-key (added in 2.25): a key in the hints bar. If you don’t
494 specify a style for this element, then the info style is used
495 • hint-keys-delimiter (added in 2.25): the comma that separates keys
497 in the hints bar. If you don’t specify a style for this element,
498 then the info style is used
499 • hint-separator (added in 2.25): the colon separating keys from
501 their descriptions in the hints bar. If you don’t specify a style
502 for this element, then the info style is used
503 • hint-description (added in 2.25): a description of a key in the
505 hints bar. If you don’t specify a style for this element, then the
506 info style is used
507 • article: the article text
509 • end-of-text-marker: filler lines (~) below blocks of text
511 The default color configuration of Newsboat looks like this:
513 color background white black
515 color listnormal white black
516 color listfocus yellow blue bold
517 color listnormal_unread magenta black
518 color listfocus_unread magenta blue bold
519 color title yellow blue bold
520 color info yellow blue bold
521 color hint-key yellow blue bold
522 color hint-keys-delimiter yellow white
523 color hint-separator yellow white bold
524 color hint-description yellow white
525 color article white black
526
528 always-display-description (parameters: [yes/no]; default value: no)
529 If set to yes, then the description will always be displayed even
530 if e.g. a <content:encoded> tag has been found. (example:
531 always-display-description yes)
532 always-download (parameters: <url> [<url>...]; default value: n/a)
534 Specifies one or more feed URLs that should always be downloaded,
535 regardless of their Last-Modified timestamp and ETag header. This
536 option can be specified multiple times. (example: always-download
537 "https://www.n-tv.de/23.rss")
538 article-sort-order (parameters: <sortfield>[-<direction>]; default
540 value: date-asc)
541 The <sortfield> specifies which article property shall be used for
542 sorting. Currently available are: date, title, flags, author, link,
543 guid, and random. The optional <direction> can be either asc for
544 ascending order, or desc for descending order. Note that direction
545 does not affect the random sorting. For date, desc order is the
546 default, i.e. date is the same as date-desc; for all others, asc is
547 the default. Also, the directions for date are reversed: desc means
548 the newest items are first, whereas asc means the oldest items are
549 first. These inconsistencies will be fixed in a future major
550 version of Newsboat. (example: article-sort-order author-desc)
551 articlelist-format (parameters: <format>; default value: "%4i %f %D %6L
553 %?T?|%-17T| ?%t")
554 This variable defines the format of entries in the article list.
555 See the respective section in the documentation for more
556 information on format strings. (example: articlelist-format "%4i %f
557 %D %?T?|%-17T| ?%t")
558 articlelist-title-format (parameters: <format>; default value: "%N %V -
560 Articles in feed '%T' (%u unread, %t total)%?F? matching filter '%F'&?
561 - %U" (localized))
562 Format of the title in article list. See "Format Strings" section
563 of Newsboat manual for details on available formats. (example:
564 articlelist-title-format "Articles in feed '%T' (%u unread)")
565 auto-reload (parameters: [yes/no]; default value: no)
567 If set to yes, all feeds will be automatically reloaded at start up
568 and then continuously after a certain time has passed (see
569 reload-time). See also refresh-on-startup to only reload the feeds
570 at start up, but not continuously. Enabling suppress-first-reload
571 omits the reload on start up. (example: auto-reload yes)
572 bind-key (parameters: <key> <operation> [<dialog>]; default value: n/a)
574 Bind key <key> to <operation>. This means that whenever <key> is
575 pressed, then <operation> is executed (if applicable in the current
576 dialog). For more information see Key Bindings. See also unbind-key
577 to remove a key binding. (example: bind-key ^R reload-all)
578 bookmark-autopilot (parameters: [yes/no]; default value: no)
580 If set to yes, the configured bookmark command is executed without
581 any further input asked from user, unless the url or the title
582 cannot be found/guessed. (example: bookmark-autopilot yes)
583 bookmark-cmd (parameters: <command>; default value: "")
585 If set, then <command> will be used as bookmarking plugin. See the
586 documentation on bookmarking for further information. (example:
587 bookmark-cmd "~/bin/delicious-bookmark.sh")
588 bookmark-interactive (parameters: [yes/no]; default value: no)
590 If set to yes, then the configured bookmark command is an
591 interactive program. (example: bookmark-interactive yes)
592 browser (parameters: <command>; default value: %BROWSER, otherwise
594 lynx)
595 Set the browser command to use when opening an article in the
596 browser. If the BROWSER environment variable is set, it will be
597 used as the default browser, otherwise lynx will be used. For more
598 information, see Using Browser. (example: browser "w3m %u")
599 cache-file (parameters: <path>; default value: "~/.newsboat/cache.db"
601 or "~/.local/share/cache.db" (see "Files" section))
602 This configuration option sets the cache file. This is especially
603 useful if the filesystem of your home directory doesn’t support
604 proper locking (e.g. NFS). (example: cache-file
605 "/tmp/testcache.db")
606 cleanup-on-quit (parameters: [yes/no]; default value: yes)
608 If set to yes, then the cache gets locked and superfluous feeds and
609 items are removed, such as feeds that can’t be found in the urls
610 configuration file anymore. Run newsboat --cleanup to do this
611 manually. If you encounter a warning about unreachable feeds having
612 been found, you may see the feed urls listed by creating a log file
613 via the error-log option. (example: cleanup-on-quit no)
614 color (parameters: <element> <fgcolor> <bgcolor> [<attribute> ...];
616 default value: n/a)
617 Set the foreground color, background color and optional attributes
618 for a certain element. (example: color background white black)
619 confirm-delete-all-articles (parameters: [yes/no]; default value: yes)
621 If set to yes, then Newsboat will ask for confirmation whether the
622 user wants to delete all articles. (example:
623 confirm-delete-all-articles no)
624 confirm-exit (parameters: [yes/no]; default value: no)
626 If set to yes, then Newsboat will ask for confirmation whether the
627 user really wants to quit Newsboat. (example: confirm-exit yes)
628 confirm-mark-all-feeds-read (parameters: [yes/no]; default value: yes)
630 If set to yes, then Newsboat will ask for confirmation whether the
631 user wants to mark all feeds as read. (example:
632 confirm-mark-all-feeds-read no)
633 confirm-mark-feed-read (parameters: [yes/no]; default value: yes)
635 If set to yes, then Newsboat will ask for confirmation on whether
636 the user wants to mark a feed as read. (example:
637 confirm-mark-feed-read no)
638 cookie-cache (parameters: <path>; default value: "")
640 Set a cookie cache. If set, cookies will be cached in (i.e. read
641 from and written to) this file, using Netscape format
642 <http://www.cookiecentral.com/faq/#3.5>. (example: cookie-cache
643 "~/.newsboat/cookies.txt")
644 datetime-format (parameters: <date/time format>; default value: %b %d)
646 This format specifies the date/time format in the article list. For
647 a detailed documentation on most of the allowed formats, consult
648 the manpage of strftime(3). %L is a custom format not available in
649 strftime which lists the days since the article was published (e.g.
650 "2 days ago"). (example: datetime-format "%D, %R")
651 define-filter (parameters: <name> <filterexpr>; default value: n/a)
653 With this command, you can predefine filters, which you can later
654 select from a list, and which are then applied after selection.
655 This is especially useful for filters that you need often and you
656 don’t want to enter them every time you need them. (example:
657 define-filter "all feeds with 'fun' tag" "tags # \"fun\"")
658 delete-read-articles-on-quit (parameters: [yes/no]; default value: no)
660 If set to yes, all read articles will be deleted when quiting
661 Newsboat. This option only applies if cleanup-on-quit is set to yes
662 or if the —cleanup argument is passed. (example:
663 delete-read-articles-on-quit yes)
664 dialogs-title-format (parameters: <format>; default value: "%N %V -
666 Dialogs" (localized))
667 Format of the title in dialog list. See "Format Strings" section of
668 Newsboat manual for details on available formats. (example:
669 dialogs-title-format "%N %V - Dialogs")
670 dirbrowser-title-format (parameters: <format>; default value: "%N %V -
672 %?O?Open Directory&Save File? - %f" (localized))
673 Format of the title in directory browser. See "Format Strings"
674 section of Newsboat manual for details on available formats.
675 (example: dirbrowser-file-format "%?O?Open Directory&Save File? -
676 %f")
677 display-article-progress (parameters: [yes/no]; default value: yes)
679 If set to yes, then a read progress (in percent) is displayed in
680 the article view. Otherwise, no read progress is displayed.
681 (example: display-article-progress no)
682 download-full-page (parameters: [yes/no]; default value: no)
684 If set to yes, then for all feed items with no content but with a
685 link, the link is downloaded and the result used as content
686 instead. This may significantly increase the download times of
687 "empty" feeds. (example: download-full-page yes)
688 download-retries (parameters: <number>; default value: 1)
690 How many times Newsboat shall try to successfully download a feed
691 before giving up. This is an option to improve the success of
692 downloads on slow and shaky connections such as via a TOR proxy.
693 (example: download-retries 4)
694 download-timeout (parameters: <number>; default value: 30)
696 The number of seconds Newsboat shall wait when downloading a feed
697 before giving up. This is an option to improve the success of
698 downloads on slow and shaky connections such as via a TOR proxy.
699 (example: download-timeout 60)
700 error-log (parameters: <path>; default value: "")
702 If set, then user errors (e.g. errors regarding defunct RSS feeds)
703 will be logged to this file. (example: error-log
704 "~/.newsboat/error.log")
705 external-url-viewer (parameters: <command>; default value: "")
707 If set, then show-urls will pipe the current article to a specific
708 external tool instead of using the internal URL viewer. This can be
709 used to integrate tools such as urlview. (example:
710 external-url-viewer "urlview")
711 feed-sort-order (parameters: <sortfield>[-<direction>]; default value:
713 none)
714 The <sortfield> specifies which feed property shall be used for
715 sorting; currently available are: firsttag, title, articlecount,
716 unreadarticlecount, lastupdated and none. The optional <direction>
717 specifies the sort direction. asc specifies ascending sorting, desc
718 specifies descending sorting. desc is the default. (example:
719 feed-sort-order firsttag)
720 feedhq-flag-share (parameters: <flag>; default value: "")
722 If set and FeedHQ support is used, then all articles that are
723 flagged with the specified flag are being "shared" in FeedHQ so
724 that people that follow you can see it. (example: feedhq-flag-share
725 "a")
726 feedhq-flag-star (parameters: <flag>; default value: "")
728 If set and FeedHQ support is used, then all articles that are
729 flagged with the specified flag are being "starred" in FeedHQ and
730 appear in the list of "Starred items". (example: feedhq-flag-star
731 "b")
732 feedhq-login (parameters: <login>; default value: "")
734 This variable sets your FeedHQ login for FeedHQ support. (example:
735 feedhq-login "your-login")
736 feedhq-min-items (parameters: <number>; default value: 20)
738 This variable sets the number of articles that are loaded from
739 FeedHQ per feed. (example: feedhq-min-items 100)
740 feedhq-password (parameters: <password>; default value: "")
742 This variable sets your FeedHQ password for FeedHQ support. Double
743 quotes and backslashes within it should be escaped. (example:
744 feedhq-password "here_goesAquote:\"")
745 feedhq-passwordeval (parameters: <command>; default value: "")
747 A more secure alternative to the above, is providing your password
748 from an external command that is evaluated during login. This can
749 be used to read your password from a gpg encrypted file or your
750 system keyring. (example: feedhq-passwordeval "gpg --decrypt
751 ~/.newsboat/feedhq-password.gpg")
752 feedhq-passwordfile (parameters: <path>; default value: "")
754 Another alternative, by storing your plaintext password elsewhere
755 in your system. (example: feedhq-passwordfile
756 "~/.newsboat/feedhq-pw.txt")
757 feedhq-show-special-feeds (parameters: [yes/no]; default value: yes)
759 If set and FeedHQ support is used, then "special feeds" like
760 "People you follow" (articles shared by people you follow),
761 "Starred items" (your starred articles) and "Shared items" (your
762 shared articles) appear in your subscription list. (example:
763 feedhq-show-special-feeds "no")
764 feedhq-url (parameters: <url>; default value: "https://feedhq.org/")
766 Configures the URL where your FeedHQ instance resides. (example:
767 feedhq-url "https://feedhq.example.com/")
768 feedlist-format (parameters: <format>; default value: "%4i %n %11u %t")
770 This variable defines the format of entries in the feed list. See
771 the respective section in the documentation for more information on
772 format strings. (example: feedlist-format " %n %4i - %11u -%> %t")
773 feedlist-title-format (parameters: <format>; default value: "%N %V -
775 %?F?Feeds&Your feeds? (%u unread, %t total)%?F? matching filter
776 '%F'&?%?T? - tag '%T'&?" (localized))
777 Format of the title in feed list. See "Format Strings" section of
778 Newsboat manual for details on available formats. (example:
779 feedlist-title-format "Feeds (%u unread, %t total)")
780 filebrowser-title-format (parameters: <format>; default value: "%N %V -
782 %?O?Open File&Save File? - %f" (localized))
783 Format of the title in file browser. See "Format Strings" section
784 of Newsboat manual for details on available formats. (example:
785 filebrowser-title-format "%?O?Open File&Save File? - %f")
786 freshrss-flag-star (parameters: <flag>; default value: "")
788 If set and FreshRSS support is used, then all articles that are
789 flagged with the specified flag are being "starred" in FreshRSS and
790 appear in the list of "Starred items". (example: freshrss-flag-star
791 "b")
792 freshrss-login (parameters: <login>; default value: "")
794 This variable sets your FreshRSS login for FreshRSS support.
795 (example: freshrss-login "your-login")
796 freshrss-min-items (parameters: <number>; default value: 20)
798 This variable sets the number of articles that are loaded from
799 FreshRSS per feed. (example: freshrss-min-items 100)
800 freshrss-password (parameters: <password>; default value: "")
802 This variable sets your FreshRSS password for FreshRSS support.
803 Double quotes and backslashes within it should be escaped.
804 (example: freshrss-password "here_goesAquote:\"")
805 freshrss-passwordeval (parameters: <command>; default value: "")
807 A more secure alternative to the above, is providing your password
808 from an external command that is evaluated during login. This can
809 be used to read your password from a gpg encrypted file or your
810 system keyring. (example: freshrss-passwordeval "gpg --decrypt
811 ~/.newsboat/freshrss-password.gpg")
812 freshrss-passwordfile (parameters: <path>; default value: "")
814 Another alternative, by storing your plaintext password elsewhere
815 in your system. (example: freshrss-passwordfile
816 "~/.newsboat/freshrss-pw.txt")
817 freshrss-show-special-feeds (parameters: [yes/no]; default value: yes)
819 If set and FreshRSS support is used, then a "Starred items" feed
820 (containing your starred/favourited articles) appears in your
821 subscription list. (example: freshrss-show-special-feeds "no")
822 freshrss-url (parameters: <url>; default value: "")
824 Configures the URL for the Google Reader API endpoint of your
825 FreshRSS instance. (example: freshrss-url
826 "https://freshrss.example.com/api/greader.php")
827 goto-first-unread (parameters: [yes/no]; default value: yes)
829 If set to yes, then the first unread article will be selected
830 whenever a feed is entered. (example: goto-first-unread no)
831 goto-next-feed (parameters: [yes/no]; default value: yes)
833 If set to yes, then the next-unread, prev-unread and random-unread
834 keys will search in other feeds for unread articles if all articles
835 in the current feed are read. If set to no, then these keys will
836 stop in the current feed. (example: goto-next-feed no)
837 help-title-format (parameters: <format>; default value: "%N %V - Help"
839 (localized))
840 Format of the title in help window. See "Format Strings" section of
841 Newsboat manual for details on available formats. (example:
842 help-title-format "%N %V - Help")
843 highlight (parameters: <target> <regex> <fgcolor> [<bgcolor>
845 [<attribute> ...]]; default value: n/a)
846 With this command, you can highlight text parts in the feed list,
847 the article list and the article view. (example: highlight all
848 "newsboat" red)
849 highlight-article (parameters: <filterexpr> <fgcolor> <bgcolor>
851 [<attribute> ...]; default value: n/a)
852 With this command, you can highlight articles in the article list
853 if they match a filter expression. (example: highlight-article
854 "author =~ \"Andreas Krennmair\"" white red bold)
855 highlight-feed (parameters: <filterexpr> <fgcolor> <bgcolor>
857 [<attribute> ...]; default value: n/a)
858 With this command, you can highlight feeds in the feed list if they
859 match a filter expression. (example: highlight-feed unread › 100
860 white red bold)
861 history-limit (parameters: <number>; default value: 100)
863 Defines the maximum number of entries of commandline resp. search
864 history to be saved. To disable history saving, set it to 0.
865 (example: history-limit 0)
866 html-renderer (parameters: <command>; default value: internal)
868 If set to internal, then the internal HTML renderer will be used.
869 Otherwise, the specified command will be executed, the HTML to be
870 rendered will be written to the command’s stdin, and the program’s
871 output will be displayed. This makes it possible to use other,
872 external programs, such as w3m, links or lynx, to render HTML.
873 (example: html-renderer "w3m -dump -T text/html")
874 http-auth-method (parameters: <method>; default value: any)
876 Set HTTP authentication method. Allowed values: any, basic, digest,
877 digest_ie (only available with libcurl 7.19.3 and newer),
878 gssnegotiate, ntlm and anysafe. (example: http-auth-method digest)
879 ignore-article (parameters: <feed> <filterexpr>; default value: n/a)
881 If a downloaded article from <feed> matches <filterexpr>, then it
882 is ignored and not presented to the user. This command is further
883 explained in the "kill file" section below. (example:
884 ignore-article "*" "title =~ \"Windows\"")
885 ignore-mode (parameters: [download/display]; default value: download)
887 This configuration option defines in what way an article is ignored
888 (see ignore-article). If set to download, then it is ignored in the
889 download/parsing phase and thus never written to the cache, if it
890 set to display, it is ignored when displaying articles but is kept
891 in the cache. (example: ignore-mode "display")
892 include (parameters: <path>; default value: n/a)
894 With this command, you can include other files to be interpreted as
895 configuration files. This is especially useful to separate your
896 configuration into several files, e.g. key configuration, color
897 configuration, ... (example: include "~/.newsboat/colors")
898 inoreader-app-id (parameters: <string>; default value: "")
900 Unique application ID issued by Inoreader. See "Inoreader" section.
901 (example: inoreader-app-id "123456789")
902 inoreader-app-key (parameters: <string>; default value: "")
904 Application key issued by Inoreader. See "Inoreader" section.
905 (example: inoreader-app-key "TmV3c2JvYXQgcm9ja3MgOikK")
906 inoreader-flag-share (parameters: <flag>; default value: "")
908 If set and Inoreader support is used, then all articles that are
909 flagged with the specified flag are being "shared" in Inoreader so
910 that people that follow you can see it. (example:
911 inoreader-flag-share "a")
912 inoreader-flag-star (parameters: <flag>; default value: "")
914 If set and Inoreader support is used, then all articles that are
915 flagged with the specified flag are being "starred" in Inoreader
916 and appear in the list of "Starred items". (example:
917 inoreader-flag-star "b")
918 inoreader-login (parameters: <login>; default value: "")
920 This variable sets your Inoreader login for Inoreader support.
921 (example: inoreader-login "your-login")
922 inoreader-min-items (parameters: <number>; default value: 20)
924 This variable sets the number of articles that are loaded from
925 Inoreader per feed. (example: inoreader-min-items 100)
926 inoreader-password (parameters: <password>; default value: "")
928 This variable sets your Inoreader password for Inoreader support.
929 Double quotes and backslashes within it should be escaped.
930 (example: inoreader-password "here_goesAquote:\"")
931 inoreader-passwordeval (parameters: <command>; default value: "")
933 A more secure alternative to the above, is providing your password
934 from an external command that is evaluated during login. This can
935 be used to read your password from a gpg encrypted file or your
936 system keyring. (example: inoreader-passwordeval "gpg --decrypt
937 ~/.newsboat/inoreader-password.gpg")
938 inoreader-passwordfile (parameters: <path>; default value: "")
940 Another alternative, by storing your plaintext password elsewhere
941 in your system. (example: inoreader-passwordfile
942 "~/.newsboat/inoreader-pw.txt")
943 inoreader-show-special-feeds (parameters: [yes/no]; default value: yes)
945 If set and Inoreader support is used, then "special feeds" like
946 "Starred items" (your starred articles) and "Shared items" (your
947 shared articles) appear in your subscription list. (example:
948 inoreader-show-special-feeds "no")
949 itemview-title-format (parameters: <format>; default value: "%N %V -
951 Article '%T' (%u unread, %t total)" (localized))
952 Format of the title in article view. See "Format Strings" section
953 of Newsboat manual for details on available formats. (example:
954 itemview-title-format "Article '%T'")
955 keep-articles-days (parameters: <number>; default value: 0)
957 If set to a number greater than 0, only articles that were
958 published within the last <number> days are kept, and older
959 articles are deleted. If set to 0, this option is not active. Note
960 that changing this setting won’t bring back the articles that were
961 deleted earlier; currently, there’s no non-hacky way to bring back
962 deleted articles. (example: keep-articles-days 30)
963 macro (parameters: <macro key> <command list> [-- "<macro
965 description>"]; default value: n/a)
966 With this command, you can define a macro key and specify a list of
967 commands that shall be executed when the macro prefix and the macro
968 key are pressed. Optionally, a description can be added. If
969 present, the description is shown in the help form. (example: macro
970 k open; reload; quit -- "enter feed to reload it")
971 mark-as-read-on-hover (parameters: [yes/no]; default value: no)
973 If set to yes, then all articles that get selected in the article
974 list are marked as read. (example: mark-as-read-on-hover yes)
975 max-browser-tabs (parameters: <number>; default value: 10)
977 Set the maximum number of articles to open in a browser when using
978 the open-all-unread-in-browser or
979 open-all-unread-in-browser-and-mark-read commands. (example:
980 max-browser-tabs 4)
981 max-download-speed (parameters: <number>; default value: 0)
983 If set to a number greater than 0, the download speed per download
984 is set to that limit (in KB/s). (example: max-download-speed 50)
985 max-items (parameters: <number>; default value: 0)
987 Set the number of articles to maximally keep per feed. If the
988 number is set to 0, then all articles are kept. (example: max-items
989 100)
990 miniflux-login (parameters: <username>; default value: "")
992 Sets the username for use with Miniflux. (example: miniflux-login
993 "admin")
994 miniflux-min-items (parameters: <number>; default value: 100)
996 This variable sets the number of articles that are loaded from
997 Miniflux per feed. (example: miniflux-min-items 20)
998 miniflux-password (parameters: <password>; default value: "")
1000 Configures the password for use with Miniflux. Double quotes and
1001 backslashes within it should be escaped. (example:
1002 miniflux-password "here_goesAquote:\"")
1003 miniflux-passwordeval (parameters: <command>; default value: "")
1005 A more secure alternative to the above, is providing your password
1006 from an external command that is evaluated during login. This can
1007 be used to read your password from a gpg encrypted file or your
1008 system keyring. (example: miniflux-passwordeval "gpg --decrypt
1009 ~/.newsboat/miniflux-password.gpg")
1010 miniflux-passwordfile (parameters: <path>; default value: "")
1012 Another alternative, by storing your plaintext password elsewhere
1013 in your system. (example: miniflux-passwordfile
1014 "~/.newsboat/miniflux-pw.txt")
1015 miniflux-token (parameters: <API Token>; default value: "")
1017 Sets the API Token for use with Miniflux. (example: miniflux-token
1018 "E-uTqU8r55KucuHz26tJbXfrZVRndwY_mZAsEfcC8Bg=")
1019 miniflux-tokeneval (parameters: <command>; default value: "")
1021 A more secure alternative to the above, is providing your API token
1022 from an external command that is evaluated during login. This can
1023 be used to read your token from a gpg encrypted file or your system
1024 keyring. (example: miniflux-tokeneval "gpg --decrypt
1025 ~/.newsboat/miniflux-token.gpg")
1026 miniflux-tokenfile (parameters: <API Token>; default value: "")
1028 Another alternative, by storing your plaintext token elsewhere in
1029 your system. (example: miniflux-tokenfile
1030 "~/.newsboat/miniflux-token.txt")
1031 miniflux-url (parameters: <url>; default value: "")
1033 Configures the URL where the Miniflux installation you want to use
1034 resides. (example: miniflux-url "https://example.com/miniflux/")
1035 newsblur-login (parameters: <login>; default value: "")
1037 This variable sets your NewsBlur login for NewsBlur support.
1038 (example: newsblur-login "your-login")
1039 newsblur-min-items (parameters: <number>; default value: 20)
1041 This variable sets the number of articles that are loaded from
1042 NewsBlur per feed. (example: newsblur-min-items 100)
1043 newsblur-password (parameters: <password>; default value: "")
1045 This variable sets your NewsBlur password for NewsBlur support.
1046 Double quotes and backslashes within it should be escaped.
1047 (example: newsblur-password "here_goesAquote:\"")
1048 newsblur-passwordeval (parameters: <command>; default value: "")
1050 A more secure alternative to the above, is providing your password
1051 from an external command that is evaluated during login. This can
1052 be used to read your password from a gpg encrypted file or your
1053 system keyring. (example: newsblur-passwordeval "gpg --decrypt
1054 ~/.newsboat/newsblur-password.gpg")
1055 newsblur-passwordfile (parameters: <path>; default value: "")
1057 Another alternative, by storing your plaintext password elsewhere
1058 in your system. (example: newsblur-passwordfile
1059 "~/.newsboat/newsblur-pw.txt")
1060 newsblur-url (parameters: <url>; default value: "https://newsblur.com")
1062 Configures the URL where the NewsBlur instance resides. (example:
1063 newsblur-url "https://localhost")
1064 notify-always (parameters: [yes/no]; default value: no)
1066 If set to no, notifications will only be made when there are new
1067 feeds or articles. If set to yes, notifications will be made
1068 regardless. (example: notify-always yes)
1069 notify-beep (parameters: [yes/no]; default value: no)
1071 If set to yes, then the speaker will beep on new articles.
1072 (example: notify-beep yes)
1073 notify-format (parameters: <string>; default value: "Newsboat: finished
1075 reload, %f unread feeds (%n unread articles total)" (localized))
1076 Format string that is used for formatting notifications. (example:
1077 notify-format "%d new articles (%n unread articles, %f unread
1078 feeds)")
1079 notify-program (parameters: <command>; default value: "")
1081 If set, then the configured program will be executed if new
1082 articles arrived (through a reload) or if notify-always is yes. The
1083 first parameter of the called program contains the notification
1084 message. In order to pass other hard-coded arguments to the
1085 program, write an appropriate wrapper shell script and use it as
1086 <command> instead. (example: notify-program "~/bin/my-notifier")
1087 notify-screen (parameters: [yes/no]; default value: no)
1089 If set to yes, then a "privacy message" will be sent to the
1090 terminal, containing a notification message about new articles.
1091 This is especially useful if you use terminal emulations such as
1092 GNU screen which implement privacy messages. (example:
1093 notify-screen yes)
1094 notify-xterm (parameters: [yes/no]; default value: no)
1096 If set to yes, then the xterm window title will be set to a
1097 notification message about new articles. (example: notify-xterm
1098 yes)
1099 ocnews-flag-star (parameters: <character>; default value: "")
1101 If set and ownCloud News support is used, then all articles that
1102 are flagged with the specified flag are being "starred" in ownCloud
1103 News. (example: ocnews-flag-star "s")
1104 ocnews-login (parameters: <username>; default value: "")
1106 Sets the username to use with the ownCloud instance. (example:
1107 ocnews-login "user")
1108 ocnews-password (parameters: <password>; default value: "")
1110 Configures the password to use with the ownCloud instance. Double
1111 quotes and backslashes within it should be escaped. (example:
1112 ocnews-password "here_goesAquote:\"")
1113 ocnews-passwordeval (parameters: <command>; default value: "")
1115 A more secure alternative to the above, is providing your password
1116 from an external command that is evaluated during login. This can
1117 be used to read your password from a gpg encrypted file or your
1118 system keyring. (example: ocnews-passwordeval "gpg --decrypt
1119 ~/.newsboat/ocnews-password.gpg")
1120 ocnews-passwordfile (parameters: <path>; default value: "")
1122 Another alternative, by storing your plaintext password elsewhere
1123 in your system. (example: ocnews-passwordfile
1124 "~/.newsboat/ocnews-pw.txt")
1125 ocnews-url (parameters: <url>; default value: "")
1127 Configures the URL where the ownCloud instance resides. (example:
1128 ocnews-url "https://localhost/owncloud")
1129 oldreader-flag-share (parameters: <flag>; default value: "")
1131 If set and The Old Reader support is used, then all articles that
1132 are flagged with the specified flag are being "shared" in The Old
1133 Reader so that people that follow you can see it. (example:
1134 oldreader-flag-share "a")
1135 oldreader-flag-star (parameters: <flag>; default value: "")
1137 If set and The Old Reader support is used, then all articles that
1138 are flagged with the specified flag are being "starred" in The Old
1139 Reader and appear in the list of "Starred items". (example:
1140 oldreader-flag-star "b")
1141 oldreader-login (parameters: <login>; default value: "")
1143 This variable sets your The Old Reader login for The Older Reader
1144 support. (example: oldreader-login "your-login")
1145 oldreader-min-items (parameters: <number>; default value: 20)
1147 This variable sets the number of articles that are loaded from The
1148 Old Reader per feed. (example: oldreader-min-items 100)
1149 oldreader-password (parameters: <password>; default value: "")
1151 This variable sets your The Old Reader password for The Old Reader
1152 support. Double quotes and backslashes within it should be escaped.
1153 (example: oldreader-password "here_goesAquote:\"")
1154 oldreader-passwordeval (parameters: <command>; default value: "")
1156 A more secure alternative to the above, is providing your password
1157 from an external command that is evaluated during login. This can
1158 be used to read your password from a gpg encrypted file or your
1159 system keyring. (example: oldreader-passwordeval "gpg --decrypt
1160 ~/.newsboat/oldreader-password.gpg")
1161 oldreader-passwordfile (parameters: <path>; default value: "")
1163 Another alternative, by storing your plaintext password elsewhere
1164 in your system. (example: oldreader-passwordfile
1165 "~/.newsboat/oldreader-pw.txt")
1166 oldreader-show-special-feeds (parameters: [yes/no]; default value: yes)
1168 If set and The Old reader support is used, then "special feeds"
1169 like "People you follow" (articles shared by people you follow),
1170 "Starred items" (your starred articles) and "Shared items" (your
1171 shared articles) appear in your subscription list. (example:
1172 oldreader-show-special-feeds "no")
1173 openbrowser-and-mark-jumps-to-next-unread (parameters: [yes/no];
1175 default value: no)
1176 If set to yes, jump to the next unread item when an item is opened
1177 in the browser and marked as read. (example:
1178 openbrowser-and-mark-jumps-to-next-unread yes)
1179 opml-url (parameters: <url> ...; default value: "")
1181 If the OPML online subscription mode is enabled, then the list of
1182 feeds will be taken from the OPML file found on this location.
1183 Optionally, you can specify more than one URL. All the listed OPML
1184 URLs will then be taken into account when loading the feed list.
1185 (example: opml-url "https://host.domain.tld/blogroll.opml"
1186 "https://example.com/anotheropmlfile.opml")
1187 pager (parameters: [<command>/internal]; default value: internal)
1189 If set to internal, then the internal pager will be used.
1190 Otherwise, the article to be displayed will be rendered to be a
1191 temporary file and then displayed with the configured pager. If the
1192 command is set to an empty string, the content of the PAGER
1193 environment variable will be used. If the command contains a
1194 placeholder %f, it will be replaced with the temporary filename.
1195 (example: pager "less %f")
1196 podcast-auto-enqueue (parameters: [yes/no]; default value: no)
1198 If set to yes, then all podcast URLs that are found in articles are
1199 added to the podcast download queue. See the respective section in
1200 the documentation for more information on podcast support in
1201 Newsboat. (example: podcast-auto-enqueue yes)
1202 prepopulate-query-feeds (parameters: [yes/no]; default value: no)
1204 If set to yes, then all query feeds are prepopulated with articles
1205 on startup. (example: prepopulate-query-feeds yes)
1206 proxy (parameters: <server:port>; default value: n/a)
1208 Set the proxy to use for downloading RSS feeds. (Don’t forget to
1209 actually enable the proxy with use-proxy yes.) Note that the
1210 NO_PROXY environment variable can disable the proxy for certain
1211 sites. (example: proxy localhost:3128)
1212 proxy-auth (parameters: <auth>; default value: n/a)
1214 Set the proxy authentication string. (example: proxy-auth
1215 user:password)
1216 proxy-auth-method (parameters: <method>; default value: any)
1218 Set proxy authentication method. Allowed values: any, basic,
1219 digest, digest_ie (only available with libcurl 7.19.3 and newer),
1220 gssnegotiate, ntlm and anysafe. (example: proxy-auth-method ntlm)
1221 proxy-type (parameters: <type>; default value: http)
1223 Set proxy type. Allowed values: http, socks4, socks4a, socks5 and
1224 socks5h. (example: proxy-type socks5)
1225 refresh-on-startup (parameters: [yes/no]; default value: no)
1227 If set to yes, then all feeds will be reloaded when Newsboat starts
1228 up. This is equivalent to the -r commandline option. See also
1229 auto-reload to additionally reload the feeds continuously.
1230 (example: refresh-on-startup yes)
1231 reload-only-visible-feeds (parameters: [yes/no]; default value: no)
1233 If set to yes, then manually reloading all feeds will only reload
1234 the currently visible feeds, e.g. if a filter or a tag is set.
1235 (example: reload-only-visible-feeds yes)
1236 reload-threads (parameters: <number>; default value: 1)
1238 The number of parallel reload threads that shall be started when
1239 all feeds are reloaded. (example: reload-threads 3)
1240 reload-time (parameters: <number>; default value: 60)
1242 The number of minutes between automatic reloads. (example:
1243 reload-time 120)
1244 reset-unread-on-update (parameters: <url> [<url>...]; default value:
1246 n/a)
1247 Specifies one or more feed URLs for whose articles the unread flag
1248 will be reset if an article has been updated, i.e. its content has
1249 been changed. This is especially useful for RSS feeds where single
1250 articles are updated after publication, and you want to be notified
1251 of the updates. This option can be specified multiple times.
1252 (example: reset-unread-on-update
1253 "https://blog.fefe.de/rss.xml?html")
1254 restrict-filename (parameters: [yes/no]; default value: yes)
1256 If set to no, Newsboat will not limit saved article filenames to
1257 ASCII characters. (example: restrict-filename no)
1258 run-on-startup (parameters: <list of operations>; default value: n/a)
1260 Specifies one or more Newsboat operations, separated by semicolons,
1261 which are executed on Newsboat startup. (example: run-on-startup
1262 next-unread; open; random-unread; open)
1263 save-path (parameters: <path-to-directory>; default value: ~/)
1265 The default path where articles shall be saved to. If an invalid
1266 path is specified, the current directory is used. (example:
1267 save-path "~/Saved Articles")
1268 scrolloff (parameters: <number>; default value: 0)
1270 Keep the configured number of lines above and below the selected
1271 item in lists. Configure a high number to keep the selected item in
1272 the center of the screen. (example: scrolloff 5)
1273 search-highlight-colors (parameters: <fgcolor> <bgcolor> [<attribute>
1275 ...]; default value: black yellow bold)
1276 This configuration command specifies the highlighting colors when
1277 searching for text from the article view. (example:
1278 search-highlight-colors white black bold)
1279 searchresult-title-format (parameters: <format>; default value: "%N %V
1281 - Search results for '%s' (%u unread, %t total)%?F? matching filter
1282 '%F'&?" (localized))
1283 Format of the title in search result. See "Format Strings" section
1284 of Newsboat manual for details on available formats. (example:
1285 searchresult-title-format "Search result")
1286 selectfilter-title-format (parameters: <format>; default value: "%N %V
1288 - Select Filter" (localized))
1289 Format of the title in filter selection dialog. See "Format
1290 Strings" section of Newsboat manual for details on available
1291 formats. (example: selectfilter-title-format "Select Filter")
1292 selecttag-format (parameters: <format>; default value: "%4i %T (%u)")
1294 Format of the lines in "Select tag" dialog. See the respective
1295 section in the documentation for more information on format
1296 strings. (example: selecttag-format "[%2i] %T (%n unread articles
1297 in %f feeds, %u feeds total)")
1298 selecttag-title-format (parameters: <format>; default value: "%N %V -
1300 Select Tag" (localized))
1301 Format of the title in tag selection dialog. See "Format Strings"
1302 section of Newsboat manual for details on available formats.
1303 (example: selecttag-title-format "Select Tag")
1304 show-keymap-hint (parameters: [yes/no]; default value: yes)
1306 If set to no, then the keymap hints will not be displayed. (The
1307 keymap hints are usually at the bottom of the screen, but see
1308 swap-title-and-hints setting.) (example: show-keymap-hint no)
1309 show-read-articles (parameters: [yes/no]; default value: yes)
1311 If set to yes, then all articles of a feed are listed in the
1312 article list. If set to no, then only unread articles are listed.
1313 (example: show-read-articles no)
1314 show-read-feeds (parameters: [yes/no]; default value: yes)
1316 If set to yes, then all feeds, including those without unread
1317 articles, are listed. If set to no, then only feeds with one or
1318 more unread articles are list. (example: show-read-feeds no)
1319 show-title-bar (parameters: [yes/no]; default value: yes)
1321 If set to no, then the title bar will not be displayed. (The title
1322 bar is usually at the top of the screen, but see
1323 swap-title-and-hints setting.) (example: show-title-bar no)
1324 ssl-verifyhost (parameters: [yes/no]; default value: yes)
1326 If set to no, skip verification of the certificate’s name against
1327 host. (example: ssl-verifyhost no)
1328 ssl-verifypeer (parameters: [yes/no]; default value: yes)
1330 If set to no, skip verification of the peer’s SSL certificate.
1331 (example: ssl-verifypeer no)
1332 suppress-first-reload (parameters: [yes/no]; default value: no)
1334 If set to yes, then the first automatic reload will be suppressed
1335 if auto-reload is set to yes. (example: suppress-first-reload yes)
1336 swap-title-and-hints (parameters: [yes/no]; default value: no)
1338 If set to yes, then the title (which is usually at the top of the
1339 screen) and the keymap hints (usually at the bottom) will exchange
1340 places. These bars can be hidden entirely, via the
1341 show-keymap-hints and show-title-bar settings. (example:
1342 swap-title-and-hints yes)
1343 text-width (parameters: <number>; default value: 0)
1345 If set to a number greater than 0, all HTML will be rendered to
1346 this maximum line length or the terminal width (whichever is
1347 smaller). If set to 0, the terminal width will always be used in
1348 the article view, while pipe-to, save, and save-all will wrap at 80
1349 columns instead. Does not apply when using external renderer or
1350 viewing the source. Also note that "Link" header and "Links"
1351 section won’t be affected by it—they contain URLs which are better
1352 not wrapped. (example: text-width 72)
1353 toggleitemread-jumps-to-next-unread (parameters: [yes/no]; default
1355 value: no)
1356 If set to yes, jump to the next unread item when an item’s read
1357 status is toggled in the article list. (example:
1358 toggleitemread-jumps-to-next-unread yes)
1359 ttrss-flag-publish (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 marked as "published"
1363 in Tiny Tiny RSS. (example: ttrss-flag-publish "b")
1364 ttrss-flag-star (parameters: <character>; default value: "")
1366 If set and Tiny Tiny RSS support is used, then all articles that
1367 are flagged with the specified flag are being "starred" in Tiny
1368 Tiny RSS. (example: ttrss-flag-star "a")
1369 ttrss-login (parameters: <username>; default value: "")
1371 Sets the username for use with Tiny Tiny RSS. (example: ttrss-login
1372 "admin")
1373 ttrss-mode (parameters: [multi/single]; default value: multi)
1375 Configures the mode in which Tiny Tiny RSS is used. In single-user
1376 mode, login and password are used for HTTP authentication, while in
1377 multi-user mode, they are used for authenticating with Tiny Tiny
1378 RSS. (example: ttrss-mode "single")
1379 ttrss-password (parameters: <password>; default value: "")
1381 Configures the password for use with Tiny Tiny RSS. Double quotes
1382 and backslashes within it should be escaped. (example:
1383 ttrss-password "here_goesAquote:\"")
1384 ttrss-passwordeval (parameters: <command>; default value: "")
1386 A more secure alternative to the above, is providing your password
1387 from an external command that is evaluated during login. This can
1388 be used to read your password from a gpg encrypted file or your
1389 system keyring. (example: ttrss-passwordeval "gpg --decrypt
1390 ~/.newsboat/ttrss-password.gpg")
1391 ttrss-passwordfile (parameters: <path>; default value: "")
1393 Another alternative, by storing your plaintext password elsewhere
1394 in your system. (example: ttrss-passwordfile
1395 "~/.newsboat/ttrss-pw.txt")
1396 ttrss-url (parameters: <url>; default value: "")
1398 Configures the URL where the Tiny Tiny RSS installation you want to
1399 use resides. (example: ttrss-url "https://example.com/ttrss/")
1400 unbind-key (parameters: <key> [<dialog>]; default value: n/a)
1402 Unbind key <key>. This means that no operation is called when <key>
1403 is pressed. If you provide "-a" as <key>, all currently bound keys
1404 will become unbound. Optionally, you can specify a dialog (for a
1405 list of available dialogs, see bind-key above). If you specify one,
1406 the key binding will only be unbound for the specified dialog.
1407 (example: unbind-key R)
1408 urls-source (parameters: <source>; default value: "local")
1410 This configuration command sets the source where URLs shall be
1411 retrieved from. By default, this is the urls file. Alternatively,
1412 you can set it to opml, which enables Newsboat’s OPML online
1413 subscription mode, to ttrss which enables Newsboat’s Tiny Tiny RSS
1414 support, to oldreader, which enables Newsboat’s The Old Reader
1415 support, to newsblur, which enables NewsBlur support, to feedhq for
1416 FeedHQ support, to freshrss for FreshRSS support, to ocnews for
1417 ownCloud News support, to inoreader for Inoreader support, or to
1418 miniflux for Miniflux support. Query feed specifications will be
1419 read from the local urls file regardless of this setting. (example:
1420 urls-source "oldreader")
1421 urlview-title-format (parameters: <format>; default value: "%N %V -
1423 URLs" (localized))
1424 Format of the title in URL view. See "Format Strings" section of
1425 Newsboat manual for details on available formats. (example:
1426 urlview-title-format "URLs")
1427 use-proxy (parameters: [yes/no]; default value: no)
1429 If set to yes, then the configured proxy will be used for
1430 downloading the RSS feeds. (example: use-proxy yes)
1431 user-agent (parameters: <string>; default value: "")
1433 If set to a non-zero-length string, this value will be used as HTTP
1434 User-Agent header for all HTTP requests. (example: user-agent
1435 "Lynx/2.8.5rel.1 libwww-FM/2.14")
1436 wrap-scroll (parameters: [yes/no]; default value: no)
1438 If set to yes, moving down while on the last item in a list will
1439 wrap around to the top and vice versa. (example: wrap-scroll yes)
1440
1442 open (default key: ENTER)
1443 Open the currently selected feed or article.
1444 quit (default key: Q)
1446 Quit the program or return to the previous dialog (depending on the
1447 context).
1448 hard-quit (default key: Shift + Q)
1450 Quit the program without confirmation.
1451 reload (default key: R)
1453 Reload the currently selected feed.
1454 reload-all (default key: Shift + R)
1456 Reload all feeds.
1457 mark-feed-read (default key: Shift + A)
1459 Mark all articles in the currently selected feed read.
1460 mark-all-feeds-read (default key: Shift + C)
1462 Mark articles in all feeds read.
1463 mark-all-above-as-read (default key: n/a)
1465 Mark all above as read.
1466 save (default key: S)
1468 Export the currently selected article to a plain text file,
1469 word-wrapped according to the text-width setting.
1470 save-all (default key: n/a)
1472 Export all articles from the currently selected feed to plain text
1473 files, word-wrapped according to the text-width setting.
1474 next-unread (default key: N)
1476 Jump to the next unread article.
1477 prev-unread (default key: P)
1479 Jump to the previous unread article.
1480 next (default key: Shift + J)
1482 Jump to next list entry.
1483 prev (default key: Shift + K)
1485 Jump to previous list entry.
1486 random-unread (default key: Ctrl + K)
1488 Jump to a random unread article.
1489 open-in-browser (default key: O)
1491 Use browser to open the URL associated with the current article,
1492 feed, or entry in the URL view.
1493 open-in-browser-noninteractively (default key: n/a)
1495 Use browser to open the URL associated with the current article,
1496 feed, or entry in the URL view. This operation works similar to
1497 open-in-browser, but the output of the browser (stdout and stderr)
1498 is not shown, and the browser doesn’t receive keyboard input. You
1499 would probably add & at the end of the browser command to put it
1500 into background, too.
1501 open-in-browser-and-mark-read (default key: Shift + O)
1503 Use browser to open the URL associated with the current article, or
1504 entry in the URL view. When used in the article list, it will also
1505 mark the article as read.
1506 open-all-unread-in-browser (default key: n/a)
1508 Open all the unread URLs in the current feed.
1509 open-all-unread-in-browser-and-mark-read (default key: n/a)
1511 Open all the unread URLs in the current feed and mark them as read.
1512 help (default key: ?)
1514 Run the help screen.
1515 toggle-source-view (default key: Ctrl + U)
1517 Toggle between the HTML view and the source view in the article
1518 view.
1519 toggle-article-read (default key: Shift + N)
1521 Toggle the read flag for the currently selected article, and clear
1522 the delete flag if set.
1523 toggle-show-read-feeds (default key: L)
1525 Toggle whether read feeds should be shown in the feed list.
1526 show-urls (default key: U)
1528 Show all URLs in the article in a list (similar to urlview).
1529 clear-tag (default key: Ctrl + T)
1531 Clear current tag.
1532 set-tag (default key: T)
1534 Select tag.
1535 open-search (default key: /)
1537 Open the search dialog. When a search is done in the article list,
1538 then the search operation only applies to the articles of the
1539 current feed, otherwise to all articles.
1540 goto-url (default key: #)
1542 Open the URL dialog and then open a specified URL in the browser.
1543 one (default key: 1)
1545 Open URL 1 in the browser.
1546 two (default key: 2)
1548 Open URL 2 in the browser.
1549 three (default key: 3)
1551 Open URL 3 in the browser.
1552 four (default key: 4)
1554 Open URL 4 in the browser.
1555 five (default key: 5)
1557 Open URL 5 in the browser.
1558 six (default key: 6)
1560 Open URL 6 in the browser.
1561 seven (default key: 7)
1563 Open URL 7 in the browser.
1564 eight (default key: 8)
1566 Open URL 8 in the browser.
1567 nine (default key: 9)
1569 Open URL 9 in the browser.
1570 zero (default key: 0)
1572 Open URL 10 in the browser.
1573 cmd-one (default key: 1)
1575 Start cmdline with 1.
1576 cmd-two (default key: 2)
1578 Start cmdline with 2.
1579 cmd-three (default key: 3)
1581 Start cmdline with 3.
1582 cmd-four (default key: 4)
1584 Start cmdline with 4.
1585 cmd-five (default key: 5)
1587 Start cmdline with 5.
1588 cmd-six (default key: 6)
1590 Start cmdline with 6.
1591 cmd-seven (default key: 7)
1593 Start cmdline with 7.
1594 cmd-eight (default key: 8)
1596 Start cmdline with 8.
1597 cmd-nine (default key: 9)
1599 Start cmdline with 9.
1600 enqueue (default key: E)
1602 Add the podcast download URL of the current article (if any is
1603 found) to the podcast download queue (see the respective section in
1604 the documentation for more information on podcast support).
1605 edit-urls (default key: Shift + E)
1607 Edit the list of subscribed URLs. Newsboat will start the editor
1608 configured through the VISUAL environment variable (if unset,
1609 EDITOR is used; fallback: vi). When editing is finished, Newsboat
1610 will reload the URLs file.
1611 reload-urls (default key: Ctrl + R)
1613 Reload the URLs configuration file.
1614 redraw (default key: Ctrl + L)
1616 Redraw the screen.
1617 cmdline (default key: :)
1619 Open the command line.
1620 set-filter (default key: Shift + F)
1622 Set a filter.
1623 select-filter (default key: F)
1625 Select a predefined filter.
1626 clear-filter (default key: Ctrl + F)
1628 Clear currently set filter.
1629 bookmark (default key: Ctrl + B)
1631 Bookmark currently selected article or URL.
1632 edit-flags (default key: Ctrl + E)
1634 Edit the flags of the currently selected article.
1635 next-unread-feed (default key: Ctrl + N)
1637 Go to the next feed with unread articles. This only works from the
1638 article list.
1639 prev-unread-feed (default key: Ctrl + P)
1641 Go to the previous feed with unread articles. This only works from
1642 the article list.
1643 next-feed (default key: J)
1645 Go to the next feed. This only works from the article list.
1646 prev-feed (default key: K)
1648 Go to the previous feed. This only works from the article list.
1649 delete-article (default key: Shift + D)
1651 Delete the currently selected article.
1652 delete-all-articles (default key: Ctrl + D)
1654 Delete all articles in the articlelist. Note that the articlelist
1655 might contain a subset of feed’s articles (because of filters or
1656 show-read-articles no), or it might contain a mix of articles from
1657 different feeds (if you’re viewing a query feed) — in either case,
1658 delete-all-articles affects just those articles, not all articles
1659 of the respective feed(s).
1660 purge-deleted (default key: $)
1662 Purge all articles that are marked as deleted from the article
1663 list.
1664 view-dialogs (default key: V)
1666 View list of open dialogs.
1667 close-dialog (default key: Ctrl + X)
1669 Close currently selected dialog.
1670 next-dialog (default key: Ctrl + V)
1672 Go to next dialog.
1673 prev-dialog (default key: Ctrl + G)
1675 Go to previous dialog.
1676 pipe-to (default key: |)
1678 Pipe article to command. The text will be word-wrapped according to
1679 the text-width setting.
1680 sort (default key: G)
1682 Sort feeds/articles by interactively choosing the sort method.
1683 rev-sort (default key: Shift + G)
1685 Sort feeds/articles by interactively choosing the sort method
1686 (reversed).
1687 up (default key: UP)
1689 Go up one item in the list.
1690 down (default key: DOWN)
1692 Go down one item in the list.
1693 pageup (default key: PPAGE)
1695 Go up one page in the list.
1696 pagedown (default key: NPAGE)
1698 Go down one page in the list.
1699 halfpageup (default key: n/a)
1701 Go up half a page.
1702 halfpagedown (default key: n/a)
1704 Go down half a page.
1705 home (default key: HOME)
1707 Go to the first item in the list.
1708 end (default key: END)
1710 Go to the last item in the list.
1711 macro-prefix (default key: ,)
1713 Initiate macro execution. The next key press selects the actual
1714 macro and runs it.
1715 switch-focus (default key: TAB)
1717 Switch focus between widgets. This is currently only applicable to
1718 the filebrowser and dirbrowser contexts.
1719 goto-title (default key: n/a)
1721 Go to item whose title contains the specified string
1722 (case-insensitive).
1723 prevsearchresults (default key: Z)
1725 Return to previous search results (if any). This only works from
1726 searchresultslist.
1727 article-feed (default key: n/a)
1729 Go to the feed of the currently selected article.
1730
1732 Newsboat comes with the possibility to categorize or "tag", as we call
1733 it, RSS feeds. Every RSS feed can be assigned 0 or more tags. Within
1734 Newsboat, you can then select to only show RSS feeds that match a
1735 certain tag. That makes it easy to categorize your feeds in a flexible
1736 and powerful way.
1737 Usually, the urls file contains one RSS feed URL per line. To assign a
1739 tag to an RSS feed, simply attach it as a single word, separated by
1740 blanks such as space or tab. If the tag needs to contain spaces, you
1741 must use quotes (") around the tag (see example below). An example urls
1742 file may look like this:
1743 https://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
1745 https://rss.orf.at/news.xml news orf
1746 https://www.heise.de/newsticker/heise.rdf news interesting
1747 When you now start Newsboat with this configuration, you can press T to
1749 select a tag. When you select the tag "news", you will see all three
1750 RSS feeds. Pressing T again and e.g. selecting the "conspiracy" tag,
1751 you will only see the https://blog.fefe.de/rss.xml?html RSS feed.
1752 Pressing Ctrl + T clears the current tag, and again shows all RSS
1753 feeds, regardless of their assigned tags.
1754 A special type of tag are tags that start with the tilde character (~).
1756 When such a tag is found, the feed title is set to the tag name
1757 (excluding the ~ character). These type of tags are ignored when any
1758 kind of "first tag" property is used. With this feature, you can give
1759 feeds any title you want in your feed list:
1760 https://rss.orf.at/news.xml "~ORF News"
1762 Another special type of tag are tags that start with the exclamation
1764 mark (!). When such a tag is found, the feed is hidden from the regular
1765 list of feeds and its content can only be found through a query feed.
1766 https://rss.orf.at/news.xml ! news
1768 http://feeds.bbci.co.uk/news/world/rss.xml ! news
1769 "query:News from around the globe:tags # \"news\""
1770 In this example, the first two feeds won’t appear in the feedlist, but
1772 their articles will still be accessible through the query feed titled
1773 "News from around the globe". The "hidden" tags in this example don’t
1774 even have names, because their only use is to hide the feed that
1775 they’re tagging.
1776
1778 Newsboat contains support for Snownews extensions. The RSS feed readers
1779 Snownews and Liferea share a common way of extending the readers with
1780 custom scripts. Two mechanisms, namely "execurl" and "filter" type
1781 scripts, are available and supported by Newsboat.
1782 An "execurl" script can be any program that gets executed and whose
1784 output is interpreted as RSS feed, while "filter" scripts are fed with
1785 the content of a configured URL and whose output is interpreted as RSS
1786 feed.
1787 The configuration is simple and straight-forward. Just add to your urls
1789 file configuration lines like the following ones:
1790 exec:~/bin/execurl-script
1792 filter:~/bin/filter-script:https://some.test/url
1793 The first line shows how to add an execurl script to your
1795 configuration: start the line with exec: and then immediately append
1796 the path of the script that shall be executed. If this script requires
1797 additional parameters, simply use quotes (see Using Double Quotes for
1798 details):
1799 "exec:~/bin/execurl-script param1 param2"
1801 The second line shows how to add a filter script to your configuration:
1803 start the line with filter:, then immediately append the path of the
1804 script, then append a colon (:), and then append the URL of the file
1805 that shall be fed to the script. Again, if the script requires any
1806 parameters, simply quote the whole thing:
1807 "filter:~/bin/filter-script param1 param2:https://url/foobar"
1809 In both cases, the tagging feature as described above is still
1811 available:
1812 exec:~/bin/execurl-script tag1 tag2 "quoted tag"
1814 filter:~/bin/filter-script:https://some.test/url tag3 tag4 tag5
1815 If you need to write your own extension, see this
1817 <https://web.archive.org/web/20090724045314/http://kiza.kcore.de/software/snownews/snowscripts/writing>
1818 short guide" for an introduction. A collection of existing scripts
1819 <https://github.com/msharov/snownews/tree/de3bd8b28191c4d4bc1be18275786613bcbc0c94/docs/untested>
1820 and filters
1821 <https://github.com/msharov/snownews/tree/9fb45e4cdf1cf9dea55b9af66c13a4c238809851/docs/filters>
1822 might help, too.
1823 Newsboat comes with an example exec script which shows one way to
1825 generate an RSS channel. It also includes a way to see which exact
1826 arguments are passed to the script by Newsboat. This example can be
1827 found in the doc/examples subdirectory.
1828
1830 Like other text-oriented software, Newsboat contains an internal
1831 commandline to modify configuration variables ad hoc and to run own
1832 commands. It provides a flexible access to the functionality of
1833 Newsboat which is especially useful for advanced users.
1834 To start the commandline, type :. You will see a ":" prompt at the
1836 bottom of the screen, similar to tools like vi(m) or mutt. You can now
1837 enter commands. Pressing the Enter key executes the command (possibly
1838 giving feedback to the user) and closes the commandline. You can cancel
1839 entering commands by pressing the Esc key. The history of all the
1840 commands that you enter will be saved to the history.cmdline file,
1841 stored next to the cache.db file. The backlog is limited to 100 entries
1842 by default, but can be influenced by setting the history-limit
1843 configuration variable. To disable history saving, set the
1844 history-limit to 0.
1845 The commandline provides you with some help if you can’t remember the
1847 full names of commandline commands. By pressing the Tab key, Newsboat
1848 will try to automatically complete your command. If there is more than
1849 one possible completion, you can subsequently press the Tab key to
1850 cycle through all results. If no match is found, no suggestion will be
1851 inserted into the commandline. For the set command, the completion also
1852 works for configuration variable names.
1853 In addition, some common key combination such as Ctrl + G (to cancel
1855 input), Ctrl + K (to delete text from the cursor position to the end of
1856 line), Ctrl + U (to clear the whole line) and Ctrl + W (to delete the
1857 word before the current cursor position) were added.
1858 Please be aware that the input history of both the command line and the
1860 search functions are saved to the filesystems, to the files
1861 history.cmdline resp. history.search (stored next to the cache.db
1862 file). By default, the last 100 entries are saved, but this can be
1863 configured (configuration variable history-limit) and also totally
1864 disabled (by setting said variable to 0).
1865 Currently, the following command line commands are available:
1867 quit
1869 Quit Newsboat
1870 q
1872 Alias for quit
1873 save <filename>
1875 Save current article to <filename>
1876 set <variable>[=<value>|&|!]
1878 Set (or get) configuration variable value. Specifying a ! after the
1879 name of a boolean configuration variable toggles their values, a &
1880 directly after the name of a configuration variable of any type
1881 resets its value to the documented default value.
1882 tag <tagname>
1884 Select a certain tag
1885 goto <case-insensitive substring>
1887 Go to the next feed whose name contains the case-insensitive
1888 substring.
1889 source <filename> [...]
1891 Load the specified configuration files. This allows it to load
1892 alternative configuration files or reload already loaded
1893 configuration files on-the-fly from the filesystem.
1894 dumpconfig <filename>
1896 Save current internal state of configuration to file, so that it
1897 can be instantly reused as configuration file.
1898 <number>
1900 Jump to the <number>th entry in the current dialog
1901
1903 By default, Newsboat stores all the files in a traditional Unix
1904 fashion, i.e. in a "dotdir" located at ~/.newsboat. However, it also
1905 supports a modern way, XDG Base Directory Specification
1906 <https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>,
1907 which splits the files between the following locations:
1908 1. $XDG_CONFIG_HOME/newsboat/ (XDG_CONFIG_HOME defaults to ~/.config)
1910 2. $XDG_DATA_HOME/newsboat/ (XDG_DATA_HOME defaults to ~/.local/share)
1912 If the newsboat directory exists under XDG_CONFIG_HOME, then Newsboat
1914 will use XDG directories (creating the data directory if necessary).
1915 Otherwise, Newsboat will default to ~/.newsboat.
1916 If you’re currently using ~/.newsboat/ but wish to migrate to XDG
1918 directories, you should move the files as follows:
1919 config, urls
1921 to $XDG_CONFIG_HOME/newsboat/
1922 cache.db, history.search, history.cmdline, queue
1924 to $XDG_DATA_HOME/newsboat/
1925 Newsboat and Podboat also create "lock files". These prevent you from
1927 starting two instances of the same program, and thus from corrupting
1928 your data. Newsboat and Podboat remove these files when you quit the
1929 program, so there is no need to copy them anywhere — just be aware of
1930 them in case you write scripts that work with cache.db or queue. By
1931 default, lock files are located as follows:
1932 ┌─────────┬───────────────────────────┬───────────────────────────────────────┐
1934 │ │ │ │
1935 │ │ dotdir │ XDG │
1936 ├─────────┼───────────────────────────┼───────────────────────────────────────┤
1937 │ │ │ │
1938 │Newsboat │ ~/.newsboat/cache.db.lock │ $XDG_DATA_HOME/newsboat/cache.db.lock │
1939 ├─────────┼───────────────────────────┼───────────────────────────────────────┤
1940 │ │ │ │
1941 │Podboat │ ~/.newsboat/pb-lock.pid │ $XDG_DATA_HOME/newsboat/.lock │
1942 └─────────┴───────────────────────────┴───────────────────────────────────────┘
1943 Newsboat places the lock file next to the cache file, so if you specify
1945 cache-file setting or pass —cache-file command-line argument, the path
1946 to the lock file will change too. Podboat, on the other hand, always
1947 places its lock file as shown above.
1948 dotfiles
1950 ~/.newsboat/config
1951 ~/.newsboat/urls
1953 XDG
1955 $XDG_CONFIG_HOME/newsboat/config
1956 $XDG_CONFIG_HOME/newsboat/urls
1958 Note: if the XDG_CONFIG_HOME environment variable is not set,
1960 Newsboat behaves as if it was set to ~/.config.
1961
1963 BROWSER
1964 Tells Newsboat what browser to use if there is no browser setting
1965 in the config file. If this variable doesn’t exist, a default of
1966 lynx(1) will be used.
1967 CURL_CA_BUNDLE
1969 Tells Newsboat to use the specified certificate file to verify the
1970 peer. The file may contain multiple certificates. The
1971 certificate(s) must be in PEM format.
1972 This option is useful if your libcurl is built without useful
1974 certificate information, and you can’t rebuild the library
1975 yourself.
1976 EDITOR
1978 Tells Newsboat what fallback editor to use when editing the urls
1979 file via the edit-urls operation and no VISUAL environment variable
1980 is set. If this variable doesn’t exist either, a default of vi(1)
1981 will be used.
1982 NO_PROXY
1984 Tells Newsboat to ignore proxy setting for certain sites.
1985 This variable contains a comma-separated list of hostnames, domain
1987 names, and IP addresses.
1988 Domain names match subdomains, i.e. "example.com" also matches
1990 "foo.example.com". Domain names that start with a dot only match
1991 subdomains, e.g. ".example.com" matches "bar.example.com" but not
1992 "example.com" itself.
1993 IPv6 addresses are written without square brackets, and are matched
1995 as strings. Thus "::1" doesn’t match "::0:1" even though this is
1996 the same address.
1997 PAGER
1999 Tells Newsboat what pager to use if the pager setting in the config
2000 file is explicitly set to an empty string.
2001 TMPDIR
2003 Tells Newsboat to use the specified directory for storing temporary
2004 files. If this variable doesn’t exist, a default of /tmp will be
2005 used.
2006 VISUAL
2008 Tells Newsboat what editor to use when editing the urls file via
2009 the edit-urls operation. If this variable doesn’t exist, the EDITOR
2010 environment variable will be used.
2011 XDG_CONFIG_HOME
2013 Tells Newsboat which base directory to use for the configuration
2014 files. See also the section on files for more information.
2015 XDG_DATA_HOME
2017 Tells Newsboat which base directory to use for the data files. See
2018 also the section on files for more information.
2019
2021 podboat(1)
2022
2024 Alexander Batischev
2025 2023-09-25 NEWSBOAT(1)