Lines Matching refs:help
7 Help on help files *helphelp*
9 1. Help commands |online-help|
10 2. Translated help files |help-translated|
11 3. Writing help files |help-writing|
14 1. Help commands *online-help*
16 *help* *<Help>* *:h* *:help* *<F1>* *i_<F1>* *i_<Help>*
18 :h[elp] Open a window and display the help file in read-only
19 mode. If there is a help window open already, use
22 wide, the help window will appear just above the
26 the main help file is available in several languages.
29 :h[elp] {subject} Like ":help", additionally jump to the tag {subject}.
31 :help options
35 :help z? jump to help for any "z" command
36 :help z. jump to the help for "z."
38 :help :? jump to help for ":?"
59 |help-translated|.
64 after ":help subject" |c_CTRL-D|).
67 :help cont<Ctrl-D>
69 < Instead of typing ":help CTRL-V" to search for help
71 :help ^V
73 example to find help for CTRL-V in Insert mode: >
74 :help i^V
76 It is also possible to first do ":help" and then
77 use ":tag {pattern}" in the help window. The
80 :help index
84 "help", to avoid listing all possible matches (that
88 The `:help` command can be followed by '|' and another
90 help command. So these both work: >
91 :help |
92 :help k| only
94 the ":help" argument.
95 You can also use <NL> or <CR> to separate the help
98 :help so<C-V><CR>only
100 :h[elp]! [subject] Like ":help", but in non-English help files prefer to
102 current file. See |help-translated|.
105 :helpc[lose] Close one help window, if there is one.
108 opening the help window initially. This might cause
113 Search all help text files and make a list of lines
127 < Example for searching in French help: >
131 but then you need to get the list of help files in a
136 Compressed help files will not be searched (Fedora
137 compresses the help files).
142 instead of the quickfix list. If the help window is
144 is used. Otherwise, a new help window is opened and
150 :exu[sage] Show help on Ex commands. Added to simulate the Nvi
154 :viu[sage] Show help on Normal mode commands. Added to simulate
157 When no argument is given to |:help| the file given with the 'helpfile' option
161 If you would like to open the help in the current window, see this tip:
162 |help-curwin|.
164 The initial height of the help window can be set with the 'helpheight' option
167 When the help buffer is created, several local options are set to make sure
168 the help text is displayed as it was intended:
194 Use ":q" to close the help window.
198 1. Open a help window
203 It is possible to add help files for plugins and other items. You don't need
204 to change the distributed help files for that. See |add-local-help|.
206 To write a local help file, see |write-local-help|.
208 Note that the title lines from the local help files are automagically added to
209 the "LOCAL ADDITIONS" section in the "help.txt" help file |local-additions|.
211 is done by going through all help files and obtaining the first line of each
214 *help-xterm-window*
215 If you want to have the help in another xterm window, you could use this
217 :!xterm -e vim +help &
221 :helpf[ind] Like |:help|, but use a dialog to enter the argument.
229 Generate the help tags file(s) for directory {dir}.
234 sub-directories are scanned for a help tag definition
237 |help-translated|. The generated tags files are
243 "help-tags" tag. This is also done when the {dir} is
246 To rebuild the help tags in the runtime directory
251 2. Translated help files *help-translated*
253 It is possible to add translated help files, next to the original English help
254 files. Vim will search for all help in "doc" directories in 'runtimepath'.
266 A set of translated help files consists of these files:
268 help.abx
275 help.itx
292 When using command-line completion for the ":help" command, the "@en"
298 When using |CTRL-]| or ":help!" in a non-English help file Vim will try to
306 The same encoding must be used for the help files of one language in one
308 a different encoding for help files of the same language but in a different
323 3. Writing help files *help-writing*
325 For ease of use, a Vim help file for a plugin should follow the format of the
326 standard Vim help files, except fot the fist line. If you are writing a new
327 help file it's best to copy one of the existing files and use it as a
330 The first line in a help file should have the following format:
334 The first field is a help tag where ":help plugin_name" will jump to. The
336 way. This will show up in the "LOCAL ADDITIONS" section of the main help
342 At the bottom of the help file, place a Vim modeline to set the 'textwidth'
343 and 'tabstop' options and the 'filetype' to "help". Never set a global option
349 To define a help tag, place the name between asterisks (*tag-name*). The
350 tag-name should be different from all the Vim help tag names and ideally
354 When referring to an existing help tag and to create a hot-link, place the
355 name between two bars (|) eg. |help-writing|.
361 When referring to a Vim option in the help file, place the option name between
372 To separate sections in a help file, place a series of '=' characters in a
385 The following are highlighted differently in a Vim help file:
395 You can find the details in $VIMRUNTIME/syntax/help.vim
401 writing help text, which quite often is many years old. Also, a lot of the
410 vim:tw=78:ts=8:noet:ft=help:norl: