1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
|
From: Aymeric Agon-Rambosson <aymeric.agon@yandex.com>
Date: Wed, 10 Aug 2022 04:55:32 +0200
Subject: Drop references to external pages and debianise
Forwarded: not-needed
---
README.org | 48 +++++++++++++++++++++++-------------------------
1 file changed, 23 insertions(+), 25 deletions(-)
Index: b/README.org
===================================================================
--- a/README.org
+++ b/README.org
@@ -7,7 +7,7 @@
#+texinfo_dir_desc: Useful commands built on completing-read.
Consult provides search and navigation commands based on the Emacs completion
-function [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Minibuffer-Completion.html][completing-read]]. Completion allows you to quickly select an item from a
+function [[info:elisp#Minibuffer Completion][completing-read]]. Completion allows you to quickly select an item from a
list of candidates. Consult offers asynchronous and interactive =consult-grep= and
=consult-ripgrep= commands, and the line-based search command =consult-line=.
Furthermore Consult provides an advanced buffer switching command =consult-buffer=
@@ -18,8 +18,8 @@ presents a flat list of the Imenu with [
Please take a look at the [[#available-commands][full list of commands]].
Consult is fully compatible with completion systems centered around the standard
-Emacs =completing-read= API, notably the default completion system, [[https://github.com/minad/vertico][Vertico]], [[https://github.com/protesilaos/mct][Mct]],
-and [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Icomplete.html][Icomplete]].
+Emacs =completing-read= API, notably the default completion system, Vertico (~apt install elpa-vertico~), [[https://github.com/protesilaos/mct][Mct]],
+and [[info:emacs#Icomplete][Icomplete]].
This package keeps the completion system specifics to a minimum. The ability of
the Consult commands to work well with arbitrary completion systems is one of
@@ -27,7 +27,7 @@ the main advantages of the package. Cons
it helps you to create a full completion environment out of small and
independent components.
-You can combine the complementary packages [[https://github.com/minad/marginalia/][Marginalia]], [[https://github.com/oantolin/embark/][Embark]] and [[https://github.com/oantolin/orderless][Orderless]] with
+You can combine the complementary packages Marginalia (~apt install elpa-marginalia~), Embark (~apt install elpa-embark~) and Orderless (~apt install elpa-orderless~) with
Consult. Marginalia enriches the completion display with annotations, e.g.,
documentation strings or file information. The versatile Embark package provides
local actions, comparable to a context menu. These actions operate on the
@@ -66,7 +66,7 @@ Many commands implement a little known b
type =M-n= and typically Consult will insert the symbol or thing at point into
the input.
-*TIP:* If you have [[https://github.com/minad/marginalia][Marginalia]] annotators activated, type =M-x ^consult= to see
+*TIP:* If you have Marginalia annotators activated, type =M-x ^consult= to see
all Consult commands with their abbreviated description. Alternatively, type
=C-h a ^consult= to get an overview of all Consult variables and functions with
their descriptions.
@@ -395,7 +395,7 @@ their descriptions.
(setq completion-in-region-function #'consult-completion-in-region)
#+end_src
Instead of =consult-completion-in-region=, you may prefer to see the completions
- directly in the buffer as a small popup. In that case, I recommend the [[https://github.com/minad/corfu][Corfu]]
+ directly in the buffer as a small popup. In that case, I recommend the Corfu (~apt install elpa-corfu~)
package. There is a technical limitation of =consult-completion-in-region= in
combination with the Lsp modes. The Lsp server relies on the input at point,
in order to generate refined candidate strings. Since the completion is
@@ -528,7 +528,7 @@ pressing =C-h=. When pressing =C-h= afte
is invoked, which shows the keybinding help window by default. As a more compact
alternative, there is the =consult-narrow-help= command which can be bound to a
key, for example =?= or =C-h= in the =consult-narrow-map=, as shown in the [[#use-package-example][example
-configuration]]. If [[https://github.com/justbur/emacs-which-key][which-key]] is installed, the narrowing keys are automatically
+configuration]]. If which-key (~apt install elpa-which-key~) is installed, the narrowing keys are automatically
shown in the which-key window after pressing the =consult-narrow-key=.
** Asynchronous search
@@ -696,11 +696,11 @@ to create new multi-source commands.
:end:
#+cindex: embark
-*NOTE*: Install the =embark-consult= package from MELPA, which provides
-Consult-specific Embark actions and the Occur buffer export.
+*NOTE*: Install the embark-consult package (~apt install elpa-embark-consult~),
+which provides Consult-specific Embark actions and the Occur buffer export.
Embark is a versatile package which offers context dependent actions, comparable
-to a context menu. See the [[https://github.com/oantolin/embark][Embark manual]] for an extensive description of its
+to a context menu. See the [[info:embark][Embark manual]] for an extensive description of its
capabilities.
Actions are commands which can operate on the currently selected candidate (or
@@ -719,9 +719,9 @@ the matching lines from =consult-line=,
=consult-global-mark=. The matching lines are exported to an Occur buffer where
they can be edited via the =occur-edit-mode= (press key =e=). Similarly, Embark
supports exporting the matches found by =consult-grep=, =consult-ripgrep= and
-=consult-git-grep= to a Grep buffer, where the matches across files can be edited,
-via =grep-edit-mode= on Emacs 31 (or via the [[https://github.com/mhayashi1120/Emacs-wgrep][wgrep]] package). These three workflows
-are symmetric.
+=consult-git-grep= to a Grep buffer, where the matches across files can be
+edited, via =grep-edit-mode= on Emacs 31 (or via the wgrep package, ~apt install
+elpa-wgrep~). These three workflows are symmetric.
+ =consult-line= -> =embark-export= to =occur-mode= buffer -> =occur-edit-mode= for editing of matches.
+ =consult-grep= -> =embark-export= to =grep-mode= buffer -> =grep-edit-mode= for editing of matches.
@@ -732,14 +732,12 @@ are symmetric.
:description: Example configuration and customization variables
:end:
-Consult can be installed from [[https://elpa.gnu.org/packages/consult.html][ELPA]] or [[https://melpa.org/#/consult][MELPA]] via the Emacs built-in package
-manager. Alternatively it can be directly installed from the development
-repository via other non-standard package managers.
+Consult can be installed via ~apt install elpa-consult~.
-There is the [[https://github.com/minad/consult/wiki][Consult wiki]], where additional configuration examples can be
-contributed.
+There is the [[https://github.com/minad/consult/wiki][Consult wiki]], where
+additional configuration examples can be contributed.
-*IMPORTANT:* It is recommended that you enable [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Lexical-Binding.html][lexical binding]] in your
+*IMPORTANT:* It is recommended that you enable [[info:elisp#Lexical Binding][lexical binding]] in your
configuration. Many Consult-related code snippets require lexical binding, since
they use lambdas and closures.
@@ -877,7 +875,7 @@ configuration examples.
:end:
#+cindex: customization
-*TIP:* If you have [[https://github.com/minad/marginalia][Marginalia]] installed, type =M-x customize-variable RET
+*TIP:* If you have Marginalia installed, type =M-x customize-variable RET
^consult= to see all Consult-specific customizable variables with their current
values and abbreviated description. Alternatively, type =C-h a ^consult= to get
an overview of all Consult variables and functions with their descriptions.
@@ -1030,11 +1028,11 @@ following techniques:
I use and recommend this combination of packages:
- consult: This package
-- [[https://github.com/minad/vertico][vertico]]: Fast and minimal vertical completion system
-- [[https://github.com/minad/marginalia][marginalia]]: Annotations for the completion candidates
-- [[https://github.com/oantolin/embark][embark and embark-consult]]: Action commands, which can act on the completion candidates
-- [[https://github.com/oantolin/orderless][orderless]]: Completion style which offers flexible candidate filtering
-- [[https://github.com/mhayashi1120/Emacs-wgrep][wgrep]] (or =grep-edit-mode= on Emacs 31): Editing of grep buffers. Use with
+- vertico (~apt install elpa-vertico~): Fast and minimal vertical completion system
+- marginalia (~apt install elpa-marginalia~): Annotations for the completion candidates
+- embark and embark-consult (~apt install elpa-embark~): Action commands, which can act on the completion candidates
+- orderless (~apt install elpa-orderless~): Completion style which offers flexible candidate filtering
+- wgrep (~apt install elpa-wgrep~) (or =grep-edit-mode= on Emacs 31): Editing of grep buffers. Use with
=consult-grep= via =embark-export=.
There exist multiple fine completion UIs beside Vertico, which are supported by
@@ -1114,7 +1112,7 @@ Please provide the necessary important i
- Do you use Evil? Consult does not provide Evil integration out of the box, but
there is some support in [[https://github.com/emacs-evil/evil-collection][evil-collection]].
-When evaluating Consult-related code snippets you should enable [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Lexical-Binding.html][lexical binding]].
+When evaluating Consult-related code snippets you should enable [[info:elisp#Lexical Binding][lexical binding]].
Consult often relies on lambdas and lexical closures.
* Hacking
@@ -1225,7 +1223,7 @@ small configuration or command snippets.
:description: Contributors and Sources of Inspiration
:end:
-This package took inspiration from [[https://github.com/abo-abo/swiper#counsel][Counsel]] by Oleh Krehel. Some of the Consult
+This package took inspiration from Counsel (~apt install elpa-counsel~) by Oleh Krehel. Some of the Consult
commands originated in the Counsel package or the wiki of the Selectrum package.
This package exists only thanks to the help of these great contributors and
thanks to the feedback of many users. Thank you!
|