code.delx.au - gnu-emacs-elpa/blob - README.md

   1 Company Mode
   2 ====
   3
   4 About
   5 ----
   6
   7 Company is an Emacs extension for performing text completion.
   8
   9 Completion candidates are retrieved from a variety of back-ends, such as
  10 `abbrev`, `Semantic`, `Eclim`, `etags`, etc.
  11
  12 Screenshots
  13 ----
  14
  15 [<img src="screenshots/company-elisp.png" alt="company-elisp" width="256"/>](screenshots/company-elisp.png)
  16 [<img src="screenshots/company-cpp.png" alt="company-cpp" width="256"/>](screenshots/company-cpp.png)
  17
  18 Installation
  19 ----
  20
  21 This package is part of [GNU ELPA](http://elpa.gnu.org/) (<kbd>M-x
  22 list-packages</kbd>).
  23
  24 Usage
  25 ----
  26
  27 Once installed, enable company-mode with <kbd>M-x company-mode</kbd>.
  28
  29 Completion will start automatically after you type a few letters. Use
  30 <kbd>M-n</kbd>, <kbd>M-p</kbd>, <kbd>\<tab\></kbd> and <kbd>\<return\></kbd> to
  31 complete. Search through the completions with <kbd>C-s</kbd>, <kbd>C-r</kbd> and
  32 <kbd>C-o</kbd>.
  33
  34 To use `company-mode` in all buffers, add the following to your init file:
  35
  36     (global-company-mode)
  37
  38 To set up preferred back-ends, customize `company-backends`.
  39
  40 Also see this variable's docstring for information on writing a back-end.
  41
  42 For more information, see the docstring for `company-mode`.
  43
  44 Feedback
  45 ----
  46
  47 If you experience any problems or have a feature request, use the
  48 [Issue Tracker](https://github.com/dgutov/company/issues).