summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAlexander Batischev <eual.jp@gmail.com>2022-06-27 21:50:35 +0300
committerGitHub <noreply@github.com>2022-06-27 21:50:35 +0300
commit320eb72585c529ce9d6f7531d28117da4784832a (patch)
tree78da975cfe6b21cf49f13b7315316ee1e353932a /doc
parent2ecd46d72fa4f4d19d52a4f1c467b10f2c08af23 (diff)
parent8e0dcae4662c32cf47e35087d62d6d4c99c37345 (diff)
Merge pull request #2096 from the-blank-x/open-t-param
Add type parameter to browser
Diffstat (limited to 'doc')
-rw-r--r--doc/configcommands.dsv2
-rw-r--r--doc/newsboat.asciidoc26
2 files changed, 25 insertions, 3 deletions
diff --git a/doc/configcommands.dsv b/doc/configcommands.dsv
index 1d8c6b5f..8c28e172 100644
--- a/doc/configcommands.dsv
+++ b/doc/configcommands.dsv
@@ -8,7 +8,7 @@ bind-key||<key> <operation> [<dialog>]||n/a||Bind key <key> to <operation>. This
bookmark-autopilot||[yes/no]||no||If set to `yes`, the configured bookmark command is executed without any further input asked from user, unless the url or the title cannot be found/guessed.||bookmark-autopilot yes
bookmark-cmd||<command>||""||If set, then <command> will be used as bookmarking plugin. See the documentation on bookmarking for further information.||bookmark-cmd "~/bin/delicious-bookmark.sh"
bookmark-interactive||[yes/no]||no||If set to `yes`, then the configured bookmark command is an interactive program.||bookmark-interactive yes
-browser||<command>||%BROWSER, otherwise lynx||Set the browser command to use when opening an article in the browser. If the <<BROWSER,`BROWSER`>> environment variable is set, it will be used as the default browser, otherwise lynx will be used. Any occurrences of `%u` in <command> will be replaced by the URL being opened, enclosed in single quotes. Any occurrences of `%F` in <command> will be replaced by the feed's URL in single quotes.||browser "w3m %u"
+browser||<command>||%BROWSER, otherwise lynx||Set the browser command to use when opening an article in the browser. If the <<BROWSER,`BROWSER`>> environment variable is set, it will be used as the default browser, otherwise lynx will be used. For more information, see <<_using_browser,Using Browser>>.||browser "w3m %u"
cache-file||<path>||"~/.newsboat/cache.db" or "~/.local/share/cache.db" (see "Files" section)||This configuration option sets the cache file. This is especially useful if the filesystem of your home directory doesn't support proper locking (e.g. NFS).||cache-file "/tmp/testcache.db"
cleanup-on-quit||[yes/no]||yes||If set to `yes`, then the cache gets locked and superfluous feeds and items are removed, such as feeds that can't be found in the urls configuration file anymore.||cleanup-on-quit no
color||<element> <fgcolor> <bgcolor> [<attribute> ...]||n/a||Set the foreground color, background color and optional attributes for a certain element.||color background white black
diff --git a/doc/newsboat.asciidoc b/doc/newsboat.asciidoc
index bab57efd..337bc6c3 100644
--- a/doc/newsboat.asciidoc
+++ b/doc/newsboat.asciidoc
@@ -1302,11 +1302,33 @@ normally run, such as a web browser or an executable script. For example:
browser firefox
The browser command also takes an optional `%u` to specify at which point the
-URL sould be expanded. If `%u` is not set, the URL will be appended at the end of
-the command. Therefore, the following example is equivalent to the last one:
+URL should be expanded, along with `%t` specifying where the type of the URL
+should be expanded and `%F` specifying where the URL of the feed's website (or
+the URL of the feed itself if not available) should be expanded. All parameters
+will be enclosed in single quotes, making it unnecessary to quote them yourself.
+If none of the parameters are used, the URL will be appended at the end of the
+command. Therefore, the previous example is equivalent to:
browser "firefox %u"
+The following table shows the available link types for `%t`:
+
+.Available Link Types
+[frame="all", grid="all", format="dsv", options="header", cols="30,70"]
+|======================================================================
+Type:Meaning
+feed:URL of the feed's website
+rssfeed:URL of the feed
+article:URL of the article
+link:A URL in an article
+image:An image in an article
+embed_flash:A flash embed in an article
+iframe:An iframe in an article
+video:A video in an article
+audio:Audio in an article
+unknown (bug):An unknown link type, should not appear
+|======================================================================
+
To open any link with your browser, the versatile
<<open-in-browser,`open-in-browser`>> operation can be used. Its behavior is
specific to each dialog.