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 Mac OS X.
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 -v, -V, --version
37 Get version information about newsboat and the libraries it uses
38 -i opmlfile, --import-from-opml=opmlfile
40 Import an OPML file
41 -u urlfile, --url-file=urlfile
43 Use an alternative URL file
44 -c cachefile, --cache-file=cachefile
46 Use an alternative cache file
47 -C configfile, --config-file=configfile
49 Use an alternative configuration file
50 -x command ..., --execute=command...
52 Execute one or more commands to run newsboat unattended. Currently
53 available commands are "reload" and "print-unread".
54 -l loglevel, --log-level=loglevel
56 Generate a logfile with a certain loglevel. Valid loglevels are 1
57 to 6. An actual logfile will only be written when you provide a
58 logfile name.
59 -d logfile, --log-file=logfile
61 Use this logfile as output when logging debug messages. Please note
62 that this only works when providing a loglevel.
63 -E file, --export-to-file=file
65 Export a list of read articles (resp. their GUIDs). This can be
66 used to transfer information about read articles between different
67 computers.
68 -I file, --import-from-file=file
70 Import a list of read articles and mark them as read if they are
71 held in the cache. This is to be used in conjunction with the -E
72 commandline parameter.
73
75 After you’ve installed newsboat, you can run it for the first time by
76 typing newsboat on your command prompt. This will bring you the
77 following message:
78 Error: no URLs configured. Please fill the file /home/ak/.newsboat/urls with RSS feed URLs or import an OPML file.
80 newsboat 2.10
82 usage: ./newsboat [-i <file>|-e] [-u <urlfile>] [-c <cachefile>] [-x <command> ...] [-h]
83 -e, --export-to-opml export OPML feed to stdout
84 -r, --refresh-on-start refresh feeds on start
85 -i, --import-from-opml=<file> import OPML file
86 -u, --url-file=<urlfile> read RSS feed URLs from <urlfile>
87 -c, --cache-file=<cachefile> use <cachefile> as cache file
88 -C, --config-file=<configfile> read configuration from <configfile>
89 -X, --vacuum compact the cache
90 -x, --execute=<command>... execute list of commands
91 -q, --quiet quiet startup
92 -v, --version get version information
93 -l, --log-level=<loglevel> write a log with a certain loglevel (valid values: 1 to 6)
94 -d, --log-file=<logfile> use <logfile> as output log file
95 -E, --export-to-file=<file> export list of read articles to <file>
96 -I, --import-from-file=<file> import list of read articles from <file>
97 -h, --help this help
98 This means that newsboat can’t start without any configured feeds. To
100 add feeds to newsboat, you can either add URLs to the configuration
101 file $HOME/.newsboat/urls or you can import an OPML file by running
102 newsboat -i blogroll.opml. To manually add URLs, open the file with
103 your favorite text editor and add the URLs, one per line:
104 http://rss.cnn.com/rss/cnn_topstories.rss
106 http://newsrss.bbc.co.uk/rss/newsonline_world_edition/front_page/rss.xml
107 If you need to add URLs that have restricted access via
109 username/password, simply provide the username/password in the
110 following way:
111 http://username:password@hostname.domain.tld/feed.rss
113 In order to protect username and password, make sure that
115 $HOME/.newsboat/urls is only readable by you and, optionally, your
116 group:
117 $ chmod u=rw,g=r,o= ~/.newsboat/urls
119 Newsboat also makes sure that usernames and passwords within URLs
121 aren’t displayed in its user interface. In case there is a @ in the
122 username, you need to write it as %40 instead so that it can be
123 distinguished from the @ that separates the username/password part from
124 the hostname part.
125 You can also configure local files as feeds, by prefixing the local
127 path with file:// and adding it to the $HOME/.newsboat/urls file:
128 file:///var/log/rss_eventlog.xml
130 Now you can run newsboat again, and it will present you with a
132 controllable list of the URLs that you configured previously. You can
133 now start downloading the feeds, either by pressing "R" to download all
134 feeds, or by pressing "r" to download the currently selected feed. You
135 can then select a feed you want to read, and by pressing "Enter", you
136 can go to the article list for this feed. This works even while the
137 downloading is still in progress.
138 You can now see the list of available articles by their title. A "N" on
140 the left indicates that an article wasn’t read yet. Pressing "Enter"
141 brings you to the content of the article. You can scroll through this
142 text, and also run a browser (default: lynx) to view the complete
143 article if the content is empty or just an abstract or a short
144 description. Each URL in the article has a number next to it; to open
145 it, type # and then the number, then press "Enter". For single-digit
146 links, like 3, you can just press that number on the keyboard.
147 Pressing "q" brings you back to the article list, and pressing "q"
149 again brings you back to the feed list. Pressing "q" a third time then
150 closes newsboat.
151 Newsboat caches the article that it downloads. This means that when you
153 start newsboat again and reload a feed, the old articles can still be
154 read even if they aren’t in the current RSS feeds anymore. Optionally
155 you can configure how many articles shall be preserved by feed so that
156 the article backlog doesn’t grow endlessly (see max-items below).
157 Newsboat also uses a number of measures to preserve the users' and feed
159 providers' bandwidth, by trying to avoid unnecessary feed downloads
160 through the use of conditional HTTP downloading. It saves every feed’s
161 "Last-Modified" and "ETag" response header values (if present) and
162 advises the feed’s HTTP server to only send data if the feed has been
163 updated by modification date/time or "ETag" header. This doesn’t only
164 make feed downloads for RSS feeds with no new updates faster, it also
165 reduces the amount of transferred data per request. Conditional HTTP
166 downloading can be optionally disabled per feed by using the
167 always-download configuration command.
168 Several aspects of newsboat’s behaviour can be configured via a
170 configuration file, by default $HOME/.newsboat/config. This
171 configuration file contains lines in the form <config-command> <arg1>
172 .... The configuration file can also contain comments, which start with
173 the # character and go as far as the end of line. If you need to enter
174 a configuration argument that contains spaces, use quotes (") around
175 the whole argument. It’s even possible to integrate the output of
176 external commands into the configuration. The text between two
177 backticks (`) is evaluated as shell command, and its output is put on
178 its place instead. This works like backtick evaluation in
179 Bourne-compatible shells and allows users to use external information
180 from the system within the configuration. Backticks can be escaped with
181 a backslash (\`); in that case, they’ll be replaced with a literal
182 backtick in the configuration.
183 Searching for articles is possible in newsboat, too. Just press the "/"
185 key, enter your search phrase, and the title and content of all
186 articles are searched for it. When you do a search from the list of
187 feeds, all articles of all feeds will be searched. When you do a search
188 from the article list of a feed, only the articles of the currently
189 viewed feed are searched. When opening an article from a search result
190 dialog, the search phrase is highlighted.
191 The history of all your searches is saved to the filesystem, to
193 ~/.newsboat/history.search. By default, the last 100 search phrases are
194 stored, but this limited can be influenced through the history-limit
195 configuration variable. To disable search history saving, simply set
196 the history-limit to 0.
197
199 always-display-description (parameters: [yes/no]; default value: no)
200 If set to yes, then the description will always be displayed even
201 if e.g. a <content:encoded> tag has been found. (example:
202 always-display-description yes)
203 always-download (parameters: <url> [<url>]; default value: n/a)
205 The parameters of this configuration command are one or more RSS
206 URLs. These URLs will always get downloaded, regardless of their
207 Last-Modified timestamp and ETag header. (example: always-download
208 "http://www.n-tv.de/23.rss")
209 article-sort-order (parameters: <sortfield>[-<direction>]; default
211 value: date)
212 The <sortfield> specifies which article property shall be used for
213 sorting, currently available are: date, title, flags, author, link,
214 guid and random. The optional <direction> specifies the sort
215 direction. asc specifies ascending sorting, desc specifies
216 descending sorting. Note that direction does not affect random sort
217 order. For date, desc is default, for all others, asc is default.
218 (example: article-sort-order author-desc)
219 articlelist-format (parameters: <format>; default value: "%4i %f %D %6L
221 %?T?|%-17T| ?%t")
222 This variable defines the format of entries in the article list.
223 See the respective section in the documentation for more
224 information on format strings. (example: articlelist-format "%4i %f
225 %D %?T?|%-17T| ?%t")
226 articlelist-title-format (parameters: <format>; default value: "%N %V -
228 Articles in feed '%T (%u unread, %t total) - %U"')
229 Format of the title in article list. See "Format Strings" section
230 of Newsboat manual for details on available formats. (example:
231 articlelist-title-format "Articles in feed %T (%u unread)")
232 auto-reload (parameters: [yes/no]; default value: no)
234 If set to yes, all feeds will be automatically reloaded at start up
235 and then continuously after a certain time has passed (see
236 reload-time). (example: auto-reload yes)
237 bind-key (parameters: <key> <operation> [<dialog>]; default value: n/a)
239 Bind key <key> to <operation>. This means that whenever <key> is
240 pressed, then <operation> is executed (if applicable in the current
241 dialog). A list of available operations can be found below.
242 Optionally, you can specify a dialog. If you specify one, the key
243 binding will only be added to the specified dialog. Available
244 dialogs are all (default if none is specified), feedlist,
245 filebrowser, help, articlelist, article, tagselection,
246 filterselection, urlview and podbeuter. (example: bind-key ^R
247 reload-all)
248 bookmark-autopilot (parameters: [yes/no]; default value: no)
250 If set to yes, the configured bookmark command is executed without
251 any further input asked from user, unless the url or the title
252 cannot be found/guessed. (example: bookmark-autopilot yes)
253 bookmark-cmd (parameters: <command>; default value: "")
255 If set, then <command> will be used as bookmarking plugin. See the
256 documentation on bookmarking for further information. (example:
257 bookmark-cmd "~/bin/delicious-bookmark.sh")
258 bookmark-interactive (parameters: [yes/no]; default value: no)
260 If set to yes, then the configured bookmark command is an
261 interactive program. (example: bookmark-interactive yes)
262 browser (parameters: <command>; default value: %BROWSER, otherwise
264 lynx)
265 Set the browser command to use when opening an article in the
266 browser. If BROWSER environment variable is set, it will be used as
267 the default browser, otherwise lynx will be used. Any occurrences
268 of %u in <command> will be replaced by a URL in single quotes.
269 (example: browser "w3m %u")
270 cache-file (parameters: <path>; default value: "~/.newsboat/cache.db")
272 This configuration option sets the cache file. This is especially
273 useful if the filesystem of your home directory doesn’t support
274 proper locking (e.g. NFS). (example: cache-file
275 "/tmp/testcache.db")
276 cleanup-on-quit (parameters: [yes/no]; default value: yes)
278 If set to yes, then the cache gets locked and superfluous feeds and
279 items are removed, such as feeds that can’t be found in the urls
280 configuration file anymore. (example: cleanup-on-quit no)
281 color (parameters: <element> <fgcolor> <bgcolor> [<attribute> ...];
283 default value: n/a)
284 Set the foreground color, background color and optional attributes
285 for a certain element. (example: color background white black)
286 confirm-exit (parameters: [yes/no]; default value: no)
288 If set to yes, then newsboat will ask for confirmation whether the
289 user really wants to quit newsboat. (example: confirm-exit yes)
290 cookie-cache (parameters: <path>; default value: "")
292 Set a cookie cache. If set, then cookies will be cached (i.e. read
293 from and written to) in this file. (example: cookie-cache
294 "~/.newsboat/cookies.txt")
295 datetime-format (parameters: <date/time format>; default value: %b %d)
297 This format specifies the date/time format in the article list. For
298 a detailed documentation on the allowed formats, consult the
299 manpage of strftime(3). (example: datetime-format "%D, %R")
300 define-filter (parameters: <name> <filterexpr>; default value: n/a)
302 With this command, you can predefine filters, which you can later
303 select from a list, and which are then applied after selection.
304 This is especially useful for filters that you need often and you
305 don’t want to enter them every time you need them. (example:
306 define-filter "all feeds with fun tag" "tags # \"fun\"")
307 delete-read-articles-on-quit (parameters: [yes/no]; default value: no)
309 If set to yes, then all read articles will be deleted when you quit
310 newsboat. (example: delete-read-articles-on-quit yes)
311 dialogs-title-format (parameters: <format>; default value: "%N %V -
313 Dialogs")
314 Format of the title in dialog list. See "Format Strings" section of
315 Newsboat manual for details on available formats. (example:
316 dialogs-title-format "%N %V - Dialogs")
317 display-article-progress (parameters: [yes/no]; default value: yes)
319 If set to yes, then a read progress (in percent) is displayed in
320 the article view. Otherwise, no read progress is displayed.
321 (example: display-article-progress no)
322 download-full-page (parameters: [yes/no]; default value: no)
324 If set to yes, then for all feed items with no content but with a
325 link, the link is downloaded and the result used as content
326 instead. This may significantly increase the download times of
327 "empty" feeds. (example: download-full-page yes)
328 download-retries (parameters: <number>; default value: 1)
330 How many times newsboat shall try to successfully download a feed
331 before giving up. This is an option to improve the success of
332 downloads on slow and shaky connections such as via a TOR proxy.
333 (example: download-retries 4)
334 download-timeout (parameters: <number>; default value: 30)
336 The number of seconds newsboat shall wait when downloading a feed
337 before giving up. This is an option to improve the success of
338 downloads on slow and shaky connections such as via a TOR proxy.
339 (example: download-timeout 60)
340 error-log (parameters: <path>; default value: "")
342 If set, then user errors (e.g. errors regarding defunct RSS feeds)
343 will be logged to this file. (example: error-log
344 "~/.newsboat/error.log")
345 external-url-viewer (parameters: <command>; default value: "")
347 If set, then show-urls will pipe the current article to a specific
348 external tool instead of using the internal URL viewer. This can be
349 used to integrate tools such as urlview. (example:
350 external-url-viewer "urlview")
351 feed-sort-order (parameters: <sortorder>[-<direction>]; default value:
353 none)
354 The <sortfield> specifies which feed property shall be used for
355 sorting; currently available are: firsttag, title, articlecount,
356 unreadarticlecount, lastupdated and none. The optional <direction>
357 specifies the sort direction. asc specifies ascending sorting,
358 desc specifies descending sorting. desc is the default. (example:
359 feed-sort-order firsttag)
360 feedhq-flag-share (parameters: <flag>; default value: "")
362 If set and FeedHQ support is used, then all articles that are
363 flagged with the specified flag are being "shared" in FeedHQ so
364 that people that follow you can see it. (example: feedhq-flag-share
365 "a")
366 feedhq-flag-star (parameters: <flag>; default value: "")
368 If set and FeedHQ support is used, then all articles that are
369 flagged with the specified flag are being "starred" in FeedHQ and
370 appear in the list of "Starred items". (example: feedhq-flag-star
371 "b")
372 feedhq-login (parameters: <login>; default value: "")
374 This variable sets your FeedHQ login for FeedHQ support. (example:
375 feedhq-login "your-login")
376 feedhq-min-items (parameters: <number>; default value: 20)
378 This variable sets the number of articles that are loaded from
379 FeedHQ per feed. (example: feedhq-min-items 100)
380 feedhq-password (parameters: <password>; default value: "")
382 This variable sets your FeedHQ password for FeedHQ support. Double
383 quotes should be escaped, i.e. you should write \" instead of ".
384 (example: feedhq-password "here_goesAquote:\"")
385 feedhq-passwordfile (parameters: <path>; default value: "")
387 A more secure alternative to the above, by storing your password
388 elsewhere in your system. (example: feedhq-passwordfile
389 "~/.newsboat/feedhq-pw.txt")
390 feedhq-passwordeval (parameters: <command>; default value: "")
392 Another secure alternative, is providing your password from an
393 external command that is evaluated during login. This can be used
394 to read your password from a gpg encrypted file or your system
395 keyring. (example: feedhq-passwordeval "gpg --decrypt
396 ~/.newsboat/feedhq-password.gpg")
397 feedhq-show-special-feeds (parameters: [yes/no]; default value: yes)
399 If set and FeedHQ support is used, then "special feeds" like
400 "People you follow" (articles shared by people you follow),
401 "Starred items" (your starred articles) and "Shared items" (your
402 shared articles) appear in your subscription list. (example:
403 feedhq-show-special-feeds "no")
404 feedhq-url (parameters: <url>; default value: "https://feedhq.org/")
406 Configures the URL where your FeedHQ instance resides. (example:
407 feedhq-url "https://feedhq.example.com/")
408 feedlist-format (parameters: <format>; default value: "%4i %n %11u %t")
410 This variable defines the format of entries in the feed list. See
411 the respective section in the documentation for more information on
412 format strings. (example: feedlist-format " %n %4i - %11u -%> %t")
413 feedlist-title-format (parameters: <format>; default value: "N %V -
415 Your feeds (%u unread, %t total)%?T? - tag ‘%T&?"’)
416 Format of the title in feed list. See "Format Strings" section of
417 Newsboat manual for details on available formats. (example:
418 feedlist-title-format "Feeds (%u unread, %t total)")
419 filebrowser-title-format (parameters: <format>; default value: "%N %V -
421 %?O?Open File&Save File? - %f")
422 Format of the title in file browser. See "Format Strings" section
423 of Newsboat manual for details on available formats. (example:
424 filebrowser-title-format "%?O?Open File&Save File? - %f")
425 goto-first-unread (parameters: [yes/no]; default value: yes)
427 If set to yes, then the first unread article will be selected
428 whenever a feed is entered. (example: goto-first-unread no)
429 goto-next-feed (parameters: [yes/no]; default value: yes)
431 If set to yes, then the next-unread, prev-unread and random-unread
432 keys will search in other feeds for unread articles if all articles
433 in the current feed are read. If set to no, then these keys will
434 stop in the current feed. (example: goto-next-feed no)
435 help-title-format (parameters: <format>; default value: "%N %V - Help")
437 Format of the title in help window. See "Format Strings" section of
438 Newsboat manual for details on available formats. (example:
439 help-title-format "%N %V - Help")
440 highlight (parameters: <target> <regex> <fgcolor> [<bgcolor>
442 [<attribute> ...]]; default value: n/a)
443 With this command, you can highlight text parts in the feed list,
444 the article list and the article view. For a detailed
445 documentation, see the chapter on highlighting. (example: highlight
446 all "newsboat" red)
447 highlight-article (parameters: <filterexpr> <fgcolor> <bgcolor>
449 [<attribute> ...]; default value: n/a)
450 With this command, you can highlight articles in the article list
451 if they match a filter expression. For a detailed documentation,
452 see the chapter on highlighting. (example: highlight-article
453 "author =~ \"Andreas Krennmair\"" white red bold)
454 history-limit (parameters: <number>; default value: 100)
456 Defines the maximum number of entries of commandline resp. search
457 history to be saved. To disable history saving, set it to 0.
458 (example: history-limit 0)
459 html-renderer (parameters: <command>; default value: internal)
461 If set to internal, then the internal HTML renderer will be used.
462 Otherwise, the specified command will be executed, the HTML to be
463 rendered will be written to the command’s stdin, and the program’s
464 output will be displayed. This makes it possible to use other,
465 external programs, such as w3m, links or lynx, to render HTML.
466 (example: html-renderer "w3m -dump -T text/html")
467 http-auth-method (parameters: <method>; default value: any)
469 Set HTTP authentication method. Allowed values: any, basic, digest,
470 digest_ie (only available with libcurl 7.19.3 and newer),
471 gssnegotiate, ntlm and anysafe. (example: http-auth-method digest)
472 ignore-article (parameters: <feed> <filterexpr>; default value: n/a)
474 If a downloaded article from <feed> matches <filterexpr>, then it
475 is ignored and not presented to the user. This command is further
476 explained in the "kill file" section below. (example:
477 ignore-article "*" "title =~ \"Windows\"")
478 ignore-mode (parameters: [download/display]; default value: download)
480 This configuration option defines in what way an article is ignored
481 (see ignore-article). If set to download, then it is ignored in the
482 download/parsing phase and thus never written to the cache, if it
483 set to display, it is ignored when displaying articles but is kept
484 in the cache. (example: ignore-mode "display")
485 include (parameters: <path>; default value: n/a)
487 With this command, you can include other files to be interpreted as
488 configuration files. This is especially useful to separate your
489 configuration into several files, e.g. key configuration, color
490 configuration, ... (example: include "~/.newsboat/colors")
491 itemview-title-format (parameters: <format>; default value: "%N %V -
493 Article '%T (%u unread, %t total)"')
494 Format of the title in article view. See "Format Strings" section
495 of Newsboat manual for details on available formats. (example:
496 itemview-title-format "Article %T")
497 inoreader-flag-share (parameters: <flag>; default value: "")
499 If set and Inoreader support is used, then all articles that are
500 flagged with the specified flag are being "shared" in Inoreader so
501 that people that follow you can see it. (example:
502 inoreader-flag-share "a")
503 inoreader-flag-star (parameters: <flag>; default value: "")
505 If set and Inoreader support is used, then all articles that are
506 flagged with the specified flag are being "starred" in Inoreader
507 and appear in the list of "Starred items". (example:
508 inoreader-flag-star "b")
509 inoreader-login (parameters: <login>; default value: "")
511 This variable sets your Inoreader login for Inoreader support.
512 (example: inoreader-login "your-login")
513 inoreader-min-items (parameters: <number>; default value: 20)
515 This variable sets the number of articles that are loaded from
516 Inoreader per feed. (example: inoreader-min-items 100)
517 inoreader-password (parameters: <password>; default value: "")
519 This variable sets your Inoreader password for Inoreader support.
520 Double quotes should be escaped, i.e. you should write \" instead
521 of ". (example: inoreader-password "here_goesAquote:\"")
522 inoreader-passwordfile (parameters: <path>; default value: "")
524 A more secure alternative to the above, by storing your password
525 elsewhere in your system. (example: inoreader-passwordfile
526 "~/.newsboat/inoreader-pw.txt")
527 inoreader-passwordeval (parameters: <command>; default value: "")
529 Another secure alternative, is providing your password from an
530 external command that is evaluated during login. This can be used
531 to read your password from a gpg encrypted file or your system
532 keyring. (example: inoreader-passwordeval "gpg --decrypt
533 ~/.newsboat/inoreader-password.gpg")
534 inoreader-show-special-feeds (parameters: [yes/no]; default value: yes)
536 If set and Inoreader support is used, then "special feeds" like
537 "Starred items" (your starred articles) and "Shared items" (your
538 shared articles) appear in your subscription list. (example:
539 inoreader-show-special-feeds "no")
540 keep-articles-days (parameters: <number>; default value: 0)
542 If set to a number greater than 0, only articles that are were
543 published within the last <number> days are kept, and older
544 articles are deleted. If set to 0, this option is not active. Note
545 that changing this setting won’t bring back the articles that were
546 deleted earlier; currently, there’s no non-hacky way to bring back
547 deleted articles. (example: keep-articles-days 30)
548 macro (parameters: <macro key> <command list>; default value: n/a)
550 With this command, you can define a macro key and specify a list of
551 commands that shall be executed when the macro prefix and the macro
552 key are pressed. (example: macro k open ; reload ; quit)
553 mark-as-read-on-hover (parameters: [yes/no]; default value: no)
555 If set to yes, then all articles that get selected in the article
556 list are marked as read. (example: mark-as-read-on-hover yes)
557 max-download-speed (parameters: <number>; default value: 0)
559 If set to a number great than 0, the download speed per download is
560 set to that limit (in kB). (example: max-download-speed 50)
561 max-browser-tabs (parameters: <number>; default value: 10)
563 Set the maximum number of articles to open in a browser when using
564 the open-all-unread-in-browser or
565 open-all-unread-in-browser-and-mark-read commands. (example:
566 max-browser-tabs 4)
567 max-items (parameters: <number>; default value: 0)
569 Set the number of articles to maximally keep per feed. If the
570 number is set to 0, then all articles are kept. (example: max-items
571 100)
572 newsblur-login (parameters: <login>; default value: "")
574 This variable sets your NewsBlur login for NewsBlur support.
575 (example: newsblur-login "your-login")
576 newsblur-min-items (parameters: <number>; default value: 20)
578 This variable sets the number of articles that are loaded from
579 NewsBlur per feed. (example: newsblur-min-items 100)
580 newsblur-password (parameters: <password>; default value: "")
582 This variable sets your NewsBlur password for NewsBlur support.
583 Double quotes should be escaped, i.e. you should write \" instead
584 of ". (example: newsblur-password "here_goesAquote:\"")
585 newsblur-passwordfile (parameters: <path>; default value: "")
587 A more secure alternative to the above, by storing your password
588 elsewhere in your system. (example: newsblur-passwordfile
589 "~/.newsboat/newsblur-pw.txt")
590 newsblur-passwordeval (parameters: <command>; default value: "")
592 Another secure alternative, is providing your password from an
593 external command that is evaluated during login. This can be used
594 to read your password from a gpg encrypted file or your system
595 keyring. (example: newsblur-passwordeval "gpg --decrypt
596 ~/.newsboat/newsblur-password.gpg")
597 newsblur-url (parameters: <url>; default value: "https://newsblur.com")
599 Configures the URL where the NewsBlur instance resides. (example:
600 newsblur-url "https://localhost")
601 notify-always (parameters: [yes/no]; default value: no)
603 If set to no, notifications will only be made when there are new
604 feeds or articles. If set to yes, notifications will be made
605 regardless. (example: notify-always yes)
606 notify-beep (parameters: [yes/no]; default value: no)
608 If set to yes, then the speaker beep on new articles. (example:
609 notify-beep yes)
610 notify-format (parameters: <string>; default value: "newsboat: finished
612 reload, %f unread feeds (%n unread articles total)")
613 Format string that is used for formatting notifications. See the
614 chapter on format strings for more information. (example:
615 notify-format "%d new articles (%n unread articles, %f unread
616 feeds)")
617 notify-program (parameters: <command>; default value: "")
619 If set, then the configured program will be executed if new
620 articles arrived (through a reload) or if notify-always is yes. The
621 first parameter of the called program contains the notification
622 message. In order to pass other hard-coded arguments to the
623 program, write an appropriate wrapper shell script and use it as
624 <command> instead. (example: notify-program "~/bin/my-notifier")
625 notify-screen (parameters: [yes/no]; default value: no)
627 If set to yes, then a "privacy message" will be sent to the
628 terminal, containing a notification message about new articles.
629 This is especially useful if you use terminal emulations such as
630 GNU screen which implement privacy messages. (example:
631 notify-screen yes)
632 notify-xterm (parameters: [yes/no]; default value: no)
634 If set to yes, then the xterm window title will be set to a
635 notification message about new articles. (example: notify-xterm
636 yes)
637 ocnews-flag-star (parameters: <character>; default value: "")
639 If set and ownCloud News support is used, then all articles that
640 are flagged with the specified flag are being "starred" in ownCloud
641 News. (example: ocnews-flag-star "s")
642 ocnews-login (parameters: <username>; default value: "")
644 Sets the username to use with the ownCloud instance. (example:
645 ocnews-login "user")
646 ocnews-password (parameters: <password>; default value: "")
648 Configures the password to use with the ownCloud instance. Double
649 quotes should be escaped, i.e. you should write \" instead of ".
650 (example: ocnews-password "here_goesAquote:\"")
651 ocnews-passwordfile (parameters: <path>; default value: "")
653 A more secure alternative to the above, by storing your password
654 elsewhere in your system. (example: ocnews-passwordfile
655 "~/.newsboat/ocnews-pw.txt")
656 ocnews-passwordeval (parameters: <command>; default value: "")
658 Another secure alternative, is providing your password from an
659 external command that is evaluated during login. This can be used
660 to read your password from a gpg encrypted file or your system
661 keyring. (example: ocnews-passwordeval "gpg --decrypt
662 ~/.newsboat/ocnews-password.gpg")
663 ocnews-url (parameters: <url>; default value: "")
665 Configures the URL where the ownCloud instance resides. (example:
666 ocnews-url "https://localhost/owncloud")
667 oldreader-flag-share (parameters: <flag>; default value: "")
669 If set and The Old Reader support is used, then all articles that
670 are flagged with the specified flag are being "shared" in The Old
671 Reader so that people that follow you can see it. (example:
672 oldreader-flag-share "a")
673 oldreader-flag-star (parameters: <flag>; default value: "")
675 If set and The Old Reader support is used, then all articles that
676 are flagged with the specified flag are being "starred" in The Old
677 Reader and appear in the list of "Starred items". (example:
678 oldreader-flag-star "b")
679 oldreader-login (parameters: <login>; default value: "")
681 This variable sets your The Old Reader login for The Older Reader
682 support. (example: oldreader-login "your-login")
683 oldreader-min-items (parameters: <number>; default value: 20)
685 This variable sets the number of articles that are loaded from The
686 Old Reader per feed. (example: oldreader-min-items 100)
687 oldreader-password (parameters: <password>; default value: "")
689 This variable sets your The Old Reader password for The Old Reader
690 support. Double quotes should be escaped, i.e. you should write \"
691 instead of ". (example: oldreader-password "here_goesAquote:\"")
692 oldreader-passwordfile (parameters: <path>; default value: "")
694 A more secure alternative to the above, by storing your password
695 elsewhere in your system. (example: oldreader-passwordfile
696 "~/.newsboat/oldreader-pw.txt")
697 oldreader-passwordeval (parameters: <command>; default value: "")
699 Another secure alternative, is providing your password from an
700 external command that is evaluated during login. This can be used
701 to read your password from a gpg encrypted file or your system
702 keyring. (example: oldreader-passwordeval "gpg --decrypt
703 ~/.newsboat/oldreader-password.gpg")
704 oldreader-show-special-feeds (parameters: [yes/no]; default value: yes)
706 If set and The Old reader support is used, then "special feeds"
707 like "People you follow" (articles shared by people you follow),
708 "Starred items" (your starred articles) and "Shared items" (your
709 shared articles) appear in your subscription list. (example:
710 oldreader-show-special-feeds "no")
711 openbrowser-and-mark-jumps-to-next-unread (parameters: [yes/no];
713 default value: no)
714 If set to yes, jump to the next unread item when an item is opened
715 in the browser and marked as read. (example:
716 openbrowser-and-mark-jumps-to-next-unread yes)
717 opml-url (parameters: <url> ...; default value: "")
719 If the OPML online subscription mode is enabled, then the list of
720 feeds will be taken from the OPML file found on this location.
721 Optionally, you can specify more than one URL. All the listed OPML
722 URLs will then be taken into account when loading the feed list.
723 (example: opml-url "http://host.domain.tld/blogroll.opml"
724 "http://example.com/anotheropmlfile.opml")
725 pager (parameters: [<command>/internal]; default value: internal)
727 If set to internal, then the internal pager will be used.
728 Otherwise, the article to be displayed will be rendered to be a
729 temporary file and then displayed with the configured pager. If the
730 command is set to an empty string, the content of the "PAGER"
731 environment variable will be used. If the command contains a
732 placeholder %f, it will be replaced with the temporary filename.
733 (example: pager "less %f")
734 podcast-auto-enqueue (parameters: [yes/no]; default value: no)
736 If set to yes, then all podcast URLs that are found in articles are
737 added to the podcast download queue. See the respective section in
738 the documentation for more information on podcast support in
739 newsboat. (example: podcast-auto-enqueue yes)
740 prepopulate-query-feeds (parameters: [yes/no]; default value: no)
742 If set to yes, then all query feeds are prepopulated with articles
743 on startup. (example: prepopulate-query-feeds yes)
744 ssl-verifyhost (parameters: [yes/no]; default value: yes)
746 If set to no, skip verification of the certificate’s name against
747 host. (example: ssl-verifyhost no)
748 ssl-verifypeer (parameters: [yes/no]; default value: yes)
750 If set to no, skip verification of the peer’s SSL certificate.
751 (example: ssl-verifypeer no)
752 proxy-auth-method (parameters: <method>; default value: any)
754 Set proxy authentication method. Allowed values: any, basic,
755 digest, digest_ie (only available with libcurl 7.19.3 and newer),
756 gssnegotiate, ntlm and anysafe. (example: proxy-auth-method ntlm)
757 proxy-auth (parameters: <auth>; default value: n/a)
759 Set the proxy authentication string. (example: proxy-auth
760 user:password)
761 proxy-type (parameters: <type>; default value: http)
763 Set proxy type. Allowed values: http, socks4, socks4a, socks5 and
764 socks5h. (example: proxy-type socks5)
765 proxy (parameters: <server:port>; default value: n/a)
767 Set the proxy to use for downloading RSS feeds. (Don’t forget to
768 actually enable the proxy with use-proxy yes.) (example: proxy
769 localhost:3128)
770 refresh-on-startup (parameters: [yes/no]; default value: no)
772 If set to yes, then all feeds will be reloaded when newsboat starts
773 up. This is equivalent to the -r commandline option. (example:
774 refresh-on-startup yes)
775 reload-only-visible-feeds (parameters: [yes/no]; default value: no)
777 If set to yes, then manually reloading all feeds will only reload
778 the currently visible feeds, e.g. if a filter or a tag is set.
779 (example: reload-only-visible-feeds yes)
780 reload-threads (parameters: <number>; default value: 1)
782 The number of parallel reload threads that shall be started when
783 all feeds are reloaded. (example: reload-threads 3)
784 reload-time (parameters: <number>; default value: 60)
786 The number of minutes between automatic reloads. (example:
787 reload-time 120)
788 reset-unread-on-update (parameters: <url> ...; default value: n/a)
790 With this configuration command, you can provide a list of RSS feed
791 URLs for whose articles the unread flag will be reset if an article
792 has been updated, i.e. its content has been changed. This is
793 especially useful for RSS feeds where single articles are updated
794 after publication, and you want to be notified of the updates.
795 (example: reset-unread-on-update
796 "http://blog.fefe.de/rss.xml?html")
797 save-path (parameters: <path-to-directory>; default value: ~/)
799 The default path where articles shall be saved to. If an invalid
800 path is specified, the current directory is used. (example:
801 save-path "~/Saved Articles")
802 search-highlight-colors (parameters: <fgcolor> <bgcolor> [<attribute>
804 ...]; default value: black yellow bold)
805 This configuration command specifies the highlighting colors when
806 searching for text from the article view. (example:
807 search-highlight-colors white black bold)
808 searchresult-title-format (parameters: <format>; default value: "%N %V
810 - Search result (%u unread, %t total)")
811 Format of the title in search result. See "Format Strings" section
812 of Newsboat manual for details on available formats. (example:
813 searchresult-title-format "Search result")
814 selectfilter-title-format (parameters: <format>; default value: "%N %V
816 - Select Filter")
817 Format of the title in filter selection dialog. See "Format
818 Strings" section of Newsboat manual for details on available
819 formats. (example: selectfilter-title-format "Select Filter")
820 selecttag-title-format (parameters: <format>; default value: "%N %V -
822 Select Tag")
823 Format of the title in tag selection dialog. See "Format Strings"
824 section of Newsboat manual for details on available formats.
825 (example: selecttag-title-format "Select Tag")
826 show-keymap-hint (parameters: [yes/no]; default value: yes)
828 If set to no, then the keymap hints on the bottom of screen will
829 not be displayed. (example: show-keymap-hint no)
830 show-title-bar (parameters: [yes/no]; default value: yes)
832 If set to no, then the title bar on the top of the screen will not
833 be displayed. (example: show-title-bar no)
834 show-read-articles (parameters: [yes/no]; default value: yes)
836 If set to yes, then all articles of a feed are listed in the
837 article list. If set to no, then only unread articles are listed.
838 (example: show-read-articles no)
839 show-read-feeds (parameters: [yes/no]; default value: yes)
841 If set to yes, then all feeds, including those without unread
842 articles, are listed. If set to no, then only feeds with one or
843 more unread articles are list. (example: show-read-feeds no)
844 suppress-first-reload (parameters: [yes/no]; default value: no)
846 If set to yes, then the first automatic reload will be suppressed
847 if auto-reload is set to yes. (example: suppress-first-reload yes)
848 swap-title-and-hints (parameters: [yes/no]; default value: no)
850 If set to yes, then the title at the top of screen and keymap hints
851 at the bottom of screen will be swapped. (example:
852 swap-title-and-hints yes)
853 text-width (parameters: <number>; default value: 0)
855 If set to a number greater than 0, all HTML will be rendered to
856 this maximum line length or the terminal width (whichever is
857 smaller). If set to 0, the terminal width will always be used. Does
858 not apply when using external renderer or viewing the source. Also
859 note that "Link" header and "Links" section won’t be affected by
860 it—they contain URLs which are better not wrapped. (example:
861 text-width 72)
862 toggleitemread-jumps-to-next-unread (parameters: [yes/no]; default
864 value: no)
865 If set to yes, jump to the next unread item when an item’s read
866 status is toggled in the article list. (example:
867 toggleitemread-jumps-to-next-unread yes)
868 ttrss-flag-publish (parameters: <character>; default value: "")
870 If set and Tiny Tiny RSS support is used, then all articles that
871 are flagged with the specified flag are being marked as "published"
872 in Tiny Tiny RSS. (example: ttrss-flag-publish "b")
873 ttrss-flag-star (parameters: <character>; default value: "")
875 If set and Tiny Tiny RSS support is used, then all articles that
876 are flagged with the specified flag are being "starred" in Tiny
877 Tiny RSS. (example: ttrss-flag-star "a")
878 ttrss-login (parameters: <username>; default value: "")
880 Sets the username for use with Tiny Tiny RSS. (example: ttrss-login
881 "admin")
882 ttrss-mode (parameters: [multi/single]; default value: multi)
884 Configures the mode in which Tiny Tiny RSS is used. In single-user
885 mode, login and password are used for HTTP authentication, while in
886 multi-user mode, they are used for authenticating with Tiny Tiny
887 RSS. (example: ttrss-mode "single")
888 ttrss-password (parameters: <password>; default value: "")
890 Configures the password for use with Tiny Tiny RSS. Double quotes
891 should be escaped, i.e. you should write \" instead of ". (example:
892 ttrss-password "here_goesAquote:\"")
893 ttrss-passwordfile (parameters: <path>; default value: "")
895 A more secure alternative to the above, by storing your password
896 elsewhere in your system. (example: ttrss-passwordfile
897 "~/.newsboat/ttrss-pw.txt")
898 ttrss-passwordeval (parameters: <command>; default value: "")
900 Another secure alternative, is providing your password from an
901 external command that is evaluated during login. This can be used
902 to read your password from a gpg encrypted file or your system
903 keyring. (example: ttrss-passwordeval "gpg --decrypt
904 ~/.newsboat/ttrss-password.gpg")
905 ttrss-url (parameters: <url>; default value: "")
907 Configures the URL where the Tiny Tiny RSS installation you want to
908 use resides. (example: ttrss-url "http://example.com/ttrss/")
909 unbind-key (parameters: <key> [<dialog>]; default value: n/a)
911 Unbind key <key>. This means that no operation is called when <key>
912 is pressed. If you provide "-a" as <key>, all currently bound keys
913 will become unbound. Optionally, you can specify a dialog (for a
914 list of available dialogs, see bind-key above). If you specify one,
915 the key binding will only be unbound for the specified dialog.
916 (example: unbind-key R)
917 urls-source (parameters: <source>; default value: "local")
919 This configuration command sets the source where URLs shall be
920 retrieved from. By default, this is ~/.newsboat/urls.
921 Alternatively, you can set it to opml, which enables newsboat’s
922 OPML online subscription mode, to ttrss which enables newsboat’s
923 Tiny Tiny RSS support, to oldreader, which enables newsboat’s The
924 Old Reader support, to newsblur, which enables NewsBlur support, or
925 feedhq for FeedHQ support, or ocnews for ownCloud News support, or
926 inoreader for Inoreader support. Query feed specifications will be
927 read from the local urls file regardless of this setting. (example:
928 urls-source "oldreader")
929 urlview-title-format (parameters: <format>; default value: "%N %V -
931 URLs")
932 Format of the title in URL view. See "Format Strings" section of
933 Newsboat manual for details on available formats. (example:
934 urlview-title-format "URLs")
935 use-proxy (parameters: [yes/no]; default value: no)
937 If set to yes, then the configured proxy will be used for
938 downloading the RSS feeds. (example: use-proxy yes)
939 user-agent (parameters: <string>; default value: "")
941 If set to a non-zero-length string, this value will be used as HTTP
942 User-Agent header for all HTTP requests. (example: user-agent
943 "Lynx/2.8.5rel.1 libwww-FM/2.14")
944
946 open (default key: ENTER)
947 Open the currently selected feed or article.
948 quit (default key: q)
950 Quit the program or return to the previous dialog (depending on the
951 context).
952 hard-quit (default key: Q)
954 Quit the program without confirmation.
955 reload (default key: r)
957 Reload the currently selected feed.
958 reload-all (default key: R)
960 Reload all feeds.
961 mark-feed-read (default key: A)
963 Mark all articles in the currently selected feed read.
964 mark-all-feeds-read (default key: C)
966 Mark articles in all feeds read.
967 mark-all-above-as-read (default key: n/a)
969 Mark all above as read.
970 save (default key: s)
972 Save the currently selected article to a file.
973 next-unread (default key: n)
975 Jump to the next unread article.
976 prev-unread (default key: p)
978 Jump to the previous unread article.
979 next (default key: J)
981 Jump to next article.
982 prev (default key: K)
984 Jump to previous article.
985 random-unread (default key: ^K)
987 Jump to a random unread article.
988 open-in-browser (default key: o)
990 Opens the URL associated with the current article.
991 open-in-browser-and-mark-read (default key: O)
993 Opens the URL associated with the current article and marks the
994 article as read.
995 open-all-unread-in-browser (default key: n/a)
997 Opens all the unread URLs in the current feed.
998 open-all-unread-in-browser-and-mark-read (default key: n/a)
1000 Opens all the unread URLs in the current feed and marks them as
1001 read.
1002 help (default key: ?)
1004 Runs the help screen.
1005 toggle-source-view (default key: ^U)
1007 Toggles between the HTML view and the source view in the article
1008 view.
1009 toggle-article-read (default key: N)
1011 Toggle the read flag for the currently selected article, and clears
1012 delete flag if set.
1013 toggle-show-read-feeds (default key: l)
1015 Toggle whether read feeds should be shown in the feed list.
1016 show-urls (default key: u)
1018 Show all URLs in the article in a list (similar to urlview).
1019 clear-tag (default key: ^T)
1021 Clear current tag.
1022 set-tag (default key: t)
1024 Select tag.
1025 open-search (default key: /)
1027 Opens the search dialog. When a search is done in the article list,
1028 then the search operation only applies to the articles of the
1029 current feed, otherwise to all articles.
1030 goto-url (default key: #)
1032 Open the URL dialog and then opens specified URL.
1033 enqueue (default key: e)
1035 Add the podcast download URL of the current article (if any is
1036 found) to the podcast download queue (see the respective section in
1037 the documentation for more information on podcast support).
1038 edit-urls (default key: E)
1040 Edit the list of subscribed URLs. newsboat will start the editor
1041 configured through the $VISUAL environment variable (if unset,
1042 $EDITOR is used; fallback: "vi"). When editing is finished,
1043 newsboat will reload the URLs file.
1044 reload-urls (default key: ^R)
1046 Reload the URLs configuration file.
1047 redraw (default key: ^L)
1049 Redraw the screen.
1050 cmdline (default key: <colon>)
1052 Open the command line.
1053 set-filter (default key: F)
1055 Set a filter.
1056 select-filter (default key: f)
1058 Select a predefined filter.
1059 clear-filter (default key: ^F)
1061 Clear currently set filter.
1062 bookmark (default key: ^B)
1064 Bookmark currently selected article or URL.
1065 edit-flags (default key: ^E)
1067 Edit the flags of the currently selected article.
1068 next-unread-feed (default key: ^N)
1070 Go to the next feed with unread articles. This only works from the
1071 article list.
1072 prev-unread-feed (default key: ^P)
1074 Go to the previous feed with unread articles. This only works from
1075 the article list.
1076 next-feed (default key: j)
1078 Go to the next feed. This only works from the article list.
1079 prev-feed (default key: k)
1081 Go to the previous feed. This only works from the article list.
1082 delete-article (default key: D)
1084 Delete the currently selected article.
1085 delete-all-articles (default key: ^D)
1087 Delete all articles in the current feed.
1088 purge-deleted (default key: $)
1090 Purge all article that are marked as deleted from the article list.
1091 view-dialogs (default key: v)
1093 View list of open dialogs.
1094 close-dialog (default key: ^X)
1096 Close currently selected dialog.
1097 next-dialog (default key: ^V)
1099 Go to next dialog.
1100 prev-dialog (default key: ^G)
1102 Go to previous dialog.
1103 pipe-to (default key: '')
1105 |Pipe article to command.
1106 sort (default key: g)
1108 Sort feeds/articles by interactively choosing the sort method.
1109 rev-sort (default key: G)
1111 Sort feeds/articles by interactively choosing the sort method
1112 (reversed).
1113 up (default key: UP)
1115 Goes up one item in the list.
1116 down (default key: DOWN)
1118 Goes down one item in the list.
1119 pageup (default key: PPAGE)
1121 Goes up one page in the list.
1122 pagedown (default key: NPAGE)
1124 Goes down one page in the list.
1125 home (default key: HOME)
1127 Goes to the first item in the list.
1128 end (default key: END)
1130 Goes to the last item in the list.
1131
1133 Newsboat comes with the possibility to categorize or "tag", as we call
1134 it, RSS feeds. Every RSS feed can be assigned 0 or more tags. Within
1135 newsboat, you can then select to only show RSS feeds that match a
1136 certain tag. That makes it easy to categorize your feeds in a flexible
1137 and powerful way.
1138 Usually, the ~/.newsboat/urls file contains one RSS feed URL per line.
1140 To assign a tag to an RSS feed, simply attach it as a single word,
1141 separated by blanks such as space or tab. If the tag needs to contain
1142 spaces, you must use quotes (") around the tag (see example below). An
1143 example ~/.newsboat/urls file may look like this:
1144 http://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
1146 http://rss.orf.at/news.xml news orf
1147 http://www.heise.de/newsticker/heise.rdf news interesting
1148 When you now start newsboat with this configuration, you can press "t"
1150 to select a tag. When you select the tag "news", you will see all three
1151 RSS feeds. Pressing "t" again and e.g. selecting the "conspiracy" tag,
1152 you will only see the http://blog.fefe.de/rss.xml?html RSS feed.
1153 Pressing "^T" clears the current tag, and again shows all RSS feeds,
1154 regardless of their assigned tags.
1155 A special type of tag are tags that start with the tilde character (~).
1157 When such a tag is found, the feed title is set to the tag name
1158 (excluding the ~ character). With this feature, you can give feeds any
1159 title you want in your feed list:
1160 http://rss.orf.at/news.xml "~ORF News"
1162 Another special type of tag are tags that start with the exclamation
1164 mark (!). When such a tag is found, the feed is hidden from the regular
1165 list of feeds and its content can only be found through a query feed.
1166 http://rss.orf.at/news.xml "!ORF News (hidden)"
1168
1170 Newsboat contains support for Snownews extensions. The RSS feed readers
1171 Snownews and Liferea share a common way of extending the readers with
1172 custom scripts. Two mechanisms, namely "execurl" and "filter" type
1173 scripts, are available and supported by newsboat.
1174 An "execurl" script can be any program that gets executed and whose
1176 output is interpreted as RSS feed, while "filter" scripts are fed with
1177 the content of a configured URL and whose output is interpreted as RSS
1178 feed.
1179 The configuration is simple and straight-forward. Just add to your
1181 ~/.newsboat/urls file configuration lines like the following ones:
1182 exec:~/bin/execurl-script
1184 filter:~/bin/filter-script:http://some.test/url
1185 The first line shows how to add an execurl script to your
1187 configuration: start the line with exec: and then immediately append
1188 the path of the script that shall be executed. If this script requires
1189 additional parameters, simply use quotes:
1190 "exec:~/bin/execurl-script param1 param2"
1192 The second line shows how to add a filter script to your configuration:
1194 start the line with filter:, then immediately append the path of the
1195 script, then append a colon (:), and then append the URL of the file
1196 that shall be fed to the script. Again, if the script requires any
1197 parameters, simply quote:
1198 "filter:~/bin/filter-script param1 param2:http://url/foobar"
1200 In both cases, the tagging feature as described above is still
1202 available:
1203 exec:~/bin/execurl-script tag1 tag2 "quoted tag"
1205 filter:~/bin/filter-script:http://some.test/url tag3 tag4 tag5
1206 If you need to write your own extension, see this short guide for an
1208 introduction. A collection of existing scripts might also help.
1209
1211 Like other text-oriented software, Newsboat contains an internal
1212 commandline to modify configuration variables ad hoc and to run own
1213 commands. It provides a flexible access to the functionality of
1214 Newsboat which is especially useful for advanced users.
1215 To start the commandline, type ":". You will see a ":" prompt at the
1217 bottom of the screen, similar to tools like vi(m) or mutt. You can now
1218 enter commands. Pressing the "Enter" key executes the command (possibly
1219 giving feedback to the user) and closes the commandline. You can cancel
1220 entering commands by pressing the "Esc" key. The history of all the
1221 commands that you enter will be saved to ~/.newsboat/history.cmdline.
1222 The backlog is limited to 100 entries by default, but can be influenced
1223 by setting the history-limit configuration variable. To disable history
1224 saving, set the history-limit to 0.
1225 The commandline provides you with some help if you can’t remember the
1227 full names of commandline commands. By pressing the "Tab" key, newsboat
1228 will try to automatically complete your command. If there is more than
1229 one possible completion, you can subsequently press the "Tab" key to
1230 cycle through all results. If no match is found, no suggestion will be
1231 inserted into the commandline. For the set command, the completion also
1232 works for configuration variable names.
1233 In addition, some common key combination such as "Ctrl-G" (to cancel
1235 input), "Ctrl-K" (to delete text from the cursor position to the end of
1236 line), "Ctrl-U" (to clear the whole line) and "Ctrl-W" (to delete the
1237 word before the current cursor position) were added.
1238 Please be aware that the input history of both the command line and the
1240 search functions are saved to the filesystems, to the files
1241 ~/.newsboat/history.cmdline resp. ~/.newsboat/history.search. By
1242 default, the last 100 entries are saved, but this can be configured
1243 (configuration variable history-limit) and also totally disabled (by
1244 setting said variable to 0).
1245 Currently, the following command line commands are available:
1247 quit
1249 Quit newsboat
1250 q
1252 Alias for quit
1253 save <filename>
1255 Save current article to <filename>
1256 set <variable>[=<value>|&|!]
1258 Set (or get) configuration variable value. Specifying a ! after
1259 the name of a boolean configuration variable toggles their values,
1260 a & directly after the name of a configuration variable of any type
1261 resets its value to the documented default value.
1262 tag <tagname>
1264 Select a certain tag
1265 goto <case-insensitive substring>
1267 Go to the next feed whose name contains the case-insensitive
1268 substring.
1269 source <filename> [...]
1271 Load the specified configuration files. This allows it to load
1272 alternative configuration files or reload already loaded
1273 configuration files on-the-fly from the filesystem.
1274 dumpconfig <filename>
1276 Save current internal state of configuration to file, so that it
1277 can be instantly reused as configuration file.
1278 <number>
1280 Jump to the <number>th entry in the current dialog
1281
1283 Newsboat defaults to storing everything in $HOME/.newsboat directory.
1284 If you prefer XDG, create $HOME/.config/newsboat and
1285 $HOME/.local/share/newsboat directories, and Newsboat will use them
1286 from there on.
1287 If you already have some files in $HOME/.newsboat/, move them as
1289 follows:
1290 config, urls
1292 to $HOME/.config/newsboat/
1293 cache.db, history.search, history.cmdline
1295 to $HOME/.local/share/newsboat/
1296 See also a corresponding section in podboat(1).
1298
1300 dotfiles
1301 $HOME/.newsboat/config
1302 $HOME/.newsboat/urls
1304 XDG
1306 $HOME/.config/newsboat/config
1307 $HOME/.config/newsboat/urls
1309
1311 BROWSER
1312 Tells Newsboat what browser to use if there is no "browser" setting
1313 in the config file. If this variable doesn’t exist, a default of
1314 lynx(1) will be used.
1315 CURL_CA_BUNDLE
1317 Tells Newsboat to use the specified certificate file to verify the
1318 peer. The file may contain multiple certificates. The
1319 certificate(s) must be in PEM format.
1320 This option is useful if your libcurl is built without useful
1322 certificate information, and you can’t rebuild the library
1323 yourself.
1324 TMPDIR
1326 Tells Newsboat to use the specified directory for storing temporary
1327 files. If this variable doesn’t exist, a default of /tmp will be
1328 used.
1329
1331 podboat(1)
1332
1334 Alexander Batischev <eual.jp@gmail.com>
1335 Author.
1336 07/25/2019 NEWSBOAT(1)