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 and # characters
181 can be escaped with a backslash (e.g. \` and \#); in that case, they’ll
182 be replaced with literal ` or # 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, podbeuter, and dirbrowser. (example:
247 bind-key ^R 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, cookies will be cached in (i.e. read
293 from and written to) this file, using Netscape format. (example:
294 cookie-cache "~/.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 dirbrowser-title-format (parameters: <format>; default value: "%N %V -
319 %?O?Open Directory&Save File? - %f")
320 Format of the title in directory browser. See "Format Strings"
321 section of Newsboat manual for details on available formats.
322 (example: dirbrowser-file-format "%?O?Open Directory&Save File? -
323 %f")
324 display-article-progress (parameters: [yes/no]; default value: yes)
326 If set to yes, then a read progress (in percent) is displayed in
327 the article view. Otherwise, no read progress is displayed.
328 (example: display-article-progress no)
329 download-full-page (parameters: [yes/no]; default value: no)
331 If set to yes, then for all feed items with no content but with a
332 link, the link is downloaded and the result used as content
333 instead. This may significantly increase the download times of
334 "empty" feeds. (example: download-full-page yes)
335 download-retries (parameters: <number>; default value: 1)
337 How many times newsboat shall try to successfully download a feed
338 before giving up. This is an option to improve the success of
339 downloads on slow and shaky connections such as via a TOR proxy.
340 (example: download-retries 4)
341 download-timeout (parameters: <number>; default value: 30)
343 The number of seconds newsboat shall wait when downloading a feed
344 before giving up. This is an option to improve the success of
345 downloads on slow and shaky connections such as via a TOR proxy.
346 (example: download-timeout 60)
347 error-log (parameters: <path>; default value: "")
349 If set, then user errors (e.g. errors regarding defunct RSS feeds)
350 will be logged to this file. (example: error-log
351 "~/.newsboat/error.log")
352 external-url-viewer (parameters: <command>; default value: "")
354 If set, then show-urls will pipe the current article to a specific
355 external tool instead of using the internal URL viewer. This can be
356 used to integrate tools such as urlview. (example:
357 external-url-viewer "urlview")
358 feed-sort-order (parameters: <sortorder>[-<direction>]; default value:
360 none)
361 The <sortfield> specifies which feed property shall be used for
362 sorting; currently available are: firsttag, title, articlecount,
363 unreadarticlecount, lastupdated and none. The optional <direction>
364 specifies the sort direction. asc specifies ascending sorting,
365 desc specifies descending sorting. desc is the default. (example:
366 feed-sort-order firsttag)
367 feedhq-flag-share (parameters: <flag>; default value: "")
369 If set and FeedHQ support is used, then all articles that are
370 flagged with the specified flag are being "shared" in FeedHQ so
371 that people that follow you can see it. (example: feedhq-flag-share
372 "a")
373 feedhq-flag-star (parameters: <flag>; default value: "")
375 If set and FeedHQ support is used, then all articles that are
376 flagged with the specified flag are being "starred" in FeedHQ and
377 appear in the list of "Starred items". (example: feedhq-flag-star
378 "b")
379 feedhq-login (parameters: <login>; default value: "")
381 This variable sets your FeedHQ login for FeedHQ support. (example:
382 feedhq-login "your-login")
383 feedhq-min-items (parameters: <number>; default value: 20)
385 This variable sets the number of articles that are loaded from
386 FeedHQ per feed. (example: feedhq-min-items 100)
387 feedhq-password (parameters: <password>; default value: "")
389 This variable sets your FeedHQ password for FeedHQ support. Double
390 quotes should be escaped, i.e. you should write \" instead of ".
391 (example: feedhq-password "here_goesAquote:\"")
392 feedhq-passwordfile (parameters: <path>; default value: "")
394 A more secure alternative to the above, by storing your password
395 elsewhere in your system. (example: feedhq-passwordfile
396 "~/.newsboat/feedhq-pw.txt")
397 feedhq-passwordeval (parameters: <command>; default value: "")
399 Another secure alternative, is providing your password from an
400 external command that is evaluated during login. This can be used
401 to read your password from a gpg encrypted file or your system
402 keyring. (example: feedhq-passwordeval "gpg --decrypt
403 ~/.newsboat/feedhq-password.gpg")
404 feedhq-show-special-feeds (parameters: [yes/no]; default value: yes)
406 If set and FeedHQ support is used, then "special feeds" like
407 "People you follow" (articles shared by people you follow),
408 "Starred items" (your starred articles) and "Shared items" (your
409 shared articles) appear in your subscription list. (example:
410 feedhq-show-special-feeds "no")
411 feedhq-url (parameters: <url>; default value: "https://feedhq.org/")
413 Configures the URL where your FeedHQ instance resides. (example:
414 feedhq-url "https://feedhq.example.com/")
415 feedlist-format (parameters: <format>; default value: "%4i %n %11u %t")
417 This variable defines the format of entries in the feed list. See
418 the respective section in the documentation for more information on
419 format strings. (example: feedlist-format " %n %4i - %11u -%> %t")
420 feedlist-title-format (parameters: <format>; default value: "N %V -
422 Your feeds (%u unread, %t total)%?T? - tag ‘%T&?"’)
423 Format of the title in feed list. See "Format Strings" section of
424 Newsboat manual for details on available formats. (example:
425 feedlist-title-format "Feeds (%u unread, %t total)")
426 filebrowser-title-format (parameters: <format>; default value: "%N %V -
428 %?O?Open File&Save File? - %f")
429 Format of the title in file browser. See "Format Strings" section
430 of Newsboat manual for details on available formats. (example:
431 filebrowser-title-format "%?O?Open File&Save File? - %f")
432 goto-first-unread (parameters: [yes/no]; default value: yes)
434 If set to yes, then the first unread article will be selected
435 whenever a feed is entered. (example: goto-first-unread no)
436 goto-next-feed (parameters: [yes/no]; default value: yes)
438 If set to yes, then the next-unread, prev-unread and random-unread
439 keys will search in other feeds for unread articles if all articles
440 in the current feed are read. If set to no, then these keys will
441 stop in the current feed. (example: goto-next-feed no)
442 help-title-format (parameters: <format>; default value: "%N %V - Help")
444 Format of the title in help window. See "Format Strings" section of
445 Newsboat manual for details on available formats. (example:
446 help-title-format "%N %V - Help")
447 highlight (parameters: <target> <regex> <fgcolor> [<bgcolor>
449 [<attribute> ...]]; default value: n/a)
450 With this command, you can highlight text parts in the feed list,
451 the article list and the article view. For a detailed
452 documentation, see the chapter on highlighting. (example: highlight
453 all "newsboat" red)
454 highlight-article (parameters: <filterexpr> <fgcolor> <bgcolor>
456 [<attribute> ...]; default value: n/a)
457 With this command, you can highlight articles in the article list
458 if they match a filter expression. For a detailed documentation,
459 see the chapter on highlighting. (example: highlight-article
460 "author =~ \"Andreas Krennmair\"" white red bold)
461 history-limit (parameters: <number>; default value: 100)
463 Defines the maximum number of entries of commandline resp. search
464 history to be saved. To disable history saving, set it to 0.
465 (example: history-limit 0)
466 html-renderer (parameters: <command>; default value: internal)
468 If set to internal, then the internal HTML renderer will be used.
469 Otherwise, the specified command will be executed, the HTML to be
470 rendered will be written to the command’s stdin, and the program’s
471 output will be displayed. This makes it possible to use other,
472 external programs, such as w3m, links or lynx, to render HTML.
473 (example: html-renderer "w3m -dump -T text/html")
474 http-auth-method (parameters: <method>; default value: any)
476 Set HTTP authentication method. Allowed values: any, basic, digest,
477 digest_ie (only available with libcurl 7.19.3 and newer),
478 gssnegotiate, ntlm and anysafe. (example: http-auth-method digest)
479 ignore-article (parameters: <feed> <filterexpr>; default value: n/a)
481 If a downloaded article from <feed> matches <filterexpr>, then it
482 is ignored and not presented to the user. This command is further
483 explained in the "kill file" section below. (example:
484 ignore-article "*" "title =~ \"Windows\"")
485 ignore-mode (parameters: [download/display]; default value: download)
487 This configuration option defines in what way an article is ignored
488 (see ignore-article). If set to download, then it is ignored in the
489 download/parsing phase and thus never written to the cache, if it
490 set to display, it is ignored when displaying articles but is kept
491 in the cache. (example: ignore-mode "display")
492 include (parameters: <path>; default value: n/a)
494 With this command, you can include other files to be interpreted as
495 configuration files. This is especially useful to separate your
496 configuration into several files, e.g. key configuration, color
497 configuration, ... (example: include "~/.newsboat/colors")
498 itemview-title-format (parameters: <format>; default value: "%N %V -
500 Article '%T (%u unread, %t total)"')
501 Format of the title in article view. See "Format Strings" section
502 of Newsboat manual for details on available formats. (example:
503 itemview-title-format "Article %T")
504 inoreader-flag-share (parameters: <flag>; default value: "")
506 If set and Inoreader support is used, then all articles that are
507 flagged with the specified flag are being "shared" in Inoreader so
508 that people that follow you can see it. (example:
509 inoreader-flag-share "a")
510 inoreader-flag-star (parameters: <flag>; default value: "")
512 If set and Inoreader support is used, then all articles that are
513 flagged with the specified flag are being "starred" in Inoreader
514 and appear in the list of "Starred items". (example:
515 inoreader-flag-star "b")
516 inoreader-login (parameters: <login>; default value: "")
518 This variable sets your Inoreader login for Inoreader support.
519 (example: inoreader-login "your-login")
520 inoreader-min-items (parameters: <number>; default value: 20)
522 This variable sets the number of articles that are loaded from
523 Inoreader per feed. (example: inoreader-min-items 100)
524 inoreader-password (parameters: <password>; default value: "")
526 This variable sets your Inoreader password for Inoreader support.
527 Double quotes should be escaped, i.e. you should write \" instead
528 of ". (example: inoreader-password "here_goesAquote:\"")
529 inoreader-passwordfile (parameters: <path>; default value: "")
531 A more secure alternative to the above, by storing your password
532 elsewhere in your system. (example: inoreader-passwordfile
533 "~/.newsboat/inoreader-pw.txt")
534 inoreader-passwordeval (parameters: <command>; default value: "")
536 Another secure alternative, is providing your password from an
537 external command that is evaluated during login. This can be used
538 to read your password from a gpg encrypted file or your system
539 keyring. (example: inoreader-passwordeval "gpg --decrypt
540 ~/.newsboat/inoreader-password.gpg")
541 inoreader-show-special-feeds (parameters: [yes/no]; default value: yes)
543 If set and Inoreader support is used, then "special feeds" like
544 "Starred items" (your starred articles) and "Shared items" (your
545 shared articles) appear in your subscription list. (example:
546 inoreader-show-special-feeds "no")
547 keep-articles-days (parameters: <number>; default value: 0)
549 If set to a number greater than 0, only articles that are were
550 published within the last <number> days are kept, and older
551 articles are deleted. If set to 0, this option is not active. Note
552 that changing this setting won’t bring back the articles that were
553 deleted earlier; currently, there’s no non-hacky way to bring back
554 deleted articles. (example: keep-articles-days 30)
555 macro (parameters: <macro key> <command list>; default value: n/a)
557 With this command, you can define a macro key and specify a list of
558 commands that shall be executed when the macro prefix and the macro
559 key are pressed. (example: macro k open ; reload ; quit)
560 mark-as-read-on-hover (parameters: [yes/no]; default value: no)
562 If set to yes, then all articles that get selected in the article
563 list are marked as read. (example: mark-as-read-on-hover yes)
564 max-download-speed (parameters: <number>; default value: 0)
566 If set to a number great than 0, the download speed per download is
567 set to that limit (in kB). (example: max-download-speed 50)
568 max-browser-tabs (parameters: <number>; default value: 10)
570 Set the maximum number of articles to open in a browser when using
571 the open-all-unread-in-browser or
572 open-all-unread-in-browser-and-mark-read commands. (example:
573 max-browser-tabs 4)
574 max-items (parameters: <number>; default value: 0)
576 Set the number of articles to maximally keep per feed. If the
577 number is set to 0, then all articles are kept. (example: max-items
578 100)
579 newsblur-login (parameters: <login>; default value: "")
581 This variable sets your NewsBlur login for NewsBlur support.
582 (example: newsblur-login "your-login")
583 newsblur-min-items (parameters: <number>; default value: 20)
585 This variable sets the number of articles that are loaded from
586 NewsBlur per feed. (example: newsblur-min-items 100)
587 newsblur-password (parameters: <password>; default value: "")
589 This variable sets your NewsBlur password for NewsBlur support.
590 Double quotes should be escaped, i.e. you should write \" instead
591 of ". (example: newsblur-password "here_goesAquote:\"")
592 newsblur-passwordfile (parameters: <path>; default value: "")
594 A more secure alternative to the above, by storing your password
595 elsewhere in your system. (example: newsblur-passwordfile
596 "~/.newsboat/newsblur-pw.txt")
597 newsblur-passwordeval (parameters: <command>; default value: "")
599 Another secure alternative, is providing your password from an
600 external command that is evaluated during login. This can be used
601 to read your password from a gpg encrypted file or your system
602 keyring. (example: newsblur-passwordeval "gpg --decrypt
603 ~/.newsboat/newsblur-password.gpg")
604 newsblur-url (parameters: <url>; default value: "https://newsblur.com")
606 Configures the URL where the NewsBlur instance resides. (example:
607 newsblur-url "https://localhost")
608 notify-always (parameters: [yes/no]; default value: no)
610 If set to no, notifications will only be made when there are new
611 feeds or articles. If set to yes, notifications will be made
612 regardless. (example: notify-always yes)
613 notify-beep (parameters: [yes/no]; default value: no)
615 If set to yes, then the speaker beep on new articles. (example:
616 notify-beep yes)
617 notify-format (parameters: <string>; default value: "newsboat: finished
619 reload, %f unread feeds (%n unread articles total)")
620 Format string that is used for formatting notifications. See the
621 chapter on format strings for more information. (example:
622 notify-format "%d new articles (%n unread articles, %f unread
623 feeds)")
624 notify-program (parameters: <command>; default value: "")
626 If set, then the configured program will be executed if new
627 articles arrived (through a reload) or if notify-always is yes. The
628 first parameter of the called program contains the notification
629 message. In order to pass other hard-coded arguments to the
630 program, write an appropriate wrapper shell script and use it as
631 <command> instead. (example: notify-program "~/bin/my-notifier")
632 notify-screen (parameters: [yes/no]; default value: no)
634 If set to yes, then a "privacy message" will be sent to the
635 terminal, containing a notification message about new articles.
636 This is especially useful if you use terminal emulations such as
637 GNU screen which implement privacy messages. (example:
638 notify-screen yes)
639 notify-xterm (parameters: [yes/no]; default value: no)
641 If set to yes, then the xterm window title will be set to a
642 notification message about new articles. (example: notify-xterm
643 yes)
644 ocnews-flag-star (parameters: <character>; default value: "")
646 If set and ownCloud News support is used, then all articles that
647 are flagged with the specified flag are being "starred" in ownCloud
648 News. (example: ocnews-flag-star "s")
649 ocnews-login (parameters: <username>; default value: "")
651 Sets the username to use with the ownCloud instance. (example:
652 ocnews-login "user")
653 ocnews-password (parameters: <password>; default value: "")
655 Configures the password to use with the ownCloud instance. Double
656 quotes should be escaped, i.e. you should write \" instead of ".
657 (example: ocnews-password "here_goesAquote:\"")
658 ocnews-passwordfile (parameters: <path>; default value: "")
660 A more secure alternative to the above, by storing your password
661 elsewhere in your system. (example: ocnews-passwordfile
662 "~/.newsboat/ocnews-pw.txt")
663 ocnews-passwordeval (parameters: <command>; default value: "")
665 Another secure alternative, is providing your password from an
666 external command that is evaluated during login. This can be used
667 to read your password from a gpg encrypted file or your system
668 keyring. (example: ocnews-passwordeval "gpg --decrypt
669 ~/.newsboat/ocnews-password.gpg")
670 ocnews-url (parameters: <url>; default value: "")
672 Configures the URL where the ownCloud instance resides. (example:
673 ocnews-url "https://localhost/owncloud")
674 oldreader-flag-share (parameters: <flag>; default value: "")
676 If set and The Old Reader support is used, then all articles that
677 are flagged with the specified flag are being "shared" in The Old
678 Reader so that people that follow you can see it. (example:
679 oldreader-flag-share "a")
680 oldreader-flag-star (parameters: <flag>; default value: "")
682 If set and The Old Reader support is used, then all articles that
683 are flagged with the specified flag are being "starred" in The Old
684 Reader and appear in the list of "Starred items". (example:
685 oldreader-flag-star "b")
686 oldreader-login (parameters: <login>; default value: "")
688 This variable sets your The Old Reader login for The Older Reader
689 support. (example: oldreader-login "your-login")
690 oldreader-min-items (parameters: <number>; default value: 20)
692 This variable sets the number of articles that are loaded from The
693 Old Reader per feed. (example: oldreader-min-items 100)
694 oldreader-password (parameters: <password>; default value: "")
696 This variable sets your The Old Reader password for The Old Reader
697 support. Double quotes should be escaped, i.e. you should write \"
698 instead of ". (example: oldreader-password "here_goesAquote:\"")
699 oldreader-passwordfile (parameters: <path>; default value: "")
701 A more secure alternative to the above, by storing your password
702 elsewhere in your system. (example: oldreader-passwordfile
703 "~/.newsboat/oldreader-pw.txt")
704 oldreader-passwordeval (parameters: <command>; default value: "")
706 Another secure alternative, is providing your password from an
707 external command that is evaluated during login. This can be used
708 to read your password from a gpg encrypted file or your system
709 keyring. (example: oldreader-passwordeval "gpg --decrypt
710 ~/.newsboat/oldreader-password.gpg")
711 oldreader-show-special-feeds (parameters: [yes/no]; default value: yes)
713 If set and The Old reader support is used, then "special feeds"
714 like "People you follow" (articles shared by people you follow),
715 "Starred items" (your starred articles) and "Shared items" (your
716 shared articles) appear in your subscription list. (example:
717 oldreader-show-special-feeds "no")
718 openbrowser-and-mark-jumps-to-next-unread (parameters: [yes/no];
720 default value: no)
721 If set to yes, jump to the next unread item when an item is opened
722 in the browser and marked as read. (example:
723 openbrowser-and-mark-jumps-to-next-unread yes)
724 opml-url (parameters: <url> ...; default value: "")
726 If the OPML online subscription mode is enabled, then the list of
727 feeds will be taken from the OPML file found on this location.
728 Optionally, you can specify more than one URL. All the listed OPML
729 URLs will then be taken into account when loading the feed list.
730 (example: opml-url "http://host.domain.tld/blogroll.opml"
731 "http://example.com/anotheropmlfile.opml")
732 pager (parameters: [<command>/internal]; default value: internal)
734 If set to internal, then the internal pager will be used.
735 Otherwise, the article to be displayed will be rendered to be a
736 temporary file and then displayed with the configured pager. If the
737 command is set to an empty string, the content of the "PAGER"
738 environment variable will be used. If the command contains a
739 placeholder %f, it will be replaced with the temporary filename.
740 (example: pager "less %f")
741 podcast-auto-enqueue (parameters: [yes/no]; default value: no)
743 If set to yes, then all podcast URLs that are found in articles are
744 added to the podcast download queue. See the respective section in
745 the documentation for more information on podcast support in
746 newsboat. (example: podcast-auto-enqueue yes)
747 prepopulate-query-feeds (parameters: [yes/no]; default value: no)
749 If set to yes, then all query feeds are prepopulated with articles
750 on startup. (example: prepopulate-query-feeds yes)
751 ssl-verifyhost (parameters: [yes/no]; default value: yes)
753 If set to no, skip verification of the certificate’s name against
754 host. (example: ssl-verifyhost no)
755 ssl-verifypeer (parameters: [yes/no]; default value: yes)
757 If set to no, skip verification of the peer’s SSL certificate.
758 (example: ssl-verifypeer no)
759 proxy-auth-method (parameters: <method>; default value: any)
761 Set proxy authentication method. Allowed values: any, basic,
762 digest, digest_ie (only available with libcurl 7.19.3 and newer),
763 gssnegotiate, ntlm and anysafe. (example: proxy-auth-method ntlm)
764 proxy-auth (parameters: <auth>; default value: n/a)
766 Set the proxy authentication string. (example: proxy-auth
767 user:password)
768 proxy-type (parameters: <type>; default value: http)
770 Set proxy type. Allowed values: http, socks4, socks4a, socks5 and
771 socks5h. (example: proxy-type socks5)
772 proxy (parameters: <server:port>; default value: n/a)
774 Set the proxy to use for downloading RSS feeds. (Don’t forget to
775 actually enable the proxy with use-proxy yes.) (example: proxy
776 localhost:3128)
777 refresh-on-startup (parameters: [yes/no]; default value: no)
779 If set to yes, then all feeds will be reloaded when newsboat starts
780 up. This is equivalent to the -r commandline option. (example:
781 refresh-on-startup yes)
782 reload-only-visible-feeds (parameters: [yes/no]; default value: no)
784 If set to yes, then manually reloading all feeds will only reload
785 the currently visible feeds, e.g. if a filter or a tag is set.
786 (example: reload-only-visible-feeds yes)
787 reload-threads (parameters: <number>; default value: 1)
789 The number of parallel reload threads that shall be started when
790 all feeds are reloaded. (example: reload-threads 3)
791 reload-time (parameters: <number>; default value: 60)
793 The number of minutes between automatic reloads. (example:
794 reload-time 120)
795 reset-unread-on-update (parameters: <url> ...; default value: n/a)
797 With this configuration command, you can provide a list of RSS feed
798 URLs for whose articles the unread flag will be reset if an article
799 has been updated, i.e. its content has been changed. This is
800 especially useful for RSS feeds where single articles are updated
801 after publication, and you want to be notified of the updates.
802 (example: reset-unread-on-update
803 "http://blog.fefe.de/rss.xml?html")
804 save-path (parameters: <path-to-directory>; default value: ~/)
806 The default path where articles shall be saved to. If an invalid
807 path is specified, the current directory is used. (example:
808 save-path "~/Saved Articles")
809 search-highlight-colors (parameters: <fgcolor> <bgcolor> [<attribute>
811 ...]; default value: black yellow bold)
812 This configuration command specifies the highlighting colors when
813 searching for text from the article view. (example:
814 search-highlight-colors white black bold)
815 searchresult-title-format (parameters: <format>; default value: "%N %V
817 - Search result (%u unread, %t total)")
818 Format of the title in search result. See "Format Strings" section
819 of Newsboat manual for details on available formats. (example:
820 searchresult-title-format "Search result")
821 selectfilter-title-format (parameters: <format>; default value: "%N %V
823 - Select Filter")
824 Format of the title in filter selection dialog. See "Format
825 Strings" section of Newsboat manual for details on available
826 formats. (example: selectfilter-title-format "Select Filter")
827 selecttag-format (parameters: <format>; default value: "%4i %T (%u)")
829 Format of the lines in "Select tag" dialog. See the respective
830 section in the documentation for more information on format
831 strings. (example: selecttag-format "[%2i] %T (%n unread articles
832 in %f feeds, %u feeds total)")
833 selecttag-title-format (parameters: <format>; default value: "%N %V -
835 Select Tag")
836 Format of the title in tag selection dialog. See "Format Strings"
837 section of Newsboat manual for details on available formats.
838 (example: selecttag-title-format "Select Tag")
839 show-keymap-hint (parameters: [yes/no]; default value: yes)
841 If set to no, then the keymap hints on the bottom of screen will
842 not be displayed. (example: show-keymap-hint no)
843 show-title-bar (parameters: [yes/no]; default value: yes)
845 If set to no, then the title bar on the top of the screen will not
846 be displayed. (example: show-title-bar no)
847 show-read-articles (parameters: [yes/no]; default value: yes)
849 If set to yes, then all articles of a feed are listed in the
850 article list. If set to no, then only unread articles are listed.
851 (example: show-read-articles no)
852 show-read-feeds (parameters: [yes/no]; default value: yes)
854 If set to yes, then all feeds, including those without unread
855 articles, are listed. If set to no, then only feeds with one or
856 more unread articles are list. (example: show-read-feeds no)
857 suppress-first-reload (parameters: [yes/no]; default value: no)
859 If set to yes, then the first automatic reload will be suppressed
860 if auto-reload is set to yes. (example: suppress-first-reload yes)
861 swap-title-and-hints (parameters: [yes/no]; default value: no)
863 If set to yes, then the title at the top of screen and keymap hints
864 at the bottom of screen will be swapped. (example:
865 swap-title-and-hints yes)
866 text-width (parameters: <number>; default value: 0)
868 If set to a number greater than 0, all HTML will be rendered to
869 this maximum line length or the terminal width (whichever is
870 smaller). If set to 0, the terminal width will always be used. Does
871 not apply when using external renderer or viewing the source. Also
872 note that "Link" header and "Links" section won’t be affected by
873 it—they contain URLs which are better not wrapped. (example:
874 text-width 72)
875 toggleitemread-jumps-to-next-unread (parameters: [yes/no]; default
877 value: no)
878 If set to yes, jump to the next unread item when an item’s read
879 status is toggled in the article list. (example:
880 toggleitemread-jumps-to-next-unread yes)
881 ttrss-flag-publish (parameters: <character>; default value: "")
883 If set and Tiny Tiny RSS support is used, then all articles that
884 are flagged with the specified flag are being marked as "published"
885 in Tiny Tiny RSS. (example: ttrss-flag-publish "b")
886 ttrss-flag-star (parameters: <character>; default value: "")
888 If set and Tiny Tiny RSS support is used, then all articles that
889 are flagged with the specified flag are being "starred" in Tiny
890 Tiny RSS. (example: ttrss-flag-star "a")
891 ttrss-login (parameters: <username>; default value: "")
893 Sets the username for use with Tiny Tiny RSS. (example: ttrss-login
894 "admin")
895 ttrss-mode (parameters: [multi/single]; default value: multi)
897 Configures the mode in which Tiny Tiny RSS is used. In single-user
898 mode, login and password are used for HTTP authentication, while in
899 multi-user mode, they are used for authenticating with Tiny Tiny
900 RSS. (example: ttrss-mode "single")
901 ttrss-password (parameters: <password>; default value: "")
903 Configures the password for use with Tiny Tiny RSS. Double quotes
904 should be escaped, i.e. you should write \" instead of ". (example:
905 ttrss-password "here_goesAquote:\"")
906 ttrss-passwordfile (parameters: <path>; default value: "")
908 A more secure alternative to the above, by storing your password
909 elsewhere in your system. (example: ttrss-passwordfile
910 "~/.newsboat/ttrss-pw.txt")
911 ttrss-passwordeval (parameters: <command>; default value: "")
913 Another secure alternative, is providing your password from an
914 external command that is evaluated during login. This can be used
915 to read your password from a gpg encrypted file or your system
916 keyring. (example: ttrss-passwordeval "gpg --decrypt
917 ~/.newsboat/ttrss-password.gpg")
918 ttrss-url (parameters: <url>; default value: "")
920 Configures the URL where the Tiny Tiny RSS installation you want to
921 use resides. (example: ttrss-url "http://example.com/ttrss/")
922 unbind-key (parameters: <key> [<dialog>]; default value: n/a)
924 Unbind key <key>. This means that no operation is called when <key>
925 is pressed. If you provide "-a" as <key>, all currently bound keys
926 will become unbound. Optionally, you can specify a dialog (for a
927 list of available dialogs, see bind-key above). If you specify one,
928 the key binding will only be unbound for the specified dialog.
929 (example: unbind-key R)
930 urls-source (parameters: <source>; default value: "local")
932 This configuration command sets the source where URLs shall be
933 retrieved from. By default, this is ~/.newsboat/urls.
934 Alternatively, you can set it to opml, which enables newsboat’s
935 OPML online subscription mode, to ttrss which enables newsboat’s
936 Tiny Tiny RSS support, to oldreader, which enables newsboat’s The
937 Old Reader support, to newsblur, which enables NewsBlur support, or
938 feedhq for FeedHQ support, or ocnews for ownCloud News support, or
939 inoreader for Inoreader support. Query feed specifications will be
940 read from the local urls file regardless of this setting. (example:
941 urls-source "oldreader")
942 urlview-title-format (parameters: <format>; default value: "%N %V -
944 URLs")
945 Format of the title in URL view. See "Format Strings" section of
946 Newsboat manual for details on available formats. (example:
947 urlview-title-format "URLs")
948 use-proxy (parameters: [yes/no]; default value: no)
950 If set to yes, then the configured proxy will be used for
951 downloading the RSS feeds. (example: use-proxy yes)
952 user-agent (parameters: <string>; default value: "")
954 If set to a non-zero-length string, this value will be used as HTTP
955 User-Agent header for all HTTP requests. (example: user-agent
956 "Lynx/2.8.5rel.1 libwww-FM/2.14")
957
959 open (default key: ENTER)
960 Open the currently selected feed or article.
961 quit (default key: q)
963 Quit the program or return to the previous dialog (depending on the
964 context).
965 hard-quit (default key: Q)
967 Quit the program without confirmation.
968 reload (default key: r)
970 Reload the currently selected feed.
971 reload-all (default key: R)
973 Reload all feeds.
974 mark-feed-read (default key: A)
976 Mark all articles in the currently selected feed read.
977 mark-all-feeds-read (default key: C)
979 Mark articles in all feeds read.
980 mark-all-above-as-read (default key: n/a)
982 Mark all above as read.
983 save (default key: s)
985 Save the currently selected article to a file.
986 save-all (default key: n/a)
988 Save all articles from currently selected feed.
989 next-unread (default key: n)
991 Jump to the next unread article.
992 prev-unread (default key: p)
994 Jump to the previous unread article.
995 next (default key: J)
997 Jump to next article.
998 prev (default key: K)
1000 Jump to previous article.
1001 random-unread (default key: ^K)
1003 Jump to a random unread article.
1004 open-in-browser (default key: o)
1006 Open the URL associated with the current article.
1007 open-in-browser-and-mark-read (default key: O)
1009 Open the URL associated with the current article and mark the
1010 article as read.
1011 open-all-unread-in-browser (default key: n/a)
1013 Open all the unread URLs in the current feed.
1014 open-all-unread-in-browser-and-mark-read (default key: n/a)
1016 Open all the unread URLs in the current feed and mark them as read.
1017 help (default key: ?)
1019 Run the help screen.
1020 toggle-source-view (default key: ^U)
1022 Toggle between the HTML view and the source view in the article
1023 view.
1024 toggle-article-read (default key: N)
1026 Toggle the read flag for the currently selected article, and clear
1027 the delete flag if set.
1028 toggle-show-read-feeds (default key: l)
1030 Toggle whether read feeds should be shown in the feed list.
1031 show-urls (default key: u)
1033 Show all URLs in the article in a list (similar to urlview).
1034 clear-tag (default key: ^T)
1036 Clear current tag.
1037 set-tag (default key: t)
1039 Select tag.
1040 open-search (default key: /)
1042 Open the search dialog. When a search is done in the article list,
1043 then the search operation only applies to the articles of the
1044 current feed, otherwise to all articles.
1045 goto-url (default key: #)
1047 Open the URL dialog and then open a specified URL.
1048 enqueue (default key: e)
1050 Add the podcast download URL of the current article (if any is
1051 found) to the podcast download queue (see the respective section in
1052 the documentation for more information on podcast support).
1053 edit-urls (default key: E)
1055 Edit the list of subscribed URLs. newsboat will start the editor
1056 configured through the $VISUAL environment variable (if unset,
1057 $EDITOR is used; fallback: "vi"). When editing is finished,
1058 newsboat will reload the URLs file.
1059 reload-urls (default key: ^R)
1061 Reload the URLs configuration file.
1062 redraw (default key: ^L)
1064 Redraw the screen.
1065 cmdline (default key: :)
1067 Open the command line.
1068 set-filter (default key: F)
1070 Set a filter.
1071 select-filter (default key: f)
1073 Select a predefined filter.
1074 clear-filter (default key: ^F)
1076 Clear currently set filter.
1077 bookmark (default key: ^B)
1079 Bookmark currently selected article or URL.
1080 edit-flags (default key: ^E)
1082 Edit the flags of the currently selected article.
1083 next-unread-feed (default key: ^N)
1085 Go to the next feed with unread articles. This only works from the
1086 article list.
1087 prev-unread-feed (default key: ^P)
1089 Go to the previous feed with unread articles. This only works from
1090 the article list.
1091 next-feed (default key: j)
1093 Go to the next feed. This only works from the article list.
1094 prev-feed (default key: k)
1096 Go to the previous feed. This only works from the article list.
1097 delete-article (default key: D)
1099 Delete the currently selected article.
1100 delete-all-articles (default key: ^D)
1102 Delete all articles in the current feed.
1103 purge-deleted (default key: $)
1105 Purge all articles that are marked as deleted from the article
1106 list.
1107 view-dialogs (default key: v)
1109 View list of open dialogs.
1110 close-dialog (default key: ^X)
1112 Close currently selected dialog.
1113 next-dialog (default key: ^V)
1115 Go to next dialog.
1116 prev-dialog (default key: ^G)
1118 Go to previous dialog.
1119 pipe-to (default key: '| ')
1121 Pipe article to command.
1122 sort (default key: g)
1124 Sort feeds/articles by interactively choosing the sort method.
1125 rev-sort (default key: G)
1127 Sort feeds/articles by interactively choosing the sort method
1128 (reversed).
1129 up (default key: UP)
1131 Go up one item in the list.
1132 down (default key: DOWN)
1134 Go down one item in the list.
1135 pageup (default key: PPAGE)
1137 Go up one page in the list.
1138 pagedown (default key: NPAGE)
1140 Go down one page in the list.
1141 home (default key: HOME)
1143 Go to the first item in the list.
1144 end (default key: END)
1146 Go to the last item in the list.
1147 macro-prefix (default key: ,)
1149 Initiate macro execution. The next key press selects the actual
1150 macro and runs it.
1151
1153 Newsboat comes with the possibility to categorize or "tag", as we call
1154 it, RSS feeds. Every RSS feed can be assigned 0 or more tags. Within
1155 newsboat, you can then select to only show RSS feeds that match a
1156 certain tag. That makes it easy to categorize your feeds in a flexible
1157 and powerful way.
1158 Usually, the ~/.newsboat/urls file contains one RSS feed URL per line.
1160 To assign a tag to an RSS feed, simply attach it as a single word,
1161 separated by blanks such as space or tab. If the tag needs to contain
1162 spaces, you must use quotes (") around the tag (see example below). An
1163 example ~/.newsboat/urls file may look like this:
1164 http://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
1166 http://rss.orf.at/news.xml news orf
1167 http://www.heise.de/newsticker/heise.rdf news interesting
1168 When you now start newsboat with this configuration, you can press "t"
1170 to select a tag. When you select the tag "news", you will see all three
1171 RSS feeds. Pressing "t" again and e.g. selecting the "conspiracy" tag,
1172 you will only see the http://blog.fefe.de/rss.xml?html RSS feed.
1173 Pressing "^T" clears the current tag, and again shows all RSS feeds,
1174 regardless of their assigned tags.
1175 A special type of tag are tags that start with the tilde character (~).
1177 When such a tag is found, the feed title is set to the tag name
1178 (excluding the ~ character). With this feature, you can give feeds any
1179 title you want in your feed list:
1180 http://rss.orf.at/news.xml "~ORF News"
1182 Another special type of tag are tags that start with the exclamation
1184 mark (!). When such a tag is found, the feed is hidden from the regular
1185 list of feeds and its content can only be found through a query feed.
1186 http://rss.orf.at/news.xml "!ORF News (hidden)"
1188
1190 Newsboat contains support for Snownews extensions. The RSS feed readers
1191 Snownews and Liferea share a common way of extending the readers with
1192 custom scripts. Two mechanisms, namely "execurl" and "filter" type
1193 scripts, are available and supported by newsboat.
1194 An "execurl" script can be any program that gets executed and whose
1196 output is interpreted as RSS feed, while "filter" scripts are fed with
1197 the content of a configured URL and whose output is interpreted as RSS
1198 feed.
1199 The configuration is simple and straight-forward. Just add to your
1201 ~/.newsboat/urls file configuration lines like the following ones:
1202 exec:~/bin/execurl-script
1204 filter:~/bin/filter-script:http://some.test/url
1205 The first line shows how to add an execurl script to your
1207 configuration: start the line with exec: and then immediately append
1208 the path of the script that shall be executed. If this script requires
1209 additional parameters, simply use quotes:
1210 "exec:~/bin/execurl-script param1 param2"
1212 The second line shows how to add a filter script to your configuration:
1214 start the line with filter:, then immediately append the path of the
1215 script, then append a colon (:), and then append the URL of the file
1216 that shall be fed to the script. Again, if the script requires any
1217 parameters, simply quote:
1218 "filter:~/bin/filter-script param1 param2:http://url/foobar"
1220 In both cases, the tagging feature as described above is still
1222 available:
1223 exec:~/bin/execurl-script tag1 tag2 "quoted tag"
1225 filter:~/bin/filter-script:http://some.test/url tag3 tag4 tag5
1226 If you need to write your own extension, see this short guide for an
1228 introduction. A collection of existing scripts might also help.
1229
1231 Like other text-oriented software, Newsboat contains an internal
1232 commandline to modify configuration variables ad hoc and to run own
1233 commands. It provides a flexible access to the functionality of
1234 Newsboat which is especially useful for advanced users.
1235 To start the commandline, type ":". You will see a ":" prompt at the
1237 bottom of the screen, similar to tools like vi(m) or mutt. You can now
1238 enter commands. Pressing the "Enter" key executes the command (possibly
1239 giving feedback to the user) and closes the commandline. You can cancel
1240 entering commands by pressing the "Esc" key. The history of all the
1241 commands that you enter will be saved to ~/.newsboat/history.cmdline.
1242 The backlog is limited to 100 entries by default, but can be influenced
1243 by setting the history-limit configuration variable. To disable history
1244 saving, set the history-limit to 0.
1245 The commandline provides you with some help if you can’t remember the
1247 full names of commandline commands. By pressing the "Tab" key, newsboat
1248 will try to automatically complete your command. If there is more than
1249 one possible completion, you can subsequently press the "Tab" key to
1250 cycle through all results. If no match is found, no suggestion will be
1251 inserted into the commandline. For the set command, the completion also
1252 works for configuration variable names.
1253 In addition, some common key combination such as "Ctrl-G" (to cancel
1255 input), "Ctrl-K" (to delete text from the cursor position to the end of
1256 line), "Ctrl-U" (to clear the whole line) and "Ctrl-W" (to delete the
1257 word before the current cursor position) were added.
1258 Please be aware that the input history of both the command line and the
1260 search functions are saved to the filesystems, to the files
1261 ~/.newsboat/history.cmdline resp. ~/.newsboat/history.search. By
1262 default, the last 100 entries are saved, but this can be configured
1263 (configuration variable history-limit) and also totally disabled (by
1264 setting said variable to 0).
1265 Currently, the following command line commands are available:
1267 quit
1269 Quit newsboat
1270 q
1272 Alias for quit
1273 save <filename>
1275 Save current article to <filename>
1276 set <variable>[=<value>|&|!]
1278 Set (or get) configuration variable value. Specifying a ! after
1279 the name of a boolean configuration variable toggles their values,
1280 a & directly after the name of a configuration variable of any type
1281 resets its value to the documented default value.
1282 tag <tagname>
1284 Select a certain tag
1285 goto <case-insensitive substring>
1287 Go to the next feed whose name contains the case-insensitive
1288 substring.
1289 source <filename> [...]
1291 Load the specified configuration files. This allows it to load
1292 alternative configuration files or reload already loaded
1293 configuration files on-the-fly from the filesystem.
1294 dumpconfig <filename>
1296 Save current internal state of configuration to file, so that it
1297 can be instantly reused as configuration file.
1298 <number>
1300 Jump to the <number>th entry in the current dialog
1301
1303 Newsboat defaults to storing everything in $HOME/.newsboat directory.
1304 If you prefer XDG, create $HOME/.config/newsboat and
1305 $HOME/.local/share/newsboat directories, and Newsboat will use them
1306 from there on.
1307 If you already have some files in $HOME/.newsboat/, move them as
1309 follows:
1310 config, urls
1312 to $HOME/.config/newsboat/
1313 cache.db, history.search, history.cmdline
1315 to $HOME/.local/share/newsboat/
1316 See also a corresponding section in podboat(1).
1318
1320 dotfiles
1321 $HOME/.newsboat/config
1322 $HOME/.newsboat/urls
1324 XDG
1326 $HOME/.config/newsboat/config
1327 $HOME/.config/newsboat/urls
1329
1331 BROWSER
1332 Tells Newsboat what browser to use if there is no "browser" setting
1333 in the config file. If this variable doesn’t exist, a default of
1334 lynx(1) will be used.
1335 CURL_CA_BUNDLE
1337 Tells Newsboat to use the specified certificate file to verify the
1338 peer. The file may contain multiple certificates. The
1339 certificate(s) must be in PEM format.
1340 This option is useful if your libcurl is built without useful
1342 certificate information, and you can’t rebuild the library
1343 yourself.
1344 TMPDIR
1346 Tells Newsboat to use the specified directory for storing temporary
1347 files. If this variable doesn’t exist, a default of /tmp will be
1348 used.
1349
1351 podboat(1)
1352
1354 Alexander Batischev <eual.jp@gmail.com>
1355 Author.
1356 01/29/2020 NEWSBOAT(1)