From f09de8b43ebc88e3ddce686dc717dfb79159ee90 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Thu, 23 Feb 2023 18:46:33 +0000 Subject: [PATCH] Generate info documentation --- rgel.info | 597 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 306 insertions(+), 291 deletions(-) diff --git a/rgel.info b/rgel.info index 1364783..44998ee 100644 --- a/rgel.info +++ b/rgel.info @@ -1,6 +1,6 @@ -This is rgel.info, produced by makeinfo version 6.7 from rgel.texi. +This is rgel.info, produced by makeinfo version 6.8 from rgel.texi. - rg.el 2.2.0, Apr 27, 2022 + rg.el 2.2.0, Feb 23, 2023 David Landell @@ -12,7 +12,7 @@ START-INFO-DIR-ENTRY END-INFO-DIR-ENTRY - Generated by Sphinx 1.8.5. + Generated by Sphinx 4.3.2.  File: rgel.info, Node: Top, Next: Usage, Up: (dir) @@ -20,29 +20,29 @@ File: rgel.info, Node: Top, Next: Usage, Up: (dir) RG User Manual ************** - rg.el 2.2.0, Apr 27, 2022 + rg.el 2.2.0, Feb 23, 2023 David Landell Copyright © 2019, David Landell -_rg.el_ is an Emacs search package based on the ripgrep +`rg.el' is an Emacs search package based on the ripgrep (https://github.com/BurntSushi/ripgrep) command line tool. It allows you to interactively create searches, doing automatic searches based on the editing context, refining and modifying search results and much more. It is also highly configurable to be able to fit different users’ needs. -Throughout this manual this emacs package will be referred to as _rg_ -while the command line utility will be referred to as _ripgrep_. +Throughout this manual this emacs package will be referred to as `rg' +while the command line utility will be referred to as `ripgrep'. -If you are used to built-in Emacs ‘rgrep’ command, transitioning to _rg_ -should be simple. _rg_ provides a lot of extra features but the basics +If you are used to built-in Emacs ‘rgrep’ command, transitioning to `rg' +should be simple. `rg' provides a lot of extra features but the basics are similar. -The big benefit of using _ripgrep_ instead of _grep_ as a backend is +The big benefit of using `ripgrep' instead of `grep' as a backend is speed. Especially when searching large source code repositories where -_ripgrep_ really shines. Please read this blog post +`ripgrep' really shines. Please read this blog post (http://blog.burntsushi.net/ripgrep/) for some speed comparisons with other tools. @@ -74,7 +74,7 @@ File: rgel.info, Node: Installation, Next: Searching, Up: Usage 1.1 Installation ================ -This version of _rg_ is supported on GNU Emacs 25.1 or later on Linux +This version of `rg' is supported on GNU Emacs 25.1 or later on Linux systems. It might work on older Emacsen and on other systems but such configurations are not tested. Patches for other OS:es are welcome. @@ -106,13 +106,13 @@ the package in your init file. You would also need to make sure all package requirements are met. For this version these are: - - *wgrep* 2.1.10 + - `wgrep' 2.1.10 - - *transient* 0.3.0 + - `transient' 0.3.0 - - *emacs* 25.1 + - `emacs' 25.1 -_rg_ is using autoloaded symbols which means it’s also possible to defer +`rg' is using autoloaded symbols which means it’s also possible to defer loading if you have autoloading setup. That usually comes out of the box with ‘package-install’. @@ -167,18 +167,18 @@ For the evil use case where isearch-mode is exited after first search hit, users would also want to add the binding to the ‘global-map’ or similar. -Interaction with the _ripgrep_ configuration file +Interaction with the `ripgrep' configuration file ................................................. -The _ripgrep_ binary allows using a configuration file +The `ripgrep' binary allows using a configuration file (https://github.com/BurntSushi/ripgrep/blob/master/GUIDE.md#configuration-file) to set default values for command line flags. This package requires -specific command line flags to function correctly and using a _ripgrep_ +specific command line flags to function correctly and using a `ripgrep' configuration may conflict with these requirements. Therefore the configuration file is ignored by default. This can be changed by the *note rg-ignore-ripgreprc: 7. setting. - Note: Using the _ripgrep_ configuration file may break + Note: Using the `ripgrep' configuration file may break functionality of this package if you are not careful.  @@ -189,11 +189,11 @@ File: rgel.info, Node: Searching, Next: Results buffer, Prev: Installation, Searching is done by invoking one of the different frontend commands. This package is built around recursive search based on three parameters; -a single _directory_, _file type_ filter, and a search _pattern_. These +a single `directory', `file type' filter, and a search `pattern'. These three parameters can interactively be selected or figured out automatically by the package, depending on which command that is used. -The underlying _ripgrep_ binary has the file type filter concept built +The underlying `ripgrep' binary has the file type filter concept built in. You have a high level of control over which files to search and which to ignore. This is partly what makes it so fast, ignoring uninteresting files. @@ -220,12 +220,12 @@ File: rgel.info, Node: Case sensitivity, Next: Interactive search, Up: Search Considering case when searching is an important feature of any search tool. This package gives you a lot of control over how to handle case -sensitive and case insensitive search. It can be forced to *on* or -*off* and set to *smart case*. The latter is similar to the _ripgrep_ +sensitive and case insensitive search. It can be forced to `on' or +`off' and set to `smart case'. The latter is similar to the `ripgrep' ‘--smart-case’ flag but is not using the flag directly. One thing to note about this is that the case insensitive setting controls the behavior when starting a new search. In the results buffer the setting -is fixed to *on* or *off* but can be toggled easily with a key binding. +is fixed to `on' or `off' but can be toggled easily with a key binding. See *note rg-ignore-case: c. customization for the details of the configuration. @@ -240,26 +240,26 @@ parameters are selected from the mini buffer. -- ELisp Command: C-c s r (rg) - This command prompts for _query_, _file type_ and _directory_ and - tries to suggest reasonable default values. The _query_ string is - interpreted as a regular expression. Default for _query_ is the - thing at point and for _directory_ it is the current directory. If + This command prompts for `query', `file type' and `directory' and + tries to suggest reasonable default values. The `query' string is + interpreted as a regular expression. Default for `query' is the + thing at point and for `directory' it is the current directory. If the type of the currently visited file is recognized, the - corresponding *note file type alias: 10. is suggested as the _file - type_ parameter. + corresponding *note file type alias: 10. is suggested as the `file + type' parameter. - Invoking this command with the _universal argument_ will trigger + Invoking this command with the `universal argument' will trigger confirmation and potential modification of the *note full command - line: 11. that will invoke the _ripgrep_ binary. + line: 11. that will invoke the `ripgrep' binary. -- ELisp Command: C-c s t (rg-literal) This command works in the same way as *note rg: f. but interprets - the _query_ string literally and not as a regular expression. + the `query' string literally and not as a regular expression. - Invoking this command with the _universal argument_ will trigger + Invoking this command with the `universal argument' will trigger confirmation and potential modification of the *note full command - line: 11. that will invoke the _ripgrep_ binary. + line: 11. that will invoke the `ripgrep' binary.  File: rgel.info, Node: Project search, Next: Do what I mean, Prev: Interactive search, Up: Searching @@ -269,8 +269,8 @@ File: rgel.info, Node: Project search, Next: Do what I mean, Prev: Interactiv A common scenario is to search through a whole project while visiting a file in the project. This essentially means identifying the project -root and use that as the top _directory_ when invoking the _ripgrep_ -binary. _rg_ supports several ways of identifying a project. Emacs’ +root and use that as the top `directory' when invoking the `ripgrep' +binary. `rg' supports several ways of identifying a project. Emacs’ major project packages are supported including projectile (https://www.projectile.mx/en/latest/), find-file-in-project (https://github.com/technomancy/find-file-in-project) and builtin @@ -280,9 +280,9 @@ If none of these are used, the fallback is Emacs’ ‘vc-backend’. -- ELisp Command: C-c s p (rg-project) - Search in the current project. The _directory_ is selected via one - of Emacs’ project packages while _query string_ and _file type_ are - prompted for. The _query string_ is interpreted as a regular + Search in the current project. The `directory' is selected via one + of Emacs’ project packages while `query string' and `file type' are + prompted for. The `query string' is interpreted as a regular expression.  @@ -291,41 +291,41 @@ File: rgel.info, Node: Do what I mean, Next: Isearch search, Prev: Project se 1.2.4 Do what I mean -------------------- -The *DWIM* family of search commands tries to be smart by figure out the +The `DWIM' family of search commands tries to be smart by figure out the search parameters from the context without prompting. Thanks to -_ripgrep’s_ speed, this allows for new ways of searching by invoking a -dwim command and then _refine_ the search from the results buffer. +`ripgrep’s' speed, this allows for new ways of searching by invoking a +dwim command and then `refine' the search from the results buffer. These commands use the word (with the definition of word depending on -context) under cursor as the _query_ string. The _file type_ parameter +context) under cursor as the `query' string. The `file type' parameter is taken from the type of the currently visited file. If the current -file type can not be identified all file types known to _ripgrep_ are +file type can not be identified all file types known to `ripgrep' are used. The fallback can be customized with *note -rg-default-alias-fallback: 18. The _directory_ parameter varies between +rg-default-alias-fallback: 18. The `directory' parameter varies between these commands. -- ELisp Command: M-x rg-dwim-project-dir - Do a *DWIM* search in the current *note project: 14. + Do a `DWIM' search in the current *note project: 14. -- ELisp Command: M-x rg-dwim-current-dir - Do a *DWIM* search in the current directory. + Do a `DWIM' search in the current directory. -- ELisp Command: M-x rg-dwim-current-file - Do a *DWIM* search in the current file. The _current file_ in this - context is actually a file _pattern_ exactly matching the current + Do a `DWIM' search in the current file. The `current file' in this + context is actually a file `pattern' exactly matching the current file name in a search starting from current directory. Most of the time this means a single file but if there are multiple files with the same name in a sub directory, those will be searched as well. -- ELisp Command: C-c s d (rg-dwim) - This command combines all the *DWIM* commands to one. The default - search is in the *note project dir: 19. With one _universal - argument_ *note current directory: 1a. is used and with double - _universal arguments_ a *note file search: 1b. is done. + This command combines all the `DWIM' commands to one. The default + search is in the *note project dir: 19. With one `universal + argument' *note current directory: 1a. is used and with double + `universal arguments' a *note file search: 1b. is done.  File: rgel.info, Node: Isearch search, Next: File type aliases, Prev: Do what I mean, Up: Searching @@ -349,8 +349,8 @@ File: rgel.info, Node: File type aliases, Next: The menu, Prev: Isearch searc 1.2.6 File type aliases ----------------------- -File type aliases are used in _ripgrep_ to filter out the files to -search in. The _ripgrep_ binary comes with a default set of aliases +File type aliases are used in `ripgrep' to filter out the files to +search in. The `ripgrep' binary comes with a default set of aliases that can be extended or overridden from this package by customizing *note rg-custom-type-aliases: 1f. @@ -361,19 +361,19 @@ completing read of the defined aliases. It is also possible to enter a custom glob pattern if there is no suitable alias defined for the file type. -_rg_ defines some internal aliases: +`rg' defines some internal aliases: Name Meaning -------------------------------------------------------------------------------------------------------------- -*all* all defined types including *note rg-custom-type-aliases: 1f. +`all' all defined types including *note rg-custom-type-aliases: 1f. -*everything* all files. No filtering on type is done. +`everything' all files. No filtering on type is done. -*custom* used internally in this package for mapping custom glob patterns. +`custom' used internally in this package for mapping custom glob patterns. Warning: Do not use any of the internal aliases in *note @@ -394,7 +394,7 @@ package is using the same popup menu backend called transient this should feels like home. The menu is mostly interesting when you want to give specific command -line flags to the _ripgrep_ binary. When you just want to do a quick +line flags to the `ripgrep' binary. When you just want to do a quick search based on the defaults the menu basically acts as a normal keymap. Pressing the ‘rg-menu’ *note prefix key: 21. will popup the menu where @@ -410,8 +410,8 @@ macro. :menu ("Custom" "w" "Word")) The ‘:menu’ keyword in the above invocation will trigger insertion of a -new menu item bound to key ‘w’ with description *Word*. The new menu -item will be put under the *Custom* group. This group is not available +new menu item bound to key ‘w’ with description `Word'. The new menu +item will be put under the `Custom' group. This group is not available in the original menu so it will be created. The menu can be triggered from the *note results buffer: 23. with the @@ -436,11 +436,11 @@ File: rgel.info, Node: Results buffer, Next: Search management, Prev: Searchi The results of a search is shown in the results buffer. This buffer displays search parameters, the full command line and the output of the -_ripgrep_ binary. It supports basic navigation between search results +`ripgrep' binary. It supports basic navigation between search results editing of the file contents directly from the search buffer and also modification of the current search. The results buffer is a modified -_compilation_ buffer and some key bindings and functionality is -inherited from the parent and from _grep mode_. +`compilation' buffer and some key bindings and functionality is +inherited from the parent and from `grep mode'. * Menu: @@ -514,20 +514,20 @@ the *note base parameters: 9. -- ELisp Command: d (rg-rerun-change-dir) - Interactively change search _directory_. + Interactively change search `directory'. -- ELisp Command: f (rg-rerun-change-files) - Interactively change searched _file types_. + Interactively change searched `file types'. -- ELisp Command: t (rg-rerun-change-literal) - Interactively change _search string_ interpret the string + Interactively change `search string' interpret the string literally. -- ELisp Command: r (rg-rerun-change-regexp) - Interactively change _search string_ interpret the string as a + Interactively change `search string' interpret the string as a regular expression. Tip: *note rg-rerun-change-regexp: 34. and *note @@ -543,12 +543,12 @@ the *note base parameters: 9. -- ELisp Command: c (rg-rerun-toggle-case) Toggle case sensitivity of search. The state of the flag is shown - in the *[case]* header field. + in the `[case]' header field. -- ELisp Command: i (rg-rerun-toggle-ignore) Toggle if ignore files are respected. The state of the flag is - shown in the *[ign]* header field. + shown in the `[ign]' header field. Tip: It is possible to create and bind your own toggle flags with the macro *note rg-define-toggle: 38. @@ -565,8 +565,8 @@ File: rgel.info, Node: Full command line search, Next: History navigation, Pr Some search commands (See *note rg: f. or *note rg-literal: 12.) allow you to edit the final command line before invoking the search by giving -a _universal argument_. This can be used to invoke features of the -_ripgrep_ binary that is not supported in this package’s interface. +a `universal argument'. This can be used to invoke features of the +`ripgrep' binary that is not supported in this package’s interface. This could be specific flags, searching in multiple directories etc. Note: Using full command line search will disable refinement of the @@ -602,7 +602,7 @@ File: rgel.info, Node: Edit and apply wgrep, Prev: History navigation, Up: Re The results buffer supports inline editing via the wgrep (https://github.com/mhayashi1120/Emacs-wgrep) package. This is setup -automatically when _rg_ is loaded. +automatically when `rg' is loaded. -- ELisp Command: e (wgrep-change-to-wgrep-mode) @@ -616,7 +616,7 @@ File: rgel.info, Node: Search management, Next: Multi line search, Prev: Resu 1.4 Search management ===================== -The result buffer is named ‘*rg*’ and _rg_ reuse the same result buffer +The result buffer is named ‘*rg*’ and `rg' reuse the same result buffer for new searches. If you want to store a search while continuing doing new searches there are two ways of doing that. @@ -709,7 +709,7 @@ Customization is done via the Emacs customization system. The group -- ELisp Variable: rg-executable [(executable-find "rg")] - The _ripgrep_ executable to use. Could be an absolute path or just + The `ripgrep' executable to use. Could be an absolute path or just the base name if the executable is in the path. The default is using ‘executable-find’ to locate the command. If you want to use this package with tramp it might be better to set it to just “rg” @@ -725,12 +725,11 @@ Customization is done via the Emacs customization system. The group remote hosts to determine the path to ripgrep. The result is stored per connection. - -- ELisp Variable: rg-custom-type-aliases [(("gyp" . "\*.gyp - \*.gypi"))] + -- ELisp Variable: rg-custom-type-aliases [nil] An association list that maps file type aliases to a space delimited string with file globs. These are combined with the - _ripgrep_ builtin file aliases. + `ripgrep' builtin file aliases. Example: @@ -747,6 +746,18 @@ Customization is done via the Emacs customization system. The group (when (in-frontend-app) (cons "ui" "*.js *.hbs *.json")))) + -- ELisp Variable: rg-prioritized-type-aliases [nil] + + A list of aliases that are prioritized among ripgrep’s builtin + aliases when selecting the alias based on the buffer file name. + This list contains only the alias names and the order between the + items does not matter. + + Example: + + (setq rg-custom-type-aliases + '("cpp" "puppet")) + -- ELisp Variable: rg-default-alias-fallback ["everything"] This setting controls the default alias used when no alias can be @@ -755,7 +766,7 @@ Customization is done via the Emacs customization system. The group -- ELisp Variable: rg-command-line-flags [nil] - A list of command line flags that will be appended to the _ripgrep_ + A list of command line flags that will be appended to the `ripgrep' command line. Must either be a list of flags or a function that returns a list of flags. @@ -764,7 +775,7 @@ Customization is done via the Emacs customization system. The group Controls the layout of the results buffer. If non ‘nil’, each file name is displayed once and matches are grouped under that filename instead of repeating the filename on each match. This is - essentially the layout of the ‘--no-heading’ _ripgrep_ command line + essentially the layout of the ‘--no-heading’ `ripgrep' command line flag. -- ELisp Variable: rg-show-columns [nil] @@ -774,19 +785,19 @@ Customization is done via the Emacs customization system. The group -- ELisp Variable: rg-ignore-case [case-fold-search] Setting that controls if case sensitive search is made or not. It - can essentially be *on*, *off* or *smart*. The *smart* setting + can essentially be `on', `off' or `smart'. The `smart' setting will trigger an analyze of the search string and if it’s all lower - case, the search will be case _insensitive_, otherwise it will be - case _sensitive_. The following values are valid: + case, the search will be case `insensitive', otherwise it will be + case `sensitive'. The following values are valid: - - *case-fold-search* - A non nil value of ‘case-fold-search’ + - `case-fold-search' - A non nil value of ‘case-fold-search’ will trigger smart case behavior. - - *smart* - Smart case behavior. + - `smart' - Smart case behavior. - - *force* - Always ignore case. + - `force' - Always ignore case. - - *nil* - Always consider case. + - `nil' - Always consider case. -- ELisp Variable: rg-hide-command [t] @@ -815,8 +826,8 @@ Customization is done via the Emacs customization system. The group -- ELisp Variable: rg-buffer-name ["rg"] - Controls the name of the results buffer. It may be _string_ or - _function_. This name will be surrounded by ‘*’ to yield the final + Controls the name of the results buffer. It may be `string' or + `function'. This name will be surrounded by ‘*’ to yield the final buffer name so if this setting is ‘foo’ the buffer name will be ‘*foo*’. One useful case of using it is to have separate result buffers per project. One can set this variable in ‘dir-locals‘ @@ -852,7 +863,7 @@ File: rgel.info, Node: Position numbers alignment, Up: Customization 2.1.1 Position numbers alignment -------------------------------- -When operating _rg_ in grouped output mode (*note rg-group-result: 2b. +When operating `rg' in grouped output mode (*note rg-group-result: 2b. is non nil), it’s possible to control how the line and column numbers are displayed in the result buffer. @@ -886,12 +897,12 @@ Will yield the following format: -- ELisp Variable: rg-align-line-column-separator [" "] Separator string used between line and column numbers. ‘nil’ means - use default separator from _ripgrep_. + use default separator from `ripgrep'. -- ELisp Variable: rg-align-position-content-separator [" "] Separator string used between the position numbers and matched - content. ‘nil’ means use default separator from _ripgrep_. + content. ‘nil’ means use default separator from `ripgrep'.  File: rgel.info, Node: Faces, Next: Configuration functions, Prev: Customization, Up: Configuration @@ -920,11 +931,11 @@ File: rgel.info, Node: Results buffer<2>, Next: Header line, Up: Faces -- ELisp Variable: rg-error-face [compilation-error] - Face used to highlight errors when invoking _ripgrep_. + Face used to highlight errors when invoking `ripgrep'. -- ELisp Variable: rg-context-face [shadow] - Face used to highlight context lines in _ripgrep_ output when + Face used to highlight context lines in `ripgrep' output when ‘--context-lines’ flag is used. -- ELisp Variable: rg-info-face [compilation-info] @@ -934,7 +945,7 @@ File: rgel.info, Node: Results buffer<2>, Next: Header line, Up: Faces -- ELisp Variable: rg-warning-face [compilation-warning] - Face used to highlight warnings in the _ripgrep_ output. + Face used to highlight warnings in the `ripgrep' output. -- ELisp Variable: rg-filename-face [rg-info-face] @@ -989,14 +1000,14 @@ File: rgel.info, Node: Configuration functions, Next: Configuration macros, P -- ELisp Function: (rg-enable-default-bindings &optional, prefix) Enable the default keyboard bindings for the package with prefix - key. If *note rg-use-transient-menu: 54. is on this will enable + key. If *note rg-use-transient-menu: 55. is on this will enable the menu instead of activating the global bindings. If ‘prefix’ is not provided *note rg-keymap-prefix: 21. will be used. -- ELisp Function: (rg-enable-menu &optional, prefix) Enable the *note rg-menu: a. with prefix key. This bypass *note - rg-use-transient-menu: 54. setting. If ‘prefix’ is not provided + rg-use-transient-menu: 55. setting. If ‘prefix’ is not provided *note rg-keymap-prefix: 21. will be used. -- ELisp Function: (rg-use-old-defaults) @@ -1014,7 +1025,7 @@ File: rgel.info, Node: Configuration macros, Next: Use with evil-mode, Prev: -- ELisp Function: (rg-define-toggle flag, &optional, key, default) - This is a macro that can be used to define custom _ripgrep_ flag + This is a macro that can be used to define custom `ripgrep' flag toggling functions in the result buffer. The macro takes the flag (and potential value) as an argument and optionally binds the toggle function to a key. If ‘default’ is non nil the flag is used @@ -1027,12 +1038,12 @@ File: rgel.info, Node: Configuration macros, Next: Use with evil-mode, Prev: (rg-define-toggle "-uu" "I" t) Creates a function named ‘rg-custom-toggle-flag-uu’ that is on by - default and bound to ‘I’ in _rg_ result buffer. + default and bound to ‘I’ in `rg' result buffer. (rg-define-toggle "--context 3" (kbd "C-c c")) Creates a function named ‘rg-custom-toggle-flag-context’ that is - off by default and bound to ‘C-c c’ in _rg_ result buffer. + off by default and bound to ‘C-c c’ in `rg' result buffer. -- ELisp Function: (rg-define-search name, &rest, args) @@ -1045,34 +1056,34 @@ File: rgel.info, Node: Configuration macros, Next: Use with evil-mode, Prev: value pairs according to the specification below. All keys are optional with specified default if left out. - - *:query* - Method for retrieving the search string. Allowed + - `:query' - Method for retrieving the search string. Allowed values are ‘point’ which means extract thing at point and ‘ask’ which means prompt the user for a string. Any form that evaluates to a string is allowed. Default is ‘ask’. - - *:format* - Specifies if ‘:query’ is interpreted literally + - `:format' - Specifies if ‘:query’ is interpreted literally (‘literal’) or as a regexp (‘regexp’). If it is a form, eg. ‘(not current-prefix-arg)’, and is non-nil the ‘:query’ is interpreted literally, otherwise as a regexp. Default is ‘regexp’. - - *:files* - Form that evaluates to a file alias or custom file + - `:files' - Form that evaluates to a file alias or custom file glob. ‘current’ means extract alias from current buffer file name, ‘ask’ will prompt the user. Default is ‘ask’. - - *:dir* - Root search directory. Allowed values are ‘ask’ for + - `:dir' - Root search directory. Allowed values are ‘ask’ for user prompt, ‘current’ for current dir and ‘project’ for project root. Any form that evaluates to a directory string is also allowed. Default is ‘ask’. - - *:confirm* - ‘never’, ‘always’, or ‘prefix’ are allowed + - `:confirm' - ‘never’, ‘always’, or ‘prefix’ are allowed values. Specifies if the the final search command line string can be modified and confirmed the user. Default is ‘never’. - - *:flags* - ‘ask’ or a list of command line flags that will be + - `:flags' - ‘ask’ or a list of command line flags that will be used when invoking the search. - - *:menu* - Bind the command into ‘rg-menu’. Must be a list + - `:menu' - Bind the command into ‘rg-menu’. Must be a list with three items in it. The first item is the description of the group in witch the new command will appear. If the group does not exist a new will be created. The second item is the @@ -1104,14 +1115,14 @@ File: rgel.info, Node: Use with evil-mode, Next: Customizing the menu, Prev: 2.5 Use with evil-mode ====================== -Some key bindings clash with _evil-mode_. Recommendation is to use evil -_motion_ state for the results buffer and then switch to evil _normal_ -mode when editing in _wgrep-mode_. Some adjustments need to be done to +Some key bindings clash with `evil-mode'. Recommendation is to use evil +`motion' state for the results buffer and then switch to evil `normal' +mode when editing in `wgrep-mode'. Some adjustments need to be done to avoid the clashes though. -This is a start of a configuration. This let _rg-mode_’s key bindings +This is a start of a configuration. This let `rg-mode'’s key bindings override the motion state map bindings based on that these motion keys -are not important in an _rg_ results buffer. Adjust this to your +are not important in an `rg' results buffer. Adjust this to your preferred use case: (with-eval-after-load 'rg @@ -1134,12 +1145,12 @@ File: rgel.info, Node: Customizing the menu, Prev: Use with evil-mode, Up: Co The menu can be modified from the emacs configuration file. -To add a new *switch* before the option triggered by ‘-n’ at suffix +To add a new `switch' before the option triggered by ‘-n’ at suffix level 3: (transient-insert-suffix 'rg-menu "-n" '(3 "-o" "Only print matches" "--only-matching")) -To add a new *option* before the option triggered by ‘-g’ at suffix +To add a new `option' before the option triggered by ‘-g’ at suffix level 4: (transient-insert-suffix 'rg-menu "-g" '(4 "-f" "Pattern file" "--file=")) @@ -1157,7 +1168,7 @@ Please refer to the transient documentation for details on customizing the menu. This package also adds a convenience function for appending new -*commands* to the menu in the groups at the bottom. +`commands' to the menu in the groups at the bottom. -- ELisp Function: (rg-menu-transient-insert group, key, description, command) @@ -1325,15 +1336,15 @@ File: rgel.info, Node: License, Next: Index, Prev: Contribute, Up: Top 4 License ********* -_rg_ is free software; you can redistribute it and/or modify it under +`rg' is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. -_rg_ is distributed in the hope that it will be useful, but WITHOUT ANY +`rg' is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *note GNU General Public -License: 8c. for more details. +License: 8d. for more details. * Menu: @@ -2048,14 +2059,14 @@ Index * rg-align-position-numbers (customize option): Position numbers alignment. (line 24) * rg-back-history (command): History navigation. (line 10) -* rg-buffer-name (customize option): Customization. (line 117) +* rg-buffer-name (customize option): Customization. (line 128) * rg-column-number-face (customize option): Results buffer<2>. (line 40) -* rg-command-line-flags (customize option): Customization. (line 57) +* rg-command-line-flags (customize option): Customization. (line 68) * rg-context-face (customize option): Results buffer<2>. (line 14) * rg-custom-type-aliases (customize option): Customization. (line 29) * rg-default-alias-fallback (customize option): Customization. - (line 51) + (line 62) * rg-define-search (function): Configuration macros. (line 28) * rg-define-toggle (function): Configuration macros. @@ -2075,12 +2086,12 @@ Index * rg-file-tag-face (customize option): Results buffer<2>. (line 32) * rg-filename-face (customize option): Results buffer<2>. (line 28) * rg-forward-history (command): History navigation. (line 14) -* rg-group-result (customize option): Customization. (line 63) -* rg-hide-command (customize option): Customization. (line 92) -* rg-ignore-case (customize option): Customization. (line 75) -* rg-ignore-ripgreprc (customize option): Customization. (line 135) +* rg-group-result (customize option): Customization. (line 74) +* rg-hide-command (customize option): Customization. (line 103) +* rg-ignore-case (customize option): Customization. (line 86) +* rg-ignore-ripgreprc (customize option): Customization. (line 146) * rg-info-face (customize option): Results buffer<2>. (line 19) -* rg-keymap-prefix (customize option): Customization. (line 98) +* rg-keymap-prefix (customize option): Customization. (line 109) * rg-kill-saved-searches (command): Search management. (line 43) * rg-line-number-face (customize option): Results buffer<2>. (line 36) * rg-list-searches (command): Search management. (line 38) @@ -2094,6 +2105,8 @@ Index (line 33) * rg-next-file (command): Navigation. (line 26) * rg-prev-file (command): Navigation. (line 31) +* rg-prioritized-type-aliases (customize option): Customization. + (line 50) * rg-project (command): Project search. (line 17) * rg-recompile (command): Refine search. (line 34) * rg-regexp-face (customize option): Header line. (line 18) @@ -2105,13 +2118,13 @@ Index * rg-rerun-toggle-ignore (command): Refine search. (line 43) * rg-save-search (command): Search management. (line 10) * rg-save-search-as-name (command): Search management. (line 22) -* rg-show-columns (customize option): Customization. (line 71) -* rg-show-header (customize option): Customization. (line 111) +* rg-show-columns (customize option): Customization. (line 82) +* rg-show-header (customize option): Customization. (line 122) * rg-toggle-off-face (customize option): Header line. (line 10) * rg-toggle-on-face (customize option): Header line. (line 6) * rg-use-old-defaults (function): Configuration functions. (line 19) -* rg-use-transient-menu (customize option): Customization. (line 104) +* rg-use-transient-menu (customize option): Customization. (line 115) * rg-warning-face (customize option): Results buffer<2>. (line 24) * wgrep-change-to-wgrep-mode (command): Edit and apply wgrep. (line 10) @@ -2286,165 +2299,167 @@ Ref: configuration option-rg-executable-per-connection25361 Ref: 5125361 Ref: configuration option-rg-custom-type-aliases25732 Ref: 1f25732 -Ref: configuration option-rg-default-alias-fallback26429 -Ref: 1826429 -Ref: configuration option-rg-command-line-flags26680 -Ref: 4b26680 -Ref: configuration option-rg-group-result26903 -Ref: 2b26903 -Ref: configuration option-rg-show-columns27245 -Ref: 5227245 -Ref: configuration option-rg-ignore-case27352 -Ref: c27352 -Ref: configuration option-rg-hide-command27992 -Ref: 5327992 -Ref: configuration option-rg-keymap-prefix28246 -Ref: 2128246 -Ref: configuration option-rg-use-transient-menu28478 -Ref: 5428478 -Ref: configuration option-rg-show-header28684 -Ref: 5528684 -Ref: configuration option-rg-buffer-name28892 -Ref: 4628892 -Ref: configuration option-rg-ignore-ripgreprc29614 -Ref: 729614 -Node: Position numbers alignment30249 -Ref: configuration id230323 -Ref: 5630323 -Ref: configuration position-numbers-alignment30323 -Ref: 5730323 -Ref: configuration option-rg-align-position-numbers30930 -Ref: 5830930 -Ref: configuration option-rg-align-line-number-field-length31087 -Ref: 5931087 -Ref: configuration option-rg-align-column-number-field-length31197 -Ref: 5a31197 -Ref: configuration option-rg-align-line-column-separator31311 -Ref: 5b31311 -Ref: configuration option-rg-align-position-content-separator31490 -Ref: 5c31490 -Node: Faces31691 -Ref: configuration faces31798 -Ref: 5d31798 -Node: Results buffer<2>32001 -Ref: configuration results-buffer32078 -Ref: 5e32078 -Ref: configuration option-rg-match-face32121 -Ref: 5f32121 -Ref: configuration option-rg-error-face32212 -Ref: 6032212 -Ref: configuration option-rg-context-face32328 -Ref: 6132328 -Ref: configuration option-rg-info-face32483 -Ref: 6232483 -Ref: configuration option-rg-warning-face32645 -Ref: 6332645 -Ref: configuration option-rg-filename-face32767 -Ref: 6432767 -Ref: configuration option-rg-file-tag-face32874 -Ref: 6532874 -Ref: configuration option-rg-line-number-face32994 -Ref: 6632994 -Ref: configuration option-rg-column-number-face33094 -Ref: 6733094 -Ref: configuration option-rg-match-position-face33200 -Ref: 6833200 -Node: Header line33419 -Ref: configuration header-line33496 -Ref: 6933496 -Ref: configuration header-line-config33496 -Ref: 6a33496 -Ref: configuration option-rg-toggle-on-face33533 -Ref: 6b33533 -Ref: configuration option-rg-toggle-off-face33644 -Ref: 6c33644 -Ref: configuration option-rg-literal-face33754 -Ref: 6d33754 -Ref: configuration option-rg-regexp-face33878 -Ref: 6e33878 -Node: Configuration functions34007 -Ref: configuration configuration-functions34121 -Ref: 6f34121 -Ref: configuration id334121 -Ref: 7034121 -Ref: configuration function-rg-enable-default-bindings34178 -Ref: 7134178 -Ref: configuration function-rg-enable-menu34524 -Ref: 7234524 -Ref: configuration function-rg-use-old-defaults34772 -Ref: 7334772 -Node: Configuration macros35065 -Ref: configuration configuration-macros35192 -Ref: 7435192 -Ref: configuration id435192 -Ref: 7535192 -Ref: configuration function-rg-define-toggle35243 -Ref: 3835243 -Ref: configuration function-rg-define-search36152 -Ref: 2236152 -Node: Use with evil-mode39151 -Ref: configuration use-with-evil-mode39275 -Ref: 7639275 -Node: Customizing the menu40249 -Ref: configuration customizing-the-menu40344 -Ref: 7740344 -Ref: configuration id540344 -Ref: 7840344 -Ref: configuration function-rg-menu-transient-insert41380 -Ref: 7941380 -Node: Contribute42003 -Ref: contribute doc42089 -Ref: 7a42089 -Ref: contribute contribute42089 -Ref: 7b42089 -Node: Pull requests42384 -Ref: contribute id142456 -Ref: 7c42456 -Ref: contribute pull-requests42456 -Ref: 7d42456 -Node: Tests43262 -Ref: contribute id243356 -Ref: 7e43356 -Ref: contribute tests43356 -Ref: 7f43356 -Node: Setup43675 -Ref: contribute setup43736 -Ref: 8043736 -Ref: contribute tests-setup43736 -Ref: 8143736 -Node: Running43912 -Ref: contribute running43973 -Ref: 8243973 -Ref: contribute tests-running43973 -Ref: 8343973 -Node: Documentation44254 -Ref: contribute documentation44326 -Ref: 8444326 -Ref: contribute id344326 -Ref: 8544326 -Node: Setup<2>45046 -Ref: contribute documentation-setup45119 -Ref: 8645119 -Ref: contribute id445119 -Ref: 8745119 -Node: Building45359 -Ref: contribute building45432 -Ref: 8845432 -Ref: contribute documentation-building45432 -Ref: 8945432 -Node: License45737 -Ref: index id145815 -Ref: 8a45815 -Ref: index license45815 -Ref: 8b45815 -Node: GNU General Public License46347 -Ref: gpl doc46415 -Ref: 8d46415 -Ref: gpl gnu-general-public-license46415 -Ref: 8e46415 -Ref: gpl gpl46478 -Ref: 8c46478 -Node: Index84391 +Ref: configuration option-rg-prioritized-type-aliases26394 +Ref: 5226394 +Ref: configuration option-rg-default-alias-fallback26774 +Ref: 1826774 +Ref: configuration option-rg-command-line-flags27025 +Ref: 4b27025 +Ref: configuration option-rg-group-result27248 +Ref: 2b27248 +Ref: configuration option-rg-show-columns27590 +Ref: 5327590 +Ref: configuration option-rg-ignore-case27697 +Ref: c27697 +Ref: configuration option-rg-hide-command28337 +Ref: 5428337 +Ref: configuration option-rg-keymap-prefix28591 +Ref: 2128591 +Ref: configuration option-rg-use-transient-menu28823 +Ref: 5528823 +Ref: configuration option-rg-show-header29029 +Ref: 5629029 +Ref: configuration option-rg-buffer-name29237 +Ref: 4629237 +Ref: configuration option-rg-ignore-ripgreprc29959 +Ref: 729959 +Node: Position numbers alignment30594 +Ref: configuration id230668 +Ref: 5730668 +Ref: configuration position-numbers-alignment30668 +Ref: 5830668 +Ref: configuration option-rg-align-position-numbers31275 +Ref: 5931275 +Ref: configuration option-rg-align-line-number-field-length31432 +Ref: 5a31432 +Ref: configuration option-rg-align-column-number-field-length31542 +Ref: 5b31542 +Ref: configuration option-rg-align-line-column-separator31656 +Ref: 5c31656 +Ref: configuration option-rg-align-position-content-separator31835 +Ref: 5d31835 +Node: Faces32036 +Ref: configuration faces32143 +Ref: 5e32143 +Node: Results buffer<2>32346 +Ref: configuration results-buffer32423 +Ref: 5f32423 +Ref: configuration option-rg-match-face32466 +Ref: 6032466 +Ref: configuration option-rg-error-face32557 +Ref: 6132557 +Ref: configuration option-rg-context-face32673 +Ref: 6232673 +Ref: configuration option-rg-info-face32828 +Ref: 6332828 +Ref: configuration option-rg-warning-face32990 +Ref: 6432990 +Ref: configuration option-rg-filename-face33112 +Ref: 6533112 +Ref: configuration option-rg-file-tag-face33219 +Ref: 6633219 +Ref: configuration option-rg-line-number-face33339 +Ref: 6733339 +Ref: configuration option-rg-column-number-face33439 +Ref: 6833439 +Ref: configuration option-rg-match-position-face33545 +Ref: 6933545 +Node: Header line33764 +Ref: configuration header-line33841 +Ref: 6a33841 +Ref: configuration header-line-config33841 +Ref: 6b33841 +Ref: configuration option-rg-toggle-on-face33878 +Ref: 6c33878 +Ref: configuration option-rg-toggle-off-face33989 +Ref: 6d33989 +Ref: configuration option-rg-literal-face34099 +Ref: 6e34099 +Ref: configuration option-rg-regexp-face34223 +Ref: 6f34223 +Node: Configuration functions34352 +Ref: configuration configuration-functions34466 +Ref: 7034466 +Ref: configuration id334466 +Ref: 7134466 +Ref: configuration function-rg-enable-default-bindings34523 +Ref: 7234523 +Ref: configuration function-rg-enable-menu34869 +Ref: 7334869 +Ref: configuration function-rg-use-old-defaults35117 +Ref: 7435117 +Node: Configuration macros35410 +Ref: configuration configuration-macros35537 +Ref: 7535537 +Ref: configuration id435537 +Ref: 7635537 +Ref: configuration function-rg-define-toggle35588 +Ref: 3835588 +Ref: configuration function-rg-define-search36497 +Ref: 2236497 +Node: Use with evil-mode39496 +Ref: configuration use-with-evil-mode39620 +Ref: 7739620 +Node: Customizing the menu40594 +Ref: configuration customizing-the-menu40689 +Ref: 7840689 +Ref: configuration id540689 +Ref: 7940689 +Ref: configuration function-rg-menu-transient-insert41725 +Ref: 7a41725 +Node: Contribute42348 +Ref: contribute doc42434 +Ref: 7b42434 +Ref: contribute contribute42434 +Ref: 7c42434 +Node: Pull requests42729 +Ref: contribute id142801 +Ref: 7d42801 +Ref: contribute pull-requests42801 +Ref: 7e42801 +Node: Tests43607 +Ref: contribute id243701 +Ref: 7f43701 +Ref: contribute tests43701 +Ref: 8043701 +Node: Setup44020 +Ref: contribute setup44081 +Ref: 8144081 +Ref: contribute tests-setup44081 +Ref: 8244081 +Node: Running44257 +Ref: contribute running44318 +Ref: 8344318 +Ref: contribute tests-running44318 +Ref: 8444318 +Node: Documentation44599 +Ref: contribute documentation44671 +Ref: 8544671 +Ref: contribute id344671 +Ref: 8644671 +Node: Setup<2>45391 +Ref: contribute documentation-setup45464 +Ref: 8745464 +Ref: contribute id445464 +Ref: 8845464 +Node: Building45704 +Ref: contribute building45777 +Ref: 8945777 +Ref: contribute documentation-building45777 +Ref: 8a45777 +Node: License46082 +Ref: index id146160 +Ref: 8b46160 +Ref: index license46160 +Ref: 8c46160 +Node: GNU General Public License46692 +Ref: gpl doc46760 +Ref: 8e46760 +Ref: gpl gnu-general-public-license46760 +Ref: 8f46760 +Ref: gpl gpl46823 +Ref: 8d46823 +Node: Index84736  End Tag Table