Vi: Difference between revisions

From miki
Jump to navigation Jump to search
Line 352: Line 352:
Go to last modification<br/>
Go to last modification<br/>
Go to last position after insert mode was stopped
Go to last position after insert mode was stopped
|}

'''Tags'''

{| class="wikitable" width="100%"
|-
|width="140px"|
{{kb|C-W}}i<br/>
{{kb|C-W}}d<br/>
<nowiki>:tn :tp</nowiki>
|
Split window and jump to declaration<br/>
Split window and jump to definition<br/>
Jump to next / previous matching tag
|}
|}


Revision as of 13:59, 11 July 2010

Related Pages

This page is about the editor vim itself. The other related pages are

  • Vimrc, which is dedicated to vim configuration settings and to the file ~/.vimrc.

External Links

General

Other General

Cheat sheets

Guides & Cheat sheets

Plugins (installed)

Plugins (not yet installed)

Some videos that illustrates those plugins:

Plugins (uninstalled)

Invocation

vi -p file1.txt file2.txt                  # Open each file in a different tab
vi -t tagname                              # Open file and move cursor at specified tag (requires ctags)
view file.txt                              # View file in vim, with syntax highlighting... (read-only)
vimdiff file1.txt file2.txt                # View differences in vim

Simple IDE using plugin TagList

Thanks to plugin TagList, it is possible to turn Vim into a simple yet efficient development IDE. The basic idea is to use the TagList window as a simple file explorer. We use a session file to add all files in the project to the TagList window. Also we define 2 mappings to ease navigation between files.

Here an example session file Session.vim: 

set tags=/win/d/projects/noekeon64/nk_fasttrails/src/tags
TlistAddFiles *.cpp
TlistAddFiles *.h
TrinityToggleTagList
nmap <A-Up> <C-W><Left>[[zz<CR>`"
nmap <A-Down> <C-W><Left>]]zz<CR>`"

Create the tag file: 

ctags -R .

Then start the IDE session with: 

gvim -S

Use the mappings A-Up / A-Down to switch the current window to the next/previous file. These mappings simply move and center the cursor in the TagList window to the previous/next file, open the file and put the cursor to its last position.

Keyboard Shortcuts

Custom Cheatsheets

Cheatsheet & plugin summary

Window management

C-W_
C-Wh
C-Wj
C-Wk
C-Wl
C-Wp
C-Wo

Maximize current window
Move to left window
Move to down window
Move to up window
Move to right window
Move to previous window
Show current window only

Plugin - taglist window (:help taglist-keys)

[[ or BS
]] or Tab
Space
- or zc
+ or zo
* or zR
=
x
CR or LMouse*2
o
P
p
t
u
s

Previous file
Next file
Show tag prototype
Close a fold
Open a fold
Open all folds
Close all folds
Maximimze/Restore window
Jump to tag location
Jump to tag location (new window)
Jump to tag location (in previous window)
tag preview (cursor remains in taglist window)
Jump to tag (new tab)
Update tags
Change the sort order

Plugin - tComment

gcm
gcc
gCm
gCc

Toggle comments motion
Toggle comment for the current line
Comment region motion
Comment the current line

Plugin - Surround

cs"'
cs'<q>
cst"
ds"
ysiw]
yssb or yss)
VmS<p class="a">

Change surrounding " to '
Change surrounding ' to <q>...</q>
Change surrounding tag back to "
Remove the surrounding "
Add [ ] around word (motion iw)
Add ( ) around current line (ignoring leading ws)
Add surrounding tag to selected lines

Plugin - MRU

:MRU
:MRU vim
CR
o
t
v

Open MRU file list
Open MRU file list, only files that contains "vim"
Open file in previous window if possible
Open file in a new window
Open file in a new tab
Open file read-only (view)

Plugin - diffchanges

leaderdcd
leaderdcp

DiffChangesDiffToggle
DiffChangesPatchToggle

Missing shortcuts in cheatsheet

Custom shortcuts are underlined.

Insert Mode

C-xC-f
C-xC-k
:set dictionary=f

Filename completion
Dictionary completion
Set dictionary

Copying

"* "+
"_
:r yx
:%y+

Use system clipboard
Use black hole register
yank range r to register x
yank whole file to clipboard

Marks and motion

`` ²²
`" ²"
`.
`^

Go to position before jump
Go to position at last edit
Go to last modification
Go to last position after insert mode was stopped

Tags

C-Wi
C-Wd
:tn :tp

Split window and jump to declaration
Split window and jump to definition
Jump to next / previous matching tag

Scrolling and multi-windowing

C-w_
C-wgf C-wgF
C-w+ C-w-
C-w> C-w<
:ls[!]
:n b

Maximize current window
New tab + go to file, file & line
Increase / decrease window height n lines
Increase / decrease window width n columns
list buffer [incl. unlisted]
edit buffer n

Ex commands (←)

:wqa
:qa
:e# C-^

Write all changed buffers and quit
Quit and confirm all buffers
Edit alternate buffer, even if has no filename

Miscellaneous

C-d
C-l

List all possible completions
Paste char under cursor

Help

Shortcut Description Custom
C-]
MouseL 		Jump to a subject. On azerty keyboard, do Ctrl-AltGr-] (but doesn't work with Synergy).
The mouse shortcut requires :set mouse=a
C-O
C-T
gMouseR
C-MouseR 		Back.

Splitting windows

Shortcut Description Custom
:{height}split [filename] Split the screen into two windows, optionally opening another file (with the optional specified height)
:new Open a new window on a new empty file
:close Close the current windows
:only Close all other windows
Ctrl-W w Switch between windows
Ctrl-W +
Ctrl-W - 		Increase / decrease window height
{height}Ctrl-W _ Set window height, or maximize it if no height specified
:qa[ll]
:wa[ll] 		Quit all windows / Write change for all windows


Tabs

Shortcut Description Custom
:tab {command} Execute the command in a new tab
:tabonly Close all tabs but the current one
:tabn[ext]
C-PageDown
gt
 Go to the next tab page
:tabp[ext]
C-PageUp
gT
 Go to the previous tab page

Miscellaneous

! If keys HJKLM have been remapped to MHJKL, shortcut below must be changed accordingly !

Shortcut Description Custom
C-[ Same effect as Esc, but a bit faster/easier to type. Works on AZERTY keyboard in Windows, but not on Linux.
C-C Same effect as Esc, but a bit faster/easier to type. Also works on AZERTY keyboard
C-Space Same effect as Esc, but a bit faster/easier to type (see [1]). Yes
C-N Omni and keyword completion. Yes
* Search next occurence of word under cursor (Here more like this...)
# Search previous occurence of word under cursor
gd Search first occurence of current search
^dBS Concatenate current line at the end of previous lines (assuming <BS> does wrap-around. See option whichwrap)
J Concatenate current line with next line
/Up Recall previous search string
:Up Recall previous command
. Redo last command
C-O Switch to normal mode for one command. Use | to execute more commands (see [2])
:C-U Remove the range that Vi may insert when entering normal mode (handy for defining maps - see :help omap-info

Block Indenting

(ref: [3])

Shortcut Description Custom
>> Indent current line
5>> Indent 5 lines
Vjjjj>> Indent 5 lines - same as above but using visual mode
>% (while cursor is on a curly brace) Indent a curly-braces block
]p paste & indent block based on surrounding text
={ (C-indenting) Auto-indent the current block (:help = for more info)
== (C-indenting) Auto-indent the current line
gg=G Intends everything!

Operator & motion

List of available operators: 

c       change
d       delete
y       yank into register (does not change the text)
~       swap case (only if 'tildeop' is set)
g~      swap case
gu      make lowercase
gU      make uppercase
!       filter through an external program
=       filter through 'equalprg' or C-indenting if empty
gq      text formatting
g?      ROT13 encoding
>       shift right
<       shift left
zf      define a fold
g@      call function set with the 'operatorfunc' option

List of frequently used operator motion (see :help operator). They are used like diB (delete inner {} block)

iw inner word aw a word i[ inner [] block a[ a [] block i" inner "" string a" a "" string
iW inner WORD aW a WORD ib i( inner () block ab a( a () block i' inner '' string a' a '' string
is inner sentence as a sentence i< inner <> block a< a <> block i` inner `` string a` a `` string
ip inner paragraph ap a paragraph it inner tag block at a tag block
iB i{ inner {} block aB a{ a {} block

Commands

:s/search/replace/g             Search & replace - current line
:%s/search/replace/g            Search & replace - global scope
:set {option}=70                Set Vim option (here textwidth)
:echo &{option}                 Show value of {option}
:set {option}?                  Show value of {option}

Miscellaneous Tips and Tricks

  • Inserting only a single character (http://vim.wikia.com/wiki/Insert_a_single_character).
  • Macro
    • qq to start recording a macro q. End macro with q again.
    • @q to replay macro, followed by . to replay it again.
  • Visual Block
    • Ctrl-v to start VISUAL BLOCK mode.
    • Shift-I to insert some text at the start of each line of selected block.
  • wrap-around
    • Set option whichwrap or ww that allows specified keys that move the cursor left/right to move to the previous/next line when the cursor is on the first/last character in the line.
    • In Vim, <space> and <backspace> are set to wrap-around by default.
  • Read-only viewer (with syntax highlighting):
$ vi -R sensitive_file
$ view sensitive_file
  • Retab
To convert tabs in current file to current tab settings, use command :retab [4]. For instance to convert tabs into space
:set expandtab
:retab
  • View differences in vim
vimdiff file1.txt file2.txt
  • Interaction with X Clipboard
vim can use the X clipboard if it has been compiled with the clipboard feature (run vim --version and see if you have +clipboard in the output). In that case, yanking to the + register, or simply selecting with the mouse, will actually copy in the X clipboard, hence allowing other applications, or even other instances of vim to exchange text snippets. Also, it will ease the copy-paste of indented text, since in that case, vim will first disable autoindentation before pasting the text (see option paste).
On system like Ubuntu, you need to install an instance of gvim (like package vim-gnome or vim-gtk) to have feature +clipboard turned on (i.e. installing package vim is not enough).
When set mouse=a, use shift-mouse to still use the xterm copy/paste (see mouse-using).
  • set incsearch, moves cursor as search pattern is typed. Ctrl-L to type letter under cursor, Ctrl-R Ctrl-W to type current word.
  • References:
http://vim.wikia.com/wiki/Best_Vim_Tips
  • type :help ctrl<C-D>, to get a list of all ctrl sequence. Type <C-D> in command line for auto-completion.
  • Support 256 colors in gnome-terminal: add set t_Co=256 in ~/.vimrc ([5])
  • Use :make and :grep instead of :!make or :!grep. Then use :cwin or :copen to view the results of either make or grep in a coloured list (from [6]).
  • (from [7]), The :g command is useful to apply a command to all lines matching a search.
" delete all lines matching pattern
:g/pattern/d
" delete all lines *NOT* matching pattern (:v same as :g!)
:g!/pattern/d
:v/pattern/d
  • Write the following in files ~/.vim/after/syntax/c.vim and ~/.vim/after/syntax/cpp.vim (or symlink) to highlight C/++ delimiters (see [8]):
syn match cDelimiter "[&\.!^,;:<>=|+%*-]"
syn match cParenDelimiter "[][(){}]"
hi def link cDelimiter Delimiter
hi def link cParenDelimiter Delimiter

Plugins

SnipMate

C

main  main()
inc   #include <...>
Inc   #include "..."
Def   #ifndef ... #define ... #endif
def   #define
ifdef #ifdef ... #endif
#if   #if ... #endif
once  #ifndef HEADER_H .... # define HEADER_H ... #endif (Header Include-Guard)
if    If (...) { ... } 
el    else { ... } 
t     ... ? ... : ... (tertiary conditional)
do    do ... while ( ... )
wh    while (...) { ... }
for   for (... = 0; ...; ...) { ... }
forr  for (... = ...; ...; ...) { ... }
fun   ... function(...) { ... }
fund  ... function(...;)
td    typedef
st    struct
tds   typedef struct
tde   typedef enum
pr    printf
fpr   fprintf
.     [ ... ]
un    unsigned

CPP

readfile  snippet for reading file
map       std::map<... , ...> map...
vector    std::vector<...> v...
ns        namespace ... { ... }
cl        class { public: ... private: };

To Do

http://www.faqs.org/docs/Linux-HOWTO/C-editing-with-VIM-HOWTO.html
http://www.ibiblio.org/pub/linux/docs/howto/translations/nl/onehtml/Vim-HOWTO-NL.html
Retrieved from "https://miki.immie.org/mediawiki/index.php?title=Vi&oldid=1986"