runtime/doc/help.txt

   1 *help.txt*      For Vim version 7.3.  Last change: 2010 Jul 20
   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
  10 Jump to a subject:  Position the cursor on a tag (e.g. |bars|) and hit CTRL-].
  11    With the mouse:  ":set mouse=a" to enable the mouse (in xterm or GUI).
  12                     Double-click the left mouse button on a tag, e.g. |bars|.
  13         Jump back:  Type CTRL-T or CTRL-O (repeat to go further back).
  14
  15 Get specific help:  It is possible to go directly to whatever you want help
  16                     on, by giving an argument to the |:help| command.
  17                     It is possible to further specify the context:
  18                                                         *help-context*
  19                           WHAT                  PREPEND    EXAMPLE      ~
  20                       Normal mode command      (nothing)   :help x
  21                       Visual mode command         v_       :help v_u
  22                       Insert mode command         i_       :help i_<Esc>
  23                       Command-line command        :        :help :quit
  24                       Command-line editing        c_       :help c_<Del>
  25                       Vim command argument        -        :help -r
  26                       Option                      '        :help 'textwidth'
  27   Search for help:  Type ":help word", then hit CTRL-D to see matching
  28                     help entries for "word".
  29                     Or use ":helpgrep word". |:helpgrep|
  30
  31 VIM stands for Vi IMproved.  Most of VIM was made by Bram Moolenaar, but only
  32 through the help of many others.  See |credits|.
  33 ------------------------------------------------------------------------------
  34                                                 *doc-file-list* *Q_ct*
  35 BASIC:
  36 |quickref|      Overview of the most common commands you will use
  37 |tutor|         30 minutes training course for beginners
  38 |copying|       About copyrights
  39 |iccf|          Helping poor children in Uganda
  40 |sponsor|       Sponsor Vim development, become a registered Vim user
  41 |www|           Vim on the World Wide Web
  42 |bugs|          Where to send bug reports
  43
  44 USER MANUAL: These files explain how to accomplish an editing task.
  45
  46 |usr_toc.txt|   Table Of Contents
  47
  48 Getting Started ~
  49 |usr_01.txt|  About the manuals
  50 |usr_02.txt|  The first steps in Vim
  51 |usr_03.txt|  Moving around
  52 |usr_04.txt|  Making small changes
  53 |usr_05.txt|  Set your settings
  54 |usr_06.txt|  Using syntax highlighting
  55 |usr_07.txt|  Editing more than one file
  56 |usr_08.txt|  Splitting windows
  57 |usr_09.txt|  Using the GUI
  58 |usr_10.txt|  Making big changes
  59 |usr_11.txt|  Recovering from a crash
  60 |usr_12.txt|  Clever tricks
  61
  62 Editing Effectively ~
  63 |usr_20.txt|  Typing command-line commands quickly
  64 |usr_21.txt|  Go away and come back
  65 |usr_22.txt|  Finding the file to edit
  66 |usr_23.txt|  Editing other files
  67 |usr_24.txt|  Inserting quickly
  68 |usr_25.txt|  Editing formatted text
  69 |usr_26.txt|  Repeating
  70 |usr_27.txt|  Search commands and patterns
  71 |usr_28.txt|  Folding
  72 |usr_29.txt|  Moving through programs
  73 |usr_30.txt|  Editing programs
  74 |usr_31.txt|  Exploiting the GUI
  75 |usr_32.txt|  The undo tree
  76
  77 Tuning Vim ~
  78 |usr_40.txt|  Make new commands
  79 |usr_41.txt|  Write a Vim script
  80 |usr_42.txt|  Add new menus
  81 |usr_43.txt|  Using filetypes
  82 |usr_44.txt|  Your own syntax highlighted
  83 |usr_45.txt|  Select your language
  84
  85 Making Vim Run ~
  86 |usr_90.txt|  Installing Vim
  87
  88
  89 REFERENCE MANUAL: These files explain every detail of Vim.      *reference_toc*
  90
  91 General subjects ~
  92 |intro.txt|     general introduction to Vim; notation used in help files
  93 |help.txt|      overview and quick reference (this file)
  94 |helphelp.txt|  about using the help files
  95 |index.txt|     alphabetical index of all commands
  96 |help-tags|     all the tags you can jump to (index of tags)
  97 |howto.txt|     how to do the most common editing tasks
  98 |tips.txt|      various tips on using Vim
  99 |message.txt|   (error) messages and explanations
 100 |quotes.txt|    remarks from users of Vim
 101 |todo.txt|      known problems and desired extensions
 102 |develop.txt|   development of Vim
 103 |debug.txt|     debugging Vim itself
 104 |uganda.txt|    Vim distribution conditions and what to do with your money
 105
 106 Basic editing ~
 107 |starting.txt|  starting Vim, Vim command arguments, initialisation
 108 |editing.txt|   editing and writing files
 109 |motion.txt|    commands for moving around
 110 |scroll.txt|    scrolling the text in the window
 111 |insert.txt|    Insert and Replace mode
 112 |change.txt|    deleting and replacing text
 113 |indent.txt|    automatic indenting for C and other languages
 114 |undo.txt|      Undo and Redo
 115 |repeat.txt|    repeating commands, Vim scripts and debugging
 116 |visual.txt|    using the Visual mode (selecting a text area)
 117 |various.txt|   various remaining commands
 118 |recover.txt|   recovering from a crash
 119
 120 Advanced editing ~
 121 |cmdline.txt|   Command-line editing
 122 |options.txt|   description of all options
 123 |pattern.txt|   regexp patterns and search commands
 124 |map.txt|       key mapping and abbreviations
 125 |tagsrch.txt|   tags and special searches
 126 |quickfix.txt|  commands for a quick edit-compile-fix cycle
 127 |windows.txt|   commands for using multiple windows and buffers
 128 |tabpage.txt|   commands for using multiple tab pages
 129 |syntax.txt|    syntax highlighting
 130 |spell.txt|     spell checking
 131 |diff.txt|      working with two to four versions of the same file
 132 |autocmd.txt|   automatically executing commands on an event
 133 |filetype.txt|  settings done specifically for a type of file
 134 |eval.txt|      expression evaluation, conditional commands
 135 |fold.txt|      hide (fold) ranges of lines
 136
 137 Special issues ~
 138 |print.txt|     printing
 139 |remote.txt|    using Vim as a server or client
 140 |term.txt|      using different terminals and mice
 141 |digraph.txt|   list of available digraphs
 142 |mbyte.txt|     multi-byte text support
 143 |mlang.txt|     non-English language support
 144 |arabic.txt|    Arabic language support and editing
 145 |farsi.txt|     Farsi (Persian) editing
 146 |hebrew.txt|    Hebrew language support and editing
 147 |russian.txt|   Russian language support and editing
 148 |ft_ada.txt|    Ada (the programming language) support
 149 |ft_sql.txt|    about the SQL filetype plugin
 150 |hangulin.txt|  Hangul (Korean) input mode
 151 |rileft.txt|    right-to-left editing mode
 152
 153 GUI ~
 154 |gui.txt|       Graphical User Interface (GUI)
 155 |gui_w16.txt|   Windows 3.1 GUI
 156 |gui_w32.txt|   Win32 GUI
 157 |gui_x11.txt|   X11 GUI
 158
 159 Interfaces ~
 160 |if_cscop.txt|  using Cscope with Vim
 161 |if_lua.txt|    Lua interface
 162 |if_mzsch.txt|  MzScheme interface
 163 |if_perl.txt|   Perl interface
 164 |if_pyth.txt|   Python interface
 165 |if_sniff.txt|  SNiFF+ interface
 166 |if_tcl.txt|    Tcl interface
 167 |if_ole.txt|    OLE automation interface for Win32
 168 |if_ruby.txt|   Ruby interface
 169 |debugger.txt|  Interface with a debugger
 170 |workshop.txt|  Sun Visual Workshop interface
 171 |netbeans.txt|  NetBeans External Editor interface
 172 |sign.txt|      debugging signs
 173
 174 Versions ~
 175 |vi_diff.txt|   Main differences between Vim and Vi
 176 |version4.txt|  Differences between Vim version 3.0 and 4.x
 177 |version5.txt|  Differences between Vim version 4.6 and 5.x
 178 |version6.txt|  Differences between Vim version 5.7 and 6.x
 179 |version7.txt|  Differences between Vim version 6.4 and 7.x
 180                                                 *sys-file-list*
 181 Remarks about specific systems ~
 182 |os_390.txt|    OS/390 Unix
 183 |os_amiga.txt|  Amiga
 184 |os_beos.txt|   BeOS and BeBox
 185 |os_dos.txt|    MS-DOS and MS-Windows NT/95 common items
 186 |os_mac.txt|    Macintosh
 187 |os_mint.txt|   Atari MiNT
 188 |os_msdos.txt|  MS-DOS (plain DOS and DOS box under Windows)
 189 |os_os2.txt|    OS/2
 190 |os_qnx.txt|    QNX
 191 |os_risc.txt|   RISC-OS
 192 |os_unix.txt|   Unix
 193 |os_vms.txt|    VMS
 194 |os_win32.txt|  MS-Windows 95/98/NT
 195                                                 *standard-plugin-list*
 196 Standard plugins ~
 197 |pi_getscript.txt| Downloading latest version of Vim scripts
 198 |pi_gzip.txt|      Reading and writing compressed files
 199 |pi_netrw.txt|     Reading and writing files over a network
 200 |pi_paren.txt|     Highlight matching parens
 201 |pi_tar.txt|       Tar file explorer
 202 |pi_vimball.txt|   Create a self-installing Vim script
 203 |pi_zip.txt|       Zip archive explorer
 204
 205 LOCAL ADDITIONS:                                *local-additions*
 206
 207 ------------------------------------------------------------------------------
 208 *bars*          Bars example
 209
 210 Now that you've jumped here with CTRL-] or a double mouse click, you can use
 211 CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were.
 212
 213 Note that tags are within | characters, but when highlighting is enabled these
 214 characters are hidden.  That makes it easier to read a command.
 215
 216 Anyway, you can use CTRL-] on any word, also when it is not within |, and Vim
 217 will try to find help for it.  Especially for options in single quotes, e.g.
 218 'compatible'.
 219
 220 ------------------------------------------------------------------------------
 221  vim:tw=78:fo=tcq2:isk=!-~,^*,^\|,^\":ts=8:ft=help:norl: