|
|
|
|
@@ -1,4 +1,4 @@
|
|
|
|
|
This is company.info, produced by makeinfo version 6.8 from
|
|
|
|
|
This is company.info, produced by makeinfo version 7.1.1 from
|
|
|
|
|
company.texi.
|
|
|
|
|
|
|
|
|
|
This user manual is for Company version 1.0.3-snapshot
|
|
|
|
|
@@ -47,7 +47,7 @@ Copyright © 2021-2024 Free Software Foundation, Inc.
|
|
|
|
|
* Troubleshooting:: When Something Goes Wrong
|
|
|
|
|
* Index::
|
|
|
|
|
|
|
|
|
|
— The Detailed Node Listing —
|
|
|
|
|
-- The Detailed Node Listing --
|
|
|
|
|
|
|
|
|
|
Overview
|
|
|
|
|
|
|
|
|
|
@@ -122,8 +122,8 @@ configurable through the user option ‘completion-styles’, which see.
|
|
|
|
|
For illustrations on how Company visualizes the matches, *note
|
|
|
|
|
Frontends::.
|
|
|
|
|
|
|
|
|
|
The package’s name ‘Company’ is based on the combination of the two
|
|
|
|
|
words: ‘Complete’ and ‘Anything’. These words reflect the package’s
|
|
|
|
|
The package's name ‘Company’ is based on the combination of the two
|
|
|
|
|
words: ‘Complete’ and ‘Anything’. These words reflect the package's
|
|
|
|
|
commitment to handling completion candidates and its extensible nature
|
|
|
|
|
allowing it to cover a wide range of usage scenarios.
|
|
|
|
|
|
|
|
|
|
@@ -154,10 +154,10 @@ commands for the user to operate with. For more details, *note
|
|
|
|
|
Customization:: and *note Commands::.
|
|
|
|
|
|
|
|
|
|
Also, Company is bundled with an alternative workflow configuration
|
|
|
|
|
“company-tng” — defining ‘company-tng-frontend’, ‘company-tng-mode’, and
|
|
|
|
|
‘company-tng-map’ — that allows performing completion with just <TAB>.
|
|
|
|
|
To enable this configuration, add the following line to the Emacs
|
|
|
|
|
initialization file (*note (emacs)Init File::):
|
|
|
|
|
“company-tng” -- defining ‘company-tng-frontend’, ‘company-tng-mode’,
|
|
|
|
|
and ‘company-tng-map’ -- that allows performing completion with just
|
|
|
|
|
<TAB>. To enable this configuration, add the following line to the
|
|
|
|
|
Emacs initialization file (*note (emacs)Init File::):
|
|
|
|
|
|
|
|
|
|
(add-hook 'after-init-hook 'company-tng-mode)
|
|
|
|
|
|
|
|
|
|
@@ -216,7 +216,7 @@ File: company.info, Node: Usage Basics, Next: Commands, Prev: Initial Setup,
|
|
|
|
|
2.3 Usage Basics
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
By default — having _company-mode_ enabled (*note Initial Setup::) — a
|
|
|
|
|
By default -- having _company-mode_ enabled (*note Initial Setup::) -- a
|
|
|
|
|
tooltip with completion candidates is shown when the user types a few
|
|
|
|
|
characters.
|
|
|
|
|
|
|
|
|
|
@@ -228,7 +228,7 @@ respectively key bindings ‘C-n’ and ‘C-p’, then do one of the following:
|
|
|
|
|
• Hit <RET> to choose a selected candidate for completion.
|
|
|
|
|
|
|
|
|
|
• Hit <TAB> to expand the “common part” of all completions. Exactly
|
|
|
|
|
what that means, can vary by backend. In the simplest case it’s
|
|
|
|
|
what that means, can vary by backend. In the simplest case it's
|
|
|
|
|
the longest string that all completion start with, but when a
|
|
|
|
|
backend returns _non-prefix matches_, it can implement the same
|
|
|
|
|
kind of expansion logic for the input string.
|
|
|
|
|
@@ -261,8 +261,8 @@ commands of the out-of-the-box Company.
|
|
|
|
|
|
|
|
|
|
‘TAB’
|
|
|
|
|
‘<tab>’
|
|
|
|
|
Insert the _common part_ of all completion candidates or — if no
|
|
|
|
|
_common part_ is present — select the next candidate
|
|
|
|
|
Insert the _common part_ of all completion candidates or -- if no
|
|
|
|
|
_common part_ is present -- select the next candidate
|
|
|
|
|
(‘company-complete-common-or-cycle’). In the latter case,
|
|
|
|
|
wraparound is implicitly enabled (*note
|
|
|
|
|
company-selection-wrap-around::).
|
|
|
|
|
@@ -360,7 +360,7 @@ core settings that influence its overall behavior.
|
|
|
|
|
than the default value of ‘3’.
|
|
|
|
|
|
|
|
|
|
-- User Option: company-idle-delay
|
|
|
|
|
This is the second of the options that configure Company’s
|
|
|
|
|
This is the second of the options that configure Company's
|
|
|
|
|
auto-start behavior (together with
|
|
|
|
|
‘company-minimum-prefix-length’). The value of this option defines
|
|
|
|
|
how fast Company is going to react to the typed input, such that
|
|
|
|
|
@@ -390,7 +390,7 @@ core settings that influence its overall behavior.
|
|
|
|
|
(setq company-global-modes '(not erc-mode message-mode eshell-mode))
|
|
|
|
|
|
|
|
|
|
-- User Option: company-selection-wrap-around
|
|
|
|
|
Enable this option to loop (cycle) the candidates’ selection: after
|
|
|
|
|
Enable this option to loop (cycle) the candidates' selection: after
|
|
|
|
|
selecting the last candidate on the list, a command to select the
|
|
|
|
|
next candidate does so with the first candidate. By default, this
|
|
|
|
|
option is disabled, which means the selection of the next candidate
|
|
|
|
|
@@ -398,7 +398,7 @@ core settings that influence its overall behavior.
|
|
|
|
|
influenced by this option similarly.
|
|
|
|
|
|
|
|
|
|
-- User Option: company-require-match
|
|
|
|
|
To allow typing in characters that don’t match the candidates, set
|
|
|
|
|
To allow typing in characters that don't match the candidates, set
|
|
|
|
|
the value of this option to ‘nil’. For an opposite behavior (that
|
|
|
|
|
is, to disallow non-matching input), set it to ‘t’. By default,
|
|
|
|
|
Company is configured to require a matching input only if the user
|
|
|
|
|
@@ -484,7 +484,7 @@ listed below.
|
|
|
|
|
-- Function: company-pseudo-tooltip-unless-just-one-frontend
|
|
|
|
|
This is one of the default frontends. It starts displaying a
|
|
|
|
|
tooltip only if more than one completion candidate is available,
|
|
|
|
|
which nicely combines — and it is done so by default — with
|
|
|
|
|
which nicely combines -- and it is done so by default -- with
|
|
|
|
|
‘company-preview-if-just-one-frontend’, *note Preview Frontends::.
|
|
|
|
|
|
|
|
|
|
-- Function: company-pseudo-tooltip-frontend
|
|
|
|
|
@@ -535,7 +535,7 @@ user options.
|
|
|
|
|
|