From 6f955744e919a5622102a57e4cd0859e64a05740 Mon Sep 17 00:00:00 2001 From: Aymeric Agon-Rambosson Date: Wed, 10 Aug 2022 04:55:32 +0200 Subject: Drop references to external images Forwarded: not-needed Gbp-Pq: Name remove-external-images.patch --- README.org | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.org b/README.org index 1d11ac3..5874131 100644 --- a/README.org +++ b/README.org @@ -6,12 +6,6 @@ #+texinfo_dir_title: Consult: (consult). #+texinfo_dir_desc: Useful commands built on completing-read. -#+html: GNU Emacs -#+html: GNU ELPA -#+html: GNU-devel ELPA -#+html: MELPA -#+html: MELPA Stable - Consult provides practical 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 list of candidates. Consult offers in particular an advanced buffer switching command -- cgit v1.2.3 From 4a983345cfb7b61beef61f4b148df6d74dcb8c35 Mon Sep 17 00:00:00 2001 From: Aymeric Agon-Rambosson Date: Wed, 10 Aug 2022 04:55:32 +0200 Subject: Drop references to external pages and debianise Forwarded: not-needed Gbp-Pq: Name replace-external-references-when-possible.patch --- README.org | 74 +++++++++++++++++++++++++++++++------------------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/README.org b/README.org index 5874131..df1e21b 100644 --- a/README.org +++ b/README.org @@ -7,7 +7,7 @@ #+texinfo_dir_desc: Useful commands built on completing-read. Consult provides practical 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 list of +[[info:elisp#Minibuffer Completion][completing-read]]. Completion allows you to quickly select an item from a list of candidates. Consult offers in particular an advanced buffer switching command =consult-buffer= to switch between buffers and recently opened files. Furthermore Consult provides multiple search commands, an asynchronous =consult-grep= and @@ -17,17 +17,17 @@ the command =consult-imenu= presents a flat list of the Imenu with [[#live-previ [[#narrowing-and-grouping][grouping and narrowing]]. Please take a look at the [[#available-commands][full list of commands]]. Consult is fully compatible with completion systems based on the standard Emacs -=completing-read= API, notably the default completion system, [[https://github.com/minad/vertico][Vertico]], [[https://github.com/protesilaos/mct][Mct]], -[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Icomplete.html][Icomplete]] and [[https://github.com/radian-software/selectrum][Selectrum]]. +=completing-read= API, notably the default completion system, Vertico (~apt install vertico~), [[https://github.com/protesilaos/mct][Mct]], +[[info:emacs#Icomplete][Icomplete]] and [[https://github.com/radian-software/selectrum][Selectrum]]. 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 the main advantages of the package. Consult fits well into existing setups and it helps you to create a full completion environment out of small and -independent components. Note that, if you use [[https://github.com/abo-abo/swiper#ivy][Ivy]] or [[https://github.com/emacs-helm/helm][Helm]], you probably don't +independent components. Note that, if you use Ivy (~apt install elpa-ivy~) or Helm (~apt install elpa-helm~), you probably don't need Consult, since both packages bring their own Consult-like functionality. -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 but convenient Emacs feature called 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. @@ -372,7 +372,7 @@ their descriptions. #+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 - either the [[https://github.com/minad/corfu][Corfu]] or the [[https://github.com/company-mode/company-mode][Company]] package. There is a technical limitation of + either the [[https://github.com/minad/corfu][Corfu]] or the Company (~apt install elpa-company~) package. There is a technical limitation of =consult-completion-in-region= in combination with Lsp-mode or Eglot. The Lsp server relies on the input at point, in order to generate refined candidate strings. Since the completion is transferred from the original buffer to the @@ -490,7 +490,7 @@ pressing =C-h=. When pressing =C-h= after some prefix key, the =prefix-help-comm 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 @@ -684,11 +684,11 @@ since some details may still change. :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 @@ -708,7 +708,7 @@ the matching lines from =consult-line=, =consult-outline=, =consult-mark= and 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, -if the [[https://github.com/mhayashi1120/Emacs-wgrep][wgrep]] package is installed. These three workflows are symmetric. +if the wgrep (~apt install elpa-wgrep~) package is installed. These three workflows are symmetric. + =consult-line= -> =embark-export= to =occur-mode= buffer -> =occur-edit-mode= for editing of matches in buffer. + =consult-grep= -> =embark-export= to =grep-mode= buffer -> =wgrep= for editing of all matches. @@ -719,14 +719,12 @@ if the [[https://github.com/mhayashi1120/Emacs-wgrep][wgrep]] package is install :description: Example configuration and customization variables :end: -Consult can be installed from [[http://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. -*IMPORTANT:* It is strongly recommended that you enable [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Lexical-Binding.html][lexical binding]] in your +*IMPORTANT:* It is strongly recommended that you enable [[info:elisp#Lexical Binding][lexical binding]] in your configuration. Consult relies on lambdas and lexical closures. For this reason many Consult-related snippets require lexical binding. @@ -742,8 +740,8 @@ modes. Therefore the package is non-intrusive but requires a little setup effort. In order to use the Consult commands, it is advised to add keybindings for commands which are accessed often. Rarely used commands can be invoked via =M-x=. Feel free to only bind the commands you consider useful to your workflow. -The configuration shown here relies on the =use-package= macro, which is a -convenient tool to manage package configurations. +The configuration shown here relies on the =use-package= macro (~apt install +elpa-use-package~), which is a convenient tool to manage package configurations. *NOTE:* There is the [[https://github.com/minad/consult/wiki][Consult wiki]], where you can contribute additional configuration examples. @@ -873,7 +871,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. @@ -995,10 +993,12 @@ 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 +- 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 elpa-embark-consult~): + Action commands, which can act on the completion candidates +- orderless (~apt install elpa-orderless~): Completion style which offers + flexible candidate filtering There exist many other fine completion UIs beside Vertico, which are supported by Consult. Give them a try and find out which interaction model fits best for @@ -1014,36 +1014,36 @@ You can integrated Consult with special programs or with other packages in the wider Emacs ecosystem. You may want to install some of theses packages depending on your preferences and requirements. -- [[https://github.com/yadex205/consult-ag][consult-ag]]: Support for the [[https://github.com/ggreer/the_silver_searcher][Silver Searcher]] in the style of =consult-grep=. +- [[https://github.com/yadex205/consult-ag][consult-ag]]: Support for the Silver Searcher (~apt install silversearcher-ag~) in the style of =consult-grep=. - [[https://github.com/mohkale/consult-company][consult-company]]: Completion at point using the [[https://github.com/company-mode/company-mode][Company]] backends. - [[https://github.com/karthink/consult-dir][consult-dir]]: Directory jumper using Consult multi sources. - [[https://codeberg.org/ravi/consult-dash][consult-dash]]: Consult interface to [[https://github.com/dash-docs-el/dash-docs][Dash documentation]] -- [[https://github.com/mohkale/consult-eglot][consult-eglot]]: Integration with Eglot (LSP client). -- [[https://github.com/minad/consult-flycheck][consult-flycheck]]: Additional Flycheck integration. +- [[https://github.com/mohkale/consult-eglot][consult-eglot]]: Integration with Eglot (LSP client, ~apt install elpa-eglot~). +- [[https://github.com/minad/consult-flycheck][consult-flycheck]]: Additional Flycheck (~apt install elpa-flycheck~)integration. - [[https://gitlab.com/OlMon/consult-flyspell][consult-flyspell]]: Additional Flyspell integration. - [[https://github.com/rcj/consult-ls-git][consult-ls-git]]: List files from git via Consult. -- [[https://github.com/gagbo/consult-lsp][consult-lsp]]: Integration with Lsp-mode (LSP client). -- [[https://codeberg.org/jao/consult-notmuch][consult-notmuch]]: Access the [[https://notmuchmail.org/][Notmuch]] email system using Consult. +- [[https://github.com/gagbo/consult-lsp][consult-lsp]]: Integration with Lsp-mode (LSP client, ~apt install elpa-lsp-mode~). +- [[https://codeberg.org/jao/consult-notmuch][consult-notmuch]]: Access the Notmuch (~apt install notmuch~) email system using Consult. - [[https://github.com/mclear-tools/consult-notes][consult-notes]]: Searching notes with Consult. -- [[https://github.com/jgru/consult-org-roam][consult-org-roam]]: Integration with [[https://github.com/org-roam/org-roam][Org-roam]]. +- [[https://github.com/jgru/consult-org-roam][consult-org-roam]]: Integration with Org-roam (~apt install elpa-org-roam~). - [[https://github.com/Qkessler/consult-project-extra/][consult-project-extra]]: Additional project.el extras and buffer sources. -- [[https://gitlab.com/OlMon/consult-projectile/][consult-projectile]]: Additional [[https://github.com/bbatsov/projectile][Projectile]] integration and buffer sources. -- [[https://codeberg.org/jao/consult-recoll][consult-recoll]]: Access the [[https://www.lesbonscomptes.com/recoll/][Recoll]] desktop full-text search using Consult. +- [[https://gitlab.com/OlMon/consult-projectile/][consult-projectile]]: Additional Projectile (~apt install elpa-projectile~) integration and buffer sources. +- [[https://codeberg.org/jao/consult-recoll][consult-recoll]]: Access the Recoll (~apt install recoll~) desktop full-text search using Consult. - [[https://codeberg.org/jao/espotify][consult-spotify]]: Access the Spotify API and control your local music player. -- [[https://github.com/mohkale/consult-yasnippet][consult-yasnippet]]: Integration with Yasnippet. +- [[https://github.com/mohkale/consult-yasnippet][consult-yasnippet]]: Integration with Yasnippet (~apt install elpa-yasnippet elpa-yasnippet-snippets~). - [[https://github.com/minad/affe][affe]]: Asynchronous Fuzzy Finder for Emacs based on Consult. Not directly related to Consult, but maybe still of interest are the following packages. These packages should work well with Consult, follow a similar spirit or offer functionality based on ~completing-read~. -- [[https://github.com/minad/corfu][corfu]]: Completion systems for =completion-at-point= using small popups (Alternative to [[https://github.com/company-mode/company-mode][Company]]). +- [[https://github.com/minad/corfu][corfu]]: Completion systems for =completion-at-point= using small popups (Alternative to Company). - [[https://github.com/minad/cape][cape]]: Completion At Point Extensions, which can be used with =consult-completion-in-region= and [[https://github.com/minad/corfu][Corfu]]. - [[https://github.com/minad/bookmark-view][bookmark-view]]: Store window configuration as bookmarks, possible integration with =consult-buffer=. -- [[https://github.com/bdarcus/citar][citar]]: Versatile package for citation insertion and bibliography management. +- citar (~apt install elpa-citar~): Versatile package for citation insertion and bibliography management. - [[https://github.com/astoff/devdocs.el][devdocs]]: Emacs viewer for [[https://devdocs.io/][DevDocs]] with a convenient completion interface. - [[https://github.com/d12frosted/flyspell-correct][flyspell-correct]]: Apply spelling corrections by selecting via =completing-read=. -- [[https://github.com/mhayashi1120/Emacs-wgrep][wgrep]]: Editing of grep buffers, use together with =consult-grep= via =embark-export=. +- wgrep (~apt install elpa-wgrep~): Editing of grep buffers, use together with =consult-grep= via =embark-export=. - [[https://github.com/iyefrat/all-the-icons-completion][all-the-icons-completion]]: Icons for the completion UI. Note that all packages are independent and can be exchanged with alternative @@ -1107,7 +1107,7 @@ Please provide the necessary important information with your bug report: 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. * Contributions @@ -1131,7 +1131,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 [[https://github.com/radian-software/selectrum/wiki/Useful-Commands][Selectrum wiki]]. The commands have been rewritten and greatly enhanced in comparison to the original versions. -- cgit v1.2.3