summaryrefslogtreecommitdiffstats
path: root/runtime/doc/usr_02.txt
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2020-01-25 13:27:42 +0100
committerBram Moolenaar <Bram@vim.org>2020-01-25 13:27:42 +0100
commit1d9215b9aaa120b9d78fee49488556f73007ce78 (patch)
treee22bd6772e3424e2c4934ce3f28e0f2f8e2fb90e /runtime/doc/usr_02.txt
parent7f51bbe0d19f1f0cb0321326f45a17b4f5155f89 (diff)
Update runtime files.
Diffstat (limited to 'runtime/doc/usr_02.txt')
-rw-r--r--runtime/doc/usr_02.txt90
1 files changed, 45 insertions, 45 deletions
diff --git a/runtime/doc/usr_02.txt b/runtime/doc/usr_02.txt
index 83ec2066a3..a866b7abbf 100644
--- a/runtime/doc/usr_02.txt
+++ b/runtime/doc/usr_02.txt
@@ -509,14 +509,14 @@ Summary: *help-summary* >
1) Use Ctrl-D after typing a topic and let Vim show all available topics.
Or press Tab to complete: >
- :help some<Tab>
+ :help some<Tab>
< More information on how to use the help: >
:help helphelp
2) Follow the links in bars to related help. You can go from the detailed
help to the user documentation, which describes certain commands more from
a user perspective and less detailed. E.g. after: >
- :help pattern.txt
+ :help pattern.txt
< You can see the user guide topics |03.9| and |usr_27.txt| in the
introduction.
@@ -528,27 +528,27 @@ Summary: *help-summary* >
< to open the help page which describes all option handling and then search
using regular expressions, e.g. textwidth.
Certain options have their own namespace, e.g.: >
- :help cpo-<letter>
+ :help cpo-<letter>
< for the corresponding flag of the 'cpoptions' settings, substitute <letter>
by a specific flag, e.g.: >
- :help cpo-;
+ :help cpo-;
< And for the guioption flags: >
- :help go-<letter>
+ :help go-<letter>
4) Normal mode commands do not have a prefix. To go to the help page for the
"gt" command: >
- :help gt
+ :help gt
5) Insert mode commands start with i_. Help for deleting a word: >
- :help i_CTRL-W
+ :help i_CTRL-W
6) Visual mode commands start with v_. Help for jumping to the other side of
the Visual area: >
- :help v_o
+ :help v_o
7) Command line editing and arguments start with c_. Help for using the
command argument %: >
- :help c_%
+ :help c_%
8) Ex-commands always start with ":", so to go to the ":s" command help: >
:help :s
@@ -559,56 +559,56 @@ Summary: *help-summary* >
10) Key combinations. They usually start with a single letter indicating
the mode for which they can be used. E.g.: >
- :help i_CTRL-X
+ :help i_CTRL-X
< takes you to the family of CTRL-X commands for insert mode which can be
used to auto-complete different things. Note, that certain keys will
always be written the same, e.g. Control will always be CTRL.
For normal mode commands there is no prefix and the topic is available at
:h CTRL-<Letter>. E.g. >
- :help CTRL-W
+ :help CTRL-W
< In contrast >
:help c_CTRL-R
< will describe what the CTRL-R does when entering commands in the Command
line and >
- :help v_CTRL-A
+ :help v_CTRL-A
< talks about incrementing numbers in visual mode and >
:help g_CTRL-A
< talks about the "g<C-A>" command (e.g. you have to press "g" then
- <CTRL-A>). Here the "g" stand for the normal command "g" which always
+ <CTRL-A>). Here the "g" stands for the normal command "g" which always
expects a second key before doing something similar to the commands
- starting with "z"
+ starting with "z".
11) Regexp items always start with /. So to get help for the "\+" quantifier
in Vim regexes: >
- :help /\+
+ :help /\+
< If you need to know everything about regular expressions, start reading
at: >
- :help pattern.txt
+ :help pattern.txt
12) Registers always start with "quote". To find out about the special ":"
register: >
- :help quote:
+ :help quote:
13) Vim script is available at >
:help eval.txt
-< Certain aspects of the language are available at :h expr-X where "X" is a
- single letter. E.g. >
- :help expr-!
-< will take you to the topic describing the "!" (Not) operator for
- VimScript.
- Also important is >
- :help function-list
-< to find a short description of all functions available. Help topics for
- Vim script functions always include the "()", so: >
- :help append()
-< talks about the append Vim script function rather than how to append text
- in the current buffer.
+< Certain aspects of the language are available at :h expr-X where "X" is a
+ single letter. E.g. >
+ :help expr-!
+< will take you to the topic describing the "!" (Not) operator for Vim
+ script.
+ Also important is >
+ :help function-list
+< to find a short description of all functions available. Help topics for
+ Vim script functions always include the "()", so: >
+ :help append()
+< talks about the append Vim script function rather than how to append text
+ in the current buffer.
14) Mappings are talked about in the help page :h |map.txt|. Use >
- :help mapmode-i
+ :help mapmode-i
< to find out about the |:imap| command. Also use :map-topic
to find out about certain subtopics particular for mappings. e.g: >
- :help :map-local
+ :help :map-local
< for buffer-local mappings or >
:help map-bar
< for how the '|' is handled in mappings.
@@ -619,7 +619,7 @@ Summary: *help-summary* >
16) Window management commands always start with CTRL-W, so you find the
corresponding help at :h CTRL-W_letter. E.g. >
- :help CTRL-W_p
+ :help CTRL-W_p
< for moving the previous accessed window. You can also access >
:help windows.txt
< and read your way through if you are looking for window handling
@@ -628,30 +628,30 @@ Summary: *help-summary* >
17) Use |:helpgrep| to search in all help pages (and also of any installed
plugins). See |:helpgrep| for how to use it.
To search for a topic: >
- :helpgrep topic
+ :helpgrep topic
< This takes you to the first match. To go to the next one: >
:cnext
< All matches are available in the quickfix window which can be opened
with: >
- :copen
+ :copen
< Move around to the match you like and press Enter to jump to that help.
18) The user manual. This describes help topics for beginners in a rather
friendly way. Start at |usr_toc.txt| to find the table of content (as you
might have guessed): >
- :help usr_toc.txt
+ :help usr_toc.txt
< Skim over the contents to find interesting topics. The "Digraphs" and
"Entering special characters" items are in chapter 24, so to go to that
particular help page: >
- :help usr_24.txt
+ :help usr_24.txt
< Also if you want to access a certain chapter in the help, the chapter
number can be accessed directly like this: >
- :help 10.1
+ :help 10.1
< which goes to chapter 10.1 in |usr_10.txt| and talks about recording
macros.
19) Highlighting groups. Always start with hl-groupname. E.g. >
- :help hl-WarningMsg
+ :help hl-WarningMsg
< talks about the WarningMsg highlighting group.
20) Syntax highlighting is namespaced to :syn-topic. E.g. >
@@ -662,24 +662,24 @@ Summary: *help-summary* >
usually start with :l
22) Autocommand events can be found by their name: >
- :help BufWinLeave
+ :help BufWinLeave
< To see all possible events: >
:help autocommand-events
23) Command-line switches always start with "-". So for the help of the -f
command switch of Vim use: >
- :help -f
+ :help -f
24) Optional features always start with "+". To find out about the
conceal feature use: >
- :help +conceal
+ :help +conceal
25) Documentation for included filetype specific functionality is usually
- available in the form ft-<filetype>-<functionality>. So >
- :help ft-c-syntax
+ available in the form ft-<filetype>-<functionality>. So >
+ :help ft-c-syntax
< talks about the C syntax file and the option it provides. Sometimes,
additional sections for omni completion >
- :help ft-php-omni
+ :help ft-php-omni
< or filetype plugins >
:help ft-tex-plugin
< are available.
@@ -691,7 +691,7 @@ Summary: *help-summary* >
< talks about the warning "Changing a readonly file".
Sometimes, however, those error codes are not described, but rather are
listed at the Vim command that usually causes this. So: >
- :help E128
+ :help E128
< takes you to the |:function| command