Mercurial > vim
annotate runtime/doc/help.txt @ 29659:2198955f9e27
Update runtime files
Commit: https://github.com/vim/vim/commit/48c3f4e0bff7efd289a7001b68c777b6f89a7057
Author: Bram Moolenaar <Bram@vim.org>
Date: Mon Aug 8 15:42:38 2022 +0100
Update runtime files
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Mon, 08 Aug 2022 16:45:05 +0200 |
parents | f8116058ca76 |
children | ebed259f919f |
rev | line source |
---|---|
29314 | 1 *help.txt* For Vim version 9.0. Last change: 2022 May 13 |
7 | 2 |
3 VIM - main help file | |
4 k | |
5 Move around: Use the cursor keys, or "h" to go left, h l | |
6 "j" to go down, "k" to go up, "l" to go right. j | |
7 Close this window: Use ":q<Enter>". | |
8 Get out of Vim: Use ":qa!<Enter>" (careful, all changes are lost!). | |
9 | |
864 | 10 Jump to a subject: Position the cursor on a tag (e.g. |bars|) and hit CTRL-]. |
7 | 11 With the mouse: ":set mouse=a" to enable the mouse (in xterm or GUI). |
864 | 12 Double-click the left mouse button on a tag, e.g. |bars|. |
15334 | 13 Jump back: Type CTRL-O. Repeat to go further back. |
7 | 14 |
15 Get specific help: It is possible to go directly to whatever you want help | |
874 | 16 on, by giving an argument to the |:help| command. |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
17 Prepend something to specify the context: *help-context* |
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
18 |
7 | 19 WHAT PREPEND EXAMPLE ~ |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
20 Normal mode command :help x |
856 | 21 Visual mode command v_ :help v_u |
22 Insert mode command i_ :help i_<Esc> | |
23 Command-line command : :help :quit | |
7 | 24 Command-line editing c_ :help c_<Del> |
856 | 25 Vim command argument - :help -r |
26 Option ' :help 'textwidth' | |
6741 | 27 Regular expression / :help /[ |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
28 See |help-summary| for more contexts and an explanation. |
29659 | 29 See |notation| for an explanation of the help syntax. |
7557
502ca0a62fd8
commit https://github.com/vim/vim/commit/acb4f221c715a333f4c49a2235a8006c6ac6e4d5
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
30 |
7 | 31 Search for help: Type ":help word", then hit CTRL-D to see matching |
32 help entries for "word". | |
2246
1e48f569b03d
Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
33 Or use ":helpgrep word". |:helpgrep| |
7 | 34 |
19968 | 35 Getting started: Do the Vim tutor, a 30-minute interactive course for the |
15334 | 36 basic commands, see |vimtutor|. |
37 Read the user manual from start to end: |usr_01.txt| | |
38 | |
11473 | 39 Vim stands for Vi IMproved. Most of Vim was made by Bram Moolenaar, but only |
7 | 40 through the help of many others. See |credits|. |
41 ------------------------------------------------------------------------------ | |
42 *doc-file-list* *Q_ct* | |
43 BASIC: | |
44 |quickref| Overview of the most common commands you will use | |
19968 | 45 |tutor| 30-minute interactive course for beginners |
7 | 46 |copying| About copyrights |
47 |iccf| Helping poor children in Uganda | |
48 |sponsor| Sponsor Vim development, become a registered Vim user | |
49 |www| Vim on the World Wide Web | |
50 |bugs| Where to send bug reports | |
51 | |
52 USER MANUAL: These files explain how to accomplish an editing task. | |
53 | |
54 |usr_toc.txt| Table Of Contents | |
55 | |
56 Getting Started ~ | |
57 |usr_01.txt| About the manuals | |
58 |usr_02.txt| The first steps in Vim | |
59 |usr_03.txt| Moving around | |
60 |usr_04.txt| Making small changes | |
61 |usr_05.txt| Set your settings | |
62 |usr_06.txt| Using syntax highlighting | |
63 |usr_07.txt| Editing more than one file | |
64 |usr_08.txt| Splitting windows | |
65 |usr_09.txt| Using the GUI | |
66 |usr_10.txt| Making big changes | |
67 |usr_11.txt| Recovering from a crash | |
68 |usr_12.txt| Clever tricks | |
69 | |
70 Editing Effectively ~ | |
71 |usr_20.txt| Typing command-line commands quickly | |
72 |usr_21.txt| Go away and come back | |
73 |usr_22.txt| Finding the file to edit | |
74 |usr_23.txt| Editing other files | |
75 |usr_24.txt| Inserting quickly | |
76 |usr_25.txt| Editing formatted text | |
77 |usr_26.txt| Repeating | |
78 |usr_27.txt| Search commands and patterns | |
79 |usr_28.txt| Folding | |
80 |usr_29.txt| Moving through programs | |
81 |usr_30.txt| Editing programs | |
82 |usr_31.txt| Exploiting the GUI | |
799 | 83 |usr_32.txt| The undo tree |
7 | 84 |
85 Tuning Vim ~ | |
86 |usr_40.txt| Make new commands | |
87 |usr_41.txt| Write a Vim script | |
88 |usr_42.txt| Add new menus | |
89 |usr_43.txt| Using filetypes | |
90 |usr_44.txt| Your own syntax highlighted | |
91 |usr_45.txt| Select your language | |
28862
82244cfc4694
Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
92 |
82244cfc4694
Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
93 Writing Vim scripts ~ |
82244cfc4694
Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
94 |usr_50.txt| Advanced Vim script writing |
82244cfc4694
Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
95 |usr_51.txt| Create a plugin |
82244cfc4694
Update runtime files, new color schemes
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
96 |usr_52.txt| Write plugins using Vim9 script |
7 | 97 |
98 Making Vim Run ~ | |
99 |usr_90.txt| Installing Vim | |
100 | |
819 | 101 REFERENCE MANUAL: These files explain every detail of Vim. *reference_toc* |
7 | 102 |
103 General subjects ~ | |
104 |intro.txt| general introduction to Vim; notation used in help files | |
105 |help.txt| overview and quick reference (this file) | |
2246
1e48f569b03d
Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
106 |helphelp.txt| about using the help files |
7 | 107 |index.txt| alphabetical index of all commands |
108 |help-tags| all the tags you can jump to (index of tags) | |
109 |howto.txt| how to do the most common editing tasks | |
110 |tips.txt| various tips on using Vim | |
111 |message.txt| (error) messages and explanations | |
112 |quotes.txt| remarks from users of Vim | |
113 |todo.txt| known problems and desired extensions | |
114 |develop.txt| development of Vim | |
502 | 115 |debug.txt| debugging Vim itself |
7 | 116 |uganda.txt| Vim distribution conditions and what to do with your money |
117 | |
118 Basic editing ~ | |
119 |starting.txt| starting Vim, Vim command arguments, initialisation | |
120 |editing.txt| editing and writing files | |
121 |motion.txt| commands for moving around | |
122 |scroll.txt| scrolling the text in the window | |
123 |insert.txt| Insert and Replace mode | |
124 |change.txt| deleting and replacing text | |
125 |undo.txt| Undo and Redo | |
126 |repeat.txt| repeating commands, Vim scripts and debugging | |
127 |visual.txt| using the Visual mode (selecting a text area) | |
128 |various.txt| various remaining commands | |
129 |recover.txt| recovering from a crash | |
130 | |
131 Advanced editing ~ | |
132 |cmdline.txt| Command-line editing | |
133 |options.txt| description of all options | |
134 |pattern.txt| regexp patterns and search commands | |
135 |map.txt| key mapping and abbreviations | |
136 |tagsrch.txt| tags and special searches | |
137 |windows.txt| commands for using multiple windows and buffers | |
674 | 138 |tabpage.txt| commands for using multiple tab pages |
221 | 139 |spell.txt| spell checking |
24911 | 140 |diff.txt| working with two to eight versions of the same file |
7 | 141 |autocmd.txt| automatically executing commands on an event |
142 |eval.txt| expression evaluation, conditional commands | |
26777
629e7046ef63
patch 8.2.3917: the eval.txt help file is way too big
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
143 |builtin.txt| builtin functions |
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
144 |channel.txt| Jobs, Channels, inter-process communication |
7 | 145 |fold.txt| hide (fold) ranges of lines |
146 | |
147 Special issues ~ | |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
148 |testing.txt| testing Vim and Vim scripts |
15 | 149 |print.txt| printing |
7 | 150 |remote.txt| using Vim as a server or client |
151 |term.txt| using different terminals and mice | |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
152 |terminal.txt| Terminal window support |
19968 | 153 |popup.txt| popup window support |
24911 | 154 |vim9.txt| using Vim9 script |
15194 | 155 |
156 Programming language support ~ | |
157 |indent.txt| automatic indenting for C and other languages | |
158 |syntax.txt| syntax highlighting | |
159 |textprop.txt| Attaching properties to text for highlighting or other | |
160 |filetype.txt| settings done specifically for a type of file | |
161 |quickfix.txt| commands for a quick edit-compile-fix cycle | |
162 |ft_ada.txt| Ada (the programming language) support | |
24911 | 163 |ft_ps1.txt| Filetype plugin for Windows PowerShell |
164 |ft_raku.txt| Filetype plugin for Raku | |
15194 | 165 |ft_rust.txt| Filetype plugin for Rust |
166 |ft_sql.txt| about the SQL filetype plugin | |
167 | |
168 Language support ~ | |
7 | 169 |digraph.txt| list of available digraphs |
21991 | 170 |mbyte.txt| multibyte text support |
7 | 171 |mlang.txt| non-English language support |
15194 | 172 |rileft.txt| right-to-left editing mode |
7 | 173 |arabic.txt| Arabic language support and editing |
174 |farsi.txt| Farsi (Persian) editing | |
175 |hebrew.txt| Hebrew language support and editing | |
176 |russian.txt| Russian language support and editing | |
177 |hangulin.txt| Hangul (Korean) input mode | |
178 | |
179 GUI ~ | |
180 |gui.txt| Graphical User Interface (GUI) | |
181 |gui_w32.txt| Win32 GUI | |
182 |gui_x11.txt| X11 GUI | |
183 | |
184 Interfaces ~ | |
14 | 185 |if_cscop.txt| using Cscope with Vim |
2320
966a5609669e
Added Lua interfae. (Luis Carvalho)
Bram Moolenaar <bram@vim.org>
parents:
2246
diff
changeset
|
186 |if_lua.txt| Lua interface |
14 | 187 |if_mzsch.txt| MzScheme interface |
7 | 188 |if_perl.txt| Perl interface |
189 |if_pyth.txt| Python interface | |
190 |if_tcl.txt| Tcl interface | |
191 |if_ole.txt| OLE automation interface for Win32 | |
192 |if_ruby.txt| Ruby interface | |
193 |debugger.txt| Interface with a debugger | |
194 |netbeans.txt| NetBeans External Editor interface | |
195 |sign.txt| debugging signs | |
196 | |
197 Versions ~ | |
198 |vi_diff.txt| Main differences between Vim and Vi | |
199 |version4.txt| Differences between Vim version 3.0 and 4.x | |
200 |version5.txt| Differences between Vim version 4.6 and 5.x | |
201 |version6.txt| Differences between Vim version 5.7 and 6.x | |
824 | 202 |version7.txt| Differences between Vim version 6.4 and 7.x |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
203 |version8.txt| Differences between Vim version 7.4 and 8.x |
27903 | 204 |version9.txt| Differences between Vim version 8.2 and 9.0 |
7 | 205 *sys-file-list* |
206 Remarks about specific systems ~ | |
207 |os_390.txt| OS/390 Unix | |
208 |os_amiga.txt| Amiga | |
209 |os_beos.txt| BeOS and BeBox | |
19116 | 210 |os_dos.txt| MS-DOS and MS-Windows common items |
20241 | 211 |os_haiku.txt| Haiku |
7 | 212 |os_mac.txt| Macintosh |
213 |os_mint.txt| Atari MiNT | |
214 |os_msdos.txt| MS-DOS (plain DOS and DOS box under Windows) | |
215 |os_os2.txt| OS/2 | |
216 |os_qnx.txt| QNX | |
217 |os_risc.txt| RISC-OS | |
218 |os_unix.txt| Unix | |
219 |os_vms.txt| VMS | |
19116 | 220 |os_win32.txt| MS-Windows |
7 | 221 *standard-plugin-list* |
222 Standard plugins ~ | |
1121 | 223 |pi_getscript.txt| Downloading latest version of Vim scripts |
4073 | 224 |pi_gzip.txt| Reading and writing compressed files |
6884 | 225 |pi_logipat.txt| Logical operators on patterns |
4073 | 226 |pi_netrw.txt| Reading and writing files over a network |
227 |pi_paren.txt| Highlight matching parens | |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
228 |pi_spec.txt| Filetype plugin to work with rpm spec files |
4073 | 229 |pi_tar.txt| Tar file explorer |
1121 | 230 |pi_vimball.txt| Create a self-installing Vim script |
4073 | 231 |pi_zip.txt| Zip archive explorer |
7 | 232 |
233 LOCAL ADDITIONS: *local-additions* | |
234 | |
235 ------------------------------------------------------------------------------ | |
236 *bars* Bars example | |
237 | |
238 Now that you've jumped here with CTRL-] or a double mouse click, you can use | |
239 CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were. | |
864 | 240 |
241 Note that tags are within | characters, but when highlighting is enabled these | |
2246
1e48f569b03d
Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
242 characters are hidden. That makes it easier to read a command. |
864 | 243 |
244 Anyway, you can use CTRL-] on any word, also when it is not within |, and Vim | |
2246
1e48f569b03d
Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
245 will try to find help for it. Especially for options in single quotes, e.g. |
1e48f569b03d
Move text from various.txt to a new helphelp.txt help file.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
246 'compatible'. |
864 | 247 |
7 | 248 ------------------------------------------------------------------------------ |
14945 | 249 vim:tw=78:isk=!-~,^*,^\|,^\":ts=8:noet:ft=help:norl: |