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