diff options
| author | Omar Antolín <omar.antolin@gmail.com> | 2021-01-18 13:37:16 -0600 |
|---|---|---|
| committer | Omar Antolín <omar.antolin@gmail.com> | 2021-01-18 13:37:16 -0600 |
| commit | 4844452f4e7008da2ebe96c7dbbb7bcd655bbe68 (patch) | |
| tree | e77ab6d7c6a522dd22a136c8bf648e0f1361e63d /orderless.texi | |
| parent | ec711079923a4817f638c520c56b575dd9084da9 (diff) | |
Update documentation
1. Mention setting completion-category-defaults to nil.
2. Update comments about Selectrum.
Diffstat (limited to 'orderless.texi')
| -rw-r--r-- | orderless.texi | 57 |
1 files changed, 3 insertions, 54 deletions
diff --git a/orderless.texi b/orderless.texi index 0aa29c6..c1dc217 100644 --- a/orderless.texi +++ b/orderless.texi @@ -25,7 +25,6 @@ @end ifnottex @menu -* Overview:: * Customization:: * Integration with other completion UIs:: * Related packages:: @@ -60,57 +59,6 @@ Related packages @end detailmenu @end menu -@node Overview -@chapter Overview - -This package provides an @samp{orderless} @emph{completion style} that divides the -pattern into space-separated components, and matches candidates that -match all of the components in any order. Each component can match in -any one of several ways: literally, as a regexp, as an initialism, in -the flex style, or as multiple word prefixes. By default, regexp and -initialism matches are enabled. - -A completion style is a back-end for completion and is used from a -front-end that provides a completion UI@. Any completion style can be -used with the default Emacs completion UI (sometimes called minibuffer -tab completion) or with the built-in Icomplete package (which is -similar to the more well-known Ido Mode). To use a completion style in -this fashion simply add it as an entry in the variables -@samp{completion-styles} and @samp{completion-category-overrides} (see their -documentation). - -With a bit of effort, it might still be possible to use @samp{orderless} with -other completion UIs, even if those UIs don't support the standard -Emacs completion styles. Currently there is support for @uref{https://github.com/abo-abo/swiper, Ivy} and -@uref{https://github.com/raxod502/selectrum, Selectrum} (see below). - -If you use MELPA, the easiest way to install @samp{orderless} is via -@samp{package-install}. If you use both MELPA and @samp{use-package}, you can use: - -@lisp -(use-package orderless - :ensure t - :init (icomplete-mode) ; optional but recommended! - :custom (completion-styles '(orderless))) -@end lisp - -Alternatively, put @samp{orderless.el} somewhere on your @samp{load-path}, and use -the following configuration: - -@lisp -(require 'orderless) -(setq completion-styles '(orderless)) -(icomplete-mode) ; optional but recommended! -@end lisp - -(And of course, if you use another completion framework such as Ivy or -Helm, disable it.) - -If you like the experience of using @samp{orderless} with Icomplete, but wish -the candidates displayed vertically, you can use @uref{https://github.com/oantolin/icomplete-vertical, icomplete-vertical}. - -Bug reports are highly welcome and appreciated! - @node Customization @chapter Customization @@ -421,8 +369,9 @@ To use @samp{orderless} from Ivy add this to your Ivy configuration: @node Selectrum @section Selectrum -To use @samp{orderless} from Selectrum add this to your Selectrum -configuration: +Recent versions of Selectrum use your configured completion styles by +default! To use @samp{orderless} from Selectrum, you can either stick to that +default or add this to your Selectrum configuration: @lisp (setq selectrum-refine-candidates-function #'orderless-filter) |
