← Back to branch summary

~neovim-ppa/neovim-ppa/neovim

« back to all changes in this revision

Viewing changes to runtime/doc/helphelp.txt

  • Committer: GitHub
  • Author(s): Justin M. Keyes
  • Date: 2016-07-09 10:58:27 UTC
  • mfrom: (2636.1.34)
  • Revision ID: git-v1:adaacdd71a70b76bc686113eaece47a6264701a5
Merge #4648 from jamessan/packages

packages (vim-patch:7.4.{1384,1388,1396,1478,1479,1480,1486,1492,1499,1528,1550,1551,1552,1553,1554,1596,1649,1712,1840,1973,1986})

Show diffs side-by-side

added added

removed removed

Lines of Context:
runtime/doc/helphelp.txt
1
 
*helphelp.txt*  For Vim version 7.4.  Last change: 2014 Sep 19
 
1
*helphelp.txt*  For Vim version 7.4.  Last change: 2016 Apr 01
2
2
 
3
3
 
4
4
                  VIM REFERENCE MANUAL    by Bram Moolenaar
188
188
                                *E154* *E150* *E151* *E152* *E153* *E670*
189
189
:helpt[ags] [++t] {dir}
190
190
                        Generate the help tags file(s) for directory {dir}.
 
191
                        When {dir} is ALL then all "doc" directories in
 
192
                        'runtimepath' will be used.
 
193
 
191
194
                        All "*.txt" and "*.??x" files in the directory and
192
195
                        sub-directories are scanned for a help tag definition
193
196
                        in between stars.  The "*.??x" files are for
196
199
                        sorted.
197
200
                        When there are duplicates an error message is given.
198
201
                        An existing tags file is silently overwritten.
 
202
 
199
203
                        The optional "++t" argument forces adding the
200
204
                        "help-tags" tag.  This is also done when the {dir} is
201
205
                        equal to $VIMRUNTIME/doc.
 
206
 
202
207
                        To rebuild the help tags in the runtime directory
203
208
                        (requires write permission there): >
204
209
                                :helptags $VIMRUNTIME/doc
249
254
 
250
255
When using command-line completion for the ":help" command, the "@en"
251
256
extension is only shown when a tag exists for multiple languages.  When the
252
 
tag only exists for English "@en" is omitted.
 
257
tag only exists for English "@en" is omitted.  When the first candidate has an
 
258
"@ab" extension and it matches the first language in 'helplang' "@ab" is also
 
259
omitted.
253
260
 
254
261
When using |CTRL-]| or ":help!" in a non-English help file Vim will try to
255
262
find the tag in the same language.  If not found then 'helplang' will be used
306
313
When referring to an existing help tag and to create a hot-link, place the
307
314
name between two bars (|) eg. |help-writing|.
308
315
 
 
316
When referring to a Vim command and to create a hot-link, place the
 
317
name between two backticks, eg. inside `:filetype`.  You will see this is
 
318
highlighted as a command, like a code block (see below).
 
319
 
309
320
When referring to a Vim option in the help file, place the option name between
310
321
two single quotes, eg. 'statusline'
311
322