vim: runtime/doc/repeat.txt annotate

annotate runtime/doc/repeat.txt @ 17375:6f36caf4f702 v8.1.1686

patch 8.1.1686: "*" of "*{" is recognized as multipy operator commit https://github.com/vim/vim/commit/2898ebb44cee62a70a11b44a97bdad8cc00157b1 Author: Bram Moolenaar <Bram@vim.org> Date: Sun Jul 14 13:41:34 2019 +0200 patch 8.1.1686: "*" of "*{" is recognized as multipy operator Problem: "*" of "*{" is recognized as multipy operator. (Yasuhiro Matsumoto) Solution: Check for the "{".

author	Bram Moolenaar <Bram@vim.org>
date	Sun, 14 Jul 2019 13:45:05 +0200
parents	9ccb1ea9b2fc
children	1e5672da6a69

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

Mercurial > vim

annotate runtime/doc/repeat.txt @ 17375:6f36caf4f702 v8.1.1686