Mercurial > vim

comparison runtime/doc/helphelp.txt @ 16553:0e473e9e70c2 v8.1.1280

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
patch 8.1.1280: remarks about functionality not in Vi clutters the help commit https://github.com/vim/vim/commit/25c9c680ec4dfbb51f4ef21c3460a48d3c67ffc8 Author: Bram Moolenaar <Bram@vim.org> Date: Sun May 5 18:13:34 2019 +0200 patch 8.1.1280: remarks about functionality not in Vi clutters the help Problem: Remarks about functionality not in Vi clutters the help. Solution: Move all info about what is new in Vim or already existed in Vi to vi_diff.txt. Remove {not in Vi} remarks. (closes #4268) Add "noet" to the help files modeline. Also include many other help file improvements.
author Bram Moolenaar <Bram@vim.org>
date Sun, 05 May 2019 18:15:06 +0200
parents 2f7e67dd088c
children 6d11fc4aa683
comparison
equal deleted inserted replaced
16552:deb3d4f5be8b 16553:0e473e9e70c2
1 *helphelp.txt* For Vim version 8.1. Last change: 2017 Mar 19 1 *helphelp.txt* For Vim version 8.1. Last change: 2019 May 04
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
22 wide, the help window will appear just above the 22 wide, the help window will appear just above the
23 current window. Otherwise the new window is put at 23 current window. Otherwise the new window is put at
24 the very top. 24 the very top.
25 The 'helplang' option is used to select a language, if 25 The 'helplang' option is used to select a language, if
26 the main help file is available in several languages. 26 the main help file is available in several languages.
27 {not in Vi}
28 27
29 *{subject}* *E149* *E661* 28 *{subject}* *E149* *E661*
30 :h[elp] {subject} Like ":help", additionally jump to the tag {subject}. 29 :h[elp] {subject} Like ":help", additionally jump to the tag {subject}.
31 For example: > 30 For example: >
32 :help options 31 :help options
95 the ":help" argument. 94 the ":help" argument.
96 You can also use <LF> or <CR> to separate the help 95 You can also use <LF> or <CR> to separate the help
97 command from a following command. You need to type 96 command from a following command. You need to type
98 CTRL-V first to insert the <LF> or <CR>. Example: > 97 CTRL-V first to insert the <LF> or <CR>. Example: >
99 :help so<C-V><CR>only 98 :help so<C-V><CR>only
100 < {not in Vi}
101 99
102 :h[elp]! [subject] Like ":help", but in non-English help files prefer to 100 :h[elp]! [subject] Like ":help", but in non-English help files prefer to
103 find a tag in a file with the same language as the 101 find a tag in a file with the same language as the
104 current file. See |help-translated|. 102 current file. See |help-translated|.
105 103
131 Cannot be followed by another command, everything is 129 Cannot be followed by another command, everything is
132 used as part of the pattern. But you can use 130 used as part of the pattern. But you can use
133 |:execute| when needed. 131 |:execute| when needed.
134 Compressed help files will not be searched (Fedora 132 Compressed help files will not be searched (Fedora
135 compresses the help files). 133 compresses the help files).
136 {not in Vi}
137 134
138 *:lh* *:lhelpgrep* 135 *:lh* *:lhelpgrep*
139 :lh[elpgrep] {pattern}[@xx] 136 :lh[elpgrep] {pattern}[@xx]
140 Same as ":helpgrep", except the location list is used 137 Same as ":helpgrep", except the location list is used
141 instead of the quickfix list. If the help window is 138 instead of the quickfix list. If the help window is
145 location list for the current window is not changed 142 location list for the current window is not changed
146 then. 143 then.
147 144
148 *:exu* *:exusage* 145 *:exu* *:exusage*
149 :exu[sage] Show help on Ex commands. Added to simulate the Nvi 146 :exu[sage] Show help on Ex commands. Added to simulate the Nvi
150 command. {not in Vi} 147 command.
151 148
152 *:viu* *:viusage* 149 *:viu* *:viusage*
153 :viu[sage] Show help on Normal mode commands. Added to simulate 150 :viu[sage] Show help on Normal mode commands. Added to simulate
154 the Nvi command. {not in Vi} 151 the Nvi command.
155 152
156 When no argument is given to |:help| the file given with the 'helpfile' option 153 When no argument is given to |:help| the file given with the 'helpfile' option
157 will be opened. Otherwise the specified tag is searched for in all "doc/tags" 154 will be opened. Otherwise the specified tag is searched for in all "doc/tags"
158 files in the directories specified in the 'runtimepath' option. 155 files in the directories specified in the 'runtimepath' option.
159 156
197 *:helpfind* *:helpf* 194 *:helpfind* *:helpf*
198 :helpf[ind] Like |:help|, but use a dialog to enter the argument. 195 :helpf[ind] Like |:help|, but use a dialog to enter the argument.
199 Only for backwards compatibility. It now executes the 196 Only for backwards compatibility. It now executes the
200 ToolBar.FindHelp menu entry instead of using a builtin 197 ToolBar.FindHelp menu entry instead of using a builtin
201 dialog. {only when compiled with |+GUI_GTK|} 198 dialog. {only when compiled with |+GUI_GTK|}
202 {not in Vi}
203 199
204 *:helpt* *:helptags* 200 *:helpt* *:helptags*
205 *E154* *E150* *E151* *E152* *E153* *E670* 201 *E154* *E150* *E151* *E152* *E153* *E670*
206 :helpt[ags] [++t] {dir} 202 :helpt[ags] [++t] {dir}
207 Generate the help tags file(s) for directory {dir}. 203 Generate the help tags file(s) for directory {dir}.
222 equal to $VIMRUNTIME/doc. 218 equal to $VIMRUNTIME/doc.
223 219
224 To rebuild the help tags in the runtime directory 220 To rebuild the help tags in the runtime directory
225 (requires write permission there): > 221 (requires write permission there): >
226 :helptags $VIMRUNTIME/doc 222 :helptags $VIMRUNTIME/doc
227 < {not in Vi}
228
229 223
230 ============================================================================== 224 ==============================================================================
231 2. Translated help files *help-translated* 225 2. Translated help files *help-translated*
232 226
233 It is possible to add translated help files, next to the original English help 227 It is possible to add translated help files, next to the original English help