summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDan Davison <dandavison7@gmail.com>2021-05-26 12:32:34 -0400
committerGitHub <noreply@github.com>2021-05-26 12:32:34 -0400
commit9de714a8a93f9c353abf5979f74b676fe6397b04 (patch)
tree4ff0307a35e44bb8e466e7b3963793a3b5892205 /src
parent974204f897f06e8b87566cf25f6866096573c959 (diff)
Improve documentation of hyperlinks (#616)
Diffstat (limited to 'src')
-rw-r--r--src/cli.rs20
1 files changed, 11 insertions, 9 deletions
diff --git a/src/cli.rs b/src/cli.rs
index 8a8c162f..d9873d3c 100644
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -237,15 +237,17 @@ pub struct Opt {
pub relative_paths: bool,
#[structopt(long = "hyperlinks")]
- /// Render commit hashes, file names, and line numbers as hyperlinks, according to the
- /// hyperlink spec for terminal emulators:
- /// https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda. By default, file names
- /// and line numbers link to the local file using a file URL, whereas commit hashes link to the
- /// commit in GitHub, if the remote repository is hosted by GitHub. See
- /// --hyperlinks-file-link-format for full control over the file URLs emitted. Hyperlinks are
- /// supported by several common terminal emulators. To make them work, you must pass the -r (as
- /// opposed to -R) flag to less, e.g. via `export DELTA_PAGER=less -rX`. If you use tmux, then
- /// you will also need a patched fork of tmux (see https://github.com/dandavison/tmux).
+ /// Render commit hashes, file names, and line numbers as hyperlinks,
+ /// according to the hyperlink spec for terminal emulators:
+ /// https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda. By
+ /// default, file names and line numbers link to the local file using a file
+ /// URL, whereas commit hashes link to the commit in GitHub, if the remote
+ /// repository is hosted by GitHub. See --hyperlinks-file-link-format for
+ /// full control over the file URLs emitted. Hyperlinks are supported by
+ /// several common terminal emulators. To make them work, you must use less
+ /// version >= 581 with the -R flag (or use -r with older less versions, but
+ /// this will break e.g. --navigate). If you use tmux, then you will also
+ /// need a patched fork of tmux (see https://github.com/dandavison/tmux).
pub hyperlinks: bool,
#[structopt(long = "keep-plus-minus-markers")]