Vim FAQ and other documentation
From Vim Tips Wiki
Tip 1172 Previous Tip • Next Tip
Created: March 15, 2006 Complexity: basic Author: Gerald Lai Minimum version: 5.7 Karma: 34/24 Imported from: Tip#1172
Vimdoc contains some of the most useful information on Vim found on the Internet:
Especially useful is the FAQ at:
The FAQ answers a lot of basic and advanced questions about how to perform tasks in Vim. If you ever had any questions regarding Vim, make sure you do a search through the FAQ before looking at other resources.
To make the FAQ part of Vim help, copy the file at http://www.geocities.com/yegappan/vim_faq_help.txt to the "doc" directory - for example, in Unix/Linux systems:
$ cp vim_faq_help.txt ~/.vim/doc
Then in Vim, do:
:helptags ~/.vim/doc
After that, to access the FAQ, do:
:help FAQ
Also, a must-read is Bram Moolenaar's "Seven Habits of Effective Text Editing" at: http://www.moolenaar.net/habits.html
[edit] Comments
This command does all that in one strike (on Linux).
$ (cd ~/.vim/doc; wget http://www.geocities.com/yegappan/vim_faq_help.txt; vim "+:helptags .|q")
If ":help FAQ" does not work after :helptags, try
:help vim_faq.txt
Make sure you have write-access to $VIMRUNTIME. Also, it must be in CAPITAL letters.
I downloaded and tried
:helptags .
which gave the following errors:
E154: Duplicate tag "FAQ" in file ./vim_faq_help.txt E154: Duplicate tag "faq" in file ./vim_faq_help.txt
So I edited vim_faq_help.txt, and on line 11 changed
*faq* *FAQ*
to
*iaq* *IAQ*
and re-did
:helptags .
("IAQ": "Infrequently asked questions)
And now
:help iaq
works fine instead. The duplicate tag is on line 78 of intro.txt (*intro.txt* For Vim version 6.4. Last change: 2004 Jun 12)
