Mercurial > vim

annotate runtime/doc/helphelp.txt @ 18781:79e10adc821d v8.1.2380

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
patch 8.1.2380: using old C style comments Commit: https://github.com/vim/vim/commit/306139005c31ea7e6f892dd119beba3c94dcb982 Author: Bram Moolenaar <Bram@vim.org> Date: Sun Dec 1 22:11:18 2019 +0100 patch 8.1.2380: using old C style comments Problem: Using old C style comments. Solution: Use // comments where appropriate.
author Bram Moolenaar <Bram@vim.org>
date Sun, 01 Dec 2019 22:15:03 +0100
parents 6d11fc4aa683
children af69c9335223
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18456
6d11fc4aa683 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
1 *helphelp.txt* For Vim version 8.1. Last change: 2019 Oct 18
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
2
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
3
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
4 VIM REFERENCE MANUAL by Bram Moolenaar
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
5
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
6
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
7 Help on help files *helphelp*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
8
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
9 1. Help commands |online-help|
2581
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2572
diff changeset
10 2. Translated help files |help-translated|
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
11 3. Writing help files |help-writing|
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
12
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
13 ==============================================================================
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
14 1. Help commands *online-help*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
15
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
16 *help* *<Help>* *:h* *:help* *<F1>* *i_<F1>* *i_<Help>*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
17 <Help> or
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
18 :h[elp] Open a window and display the help file in read-only
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
19 mode. If there is a help window open already, use
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
20 that one. Otherwise, if the current window uses the
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
21 full width of the screen or is at least 80 characters
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
22 wide, the help window will appear just above the
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
23 current window. Otherwise the new window is put at
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
24 the very top.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
25 The 'helplang' option is used to select a language, if
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
26 the main help file is available in several languages.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
27
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
28 *{subject}* *E149* *E661*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
29 :h[elp] {subject} Like ":help", additionally jump to the tag {subject}.
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
30 For example: >
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
31 :help options
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
32
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
33 < {subject} can include wildcards such as "*", "?" and
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
34 "[a-z]":
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
35 :help z? jump to help for any "z" command
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
36 :help z. jump to the help for "z."
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
37 But when a tag exists it is taken literally:
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
38 :help :? jump to help for ":?"
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
39
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
40 If there is no full match for the pattern, or there
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
41 are several matches, the "best" match will be used.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
42 A sophisticated algorithm is used to decide which
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
43 match is better than another one. These items are
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
44 considered in the computation:
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
45 - A match with same case is much better than a match
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
46 with different case.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
47 - A match that starts after a non-alphanumeric
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
48 character is better than a match in the middle of a
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
49 word.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
50 - A match at or near the beginning of the tag is
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
51 better than a match further on.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
52 - The more alphanumeric characters match, the better.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
53 - The shorter the length of the match, the better.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
54
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
55 The 'helplang' option is used to select a language, if
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
56 the {subject} is available in several languages.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
57 To find a tag in a specific language, append "@ab",
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
58 where "ab" is the two-letter language code. See
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
59 |help-translated|.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
60
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
61 Note that the longer the {subject} you give, the less
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
62 matches will be found. You can get an idea how this
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
63 all works by using commandline completion (type CTRL-D
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
64 after ":help subject" |c_CTRL-D|).
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
65 If there are several matches, you can have them listed
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
66 by hitting CTRL-D. Example: >
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
67 :help cont<Ctrl-D>
2434
86532ee3ea41 Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
68
86532ee3ea41 Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
69 < Instead of typing ":help CTRL-V" to search for help
86532ee3ea41 Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
70 for CTRL-V you can type: >
86532ee3ea41 Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
71 :help ^V
86532ee3ea41 Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
72 < This also works together with other characters, for
86532ee3ea41 Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
73 example to find help for CTRL-V in Insert mode: >
86532ee3ea41 Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
74 :help i^V
86532ee3ea41 Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
75 <
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
76 It is also possible to first do ":help" and then
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
77 use ":tag {pattern}" in the help window. The
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
78 ":tnext" command can then be used to jump to other
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
79 matches, "tselect" to list matches and choose one. >
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
80 :help index
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
81 :tselect /.*mode
2434
86532ee3ea41 Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
82
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
83 < When there is no argument you will see matches for
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
84 "help", to avoid listing all possible matches (that
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
85 would be very slow).
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
86 The number of matches displayed is limited to 300.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
87
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
88 The `:help` command can be followed by '|' and another
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
89 command, but you don't need to escape the '|' inside a
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
90 help command. So these both work: >
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
91 :help |
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
92 :help k| only
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
93 < Note that a space before the '|' is seen as part of
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
94 the ":help" argument.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
95 You can also use <LF> or <CR> to separate the help
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
96 command from a following command. You need to type
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
97 CTRL-V first to insert the <LF> or <CR>. Example: >
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
98 :help so<C-V><CR>only
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
99
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
100 :h[elp]! [subject] Like ":help", but in non-English help files prefer to
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
101 find a tag in a file with the same language as the
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
102 current file. See |help-translated|.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
103
6228
cb5480096f1b updated for version 7.4.449
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
104 *:helpc* *:helpclose*
18456
6d11fc4aa683 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
105 :helpc[lose] Close one help window, if there is one.
6d11fc4aa683 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
106 Vim will try to restore the window layout (including
6d11fc4aa683 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
107 cursor position) to the same layout it was before
6d11fc4aa683 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
108 opening the help window initially. This might cause
6d11fc4aa683 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
109 triggering several autocommands.
6228
cb5480096f1b updated for version 7.4.449
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
110
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
111 *:helpg* *:helpgrep*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
112 :helpg[rep] {pattern}[@xx]
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
113 Search all help text files and make a list of lines
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
114 in which {pattern} matches. Jumps to the first match.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
115 The optional [@xx] specifies that only matches in the
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
116 "xx" language are to be found.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
117 You can navigate through the matches with the
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
118 |quickfix| commands, e.g., |:cnext| to jump to the
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
119 next one. Or use |:cwindow| to get the list of
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
120 matches in the quickfix window.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
121 {pattern} is used as a Vim regexp |pattern|.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
122 'ignorecase' is not used, add "\c" to ignore case.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
123 Example for case sensitive search: >
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
124 :helpgrep Uganda
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
125 < Example for case ignoring search: >
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
126 :helpgrep uganda\c
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
127 < Example for searching in French help: >
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
128 :helpgrep backspace@fr
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
129 < The pattern does not support line breaks, it must
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
130 match within one line. You can use |:grep| instead,
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
131 but then you need to get the list of help files in a
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
132 complicated way.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
133 Cannot be followed by another command, everything is
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
134 used as part of the pattern. But you can use
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
135 |:execute| when needed.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
136 Compressed help files will not be searched (Fedora
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
137 compresses the help files).
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
138
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
139 *:lh* *:lhelpgrep*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
140 :lh[elpgrep] {pattern}[@xx]
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
141 Same as ":helpgrep", except the location list is used
2267
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
142 instead of the quickfix list. If the help window is
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
143 already opened, then the location list for that window
2267
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
144 is used. Otherwise, a new help window is opened and
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
145 the location list for that window is set. The
11229
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 11062
diff changeset
146 location list for the current window is not changed
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 11062
diff changeset
147 then.
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
148
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
149 *:exu* *:exusage*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
150 :exu[sage] Show help on Ex commands. Added to simulate the Nvi
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 14421
diff changeset
151 command.
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
152
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
153 *:viu* *:viusage*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
154 :viu[sage] Show help on Normal mode commands. Added to simulate
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 14421
diff changeset
155 the Nvi command.
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
156
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
157 When no argument is given to |:help| the file given with the 'helpfile' option
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
158 will be opened. Otherwise the specified tag is searched for in all "doc/tags"
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
159 files in the directories specified in the 'runtimepath' option.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
160
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
161 The initial height of the help window can be set with the 'helpheight' option
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
162 (default 20).
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
163
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
164 Jump to specific subjects by using tags. This can be done in two ways:
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
165 - Use the "CTRL-]" command while standing on the name of a command or option.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
166 This only works when the tag is a keyword. "<C-Leftmouse>" and
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
167 "g<LeftMouse>" work just like "CTRL-]".
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
168 - use the ":ta {subject}" command. This also works with non-keyword
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
169 characters.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
170
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
171 Use CTRL-T or CTRL-O to jump back.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
172 Use ":q" to close the help window.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
173
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
174 If there are several matches for an item you are looking for, this is how you
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
175 can jump to each one of them:
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
176 1. Open a help window
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
177 2. Use the ":tag" command with a slash prepended to the tag. E.g.: >
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
178 :tag /min
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
179 3. Use ":tnext" to jump to the next matching tag.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
180
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
181 It is possible to add help files for plugins and other items. You don't need
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
182 to change the distributed help files for that. See |add-local-help|.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
183
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
184 To write a local help file, see |write-local-help|.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
185
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
186 Note that the title lines from the local help files are automagically added to
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
187 the "LOCAL ADDITIONS" section in the "help.txt" help file |local-additions|.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
188 This is done when viewing the file in Vim, the file itself is not changed. It
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
189 is done by going through all help files and obtaining the first line of each
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
190 file. The files in $VIMRUNTIME/doc are skipped.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
191
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
192 *help-xterm-window*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
193 If you want to have the help in another xterm window, you could use this
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
194 command: >
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
195 :!xterm -e vim +help &
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
196 <
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
197
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
198 *:helpfind* *:helpf*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
199 :helpf[ind] Like |:help|, but use a dialog to enter the argument.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
200 Only for backwards compatibility. It now executes the
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
201 ToolBar.FindHelp menu entry instead of using a builtin
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
202 dialog. {only when compiled with |+GUI_GTK|}
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
203
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
204 *:helpt* *:helptags*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
205 *E154* *E150* *E151* *E152* *E153* *E670*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
206 :helpt[ags] [++t] {dir}
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
207 Generate the help tags file(s) for directory {dir}.
8673
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents: 6238
diff changeset
208 When {dir} is ALL then all "doc" directories in
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents: 6238
diff changeset
209 'runtimepath' will be used.
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents: 6238
diff changeset
210
3967
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
211 All "*.txt" and "*.??x" files in the directory and
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
212 sub-directories are scanned for a help tag definition
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
213 in between stars. The "*.??x" files are for
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
214 translated docs, they generate the "tags-??" file, see
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
215 |help-translated|. The generated tags files are
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
216 sorted.
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
217 When there are duplicates an error message is given.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
218 An existing tags file is silently overwritten.
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8673
diff changeset
219
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
220 The optional "++t" argument forces adding the
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
221 "help-tags" tag. This is also done when the {dir} is
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
222 equal to $VIMRUNTIME/doc.
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8673
diff changeset
223
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
224 To rebuild the help tags in the runtime directory
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
225 (requires write permission there): >
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
226 :helptags $VIMRUNTIME/doc
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
227
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
228 ==============================================================================
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
229 2. Translated help files *help-translated*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
230
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
231 It is possible to add translated help files, next to the original English help
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
232 files. Vim will search for all help in "doc" directories in 'runtimepath'.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
233 This is only available when compiled with the |+multi_lang| feature.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
234
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
235 At this moment translations are available for:
3513
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
236 Chinese - multiple authors
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
237 French - translated by David Blanchet
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
238 Italian - translated by Antonio Colombo
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
239 Japanese - multiple authors
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
240 Polish - translated by Mikolaj Machowski
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
241 Russian - translated by Vassily Ragosin
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
242 See the Vim website to find them: http://www.vim.org/translations.php
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
243
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
244 A set of translated help files consists of these files:
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
245
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
246 help.abx
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
247 howto.abx
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
248 ...
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
249 tags-ab
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
250
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
251 "ab" is the two-letter language code. Thus for Italian the names are:
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
252
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
253 help.itx
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
254 howto.itx
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
255 ...
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
256 tags-it
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
257
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
258 The 'helplang' option can be set to the preferred language(s). The default is
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
259 set according to the environment. Vim will first try to find a matching tag
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
260 in the preferred language(s). English is used when it cannot be found.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
261
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
262 To find a tag in a specific language, append "@ab" to a tag, where "ab" is the
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
263 two-letter language code. Example: >
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
264 :he user-manual@it
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
265 :he user-manual@en
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
266 The first one finds the Italian user manual, even when 'helplang' is empty.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
267 The second one finds the English user manual, even when 'helplang' is set to
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
268 "it".
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
269
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
270 When using command-line completion for the ":help" command, the "@en"
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
271 extension is only shown when a tag exists for multiple languages. When the
8795
aba2d0a01290 commit https://github.com/vim/vim/commit/7db8f6f4f85e5d0526d23107b2a5e2334dc23354
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
272 tag only exists for English "@en" is omitted. When the first candidate has an
aba2d0a01290 commit https://github.com/vim/vim/commit/7db8f6f4f85e5d0526d23107b2a5e2334dc23354
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
273 "@ab" extension and it matches the first language in 'helplang' "@ab" is also
aba2d0a01290 commit https://github.com/vim/vim/commit/7db8f6f4f85e5d0526d23107b2a5e2334dc23354
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
274 omitted.
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
275
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
276 When using |CTRL-]| or ":help!" in a non-English help file Vim will try to
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
277 find the tag in the same language. If not found then 'helplang' will be used
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
278 to select a language.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
279
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
280 Help files must use latin1 or utf-8 encoding. Vim assumes the encoding is
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
281 utf-8 when finding non-ASCII characters in the first line. Thus you must
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
282 translate the header with "For Vim version".
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
283
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
284 The same encoding must be used for the help files of one language in one
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
285 directory. You can use a different encoding for different languages and use
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
286 a different encoding for help files of the same language but in a different
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
287 directory.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
288
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
289 Hints for translators:
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
290 - Do not translate the tags. This makes it possible to use 'helplang' to
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
291 specify the preferred language. You may add new tags in your language.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
292 - When you do not translate a part of a file, add tags to the English version,
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
293 using the "tag@en" notation.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
294 - Make a package with all the files and the tags file available for download.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
295 Users can drop it in one of the "doc" directories and start use it.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
296 Report this to Bram, so that he can add a link on www.vim.org.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
297 - Use the |:helptags| command to generate the tags files. It will find all
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
298 languages in the specified directory.
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
299
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
300 ==============================================================================
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
301 3. Writing help files *help-writing*
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
302
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
303 For ease of use, a Vim help file for a plugin should follow the format of the
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
304 standard Vim help files. If you are writing a new help file it's best to copy
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
305 one of the existing files and use it as a template.
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
306
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
307 The first line in a help file should have the following format:
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
308
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
309 *helpfile_name.txt* For Vim version 7.3 Last change: 2010 June 4
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
310
2267
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
311 The first field is a link to the help file name. The second field describes
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
312 the applicable Vim version. The last field specifies the last modification
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
313 date of the file. Each field is separated by a tab.
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
314
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
315 At the bottom of the help file, place a Vim modeline to set the 'textwidth'
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
316 and 'tabstop' options and the 'filetype' to "help". Never set a global option
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
317 in such a modeline, that can have consequences undesired by whoever reads that
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
318 help.
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
319
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
320
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
321 TAGS
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
322
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
323 To define a help tag, place the name between asterisks (*tag-name*). The
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
324 tag-name should be different from all the Vim help tag names and ideally
2267
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
325 should begin with the name of the Vim plugin. The tag name is usually right
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
326 aligned on a line.
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
327
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
328 When referring to an existing help tag and to create a hot-link, place the
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
329 name between two bars (|) eg. |help-writing|.
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
330
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
331 When referring to a Vim command and to create a hot-link, place the
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
332 name between two backticks, eg. inside `:filetype`. You will see this is
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
333 highlighted as a command, like a code block (see below).
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
334
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
335 When referring to a Vim option in the help file, place the option name between
2267
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
336 two single quotes, eg. 'statusline'
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
337
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
338
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
339 HIGHLIGHTING
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
340
2267
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
341 To define a column heading, use a tilde character at the end of the line.
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
342 This will highlight the column heading in a different color. E.g.
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
343
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
344 Column heading~
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
345
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
346 To separate sections in a help file, place a series of '=' characters in a
2267
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
347 line starting from the first column. The section separator line is highlighted
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
348 differently.
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
349
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
350 To quote a block of ex-commands verbatim, place a greater than (>) character
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
351 at the end of the line before the block and a less than (<) character as the
2267
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
352 first non-blank on a line following the block. Any line starting in column 1
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
353 also implicitly stops the block of ex-commands before it. E.g. >
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
354 function Example_Func()
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
355 echo "Example"
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
356 endfunction
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
357 <
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
358
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
359 The following are highlighted differently in a Vim help file:
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
360 - a special key name expressed either in <> notation as in <PageDown>, or
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
361 as a Ctrl character as in CTRL-X
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
362 - anything between {braces}, e.g. {lhs} and {rhs}
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
363
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
364 The word "Note", "Notes" and similar automagically receive distinctive
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
365 highlighting. So do these:
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
366 *Todo something to do
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
367 *Error something wrong
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
368
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2246
diff changeset
369 You can find the details in $VIMRUNTIME/syntax/help.vim
2246
1e48f569b03d Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
diff changeset
370
14421
2f7e67dd088c Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
371 vim:tw=78:ts=8:noet:ft=help:norl: