aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/helphelp.txt
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2016-07-09 06:58:27 -0400
committerGitHub <noreply@github.com>2016-07-09 06:58:27 -0400
commitadaacdd71a70b76bc686113eaece47a6264701a5 (patch)
tree4be6079a8571316cbd89e3f310981b080f2815a4 /runtime/doc/helphelp.txt
parent6cee9d1a17177f4ccdf34283c6ed3ffaa98b32cc (diff)
parent059e9785dc2fea0a15344162de4a5a7c8da6f491 (diff)
downloadrneovim-adaacdd71a70b76bc686113eaece47a6264701a5.tar.gz
rneovim-adaacdd71a70b76bc686113eaece47a6264701a5.tar.bz2
rneovim-adaacdd71a70b76bc686113eaece47a6264701a5.zip
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})
Diffstat (limited to 'runtime/doc/helphelp.txt')
-rw-r--r--runtime/doc/helphelp.txt15
1 files changed, 13 insertions, 2 deletions
diff --git a/runtime/doc/helphelp.txt b/runtime/doc/helphelp.txt
index f3533b8815..ca341af200 100644
--- a/runtime/doc/helphelp.txt
+++ b/runtime/doc/helphelp.txt
@@ -1,4 +1,4 @@
-*helphelp.txt* For Vim version 7.4. Last change: 2014 Sep 19
+*helphelp.txt* For Vim version 7.4. Last change: 2016 Apr 01
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -188,6 +188,9 @@ command: >
*E154* *E150* *E151* *E152* *E153* *E670*
:helpt[ags] [++t] {dir}
Generate the help tags file(s) for directory {dir}.
+ When {dir} is ALL then all "doc" directories in
+ 'runtimepath' will be used.
+
All "*.txt" and "*.??x" files in the directory and
sub-directories are scanned for a help tag definition
in between stars. The "*.??x" files are for
@@ -196,9 +199,11 @@ command: >
sorted.
When there are duplicates an error message is given.
An existing tags file is silently overwritten.
+
The optional "++t" argument forces adding the
"help-tags" tag. This is also done when the {dir} is
equal to $VIMRUNTIME/doc.
+
To rebuild the help tags in the runtime directory
(requires write permission there): >
:helptags $VIMRUNTIME/doc
@@ -249,7 +254,9 @@ The second one finds the English user manual, even when 'helplang' is set to
When using command-line completion for the ":help" command, the "@en"
extension is only shown when a tag exists for multiple languages. When the
-tag only exists for English "@en" is omitted.
+tag only exists for English "@en" is omitted. When the first candidate has an
+"@ab" extension and it matches the first language in 'helplang' "@ab" is also
+omitted.
When using |CTRL-]| or ":help!" in a non-English help file Vim will try to
find the tag in the same language. If not found then 'helplang' will be used
@@ -306,6 +313,10 @@ aligned on a line.
When referring to an existing help tag 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 as 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 quotes, eg. 'statusline'