From 8c7968a4d69e2e459fde15b42b27109ce217ab76 Mon Sep 17 00:00:00 2001 From: Charlie Groves Date: Sun, 28 Aug 2022 07:02:39 -0400 Subject: [PATCH] Describe --hyperlink-only-matches in the docs --- docs/kittens/hyperlinked_grep.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/kittens/hyperlinked_grep.rst b/docs/kittens/hyperlinked_grep.rst index eba86c143..ffb9f4646 100644 --- a/docs/kittens/hyperlinked_grep.rst +++ b/docs/kittens/hyperlinked_grep.rst @@ -74,6 +74,10 @@ to :program:`rg`. How to do that varies based on the shell: To learn more about kitty's powerful framework for customizing URL click actions, see :doc:`here `. +By default, this adds hyperlinks for several parts of ripgrep output: the +per-file header, match context lines, and match lines. Passing the +`--hyperlink-only-matches` flag will only add hyperlinks to the match lines. + Hopefully, someday this functionality will make it into some `upstream grep `__ program directly removing the need for this kitten.