neulab/tldr huggingface dataset:
Newsboat caches the article that it downloads. This means that when you start Newsboat again and reload a feed, the old articles can still be read even if they aren’t in the current RSS feeds anymore. Optionally you can configure how many articles shall be preserved by feed so that the article backlog doesn’t grow endlessly (see max-items below).
Newsboat also uses a number of measures to preserve the users' and feed providers' bandwidth, by trying to avoid unnecessary feed downloads through the use of conditional HTTP downloading. It saves every feed’s "Last-Modified" and "ETag" response header values (if present) and advises the feed’s HTTP server to only send data if the feed has been updated by modification date/time or "ETag" header. This doesn’t only make feed downloads for RSS feeds with no new updates faster, it also reduces the amount of transferred data per request. Conditional HTTP downloading can be optionally disabled per feed by using the always-download configuration command.
Several aspects of Newsboat’s behaviour can be configured via a configuration file config, which is stored next to the urls file. This configuration file contains lines in the form <config-command> <arg1> .... The configuration file can also contain comments, which start with the # character and go as far as the end of line. If you need to enter a configuration argument that contains spaces, use quotes (") around the whole argument. It’s even possible to integrate the output of external commands into the configuration. The text between two backticks (`) is evaluated as shell command, and its output is put on its place instead. This works like backtick evaluation in Bourne-compatible shells and allows users to use external information from the system within the configuration. Backticks and # characters can be escaped with a backslash (e.g. \` and \#); in that case, they’ll be replaced with literal ` or # in the configuration.
Searching for articles is possible in Newsboat, too. Just press the "/" key, enter your search phrase, and the title and content of all articles are searched for it. When you do a search from the list of feeds, all articles of all feeds will be searched. When you do a search from the article list of a feed, only the articles of the currently viewed feed are searched. When opening an article from a search result dialog, the search phrase is highlighted.
The history of all your searches is saved to the filesystem, to the history.search file (stored next to the cache.db file). By default, the last 100 search phrases are stored, but this limited can be influenced through the history-limit configuration variable. To disable search history saving, simply set the history-limit to 0.
Keys, as used in the bind-key configuration command, use a special syntax. Lowercase keys, uppercase keys and special characters are written literally. The "Enter" key is written as ENTER, "Tab" key as TAB, and the "Esc" key is written as ESC. The function keys "F1" to "F12" are written as F1 to F12. The "Space" key is written as SPACE. Key combinations with the "Ctrl" key, such as "Ctrl-R", are written as ^R. Please be aware that all Ctrl-related key combinations need to be written in uppercase. The following identifiers for keys are supported:
•   ENTER (Enter key)
•   BACKSPACE (backspace key)
•   LEFT (left cursor)
•   RIGHT (right cursor)
•   UP (up cursor)
•   DOWN (down cursor)
•   PPAGE (page up cursor)
•   NPAGE (page down cursor)
•   HOME (cursor to beginning of list/article)
•   END (cursor to end of list/article)
•   ESC (Esc key)
•   TAB (Tab key)
Newsboat also comes with user contributed content like scripts and color themes. The user contributed content can be found in /usr/share/doc/newsboat/contrib/. End users are encouraged to take a look as they may find something useful.
always-display-description (parameters: [yes/no]; default value: no) If set to yes, then the description will always be displayed even if e.g. a <content:encoded> tag has been found. (example: always-display-description yes)
always-download (parameters: <url> [<url>...]; default value: n/a) Specifies one or more feed URLs that should always be downloaded, regardless of their Last-Modified timestamp and ETag header. This option can be specified multiple times. (example: always-download "https://www.n-tv.de/23.rss")
article-sort-order (parameters: <sortfield>[-<direction>]; default value: date-asc) The <sortfield> specifies which article property shall be used for sorting. Currently available are: date, title, flags, author, link, guid, and random. The optional <direction> can be either asc for ascending order, or desc for descending order. Note that direction does not affect the random sorting. For date, desc order is the default, i.e. date is the same as date-desc; for all others, asc is the default. Also, the directions for date are reversed: desc means the newest items are first, whereas asc means the oldest items are first. These inconsistencies will be fixed in a future major version of Newsboat. (example: article-sort-order author-desc)
articlelist-format (parameters: <format>; default value: "%4i %f %D %6L %?T?|%-17T|  ?%t") This variable defines the format of entries in the article list. See the respective section in the documentation for more information on format strings. (example: articlelist-format "%4i %f %D   %?T?|%-17T| ?%t")
articlelist-title-format (parameters: <format>; default value: "%N %V - Articles in feed '%T' (%u unread, %t total)%?F? matching filter '%F'&? - %U" (localized)) Format of the title in article list. See "Format Strings" section of Newsboat manual for details on available formats. (example: articlelist-title-format "Articles in feed '%T' (%u unread)")
auto-reload (parameters: [yes/no]; default value: no) If set to yes, all feeds will be automatically reloaded at start up and then continuously after a certain time has passed (see reload-time). (example: auto-reload yes)
bind-key (parameters: <key> <operation> [<dialog>]; default value: n/a) Bind key <key> to <operation>. This means that whenever <key> is pressed, then <operation> is executed (if applicable in the current dialog). See [_newsboat_operations] and [_podboat_operations] for lists of available <operation> values. Optionally, you can specify a dialog. If you specify one, the key binding will only be added to the specified dialog. Available dialogs are all (default if none is specified), feedlist, filebrowser, help, articlelist, article, tagselection, filterselection, urlview, podboat, and dirbrowser. (example: bind-key ^R reload-all)
bookmark-autopilot (parameters: [yes/no]; default value: no) If set to yes, the configured bookmark command is executed without any further input asked from user, unless the url or the title cannot be found/guessed. (example: bookmark-autopilot yes)
bookmark-cmd (parameters: <command>; default value: "") If set, then <command> will be used as bookmarking plugin. See the documentation on bookmarking for further information. (example: bookmark-cmd "~/bin/delicious-bookmark.sh")
bookmark-interactive (parameters: [yes/no]; default value: no) If set to yes, then the configured bookmark command is an interactive program. (example: bookmark-interactive yes)
browser (parameters: <command>; default value: %BROWSER, otherwise lynx) Set the browser command to use when opening an article in the browser. If the BROWSER environment variable is set, it will be used as the default browser, otherwise lynx will be used. Any occurrences of %u in <command> will be replaced by the URL being opened, enclosed in single quotes. Any occurrences of %F in <command> will be replaced by the feed’s URL in single quotes. (example: browser "w3m %u")
cache-file (parameters: <path>; default value: "~/.newsboat/cache.db" or "~/.local/share/cache.db" (see "Files" section)) This configuration option sets the cache file. This is especially useful if the filesystem of your home directory doesn’t support proper locking (e.g. NFS). (example: cache-file "/tmp/testcache.db")
cleanup-on-quit (parameters: [yes/no]; default value: yes) If set to yes, then the cache gets locked and superfluous feeds and items are removed, such as feeds that can’t be found in the urls configuration file anymore. (example: cleanup-on-quit no)
color (parameters: <element> <fgcolor> <bgcolor> [<attribute> ...]; default value: n/a) Set the foreground color, background color and optional attributes for a certain element. (example: color background white black)
confirm-delete-all-articles (parameters: [yes/no]; default value: yes) If set to yes, then Newsboat will ask for confirmation whether the user wants to delete all articles. (example: confirm-delete-all-articles no)
confirm-mark-all-feeds-read (parameters: [yes/no]; default value: yes) If set to yes, then Newsboat will ask for confirmation whether the user wants to mark all feeds as read. (example: confirm-mark-all-feeds-read no)
confirm-exit (parameters: [yes/no]; default value: no) If set to yes, then Newsboat will ask for confirmation whether the user really wants to quit Newsboat. (example: confirm-exit yes)
cookie-cache (parameters: <path>; default value: "") Set a cookie cache. If set, cookies will be cached in (i.e. read from and written to) this file, using Netscape format <http://www.cookiecentral.com/faq/#3.5>. (example: cookie-cache "~/.newsboat/cookies.txt")
datetime-format (parameters: <date/time format>; default value: %b %d) This format specifies the date/time format in the article list. For a detailed documentation on most of the allowed formats, consult the manpage of strftime(3). %L is a custom format not available in strftime which lists the days since the article was published (e.g. "2 days ago"). (example: datetime-format "%D, %R")
define-filter (parameters: <name> <filterexpr>; default value: n/a) With this command, you can predefine filters, which you can later select from a list, and which are then applied after selection. This is especially useful for filters that you need often and you don’t want to enter them every time you need them. (example: define-filter "all feeds with 'fun' tag" "tags # \"fun\"")
delete-read-articles-on-quit (parameters: [yes/no]; default value: no) If set to yes, all read articles will be deleted when quiting Newsboat. This option only applies if cleanup-on-quit is set to yes or if the --cleanup argument is passed. (example: delete-read-articles-on-quit yes)
dialogs-title-format (parameters: <format>; default value: "%N %V - Dialogs" (localized)) Format of the title in dialog list. See "Format Strings" section of Newsboat manual for details on available formats. (example: dialogs-title-format "%N %V - Dialogs")
dirbrowser-title-format (parameters: <format>; default value: "%N %V - %?O?Open Directory&Save File? - %f" (localized)) Format of the title in directory browser. See "Format Strings" section of Newsboat manual for details on available formats. (example: dirbrowser-file-format "%?O?Open Directory&Save File? - %f")
display-article-progress (parameters: [yes/no]; default value: yes) If set to yes, then a read progress (in percent) is displayed in the article view. Otherwise, no read progress is displayed. (example: display-article-progress no)
download-full-page (parameters: [yes/no]; default value: no) If set to yes, then for all feed items with no content but with a link, the link is downloaded and the result used as content instead. This may significantly increase the download times of "empty" feeds. (example: download-full-page yes)
download-retries (parameters: <number>; default value: 1) How many times Newsboat shall try to successfully download a feed before giving up. This is an option to improve the success of downloads on slow and shaky connections such as via a TOR proxy. (example: download-retries 4)
download-timeout (parameters: <number>; default value: 30) The number of seconds Newsboat shall wait when downloading a feed before giving up. This is an option to improve the success of downloads on slow and shaky connections such as via a TOR proxy. (example: download-timeout 60)
error-log (parameters: <path>; default value: "") If set, then user errors (e.g. errors regarding defunct RSS feeds) will be logged to this file. (example: error-log "~/.newsboat/error.log")
external-url-viewer (parameters: <command>; default value: "") If set, then show-urls will pipe the current article to a specific external tool instead of using the internal URL viewer. This can be used to integrate tools such as urlview. (example: external-url-viewer "urlview")
feed-sort-order (parameters: <sortfield>[-<direction>]; default value: none) The <sortfield> specifies which feed property shall be used for sorting; currently available are: firsttag, title, articlecount, unreadarticlecount, lastupdated and none. The optional <direction> specifies the sort direction. asc specifies ascending sorting, desc specifies descending sorting. desc is the default. (example: feed-sort-order firsttag)
feedhq-flag-share (parameters: <flag>; default value: "") If set and FeedHQ support is used, then all articles that are flagged with the specified flag are being "shared" in FeedHQ so that people that follow you can see it. (example: feedhq-flag-share "a")
feedhq-flag-star (parameters: <flag>; default value: "") If set and FeedHQ support is used, then all articles that are flagged with the specified flag are being "starred" in FeedHQ and appear in the list of "Starred items". (example: feedhq-flag-star "b")
feedhq-login (parameters: <login>; default value: "") This variable sets your FeedHQ login for FeedHQ support. (example: feedhq-login "your-login")
feedhq-min-items (parameters: <number>; default value: 20) This variable sets the number of articles that are loaded from FeedHQ per feed. (example: feedhq-min-items 100)
feedhq-password (parameters: <password>; default value: "") This variable sets your FeedHQ password for FeedHQ support. Double quotes and backslashes within it should be escaped. (example: feedhq-password "here_goesAquote:\"")
feedhq-passwordfile (parameters: <path>; default value: "") A more secure alternative to the above, by storing your password elsewhere in your system. (example: feedhq-passwordfile "~/.newsboat/feedhq-pw.txt")
feedhq-passwordeval (parameters: <command>; default value: "") Another secure alternative, is providing your password from an external command that is evaluated during login. This can be used to read your password from a gpg encrypted file or your system keyring. (example: feedhq-passwordeval "gpg --decrypt ~/.newsboat/feedhq-password.gpg")
feedhq-show-special-feeds (parameters: [yes/no]; default value: yes) If set and FeedHQ support is used, then "special feeds" like "People you follow" (articles shared by people you follow), "Starred items" (your starred articles) and "Shared items" (your shared articles) appear in your subscription list. (example: feedhq-show-special-feeds "no")
feedhq-url (parameters: <url>; default value: "https://feedhq.org/") Configures the URL where your FeedHQ instance resides. (example: feedhq-url "https://feedhq.example.com/")
feedlist-format (parameters: <format>; default value: "%4i %n %11u %t") This variable defines the format of entries in the feed list. See the respective section in the documentation for more information on format strings. (example: feedlist-format " %n %4i - %11u -%> %t")
feedlist-title-format (parameters: <format>; default value: "%N %V - %?F?Feeds&Your feeds? (%u unread, %t total)%?F? matching filter '%F'&?%?T? - tag '%T'&?" (localized)) Format of the title in feed list. See "Format Strings" section of Newsboat manual for details on available formats. (example: feedlist-title-format "Feeds (%u unread, %t total)")
filebrowser-title-format (parameters: <format>; default value: "%N %V - %?O?Open File&Save File? - %f" (localized)) Format of the title in file browser. See "Format Strings" section of Newsboat manual for details on available formats. (example: filebrowser-title-format "%?O?Open File&Save File? - %f")
freshrss-flag-star (parameters: <flag>; default value: "") If set and FreshRSS support is used, then all articles that are flagged with the specified flag are being "starred" in FreshRSS and appear in the list of "Starred items". (example: freshrss-flag-star "b")
freshrss-login (parameters: <login>; default value: "") This variable sets your FreshRSS login for FreshRSS support. (example: freshrss-login "your-login")
freshrss-min-items (parameters: <number>; default value: 20) This variable sets the number of articles that are loaded from FreshRSS per feed. (example: freshrss-min-items 100)
freshrss-password (parameters: <password>; default value: "") This variable sets your FreshRSS password for FreshRSS support. Double quotes and backslashes within it should be escaped. (example: freshrss-password "here_goesAquote:\"")
freshrss-passwordfile (parameters: <path>; default value: "") A more secure alternative to the above, by storing your password elsewhere in your system. (example: freshrss-passwordfile "~/.newsboat/freshrss-pw.txt")
freshrss-passwordeval (parameters: <command>; default value: "") Another secure alternative, is providing your password from an external command that is evaluated during login. This can be used to read your password from a gpg encrypted file or your system keyring. (example: freshrss-passwordeval "gpg --decrypt ~/.newsboat/freshrss-password.gpg")
freshrss-show-special-feeds (parameters: [yes/no]; default value: yes) If set and FreshRSS support is used, then a "Starred items" feed (containing your starred/favourited articles) appears in your subscription list. (example: freshrss-show-special-feeds "no")
freshrss-url (parameters: <url>; default value: "") Configures the URL for the Google Reader API endpoint of your FreshRSS instance. (example: freshrss-url "https://freshrss.example.com/api/greader.php")
goto-first-unread (parameters: [yes/no]; default value: yes) If set to yes, then the first unread article will be selected whenever a feed is entered. (example: goto-first-unread no)
goto-next-feed (parameters: [yes/no]; default value: yes) If set to yes, then the next-unread, prev-unread and random-unread keys will search in other feeds for unread articles if all articles in the current feed are read. If set to no, then these keys will stop in the current feed. (example: goto-next-feed no)
help-title-format (parameters: <format>; default value: "%N %V - Help" (localized)) Format of the title in help window. See "Format Strings" section of Newsboat manual for details on available formats. (example: help-title-format "%N %V - Help")
highlight (parameters: <target> <regex> <fgcolor> [<bgcolor> [<attribute> ...]]; default value: n/a) With this command, you can highlight text parts in the feed list, the article list and the article view. For a detailed documentation, see the chapter on highlighting. (example: highlight all "newsboat" red)
highlight-article (parameters: <filterexpr> <fgcolor> <bgcolor> [<attribute> ...]; default value: n/a) With this command, you can highlight articles in the article list if they match a filter expression. For a detailed documentation, see the chapter on highlighting. (example: highlight-article "author =~ \"Andreas Krennmair\"" white red bold)
highlight-feed (parameters: <filterexpr> <fgcolor> <bgcolor> [<attribute> ...]; default value: n/a) With this command, you can highlight feeds in the feed list if they match a filter expression. For a detailed documentation, see the chapter on highlighting. (example: highlight-feed "unread > 100" white red bold)
history-limit (parameters: <number>; default value: 100) Defines the maximum number of entries of commandline resp. search history to be saved. To disable history saving, set it to 0. (example: history-limit 0)
html-renderer (parameters: <command>; default value: internal) If set to internal, then the internal HTML renderer will be used. Otherwise, the specified command will be executed, the HTML to be rendered will be written to the command’s stdin, and the program’s output will be displayed. This makes it possible to use other, external programs, such as w3m, links or lynx, to render HTML. (example: html-renderer "w3m -dump -T text/html")
http-auth-method (parameters: <method>; default value: any) Set HTTP authentication method. Allowed values: any, basic, digest, digest_ie (only available with libcurl 7.19.3 and newer), gssnegotiate, ntlm and anysafe. (example: http-auth-method digest)
ignore-article (parameters: <feed> <filterexpr>; default value: n/a) If a downloaded article from <feed> matches <filterexpr>, then it is ignored and not presented to the user. This command is further explained in the "kill file" section below. (example: ignore-article "*" "title =~ \"Windows\"")
ignore-mode (parameters: [download/display]; default value: download) This configuration option defines in what way an article is ignored (see ignore-article). If set to download, then it is ignored in the download/parsing phase and thus never written to the cache, if it set to display, it is ignored when displaying articles but is kept in the cache. (example: ignore-mode "display")
include (parameters: <path>; default value: n/a) With this command, you can include other files to be interpreted as configuration files. This is especially useful to separate your configuration into several files, e.g. key configuration, color configuration, ... (example: include "~/.newsboat/colors")
itemview-title-format (parameters: <format>; default value: "%N %V - Article '%T' (%u unread, %t total)" (localized)) Format of the title in article view. See "Format Strings" section of Newsboat manual for details on available formats. (example: itemview-title-format "Article '%T'")
inoreader-app-id (parameters: <string>; default value: "") Unique application ID issued by Inoreader. See "Inoreader" section. (example: inoreader-app-id "123456789")
inoreader-app-key (parameters: <string>; default value: "") Application key issued by Inoreader. See "Inoreader" section. (example: inoreader-app-key "TmV3c2JvYXQgcm9ja3MgOikK")
inoreader-flag-share (parameters: <flag>; default value: "") If set and Inoreader support is used, then all articles that are flagged with the specified flag are being "shared" in Inoreader so that people that follow you can see it. (example: inoreader-flag-share "a")
inoreader-flag-star (parameters: <flag>; default value: "") If set and Inoreader support is used, then all articles that are flagged with the specified flag are being "starred" in Inoreader and appear in the list of "Starred items". (example: inoreader-flag-star "b")
inoreader-login (parameters: <login>; default value: "") This variable sets your Inoreader login for Inoreader support. (example: inoreader-login "your-login")
inoreader-min-items (parameters: <number>; default value: 20) This variable sets the number of articles that are loaded from Inoreader per feed. (example: inoreader-min-items 100)
inoreader-password (parameters: <password>; default value: "") This variable sets your Inoreader password for Inoreader support. Double quotes and backslashes within it should be escaped. (example: inoreader-password "here_goesAquote:\"")
inoreader-passwordfile (parameters: <path>; default value: "") A more secure alternative to the above, by storing your password elsewhere in your system. (example: inoreader-passwordfile "~/.newsboat/inoreader-pw.txt")
inoreader-passwordeval (parameters: <command>; default value: "") Another secure alternative, is providing your password from an external command that is evaluated during login. This can be used to read your password from a gpg encrypted file or your system keyring. (example: inoreader-passwordeval "gpg --decrypt ~/.newsboat/inoreader-password.gpg")
inoreader-show-special-feeds (parameters: [yes/no]; default value: yes) If set and Inoreader support is used, then "special feeds" like "Starred items" (your starred articles) and "Shared items" (your shared articles) appear in your subscription list. (example: inoreader-show-special-feeds "no")
keep-articles-days (parameters: <number>; default value: 0) If set to a number greater than 0, only articles that were published within the last <number> days are kept, and older articles are deleted. If set to 0, this option is not active. Note that changing this setting won’t bring back the articles that were deleted earlier; currently, there’s no non-hacky way to bring back deleted articles. (example: keep-articles-days 30)
macro (parameters: <macro key> <command list> [-- "<macro description>"]; default value: n/a) With this command, you can define a macro key and specify a list of commands that shall be executed when the macro prefix and the macro key are pressed. Optionally, a description can be added. If present, the description is shown in the help form. (example: macro k open; reload; quit -- "enter feed to reload it")
mark-as-read-on-hover (parameters: [yes/no]; default value: no) If set to yes, then all articles that get selected in the article list are marked as read. (example: mark-as-read-on-hover yes)
max-download-speed (parameters: <number>; default value: 0) If set to a number greater than 0, the download speed per download is set to that limit (in KB/s). (example: max-download-speed 50)
max-browser-tabs (parameters: <number>; default value: 10) Set the maximum number of articles to open in a browser when using the open-all-unread-in-browser or open-all-unread-in-browser-and-mark-read commands. (example: max-browser-tabs 4)
max-items (parameters: <number>; default value: 0) Set the number of articles to maximally keep per feed. If the number is set to 0, then all articles are kept. (example: max-items 100)
miniflux-login (parameters: <username>; default value: "") Sets the username for use with Miniflux. (example: miniflux-login "admin")
miniflux-password (parameters: <password>; default value: "") Configures the password for use with Miniflux. Double quotes and backslashes within it should be escaped. (example: miniflux-password "here_goesAquote:\"")
miniflux-passwordfile (parameters: <path>; default value: "") A more secure alternative to the above, by storing your password elsewhere in your system. (example: miniflux-passwordfile "~/.newsboat/miniflux-pw.txt")
miniflux-passwordeval (parameters: <command>; default value: "") Another secure alternative, is providing your password from an external command that is evaluated during login. This can be used to read your password from a gpg encrypted file or your system keyring. (example: miniflux-passwordeval "gpg --decrypt ~/.newsboat/miniflux-password.gpg")
miniflux-url (parameters: <url>; default value: "") Configures the URL where the Miniflux installation you want to use resides. (example: miniflux-url "https://example.com/miniflux/")
newsblur-login (parameters: <login>; default value: "") This variable sets your NewsBlur login for NewsBlur support. (example: newsblur-login "your-login")
newsblur-min-items (parameters: <number>; default value: 20) This variable sets the number of articles that are loaded from NewsBlur per feed. (example: newsblur-min-items 100)
newsblur-password (parameters: <password>; default value: "") This variable sets your NewsBlur password for NewsBlur support. Double quotes and backslashes within it should be escaped. (example: newsblur-password "here_goesAquote:\"")
newsblur-passwordfile (parameters: <path>; default value: "") A more secure alternative to the above, by storing your password elsewhere in your system. (example: newsblur-passwordfile "~/.newsboat/newsblur-pw.txt")
newsblur-passwordeval (parameters: <command>; default value: "") Another secure alternative, is providing your password from an external command that is evaluated during login. This can be used to read your password from a gpg encrypted file or your system keyring. (example: newsblur-passwordeval "gpg --decrypt ~/.newsboat/newsblur-password.gpg")
newsblur-url (parameters: <url>; default value: "https://newsblur.com") Configures the URL where the NewsBlur instance resides. (example: newsblur-url "https://localhost")
notify-always (parameters: [yes/no]; default value: no) If set to no, notifications will only be made when there are new feeds or articles. If set to yes, notifications will be made regardless. (example: notify-always yes)
notify-beep (parameters: [yes/no]; default value: no) If set to yes, then the speaker will beep on new articles. (example: notify-beep yes)
notify-format (parameters: <string>; default value: "Newsboat: finished reload, %f unread feeds (%n unread articles total)" (localized)) Format string that is used for formatting notifications. See the chapter on format strings for more information. (example: notify-format "%d new articles (%n unread articles, %f unread feeds)")
notify-program (parameters: <command>; default value: "") If set, then the configured program will be executed if new articles arrived (through a reload) or if notify-always is yes. The first parameter of the called program contains the notification message. In order to pass other hard-coded arguments to the program, write an appropriate wrapper shell script and use it as <command> instead. (example: notify-program "~/bin/my-notifier")
notify-screen (parameters: [yes/no]; default value: no) If set to yes, then a "privacy message" will be sent to the terminal, containing a notification message about new articles. This is especially useful if you use terminal emulations such as GNU screen which implement privacy messages. (example: notify-screen yes)
notify-xterm (parameters: [yes/no]; default value: no) If set to yes, then the xterm window title will be set to a notification message about new articles. (example: notify-xterm yes)
ocnews-flag-star (parameters: <character>; default value: "") If set and ownCloud News support is used, then all articles that are flagged with the specified flag are being "starred" in ownCloud News. (example: ocnews-flag-star "s")
ocnews-login (parameters: <username>; default value: "") Sets the username to use with the ownCloud instance. (example: ocnews-login "user")
ocnews-password (parameters: <password>; default value: "") Configures the password to use with the ownCloud instance. Double quotes and backslashes within it should be escaped. (example: ocnews-password "here_goesAquote:\"")
ocnews-passwordfile (parameters: <path>; default value: "") A more secure alternative to the above, by storing your password elsewhere in your system. (example: ocnews-passwordfile "~/.newsboat/ocnews-pw.txt")
ocnews-passwordeval (parameters: <command>; default value: "") Another secure alternative, is providing your password from an external command that is evaluated during login. This can be used to read your password from a gpg encrypted file or your system keyring. (example: ocnews-passwordeval "gpg --decrypt ~/.newsboat/ocnews-password.gpg")
ocnews-url (parameters: <url>; default value: "") Configures the URL where the ownCloud instance resides. (example: ocnews-url "https://localhost/owncloud")
oldreader-flag-share (parameters: <flag>; default value: "") If set and The Old Reader support is used, then all articles that are flagged with the specified flag are being "shared" in The Old Reader so that people that follow you can see it. (example: oldreader-flag-share "a")
oldreader-flag-star (parameters: <flag>; default value: "") If set and The Old Reader support is used, then all articles that are flagged with the specified flag are being "starred" in The Old Reader and appear in the list of "Starred items". (example: oldreader-flag-star "b")
oldreader-login (parameters: <login>; default value: "") This variable sets your The Old Reader login for The Older Reader support. (example: oldreader-login "your-login")
oldreader-min-items (parameters: <number>; default value: 20) This variable sets the number of articles that are loaded from The Old Reader per feed. (example: oldreader-min-items 100)
oldreader-password (parameters: <password>; default value: "") This variable sets your The Old Reader password for The Old Reader support. Double quotes and backslashes within it should be escaped. (example: oldreader-password "here_goesAquote:\"")
oldreader-passwordfile (parameters: <path>; default value: "") A more secure alternative to the above, by storing your password elsewhere in your system. (example: oldreader-passwordfile "~/.newsboat/oldreader-pw.txt")
oldreader-passwordeval (parameters: <command>; default value: "") Another secure alternative, is providing your password from an external command that is evaluated during login. This can be used to read your password from a gpg encrypted file or your system keyring. (example: oldreader-passwordeval "gpg --decrypt ~/.newsboat/oldreader-password.gpg")
oldreader-show-special-feeds (parameters: [yes/no]; default value: yes) If set and The Old reader support is used, then "special feeds" like "People you follow" (articles shared by people you follow), "Starred items" (your starred articles) and "Shared items" (your shared articles) appear in your subscription list. (example: oldreader-show-special-feeds "no")
openbrowser-and-mark-jumps-to-next-unread (parameters: [yes/no]; default value: no) If set to yes, jump to the next unread item when an item is opened in the browser and marked as read. (example: openbrowser-and-mark-jumps-to-next-unread yes)
opml-url (parameters: <url> ...; default value: "") If the OPML online subscription mode is enabled, then the list of feeds will be taken from the OPML file found on this location. Optionally, you can specify more than one URL. All the listed OPML URLs will then be taken into account when loading the feed list. (example: opml-url "https://host.domain.tld/blogroll.opml" "https://example.com/anotheropmlfile.opml")
pager (parameters: [<command>/internal]; default value: internal) If set to internal, then the internal pager will be used. Otherwise, the article to be displayed will be rendered to be a temporary file and then displayed with the configured pager. If the command is set to an empty string, the content of the PAGER environment variable will be used. If the command contains a placeholder %f, it will be replaced with the temporary filename. (example: pager "less %f")
podcast-auto-enqueue (parameters: [yes/no]; default value: no) If set to yes, then all podcast URLs that are found in articles are added to the podcast download queue. See the respective section in the documentation for more information on podcast support in Newsboat. (example: podcast-auto-enqueue yes)
prepopulate-query-feeds (parameters: [yes/no]; default value: no) If set to yes, then all query feeds are prepopulated with articles on startup. (example: prepopulate-query-feeds yes)
ssl-verifyhost (parameters: [yes/no]; default value: yes) If set to no, skip verification of the certificate’s name against host. (example: ssl-verifyhost no)
ssl-verifypeer (parameters: [yes/no]; default value: yes) If set to no, skip verification of the peer’s SSL certificate. (example: ssl-verifypeer no)
proxy-auth-method (parameters: <method>; default value: any) Set proxy authentication method. Allowed values: any, basic, digest, digest_ie (only available with libcurl 7.19.3 and newer), gssnegotiate, ntlm and anysafe. (example: proxy-auth-method ntlm)
proxy-auth (parameters: <auth>; default value: n/a) Set the proxy authentication string. (example: proxy-auth user:password)
proxy-type (parameters: <type>; default value: http) Set proxy type. Allowed values: http, socks4, socks4a, socks5 and socks5h. (example: proxy-type socks5)
proxy (parameters: <server:port>; default value: n/a) Set the proxy to use for downloading RSS feeds. (Don’t forget to actually enable the proxy with use-proxy yes.) (example: proxy localhost:3128)
refresh-on-startup (parameters: [yes/no]; default value: no) If set to yes, then all feeds will be reloaded when Newsboat starts up. This is equivalent to the -r commandline option. (example: refresh-on-startup yes)
reload-only-visible-feeds (parameters: [yes/no]; default value: no) If set to yes, then manually reloading all feeds will only reload the currently visible feeds, e.g. if a filter or a tag is set. (example: reload-only-visible-feeds yes)
reload-threads (parameters: <number>; default value: 1) The number of parallel reload threads that shall be started when all feeds are reloaded. (example: reload-threads 3)
reload-time (parameters: <number>; default value: 60) The number of minutes between automatic reloads. (example: reload-time 120)
reset-unread-on-update (parameters: <url> [<url>...]; default value: n/a) Specifies one or more feed URLs for whose articles the unread flag will be reset if an article has been updated, i.e. its content has been changed. This is especially useful for RSS feeds where single articles are updated after publication, and you want to be notified of the updates. This option can be specified multiple times. (example: reset-unread-on-update "https://blog.fefe.de/rss.xml?html")
restrict-filename (parameters: [yes/no]; default value: yes) If set to no, Newsboat will not limit saved article filenames to ASCII characters. (example: restrict-filename no)
run-on-startup (parameters: <list of operations>; default value: n/a) Specifies one or more Newsboat operations, separated by semicolons, which are executed on Newsboat startup. (example: run-on-startup next-unread; open; random-unread; open)
save-path (parameters: <path-to-directory>; default value: ~/) The default path where articles shall be saved to. If an invalid path is specified, the current directory is used. (example: save-path "~/Saved Articles")
scrolloff (parameters: <number>; default value: 0) Keep the configured number of lines above and below the selected item in lists. Configure a high number to keep the selected item in the center of the screen. (example: scrolloff 5)
search-highlight-colors (parameters: <fgcolor> <bgcolor> [<attribute> ...]; default value: black yellow bold) This configuration command specifies the highlighting colors when searching for text from the article view. (example: search-highlight-colors white black bold)
searchresult-title-format (parameters: <format>; default value: "%N %V - Search results (%u unread, %t total)%?F? matching filter '%F'&?" (localized)) Format of the title in search result. See "Format Strings" section of Newsboat manual for details on available formats. (example: searchresult-title-format "Search result")
selectfilter-title-format (parameters: <format>; default value: "%N %V - Select Filter" (localized)) Format of the title in filter selection dialog. See "Format Strings" section of Newsboat manual for details on available formats. (example: selectfilter-title-format "Select Filter")
selecttag-format (parameters: <format>; default value: "%4i  %T (%u)") Format of the lines in "Select tag" dialog. See the respective section in the documentation for more information on format strings. (example: selecttag-format "[%2i] %T (%n unread articles in %f feeds, %u feeds total)")
selecttag-title-format (parameters: <format>; default value: "%N %V - Select Tag" (localized)) Format of the title in tag selection dialog. See "Format Strings" section of Newsboat manual for details on available formats. (example: selecttag-title-format "Select Tag")
show-keymap-hint (parameters: [yes/no]; default value: yes) If set to no, then the keymap hints will not be displayed. (The keymap hints are usually at the bottom of the screen, but see swap-title-and-hints setting.) (example: show-keymap-hint no)
show-title-bar (parameters: [yes/no]; default value: yes) If set to no, then the title bar will not be displayed. (The title bar is usually at the top of the screen, but see swap-title-and-hints setting.) (example: show-title-bar no)
show-read-articles (parameters: [yes/no]; default value: yes) If set to yes, then all articles of a feed are listed in the article list. If set to no, then only unread articles are listed. (example: show-read-articles no)
show-read-feeds (parameters: [yes/no]; default value: yes) If set to yes, then all feeds, including those without unread articles, are listed. If set to no, then only feeds with one or more unread articles are list. (example: show-read-feeds no)
suppress-first-reload (parameters: [yes/no]; default value: no) If set to yes, then the first automatic reload will be suppressed if auto-reload is set to yes. (example: suppress-first-reload yes)
swap-title-and-hints (parameters: [yes/no]; default value: no) If set to yes, then the title (which is usually at the top of the screen) and the keymap hints (usually at the bottom) will exchange places. These bars can be hidden entirely, via the show-keymap-hints and show-title-bar settings. (example: swap-title-and-hints yes)
text-width (parameters: <number>; default value: 0) If set to a number greater than 0, all HTML will be rendered to this maximum line length or the terminal width (whichever is smaller). If set to 0, the terminal width will always be used in the article view, while pipe-to, save, and save-all will wrap at 80 columns instead. Does not apply when using external renderer or viewing the source. Also note that "Link" header and "Links" section won’t be affected by it—they contain URLs which are better not wrapped. (example: text-width 72)
toggleitemread-jumps-to-next-unread (parameters: [yes/no]; default value: no) If set to yes, jump to the next unread item when an item’s read status is toggled in the article list. (example: toggleitemread-jumps-to-next-unread yes)
ttrss-flag-publish (parameters: <character>; default value: "") If set and Tiny Tiny RSS support is used, then all articles that are flagged with the specified flag are being marked as "published" in Tiny Tiny RSS. (example: ttrss-flag-publish "b")
ttrss-flag-star (parameters: <character>; default value: "") If set and Tiny Tiny RSS support is used, then all articles that are flagged with the specified flag are being "starred" in Tiny Tiny RSS. (example: ttrss-flag-star "a")
ttrss-login (parameters: <username>; default value: "") Sets the username for use with Tiny Tiny RSS. (example: ttrss-login "admin")
ttrss-mode (parameters: [multi/single]; default value: multi) Configures the mode in which Tiny Tiny RSS is used. In single-user mode, login and password are used for HTTP authentication, while in multi-user mode, they are used for authenticating with Tiny Tiny RSS. (example: ttrss-mode "single")
ttrss-password (parameters: <password>; default value: "") Configures the password for use with Tiny Tiny RSS. Double quotes and backslashes within it should be escaped. (example: ttrss-password "here_goesAquote:\"")
ttrss-passwordfile (parameters: <path>; default value: "") A more secure alternative to the above, by storing your password elsewhere in your system. (example: ttrss-passwordfile "~/.newsboat/ttrss-pw.txt")
ttrss-passwordeval (parameters: <command>; default value: "") Another secure alternative, is providing your password from an external command that is evaluated during login. This can be used to read your password from a gpg encrypted file or your system keyring. (example: ttrss-passwordeval "gpg --decrypt ~/.newsboat/ttrss-password.gpg")
ttrss-url (parameters: <url>; default value: "") Configures the URL where the Tiny Tiny RSS installation you want to use resides. (example: ttrss-url "https://example.com/ttrss/")
unbind-key (parameters: <key> [<dialog>]; default value: n/a) Unbind key <key>. This means that no operation is called when <key> is pressed. If you provide "-a" as <key>, all currently bound keys will become unbound. Optionally, you can specify a dialog (for a list of available dialogs, see bind-key above). If you specify one, the key binding will only be unbound for the specified dialog. (example: unbind-key R)
urls-source (parameters: <source>; default value: "local") This configuration command sets the source where URLs shall be retrieved from. By default, this is the urls file. Alternatively, you can set it to opml, which enables Newsboat’s OPML online subscription mode, to ttrss which enables Newsboat’s Tiny Tiny RSS support, to oldreader, which enables Newsboat’s The Old Reader support, to newsblur, which enables NewsBlur support, to feedhq for FeedHQ support, to freshrss for FreshRSS support, to ocnews for ownCloud News support, to inoreader for Inoreader support, or to miniflux for Miniflux support. Query feed specifications will be read from the local urls file regardless of this setting. (example: urls-source "oldreader")
urlview-title-format (parameters: <format>; default value: "%N %V - URLs" (localized)) Format of the title in URL view. See "Format Strings" section of Newsboat manual for details on available formats. (example: urlview-title-format "URLs")
use-proxy (parameters: [yes/no]; default value: no) If set to yes, then the configured proxy will be used for downloading the RSS feeds. (example: use-proxy yes)
user-agent (parameters: <string>; default value: "") If set to a non-zero-length string, this value will be used as HTTP User-Agent header for all HTTP requests. (example: user-agent "Lynx/2.8.5rel.1 libwww-FM/2.14")
wrap-scroll (parameters: [yes/no]; default value: no) If set to yes, moving down while on the last item in a list will wrap around to the top and vice versa. (example: wrap-scroll yes)
open (default key: ENTER) Open the currently selected feed or article.
quit (default key: q) Quit the program or return to the previous dialog (depending on the context).
hard-quit (default key: Q) Quit the program without confirmation.
reload (default key: r) Reload the currently selected feed.
reload-all (default key: R) Reload all feeds.
mark-feed-read (default key: A) Mark all articles in the currently selected feed read.
mark-all-feeds-read (default key: C) Mark articles in all feeds read.
mark-all-above-as-read (default key: n/a) Mark all above as read.
save (default key: s) Export the currently selected article to a plain text file, word-wrapped according to the text-width setting.
save-all (default key: n/a) Export all articles from the currently selected feed to plain text files, word-wrapped according to the text-width setting.
next-unread (default key: n) Jump to the next unread article.
prev-unread (default key: p) Jump to the previous unread article.
next (default key: J) Jump to next list entry.
prev (default key: K) Jump to previous list entry.
random-unread (default key: ^K) Jump to a random unread article.
open-in-browser (default key: o) Use browser to open the URL associated with the current article, feed, or entry in the URL view.
open-in-browser-noninteractively (default key: o) Use browser to open the URL associated with the current article, feed, or entry in the URL view. This operation works similar to open-in-browser, but the output of the browser (stdout and stderr) is not shown, and the browser doesn’t receive keyboard input. You would probably add & at the end of the browser command to put it into background, too.
open-in-browser-and-mark-read (default key: O) Use browser to open the URL associated with the current article, or entry in the URL view. When used in the article list, it will also mark the article as read.
open-all-unread-in-browser (default key: n/a) Open all the unread URLs in the current feed.
open-all-unread-in-browser-and-mark-read (default key: n/a) Open all the unread URLs in the current feed and mark them as read.
help (default key: ?) Run the help screen.
toggle-source-view (default key: ^U) Toggle between the HTML view and the source view in the article view.
toggle-article-read (default key: N) Toggle the read flag for the currently selected article, and clear the delete flag if set.
toggle-show-read-feeds (default key: l) Toggle whether read feeds should be shown in the feed list.
show-urls (default key: u) Show all URLs in the article in a list (similar to urlview).
clear-tag (default key: ^T) Clear current tag.
set-tag (default key: t) Select tag.
open-search (default key: /) Open the search dialog. When a search is done in the article list, then the search operation only applies to the articles of the current feed, otherwise to all articles.
goto-url (default key: #) Open the URL dialog and then open a specified URL in the browser.
one (default key: 1) Open URL 1 in the browser.
two (default key: 2) Open URL 2 in the browser.
three (default key: 3) Open URL 3 in the browser.
four (default key: 4) Open URL 4 in the browser.
five (default key: 5) Open URL 5 in the browser.
six (default key: 6) Open URL 6 in the browser.
seven (default key: 7) Open URL 7 in the browser.
eight (default key: 8) Open URL 8 in the browser.
nine (default key: 9) Open URL 9 in the browser.
zero (default key: 0) Open URL 10 in the browser.