branch: externals/consult
commit bdffe379f8272194ada7236d6d2d565a01c07e92
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Update README
---
README.org | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/README.org b/README.org
index a2ffc5b..7c67802 100644
--- a/README.org
+++ b/README.org
@@ -250,13 +250,14 @@ their descriptions.
search gets started. Consult splits the input string into two parts, if the
first character is a punctuation character, like =#=. For example
=#grep-regexp#filter-string=, is split at the second =#=. The string
=grep-regexp=
- is passed to Grep, the =filter-string= is passed to the /fast/ Emacs
filtering to
- further narrow down the list of matches. This is particularly useful if you
- are using an advanced completion style like orderless. =consult-grep=
supports
- preview. If the =consult-project-root-function= is
[[#use-package-example][configured]] and returns
- non-nil, =consult-grep= searches the current project directory. Otherwise
the
- =default-directory= is searched. If =consult-grep= is invoked with prefix
- argument =C-u M-s g=, you can specify the directory manually.
+ is passed to Grep. By default, spaces are replaced by ~.*~. The
=filter-string=
+ is passed to the /fast/ Emacs filtering to further narrow down the list of
+ matches. This is particularly useful if you are using an advanced completion
+ style like orderless. =consult-grep= supports preview. If the
+ =consult-project-root-function= is [[#use-package-example][configured]] and
returns non-nil, =consult-grep=
+ searches the current project directory. Otherwise the =default-directory= is
+ searched. If =consult-grep= is invoked with prefix argument =C-u M-s g=,
you can
+ specify the directory manually.
- =consult-find=, =consult-locate=: Find file by
matching the path against a regexp. Like for =consult-grep,= either the
project
root or the current directory is the root directory for the search. The
input
@@ -534,6 +535,7 @@ their descriptions.
Examples:
- =#defun=: Search for "defun" using grep.
+ - =#defun embark=: Search for "defun.*embark" using grep.
- =#defun#consult=: Search for "defun" using grep, filter with the word
"consult".
- =/defun/consult=: It is also possible to use other punctuation
