vimhelp-ipad.pdf

3018
help.txt For Vim version 7.4. Last change: 2012 Dec 06 VIM - main help file k Move around: Use the cursor keys, or "h" to go left, h l "j" to go down, "k" to go up, "l" to go right. j Close this window: Use ":q<Enter>". Get out of Vim: Use ":qa!<Enter>" (careful, all changes are lost!). Jump to a subject: Position the cursor on a tag (e.g. bars ) and hit CTRL-]. With the mouse: ":set mouse=a" to enable the mouse (in xterm or GUI). Double-click the left mouse button on a tag, e.g. bars . Jump back: Type CTRL-T or CTRL-O (repeat to go further back). Get specific help: It is possible to go directly to whatever you want help on, by giving an argument to the :help command. It is possible to further specify the context: help-context WHAT PREPEND EXAMPLE Normal mode command (nothing) :help x Visual mode command v_ :help v_u Insert mode command i_ :help i_<Esc> Command-line command : :help :quit Command-line editing c_ :help c_<Del> Vim command argument - :help -r Option ' :help 'textwidth' Search for help: Type ":help word", then hit CTRL-D to see matching help entries for "word". Or use ":helpgrep word". :helpgrep VIM stands for Vi IMproved. Most of VIM was made by Bram Moolenaar, but only through the help of many others. See credits . ------------------------------------------------------------------------------ doc-file-list Q_ct BASIC: quickref Overview of the most common commands you will use tutor 30 minutes training course for beginners copying About copyrights iccf Helping poor children in Uganda sponsor Sponsor Vim development, become a registered Vim user www Vim on the World Wide Web bugs Where to send bug reports USER MANUAL: These files explain how to accomplish an editing task. usr_toc.txt Table Of Contents Getting Started usr_01.txt About the manuals usr_02.txt The first steps in Vim usr_03.txt Moving around help.txt — 1

Upload: chester-connolly

Post on 12-Dec-2015

219 views

Category:

Documents


0 download

TRANSCRIPT

  • help.txt For Vim version 7.4. Last change: 2012 Dec 06

    VIM - main help filek

    Move around: Use the cursor keys, or "h" to go left, h l"j" to go down, "k" to go up, "l" to go right. j

    Close this window: Use ":q".Get out of Vim: Use ":qa!" (careful, all changes are lost!).

    Jump to a subject: Position the cursor on a tag (e.g. bars ) and hit CTRL-].With the mouse: ":set mouse=a" to enable the mouse (in xterm or GUI).

    Double-click the left mouse button on a tag, e.g. bars .Jump back: Type CTRL-T or CTRL-O (repeat to go further back).

    Get specific help: It is possible to go directly to whatever you want helpon, by giving an argument to the :help command.It is possible to further specify the context:

    help-contextWHAT PREPEND EXAMPLE

    Normal mode command (nothing) :help xVisual mode command v_ :help v_uInsert mode command i_ :help i_Command-line command : :help :quitCommand-line editing c_ :help c_Vim command argument - :help -rOption ' :help 'textwidth'

    Search for help: Type ":help word", then hit CTRL-D to see matchinghelp entries for "word".Or use ":helpgrep word". :helpgrep

    VIM stands for Vi IMproved. Most of VIM was made by Bram Moolenaar, but onlythrough the help of many others. See credits .------------------------------------------------------------------------------

    doc-file-list Q_ctBASIC:quickref Overview of the most common commands you will usetutor 30 minutes training course for beginnerscopying About copyrightsiccf Helping poor children in Ugandasponsor Sponsor Vim development, become a registered Vim userwww Vim on the World Wide Webbugs Where to send bug reports

    USER MANUAL: These files explain how to accomplish an editing task.

    usr_toc.txt Table Of Contents

    Getting Startedusr_01.txt About the manualsusr_02.txt The first steps in Vimusr_03.txt Moving around

    help.txt 1

  • usr_04.txt Making small changesusr_05.txt Set your settingsusr_06.txt Using syntax highlightingusr_07.txt Editing more than one fileusr_08.txt Splitting windowsusr_09.txt Using the GUIusr_10.txt Making big changesusr_11.txt Recovering from a crashusr_12.txt Clever tricks

    Editing Effectivelyusr_20.txt Typing command-line commands quicklyusr_21.txt Go away and come backusr_22.txt Finding the file to editusr_23.txt Editing other filesusr_24.txt Inserting quicklyusr_25.txt Editing formatted textusr_26.txt Repeatingusr_27.txt Search commands and patternsusr_28.txt Foldingusr_29.txt Moving through programsusr_30.txt Editing programsusr_31.txt Exploiting the GUIusr_32.txt The undo tree

    Tuning Vimusr_40.txt Make new commandsusr_41.txt Write a Vim scriptusr_42.txt Add new menususr_43.txt Using filetypesusr_44.txt Your own syntax highlightedusr_45.txt Select your language

    Making Vim Runusr_90.txt Installing Vim

    REFERENCE MANUAL: These files explain every detail of Vim. reference_toc

    General subjectsintro.txt general introduction to Vim; notation used in help fileshelp.txt overview and quick reference (this file)helphelp.txt about using the help filesindex.txt alphabetical index of all commandshelp-tags all the tags you can jump to (index of tags)howto.txt how to do the most common editing taskstips.txt various tips on using Vimmessage.txt (error) messages and explanationsquotes.txt remarks from users of Vimtodo.txt known problems and desired extensionsdevelop.txt development of Vim

    help.txt 2

  • debug.txt debugging Vim itselfuganda.txt Vim distribution conditions and what to do with your money

    Basic editingstarting.txt starting Vim, Vim command arguments, initialisationediting.txt editing and writing filesmotion.txt commands for moving aroundscroll.txt scrolling the text in the windowinsert.txt Insert and Replace modechange.txt deleting and replacing textindent.txt automatic indenting for C and other languagesundo.txt Undo and Redorepeat.txt repeating commands, Vim scripts and debuggingvisual.txt using the Visual mode (selecting a text area)various.txt various remaining commandsrecover.txt recovering from a crash

    Advanced editingcmdline.txt Command-line editingoptions.txt description of all optionspattern.txt regexp patterns and search commandsmap.txt key mapping and abbreviationstagsrch.txt tags and special searchesquickfix.txt commands for a quick edit-compile-fix cyclewindows.txt commands for using multiple windows and bufferstabpage.txt commands for using multiple tab pagessyntax.txt syntax highlightingspell.txt spell checkingdiff.txt working with two to four versions of the same fileautocmd.txt automatically executing commands on an eventfiletype.txt settings done specifically for a type of fileeval.txt expression evaluation, conditional commandsfold.txt hide (fold) ranges of lines

    Special issuesprint.txt printingremote.txt using Vim as a server or clientterm.txt using different terminals and micedigraph.txt list of available digraphsmbyte.txt multi-byte text supportmlang.txt non-English language supportarabic.txt Arabic language support and editingfarsi.txt Farsi (Persian) editinghebrew.txt Hebrew language support and editingrussian.txt Russian language support and editingft_ada.txt Ada (the programming language) supportft_sql.txt about the SQL filetype pluginhangulin.txt Hangul (Korean) input moderileft.txt right-to-left editing mode

    GUI

    help.txt 3

  • gui.txt Graphical User Interface (GUI)gui_w16.txt Windows 3.1 GUIgui_w32.txt Win32 GUIgui_x11.txt X11 GUI

    Interfacesif_cscop.txt using Cscope with Vimif_lua.txt Lua interfaceif_mzsch.txt MzScheme interfaceif_perl.txt Perl interfaceif_pyth.txt Python interfaceif_sniff.txt SNiFF+ interfaceif_tcl.txt Tcl interfaceif_ole.txt OLE automation interface for Win32if_ruby.txt Ruby interfacedebugger.txt Interface with a debuggerworkshop.txt Sun Visual Workshop interfacenetbeans.txt NetBeans External Editor interfacesign.txt debugging signs

    Versionsvi_diff.txt Main differences between Vim and Viversion4.txt Differences between Vim version 3.0 and 4.xversion5.txt Differences between Vim version 4.6 and 5.xversion6.txt Differences between Vim version 5.7 and 6.xversion7.txt Differences between Vim version 6.4 and 7.x

    sys-file-listRemarks about specific systemsos_390.txt OS/390 Unixos_amiga.txt Amigaos_beos.txt BeOS and BeBoxos_dos.txt MS-DOS and MS-Windows NT/95 common itemsos_mac.txt Macintoshos_mint.txt Atari MiNTos_msdos.txt MS-DOS (plain DOS and DOS box under Windows)os_os2.txt OS/2os_qnx.txt QNXos_risc.txt RISC-OSos_unix.txt Unixos_vms.txt VMSos_win32.txt MS-Windows 95/98/NT

    standard-plugin-listStandard pluginspi_getscript.txt Downloading latest version of Vim scriptspi_gzip.txt Reading and writing compressed filespi_netrw.txt Reading and writing files over a networkpi_paren.txt Highlight matching parenspi_tar.txt Tar file explorerpi_vimball.txt Create a self-installing Vim scriptpi_zip.txt Zip archive explorer

    help.txt 4

  • LOCAL ADDITIONS: local-additionsvim_faq.txt Frequently asked questions

    ------------------------------------------------------------------------------bars Bars example

    Now that you've jumped here with CTRL-] or a double mouse click, you can useCTRL-T, CTRL-O, g, or to go back to where you were.

    Note that tags are within | characters, but when highlighting is enabled thesecharacters are hidden. That makes it easier to read a command.

    Anyway, you can use CTRL-] on any word, also when it is not within |, and Vimwill try to find help for it. Especially for options in single quotes, e.g.'compatible'.

    ------------------------------------------------------------------------------vim:tw=78:fo=tcq2:isk=!-~,^*,^\|,^\":ts=8:ft=help:norl:

    help.txt 5

  • quickref.txt For Vim version 7.4. Last change: 2013 Jun 29

    VIM REFERENCE MANUAL by Bram Moolenaar

    Quick reference guide

    quickref Contentstag subject tag subjectQ_ct list of help files Q_re Repeating commandsQ_lr motion: Left-right Q_km Key mappingQ_ud motion: Up-down Q_ab AbbreviationsQ_tm motion: Text object Q_op OptionsQ_pa motion: Pattern searches Q_ur Undo/Redo commandsQ_ma motion: Marks Q_et External commandsQ_vm motion: Various Q_qf Quickfix commandsQ_ta motion: Using tags Q_vc Various commandsQ_sc Scrolling Q_ce Ex: Command-line editingQ_in insert: Inserting text Q_ra Ex: RangesQ_ai insert: Keys Q_ex Ex: Special charactersQ_ss insert: Special keys Q_st Starting VimQ_di insert: Digraphs Q_ed Editing a fileQ_si insert: Special inserts Q_fl Using the argument listQ_de change: Deleting text Q_wq Writing and quittingQ_cm change: Copying and moving Q_ac Automatic commandsQ_ch change: Changing text Q_wi Multi-window commandsQ_co change: Complex Q_bu Buffer list commandsQ_vi Visual mode Q_sy Syntax highlightingQ_to Text objects Q_gu GUI commands

    Q_fo Folding

    ------------------------------------------------------------------------------N is used to indicate an optional count that can be given before the command.------------------------------------------------------------------------------Q_lr Left-right motions

    h N h left (also: CTRL-H, , or key)l N l right (also: or key)0 0 to first character in the line (also: key)^ ^ to first non-blank character in the line$ N $ to the last character in the line (N-1 lines lower)

    (also: key)g0 g0 to first character in screen line (differs from "0"

    when lines wrap)g^ g^ to first non-blank character in screen line (differs

    from "^" when lines wrap)g$ N g$ to last character in screen line (differs from "$"

    when lines wrap)gm gm to middle of the screen linebar N | to column N (default: 1)f N f{char} to the Nth occurrence of {char} to the right

    quickref.txt 6

  • F N F{char} to the Nth occurrence of {char} to the leftt N t{char} till before the Nth occurrence of {char} to the rightT N T{char} till before the Nth occurrence of {char} to the left; N ; repeat the last "f", "F", "t", or "T" N times, N , repeat the last "f", "F", "t", or "T" N times in

    opposite direction------------------------------------------------------------------------------Q_ud Up-down motions

    k N k up N lines (also: CTRL-P and )j N j down N lines (also: CTRL-J, CTRL-N, , and )- N - up N lines, on the first non-blank character+ N + down N lines, on the first non-blank character (also:

    CTRL-M and )_ N _ down N-1 lines, on the first non-blank characterG N G goto line N (default: last line), on the first

    non-blank charactergg N gg goto line N (default: first line), on the first

    non-blank characterN% N % goto line N percentage down in the file; N must be

    given, otherwise it is the % commandgk N gk up N screen lines (differs from "k" when line wraps)gj N gj down N screen lines (differs from "j" when line wraps)

    ------------------------------------------------------------------------------Q_tm Text object motions

    w N w N words forwardW N W N blank-separated WORD s forwarde N e forward to the end of the Nth wordE N E forward to the end of the Nth blank-separated WORDb N b N words backwardB N B N blank-separated WORD s backwardge N ge backward to the end of the Nth wordgE N gE backward to the end of the Nth blank-separated WORD

    ) N ) N sentences forward( N ( N sentences backward} N } N paragraphs forward{ N { N paragraphs backward]] N ]] N sections forward, at start of section[[ N [[ N sections backward, at start of section][ N ][ N sections forward, at end of section[] N [] N sections backward, at end of section[( N [( N times back to unclosed '('[{ N [{ N times back to unclosed '{'[m N [m N times back to start of method (for Java)[M N [M N times back to end of method (for Java)]) N ]) N times forward to unclosed ')']} N ]} N times forward to unclosed '}']m N ]m N times forward to start of method (for Java)]M N ]M N times forward to end of method (for Java)

    quickref.txt 7

  • [# N [# N times back to unclosed "#if" or "#else"]# N ]# N times forward to unclosed "#else" or "#endif"[star N [* N times back to start of comment "/*"]star N ]* N times forward to end of comment "*/"

    ------------------------------------------------------------------------------Q_pa Pattern searches

    / N /{pattern}[/[offset]]search forward for the Nth occurrence of {pattern}

    ? N ?{pattern}[?[offset]]search backward for the Nth occurrence of {pattern}

    / N / repeat last search, in the forward direction? N ? repeat last search, in the backward directionn N n repeat last searchN N N repeat last search, in opposite directionstar N * search forward for the identifier under the cursor# N # search backward for the identifier under the cursorgstar N g* like "*", but also find partial matchesg# N g# like "#", but also find partial matchesgd gd goto local declaration of identifier under the cursorgD gD goto global declaration of identifier under the cursor

    pattern Special characters in search patterns

    meaning magic nomagicmatches any single character . \.

    matches start of line ^ ^matches $ $

    matches start of word \< \ \>

    matches a single char from the range [a-z] \[a-z]matches a single char not in the range [^a-z] \[^a-z]

    matches an identifier char \i \iidem but excluding digits \I \I

    matches a keyword character \k \kidem but excluding digits \K \K

    matches a file name character \f \fidem but excluding digits \F \F

    matches a printable character \p \pidem but excluding digits \P \P

    matches a white space character \s \smatches a non-white space character \S \S

    matches \e \ematches \t \tmatches \r \rmatches \b \b

    matches 0 or more of the preceding atom * \*matches 1 or more of the preceding atom \+ \+

    matches 0 or 1 of the preceding atom \= \=

    quickref.txt 8

  • matches 2 to 5 of the preceding atom \{2,5} \{2,5}separates two alternatives \| \|

    group a pattern into an atom \(\) \(\)

    search-offset Offsets allowed after search command

    [num] [num] lines downwards, in column 1+[num] [num] lines downwards, in column 1-[num] [num] lines upwards, in column 1e[+num] [num] characters to the right of the end of the matche[-num] [num] characters to the left of the end of the matchs[+num] [num] characters to the right of the start of the matchs[-num] [num] characters to the left of the start of the matchb[+num] [num] identical to s[+num] above (mnemonic: begin)b[-num] [num] identical to s[-num] above (mnemonic: begin);{search-command} execute {search-command} next

    ------------------------------------------------------------------------------Q_ma Marks and motions

    m m{a-zA-Z} mark current position with mark {a-zA-Z}`a `{a-z} go to mark {a-z} within current file`A `{A-Z} go to mark {A-Z} in any file`0 `{0-9} go to the position where Vim was previously exited`` `` go to the position before the last jump`quote `" go to the position when last editing this file`[ `[ go to the start of the previously operated or put text`] `] go to the end of the previously operated or put text`< `< go to the start of the (previous) Visual area`> `> go to the end of the (previous) Visual area`. `. go to the position of the last change in this file' '{a-zA-Z0-9[]'".}

    same as `, but on the first non-blank in the line:marks :marks print the active marksCTRL-O N CTRL-O go to Nth older position in jump listCTRL-I N CTRL-I go to Nth newer position in jump list:ju :ju[mps] print the jump list

    ------------------------------------------------------------------------------Q_vm Various motions

    % % find the next brace, bracket, comment, or "#if"/"#else"/"#endif" in this line and go to its match

    H N H go to the Nth line in the window, on the firstnon-blank

    M M go to the middle line in the window, on the firstnon-blank

    L N L go to the Nth line from the bottom, on the firstnon-blank

    go N go go to Nth byte in the buffer:go :[range]go[to] [off] go to [off] byte in the buffer

    ------------------------------------------------------------------------------

    quickref.txt 9

  • Q_ta Using tags

    :ta :ta[g][!] {tag} jump to tag {tag}:ta :[count]ta[g][!] jump to [count]'th newer tag in tag listCTRL-] CTRL-] jump to the tag under cursor, unless changes

    have been made:ts :ts[elect][!] [tag] list matching tags and select one to jump to:tjump :tj[ump][!] [tag] jump to tag [tag] or select from list when

    there are multiple matches:ltag :lt[ag][!] [tag] jump to tag [tag] and add matching tags to the

    location list

    :tags :tags print tag listCTRL-T N CTRL-T jump back from Nth older tag in tag list:po :[count]po[p][!] jump back from [count]'th older tag in tag list:tnext :[count]tn[ext][!] jump to [count]'th next matching tag:tp :[count]tp[revious][!] jump to [count]'th previous matching tag:tr :[count]tr[ewind][!] jump to [count]'th matching tag:tl :tl[ast][!] jump to last matching tag

    :ptag :pt[ag] {tag} open a preview window to show tag {tag}CTRL-W_} CTRL-W } like CTRL-] but show tag in preview window:pts :pts[elect] like ":tselect" but show tag in preview window:ptjump :ptj[ump] like ":tjump" but show tag in preview window:pclose :pc[lose] close tag preview windowCTRL-W_z CTRL-W z close tag preview window

    ------------------------------------------------------------------------------Q_sc Scrolling

    CTRL-E N CTRL-E window N lines downwards (default: 1)CTRL-D N CTRL-D window N lines Downwards (default: 1/2 window)CTRL-F N CTRL-F window N pages Forwards (downwards)CTRL-Y N CTRL-Y window N lines upwards (default: 1)CTRL-U N CTRL-U window N lines Upwards (default: 1/2 window)CTRL-B N CTRL-B window N pages Backwards (upwards)z z or zt redraw, current line at top of windowz. z. or zz redraw, current line at center of windowz- z- or zb redraw, current line at bottom of window

    These only work when 'wrap' is off:zh N zh scroll screen N characters to the rightzl N zl scroll screen N characters to the leftzH N zH scroll screen half a screenwidth to the rightzL N zL scroll screen half a screenwidth to the left

    ------------------------------------------------------------------------------Q_in Inserting text

    a N a append text after the cursor (N times)A N A append text at the end of the line (N times)i N i insert text before the cursor (N times) (also: )I N I insert text before the first non-blank in the line (N times)

    quickref.txt 10

  • gI N gI insert text in column 1 (N times)o N o open a new line below the current line, append text (N times)O N O open a new line above the current line, append text (N times):startinsert :star[tinsert][!] start Insert mode, append when [!] used:startreplace :startr[eplace][!] start Replace mode, at EOL when [!] used

    in Visual block mode:v_b_I I insert the same text in front of all the selected linesv_b_A A append the same text after all the selected lines

    ------------------------------------------------------------------------------Q_ai Insert mode keys

    insert-index alphabetical index of Insert mode commands

    leaving Insert mode:i_ end Insert mode, back to Normal modei_CTRL-C CTRL-C like , but do not use an abbreviationi_CTRL-O CTRL-O {command} execute {command} and return to Insert mode

    moving around:i_ cursor keys move cursor left/right/up/downi_ shift-left/right one word left/righti_ shift-up/down one screenful backward/forwardi_ cursor after last character in the linei_ cursor to first character in the line

    ------------------------------------------------------------------------------Q_ss Special keys in Insert mode

    i_CTRL-V CTRL-V {char}.. insert character literally, or enter decimalbyte value

    i_ or or CTRL-M or CTRL-Jbegin new line

    i_CTRL-E CTRL-E insert the character from below the cursori_CTRL-Y CTRL-Y insert the character from above the cursor

    i_CTRL-A CTRL-A insert previously inserted texti_CTRL-@ CTRL-@ insert previously inserted text and stop

    Insert modei_CTRL-R CTRL-R {0-9a-z%#:.-="} insert the contents of a register

    i_CTRL-N CTRL-N insert next match of identifier before thecursor

    i_CTRL-P CTRL-P insert previous match of identifier beforethe cursor

    i_CTRL-X CTRL-X ... complete the word before the cursor invarious ways

    i_ or CTRL-H delete the character before the cursori_ delete the character under the cursori_CTRL-W CTRL-W delete word before the cursori_CTRL-U CTRL-U delete all entered characters in the current

    quickref.txt 11

  • linei_CTRL-T CTRL-T insert one shiftwidth of indent in front of

    the current linei_CTRL-D CTRL-D delete one shiftwidth of indent in front of

    the current linei_0_CTRL-D 0 CTRL-D delete all indent in the current linei_^_CTRL-D ^ CTRL-D delete all indent in the current line,

    restore indent in next line------------------------------------------------------------------------------Q_di Digraphs

    :dig :dig[raphs] show current list of digraphs:dig :dig[raphs] {char1}{char2} {number} ...

    add digraph(s) to the list

    In Insert or Command-line mode:i_CTRL-K CTRL-K {char1} {char2}

    enter digraphi_digraph {char1} {char2}

    enter digraph if 'digraph' option set------------------------------------------------------------------------------Q_si Special inserts

    :r :r [file] insert the contents of [file] below the cursor:r! :r! {command} insert the standard output of {command} below the

    cursor------------------------------------------------------------------------------Q_de Deleting text

    x N x delete N characters under and after the cursor N delete N characters under and after the cursorX N X delete N characters before the cursord N d{motion} delete the text that is moved over with {motion}v_d {visual}d delete the highlighted textdd N dd delete N linesD N D delete to the end of the line (and N-1 more lines)J N J join N-1 lines (delete s)v_J {visual}J join the highlighted linesgJ N gJ like "J", but without inserting spacesv_gJ {visual}gJ like "{visual}J", but without inserting spaces:d :[range]d [x] delete [range] lines [into register x]

    ------------------------------------------------------------------------------Q_cm Copying and moving text

    quote "{char} use register {char} for the next delete, yank, or put:reg :reg show the contents of all registers:reg :reg {arg} show the contents of registers mentioned in {arg}y N y{motion} yank the text moved over with {motion} into a registerv_y {visual}y yank the highlighted text into a registeryy N yy yank N lines into a registerY N Y yank N lines into a register

    quickref.txt 12

  • p N p put a register after the cursor position (N times)P N P put a register before the cursor position (N times)]p N ]p like p, but adjust indent to current line[p N [p like P, but adjust indent to current linegp N gp like p, but leave cursor after the new textgP N gP like P, but leave cursor after the new text

    ------------------------------------------------------------------------------Q_ch Changing text

    r N r{char} replace N characters with {char}gr N gr{char} replace N characters without affecting layoutR N R enter Replace mode (repeat the entered text N times)gR N gR enter virtual Replace mode: Like Replace mode but

    without affecting layoutv_b_r {visual}r{char}

    in Visual block mode: Replace each char of theselected text with {char}

    (change = delete text and enter Insert mode)c N c{motion} change the text that is moved over with {motion}v_c {visual}c change the highlighted textcc N cc change N linesS N S change N linesC N C change to the end of the line (and N-1 more lines)s N s change N charactersv_b_c {visual}c in Visual block mode: Change each of the selected

    lines with the entered textv_b_C {visual}C in Visual block mode: Change each of the selected

    lines until end-of-line with the entered text

    ~ N ~ switch case for N characters and advance cursorv_~ {visual}~ switch case for highlighted textv_u {visual}u make highlighted text lowercasev_U {visual}U make highlighted text uppercaseg~ g~{motion} switch case for the text that is moved over with

    {motion}gu gu{motion} make the text that is moved over with {motion}

    lowercasegU gU{motion} make the text that is moved over with {motion}

    uppercasev_g? {visual}g? perform rot13 encoding on highlighted textg? g?{motion} perform rot13 encoding on the text that is moved over

    with {motion}

    CTRL-A N CTRL-A add N to the number at or after the cursorCTRL-X N CTRL-X subtract N from the number at or after the cursor

    < N

  • shiftwidth right>> N >> move N lines one shiftwidth rightgq N gq{motion} format the lines that are moved over with {motion} to

    'textwidth' length:ce :[range]ce[nter] [width]

    center the lines in [range]:le :[range]le[ft] [indent]

    left-align the lines in [range] (with [indent]):ri :[range]ri[ght] [width]

    right-align the lines in [range]------------------------------------------------------------------------------Q_co Complex changes

    ! N !{motion}{command}filter the lines that are moved over through {command}

    !! N !!{command}filter N lines through {command}

    v_! {visual}!{command}filter the highlighted lines through {command}

    :range! :[range]! {command}filter [range] lines through {command}

    = N ={motion}filter the lines that are moved over through 'equalprg'

    == N == filter N lines through 'equalprg'v_= {visual}=

    filter the highlighted lines through 'equalprg':s :[range]s[ubstitute]/{pattern}/{string}/[g][c]

    substitute {pattern} by {string} in [range] lines;with [g], replace all occurrences of {pattern};with [c], confirm each replacement

    :s :[range]s[ubstitute] [g][c]repeat previous ":s" with new range and options

    & & Repeat previous ":s" on current line without options:ret :[range]ret[ab][!] [tabstop]

    set 'tabstop' to new value and adjust white spaceaccordingly

    ------------------------------------------------------------------------------Q_vi Visual mode

    visual-index list of Visual mode commands.

    v v start highlighting characters } move cursor and useV V start highlighting linewise } operator to affectCTRL-V CTRL-V start highlighting blockwise } highlighted textv_o o exchange cursor position with start of highlightinggv gv start highlighting on previous visual areav_v v highlight characters or stop highlightingv_V V highlight linewise or stop highlightingv_CTRL-V CTRL-V highlight blockwise or stop highlighting

    ------------------------------------------------------------------------------Q_to Text objects (only in Visual mode or after an operator)

    quickref.txt 14

  • v_aw N aw Select "a word"v_iw N iw Select "inner word"v_aW N aW Select "a WORD "v_iW N iW Select "inner WORD "v_as N as Select "a sentence"v_is N is Select "inner sentence"v_ap N ap Select "a paragraph"v_ip N ip Select "inner paragraph"v_ab N ab Select "a block" (from "[(" to "])")v_ib N ib Select "inner block" (from "[(" to "])")v_aB N aB Select "a Block" (from "[{" to "]}")v_iB N iB Select "inner Block" (from "[{" to "]}")v_a> N a> Select "a block"v_i> N i> Select "inner block"v_at N at Select "a tag block" (from to )v_it N it Select "inner tag block" (from to )v_a' N a' Select "a single quoted string"v_i' N i' Select "inner single quoted string"v_aquote N a" Select "a double quoted string"v_iquote N i" Select "inner double quoted string"v_a` N a` Select "a backward quoted string"v_i` N i` Select "inner backward quoted string"

    ------------------------------------------------------------------------------Q_re Repeating commands

    . N . repeat last change (with count replaced with N)q q{a-z} record typed characters into register {a-z}q q{A-Z} record typed characters, appended to register {a-z}q q stop recording@ N @{a-z} execute the contents of register {a-z} (N times)@@ N @@ repeat previous @{a-z} (N times):@ :@{a-z} execute the contents of register {a-z} as an Ex

    command:@@ :@@ repeat previous :@{a-z}:g :[range]g[lobal]/{pattern}/[cmd]

    execute Ex command [cmd] (default: ":p") on the lineswithin [range] where {pattern} matches

    :g :[range]g[lobal]!/{pattern}/[cmd]execute Ex command [cmd] (default: ":p") on the lines

    within [range] where {pattern} does NOT match:so :so[urce] {file}

    read Ex commands from {file}:so :so[urce]! {file}

    read Vim commands from {file}:sl :sl[eep] [sec]

    don't do anything for [sec] secondsgs N gs goto Sleep for N seconds

    ------------------------------------------------------------------------------Q_km Key mapping

    quickref.txt 15

  • :map :ma[p] {lhs} {rhs} map {lhs} to {rhs} in Normal and Visual mode:map! :ma[p]! {lhs} {rhs} map {lhs} to {rhs} in Insert and Command-line

    mode:noremap :no[remap][!] {lhs} {rhs}

    same as ":map", no remapping for this {rhs}:unmap :unm[ap] {lhs} remove the mapping of {lhs} for Normal and

    Visual mode:unmap! :unm[ap]! {lhs} remove the mapping of {lhs} for Insert and

    Command-line mode:map_l :ma[p] [lhs] list mappings (starting with [lhs]) for

    Normal and Visual mode:map_l! :ma[p]! [lhs] list mappings (starting with [lhs]) for

    Insert and Command-line mode:cmap :cmap/:cunmap/:cnoremap

    like ":map!"/":unmap!"/":noremap!" but forCommand-line mode only

    :imap :imap/:iunmap/:inoremaplike ":map!"/":unmap!"/":noremap!" but for

    Insert mode only:nmap :nmap/:nunmap/:nnoremap

    like ":map"/":unmap"/":noremap" but forNormal mode only

    :vmap :vmap/:vunmap/:vnoremaplike ":map"/":unmap"/":noremap" but for

    Visual mode only:omap :omap/:ounmap/:onoremap

    like ":map"/":unmap"/":noremap" but only forwhen an operator is pending

    :mapc :mapc[lear] remove mappings for Normal and Visual mode:mapc :mapc[lear]! remove mappings for Insert and Cmdline mode:imapc :imapc[lear] remove mappings for Insert mode:vmapc :vmapc[lear] remove mappings for Visual mode:omapc :omapc[lear] remove mappings for Operator-pending mode:nmapc :nmapc[lear] remove mappings for Normal mode:cmapc :cmapc[lear] remove mappings for Cmdline mode:mkexrc :mk[exrc][!] [file] write current mappings, abbreviations, and

    settings to [file] (default: ".exrc";use ! to overwrite)

    :mkvimrc :mkv[imrc][!] [file]same as ":mkexrc", but with default ".vimrc"

    :mksession :mks[ession][!] [file]like ":mkvimrc", but store current files,

    windows, etc. too, to be able to continuethis session later

    ------------------------------------------------------------------------------Q_ab Abbreviations

    :abbreviate :ab[breviate] {lhs} {rhs} add abbreviation for {lhs} to {rhs}:abbreviate :ab[breviate] {lhs} show abbr's that start with {lhs}:abbreviate :ab[breviate] show all abbreviations

    quickref.txt 16

  • :unabbreviate :una[bbreviate] {lhs} remove abbreviation for {lhs}:noreabbrev :norea[bbrev] [lhs] [rhs] like ":ab", but don't remap [rhs]:iabbrev :iab/:iunab/:inoreab like ":ab", but only for Insert mode:cabbrev :cab/:cunab/:cnoreab like ":ab", but only for

    Command-line mode:abclear :abc[lear] remove all abbreviations:cabclear :cabc[lear] remove all abbr's for Cmdline mode:iabclear :iabc[lear] remove all abbr's for Insert mode

    ------------------------------------------------------------------------------Q_op Options

    :set :se[t] show all modified options:set :se[t] all show all non-termcap options:set :se[t] termcap show all termcap options:set :se[t] {option} set boolean option (switch it on),

    show string or number option:set :se[t] no{option} reset boolean option (switch it off):set :se[t] inv{option} invert boolean option:set :se[t] {option}={value} set string/number option to {value}:set :se[t] {option}+={value} append {value} to string option, add

    {value} to number option:set :se[t] {option}-={value} remove {value} to string option,

    subtract {value} from number option:set :se[t] {option}? show value of {option}:set :se[t] {option}& reset {option} to its default value

    :setlocal :setl[ocal] like ":set" but set the local valuefor options that have one

    :setglobal :setg[lobal] like ":set" but set the global valueof a local option

    :fix :fix[del] set value of 't_kD' according tovalue of 't_kb'

    :options :opt[ions] open a new window to view and setoptions, grouped by functionality,a one line explanation and links tothe help

    Short explanation of each option: option-list'aleph' 'al' ASCII code of the letter Aleph (Hebrew)'allowrevins' 'ari' allow CTRL-_ in Insert and Command-line mode'altkeymap' 'akm' for default second language (Farsi/Hebrew)'ambiwidth' 'ambw' what to do with Unicode chars of ambiguous width'antialias' 'anti' Mac OS X: use smooth, antialiased fonts'autochdir' 'acd' change directory to the file in the current window'arabic' 'arab' for Arabic as a default second language'arabicshape' 'arshape' do shaping for Arabic characters'autoindent' 'ai' take indent for new line from previous line'autoread' 'ar' autom. read file when changed outside of Vim'autowrite' 'aw' automatically write file if changed'autowriteall' 'awa' as 'autowrite', but works with more commands

    quickref.txt 17

  • 'background' 'bg' "dark" or "light", used for highlight colors'backspace' 'bs' how backspace works at start of line'backup' 'bk' keep backup file after overwriting a file'backupcopy' 'bkc' make backup as a copy, don't rename the file'backupdir' 'bdir' list of directories for the backup file'backupext' 'bex' extension used for the backup file'backupskip' 'bsk' no backup for files that match these patterns'balloondelay' 'bdlay' delay in mS before a balloon may pop up'ballooneval' 'beval' switch on balloon evaluation'balloonexpr' 'bexpr' expression to show in balloon'binary' 'bin' read/write/edit file in binary mode'bioskey' 'biosk' MS-DOS: use bios calls for input characters'bomb' prepend a Byte Order Mark to the file'breakat' 'brk' characters that may cause a line break'browsedir' 'bsdir' which directory to start browsing in'bufhidden' 'bh' what to do when buffer is no longer in window'buflisted' 'bl' whether the buffer shows up in the buffer list'buftype' 'bt' special type of buffer'casemap' 'cmp' specifies how case of letters is changed'cdpath' 'cd' list of directories searched with ":cd"'cedit' key used to open the command-line window'charconvert' 'ccv' expression for character encoding conversion'cindent' 'cin' do C program indenting'cinkeys' 'cink' keys that trigger indent when 'cindent' is set'cinoptions' 'cino' how to do indenting when 'cindent' is set'cinwords' 'cinw' words where 'si' and 'cin' add an indent'clipboard' 'cb' use the clipboard as the unnamed register'cmdheight' 'ch' number of lines to use for the command-line'cmdwinheight' 'cwh' height of the command-line window'colorcolumn' 'cc' columns to highlight'columns' 'co' number of columns in the display'comments' 'com' patterns that can start a comment line'commentstring' 'cms' template for comments; used for fold marker'compatible' 'cp' behave Vi-compatible as much as possible'complete' 'cpt' specify how Insert mode completion works'completefunc' 'cfu' function to be used for Insert mode completion'completeopt' 'cot' options for Insert mode completion'concealcursor' 'cocu' whether concealable text is hidden in cursor line'conceallevel' 'cole' whether concealable text is shown or hidden'confirm' 'cf' ask what to do about unsaved/read-only files'conskey' 'consk' get keys directly from console (MS-DOS only)'copyindent' 'ci' make 'autoindent' use existing indent structure'cpoptions' 'cpo' flags for Vi-compatible behavior'cryptmethod' 'cm' type of encryption to use for file writing'cscopepathcomp' 'cspc' how many components of the path to show'cscopeprg' 'csprg' command to execute cscope'cscopequickfix' 'csqf' use quickfix window for cscope results'cscoperelative' 'csre' Use cscope.out path basename as prefix'cscopetag' 'cst' use cscope for tag commands'cscopetagorder' 'csto' determines ":cstag" search order'cscopeverbose' 'csverb' give messages when adding a cscope database

    quickref.txt 18

  • 'cursorbind' 'crb' move cursor in window as it moves in other windows'cursorcolumn' 'cuc' highlight the screen column of the cursor'cursorline' 'cul' highlight the screen line of the cursor'debug' set to "msg" to see all error messages'define' 'def' pattern to be used to find a macro definition'delcombine' 'deco' delete combining characters on their own'dictionary' 'dict' list of file names used for keyword completion'diff' use diff mode for the current window'diffexpr' 'dex' expression used to obtain a diff file'diffopt' 'dip' options for using diff mode'digraph' 'dg' enable the entering of digraphs in Insert mode'directory' 'dir' list of directory names for the swap file'display' 'dy' list of flags for how to display text'eadirection' 'ead' in which direction 'equalalways' works'edcompatible' 'ed' toggle flags of ":substitute" command'encoding' 'enc' encoding used internally'endofline' 'eol' write for last line in file'equalalways' 'ea' windows are automatically made the same size'equalprg' 'ep' external program to use for "=" command'errorbells' 'eb' ring the bell for error messages'errorfile' 'ef' name of the errorfile for the QuickFix mode'errorformat' 'efm' description of the lines in the error file'esckeys' 'ek' recognize function keys in Insert mode'eventignore' 'ei' autocommand events that are ignored'expandtab' 'et' use spaces when is inserted'exrc' 'ex' read .vimrc and .exrc in the current directory'fileencoding' 'fenc' file encoding for multi-byte text'fileencodings' 'fencs' automatically detected character encodings'fileformat' 'ff' file format used for file I/O'fileformats' 'ffs' automatically detected values for 'fileformat''fileignorecase' 'fic' ignore case when using file names'filetype' 'ft' type of file, used for autocommands'fillchars' 'fcs' characters to use for displaying special items'fkmap' 'fk' Farsi keyboard mapping'foldclose' 'fcl' close a fold when the cursor leaves it'foldcolumn' 'fdc' width of the column used to indicate folds'foldenable' 'fen' set to display all folds open'foldexpr' 'fde' expression used when 'foldmethod' is "expr"'foldignore' 'fdi' ignore lines when 'foldmethod' is "indent"'foldlevel' 'fdl' close folds with a level higher than this'foldlevelstart' 'fdls' 'foldlevel' when starting to edit a file'foldmarker' 'fmr' markers used when 'foldmethod' is "marker"'foldmethod' 'fdm' folding type'foldminlines' 'fml' minimum number of lines for a fold to be closed'foldnestmax' 'fdn' maximum fold depth'foldopen' 'fdo' for which commands a fold will be opened'foldtext' 'fdt' expression used to display for a closed fold'formatlistpat' 'flp' pattern used to recognize a list header'formatoptions' 'fo' how automatic formatting is to be done'formatprg' 'fp' name of external program used with "gq" command'formatexpr' 'fex' expression used with "gq" command

    quickref.txt 19

  • 'fsync' 'fs' whether to invoke fsync() after file write'gdefault' 'gd' the ":substitute" flag 'g' is default on'grepformat' 'gfm' format of 'grepprg' output'grepprg' 'gp' program to use for ":grep"'guicursor' 'gcr' GUI: settings for cursor shape and blinking'guifont' 'gfn' GUI: Name(s) of font(s) to be used'guifontset' 'gfs' GUI: Names of multi-byte fonts to be used'guifontwide' 'gfw' list of font names for double-wide characters'guiheadroom' 'ghr' GUI: pixels room for window decorations'guioptions' 'go' GUI: Which components and options are used'guipty' GUI: try to use a pseudo-tty for ":!" commands'guitablabel' 'gtl' GUI: custom label for a tab page'guitabtooltip' 'gtt' GUI: custom tooltip for a tab page'helpfile' 'hf' full path name of the main help file'helpheight' 'hh' minimum height of a new help window'helplang' 'hlg' preferred help languages'hidden' 'hid' don't unload buffer when it is abandon ed'highlight' 'hl' sets highlighting mode for various occasions'hlsearch' 'hls' highlight matches with last search pattern'history' 'hi' number of command-lines that are remembered'hkmap' 'hk' Hebrew keyboard mapping'hkmapp' 'hkp' phonetic Hebrew keyboard mapping'icon' let Vim set the text of the window icon'iconstring' string to use for the Vim icon text'ignorecase' 'ic' ignore case in search patterns'imactivatekey' 'imak' key that activates the X input method'imactivatefunc' 'imaf' function to enable/disable the X input method'imcmdline' 'imc' use IM when starting to edit a command line'imdisable' 'imd' do not use the IM in any mode'iminsert' 'imi' use :lmap or IM in Insert mode'imsearch' 'ims' use :lmap or IM when typing a search pattern'imstatusfunc' 'imsf' function to obtain X input method status'include' 'inc' pattern to be used to find an include file'includeexpr' 'inex' expression used to process an include line'incsearch' 'is' highlight match while typing search pattern'indentexpr' 'inde' expression used to obtain the indent of a line'indentkeys' 'indk' keys that trigger indenting with 'indentexpr''infercase' 'inf' adjust case of match for keyword completion'insertmode' 'im' start the edit of a file in Insert mode'isfname' 'isf' characters included in file names and pathnames'isident' 'isi' characters included in identifiers'iskeyword' 'isk' characters included in keywords'isprint' 'isp' printable characters'joinspaces' 'js' two spaces after a period with a join command'key' encryption key'keymap' 'kmp' name of a keyboard mapping'keymodel' 'km' enable starting/stopping selection with keys'keywordprg' 'kp' program to use for the "K" command'langmap' 'lmap' alphabetic characters for other language mode'langmenu' 'lm' language to be used for the menus'laststatus' 'ls' tells when last window has status lines

    quickref.txt 20

  • 'lazyredraw' 'lz' don't redraw while executing macros'linebreak' 'lbr' wrap long lines at a blank'lines' number of lines in the display'linespace' 'lsp' number of pixel lines to use between characters'lisp' automatic indenting for Lisp'lispwords' 'lw' words that change how lisp indenting works'list' show and 'listchars' 'lcs' characters for displaying in list mode'loadplugins' 'lpl' load plugin scripts when starting up'macatsui' Mac GUI: use ATSUI text drawing'magic' changes special characters in search patterns'makeef' 'mef' name of the errorfile for ":make"'makeprg' 'mp' program to use for the ":make" command'matchpairs' 'mps' pairs of characters that "%" can match'matchtime' 'mat' tenths of a second to show matching paren'maxcombine' 'mco' maximum nr of combining characters displayed'maxfuncdepth' 'mfd' maximum recursive depth for user functions'maxmapdepth' 'mmd' maximum recursive depth for mapping'maxmem' 'mm' maximum memory (in Kbyte) used for one buffer'maxmempattern' 'mmp' maximum memory (in Kbyte) used for pattern search'maxmemtot' 'mmt' maximum memory (in Kbyte) used for all buffers'menuitems' 'mis' maximum number of items in a menu'mkspellmem' 'msm' memory used before :mkspell compresses the tree'modeline' 'ml' recognize modelines at start or end of file'modelines' 'mls' number of lines checked for modelines'modifiable' 'ma' changes to the text are not possible'modified' 'mod' buffer has been modified'more' pause listings when the whole screen is filled'mouse' enable the use of mouse clicks'mousefocus' 'mousef' keyboard focus follows the mouse'mousehide' 'mh' hide mouse pointer while typing'mousemodel' 'mousem' changes meaning of mouse buttons'mouseshape' 'mouses' shape of the mouse pointer in different modes'mousetime' 'mouset' max time between mouse double-click'mzquantum' 'mzq' the interval between polls for MzScheme threads'nrformats' 'nf' number formats recognized for CTRL-A command'number' 'nu' print the line number in front of each line'numberwidth' 'nuw' number of columns used for the line number'omnifunc' 'ofu' function for filetype-specific completion'opendevice' 'odev' allow reading/writing devices on MS-Windows'operatorfunc' 'opfunc' function to be called for g@ operator'osfiletype' 'oft' no longer supported'paragraphs' 'para' nroff macros that separate paragraphs'paste' allow pasting text'pastetoggle' 'pt' key code that causes 'paste' to toggle'patchexpr' 'pex' expression used to patch a file'patchmode' 'pm' keep the oldest version of a file'path' 'pa' list of directories searched with "gf" et.al.'preserveindent' 'pi' preserve the indent structure when reindenting'previewheight' 'pvh' height of the preview window'previewwindow' 'pvw' identifies the preview window

    quickref.txt 21

  • 'printdevice' 'pdev' name of the printer to be used for :hardcopy'printencoding' 'penc' encoding to be used for printing'printexpr' 'pexpr' expression used to print PostScript for :hardcopy'printfont' 'pfn' name of the font to be used for :hardcopy'printheader' 'pheader' format of the header used for :hardcopy'printmbcharset' 'pmbcs' CJK character set to be used for :hardcopy'printmbfont' 'pmbfn' font names to be used for CJK output of :hardcopy'printoptions' 'popt' controls the format of :hardcopy output'pumheight' 'ph' maximum height of the popup menu'quoteescape' 'qe' escape characters used in a string'readonly' 'ro' disallow writing the buffer'redrawtime' 'rdt' timeout for 'hlsearch' and :match highlighting'regexpengine' 're' default regexp engine to use'relativenumber' 'rnu' show relative line number in front of each line'remap' allow mappings to work recursively'report' threshold for reporting nr. of lines changed'restorescreen' 'rs' Win32: restore screen when exiting'revins' 'ri' inserting characters will work backwards'rightleft' 'rl' window is right-to-left oriented'rightleftcmd' 'rlc' commands for which editing works right-to-left'ruler' 'ru' show cursor line and column in the status line'rulerformat' 'ruf' custom format for the ruler'runtimepath' 'rtp' list of directories used for runtime files'scroll' 'scr' lines to scroll with CTRL-U and CTRL-D'scrollbind' 'scb' scroll in window as other windows scroll'scrolljump' 'sj' minimum number of lines to scroll'scrolloff' 'so' minimum nr. of lines above and below cursor'scrollopt' 'sbo' how 'scrollbind' should behave'sections' 'sect' nroff macros that separate sections'secure' secure mode for reading .vimrc in current dir'selection' 'sel' what type of selection to use'selectmode' 'slm' when to use Select mode instead of Visual mode'sessionoptions' 'ssop' options for :mksession'shell' 'sh' name of shell to use for external commands'shellcmdflag' 'shcf' flag to shell to execute one command'shellpipe' 'sp' string to put output of ":make" in error file'shellquote' 'shq' quote character(s) for around shell command'shellredir' 'srr' string to put output of filter in a temp file'shellslash' 'ssl' use forward slash for shell file names'shelltemp' 'stmp' whether to use a temp file for shell commands'shelltype' 'st' Amiga: influences how to use a shell'shellxescape' 'sxe' characters to escape when 'shellxquote' is ('shellxquote' 'sxq' like 'shellquote', but include redirection'shiftround' 'sr' round indent to multiple of shiftwidth'shiftwidth' 'sw' number of spaces to use for (auto)indent step'shortmess' 'shm' list of flags, reduce length of messages'shortname' 'sn' non-MS-DOS: Filenames assumed to be 8.3 chars'showbreak' 'sbr' string to use at the start of wrapped lines'showcmd' 'sc' show (partial) command in status line'showfulltag' 'sft' show full tag pattern when completing tag'showmatch' 'sm' briefly jump to matching bracket if insert one

    quickref.txt 22

  • 'showmode' 'smd' message on status line to show current mode'showtabline' 'stal' tells when the tab pages line is displayed'sidescroll' 'ss' minimum number of columns to scroll horizontal'sidescrolloff' 'siso' min. nr. of columns to left and right of cursor'smartcase' 'scs' no ignore case when pattern has uppercase'smartindent' 'si' smart autoindenting for C programs'smarttab' 'sta' use 'shiftwidth' when inserting 'softtabstop' 'sts' number of spaces that uses while editing'spell' enable spell checking'spellcapcheck' 'spc' pattern to locate end of a sentence'spellfile' 'spf' files where zg and zw store words'spelllang' 'spl' language(s) to do spell checking for'spellsuggest' 'sps' method(s) used to suggest spelling corrections'splitbelow' 'sb' new window from split is below the current one'splitright' 'spr' new window is put right of the current one'startofline' 'sol' commands move cursor to first non-blank in line'statusline' 'stl' custom format for the status line'suffixes' 'su' suffixes that are ignored with multiple match'suffixesadd' 'sua' suffixes added when searching for a file'swapfile' 'swf' whether to use a swapfile for a buffer'swapsync' 'sws' how to sync the swap file'switchbuf' 'swb' sets behavior when switching to another buffer'synmaxcol' 'smc' maximum column to find syntax items'syntax' 'syn' syntax to be loaded for current buffer'tabstop' 'ts' number of spaces that in file uses'tabline' 'tal' custom format for the console tab pages line'tabpagemax' 'tpm' maximum number of tab pages for -p and "tab all"'tagbsearch' 'tbs' use binary searching in tags files'taglength' 'tl' number of significant characters for a tag'tagrelative' 'tr' file names in tag file are relative'tags' 'tag' list of file names used by the tag command'tagstack' 'tgst' push tags onto the tag stack'term' name of the terminal'termbidi' 'tbidi' terminal takes care of bi-directionality'termencoding' 'tenc' character encoding used by the terminal'terse' shorten some messages'textauto' 'ta' obsolete, use 'fileformats''textmode' 'tx' obsolete, use 'fileformat''textwidth' 'tw' maximum width of text that is being inserted'thesaurus' 'tsr' list of thesaurus files for keyword completion'tildeop' 'top' tilde command "~" behaves like an operator'timeout' 'to' time out on mappings and key codes'timeoutlen' 'tm' time out time in milliseconds'title' let Vim set the title of the window'titlelen' percentage of 'columns' used for window title'titleold' old title, restored when exiting'titlestring' string to use for the Vim window title'toolbar' 'tb' GUI: which items to show in the toolbar'toolbariconsize' 'tbis' size of the toolbar icons (for GTK 2 only)'ttimeout' time out on mappings'ttimeoutlen' 'ttm' time out time for key codes in milliseconds

    quickref.txt 23

  • 'ttybuiltin' 'tbi' use built-in termcap before external termcap'ttyfast' 'tf' indicates a fast terminal connection'ttymouse' 'ttym' type of mouse codes generated'ttyscroll' 'tsl' maximum number of lines for a scroll'ttytype' 'tty' alias for 'term''undodir' 'udir' where to store undo files'undofile' 'udf' save undo information in a file'undolevels' 'ul' maximum number of changes that can be undone'undoreload' 'ur' max nr of lines to save for undo on a buffer reload'updatecount' 'uc' after this many characters flush swap file'updatetime' 'ut' after this many milliseconds flush swap file'verbose' 'vbs' give informative messages'verbosefile' 'vfile' file to write messages in'viewdir' 'vdir' directory where to store files with :mkview'viewoptions' 'vop' specifies what to save for :mkview'viminfo' 'vi' use .viminfo file upon startup and exiting'virtualedit' 've' when to use virtual editing'visualbell' 'vb' use visual bell instead of beeping'warn' warn for shell command when buffer was changed'weirdinvert' 'wiv' for terminals that have weird inversion method'whichwrap' 'ww' allow specified keys to cross line boundaries'wildchar' 'wc' command-line character for wildcard expansion'wildcharm' 'wcm' like 'wildchar' but also works when mapped'wildignore' 'wig' files matching these patterns are not completed'wildignorecase' 'wic' ignore case when completing file names'wildmenu' 'wmnu' use menu for command line completion'wildmode' 'wim' mode for 'wildchar' command-line expansion'wildoptions' 'wop' specifies how command line completion is done'winaltkeys' 'wak' when the windows system handles ALT keys'window' 'wi' nr of lines to scroll for CTRL-F and CTRL-B'winheight' 'wh' minimum number of lines for the current window'winfixheight' 'wfh' keep window height when opening/closing windows'winfixwidth' 'wfw' keep window width when opening/closing windows'winminheight' 'wmh' minimum number of lines for any window'winminwidth' 'wmw' minimal number of columns for any window'winwidth' 'wiw' minimal number of columns for current window'wrap' long lines wrap and continue on the next line'wrapmargin' 'wm' chars from the right where wrapping starts'wrapscan' 'ws' searches wrap around the end of the file'write' writing to a file is allowed'writeany' 'wa' write to file with no need for "!" override'writebackup' 'wb' make a backup before overwriting a file'writedelay' 'wd' delay this many msec for each char (for debug)------------------------------------------------------------------------------Q_ur Undo/Redo commands

    u N u undo last N changesCTRL-R N CTRL-R redo last N undone changesU U restore last changed line

    ------------------------------------------------------------------------------Q_et External commands

    quickref.txt 24

  • :shell :sh[ell] start a shell:! :!{command} execute {command} with a shellK K lookup keyword under the cursor with

    'keywordprg' program (default: "man")------------------------------------------------------------------------------Q_qf Quickfix commands

    :cc :cc [nr] display error [nr] (default is the same again):cnext :cn display the next error:cprevious :cp display the previous error:clist :cl list all errors:cfile :cf read errors from the file 'errorfile':cgetbuffer :cgetb like :cbuffer but don't jump to the first error:cgetfile :cg like :cfile but don't jump to the first error:cgetexpr :cgete like :cexpr but don't jump to the first error:caddfile :caddf add errors from the error file to the current

    quickfix list:caddexpr :cad add errors from an expression to the current

    quickfix list:cbuffer :cb read errors from text in a buffer:cexpr :cex read errors from an expression:cquit :cq quit without writing and return error code (to

    the compiler):make :make [args] start make, read errors, and jump to first

    error:grep :gr[ep] [args] execute 'grepprg' to find matches and jump to

    the first one------------------------------------------------------------------------------Q_vc Various commands

    CTRL-L CTRL-L clear and redraw the screenCTRL-G CTRL-G show current file name (with path) and cursor

    positionga ga show ascii value of character under cursor in

    decimal, hex, and octalg8 g8 for utf-8 encoding: show byte sequence for

    character under cursor in hexg_CTRL-G g CTRL-G show cursor column, line, and character

    positionCTRL-C CTRL-C during searches: Interrupt the searchdos-CTRL-Break CTRL-Break MS-DOS: during searches: Interrupt the search while entering a count: delete last character:version :ve[rsion] show version information:mode :mode N MS-DOS: set screen mode to N (number, C80,

    C4350, etc.):normal :norm[al][!] {commands}

    execute Normal mode commandsQ Q switch to "Ex" mode

    :redir :redir >{file} redirect messages to {file}

    quickref.txt 25

  • :silent :silent[!] {command} execute {command} silently:confirm :confirm {command} quit, write, etc., asking about

    unsaved changes or read-only files:browse :browse {command} open/read/write file, using a

    file selection dialog------------------------------------------------------------------------------Q_ce Command-line editing

    c_ abandon command-line (if 'wildchar' is, type it twice)

    c_CTRL-V CTRL-V {char} insert {char} literallyc_CTRL-V CTRL-V {number} enter decimal value of character (up to

    three digits)c_CTRL-K CTRL-K {char1} {char2}

    enter digraph (See Q_di )c_CTRL-R CTRL-R {0-9a-z"%#:-=}

    insert the contents of a register

    c_ / cursor left/rightc_ / cursor one word left/rightc_CTRL-B CTRL-B/CTRL-E cursor to beginning/end of command-line

    c_ delete the character in front of the cursorc_ delete the character under the cursorc_CTRL-W CTRL-W delete the word in front of the cursorc_CTRL-U CTRL-U remove all characters

    c_ / recall older/newer command-line that startswith current command

    c_ / recall older/newer command-line from history:history :his[tory] show older command-lines

    Context-sensitive completion on the command-line:

    c_wildchar 'wildchar' (default: )do completion on the pattern in front of the

    cursor; if there are multiple matches,beep and show the first one; further'wildchar' will show the next ones

    c_CTRL-D CTRL-D list all names that match the pattern infront of the cursor

    c_CTRL-A CTRL-A insert all names that match pattern in frontof cursor

    c_CTRL-L CTRL-L insert longest common part of names thatmatch pattern

    c_CTRL-N CTRL-N after 'wildchar' with multiple matches: goto next match

    c_CTRL-P CTRL-P after 'wildchar' with multiple matches: goto previous match

    ------------------------------------------------------------------------------

    quickref.txt 26

  • Q_ra Ex ranges

    :range , separates two line numbers:range ; idem, set cursor to the first line number

    before interpreting the second one

    :range {number} an absolute line number:range . the current line:range $ the last line in the file:range % equal to 1,$ (the entire file):range * equal to '

  • ------------------------------------------------------------------------------Q_st Starting Vim

    -vim vim [options] start editing with an empty buffer-file vim [options] {file} .. start editing one or more files-- vim [options] - read file from stdin-tag vim [options] -t {tag} edit the file associated with {tag}-qf vim [options] -q [fname] start editing in QuickFix mode,

    display the first error

    Most useful Vim arguments (for full list see startup-options )

    -gui -g start GUI (also allows other options)

    -+ +[num] put the cursor at line [num] (default: last line)-+c +{command} execute {command} after loading the file-+/ +/{pat} {file} .. put the cursor at the first occurrence of {pat}-v -v Vi mode, start ex in Normal mode-e -e Ex mode, start vim in Ex mode-R -R Read-only mode, implies -n-m -m modifications not allowed (resets 'write' option)-d -d diff mode diff-b -b binary mode-l -l lisp mode-A -A Arabic mode ('arabic' is set)-F -F Farsi mode ('fkmap' and 'rightleft' are set)-H -H Hebrew mode ('hkmap' and 'rightleft' are set)-V -V Verbose, give informative messages-C -C Compatible, set the 'compatible' option-N -N Nocompatible, reset the 'compatible' option-r -r give list of swap files-r -r {file} .. recover aborted edit session-n -n do not create a swap file-o -o [num] open [num] windows (default: one for each file)-f -f GUI: foreground process, don't fork

    Amiga: do not restart Vim to open a window (fore.g., mail)

    -s -s {scriptin} first read commands from the file {scriptin}-w -w {scriptout} write typed chars to file {scriptout} (append)-W -W {scriptout} write typed chars to file {scriptout} (overwrite)-T -T {terminal} set terminal name-d -d {device} Amiga: open {device} to be used as a console-u -u {vimrc} read inits from {vimrc} instead of other inits-U -U {gvimrc} idem, for when starting the GUI-i -i {viminfo} read info from {viminfo} instead of other files--- -- end of options, other arguments are file names--help --help show list of arguments and exit--version --version show version info and exit-- - read file from stdin

    ------------------------------------------------------------------------------Q_ed Editing a file

    quickref.txt 28

  • Without !: Fail if changes have been made to the current buffer.With !: Discard any changes to the current buffer.

    :edit_f :e[dit][!] {file} edit {file}:edit :e[dit][!] reload the current file:enew :ene[w][!] edit a new, unnamed buffer:find :fin[d][!] {file} find {file} in 'path' and edit it

    CTRL-^ N CTRL-^ edit alternate file N (equivalent to ":e #N")gf gf or ]f edit the file whose name is under the cursor:pwd :pwd print the current directory name:cd :cd [path] change the current directory to [path]:cd- :cd - back to previous current directory:file :f[ile] print the current file name and the cursor

    position:file :f[ile] {name} set the current file name to {name}:files :files show alternate file names

    ------------------------------------------------------------------------------Q_fl Using the argument list argument-list

    :args :ar[gs] print the argument list, with the current filein "[]"

    :all :all or :sall open a window for every file in the arg list:wn :wn[ext][!] write file and edit next file:wn :wn[ext][!] {file} write to {file} and edit next file, unless

    {file} exists; With !, overwrite existingfile

    :wN :wN[ext][!] [file] write file and edit previous file

    in current window in new window:argument :argu[ment] N :sar[gument] N edit file N:next :n[ext] :sn[ext] edit next file:next_f :n[ext] {arglist} :sn[ext] {arglist} define new arg list

    and edit first file:Next :N[ext] :sN[ext] edit previous file:first :fir[st] :sfir[st] edit first file:last :la[st] :sla[st] edit last file

    ------------------------------------------------------------------------------Q_wq Writing and quitting

    :w :[range]w[rite][!] write to the current file:w_f :[range]w[rite] {file} write to {file}, unless it already

    exists:w_f :[range]w[rite]! {file} write to {file}. Overwrite an existing

    file:w_a :[range]w[rite][!] >> append to the current file:w_a :[range]w[rite][!] >> {file} append to {file}:w_c :[range]w[rite] !{cmd} execute {cmd} with [range] lines as

    standard input:up :[range]up[date][!] write to current file if modified:wall :wa[ll][!] write all changed buffers

    quickref.txt 29

  • :q :q[uit] quit current buffer, unless changes have beenmade; Exit Vim when there are no othernon-help buffers

    :q :q[uit]! quit current buffer always, discard anychanges. Exit Vim when there are no othernon-help buffers

    :qa :qa[ll] exit Vim, unless changes have been made:qa :qa[ll]! exit Vim always, discard any changes:cq :cq quit without writing and return error code

    :wq :wq[!] write the current file and exit:wq :wq[!] {file} write to {file} and exit:xit :x[it][!] [file] like ":wq" but write only when changes have

    been madeZZ ZZ same as ":x"ZQ ZQ same as ":q!":xall :xa[ll][!] or :wqall[!]

    write all changed buffers and exit

    :stop :st[op][!] suspend Vim or start new shell; if 'aw' optionis set and [!] not given write the buffer

    CTRL-Z CTRL-Z same as ":stop"------------------------------------------------------------------------------Q_ac Automatic Commands

    viminfo-file read registers, marks, history at startup, save when exiting.

    :rviminfo :rv[iminfo] [file] read info from viminfo file [file]:rviminfo :rv[iminfo]! [file] idem, overwrite existing info:wviminfo :wv[iminfo] [file] add info to viminfo file [file]:wviminfo :wv[iminfo]! [file] write info to viminfo file [file]

    modeline Automatic option setting when editing a file

    modeline vim:{set-arg}: .. In the first and last lines of thefile (see 'ml' option), {set-arg} isgiven as an argument to ":set"

    autocommand Automatic execution of commands on certain events.

    :autocmd :au list all autocommands:autocmd :au {event} list all autocommands for {event}:autocmd :au {event} {pat} list all autocommands for {event}

    with {pat}:autocmd :au {event} {pat} {cmd} enter new autocommands for {event}

    with {pat}:autocmd :au! remove all autocommands:autocmd :au! {event} remove all autocommands for {event}:autocmd :au! * {pat} remove all autocommands for {pat}:autocmd :au! {event} {pat} remove all autocommands for {event}

    quickref.txt 30

  • with {pat}:autocmd :au! {event} {pat} {cmd} remove all autocommands for {event}

    with {pat} and enter new one------------------------------------------------------------------------------Q_wi Multi-window commands

    CTRL-W_s CTRL-W s or :split split window into two parts:split_f :split {file} split window and edit {file} in one of

    them:vsplit :vsplit {file} same, but split vertically:vertical :vertical {cmd} make {cmd} split vertically

    :sfind :sf[ind] {file} split window, find {file} in 'path'and edit it

    CTRL-W_] CTRL-W ] split window and jump to tag undercursor

    CTRL-W_f CTRL-W f split window and edit file name underthe cursor

    CTRL-W_^ CTRL-W ^ split window and edit alternate fileCTRL-W_n CTRL-W n or :new create new empty windowCTRL-W_q CTRL-W q or :q[uit] quit editing and close windowCTRL-W_c CTRL-W c or :cl[ose] make buffer hidden and close windowCTRL-W_o CTRL-W o or :on[ly] make current window only one on the

    screen

    CTRL-W_j CTRL-W j move cursor to window belowCTRL-W_k CTRL-W k move cursor to window aboveCTRL-W_CTRL-W CTRL-W CTRL-W move cursor to window below (wrap)CTRL-W_W CTRL-W W move cursor to window above (wrap)CTRL-W_t CTRL-W t move cursor to top windowCTRL-W_b CTRL-W b move cursor to bottom windowCTRL-W_p CTRL-W p move cursor to previous active window

    CTRL-W_r CTRL-W r rotate windows downwardsCTRL-W_R CTRL-W R rotate windows upwardsCTRL-W_x CTRL-W x exchange current window with next one

    CTRL-W_= CTRL-W = make all windows equal heightCTRL-W_- CTRL-W - decrease current window heightCTRL-W_+ CTRL-W + increase current window heightCTRL-W__ CTRL-W _ set current window height (default:

    very high)------------------------------------------------------------------------------Q_bu Buffer list commands

    :buffers :buffers or :files list all known buffer and file names

    :ball :ball or :sball edit all args/buffers:unhide :unhide or :sunhide edit all loaded buffers

    :badd :badd {fname} add file name {fname} to the list

    quickref.txt 31

  • :bunload :bunload[!] [N] unload buffer [N] from memory:bdelete :bdelete[!] [N] unload buffer [N] and delete it from

    the buffer list

    in current window in new window:buffer :[N]buffer [N] :[N]sbuffer [N] to arg/buf N:bnext :[N]bnext [N] :[N]sbnext [N] to Nth next arg/buf:bNext :[N]bNext [N] :[N]sbNext [N] to Nth previous arg/buf:bprevious :[N]bprevious [N] :[N]sbprevious [N] to Nth previous arg/buf:bfirst :bfirst :sbfirst to first arg/buf:blast :blast :sblast to last arg/buf:bmodified :[N]bmod [N] :[N]sbmod [N] to Nth modified buf

    ------------------------------------------------------------------------------Q_sy Syntax Highlighting

    :syn-on :syntax on start using syntax highlighting:syn-off :syntax off stop using syntax highlighting

    :syn-keyword :syntax keyword {group-name} {keyword} ..add a syntax keyword item

    :syn-match :syntax match {group-name} {pattern} ...add syntax match item

    :syn-region :syntax region {group-name} {pattern} ...add syntax region item

    :syn-sync :syntax sync [ccomment | lines {N} | ...]tell syntax how to sync

    :syntax :syntax [list] list current syntax items:syn-clear :syntax clear clear all syntax info

    :highlight :highlight clear clear all highlight info:highlight :highlight {group-name} {key}={arg} ..

    set highlighting for {group-name}

    :filetype :filetype on switch on file type detection, withoutsyntax highlighting

    :filetype :filetype plugin indent onswitch on file type detection, withautomatic indenting and settings

    ------------------------------------------------------------------------------Q_gu GUI commands

    :gui :gui UNIX: start the GUI:gui :gui {fname} .. idem, and edit {fname} ..

    :menu :menu list all menus:menu :menu {mpath} list menus starting with {mpath}:menu :menu {mpath} {rhs} add menu {mpath}, giving {rhs}:menu :menu {pri} {mpath} {rhs}

    idem, with priorities {pri}:menu :menu ToolBar.{name} {rhs}

    add toolbar item, giving {rhs}

    quickref.txt 32

  • :tmenu :tmenu {mpath} {text} add tooltip to menu {mpath}:unmenu :unmenu {mpath} remove menu {mpath}

    ------------------------------------------------------------------------------Q_fo Folding

    'foldmethod' set foldmethod=manual manual foldingset foldmethod=indent folding by indentset foldmethod=expr folding by 'foldexpr'set foldmethod=syntax folding by syntax regionsset foldmethod=marker folding by 'foldmarker'

    zf zf{motion} operator: Define a fold manually:fold :{range}fold define a fold for {range} lineszd zd delete one fold under the cursorzD zD delete all folds under the cursor

    zo zo open one fold under the cursorzO zO open all folds under the cursorzc zc close one fold under the cursorzC zC close all folds under the cursor

    zm zm fold more: decrease 'foldlevel'zM zM close all folds: make 'foldlevel' zerozr zr reduce folding: increase 'foldlevel'zR zR open all folds: make 'foldlevel' max.

    zn zn fold none: reset 'foldenable'zN zN fold normal set 'foldenable'zi zi invert 'foldenable'

    vim:tw=78:ts=8:ft=help:norl:

    quickref.txt 33

  • usr_toc.txt For Vim version 7.4. Last change: 2010 Jul 20

    VIM USER MANUAL - by Bram Moolenaar

    Table Of Contents user-manual

    ==============================================================================Overview

    Getting Startedusr_01.txt About the manualsusr_02.txt The first steps in Vimusr_03.txt Moving aroundusr_04.txt Making small changesusr_05.txt Set your settingsusr_06.txt Using syntax highlightingusr_07.txt Editing more than one fileusr_08.txt Splitting windowsusr_09.txt Using the GUIusr_10.txt Making big changesusr_11.txt Recovering from a crashusr_12.txt Clever tricks

    Editing Effectivelyusr_20.txt Typing command-line commands quicklyusr_21.txt Go away and come backusr_22.txt Finding the file to editusr_23.txt Editing other filesusr_24.txt Inserting quicklyusr_25.txt Editing formatted textusr_26.txt Repeatingusr_27.txt Search commands and patternsusr_28.txt Foldingusr_29.txt Moving through programsusr_30.txt Editing programsusr_31.txt Exploiting the GUIusr_32.txt The undo tree

    Tuning Vimusr_40.txt Make new commandsusr_41.txt Write a Vim scriptusr_42.txt Add new menususr_43.txt Using filetypesusr_44.txt Your own syntax highlightedusr_45.txt Select your language

    Making Vim Runusr_90.txt Installing Vim

    Reference manual

    usr_toc.txt 34

  • reference_toc More detailed information for all commands

    The user manual is available as a single, ready to print HTML and PDF filehere:

    http://vimdoc.sf.net

    ==============================================================================Getting Started

    Read this from start to end to learn the essential commands.

    usr_01.txt About the manuals01.1 Two manuals01.2 Vim installed01.3 Using the Vim tutor01.4 Copyright

    usr_02.txt The first steps in Vim02.1 Running Vim for the First Time02.2 Inserting text02.3 Moving around02.4 Deleting characters02.5 Undo and Redo02.6 Other editing commands02.7 Getting out02.8 Finding help

    usr_03.txt Moving around03.1 Word movement03.2 Moving to the start or end of a line03.3 Moving to a character03.4 Matching a paren03.5 Moving to a specific line03.6 Telling where you are03.7 Scrolling around03.8 Simple searches03.9 Simple search patterns03.10 Using marks

    usr_04.txt Making small changes04.1 Operators and motions04.2 Changing text04.3 Repeating a change04.4 Visual mode04.5 Moving text04.6 Copying text04.7 Using the clipboard04.8 Text objects04.9 Replace mode04.10 Conclusion

    usr_toc.txt 35

  • usr_05.txt Set your settings05.1 The vimrc file05.2 The example vimrc file explained05.3 Simple mappings05.4 Adding a plugin05.5 Adding a help file05.6 The option window05.7 Often used options

    usr_06.txt Using syntax highlighting06.1 Switching it on06.2 No or wrong colors?06.3 Different colors06.4 With colors or without colors06.5 Printing with colors06.6 Further reading

    usr_07.txt Editing more than one file07.1 Edit another file07.2 A list of files07.3 Jumping from file to file07.4 Backup files07.5 Copy text between files07.6 Viewing a file07.7 Changing the file name

    usr_08.txt Splitting windows08.1 Split a window08.2 Split a window on another file08.3 Window size08.4 Vertical splits08.5 Moving windows08.6 Commands for all windows08.7 Viewing differences with vimdiff08.8 Various

    usr_09.txt Using the GUI09.1 Parts of the GUI09.2 Using the mouse09.3 The clipboard09.4 Select mode

    usr_10.txt Making big changes10.1 Record and playback commands10.2 Substitution10.3 Command ranges10.4 The global command10.5 Visual block mode10.6 Reading and writing part of a file10.7 Formatting text10.8 Changing case

    usr_toc.txt 36

  • 10.9 Using an external program

    usr_11.txt Recovering from a crash11.1 Basic recovery11.2 Where is the swap file?11.3 Crashed or not?11.4 Further reading

    usr_12.txt Clever tricks12.1 Replace a word12.2 Change "Last, First" to "First Last"12.3 Sort a list12.4 Reverse line order12.5 Count words12.6 Find a man page12.7 Trim blanks12.8 Find where a word is used

    ==============================================================================Editing Effectively

    Subjects that can be read independently.

    usr_20.txt Typing command-line commands quickly20.1 Command line editing20.2 Command line abbreviations20.3 Command line completion20.4 Command line history20.5 Command line window

    usr_21.txt Go away and come back21.1 Suspend and resume21.2 Executing shell commands21.3 Remembering information; viminfo21.4 Sessions21.5 Views21.6 Modelines

    usr_22.txt Finding the file to edit22.1 The file explorer22.2 The current directory22.3 Finding a file22.4 The buffer list

    usr_23.txt Editing other files23.1 DOS, Mac and Unix files23.2 Files on the internet23.3 Encryption23.4 Binary files23.5 Compressed files

    usr_toc.txt 37

  • usr_24.txt Inserting quickly24.1 Making corrections24.2 Showing matches24.3 Completion24.4 Repeating an insert24.5 Copying from another line24.6 Inserting a register24.7 Abbreviations24.8 Entering special characters24.9 Digraphs24.10 Normal mode commands

    usr_25.txt Editing formatted text25.1 Breaking lines25.2 Aligning text25.3 Indents and tabs25.4 Dealing with long lines25.5 Editing tables

    usr_26.txt Repeating26.1 Repeating with Visual mode26.2 Add and subtract26.3 Making a change in many files26.4 Using Vim from a shell script

    usr_27.txt Search commands and patterns27.1 Ignoring case27.2 Wrapping around the file end27.3 Offsets27.4 Matching multiple times27.5 Alternatives27.6 Character ranges27.7 Character classes27.8 Matching a line break27.9 Examples

    usr_28.txt Folding28.1 What is folding?28.2 Manual folding28.3 Working with folds28.4 Saving and restoring folds28.5 Folding by indent28.6 Folding with markers28.7 Folding by syntax28.8 Folding by expression28.9 Folding unchanged lines28.10 Which fold method to use?

    usr_29.txt Moving through programs29.1 Using tags29.2 The preview window

    usr_toc.txt 38

  • 29.3 Moving through a program29.4 Finding global identifiers29.5 Finding local identifiers

    usr_30.txt Editing programs30.1 Compiling30.2 Indenting C files30.3 Automatic indenting30.4 Other indenting30.5 Tabs and spaces30.6 Formatting comments

    usr_31.txt Exploiting the GUI31.1 The file browser31.2 Confirmation31.3 Menu shortcuts31.4 Vim window position and size31.5 Various

    usr_32.txt The undo tree32.1 Undo up to a file write32.2 Numbering changes32.3 Jumping around the tree32.4 Time travelling

    ==============================================================================Tuning Vim

    Make Vim work as you like it.

    usr_40.txt Make new commands40.1 Key mapping40.2 Defining command-line commands40.3 Autocommands

    usr_41.txt Write a Vim script41.1 Introduction41.2 Variables41.3 Expressions41.4 Conditionals41.5 Executing an expression41.6 Using functions41.7 Defining a function41.8 Lists and Dictionaries41.9 Exceptions41.10 Various remarks41.11 Writing a plugin41.12 Writing a filetype plugin41.13 Writing a compiler plugin41.14 Writing a plugin that loads quickly41.15 Writing library scripts

    usr_toc.txt 39

  • 41.16 Distributing Vim scripts

    usr_42.txt Add new menus42.1 Introduction42.2 Menu commands42.3 Various42.4 Toolbar and popup menus

    usr_43.txt Using filetypes43.1 Plugins for a filetype43.2 Adding a filetype

    usr_44.txt Your own syntax highlighted44.1 Basic syntax commands44.2 Keywords44.3 Matches44.4 Regions44.5 Nested items44.6 Following groups44.7 Other arguments44.8 Clusters44.9 Including another syntax file44.10 Synchronizing44.11 Installing a syntax file44.12 Portable syntax file layout

    usr_45.txt Select your language45.1 Language for Messages45.2 Language for Menus45.3 Using another encoding45.4 Editing files with a different encoding45.5 Entering language text

    ==============================================================================Making Vim Run

    Before you can use Vim.

    usr_90.txt Installing Vim90.1 Unix90.2 MS-Windows90.3 Upgrading90.4 Common installation issues90.5 Uninstalling Vim

    ==============================================================================

    Copyright: see manual-copyright vim:tw=78:ts=8:ft=help:norl:

    usr_toc.txt 40

  • usr_01.txt For Vim version 7.4. Last change: 2010 Nov 03

    VIM USER MANUAL - by Bram Moolenaar

    About the manuals

    This chapter introduces the manuals available with Vim. Read this to know theconditions under which the commands are explained.

    01.1 Two manuals01.2 Vim installed01.3 Using the Vim tutor01.4 Copyright

    Next chapter: usr_02.txt The first steps in VimTable of contents: usr_toc.txt

    ==============================================================================01.1 Two manuals

    The Vim documentation consists of two parts:

    1. The User manualTask oriented explanations, from simple to complex. Reads from start toend like a book.

    2. The Reference manualPrecise description of how everything in Vim works.

    The notation used in these manuals is explained here: notation

    JUMPING AROUND

    The text contains hyperlinks between the two parts, allowing you to quicklyjump between the description of an editing task and a precise explanation ofthe commands and options used for it. Use these two commands:

    Press CTRL-] to jump to a subject under the cursor.Press CTRL-O to jump back (repeat to go further back).

    Many links are in vertical bars, like this: bars . The bars themselves maybe hidden or invisible, see below. An option name, like 'number', a commandin double quotes like ":write" and any other word can also be used as a link.Try it out: Move the cursor to CTRL-] and press CTRL-] on it.

    Other subjects can be found with the ":help" command, see help.txt .

    The bars and stars are usually hidden with the conceal feature. They alsouse hl-Ignore , using the same color for the text as the background. You can

    usr_01.txt 41

  • make them visible with::set conceallevel=0:hi link HelpBar Normal:hi link HelpStar Normal

    ==============================================================================01.2 Vim installed

    Most of the manuals assume that Vim has been properly installed. If youdidn't do that yet, or if Vim doesn't run properly (e.g., files can't be foundor in the GUI the menus do not show up) first read the chapter oninstallation: usr_90.txt .

    not-compatibleThe manuals often assume you are using Vim with Vi-compatibility switchedoff. For most commands this doesn't matter, but sometimes it is important,e.g., for multi-level undo. An easy way to make sure you are using a nicesetup is to copy the example vimrc file. By doing this inside Vim you don'thave to check out where it is located. How to do this depends on the systemyou are using:

    Unix::!cp -i $VIMRUNTIME/vimrc_example.vim ~/.vimrc

    MS-DOS, MS-Windows, OS/2::!copy $VIMRUNTIME/vimrc_example.vim $VIM/_vimrc

    Amiga::!copy $VIMRUNTIME/vimrc_example.vim $VIM/.vimrc

    If the file already exists you probably want to keep it.

    If you start Vim now, the 'compatible' option should be off. You can check itwith this command:

    :set compatible?

    If it responds with "nocompatible" you are doing well. If the response is"compatible" you are in trouble. You will have to find out why the option isstill set. Perhaps the file you wrote above is not found. Use this commandto find out:

    :scriptnames

    If your file is not in the list, check its location and name. If it is in thelist, there must be some other place where the 'compatible' option is switchedback on.

    For more info see vimrc and compatible-default .

    Note:This manual is about using Vim in the normal way. There is analternative called "evim" (easy Vim). This is still Vim, but used ina way that resembles a click-and-type editor like Notepad. It always

    usr_01.txt 42

  • stays in Insert mode, thus it feels very different. It is notexplained in the user manual, since it should be mostly selfexplanatory. See evim-keys for details.

    ==============================================================================01.3 Using the Vim tutor tutor vimtutor

    Instead of reading the text (boring!) you can use the vimtutor to learn yourfirst Vim commands. This is a 30 minute tutorial that teaches the most basicVim functionality hands-on.

    On Unix, if Vim has been properly installed, you can start it from the shell:

    vimtutor

    On MS-Windows you can find it in the Program/Vim menu. Or executevimtutor.bat in the $VIMRUNTIME directory.

    This will make a copy of the tutor file, so that you can edit it withoutthe risk of damaging the original.

    There are a few translated versions of the tutor. To find out if yours isavailable, use the two-letter language code. For French:

    vimtutor fr

    On Unix, if you prefer using the GUI version of Vim, use "gvimtutor" or"vimtutor -g" instead of "vimtutor".

    For OpenVMS, if Vim has been properly installed, you can start vimtutor from aVMS prompt with:

    @VIM:vimtutor

    Optionally add the two-letter language code as above.

    On other systems, you have to do a little work:

    1. Copy the tutor file. You can do this with Vim (it knows where to find it):

    vim -u NONE -c 'e $VIMRUNTIME/tutor/tutor' -c 'w! TUTORCOPY' -c 'q'

    This will write the file "TUTORCOPY" in the current directory. To use atranslated version of the tutor, append the two-letter language code to thefilename. For French:

    vim -u NONE -c 'e $VIMRUNTIME/tutor/tutor.fr' -c 'w! TUTORCOPY' -c 'q'

    2. Edit the copied file with Vim:

    vim -u NONE -c "set nocp" TUTORCOPY

    usr_01.txt 43

  • The extra arguments make sure Vim is started in a good mood.

    3. Delete the copied file when you are finished with it:

    del TUTORCOPY

    ==============================================================================01.4 Copyright manual-copyright

    The Vim user manual and reference manual are Copyright (c) 1988-2003 by BramMoolenaar. This material may be distributed only subject to the terms andconditions set forth in the Open Publication License, v1.0 or later. Thelatest version is presently available at:

    http://www.opencontent.org/openpub/

    People who contribute to the manuals must agree with the above copyrightnotice.

    frombookParts of the user manual come from the book "Vi IMproved - Vim" by SteveOualline (published by New Riders Publishing, ISBN: 0735710015). The OpenPublication License applies to this book. Only selected parts are includedand these have been modified (e.g., by removing the pictures, updating thetext for Vim 6.0 and later, fixing mistakes). The omission of the frombooktag does not mean that the text does not come from the book.

    Many thanks to Steve Oualline and New Riders for creating this book andpublishing it under the OPL! It has been a great help while writing the usermanual. Not only by providing literal text, but also by setting the tone andstyle.

    If you make money through selling the manuals, you are strongly encouraged todonate part of the profit to help AIDS victims in Uganda. See iccf .

    ==============================================================================

    Next chapter: usr_02.txt The first steps in Vim

    Copyright: see manual-copyright vim:tw=78:ts=8:ft=help:norl:

    usr_01.txt 44

  • usr_02.txt For Vim version 7.4. Last change: 2010 Jul 20

    VIM USER MANUAL - by Bram Moolenaar

    The first steps in Vim

    This chapter provides just enough information to edit a file with Vim. Notwell or fast, but you can edit. Take some time to practice with thesecommands, they form the base for what follows.

    02.1 Running Vim for the First Time02.2 Inserting text02.3 Moving around02.4 Deleting characters02.5 Undo and Redo02.6 Other editing commands02.7 Getting out02.8 Finding help

    Next chapter: usr_03.txt Moving aroundPrevious chapter: usr_01.txt About the manuals

    Table of contents: usr_toc.txt

    ==============================================================================02.1 Running Vim for the First Time

    To start Vim, enter this command:

    gvim file.txt

    In UNIX you can type this at any command prompt. If you are running MicrosoftWindows, open an MS-DOS prompt window and enter the command.

    In either case, Vim starts editing a file called file.txt. Because thisis a new file, you get a blank window. This is what your screen will looklike:

    +---------------------------------------+|# ||~ ||~ ||~ ||~ ||"file.txt" [New file] |+---------------------------------------+

    ('#" is the cursor position.)

    The tilde (~) lines indicate lines not in the file. In other words, when Vimruns out of file to display, it displays tilde lines. At the bottom of thescreen, a message line indicates the file is named file.txt and shows that youare creating a new file. The message information is temporary and other

    usr_02.txt 45

  • information overwrites it.

    THE VIM COMMAND

    The gvim command causes the editor to create a new window for editing. If youuse this command:

    vim file.txt

    the editing occurs inside your command window. In other words, if you arerunning inside an xterm, the editor uses your xterm window. If you are usingan MS-DOS command prompt window under Microsoft Windows, the editing occursinside this window. The text in the window will look the same for bothversions, but with gvim you have extra features, like a menu bar. More aboutthat later.

    ==============================================================================02.2 Inserting text

    The Vim editor is a modal editor. That means that the editor behavesdifferently, depending on which mode you are in. The two basic modes arecalled Normal mode and Insert mode. In Normal mode the characters you typeare commands. In Insert mode the characters are inserted as text.

    Since you have just started Vim it will be in Normal mode. To start Insertmode you type the "i" command (i for Insert). Then you can enterthe text. It will be inserted into the file. Do not worry if you makemistakes; you can correct them later. To enter the following programmer'slimerick, this is what you type:

    iA very intelligent turtleFound programming UNIX a hurdle

    After typing "turtle" you press the key to start a new line. Finallyyou press the key to stop Insert mode and go back to Normal mode. Younow have two lines of text in your Vim window:

    +---------------------------------------+|A very intelligent turtle ||Found programming UNIX a hurdle ||~ ||~ || |+---------------------------------------+

    WHAT IS THE MODE?

    To be able to see what mode you are in, type this command:

    :set showmode

    usr_02.txt 46

  • You will notice that when typing the colon Vim moves the cursor to the lastline of the window. That's where you type colon commands (commands that startwith a colon). Finish this command by pressing the key (all commandsthat start with a colon are finished this way).

    Now, if you type the "i" command Vim will display --INSERT-- at the bottomof the window. This indicates you are in Insert mode.

    +---------------------------------------+|A very intelligent turtle ||Found programming UNIX a hurdle ||~ ||~ ||-- INSERT -- |+---------------------------------------+

    If you press to go back to Normal mode the last line will be made blank.

    GETTING OUT OF TROUBLE

    One of the problems for Vim novices is mode confusion, which is caused byforgetting which mode you are in or by accidentally typing a command thatswitches modes. To get back to Normal mode, no matter what mode you are in,press the key. Sometimes you have to press it twice. If Vim beeps backat you, you already are in Normal mode.

    ==============================================================================02.3 Moving around

    After you return to Normal mode, you can move around by using these keys:

    h left hjklj downk upl right

    At first, it may appear that these commands were chosen at random. After all,who ever heard of using l for right? But actually, there is a very goodreason for these choices: M