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 and guid. The optional <direction> specifies the sort direction.
215 asc specifies ascending sorting, desc specifies descending sorting.
216 For date, desc is default, for all others, asc is default.
217 (example: article-sort-order author-desc)
218 articlelist-format (parameters: <format>; default value: "%4i %f %D %6L
220 %?T?|%-17T| ?%t")
221 This variable defines the format of entries in the article list.
222 See the respective section in the documentation for more
223 information on format strings. (example: articlelist-format "%4i %f
224 %D %?T?|%-17T| ?%t")
225 articlelist-title-format (parameters: <format>; default value: "%N %V -
227 Articles in feed '%T (%u unread, %t total) - %U"')
228 Format of the title in article list. See "Format Strings" section
229 of Newsboat manual for details on available formats. (example:
230 articlelist-title-format "Articles in feed %T (%u unread)")
231 auto-reload (parameters: [yes/no]; default value: no)
233 If set to yes, all feeds will be automatically reloaded at start up
234 and then continuously after a certain time has passed (see
235 reload-time). (example: auto-reload yes)
236 bind-key (parameters: <key> <operation> [<dialog>]; default value: n/a)
238 Bind key <key> to <operation>. This means that whenever <key> is
239 pressed, then <operation> is executed (if applicable in the current
240 dialog). A list of available operations can be found below.
241 Optionally, you can specify a dialog. If you specify one, the key
242 binding will only be added to the specified dialog. Available
243 dialogs are all (default if none is specified), feedlist,
244 filebrowser, help, articlelist, article, tagselection,
245 filterselection, urlview and podbeuter. (example: bind-key ^R
246 reload-all)
247 bookmark-autopilot (parameters: [yes/no]; default value: no)
249 If set to yes, the configured bookmark command is executed without
250 any further input asked from user, unless the url or the title
251 cannot be found/guessed. (example: bookmark-autopilot yes)
252 bookmark-cmd (parameters: <command>; default value: "")
254 If set, then <command> will be used as bookmarking plugin. See the
255 documentation on bookmarking for further information. (example:
256 bookmark-cmd "~/bin/delicious-bookmark.sh")
257 bookmark-interactive (parameters: [yes/no]; default value: no)
259 If set to yes, then the configured bookmark command is an
260 interactive program. (example: bookmark-interactive yes)
261 browser (parameters: <command>; default value: %BROWSER, otherwise
263 lynx)
264 Set the browser command to use when opening an article in the
265 browser. If BROWSER environment variable is set, it will be used as
266 the default browser, otherwise lynx will be used. Any occurrences
267 of %u in <command> will be replaced by a URL in single quotes.
268 (example: browser "w3m %u")
269 cache-file (parameters: <path>; default value: "~/.newsboat/cache.db")
271 This configuration option sets the cache file. This is especially
272 useful if the filesystem of your home directory doesn’t support
273 proper locking (e.g. NFS). (example: cache-file
274 "/tmp/testcache.db")
275 cleanup-on-quit (parameters: [yes/no]; default value: yes)
277 If set to yes, then the cache gets locked and superfluous feeds and
278 items are removed, such as feeds that can’t be found in the urls
279 configuration file anymore. (example: cleanup-on-quit no)
280 color (parameters: <element> <fgcolor> <bgcolor> [<attribute> ...];
282 default value: n/a)
283 Set the foreground color, background color and optional attributes
284 for a certain element. (example: color background white black)
285 confirm-exit (parameters: [yes/no]; default value: no)
287 If set to yes, then newsboat will ask for confirmation whether the
288 user really wants to quit newsboat. (example: confirm-exit yes)
289 cookie-cache (parameters: <path>; default value: "")
291 Set a cookie cache. If set, then cookies will be cached (i.e. read
292 from and written to) in this file. (example: cookie-cache
293 "~/.newsboat/cookies.txt")
294 datetime-format (parameters: <date/time format>; default value: %b %d)
296 This format specifies the date/time format in the article list. For
297 a detailed documentation on the allowed formats, consult the
298 manpage of strftime(3). (example: datetime-format "%D, %R")
299 define-filter (parameters: <name> <filterexpr>; default value: n/a)
301 With this command, you can predefine filters, which you can later
302 select from a list, and which are then applied after selection.
303 This is especially useful for filters that you need often and you
304 don’t want to enter them every time you need them. (example:
305 define-filter "all feeds with fun tag" "tags # \"fun\"")
306 delete-read-articles-on-quit (parameters: [yes/no]; default value: no)
308 If set to yes, then all read articles will be deleted when you quit
309 newsboat. (example: delete-read-articles-on-quit yes)
310 dialogs-title-format (parameters: <format>; default value: "%N %V -
312 Dialogs")
313 Format of the title in dialog list. See "Format Strings" section of
314 Newsboat manual for details on available formats. (example:
315 dialogs-title-format "%N %V - Dialogs")
316 display-article-progress (parameters: [yes/no]; default value: yes)
318 If set to yes, then a read progress (in percent) is displayed in
319 the article view. Otherwise, no read progress is displayed.
320 (example: display-article-progress no)
321 download-full-page (parameters: [yes/no]; default value: no)
323 If set to yes, then for all feed items with no content but with a
324 link, the link is downloaded and the result used as content
325 instead. This may significantly increase the download times of
326 "empty" feeds. (example: download-full-page yes)
327 download-retries (parameters: <number>; default value: 1)
329 How many times newsboat shall try to successfully download a feed
330 before giving up. This is an option to improve the success of
331 downloads on slow and shaky connections such as via a TOR proxy.
332 (example: download-retries 4)
333 download-timeout (parameters: <number>; default value: 30)
335 The number of seconds newsboat shall wait when downloading a feed
336 before giving up. This is an option to improve the success of
337 downloads on slow and shaky connections such as via a TOR proxy.
338 (example: download-timeout 60)
339 error-log (parameters: <path>; default value: "")
341 If set, then user errors (e.g. errors regarding defunct RSS feeds)
342 will be logged to this file. (example: error-log
343 "~/.newsboat/error.log")
344 external-url-viewer (parameters: <command>; default value: "")
346 If set, then show-urls will pipe the current article to a specific
347 external tool instead of using the internal URL viewer. This can be
348 used to integrate tools such as urlview. (example:
349 external-url-viewer "urlview")
350 feed-sort-order (parameters: <sortorder>[-<direction>]; default value:
352 none)
353 The <sortfield> specifies which feed property shall be used for
354 sorting; currently available are: firsttag, title, articlecount,
355 unreadarticlecount, lastupdated and none. The optional <direction>
356 specifies the sort direction. asc specifies ascending sorting,
357 desc specifies descending sorting. desc is the default. (example:
358 feed-sort-order firsttag)
359 feedhq-flag-share (parameters: <flag>; default value: "")
361 If set and FeedHQ support is used, then all articles that are
362 flagged with the specified flag are being "shared" in FeedHQ so
363 that people that follow you can see it. (example: feedhq-flag-share
364 "a")
365 feedhq-flag-star (parameters: <flag>; default value: "")
367 If set and FeedHQ support is used, then all articles that are
368 flagged with the specified flag are being "starred" in FeedHQ and
369 appear in the list of "Starred items". (example: feedhq-flag-star
370 "b")
371 feedhq-login (parameters: <login>; default value: "")
373 This variable sets your FeedHQ login for FeedHQ support. (example:
374 feedhq-login "your-login")
375 feedhq-min-items (parameters: <number>; default value: 20)
377 This variable sets the number of articles that are loaded from
378 FeedHQ per feed. (example: feedhq-min-items 100)
379 feedhq-password (parameters: <password>; default value: "")
381 This variable sets your FeedHQ password for FeedHQ support. Double
382 quotes should be escaped, i.e. you should write \" instead of ".
383 (example: feedhq-password "here_goesAquote:\"")
384 feedhq-passwordfile (parameters: <path>; default value: "")
386 A more secure alternative to the above, by storing your password
387 elsewhere in your system. (example: feedhq-passwordfile
388 "~/.newsboat/feedhq-pw.txt")
389 feedhq-passwordeval (parameters: <command>; default value: "")
391 Another secure alternative, is providing your password from an
392 external command that is evaluated during login. This can be used
393 to read your password from a gpg encrypted file or your system
394 keyring. (example: feedhq-passwordeval "command some-parameter")
395 feedhq-show-special-feeds (parameters: [yes/no]; default value: yes)
397 If set and FeedHQ support is used, then "special feeds" like
398 "People you follow" (articles shared by people you follow),
399 "Starred items" (your starred articles) and "Shared items" (your
400 shared articles) appear in your subscription list. (example:
401 feedhq-show-special-feeds "no")
402 feedhq-url (parameters: <url>; default value: "https://feedhq.org/")
404 Configures the URL where your FeedHQ instance resides. (example:
405 feedhq-url "https://feedhq.example.com/")
406 feedlist-format (parameters: <format>; default value: "%4i %n %11u %t")
408 This variable defines the format of entries in the feed list. See
409 the respective section in the documentation for more information on
410 format strings. (example: feedlist-format " %n %4i - %11u -%> %t")
411 feedlist-title-format (parameters: <format>; default value: "N %V -
413 Your feeds (%u unread, %t total)%?T? - tag ‘%T&?"’)
414 Format of the title in feed list. See "Format Strings" section of
415 Newsboat manual for details on available formats. (example:
416 feedlist-title-format "Feeds (%u unread, %t total)")
417 filebrowser-title-format (parameters: <format>; default value: "%N %V -
419 %?O?Open File&Save File? - %f")
420 Format of the title in file browser. See "Format Strings" section
421 of Newsboat manual for details on available formats. (example:
422 filebrowser-title-format "%?O?Open File&Save File? - %f")
423 goto-first-unread (parameters: [yes/no]; default value: yes)
425 If set to yes, then the first unread article will be selected
426 whenever a feed is entered. (example: goto-first-unread no)
427 goto-next-feed (parameters: [yes/no]; default value: yes)
429 If set to yes, then the next-unread, prev-unread and random-unread
430 keys will search in other feeds for unread articles if all articles
431 in the current feed are read. If set to no, then these keys will
432 stop in the current feed. (example: goto-next-feed no)
433 help-title-format (parameters: <format>; default value: "%N %V - Help")
435 Format of the title in help window. See "Format Strings" section of
436 Newsboat manual for details on available formats. (example:
437 help-title-format "%N %V - Help")
438 highlight (parameters: <target> <regex> <fgcolor> [<bgcolor>
440 [<attribute> ...]]; default value: n/a)
441 With this command, you can highlight text parts in the feed list,
442 the article list and the article view. For a detailed
443 documentation, see the chapter on highlighting. (example: highlight
444 all "newsboat" red)
445 highlight-article (parameters: <filterexpr> <fgcolor> <bgcolor>
447 [<attribute> ...]; default value: n/a)
448 With this command, you can highlight articles in the article list
449 if they match a filter expression. For a detailed documentation,
450 see the chapter on highlighting. (example: highlight-article
451 "author =~ \"Andreas Krennmair\"" white red bold)
452 history-limit (parameters: <number>; default value: 100)
454 Defines the maximum number of entries of commandline resp. search
455 history to be saved. To disable history saving, set it to 0.
456 (example: history-limit 0)
457 html-renderer (parameters: <command>; default value: internal)
459 If set to internal, then the internal HTML renderer will be used.
460 Otherwise, the specified command will be executed, the HTML to be
461 rendered will be written to the command’s stdin, and the program’s
462 output will be displayed. This makes it possible to use other,
463 external programs, such as w3m, links or lynx, to render HTML.
464 (example: html-renderer "w3m -dump -T text/html")
465 http-auth-method (parameters: <method>; default value: any)
467 Set HTTP authentication method. Allowed values: any, basic, digest,
468 digest_ie (only available with libcurl 7.19.3 and newer),
469 gssnegotiate, ntlm and anysafe. (example: http-auth-method digest)
470 ignore-article (parameters: <feed> <filterexpr>; default value: n/a)
472 If a downloaded article from <feed> matches <filterexpr>, then it
473 is ignored and not presented to the user. This command is further
474 explained in the "kill file" section below. (example:
475 ignore-article "*" "title =~ \"Windows\"")
476 ignore-mode (parameters: [download/display]; default value: download)
478 This configuration option defines in what way an article is ignored
479 (see ignore-article). If set to download, then it is ignored in the
480 download/parsing phase and thus never written to the cache, if it
481 set to display, it is ignored when displaying articles but is kept
482 in the cache. (example: ignore-mode "display")
483 include (parameters: <path>; default value: n/a)
485 With this command, you can include other files to be interpreted as
486 configuration files. This is especially useful to separate your
487 configuration into several files, e.g. key configuration, color
488 configuration, ... (example: include "~/.newsboat/colors")
489 itemview-title-format (parameters: <format>; default value: "%N %V -
491 Article '%T (%u unread, %t total)"')
492 Format of the title in article view. See "Format Strings" section
493 of Newsboat manual for details on available formats. (example:
494 itemview-title-format "Article %T")
495 inoreader-flag-share (parameters: <flag>; default value: "")
497 If set and Inoreader support is used, then all articles that are
498 flagged with the specified flag are being "shared" in Inoreader so
499 that people that follow you can see it. (example:
500 inoreader-flag-share "a")
501 inoreader-flag-star (parameters: <flag>; default value: "")
503 If set and Inoreader support is used, then all articles that are
504 flagged with the specified flag are being "starred" in Inoreader
505 and appear in the list of "Starred items". (example:
506 inoreader-flag-star "b")
507 inoreader-login (parameters: <login>; default value: "")
509 This variable sets your Inoreader login for Inoreader support.
510 (example: inoreader-login "your-login")
511 inoreader-min-items (parameters: <number>; default value: 20)
513 This variable sets the number of articles that are loaded from
514 Inoreader per feed. (example: inoreader-min-items 100)
515 inoreader-password (parameters: <password>; default value: "")
517 This variable sets your Inoreader password for Inoreader support.
518 Double quotes should be escaped, i.e. you should write \" instead
519 of ". (example: inoreader-password "here_goesAquote:\"")
520 inoreader-passwordfile (parameters: <path>; default value: "")
522 A more secure alternative to the above, by storing your password
523 elsewhere in your system. (example: inoreader-passwordfile
524 "~/.newsboat/inoreader-pw.txt")
525 inoreader-passwordeval (parameters: <command>; default value: "")
527 Another secure alternative, is providing your password from an
528 external command that is evaluated during login. This can be used
529 to read your password from a gpg encrypted file or your system
530 keyring. (example: inoreader-passwordeval "command some-parameter")
531 inoreader-show-special-feeds (parameters: [yes/no]; default value: yes)
533 If set and Inoreader support is used, then "special feeds" like
534 "Starred items" (your starred articles) and "Shared items" (your
535 shared articles) appear in your subscription list. (example:
536 inoreader-show-special-feeds "no")
537 keep-articles-days (parameters: <number>; default value: 0)
539 If set to a number greater than 0, only articles that are were
540 published within the last <number> days are kept, and older
541 articles are deleted. If set to 0, this option is not active. Note
542 that changing this setting won’t bring back the articles that were
543 deleted earlier; currently, there’s no non-hacky way to bring back
544 deleted articles. (example: keep-articles-days 30)
545 macro (parameters: <macro key> <command list>; default value: n/a)
547 With this command, you can define a macro key and specify a list of
548 commands that shall be executed when the macro prefix and the macro
549 key are pressed. (example: macro k open ; reload ; quit)
550 mark-as-read-on-hover (parameters: [yes/no]; default value: no)
552 If set to yes, then all articles that get selected in the article
553 list are marked as read. (example: mark-as-read-on-hover yes)
554 max-download-speed (parameters: <number>; default value: 0)
556 If set to a number great than 0, the download speed per download is
557 set to that limit (in kB). (example: max-download-speed 50)
558 max-browser-tabs (parameters: <number>; default value: 10)
560 Set the maximum number of articles to open in a browser when using
561 the open-all-unread-in-browser or
562 open-all-unread-in-browser-and-mark-read commands. (example:
563 max-browser-tabs 4)
564 max-items (parameters: <number>; default value: 0)
566 Set the number of articles to maximally keep per feed. If the
567 number is set to 0, then all articles are kept. (example: max-items
568 100)
569 newsblur-login (parameters: <login>; default value: "")
571 This variable sets your NewsBlur login for NewsBlur support.
572 (example: newsblur-login "your-login")
573 newsblur-min-items (parameters: <number>; default value: 20)
575 This variable sets the number of articles that are loaded from
576 NewsBlur per feed. (example: newsblur-min-items 100)
577 newsblur-password (parameters: <password>; default value: "")
579 This variable sets your NewsBlur password for NewsBlur support.
580 Double quotes should be escaped, i.e. you should write \" instead
581 of ". (example: newsblur-password "here_goesAquote:\"")
582 newsblur-passwordfile (parameters: <path>; default value: "")
584 A more secure alternative to the above, by storing your password
585 elsewhere in your system. (example: newsblur-passwordfile
586 "~/.newsboat/newsblur-pw.txt")
587 newsblur-passwordeval (parameters: <command>; default value: "")
589 Another secure alternative, is providing your password from an
590 external command that is evaluated during login. This can be used
591 to read your password from a gpg encrypted file or your system
592 keyring. (example: newsblur-passwordeval "command some-parameter")
593 newsblur-url (parameters: <url>; default value: "https://newsblur.com")
595 Configures the URL where the NewsBlur instance resides. (example:
596 newsblur-url "https://localhost")
597 notify-always (parameters: [yes/no]; default value: no)
599 If set to no, notifications will only be made when there are new
600 feeds or articles. If set to yes, notifications will be made
601 regardless. (example: notify-always yes)
602 notify-beep (parameters: [yes/no]; default value: no)
604 If set to yes, then the speaker beep on new articles. (example:
605 notify-beep yes)
606 notify-format (parameters: <string>; default value: "newsboat: finished
608 reload, %f unread feeds (%n unread articles total)")
609 Format string that is used for formatting notifications. See the
610 chapter on format strings for more information. (example:
611 notify-format "%d new articles (%n unread articles, %f unread
612 feeds)")
613 notify-program (parameters: <command>; default value: "")
615 If set, then the configured program will be executed if new
616 articles arrived (through a reload) or if notify-always is yes. The
617 first parameter of the called program contains the notification
618 message. In order to pass other hard-coded arguments to the
619 program, write an appropriate wrapper shell script and use it as
620 <command> instead. (example: notify-program "~/bin/my-notifier")
621 notify-screen (parameters: [yes/no]; default value: no)
623 If set to yes, then a "privacy message" will be sent to the
624 terminal, containing a notification message about new articles.
625 This is especially useful if you use terminal emulations such as
626 GNU screen which implement privacy messages. (example:
627 notify-screen yes)
628 notify-xterm (parameters: [yes/no]; default value: no)
630 If set to yes, then the xterm window title will be set to a
631 notification message about new articles. (example: notify-xterm
632 yes)
633 ocnews-flag-star (parameters: <character>; default value: "")
635 If set and ownCloud News support is used, then all articles that
636 are flagged with the specified flag are being "starred" in ownCloud
637 News. (example: ocnews-flag-star "s")
638 ocnews-login (parameters: <username>; default value: "")
640 Sets the username to use with the ownCloud instance. (example:
641 ocnews-login "user")
642 ocnews-password (parameters: <password>; default value: "")
644 Configures the password to use with the ownCloud instance. Double
645 quotes should be escaped, i.e. you should write \" instead of ".
646 (example: ocnews-password "here_goesAquote:\"")
647 ocnews-passwordfile (parameters: <path>; default value: "")
649 A more secure alternative to the above, by storing your password
650 elsewhere in your system. (example: ocnews-passwordfile
651 "~/.newsboat/ocnews-pw.txt")
652 ocnews-passwordeval (parameters: <command>; default value: "")
654 Another secure alternative, is providing your password from an
655 external command that is evaluated during login. This can be used
656 to read your password from a gpg encrypted file or your system
657 keyring. (example: ocnews-passwordeval "command some-parameter")
658 ocnews-url (parameters: <url>; default value: "")
660 Configures the URL where the ownCloud instance resides. (example:
661 ocnews-url "https://localhost/owncloud")
662 oldreader-flag-share (parameters: <flag>; default value: "")
664 If set and The Old Reader support is used, then all articles that
665 are flagged with the specified flag are being "shared" in The Old
666 Reader so that people that follow you can see it. (example:
667 oldreader-flag-share "a")
668 oldreader-flag-star (parameters: <flag>; default value: "")
670 If set and The Old Reader support is used, then all articles that
671 are flagged with the specified flag are being "starred" in The Old
672 Reader and appear in the list of "Starred items". (example:
673 oldreader-flag-star "b")
674 oldreader-login (parameters: <login>; default value: "")
676 This variable sets your The Old Reader login for The Older Reader
677 support. (example: oldreader-login "your-login")
678 oldreader-min-items (parameters: <number>; default value: 20)
680 This variable sets the number of articles that are loaded from The
681 Old Reader per feed. (example: oldreader-min-items 100)
682 oldreader-password (parameters: <password>; default value: "")
684 This variable sets your The Old Reader password for The Old Reader
685 support. Double quotes should be escaped, i.e. you should write \"
686 instead of ". (example: oldreader-password "here_goesAquote:\"")
687 oldreader-passwordfile (parameters: <path>; default value: "")
689 A more secure alternative to the above, by storing your password
690 elsewhere in your system. (example: oldreader-passwordfile
691 "~/.newsboat/oldreader-pw.txt")
692 oldreader-passwordeval (parameters: <command>; default value: "")
694 Another secure alternative, is providing your password from an
695 external command that is evaluated during login. This can be used
696 to read your password from a gpg encrypted file or your system
697 keyring. (example: oldreader-passwordeval "command some-parameter")
698 oldreader-show-special-feeds (parameters: [yes/no]; default value: yes)
700 If set and The Old reader support is used, then "special feeds"
701 like "People you follow" (articles shared by people you follow),
702 "Starred items" (your starred articles) and "Shared items" (your
703 shared articles) appear in your subscription list. (example:
704 oldreader-show-special-feeds "no")
705 openbrowser-and-mark-jumps-to-next-unread (parameters: [yes/no];
707 default value: no)
708 If set to yes, jump to the next unread item when an item is opened
709 in the browser and marked as read. (example:
710 openbrowser-and-mark-jumps-to-next-unread yes)
711 opml-url (parameters: <url> ...; default value: "")
713 If the OPML online subscription mode is enabled, then the list of
714 feeds will be taken from the OPML file found on this location.
715 Optionally, you can specify more than one URL. All the listed OPML
716 URLs will then be taken into account when loading the feed list.
717 (example: opml-url "http://host.domain.tld/blogroll.opml"
718 "http://example.com/anotheropmlfile.opml")
719 pager (parameters: [<command>/internal]; default value: internal)
721 If set to internal, then the internal pager will be used.
722 Otherwise, the article to be displayed will be rendered to be a
723 temporary file and then displayed with the configured pager. If the
724 command is set to an empty string, the content of the "PAGER"
725 environment variable will be used. If the command contains a
726 placeholder %f, it will be replaced with the temporary filename.
727 (example: pager "less %f")
728 podcast-auto-enqueue (parameters: [yes/no]; default value: no)
730 If set to yes, then all podcast URLs that are found in articles are
731 added to the podcast download queue. See the respective section in
732 the documentation for more information on podcast support in
733 newsboat. (example: podcast-auto-enqueue yes)
734 prepopulate-query-feeds (parameters: [yes/no]; default value: no)
736 If set to yes, then all query feeds are prepopulated with articles
737 on startup. (example: prepopulate-query-feeds yes)
738 ssl-verifyhost (parameters: [yes/no]; default value: yes)
740 If set to no, skip verification of the certificate’s name against
741 host. (example: ssl-verifyhost no)
742 ssl-verifypeer (parameters: [yes/no]; default value: yes)
744 If set to no, skip verification of the peer’s SSL certificate.
745 (example: ssl-verifypeer no)
746 proxy-auth-method (parameters: <method>; default value: any)
748 Set proxy authentication method. Allowed values: any, basic,
749 digest, digest_ie (only available with libcurl 7.19.3 and newer),
750 gssnegotiate, ntlm and anysafe. (example: proxy-auth-method ntlm)
751 proxy-auth (parameters: <auth>; default value: n/a)
753 Set the proxy authentication string. (example: proxy-auth
754 user:password)
755 proxy-type (parameters: <type>; default value: http)
757 Set proxy type. Allowed values: http, socks4, socks4a, socks5 and
758 socks5h. (example: proxy-type socks5)
759 proxy (parameters: <server:port>; default value: n/a)
761 Set the proxy to use for downloading RSS feeds. (Don’t forget to
762 actually enable the proxy with use-proxy yes.) (example: proxy
763 localhost:3128)
764 refresh-on-startup (parameters: [yes/no]; default value: no)
766 If set to yes, then all feeds will be reloaded when newsboat starts
767 up. This is equivalent to the -r commandline option. (example:
768 refresh-on-startup yes)
769 reload-only-visible-feeds (parameters: [yes/no]; default value: no)
771 If set to yes, then manually reloading all feeds will only reload
772 the currently visible feeds, e.g. if a filter or a tag is set.
773 (example: reload-only-visible-feeds yes)
774 reload-threads (parameters: <number>; default value: 1)
776 The number of parallel reload threads that shall be started when
777 all feeds are reloaded. (example: reload-threads 3)
778 reload-time (parameters: <number>; default value: 60)
780 The number of minutes between automatic reloads. (example:
781 reload-time 120)
782 reset-unread-on-update (parameters: <url> ...; default value: n/a)
784 With this configuration command, you can provide a list of RSS feed
785 URLs for whose articles the unread flag will be reset if an article
786 has been updated, i.e. its content has been changed. This is
787 especially useful for RSS feeds where single articles are updated
788 after publication, and you want to be notified of the updates.
789 (example: reset-unread-on-update
790 "http://blog.fefe.de/rss.xml?html")
791 save-path (parameters: <path-to-directory>; default value: ~/)
793 The default path where articles shall be saved to. If an invalid
794 path is specified, the current directory is used. (example:
795 save-path "~/Saved Articles")
796 search-highlight-colors (parameters: <fgcolor> <bgcolor> [<attribute>
798 ...]; default value: black yellow bold)
799 This configuration command specifies the highlighting colors when
800 searching for text from the article view. (example:
801 search-highlight-colors white black bold)
802 searchresult-title-format (parameters: <format>; default value: "%N %V
804 - Search result (%u unread, %t total)")
805 Format of the title in search result. See "Format Strings" section
806 of Newsboat manual for details on available formats. (example:
807 searchresult-title-format "Search result")
808 selectfilter-title-format (parameters: <format>; default value: "%N %V
810 - Select Filter")
811 Format of the title in filter selection dialog. See "Format
812 Strings" section of Newsboat manual for details on available
813 formats. (example: selectfilter-title-format "Select Filter")
814 selecttag-title-format (parameters: <format>; default value: "%N %V -
816 Select Tag")
817 Format of the title in tag selection dialog. See "Format Strings"
818 section of Newsboat manual for details on available formats.
819 (example: selecttag-title-format "Select Tag")
820 show-keymap-hint (parameters: [yes/no]; default value: yes)
822 If set to no, then the keymap hints on the bottom of screen will
823 not be displayed. (example: show-keymap-hint no)
824 show-read-articles (parameters: [yes/no]; default value: yes)
826 If set to yes, then all articles of a feed are listed in the
827 article list. If set to no, then only unread articles are listed.
828 (example: show-read-articles no)
829 show-read-feeds (parameters: [yes/no]; default value: yes)
831 If set to yes, then all feeds, including those without unread
832 articles, are listed. If set to no, then only feeds with one or
833 more unread articles are list. (example: show-read-feeds no)
834 suppress-first-reload (parameters: [yes/no]; default value: no)
836 If set to yes, then the first automatic reload will be suppressed
837 if auto-reload is set to yes. (example: suppress-first-reload yes)
838 swap-title-and-hints (parameters: [yes/no]; default value: no)
840 If set to yes, then the title at the top of screen and keymap hints
841 at the bottom of screen will be swapped. (example:
842 swap-title-and-hints yes)
843 text-width (parameters: <number>; default value: 0)
845 If set to a number greater than 0, all HTML will be rendered to
846 this maximum line length or the terminal width (whichever is
847 smaller). If set to 0, the terminal width will always be used. Does
848 not apply when using external renderer or viewing the source. Also
849 note that "Link" header and "Links" section won’t be affected by
850 it—they contain URLs which are better not wrapped. (example:
851 text-width 72)
852 toggleitemread-jumps-to-next-unread (parameters: [yes/no]; default
854 value: no)
855 If set to yes, jump to the next unread item when an item’s read
856 status is toggled in the article list. (example:
857 toggleitemread-jumps-to-next-unread yes)
858 ttrss-flag-publish (parameters: <character>; default value: "")
860 If set and Tiny Tiny RSS support is used, then all articles that
861 are flagged with the specified flag are being marked as "published"
862 in Tiny Tiny RSS. (example: ttrss-flag-publish "b")
863 ttrss-flag-star (parameters: <character>; default value: "")
865 If set and Tiny Tiny RSS support is used, then all articles that
866 are flagged with the specified flag are being "starred" in Tiny
867 Tiny RSS. (example: ttrss-flag-star "a")
868 ttrss-login (parameters: <username>; default value: "")
870 Sets the username for use with Tiny Tiny RSS. (example: ttrss-login
871 "admin")
872 ttrss-mode (parameters: [multi/single]; default value: multi)
874 Configures the mode in which Tiny Tiny RSS is used. In single-user
875 mode, login and password are used for HTTP authentication, while in
876 multi-user mode, they are used for authenticating with Tiny Tiny
877 RSS. (example: ttrss-mode "single")
878 ttrss-password (parameters: <password>; default value: "")
880 Configures the password for use with Tiny Tiny RSS. Double quotes
881 should be escaped, i.e. you should write \" instead of ". (example:
882 ttrss-password "here_goesAquote:\"")
883 ttrss-passwordfile (parameters: <path>; default value: "")
885 A more secure alternative to the above, by storing your password
886 elsewhere in your system. (example: ttrss-passwordfile
887 "~/.newsboat/ttrss-pw.txt")
888 ttrss-passwordeval (parameters: <command>; default value: "")
890 Another secure alternative, is providing your password from an
891 external command that is evaluated during login. This can be used
892 to read your password from a gpg encrypted file or your system
893 keyring. (example: ttrss-passwordeval "command some-parameter")
894 ttrss-url (parameters: <url>; default value: "")
896 Configures the URL where the Tiny Tiny RSS installation you want to
897 use resides. (example: ttrss-url "http://example.com/ttrss/")
898 unbind-key (parameters: <key> [<dialog>]; default value: n/a)
900 Unbind key <key>. This means that no operation is called when <key>
901 is pressed. If you provide "-a" as <key>, all currently bound keys
902 will become unbound. Optionally, you can specify a dialog (for a
903 list of available dialogs, see bind-key above). If you specify one,
904 the key binding will only be unbound for the specified dialog.
905 (example: unbind-key R)
906 urls-source (parameters: <source>; default value: "local")
908 This configuration command sets the source where URLs shall be
909 retrieved from. By default, this is ~/.newsboat/urls.
910 Alternatively, you can set it to opml, which enables newsboat’s
911 OPML online subscription mode, to ttrss which enables newsboat’s
912 Tiny Tiny RSS support, to oldreader, which enables newsboat’s The
913 Old Reader support, to newsblur, which enables NewsBlur support, or
914 feedhq for FeedHQ support, or ocnews for ownCloud News support, or
915 inoreader for Inoreader support. Query feed specifications will be
916 read from the local urls file regardless of this setting. (example:
917 urls-source "oldreader")
918 urlview-title-format (parameters: <format>; default value: "%N %V -
920 URLs")
921 Format of the title in URL view. See "Format Strings" section of
922 Newsboat manual for details on available formats. (example:
923 urlview-title-format "URLs")
924 use-proxy (parameters: [yes/no]; default value: no)
926 If set to yes, then the configured proxy will be used for
927 downloading the RSS feeds. (example: use-proxy yes)
928 user-agent (parameters: <string>; default value: "")
930 If set to a non-zero-length string, this value will be used as HTTP
931 User-Agent header for all HTTP requests. (example: user-agent
932 "Lynx/2.8.5rel.1 libwww-FM/2.14")
933
935 open (default key: ENTER)
936 Open the currently selected feed or article.
937 quit (default key: q)
939 Quit the program or return to the previous dialog (depending on the
940 context).
941 hard-quit (default key: Q)
943 Quit the program without confirmation.
944 reload (default key: r)
946 Reload the currently selected feed.
947 reload-all (default key: R)
949 Reload all feeds.
950 mark-feed-read (default key: A)
952 Mark all articles in the currently selected feed read.
953 mark-all-feeds-read (default key: C)
955 Mark articles in all feeds read.
956 mark-all-above-as-read (default key: n/a)
958 Mark all above as read.
959 save (default key: s)
961 Save the currently selected article to a file.
962 next-unread (default key: n)
964 Jump to the next unread article.
965 prev-unread (default key: p)
967 Jump to the previous unread article.
968 next (default key: J)
970 Jump to next article.
971 prev (default key: K)
973 Jump to previous article.
974 random-unread (default key: ^K)
976 Jump to a random unread article.
977 open-in-browser (default key: o)
979 Opens the URL associated with the current article.
980 open-in-browser-and-mark-read (default key: O)
982 Opens the URL associated with the current article and marks the
983 article as read.
984 open-all-unread-in-browser (default key: n/a)
986 Opens all the unread URLs in the current feed.
987 open-all-unread-in-browser-and-mark-read (default key: n/a)
989 Opens all the unread URLs in the current feed and marks them as
990 read.
991 help (default key: ?)
993 Runs the help screen.
994 toggle-source-view (default key: ^U)
996 Toggles between the HTML view and the source view in the article
997 view.
998 toggle-article-read (default key: N)
1000 Toggle the read flag for the currently selected article, and clears
1001 delete flag if set.
1002 toggle-show-read-feeds (default key: l)
1004 Toggle whether read feeds should be shown in the feed list.
1005 show-urls (default key: u)
1007 Show all URLs in the article in a list (similar to urlview).
1008 clear-tag (default key: ^T)
1010 Clear current tag.
1011 set-tag (default key: t)
1013 Select tag.
1014 open-search (default key: /)
1016 Opens the search dialog. When a search is done in the article list,
1017 then the search operation only applies to the articles of the
1018 current feed, otherwise to all articles.
1019 goto-url (default key: #)
1021 Open the URL dialog and then opens specified URL.
1022 enqueue (default key: e)
1024 Add the podcast download URL of the current article (if any is
1025 found) to the podcast download queue (see the respective section in
1026 the documentation for more information on podcast support).
1027 edit-urls (default key: E)
1029 Edit the list of subscribed URLs. newsboat will start the editor
1030 configured through the $VISUAL environment variable (if unset,
1031 $EDITOR is used; fallback: "vi"). When editing is finished,
1032 newsboat will reload the URLs file.
1033 reload-urls (default key: ^R)
1035 Reload the URLs configuration file.
1036 redraw (default key: ^L)
1038 Redraw the screen.
1039 cmdline (default key: <colon>)
1041 Open the command line.
1042 set-filter (default key: F)
1044 Set a filter.
1045 select-filter (default key: f)
1047 Select a predefined filter.
1048 clear-filter (default key: ^F)
1050 Clear currently set filter.
1051 bookmark (default key: ^B)
1053 Bookmark currently selected article or URL.
1054 edit-flags (default key: ^E)
1056 Edit the flags of the currently selected article.
1057 next-unread-feed (default key: ^N)
1059 Go to the next feed with unread articles. This only works from the
1060 article list.
1061 prev-unread-feed (default key: ^P)
1063 Go to the previous feed with unread articles. This only works from
1064 the article list.
1065 next-feed (default key: j)
1067 Go to the next feed. This only works from the article list.
1068 prev-feed (default key: k)
1070 Go to the previous feed. This only works from the article list.
1071 delete-article (default key: D)
1073 Delete the currently selected article.
1074 delete-all-articles (default key: ^D)
1076 Delete all articles in the current feed.
1077 purge-deleted (default key: $)
1079 Purge all article that are marked as deleted from the article list.
1080 view-dialogs (default key: v)
1082 View list of open dialogs.
1083 close-dialog (default key: ^X)
1085 Close currently selected dialog.
1086 next-dialog (default key: ^V)
1088 Go to next dialog.
1089 prev-dialog (default key: ^G)
1091 Go to previous dialog.
1092 pipe-to (default key: '')
1094 |Pipe article to command.
1095 sort (default key: g)
1097 Sort feeds/articles by interactively choosing the sort method.
1098 rev-sort (default key: G)
1100 Sort feeds/articles by interactively choosing the sort method
1101 (reversed).
1102 up (default key: UP)
1104 Goes up one item in the list.
1105 down (default key: DOWN)
1107 Goes down one item in the list.
1108 pageup (default key: PPAGE)
1110 Goes up one page in the list.
1111 pagedown (default key: NPAGE)
1113 Goes down one page in the list.
1114 home (default key: HOME)
1116 Goes to the first item in the list.
1117 end (default key: END)
1119 Goes to the last item in the list.
1120
1122 Newsboat comes with the possibility to categorize or "tag", as we call
1123 it, RSS feeds. Every RSS feed can be assigned 0 or more tags. Within
1124 newsboat, you can then select to only show RSS feeds that match a
1125 certain tag. That makes it easy to categorize your feeds in a flexible
1126 and powerful way.
1127 Usually, the ~/.newsboat/urls file contains one RSS feed URL per line.
1129 To assign a tag to an RSS feed, simply attach it as a single word,
1130 separated by blanks such as space or tab. If the tag needs to contain
1131 spaces, you must use quotes (") around the tag (see example below). An
1132 example ~/.newsboat/urls file may look like this:
1133 http://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
1135 http://rss.orf.at/news.xml news orf
1136 http://www.heise.de/newsticker/heise.rdf news interesting
1137 When you now start newsboat with this configuration, you can press "t"
1139 to select a tag. When you select the tag "news", you will see all three
1140 RSS feeds. Pressing "t" again and e.g. selecting the "conspiracy" tag,
1141 you will only see the http://blog.fefe.de/rss.xml?html RSS feed.
1142 Pressing "^T" clears the current tag, and again shows all RSS feeds,
1143 regardless of their assigned tags.
1144 A special type of tag are tags that start with the tilde character (~).
1146 When such a tag is found, the feed title is set to the tag name
1147 (excluding the ~ character). With this feature, you can give feeds any
1148 title you want in your feed list:
1149 http://rss.orf.at/news.xml "~ORF News"
1151 Another special type of tag are tags that start with the exclamation
1153 mark (!). When such a tag is found, the feed is hidden from the regular
1154 list of feeds and its content can only be found through a query feed.
1155 http://rss.orf.at/news.xml "!ORF News (hidden)"
1157
1159 Newsboat contains support for Snownews extensions. The RSS feed readers
1160 Snownews and Liferea share a common way of extending the readers with
1161 custom scripts. Two mechanisms, namely "execurl" and "filter" type
1162 scripts, are available and supported by newsboat.
1163 An "execurl" script can be any program that gets executed and whose
1165 output is interpreted as RSS feed, while "filter" scripts are fed with
1166 the content of a configured URL and whose output is interpreted as RSS
1167 feed.
1168 The configuration is simple and straight-forward. Just add to your
1170 ~/.newsboat/urls file configuration lines like the following ones:
1171 exec:~/bin/execurl-script
1173 filter:~/bin/filter-script:http://some.test/url
1174 The first line shows how to add an execurl script to your
1176 configuration: start the line with exec: and then immediately append
1177 the path of the script that shall be executed. If this script requires
1178 additional parameters, simply use quotes:
1179 "exec:~/bin/execurl-script param1 param2"
1181 The second line shows how to add a filter script to your configuration:
1183 start the line with filter:, then immediately append the path of the
1184 script, then append a colon (:), and then append the URL of the file
1185 that shall be fed to the script. Again, if the script requires any
1186 parameters, simply quote:
1187 "filter:~/bin/filter-script param1 param2:http://url/foobar"
1189 In both cases, the tagging feature as described above is still
1191 available:
1192 exec:~/bin/execurl-script tag1 tag2 "quoted tag"
1194 filter:~/bin/filter-script:http://some.test/url tag3 tag4 tag5
1195 If you need to write your own extension, see this short guide for an
1197 introduction. A collection of existing scripts might also help.
1198
1200 Like other text-oriented software, Newsboat contains an internal
1201 commandline to modify configuration variables ad hoc and to run own
1202 commands. It provides a flexible access to the functionality of
1203 Newsboat which is especially useful for advanced users.
1204 To start the commandline, type ":". You will see a ":" prompt at the
1206 bottom of the screen, similar to tools like vi(m) or mutt. You can now
1207 enter commands. Pressing the "Enter" key executes the command (possibly
1208 giving feedback to the user) and closes the commandline. You can cancel
1209 entering commands by pressing the "Esc" key. The history of all the
1210 commands that you enter will be saved to ~/.newsboat/history.cmdline.
1211 The backlog is limited to 100 entries by default, but can be influenced
1212 by setting the history-limit configuration variable. To disable history
1213 saving, set the history-limit to 0.
1214 The commandline provides you with some help if you can’t remember the
1216 full names of commandline commands. By pressing the "Tab" key, newsboat
1217 will try to automatically complete your command. If there is more than
1218 one possible completion, you can subsequently press the "Tab" key to
1219 cycle through all results. If no match is found, no suggestion will be
1220 inserted into the commandline. For the set command, the completion also
1221 works for configuration variable names.
1222 In addition, some common key combination such as "Ctrl-G" (to cancel
1224 input), "Ctrl-K" (to delete text from the cursor position to the end of
1225 line), "Ctrl-U" (to clear the whole line) and "Ctrl-W" (to delete the
1226 word before the current cursor position) were added.
1227 Please be aware that the input history of both the command line and the
1229 search functions are saved to the filesystems, to the files
1230 ~/.newsboat/history.cmdline resp. ~/.newsboat/history.search. By
1231 default, the last 100 entries are saved, but this can be configured
1232 (configuration variable history-limit) and also totally disabled (by
1233 setting said variable to 0).
1234 Currently, the following command line commands are available:
1236 quit
1238 Quit newsboat
1239 q
1241 Alias for quit
1242 save <filename>
1244 Save current article to <filename>
1245 set <variable>[=<value>|&|!]
1247 Set (or get) configuration variable value. Specifying a ! after
1248 the name of a boolean configuration variable toggles their values,
1249 a & directly after the name of a configuration variable of any type
1250 resets its value to the documented default value.
1251 tag <tagname>
1253 Select a certain tag
1254 goto <case-insensitive substring>
1256 Go to the next feed whose name contains the case-insensitive
1257 substring.
1258 source <filename> [...]
1260 Load the specified configuration files. This allows it to load
1261 alternative configuration files or reload already loaded
1262 configuration files on-the-fly from the filesystem.
1263 dumpconfig <filename>
1265 Save current internal state of configuration to file, so that it
1266 can be instantly reused as configuration file.
1267 <number>
1269 Jump to the <number>th entry in the current dialog
1270
1272 Newsboat defaults to storing everything in $HOME/.newsboat directory.
1273 If you prefer XDG, create $HOME/.config/newsboat and
1274 $HOME/.local/share/newsboat directories, and Newsboat will use them
1275 from there on.
1276 If you already have some files in $HOME/.newsboat/, move them as
1278 follows:
1279 config, urls
1281 to $HOME/.config/newsboat/
1282 cache.db, history.search, history.cmdline
1284 to $HOME/.local/share/newsboat/
1285 See also a corresponding section in podboat(1).
1287
1289 dotfiles
1290 $HOME/.newsboat/config
1291 $HOME/.newsboat/urls
1293 XDG
1295 $HOME/.config/newsboat/config
1296 $HOME/.config/newsboat/urls
1298
1300 BROWSER
1301 Tells Newsboat what browser to use if there is no "browser" setting
1302 in the config file. If this variable doesn’t exist, a default of
1303 lynx(1) will be used.
1304 CURL_CA_BUNDLE
1306 Tells Newsboat to use the specified certificate file to verify the
1307 peer. The file may contain multiple certificates. The
1308 certificate(s) must be in PEM format.
1309 This option is useful if your libcurl is built without useful
1311 certificate information, and you can’t rebuild the library
1312 yourself.
1313 TMPDIR
1315 Tells Newsboat to use the specified directory for storing temporary
1316 files. If this variable doesn’t exist, a default of /tmp will be
1317 used.
1318
1320 podboat(1)
1321
1323 Alexander Batischev <eual.jp@gmail.com>
1324 Author.
1325 02/28/2019 NEWSBOAT(1)