annotate runtime/doc/editing.txt @ 16005:ce8f501c9ce2 v8.1.1008

patch 8.1.1008: MS-Windows: HAVE_STDINT_H only defined for non-debug version commit https://github.com/vim/vim/commit/0251d2d8114f2faae0a5822870af2c6118bfbc15 Author: Bram Moolenaar <Bram@vim.org> Date: Thu Mar 14 21:37:19 2019 +0100 patch 8.1.1008: MS-Windows: HAVE_STDINT_H only defined for non-debug version Problem: MS-Windows: HAVE_STDINT_H only defined for non-debug version. Solution: Move definition of HAVE_STDINT_H up. (Taro Muraoka, closes https://github.com/vim/vim/issues/4109)
author Bram Moolenaar <Bram@vim.org>
date Thu, 14 Mar 2019 21:45:14 +0100
parents 8b334e4cb97f
children 8c3a1bd270bb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14421
diff changeset
1 *editing.txt* For Vim version 8.1. Last change: 2018 Dec 16
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 Editing files *edit-files*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 1. Introduction |edit-intro|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 2. Editing a file |edit-a-file|
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
11 3. The argument list |argument-list|
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
12 4. Writing |writing|
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
13 5. Writing and quitting |write-quit|
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
14 6. Dialogs |edit-dialogs|
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
15 7. The current directory |current-directory|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 8. Editing binary files |edit-binary|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 9. Encryption |encryption|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 10. Timestamps |timestamps|
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
19 11. File Searching |file-searching|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 1. Introduction *edit-intro*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 Editing a file with Vim means:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
26 1. reading the file into a buffer
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 2. changing the buffer with editor commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 3. writing the buffer into a file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 *current-file*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 As long as you don't write the buffer, the original file remains unchanged.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 If you start editing a file (read a file into the buffer), the file name is
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 14
diff changeset
33 remembered as the "current file name". This is also known as the name of the
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
34 current buffer. It can be used with "%" on the command line |:_%|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 *alternate-file*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 If there already was a current file name, then that one becomes the alternate
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
38 file name. It can be used with "#" on the command line |:_#| and you can use
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
39 the |CTRL-^| command to toggle between the current and the alternate file.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
40 However, the alternate file name is not changed when |:keepalt| is used.
5510
d7d7bac1a163 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
41 An alternate file name is remembered for each window.
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 14
diff changeset
42
cc049b00ee70 updated for version 7.0014
vimboss
parents: 14
diff changeset
43 *:keepalt* *:keepa*
cc049b00ee70 updated for version 7.0014
vimboss
parents: 14
diff changeset
44 :keepalt {cmd} Execute {cmd} while keeping the current alternate file
cc049b00ee70 updated for version 7.0014
vimboss
parents: 14
diff changeset
45 name. Note that commands invoked indirectly (e.g.,
cc049b00ee70 updated for version 7.0014
vimboss
parents: 14
diff changeset
46 with a function) may still set the alternate file
cc049b00ee70 updated for version 7.0014
vimboss
parents: 14
diff changeset
47 name. {not in Vi}
cc049b00ee70 updated for version 7.0014
vimboss
parents: 14
diff changeset
48
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
49 All file names are remembered in the buffer list. When you enter a file name,
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
50 for editing (e.g., with ":e filename") or writing (e.g., with ":w filename"),
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
51 the file name is added to the list. You can use the buffer list to remember
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
52 which files you edited and to quickly switch from one file to another (e.g.,
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
53 to copy text) with the |CTRL-^| command. First type the number of the file
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
54 and then hit CTRL-^. {Vi: only one alternate file name is remembered}
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
55
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 CTRL-G or *CTRL-G* *:f* *:fi* *:file*
268
8e3c690f1f3c updated for version 7.0072
vimboss
parents: 236
diff changeset
58 :f[ile] Prints the current file name (as typed, unless ":cd"
8e3c690f1f3c updated for version 7.0072
vimboss
parents: 236
diff changeset
59 was used), the cursor position (unless the 'ruler'
8e3c690f1f3c updated for version 7.0072
vimboss
parents: 236
diff changeset
60 option is set), and the file status (readonly,
8e3c690f1f3c updated for version 7.0072
vimboss
parents: 236
diff changeset
61 modified, read errors, new file). See the 'shortmess'
8e3c690f1f3c updated for version 7.0072
vimboss
parents: 236
diff changeset
62 option about how to make this message shorter.
8e3c690f1f3c updated for version 7.0072
vimboss
parents: 236
diff changeset
63 {Vi does not include column number}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64
14
946da5994c01 updated for version 7.0006
vimboss
parents: 9
diff changeset
65 :f[ile]! like |:file|, but don't truncate the name even when
946da5994c01 updated for version 7.0006
vimboss
parents: 9
diff changeset
66 'shortmess' indicates this.
946da5994c01 updated for version 7.0006
vimboss
parents: 9
diff changeset
67
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 {count}CTRL-G Like CTRL-G, but prints the current file name with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 full path. If the count is higher than 1 the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 buffer number is also given. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 *g_CTRL-G* *word-count* *byte-count*
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
73 g CTRL-G Prints the current position of the cursor in five
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
74 ways: Column, Line, Word, Character and Byte. If the
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
75 number of Characters and Bytes is the same then the
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
76 Character position is omitted.
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
77 If there are characters in the line that take more
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
78 than one position on the screen (<Tab> or special
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
79 character), both the "real" column and the screen
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
80 column are shown, separated with a dash.
7480
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
81 Also see the 'ruler' option and the |wordcount()|
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
82 function.
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
83 {not in Vi}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 *v_g_CTRL-G*
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
86 {Visual}g CTRL-G Similar to "g CTRL-G", but Word, Character, Line, and
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
87 Byte counts for the visually selected region are
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
88 displayed.
6df0106fc595 updated for version 7.0049
vimboss
parents: 139
diff changeset
89 In Blockwise mode, Column count is also shown. (For
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 {Visual} see |Visual-mode|.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 {not in VI}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 *:file_f*
14
946da5994c01 updated for version 7.0006
vimboss
parents: 9
diff changeset
94 :f[ile][!] {name} Sets the current file name to {name}. The optional !
946da5994c01 updated for version 7.0006
vimboss
parents: 9
diff changeset
95 avoids truncating the message, as with |:file|.
28
726bdc53fa49 updated for version 7.0018
vimboss
parents: 22
diff changeset
96 If the buffer did have a name, that name becomes the
726bdc53fa49 updated for version 7.0018
vimboss
parents: 22
diff changeset
97 |alternate-file| name. An unlisted buffer is created
726bdc53fa49 updated for version 7.0018
vimboss
parents: 22
diff changeset
98 to hold the old name.
139
a217baa06d43 updated for version 7.0045
vimboss
parents: 42
diff changeset
99 *:0file*
14
946da5994c01 updated for version 7.0006
vimboss
parents: 9
diff changeset
100 :0f[ile][!] Remove the name of the current buffer. The optional !
946da5994c01 updated for version 7.0006
vimboss
parents: 9
diff changeset
101 avoids truncating the message, as with |:file|. {not
946da5994c01 updated for version 7.0006
vimboss
parents: 9
diff changeset
102 in Vi}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 :buffers
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105 :files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 :ls List all the currently known file names. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 'windows.txt' |:files| |:buffers| |:ls|. {not in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 Vim will remember the full path name of a file name that you enter. In most
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 cases when the file name is displayed only the name you typed is shown, but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 the full path name is being used if you used the ":cd" command |:cd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 *home-replace*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 If the environment variable $HOME is set, and the file name starts with that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116 string, it is often displayed with HOME replaced with "~". This was done to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117 keep file names short. When reading or writing files the full name is still
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118 used, the "~" is only used when displaying file names. When replacing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 file name would result in just "~", "~/" is used instead (to avoid confusion
42
c75153d791d0 updated for version 7.0026
vimboss
parents: 39
diff changeset
120 between options set to $HOME with 'backupext' set to "~").
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
121
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122 When writing the buffer, the default is to use the current file name. Thus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
123 when you give the "ZZ" or ":wq" command, the original file will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
124 overwritten. If you do not want this, the buffer can be written into another
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
125 file by giving a file name argument to the ":write" command. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127 vim testfile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 [change the buffer with editor commands]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129 :w newfile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
130 :q
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
131
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132 This will create a file "newfile", that is a modified copy of "testfile".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133 The file "testfile" will remain unchanged. Anyway, if the 'backup' option is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134 set, Vim renames or copies the original file before it will be overwritten.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135 You can use this file if you discover that you need the original file. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 also the 'patchmode' option. The name of the backup file is normally the same
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137 as the original file with 'backupext' appended. The default "~" is a bit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
138 strange to avoid accidentally overwriting existing files. If you prefer ".bak"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139 change the 'backupext' option. Extra dots are replaced with '_' on MS-DOS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140 machines, when Vim has detected that an MS-DOS-like filesystem is being used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
141 (e.g., messydos or crossdos) or when the 'shortname' option is on. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
142 backup file can be placed in another directory by setting 'backupdir'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144 *auto-shortname*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145 Technical: On the Amiga you can use 30 characters for a file name. But on an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 MS-DOS-compatible filesystem only 8 plus 3 characters are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147 available. Vim tries to detect the type of filesystem when it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 creating the .swp file. If an MS-DOS-like filesystem is suspected,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
149 a flag is set that has the same effect as setting the 'shortname'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150 option. This flag will be reset as soon as you start editing a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151 new file. The flag will be used when making the file name for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 ".swp" and ".~" files for the current file. But when you are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153 editing a file in a normal filesystem and write to an MS-DOS-like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154 filesystem the flag will not have been set. In that case the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155 creation of the ".~" file may fail and you will get an error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156 message. Use the 'shortname' option in this case.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
157
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
158 When you started editing without giving a file name, "No File" is displayed in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
159 messages. If the ":write" command is used with a file name argument, the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
160 name for the current file is set to that file name. This only happens when
633
7437be625546 updated for version 7.0183
vimboss
parents: 595
diff changeset
161 the 'F' flag is included in 'cpoptions' (by default it is included) |cpo-F|.
7437be625546 updated for version 7.0183
vimboss
parents: 595
diff changeset
162 This is useful when entering text in an empty buffer and then writing it to a
7437be625546 updated for version 7.0183
vimboss
parents: 595
diff changeset
163 file. If 'cpoptions' contains the 'f' flag (by default it is NOT included)
7437be625546 updated for version 7.0183
vimboss
parents: 595
diff changeset
164 |cpo-f| the file name is set for the ":read file" command. This is useful
7437be625546 updated for version 7.0183
vimboss
parents: 595
diff changeset
165 when starting Vim without an argument and then doing ":read file" to start
7437be625546 updated for version 7.0183
vimboss
parents: 595
diff changeset
166 editing a file.
7437be625546 updated for version 7.0183
vimboss
parents: 595
diff changeset
167 When the file name was set and 'filetype' is empty the filetype detection
7437be625546 updated for version 7.0183
vimboss
parents: 595
diff changeset
168 autocommands will be triggered.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
169 *not-edited*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
170 Because the file name was set without really starting to edit that file, you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
171 are protected from overwriting that file. This is done by setting the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
172 "notedited" flag. You can see if this flag is set with the CTRL-G or ":file"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
173 command. It will include "[Not edited]" when the "notedited" flag is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
174 When writing the buffer to the current file name (with ":w!"), the "notedited"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
175 flag is reset.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
176
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
177 *abandon*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
178 Vim remembers whether you have changed the buffer. You are protected from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
179 losing the changes you made. If you try to quit without writing, or want to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
180 start editing another file, Vim will refuse this. In order to overrule this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181 protection, add a '!' to the command. The changes will then be lost. For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182 example: ":q" will not work if the buffer was changed, but ":q!" will. To see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183 whether the buffer was changed use the "CTRL-G" command. The message includes
10244
876fbdd84e52 commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
184 the string "[Modified]" if the buffer has been changed, or "+" if the 'm' flag
876fbdd84e52 commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
185 is in 'shortmess'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
186
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
187 If you want to automatically save the changes without asking, switch on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
188 'autowriteall' option. 'autowrite' is the associated Vi-compatible option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
189 that does not work for all commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
190
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
191 If you want to keep the changed buffer without saving it, switch on the
5277
42bf9264e64e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5247
diff changeset
192 'hidden' option. See |hidden-buffer|. Some commands work like this even when
42bf9264e64e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5247
diff changeset
193 'hidden' is not set, check the help for the command.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
194
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
195 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
196 2. Editing a file *edit-a-file*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
197
5277
42bf9264e64e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5247
diff changeset
198 *:e* *:edit* *reload*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
199 :e[dit] [++opt] [+cmd] Edit the current file. This is useful to re-edit the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
200 current file, when it has been changed outside of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
201 This fails when changes have been made to the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
202 buffer and 'autowriteall' isn't set or the file can't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
203 be written.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
204 Also see |++opt| and |+cmd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
205 {Vi: no ++opt}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
206
5277
42bf9264e64e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5247
diff changeset
207 *:edit!* *discard*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
208 :e[dit]! [++opt] [+cmd]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
209 Edit the current file always. Discard any changes to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
210 the current buffer. This is useful if you want to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
211 start all over again.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
212 Also see |++opt| and |+cmd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
213 {Vi: no ++opt}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
214
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
215 *:edit_f*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
216 :e[dit] [++opt] [+cmd] {file}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
217 Edit {file}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
218 This fails when changes have been made to the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
219 buffer, unless 'hidden' is set or 'autowriteall' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
220 set and the file can be written.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
221 Also see |++opt| and |+cmd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
222 {Vi: no ++opt}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
223
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
224 *:edit!_f*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
225 :e[dit]! [++opt] [+cmd] {file}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
226 Edit {file} always. Discard any changes to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
227 current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
228 Also see |++opt| and |+cmd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
229 {Vi: no ++opt}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
230
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
231 :e[dit] [++opt] [+cmd] #[count]
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
232 Edit the [count]th buffer (as shown by |:files|).
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
233 This command does the same as [count] CTRL-^. But ":e
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
234 #" doesn't work if the alternate buffer doesn't have a
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
235 file name, while CTRL-^ still works then.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
236 Also see |++opt| and |+cmd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
237 {Vi: no ++opt}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
238
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
239 *:ene* *:enew*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
240 :ene[w] Edit a new, unnamed buffer. This fails when changes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
241 have been made to the current buffer, unless 'hidden'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
242 is set or 'autowriteall' is set and the file can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
243 written.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
244 If 'fileformats' is not empty, the first format given
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
245 will be used for the new buffer. If 'fileformats' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
246 empty, the 'fileformat' of the current buffer is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
247 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
248
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
249 *:ene!* *:enew!*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
250 :ene[w]! Edit a new, unnamed buffer. Discard any changes to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
251 the current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
252 Set 'fileformat' like |:enew|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
253 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
254
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
255 *:fin* *:find*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
256 :fin[d][!] [++opt] [+cmd] {file}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
257 Find {file} in 'path' and then |:edit| it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
258 {not in Vi} {not available when the |+file_in_path|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
259 feature was disabled at compile time}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
260
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
261 :{count}fin[d][!] [++opt] [+cmd] {file}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
262 Just like ":find", but use the {count} match in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
263 'path'. Thus ":2find file" will find the second
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
264 "file" found in 'path'. When there are fewer matches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
265 for the file in 'path' than asked for, you get an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
266 error message.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
267
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
268 *:ex*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
269 :ex [++opt] [+cmd] [file]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
270 Same as |:edit|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
271
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
272 *:vi* *:visual*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
273 :vi[sual][!] [++opt] [+cmd] [file]
42
c75153d791d0 updated for version 7.0026
vimboss
parents: 39
diff changeset
274 When used in Ex mode: Leave |Ex-mode|, go back to
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
275 Normal mode. Otherwise same as |:edit|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
276
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
277 *:vie* *:view*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
278 :vie[w][!] [++opt] [+cmd] file
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10449
diff changeset
279 When used in Ex mode: Leave |Ex-mode|, go back to
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
280 Normal mode. Otherwise same as |:edit|, but set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
281 'readonly' option for this buffer. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
282
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
283 *CTRL-^* *CTRL-6*
2725
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
284 CTRL-^ Edit the alternate file. Mostly the alternate file is
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
285 the previously edited file. This is a quick way to
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
286 toggle between two files. It is equivalent to ":e #",
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
287 except that it also works when there is no file name.
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
288
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
289 If the 'autowrite' or 'autowriteall' option is on and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
290 the buffer was changed, write it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
291 Mostly the ^ character is positioned on the 6 key,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
292 pressing CTRL and 6 then gets you what we call CTRL-^.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
293 But on some non-US keyboards CTRL-^ is produced in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
294 another way.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
295
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
296 {count}CTRL-^ Edit [count]th file in the buffer list (equivalent to
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
297 ":e #[count]"). This is a quick way to switch between
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
298 files.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
299 See |CTRL-^| above for further details.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
300 {not in Vi}
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
301
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
302 [count]]f *]f* *[f*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
303 [count][f Same as "gf". Deprecated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
304
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
305 *gf* *E446* *E447*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
306 [count]gf Edit the file whose name is under or after the cursor.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
307 Mnemonic: "goto file".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
308 Uses the 'isfname' option to find out which characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
309 are supposed to be in a file name. Trailing
6647
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6474
diff changeset
310 punctuation characters ".,:;!" are ignored. Escaped
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6474
diff changeset
311 spaces "\ " are reduced to a single space.
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
312 Uses the 'path' option as a list of directory names to
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
313 look for the file. See the 'path' option for details
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
314 about relative directories and wildcards.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
315 Uses the 'suffixesadd' option to check for file names
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
316 with a suffix added.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
317 If the file can't be found, 'includeexpr' is used to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
318 modify the name and another attempt is done.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
319 If a [count] is given, the count'th file that is found
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
320 in the 'path' is edited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
321 This command fails if Vim refuses to |abandon| the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
322 current file.
820
57c7403f6599 updated for version 7.0c11
vimboss
parents: 819
diff changeset
323 If you want to edit the file in a new window use
57c7403f6599 updated for version 7.0c11
vimboss
parents: 819
diff changeset
324 |CTRL-W_CTRL-F|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
325 If you do want to edit a new file, use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
326 :e <cfile>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
327 < To make gf always work like that: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
328 :map gf :e <cfile><CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
329 < If the name is a hypertext link, that looks like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
330 "type://machine/path", you need the |netrw| plugin.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
331 For Unix the '~' character is expanded, like in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
332 "~user/file". Environment variables are expanded too
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
333 |expand-env|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
334 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
335 {not available when the |+file_in_path| feature was
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
336 disabled at compile time}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
337
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
338 *v_gf*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
339 {Visual}[count]gf Same as "gf", but the highlighted text is used as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
340 name of the file to edit. 'isfname' is ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
341 Leading blanks are skipped, otherwise all blanks and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
342 special characters are included in the file name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
343 (For {Visual} see |Visual-mode|.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
344 {not in VI}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
345
681
9364d114ed8d updated for version 7.0204
vimboss
parents: 674
diff changeset
346 *gF*
9364d114ed8d updated for version 7.0204
vimboss
parents: 674
diff changeset
347 [count]gF Same as "gf", except if a number follows the file
9364d114ed8d updated for version 7.0204
vimboss
parents: 674
diff changeset
348 name, then the cursor is positioned on that line in
9364d114ed8d updated for version 7.0204
vimboss
parents: 674
diff changeset
349 the file. The file name and the number must be
9364d114ed8d updated for version 7.0204
vimboss
parents: 674
diff changeset
350 separated by a non-filename (see 'isfname') and
9364d114ed8d updated for version 7.0204
vimboss
parents: 674
diff changeset
351 non-numeric character. White space between the
9364d114ed8d updated for version 7.0204
vimboss
parents: 674
diff changeset
352 filename, the separator and the number are ignored.
852
d58e3db4a7d1 updated for version 7.0f05
vimboss
parents: 842
diff changeset
353 Examples:
d58e3db4a7d1 updated for version 7.0f05
vimboss
parents: 842
diff changeset
354 eval.c:10 ~
d58e3db4a7d1 updated for version 7.0f05
vimboss
parents: 842
diff changeset
355 eval.c @ 20 ~
d58e3db4a7d1 updated for version 7.0f05
vimboss
parents: 842
diff changeset
356 eval.c (30) ~
d58e3db4a7d1 updated for version 7.0f05
vimboss
parents: 842
diff changeset
357 eval.c 40 ~
d58e3db4a7d1 updated for version 7.0f05
vimboss
parents: 842
diff changeset
358
681
9364d114ed8d updated for version 7.0204
vimboss
parents: 674
diff changeset
359 *v_gF*
9364d114ed8d updated for version 7.0204
vimboss
parents: 674
diff changeset
360 {Visual}[count]gF Same as "v_gf".
9364d114ed8d updated for version 7.0204
vimboss
parents: 674
diff changeset
361
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
362 These commands are used to start editing a single file. This means that the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
363 file is read into the buffer and the current file name is set. The file that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
364 is opened depends on the current directory, see |:cd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
365
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
366 See |read-messages| for an explanation of the message that is given after the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
367 file has been read.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
368
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
369 You can use the ":e!" command if you messed up the buffer and want to start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
370 all over again. The ":e" command is only useful if you have changed the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
371 current file name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
372
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
373 *:filename* *{file}*
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
374 Besides the things mentioned here, more special items for where a filename is
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
375 expected are mentioned at |cmdline-special|.
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
376
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
377 Note for systems other than Unix: When using a command that accepts a single
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
378 file name (like ":edit file") spaces in the file name are allowed, but
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
379 trailing spaces are ignored. This is useful on systems that regularly embed
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
380 spaces in file names (like MS-Windows and the Amiga). Example: The command
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
381 ":e Long File Name " will edit the file "Long File Name". When using a
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
382 command that accepts more than one file name (like ":next file1 file2")
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
383 embedded spaces must be escaped with a backslash.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
384
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 874
diff changeset
385 *wildcard* *wildcards*
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
386 Wildcards in {file} are expanded, but as with file completion, 'wildignore'
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
387 and 'suffixes' apply. Which wildcards are supported depends on the system.
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
388 These are the common ones:
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
389 ? matches one character
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
390 * matches anything, including nothing
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
391 ** matches anything, including nothing, recurses into directories
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
392 [abc] match 'a', 'b' or 'c'
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
393
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
394 To avoid the special meaning of the wildcards prepend a backslash. However,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
395 on MS-Windows the backslash is a path separator and "path\[abc]" is still seen
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
396 as a wildcard when "[" is in the 'isfname' option. A simple way to avoid this
8795
aba2d0a01290 commit https://github.com/vim/vim/commit/7db8f6f4f85e5d0526d23107b2a5e2334dc23354
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
397 is to use "path\[[]abc]", this matches the file "path\[abc]".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
398
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
399 *starstar-wildcard*
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
400 Expanding "**" is possible on Unix, Win32, Mac OS/X and a few other systems.
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
401 This allows searching a directory tree. This goes up to 100 directories deep.
3750
536aa8b0c934 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3682
diff changeset
402 Note there are some commands where this works slightly differently, see
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
403 |file-searching|.
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
404 Example: >
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
405 :n **/*.txt
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
406 Finds files:
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
407 aaa.txt ~
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
408 subdir/bbb.txt ~
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
409 a/b/c/d/ccc.txt ~
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
410 When non-wildcard characters are used right before or after "**" these are
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
411 only matched in the top directory. They are not used for directories further
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
412 down in the tree. For example: >
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
413 :n /usr/inc**/types.h
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
414 Finds files:
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
415 /usr/include/types.h ~
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
416 /usr/include/sys/types.h ~
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
417 /usr/inc/old/types.h ~
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
418 Note that the path with "/sys" is included because it does not need to match
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
419 "/inc". Thus it's like matching "/usr/inc*/*/*...", not
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
420 "/usr/inc*/inc*/inc*".
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
421
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
422 *backtick-expansion* *`-expansion*
7013
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
423 On Unix and a few other systems you can also use backticks for the file name
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
424 argument, for example: >
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
425 :next `find . -name ver\\*.c -print`
7051
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 7013
diff changeset
426 :view `ls -t *.patch \| head -n1`
13563
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
427 Vim will run the command in backticks using the 'shell' and use the standard
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
428 output as argument for the given Vim command (error messages from the shell
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
429 command will be discarded).
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
430 To see what shell command Vim is running, set the 'verbose' option to 4. When
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
431 the shell command returns a non-zero exit code, an error message will be
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
432 displayed and the Vim command will be aborted. To avoid this make the shell
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
433 always return zero like so: >
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
434 :next `find . -name ver\\*.c -print \|\| true`
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
435
7013
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
436 The backslashes before the star are required to prevent the shell from
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
437 expanding "ver*.c" prior to execution of the find program. The backslash
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
438 before the shell pipe symbol "|" prevents Vim from parsing it as command
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
439 termination.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
440 This also works for most other systems, with the restriction that the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
441 backticks must be around the whole item. It is not possible to have text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
442 directly before the first or just after the last backtick.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
443
8
7edf9b6e4c36 Various changes
vimboss
parents: 7
diff changeset
444 *`=*
7013
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
445 You can have the backticks expanded as a Vim expression, instead of as an
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
446 external command, by putting an equal sign right after the first backtick,
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
447 e.g.: >
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
448 :e `=tempname()`
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
449 The expression can contain just about anything, thus this can also be used to
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
450 avoid the special meaning of '"', '|', '%' and '#'. However, 'wildignore'
4119
61bcafd8c648 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3750
diff changeset
451 does apply like to other wildcards.
7013
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
452
7051
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 7013
diff changeset
453 Environment variables in the expression are expanded when evaluating the
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 7013
diff changeset
454 expression, thus this works: >
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 7013
diff changeset
455 :e `=$HOME . '/.vimrc'`
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 7013
diff changeset
456 This does not work, $HOME is inside a string and used literally: >
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 7013
diff changeset
457 :e `='$HOME' . '/.vimrc'`
7013
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
458
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
459 If the expression returns a string then names are to be separated with line
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
460 breaks. When the result is a |List| then each item is used as a name. Line
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
461 breaks also separate names.
6951
b2673982c625 Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
462 Note that such expressions are only supported in places where a filename is
b2673982c625 Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
463 expected as an argument to an Ex-command.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
464
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
465 *++opt* *[++opt]*
595
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
466 The [++opt] argument can be used to force the value of 'fileformat',
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
467 'fileencoding' or 'binary' to a value for one command, and to specify the
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
468 behavior for bad characters. The form is: >
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
469 ++{optname}
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
470 Or: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
471 ++{optname}={value}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
472
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
473 Where {optname} is one of: *++ff* *++enc* *++bin* *++nobin* *++edit*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
474 ff or fileformat overrides 'fileformat'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
475 enc or encoding overrides 'fileencoding'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
476 bin or binary sets 'binary'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
477 nobin or nobinary resets 'binary'
856
8cd729851562 updated for version 7.0g
vimboss
parents: 852
diff changeset
478 bad specifies behavior for bad characters
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
479 edit for |:read| only: keep option values as if editing
856
8cd729851562 updated for version 7.0g
vimboss
parents: 852
diff changeset
480 a file
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
481
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
482 {value} cannot contain white space. It can be any valid value for these
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
483 options. Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
484 :e ++ff=unix
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
485 This edits the same file again with 'fileformat' set to "unix". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
486
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
487 :w ++enc=latin1 newfile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
488 This writes the current buffer to "newfile" in latin1 format.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
489
595
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
490 There may be several ++opt arguments, separated by white space. They must all
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
491 appear before any |+cmd| argument.
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
492
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
493 *++bad*
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
494 The argument of "++bad=" specifies what happens with characters that can't be
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
495 converted and illegal bytes. It can be one of three things:
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
496 ++bad=X A single-byte character that replaces each bad character.
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
497 ++bad=keep Keep bad characters without conversion. Note that this may
856
8cd729851562 updated for version 7.0g
vimboss
parents: 852
diff changeset
498 result in illegal bytes in your text!
595
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
499 ++bad=drop Remove the bad characters.
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
500
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
501 The default is like "++bad=?": Replace each bad character with a question
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
502 mark. In some places an inverted question mark is used (0xBF).
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
503
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
504 Note that not all commands use the ++bad argument, even though they do not
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
505 give an error when you add it. E.g. |:write|.
595
fea48f63efc8 updated for version 7.0169
vimboss
parents: 444
diff changeset
506
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
507 Note that when reading, the 'fileformat' and 'fileencoding' options will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
508 set to the used format. When writing this doesn't happen, thus a next write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
509 will use the old value of the option. Same for the 'binary' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
510
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
511
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
512 *+cmd* *[+cmd]*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
513 The [+cmd] argument can be used to position the cursor in the newly opened
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
514 file, or execute any other command:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
515 + Start at the last line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
516 +{num} Start at line {num}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
517 +/{pat} Start at first line containing {pat}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
518 +{command} Execute {command} after opening the new file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
519 {command} is any Ex command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
520 To include a white space in the {pat} or {command}, precede it with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
521 backslash. Double the number of backslashes. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
522 :edit +/The\ book file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
523 :edit +/dir\ dirname\\ file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
524 :edit +set\ dir=c:\\\\temp file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
525 Note that in the last example the number of backslashes is halved twice: Once
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
526 for the "+cmd" argument and once for the ":set" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
527
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
528 *file-formats*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
529 The 'fileformat' option sets the <EOL> style for a file:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
530 'fileformat' characters name ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
531 "dos" <CR><NL> or <NL> DOS format *DOS-format*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
532 "unix" <NL> Unix format *Unix-format*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
533 "mac" <CR> Mac format *Mac-format*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
534 Previously 'textmode' was used. It is obsolete now.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
535
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
536 When reading a file, the mentioned characters are interpreted as the <EOL>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
537 In DOS format (default for MS-DOS, OS/2 and Win32), <CR><NL> and <NL> are both
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
538 interpreted as the <EOL>. Note that when writing the file in DOS format,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
539 <CR> characters will be added for each single <NL>. Also see |file-read|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
540
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
541 When writing a file, the mentioned characters are used for <EOL>. For DOS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
542 format <CR><NL> is used. Also see |DOS-format-write|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
543
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
544 You can read a file in DOS format and write it in Unix format. This will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
545 replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
546 :e file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
547 :set fileformat=unix
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
548 :w
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
549 If you read a file in Unix format and write with DOS format, all <NL>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
550 characters will be replaced with <CR><NL> (assuming 'fileformats' includes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
551 "unix"): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
552 :e file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
553 :set fileformat=dos
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
554 :w
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
555
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
556 If you start editing a new file and the 'fileformats' option is not empty
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
557 (which is the default), Vim will try to detect whether the lines in the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
558 are separated by the specified formats. When set to "unix,dos", Vim will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
559 check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
560 <NL> pair (MS-DOS). Only when ALL lines end in <CR><NL>, 'fileformat' is set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
561 to "dos", otherwise it is set to "unix". When 'fileformats' includes "mac",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
562 and no <NL> characters are found in the file, 'fileformat' is set to "mac".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
563
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
564 If the 'fileformat' option is set to "dos" on non-MS-DOS systems the message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
565 "[dos format]" is shown to remind you that something unusual is happening. On
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
566 MS-DOS systems you get the message "[unix format]" if 'fileformat' is set to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
567 "unix". On all systems but the Macintosh you get the message "[mac format]"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
568 if 'fileformat' is set to "mac".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
569
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
570 If the 'fileformats' option is empty and DOS format is used, but while reading
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
571 a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
572 the file message.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
573 If the 'fileformats' option is empty and Mac format is used, but while reading
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
574 a file a <NL> was found, "[NL missing]" will be included in the file message.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
575
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
576 If the new file does not exist, the 'fileformat' of the current buffer is used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
577 when 'fileformats' is empty. Otherwise the first format from 'fileformats' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
578 used for the new file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
579
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
580 Before editing binary, executable or Vim script files you should set the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
581 'binary' option. A simple way to do this is by starting Vim with the "-b"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
582 option. This will avoid the use of 'fileformat'. Without this you risk that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
583 single <NL> characters are unexpectedly replaced with <CR><NL>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
584
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
585 You can encrypt files that are written by setting the 'key' option. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
586 provides some security against others reading your files. |encryption|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
587
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
588
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
589 ==============================================================================
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
590 3. The argument list *argument-list* *arglist*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
591
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
592 If you give more than one file name when starting Vim, this list is remembered
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
593 as the argument list. You can jump to each file in this list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
594
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
595 Do not confuse this with the buffer list, which you can see with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
596 |:buffers| command. The argument list was already present in Vi, the buffer
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
597 list is new in Vim. Every file name in the argument list will also be present
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
598 in the buffer list (unless it was deleted with |:bdel| or |:bwipe|). But it's
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
599 common that names in the buffer list are not in the argument list.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
600
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
601 This subject is introduced in section |07.2| of the user manual.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
602
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
603 There is one global argument list, which is used for all windows by default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
604 It is possible to create a new argument list local to a window, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
605 |:arglocal|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
606
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
607 You can use the argument list with the following commands, and with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
608 expression functions |argc()| and |argv()|. These all work on the argument
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
609 list of the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
610
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
611 *:ar* *:args*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
612 :ar[gs] Print the argument list, with the current file in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
613 square brackets.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
614
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
615 :ar[gs] [++opt] [+cmd] {arglist} *:args_f*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
616 Define {arglist} as the new argument list and edit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
617 the first one. This fails when changes have been made
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
618 and Vim does not want to |abandon| the current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
619 Also see |++opt| and |+cmd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
620 {Vi: no ++opt}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
621
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
622 :ar[gs]! [++opt] [+cmd] {arglist} *:args_f!*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
623 Define {arglist} as the new argument list and edit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
624 the first one. Discard any changes to the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
625 buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
626 Also see |++opt| and |+cmd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
627 {Vi: no ++opt}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
628
11676
f87c43fca41d patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
629 :[count]arge[dit][!] [++opt] [+cmd] {name} .. *:arge* *:argedit*
f87c43fca41d patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
630 Add {name}s to the argument list and edit it.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
631 When {name} already exists in the argument list, this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
632 entry is edited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
633 This is like using |:argadd| and then |:edit|.
11676
f87c43fca41d patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
634 Spaces in filenames have to be escaped with "\".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
635 [count] is used like with |:argadd|.
11676
f87c43fca41d patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
636 If the current file cannot be |abandon|ed {name}s will
f87c43fca41d patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
637 still be added to the argument list, but won't be
f87c43fca41d patch 8.0.0721: :argedit can only have one argument
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
638 edited. No check for duplicates is done.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
639 Also see |++opt| and |+cmd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
640 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
641
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
642 :[count]arga[dd] {name} .. *:arga* *:argadd* *E479*
6238
47b1887483da Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6122
diff changeset
643 :[count]arga[dd]
47b1887483da Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6122
diff changeset
644 Add the {name}s to the argument list. When {name} is
6421
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
645 omitted add the current buffer name to the argument
6238
47b1887483da Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6122
diff changeset
646 list.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
647 If [count] is omitted, the {name}s are added just
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
648 after the current entry in the argument list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
649 Otherwise they are added after the [count]'th file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
650 If the argument list is "a b c", and "b" is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
651 current argument, then these commands result in:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
652 command new argument list ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
653 :argadd x a b x c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
654 :0argadd x x a b c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
655 :1argadd x a x b c
6421
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
656 :$argadd x a b c x
7659
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
657 And after the last one:
6421
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
658 :+2argadd y a b c x y
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
659 There is no check for duplicates, it is possible to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
660 add a file to the argument list twice.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
661 The currently edited file is not changed.
13563
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
662 {not in Vi}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
663 Note: you can also use this method: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
664 :args ## x
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
665 < This will add the "x" item and sort the new list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
666
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
667 :argd[elete] {pattern} .. *:argd* *:argdelete* *E480*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
668 Delete files from the argument list that match the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
669 {pattern}s. {pattern} is used like a file pattern,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
670 see |file-pattern|. "%" can be used to delete the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
671 current entry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
672 This command keeps the currently edited file, also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
673 when it's deleted from the argument list.
280
453b78cb4881 updated for version 7.0075
vimboss
parents: 268
diff changeset
674 Example: >
453b78cb4881 updated for version 7.0075
vimboss
parents: 268
diff changeset
675 :argdel *.obj
13563
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
676 < {not in Vi}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
677
6421
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
678 :[range]argd[elete] Delete the {range} files from the argument list.
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
679 Example: >
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
680 :10,$argdel
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
681 < Deletes arguments 10 and further, keeping 1-9. >
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
682 :$argd
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
683 < Deletes just the last one. >
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
684 :argd
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
685 :.argd
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
686 < Deletes the current argument. >
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
687 :%argd
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
688 < Removes all the files from the arglist.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
689 When the last number in the range is too high, up to
6421
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6385
diff changeset
690 the last argument is deleted.
13563
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
691 {not in Vi}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
692
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
693 *:argu* *:argument*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
694 :[count]argu[ment] [count] [++opt] [+cmd]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
695 Edit file [count] in the argument list. When [count]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
696 is omitted the current entry is used. This fails
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
697 when changes have been made and Vim does not want to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
698 |abandon| the current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
699 Also see |++opt| and |+cmd|.
13563
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
700 {not in Vi}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
701
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
702 :[count]argu[ment]! [count] [++opt] [+cmd]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
703 Edit file [count] in the argument list, discard any
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
704 changes to the current buffer. When [count] is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
705 omitted the current entry is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
706 Also see |++opt| and |+cmd|.
13563
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
707 {not in Vi}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
708
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
709 :[count]n[ext] [++opt] [+cmd] *:n* *:ne* *:next* *E165* *E163*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
710 Edit [count] next file. This fails when changes have
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
711 been made and Vim does not want to |abandon| the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
712 current buffer. Also see |++opt| and |+cmd|. {Vi: no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
713 count or ++opt}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
714
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
715 :[count]n[ext]! [++opt] [+cmd]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
716 Edit [count] next file, discard any changes to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
717 buffer. Also see |++opt| and |+cmd|. {Vi: no count
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
718 or ++opt}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
719
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
720 :n[ext] [++opt] [+cmd] {arglist} *:next_f*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
721 Same as |:args_f|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
722
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
723 :n[ext]! [++opt] [+cmd] {arglist}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
724 Same as |:args_f!|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
725
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
726 :[count]N[ext] [count] [++opt] [+cmd] *:Next* *:N* *E164*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
727 Edit [count] previous file in argument list. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
728 fails when changes have been made and Vim does not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
729 want to |abandon| the current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
730 Also see |++opt| and |+cmd|. {Vi: no count or ++opt}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
731
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
732 :[count]N[ext]! [count] [++opt] [+cmd]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
733 Edit [count] previous file in argument list. Discard
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
734 any changes to the buffer. Also see |++opt| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
735 |+cmd|. {Vi: no count or ++opt}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
736
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
737 :[count]prev[ious] [count] [++opt] [+cmd] *:prev* *:previous*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
738 Same as :Next. Also see |++opt| and |+cmd|. {Vi:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
739 only in some versions}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
740
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
741 *:rew* *:rewind*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
742 :rew[ind] [++opt] [+cmd]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
743 Start editing the first file in the argument list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
744 This fails when changes have been made and Vim does
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
745 not want to |abandon| the current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
746 Also see |++opt| and |+cmd|. {Vi: no ++opt}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
747
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
748 :rew[ind]! [++opt] [+cmd]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
749 Start editing the first file in the argument list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
750 Discard any changes to the buffer. Also see |++opt|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
751 and |+cmd|. {Vi: no ++opt}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
752
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
753 *:fir* *:first*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
754 :fir[st][!] [++opt] [+cmd]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
755 Other name for ":rewind". {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
756
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
757 *:la* *:last*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
758 :la[st] [++opt] [+cmd]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
759 Start editing the last file in the argument list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
760 This fails when changes have been made and Vim does
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
761 not want to |abandon| the current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
762 Also see |++opt| and |+cmd|. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
763
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
764 :la[st]! [++opt] [+cmd]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
765 Start editing the last file in the argument list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
766 Discard any changes to the buffer. Also see |++opt|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
767 and |+cmd|. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
768
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
769 *:wn* *:wnext*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
770 :[count]wn[ext] [++opt]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
771 Write current file and start editing the [count]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
772 next file. Also see |++opt| and |+cmd|. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
773
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
774 :[count]wn[ext] [++opt] {file}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
775 Write current file to {file} and start editing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
776 [count] next file, unless {file} already exists and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
777 the 'writeany' option is off. Also see |++opt| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
778 |+cmd|. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
779
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
780 :[count]wn[ext]! [++opt] {file}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
781 Write current file to {file} and start editing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
782 [count] next file. Also see |++opt| and |+cmd|. {not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
783 in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
784
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
785 :[count]wN[ext][!] [++opt] [file] *:wN* *:wNext*
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
786 :[count]wp[revious][!] [++opt] [file] *:wp* *:wprevious*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
787 Same as :wnext, but go to previous file instead of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
788 next. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
789
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
790 The [count] in the commands above defaults to one. For some commands it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
791 possible to use two counts. The last one (rightmost one) is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
792
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
793 If no [+cmd] argument is present, the cursor is positioned at the last known
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
794 cursor position for the file. If 'startofline' is set, the cursor will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
795 positioned at the first non-blank in the line, otherwise the last know column
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
796 is used. If there is no last known cursor position the cursor will be in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
797 first line (the last line in Ex mode).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
798
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
799 *{arglist}*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
800 The wildcards in the argument list are expanded and the file names are sorted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
801 Thus you can use the command "vim *.c" to edit all the C files. From within
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
802 Vim the command ":n *.c" does the same.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
803
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
804 White space is used to separate file names. Put a backslash before a space or
1240
5bed56fce2b5 updated for version 7.1
vimboss
parents: 1197
diff changeset
805 tab to include it in a file name. E.g., to edit the single file "foo bar": >
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
806 :next foo\ bar
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
807
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
808 On Unix and a few other systems you can also use backticks, for example: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
809 :next `find . -name \\*.c -print`
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
810 The backslashes before the star are required to prevent "*.c" to be expanded
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
811 by the shell before executing the find program.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
812
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
813 *arglist-position*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
814 When there is an argument list you can see which file you are editing in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
815 title of the window (if there is one and 'title' is on) and with the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
816 message you get with the "CTRL-G" command. You will see something like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
817 (file 4 of 11)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
818 If 'shortmess' contains 'f' it will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
819 (4 of 11)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
820 If you are not really editing the file at the current position in the argument
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
821 list it will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
822 (file (4) of 11)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
823 This means that you are position 4 in the argument list, but not editing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
824 fourth file in the argument list. This happens when you do ":e file".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
825
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
826
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
827 LOCAL ARGUMENT LIST
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
828
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
829 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
830
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
831 *:arglocal*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
832 :argl[ocal] Make a local copy of the global argument list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
833 Doesn't start editing another file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
834
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
835 :argl[ocal][!] [++opt] [+cmd] {arglist}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
836 Define a new argument list, which is local to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
837 current window. Works like |:args_f| otherwise.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
838
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
839 *:argglobal*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
840 :argg[lobal] Use the global argument list for the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
841 Doesn't start editing another file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
842
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
843 :argg[lobal][!] [++opt] [+cmd] {arglist}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
844 Use the global argument list for the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
845 Define a new global argument list like |:args_f|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
846 All windows using the global argument list will see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
847 this new list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
848
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
849 There can be several argument lists. They can be shared between windows.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
850 When they are shared, changing the argument list in one window will also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
851 change it in the other window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
852
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
853 When a window is split the new window inherits the argument list from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
854 current window. The two windows then share this list, until one of them uses
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
855 |:arglocal| or |:argglobal| to use another argument list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
856
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
857
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
858 USING THE ARGUMENT LIST
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
859
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
860 *:argdo*
6474
a88d4dc02bf4 updated for version 7.4.566
Bram Moolenaar <bram@vim.org>
parents: 6421
diff changeset
861 :[range]argdo[!] {cmd} Execute {cmd} for each file in the argument list or
a88d4dc02bf4 updated for version 7.4.566
Bram Moolenaar <bram@vim.org>
parents: 6421
diff changeset
862 if [range] is specified only for arguments in that
a88d4dc02bf4 updated for version 7.4.566
Bram Moolenaar <bram@vim.org>
parents: 6421
diff changeset
863 range. It works like doing this: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
864 :rewind
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
865 :{cmd}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
866 :next
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
867 :{cmd}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
868 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
869 < When the current file can't be |abandon|ed and the [!]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
870 is not present, the command fails.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
871 When an error is detected on one file, further files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
872 in the argument list will not be visited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
873 The last file in the argument list (or where an error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
874 occurred) becomes the current file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
875 {cmd} can contain '|' to concatenate several commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
876 {cmd} must not change the argument list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
877 Note: While this command is executing, the Syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
878 autocommand event is disabled by adding it to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
879 'eventignore'. This considerably speeds up editing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
880 each file.
13563
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
881 {not in Vi}
7092
64e30831fa42 commit https://github.com/vim/vim/commit/aa23b379421aa214e6543b06c974594a25799b09
Christian Brabandt <cb@256bit.org>
parents: 7051
diff changeset
882 Also see |:windo|, |:tabdo|, |:bufdo|, |:cdo|, |:ldo|,
64e30831fa42 commit https://github.com/vim/vim/commit/aa23b379421aa214e6543b06c974594a25799b09
Christian Brabandt <cb@256bit.org>
parents: 7051
diff changeset
883 |:cfdo| and |:lfdo|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
884
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
885 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
886 :args *.c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
887 :argdo set ff=unix | update
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
888 This sets the 'fileformat' option to "unix" and writes the file if it is now
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
889 changed. This is done for all *.c files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
890
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
891 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
892 :args *.[ch]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
893 :argdo %s/\<my_foo\>/My_Foo/ge | update
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
894 This changes the word "my_foo" to "My_Foo" in all *.c and *.h files. The "e"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
895 flag is used for the ":substitute" command to avoid an error for files where
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
896 "my_foo" isn't used. ":update" writes the file only if changes were made.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
897
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
898 ==============================================================================
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
899 4. Writing *writing* *save-file*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
900
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
901 Note: When the 'write' option is off, you are not able to write any file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
902
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
903 *:w* *:write*
14249
4543777545a3 Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
904 *E502* *E503* *E504* *E505*
4543777545a3 Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
905 *E512* *E514* *E667* *E796* *E949*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
906 :w[rite] [++opt] Write the whole buffer to the current file. This is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
907 the normal way to save changes to a file. It fails
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
908 when the 'readonly' option is set or when there is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
909 another reason why the file can't be written.
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
910 For ++opt see |++opt|, but only ++bin, ++nobin, ++ff
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
911 and ++enc are effective.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
912
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
913 :w[rite]! [++opt] Like ":write", but forcefully write when 'readonly' is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
914 set or there is another reason why writing was
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
915 refused.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
916 Note: This may change the permission and ownership of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
917 the file and break (symbolic) links. Add the 'W' flag
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
918 to 'cpoptions' to avoid this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
919
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
920 :[range]w[rite][!] [++opt]
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
921 Write the specified lines to the current file. This
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
922 is unusual, because the file will not contain all
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
923 lines in the buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
924
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
925 *:w_f* *:write_f*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
926 :[range]w[rite] [++opt] {file}
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
927 Write the specified lines to {file}, unless it
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
928 already exists and the 'writeany' option is off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
929
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
930 *:w!*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
931 :[range]w[rite]! [++opt] {file}
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
932 Write the specified lines to {file}. Overwrite an
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
933 existing file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
934
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
935 *:w_a* *:write_a* *E494*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
936 :[range]w[rite][!] [++opt] >>
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
937 Append the specified lines to the current file.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
938
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
939 :[range]w[rite][!] [++opt] >> {file}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
940 Append the specified lines to {file}. '!' forces the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
941 write even if file does not exist.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
942
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
943 *:w_c* *:write_c*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
944 :[range]w[rite] [++opt] !{cmd}
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
945 Execute {cmd} with [range] lines as standard input
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
946 (note the space in front of the '!'). {cmd} is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
947 executed like with ":!{cmd}", any '!' is replaced with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
948 the previous command |:!|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
949
31
6f8b1be930a6 updated for version 7.0019
vimboss
parents: 28
diff changeset
950 The default [range] for the ":w" command is the whole buffer (1,$). If you
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
951 write the whole buffer, it is no longer considered changed. When you
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
952 write it to a different file with ":w somefile" it depends on the "+" flag in
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
953 'cpoptions'. When included, the write command will reset the 'modified' flag,
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
954 even though the buffer itself may still be different from its file.
31
6f8b1be930a6 updated for version 7.0019
vimboss
parents: 28
diff changeset
955
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
956 If a file name is given with ":w" it becomes the alternate file. This can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
957 used, for example, when the write fails and you want to try again later with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
958 ":w #". This can be switched off by removing the 'A' flag from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
959 'cpoptions' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
960
12909
1578c0ba0dd1 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
961 Note that the 'fsync' option matters here. If it's set it may make writes
1578c0ba0dd1 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
962 slower (but safer).
1578c0ba0dd1 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
963
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
964 *:sav* *:saveas*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
965 :sav[eas][!] [++opt] {file}
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
966 Save the current buffer under the name {file} and set
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
967 the filename of the current buffer to {file}. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
968 previous name is used for the alternate file name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
969 The [!] is needed to overwrite an existing file.
633
7437be625546 updated for version 7.0183
vimboss
parents: 595
diff changeset
970 When 'filetype' is empty filetype detection is done
7437be625546 updated for version 7.0183
vimboss
parents: 595
diff changeset
971 with the new name, before the file is written.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
972 When the write was successful 'readonly' is reset.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
973 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
974
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
975 *:up* *:update*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
976 :[range]up[date][!] [++opt] [>>] [file]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
977 Like ":write", but only write when the buffer has been
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
978 modified. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
979
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
980
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
981 WRITING WITH MULTIPLE BUFFERS *buffer-write*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
982
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
983 *:wa* *:wall*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
984 :wa[ll] Write all changed buffers. Buffers without a file
10449
222b1432814e commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents: 10244
diff changeset
985 name cause an error message. Buffers which are
222b1432814e commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents: 10244
diff changeset
986 readonly are not written. {not in Vi}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
987
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
988 :wa[ll]! Write all changed buffers, even the ones that are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
989 readonly. Buffers without a file name are not
10449
222b1432814e commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents: 10244
diff changeset
990 written and cause an error message. {not in Vi}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
991
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
992
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
993 Vim will warn you if you try to overwrite a file that has been changed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
994 elsewhere. See |timestamp|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
995
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
996 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
997 If you write to an existing file (but do not append) while the 'backup',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
998 'writebackup' or 'patchmode' option is on, a backup of the original file is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
999 made. The file is either copied or renamed (see 'backupcopy'). After the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1000 file has been successfully written and when the 'writebackup' option is on and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1001 the 'backup' option is off, the backup file is deleted. When the 'patchmode'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1002 option is on the backup file may be renamed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1003
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1004 *backup-table*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1005 'backup' 'writebackup' action ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1006 off off no backup made
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1007 off on backup current file, deleted afterwards (default)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1008 on off delete old backup, backup current file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1009 on on delete old backup, backup current file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1010
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1011 When the 'backupskip' pattern matches with the name of the file which is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1012 written, no backup file is made. The values of 'backup' and 'writebackup' are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1013 ignored then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1014
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1015 When the 'backup' option is on, an old backup file (with the same name as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1016 new backup file) will be deleted. If 'backup' is not set, but 'writebackup'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1017 is set, an existing backup file will not be deleted. The backup file that is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1018 made while the file is being written will have a different name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1019
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1020 On some filesystems it's possible that in a crash you lose both the backup and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1021 the newly written file (it might be there but contain bogus data). In that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1022 case try recovery, because the swap file is synced to disk and might still be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1023 there. |:recover|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1024
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8061
diff changeset
1025 The directories given with the 'backupdir' option are used to put the backup
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1026 file in. (default: same directory as the written file).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1027
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1028 Whether the backup is a new file, which is a copy of the original file, or the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1029 original file renamed depends on the 'backupcopy' option. See there for an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1030 explanation of when the copy is made and when the file is renamed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1031
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1032 If the creation of a backup file fails, the write is not done. If you want
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1033 to write anyway add a '!' to the command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1034
2698
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
1035 *write-permissions*
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
1036 When writing a new file the permissions are read-write. For unix the mask is
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
1037 0666 with additionally umask applied. When writing a file that was read Vim
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
1038 will preserve the permissions, but clear the s-bit.
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
1039
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1040 *write-readonly*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1041 When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1042 readonly file. When 'W' is not present, ":w!" will overwrite a readonly file,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1043 if the system allows it (the directory must be writable).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1044
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1045 *write-fail*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1046 If the writing of the new file fails, you have to be careful not to lose
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1047 your changes AND the original file. If there is no backup file and writing
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1048 the new file failed, you have already lost the original file! DON'T EXIT VIM
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1049 UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1050 of the original file (if possible). If you exit Vim, and lose the changes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1051 you made, the original file will mostly still be there. If putting back the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1052 original file fails, there will be an error message telling you that you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1053 lost the original file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1054
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1055 *DOS-format-write*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1056 If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>. This is default
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1057 for MS-DOS, Win32 and OS/2. On other systems the message "[dos format]" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1058 shown to remind you that an unusual <EOL> was used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1059 *Unix-format-write*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1060 If the 'fileformat' is "unix", <NL> is used for <EOL>. On MS-DOS, Win32 and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1061 OS/2 the message "[unix format]" is shown.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1062 *Mac-format-write*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1063 If the 'fileformat' is "mac", <CR> is used for <EOL>. On non-Mac systems the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1064 message "[mac format]" is shown.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1065
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1066 See also |file-formats| and the 'fileformat' and 'fileformats' options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1067
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1068 *ACL*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1069 ACL stands for Access Control List. It is an advanced way to control access
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1070 rights for a file. It is used on new MS-Windows and Unix systems, but only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1071 when the filesystem supports it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1072 Vim attempts to preserve the ACL info when writing a file. The backup file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1073 will get the ACL info of the original file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1074 The ACL info is also used to check if a file is read-only (when opening the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1075 file).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1076
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1077 *read-only-share*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1078 When MS-Windows shares a drive on the network it can be marked as read-only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1079 This means that even if the file read-only attribute is absent, and the ACL
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1080 settings on NT network shared drives allow writing to the file, you can still
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1081 not write to the file. Vim on Win32 platforms will detect read-only network
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1082 drives and will mark the file as read-only. You will not be able to override
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1083 it with |:write|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1084
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1085 *write-device*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1086 When the file name is actually a device name, Vim will not make a backup (that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1087 would be impossible). You need to use "!", since the device already exists.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1088 Example for Unix: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1089 :w! /dev/lpt0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1090 and for MS-DOS or MS-Windows: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1091 :w! lpt0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1092 For Unix a device is detected when the name doesn't refer to a normal file or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1093 a directory. A fifo or named pipe also looks like a device to Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1094 For MS-DOS and MS-Windows the device is detected by its name:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1095 AUX
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1096 CON
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1097 CLOCK$
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1098 NUL
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1099 PRN
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1100 COMn n=1,2,3... etc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1101 LPTn n=1,2,3... etc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1102 The names can be in upper- or lowercase.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1103
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1104 ==============================================================================
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1105 5. Writing and quitting *write-quit*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1106
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1107 *:q* *:quit*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1108 :q[uit] Quit the current window. Quit Vim if this is the last
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1109 window. This fails when changes have been made and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1110 Vim refuses to |abandon| the current buffer, and when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1111 the last file in the argument list has not been
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1112 edited.
674
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 633
diff changeset
1113 If there are other tab pages and quitting the last
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 633
diff changeset
1114 window in the current tab page the current tab page is
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 633
diff changeset
1115 closed |tab-page|.
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1116 Triggers the |QuitPre| autocommand event.
12254
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
1117 See |CTRL-W_q| for quitting another window.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1118
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1119 :conf[irm] q[uit] Quit, but give prompt when changes have been made, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1120 the last file in the argument list has not been
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1121 edited. See |:confirm| and 'confirm'. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1122
7477
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7469
diff changeset
1123 :q[uit]! Quit without writing, also when the current buffer has
9860
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
1124 changes. The buffer is unloaded, also when it has
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
1125 'hidden' set.
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
1126 If this is the last window and there is a modified
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
1127 hidden buffer, the current buffer is abandoned and the
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
1128 first changed hidden buffer becomes the current
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
1129 buffer.
6385
f654ad95fd4e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6369
diff changeset
1130 Use ":qall!" to exit always.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1131
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1132 :cq[uit] Quit always, without writing, and return an error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1133 code. See |:cq|. Used for Manx's QuickFix mode (see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1134 |quickfix|). {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1135
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1136 *:wq*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1137 :wq [++opt] Write the current file and quit. Writing fails when
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1138 the file is read-only or the buffer does not have a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1139 name. Quitting fails when the last file in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1140 argument list has not been edited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1141
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1142 :wq! [++opt] Write the current file and quit. Writing fails when
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1143 the current buffer does not have a name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1144
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1145 :wq [++opt] {file} Write to {file} and quit. Quitting fails when the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1146 last file in the argument list has not been edited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1147
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1148 :wq! [++opt] {file} Write to {file} and quit.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1149
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1150 :[range]wq[!] [++opt] [file]
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1151 Same as above, but only write the lines in [range].
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1152
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1153 *:x* *:xit*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1154 :[range]x[it][!] [++opt] [file]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1155 Like ":wq", but write only when changes have been
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1156 made.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1157 When 'hidden' is set and there are more windows, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1158 current buffer becomes hidden, after writing the file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1159
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1160 *:exi* *:exit*
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1161 :[range]exi[t][!] [++opt] [file]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1162 Same as :xit.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1163
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1164 *ZZ*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1165 ZZ Write current file, if modified, and quit (same as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1166 ":x"). (Note: If there are several windows for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1167 current file, the file is written if it was modified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1168 and the window is closed).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1169
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1170 *ZQ*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1171 ZQ Quit without checking for changes (same as ":q!").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1172 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1173
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1174 MULTIPLE WINDOWS AND BUFFERS *window-exit*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1175
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1176 *:qa* *:qall*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1177 :qa[ll] Exit Vim, unless there are some buffers which have been
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1178 changed. (Use ":bmod" to go to the next modified buffer).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1179 When 'autowriteall' is set all changed buffers will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1180 written, like |:wqall|. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1181
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1182 :conf[irm] qa[ll]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1183 Exit Vim. Bring up a prompt when some buffers have been
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1184 changed. See |:confirm|. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1185
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1186 :qa[ll]! Exit Vim. Any changes to buffers are lost. {not in Vi}
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
1187 Also see |:cquit|, it does the same but exits with a non-zero
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
1188 value.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1189
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1190 *:quita* *:quitall*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1191 :quita[ll][!] Same as ":qall". {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1192
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1193 :wqa[ll] [++opt] *:wqa* *:wqall* *:xa* *:xall*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1194 :xa[ll] Write all changed buffers and exit Vim. If there are buffers
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1195 without a file name, which are readonly or which cannot be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1196 written for another reason, Vim will not quit. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1197
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1198 :conf[irm] wqa[ll] [++opt]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1199 :conf[irm] xa[ll]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1200 Write all changed buffers and exit Vim. Bring up a prompt
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1201 when some buffers are readonly or cannot be written for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1202 another reason. See |:confirm|. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1203
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
1204 :wqa[ll]! [++opt]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1205 :xa[ll]! Write all changed buffers, even the ones that are readonly,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1206 and exit Vim. If there are buffers without a file name or
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12909
diff changeset
1207 which cannot be written for another reason, or there is a
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12909
diff changeset
1208 terminal with a running job, Vim will not quit.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1209 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1210
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1211 ==============================================================================
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1212 6. Dialogs *edit-dialogs*
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1213
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1214 *:confirm* *:conf*
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1215 :conf[irm] {command} Execute {command}, and use a dialog when an
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1216 operation has to be confirmed. Can be used on the
3445
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
1217 |:q|, |:qa| and |:w| commands (the latter to override
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
1218 a read-only setting), and any other command that can
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
1219 fail in such a way, such as |:only|, |:buffer|,
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
1220 |:bdelete|, etc.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1221
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1222 Examples: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1223 :confirm w foo
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1224 < Will ask for confirmation when "foo" already exists. >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1225 :confirm q
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1226 < Will ask for confirmation when there are changes. >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1227 :confirm qa
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1228 < If any modified, unsaved buffers exist, you will be prompted to save
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1229 or abandon each one. There are also choices to "save all" or "abandon
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1230 all".
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1231
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1232 If you want to always use ":confirm", set the 'confirm' option.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1233
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
1234 *:browse* *:bro* *E338* *E614* *E615* *E616*
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1235 :bro[wse] {command} Open a file selection dialog for an argument to
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1236 {command}. At present this works for |:e|, |:w|,
2296
eb7be7b075a6 Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
1237 |:wall|, |:wq|, |:wqall|, |:x|, |:xall|, |:exit|,
eb7be7b075a6 Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
1238 |:view|, |:sview|, |:r|, |:saveas|, |:sp|, |:mkexrc|,
eb7be7b075a6 Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
1239 |:mkvimrc|, |:mksession|, |:mkview|, |:split|,
eb7be7b075a6 Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
1240 |:vsplit|, |:tabe|, |:tabnew|, |:cfile|, |:cgetfile|,
eb7be7b075a6 Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
1241 |:caddfile|, |:lfile|, |:lgetfile|, |:laddfile|,
eb7be7b075a6 Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
1242 |:diffsplit|, |:diffpatch|, |:open|, |:pedit|,
eb7be7b075a6 Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
1243 |:redir|, |:source|, |:update|, |:visual|, |:vsplit|,
eb7be7b075a6 Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
1244 and |:qall| if 'confirm' is set.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1245 {only in Win32, Athena, Motif, GTK and Mac GUI}
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1246 When ":browse" is not possible you get an error
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1247 message. If the |+browse| feature is missing or the
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1248 {command} doesn't support browsing, the {command} is
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1249 executed without a dialog.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1250 ":browse set" works like |:options|.
2296
eb7be7b075a6 Support :browse for commands that use an error file argument. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents: 2283
diff changeset
1251 See also |:oldfiles| for ":browse oldfiles".
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1252
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1253 The syntax is best shown via some examples: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1254 :browse e $vim/foo
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1255 < Open the browser in the $vim/foo directory, and edit the
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1256 file chosen. >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1257 :browse e
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1258 < Open the browser in the directory specified with 'browsedir',
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1259 and edit the file chosen. >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1260 :browse w
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1261 < Open the browser in the directory of the current buffer,
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1262 with the current buffer filename as default, and save the
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1263 buffer under the filename chosen. >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1264 :browse w C:/bar
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1265 < Open the browser in the C:/bar directory, with the current
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1266 buffer filename as default, and save the buffer under the
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1267 filename chosen.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1268 Also see the |'browsedir'| option.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1269 For versions of Vim where browsing is not supported, the command is executed
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1270 unmodified.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1271
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1272 *browsefilter*
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1273 For MS Windows and GTK, you can modify the filters that are used in the browse
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1274 dialog. By setting the g:browsefilter or b:browsefilter variables, you can
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1275 change the filters globally or locally to the buffer. The variable is set to
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1276 a string in the format "{filter label}\t{pattern};{pattern}\n" where {filter
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1277 label} is the text that appears in the "Files of Type" comboBox, and {pattern}
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1278 is the pattern which filters the filenames. Several patterns can be given,
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1279 separated by ';'.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1280
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1281 For Motif the same format is used, but only the very first pattern is actually
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1282 used (Motif only offers one pattern, but you can edit it).
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1283
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1284 For example, to have only Vim files in the dialog, you could use the following
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1285 command: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1286
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1287 let g:browsefilter = "Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1288
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1289 You can override the filter setting on a per-buffer basis by setting the
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1290 b:browsefilter variable. You would most likely set b:browsefilter in a
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1291 filetype plugin, so that the browse dialog would contain entries related to
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1292 the type of file you are currently editing. Disadvantage: This makes it
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1293 difficult to start editing a file of a different type. To overcome this, you
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1294 may want to add "All Files\t*.*\n" as the final filter, so that the user can
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1295 still access any desired file.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1296
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1297 To avoid setting browsefilter when Vim does not actually support it, you can
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1298 use has("browsefilter"): >
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1299
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1300 if has("browsefilter")
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1301 let g:browsefilter = "whatever"
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1302 endif
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
1303
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1304 ==============================================================================
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1305 7. The current directory *current-directory*
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1306
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1307 You may use the |:cd| and |:lcd| commands to change to another directory, so
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1308 you will not have to type that directory name in front of the file names. It
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1309 also makes a difference for executing external commands, e.g. ":!ls".
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1310
167
c93c9cad9618 updated for version 7.0051
vimboss
parents: 161
diff changeset
1311 Changing directory fails when the current buffer is modified, the '.' flag is
c93c9cad9618 updated for version 7.0051
vimboss
parents: 161
diff changeset
1312 present in 'cpoptions' and "!" is not used in the command.
c93c9cad9618 updated for version 7.0051
vimboss
parents: 161
diff changeset
1313
835
8bebcabccc2c updated for version 7.0e01
vimboss
parents: 834
diff changeset
1314 *:cd* *E747* *E472*
167
c93c9cad9618 updated for version 7.0051
vimboss
parents: 161
diff changeset
1315 :cd[!] On non-Unix systems: Print the current directory
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1316 name. On Unix systems: Change the current directory
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1317 to the home directory. Use |:pwd| to print the
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1318 current directory on all systems.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1319
167
c93c9cad9618 updated for version 7.0051
vimboss
parents: 161
diff changeset
1320 :cd[!] {path} Change the current directory to {path}.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1321 If {path} is relative, it is searched for in the
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1322 directories listed in |'cdpath'|.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1323 Does not change the meaning of an already opened file,
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1324 because its full path name is remembered. Files from
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1325 the |arglist| may change though!
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1326 On MS-DOS this also changes the active drive.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1327 To change to the directory of the current file: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1328 :cd %:h
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1329 <
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1330 *:cd-* *E186*
167
c93c9cad9618 updated for version 7.0051
vimboss
parents: 161
diff changeset
1331 :cd[!] - Change to the previous current directory (before the
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1332 previous ":cd {path}" command). {not in Vi}
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1333
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1334 *:chd* *:chdir*
167
c93c9cad9618 updated for version 7.0051
vimboss
parents: 161
diff changeset
1335 :chd[ir][!] [path] Same as |:cd|.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1336
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1337 *:lc* *:lcd*
11659
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11400
diff changeset
1338 :lc[d][!] {path} Like |:cd|, but only set the current directory when
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11400
diff changeset
1339 the cursor is in the current window. The current
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11400
diff changeset
1340 directory for other windows is not changed, switching
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11400
diff changeset
1341 to another window will stop using {path}.
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 11400
diff changeset
1342 {not in Vi}
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1343
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1344 *:lch* *:lchdir*
167
c93c9cad9618 updated for version 7.0051
vimboss
parents: 161
diff changeset
1345 :lch[dir][!] Same as |:lcd|. {not in Vi}
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1346
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1347 *:pw* *:pwd* *E187*
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1348 :pw[d] Print the current directory name. {Vi: no pwd}
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1349 Also see |getcwd()|.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1350
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1351 So long as no |:lcd| command has been used, all windows share the same current
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1352 directory. Using a command to jump to another window doesn't change anything
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1353 for the current directory.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1354 When a |:lcd| command has been used for a window, the specified directory
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1355 becomes the current directory for that window. Windows where the |:lcd|
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1356 command has not been used stick to the global current directory. When jumping
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1357 to another window the current directory will become the last specified local
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1358 current directory. If none was specified, the global current directory is
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1359 used.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1360 When a |:cd| command is used, the current window will lose his local current
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1361 directory and will use the global current directory from now on.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1362
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1363 After using |:cd| the full path name will be used for reading and writing
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1364 files. On some networked file systems this may cause problems. The result of
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1365 using the full path name is that the file names currently in use will remain
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1366 referring to the same file. Example: If you have a file a:test and a
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1367 directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1368 a:test and not write a:vim/test. But if you do ":w test" the file a:vim/test
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1369 will be written, because you gave a new file name and did not refer to a
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1370 filename before the ":cd".
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1371
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1372 ==============================================================================
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1373 8. Editing binary files *edit-binary*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1374
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1375 Although Vim was made to edit text files, it is possible to edit binary
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1376 files. The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1377 mode, and sets some options for editing binary files ('binary' on, 'textwidth'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1378 to 0, 'modeline' off, 'expandtab' off). Setting the 'binary' option has the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1379 same effect. Don't forget to do this before reading the file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1380
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1381 There are a few things to remember when editing binary files:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1382 - When editing executable files the number of characters must not change.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1383 Use only the "R" or "r" command to change text. Do not delete characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1384 with "x" or by backspacing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1385 - Set the 'textwidth' option to 0. Otherwise lines will unexpectedly be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1386 split in two.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1387 - When there are not many <EOL>s, the lines will become very long. If you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1388 want to edit a line that does not fit on the screen reset the 'wrap' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1389 Horizontal scrolling is used then. If a line becomes too long (more than
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1390 about 32767 characters on the Amiga, much more on 32-bit systems, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1391 |limits|) you cannot edit that line. The line will be split when reading
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1392 the file. It is also possible that you get an "out of memory" error when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1393 reading the file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1394 - Make sure the 'binary' option is set BEFORE loading the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1395 file. Otherwise both <CR> <NL> and <NL> are considered to end a line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1396 and when the file is written the <NL> will be replaced with <CR> <NL>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1397 - <Nul> characters are shown on the screen as ^@. You can enter them with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1398 "CTRL-V CTRL-@" or "CTRL-V 000" {Vi cannot handle <Nul> characters in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1399 file}
7013
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
1400 - To insert a <NL> character in the file split a line. When writing the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1401 buffer to a file a <NL> will be written for the <EOL>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1402 - Vim normally appends an <EOL> at the end of the file if there is none.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1403 Setting the 'binary' option prevents this. If you want to add the final
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1404 <EOL>, set the 'endofline' option. You can also read the value of this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1405 option to see if there was an <EOL> for the last line (you cannot see this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1406 in the text).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1407
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1408 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1409 9. Encryption *encryption*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1410
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1411 Vim is able to write files encrypted, and read them back. The encrypted text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1412 cannot be read without the right key.
2283
7e1bd501306d Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents: 2267
diff changeset
1413 {only available when compiled with the |+cryptv| feature} *E833*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1414
2662
916c90b37ea9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
1415 The text in the swap file and the undo file is also encrypted. *E843*
6070
32a77cc160d9 Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
1416 However, this is done block-by-block and may reduce the time needed to crack a
32a77cc160d9 Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
1417 password. You can disable the swap file, but then a crash will cause you to
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14421
diff changeset
1418 lose your work. The undo file can be disabled without too much disadvantage. >
6070
32a77cc160d9 Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
1419 :set noundofile
32a77cc160d9 Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
1420 :noswapfile edit secrets
2267
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2264
diff changeset
1421
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2264
diff changeset
1422 Note: The text in memory is not encrypted. A system administrator may be able
c08f91142c41 Crypt the swapfile.
Bram Moolenaar <bram@vim.org>
parents: 2264
diff changeset
1423 to see your text while you are editing it. When filtering text with
6122
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1424 ":!filter" or using ":w !command" the text is also not encrypted, this may
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1425 reveal it to others. The 'viminfo' file is not encrypted.
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1426
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1427 You could do this to edit very secret text: >
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1428 :set noundofile viminfo=
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1429 :noswapfile edit secrets.txt
7051
eff26a8620ce commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents: 7013
diff changeset
1430 Keep in mind that without a swap file you risk losing your work in the event
7013
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
1431 of a crash or a power failure.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1432
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1433 WARNING: If you make a typo when entering the key and then write the file and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1434 exit, the text will be lost!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1435
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1436 The normal way to work with encryption, is to use the ":X" command, which will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1437 ask you to enter a key. A following write command will use that key to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1438 encrypt the file. If you later edit the same file, Vim will ask you to enter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1439 a key. If you type the same key as that was used for writing, the text will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1440 be readable again. If you use a wrong key, it will be a mess.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1441
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1442 *:X*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1443 :X Prompt for an encryption key. The typing is done without showing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1444 actual text, so that someone looking at the display won't see it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1445 The typed key is stored in the 'key' option, which is used to encrypt
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1446 the file when it is written. The file will remain unchanged until you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1447 write it. See also |-x|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1448
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1449 The value of the 'key' options is used when text is written. When the option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1450 is not empty, the written file will be encrypted, using the value as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1451 encryption key. A magic number is prepended, so that Vim can recognize that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1452 the file is encrypted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1453
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1454 To disable the encryption, reset the 'key' option to an empty value: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1455 :set key=
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1456
2360
d8e4b27cef80 Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents: 2345
diff changeset
1457 You can use the 'cryptmethod' option to select the type of encryption, use one
6122
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1458 of these: >
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1459 :setlocal cm=zip " weak method, backwards compatible
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1460 :setlocal cm=blowfish " method with flaws
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1461 :setlocal cm=blowfish2 " medium strong method
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1462
2360
d8e4b27cef80 Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents: 2345
diff changeset
1463 Do this before writing the file. When reading an encrypted file it will be
d8e4b27cef80 Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents: 2345
diff changeset
1464 set automatically to the method used when that file was written. You can
d8e4b27cef80 Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents: 2345
diff changeset
1465 change 'cryptmethod' before writing that file to change the method.
6122
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1466
6369
c5d53d4c3e2e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
1467 To set the default method, used for new files, use this in your |vimrc|
c5d53d4c3e2e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
1468 file: >
6122
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1469 set cm=blowfish2
6369
c5d53d4c3e2e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
1470 Using "blowfish2" is highly recommended. Only use another method if you
c5d53d4c3e2e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
1471 must use an older Vim version that does not support it.
6122
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1472
2725
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
1473 The message given for reading and writing a file will show "[crypted]" when
6122
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1474 using zip, "[blowfish]" when using blowfish, etc.
2180
f60a0c9cbe6c Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
1475
2239
732cb7b31956 Crypt the text in the undo file if the file itself is crypted.
Bram Moolenaar <bram@vim.org>
parents: 2199
diff changeset
1476 When writing an undo file, the same key and method will be used for the text
732cb7b31956 Crypt the text in the undo file if the file itself is crypted.
Bram Moolenaar <bram@vim.org>
parents: 2199
diff changeset
1477 in the undo file. |persistent-undo|.
732cb7b31956 Crypt the text in the undo file if the file itself is crypted.
Bram Moolenaar <bram@vim.org>
parents: 2199
diff changeset
1478
7659
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
1479 To test for blowfish support you can use these conditions: >
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
1480 has('crypt-blowfish')
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
1481 has('crypt-blowfish2')
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
1482 This works since Vim 7.4.1099 while blowfish support was added earlier.
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
1483 Thus the condition failing doesn't mean blowfish is not supported. You can
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
1484 test for blowfish with: >
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
1485 v:version >= 703
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
1486 And for blowfish2 with: >
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
1487 v:version > 704 || (v:version == 704 && has('patch401'))
7876
93f747af7b58 commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents: 7659
diff changeset
1488 If you are sure Vim includes patch 7.4.237 a simpler check is: >
93f747af7b58 commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents: 7659
diff changeset
1489 has('patch-7.4.401')
7659
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7480
diff changeset
1490 <
2199
014a996ac896 Use UINT32_T in the code, define it to uint32_t or unsigned int.
Bram Moolenaar <bram@vim.org>
parents: 2184
diff changeset
1491 *E817* *E818* *E819* *E820*
2184
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1492 When encryption does not work properly, you would be able to write your text
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1493 to a file and never be able to read it back. Therefore a test is performed to
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1494 check if the encryption works as expected. If you get one of these errors
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1495 don't write the file encrypted! You need to rebuild the Vim binary to fix
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1496 this.
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1497
2264
0256b9c93e87 Update help files.
Bram Moolenaar <bram@vim.org>
parents: 2251
diff changeset
1498 *E831* This is an internal error, "cannot happen". If you can reproduce it,
2251
646d34788036 Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents: 2239
diff changeset
1499 please report to the developers.
646d34788036 Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents: 2239
diff changeset
1500
2184
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1501 When reading a file that has been encrypted and the 'key' option is not empty,
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1502 it will be used for decryption. If the value is empty, you will be prompted
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1503 to enter the key. If you don't enter a key, or you enter the wrong key, the
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1504 file is edited without being decrypted. There is no warning about using the
5028c4d6d825 Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents: 2180
diff changeset
1505 wrong key (this makes brute force methods to find the key more difficult).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1506
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1507 If want to start reading a file that uses a different key, set the 'key'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1508 option to an empty string, so that Vim will prompt for a new one. Don't use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1509 the ":set" command to enter the value, other people can read the command over
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1510 your shoulder.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1511
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1512 Since the value of the 'key' option is supposed to be a secret, its value can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1513 never be viewed. You should not set this option in a vimrc file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1514
2368
9973354ee964 Small docs fixes.
Bram Moolenaar <bram@vim.org>
parents: 2365
diff changeset
1515 An encrypted file can be recognized by the "file" command, if you add these
9973354ee964 Small docs fixes.
Bram Moolenaar <bram@vim.org>
parents: 2365
diff changeset
1516 lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1517 "magic" file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1518 0 string VimCrypt~ Vim encrypted file
2364
151b037b7e74 Fix hang when resizing in diff mode and there are concealed items.
Bram Moolenaar <bram@vim.org>
parents: 2360
diff changeset
1519 >9 string 01 - "zip" cryptmethod
151b037b7e74 Fix hang when resizing in diff mode and there are concealed items.
Bram Moolenaar <bram@vim.org>
parents: 2360
diff changeset
1520 >9 string 02 - "blowfish" cryptmethod
6122
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1521 >9 string 03 - "blowfish2" cryptmethod
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1522
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1523 Notes:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1524 - Encryption is not possible when doing conversion with 'charconvert'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1525 - Text you copy or delete goes to the numbered registers. The registers can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1526 be saved in the .viminfo file, where they could be read. Change your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1527 'viminfo' option to be safe.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1528 - Someone can type commands in Vim when you walk away for a moment, he should
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1529 not be able to get the key.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1530 - If you make a typing mistake when entering the key, you might not be able to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1531 get your text back!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1532 - If you type the key with a ":set key=value" command, it can be kept in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1533 history, showing the 'key' value in a viminfo file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1534 - There is never 100% safety. The encryption in Vim has not been tested for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1535 robustness.
2581
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
1536 - The algorithm used for 'cryptmethod' "zip" is breakable. A 4 character key
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
1537 in about one hour, a 6 character key in one day (on a Pentium 133 PC). This
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
1538 requires that you know some text that must appear in the file. An expert
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
1539 can break it for any key. When the text has been decrypted, this also means
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
1540 that the key can be revealed, and other files encrypted with the same key
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
1541 can be decrypted.
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
1542 - Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
1543 objection to its export. Pkzip's public file APPNOTE.TXT describes this
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
1544 algorithm in detail.
6259
bd18da914be9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6238
diff changeset
1545 - The implementation of 'cryptmethod' "blowfish" has a flaw. It is possible
bd18da914be9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6238
diff changeset
1546 to crack the first 64 bytes of a file and in some circumstances more of the
6122
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1547 file. Use of it is not recommended, but it's still the strongest method
18ac55444b37 updated for version 7.4.399
Bram Moolenaar <bram@vim.org>
parents: 6070
diff changeset
1548 supported by Vim 7.3 and 7.4. The "zip" method is even weaker.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1549 - Vim originates from the Netherlands. That is where the sources come from.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1550 Thus the encryption code is not exported from the USA.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1551
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1552 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1553 10. Timestamps *timestamp* *timestamps*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1554
5908
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5510
diff changeset
1555 Vim remembers the modification timestamp, mode and size of a file when you
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5510
diff changeset
1556 begin editing it. This is used to avoid that you have two different versions
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5510
diff changeset
1557 of the same file (without you knowing this).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1558
5908
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5510
diff changeset
1559 After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps,
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5510
diff changeset
1560 file modes and file sizes are compared for all buffers in a window. Vim will
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5510
diff changeset
1561 run any associated |FileChangedShell| autocommands or display a warning for
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5510
diff changeset
1562 any files that have changed. In the GUI this happens when Vim regains input
32de51778c27 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5510
diff changeset
1563 focus.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1564
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1565 *E321* *E462*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1566 If you want to automatically reload a file when it has been changed outside of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1567 Vim, set the 'autoread' option. This doesn't work at the moment you write the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1568 file though, only when the file wasn't changed inside of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1569
11400
0f8713fe20dc Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1570 If you do not want to be asked or automatically reload the file, you can use
0f8713fe20dc Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1571 this: >
0f8713fe20dc Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1572 set buftype=nofile
0f8713fe20dc Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1573
0f8713fe20dc Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1574 Or, when starting gvim from a shell: >
0f8713fe20dc Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1575 gvim file.log -c "set buftype=nofile"
0f8713fe20dc Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1576
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1577 Note that if a FileChangedShell autocommand is defined you will not get a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1578 warning message or prompt. The autocommand is expected to handle this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1579
139
a217baa06d43 updated for version 7.0045
vimboss
parents: 42
diff changeset
1580 There is no warning for a directory (e.g., with |netrw-browse|). But you do
a217baa06d43 updated for version 7.0045
vimboss
parents: 42
diff changeset
1581 get warned if you started editing a new file and it was created as a directory
a217baa06d43 updated for version 7.0045
vimboss
parents: 42
diff changeset
1582 later.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1583
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1584 When Vim notices the timestamp of a file has changed, and the file is being
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1585 edited in a buffer but has not changed, Vim checks if the contents of the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1586 is equal. This is done by reading the file again (into a hidden buffer, which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1587 is immediately deleted again) and comparing the text. If the text is equal,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1588 you will get no warning.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1589
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1590 If you don't get warned often enough you can use the following command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1591
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1592 *:checkt* *:checktime*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1593 :checkt[ime] Check if any buffers were changed outside of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1594 This checks and warns you if you would end up with two
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1595 versions of a file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1596 If this is called from an autocommand, a ":global"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1597 command or is not typed the actual check is postponed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1598 until a moment the side effects (reloading the file)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1599 would be harmless.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1600 Each loaded buffer is checked for its associated file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1601 being changed. If the file was changed Vim will take
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1602 action. If there are no changes in the buffer and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1603 'autoread' is set, the buffer is reloaded. Otherwise,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1604 you are offered the choice of reloading the file. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1605 the file was deleted you get an error message.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1606 If the file previously didn't exist you get a warning
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1607 if it exists now.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1608 Once a file has been checked the timestamp is reset,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1609 you will not be warned again.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1610
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1611 :[N]checkt[ime] {filename}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1612 :[N]checkt[ime] [N]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1613 Check the timestamp of a specific buffer. The buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1614 may be specified by name, number or with a pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1615
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1616
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1617 *E813* *E814*
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1618 Vim will reload the buffer if you chose to. If a window is visible that
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1619 contains this buffer, the reloading will happen in the context of this window.
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1620 Otherwise a special window is used, so that most autocommands will work. You
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1621 can't close this window. A few other restrictions apply. Best is to make
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1622 sure nothing happens outside of the current buffer. E.g., setting
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1623 window-local options may end up in the wrong window. Splitting the window,
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1624 doing something there and closing it should be OK (if there are no side
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1625 effects from other autocommands). Closing unrelated windows and buffers will
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1626 get you into trouble.
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1627
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1628 Before writing a file the timestamp is checked. If it has changed, Vim will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1629 ask if you really want to overwrite the file:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1630
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1631 WARNING: The file has been changed since reading it!!!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1632 Do you really want to write to it (y/n)?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1633
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1634 If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1635 aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1636 chance to write the file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1637
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1638 The message would normally mean that somebody has written to the file after
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1639 the edit session started. This could be another person, in which case you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1640 probably want to check if your changes to the file and the changes from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1641 other person should be merged. Write the file under another name and check for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1642 differences (the "diff" program can be used for this).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1643
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1644 It is also possible that you modified the file yourself, from another edit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1645 session or with another command (e.g., a filter command). Then you will know
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1646 which version of the file you want to keep.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1647
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1648 There is one situation where you get the message while there is nothing wrong:
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1649 On a Win32 system on the day daylight saving time starts. There is something
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1650 in the Win32 libraries that confuses Vim about the hour time difference. The
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1651 problem goes away the next day.
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1652
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1653 ==============================================================================
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1654 11. File Searching *file-searching*
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1655
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1656 {not available when compiled without the |+path_extra| feature}
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1657
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1658 The file searching is currently used for the 'path', 'cdpath' and 'tags'
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1659 options, for |finddir()| and |findfile()|. Other commands use |wildcards|
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1660 which is slightly different.
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 874
diff changeset
1661
e63691e7c504 updated for version 7.1a
vimboss
parents: 874
diff changeset
1662 There are three different types of searching:
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1663
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 280
diff changeset
1664 1) Downward search: *starstar*
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1665 Downward search uses the wildcards '*', '**' and possibly others
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1666 supported by your operating system. '*' and '**' are handled inside Vim,
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1667 so they work on all operating systems. Note that "**" only acts as a
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1668 special wildcard when it is at the start of a name.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1669
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
1670 The usage of '*' is quite simple: It matches 0 or more characters. In a
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
1671 search pattern this would be ".*". Note that the "." is not used for file
73fe8baea242 updated for version 7.2a
vimboss
parents: 1240
diff changeset
1672 searching.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1673
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1674 '**' is more sophisticated:
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1675 - It ONLY matches directories.
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1676 - It matches up to 30 directories deep by default, so you can use it to
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1677 search an entire directory tree
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1678 - The maximum number of levels matched can be given by appending a number
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1679 to '**'.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1680 Thus '/usr/**2' can match: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1681 /usr
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1682 /usr/include
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1683 /usr/include/sys
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1684 /usr/include/g++
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1685 /usr/lib
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1686 /usr/lib/X11
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1687 ....
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1688 < It does NOT match '/usr/include/g++/std' as this would be three
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1689 levels.
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1690 The allowed number range is 0 ('**0' is removed) to 100
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1691 If the given number is smaller than 0 it defaults to 30, if it's
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1692 bigger than 100 then 100 is used. The system also has a limit on the
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1693 path length, usually 256 or 1024 bytes.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1694 - '**' can only be at the end of the path or be followed by a path
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1695 separator or by a number and a path separator.
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1696
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1697 You can combine '*' and '**' in any order: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1698 /usr/**/sys/*
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
1699 /usr/*tory/sys/**
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1700 /usr/**2/sys/*
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1701
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1702 2) Upward search:
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1703 Here you can give a directory and then search the directory tree upward for
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1704 a file. You could give stop-directories to limit the upward search. The
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1705 stop-directories are appended to the path (for the 'path' option) or to
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1706 the filename (for the 'tags' option) with a ';'. If you want several
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1707 stop-directories separate them with ';'. If you want no stop-directory
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1708 ("search upward till the root directory) just use ';'. >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1709 /usr/include/sys;/usr
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1710 < will search in: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1711 /usr/include/sys
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1712 /usr/include
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1713 /usr
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1714 <
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1715 If you use a relative path the upward search is started in Vim's current
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1716 directory or in the directory of the current file (if the relative path
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1717 starts with './' and 'd' is not included in 'cpoptions').
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1718
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1719 If Vim's current path is /u/user_x/work/release and you do >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1720 :set path=include;/u/user_x
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1721 < and then search for a file with |gf| the file is searched in: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1722 /u/user_x/work/release/include
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1723 /u/user_x/work/include
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1724 /u/user_x/include
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1725
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1726 3) Combined up/downward search:
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1727 If Vim's current path is /u/user_x/work/release and you do >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1728 set path=**;/u/user_x
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1729 < and then search for a file with |gf| the file is searched in: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1730 /u/user_x/work/release/**
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1731 /u/user_x/work/**
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1732 /u/user_x/**
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1733 <
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1734 BE CAREFUL! This might consume a lot of time, as the search of
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1735 '/u/user_x/**' includes '/u/user_x/work/**' and
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1736 '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 167
diff changeset
1737 three times and '/u/user_x/work/**' is searched twice.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1738
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1739 In the above example you might want to set path to: >
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1740 :set path=**,/u/user_x/**
2429
7ce8b24450dc Improvements for ":find" completion. (Nazri Ramliy)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1741 < This searches:
7ce8b24450dc Improvements for ":find" completion. (Nazri Ramliy)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1742 /u/user_x/work/release/** ~
7ce8b24450dc Improvements for ":find" completion. (Nazri Ramliy)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1743 /u/user_x/** ~
7ce8b24450dc Improvements for ":find" completion. (Nazri Ramliy)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1744 This searches the same directories, but in a different order.
39
410fa1a31baf updated for version 7.0023
vimboss
parents: 31
diff changeset
1745
2429
7ce8b24450dc Improvements for ":find" completion. (Nazri Ramliy)
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
1746 Note that completion for ":find", ":sfind", and ":tabfind" commands do not
11914
4f7081eb1e26 Updated runtime files
Christian Brabandt <cb@256bit.org>
parents: 11676
diff changeset
1747 currently work with 'path' items that contain a URL or use the double star
3456
4dde9b516e72 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3445
diff changeset
1748 with depth limiter (/usr/**2) or upward search (;) notations.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1749
14421
2f7e67dd088c Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14249
diff changeset
1750 vim:tw=78:ts=8:noet:ft=help:norl: