/usr/share/doc/vim/html/helphelp.html is in vim-doc 2:8.0.1453-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 | <HTML>
<HEAD>
<META HTTP-EQUIV="Content-type" content="text/html; charset=ISO-8859-1">
<TITLE>Vim documentation: helphelp</TITLE>
</HEAD>
<BODY BGCOLOR="#ffffff">
<H1>Vim documentation: helphelp</H1>
<A NAME="top"></A>
<A HREF="index.html">main help file</A>
<HR>
<PRE>
*<A NAME="helphelp.txt"></A><B>helphelp.txt</B>* For Vim version 8.0. Last change: 2017 Mar 19
VIM REFERENCE MANUAL by <A HREF="intro.html#Bram">Bram</A> <A HREF="intro.html#Moolenaar">Moolenaar</A>
Help on help files *<A NAME="helphelp"></A><B>helphelp</B>*
1. Help commands |<A HREF="#online-help">online-help</A>|
2. Translated help files |<A HREF="#help-translated">help-translated</A>|
3. Writing help files |<A HREF="#help-writing">help-writing</A>|
==============================================================================
1. Help commands *<A NAME="online-help"></A><B>online-help</B>*
*<A NAME="help"></A><B>help</B>* *<A NAME="<Help>"></A><B><Help></B>* *<A NAME=":h"></A><B>:h</B>* *<A NAME=":help"></A><B>:help</B>* *<A NAME="<F1>"></A><B><F1></B>* *<A NAME="i_<F1>"></A><B>i_<F1></B>* *<A NAME="i_<Help>"></A><B>i_<Help></B>*
<A HREF="#<Help>"><Help></A> or
:h[elp] Open a <A HREF="windows.html#window">window</A> and display the help file in read-only
mode. If there is a help <A HREF="windows.html#window">window</A> open already, use
that one. Otherwise, if the current <A HREF="windows.html#window">window</A> uses the
full width of the screen or is at least 80 characters
wide, the help <A HREF="windows.html#window">window</A> will appear just above the
current <A HREF="windows.html#window">window</A>. Otherwise the new <A HREF="windows.html#window">window</A> is put at
the very top.
The <A HREF="options.html#'helplang'">'helplang'</A> option is used to select a language, if
the main help file is available in several languages.
{not in Vi}
*<A NAME="{subject}"></A><B>{subject}</B>* *<A NAME="E149"></A><B>E149</B>* *<A NAME="E661"></A><B>E661</B>*
:h[elp] <A HREF="#{subject}">{subject}</A> Like "<A HREF="#:help">:help</A>", additionally jump to the <A HREF="tagsrch.html#tag">tag</A> <A HREF="#{subject}">{subject}</A>.
For example:
<B> :help options</B>
<A HREF="#{subject}">{subject}</A> can include <A HREF="editing.html#wildcards">wildcards</A> such <A HREF="motion.html#as">as</A> "*", "<A HREF="pattern.html#?">?</A>" and
"[a-z]":
<A HREF="#:help">:help</A> <A HREF="index.html#z">z</A>? jump to help for any "<A HREF="index.html#z">z</A>" command
<A HREF="#:help">:help</A> <A HREF="scroll.html#z.">z.</A> jump to the help for "<A HREF="scroll.html#z.">z.</A>"
But when a <A HREF="tagsrch.html#tag">tag</A> exists <A HREF="motion.html#it">it</A> is taken literally:
<A HREF="#:help">:help</A> <A HREF="cmdline.html#:?">:?</A> jump to help for "<A HREF="cmdline.html#:?">:?</A>"
If there is no full match for the <A HREF="pattern.html#pattern">pattern</A>, or there
are several matches, the "best" match will be used.
A sophisticated algorithm is used to decide which
match is better than another one. These items are
considered in the computation:
- A match with same <A HREF="change.html#case">case</A> is much better than a match
with different <A HREF="change.html#case">case</A>.
- A match that starts after a non-alphanumeric
character is better than a match in the middle of a
<A HREF="motion.html#word">word</A>.
- A match at or near the beginning of the <A HREF="tagsrch.html#tag">tag</A> is
better than a match further on.
- The more alphanumeric characters match, the better.
- The shorter the length of the match, the better.
The <A HREF="options.html#'helplang'">'helplang'</A> option is used to select a language, if
the <A HREF="#{subject}">{subject}</A> is available in several languages.
To find a <A HREF="tagsrch.html#tag">tag</A> in a specific language, append "@ab",
where "<A HREF="motion.html#ab">ab</A>" is the two-letter language code. See
|<A HREF="#help-translated">help-translated</A>|.
Note that the longer the <A HREF="#{subject}">{subject}</A> you give, the <A HREF="various.html#less">less</A>
matches will be found. You can get an idea how this
all works by using commandline completion (type <A HREF="scroll.html#CTRL-D">CTRL-D</A>
after "<A HREF="#:help">:help</A> subject" |<A HREF="cmdline.html#c_CTRL-D">c_CTRL-D</A>|).
If there are several matches, you can have them listed
by hitting <A HREF="scroll.html#CTRL-D">CTRL-D</A>. Example:
<B> :help cont<Ctrl-D></B>
Instead of typing "<A HREF="#:help">:help</A> CTRL-V" to search for help
for <A HREF="visual.html#CTRL-V">CTRL-V</A> you can type:
<B> :help ^V</B>
This also works together with other characters, for
example to find help for <A HREF="visual.html#CTRL-V">CTRL-V</A> in <A HREF="insert.html#Insert">Insert</A> mode:
<B> :help i^V</B>
It is also possible to first <A HREF="diff.html#do">do</A> "<A HREF="#:help">:help</A>" and then
use "<A HREF="tagsrch.html#:tag">:tag</A> {pattern}" in the help <A HREF="windows.html#window">window</A>. The
"<A HREF="tagsrch.html#:tnext">:tnext</A>" command can then be used to jump to other
matches, "tselect" to <A HREF="eval.html#list">list</A> matches and choose one.
<B> :help index</B>
<B> :tselect /.*mode</B>
When there is no argument you will see matches for
"help", to avoid listing all possible matches (that
would be very slow).
The number of matches displayed is limited to 300.
The `:help` command can be followed by '|' and another
command, but you don't need to <A HREF="intro.html#escape">escape</A> the '|' inside a
help command. So these both work:
<B> :help |</B>
<B> :help k| only</B>
Note that a space before the '|' is seen <A HREF="motion.html#as">as</A> part of
the "<A HREF="#:help">:help</A>" argument.
You can also use <LF> or <A HREF="motion.html#<CR>"><CR></A> to separate the help
command from a following command. You need to type
<A HREF="visual.html#CTRL-V">CTRL-V</A> first to insert the <LF> or <A HREF="motion.html#<CR>"><CR></A>. Example:
<B> :help so<C-V><CR>only</B>
{not in Vi}
:h[elp]! [subject] Like "<A HREF="#:help">:help</A>", but in non-English help files prefer to
find a <A HREF="tagsrch.html#tag">tag</A> in a file with the same language <A HREF="motion.html#as">as</A> the
current file. See |<A HREF="#help-translated">help-translated</A>|.
*<A NAME=":helpc"></A><B>:helpc</B>* *<A NAME=":helpclose"></A><B>:helpclose</B>*
:helpc[lose] Close one help <A HREF="windows.html#window">window</A>, if there is one.
*<A NAME=":helpg"></A><B>:helpg</B>* *<A NAME=":helpgrep"></A><B>:helpgrep</B>*
:helpg[rep] {pattern}[@xx]
Search all help text files and make a <A HREF="eval.html#list">list</A> of lines
in which {pattern} matches. Jumps to the first match.
The optional [@xx] specifies that only matches in the
"xx" language are to be found.
You can navigate through the matches with the
|<A HREF="quickfix.html#quickfix">quickfix</A>| commands, e.g., |<A HREF="quickfix.html#:cnext">:cnext</A>| to jump to the
next one. Or use |<A HREF="quickfix.html#:cwindow">:cwindow</A>| to get the <A HREF="eval.html#list">list</A> of
matches in the <A HREF="quickfix.html#quickfix">quickfix</A> <A HREF="windows.html#window">window</A>.
{pattern} is used <A HREF="motion.html#as">as</A> a Vim <A HREF="pattern.html#regexp">regexp</A> |<A HREF="pattern.html#pattern">pattern</A>|.
<A HREF="options.html#'ignorecase'">'ignorecase'</A> is not used, add "\c" to ignore <A HREF="change.html#case">case</A>.
Example for <A HREF="change.html#case">case</A> sensitive search:
<B> :helpgrep Uganda</B>
Example for <A HREF="change.html#case">case</A> ignoring search:
<B> :helpgrep uganda\c</B>
Example for searching in French help:
<B> :helpgrep backspace@fr</B>
The <A HREF="pattern.html#pattern">pattern</A> does not support line breaks, <A HREF="motion.html#it">it</A> must
match within one line. You can use |<A HREF="quickfix.html#:grep">:grep</A>| instead,
but then you need to get the <A HREF="eval.html#list">list</A> of help files in a
complicated way.
Cannot be followed by another command, everything is
used <A HREF="motion.html#as">as</A> part of the <A HREF="pattern.html#pattern">pattern</A>. But you can use
|<A HREF="eval.html#:execute">:execute</A>| when needed.
Compressed help files will not be searched (Fedora
compresses the help files).
{not in Vi}
*<A NAME=":lh"></A><B>:lh</B>* *<A NAME=":lhelpgrep"></A><B>:lhelpgrep</B>*
:lh[elpgrep] {pattern}[@xx]
Same <A HREF="motion.html#as">as</A> "<A HREF="#:helpgrep">:helpgrep</A>", except the location <A HREF="eval.html#list">list</A> is used
instead of the <A HREF="quickfix.html#quickfix">quickfix</A> <A HREF="eval.html#list">list</A>. If the help <A HREF="windows.html#window">window</A> is
already opened, then the location <A HREF="eval.html#list">list</A> for that <A HREF="windows.html#window">window</A>
is used. Otherwise, a new help <A HREF="windows.html#window">window</A> is opened and
the location <A HREF="eval.html#list">list</A> for that <A HREF="windows.html#window">window</A> is set. The
location <A HREF="eval.html#list">list</A> for the current <A HREF="windows.html#window">window</A> is not changed
then.
*<A NAME=":exu"></A><B>:exu</B>* *<A NAME=":exusage"></A><B>:exusage</B>*
:exu[sage] Show help on <A HREF="intro.html#Ex">Ex</A> commands. Added to simulate the <A HREF="intro.html#Nvi">Nvi</A>
command. {not in Vi}
*<A NAME=":viu"></A><B>:viu</B>* *<A NAME=":viusage"></A><B>:viusage</B>*
:viu[sage] Show help on <A HREF="intro.html#Normal">Normal</A> mode commands. Added to simulate
the <A HREF="intro.html#Nvi">Nvi</A> command. {not in Vi}
When no argument is given to |<A HREF="#:help">:help</A>| the file given with the <A HREF="options.html#'helpfile'">'helpfile'</A> option
will be opened. Otherwise the specified <A HREF="tagsrch.html#tag">tag</A> is searched for in all "doc/tags"
files in the directories specified in the <A HREF="options.html#'runtimepath'">'runtimepath'</A> option.
The initial height of the help <A HREF="windows.html#window">window</A> can be set with the <A HREF="options.html#'helpheight'">'helpheight'</A> option
(default 20).
Jump to specific subjects by using <A HREF="tagsrch.html#tags">tags</A>. This can be done in two ways:
- Use the "<A HREF="tagsrch.html#CTRL-]">CTRL-]</A>" command while standing on the name of a command or option.
This only works when the <A HREF="tagsrch.html#tag">tag</A> is a keyword. "<C-Leftmouse>" and
"<A HREF="tagsrch.html#g<LeftMouse>">g<LeftMouse></A>" work just like "<A HREF="tagsrch.html#CTRL-]">CTRL-]</A>".
- use the "<A HREF="tagsrch.html#:ta">:ta</A> {subject}" command. This also works with non-keyword
characters.
Use <A HREF="tagsrch.html#CTRL-T">CTRL-T</A> or <A HREF="motion.html#CTRL-O">CTRL-O</A> to jump back.
Use "<A HREF="editing.html#:q">:q</A>" to close the help <A HREF="windows.html#window">window</A>.
If there are several matches for an item you are looking for, this is how you
can jump to each one of them:
1. Open a help <A HREF="windows.html#window">window</A>
2. Use the "<A HREF="tagsrch.html#:tag">:tag</A>" command with a slash prepended to the <A HREF="tagsrch.html#tag">tag</A>. E.g.:
<B> :tag /min</B>
3. Use "<A HREF="tagsrch.html#:tnext">:tnext</A>" to jump to the next matching <A HREF="tagsrch.html#tag">tag</A>.
It is possible to add help files for plugins and other items. You don't need
to change the distributed help files for that. See |<A HREF="usr_05.html#add-local-help">add-local-help</A>|.
To write a local help file, see |<A HREF="usr_41.html#write-local-help">write-local-help</A>|.
Note that the title lines from the local help files are automagically added to
the "LOCAL ADDITIONS" section in the "<A HREF="help.html#help.txt">help.txt</A>" help file |<A HREF="help.html#local-additions">local-additions</A>|.
This is done when viewing the file in Vim, the file itself is not changed. It
is done by going through all help files and obtaining the first line of each
file. The files in $VIMRUNTIME/doc are skipped.
*<A NAME="help-xterm-window"></A><B>help-xterm-window</B>*
If you want to have the help in another xterm <A HREF="windows.html#window">window</A>, you could use this
command:
<B> :!xterm -e vim +help &</B>
*<A NAME=":helpfind"></A><B>:helpfind</B>* *<A NAME=":helpf"></A><B>:helpf</B>*
:helpf[ind] Like |<A HREF="#:help">:help</A>|, but use a <A HREF="gui_w32.html#dialog">dialog</A> to enter the argument.
Only for backwards compatibility. It now executes the
ToolBar.FindHelp menu entry instead of using a builtin
<A HREF="gui_w32.html#dialog">dialog</A>. {only when compiled with YXXY+GUI_GTK|}
{not in Vi}
*<A NAME=":helpt"></A><B>:helpt</B>* *<A NAME=":helptags"></A><B>:helptags</B>*
*<A NAME="E154"></A><B>E154</B>* *<A NAME="E150"></A><B>E150</B>* *<A NAME="E151"></A><B>E151</B>* *<A NAME="E152"></A><B>E152</B>* *<A NAME="E153"></A><B>E153</B>* *<A NAME="E670"></A><B>E670</B>*
:helpt[ags] [++t] {dir}
Generate the help <A HREF="tagsrch.html#tags">tags</A> file(s) for directory {dir}.
When {dir} is ALL then all "doc" directories in
<A HREF="options.html#'runtimepath'">'runtimepath'</A> will be used.
All "*.txt" and "*.??x" files in the directory and
sub-directories are scanned for a help <A HREF="tagsrch.html#tag">tag</A> definition
in between stars. The "*.??x" files are for
translated docs, they generate the "tags-??" file, see
|<A HREF="#help-translated">help-translated</A>|. The generated <A HREF="tagsrch.html#tags">tags</A> files are
sorted.
When there are duplicates an error message is given.
An existing <A HREF="tagsrch.html#tags">tags</A> file is silently overwritten.
The optional "++t" argument forces adding the
"<A HREF="tags.html#help-tags">help-tags</A>" <A HREF="tagsrch.html#tag">tag</A>. This is also done when the {dir} is
equal to $VIMRUNTIME/doc.
To rebuild the help <A HREF="tagsrch.html#tags">tags</A> in the runtime directory
(requires write permission there):
<B> :helptags $VIMRUNTIME/doc</B>
{not in Vi}
==============================================================================
2. Translated help files *<A NAME="help-translated"></A><B>help-translated</B>*
It is possible to add translated help files, next to the original English help
files. Vim will search for all help in "doc" directories in <A HREF="options.html#'runtimepath'">'runtimepath'</A>.
This is only available when compiled with the |<A HREF="various.html#+multi_lang">+multi_lang</A>| feature.
At this moment translations are available for:
<A HREF="mbyte.html#Chinese">Chinese</A> - multiple authors
French - translated by David Blanchet
Italian - translated by Antonio Colombo
<A HREF="mbyte.html#Japanese">Japanese</A> - multiple authors
Polish - translated by Mikolaj Machowski
<A HREF="russian.html#Russian">Russian</A> - translated by Vassily Ragosin
See the Vim website to find them: <A HREF="http://www.vim.org/translations.php">http://www.vim.org/translations.php</A>
A set of translated help files consists of these files:
help.abx
howto.abx
<A HREF="eval.html#...">...</A>
tags-ab
"<A HREF="motion.html#ab">ab</A>" is the two-letter language code. Thus for Italian the names are:
help.itx
howto.itx
<A HREF="eval.html#...">...</A>
tags-it
The <A HREF="options.html#'helplang'">'helplang'</A> option can be set to the preferred language(s). The default is
set according to the environment. Vim will first try to find a matching <A HREF="tagsrch.html#tag">tag</A>
in the preferred language(s). English is used when <A HREF="motion.html#it">it</A> cannot be found.
To find a <A HREF="tagsrch.html#tag">tag</A> in a specific language, append "@ab" to a <A HREF="tagsrch.html#tag">tag</A>, where "<A HREF="motion.html#ab">ab</A>" is the
two-letter language code. Example:
<B> :he user-manual@it</B>
<B> :he user-manual@en</B>
The first one finds the Italian user manual, even when <A HREF="options.html#'helplang'">'helplang'</A> is empty.
The second one finds the English user manual, even when <A HREF="options.html#'helplang'">'helplang'</A> is set to
"<A HREF="motion.html#it">it</A>".
When using command-line completion for the "<A HREF="#:help">:help</A>" command, the "@en"
extension is only shown when a <A HREF="tagsrch.html#tag">tag</A> exists for multiple languages. When the
<A HREF="tagsrch.html#tag">tag</A> only exists for English "@en" is omitted. When the first candidate has an
"@ab" extension and <A HREF="motion.html#it">it</A> matches the first language in <A HREF="options.html#'helplang'">'helplang'</A> "@ab" is also
omitted.
When using |<A HREF="tagsrch.html#CTRL-]">CTRL-]</A>| or ":help!" in a non-English help file Vim will try to
find the <A HREF="tagsrch.html#tag">tag</A> in the same language. If not found then <A HREF="options.html#'helplang'">'helplang'</A> will be used
to select a language.
Help files must use latin1 or <A HREF="mbyte.html#utf-8">utf-8</A> encoding. Vim assumes the encoding is
<A HREF="mbyte.html#utf-8">utf-8</A> when finding non-ASCII characters in the first line. Thus you must
translate the header with "For Vim version".
The same encoding must be used for the help files of one language in one
directory. You can use a different encoding for different languages and use
a different encoding for help files of the same language but in a different
directory.
Hints for translators:
- Do not translate the <A HREF="tagsrch.html#tags">tags</A>. This makes <A HREF="motion.html#it">it</A> possible to use <A HREF="options.html#'helplang'">'helplang'</A> to
specify the preferred language. You may add new <A HREF="tagsrch.html#tags">tags</A> in your language.
- When you <A HREF="diff.html#do">do</A> not translate a part of a file, add <A HREF="tagsrch.html#tags">tags</A> to the English version,
using the <A HREF="mailto:"tag@en"">"tag@en"</A> notation.
- Make a package with all the files and the <A HREF="tagsrch.html#tags">tags</A> file available for <A HREF="intro.html#download">download</A>.
Users can drop <A HREF="motion.html#it">it</A> in one of the "doc" directories and start use <A HREF="motion.html#it">it</A>.
Report this to <A HREF="intro.html#Bram">Bram</A>, so that he can add a link on www.vim.org.
- Use the |<A HREF="#:helptags">:helptags</A>| command to generate the tags files. It will find all
languages in the specified directory.
==============================================================================
3. Writing help files *<A NAME="help-writing"></A><B>help-writing</B>*
For ease of use, a Vim help file for a <A HREF="usr_05.html#plugin">plugin</A> should follow the format of the
standard Vim help files. If you are <A HREF="editing.html#writing">writing</A> a new help file it's best to copy
one of the existing files and use <A HREF="motion.html#it">it</A> <A HREF="motion.html#as">as</A> a <A HREF="autocmd.html#template">template</A>.
The first line in a help file should have the following format:
*<A NAME="helpfile_name.txt"></A><B>helpfile_name.txt</B>* For Vim version 7.3 Last change: 2010 June 4
The first field is a link to the help file name. The second field describes
the applicable Vim version. The last field specifies the last modification
date of the file. Each field is separated by a <A HREF="intro.html#tab">tab</A>.
At the bottom of the help file, place a Vim <A HREF="options.html#modeline">modeline</A> to set the <A HREF="options.html#'textwidth'">'textwidth'</A>
and <A HREF="options.html#'tabstop'">'tabstop'</A> <A HREF="options.html#options">options</A> and the <A HREF="options.html#'filetype'">'filetype'</A> to "help". Never set a global option
in such a <A HREF="options.html#modeline">modeline</A>, that can have consequences undesired by whoever reads that
help.
TAGS
To define a help <A HREF="tagsrch.html#tag">tag</A>, place the name between asterisks (*tag-name*). The
tag-name should be different from all the Vim help <A HREF="tagsrch.html#tag">tag</A> names and ideally
should begin with the name of the Vim <A HREF="usr_05.html#plugin">plugin</A>. The <A HREF="tagsrch.html#tag">tag</A> name is usually right
aligned on a line.
When referring to an existing help <A HREF="tagsrch.html#tag">tag</A> and to create a hot-link, place the
name between two bars (|) eg. |help-writing|.|||
When referring to a Vim command and to create a hot-link, place the
name between two backticks, eg. inside `:filetype`. You will see this is
highlighted <A HREF="motion.html#as">as</A> a command, like a code block (see below).
When referring to a Vim option in the help file, place the option name between
two single <A HREF="quotes.html#quotes">quotes</A>, eg. <A HREF="options.html#'statusline'">'statusline'</A>
HIGHLIGHTING
To define a column heading, use a tilde character at the end of the line.
This will highlight the column heading in a different color. E.g.
<B><FONT COLOR="PURPLE">Column heading</FONT></B>
To separate sections in a help file, place a series of '<A HREF="change.html#=">=</A>' characters in a
line starting from the first column. The section separator line is highlighted
differently.
To <A HREF="change.html#quote">quote</A> a block of ex-commands verbatim, place a greater than (>) character
at the end of the line before the block and a <A HREF="various.html#less">less</A> than (<) character <A HREF="motion.html#as">as</A> the
first non-blank on a line following the block. Any line starting in column 1
also implicitly stops the block of ex-commands before <A HREF="motion.html#it">it</A>. E.g.
<B> function Example_Func()</B>
<B> echo "Example"</B>
<B> endfunction</B>
The following are highlighted differently in a Vim help file:
- a special key name expressed either in <A HREF="intro.html#<>"><></A> <A HREF="intro.html#notation">notation</A> <A HREF="motion.html#as">as</A> in <A HREF="scroll.html#<PageDown>"><PageDown></A>, or
<A HREF="motion.html#as">as</A> a Ctrl character <A HREF="motion.html#as">as</A> in <A HREF="change.html#CTRL-X">CTRL-X</A>
- anything between {braces}, e.g. <A HREF="map.html#{lhs}">{lhs}</A> and <A HREF="map.html#{rhs}">{rhs}</A>
The <A HREF="motion.html#word">word</A> "Note", "Notes" and similar automagically receive distinctive
highlighting. So <A HREF="diff.html#do">do</A> these:
*Todo something to <A HREF="diff.html#do">do</A>
*Error something wrong
You can find the details in $VIMRUNTIME/syntax/help.vim
<A HREF="#top">top</A> - <A HREF="index.html">main help file</A>
</PRE>
</BODY>
</HTML>
|