os_dos.txt (15699B)
1 *os_dos.txt* For Vim version 9.2. Last change: 2026 Feb 14 2 3 4 VIM REFERENCE MANUAL by Bram Moolenaar 5 6 7 *dos* *DOS* 8 This file documents the common particularities of the MS-DOS and Win32 9 versions of Vim. Also see |os_win32.txt| and |os_msdos.txt|. 10 11 1. File locations |dos-locations| 12 2. Using backslashes |dos-backslash| 13 3. Standard mappings |dos-standard-mappings| 14 4. Screen output and colors |dos-colors| 15 5. File formats |dos-file-formats| 16 6. :cd command |dos-:cd| 17 7. Interrupting |dos-CTRL-Break| 18 8. Temp files |dos-temp-files| 19 9. Shell option default |dos-shell| 20 10. PowerShell |dos-powershell| 21 22 ============================================================================== 23 1. File locations *dos-locations* 24 25 If you keep the Vim executable in the directory that contains the help and 26 syntax subdirectories, there is no need to do anything special for Vim to 27 work. No registry entries or environment variables need to be set. Just make 28 sure that the directory is in your search path, or use a shortcut on the 29 desktop. 30 31 Your vimrc files ("_vimrc" and "_gvimrc") are normally located one directory 32 up from the runtime files. If you want to put them somewhere else, set the 33 environment variable $VIM to the directory where you keep them. Example: > 34 set VIM=C:\user\piet 35 Will find "c:\user\piet\_vimrc". 36 Note: This would only be needed when the computer is used by several people. 37 Otherwise it's simpler to keep your _vimrc file in the default place. 38 39 If you move the executable to another location, you also need to set the $VIM 40 environment variable. The runtime files will be found in "$VIM/vim{version}". 41 Example: > 42 set VIM=E:\vim 43 Will find the version 8.2 runtime files in "e:\vim\vim82". 44 Note: This is _not_ recommended. The preferred way is to keep the executable 45 in the runtime directory. 46 47 If you move your executable AND want to put your "_vimrc" and "_gvimrc" files 48 somewhere else, you must set $VIM to where you vimrc files are, and set 49 $VIMRUNTIME to the runtime files. Example: > 50 set VIM=C:\usr\piet 51 set VIMRUNTIME=E:\vim\vim82 52 Will find "c:\user\piet\_vimrc" and the runtime files in "e:\vim\vim82". 53 54 See |$VIM| and |$VIMRUNTIME| for more information. 55 56 You can set environment variables for each user separately through the 57 System Properties dialog box. The steps to do that: 58 1. Type Windows Key + R to open the "Run" dialog box. 59 2. Enter "sysdm.cpl" and press the "OK" button. The "System Properties" 60 dialog box will open. 61 3. Select the "Advanced" tab and press the "Environment Variables..." button. 62 The "Environment Variables" dialog box will open. 63 4. Select an existing variable in the "User variables" list and press the 64 "Edit..." button to edit it. Or press the "New..." button to add a new 65 variable. 66 5. After you finished editing variables, press the "OK" button to save the 67 changes. 68 69 ============================================================================== 70 2. Using backslashes *dos-backslash* 71 72 Using backslashes in file names can be a problem. Vi halves the number of 73 backslashes for some commands. Vim is a bit more tolerant and does not remove 74 backslashes from a file name, so ":e c:\foo\bar" works as expected. But when 75 a backslash occurs before a special character (space, comma, backslash, etc.), 76 Vim removes the backslash. Use slashes to avoid problems: ":e c:/foo/bar" 77 works fine. Vim replaces the slashes with backslashes internally to avoid 78 problems with some MS-DOS programs and Win32 programs. 79 80 When you prefer to use forward slashes, set the 'shellslash' option. Vim will 81 then replace backslashes with forward slashes when expanding file names. This 82 is especially useful when using a Unix-like 'shell'. 83 84 ============================================================================== 85 3. Standard mappings *dos-standard-mappings* 86 87 The mappings for CTRL-PageUp and CTRL-PageDown have been removed, they now 88 jump to the next or previous tab page |<C-PageUp>| |<C-PageDown>| 89 90 If you want them to move to the first and last screen line you can use these 91 mappings: 92 93 key key code Normal/Visual mode Insert mode ~ 94 CTRL-PageUp <M-N><M-C-D> H <C-O>H 95 CTRL-PageDown <M-N>v L$ <C-O>L<C-O>$ 96 97 Additionally, these keys are available for copy/cut/paste. In the Win32 98 and DJGPP versions, they also use the clipboard. 99 100 Shift-Insert paste text (from clipboard) *<S-Insert>* 101 CTRL-Insert copy Visual text (to clipboard) *<C-Insert>* 102 CTRL-Del cut Visual text (to clipboard) *<C-Del>* 103 Shift-Del cut Visual text (to clipboard) *<S-Del>* 104 CTRL-X cut Visual text (to clipboard) 105 106 These mappings accomplish this (Win32 and DJGPP versions of Vim): 107 108 key key code Normal Visual Insert ~ 109 Shift-Insert <M-N><M-T> "*P "-d"*P <C-R><C-O>* 110 CTRL-Insert <M-N><M-U> "*y 111 Shift-Del <M-N><M-W> "*d 112 CTRL-Del <M-N><M-X> "*d 113 CTRL-X <C-X> "*d 114 115 Or these mappings (non-Win32 version of Vim): 116 117 key key code Normal Visual Insert ~ 118 Shift-Insert <M-N><M-T> P "-dP <C-R><C-O>" 119 CTRL-Insert <M-N><M-U> y 120 Shift-Del <M-N><M-W> d 121 CTRL-Del <M-N><M-X> d 122 123 When the clipboard is supported, the "* register is used. 124 125 ============================================================================== 126 4. Screen output and colors *dos-colors* 127 128 The default output method for the screen is to use bios calls. This works 129 right away on most systems. You do not need ansi.sys. You can use ":mode" to 130 set the current screen mode. See |:mode|. 131 132 To change the screen colors that Vim uses, you can use the |:highlight| 133 command. The Normal highlight group specifies the colors Vim uses for normal 134 text. For example, to get grey text on a blue background: > 135 :hi Normal ctermbg=Blue ctermfg=grey 136 See |highlight-groups| for other groups that are available. 137 138 A DOS console does not support attributes like bold and underlining. You can 139 set the color used in five modes with nine terminal options. Note that this 140 is not necessary since you can set the color directly with the ":highlight" 141 command; these options are for backward compatibility with older Vim versions. 142 The 'highlight' option specifies which of the five modes is used for which 143 action. > 144 145 :set t_mr=^V^[\|xxm start of invert mode 146 :set t_md=^V^[\|xxm start of bold mode 147 :set t_me=^V^[\|xxm back to normal text 148 149 :set t_so=^V^[\|xxm start of standout mode 150 :set t_se=^V^[\|xxm back to normal text 151 152 :set t_us=^V^[\|xxm start of underline mode 153 :set t_ue=^V^[\|xxm back to normal text 154 155 :set t_ZH=^V^[\|xxm start of italics mode 156 :set t_ZR=^V^[\|xxm back to normal text 157 158 ^V is CTRL-V 159 ^[ is <Esc> 160 You must replace xx with a decimal code, which is the foreground color number 161 and background color number added together: 162 163 COLOR FOREGROUND BACKGROUND ~ 164 Black 0 0 165 DarkBlue 1 16 166 DarkGreen 2 32 167 DarkCyan 3 48 168 DarkRed 4 64 169 DarkMagenta 5 80 170 Brown, DarkYellow 6 96 171 LightGray 7 112 172 DarkGray 8 128 * 173 Blue, LightBlue 9 144 * 174 Green, LightGreen 10 160 * 175 Cyan, LightCyan 11 176 * 176 Red, LightRed 12 192 * 177 Magenta, LightMagenta 13 208 * 178 Yellow, LightYellow 14 224 * 179 White 15 240 * 180 181 * Depending on the display mode, the color codes above 128 may not be 182 available, and code 128 will make the text blink. 183 184 When you use 0, the color is reset to the one used when you started Vim 185 (usually 7, lightgray on black, but you can override this. If you have 186 overridden the default colors in a command prompt, you may need to adjust 187 some of the highlight colors in your vimrc---see below). 188 This is the default for t_me. 189 190 The defaults for the various highlight modes are: 191 t_mr 112 reverse mode: Black text (0) on LightGray (112) 192 t_md 15 bold mode: White text (15) on Black (0) 193 t_me 0 normal mode (revert to default) 194 195 t_so 31 standout mode: White (15) text on DarkBlue (16) 196 t_se 0 standout mode end (revert to default) 197 198 t_ZH 225 italic mode: DarkBlue text (1) on Yellow (224) 199 t_ZR 0 italic mode end (revert to default) 200 201 t_us 67 underline mode: DarkCyan text (3) on DarkRed (64) 202 t_ue 0 underline mode end (revert to default) 203 204 These colors were chosen because they also look good when using an inverted 205 display, but you can change them to your liking. 206 207 Example: > 208 :set t_mr=^V^[\|97m " start of invert mode: DarkBlue (1) on Brown (96) 209 :set t_md=^V^[\|67m " start of bold mode: DarkCyan (3) on DarkRed (64) 210 :set t_me=^V^[\|112m " back to normal mode: Black (0) on LightGray (112) 211 212 :set t_so=^V^[\|37m " start of standout mode: DarkMagenta (5) on DarkGreen 213 (32) 214 :set t_se=^V^[\|112m " back to normal mode: Black (0) on LightGray (112) 215 216 ============================================================================== 217 5. File formats *dos-file-formats* 218 219 If the 'fileformat' option is set to "dos" (which is the default), Vim accepts 220 a single <NL> or a <CR><NL> pair for end-of-line (<EOL>). When writing a 221 file, Vim uses <CR><NL>. Thus, if you edit a file and write it, Vim replaces 222 <NL> with <CR><NL>. 223 224 If the 'fileformat' option is set to "unix", Vim uses a single <NL> for <EOL> 225 and shows <CR> as ^M. 226 227 You can use Vim to replace <NL> with <CR><NL> by reading in any mode and 228 writing in Dos mode (":se ff=dos"). 229 You can use Vim to replace <CR><NL> with <NL> by reading in Dos mode and 230 writing in Unix mode (":se ff=unix"). 231 232 Vim sets 'fileformat' automatically when 'fileformats' is not empty (which is 233 the default), so you don't really have to worry about what you are doing. 234 235 If you want to edit a script file or a binary file, you should set the 236 'binary' option before loading the file. Script files and binary files may 237 contain single <NL> characters which Vim would replace with <CR><NL>. You can 238 set 'binary' automatically by starting Vim with the "-b" (binary) option. 239 240 ============================================================================== 241 6. :cd command *dos-:cd* 242 243 The ":cd" command recognizes the drive specifier and changes the current 244 drive. Use ":cd c:" to make drive C the active drive. Use ":cd d:\foo" to go 245 to the directory "foo" in the root of drive D. Vim also recognizes UNC names 246 if the system supports them; e.g., ":cd \\server\share\dir". |:cd| 247 248 ============================================================================== 249 7. Interrupting *dos-CTRL-Break* 250 251 Use CTRL-Break instead of CTRL-C to interrupt searches. Vim does not detect 252 the CTRL-C until it tries to read a key. 253 254 ============================================================================== 255 8. Temp files *dos-temp-files* 256 257 Only for the 16 bit and 32 bit DOS version: 258 Vim puts temporary files (for filtering) in the first of these directories 259 that exists and in which Vim can create a file: 260 $TMP 261 $TEMP 262 C:\TMP 263 C:\TEMP 264 current directory 265 266 For the Win32 version (both console and GUI): 267 Vim uses standard Windows functions to obtain a temporary file name (for 268 filtering). The first of these directories that exists and in which Vim can 269 create a file is used: 270 $TMP 271 $TEMP 272 current directory 273 274 ============================================================================== 275 9. Shell option default *dos-shell* 276 277 The default for the 'sh' ('shell') option is "command.com" on Windows 95 and 278 "cmd.exe" on Windows NT. If SHELL is defined, Vim uses SHELL instead, and if 279 SHELL is not defined but COMSPEC is, Vim uses COMSPEC. Vim starts external 280 commands with "<shell> /c <command_name>". Typing CTRL-Z starts a new command 281 subshell. Return to Vim with "exit". 'shell' |CTRL-Z| 282 283 If you are running a third-party shell, you may need to set the 284 'shellcmdflag' ('shcf') and 'shellquote' ('shq') or 'shellxquote' 285 ('sxq') options. Unfortunately, this also depends on the version of Vim used. 286 For example, with the MKS Korn shell or with bash, the values of the options 287 should be: 288 289 DOS 16 bit DOS 32 bit Win32 ~ 290 'shellcmdflag' -c -c -c 291 'shellquote' " 292 'shellxquote' " 293 294 For Dos 16 bit this starts the shell as: > 295 <shell> -c "command name" >file 296 For Win32 as: > 297 <shell> -c "command name >file" 298 For DOS 32 bit, DJGPP does this internally somehow. 299 300 When starting up, if Vim does not recognise a standard Windows shell it checks 301 for the presence of "sh" anywhere in the 'shell' option. If it is present, 302 Vim sets the 'shellcmdflag' and 'shellquote' or 'shellxquote' options will be 303 set as described above. 304 305 ============================================================================== 306 10. PowerShell *dos-powershell* *dos-pwsh* 307 308 Vim supports PowerShell Desktop and PowerShell Core. PowerShell Desktop is 309 the version of PowerShell that is installed with Windows, while PowerShell 310 Core is a separate downloadable version that works cross-platform. To see 311 which version you are using then enter the following in a PowerShell prompt - 312 $PSVersionTable.PSEdition 313 314 If 'shell' includes "powershell" in the filename at startup then VIM sets 315 'shellcmdflag', 'shellxquote', 'shellpipe', and 'shellredir' options to the 316 following values: 317 318 'shellcmdflag' -Command 319 'shellxquote' " 320 'shellpipe' 2>&1 | Out-File -Encoding default 321 'shellredir' 2>&1 | Out-File -Encoding default 322 323 If 'shell' includes "pwsh" in the filename at startup then VIM sets 324 'shellcmdflag', 'shellxquote', 'shellpipe', and 'shellredir' options to the 325 following values: 326 327 'shellcmdflag' -c 328 'shellxquote' " 329 'shellpipe' >%s 2>&1 330 'shellredir' >%s 2>&1 331 332 Note: those options are only set after reading the |.vimrc| file, in 333 particular setting the 'shell' option via |-c| is too late to take effect for 334 the other shell related settings. Consider using |--cmd| to override this 335 option via the command line. 336 337 If you find that PowerShell commands are taking a long time to run then try 338 with "-NoProfile" at the beginning of the 'shellcmdflag'. Note this will 339 prevent any PowerShell environment setup by the profile from taking place. 340 341 If you have problems running PowerShell scripts through the 'shell' then try 342 with "-ExecutionPolicy RemoteSigned -Command" at the beginning of 343 'shellcmdflag'. See online Windows documentation for more information on 344 PowerShell Execution Policy settings. 345 346 See |option-backslash| about including spaces in 'shellcmdflag' when using 347 multiple flags. 348 349 The 'shellpipe' and 'shellredir' option values re-encode the UTF-16LE output 350 from PowerShell Desktop to your currently configured console codepage. The 351 output can be forced into a different encoding by changing "default" to one of 352 the following: 353 354 unicode - UTF-16LE (default output from PowerShell 5.1) 355 bigendianunicode - UTF-16 356 utf8 - UTF-8 357 utf7 - UTF-7 (no BOM) 358 utf32 - UTF-32 359 ascii - 7-bit ASCII character set 360 default - System's active code page (typically ANSI) 361 oem - System's current OEM code page 362 363 Note The above multi-byte Unicode encodings include a leading BOM unless 364 otherwise indicated. 365 366 By default PowerShell Core's output is UTF-8 encoded without a BOM. If you 367 want to force the output of PowerShell Core into a different encoding then set 368 'shellredir' and 'shellpipe' to "2>&1 | Out-File -Encoding encoding" where 369 encoding is one of the following: 370 371 ascii - 7-bit ASCII character set 372 bigendianunicode - UTF-16BE 373 bigendianutf32 - UTF-32BE 374 oem - System's current OEM code page 375 unicode - UTF-16LE 376 utf7 - UTF-7 377 utf8 - UTF-8 378 utf8BOM - UTF-8, with BOM 379 utf8NoBOM - UTF-8, no BOM (default output from PowerShell Core) 380 utf32 - UTF-32 381 382 Since PowerShell Core 6.2, the Encoding parameter also supports specifying a 383 numeric ID of a registered code page (-Encoding 1251) or string names of 384 registered code pages (-Encoding "windows-1251"). The .NET documentation for 385 Encoding.CodePage has more information 386 387 vim:tw=78:ts=8:noet:ft=help:norl: