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