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 https://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 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 config, which is stored next to the urls file. 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 the
193 history.search file (stored next to the cache.db file). By default, the
194 last 100 search phrases are stored, but this limited can be influenced
195 through the history-limit configuration variable. To disable search
196 history saving, simply set 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 Specifies one or more feed URLs that should always be downloaded,
206 regardless of their Last-Modified timestamp and ETag header. This
207 option can be specified multiple times. (example: always-download
208 "https://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)%?F? matching filter `%F'&?
229 - %U")
230 Format of the title in article list. See "Format Strings" section
231 of Newsboat manual for details on available formats. (example:
232 articlelist-title-format "Articles in feed '%T' (%u unread)")
233 auto-reload (parameters: [yes/no]; default value: no)
235 If set to yes, all feeds will be automatically reloaded at start up
236 and then continuously after a certain time has passed (see
237 reload-time). (example: auto-reload yes)
238 bind-key (parameters: <key> <operation> [<dialog>]; default value: n/a)
240 Bind key <key> to <operation>. This means that whenever <key> is
241 pressed, then <operation> is executed (if applicable in the current
242 dialog). A list of available operations can be found below.
243 Optionally, you can specify a dialog. If you specify one, the key
244 binding will only be added to the specified dialog. Available
245 dialogs are all (default if none is specified), feedlist,
246 filebrowser, help, articlelist, article, tagselection,
247 filterselection, urlview, podboat, and dirbrowser. (example:
248 bind-key ^R reload-all)
249 bookmark-autopilot (parameters: [yes/no]; default value: no)
251 If set to yes, the configured bookmark command is executed without
252 any further input asked from user, unless the url or the title
253 cannot be found/guessed. (example: bookmark-autopilot yes)
254 bookmark-cmd (parameters: <command>; default value: "")
256 If set, then <command> will be used as bookmarking plugin. See the
257 documentation on bookmarking for further information. (example:
258 bookmark-cmd "~/bin/delicious-bookmark.sh")
259 bookmark-interactive (parameters: [yes/no]; default value: no)
261 If set to yes, then the configured bookmark command is an
262 interactive program. (example: bookmark-interactive yes)
263 browser (parameters: <command>; default value: %BROWSER, otherwise
265 lynx)
266 Set the browser command to use when opening an article in the
267 browser. If the BROWSER environment variable is set, it will be
268 used as the default browser, otherwise lynx will be used. Any
269 occurrences of %u in <command> will be replaced by a URL in single
270 quotes. (example: browser "w3m %u")
271 cache-file (parameters: <path>; default value: "~/.newsboat/cache.db"
273 or "~/.local/share/cache.db" (see "Files" section))
274 This configuration option sets the cache file. This is especially
275 useful if the filesystem of your home directory doesn’t support
276 proper locking (e.g. NFS). (example: cache-file
277 "/tmp/testcache.db")
278 cleanup-on-quit (parameters: [yes/no]; default value: yes)
280 If set to yes, then the cache gets locked and superfluous feeds and
281 items are removed, such as feeds that can’t be found in the urls
282 configuration file anymore. (example: cleanup-on-quit no)
283 color (parameters: <element> <fgcolor> <bgcolor> [<attribute> ...];
285 default value: n/a)
286 Set the foreground color, background color and optional attributes
287 for a certain element. (example: color background white black)
288 confirm-exit (parameters: [yes/no]; default value: no)
290 If set to yes, then newsboat will ask for confirmation whether the
291 user really wants to quit newsboat. (example: confirm-exit yes)
292 cookie-cache (parameters: <path>; default value: "")
294 Set a cookie cache. If set, cookies will be cached in (i.e. read
295 from and written to) this file, using Netscape format
296 <http://www.cookiecentral.com/faq/#3.5>. (example: cookie-cache
297 "~/.newsboat/cookies.txt")
298 datetime-format (parameters: <date/time format>; default value: %b %d)
300 This format specifies the date/time format in the article list. For
301 a detailed documentation on the allowed formats, consult the
302 manpage of strftime(3). (example: datetime-format "%D, %R")
303 define-filter (parameters: <name> <filterexpr>; default value: n/a)
305 With this command, you can predefine filters, which you can later
306 select from a list, and which are then applied after selection.
307 This is especially useful for filters that you need often and you
308 don’t want to enter them every time you need them. (example:
309 define-filter "all feeds with 'fun' tag" "tags # \"fun\"")
310 delete-read-articles-on-quit (parameters: [yes/no]; default value: no)
312 If set to yes, then all read articles will be deleted when you quit
313 newsboat. (example: delete-read-articles-on-quit yes)
314 dialogs-title-format (parameters: <format>; default value: "%N %V -
316 Dialogs")
317 Format of the title in dialog list. See "Format Strings" section of
318 Newsboat manual for details on available formats. (example:
319 dialogs-title-format "%N %V - Dialogs")
320 dirbrowser-title-format (parameters: <format>; default value: "%N %V -
322 %?O?Open Directory&Save File? - %f")
323 Format of the title in directory browser. See "Format Strings"
324 section of Newsboat manual for details on available formats.
325 (example: dirbrowser-file-format "%?O?Open Directory&Save File? -
326 %f")
327 display-article-progress (parameters: [yes/no]; default value: yes)
329 If set to yes, then a read progress (in percent) is displayed in
330 the article view. Otherwise, no read progress is displayed.
331 (example: display-article-progress no)
332 download-full-page (parameters: [yes/no]; default value: no)
334 If set to yes, then for all feed items with no content but with a
335 link, the link is downloaded and the result used as content
336 instead. This may significantly increase the download times of
337 "empty" feeds. (example: download-full-page yes)
338 download-retries (parameters: <number>; default value: 1)
340 How many times newsboat shall try to successfully download a feed
341 before giving up. This is an option to improve the success of
342 downloads on slow and shaky connections such as via a TOR proxy.
343 (example: download-retries 4)
344 download-timeout (parameters: <number>; default value: 30)
346 The number of seconds newsboat shall wait when downloading a feed
347 before giving up. This is an option to improve the success of
348 downloads on slow and shaky connections such as via a TOR proxy.
349 (example: download-timeout 60)
350 error-log (parameters: <path>; default value: "")
352 If set, then user errors (e.g. errors regarding defunct RSS feeds)
353 will be logged to this file. (example: error-log
354 "~/.newsboat/error.log")
355 external-url-viewer (parameters: <command>; default value: "")
357 If set, then show-urls will pipe the current article to a specific
358 external tool instead of using the internal URL viewer. This can be
359 used to integrate tools such as urlview. (example:
360 external-url-viewer "urlview")
361 feed-sort-order (parameters: <sortfield>[-<direction>]; default value:
363 none)
364 The <sortfield> specifies which feed property shall be used for
365 sorting; currently available are: firsttag, title, articlecount,
366 unreadarticlecount, lastupdated and none. The optional <direction>
367 specifies the sort direction. asc specifies ascending sorting, desc
368 specifies descending sorting. desc is the default. (example:
369 feed-sort-order firsttag)
370 feedhq-flag-share (parameters: <flag>; default value: "")
372 If set and FeedHQ support is used, then all articles that are
373 flagged with the specified flag are being "shared" in FeedHQ so
374 that people that follow you can see it. (example: feedhq-flag-share
375 "a")
376 feedhq-flag-star (parameters: <flag>; default value: "")
378 If set and FeedHQ support is used, then all articles that are
379 flagged with the specified flag are being "starred" in FeedHQ and
380 appear in the list of "Starred items". (example: feedhq-flag-star
381 "b")
382 feedhq-login (parameters: <login>; default value: "")
384 This variable sets your FeedHQ login for FeedHQ support. (example:
385 feedhq-login "your-login")
386 feedhq-min-items (parameters: <number>; default value: 20)
388 This variable sets the number of articles that are loaded from
389 FeedHQ per feed. (example: feedhq-min-items 100)
390 feedhq-password (parameters: <password>; default value: "")
392 This variable sets your FeedHQ password for FeedHQ support. Double
393 quotes should be escaped, i.e. you should write \" instead of ".
394 (example: feedhq-password "here_goesAquote:\"")
395 feedhq-passwordfile (parameters: <path>; default value: "")
397 A more secure alternative to the above, by storing your password
398 elsewhere in your system. (example: feedhq-passwordfile
399 "~/.newsboat/feedhq-pw.txt")
400 feedhq-passwordeval (parameters: <command>; default value: "")
402 Another secure alternative, is providing your password from an
403 external command that is evaluated during login. This can be used
404 to read your password from a gpg encrypted file or your system
405 keyring. (example: feedhq-passwordeval "gpg --decrypt
406 ~/.newsboat/feedhq-password.gpg")
407 feedhq-show-special-feeds (parameters: [yes/no]; default value: yes)
409 If set and FeedHQ support is used, then "special feeds" like
410 "People you follow" (articles shared by people you follow),
411 "Starred items" (your starred articles) and "Shared items" (your
412 shared articles) appear in your subscription list. (example:
413 feedhq-show-special-feeds "no")
414 feedhq-url (parameters: <url>; default value: "https://feedhq.org/")
416 Configures the URL where your FeedHQ instance resides. (example:
417 feedhq-url "https://feedhq.example.com/")
418 feedlist-format (parameters: <format>; default value: "%4i %n %11u %t")
420 This variable defines the format of entries in the feed list. See
421 the respective section in the documentation for more information on
422 format strings. (example: feedlist-format " %n %4i - %11u -%> %t")
423 feedlist-title-format (parameters: <format>; default value: "%N %V -
425 %?F?Feeds&Your feeds? (%u unread, %t total)%?F? matching filter
426 `%F'&?%?T? - tag `%T'&?")
427 Format of the title in feed list. See "Format Strings" section of
428 Newsboat manual for details on available formats. (example:
429 feedlist-title-format "Feeds (%u unread, %t total)")
430 filebrowser-title-format (parameters: <format>; default value: "%N %V -
432 %?O?Open File&Save File? - %f")
433 Format of the title in file browser. See "Format Strings" section
434 of Newsboat manual for details on available formats. (example:
435 filebrowser-title-format "%?O?Open File&Save File? - %f")
436 goto-first-unread (parameters: [yes/no]; default value: yes)
438 If set to yes, then the first unread article will be selected
439 whenever a feed is entered. (example: goto-first-unread no)
440 goto-next-feed (parameters: [yes/no]; default value: yes)
442 If set to yes, then the next-unread, prev-unread and random-unread
443 keys will search in other feeds for unread articles if all articles
444 in the current feed are read. If set to no, then these keys will
445 stop in the current feed. (example: goto-next-feed no)
446 help-title-format (parameters: <format>; default value: "%N %V - Help")
448 Format of the title in help window. See "Format Strings" section of
449 Newsboat manual for details on available formats. (example:
450 help-title-format "%N %V - Help")
451 highlight (parameters: <target> <regex> <fgcolor> [<bgcolor>
453 [<attribute> ...]]; default value: n/a)
454 With this command, you can highlight text parts in the feed list,
455 the article list and the article view. For a detailed
456 documentation, see the chapter on highlighting. (example: highlight
457 all "newsboat" red)
458 highlight-article (parameters: <filterexpr> <fgcolor> <bgcolor>
460 [<attribute> ...]; default value: n/a)
461 With this command, you can highlight articles in the article list
462 if they match a filter expression. For a detailed documentation,
463 see the chapter on highlighting. (example: highlight-article
464 "author =~ \"Andreas Krennmair\"" white red bold)
465 history-limit (parameters: <number>; default value: 100)
467 Defines the maximum number of entries of commandline resp. search
468 history to be saved. To disable history saving, set it to 0.
469 (example: history-limit 0)
470 html-renderer (parameters: <command>; default value: internal)
472 If set to internal, then the internal HTML renderer will be used.
473 Otherwise, the specified command will be executed, the HTML to be
474 rendered will be written to the command’s stdin, and the program’s
475 output will be displayed. This makes it possible to use other,
476 external programs, such as w3m, links or lynx, to render HTML.
477 (example: html-renderer "w3m -dump -T text/html")
478 http-auth-method (parameters: <method>; default value: any)
480 Set HTTP authentication method. Allowed values: any, basic, digest,
481 digest_ie (only available with libcurl 7.19.3 and newer),
482 gssnegotiate, ntlm and anysafe. (example: http-auth-method digest)
483 ignore-article (parameters: <feed> <filterexpr>; default value: n/a)
485 If a downloaded article from <feed> matches <filterexpr>, then it
486 is ignored and not presented to the user. This command is further
487 explained in the "kill file" section below. (example:
488 ignore-article "*" "title =~ \"Windows\"")
489 ignore-mode (parameters: [download/display]; default value: download)
491 This configuration option defines in what way an article is ignored
492 (see ignore-article). If set to download, then it is ignored in the
493 download/parsing phase and thus never written to the cache, if it
494 set to display, it is ignored when displaying articles but is kept
495 in the cache. (example: ignore-mode "display")
496 include (parameters: <path>; default value: n/a)
498 With this command, you can include other files to be interpreted as
499 configuration files. This is especially useful to separate your
500 configuration into several files, e.g. key configuration, color
501 configuration, ... (example: include "~/.newsboat/colors")
502 itemview-title-format (parameters: <format>; default value: "%N %V -
504 Article '%T' (%u unread, %t total)")
505 Format of the title in article view. See "Format Strings" section
506 of Newsboat manual for details on available formats. (example:
507 itemview-title-format "Article '%T'")
508 inoreader-app-id (parameters: <string>; default value: "")
510 Unique application ID issued by Inoreader. See "Inoreader" section.
511 (example: inoreader-app-id "123456789")
512 inoreader-app-key (parameters: <string>; default value: "")
514 Application key issued by Inoreader. See "Inoreader" section.
515 (example: inoreader-app-key "TmV3c2JvYXQgcm9ja3MgOikK")
516 inoreader-flag-share (parameters: <flag>; default value: "")
518 If set and Inoreader support is used, then all articles that are
519 flagged with the specified flag are being "shared" in Inoreader so
520 that people that follow you can see it. (example:
521 inoreader-flag-share "a")
522 inoreader-flag-star (parameters: <flag>; default value: "")
524 If set and Inoreader support is used, then all articles that are
525 flagged with the specified flag are being "starred" in Inoreader
526 and appear in the list of "Starred items". (example:
527 inoreader-flag-star "b")
528 inoreader-login (parameters: <login>; default value: "")
530 This variable sets your Inoreader login for Inoreader support.
531 (example: inoreader-login "your-login")
532 inoreader-min-items (parameters: <number>; default value: 20)
534 This variable sets the number of articles that are loaded from
535 Inoreader per feed. (example: inoreader-min-items 100)
536 inoreader-password (parameters: <password>; default value: "")
538 This variable sets your Inoreader password for Inoreader support.
539 Double quotes should be escaped, i.e. you should write \" instead
540 of ". (example: inoreader-password "here_goesAquote:\"")
541 inoreader-passwordfile (parameters: <path>; default value: "")
543 A more secure alternative to the above, by storing your password
544 elsewhere in your system. (example: inoreader-passwordfile
545 "~/.newsboat/inoreader-pw.txt")
546 inoreader-passwordeval (parameters: <command>; default value: "")
548 Another secure alternative, is providing your password from an
549 external command that is evaluated during login. This can be used
550 to read your password from a gpg encrypted file or your system
551 keyring. (example: inoreader-passwordeval "gpg --decrypt
552 ~/.newsboat/inoreader-password.gpg")
553 inoreader-show-special-feeds (parameters: [yes/no]; default value: yes)
555 If set and Inoreader support is used, then "special feeds" like
556 "Starred items" (your starred articles) and "Shared items" (your
557 shared articles) appear in your subscription list. (example:
558 inoreader-show-special-feeds "no")
559 keep-articles-days (parameters: <number>; default value: 0)
561 If set to a number greater than 0, only articles that were
562 published within the last <number> days are kept, and older
563 articles are deleted. If set to 0, this option is not active. Note
564 that changing this setting won’t bring back the articles that were
565 deleted earlier; currently, there’s no non-hacky way to bring back
566 deleted articles. (example: keep-articles-days 30)
567 macro (parameters: <macro key> <command list>; default value: n/a)
569 With this command, you can define a macro key and specify a list of
570 commands that shall be executed when the macro prefix and the macro
571 key are pressed. (example: macro k open ; reload ; quit)
572 mark-as-read-on-hover (parameters: [yes/no]; default value: no)
574 If set to yes, then all articles that get selected in the article
575 list are marked as read. (example: mark-as-read-on-hover yes)
576 max-download-speed (parameters: <number>; default value: 0)
578 If set to a number greater than 0, the download speed per download
579 is set to that limit (in KB/s). (example: max-download-speed 50)
580 max-browser-tabs (parameters: <number>; default value: 10)
582 Set the maximum number of articles to open in a browser when using
583 the open-all-unread-in-browser or
584 open-all-unread-in-browser-and-mark-read commands. (example:
585 max-browser-tabs 4)
586 max-items (parameters: <number>; default value: 0)
588 Set the number of articles to maximally keep per feed. If the
589 number is set to 0, then all articles are kept. (example: max-items
590 100)
591 newsblur-login (parameters: <login>; default value: "")
593 This variable sets your NewsBlur login for NewsBlur support.
594 (example: newsblur-login "your-login")
595 newsblur-min-items (parameters: <number>; default value: 20)
597 This variable sets the number of articles that are loaded from
598 NewsBlur per feed. (example: newsblur-min-items 100)
599 newsblur-password (parameters: <password>; default value: "")
601 This variable sets your NewsBlur password for NewsBlur support.
602 Double quotes should be escaped, i.e. you should write \" instead
603 of ". (example: newsblur-password "here_goesAquote:\"")
604 newsblur-passwordfile (parameters: <path>; default value: "")
606 A more secure alternative to the above, by storing your password
607 elsewhere in your system. (example: newsblur-passwordfile
608 "~/.newsboat/newsblur-pw.txt")
609 newsblur-passwordeval (parameters: <command>; default value: "")
611 Another secure alternative, is providing your password from an
612 external command that is evaluated during login. This can be used
613 to read your password from a gpg encrypted file or your system
614 keyring. (example: newsblur-passwordeval "gpg --decrypt
615 ~/.newsboat/newsblur-password.gpg")
616 newsblur-url (parameters: <url>; default value: "https://newsblur.com")
618 Configures the URL where the NewsBlur instance resides. (example:
619 newsblur-url "https://localhost")
620 notify-always (parameters: [yes/no]; default value: no)
622 If set to no, notifications will only be made when there are new
623 feeds or articles. If set to yes, notifications will be made
624 regardless. (example: notify-always yes)
625 notify-beep (parameters: [yes/no]; default value: no)
627 If set to yes, then the speaker will beep on new articles.
628 (example: notify-beep yes)
629 notify-format (parameters: <string>; default value: "newsboat: finished
631 reload, %f unread feeds (%n unread articles total)")
632 Format string that is used for formatting notifications. See the
633 chapter on format strings for more information. (example:
634 notify-format "%d new articles (%n unread articles, %f unread
635 feeds)")
636 notify-program (parameters: <command>; default value: "")
638 If set, then the configured program will be executed if new
639 articles arrived (through a reload) or if notify-always is yes. The
640 first parameter of the called program contains the notification
641 message. In order to pass other hard-coded arguments to the
642 program, write an appropriate wrapper shell script and use it as
643 <command> instead. (example: notify-program "~/bin/my-notifier")
644 notify-screen (parameters: [yes/no]; default value: no)
646 If set to yes, then a "privacy message" will be sent to the
647 terminal, containing a notification message about new articles.
648 This is especially useful if you use terminal emulations such as
649 GNU screen which implement privacy messages. (example:
650 notify-screen yes)
651 notify-xterm (parameters: [yes/no]; default value: no)
653 If set to yes, then the xterm window title will be set to a
654 notification message about new articles. (example: notify-xterm
655 yes)
656 ocnews-flag-star (parameters: <character>; default value: "")
658 If set and ownCloud News support is used, then all articles that
659 are flagged with the specified flag are being "starred" in ownCloud
660 News. (example: ocnews-flag-star "s")
661 ocnews-login (parameters: <username>; default value: "")
663 Sets the username to use with the ownCloud instance. (example:
664 ocnews-login "user")
665 ocnews-password (parameters: <password>; default value: "")
667 Configures the password to use with the ownCloud instance. Double
668 quotes should be escaped, i.e. you should write \" instead of ".
669 (example: ocnews-password "here_goesAquote:\"")
670 ocnews-passwordfile (parameters: <path>; default value: "")
672 A more secure alternative to the above, by storing your password
673 elsewhere in your system. (example: ocnews-passwordfile
674 "~/.newsboat/ocnews-pw.txt")
675 ocnews-passwordeval (parameters: <command>; default value: "")
677 Another secure alternative, is providing your password from an
678 external command that is evaluated during login. This can be used
679 to read your password from a gpg encrypted file or your system
680 keyring. (example: ocnews-passwordeval "gpg --decrypt
681 ~/.newsboat/ocnews-password.gpg")
682 ocnews-url (parameters: <url>; default value: "")
684 Configures the URL where the ownCloud instance resides. (example:
685 ocnews-url "https://localhost/owncloud")
686 oldreader-flag-share (parameters: <flag>; default value: "")
688 If set and The Old Reader support is used, then all articles that
689 are flagged with the specified flag are being "shared" in The Old
690 Reader so that people that follow you can see it. (example:
691 oldreader-flag-share "a")
692 oldreader-flag-star (parameters: <flag>; default value: "")
694 If set and The Old Reader support is used, then all articles that
695 are flagged with the specified flag are being "starred" in The Old
696 Reader and appear in the list of "Starred items". (example:
697 oldreader-flag-star "b")
698 oldreader-login (parameters: <login>; default value: "")
700 This variable sets your The Old Reader login for The Older Reader
701 support. (example: oldreader-login "your-login")
702 oldreader-min-items (parameters: <number>; default value: 20)
704 This variable sets the number of articles that are loaded from The
705 Old Reader per feed. (example: oldreader-min-items 100)
706 oldreader-password (parameters: <password>; default value: "")
708 This variable sets your The Old Reader password for The Old Reader
709 support. Double quotes should be escaped, i.e. you should write \"
710 instead of ". (example: oldreader-password "here_goesAquote:\"")
711 oldreader-passwordfile (parameters: <path>; default value: "")
713 A more secure alternative to the above, by storing your password
714 elsewhere in your system. (example: oldreader-passwordfile
715 "~/.newsboat/oldreader-pw.txt")
716 oldreader-passwordeval (parameters: <command>; default value: "")
718 Another secure alternative, is providing your password from an
719 external command that is evaluated during login. This can be used
720 to read your password from a gpg encrypted file or your system
721 keyring. (example: oldreader-passwordeval "gpg --decrypt
722 ~/.newsboat/oldreader-password.gpg")
723 oldreader-show-special-feeds (parameters: [yes/no]; default value: yes)
725 If set and The Old reader support is used, then "special feeds"
726 like "People you follow" (articles shared by people you follow),
727 "Starred items" (your starred articles) and "Shared items" (your
728 shared articles) appear in your subscription list. (example:
729 oldreader-show-special-feeds "no")
730 openbrowser-and-mark-jumps-to-next-unread (parameters: [yes/no];
732 default value: no)
733 If set to yes, jump to the next unread item when an item is opened
734 in the browser and marked as read. (example:
735 openbrowser-and-mark-jumps-to-next-unread yes)
736 opml-url (parameters: <url> ...; default value: "")
738 If the OPML online subscription mode is enabled, then the list of
739 feeds will be taken from the OPML file found on this location.
740 Optionally, you can specify more than one URL. All the listed OPML
741 URLs will then be taken into account when loading the feed list.
742 (example: opml-url "https://host.domain.tld/blogroll.opml"
743 "https://example.com/anotheropmlfile.opml")
744 pager (parameters: [<command>/internal]; default value: internal)
746 If set to internal, then the internal pager will be used.
747 Otherwise, the article to be displayed will be rendered to be a
748 temporary file and then displayed with the configured pager. If the
749 command is set to an empty string, the content of the PAGER
750 environment variable will be used. If the command contains a
751 placeholder %f, it will be replaced with the temporary filename.
752 (example: pager "less %f")
753 podcast-auto-enqueue (parameters: [yes/no]; default value: no)
755 If set to yes, then all podcast URLs that are found in articles are
756 added to the podcast download queue. See the respective section in
757 the documentation for more information on podcast support in
758 newsboat. (example: podcast-auto-enqueue yes)
759 prepopulate-query-feeds (parameters: [yes/no]; default value: no)
761 If set to yes, then all query feeds are prepopulated with articles
762 on startup. (example: prepopulate-query-feeds yes)
763 ssl-verifyhost (parameters: [yes/no]; default value: yes)
765 If set to no, skip verification of the certificate’s name against
766 host. (example: ssl-verifyhost no)
767 ssl-verifypeer (parameters: [yes/no]; default value: yes)
769 If set to no, skip verification of the peer’s SSL certificate.
770 (example: ssl-verifypeer no)
771 proxy-auth-method (parameters: <method>; default value: any)
773 Set proxy authentication method. Allowed values: any, basic,
774 digest, digest_ie (only available with libcurl 7.19.3 and newer),
775 gssnegotiate, ntlm and anysafe. (example: proxy-auth-method ntlm)
776 proxy-auth (parameters: <auth>; default value: n/a)
778 Set the proxy authentication string. (example: proxy-auth
779 user:password)
780 proxy-type (parameters: <type>; default value: http)
782 Set proxy type. Allowed values: http, socks4, socks4a, socks5 and
783 socks5h. (example: proxy-type socks5)
784 proxy (parameters: <server:port>; default value: n/a)
786 Set the proxy to use for downloading RSS feeds. (Don’t forget to
787 actually enable the proxy with use-proxy yes.) (example: proxy
788 localhost:3128)
789 refresh-on-startup (parameters: [yes/no]; default value: no)
791 If set to yes, then all feeds will be reloaded when newsboat starts
792 up. This is equivalent to the -r commandline option. (example:
793 refresh-on-startup yes)
794 reload-only-visible-feeds (parameters: [yes/no]; default value: no)
796 If set to yes, then manually reloading all feeds will only reload
797 the currently visible feeds, e.g. if a filter or a tag is set.
798 (example: reload-only-visible-feeds yes)
799 reload-threads (parameters: <number>; default value: 1)
801 The number of parallel reload threads that shall be started when
802 all feeds are reloaded. (example: reload-threads 3)
803 reload-time (parameters: <number>; default value: 60)
805 The number of minutes between automatic reloads. (example:
806 reload-time 120)
807 reset-unread-on-update (parameters: <url> [<url>...]; default value:
809 n/a)
810 Specifies one or more feed URLs for whose articles the unread flag
811 will be reset if an article has been updated, i.e. its content has
812 been changed. This is especially useful for RSS feeds where single
813 articles are updated after publication, and you want to be notified
814 of the updates. This option can be specified multiple times.
815 (example: reset-unread-on-update
816 "https://blog.fefe.de/rss.xml?html")
817 save-path (parameters: <path-to-directory>; default value: ~/)
819 The default path where articles shall be saved to. If an invalid
820 path is specified, the current directory is used. (example:
821 save-path "~/Saved Articles")
822 search-highlight-colors (parameters: <fgcolor> <bgcolor> [<attribute>
824 ...]; default value: black yellow bold)
825 This configuration command specifies the highlighting colors when
826 searching for text from the article view. (example:
827 search-highlight-colors white black bold)
828 searchresult-title-format (parameters: <format>; default value: "%N %V
830 - Search results (%u unread, %t total)%?F? matching filter `%F'&?")
831 Format of the title in search result. See "Format Strings" section
832 of Newsboat manual for details on available formats. (example:
833 searchresult-title-format "Search result")
834 selectfilter-title-format (parameters: <format>; default value: "%N %V
836 - Select Filter")
837 Format of the title in filter selection dialog. See "Format
838 Strings" section of Newsboat manual for details on available
839 formats. (example: selectfilter-title-format "Select Filter")
840 selecttag-format (parameters: <format>; default value: "%4i %T (%u)")
842 Format of the lines in "Select tag" dialog. See the respective
843 section in the documentation for more information on format
844 strings. (example: selecttag-format "[%2i] %T (%n unread articles
845 in %f feeds, %u feeds total)")
846 selecttag-title-format (parameters: <format>; default value: "%N %V -
848 Select Tag")
849 Format of the title in tag selection dialog. See "Format Strings"
850 section of Newsboat manual for details on available formats.
851 (example: selecttag-title-format "Select Tag")
852 show-keymap-hint (parameters: [yes/no]; default value: yes)
854 If set to no, then the keymap hints on the bottom of screen will
855 not be displayed. (example: show-keymap-hint no)
856 show-title-bar (parameters: [yes/no]; default value: yes)
858 If set to no, then the title bar on the top of the screen will not
859 be displayed. (example: show-title-bar no)
860 show-read-articles (parameters: [yes/no]; default value: yes)
862 If set to yes, then all articles of a feed are listed in the
863 article list. If set to no, then only unread articles are listed.
864 (example: show-read-articles no)
865 show-read-feeds (parameters: [yes/no]; default value: yes)
867 If set to yes, then all feeds, including those without unread
868 articles, are listed. If set to no, then only feeds with one or
869 more unread articles are list. (example: show-read-feeds no)
870 suppress-first-reload (parameters: [yes/no]; default value: no)
872 If set to yes, then the first automatic reload will be suppressed
873 if auto-reload is set to yes. (example: suppress-first-reload yes)
874 swap-title-and-hints (parameters: [yes/no]; default value: no)
876 If set to yes, then the title at the top of screen and keymap hints
877 at the bottom of screen will be swapped. (example:
878 swap-title-and-hints yes)
879 text-width (parameters: <number>; default value: 0)
881 If set to a number greater than 0, all HTML will be rendered to
882 this maximum line length or the terminal width (whichever is
883 smaller). If set to 0, the terminal width will always be used. Does
884 not apply when using external renderer or viewing the source. Also
885 note that "Link" header and "Links" section won’t be affected by
886 it—they contain URLs which are better not wrapped. (example:
887 text-width 72)
888 toggleitemread-jumps-to-next-unread (parameters: [yes/no]; default
890 value: no)
891 If set to yes, jump to the next unread item when an item’s read
892 status is toggled in the article list. (example:
893 toggleitemread-jumps-to-next-unread yes)
894 ttrss-flag-publish (parameters: <character>; default value: "")
896 If set and Tiny Tiny RSS support is used, then all articles that
897 are flagged with the specified flag are being marked as "published"
898 in Tiny Tiny RSS. (example: ttrss-flag-publish "b")
899 ttrss-flag-star (parameters: <character>; default value: "")
901 If set and Tiny Tiny RSS support is used, then all articles that
902 are flagged with the specified flag are being "starred" in Tiny
903 Tiny RSS. (example: ttrss-flag-star "a")
904 ttrss-login (parameters: <username>; default value: "")
906 Sets the username for use with Tiny Tiny RSS. (example: ttrss-login
907 "admin")
908 ttrss-mode (parameters: [multi/single]; default value: multi)
910 Configures the mode in which Tiny Tiny RSS is used. In single-user
911 mode, login and password are used for HTTP authentication, while in
912 multi-user mode, they are used for authenticating with Tiny Tiny
913 RSS. (example: ttrss-mode "single")
914 ttrss-password (parameters: <password>; default value: "")
916 Configures the password for use with Tiny Tiny RSS. Double quotes
917 should be escaped, i.e. you should write \" instead of ". (example:
918 ttrss-password "here_goesAquote:\"")
919 ttrss-passwordfile (parameters: <path>; default value: "")
921 A more secure alternative to the above, by storing your password
922 elsewhere in your system. (example: ttrss-passwordfile
923 "~/.newsboat/ttrss-pw.txt")
924 ttrss-passwordeval (parameters: <command>; default value: "")
926 Another secure alternative, is providing your password from an
927 external command that is evaluated during login. This can be used
928 to read your password from a gpg encrypted file or your system
929 keyring. (example: ttrss-passwordeval "gpg --decrypt
930 ~/.newsboat/ttrss-password.gpg")
931 ttrss-url (parameters: <url>; default value: "")
933 Configures the URL where the Tiny Tiny RSS installation you want to
934 use resides. (example: ttrss-url "https://example.com/ttrss/")
935 unbind-key (parameters: <key> [<dialog>]; default value: n/a)
937 Unbind key <key>. This means that no operation is called when <key>
938 is pressed. If you provide "-a" as <key>, all currently bound keys
939 will become unbound. Optionally, you can specify a dialog (for a
940 list of available dialogs, see bind-key above). If you specify one,
941 the key binding will only be unbound for the specified dialog.
942 (example: unbind-key R)
943 urls-source (parameters: <source>; default value: "local")
945 This configuration command sets the source where URLs shall be
946 retrieved from. By default, this is the urls file. Alternatively,
947 you can set it to opml, which enables newsboat’s OPML online
948 subscription mode, to ttrss which enables newsboat’s Tiny Tiny RSS
949 support, to oldreader, which enables newsboat’s The Old Reader
950 support, to newsblur, which enables NewsBlur support, or feedhq for
951 FeedHQ support, or ocnews for ownCloud News support, or inoreader
952 for Inoreader support. Query feed specifications will be read from
953 the local urls file regardless of this setting. (example:
954 urls-source "oldreader")
955 urlview-title-format (parameters: <format>; default value: "%N %V -
957 URLs")
958 Format of the title in URL view. See "Format Strings" section of
959 Newsboat manual for details on available formats. (example:
960 urlview-title-format "URLs")
961 use-proxy (parameters: [yes/no]; default value: no)
963 If set to yes, then the configured proxy will be used for
964 downloading the RSS feeds. (example: use-proxy yes)
965 user-agent (parameters: <string>; default value: "")
967 If set to a non-zero-length string, this value will be used as HTTP
968 User-Agent header for all HTTP requests. (example: user-agent
969 "Lynx/2.8.5rel.1 libwww-FM/2.14")
970 wrap-scroll (parameters: [yes/no]; default value: no)
972 If set to yes, moving down while on the last item in a list will
973 wrap around to the top and vice versa. (example: wrap-scroll yes)
974
976 open (default key: ENTER)
977 Open the currently selected feed or article.
978 quit (default key: q)
980 Quit the program or return to the previous dialog (depending on the
981 context).
982 hard-quit (default key: Q)
984 Quit the program without confirmation.
985 reload (default key: r)
987 Reload the currently selected feed.
988 reload-all (default key: R)
990 Reload all feeds.
991 mark-feed-read (default key: A)
993 Mark all articles in the currently selected feed read.
994 mark-all-feeds-read (default key: C)
996 Mark articles in all feeds read.
997 mark-all-above-as-read (default key: n/a)
999 Mark all above as read.
1000 save (default key: s)
1002 Save the currently selected article to a file.
1003 save-all (default key: n/a)
1005 Save all articles from currently selected feed.
1006 next-unread (default key: n)
1008 Jump to the next unread article.
1009 prev-unread (default key: p)
1011 Jump to the previous unread article.
1012 next (default key: J)
1014 Jump to next article.
1015 prev (default key: K)
1017 Jump to previous article.
1018 random-unread (default key: ^K)
1020 Jump to a random unread article.
1021 open-in-browser (default key: o)
1023 Open the URL associated with the current article, or selection when
1024 in the URL view.
1025 open-in-browser-and-mark-read (default key: O)
1027 Open the URL associated with the current article, or selection when
1028 in the URL view. When used in the article view, it will also mark
1029 the article as read.
1030 open-all-unread-in-browser (default key: n/a)
1032 Open all the unread URLs in the current feed.
1033 open-all-unread-in-browser-and-mark-read (default key: n/a)
1035 Open all the unread URLs in the current feed and mark them as read.
1036 help (default key: ?)
1038 Run the help screen.
1039 toggle-source-view (default key: ^U)
1041 Toggle between the HTML view and the source view in the article
1042 view.
1043 toggle-article-read (default key: N)
1045 Toggle the read flag for the currently selected article, and clear
1046 the delete flag if set.
1047 toggle-show-read-feeds (default key: l)
1049 Toggle whether read feeds should be shown in the feed list.
1050 show-urls (default key: u)
1052 Show all URLs in the article in a list (similar to urlview).
1053 clear-tag (default key: ^T)
1055 Clear current tag.
1056 set-tag (default key: t)
1058 Select tag.
1059 open-search (default key: /)
1061 Open the search dialog. When a search is done in the article list,
1062 then the search operation only applies to the articles of the
1063 current feed, otherwise to all articles.
1064 goto-url (default key: #)
1066 Open the URL dialog and then open a specified URL.
1067 enqueue (default key: e)
1069 Add the podcast download URL of the current article (if any is
1070 found) to the podcast download queue (see the respective section in
1071 the documentation for more information on podcast support).
1072 edit-urls (default key: E)
1074 Edit the list of subscribed URLs. newsboat will start the editor
1075 configured through the VISUAL environment variable (if unset,
1076 EDITOR is used; fallback: vi). When editing is finished, newsboat
1077 will reload the URLs file.
1078 reload-urls (default key: ^R)
1080 Reload the URLs configuration file.
1081 redraw (default key: ^L)
1083 Redraw the screen.
1084 cmdline (default key: :)
1086 Open the command line.
1087 set-filter (default key: F)
1089 Set a filter.
1090 select-filter (default key: f)
1092 Select a predefined filter.
1093 clear-filter (default key: ^F)
1095 Clear currently set filter.
1096 bookmark (default key: ^B)
1098 Bookmark currently selected article or URL.
1099 edit-flags (default key: ^E)
1101 Edit the flags of the currently selected article.
1102 next-unread-feed (default key: ^N)
1104 Go to the next feed with unread articles. This only works from the
1105 article list.
1106 prev-unread-feed (default key: ^P)
1108 Go to the previous feed with unread articles. This only works from
1109 the article list.
1110 next-feed (default key: j)
1112 Go to the next feed. This only works from the article list.
1113 prev-feed (default key: k)
1115 Go to the previous feed. This only works from the article list.
1116 delete-article (default key: D)
1118 Delete the currently selected article.
1119 delete-all-articles (default key: ^D)
1121 Delete all articles in the current feed.
1122 purge-deleted (default key: $)
1124 Purge all articles that are marked as deleted from the article
1125 list.
1126 view-dialogs (default key: v)
1128 View list of open dialogs.
1129 close-dialog (default key: ^X)
1131 Close currently selected dialog.
1132 next-dialog (default key: ^V)
1134 Go to next dialog.
1135 prev-dialog (default key: ^G)
1137 Go to previous dialog.
1138 pipe-to (default key: _| _)
1140 Pipe article to command.
1141 sort (default key: g)
1143 Sort feeds/articles by interactively choosing the sort method.
1144 rev-sort (default key: G)
1146 Sort feeds/articles by interactively choosing the sort method
1147 (reversed).
1148 up (default key: UP)
1150 Go up one item in the list.
1151 down (default key: DOWN)
1153 Go down one item in the list.
1154 pageup (default key: PPAGE)
1156 Go up one page in the list.
1157 pagedown (default key: NPAGE)
1159 Go down one page in the list.
1160 home (default key: HOME)
1162 Go to the first item in the list.
1163 end (default key: END)
1165 Go to the last item in the list.
1166 macro-prefix (default key: ,)
1168 Initiate macro execution. The next key press selects the actual
1169 macro and runs it.
1170 switch-focus (default key: TAB)
1172 Switch focus between widgets. This is currently only applicable to
1173 the filebrowser and dirbrowser contexts.
1174
1176 Newsboat comes with the possibility to categorize or "tag", as we call
1177 it, RSS feeds. Every RSS feed can be assigned 0 or more tags. Within
1178 newsboat, you can then select to only show RSS feeds that match a
1179 certain tag. That makes it easy to categorize your feeds in a flexible
1180 and powerful way.
1181 Usually, the urls file contains one RSS feed URL per line. To assign a
1183 tag to an RSS feed, simply attach it as a single word, separated by
1184 blanks such as space or tab. If the tag needs to contain spaces, you
1185 must use quotes (") around the tag (see example below). An example urls
1186 file may look like this:
1187 https://blog.fefe.de/rss.xml?html interesting conspiracy news "cool stuff"
1189 https://rss.orf.at/news.xml news orf
1190 https://www.heise.de/newsticker/heise.rdf news interesting
1191 When you now start newsboat with this configuration, you can press "t"
1193 to select a tag. When you select the tag "news", you will see all three
1194 RSS feeds. Pressing "t" again and e.g. selecting the "conspiracy" tag,
1195 you will only see the https://blog.fefe.de/rss.xml?html RSS feed.
1196 Pressing "^T" clears the current tag, and again shows all RSS feeds,
1197 regardless of their assigned tags.
1198 A special type of tag are tags that start with the tilde character (~).
1200 When such a tag is found, the feed title is set to the tag name
1201 (excluding the ~ character). With this feature, you can give feeds any
1202 title you want in your feed list:
1203 https://rss.orf.at/news.xml "~ORF News"
1205 Another special type of tag are tags that start with the exclamation
1207 mark (!). When such a tag is found, the feed is hidden from the regular
1208 list of feeds and its content can only be found through a query feed.
1209 https://rss.orf.at/news.xml "!ORF News (hidden)"
1211
1213 Newsboat contains support for Snownews extensions. The RSS feed readers
1214 Snownews and Liferea share a common way of extending the readers with
1215 custom scripts. Two mechanisms, namely "execurl" and "filter" type
1216 scripts, are available and supported by newsboat.
1217 An "execurl" script can be any program that gets executed and whose
1219 output is interpreted as RSS feed, while "filter" scripts are fed with
1220 the content of a configured URL and whose output is interpreted as RSS
1221 feed.
1222 The configuration is simple and straight-forward. Just add to your urls
1224 file configuration lines like the following ones:
1225 exec:~/bin/execurl-script
1227 filter:~/bin/filter-script:https://some.test/url
1228 The first line shows how to add an execurl script to your
1230 configuration: start the line with exec: and then immediately append
1231 the path of the script that shall be executed. If this script requires
1232 additional parameters, simply use quotes (see [_using_double_quotes]
1233 for details):
1234 "exec:~/bin/execurl-script param1 param2"
1236 The second line shows how to add a filter script to your configuration:
1238 start the line with filter:, then immediately append the path of the
1239 script, then append a colon (:), and then append the URL of the file
1240 that shall be fed to the script. Again, if the script requires any
1241 parameters, simply quote the whole thing:
1242 "filter:~/bin/filter-script param1 param2:https://url/foobar"
1244 In both cases, the tagging feature as described above is still
1246 available:
1247 exec:~/bin/execurl-script tag1 tag2 "quoted tag"
1249 filter:~/bin/filter-script:https://some.test/url tag3 tag4 tag5
1250 If you need to write your own extension, see this
1252 <https://web.archive.org/web/20090724045314/http://kiza.kcore.de/software/snownews/snowscripts/writing>
1253 short guide" for an introduction. A collection
1254 <https://github.com/kouya/snownews/tree/master/contrib> of existing
1255 scripts" might also help.
1256 Newsboat comes with an example exec script which shows one way to
1258 generate an RSS channel. It also includes a way to see which exact
1259 arguments are passed to the script by Newsboat. This example can be
1260 found in the doc/examples subdirectory.
1261
1263 Like other text-oriented software, Newsboat contains an internal
1264 commandline to modify configuration variables ad hoc and to run own
1265 commands. It provides a flexible access to the functionality of
1266 Newsboat which is especially useful for advanced users.
1267 To start the commandline, type ":". You will see a ":" prompt at the
1269 bottom of the screen, similar to tools like vi(m) or mutt. You can now
1270 enter commands. Pressing the "Enter" key executes the command (possibly
1271 giving feedback to the user) and closes the commandline. You can cancel
1272 entering commands by pressing the "Esc" key. The history of all the
1273 commands that you enter will be saved to the history.cmdline file,
1274 stored next to the cache.db file. The backlog is limited to 100 entries
1275 by default, but can be influenced by setting the history-limit
1276 configuration variable. To disable history saving, set the
1277 history-limit to 0.
1278 The commandline provides you with some help if you can’t remember the
1280 full names of commandline commands. By pressing the "Tab" key, newsboat
1281 will try to automatically complete your command. If there is more than
1282 one possible completion, you can subsequently press the "Tab" key to
1283 cycle through all results. If no match is found, no suggestion will be
1284 inserted into the commandline. For the set command, the completion also
1285 works for configuration variable names.
1286 In addition, some common key combination such as "Ctrl-G" (to cancel
1288 input), "Ctrl-K" (to delete text from the cursor position to the end of
1289 line), "Ctrl-U" (to clear the whole line) and "Ctrl-W" (to delete the
1290 word before the current cursor position) were added.
1291 Please be aware that the input history of both the command line and the
1293 search functions are saved to the filesystems, to the files
1294 history.cmdline resp. history.search (stored next to the cache.db
1295 file). By default, the last 100 entries are saved, but this can be
1296 configured (configuration variable history-limit) and also totally
1297 disabled (by setting said variable to 0).
1298 Currently, the following command line commands are available:
1300 quit
1302 Quit newsboat
1303 q
1305 Alias for quit
1306 save <filename>
1308 Save current article to <filename>
1309 set <variable>[=<value>|&|!]
1311 Set (or get) configuration variable value. Specifying a ! after the
1312 name of a boolean configuration variable toggles their values, a &
1313 directly after the name of a configuration variable of any type
1314 resets its value to the documented default value.
1315 tag <tagname>
1317 Select a certain tag
1318 goto <case-insensitive substring>
1320 Go to the next feed whose name contains the case-insensitive
1321 substring.
1322 source <filename> [...]
1324 Load the specified configuration files. This allows it to load
1325 alternative configuration files or reload already loaded
1326 configuration files on-the-fly from the filesystem.
1327 dumpconfig <filename>
1329 Save current internal state of configuration to file, so that it
1330 can be instantly reused as configuration file.
1331 <number>
1333 Jump to the <number>th entry in the current dialog
1334
1336 By default, Newsboat stores all the files in a traditional Unix
1337 fashion, i.e. in the "dotdir" located at ~/.newsboat. However, it also
1338 supports a modern way, XDG Base Directory Specification
1339 <https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>,
1340 which splits the files between the following locations:
1341 · ~/.local/share/newsboat/
1343 · ~/.config/newsboat/
1345 If these directories exist or the environment variables
1347 $XDG_CONFIG_HOME and $XDG_DATA_HOME are set, newsboat will use these
1348 directories, otherwise it will default to ~/.newsboat as its
1349 configuration directory.
1350 If you’re currently using ~/.newsboat/ but wish to migrate to XDG
1352 directories, you should move the files as follows:
1353 config, urls
1355 to $HOME/.config/newsboat/
1356 cache.db, history.search, history.cmdline, queue
1358 to $HOME/.local/share/newsboat/
1359 dotfiles
1361 $HOME/.newsboat/config
1362 $HOME/.newsboat/urls
1364 XDG
1366 $HOME/.config/newsboat/config
1367 $HOME/.config/newsboat/urls
1369
1371 BROWSER
1372 Tells Newsboat what browser to use if there is no browser setting
1373 in the config file. If this variable doesn’t exist, a default of
1374 lynx(1) will be used.
1375 CURL_CA_BUNDLE
1377 Tells Newsboat to use the specified certificate file to verify the
1378 peer. The file may contain multiple certificates. The
1379 certificate(s) must be in PEM format.
1380 This option is useful if your libcurl is built without useful
1382 certificate information, and you can’t rebuild the library
1383 yourself.
1384 EDITOR
1386 Tells Newsboat what fallback editor to use when editing the urls
1387 file via the edit-urls operation and no VISUAL environment variable
1388 is set. If this variable doesn’t exist either, a default of vi(1)
1389 will be used.
1390 PAGER
1392 Tells Newsboat what pager to use if the pager setting in the config
1393 file is explicitly set to an empty string.
1394 TMPDIR
1396 Tells Newsboat to use the specified directory for storing temporary
1397 files. If this variable doesn’t exist, a default of /tmp will be
1398 used.
1399 VISUAL
1401 Tells Newsboat what editor to use when editing the urls file via
1402 the edit-urls operation. If this variable doesn’t exist, the EDITOR
1403 environment variable will be used.
1404 XDG_CONFIG_HOME
1406 Tells Newsboat which base directory to use for the configuration
1407 files. See also the section on files for more information.
1408 XDG_DATA_HOME
1410 Tells Newsboat which base directory to use for the data files. See
1411 also the section on files for more information.
1412
1414 podboat(1)
1415
1417 Alexander Batischev
1418 2020-07-28 NEWSBOAT(1)