branch: externals/modus-operandi-theme
commit f670dc2b932b68ad917d7d67d4992632e5d11e56
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Update README with note for HELM grep users
The topic was presented in issue 21, specifically this comment of mine:
https://gitlab.com/protesilaos/modus-themes/-/issues/21#note_302748582
---
README.org | 34 +++++++++++++++++++++++++++++++++-
1 file changed, 33 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index c402597..293cf2c 100644
--- a/README.org
+++ b/README.org
@@ -243,7 +243,7 @@ the "full support" may not be 100% true…
+ git-lens
+ git-timemachine
+ gnus
-+ helm*
++ helm* (also see [[#h:e4408911-e186-4825-bd4f-4d0ea55cd6d6][section below on
Helm's grep-related functions]])
+ helm-ls-git
+ helm-xref
+ highlight-blocks
@@ -380,6 +380,38 @@ effect/: less intense colours (but still accessible) for
supportive
interfaces and the intended styles for the content you are actually
working on.
+** Note for HELM users of grep or grep-like functions
+ :PROPERTIES:
+ :CUSTOM_ID: h:e4408911-e186-4825-bd4f-4d0ea55cd6d6
+ :END:
+
+There is one face from the Helm package that is meant to highlight the
+matches of a grep or grep-like command (=ag= or =ripgrep=). It is
+=helm-grep-match=. However, this face can only apply when the user does
+not pass =--color=always= as a command-line option for their command.
+
+This is the docstring for the aforementioned face, which is defined in
+the =helm-grep.el= library (visit a library with =M-x find-library=).
+
+#+begin_quote
+Face used to highlight grep matches. Have no effect when grep backend
+use "--color="
+#+end_quote
+
+The user must either remove =--colour= from the flags passed to the grep
+function, or explicitly use =--colour=never= (or equivalent). Helm
+provides user-facing customisation options for configuring the grep
+function's output, such as =helm-grep-default-command= and
+=helm-grep-git-grep-command=.
+
+When =--colour=always= is applied, the grep output will use red-coloured
+text with bold letter forms to present the matching text in the list of
+candidates. That presentation is still accessible, though I have not
+been able to track its source in order to identify some other possible
+means of controlling it.
+
+I presented
[[https://gitlab.com/protesilaos/modus-themes/-/issues/21#note_302748582][some
screen shots of this in issue 21]].
+
* Contributing
:PROPERTIES:
:CUSTOM_ID: h:25ba8d6f-6604-4338-b774-bbe531d467f6
