vim: runtime/doc/repeat.txt annotate

annotate runtime/doc/repeat.txt @ 9187:fb1a19011fbe v7.4.1877

commit https://github.com/vim/vim/commit/01d46e41ba4967ee534db4b94ad642007634841e Author: Bram Moolenaar <Bram@vim.org> Date: Thu Jun 2 19:06:25 2016 +0200 patch 7.4.1877 Problem: No test for invoking "close_cb" when writing to a buffer. Solution: Add using close_cb to a test case.

author	Christian Brabandt <cb@256bit.org>
date	Thu, 02 Jun 2016 19:15:06 +0200
parents	bc38030aec7d
children	64035abb986b

rev	line source
9116 bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb Christian Brabandt <cb@256bit.org> parents: 8876 diff changeset	1 repeat.txt For Vim version 7.4. Last change: 2016 May 24
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4 VIM REFERENCE MANUAL by Bram Moolenaar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	6
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	7 Repeating commands, Vim scripts and debugging repeating
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	8
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	9 Chapter 26 of the user manual introduces repeating \|usr_26.txt\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	10
8748 b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	11 1. Single repeats \|single-repeat\|
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	12 2. Multiple repeats \|multi-repeat\|
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	13 3. Complex repeats \|complex-repeat\|
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	14 4. Using Vim scripts \|using-scripts\|
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	15 5. Using Vim packages \|packages\|
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	16 6. Creating Vim packages \|package-create\|
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	17 7. Debugging scripts \|debug-scripts\|
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	18 8. Profiling \|profiling\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	19
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	20 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	21 1. Single repeats single-repeat
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	22
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	23 .
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	24 . Repeat last change, with count replaced with [count].
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	25 Also repeat a yank command, when the 'y' flag is
22 cc049b00ee70 updated for version 7.0014 vimboss parents: 11 diff changeset	26 included in 'cpoptions'. Does not repeat a
cc049b00ee70 updated for version 7.0014 vimboss parents: 11 diff changeset	27 command-line command.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	28
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	29 Simple changes can be repeated with the "." command. Without a count, the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	30 count of the last change is used. If you enter a count, it will replace the
5663 1dea14d4c738 Update runtime files. Add support for systemverilog. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	31 last one. \|v:count\| and \|v:count1\| will be set.
1dea14d4c738 Update runtime files. Add support for systemverilog. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	32
1dea14d4c738 Update runtime files. Add support for systemverilog. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	33 If the last change included a specification of a numbered register, the
1dea14d4c738 Update runtime files. Add support for systemverilog. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	34 register number will be incremented. See \|redo-register\| for an example how
1dea14d4c738 Update runtime files. Add support for systemverilog. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	35 to use this.
1dea14d4c738 Update runtime files. Add support for systemverilog. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	36
1dea14d4c738 Update runtime files. Add support for systemverilog. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	37 Note that when repeating a command that used a Visual selection, the same SIZE
1dea14d4c738 Update runtime files. Add support for systemverilog. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	38 of area is used, see \|visual-repeat\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	39
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	40 @:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	41 @: Repeat last command-line [count] times.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	42 {not available when compiled without the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	43 \|+cmdline_hist\| feature}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	44
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	45
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	46 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	47 2. Multiple repeats multi-repeat
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	48
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	49 :g :global E147 E148
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	50 :[range]g[lobal]/{pattern}/[cmd]
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	51 Execute the Ex command [cmd] (default ":p") on the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	52 lines within [range] where {pattern} matches.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	53
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	54 :[range]g[lobal]!/{pattern}/[cmd]
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	55 Execute the Ex command [cmd] (default ":p") on the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	56 lines within [range] where {pattern} does NOT match.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	57
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	58 :v :vglobal
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	59 :[range]v[global]/{pattern}/[cmd]
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	60 Same as :g!.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	61
1125 96cd8222a819 updated for version 7.1a vimboss parents: 874 diff changeset	62 Instead of the '/' which surrounds the {pattern}, you can use any other
5239 11cd8d58372e Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5146 diff changeset	63 single byte character, but not an alphabetic character, '\', '"' or '\|'.
1125 96cd8222a819 updated for version 7.1a vimboss parents: 874 diff changeset	64 This is useful if you want to include a '/' in the search pattern or
96cd8222a819 updated for version 7.1a vimboss parents: 874 diff changeset	65 replacement string.
96cd8222a819 updated for version 7.1a vimboss parents: 874 diff changeset	66
96cd8222a819 updated for version 7.1a vimboss parents: 874 diff changeset	67 For the definition of a pattern, see \|pattern\|.
96cd8222a819 updated for version 7.1a vimboss parents: 874 diff changeset	68
6336 4abac79c0b7a Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5763 diff changeset	69 NOTE [cmd] may contain a range; see \|collapse\| and \|edit-paragraph-join\| for
4abac79c0b7a Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5763 diff changeset	70 examples.
4abac79c0b7a Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5763 diff changeset	71
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	72 The global commands work by first scanning through the [range] lines and
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	73 marking each line where a match occurs (for a multi-line pattern, only the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	74 start of the match matters).
8876 47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	75 In a second scan the [cmd] is executed for each marked line, as if the cursor
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	76 was in that line. For ":v" and ":g!" the command is executed for each not
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	77 marked line. If a line is deleted its mark disappears.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	78 The default for [range] is the whole buffer (1,$). Use "CTRL-C" to interrupt
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	79 the command. If an error message is given for a line, the command for that
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	80 line is aborted and the global command continues with the next marked or
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	81 unmarked line.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	82
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	83 To repeat a non-Ex command, you can use the ":normal" command: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	84 :g/pat/normal {commands}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	85 Make sure that {commands} ends with a whole command, otherwise Vim will wait
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	86 for you to type the rest of the command for each match. The screen will not
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	87 have been updated, so you don't know what you are doing. See \|:normal\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	88
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	89 The undo/redo command will undo/redo the whole global command at once.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	90 The previous context mark will only be set once (with "''" you go back to
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	91 where the cursor was before the global command).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	92
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	93 The global command sets both the last used search pattern and the last used
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	94 substitute pattern (this is vi compatible). This makes it easy to globally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	95 replace a string:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	96 :g/pat/s//PAT/g
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	97 This replaces all occurrences of "pat" with "PAT". The same can be done with:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	98 :%s/pat/PAT/g
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	99 Which is two characters shorter!
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	100
1623 53938adac247 updated for version 7.2a vimboss parents: 1270 diff changeset	101 When using "global" in Ex mode, a special case is using ":visual" as a
53938adac247 updated for version 7.2a vimboss parents: 1270 diff changeset	102 command. This will move to a matching line, go to Normal mode to let you
53938adac247 updated for version 7.2a vimboss parents: 1270 diff changeset	103 execute commands there until you use \|Q\| to return to Ex mode. This will be
53938adac247 updated for version 7.2a vimboss parents: 1270 diff changeset	104 repeated for each matching line. While doing this you cannot use ":global".
53938adac247 updated for version 7.2a vimboss parents: 1270 diff changeset	105 To abort this type CTRL-C twice.
168 4d9eabb1396e updated for version 7.0051 vimboss parents: 148 diff changeset	106
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	107 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	108 3. Complex repeats complex-repeat
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	109
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	110 q recording
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	111 q{0-9a-zA-Z"} Record typed characters into register {0-9a-zA-Z"}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	112 (uppercase to append). The 'q' command is disabled
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	113 while executing a register, and it doesn't work inside
7233 9487ea110214 commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845 Christian Brabandt <cb@256bit.org> parents: 6757 diff changeset	114 a mapping and \|:normal\|.
9487ea110214 commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845 Christian Brabandt <cb@256bit.org> parents: 6757 diff changeset	115
9487ea110214 commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845 Christian Brabandt <cb@256bit.org> parents: 6757 diff changeset	116 Note: If the register being used for recording is also
9487ea110214 commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845 Christian Brabandt <cb@256bit.org> parents: 6757 diff changeset	117 used for \|y\| and \|p\| the result is most likely not
9487ea110214 commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845 Christian Brabandt <cb@256bit.org> parents: 6757 diff changeset	118 what is expected, because the put will paste the
9487ea110214 commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845 Christian Brabandt <cb@256bit.org> parents: 6757 diff changeset	119 recorded macro and the yank will overwrite the
9487ea110214 commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845 Christian Brabandt <cb@256bit.org> parents: 6757 diff changeset	120 recorded macro. {Vi: no recording}
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	121
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	122 q Stops recording. (Implementation note: The 'q' that
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	123 stops recording is not stored in the register, unless
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	124 it was the result of a mapping) {Vi: no recording}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	125
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	126 @
3445 2cfb68fa26cd Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2681 diff changeset	127 @{0-9a-z".=+} Execute the contents of register {0-9a-z".=+} [count]
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	128 times. Note that register '%' (name of the current
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	129 file) and '#' (name of the alternate file) cannot be
2681 85c5a72551e2 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	130 used.
85c5a72551e2 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	131 The register is executed like a mapping, that means
85c5a72551e2 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	132 that the difference between 'wildchar' and 'wildcharm'
85c5a72551e2 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	133 applies.
85c5a72551e2 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	134 For "@=" you are prompted to enter an expression. The
85c5a72551e2 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	135 result of the expression is then executed.
85c5a72551e2 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	136 See also \|@:\|. {Vi: only named registers}
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	137
168 4d9eabb1396e updated for version 7.0051 vimboss parents: 148 diff changeset	138 @@ E748
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	139 @@ Repeat the previous @{0-9a-z":*} [count] times.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	140
3445 2cfb68fa26cd Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2681 diff changeset	141 :[addr]{0-9a-z".=+} :@* :star
2cfb68fa26cd Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2681 diff changeset	142 :[addr]@{0-9a-z".=+} Execute the contents of register {0-9a-z".=+} as an Ex
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	143 command. First set cursor at line [addr] (default is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	144 current line). When the last line in the register does
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	145 not have a <CR> it will be added automatically when
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	146 the 'e' flag is present in 'cpoptions'.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	147 Note that the ":*" command is only recognized when the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	148 '*' flag is present in 'cpoptions'. This is NOT the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	149 default when 'nocompatible' is used.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	150 For ":@=" the last used expression is used. The
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	151 result of evaluating the expression is executed as an
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	152 Ex command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	153 Mappings are not recognized in these commands.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	154 {Vi: only in some versions} Future: Will execute the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	155 register for each line in the address range.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	156
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	157 :@:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	158 :[addr]@: Repeat last command-line. First set cursor at line
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	159 [addr] (default is current line). {not in Vi}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	160
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	161 :@@
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	162 :[addr]@@ Repeat the previous :@{0-9a-z"}. First set cursor at
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	163 line [addr] (default is current line). {Vi: only in
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	164 some versions}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	165
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	166 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	167 4. Using Vim scripts using-scripts
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	168
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	169 For writing a Vim script, see chapter 41 of the user manual \|usr_41.txt\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	170
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	171 :so :source load-vim-script
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	172 :so[urce] {file} Read Ex commands from {file}. These are commands that
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	173 start with a ":".
716 8ae24f338cab updated for version 7.0217 vimboss parents: 364 diff changeset	174 Triggers the \|SourcePre\| autocommand.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	175
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	176 :so[urce]! {file} Read Vim commands from {file}. These are commands
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	177 that are executed from Normal mode, like you type
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	178 them.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	179 When used after \|:global\|, \|:argdo\|, \|:windo\|,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	180 \|:bufdo\|, in a loop or when another command follows
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	181 the display won't be updated while executing the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	182 commands.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	183 {not in Vi}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	184
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	185 :ru :runtime
8526 981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	186 :ru[ntime][!] [where] {file} ..
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	187 Read Ex commands from {file} in each directory given
8526 981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	188 by 'runtimepath' and/or 'packpath'. There is no error
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	189 for non-existing files.
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	190
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	191 Example: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	192 :runtime syntax/c.vim
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	193
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	194 < There can be multiple {file} arguments, separated by
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	195 spaces. Each {file} is searched for in the first
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	196 directory from 'runtimepath', then in the second
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	197 directory, etc. Use a backslash to include a space
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	198 inside {file} (although it's better not to use spaces
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	199 in file names, it causes trouble).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	200
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	201 When [!] is included, all found files are sourced.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	202 When it is not included only the first found file is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	203 sourced.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	204
8526 981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	205 When [where] is omitted only 'runtimepath' is used.
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	206 Other values:
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	207 START search under "start" in 'packpath'
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	208 OPT search under "opt" in 'packpath'
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	209 PACK search under "start" and "opt" in
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	210 'packpath'
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	211 ALL first use 'runtimepath', then search
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	212 under "start" and "opt" in 'packpath'
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	213
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	214 When {file} contains wildcards it is expanded to all
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	215 matching files. Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	216 :runtime! plugin/*.vim
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	217 < This is what Vim uses to load the plugin files when
237 73354c21f1e4 updated for version 7.0066 vimboss parents: 177 diff changeset	218 starting up. This similar command: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	219 :runtime plugin/*.vim
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	220 < would source the first file only.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	221
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	222 When 'verbose' is one or higher, there is a message
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	223 when no file could be found.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	224 When 'verbose' is two or higher, there is a message
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	225 about each searched file.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	226 {not in Vi}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	227
8416 1a6527cce675 commit https://github.com/vim/vim/commit/be82c254862e475a582c0717455e1db6bf96b0d0 Christian Brabandt <cb@256bit.org> parents: 8392 diff changeset	228 :pa :packadd E919
8392 1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	229 :pa[ckadd][!] {name} Search for an optional plugin directory in 'packpath'
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	230 and source any plugin files found. The directory must
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	231 match:
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	232 pack/*/opt/{name} ~
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	233 The directory is added to 'runtimepath' if it wasn't
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	234 there yet.
9116 bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb Christian Brabandt <cb@256bit.org> parents: 8876 diff changeset	235 If the directory pack/*/opt/{name}/after exists it is
bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb Christian Brabandt <cb@256bit.org> parents: 8876 diff changeset	236 added at the end of 'runtimepath'.
8303 88207f4b861a commit https://github.com/vim/vim/commit/dae8d21dd291df6a6679a00be64e18bca0156576 Christian Brabandt <cb@256bit.org> parents: 8246 diff changeset	237
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	238 Note that {name} is the directory name, not the name
8876 47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	239 of the .vim file. All the files matching the pattern
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	240 pack//opt/{name}/plugin//.vim ~
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	241 will be sourced. This allows for using subdirectories
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	242 below "plugin", just like with plugins in
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	243 'runtimepath'.
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	244
8392 1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	245 If the filetype detection was not enabled yet (this
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	246 is usually done with a "syntax enable" or "filetype
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	247 on" command in your .vimrc file), this will also look
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	248 for "{name}/ftdetect/*.vim" files.
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	249
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	250 When the optional ! is added no plugin files or
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	251 ftdetect scripts are loaded, only the matching
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	252 directories are added to 'runtimepath'. This is
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	253 useful in your .vimrc. The plugins will then be
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	254 loaded during initialization, see \|load-plugins\|.
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	255
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	256 Also see \|pack-add\|.
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69 Christian Brabandt <cb@256bit.org> parents: 8388 diff changeset	257
8673 ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 8526 diff changeset	258 :packl :packloadall
8876 47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	259 :packl[oadall][!] Load all packages in the "start" directory under each
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	260 entry in 'packpath'.
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	261
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	262 First all the directories found are added to
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	263 'runtimepath', then the plugins found in the
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	264 directories are sourced. This allows for a plugin to
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	265 depend on something of another plugin, e.g. an
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	266 "autoload" directory. See \|packload-two-steps\| for
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	267 how this can be useful.
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	268
8673 ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 8526 diff changeset	269 This is normally done automatically during startup,
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 8526 diff changeset	270 after loading your .vimrc file. With this command it
ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 8526 diff changeset	271 can be done earlier.
8876 47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	272
8526 981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	273 Packages will be loaded only once. After this command
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	274 it won't happen again. When the optional ! is added
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	275 this command will load packages even when done before.
8876 47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	276
8795 aba2d0a01290 commit https://github.com/vim/vim/commit/7db8f6f4f85e5d0526d23107b2a5e2334dc23354 Christian Brabandt <cb@256bit.org> parents: 8748 diff changeset	277 An error only causes sourcing the script where it
8673 ed7251c3e2d3 commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07 Christian Brabandt <cb@256bit.org> parents: 8526 diff changeset	278 happens to be aborted, further plugins will be loaded.
8526 981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	279 See \|packages\|.
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	280
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	281 :scripte[ncoding] [encoding] :scripte :scriptencoding E167
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	282 Specify the character encoding used in the script.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	283 The following lines will be converted from [encoding]
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	284 to the value of the 'encoding' option, if they are
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	285 different. Examples: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	286 scriptencoding iso-8859-5
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	287 scriptencoding cp932
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	288 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	289 When [encoding] is empty, no conversion is done. This
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	290 can be used to restrict conversion to a sequence of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	291 lines: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	292 scriptencoding euc-jp
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	293 ... lines to be converted ...
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	294 scriptencoding
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	295 ... not converted ...
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	296
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	297 < When conversion isn't supported by the system, there
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	298 is no error message and no conversion is done.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	299
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	300 Don't use "ucs-2" or "ucs-4", scripts cannot be in
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	301 these encodings (they would contain NUL bytes).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	302 When a sourced script starts with a BOM (Byte Order
2207 b17bbfa96fa0 Add the settabvar() and gettabvar() functions. Bram Moolenaar <bram@vim.org> parents: 2154 diff changeset	303 Mark) in utf-8 format Vim will recognize it, no need
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	304 to use ":scriptencoding utf-8" then.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	305
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	306 When compiled without the \|+multi_byte\| feature this
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	307 command is ignored.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	308 {not in Vi}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	309
6476 11d78e58a487 Update runtime files. Bram Moolenaar <bram@vim.org> parents: 6336 diff changeset	310 :scr :scriptnames
11d78e58a487 Update runtime files. Bram Moolenaar <bram@vim.org> parents: 6336 diff changeset	311 :scr[iptnames] List all sourced script names, in the order they were
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	312 first sourced. The number is used for the script ID
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	313 \|<SID>\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	314 {not in Vi} {not available when compiled without the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	315 \|+eval\| feature}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	316
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	317 :fini :finish E168
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	318 :fini[sh] Stop sourcing a script. Can only be used in a Vim
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	319 script file. This is a quick way to skip the rest of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	320 the file. If it is used after a \|:try\| but before the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	321 matching \|:finally\| (if present), the commands
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	322 following the ":finally" up to the matching \|:endtry\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	323 are executed first. This process applies to all
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	324 nested ":try"s in the script. The outermost ":endtry"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	325 then stops sourcing the script. {not in Vi}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	326
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	327 All commands and command sequences can be repeated by putting them in a named
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	328 register and then executing it. There are two ways to get the commands in the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	329 register:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	330 - Use the record command "q". You type the commands once, and while they are
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	331 being executed they are stored in a register. Easy, because you can see
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	332 what you are doing. If you make a mistake, "p"ut the register into the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	333 file, edit the command sequence, and then delete it into the register
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	334 again. You can continue recording by appending to the register (use an
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	335 uppercase letter).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	336 - Delete or yank the command sequence into the register.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	337
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	338 Often used command sequences can be put under a function key with the ':map'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	339 command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	340
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	341 An alternative is to put the commands in a file, and execute them with the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	342 ':source!' command. Useful for long command sequences. Can be combined with
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	343 the ':map' command to put complicated commands under a function key.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	344
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	345 The ':source' command reads Ex commands from a file line by line. You will
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	346 have to type any needed keyboard input. The ':source!' command reads from a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	347 script file character by character, interpreting each character as if you
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	348 typed it.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	349
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	350 Example: When you give the ":!ls" command you get the \|hit-enter\| prompt. If
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	351 you ':source' a file with the line "!ls" in it, you will have to type the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	352 <Enter> yourself. But if you ':source!' a file with the line ":!ls" in it,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	353 the next characters from that file are read until a <CR> is found. You will
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	354 not have to type <CR> yourself, unless ":!ls" was the last line in the file.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	355
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	356 It is possible to put ':source[!]' commands in the script file, so you can
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	357 make a top-down hierarchy of script files. The ':source' command can be
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	358 nested as deep as the number of files that can be opened at one time (about
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	359 15). The ':source!' command can be nested up to 15 levels deep.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	360
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	361 You can use the "<sfile>" string (literally, this is not a special key) inside
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	362 of the sourced file, in places where a file name is expected. It will be
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	363 replaced by the file name of the sourced file. For example, if you have a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	364 "other.vimrc" file in the same directory as your ".vimrc" file, you can source
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	365 it from your ".vimrc" file with this command: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	366 :source <sfile>:h/other.vimrc
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	367
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	368 In script files terminal-dependent key codes are represented by
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	369 terminal-independent two character codes. This means that they can be used
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	370 in the same way on different kinds of terminals. The first character of a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	371 key code is 0x80 or 128, shown on the screen as "~@". The second one can be
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	372 found in the list \|key-notation\|. Any of these codes can also be entered
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	373 with CTRL-V followed by the three digit decimal code. This does NOT work for
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	374 the <t_xx> termcap codes, these can only be used in mappings.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	375
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	376 :source_crnl W15
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	377 MS-DOS, Win32 and OS/2: Files that are read with ":source" normally have
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	378 <CR><NL> <EOL>s. These always work. If you are using a file with <NL> <EOL>s
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	379 (for example, a file made on Unix), this will be recognized if 'fileformats'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	380 is not empty and the first line does not end in a <CR>. This fails if the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	381 first line has something like ":map <F1> :help^M", where "^M" is a <CR>. If
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	382 the first line ends in a <CR>, but following ones don't, you will get an error
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	383 message, because the <CR> from the first lines will be lost.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	384
333 18f024844150 updated for version 7.0086 vimboss parents: 237 diff changeset	385 Mac Classic: Files that are read with ":source" normally have <CR> <EOL>s.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	386 These always work. If you are using a file with <NL> <EOL>s (for example, a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	387 file made on Unix), this will be recognized if 'fileformats' is not empty and
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	388 the first line does not end in a <CR>. Be careful not to use a file with <NL>
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	389 linebreaks which has a <CR> in first line.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	390
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	391 On other systems, Vim expects ":source"ed files to end in a <NL>. These
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	392 always work. If you are using a file with <CR><NL> <EOL>s (for example, a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	393 file made on MS-DOS), all lines will have a trailing <CR>. This may cause
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	394 problems for some commands (e.g., mappings). There is no automatic <EOL>
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	395 detection, because it's common to start with a line that defines a mapping
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	396 that ends in a <CR>, which will confuse the automaton.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	397
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	398 line-continuation
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	399 Long lines in a ":source"d Ex command script file can be split by inserting
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	400 a line continuation symbol "\" (backslash) at the start of the next line.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	401 There can be white space before the backslash, which is ignored.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	402
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	403 Example: the lines >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	404 :set comments=sr:/,mb:,el:*/,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	405 \://,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	406 \b:#,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	407 \:%,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	408 \n:>,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	409 \fb:-
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	410 are interpreted as if they were given in one line:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	411 :set comments=sr:/,mb:,el:*/,://,b:#,:%,n:>,fb:-
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	412
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	413 All leading whitespace characters in the line before a backslash are ignored.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	414 Note however that trailing whitespace in the line before it cannot be
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	415 inserted freely; it depends on the position where a command is split up
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	416 whether additional whitespace is allowed or not.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	417
2033 de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1702 diff changeset	418 When a space is required it's best to put it right after the backslash. A
de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1702 diff changeset	419 space at the end of a line is hard to see and may be accidentally deleted. >
de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1702 diff changeset	420 :syn match Comment
de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1702 diff changeset	421 \ "very long regexp"
de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1702 diff changeset	422 \ keepend
de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1702 diff changeset	423
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	424 There is a problem with the ":append" and ":insert" commands: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	425 :1append
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	426 \asdf
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	427 .
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	428 The backslash is seen as a line-continuation symbol, thus this results in the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	429 command: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	430 :1appendasdf
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	431 .
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	432 To avoid this, add the 'C' flag to the 'cpoptions' option: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	433 :set cpo+=C
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	434 :1append
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	435 \asdf
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	436 .
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	437 :set cpo-=C
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	438
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	439 Note that when the commands are inside a function, you need to add the 'C'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	440 flag when defining the function, it is not relevant when executing it. >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	441 :set cpo+=C
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	442 :function Foo()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	443 :1append
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	444 \asdf
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	445 .
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	446 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	447 :set cpo-=C
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	448
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	449 Rationale:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	450 Most programs work with a trailing backslash to indicate line
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	451 continuation. Using this in Vim would cause incompatibility with Vi.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	452 For example for this Vi mapping: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	453 :map xx asdf\
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	454 < Therefore the unusual leading backslash is used.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	455
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	456 ==============================================================================
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	457 5. Using Vim packages packages
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	458
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	459 A Vim package is a directory that contains one or more plugins. The
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	460 advantages over normal plugins:
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	461 - A package can be downloaded as an archive and unpacked in its own directory.
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	462 Thus the files are not mixed with files of other plugins. That makes it
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	463 easy to update and remove.
8376 e448f2a5d45b commit https://github.com/vim/vim/commit/91715873d19a1859c08eeded7848113596e2f2bd Christian Brabandt <cb@256bit.org> parents: 8303 diff changeset	464 - A package can be a git, mercurial, etc. repository. That makes it really
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	465 easy to update.
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	466 - A package can contain multiple plugins that depend on each other.
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	467 - A package can contain plugins that are automatically loaded on startup and
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	468 ones that are only loaded when needed with `:packadd`.
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	469
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	470
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	471 Using a package and loading automatically ~
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	472
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	473 Let's assume your Vim files are in the "~/.vim" directory and you want to add a
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	474 package from a zip archive "/tmp/foopack.zip":
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	475 % mkdir -p ~/.vim/pack/foo
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	476 % cd ~/.vim/pack/foo
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	477 % unzip /tmp/foopack.zip
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	478
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	479 The directory name "foo" is arbitrary, you can pick anything you like.
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	480
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	481 You would now have these files under ~/.vim:
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	482 pack/foo/README.txt
8475 aec051e61547 commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43 Christian Brabandt <cb@256bit.org> parents: 8440 diff changeset	483 pack/foo/start/foobar/plugin/foo.vim
aec051e61547 commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43 Christian Brabandt <cb@256bit.org> parents: 8440 diff changeset	484 pack/foo/start/foobar/syntax/some.vim
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	485 pack/foo/opt/foodebug/plugin/debugger.vim
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	486
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	487 When Vim starts up, after processing your .vimrc, it scans all directories in
8876 47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	488 'packpath' for plugins under the "pack/*/start" directory. First all those
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	489 directories are added to 'runtimepath'. Then all the plugins are loaded.
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	490 See \|packload-two-steps\| for how these two steps can be useful.
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	491
8475 aec051e61547 commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43 Christian Brabandt <cb@256bit.org> parents: 8440 diff changeset	492 In the example Vim will find "pack/foo/start/foobar/plugin/foo.vim" and adds
aec051e61547 commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43 Christian Brabandt <cb@256bit.org> parents: 8440 diff changeset	493 "~/.vim/pack/foo/start/foobar" to 'runtimepath'.
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	494
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	495 If the "foobar" plugin kicks in and sets the 'filetype' to "some", Vim will
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	496 find the syntax/some.vim file, because its directory is in 'runtimepath'.
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	497
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	498 Vim will also load ftdetect files, if there are any.
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	499
8748 b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	500 Note that the files under "pack/foo/opt" are not loaded automatically, only the
8475 aec051e61547 commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43 Christian Brabandt <cb@256bit.org> parents: 8440 diff changeset	501 ones under "pack/foo/start". See \|pack-add\| below for how the "opt" directory
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	502 is used.
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	503
8526 981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	504 Loading packages automatically will not happen if loading plugins is disabled,
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	505 see \|load-plugins\|.
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	506
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	507 To load packages earlier, so that 'runtimepath' gets updated: >
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	508 :packloadall
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	509 This also works when loading plugins is disabled. The automatic loading will
981cc3bef9f3 commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9 Christian Brabandt <cb@256bit.org> parents: 8475 diff changeset	510 only happen once.
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	511
9116 bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb Christian Brabandt <cb@256bit.org> parents: 8876 diff changeset	512 If the package has an "after" directory, that directory is added to the end of
bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb Christian Brabandt <cb@256bit.org> parents: 8876 diff changeset	513 'runtimepath', so that anything there will be loaded later.
bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb Christian Brabandt <cb@256bit.org> parents: 8876 diff changeset	514
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	515
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	516 Using a single plugin and loading it automatically ~
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	517
8388 f5972de59001 commit https://github.com/vim/vim/commit/f3654827368e6204608036353a0360e9e7c21e02 Christian Brabandt <cb@256bit.org> parents: 8376 diff changeset	518 If you don't have a package but a single plugin, you need to create the extra
f5972de59001 commit https://github.com/vim/vim/commit/f3654827368e6204608036353a0360e9e7c21e02 Christian Brabandt <cb@256bit.org> parents: 8376 diff changeset	519 directory level:
8475 aec051e61547 commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43 Christian Brabandt <cb@256bit.org> parents: 8440 diff changeset	520 % mkdir -p ~/.vim/pack/foo/start/foobar
aec051e61547 commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43 Christian Brabandt <cb@256bit.org> parents: 8440 diff changeset	521 % cd ~/.vim/pack/foo/start/foobar
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	522 % unzip /tmp/someplugin.zip
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	523
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	524 You would now have these files:
8475 aec051e61547 commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43 Christian Brabandt <cb@256bit.org> parents: 8440 diff changeset	525 pack/foo/start/foobar/plugin/foo.vim
aec051e61547 commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43 Christian Brabandt <cb@256bit.org> parents: 8440 diff changeset	526 pack/foo/start/foobar/syntax/some.vim
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	527
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	528 From here it works like above.
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	529
8376 e448f2a5d45b commit https://github.com/vim/vim/commit/91715873d19a1859c08eeded7848113596e2f2bd Christian Brabandt <cb@256bit.org> parents: 8303 diff changeset	530
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	531 Optional plugins ~
8388 f5972de59001 commit https://github.com/vim/vim/commit/f3654827368e6204608036353a0360e9e7c21e02 Christian Brabandt <cb@256bit.org> parents: 8376 diff changeset	532 pack-add
f5972de59001 commit https://github.com/vim/vim/commit/f3654827368e6204608036353a0360e9e7c21e02 Christian Brabandt <cb@256bit.org> parents: 8376 diff changeset	533 To load an optional plugin from a pack use the `:packadd` command: >
8440 4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	534 :packadd foodebug
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	535 This searches for "pack/*/opt/foodebug" in 'packpath' and will find
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	536 ~/.vim/pack/foo/opt/foodebug/plugin/debugger.vim and source it.
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Christian Brabandt <cb@256bit.org> parents: 8416 diff changeset	537
8748 b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	538 This could be done if some conditions are met. For example, depending on
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	539 whether Vim supports a feature or a dependency is missing.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	540
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	541 You can also load an optional plugin at startup, by putting this command in
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	542 your \|.vimrc\|: >
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	543 :packadd! foodebug
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	544 The extra "!" is so that the plugin isn't loaded with Vim was started with
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	545 \|--noplugin\|.
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	546
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	547 It is perfectly normal for a package to only have files in the "opt"
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	548 directory. You then need to load each plugin when you want to use it.
95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	549
8748 b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	550
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	551 Where to put what ~
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	552
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	553 Since color schemes, loaded with `:colorscheme`, are found below
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	554 "pack//start" and "pack//opt", you could put them anywhere. We recommend
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	555 you put them below "pack/*/opt", for example
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	556 ".vim/pack/mycolors/opt/dark/colors/very_dark.vim".
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	557
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	558 Filetype plugins should go under "pack/*/start", so that they are always
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	559 found. Unless you have more than one plugin for a file type and want to
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	560 select which one to load with `:packadd`. E.g. depending on the compiler
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	561 version: >
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	562 if foo_compiler_version > 34
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	563 packadd foo_new
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	564 else
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	565 packadd foo_old
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	566 endif
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	567
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	568 The "after" directory is most likely not useful in a package. It's not
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	569 disallowed though.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	570
8182 95d59081580f commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf Christian Brabandt <cb@256bit.org> parents: 8061 diff changeset	571 ==============================================================================
8748 b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	572 6. Creating Vim packages package-create
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	573
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	574 This assumes you write one or more plugins that you distribute as a package.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	575
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	576 If you have two unrelated plugins you would use two packages, so that Vim
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	577 users can chose what they include or not. Or you can decide to use one
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	578 package with optional plugins, and tell the user to add the ones he wants with
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	579 `:packadd`.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	580
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	581 Decide how you want to distribute the package. You can create an archive or
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	582 you could use a repository. An archive can be used by more users, but is a
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	583 bit harder to update to a new version. A repository can usually be kept
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	584 up-to-date easily, but it requires a program like "git" to be available.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	585 You can do both, github can automatically create an archive for a release.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	586
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	587 Your directory layout would be like this:
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	588 start/foobar/plugin/foo.vim " always loaded, defines commands
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	589 start/foobar/plugin/bar.vim " always loaded, defines commands
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	590 start/foobar/autoload/foo.vim " loaded when foo command used
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	591 start/foobar/doc/foo.txt " help for foo.vim
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	592 start/foobar/doc/tags " help tags
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	593 opt/fooextra/plugin/extra.vim " optional plugin, defines commands
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	594 opt/fooextra/autoload/extra.vim " loaded when extra command used
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	595 opt/fooextra/doc/extra.txt " help for extra.vim
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	596 opt/fooextra/doc/tags " help tags
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	597
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	598 This allows for the user to do: >
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	599 mkdir ~/.vim/pack/myfoobar
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	600 cd ~/.vim/pack/myfoobar
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	601 git clone https://github.com/you/foobar.git
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	602
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	603 Here "myfoobar" is a name that the user can choose, the only condition is that
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	604 it differs from other packages.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	605
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	606 In your documentation you explain what the plugins do, and tell the user how
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	607 to load the optional plugin: >
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	608 :packadd! fooextra
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	609
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	610 You could add this packadd command in one of your plugins, to be executed when
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	611 the optional plugin is needed.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	612
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	613 Run the `:helptags` command to generate the doc/tags file. Including this
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	614 generated file in the package means that the user can drop the package in his
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	615 pack directory and the help command works right away. Don't forget to re-run
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	616 the command after changing the plugin help: >
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	617 :helptags path/start/foobar/doc
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	618 :helptags path/opt/fooextra/doc
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	619
8876 47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	620
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	621 Dependencies between plugins ~
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	622 packload-two-steps
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	623 Suppose you have a two plugins that depend on the same functionality. You can
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	624 put the common functionality in an autoload directory, so that it will be
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	625 found automatically. Your package would have these files:
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	626
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	627 pack/foo/start/one/plugin/one.vim >
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	628 call foolib#getit()
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	629 < pack/foo/start/two/plugin/two.vim >
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	630 call foolib#getit()
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	631 < pack/foo/start/lib/autoload/foolib.vim >
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	632 func foolib#getit()
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	633
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	634 This works, because loading packages will first add all found directories to
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	635 'runtimepath' before sourcing the plugins.
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Christian Brabandt <cb@256bit.org> parents: 8795 diff changeset	636
8748 b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	637 ==============================================================================
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	638 7. Debugging scripts debug-scripts
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	639
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	640 Besides the obvious messages that you can add to your scripts to find out what
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	641 they are doing, Vim offers a debug mode. This allows you to step through a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	642 sourced file or user function and set breakpoints.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	643
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	644 NOTE: The debugging mode is far from perfect. Debugging will have side
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	645 effects on how Vim works. You cannot use it to debug everything. For
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	646 example, the display is messed up by the debugging messages.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	647 {Vi does not have a debug mode}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	648
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	649 An alternative to debug mode is setting the 'verbose' option. With a bigger
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	650 number it will give more verbose messages about what Vim is doing.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	651
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	652
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	653 STARTING DEBUG MODE debug-mode
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	654
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	655 To enter debugging mode use one of these methods:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	656 1. Start Vim with the \|-D\| argument: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	657 vim -D file.txt
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	658 < Debugging will start as soon as the first vimrc file is sourced. This is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	659 useful to find out what is happening when Vim is starting up. A side
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	660 effect is that Vim will switch the terminal mode before initialisations
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	661 have finished, with unpredictable results.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	662 For a GUI-only version (Windows, Macintosh) the debugging will start as
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	663 soon as the GUI window has been opened. To make this happen early, add a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	664 ":gui" command in the vimrc file.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	665 :debug
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	666 2. Run a command with ":debug" prepended. Debugging will only be done while
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	667 this command executes. Useful for debugging a specific script or user
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	668 function. And for scripts and functions used by autocommands. Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	669 :debug edit test.txt.gz
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	670
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	671 3. Set a breakpoint in a sourced file or user function. You could do this in
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	672 the command line: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	673 vim -c "breakadd file */explorer.vim" .
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	674 < This will run Vim and stop in the first line of the "explorer.vim" script.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	675 Breakpoints can also be set while in debugging mode.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	676
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	677 In debugging mode every executed command is displayed before it is executed.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	678 Comment lines, empty lines and lines that are not executed are skipped. When
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	679 a line contains two commands, separated by "\|", each command will be displayed
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	680 separately.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	681
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	682
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	683 DEBUG MODE
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	684
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	685 Once in debugging mode, the usual Ex commands can be used. For example, to
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	686 inspect the value of a variable: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	687 echo idx
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	688 When inside a user function, this will print the value of the local variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	689 "idx". Prepend "g:" to get the value of a global variable: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	690 echo g:idx
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	691 All commands are executed in the context of the current function or script.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	692 You can also set options, for example setting or resetting 'verbose' will show
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	693 what happens, but you might want to set it just before executing the lines you
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	694 are interested in: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	695 :set verbose=20
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	696
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	697 Commands that require updating the screen should be avoided, because their
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	698 effect won't be noticed until after leaving debug mode. For example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	699 :help
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	700 won't be very helpful.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	701
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	702 There is a separate command-line history for debug mode.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	703
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	704 The line number for a function line is relative to the start of the function.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	705 If you have trouble figuring out where you are, edit the file that defines
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	706 the function in another Vim, search for the start of the function and do
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	707 "99j". Replace "99" with the line number.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	708
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	709 Additionally, these commands can be used:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	710 >cont
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	711 cont Continue execution until the next breakpoint is hit.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	712 >quit
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	713 quit Abort execution. This is like using CTRL-C, some
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	714 things might still be executed, doesn't abort
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	715 everything. Still stops at the next breakpoint.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	716 >next
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	717 next Execute the command and come back to debug mode when
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	718 it's finished. This steps over user function calls
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	719 and sourced files.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	720 >step
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	721 step Execute the command and come back to debug mode for
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	722 the next command. This steps into called user
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	723 functions and sourced files.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	724 >interrupt
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	725 interrupt This is like using CTRL-C, but unlike ">quit" comes
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	726 back to debug mode for the next command that is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	727 executed. Useful for testing \|:finally\| and \|:catch\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	728 on interrupt exceptions.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	729 >finish
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	730 finish Finish the current script or user function and come
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	731 back to debug mode for the command after the one that
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	732 sourced or called it.
7605 8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	733 >bt
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	734 >backtrace
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	735 >where
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	736 backtrace Show the call stacktrace for current debugging session.
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	737 bt
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	738 where
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	739 >frame
8061 abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75 Christian Brabandt <cb@256bit.org> parents: 7605 diff changeset	740 frame N Goes to N backtrace level. + and - signs make movement
7605 8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	741 relative. E.g., ":frame +3" goes three frames up.
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	742 >up
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	743 up Goes one level up from call stacktrace.
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	744 >down
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	745 down Goes one level down from call stacktrace.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	746
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	747 About the additional commands in debug mode:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	748 - There is no command-line completion for them, you get the completion for the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	749 normal Ex commands only.
8303 88207f4b861a commit https://github.com/vim/vim/commit/dae8d21dd291df6a6679a00be64e18bca0156576 Christian Brabandt <cb@256bit.org> parents: 8246 diff changeset	750 - You can shorten them, up to a single character, unless more than one command
7605 8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	751 starts with the same letter. "f" stands for "finish", use "fr" for "frame".
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	752 - Hitting <CR> will repeat the previous one. When doing another command, this
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	753 is reset (because it's not clear what you want to repeat).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	754 - When you want to use the Ex command with the same name, prepend a colon:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	755 ":cont", ":next", ":finish" (or shorter).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	756
7605 8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	757 The backtrace shows the hierarchy of function calls, e.g.:
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	758 >bt ~
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	759 3 function One[3] ~
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	760 2 Two[3] ~
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	761 ->1 Three[3] ~
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	762 0 Four ~
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	763 line 1: let four = 4 ~
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	764
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	765 The "->" points to the current frame. Use "up", "down" and "frame N" to
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	766 select another frame.
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	767
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	768 In the current frame you can evaluate the local function variables. There is
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	769 no way to see the command at the current line yet.
8fc60af6dbf5 commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc Christian Brabandt <cb@256bit.org> parents: 7233 diff changeset	770
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	771
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	772 DEFINING BREAKPOINTS
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	773 :breaka :breakadd
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	774 :breaka[dd] func [lnum] {name}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	775 Set a breakpoint in a function. Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	776 :breakadd func Explore
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	777 < Doesn't check for a valid function name, thus the breakpoint
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	778 can be set before the function is defined.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	779
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	780 :breaka[dd] file [lnum] {name}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	781 Set a breakpoint in a sourced file. Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	782 :breakadd file 43 .vimrc
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	783
10 4e2284e71352 updated for version 7.0002 vimboss parents: 7 diff changeset	784 :breaka[dd] here
4e2284e71352 updated for version 7.0002 vimboss parents: 7 diff changeset	785 Set a breakpoint in the current line of the current file.
4e2284e71352 updated for version 7.0002 vimboss parents: 7 diff changeset	786 Like doing: >
4e2284e71352 updated for version 7.0002 vimboss parents: 7 diff changeset	787 :breakadd file <cursor-line> <current-file>
4e2284e71352 updated for version 7.0002 vimboss parents: 7 diff changeset	788 < Note that this only works for commands that are executed when
4e2284e71352 updated for version 7.0002 vimboss parents: 7 diff changeset	789 sourcing the file, not for a function defined in that file.
4e2284e71352 updated for version 7.0002 vimboss parents: 7 diff changeset	790
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	791 The [lnum] is the line number of the breakpoint. Vim will stop at or after
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	792 this line. When omitted line 1 is used.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	793
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	794 :debug-name
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	795 {name} is a pattern that is matched with the file or function name. The
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	796 pattern is like what is used for autocommands. There must be a full match (as
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	797 if the pattern starts with "^" and ends in "$"). A "*" matches any sequence
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	798 of characters. 'ignorecase' is not used, but "\c" can be used in the pattern
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	799 to ignore case \|/\c\|. Don't include the () for the function name!
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	800
11 4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	801 The match for sourced scripts is done against the full file name. If no path
4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	802 is specified the current directory is used. Examples: >
4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	803 breakadd file explorer.vim
4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	804 matches "explorer.vim" in the current directory. >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	805 breakadd file *explorer.vim
11 4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	806 matches ".../plugin/explorer.vim", ".../plugin/iexplorer.vim", etc. >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	807 breakadd file */explorer.vim
11 4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	808 matches ".../plugin/explorer.vim" and "explorer.vim" in any other directory.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	809
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	810 The match for functions is done against the name as it's shown in the output
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	811 of ":function". For local functions this means that something like "<SNR>99_"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	812 is prepended.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	813
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 22 diff changeset	814 Note that functions are first loaded and later executed. When they are loaded
72aefd4c1e0d updated for version 7.0046 vimboss parents: 22 diff changeset	815 the "file" breakpoints are checked, when they are executed the "func"
72aefd4c1e0d updated for version 7.0046 vimboss parents: 22 diff changeset	816 breakpoints.
72aefd4c1e0d updated for version 7.0046 vimboss parents: 22 diff changeset	817
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	818
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	819 DELETING BREAKPOINTS
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	820 :breakd :breakdel E161
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	821 :breakd[el] {nr}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	822 Delete breakpoint {nr}. Use \|:breaklist\| to see the number of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	823 each breakpoint.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	824
359 6c62b9b939bd updated for version 7.0093 vimboss parents: 333 diff changeset	825 :breakd[el] *
6c62b9b939bd updated for version 7.0093 vimboss parents: 333 diff changeset	826 Delete all breakpoints.
6c62b9b939bd updated for version 7.0093 vimboss parents: 333 diff changeset	827
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	828 :breakd[el] func [lnum] {name}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	829 Delete a breakpoint in a function.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	830
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	831 :breakd[el] file [lnum] {name}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	832 Delete a breakpoint in a sourced file.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	833
10 4e2284e71352 updated for version 7.0002 vimboss parents: 7 diff changeset	834 :breakd[el] here
4e2284e71352 updated for version 7.0002 vimboss parents: 7 diff changeset	835 Delete a breakpoint at the current line of the current file.
4e2284e71352 updated for version 7.0002 vimboss parents: 7 diff changeset	836
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	837 When [lnum] is omitted, the first breakpoint in the function or file is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	838 deleted.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	839 The {name} must be exactly the same as what was typed for the ":breakadd"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	840 command. "explorer", "explorer.vim" and "explorer*" are different.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	841
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	842
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	843 LISTING BREAKPOINTS
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	844 :breakl :breaklist
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	845 :breakl[ist]
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	846 List all breakpoints.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	847
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	848
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	849 OBSCURE
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	850
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	851 :debugg :debuggreedy
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	852 :debugg[reedy]
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	853 Read debug mode commands from the normal input stream, instead
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	854 of getting them directly from the user. Only useful for test
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	855 scripts. Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	856 echo 'q^Mq' \| vim -e -s -c debuggreedy -c 'breakadd file script.vim' -S script.vim
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	857
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	858 :0debugg[reedy]
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	859 Undo ":debuggreedy": get debug mode commands directly from the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	860 user, don't use typeahead for debug commands.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	861
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	862 ==============================================================================
8748 b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82 Christian Brabandt <cb@256bit.org> parents: 8673 diff changeset	863 8. Profiling profile profiling
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	864
2283 7e1bd501306d Mainly documentation updates. Bram Moolenaar <bram@vim.org> parents: 2207 diff changeset	865 Profiling means that Vim measures the time that is spent on executing
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	866 functions and/or scripts. The \|+profile\| feature is required for this.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	867 It is only included when Vim was compiled with "huge" features.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	868 {Vi does not have profiling}
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	869
794 f19994020dad updated for version 7.0231 vimboss parents: 790 diff changeset	870 You can also use the \|reltime()\| function to measure time. This only requires
f19994020dad updated for version 7.0231 vimboss parents: 790 diff changeset	871 the \|+reltime\| feature, which is present more often.
f19994020dad updated for version 7.0231 vimboss parents: 790 diff changeset	872
5244 eb7ce2918a03 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5239 diff changeset	873 For profiling syntax highlighting see \|:syntime\|.
eb7ce2918a03 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5239 diff changeset	874
5763 c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5663 diff changeset	875 For example, to profile the one_script.vim script file: >
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5663 diff changeset	876 :profile start /tmp/one_script_profile
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5663 diff changeset	877 :profile file one_script.vim
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5663 diff changeset	878 :source one_script.vim
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5663 diff changeset	879 :exit
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5663 diff changeset	880
5244 eb7ce2918a03 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5239 diff changeset	881
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	882 :prof[ile] start {fname} :prof :profile E750
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	883 Start profiling, write the output in {fname} upon exit.
6757 49db2b239564 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 6476 diff changeset	884 "~/" and environment variables in {fname} will be expanded.
790 c8680debe1cc updated for version 7.0230 vimboss parents: 716 diff changeset	885 If {fname} already exists it will be silently overwritten.
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	886 The variable \|v:profiling\| is set to one.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	887
790 c8680debe1cc updated for version 7.0230 vimboss parents: 716 diff changeset	888 :prof[ile] pause
c8680debe1cc updated for version 7.0230 vimboss parents: 716 diff changeset	889 Don't profile until the following ":profile continue". Can be
c8680debe1cc updated for version 7.0230 vimboss parents: 716 diff changeset	890 used when doing something that should not be counted (e.g., an
c8680debe1cc updated for version 7.0230 vimboss parents: 716 diff changeset	891 external command). Does not nest.
c8680debe1cc updated for version 7.0230 vimboss parents: 716 diff changeset	892
c8680debe1cc updated for version 7.0230 vimboss parents: 716 diff changeset	893 :prof[ile] continue
c8680debe1cc updated for version 7.0230 vimboss parents: 716 diff changeset	894 Continue profiling after ":profile pause".
c8680debe1cc updated for version 7.0230 vimboss parents: 716 diff changeset	895
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	896 :prof[ile] func {pattern}
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	897 Profile function that matches the pattern {pattern}.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	898 See \|:debug-name\| for how {pattern} is used.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	899
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	900 :prof[ile][!] file {pattern}
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	901 Profile script file that matches the pattern {pattern}.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	902 See \|:debug-name\| for how {pattern} is used.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	903 This only profiles the script itself, not the functions
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	904 defined in it.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	905 When the [!] is added then all functions defined in the script
5763 c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5663 diff changeset	906 will also be profiled.
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5663 diff changeset	907 Note that profiling only starts when the script is loaded
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5663 diff changeset	908 after this command. A :profile command in the script itself
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5663 diff changeset	909 won't work.
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	910
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	911
364 5332dd13733c updated for version 7.0094 vimboss parents: 359 diff changeset	912 :profd[el] ... :profd :profdel
5332dd13733c updated for version 7.0094 vimboss parents: 359 diff changeset	913 Stop profiling for the arguments specified. See \|:breakdel\|
5332dd13733c updated for version 7.0094 vimboss parents: 359 diff changeset	914 for the arguments.
5332dd13733c updated for version 7.0094 vimboss parents: 359 diff changeset	915
5332dd13733c updated for version 7.0094 vimboss parents: 359 diff changeset	916
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	917 You must always start with a ":profile start fname" command. The resulting
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	918 file is written when Vim exits. Here is an example of the output, with line
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	919 numbers prepended for the explanation:
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	920
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	921 1 FUNCTION Test2() ~
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	922 2 Called 1 time ~
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	923 3 Total time: 0.155251 ~
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	924 4 Self time: 0.002006 ~
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	925 5 ~
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	926 6 count total (s) self (s) ~
856 8cd729851562 updated for version 7.0g vimboss parents: 842 diff changeset	927 7 9 0.000096 for i in range(8) ~
8cd729851562 updated for version 7.0g vimboss parents: 842 diff changeset	928 8 8 0.153655 0.000410 call Test3() ~
8cd729851562 updated for version 7.0g vimboss parents: 842 diff changeset	929 9 8 0.000070 endfor ~
8cd729851562 updated for version 7.0g vimboss parents: 842 diff changeset	930 10 " Ask a question ~
8cd729851562 updated for version 7.0g vimboss parents: 842 diff changeset	931 11 1 0.001341 echo input("give me an answer: ") ~
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	932
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	933 The header (lines 1-4) gives the time for the whole function. The "Total"
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	934 time is the time passed while the function was executing. The "Self" time is
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	935 the "Total" time reduced by time spent in:
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	936 - other user defined functions
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	937 - sourced scripts
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	938 - executed autocommands
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	939 - external (shell) commands
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	940
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	941 Lines 7-11 show the time spent in each executed line. Lines that are not
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	942 executed do not count. Thus a comment line is never counted.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	943
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	944 The Count column shows how many times a line was executed. Note that the
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	945 "for" command in line 7 is executed one more time as the following lines.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	946 That is because the line is also executed to detect the end of the loop.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	947
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	948 The time Vim spends waiting for user input isn't counted at all. Thus how
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	949 long you take to respond to the input() prompt is irrelevant.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	950
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	951 Profiling should give a good indication of where time is spent, but keep in
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	952 mind there are various things that may clobber the results:
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	953
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	954 - The accuracy of the time measured depends on the gettimeofday() system
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	955 function. It may only be as accurate as 1/100 second, even though the times
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	956 are displayed in micro seconds.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	957
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	958 - Real elapsed time is measured, if other processes are busy they may cause
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	959 delays at unpredictable moments. You may want to run the profiling several
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	960 times and use the lowest results.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	961
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	962 - If you have several commands in one line you only get one time. Split the
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	963 line to see the time for the individual commands.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	964
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	965 - The time of the lines added up is mostly less than the time of the whole
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	966 function. There is some overhead in between.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	967
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	968 - Functions that are deleted before Vim exits will not produce profiling
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	969 information. You can check the \|v:profiling\| variable if needed: >
856 8cd729851562 updated for version 7.0g vimboss parents: 842 diff changeset	970 :if !v:profiling
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	971 : delfunc MyFunc
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	972 :endif
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	973 <
177 84c21eb4fc40 updated for version 7.0054 vimboss parents: 170 diff changeset	974 - Profiling may give weird results on multi-processor systems, when sleep
84c21eb4fc40 updated for version 7.0054 vimboss parents: 170 diff changeset	975 mode kicks in or the processor frequency is reduced to save power.
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	976
1125 96cd8222a819 updated for version 7.1a vimboss parents: 874 diff changeset	977 - The "self" time is wrong when a function is used recursively.
96cd8222a819 updated for version 7.1a vimboss parents: 874 diff changeset	978
96cd8222a819 updated for version 7.1a vimboss parents: 874 diff changeset	979
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	980 vim:tw=78:ts=8:ft=help:norl:

Mercurial > vim

annotate runtime/doc/repeat.txt @ 9187:fb1a19011fbe v7.4.1877