Merge pull request #120 from Konfekt/patch-1

document necessity of --servername in Unix terminal Vim
This commit is contained in:
Karl Yngve Lervåg 2015-02-18 09:29:24 +01:00
commit ce5db6693b

View File

@ -63,6 +63,15 @@ Some of the functionalities of |vim-latex| has certain requirements:
Requires that the user has installed both `latexmk` and `pgrep`. If these
are not available, then the functionalities provided by
|vim-latex-latexmk| will not be available.
If you use Vim under a Terminal in Linux or MacOS, then Vim must also
explicitly be started as a command server by appending the parameter
`--servername`. For example, `vim --servername VIM`.
A ready and mostly sufficient way to ensure this, is by adding an alias
`alias vim=vim --servername VIM` to your Shell (for example, in ~/.bashrc
or ~/.zshrc).
A more thorough solution is to create a shell script `vim` in $PATH that
calls vim with the argument `--servername VIM`. See Method (B)
at http://vim.wikia.com/wiki/Enable_servername_capability_in_vim/xterm
|vim-latex-completion|
The function |latex#complete#bibtex| requires `bibtex` and `kpsewhich` to