vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Auto merge of #2011 - micbou:readme, r=micbou

Browse Source 
[READY] Fix entries in table of contents

Rename entries of `YcmCompleter subcommands` section in table of contents so that they correspond to their sections title. Add `Miscellaneous commands` missing entry.

<!-- Reviewable:start -->
[<img src="https://reviewable.io/review_button.svg" height="40" alt="Review on Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/2011)
<!-- Reviewable:end -->
This commit is contained in:
Homu 2016-02-28 05:28:47 +09:00
commit 72b08862d3
2 changed files with 106 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
README.md
View File

@ -15,22 +15,24 @@ YouCompleteMe: a code-completion engine for Vim
- [Quick Feature Summary](#quick-feature-summary) - [Quick Feature Summary](#quick-feature-summary)
- [User Guide](#user-guide) - [User Guide](#user-guide)
- [General Usage](#general-usage) - [General Usage](#general-usage)
- [Client-server architecture](#client-server-architecture) - [Client-Server Architecture](#client-server-architecture)
- [Completion string ranking](#completion-string-ranking) - [Completion String Ranking](#completion-string-ranking)
- [General semantic completion](#general-semantic-completion-engine-usage) - [General Semantic Completion](#general-semantic-completion-engine-usage)
- [C-family semantic completion](#c-family-semantic-completion-engine-usage) - [C-family Semantic Completion](#c-family-semantic-completion-engine-usage)
- [JavaScript semantic completion](#javascript-semantic-completion) - [JavaScript Semantic Completion](#javascript-semantic-completion)
- [Rust semantic completion](#rust-semantic-completion) - [Rust Semantic Completion](#rust-semantic-completion)
- [Python semantic completion](#python-semantic-completion) - [Python Semantic Completion](#python-semantic-completion)
- [Semantic completion for other languages](#semantic-completion-for-other-languages) - [Semantic Completion for Other Languages](#semantic-completion-for-other-languages)
- [Writing new semantic completers](#writing-new-semantic-completers) - [Writing New Semantic Completers](#writing-new-semantic-completers)
- [Diagnostic display](#diagnostic-display) - [Diagnostic Display](#diagnostic-display)
- [Diagnostic highlighting groups](#diagnostic-highlighting-groups) - [Diagnostic Highlighting Groups](#diagnostic-highlighting-groups)
- [Commands](#commands) - [Commands](#commands)
- [YcmCompleter subcommands](#ycmcompleter-subcommands) - [YcmCompleter subcommands](#ycmcompleter-subcommands)
- [Go to declaration/definition/etc. commands](#goto-commands) - [GoTo Commands](#goto-commands)
- [Semantic type information and documentation](#semantic-information-commands) - [Semantic Information Commands](#semantic-information-commands)
- [Refactoring and FixIt commands](#refactoring-and-fixit-commands) - [Refactoring and FixIt Commands](#refactoring-and-fixit-commands)
- [Miscellaneous Commands](#miscellaneous-commands)
- [Functions](#functions)
- [Options](#options) - [Options](#options)
- [FAQ](#faq) - [FAQ](#faq)
- [Contributor Code of Conduct](#contributor-code-of-conduct) - [Contributor Code of Conduct](#contributor-code-of-conduct)
@ -107,7 +109,7 @@ features plus extra:
- Supertab - Supertab
- neocomplcache - neocomplcache
### And that's not all... **And that's not all...**
YCM also provides [semantic IDE-like features](#quick-feature-summary) in a YCM also provides [semantic IDE-like features](#quick-feature-summary) in a
number of languages, including: number of languages, including:
@ -129,7 +131,7 @@ and a completer that integrates with [UltiSnips][].
Installation Installation
------------ ------------
### Mac OS X Installation ### Mac OS X
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
@ -198,7 +200,7 @@ YCM comes with sane defaults for its options, but you still may want to take a
look at what's available for configuration. There are a few interesting options look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on. that are conservatively turned off by default that you may want to turn on.
### Ubuntu Linux x64 Installation ### Ubuntu Linux x64
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
@ -256,7 +258,7 @@ YCM comes with sane defaults for its options, but you still may want to take a
look at what's available for configuration. There are a few interesting options look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on. that are conservatively turned off by default that you may want to turn on.
### Fedora Linux x64 Installation ### Fedora Linux x64
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
@ -314,7 +316,7 @@ YCM comes with sane defaults for its options, but you still may want to take a
look at what's available for configuration. There are a few interesting options look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on. that are conservatively turned off by default that you may want to turn on.
### Windows Installation ### Windows
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
@ -389,7 +391,7 @@ YCM comes with sane defaults for its options, but you still may want to take a
look at what's available for configuration. There are a few interesting options look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on. that are conservatively turned off by default that you may want to turn on.
### FreeBSD/OpenBSD Installation ### FreeBSD/OpenBSD
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. OpenBSD / FreeBSD are provided on a best-effort basis and may not work for you. OpenBSD / FreeBSD are
@ -748,14 +750,14 @@ YCM automatically detects which completion engine would be the best in any
situation. On occasion, it queries several of them at once, merges the situation. On occasion, it queries several of them at once, merges the
outputs and presents the results to you. outputs and presents the results to you.
### Client-server architecture ### Client-Server Architecture
YCM has a client-server architecture; the Vim part of YCM is only a thin client YCM has a client-server architecture; the Vim part of YCM is only a thin client
that talks to the [ycmd HTTP+JSON server][ycmd] that has the vast majority of that talks to the [ycmd HTTP+JSON server][ycmd] that has the vast majority of
YCM logic and functionality. The server is started and stopped automatically as YCM logic and functionality. The server is started and stopped automatically as
you start and stop Vim. you start and stop Vim.
### Completion string ranking ### Completion String Ranking
The subsequence filter removes any completions that do not match the input, but The subsequence filter removes any completions that do not match the input, but
then the sorting system kicks in. It's actually very complicated and uses lots then the sorting system kicks in. It's actually very complicated and uses lots
@ -767,13 +769,13 @@ matches). A word-boundary character are all capital characters, characters
preceded by an underscore and the first letter character in the completion preceded by an underscore and the first letter character in the completion
string. string.
### General Semantic Completion Engine Usage ### General Semantic Completion
- You can use Ctrl+Space to trigger the completion suggestions anywhere, even - You can use Ctrl+Space to trigger the completion suggestions anywhere, even
without a string prefix. This is useful to see which top-level functions are without a string prefix. This is useful to see which top-level functions are
available for use. available for use.
### C-family Semantic Completion Engine Usage ### C-family Semantic Completion
YCM looks for a `.ycm_extra_conf.py` file in the directory of the opened file or YCM looks for a `.ycm_extra_conf.py` file in the directory of the opened file or
in any directory above it in the hierarchy (recursively); when the file is in any directory above it in the hierarchy (recursively); when the file is
@ -815,7 +817,7 @@ getting fast completions.
Call the `:YcmDiags` command to see if any errors or warnings were detected in Call the `:YcmDiags` command to see if any errors or warnings were detected in
your file. your file.
### JavaScript semantic completion ### JavaScript Semantic Completion
#### Quick start #### Quick start
@ -862,7 +864,7 @@ should be sought from the [Tern][] project. For example, see the [list of tern
plugins](http://ternjs.net/doc/manual.html#plugins) for the list of plugins plugins](http://ternjs.net/doc/manual.html#plugins) for the list of plugins
which can be enabled in the `plugins` section of the `.tern-project` file. which can be enabled in the `plugins` section of the `.tern-project` file.
##### Configuring Tern for node support ##### Configuring Tern for node support
The following simple example `.tern-project` file enables nodejs support: The following simple example `.tern-project` file enables nodejs support:
@ -909,7 +911,7 @@ define( [ 'mylib/file1', 'anotherlib/anotherfile' ], function( f1, f2 ) {
} ); } );
``` ```
### Rust semantic completion ### Rust Semantic Completion
Completions and GoTo commands within the current crate and its dependencies Completions and GoTo commands within the current crate and its dependencies
should work out of the box with no additional configuration (provided that you should work out of the box with no additional configuration (provided that you
@ -925,7 +927,7 @@ locate it.
let g:ycm_rust_src_path = '/usr/local/rust/rustc-1.5.0/src' let g:ycm_rust_src_path = '/usr/local/rust/rustc-1.5.0/src'
``` ```
### Python semantic completion ### Python Semantic Completion
Completion and GoTo commands work out of the box with no additional Completion and GoTo commands work out of the box with no additional
configuration. Those features are provided by the [jedi][] library which configuration. Those features are provided by the [jedi][] library which
@ -939,7 +941,7 @@ binary to use. For example, to provide Python 3 completion in your project, set:
let g:ycm_python_binary_path = '/usr/bin/python3' let g:ycm_python_binary_path = '/usr/bin/python3'
``` ```
### Semantic completion for other languages ### Semantic Completion for Other Languages
Python, C#, Go, Rust, and TypeScript are supported natively by YouCompleteMe Python, C#, Go, Rust, and TypeScript are supported natively by YouCompleteMe
using the [Jedi][], [Omnisharp][], [Gocode][], [racer][], and [TSServer][] using the [Jedi][], [Omnisharp][], [Gocode][], [racer][], and [TSServer][]
@ -987,7 +989,7 @@ complete-functions`. For the Completer API, see [the API docs][completer-api].
If you want to upstream your completer into YCM's source, you should use the If you want to upstream your completer into YCM's source, you should use the
Completer API. Completer API.
### Diagnostic display ### Diagnostic Display
YCM will display diagnostic notifications for C-family and C# languages if you YCM will display diagnostic notifications for C-family and C# languages if you
compiled YCM with Clang and Omnisharp support, respectively. Since YCM continuously compiled YCM with Clang and Omnisharp support, respectively. Since YCM continuously
@ -1034,7 +1036,7 @@ another (very small) Vim plugin called [ListToggle][] (which also makes it
possible to change the height of the `locationlist` window), also written by possible to change the height of the `locationlist` window), also written by
yours truly. yours truly.
#### Diagnostic highlighting groups #### Diagnostic Highlighting Groups
You can change the styling for the highlighting groups YCM uses. For the signs You can change the styling for the highlighting groups YCM uses. For the signs
in the Vim gutter, the relevant groups are: in the Vim gutter, the relevant groups are:
@ -1137,7 +1139,7 @@ See the [file type feature summary](#quick-feature-summary) for an overview of
the features available for each file type. See the _YcmCompleter subcommands_ the features available for each file type. See the _YcmCompleter subcommands_
section for more information on the available subcommands and their usage. section for more information on the available subcommands and their usage.
YcmCompleter subcommands YcmCompleter Subcommands
------------------------ ------------------------
NOTE: See the docs for the `YcmCompleter` command before tackling this section. NOTE: See the docs for the `YcmCompleter` command before tackling this section.
@ -1152,7 +1154,7 @@ You may also want to map the subcommands to something less verbose; for
instance, `nnoremap <leader>jd :YcmCompleter GoTo<CR>` instance, `nnoremap <leader>jd :YcmCompleter GoTo<CR>`
maps the `<leader>jd` sequence to the longer subcommand invocation. maps the `<leader>jd` sequence to the longer subcommand invocation.
### GoTo commands ### GoTo Commands
These commands are useful for jumping around and exploring code. When moving These commands are useful for jumping around and exploring code. When moving
the cursor, the subcommands add entries to Vim's `jumplist` so you can use the cursor, the subcommands add entries to Vim's `jumplist` so you can use
@ -1231,7 +1233,7 @@ provides a list of implementations to choose from.
Supported in filetypes: `cs` Supported in filetypes: `cs`
### Semantic information commands ### Semantic Information Commands
These commands are useful for finding static information about the code, such These commands are useful for finding static information about the code, such
as the types of variables, viewing declarations and documentation strings. as the types of variables, viewing declarations and documentation strings.
@ -1311,7 +1313,7 @@ under the cursor. Depending on the file type, this includes things like:
Supported in filetypes: `c, cpp, objc, objcpp, cs, python, typescript, Supported in filetypes: `c, cpp, objc, objcpp, cs, python, typescript,
javascript` javascript`
### Refactoring and FixIt commands ### Refactoring and FixIt Commands
These commands make changes to your source code in order to perform refactoring These commands make changes to your source code in order to perform refactoring
or code correction. YouCompleteMe does not perform any action which cannot be or code correction. YouCompleteMe does not perform any action which cannot be
@ -1393,7 +1395,7 @@ manually corrected using Vim's undo features. The quickfix list is *not*
populated in this case. Inspect `:buffers` or equivalent (see `:help buffers`) populated in this case. Inspect `:buffers` or equivalent (see `:help buffers`)
to see the buffers that were opened by the command. to see the buffers that were opened by the command.
### Miscellaneous commands ### Miscellaneous Commands
These commands are for general administration, rather than IDE-like features. These commands are for general administration, rather than IDE-like features.
They cover things like the semantic engine server instance and compilation They cover things like the semantic engine server instance and compilation
@ -2751,7 +2753,7 @@ License
------- -------
This software is licensed under the [GPL v3 license][gpl]. This software is licensed under the [GPL v3 license][gpl].
© 2015 YouCompleteMe contributors © 2015-2016 YouCompleteMe contributors
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/Valloric/youcompleteme/trend.png)](https://bitdeli.com/free "Bitdeli Badge") [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/Valloric/youcompleteme/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

134
doc/youcompleteme.txt
View File

@ -5,13 +5,12 @@ Contents ~
1. Introduction |youcompleteme-introduction| 1. Introduction |youcompleteme-introduction|
2. Intro |youcompleteme-intro| 2. Intro |youcompleteme-intro|
1. And that's not all... |youcompleteme-thats-not-all...|
3. Installation |youcompleteme-installation| 3. Installation |youcompleteme-installation|
1. Mac OS X Installation |youcompleteme-mac-os-x-installation| 1. Mac OS X |youcompleteme-mac-os-x|
2. Ubuntu Linux x64 Installation |youcompleteme-ubuntu-linux-x64-installation| 2. Ubuntu Linux x64 |youcompleteme-ubuntu-linux-x64|
3. Fedora Linux x64 Installation |youcompleteme-fedora-linux-x64-installation| 3. Fedora Linux x64 |youcompleteme-fedora-linux-x64|
4. Windows Installation |youcompleteme-windows-installation| 4. Windows |youcompleteme-windows|
5. FreeBSD/OpenBSD Installation |youcompleteme-freebsd-openbsd-installation| 5. FreeBSD/OpenBSD |youcompleteme-freebsd-openbsd|
6. Full Installation Guide |youcompleteme-full-installation-guide| 6. Full Installation Guide |youcompleteme-full-installation-guide|
4. Quick Feature Summary |youcompleteme-quick-feature-summary| 4. Quick Feature Summary |youcompleteme-quick-feature-summary|
1. General (all languages) |youcompleteme-general| 1. General (all languages) |youcompleteme-general|
@ -24,22 +23,22 @@ Contents ~
8. Rust |youcompleteme-rust| 8. Rust |youcompleteme-rust|
5. User Guide |youcompleteme-user-guide| 5. User Guide |youcompleteme-user-guide|
1. General Usage |youcompleteme-general-usage| 1. General Usage |youcompleteme-general-usage|
2. Client-server architecture |youcompleteme-client-server-architecture| 2. Client-Server Architecture |youcompleteme-client-server-architecture|
3. Completion string ranking |youcompleteme-completion-string-ranking| 3. Completion String Ranking |youcompleteme-completion-string-ranking|
4. General Semantic Completion Engine Usage |youcompleteme-general-semantic-completion-engine-usage| 4. General Semantic Completion |youcompleteme-general-semantic-completion|
5. C-family Semantic Completion Engine Usage |youcompleteme-c-family-semantic-completion-engine-usage| 5. C-family Semantic Completion |youcompleteme-c-family-semantic-completion|
6. JavaScript semantic completion |youcompleteme-javascript-semantic-completion| 6. JavaScript Semantic Completion |youcompleteme-javascript-semantic-completion|
1. Quick start |youcompleteme-quick-start| 1. Quick start |youcompleteme-quick-start|
2. Explanation |youcompleteme-explanation| 2. Explanation |youcompleteme-explanation|
3. Tips and tricks |youcompleteme-tips-tricks| 3. Tips and tricks |youcompleteme-tips-tricks|
1. Configuring Tern for node support |youcompleteme-configuring-tern-for-node-support| 1. Configuring Tern for node support |youcompleteme-configuring-tern-for-node-support|
2. Configuring Tern for requirejs support |youcompleteme-configuring-tern-for-requirejs-support| 2. Configuring Tern for requirejs support |youcompleteme-configuring-tern-for-requirejs-support|
7. Rust semantic completion |youcompleteme-rust-semantic-completion| 7. Rust Semantic Completion |youcompleteme-rust-semantic-completion|
8. Python semantic completion |youcompleteme-python-semantic-completion| 8. Python Semantic Completion |youcompleteme-python-semantic-completion|
9. Semantic completion for other languages |youcompleteme-semantic-completion-for-other-languages| 9. Semantic Completion for Other Languages |youcompleteme-semantic-completion-for-other-languages|
10. Writing New Semantic Completers |youcompleteme-writing-new-semantic-completers| 10. Writing New Semantic Completers |youcompleteme-writing-new-semantic-completers|
11. Diagnostic display |youcompleteme-diagnostic-display| 11. Diagnostic Display |youcompleteme-diagnostic-display|
1. Diagnostic highlighting groups |youcompleteme-diagnostic-highlighting-groups| 1. Diagnostic Highlighting Groups |youcompleteme-diagnostic-highlighting-groups|
6. Commands |youcompleteme-commands| 6. Commands |youcompleteme-commands|
1. The |:YcmRestartServer| command 1. The |:YcmRestartServer| command
2. The |:YcmForceCompileAndDiagnostics| command 2. The |:YcmForceCompileAndDiagnostics| command
@ -48,8 +47,8 @@ Contents ~
5. The |:YcmDebugInfo| command 5. The |:YcmDebugInfo| command
6. The |:YcmToggleLogs| command 6. The |:YcmToggleLogs| command
7. The |:YcmCompleter| command 7. The |:YcmCompleter| command
7. YcmCompleter subcommands |youcompleteme-ycmcompleter-subcommands| 7. YcmCompleter Subcommands |youcompleteme-ycmcompleter-subcommands|
1. GoTo commands |youcompleteme-goto-commands| 1. GoTo Commands |youcompleteme-goto-commands|
1. The |GoToInclude| subcommand 1. The |GoToInclude| subcommand
2. The |GoToDeclaration| subcommand 2. The |GoToDeclaration| subcommand
3. The |GoToDefinition| subcommand 3. The |GoToDefinition| subcommand
@ -58,15 +57,15 @@ Contents ~
6. The |GoToReferences| subcommand 6. The |GoToReferences| subcommand
7. The |GoToImplementation| subcommand 7. The |GoToImplementation| subcommand
8. The |GoToImplementationElseDeclaration| subcommand 8. The |GoToImplementationElseDeclaration| subcommand
2. Semantic information commands |youcompleteme-semantic-information-commands| 2. Semantic Information Commands |youcompleteme-semantic-information-commands|
1. The |GetType| subcommand 1. The |GetType| subcommand
2. The |GetParent| subcommand 2. The |GetParent| subcommand
3. The |GetDoc| subcommand 3. The |GetDoc| subcommand
3. Refactoring and FixIt commands |youcompleteme-refactoring-fixit-commands| 3. Refactoring and FixIt Commands |youcompleteme-refactoring-fixit-commands|
1. The |FixIt| subcommand 1. The |FixIt| subcommand
2. The 'RefactorRename <new name>' subcommand |RefactorRename-new-name| 2. The 'RefactorRename <new name>' subcommand |RefactorRename-new-name|
3. Multi-file Refactor |youcompleteme-multi-file-refactor| 3. Multi-file Refactor |youcompleteme-multi-file-refactor|
4. Miscellaneous commands |youcompleteme-miscellaneous-commands| 4. Miscellaneous Commands |youcompleteme-miscellaneous-commands|
1. The |ClearCompilationFlagCache| subcommand 1. The |ClearCompilationFlagCache| subcommand
2. The |StartServer| subcommand 2. The |StartServer| subcommand
3. The |StopServer| subcommand 3. The |StopServer| subcommand
@ -181,26 +180,29 @@ Image: Build Status [1] Image: Build status [3]
- User Guide - User Guide
- General Usage - General Usage
- Client-server architecture - Client-Server Architecture
- Completion string ranking - Completion String Ranking
- General semantic completion - General Semantic Completion
- C-family semantic completion - C-family Semantic Completion
- JavaScript semantic completion - JavaScript Semantic Completion
- Rust semantic completion - Rust Semantic Completion
- Python semantic completion - Python Semantic Completion
- Semantic completion for other languages - Semantic Completion for Other Languages
- Writing new semantic completers - Writing New Semantic Completers
- Diagnostic display - Diagnostic Display
- Diagnostic highlighting groups
- Diagnostic Highlighting Groups
- Commands - Commands
- YcmCompleter subcommands - YcmCompleter subcommands
- Go to declaration/definition/etc. commands - GoTo Commands
- Semantic type information and documentation - Semantic Information Commands
- Refactoring and FixIt commands - Refactoring and FixIt Commands
- Miscellaneous Commands
- Functions
- Options - Options
- FAQ - FAQ
- Contributor Code of Conduct - Contributor Code of Conduct
@ -288,9 +290,7 @@ features plus extra:
- Supertab - Supertab
- neocomplcache - neocomplcache
------------------------------------------------------------------------------- **And that's not all...**
*youcompleteme-thats-not-all...*
And that's not all... ~
YCM also provides semantic IDE-like features in a number of languages, YCM also provides semantic IDE-like features in a number of languages,
including: including:
@ -313,8 +313,8 @@ and a completer that integrates with UltiSnips [17].
Installation ~ Installation ~
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-mac-os-x-installation* *youcompleteme-mac-os-x*
Mac OS X Installation ~ Mac OS X ~
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
@ -387,8 +387,8 @@ look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on. that are conservatively turned off by default that you may want to turn on.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-ubuntu-linux-x64-installation* *youcompleteme-ubuntu-linux-x64*
Ubuntu Linux x64 Installation ~ Ubuntu Linux x64 ~
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
@ -451,8 +451,8 @@ look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on. that are conservatively turned off by default that you may want to turn on.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-fedora-linux-x64-installation* *youcompleteme-fedora-linux-x64*
Fedora Linux x64 Installation ~ Fedora Linux x64 ~
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
@ -515,8 +515,8 @@ look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on. that are conservatively turned off by default that you may want to turn on.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-windows-installation* *youcompleteme-windows*
Windows Installation ~ Windows ~
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
@ -596,8 +596,8 @@ look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on. that are conservatively turned off by default that you may want to turn on.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-freebsd-openbsd-installation* *youcompleteme-freebsd-openbsd*
FreeBSD/OpenBSD Installation ~ FreeBSD/OpenBSD ~
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. OpenBSD / FreeBSD are provided on a best-effort basis and may not work for you. OpenBSD / FreeBSD are
@ -987,7 +987,7 @@ and presents the results to you.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-client-server-architecture* *youcompleteme-client-server-architecture*
Client-server architecture ~ Client-Server Architecture ~
YCM has a client-server architecture; the Vim part of YCM is only a thin client YCM has a client-server architecture; the Vim part of YCM is only a thin client
that talks to the ycmd HTTP+JSON server [34] that has the vast majority of YCM that talks to the ycmd HTTP+JSON server [34] that has the vast majority of YCM
@ -996,7 +996,7 @@ start and stop Vim.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-completion-string-ranking* *youcompleteme-completion-string-ranking*
Completion string ranking ~ Completion String Ranking ~
The subsequence filter removes any completions that do not match the input, but The subsequence filter removes any completions that do not match the input, but
then the sorting system kicks in. It's actually very complicated and uses lots then the sorting system kicks in. It's actually very complicated and uses lots
@ -1009,16 +1009,16 @@ preceded by an underscore and the first letter character in the completion
string. string.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-general-semantic-completion-engine-usage* *youcompleteme-general-semantic-completion*
General Semantic Completion Engine Usage ~ General Semantic Completion ~
- You can use Ctrl+Space to trigger the completion suggestions anywhere, even - You can use Ctrl+Space to trigger the completion suggestions anywhere, even
without a string prefix. This is useful to see which top-level functions without a string prefix. This is useful to see which top-level functions
are available for use. are available for use.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-c-family-semantic-completion-engine-usage* *youcompleteme-c-family-semantic-completion*
C-family Semantic Completion Engine Usage ~ C-family Semantic Completion ~
YCM looks for a '.ycm_extra_conf.py' file in the directory of the opened file YCM looks for a '.ycm_extra_conf.py' file in the directory of the opened file
or in any directory above it in the hierarchy (recursively); when the file is or in any directory above it in the hierarchy (recursively); when the file is
@ -1062,7 +1062,7 @@ your file.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-javascript-semantic-completion* *youcompleteme-javascript-semantic-completion*
JavaScript semantic completion ~ JavaScript Semantic Completion ~
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-quick-start* *youcompleteme-quick-start*
@ -1159,7 +1159,7 @@ Can be used as follows:
< <
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-rust-semantic-completion* *youcompleteme-rust-semantic-completion*
Rust semantic completion ~ Rust Semantic Completion ~
Completions and GoTo commands within the current crate and its dependencies Completions and GoTo commands within the current crate and its dependencies
should work out of the box with no additional configuration (provided that you should work out of the box with no additional configuration (provided that you
@ -1174,7 +1174,7 @@ following option so YouCompleteMe can locate it.
< <
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-python-semantic-completion* *youcompleteme-python-semantic-completion*
Python semantic completion ~ Python Semantic Completion ~
Completion and GoTo commands work out of the box with no additional Completion and GoTo commands work out of the box with no additional
configuration. Those features are provided by the jedi [6] library which configuration. Those features are provided by the jedi [6] library which
@ -1189,7 +1189,7 @@ set:
< <
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-semantic-completion-for-other-languages* *youcompleteme-semantic-completion-for-other-languages*
Semantic completion for other languages ~ Semantic Completion for Other Languages ~
Python, C#, Go, Rust, and TypeScript are supported natively by YouCompleteMe Python, C#, Go, Rust, and TypeScript are supported natively by YouCompleteMe
using the Jedi [6], Omnisharp [8], Gocode [9], racer [13], and TSServer [11] using the Jedi [6], Omnisharp [8], Gocode [9], racer [13], and TSServer [11]
@ -1245,7 +1245,7 @@ Completer API.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-diagnostic-display* *youcompleteme-diagnostic-display*
Diagnostic display ~ Diagnostic Display ~
YCM will display diagnostic notifications for C-family and C# languages if you YCM will display diagnostic notifications for C-family and C# languages if you
compiled YCM with Clang and Omnisharp support, respectively. Since YCM compiled YCM with Clang and Omnisharp support, respectively. Since YCM
@ -1295,7 +1295,7 @@ yours truly.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-diagnostic-highlighting-groups* *youcompleteme-diagnostic-highlighting-groups*
Diagnostic highlighting groups ~ Diagnostic Highlighting Groups ~
You can change the styling for the highlighting groups YCM uses. For the signs You can change the styling for the highlighting groups YCM uses. For the signs
in the Vim gutter, the relevant groups are: in the Vim gutter, the relevant groups are:
@ -1403,7 +1403,7 @@ on the available subcommands and their usage.
=============================================================================== ===============================================================================
*youcompleteme-ycmcompleter-subcommands* *youcompleteme-ycmcompleter-subcommands*
YcmCompleter subcommands ~ YcmCompleter Subcommands ~
NOTE: See the docs for the 'YcmCompleter' command before tackling this section. NOTE: See the docs for the 'YcmCompleter' command before tackling this section.
@ -1419,7 +1419,7 @@ sequence to the longer subcommand invocation.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-goto-commands* *youcompleteme-goto-commands*
GoTo commands ~ GoTo Commands ~
These commands are useful for jumping around and exploring code. When moving These commands are useful for jumping around and exploring code. When moving
the cursor, the subcommands add entries to Vim's 'jumplist' so you can use the cursor, the subcommands add entries to Vim's 'jumplist' so you can use
@ -1509,7 +1509,7 @@ Supported in filetypes: 'cs'
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-semantic-information-commands* *youcompleteme-semantic-information-commands*
Semantic information commands ~ Semantic Information Commands ~
These commands are useful for finding static information about the code, such These commands are useful for finding static information about the code, such
as the types of variables, viewing declarations and documentation strings. as the types of variables, viewing declarations and documentation strings.
@ -1588,7 +1588,7 @@ javascript'
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-refactoring-fixit-commands* *youcompleteme-refactoring-fixit-commands*
Refactoring and FixIt commands ~ Refactoring and FixIt Commands ~
These commands make changes to your source code in order to perform refactoring These commands make changes to your source code in order to perform refactoring
or code correction. YouCompleteMe does not perform any action which cannot be or code correction. YouCompleteMe does not perform any action which cannot be
@ -1678,7 +1678,7 @@ to see the buffers that were opened by the command.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
*youcompleteme-miscellaneous-commands* *youcompleteme-miscellaneous-commands*
Miscellaneous commands ~ Miscellaneous Commands ~
These commands are for general administration, rather than IDE-like features. These commands are for general administration, rather than IDE-like features.
They cover things like the semantic engine server instance and compilation They cover things like the semantic engine server instance and compilation
@ -3028,8 +3028,8 @@ The author's homepage is http://val.markovic.io.
*youcompleteme-license* *youcompleteme-license*
License ~ License ~
This software is licensed under the GPL v3 license [59]. © 2015 YouCompleteMe This software is licensed under the GPL v3 license [59]. © 2015-2016
contributors YouCompleteMe contributors
Image: Bitdeli Badge [60] Image: Bitdeli Badge [60]