-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.html
181 lines (142 loc) · 6.58 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'/>
<meta http-equiv="X-UA-Compatible" content="chrome=1"/>
<link href='https://fonts.googleapis.com/css?family=Chivo:900' rel='stylesheet' type='text/css'/>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>company-mode for Emacs</title>
</head>
<body>
<div id="container">
<div class="inner">
<header>
<h1>company-mode</h1>
<h2>Modular in-buffer completion framework for Emacs</h2>
</header>
<section id="downloads" class="clearfix">
<a href="https://github.com/company-mode/company-mode" id="view-on-github" class="button"><span>View on GitHub</span></a>
</section>
<hr>
<section id="main_content">
<h2>About</h2>
<p>Company is a text and code completion framework for Emacs. The name
stands for "<em>comp</em>lete <em>any</em>thing". It uses pluggable
back-ends and front-ends to retrieve and display completion
candidates.</p>
<p>It comes with several back-ends such as
<code>Clang</code>, <code>Ispell</code>,
<code>CMake</code>, <code>BBDB</code>, <code>Yasnippet</code>,
<code>Dabbrev</code>, <code>Etags</code>, <code>Gtags</code>,
<code>Files</code>, <code>Keywords</code> and others.</p>
<p>And the <code>CAPF</code> back-end provides a bridge to the
standard <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Completion-in-Buffers.html"
target="_blank">completion-at-point-functions</a> facility, and thus
works with any major mode that uses the common protocol.</p>
<h2>Screenshots</h2>
<p class="screenshots">
<a href="images/company-elisp.png">
<img src="images/company-elisp.png" alt="company-elisp" width="214">
</a>
<a href="images/company-semantic.png">
<img src="images/company-semantic.png" alt="company-semantic" width="214">
</a>
</p>
<h2>Installation</h2>
<p>This package is part of <a href="http://elpa.gnu.org/">GNU ELPA</a> (<kbd>M-x
list-packages</kbd>).</p>
<p><kbd>M-x package-install RET company RET</kbd> </p>
<p>Advanced users can also download the <a href="https://github.com/company-mode/company-mode/zipball/master">development snapshot</a>.</p>
<h2>Usage</h2>
<p>Once installed, enable <code>company-mode</code> with <kbd>M-x company-mode</kbd>.</p>
<p>Completion will start automatically after you type a few letters. Use
<kbd>C-n</kbd> and <kbd>C-p</kbd> to select, <kbd><return></kbd> to
complete or <kbd><tab></kbd> to complete the common part.
Search through the completions with <kbd>C-s</kbd>, <kbd>C-r</kbd>
and <kbd>C-o</kbd>. Press <kbd>M-(digit)</kbd> to quickly complete
with one of the first 10 candidates.</p>
<p>Type <kbd>M-x company-complete</kbd> to initiate completion
manually. <a href="http://www.gnu.org/software/emacs/manual/html_node/elisp/Key-Binding-Commands.html"
target="_blank">Bind</a> this command to a key combination of your
choice (this is optional).</p>
<p>When the completion candidates are shown,
press <kbd><f1></kbd> to display the documentation for the
selected candidate, or <kbd>C-w</kbd> to see its source. Not all
back-ends support this.</p>
<p>To use <code>company-mode</code> in all buffers, add the following
line to your init file:</p>
<pre><code>(add-hook 'after-init-hook 'global-company-mode)
</code></pre>
<p>To see or change the list of enabled back-ends, type <kbd>M-x
customize-variable RET company-backends</kbd>. Also see its
description for information on writing a back-end.</p>
<p>For information on specific back-ends, also check out the comments
inside the respective files.</p>
<p>For more information, type <kbd>M-x describe-function RET
company-mode</kbd>.</p>
<p>To customize other aspects of its behavior, type <kbd>M-x customize-group RET
company</kbd>.</p>
<p>To diagnose missing or wrong completions, try <kbd>M-x company-diag</kbd> as the first step.</p>
<h2>See Also</h2>
<ul>
<li>
<a href="manual">
User Manual
</a>
</li>
<li>
<a href="https://github.com/company-mode/company-mode/blob/master/NEWS.md">
Latest Changes
</a>
</li>
<li>
<a href="https://github.com/company-mode/company-mode/wiki/Third-Party-Packages">
Third-Party Packages
</a>
</li>
<li>
<a href="https://github.com/company-mode/company-mode/wiki/Writing-backends">
Writing backends
</a>
</li>
</ul>
<h2>Feedback</h2>
<p>If you experience any problems, please use the
<a href="https://github.com/company-mode/company-mode/issues">issue tracker</a>.
If you have a question or would like to submit a feature request, start a new
<a href="https://github.com/company-mode/company-mode/discussions/">discussion</a>.</p>
<h2>Contributing</h2>
<p>Company is successful thanks to the input from many volunteers.</p>
<p>We welcome <strong>everyone</strong> to become a part of this project.
Some ideas on how you could participate are listed in the
<a href="https://github.com/company-mode/company-mode/blob/master/CONTRIBUTING.md">Contributing file</a>.
And <a href="https://github.com/company-mode/company-mode/blob/master/LICENSE">feel free</a>
to find your own unique way to improve Company.</p>
<h2>More Reading</h2>
<ul>
<li><a href="https://www.gnu.org/software/emacs/manual/html_node/eglot/Quick-Start.html">Eglot Quick Start (built-in LSP client for Emacs)</li>
<li><a href="https://emacs-lsp.github.io/lsp-mode/tutorials/CPP-guide/">LSP Mode: Configuring Emacs as a C/C++ IDE (alternative LSP client)</li>
<li><a href="http://lorefnon.me/2014/02/02/configuring-emacs-for-rails.html">Configuring Emacs for Rails</a></li>
<li><a href="http://www.emacswiki.org/emacs/CompanyMode">CompanyMode EmacsWiki page</a></li>
</ul>
</section>
<footer>
This page was generated by <a href="http://pages.github.com">GitHub Pages</a>. Tactile theme by <a href="http://twitter.com/jasonlong">Jason Long</a>.
</footer>
</div>
</div>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-JFMMGZ27EK"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-JFMMGZ27EK');
</script>
</body>
</html>