| blob | bd83bcfd39931fbbb1a1b1af538418401c77892d |
1 *pi_netrw.txt* For Vim version 7.2. Last change: 2008 Sep 02
3 -----------------------------------------------------
4 NETRW REFERENCE MANUAL by Charles E. Campbell, Jr.
5 -----------------------------------------------------
8 *dav* *ftp* *netrw-file* *Nread* *rcp* *scp*
9 *davs* *http* *netrw.vim* *Nsource* *rsync* *sftp*
10 *fetch* *netrw* *network* *Nwrite*
12 ==============================================================================
13 1. Contents *netrw-contents* {{{1
15 1. Contents.............................................|netrw-contents|
16 2. Starting With Netrw..................................|netrw-start|
17 3. Netrw Reference......................................|netrw-ref|
18 EXTERNAL APPLICATIONS AND PROTOCOLS................|netrw-externapp|
19 READING............................................|netrw-read|
20 WRITING............................................|netrw-write|
21 DIRECTORY LISTING..................................|netrw-dirlist|
22 CHANGING THE USERID AND PASSWORD...................|netrw-chgup|
23 VARIABLES AND SETTINGS.............................|netrw-variables|
24 PATHS..............................................|netrw-path|
25 4. Network-Oriented File Transfer.......................|netrw-xfer|
26 NETRC..............................................|netrw-netrc|
27 PASSWORD...........................................|netrw-passwd|
28 5. Activation...........................................|netrw-activate|
29 6. Transparent File Editing.............................|netrw-transparent|
30 7. Ex Commands..........................................|netrw-ex|
31 8. Variables and Options................................|netrw-var|
32 9. Browsing.............................................|netrw-browse|
33 Introduction To Browsing...........................|netrw-intro-browse|
34 Quick Reference: Maps..............................|netrw-browse-maps|
35 Quick Reference: Commands..........................|netrw-browse-cmds|
36 Bookmarking A Directory............................|netrw-mb|
37 Browsing...........................................|netrw-cr|
38 Browsing With A Horizontally Split Window..........|netrw-o|
39 Browsing With A New Tab............................|netrw-t|
40 Browsing With A Vertically Split Window............|netrw-v|
41 Change Listing Style...............................|netrw-i|
42 Changing To A Bookmarked Directory.................|netrw-gb|
43 Changing To A Predecessor Directory................|netrw-u|
44 Changing To A Successor Directory..................|netrw-U|
45 Customizing Browsing With A User Function..........|netrw-x|
46 Deleting Files Or Directories......................|netrw-D|
47 Directory Exploring Commands.......................|netrw-explore|
48 Exploring With Stars and Patterns..................|netrw-star|
49 Displaying Information About File..................|netrw-qf|
50 Edit File Or Directory Hiding List.................|netrw-ctrl-h|
51 Editing The Sorting Sequence.......................|netrw-S|
52 Going Up...........................................|netrw--|
53 Hiding Files Or Directories........................|netrw-a|
54 Improving Browsing.................................|netrw-ssh-hack|
55 Listing Bookmarks And History......................|netrw-qb|
56 Making A New Directory.............................|netrw-d|
57 Making The Browsing Directory The Current Directory|netrw-c|
58 Marking Files......................................|netrw-mf|
59 Marking Files By Regular Expression................|netrw-mr|
60 Marked Files: Arbitrary Command....................|netrw-mx|
61 Marked Files: Compression And Decompression........|netrw-mz|
62 Marked Files: Copying..............................|netrw-mc|
63 Marked Files: Diff.................................|netrw-md|
64 Marked Files: Editing..............................|netrw-me|
65 Marked Files: Grep.................................|netrw-mg|
66 Marked Files: Hiding and Unhiding by Suffix........|netrw-mh|
67 Marked Files: Moving...............................|netrw-mm|
68 Marked Files: Printing.............................|netrw-mp|
69 Marked Files: Sourcing.............................|netrw-ms|
70 Marked Files: Tagging..............................|netrw-mT|
71 Marked Files: Setting the Target Directory.........|netrw-mt|
72 Marked Files: Unmarking............................|netrw-mu|
73 Netrw Browser Variables............................|netrw-browser-var|
74 Netrw Browsing And Option Incompatibilities........|netrw-incompatible|
75 Netrw Settings.....................................|netrw-settings|
76 Obtaining A File...................................|netrw-O|
77 Preview Window.....................................|netrw-p|
78 Previous Window....................................|netrw-P|
79 Refreshing The Listing.............................|netrw-ctrl-l|
80 Renaming Files Or Directories......................|netrw-move|
81 Reversing Sorting Order............................|netrw-r|
82 Selecting Sorting Style............................|netrw-s|
83 10. Problems and Fixes...................................|netrw-problems|
84 11. Debugging Netrw Itself...............................|netrw-debug|
85 12. History..............................................|netrw-history|
86 13. Credits..............................................|netrw-credits|
88 {Vi does not have any of this}
90 ==============================================================================
91 2. Starting With Netrw *netrw-start* {{{1
93 Netrw makes reading files, writing files, browsing over a network, and
94 browsing locally easy! First, make sure that you have plugins enabled, so
95 you'll need to have at least the following in your <.vimrc>:
96 (or see |netrw-activate|) >
98 set nocp " 'compatible' is not set
99 filetype plugin on " plugins are enabled
100 <
101 (see |'cp'| and |:filetype-plugin-on|)
103 Netrw supports "transparent" editing of files on other machines using urls
104 (see |netrw-transparent|). As an example of this, let's assume you have an
105 account on some other machine; if you can use scp, try: >
107 vim scp://hostname/path/to/file
108 <
109 Want to make ssh/scp easier to use? Check out |netrw-ssh-hack|!
111 So, what if you have ftp, not ssh/scp? That's easy, too; try >
113 vim ftp://hostname/path/to/file
114 <
115 Want to make ftp simpler to use? See if your ftp supports a file called
116 <.netrc> -- typically it goes in your home directory, has read/write
117 permissions for only the user to read (ie. not group, world, other, etc),
118 and has lines resembling >
120 machine HOSTNAME login USERID password "PASSWORD"
121 machine HOSTNAME login USERID password "PASSWORD"
122 ...
123 default login USERID password "PASSWORD"
124 <
125 Now about browsing -- when you just want to look around before editing a
126 file. For browsing on your current host, just "edit" a directory: >
128 vim .
129 vim /home/userid/path
130 <
131 For browsing on a remote host, "edit" a directory (but make sure that
132 the directory name is followed by a "/"): >
134 vim scp://hostname/
135 vim ftp://hostname/path/to/dir/
136 <
137 See |netrw-browse| for more!
139 There are more protocols supported by netrw just than scp and ftp, too: see the
140 next section, |netrw-externapp|, for how to use these external applications.
142 If you want to use plugins, but for some reason don't wish to use netrw, then
143 you need to avoid loading both the plugin and the autoload portions of netrw.
144 You may do so by placing the following two lines in your <.vimrc>: >
146 :let g:loaded_netrw = 1
147 :let g:loaded_netrwPlugin = 1
148 <
150 ==============================================================================
151 3. Netrw Reference *netrw-ref* {{{1
153 Netrw supports several protocols in addition to scp and ftp mentioned
154 in |netrw-start|. These include dav, fetch, http,... well, just look
155 at the list in |netrw-externapp|. Each protocol is associated with a
156 variable which holds the default command supporting that protocol.
158 EXTERNAL APPLICATIONS AND PROTOCOLS *netrw-externapp* {{{2
160 Protocol Variable Default Value
161 -------- ---------------- -------------
162 dav: *g:netrw_dav_cmd* = "cadaver"
163 fetch: *g:netrw_fetch_cmd* = "fetch -o" if fetch is available
164 ftp: *g:netrw_ftp_cmd* = "ftp"
165 http: *g:netrw_http_cmd* = "curl -o" if curl is available
166 http: g:netrw_http_cmd = "wget -q -O" elseif wget is available
167 http: g:netrw_http_cmd = "fetch -o" elseif fetch is available
168 rcp: *g:netrw_rcp_cmd* = "rcp"
169 rsync: *g:netrw_rsync_cmd* = "rsync -a"
170 scp: *g:netrw_scp_cmd* = "scp -q"
171 sftp: *g:netrw_sftp_cmd* = "sftp"
173 READING *netrw-read* *netrw-nread* {{{2
175 Generally, one may just use the url notation with a normal editing
176 command, such as >
178 :e ftp://[user@]machine/path
179 <
180 Netrw also provides the Nread command:
182 :Nread ? give help
183 :Nread "machine:path" uses rcp
184 :Nread "machine path" uses ftp w/ <.netrc>
185 :Nread "machine id password path" uses ftp
186 :Nread "dav://machine[:port]/path" uses cadaver
187 :Nread "fetch://[user@]machine/path" uses fetch
188 :Nread "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
189 :Nread "http://[user@]machine/path" uses http uses wget
190 :Nread "rcp://[user@]machine/path" uses rcp
191 :Nread "rsync://[user@]machine[:port]/path" uses rsync
192 :Nread "scp://[user@]machine[[:#]port]/path" uses scp
193 :Nread "sftp://[user@]machine/path" uses sftp
195 WRITING *netrw-write* *netrw-nwrite* {{{2
197 One may just use the url notation with a normal file writing
198 command, such as >
200 :w ftp://[user@]machine/path
201 <
202 Netrw also provides the Nwrite command:
204 :Nwrite ? give help
205 :Nwrite "machine:path" uses rcp
206 :Nwrite "machine path" uses ftp w/ <.netrc>
207 :Nwrite "machine id password path" uses ftp
208 :Nwrite "dav://machine[:port]/path" uses cadaver
209 :Nwrite "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
210 :Nwrite "rcp://[user@]machine/path" uses rcp
211 :Nwrite "rsync://[user@]machine[:port]/path" uses rsync
212 :Nwrite "scp://[user@]machine[[:#]port]/path" uses scp
213 :Nwrite "sftp://[user@]machine/path" uses sftp
214 http: not supported!
216 SOURCING *netrw-source* {{{2
218 One may just use the url notation with the normal file sourcing
219 command, such as >
221 :so ftp://[user@]machine/path
222 <
223 Netrw also provides the Nsource command:
225 :Nsource ? give help
226 :Nsource "dav://machine[:port]/path" uses cadaver
227 :Nsource "fetch://[user@]machine/path" uses fetch
228 :Nsource "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
229 :Nsource "http://[user@]machine/path" uses http uses wget
230 :Nsource "rcp://[user@]machine/path" uses rcp
231 :Nsource "rsync://[user@]machine[:port]/path" uses rsync
232 :Nsource "scp://[user@]machine[[:#]port]/path" uses scp
233 :Nsource "sftp://[user@]machine/path" uses sftp
235 DIRECTORY LISTING *netrw-dirlist* {{{2
237 One may browse a directory to get a listing by simply attempting to
238 edit the directory: >
240 :e scp://[user]@hostname/path/
241 :e ftp://[user]@hostname/path/
242 <
243 For remote directories (ie. those using scp or ftp), that trailing
244 "/" is necessary (it tells netrw that its to treat it as a directory
245 to browse instead of a file to download).
247 However, the Nread command can also be used to accomplish this:
249 :Nread [protocol]://[user]@hostname/path/
251 *netrw-login* *netrw-password*
252 CHANGING USERID AND PASSWORD *netrw-chgup* *netrw-userpass* {{{2
254 Attempts to use ftp will prompt you for a user-id and a password.
255 These will be saved in global variables g:netrw_uid and
256 s:netrw_passwd; subsequent uses of ftp will re-use those two items to
257 simplify the further use of ftp. However, if you need to use a
258 different user id and/or password, you'll want to call NetUserPass()
259 first. To work around the need to enter passwords, check if your ftp
260 supports a <.netrc> file in your home directory. Also see
261 |netrw-passwd| (and if you're using ssh/scp hoping to figure out how
262 to not need to use passwords, look at |netrw-ssh-hack|).
264 :NetUserPass [uid [password]] -- prompts as needed
265 :call NetUserPass() -- prompts for uid and password
266 :call NetUserPass("uid") -- prompts for password
267 :call NetUserPass("uid","password") -- sets global uid and password
269 NETRW VARIABLES AND SETTINGS *netrw-variables* {{{2
270 (also see: |netrw-browser-var| |netrw-protocol| |netrw-settings| |netrw-var|)
272 Netrw provides a lot of variables which allow you to customize netrw to your
273 preferences. One way to look at them is via the command :NetrwSettings (see
274 |netrw-settings|) which will display your current netrw settings. Most such
275 settings are described below, in |netrw-browser-options|, and in
276 |netrw-externapp|:
278 *b:netrw_lastfile* last file Network-read/written retained on a per-buffer
279 basis (supports plain :Nw )
281 *g:netrw_ftp* if it doesn't exist, use default ftp
282 =0 use default ftp (uid password)
283 =1 use alternate ftp method (user uid password)
284 If you're having trouble with ftp, try changing the
285 value of this variable to see if the alternate ftp
286 method works for your setup.
288 *g:netrw_extracmd* default: doesn't exist
289 If this variable exists, then any string it contains
290 will be placed into the commands set to your ftp
291 client. As an example:
292 ="passive"
294 *g:netrw_ftpmode* ="binary" (default)
295 ="ascii"
297 *g:netrw_ignorenetrc* =0 (default for linux, cygwin)
298 =1 If you have a <.netrc> file but it doesn't work and
299 you want it ignored, then set this variable as
300 shown. (default for Windows + cmd.exe)
302 *g:netrw_menu* =0 disable netrw's menu
303 =1 (default) netrw's menu enabled
305 *g:netrw_nogx* if this variable exists, then the "gx" map will not
306 be available (see |netrw-gx|)
308 *g:netrw_uid* (ftp) user-id, retained on a per-session basis
309 *s:netrw_passwd* (ftp) password, retained on a per-session basis
311 *g:netrw_preview* =0 (default) preview window shown in a horizontally
312 split window
313 =1 preview window shown in a vertically split window.
314 Also affects the "previous window" (see |netrw-P|) in
315 the same way.
317 *g:netrw_scpport* = "-P" : option to use to set port for scp
318 *g:netrw_sshport* = "-p" : option to use to set port for ssh
320 *g:netrw_silent* =0 : transfers done normally
321 =1 : transfers done silently
323 *g:netrw_use_errorwindow* =1 : messages from netrw will use a separate one
324 line window. This window provides reliable
325 delivery of messages. (default)
326 =0 : messages from netrw will use echoerr ;
327 messages don't always seem to show up this
328 way, but one doesn't have to quit the window.
330 *g:netrw_win95ftp* =1 if using Win95, will remove four trailing blank
331 lines that o/s's ftp "provides" on transfers
332 =0 force normal ftp behavior (no trailing line removal)
334 *g:netrw_cygwin* =1 assume scp under windows is from cygwin. Also
335 permits network browsing to use ls with time and
336 size sorting (default if windows)
337 =0 assume Windows' scp accepts windows-style paths
338 Network browsing uses dir instead of ls
339 This option is ignored if you're using unix
341 *g:netrw_use_nt_rcp* =0 don't use the rcp of WinNT, Win2000 and WinXP
342 =1 use WinNT's rcp in binary mode (default)
344 PATHS *netrw-path* {{{2
346 Paths to files are generally user-directory relative for most protocols.
347 It is possible that some protocol will make paths relative to some
348 associated directory, however.
349 >
350 example: vim scp://user@host/somefile
351 example: vim scp://user@host/subdir1/subdir2/somefile
352 <
353 where "somefile" is in the "user"'s home directory. If you wish to get a
354 file using root-relative paths, use the full path:
355 >
356 example: vim scp://user@host//somefile
357 example: vim scp://user@host//subdir1/subdir2/somefile
358 <
360 ==============================================================================
361 4. Network-Oriented File Transfer *netrw-xfer* {{{1
363 Network-oriented file transfer under Vim is implemented by a VimL-based script
364 (<netrw.vim>) using plugin techniques. It currently supports both reading and
365 writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch,
366 dav/cadaver, rsync, or sftp.
368 http is currently supported read-only via use of wget or fetch.
370 <netrw.vim> is a standard plugin which acts as glue between Vim and the
371 various file transfer programs. It uses autocommand events (BufReadCmd,
372 FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. >
374 ex. vim ftp://hostname/path/to/file
375 <
376 The characters preceding the colon specify the protocol to use; in the
377 example, it's ftp. The <netrw.vim> script then formulates a command or a
378 series of commands (typically ftp) which it issues to an external program
379 (ftp, scp, etc) which does the actual file transfer/protocol. Files are read
380 from/written to a temporary file (under Unix/Linux, /tmp/...) which the
381 <netrw.vim> script will clean up.
383 *netrw-putty* *netrw-pscp* *netrw-psftp*
384 One may modify any protocol's implementing external application by setting a
385 variable (ex. scp uses the variable g:netrw_scp_cmd, which is defaulted to
386 "scp -q"). As an example, consider using PuTTY: >
388 let g:netrw_scp_cmd = '"c:\Program Files\PuTTY\pscp.exe" -q -batch'
389 let g:netrw_sftp_cmd= '"c:\Program Files\PuTTY\psftp.exe"'
390 <
391 See |netrw-p8| for more about putty, pscp, psftp, etc.
393 Ftp, an old protocol, seems to be blessed by numerous implementations.
394 Unfortunately, some implementations are noisy (ie., add junk to the end of the
395 file). Thus, concerned users may decide to write a NetReadFixup() function
396 that will clean up after reading with their ftp. Some Unix systems (ie.,
397 FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is
398 not noisy and more convenient, actually, for <netrw.vim> to use.
399 Consequently, if "fetch" is executable, it will be used to do reads for
400 ftp://... (and http://...) . See |netrw-var| for more about this.
402 For rcp, scp, sftp, and http, one may use network-oriented file transfers
403 transparently; ie.
404 >
405 vim rcp://[user@]machine/path
406 vim scp://[user@]machine/path
407 <
408 If your ftp supports <.netrc>, then it too can be just as transparently used
409 if the needed triad of machine name, user id, and password are present in
410 that file. Your ftp must be able to use the <.netrc> file on its own, however.
411 >
412 vim ftp://[user@]machine[[:#]portnumber]/path
413 <
414 However, ftp will often need to query the user for the userid and password.
415 The latter will be done "silently"; ie. asterisks will show up instead of
416 the actually-typed-in password. Netrw will retain the userid and password
417 for subsequent read/writes from the most recent transfer so subsequent
418 transfers (read/write) to or from that machine will take place without
419 additional prompting.
421 *netrw-urls*
422 +=================================+============================+============+
423 | Reading | Writing | Uses |
424 +=================================+============================+============+
425 | DAV: | | |
426 | dav://host/path | | cadaver |
427 | :Nread dav://host/path | :Nwrite dav://host/path | cadaver |
428 +---------------------------------+----------------------------+------------+
429 | DAV + SSL: | | |
430 | davs://host/path | | cadaver |
431 | :Nread davs://host/path | :Nwrite davs://host/path | cadaver |
432 +---------------------------------+----------------------------+------------+
433 | FETCH: | | |
434 | fetch://[user@]host/path | | |
435 | fetch://[user@]host:http/path | Not Available | fetch |
436 | :Nread fetch://[user@]host/path| | |
437 +---------------------------------+----------------------------+------------+
438 | FILE: | | |
439 | file:///* | file:///* | |
440 | file://localhost/* | file://localhost/* | |
441 +---------------------------------+----------------------------+------------+
442 | FTP: (*3) | (*3) | |
443 | ftp://[user@]host/path | ftp://[user@]host/path | ftp (*2) |
444 | :Nread ftp://host/path | :Nwrite ftp://host/path | ftp+.netrc |
445 | :Nread host path | :Nwrite host path | ftp+.netrc |
446 | :Nread host uid pass path | :Nwrite host uid pass path | ftp |
447 +---------------------------------+----------------------------+------------+
448 | HTTP: wget is executable: (*4) | | |
449 | http://[user@]host/path | Not Available | wget |
450 +---------------------------------+----------------------------+------------+
451 | HTTP: fetch is executable (*4) | | |
452 | http://[user@]host/path | Not Available | fetch |
453 +---------------------------------+----------------------------+------------+
454 | RCP: | | |
455 | rcp://[user@]host/path | rcp://[user@]host/path | rcp |
456 +---------------------------------+----------------------------+------------+
457 | RSYNC: | | |
458 | rsync://[user@]host/path | rsync://[user@]host/path | rsync |
459 | :Nread rsync://host/path | :Nwrite rsync://host/path | rsync |
460 | :Nread rcp://host/path | :Nwrite rcp://host/path | rcp |
461 +---------------------------------+----------------------------+------------+
462 | SCP: | | |
463 | scp://[user@]host/path | scp://[user@]host/path | scp |
464 | :Nread scp://host/path | :Nwrite scp://host/path | scp (*1) |
465 +---------------------------------+----------------------------+------------+
466 | SFTP: | | |
467 | sftp://[user@]host/path | sftp://[user@]host/path | sftp |
468 | :Nread sftp://host/path | :Nwrite sftp://host/path | sftp (*1) |
469 +=================================+============================+============+
471 (*1) For an absolute path use scp://machine//path.
473 (*2) if <.netrc> is present, it is assumed that it will
474 work with your ftp client. Otherwise the script will
475 prompt for user-id and password.
477 (*3) for ftp, "machine" may be machine#port or machine:port
478 if a different port is needed than the standard ftp port
480 (*4) for http:..., if wget is available it will be used. Otherwise,
481 if fetch is available it will be used.
483 Both the :Nread and the :Nwrite ex-commands can accept multiple filenames.
486 NETRC *netrw-netrc*
488 The <.netrc> file, typically located in your home directory, contains lines
489 therein which map a hostname (machine name) to the user id and password you
490 prefer to use with it.
492 The typical syntax for lines in a <.netrc> file is given as shown below.
493 Ftp under Unix usually supports <.netrc>; ftp under Windows usually doesn't.
494 >
495 machine {full machine name} login {user-id} password "{password}"
496 default login {user-id} password "{password}"
498 Your ftp client must handle the use of <.netrc> on its own, but if the
499 <.netrc> file exists, an ftp transfer will not ask for the user-id or
500 password.
502 Note:
503 Since this file contains passwords, make very sure nobody else can
504 read this file! Most programs will refuse to use a .netrc that is
505 readable for others. Don't forget that the system administrator can
506 still read the file! Ie. for Linux/Unix: chmod 600 .netrc
509 PASSWORD *netrw-passwd*
511 The script attempts to get passwords for ftp invisibly using |inputsecret()|,
512 a built-in Vim function. See |netrw-uidpass| for how to change the password
513 after one has set it.
515 Unfortunately there doesn't appear to be a way for netrw to feed a password to
516 scp. Thus every transfer via scp will require re-entry of the password.
517 However, |netrw-ssh-hack| can help with this problem.
520 ==============================================================================
521 5. Activation *netrw-activate* {{{1
523 Network-oriented file transfers are available by default whenever Vim's
524 |'nocompatible'| mode is enabled. Netrw's script files reside in your
525 system's plugin, autoload, and syntax directories; just the
526 plugin/netrwPlugin.vim script is sourced automatically whenever you bring up
527 vim. The main script in autoload/netrw.vim is only loaded when you actually
528 use netrw. I suggest that, at a minimum, you have at least the following in
529 your <.vimrc> customization file: >
531 set nocp
532 if version >= 600
533 filetype plugin indent on
534 endif
535 <
537 ==============================================================================
538 6. Transparent File Editing *netrw-transparent* {{{1
540 Transparent file transfers occur whenever a regular file read or write
541 (invoked via an |:autocmd| for |BufReadCmd|, |BufWriteCmd|, or |SourceCmd|
542 events) is made. Thus one may read, write, or source files across networks
543 just as easily as if they were local files! >
545 vim ftp://[user@]machine/path
546 ...
547 :wq
549 See |netrw-activate| for more on how to encourage your vim to use plugins
550 such as netrw.
553 ==============================================================================
554 7. Ex Commands *netrw-ex* {{{1
556 The usual read/write commands are supported. There are also a few
557 additional commands available. Often you won't need to use Nwrite or
558 Nread as shown in |netrw-transparent| (ie. simply use >
559 :e url
560 :r url
561 :w url
562 instead, as appropriate) -- see |netrw-urls|. In the explanations
563 below, a {netfile} is an url to a remote file.
565 :[range]Nw[rite] Write the specified lines to the current
566 file as specified in b:netrw_lastfile.
568 :[range]Nw[rite] {netfile} [{netfile}]...
569 Write the specified lines to the {netfile}.
571 :Nr[ead] Read the specified lines into the current
572 buffer from the file specified in
573 b:netrw_lastfile.
575 :Nr[ead] {netfile} {netfile}...
576 Read the {netfile} after the current line.
578 :Ns[ource] {netfile}
579 Source the {netfile}.
580 To start up vim using a remote .vimrc, one may use
581 the following (all on one line) (tnx to Antoine Mechelynck) >
582 vim -u NORC -N
583 --cmd "runtime plugin/netrwPlugin.vim"
584 --cmd "source scp://HOSTNAME/.vimrc"
585 < *netrw-uidpass*
586 :call NetUserPass()
587 If g:netrw_uid and s:netrw_passwd don't exist,
588 this function will query the user for them.
590 :call NetUserPass("userid")
591 This call will set the g:netrw_uid and, if
592 the password doesn't exist, will query the user for it.
594 :call NetUserPass("userid","passwd")
595 This call will set both the g:netrw_uid and s:netrw_passwd.
596 The user-id and password are used by ftp transfers. One may
597 effectively remove the user-id and password by using empty
598 strings (ie. "").
600 :NetrwSettings This command is described in |netrw-settings| -- used to
601 display netrw settings and change netrw behavior.
604 ==============================================================================
605 8. Variables and Options *netrw-options* *netrw-var* {{{1
607 (if you're interested in the netrw browser settings, see: |netrw-browser-var|)
609 The <netrw.vim> script provides several variables which act as options to
610 affect <netrw.vim>'s file transfer behavior. These variables typically may be
611 set in the user's <.vimrc> file: (see also |netrw-settings| |netrw-protocol|)
613 >
615 -------------
616 Netrw Options
617 -------------
618 Option Meaning
619 -------------- -----------------------------------------------
620 <
621 b:netrw_col Holds current cursor position (during NetWrite)
622 g:netrw_cygwin =1 assume scp under windows is from cygwin
623 (default/windows)
624 =0 assume scp under windows accepts windows
625 style paths (default/else)
626 g:netrw_ftp =0 use default ftp (uid password)
627 g:netrw_ftpmode ="binary" (default)
628 ="ascii" (your choice)
629 g:netrw_ignorenetrc =1 (default)
630 if you have a <.netrc> file but you don't
631 want it used, then set this variable. Its
632 mere existence is enough to cause <.netrc>
633 to be ignored.
634 b:netrw_lastfile Holds latest method/machine/path.
635 b:netrw_line Holds current line number (during NetWrite)
636 g:netrw_passwd Holds current password for ftp.
637 g:netrw_silent =0 transfers done normally
638 =1 transfers done silently
639 g:netrw_uid Holds current user-id for ftp.
640 =1 use alternate ftp (user uid password)
641 (see |netrw-options|)
642 g:netrw_use_nt_rcp =0 don't use WinNT/2K/XP's rcp (default)
643 =1 use WinNT/2K/XP's rcp, binary mode
644 g:netrw_win95ftp =0 use unix-style ftp even if win95/98/ME/etc
645 =1 use default method to do ftp >
646 -----------------------------------------------------------------------
647 <
648 The script will also make use of the following variables internally, albeit
649 temporarily.
650 >
651 -------------------
652 Temporary Variables
653 -------------------
654 Variable Meaning
655 -------- ------------------------------------
656 <
657 g:netrw_method Index indicating rcp/ftp+.netrc/ftp
658 g:netrw_machine Holds machine name parsed from input
659 g:netrw_fname Holds filename being accessed >
660 ------------------------------------------------------------
661 <
662 *netrw-protocol*
664 Netrw supports a number of protocols. These protocols are invoked using the
665 variables listed below, and may be modified by the user.
666 >
667 ------------------------
668 Protocol Control Options
669 ------------------------
670 Option Type Setting Meaning
671 --------- -------- -------------- ---------------------------
672 <
673 netrw_ftp variable =doesn't exist userid set by "user userid"
674 =0 userid set by "user userid"
675 =1 userid set by "userid"
676 NetReadFixup function =doesn't exist no change
677 =exists Allows user to have files
678 read via ftp automatically
679 transformed however they wish
680 by NetReadFixup()
681 g:netrw_dav_cmd variable ="cadaver"
682 g:netrw_fetch_cmd variable ="fetch -o" if fetch is available
683 g:netrw_ftp_cmd variable ="ftp"
684 g:netrw_http_cmd variable ="fetch -o" if fetch is available
685 g:netrw_http_cmd variable ="wget -O" else if wget is available
686 g:netrw_list_cmd variable ="ssh USEPORT HOSTNAME ls -Fa"
687 g:netrw_rcp_cmd variable ="rcp"
688 g:netrw_rsync_cmd variable ="rsync -a"
689 g:netrw_scp_cmd variable ="scp -q"
690 g:netrw_sftp_cmd variable ="sftp" >
691 -------------------------------------------------------------------------
692 <
693 *netrw-ftp*
695 The g:netrw_..._cmd options (|g:netrw_ftp_cmd| and |g:netrw_sftp_cmd|)
696 specify the external program to use handle the ftp protocol. They may
697 include command line options (such as -p for passive mode).
699 Browsing is supported by using the |g:netrw_list_cmd|; the substring
700 "HOSTNAME" will be changed via substitution with whatever the current request
701 is for a hostname.
703 Two options (|g:netrw_ftp| and |netrw-fixup|) both help with certain ftp's
704 that give trouble . In order to best understand how to use these options if
705 ftp is giving you troubles, a bit of discussion is provided on how netrw does
706 ftp reads.
708 For ftp, netrw typically builds up lines of one of the following formats in a
709 temporary file:
710 >
711 IF g:netrw_ftp !exists or is not 1 IF g:netrw_ftp exists and is 1
712 ---------------------------------- ------------------------------
713 <
714 open machine [port] open machine [port]
715 user userid password userid password
716 [g:netrw_ftpmode] password
717 [g:netrw_extracmd] [g:netrw_ftpmode]
718 get filename tempfile [g:netrw_extracmd]
719 get filename tempfile >
720 ---------------------------------------------------------------------
721 <
722 The |g:netrw_ftpmode| and |g:netrw_extracmd| are optional.
724 Netrw then executes the lines above by use of a filter:
725 >
726 :%! {g:netrw_ftp_cmd} -i [-n]
727 <
728 where
729 g:netrw_ftp_cmd is usually "ftp",
730 -i tells ftp not to be interactive
731 -n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>)
733 If <.netrc> exists it will be used to avoid having to query the user for
734 userid and password. The transferred file is put into a temporary file.
735 The temporary file is then read into the main editing session window that
736 requested it and the temporary file deleted.
738 If your ftp doesn't accept the "user" command and immediately just demands a
739 userid, then try putting "let netrw_ftp=1" in your <.vimrc>.
741 *netrw-cadaver*
742 To handle the SSL certificate dialog for untrusted servers, one may pull
743 down the certificate and place it into /usr/ssl/cert.pem. This operation
744 renders the server treatment as "trusted".
746 *netrw-fixup* *netreadfixup*
747 If your ftp for whatever reason generates unwanted lines (such as AUTH
748 messages) you may write a NetReadFixup(tmpfile) function:
749 >
750 function! NetReadFixup(method,line1,line2)
751 " a:line1: first new line in current file
752 " a:line2: last new line in current file
753 if a:method == 1 "rcp
754 elseif a:method == 2 "ftp + <.netrc>
755 elseif a:method == 3 "ftp + machine,uid,password,filename
756 elseif a:method == 4 "scp
757 elseif a:method == 5 "http/wget
758 elseif a:method == 6 "dav/cadaver
759 elseif a:method == 7 "rsync
760 elseif a:method == 8 "fetch
761 elseif a:method == 9 "sftp
762 else " complain
763 endif
764 endfunction
765 >
766 The NetReadFixup() function will be called if it exists and thus allows you to
767 customize your reading process. As a further example, <netrw.vim> contains
768 just such a function to handle Windows 95 ftp. For whatever reason, Windows
769 95's ftp dumps four blank lines at the end of a transfer, and so it is
770 desirable to automate their removal. Here's some code taken from <netrw.vim>
771 itself:
772 >
773 if has("win95") && g:netrw_win95ftp
774 fun! NetReadFixup(method, line1, line2)
775 if method == 3 " ftp (no <.netrc>)
776 let fourblanklines= line2 - 3
777 silent fourblanklines.",".line2."g/^\s*/d"
778 endif
779 endfunction
780 endif
781 >
783 ==============================================================================
784 9. Browsing *netrw-browsing* *netrw-browse* *netrw-help* {{{1
785 *netrw-browser* *netrw-dir* *netrw-list*
787 INTRODUCTION TO BROWSING *netrw-intro-browse* {{{2
788 (Quick References: |netrw-quickmaps| |netrw-quickcoms|)
790 Netrw supports the browsing of directories on your local system and on remote
791 hosts; browsing includes listing files and directories, entering directories,
792 editing files therein, deleting files/directories, making new directories,
793 moving (renaming) files and directories, copying files and directories, etc.
794 One may mark files and execute any system command on them! The Netrw browser
795 generally implements the previous explorer's maps and commands for remote
796 directories, although details (such as pertinent global variable names)
797 necessarily differ. To browse a directory, simply "edit" it! >
799 vim /your/directory/
800 vim .
801 vim c:\your\directory\
802 <
803 (Related topics: |netrw-cr| |netrw-o| |netrw-p| |netrw-P| |netrw-t|
804 |netrw-mf| |netrw-mx| |netrw-D| |netrw-R| |netrw-v| )
806 The Netrw remote file and directory browser handles two protocols: ssh and
807 ftp. The protocol in the url, if it is ftp, will cause netrw also to use ftp
808 in its remote browsing. Specifying any other protocol will cause it to be
809 used for file transfers; but the ssh protocol will be used to do remote
810 browsing.
812 To use Netrw's remote directory browser, simply attempt to read a "file" with
813 a trailing slash and it will be interpreted as a request to list a directory:
814 >
815 vim [protocol]://[user@]hostname/path/
816 <
817 where [protocol] is typically scp or ftp. As an example, try: >
819 vim ftp://ftp.home.vim.org/pub/vim/
820 <
821 For local directories, the trailing slash is not required. Again, because its
822 easy to miss: to browse remote directories, the url must terminate with a
823 slash!
825 If you'd like to avoid entering the password repeatedly for remote directory
826 listings with ssh or scp, see |netrw-ssh-hack|. To avoid password entry with
827 ftp, see |netrw-netrc| (if your ftp supports it).
829 There are several things you can do to affect the browser's display of files:
831 * To change the listing style, press the "i" key (|netrw-i|).
832 Currently there are four styles: thin, long, wide, and tree.
834 * To hide files (don't want to see those xyz~ files anymore?) see
835 |netrw-ctrl-h|.
837 * Press s to sort files by name, time, or size.
839 See |netrw-browse-cmds| for all the things you can do with netrw!
842 QUICK HELP *netrw-quickhelp* {{{2
843 (Use ctrl-] to select a topic)~
844 Intro to Browsing...............................|netrw-intro-browse|
845 Quick Reference: Maps.........................|netrw-quickmap|
846 Quick Reference: Commands.....................|netrw-browse-cmds|
847 Hiding
848 Edit hiding list..............................|netrw-ctrl-h|
849 Hiding Files or Directories...................|netrw-a|
850 Hiding/Unhiding by suffix.....................|netrw-mh|
851 Hiding dot-files.............................|netrw-gh|
852 Listing Style
853 Select listing style (thin/long/wide/tree)....|netrw-i|
854 Associated setting variable...................|g:netrw_liststyle|
855 Shell command used to perform listing.........|g:netrw_list_cmd|
856 Quick file info...............................|netrw-qf|
857 Sorted by
858 Select sorting style (name/time/size).........|netrw-s|
859 Editing the sorting sequence..................|netrw-S|
860 Sorting options...............................|g:netrw_sort_options|
861 Associated setting variable...................|g:netrw_sort_sequence|
862 Reverse sorting order.........................|netrw-r|
865 *netrw-quickmap* *netrw-quickmaps*
866 QUICK REFERENCE: MAPS *netrw-browse-maps* {{{2
867 >
868 --- ----------------- ----
869 Map Quick Explanation Link
870 --- ----------------- ----
871 < <F1> Causes Netrw to issue help
872 <cr> Netrw will enter the directory or read the file |netrw-cr|
873 <del> Netrw will attempt to remove the file/directory |netrw-del|
874 - Makes Netrw go up one directory |netrw--|
875 a Toggles between normal display, |netrw-a|
876 hiding (suppress display of files matching g:netrw_list_hide)
877 showing (display only files which match g:netrw_list_hide)
878 c Make browsing directory the current directory |netrw-c|
879 d Make a directory |netrw-d|
880 D Attempt to remove the file(s)/directory(ies) |netrw-D|
881 gb Go to previous bookmarked directory |netrw-gb|
882 gh Quick hide/unhide of dot-files |netrw-gh|
883 gi Display information on file |netrw-qf|
884 <c-h> Edit file hiding list |netrw-ctrl-h|
885 i Cycle between thin, long, wide, and tree listings |netrw-i|
886 <c-l> Causes Netrw to refresh the directory listing |netrw-ctrl-l|
887 mb Bookmark current directory |netrw-mb|
888 mc Copy marked files to marked-file target directory |netrw-mc|
889 md Apply diff to marked files (up to 3) |netrw-md|
890 me Place marked files on arg list and edit them |netrw-me|
891 mf Mark a file |netrw-mf|
892 mh Toggle marked file suffices' presence on hiding list |netrw-mh|
893 mm Move marked files to marked-file target directory |netrw-mm|
894 mp Print marked files |netrw-mp|
895 mr Mark files satisfying a |regexp| |netrw-mr|
896 mt Current browsing directory becomes markfile target |netrw-mt|
897 mT Apply ctags to marked files |netrw-mT|
898 mu Unmark all marked files |netrw-mu|
899 mx Apply arbitrary shell command to marked files |netrw-mx|
900 mz Compress/decompress marked files |netrw-mz|
901 o Enter the file/directory under the cursor in a new |netrw-o|
902 browser window. A horizontal split is used.
903 O Obtain a file specified by cursor |netrw-O|
904 p Preview the file |netrw-p|
905 P Browse in the previously used window |netrw-P|
906 q List bookmarked directories and history |netrw-qb|
907 r Reverse sorting order |netrw-r|
908 R Rename the designed file(s)/directory(ies) |netrw-R|
909 s Select sorting style: by name, time, or file size |netrw-s|
910 S Specify suffix priority for name-sorting |netrw-S|
911 t Enter the file/directory under the cursor in a new tab|netrw-t|
912 u Change to recently-visited directory |netrw-u|
913 U Change to subsequently-visited directory |netrw-U|
914 v Enter the file/directory under the cursor in a new |netrw-v|
915 browser window. A vertical split is used.
916 x View file with an associated program |netrw-x|
918 % Open a new file in netrw's current directory |netrw-%|
920 <leftmouse> (gvim only) selects word under mouse as if a <cr>
921 had been pressed (ie. edit file, change directory)
922 <middlemouse> (gvim only) same as P selecting word under mouse;
923 see |netrw-P|
924 <rightmouse> (gvim only) delete file/directory using word under
925 mouse
926 <2-leftmouse> (gvim only) when:
927 * in a netrw-selected file, AND
928 * |g:netrw_retmap| == 1 AND
929 * the user doesn't already have a <2-leftmouse> mapping
930 defined before netrw is autoloaded,
931 then a double clicked leftmouse button will return
932 to the netrw browser window.
933 <s-leftmouse> (gvim only) like mf, will mark files
935 *netrw-quickcom* *netrw-quickcoms*
936 QUICK REFERENCE: COMMANDS *netrw-explore-cmds* *netrw-browse-cmds* {{{2
937 :NetrwClean[!] ...........................................|netrw-clean|
938 :NetrwSettings ...........................................|netrw-settings|
939 :Explore[!] [dir] Explore directory of current file......|netrw-explore|
940 :Hexplore[!] [dir] Horizontal Split & Explore.............|netrw-explore|
941 :Nexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
942 :Pexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
943 :Rexplore Return to Explorer.....................|netrw-explore|
944 :Sexplore[!] [dir] Split & Explore directory .............|netrw-explore|
945 :Texplore[!] [dir] Tab & Explore..........................|netrw-explore|
946 :Vexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
948 BOOKMARKING A DIRECTORY *netrw-mb* *netrw-bookmark* *netrw-bookmarks* {{{2
949 One may easily "bookmark" a directory by using >
951 {cnt}mb
952 <
953 Any count may be used. One may use viminfo's "!" option (|'viminfo'|) to
954 retain bookmarks between vim sessions. See |netrw-gb| for how to return
955 to a bookmark and |netrw-qb| for how to list them.
958 BROWSING *netrw-cr* {{{2
960 Browsing is simple: move the cursor onto a file or directory of interest.
961 Hitting the <cr> (the return key) will select the file or directory.
962 Directories will themselves be listed, and files will be opened using the
963 protocol given in the original read request.
965 CAVEAT: There are four forms of listing (see |netrw-i|). Netrw assumes that
966 two or more spaces delimit filenames and directory names for the long and
967 wide listing formats. Thus, if your filename or directory name has two or
968 more sequential spaces embedded in it, or any trailing spaces, then you'll
969 need to use the "thin" format to select it.
971 The |g:netrw_browse_split| option, which is zero by default, may be used to
972 cause the opening of files to be done in a new window or tab instead of the
973 default. When the option is one or two, the splitting will be taken
974 horizontally or vertically, respectively. When the option is set to three, a
975 <cr> will cause the file to appear in a new tab.
978 When using the gui (gvim) one may select a file by pressing the <leftmouse>
979 button. In addtion, if
981 *|g:netrw_retmap| == 1 AND (its default value is 0)
982 * in a netrw-selected file, AND
983 * the user doesn't already have a <2-leftmouse> mapping defined before
984 netrw is loaded
986 then a doubly-clicked leftmouse button will return to the netrw browser
987 window.
989 Netrw attempts to speed up browsing, especially for remote browsing where one
990 may have to enter passwords, by keeping and re-using previously obtained
991 directory listing buffers. The |g:netrw_fastbrowse| variable is used to
992 control this behavior; one may have slow browsing (no buffer re-use), medium
993 speed browsing (re-use directory buffer listings only for remote directories),
994 and fast browsing (re-use directory buffer listings as often as possible).
995 The price for such re-use is that when changes are made (such as new files
996 are introduced into a directory), the listing may become out-of-date. One may
997 always refresh directory listing buffers by pressing ctrl-L (see
998 |netrw-ctrl-l|).
1001 Related topics: |netrw-o| |netrw-p| |netrw-P| |netrw-t| |netrw-v|
1002 Associated setting variables: |g:netrw_browse_split| |g:netrw_fastbrowse|
1003 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd|
1004 |g:netrw_ftp_timelist_cmd| |g:netrw_ssh_cmd|
1005 |g:netrw_ssh_browse_reject| |g:netrw_use_noswf|
1008 BROWSING WITH A HORIZONTALLY SPLIT WINDOW *netrw-o* *netrw-horiz* {{{2
1010 Normally one enters a file or directory using the <cr>. However, the "o" map
1011 allows one to open a new window to hold the new directory listing or file. A
1012 horizontal split is used. (for vertical splitting, see |netrw-v|)
1014 Normally, the o key splits the window horizontally with the new window and
1015 cursor at the top. To change to splitting the window horizontally with the
1016 new window and cursor at the bottom, have
1018 let g:netrw_alto = 1
1020 in your <.vimrc>. (also see |netrw-t| |netrw-v|)
1022 There is only one tree listing buffer; using "o" on a displayed subdirectory
1023 will split the screen, but the same buffer will be shown twice.
1025 Associated setting variables: |g:netrw_alto| |g:netrw_winsize|
1028 BROWSING WITH A NEW TAB *netrw-t* {{{2
1030 Normally one enters a file or directory using the <cr>. The "t" map
1031 allows one to open a new window hold the new directory listing or file in a
1032 new tab. (also see: |netrw-o| |netrw-v|)
1035 BROWSING WITH A VERTICALLY SPLIT WINDOW *netrw-v* {{{2
1037 Normally one enters a file or directory using the <cr>. However, the "v" map
1038 allows one to open a new window to hold the new directory listing or file. A
1039 vertical split is used. (for horizontal splitting, see |netrw-o|)
1041 Normally, the v key splits the window vertically with the new window and
1042 cursor at the left. To change to splitting the window vertically with the new
1043 window and cursor at the right, have
1045 let g:netrw_altv = 1
1047 in your <.vimrc>. (also see: |netrw-o| |netrw-t|)
1049 There is only one tree listing buffer; using "v" on a displayed subdirectory
1050 will split the screen, but the same buffer will be shown twice.
1052 Associated setting variable: |g:netrw_altv| |g:netrw_winsize|
1054 CHANGE LISTING STYLE *netrw-i* {{{2
1056 The "i" map cycles between the thin, long, wide, and tree listing formats.
1058 The short listing format gives just the files' and directories' names.
1060 The long listing is either based on the "ls" command via ssh for remote
1061 directories or displays the filename, file size (in bytes), and the time and
1062 date of last modification for local directories. With the long listing
1063 format, netrw is not able to recognize filenames which have trailing spaces.
1064 Use the thin listing format for such files.
1066 The wide listing format uses two or more contiguous spaces to delineate
1067 filenames; when using that format, netrw won't be able to recognize or use
1068 filenames which have two or more contiguous spaces embedded in the name or any
1069 trailing spaces. The thin listing format will, however, work with such files.
1070 This listing format is the most compact.
1072 The tree listing format has a top directory followed by files and directories
1073 preceded by a "|". One may open and close directories by pressing the <cr>
1074 key while atop the directory name. There is only one tree listing buffer;
1075 hence, using "v" or "o" on a subdirectory will only show the same buffer,
1076 twice.
1078 Associated setting variables: |g:netrw_liststyle| |g:netrw_maxfilenamelen|
1079 |g:netrw_timefmt| |g:netrw_list_cmd|
1082 CHANGING TO A BOOKMARKED DIRECTORY *netrw-gb* {{{2
1084 To change directory back to a bookmarked directory, use
1086 {cnt}gb
1088 Any count may be used to reference any of the bookmarks. See |netrw-mb| on
1089 how to bookmark a directory and |netrw-qb| on how to list bookmarks.
1092 CHANGING TO A PREDECESSOR DIRECTORY *netrw-u* *netrw-updir* {{{2
1094 Every time you change to a new directory (new for the current session),
1095 netrw will save the directory in a recently-visited directory history
1096 list (unless g:netrw_dirhistmax is zero; by default, it's ten). With the
1097 "u" map, one can change to an earlier directory (predecessor). To do
1098 the opposite, see |netrw-U|.
1101 CHANGING TO A SUCCESSOR DIRECTORY *netrw-U* *netrw-downdir* {{{2
1103 With the "U" map, one can change to a later directory (successor).
1104 This map is the opposite of the "u" map. (see |netrw-u|) Use the
1105 q map to list both the bookmarks and history. (see |netrw-qb|)
1108 NETRW CLEAN *netrw-clean* *:NetrwClean*
1110 With :NetrwClean one may easily remove netrw from one's home directory;
1111 more precisely, from the first directory on your |'runtimepath'|.
1113 With :NetrwClean!, netrw will remove netrw from all directories on your
1114 |'runtimepath'|.
1116 With either form of the command, netrw will first ask for confirmation
1117 that the removal is in fact what you want to do. If netrw doesn't have
1118 permission to remove a file, it will issue an error message.
1120 *netrw-gx*
1121 CUSTOMIZING BROWSING WITH A USER FUNCTION *netrw-x* *netrw-handler* {{{2
1122 (also see |netrw_filehandler|)
1124 Certain files, such as html, gif, jpeg, (word/office) doc, etc, files, are
1125 best seen with a special handler (ie. a tool provided with your computer).
1126 Netrw allows one to invoke such special handlers by: >
1128 * when Exploring, hit the "x" key
1129 * when editing, hit gx with the cursor atop the special filename
1130 < (not available if the |g:netrw_nogx| variable exists)
1132 Netrw determines which special handler by the following method:
1134 * if |g:netrw_browsex_viewer| exists, then it will be used to attempt to
1135 view files. Examples of useful settings (place into your <.vimrc>): >
1137 :let g:netrw_browsex_viewer= "kfmclient exec"
1138 < or >
1139 :let g:netrw_browsex_viewer= "gnome-open"
1140 <
1141 If g:netrw_browsex_viewer == '-', then netrwFileHandler() will be
1142 invoked first (see |netrw_filehandler|).
1144 * for Windows 32 or 64, the url and FileProtocolHandler dlls are used.
1145 * for Gnome (with gnome-open): gnome-open is used.
1146 * for KDE (with kfmclient) : kfmclient is used.
1147 * for Mac OS X : open is used.
1148 * otherwise the netrwFileHandler plugin is used.
1150 The file's suffix is used by these various approaches to determine an
1151 appropriate application to use to "handle" these files. Such things as
1152 OpenOffice (*.sfx), visualization (*.jpg, *.gif, etc), and PostScript (*.ps,
1153 *.eps) can be handled.
1155 *netrw_filehandler*
1157 The "x" map applies a function to a file, based on its extension. Of course,
1158 the handler function must exist for it to be called!
1159 >
1160 Ex. mypgm.html x ->
1161 NFH_html("scp://user@host/some/path/mypgm.html")
1162 <
1163 Users may write their own netrw File Handler functions to support more
1164 suffixes with special handling. See <plugin/netrwFileHandlers.vim> for
1165 examples on how to make file handler functions. As an example: >
1167 " NFH_suffix(filename)
1168 fun! NFH_suffix(filename)
1169 ..do something special with filename..
1170 endfun
1171 <
1172 These functions need to be defined in some file in your .vim/plugin
1173 (vimfiles\plugin) directory. Vim's function names may not have punctuation
1174 characters (except for the underscore) in them. To support suffices that
1175 contain such characters, netrw will first convert the suffix using the
1176 following table: >
1178 @ -> AT ! -> EXCLAMATION % -> PERCENT
1179 : -> COLON = -> EQUAL ? -> QUESTION
1180 , -> COMMA - -> MINUS ; -> SEMICOLON
1181 $ -> DOLLAR + -> PLUS ~ -> TILDE
1182 <
1183 So, for example: >
1185 file.rcs,v -> NFH_rcsCOMMAv()
1186 <
1187 If more such translations are necessary, please send me email: >
1188 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
1189 with a request.
1191 Associated setting variable: |g:netrw_browsex_viewer|
1193 *netrw-curdir*
1194 DELETING FILES OR DIRECTORIES *netrw-delete* *netrw-D* *netrw-del* {{{2
1196 If files have not been marked with |netrw-mf|: (local marked file list)
1198 Deleting/removing files and directories involves moving the cursor to the
1199 file/directory to be deleted and pressing "D". Directories must be empty
1200 first before they can be successfully removed. If the directory is a
1201 softlink to a directory, then netrw will make two requests to remove the
1202 directory before succeeding. Netrw will ask for confirmation before doing
1203 the removal(s). You may select a range of lines with the "V" command
1204 (visual selection), and then pressing "D".
1206 If files have been marked with |netrw-mf|: (local marked file list)
1208 Marked files (and empty directories) will be deleted; again, you'll be
1209 asked to confirm the deletion before it actually takes place.
1211 The |g:netrw_rm_cmd|, |g:netrw_rmf_cmd|, and |g:netrw_rmdir_cmd| variables are
1212 used to control the attempts to remove files and directories. The
1213 g:netrw_rm_cmd is used with files, and its default value is:
1215 g:netrw_rm_cmd: ssh HOSTNAME rm
1217 The g:netrw_rmdir_cmd variable is used to support the removal of directories.
1218 Its default value is:
1220 g:netrw_rmdir_cmd: ssh HOSTNAME rmdir
1222 If removing a directory fails with g:netrw_rmdir_cmd, netrw then will attempt
1223 to remove it again using the g:netrw_rmf_cmd variable. Its default value is:
1225 g:netrw_rmf_cmd: ssh HOSTNAME rm -f
1227 Associated setting variable: |g:netrw_local_rmdir| |g:netrw_rm_cmd|
1228 |g:netrw_rmdir_cmd| |g:netrw_ssh_cmd|
1231 *netrw-explore* *netrw-hexplore* *netrw-nexplore* *netrw-pexplore*
1232 *netrw-rexplore* *netrw-sexplore* *netrw-texplore* *netrw-vexplore*
1233 DIRECTORY EXPLORATION COMMANDS {{{2
1235 :Explore[!] [dir]... Explore directory of current file *:Explore*
1236 :Hexplore[!] [dir]... Horizontal Split & Explore *:Hexplore*
1237 :Rexplore ... Return to Explorer *:Rexplore*
1238 :Sexplore[!] [dir]... Split&Explore directory of current file *:Sexplore*
1239 :Texplore [dir]... Tab & Explore *:Texplore*
1240 :Vexplore[!] [dir]... Vertical Split & Explore *:Vexplore*
1242 Used with :Explore **/pattern : (also see |netrw-starstar|)
1243 :Nexplore............. go to next matching file *:Nexplore*
1244 :Pexplore............. go to previous matching file *:Pexplore*
1246 :Explore will open the local-directory browser on the current file's
1247 directory (or on directory [dir] if specified). The window will be
1248 split only if the file has been modified, otherwise the browsing
1249 window will take over that window. Normally the splitting is taken
1250 horizontally.
1251 :Explore! is like :Explore, but will use vertical splitting.
1252 :Sexplore will always split the window before invoking the local-directory
1253 browser. As with Explore, the splitting is normally done
1254 horizontally.
1255 :Sexplore! [dir] is like :Sexplore, but the splitting will be done vertically.
1256 :Hexplore [dir] does an :Explore with |:belowright| horizontal splitting.
1257 :Hexplore! [dir] does an :Explore with |:aboveleft| horizontal splitting.
1258 :Vexplore [dir] does an :Explore with |:leftabove| vertical splitting.
1259 :Vexplore! [dir] does an :Explore with |:rightbelow| vertical splitting.
1260 :Texplore [dir] does a tabnew before generating the browser window
1262 By default, these commands use the current file's directory. However, one
1263 may explicitly provide a directory (path) to use.
1265 The |g:netrw_winsize| variable also is used, if specified by the user, to
1266 size Hexplore and Vexplore windows.
1268 :Rexplore This command is a little different from the others. When one
1269 edits a file, for example by pressing <cr> when atop a file in
1270 a netrw browser window, :Rexplore will return the display to
1271 that of the last netrw browser window. Its a command version
1272 of <2-leftmouse> (which is only available under gvim and
1273 cooperative terms).
1276 *netrw-star* *netrw-starpat* *netrw-starstar* *netrw-starstarpat*
1277 EXPLORING WITH STARS AND PATTERNS
1279 When Explore, Sexplore, Hexplore, or Vexplore are used with one of the
1280 following four styles, Explore generates a list of files which satisfy
1281 the request. >
1283 */filepat files in current directory which satisfy filepat
1284 **/filepat files in current directory or below which satisfy the
1285 file pattern
1286 *//pattern files in the current directory which contain the
1287 pattern (vimgrep is used)
1288 **//pattern files in the current directory or below which contain
1289 the pattern (vimgrep is used)
1290 <
1291 The cursor will be placed on the first file in the list. One may then
1292 continue to go to subsequent files on that list via |:Nexplore| or to
1293 preceding files on that list with |:Pexplore|. Explore will update the
1294 directory and place the cursor appropriately.
1296 A plain >
1297 :Explore
1298 will clear the explore list.
1300 If your console or gui produces recognizable shift-up or shift-down sequences,
1301 then you'll likely find using shift-downarrow and shift-uparrow convenient.
1302 They're mapped by netrw:
1304 <s-down> == Nexplore, and
1305 <s-up> == Pexplore.
1307 As an example, consider
1308 >
1309 :Explore */*.c
1310 :Nexplore
1311 :Nexplore
1312 :Pexplore
1313 <
1314 The status line will show, on the right hand side of the status line, a
1315 message like "Match 3 of 20".
1317 Associated setting variables: |g:netrw_keepdir| |g:netrw_browse_split|
1318 |g:netrw_fastbrowse| |g:netrw_ftp_browse_reject|
1319 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd|
1320 |g:netrw_ftp_timelist_cmd| |g:netrw_list_cmd|
1321 |g:netrw_liststyle|
1324 DISPLAYING INFORMATION ABOUT FILE *netrw-qf* {{{2
1326 With the cursor atop a filename, pressing "qf" will reveal the file's size
1327 and last modification timestamp. Currently this capability is only available
1328 for local files.
1331 EDIT FILE OR DIRECTORY HIDING LIST *netrw-ctrl-h* *netrw-edithide* {{{2
1333 The "<ctrl-h>" map brings up a requestor allowing the user to change the
1334 file/directory hiding list contained in |g:netrw_list_hide|. The hiding list
1335 consists of one or more patterns delimited by commas. Files and/or
1336 directories satisfying these patterns will either be hidden (ie. not shown) or
1337 be the only ones displayed (see |netrw-a|).
1339 The "gh" mapping (see |netrw-gh|) quickly alternates between the usual
1340 hiding list and the hiding of files or directories that begin with ".".
1342 Associated setting variables: |g:netrw_hide| |g:netrw_list_hide|
1343 Associated topics: |netrw-a| |netrw-gh| |netrw-mh|
1346 EDITING THE SORTING SEQUENCE *netrw-S* *netrw-sortsequence* {{{2
1348 When "Sorted by" is name, one may specify priority via the sorting sequence
1349 (g:netrw_sort_sequence). The sorting sequence typically prioritizes the
1350 name-listing by suffix, although any pattern will do. Patterns are delimited
1351 by commas. The default sorting sequence is (all one line):
1352 >
1353 '[\/]$,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$,\.info$,
1354 \.swp$,\.bak$,\~$'
1355 <
1356 The lone * is where all filenames not covered by one of the other patterns
1357 will end up. One may change the sorting sequence by modifying the
1358 g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by
1359 using the "S" map.
1361 Related topics: |netrw-s| |netrw-S|
1362 Associated setting variables: |g:netrw_sort_sequence| |g:netrw_sort_options|
1365 GOING UP *netrw--* {{{2
1367 To go up a directory, press "-" or press the <cr> when atop the ../ directory
1368 entry in the listing.
1370 Netrw will use the command in |g:netrw_list_cmd| to perform the directory
1371 listing operation after changing HOSTNAME to the host specified by the
1372 user-provided url. By default netrw provides the command as:
1374 ssh HOSTNAME ls -FLa
1376 where the HOSTNAME becomes the [user@]hostname as requested by the attempt to
1377 read. Naturally, the user may override this command with whatever is
1378 preferred. The NetList function which implements remote browsing
1379 expects that directories will be flagged by a trailing slash.
1382 HIDING FILES OR DIRECTORIES *netrw-a* *netrw-hiding* {{{2
1384 Netrw's browsing facility allows one to use the hiding list in one of three
1385 ways: ignore it, hide files which match, and show only those files which
1386 match.
1388 If no files have been marked via |netrw-mf|:
1390 The "a" map allows the user to cycle through the three hiding modes.
1392 The |g:netrw_list_hide| variable holds a comma delimited list of patterns
1393 based on regular expressions (ex. ^.*\.obj$,^\.) which specify the hiding list.
1394 (also see |netrw-ctrl-h|) To set the hiding list, use the <c-h> map. As an
1395 example, to hide files which begin with a ".", one may use the <c-h> map to
1396 set the hiding list to '^\..*' (or one may put let g:netrw_list_hide= '^\..*'
1397 in one's <.vimrc>). One may then use the "a" key to show all files, hide
1398 matching files, or to show only the matching files.
1400 Example: \.[ch]$
1401 This hiding list command will hide/show all *.c and *.h files.
1403 Example: \.c$,\.h$
1404 This hiding list command will also hide/show all *.c and *.h
1405 files.
1407 Don't forget to use the "a" map to select the mode (normal/hiding/show) you
1408 want!
1410 If files have been marked using |netrw-mf|, then this command will:
1412 if showing all files or non-hidden files:
1413 modify the g:netrw_list_hide list by appending the marked files to it
1414 and showing only non-hidden files.
1416 else if showing hidden files only:
1417 modify the g:netrw_list_hide list by removing the marked files from it
1418 and showing only non-hidden files.
1419 endif
1421 *netrw-gh* *netrw-hide*
1422 As a quick shortcut, one may press >
1423 gh
1424 to toggle between hiding files which begin with a period (dot) and not hiding
1425 them.
1427 Associated setting variable: |g:netrw_list_hide|
1428 Associated topics: |netrw-a| |netrw-ctrl-h| |netrw-mh|
1430 IMPROVING BROWSING *netrw-listhack* *netrw-ssh-hack* {{{2
1432 Especially with the remote directory browser, constantly entering the password
1433 is tedious.
1435 For Linux/Unix systems, the book "Linux Server Hacks - 100 industrial strength
1436 tips & tools" by Rob Flickenger (O'Reilly, ISBN 0-596-00461-3) gives a tip
1437 for setting up no-password ssh and scp and discusses associated security
1438 issues. It used to be available at http://hacks.oreilly.com/pub/h/66 ,
1439 but apparently that address is now being redirected to some "hackzine".
1440 I'll attempt a summary based on that article and on a communication from
1441 Ben Schmidt:
1443 1. Generate a public/private key pair on the local machine
1444 (ssh client): >
1445 ssh-keygen -t rsa
1446 (saving the file in ~/.ssh/id_rsa as prompted)
1447 <
1448 2. Just hit the <CR> when asked for passphrase (twice) for no
1449 passphrase. If you do use a passphrase, you will also need to use
1450 ssh-agent so you only have to type the passphrase once per session.
1451 If you don't use a passphrase, simply logging onto your local
1452 computer or getting access to the keyfile in any way will suffice
1453 to access any ssh servers which have that key authorized for login.
1455 3. This creates two files: >
1456 ~/.ssh/id_rsa
1457 ~/.ssh/id_rsa.pub
1458 <
1459 4. On the target machine (ssh server): >
1460 cd
1461 mkdir -p .ssh
1462 chmod 0700 .ssh
1463 <
1464 5. On your local machine (ssh client): (one line) >
1465 ssh {serverhostname}
1466 cat '>>' '~/.ssh/authorized_keys2' < ~/.ssh/id_rsa.pub
1467 <
1468 or, for OpenSSH, (one line) >
1469 ssh {serverhostname}
1470 cat '>>' '~/.ssh/authorized_keys' < ~/.ssh/id_rsa.pub
1471 <
1472 You can test it out with >
1473 ssh {serverhostname}
1474 and you should be log onto the server machine without further need to type
1475 anything.
1477 If you decided to use a passphrase, do: >
1478 ssh-agent $SHELL
1479 ssh-add
1480 ssh {serverhostname}
1481 You will be prompted for your key passphrase when you use ssh-add, but not
1482 subsequently when you use ssh. For use with vim, you can use >
1483 ssh-agent vim
1484 and, when next within vim, use >
1485 :!ssh-add
1486 Alternatively, you can apply ssh-agent to the terminal you're planning on
1487 running vim in: >
1488 ssh-agent xterm &
1489 and do ssh-add whenever you need.
1491 For Windows, folks on the vim mailing list have mentioned that Pageant helps
1492 with avoiding the constant need to enter the password.
1494 Kingston Fung wrote about another way to avoid constantly needing to enter
1495 passwords:
1497 In order to avoid the need to type in the password for scp each time, you
1498 provide a hack in the docs to set up a non password ssh account. I found a
1499 better way to do that: I can use a regular ssh account which uses a
1500 password to access the material without the need to key-in the password
1501 each time. It's good for security and convenience. I tried ssh public key
1502 authorization + ssh-agent, implementing this, and it works! Here are two
1503 links with instructions:
1505 http://www.ibm.com/developerworks/library/l-keyc2/
1506 http://sial.org/howto/openssh/publickey-auth/
1509 LISTING BOOKMARKS AND HISTORY *netrw-qb* *netrw-listbookmark* {{{2
1511 Pressing "qb" (query bookmarks) will list the bookmarked directories and
1512 directory traversal history (query).
1514 (see |netrw-mb|, |netrw-gb|, |netrw-u|, and |netrw-U|)
1517 MAKING A NEW DIRECTORY *netrw-d* {{{2
1519 With the "d" map one may make a new directory either remotely (which depends
1520 on the global variable g:netrw_mkdir_cmd) or locally (which depends on the
1521 global variable g:netrw_local_mkdir). Netrw will issue a request for the new
1522 directory's name. A bare <CR> at that point will abort the making of the
1523 directory. Attempts to make a local directory that already exists (as either
1524 a file or a directory) will be detected, reported on, and ignored.
1526 Currently, making a directory via ftp is not supported.
1528 Associated setting variable: |g:netrw_local_mkdir| |g:netrw_mkdir_cmd|
1531 MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY *netrw-c* {{{2
1533 By default, |g:netrw_keepdir| is 1. This setting means that the current
1534 directory will not track the browsing directory.
1536 Setting g:netrw_keepdir to 0 tells netrw to make vim's current directory to
1537 track netrw's browsing directory.
1539 However, given the default setting for g:netrw_keepdir of 1 where netrw
1540 maintains its own separate notion of the current directory, in order to make
1541 the two directories the same, use the "c" map (just type c). That map will
1542 set Vim's notion of the current directory to netrw's current browsing
1543 directory.
1545 Associated setting variable: |g:netrw_keepdir|
1547 MARKING FILES *netrw-mf* {{{2
1548 (also see |netrw-mr|)
1550 One may mark files with the cursor atop a filename and then pressing "mf".
1551 With gvim, one may also mark files with <s-leftmouse>. The following netrw
1552 maps make use of marked files:
1554 |netrw-a| Hide marked files/directories
1555 |netrw-D| Delete marked files/directories
1556 |netrw-mc| Copy marked files to target
1557 |netrw-md| Apply vimdiff to marked files
1558 |netrw-me| Edit marked files
1559 |netrw-mg| Apply vimgrep to marked files
1560 |netrw-mm| Move marked files
1561 |netrw-mp| Print marked files
1562 |netrw-mt| Set target for |netrw-mm| and |netrw-mc|
1563 |netrw-mT| Generate tags using marked files
1564 |netrw-mx| Apply shell command to marked files
1565 |netrw-mz| Compress/Decompress marked files
1566 |netrw-O| Obtain marked files
1567 |netrw-R| Rename marked files
1569 One may unmark files one at a time the same way one marks them; ie. place
1570 the cursor atop a marked file and press "mf". This process also works
1571 with <s-leftmouse> using gvim. One may unmark all files by pressing
1572 "mu" (see |netrw-mu|).
1574 *markfilelist* *global_markfilelist* *local_markfilelist*
1575 All marked files are entered onto the global marked file list; there is only
1576 one such list. In addition, every netrw buffer also has its own local marked
1577 file list; since netrw buffers are associated with specific directories, this
1578 means that each directory has its own local marked file list. The various
1579 commands which operate on marked files use one or the other of the marked file
1580 lists.
1583 MARKING FILES BY REGULAR EXPRESSION *netrw-mr* {{{2
1584 (also see |netrw-mf|)
1586 One may also mark files by pressing "mr"; netrw will then issue a prompt,
1587 "Enter regexp: ". You may then enter a regular expression such as \.c$ .
1588 All files in the current directory will then be marked. Note that the
1589 regular expressions are vim-style |regexp| ones, not shell ones. So
1590 entering *.c probably isn't what you want!
1593 MARKED FILES: ARBITRARY COMMAND *netrw-mx* {{{2
1594 (See |netrw-mf| and |netrw-mr| for how to mark files)
1595 (uses the local marked-file list)
1597 Upon activation of the "mx" map, netrw will query the user for some (external)
1598 command to be applied to all marked files. All "%"s in the command will be
1599 substituted with the name of each marked file in turn. If no "%"s are in the
1600 command, then the command will be followed by a space and a marked filename.
1603 MARKED FILES: COMPRESSION AND DECOMPRESSION *netrw-mz* {{{2
1604 (See |netrw-mf| and |netrw-mr| for how to mark files)
1605 (uses the local marked file list)
1607 If any marked files are compressed, then "mz" will decompress them.
1608 If any marked files are decompressed, then "mz" will compress them
1609 using the command specified by |g:netrw_compress|; by default,
1610 that's "gzip".
1612 For decompression, netrw provides a |Dictionary| of suffices and their
1613 associated decompressing utilities; see |g:netrw_decompress|.
1615 Associated setting variables: |g:netrw_compress| |g:netrw_decompress|
1617 MARKED FILES: COPYING *netrw-mc* {{{2
1618 (See |netrw-mf| and |netrw-mr| for how to mark files)
1619 (Uses the global marked file list)
1621 Select a target directory with mt (|netrw-mt|). Then change directory,
1622 select file(s) (see |netrw-mf|), and press "mc".
1624 Associated setting variable: |g:netrw_localcopycmd| |g:netrw_ssh_cmd|
1626 MARKED FILES: DIFF *netrw-md* {{{2
1627 (See |netrw-mf| and |netrw-mr| for how to mark files)
1628 (uses the global marked file list)
1630 Use |vimdiff| to visualize difference between selected files (two or
1631 three may be selected for this). Uses the global marked file list.
1633 MARKED FILES: EDITING *netrw-me* {{{2
1634 (See |netrw-mf| and |netrw-mr| for how to mark files)
1635 (uses the global marked file list)
1637 This command will place the marked files on the |arglist| and commence
1638 editing them. One may return the to explorer window with |:Rexplore|.
1640 MARKED FILES: GREP *netrw-mg* {{{2
1641 (See |netrw-mf| and |netrw-mr| for how to mark files)
1642 (uses the global marked file list)
1644 This command will apply |:vimgrep| to the marked files. The command will ask
1645 for the requested pattern; one may enter: >
1646 /pattern/[g][j]
1647 ! /pattern/[g][j]
1648 pattern
1649 <
1650 MARKED FILES: HIDING AND UNHIDING BY SUFFIX *netrw-mh* {{{2
1651 (See |netrw-mf| and |netrw-mr| for how to mark files)
1652 (uses the local marked file list)
1654 This command extracts the suffices of the marked files and toggles their
1655 presence on the hiding list. Please note that marking the same suffix
1656 this way multiple times will result in the suffix's presence being toggled
1657 for each file (so an even quantity of marked files having the same suffix
1658 is the same as not having bothered to select them at all).
1660 Related topics: |netrw-a| |g:netrw_list_hide|
1662 MARKED FILES: MOVING *netrw-mm* {{{2
1663 (See |netrw-mf| and |netrw-mr| for how to mark files)
1664 (uses the global marked file list)
1666 WARNING: moving files is more dangerous than copying them.
1667 A file being moved is first copied and then deleted; if the
1668 copy operation fails and the delete succeeds, you will lose
1669 the file. Either try things out with unimportant files
1670 first or do the copy and then delete yourself using mc and D.
1671 Use at your own risk!
1673 Select a target directory with mT (|netrw-mt|). Then change directory,
1674 select file(s) (see |netrw-mf|), and press "mm".
1676 Associated setting variable: |g:netrw_localmovecmd| |g:netrw_ssh_cmd|
1678 MARKED FILES: PRINTING *netrw-mp* {{{2
1679 (See |netrw-mf| and |netrw-mr| for how to mark files)
1680 (uses the local marked file list)
1682 Netrw will apply the |:hardcopy| command to marked files. What it does
1683 is open each file in a one-line window, execute hardcopy, then close the
1684 one-line window.
1687 MARKED FILES: SOURCING *netrw-ms* {{{2
1688 (See |netrw-mf| and |netrw-mr| for how to mark files)
1689 (uses the local marked file list)
1691 Netrw will source the marked files (using vim's |:source| command)
1694 MARKED FILES: TAGGING *netrw-mT* {{{2
1695 (See |netrw-mf| and |netrw-mr| for how to mark files)
1696 (uses the global marked file list)
1698 The "mt" mapping will apply the command in |g:netrw_ctags| (by default, its
1699 "ctags") to marked files. For remote browsing, in order to create a tags file
1700 netrw will use ssh (see |g:netrw_ssh_cmd|), and so ssh must be available for
1701 this to work on remote systems. For your local system, see |ctags| on how to
1702 get a version. I myself use hdrtags, currently available at
1703 http://mysite.verizon.net/astronaut/src/index.html , and have >
1705 let g:netrw_ctags= "hdrtag"
1706 <
1707 in my <.vimrc>.
1709 When a remote set of files are tagged, the resulting tags file is "obtained";
1710 ie. a copy is transferred to the local system's directory. The local tags
1711 file is then modified so that one may use it through the network. The
1712 modification is concerns the names of the files in the tags; each filename is
1713 preceded by the netrw-compatible url used to obtain it. When one subsequently
1714 uses one of the go to tag actions (|tags|), the url will be used by netrw to
1715 edit the desired file and go to the tag.
1717 Associated setting variables: |g:netrw_ctags| |g:netrw_ssh_cmd|
1720 MARKED FILES: SETTING THE TARGET DIRECTORY *netrw-mt* {{{2
1721 (See |netrw-mf| and |netrw-mr| for how to mark files)
1723 Set the marked file copy/move-to target (see |netrw-mc| and |netrw-mm|):
1725 * if the cursor is atop a file name, then the netrw window's currently
1726 displayed directory is used for the copy/move-to target.
1728 * also, if the cursor is in the banner, then the netrw window's currently
1729 displayed directory is used for the copy/move-to target.
1731 * however, if the cursor is atop a directory name, then that directory is
1732 used for the copy/move-to target
1734 There is only one copy/move-to target per vim session; ie. the target is a
1735 script variable (see |s:var|) and is shared between all netrw windows (in an
1736 instance of vim).
1738 MARKED FILES: UNMARKING *netrw-mu* {{{2
1739 (See |netrw-mf| and |netrw-mr| for how to mark files)
1741 The "mu" mapping will unmark all currently marked files.
1744 NETRW BROWSER VARIABLES *netrw-browser-options* *netrw-browser-var* {{{2
1746 (if you're interestd in the netrw file transfer settings, see |netrw-options|)
1748 The <netrw.vim> browser provides settings in the form of variables which
1749 you may modify; by placing these settings in your <.vimrc>, you may customize
1750 your browsing preferences. (see also: |netrw-settings|)
1751 >
1752 --- -----------
1753 Var Explanation
1754 --- -----------
1755 < *g:netrw_alto* change from above splitting to below splitting
1756 by setting this variable (see |netrw-o|)
1757 default: =&sb (see |'sb'|)
1759 *g:netrw_altv* change from left splitting to right splitting
1760 by setting this variable (see |netrw-v|)
1761 default: =&spr (see |'spr'|)
1763 *g:netrw_browse_split* when browsing, <cr> will open the file by:
1764 =0: re-using the same window
1765 =1: horizontally splitting the window first
1766 =2: vertically splitting the window first
1767 =3: open file in new tab
1768 =4: act like "P" (ie. open previous window)
1770 *g:netrw_browsex_viewer* specify user's preference for a viewer: >
1771 "kfmclient exec"
1772 "gnome-open"
1773 < If >
1774 "-"
1775 < is used, then netrwFileHandler() will look for
1776 a script/function to handle the given
1777 extension. (see |netrw_filehandler|).
1779 *g:netrw_compress* ="gzip"
1780 Will compress marked files with this
1781 command
1783 *g:netrw_ctags* ="ctags"
1784 The default external program used to create tags
1786 *g:netrw_cursorline* = 1 (default)
1787 will use the |'cursorline'| local setting when
1788 |g:netrw_liststyle| ==0 (thin listing) or
1789 |g:netrw_liststyle| ==1 (long listing) or
1790 |g:netrw_liststyle| ==3 (tree listing)
1791 =0: off
1792 =2: like ==1, but the wide listing gets both
1793 cursorline and |'cursorcolumn'|locally set
1794 (ie. doesn't affect the wide listing)
1796 *g:netrw_decompress* = { ".gz" : "gunzip" ,
1797 ".bz2" : "bunzip2" ,
1798 ".zip" : "unzip" ,
1799 ".tar" : "tar -xf"}
1800 A dictionary mapping suffices to
1801 decompression programs.
1803 *g:netrw_fastbrowse* =0: slow speed directory browsing;
1804 never re-uses directory listings,
1805 always obtains directory listings.
1806 =1: medium speed directory browsing;
1807 re-use directory listings only
1808 when remote directory browsing.
1809 (default value)
1810 =2: fast directory browsing;
1811 only obtains directory listings when the
1812 directory hasn't been seen before
1813 (or |netrw-ctrl-l| is used).
1815 Fast browsing retains old directory listing
1816 buffers so that they don't need to be
1817 re-acquired. This feature is especially
1818 important for remote browsing. However, if
1819 a file is introduced or deleted into or from
1820 such directories, the old directory buffer
1821 becomes out-of-date. One may always refresh
1822 such a directory listing with |netrw-ctrl-l|.
1823 This option gives the user the choice of
1824 trading off accuracy (ie. up-to-date listing)
1825 versus speed.
1827 *g:netrw_fname_escape* =' ?&;%'
1828 Used on filenames before remote reading/writing
1830 *g:netrw_ftp_browse_reject* ftp can produce a number of errors and warnings
1831 that can show up as "directories" and "files"
1832 in the listing. This pattern is used to
1833 remove such embedded messages. By default its
1834 value is:
1835 '^total\s\+\d\+$\|
1836 ^Trying\s\+\d\+.*$\|
1837 ^KERBEROS_V\d rejected\|
1838 ^Security extensions not\|
1839 No such file\|
1840 : connect to address [0-9a-fA-F:]*
1841 : No route to host$'
1843 *g:netrw_ftp_list_cmd* options for passing along to ftp for directory
1844 listing. Defaults:
1845 unix or g:netrw_cygwin set: : "ls -lF"
1846 otherwise "dir"
1849 *g:netrw_ftp_sizelist_cmd* options for passing along to ftp for directory
1850 listing, sorted by size of file.
1851 Defaults:
1852 unix or g:netrw_cygwin set: : "ls -slF"
1853 otherwise "dir"
1855 *g:netrw_ftp_timelist_cmd* options for passing along to ftp for directory
1856 listing, sorted by time of last modification.
1857 Defaults:
1858 unix or g:netrw_cygwin set: : "ls -tlF"
1859 otherwise "dir"
1861 *g:netrw_glob_escape* ='[]*?`{~$'
1862 These characters in directory names are
1863 escaped before applying glob()
1865 *g:netrw_hide* if true, the hiding list is used
1866 default: =0
1868 *g:netrw_keepdir* =1 (default) keep current directory immune from
1869 the browsing directory.
1870 =0 keep the current directory the same as the
1871 browsing directory.
1872 The current browsing directory is contained in
1873 b:netrw_curdir (also see |netrw-c|)
1875 *g:netrw_list_cmd* command for listing remote directories
1876 default: (if ssh is executable)
1877 "ssh HOSTNAME ls -FLa"
1879 *g:netrw_liststyle* Set the default listing style:
1880 = 0: thin listing (one file per line)
1881 = 1: long listing (one file per line with time
1882 stamp information and file size)
1883 = 2: wide listing (multiple files in columns)
1884 = 3: tree style listing
1885 *g:netrw_list_hide* comma separated pattern list for hiding files
1886 Patterns are regular expressions (see |regexp|)
1887 Example: let g:netrw_list_hide= '.*\.swp$'
1888 default: ""
1890 *g:netrw_localcopycmd* ="cp" Linux/Unix/MacOS/Cygwin
1891 ="copy" Windows
1892 Copies marked files (|netrw-mf|) to target
1893 directory (|netrw-mt|, |netrw-mc|)
1895 *g:netrw_localmovecmd* ="mv" Linux/Unix/MacOS/Cygwin
1896 ="move" Windows
1897 Moves marked files (|netrw-mf|) to target
1898 directory (|netrw-mt|, |netrw-mm|)
1900 *g:netrw_local_mkdir* command for making a local directory
1901 default: "mkdir"
1903 *g:netrw_local_rmdir* remove directory command (rmdir)
1904 default: "rmdir"
1906 *g:netrw_maxfilenamelen* =32 by default, selected so as to make long
1907 listings fit on 80 column displays.
1908 If your screen is wider, and you have file
1909 or directory names longer than 32 bytes,
1910 you may set this option to keep listings
1911 columnar.
1913 *g:netrw_mkdir_cmd* command for making a remote directory
1914 default: "ssh USEPORT HOSTNAME mkdir"
1916 *g:netrw_retmap* if it exists and is set to one, then
1917 <2-leftmouse> will be mapped for easy
1918 return to the netrw browser window.
1919 (example: click once to select and open
1920 a file, double-click to return)
1921 default: =0
1923 *g:netrw_rm_cmd* command for removing files
1924 default: "ssh USEPORT HOSTNAME rm"
1926 *g:netrw_rmdir_cmd* command for removing directories
1927 default: "ssh USEPORT HOSTNAME rmdir"
1929 *g:netrw_rmf_cmd* command for removing softlinks
1930 default: "ssh USEPORT HOSTNAME rm -f"
1932 *g:netrw_sort_by* sort by "name", "time", or "size"
1933 default: "name"
1935 *g:netrw_sort_direction* sorting direction: "normal" or "reverse"
1936 default: "normal"
1938 *g:netrw_sort_options* sorting is done using |:sort|; this
1939 variable's value is appended to the
1940 sort command. Thus one may ignore case,
1941 for example, with the following in your
1942 .vimrc: >
1943 let g:netrw_sort_options="i"
1944 < default: ""
1946 *g:netrw_sort_sequence* when sorting by name, first sort by the
1947 comma-separated pattern sequence
1948 default: '[\/]$,*,\.bak$,\.o$,\.h$,
1949 \.info$,\.swp$,\.obj$'
1951 *g:netrw_special_syntax* If true, then certain files will be shown
1952 in special syntax in the browser:
1954 netrwBak : *.bak
1955 netrwCompress: *.gz *.bz2 *.Z *.zip
1956 netrwData : *.dat
1957 netrwHdr : *.h
1958 netrwLib : *.a *.so *.lib *.dll
1959 netrwMakefile: [mM]akefile *.mak
1960 netrwObj : *.o *.obj
1961 netrwTags : tags ANmenu ANtags
1962 netrwTilde : *~
1963 netrwTmp : tmp* *tmp
1965 These syntax highlighting groups are linked
1966 to Folded or DiffChange by default
1967 (see |hl-Folded| and |hl-DiffChange|), but
1968 one may put lines like >
1969 hi link netrwCompress Visual
1970 < into one's <.vimrc> to use one's own
1971 preferences.
1973 *g:netrw_ssh_cmd* One may specify an executable command
1974 to use instead of ssh for remote actions
1975 such as listing, file removal, etc.
1976 default: ssh
1978 *g:netrw_ssh_browse_reject* ssh can sometimes produce unwanted lines,
1979 messages, banners, and whatnot that one doesn't
1980 want masquerading as "directories" and "files".
1981 Use this pattern to remove such embedded
1982 messages. By default its value is:
1983 '^total\s\+\d\+$'
1986 *g:netrw_tmpfile_escape* =' &;'
1987 escape() is applied to all temporary files
1988 to escape these characters.
1990 *g:netrw_timefmt* specify format string to vim's strftime().
1991 The default, "%c", is "the preferred date
1992 and time representation for the current
1993 locale" according to my manpage entry for
1994 strftime(); however, not all are satisfied
1995 with it. Some alternatives:
1996 "%a %d %b %Y %T",
1997 " %a %Y-%m-%d %I-%M-%S %p"
1998 default: "%c"
2000 *g:netrw_use_noswf* netrw normally avoids writing swapfiles
2001 for browser buffers. However, under some
2002 systems this apparently is causing nasty
2003 ml_get errors to appear; if you're getting
2004 ml_get errors, try putting
2005 let g:netrw_use_noswf= 0
2006 in your .vimrc.
2008 *g:netrw_winsize* specify initial size of new windows made with
2009 "o" (see |netrw-o|), "v" (see |netrw-v|),
2010 |:Hexplore| or |:Vexplore|.
2011 default: ""
2013 *g:netrw_xstrlen* Controls how netrw computes a string
2014 including multi-byte characters' string
2015 length. (thanks to N Weibull, T Mechelynck)
2016 =0: uses Vim's built-in strlen()
2017 =1: number of codepoints (Latin + a combining
2018 circumflex is two codepoints) (DEFAULT)
2019 =2: number of spacing codepoints (Latin a +
2020 combining circumflex is one spacing
2021 codepoint; a hard tab is one; wide and
2022 narrow CJK are one each; etc.)
2023 =3: virtual length (counting tabs as anything
2024 between 1 and |'tabstop'|, wide CJJK as 2
2025 rather than 1, Arabic alif as zero when
2026 immediately preceded by lam, one
2027 otherwise, etc)
2029 *g:NetrwTopLvlMenu* This variable specifies the top level
2030 menu name; by default, it's "Netrw.". If
2031 you wish to change this, do so in your
2032 .vimrc.
2034 NETRW BROWSING AND OPTION INCOMPATIBILITIES *netrw-incompatible* {{{2
2036 Netrw has been designed to handle user options by saving them, setting the
2037 options to something that's compatible with netrw's needs, and then restoring
2038 them. However, the autochdir option: >
2039 :set acd
2040 is problematical. Autochdir sets the current directory to that containing the
2041 file you edit; this apparently also applies to directories. In other words,
2042 autochdir sets the current directory to that containing the "file" (even if
2043 that "file" is itself a directory).
2045 NETRW SETTINGS *netrw-settings* {{{2
2047 With the NetrwSettings.vim plugin, >
2048 :NetrwSettings
2049 will bring up a window with the many variables that netrw uses for its
2050 settings. You may change any of their values; when you save the file, the
2051 settings therein will be used. One may also press "?" on any of the lines for
2052 help on what each of the variables do.
2054 (also see: |netrw-browser-var| |netrw-protocol| |netrw-var| |netrw-variables|)
2057 ==============================================================================
2058 OBTAINING A FILE *netrw-O* {{{2
2060 If there are no marked files:
2062 When browsing a remote directory, one may obtain a file under the cursor
2063 (ie. get a copy on your local machine, but not edit it) by pressing the O
2064 key.
2066 If there are marked files:
2068 The marked files will be obtained (ie. a copy will be transferred to your
2069 local machine, but not set up for editing).
2071 Only ftp and scp are supported for this operation (but since these two are
2072 available for browsing, that shouldn't be a problem). The status bar will
2073 then show, on its right hand side, a message like "Obtaining filename". The
2074 statusline will be restored after the transfer is complete.
2076 Netrw can also "obtain" a file using the local browser. Netrw's display
2077 of a directory is not necessarily the same as Vim's "current directory",
2078 unless |g:netrw_keepdir| is set to 0 in the user's <.vimrc>. One may select
2079 a file using the local browser (by putting the cursor on it) and pressing
2080 "O" will then "obtain" the file; ie. copy it to Vim's current directory.
2082 Related topics:
2083 * To see what the current directory is, use |:pwd|
2084 * To make the currently browsed directory the current directory, see |netrw-c|
2085 * To automatically make the currently browsed directory the current
2086 directory, see |g:netrw_keepdir|.
2089 OPEN A NEW FILE IN NETRW'S CURRENT DIRECTORY *netrw-%*
2091 To open a file in netrw's current directory, press "%". This map will
2092 query the user for a new filename; an empty file by that name will be
2093 placed in the netrw's current directory (ie. b:netrw_curdir).
2096 PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2
2098 One may use a preview window by using the "p" key when the cursor is atop the
2099 desired filename to be previewed. The display will then split to show both
2100 the browser (where the cursor will remain) and the file (see |:pedit|).
2101 By default, the split will be taken horizontally; one may use vertical
2102 splitting if one has set |g:netrw_preview| first.
2105 PREVIOUS WINDOW *netrw-P* *netrw-prvwin* {{{2
2107 To edit a file or directory in the previously used (last accessed) window (see
2108 :he |CTRL-W_p|), press a "P". If there's only one window, then the one window
2109 will be horizontally split (above/below splitting is controlled by
2110 |g:netrw_alto|, and its initial size is controlled by |g:netrw_winsize|).
2112 If there's more than one window, the previous window will be re-used on
2113 the selected file/directory. If the previous window's associated buffer
2114 has been modified, and there's only one window with that buffer, then
2115 the user will be asked if s/he wishes to save the buffer first (yes,
2116 no, or cancel).
2119 REFRESHING THE LISTING *netrw-ctrl-l* *netrw-ctrl_l* {{{2
2121 To refresh either a local or remote directory listing, press ctrl-l (<c-l>) or
2122 hit the <cr> when atop the ./ directory entry in the listing. One may also
2123 refresh a local directory by using ":e .".
2126 RENAMING FILES OR DIRECTORIES *netrw-move* *netrw-rename* *netrw-R* {{{2
2128 If there are no marked files: (see |netrw-mf|)
2130 Renaming/moving files and directories involves moving the cursor to the
2131 file/directory to be moved (renamed) and pressing "R". You will then be
2132 queried for where you want the file/directory to be moved. You may select
2133 a range of lines with the "V" command (visual selection), and then
2134 pressing "R".
2136 If there are marked files: (see |netrw-mf|)
2138 Marked files will be renamed (moved). You will be queried as above in
2139 order to specify where you want the file/directory to be moved.
2141 WARNING:~
2143 Note that moving files is a dangerous operation; copies are safer. That's
2144 because a "move" for remote files is actually a copy + delete -- and if
2145 the copy fails and the delete does not, you may lose the file.
2147 The g:netrw_rename_cmd variable is used to implement renaming. By default its
2148 value is:
2150 ssh HOSTNAME mv
2152 One may rename a block of files and directories by selecting them with
2153 the V (|linewise-visual|).
2156 REVERSING SORTING ORDER *netrw-r* *netrw-reverse* {{{2
2158 One may toggle between normal and reverse sorting order by pressing the
2159 "r" key.
2161 Related topics: |netrw-s|
2162 Associated setting variable: |g:netrw_sort_direction|
2165 SELECTING SORTING STYLE *netrw-s* *netrw-sort* {{{2
2167 One may select the sorting style by name, time, or (file) size. The "s" map
2168 allows one to circulate amongst the three choices; the directory listing will
2169 automatically be refreshed to reflect the selected style.
2171 Related topics: |netrw-r| |netrw-S|
2172 Associated setting variables: |g:netrw_sort_by| |g:netrw_sort_sequence|
2175 10. Problems and Fixes *netrw-problems* {{{1
2177 (This section is likely to grow as I get feedback)
2178 (also see |netrw-debug|)
2179 *netrw-p1*
2180 P1. I use windows 95, and my ftp dumps four blank lines at the
2181 end of every read.
2183 See |netrw-fixup|, and put the following into your
2184 <.vimrc> file:
2186 let g:netrw_win95ftp= 1
2188 *netrw-p2*
2189 P2. I use Windows, and my network browsing with ftp doesn't sort by
2190 time or size! -or- The remote system is a Windows server; why
2191 don't I get sorts by time or size?
2193 Windows' ftp has a minimal support for ls (ie. it doesn't
2194 accept sorting options). It doesn't support the -F which
2195 gives an explanatory character (ABC/ for "ABC is a directory").
2196 Netrw then uses "dir" to get both its short and long listings.
2197 If you think your ftp does support a full-up ls, put the
2198 following into your <.vimrc>: >
2200 let g:netrw_ftp_list_cmd = "ls -lF"
2201 let g:netrw_ftp_timelist_cmd= "ls -tlF"
2202 let g:netrw_ftp_sizelist_cmd= "ls -slF"
2203 <
2204 Alternatively, if you have cygwin on your Windows box, put
2205 into your <.vimrc>: >
2207 let g:netrw_cygwin= 1
2208 <
2209 This problem also occurs when the remote system is Windows.
2210 In this situation, the various g:netrw_ftp_[time|size]list_cmds
2211 are as shown above, but the remote system will not correctly
2212 modify its listing behavior.
2215 *netrw-p3*
2216 P3. I tried rcp://user@host/ (or protocol other than ftp) and netrw
2217 used ssh! That wasn't what I asked for...
2219 Netrw has two methods for browsing remote directories: ssh
2220 and ftp. Unless you specify ftp specifically, ssh is used.
2221 When it comes time to do download a file (not just a directory
2222 listing), netrw will use the given protocol to do so.
2224 *netrw-p4*
2225 P4. I would like long listings to be the default.
2227 Put the following statement into your |.vimrc|: >
2229 let g:netrw_liststyle= 1
2230 <
2231 Check out |netrw-browser-var| for more customizations that
2232 you can set.
2234 *netrw-p5*
2235 P5. My times come up oddly in local browsing
2237 Does your system's strftime() accept the "%c" to yield dates
2238 such as "Sun Apr 27 11:49:23 1997"? If not, do a "man strftime"
2239 and find out what option should be used. Then put it into
2240 your |.vimrc|: >
2242 let g:netrw_timefmt= "%X" (where X is the option)
2243 <
2244 *netrw-p6*
2245 P6. I want my current directory to track my browsing.
2246 How do I do that?
2248 Put the following line in your |.vimrc|:
2249 >
2250 let g:netrw_keepdir= 0
2251 <
2252 *netrw-p7*
2253 P7. I use Chinese (or other non-ascii) characters in my filenames, and
2254 netrw (Explore, Sexplore, Hexplore, etc) doesn't display them!
2256 (taken from an answer provided by Wu Yongwei on the vim
2257 mailing list)
2258 I now see the problem. You code page is not 936, right? Vim
2259 seems only able to open files with names that are valid in the
2260 current code page, as are many other applications that do not
2261 use the Unicode version of Windows APIs. This is an OS-related
2262 issue. You should not have such problems when the system
2263 locale uses UTF-8, such as modern Linux distros.
2265 (...it is one more reason to recommend that people use utf-8!)
2267 *netrw-p8*
2268 P8. I'm getting "ssh is not executable on your system" -- what do I
2269 do?
2271 (Dudley Fox) Most people I know use putty for windows ssh. It
2272 is a free ssh/telnet application. You can read more about it
2273 here:
2275 http://www.chiark.greenend.org.uk/~sgtatham/putty/ Also:
2277 (Marlin Unruh) This program also works for me. It's a single
2278 executable, so he/she can copy it into the Windows\System32
2279 folder and create a shortcut to it.
2281 (Dudley Fox) You might also wish to consider plink, as it
2282 sounds most similar to what you are looking for. plink is an
2283 application in the putty suite.
2285 http://the.earth.li/~sgtatham/putty/0.58/htmldoc/Chapter7.html#plink
2287 (Vissale Neang) Maybe you can try OpenSSH for windows, which
2288 can be obtained from:
2290 http://sshwindows.sourceforge.net/
2292 It doesn't need the full Cygwin package.
2294 (Antoine Mechelynck) For individual Unix-like programs needed
2295 for work in a native-Windows environment, I recommend getting
2296 them from the GnuWin32 project on sourceforge if it has them:
2298 http://gnuwin32.sourceforge.net/
2300 Unlike Cygwin, which sets up a Unix-like virtual machine on
2301 top of Windows, GnuWin32 is a rewrite of Unix utilities with
2302 Windows system calls, and its programs works quite well in the
2303 cmd.exe "Dos box".
2305 (dave) Download WinSCP and use that to connect to the server.
2306 In Preferences > Editors, set gvim as your editor:
2308 - Click "Add..."
2309 - Set External Editor (adjust path as needed, include
2310 the quotes and !.! at the end):
2311 "c:\Program Files\Vim\vim70\gvim.exe" !.!
2312 - Check that the filetype in the box below is
2313 {asterisk}.{asterisk} (all files), or whatever types
2314 you want (cec: change {asterisk} to * ; I had to
2315 write it that way because otherwise the helptags
2316 system thinks it's a tag)
2317 - Make sure it's at the top of the listbox (click it,
2318 then click "Up" if it's not)
2319 If using the Norton Commander style, you just have to hit <F4>
2320 to edit a file in a local copy of gvim.
2322 (Vit Gottwald) How to generate public/private key and save
2323 public key it on server: >
2324 http://www.tartarus.org/~simon/puttydoc/Chapter8.html#pubkey-gettingready
2325 8.3 Getting ready for public key authentication
2326 <
2327 How to use a private key with 'pscp': >
2329 http://www.tartarus.org/~simon/puttydoc/Chapter5.html
2330 5.2.4 Using public key authentication with PSCP
2331 <
2332 (Ben Schmidt) I find the ssh included with cwRsync is
2333 brilliant, and install cwRsync or cwRsyncServer on most
2334 Windows systems I come across these days. I guess COPSSH,
2335 packed by the same person, is probably even better for use as
2336 just ssh on Windows, and probably includes sftp, etc. which I
2337 suspect the cwRsync doesn't, though it might
2339 (cec) To make proper use of these suggestions above, you will
2340 need to modify the following user-settable variables in your
2341 .vimrc:
2343 |g:netrw_ssh_cmd| |g:netrw_list_cmd| |g:netrw_mkdir_cmd|
2344 |g:netrw_rm_cmd| |g:netrw_rmdir_cmd| |g:netrw_rmf_cmd|
2346 The first one (|g:netrw_ssh_cmd|) is the most important; most
2347 of the others will use the string in g:netrw_ssh_cmd by
2348 default.
2349 *netrw-p9* *netrw-ml_get*
2350 P9. I'm browsing, changing directory, and bang! ml_get errors
2351 appear and I have to kill vim. Any way around this?
2353 Normally netrw attempts to avoid writing swapfiles for
2354 its temporary directory buffers. However, on some systems
2355 this attempt appears to be causing ml_get errors to
2356 appear. Please try setting |g:netrw_use_noswf| to 0
2357 in your <.vimrc>: >
2358 let g:netrw_use_noswf= 0
2359 <
2360 *netrw-p10*
2361 P10. I'm being pestered with "[something] is a directory" and
2362 "Press ENTER or type command to continue" prompts...
2364 The "[something] is a directory" prompt is issued by Vim,
2365 not by netrw, and there appears to be no way to work around
2366 it. Coupled with the default cmdheight of 1, this message
2367 causes the "Press ENTER..." prompt. So: read |hit-enter|;
2368 I also suggest that you set your |'cmdheight'| to 2 (or more) in
2369 your <.vimrc> file.
2371 *netrw-p11*
2372 P11. I want to have two windows; a thin one on the left and my editing
2373 window on the right. How can I do this?
2375 * Put the following line in your <.vimrc>:
2376 let g:netrw_altv = 1
2377 * Edit the current directory: :e .
2378 * Select some file, press v
2379 * Resize the windows as you wish (see |CTRL-W_<| and
2380 |CTRL-W_>|). If you're using gvim, you can drag
2381 the separating bar with your mouse.
2382 * When you want a new file, use ctrl-w h to go back to the
2383 netrw browser, select a file, then press P (see |CTRL-W_h|
2384 and |netrw-P|). If you're using gvim, you can press
2385 <leftmouse> in the browser window and then press the
2386 <middlemouse> to select the file.
2388 ==============================================================================
2389 11. Debugging Netrw Itself *netrw-debug* {{{1
2391 The <netrw.vim> script is typically available as:
2392 >
2393 /usr/local/share/vim/vim6x/plugin/netrwPlugin.vim
2394 /usr/local/share/vim/vim6x/autoload/netrw.vim
2395 < -or- >
2396 /usr/local/share/vim/vim7x/plugin/netrwPlugin.vim
2397 /usr/local/share/vim/vim7x/autoload/netrw.vim
2398 <
2399 which is loaded automatically at startup (assuming :set nocp).
2401 1. Get the <Decho.vim> script, available as:
2403 http://mysite.verizon.net/astronaut/vim/index.html#DECHO
2404 or
2405 http://vim.sourceforge.net/scripts/script.php?script_id=120
2407 It now comes as a "vimball"; if you're using vim 7.0 or earlier,
2408 you'll need to update vimball, too. See
2409 http://mysite.verizon.net/astronaut/vim/index.html#VIMBALL
2411 2. Edit the <netrw.vim> file by typing: >
2413 vim netrw.vim
2414 :DechoOn
2415 :wq
2416 <
2417 To restore to normal non-debugging behavior, re-edit <netrw.vim>
2418 and type >
2420 vim netrw.vim
2421 :DechoOff
2422 :wq
2423 <
2424 This command, provided by <Decho.vim>, will comment out all
2425 Decho-debugging statements (Dfunc(), Dret(), Decho(), Dredir()).
2427 3. Then bring up vim and attempt to evoke the problem by doing a
2428 transfer or doing some browsing. A set of messages should appear
2429 concerning the steps that <netrw.vim> took in attempting to
2430 read/write your file over the network in a separate tab.
2432 To save the file, use >
2433 :wincmd j
2434 :set bt=
2435 :w! DBG
2436 < Please send that information to <netrw.vim>'s maintainer, >
2437 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
2438 <
2439 ==============================================================================
2440 12. History *netrw-history* {{{1
2442 v133: Aug 10, 2008 * NetReadFixup() for win95 was missing some "a:"s
2443 Aug 12, 2008 * (Jan Minář) an error condition in NetrwMethod()
2444 wasn't being used, resulting in b:netrw_fname
2445 undefined errors
2446 Aug 12, 2008 * (François Ingeirest) asked that "hi link" be
2447 changed to hi default link in the netrw syntax
2448 files.
2449 Aug 12, 2008 * using s:NetrwUnmarkList() more often. Filenames
2450 were being left on the global list when removed
2451 from the buffer-local lists.
2452 Aug 14, 2008 * (Joshua Clayton) an errant extra ")" was left in
2453 the rcp-handling portion of NetRead().
2454 Sep 03, 2008 * added |'cursorline'| highlighting to thin, long,
2455 and tree displays.
2456 v132: Aug 06, 2008 * Fixed marked file-based obtain
2457 Aug 08, 2008 * sourcing a file via ftp from a netrw-generated
2458 buffer (or any buffer with |'nobl'|) left an
2459 empty no-name buffer in its wake. Fixed.
2460 v130: Jul 31, 2008 * trying out elinks/links for http://host/
2461 requests. One problem: in-page links
2462 (such as with ...#LABEL) are not supported
2463 * verified that Bram's modified netrwPlugin works
2464 Aug 01, 2008 * fixed a bug: when sourcing a file via ftp, the
2465 "filter window" was left behind.
2466 v129: Jul 31, 2008 * bug found in non-mouse enabled vim and some
2467 local maps
2468 v128: Jul 30, 2008 * much work done in using shellescape() and
2469 fnameescape()
2470 v126: Jun 30, 2008 * after having gone to a remote directory,
2471 <f1> was no longer taking one to the correct
2472 entry in the help (|netrw-quickhelp|). Fixed.
2473 Jul 01, 2008 * extracting the last filename from a wide listing
2474 missed the last letter when |'virtualedit'| not
2475 enabled.
2476 Jul 01, 2008 * vim foo/bar was creating [Scratch] buffers,
2477 where bar was also a directory
2478 Jul 01, 2008 * numerous additional changes were made to netrw
2479 to use fnameescape() and shellescape() instead
2480 of escape(). Not all changes have been tested
2481 as yet...
2482 Jul 01, 2008 * (James Vega reported) some problems with
2483 :NetrwSettings (due to no longer used setting
2484 variables).
2485 Jul 07, 2008 * Additional numerous changes to support security;
2486 shellescape(arg,1), etc.
2487 v125: Apr 07, 2008 * (Cristian Rigamonti) CR provides a patch; he
2488 noted that gx was failing since its call to
2489 netrw#NetBrowseX() wasn't updated to
2490 netrw#NetrwBrowseX().
2491 * (Stanis Trendelenburg) ST provides a patch to
2492 supports davs: (dav + ssl)
2493 * (Rick Choi) noted that directory names comprised
2494 of three digits were not being displayed by
2495 the internal browser. Fixed.
2496 * (Erik Falor) provided a patch to handle problems
2497 with changing directory and |'acd'| option.
2498 * (James Vega, Teemu Likonen) noted that netrw
2499 wasn't handling multi-byte filenames/directories
2500 correctly. Fixed.
2501 * (Rick) found problem with g:netrw_maxfilenamelen
2502 being overridden.
2503 * (James Vega) pointed out that netrw was
2504 misidentifying all files in a symbolically linked
2505 directory as being symbolically linked
2506 themselves. This particular problem was fixed;
2507 however, there are now situations where
2508 symbolically linked files will not be detected.
2509 Really need an internal vim function to do this
2510 identification.
2511 Apr 17, 2008 * When g:netrw_keepdir==0, current directory
2512 doesn't necessarily equal b:netrw_curdir
2513 initially. Problem is due to the patch directly
2514 above.
2515 * Fixed qf to handle case where b:netrw_curdir
2516 isn't the same as the current directory under
2517 linux/macosx.
2518 * New: |netrw-mg| (apply vimgrep to marked files)
2519 May 05, 2008 * (Rick) pointed out that a "setlocal ts=32" was
2520 interfering with g:netrw_maxfilenamelen
2521 May 05, 2008 * (James Vega) a file inside a linked directory
2522 was showing up as a symbolic link itself.
2523 May 22, 2008 * symbolic links, fifos, and sockets are now
2524 indicated by a trailing @, |, or =, respectively.
2525 Jun 06, 2008 * Removed numerous bugs from the marked file
2526 move and copy. Tested these changes under
2527 Unix only thus far.
2528 * :Rexplore returns to the screen position in the
2529 netrw listing from whence the file was edited
2530 v124: Apr 02, 2008 * (Adrian Rollett) change the line supporting the
2531 "x" action for mac to use g:netrw_shq
2532 v123: Feb 27, 2008 * Marked files now keeps a "global" marked file
2533 list. The global marked file list is used to
2534 support tag processing and vimdiff'ing
2535 (|netrw-md| |netrw-mt|)
2536 * Been insuring that mm and mc works with various
2537 combinations of local and remote directories
2538 * (Stefan Bittner) http://.../ should always have
2539 filetype "html" -- fixed.
2540 * (Stefan Bittner) a "?" in a http://.../ request
2541 wasn't being handled correctly. Fixed by
2542 removing ? from default |g:netrw_tmpfile_escape|.
2543 * (Nico Weber) % codes in http://.../ requests
2544 weren't being handled correctly. Fixed by
2545 including % in default |g:netrw_fname_escape|.
2546 * (Stefan Bittner) attempts to update Buffers.Refresh
2547 were failing because locale use changed the menu
2548 names. I implemented a workaround.
2549 v122: Feb 12, 2008 * bugfix - first sorting sequence match now has
2550 priority
2551 Feb 14, 2008 * bugfix - sorting sequence was effectively ignoring
2552 sequencing priority of anything following '*'
2553 * toggling a marked file was showing incorrect list
2554 (list was correct, but displayed matches weren't)
2555 * |g:netrw_special_syntax| implemented
2556 v121: Feb 11, 2008 * Bram M reported that :e file ... :e . would not
2557 retain the alternate file. Fixed -- I hope!
2558 * bugfix -- apparently v120 broke an explicit
2559 :Explore dirname
2560 v120: Jan 21, 2008 * |netrw-mt| changed to allow for target selection
2561 based on whether or not word under cursor is a
2562 directory or file, or if cursor is in banner
2563 area.
2564 * |netrw-mh| included (hiding by marked-file suffix)
2565 * functions moved about a bit (improved
2566 categorization)
2567 * executable files now displayed with trailing (*)
2568 * symbolically linked files now displayed with
2569 trailing (@)
2570 * Somewhen, s:NetrwMarkFileMove() got damaged. Its
2571 now restored (missing an endif, for example).
2572 * |netrw-mu| implemented (unmarking marked files)
2573 * many bugs have been removed from the marked file
2574 system (tnx to Mark S. for feedback)
2575 * |netrw-ms| implemented (sourcing marked files)
2576 * fixed use of P with tree listing style
2577 * multiple tree listing now supported
2578 * ./ suppressed
2579 * changed q -> qb (query bookmarks)
2580 * implemented |netrw-qf|
2581 * Explore now has four special list-generation
2582 modes: */filepat **/filepat
2583 *//pattern **//pattern
2584 * gh (|netrw-gh|) is a shortcut for toggling the
2585 hiding of files and directories beginning with a
2586 dot
2587 v119: Jan 10, 2008 * When g:netrw_keepdir is false,
2588 NetrwOptionsRestore() had a problem
2589 (Bill McCarthy)
2590 Jan 11, 2008 * Netrw now shows symbolic links with a trailing
2591 "@" and special highlighting.
2592 Jan 15, 2008 * Changed g:netrw_noretmap -> |g:netrw_retmap|.
2593 Changed: disabled by default at Bram's
2594 preference.
2595 v118: Jan 02, 2008 * Fixed a problem with Windows;
2596 :Explore c:/path/ would not work,
2597 but :Explore c:/path would.
2598 * Fixed a bug in s:NetrwOptionRestore() - lcd's
2599 argument wasn't being properly escaped so it
2600 wouldn't handle spaces in directory names.
2601 (Gary Johnson)
2602 v117: Jan 02, 2008 * Fixed a problem with P; had to include
2603 a b:netrw_curdir bypass (Bram Moolenaar)
2604 v116: Nov 27, 2007 * netrw#LocalBrowseCheck() has &ft=="netrw"
2605 check to prevent doing a directory listing
2606 (was getting unexpected directory refreshes
2607 in the middle of some function calls)
2608 * NetrwOptionRestore moved after e! filename
2609 in order to retain user options for editing
2610 in s:NetrwBrowseChgDir()
2611 Dec 12, 2007 * Bug fix -- netrw does a better job of retaining
2612 user options when editing files under the aegis
2613 of the browser
2614 v115: Oct 04, 2007 * Erik Remmelzwaal pointed out that the use of
2615 shellslash in s:GetTempfile() was incorrect
2616 Oct 11, 2007 * Tracked down and eliminated a bug with editing
2617 remote *.tar.gz and *.tar.bz2 files
2618 Oct 11, 2007 * g:netrw_localmovecmd wasn't being initialized
2619 properly, and g:netrw_localcopycmd was being
2620 overwritten.
2621 Oct 12, 2007 * Placed all :Rexplore and <2-leftmouse> setup
2622 in a new support function (s:SetRexDir()).
2623 Oct 15, 2007 * new: g:netrw_browse_split == 4; means <cr>
2624 based selection will use previous window
2625 Oct 20, 2007 * also checks on |'shellxquote'| to set g:netrw_shq
2626 Oct 24, 2007 * Explore handles path/**/filename
2627 Oct 27, 2007 * sourcing remote files often didn't work with ftp,
2628 turns out that b:netrw_method was undefined, so
2629 s:SaveBufVars and s:RestoreBufVars() fixed it.
2630 v114: Sep 28, 2007 * mT, the map that invokes tags, has been improved
2631 to support use of remote tags files.
2632 Oct 02, 2007 * changed Netrw menu to use more submenus
2633 v113: Sep 07, 2007 * worked out why the cursor position wasn't being
2634 saved and restored as intended after doing such
2635 things as deleting and renaming files.
2636 Sep 11, 2007 * Fixed bug which effectively disabled <c-l> and
2637 <c-h> maps
2638 Sep 18, 2007 * there used to be one NetrwOptionRestore() call at
2639 the end of the s:NetrwBrowseChgDir() function;
2640 they're now at the end of every if..elseif..else
2641 block. The edit-a-file one is not quite at the end
2642 of its block; instead, its just before the edit.
2643 Restores user options, then this new placement
2644 allows ftplugins, autocmds, etc to change settings
2645 (ex. ftplugin/cpp.vim sets cindent).
2646 Sep 19, 2007 * changed all strlen() calls to use s:Strlen(), a
2647 function which handles utf-8 wide characters
2648 correctly.
2649 Sep 20, 2007 * (Nico Weber) the "x" command has been extended
2650 to Mac's OS/X (macunix); it now uses open to
2651 handle |netrw-x| browsing with special files.
2652 Sep 22, 2007 * Added g:netrw_noretmap to netrw at Tony M's
2653 request.
2654 * Included path to NetrwRemoteRmFile()
2655 v112: Aug 18, 2007 * added mx (|netrw-mx|) for executing arbitrary
2656 commands on marked files
2657 Aug 22, 2007 * more option save/restore work for
2658 s:NetrwBrowseChgDir(); s:NetrwOptionSave()
2659 and s:NetrwOptionRestore() now take a parameter
2660 specifying the type of variables to be used for
2661 saving and restoring (either "w:" or "s:")
2662 Sep 04, 2007 * added the :NetrwClean[!] command
2663 v111: Jul 25, 2007 * using Windows but not using Cygwin, netrw does a
2664 "file bufname" where the bufname uses /s
2665 instead of \s; Vim "fixes" it by changing the
2666 bufname to use \s anyway. This meant that
2667 NetrwGetBuffer() didn't find the appropriately
2668 named buffer, and so would generate a new
2669 buffer listing; hence the cursor would appear
2670 to have been moved when doing a preview.
2671 * added <2-leftmouse> map to return to netrw's
2672 browser display
2673 Aug 16, 2007 * added the mark-file system, including
2674 maps for mf mp mt mz and mu. Modifications
2675 made to maps for a D O and R to support
2676 marked files.
2677 v110: May 10, 2007 * added [ and ] maps to NetrwTreeListing
2678 May 25, 2007 * |g:netrw_preview| included
2679 May 29, 2007 * modifed netrw#NetBrowseX to consistently use
2680 g:netrw_shq instead of hardcoded quotes,
2681 and modified the snippet that sets up redir
2682 so Windows machines use "nul" instead of
2683 "/dev/null".
2684 Jun 01, 2007 * fixed bug -- NetGetBuffer() wasn't always
2685 recognizing a buffer name match when it should,
2686 thus resulting in [Scratch] buffers.
2687 Jun 04, 2007 * Gary Johnson found a bugfix for the "c" mapping
2688 when the directory is to be made current but
2689 the name contains spaces.
2690 v109: Mar 26, 2007 * if a directory name includes a "$" character,
2691 Explore() will use expand() in an attempt to
2692 decipher the name.
2693 May 07, 2007 * g:netrw_use_errorwindow now allows one to
2694 have error messages go to a reliable window
2695 or to use a less reliable but recallable
2696 echoerr method
2697 May 07, 2007 * g:netrw_scpport and g:netrw_sshport support
2698 use of -P and -p, respectively, to set port
2699 for scp/ssh.
2700 v108: Jan 03, 2007 * included preview map (|netrw-p|), supporting
2701 remote browsing
2702 * netrw can now source remote files
2703 Jan 26, 2007 * Colton Jamieson noted that remote directory
2704 browsing did not support alternate port
2705 selection. This feature has now been extended
2706 to apply to all remote browsing commands via ssh.
2707 (list, remove/delete, rename)
2708 Jan 31, 2007 * Luis Florit reported that @* was an invalid
2709 register. The @* register is now only saved and
2710 restored if |'guioptions'| contains "a".
2711 Feb 02, 2007 * Fixed a bug that cropped up when writing files
2712 via scp using cygwin
2713 Feb 08, 2007 * tree listing mode managed to stop working again;
2714 fixed again!
2715 Feb 15, 2007 * Guido Van Hoecke reported that netrw didn't
2716 handle browsing well with M$ ftp servers. He even
2717 set up a temporary account for me to test with
2718 (thanks!). Netrw now can browse M$ ftp servers.
2719 v107: Oct 12, 2006 * bypassed the autowrite option
2720 Oct 24, 2006 * handles automatic decompression of *.gz and *.bz2
2721 files
2722 Nov 03, 2006 * Explore will highlight matching files when
2723 **/pattern is used (and if the |'hls'| option
2724 is set)
2725 Nov 09, 2006 * a debugging line, when enabled, was inadvertently
2726 bringing up help instead of simply reporting on
2727 list contents
2728 Nov 21, 2006 * tree listing improved (cursor remains put)
2729 Nov 27, 2006 * fixed b:netrw_curdir bug when repeated "i"s were
2730 pressed.
2731 Dec 15, 2006 * considerable qty of changes, mostly to share more
2732 code between local and remote browsing. Includes
2733 support for tree-style listing for both remote
2734 and local browsing.
2735 Dec 15, 2006 * Included Peter Bengtsson's modifications to
2736 support the Amiga.
2737 v106: Sep 21, 2006 * removed old v:version<700 code as netrw now
2738 requires vim 7.0
2739 * worked around a bug where register * was
2740 overwritten during local browsing
2741 v104: Sep 05, 2006 * as suggested by Rodolfo Borges, :Explore and
2742 variants will position the cursor on the file
2743 just having been edited
2744 * changed default |g:netrw_sort_sequence| order
2745 * changed b, Nb to simply mb (see |netrw-mb|)
2746 * changed B, NB to simply gb (see |netrw-gb|)
2747 * tree listing style (see |g:netrw_liststyle|)
2748 * attempts to retain the alternate file
2749 v103: Jul 26, 2006 * used Yakov Lerner's tip#1289 to improve netrw
2750 error message display
2751 * wide listings didn't handle files with backslashes
2752 in their names properly. A symptom was an
2753 inability to open files.
2754 Aug 09, 2006 * included "t" mapping for opening tabbed windows,
2755 both for remote and local browsing
2756 * changed netrw_longlist to netrw_liststyle
2757 Aug 15, 2006 * fixed one of the NB maps
2758 Aug 22, 2006 * changed *Explore commands to use -nargs=* instead
2759 of -nargs=?. Allows both -complete=dir _and_ the
2760 starstar arguments to work (-nargs=? seems to
2761 require one or the other).
2762 Aug 23, 2006 * copied all w:.. variables across splits to
2763 new windows
2764 Aug 25, 2006 * when g:netrw_browsex_viewer was '-'
2765 (see |g:netrw_browsex_viewer|) it wasn't causing
2766 netrwFileHandlers#Invoke() to be called as it
2767 was expected to. (tnx Steve Dugaro)
2768 Aug 29, 2006 * changed NetBrowseX() to use "setlocal ... noswf"
2769 instead of "set ... noswf" (tnx Benji Fisher)
2770 Aug 31, 2006 * tabs and fastbrowse<=1 didn't work together.
2771 v102: Jun 15, 2006 * chgd netrwPlugin to call netrw#LocalBrowseCheck()
2772 * bugfix: g:netrw_keepdir==0 had stopped working
2773 Jul 06, 2006 * bugfix: NetOptionSave/Restore now saves/restores
2774 the unnamed register (|registers|)
2775 Jul 07, 2006 * |g:netrw_menu| support included
2776 Jul 13, 2006 * :Texplore command implemented
2777 Jul 17, 2006 * NetSplit and (Local|Net)BrowseChgDir() were both
2778 splitting windows. This affected o, v, and
2779 g:netrw_browse_split.
2780 Jul 20, 2006 * works around wildignore setting (was causing
2781 netrw's local browser not to list wildignore'd
2782 files)
2783 Jul 24, 2006 * <leftmouse> acts as a <cr> for selecting a file
2784 <rightmouse> acts as a <del> for deleting a file
2785 v100: May 14, 2006 * when using Windows and shell==cmd.exe, the
2786 default for g:netrw_ignorenetrc is now 1
2787 * bugfix: unwanted ^Ms now removed
2788 (affected shell==cmd.exe - Windows)
2789 * added Bookmarks and History to the menu
2790 * an error message about non-existing
2791 w:netrw_longlist was appearing during attempts to
2792 Explore (fixed)
2793 * g:netrw_shq now available to make netrw use
2794 specified style of quotes for commands
2795 May 29, 2006 * user NFH_*() functions were inadvertently being
2796 ignored
2797 * fixed a Windows non-cygwin ftp handling problem.
2798 * hiding pattern candidate separators included some
2799 characters it shouldn't have (tnx to Osei Poku)
2800 Jun 01, 2006 * for browsing, netrw was supposed to use "dir"
2801 instead of "ls -lF" when using
2802 ftp+non-cygwin+windows. Fixed.
2803 * an inadvertently left-in-place debugging statement
2804 was preventing use of the "x" key with browsing.
2805 Jun 05, 2006 * g:netrw_nogx available to prevent making the gx
2806 map (see |g:netrw_nogx|)
2807 * bugfix, Explore wouldn't change directory
2808 properly (vim ., :Explore subdirname)
2809 Jun 06, 2006 * moved history to 2nd line in Netrw menu
2810 * fixed delete for unix-based systems
2811 Jun 07, 2006 * x key now works for windows-noncygwin-ftp
2812 Jun 08, 2006 * Explore */pat and **//pat now wraps
2813 v99: May 09, 2006 * g:netrw_browse_split=3 for opening files in new
2814 tabs implemented.
2815 May 12, 2006 * deletes temporary file at end of NetRead()
2816 * visual mode based Obtain implemented
2817 * added -complete=dir to the various Explore
2818 commands
2819 v98: May 02, 2006 * the "p" key didn't work properly when the browsing
2820 directory name had spaces in it.
2821 v97: May 01, 2006 * exists("&acd") now used to determine if
2822 the 'acd' option exists
2823 * "obtain" now works again under Windows
2824 v96: * bugfix - the |'acd'| option is not always defined
2825 but is now bypassed only when it is
2826 v95: * bugfix - Hiding mode worked correctly (don't show
2827 any file matching any of the g:netrw_hide
2828 patterns), but showing mode was showing only those
2829 files that didn't match any of the g:netrw_hide
2830 patterns. Instead, it now shows all files that
2831 match any of the g:netrw_hide patterns (the
2832 difference between a logical and and logical or).
2833 v94: * bugfix - a Decho() had a missing quote; only
2834 affects things when debugging was enabled.
2835 v93: * bugfix - removed FocusGained event from causing a
2836 slow-browser refresh for Windows
2837 v92: * :Explore **//pattern implemented
2838 (**/filepattern was already taken)
2839 v91: * :Explore */pattern implemented
2840 * |'acd'| option bypassed
2841 v90: * mark ', as suggested by Yegappan Lakshmanan, used
2842 to help guarantee entry into the jump list when
2843 appropriate.
2844 * <s-down> and <s-up> are no longer defined until a
2845 :Explore **/pattern is used (if the user already
2846 has a map for them). They will be defined for new
2847 browser windows from that point forward.
2848 v89: * A <s-down>, <s-up>, :Nexplore, or a :Pexplore
2849 without having first done an :Explore **/pattern
2850 (see |netrw-starstar|) caused
2851 a lot of unhelpful error messages to appear
2852 v88: * moved DrChip.Netrw menu to Netrw. Now has
2853 priority 80 by default.
2854 g:NetrwTopLvlMenu == "Netrw" and can be changed
2855 by the user to suit. The priority is given by
2856 g:NetrwMenuPriority.
2857 * Changed filetype for browser displays from
2858 netrwlist to netrw.
2859 v87: * bug fix -- menus were partially disappearing
2860 v85: * bug fix -- missing an endif
2861 * bug fix -- handles spaces in names and directories
2862 when using ftp-based browsing
2863 v83: * disabled stop-acd handling; the change in directory
2864 handling may allow acd to be used again.
2865 * D was refusing to delete remote files/directories
2866 in wide listing mode.
2867 v81: * FocusGained also used to refresh/wipe local browser
2868 directory buffers
2869 * (bugfix) netrw was leaving [Scratch] buffers behind
2870 when the user had the "hidden" option set. The
2871 'hidden' option is now bypassed.
2872 v80: * ShellCmdPost event used in conjunction with
2873 g:netrw_fastbrowse to refresh/wipe local browser
2874 directory buffers.
2875 v79: * directories are now displayed with nowrap
2876 * (bugfix) if the column width was smaller than the
2877 largest file's name, then netrw would hang when
2878 using wide-listing mode - fixed
2879 * g:netrw_fastbrowse introduced
2880 v78: * progress has been made on allowing spaces inside
2881 directory names for remote work (reading, writing,
2882 browsing). (scp)
2883 v77: * Mikolaj Machowski fixed a bug in a substitute cmd
2884 * g:netrw_browsex_viewer implemented
2885 * Mikolaj Machowski pointed out that gnome-open is
2886 often executable under KDE systems, although it is
2887 effectively not functional. NetBrowseX now looks
2888 for "kicker" as a running process to determine if
2889 KDE is actually running.
2890 * Explorer's O functionality was inadvertently left
2891 out. Netrw now does the same thing, but with the
2892 "P" key.
2893 * added g:netrw_browse_split option
2894 * fixed a bug where the directory contained a "." but
2895 the file didn't (was treating the dirname from "."
2896 onwards as a suffix)
2897 v76: * "directory is missing" error message now restores
2898 echo highlighting
2899 v75: * file://... now conforms to RFC2396 (thanks to
2900 S. Zacchiroli)
2901 * if the binary option is set, then NetWrite() will
2902 only write the whole file (line numbers don't make
2903 sense with this). Supports writing of tar and zip
2904 files.
2905 v74: * bugfix (vim, then :Explore) now works
2906 * ctrl-L keeps cursor at same screen location (both
2907 local and remote browsing)
2908 * netrw now can read remote zip and tar files
2909 * Obtain now uses WinXP ftp+.netrc successfully
2910 v73: * bugfix -- scp://host/path/file was getting named
2911 incorrectly
2912 * netrw detects use of earlier-than-7.0 version of
2913 vim and issues a pertinent error message.
2914 * netrwSettings.vim is now uses autoloading. Only
2915 <netrwPlugin.vim> is needed as a pure plugin
2916 (ie. always loaded).
2917 v72: * bugfix -- formerly, one could prevent the loading
2918 of netrw by "let g:loaded_netrw=1"; when
2919 autoloading became supported, this feature was
2920 lost. It is now restored.
2921 v71: * bugfix -- made some "set nomodifiable"s into
2922 setlocal variants (allows :e somenewfile to be
2923 modifiable as usual)
2924 * NetrwSettings calls a netrw function, thereby
2925 assuring that netrw has loaded. However, if netrw
2926 does not load for whatever reason, then
2927 NetrwSettings will now issue a warning message.
2928 * For what reason I don't recall, when wget and fetch
2929 are both not present, and an attempt to read a
2930 http://... url is made, netrw exited. It now only
2931 returns.
2932 * When ch=1, on the second and subsequent uses of
2933 browsing Netrw would issue a blank line to clear
2934 the echo'd messages. This caused an annoying
2935 "Hit-Enter" prompt; now a blank line message
2936 is echo'd only if &ch>1.
2937 v70: * when using |netrw-O|, the "Obtaining filename"
2938 message is now shown using |hl-User9|. If User9
2939 has not been defined, netrw itself will define it.
2940 v69: * Bugfix: win95/98 machines were experiencing a
2941 "E121: Undefined variable: g:netrw_win95ftp"
2942 message
2943 v68: * double-click-leftmouse selects word under mouse
2944 v67: * Passwords which contain blanks will now be
2945 surrounded by double-quotes automatically (Yongwei)
2946 v66: * Netrw now seems to work with a few more Windows
2947 situations
2948 * O now obtains a file: remote browsing
2949 file -> local copy, locally browsing
2950 file -> current directory (see :pwd)
2951 * i now cycles between thin, long, and wide listing
2952 styles
2953 * NB and Nb are maps that are always available;
2954 corresponding B and b maps are only available when
2955 not using wide listing in order to allow them to
2956 be used for motions
2957 v65: * Browser functions now use NetOptionSave/Restore; in
2958 particular, netrw now works around the report
2959 setting
2960 v64: * Bugfix - browsing a "/" directory (Unix) yielded
2961 buffers named "[Scratch]" instead of "/"
2962 * Bugfix - remote browsing with ftp was omitting
2963 the ./ and ../
2964 v63: * netrw now takes advantage of autoload (needs 7.0)
2965 * Bugfix - using r (to reverse sort) working again
2966 v62: * Bugfix - spaces allowed again in directory names
2967 with g:netrw_keepdir=0. In fact, I've tested netrw
2968 with most ANSI punctuation marks for directory
2969 names.
2970 * Bugfix - NetrwSettings gave errors when
2971 g:netrw_silent had not be set.
2972 v61: * Document upgrade -- netrw variable-based settings
2973 all should have tags. Supports NetrwSettings cmd.
2974 * Several important variables are window-oriented.
2975 Netrw has to transfer these across a window split.
2976 See s:BufWinVars() and s:UseBufWinVars().
2977 v60: * When using the i map to switch between long and
2978 short listings, netrw will now keep cursor on same
2979 line
2980 * "Match # of #" now uses status line
2981 * :Explore **/*.c will now work from a
2982 non-netrw-browser window
2983 * :Explore **/patterns can now be run in separate
2984 browser windows
2985 * active banner (hit <cr> will cause various things
2986 to happen)
2987 v59: * bugfix -- another keepalt work-around installed
2988 (for vim6.3)
2989 * "Match # of #" for Explore **/pattern matches
2990 v58: * Explore and relatives can now handle
2991 **/somefilepattern (v7)
2992 * Nexplore and Pexplore introduced (v7). shift-down
2993 and shift-up cursor keys will invoke Nexplore and
2994 Pexplore, respectively.
2995 * bug fixed with o and v
2996 * autochdir only worked around for vim when it has
2997 been compiled with either
2998 |+netbeans_intg| or |+sun_workshop|
2999 * Under Windows, all directories and files were
3000 being preceded with a "/" when local browsing.
3001 Fixed.
3002 * When: syntax highlighting is off, laststatus=2, and
3003 remote browsing is used, sometimes the laststatus
3004 highlighting bleeds into the entire display. Work
3005 around - do an extra redraw in that case.
3006 * Bugfix: when g:netrw_keepdir=0, due to re-use of
3007 buffers, netrw didn't change the directory when it
3008 should've
3009 * Bugfix: D and R commands work again
3010 v57: * Explore and relatives can now handle RO files
3011 * reverse sort restored with vim7's sort command
3012 * g:netrw_keepdir now being used to keep the current
3013 directory unchanged as intended (sense change)
3014 * vim 6.3 still supported
3015 v56: * LocalBrowse now saves autochdir setting, unsets it,
3016 and restores it before returning.
3017 * using vim's rename() instead of system +
3018 local_rename variable
3019 * avoids changing directory when g:netrw_keepdir is
3020 false
3021 v55: * -bar used with :Explore :Sexplore etc to allow
3022 multiple commands to be separated by |s
3023 * browser listings now use the "nowrap" option
3024 * browser: some unuseful error messages now
3025 suppressed
3026 v54: * For backwards compatibility, Explore and Sexplore
3027 have been implemented. In addition, Hexplore and
3028 Vexplore commands are available, too.
3029 * <amatch> used instead of <afile> in the
3030 transparency support (BufReadCmd, FileReadCmd,
3031 FileWriteCmd)
3032 * ***netrw*** prepended to various error messages
3033 netrw may emit
3034 * g:netrw_port used instead of b:netrw_port for scp
3035 * any leading [:#] is removed from port numbers
3036 v53: * backslashes as well as slashes placed in various
3037 patterns (ex. g:netrw_sort_sequence) to better
3038 support Windows
3039 v52: * nonumber'ing now set for browsing buffers
3040 * when the hiding list hid all files, error messages
3041 ensued. Fixed
3042 * when browsing, swf is set, but directory is not
3043 set, when netrw was attempting to restore options,
3044 vim wanted to save a swapfile to a local directory
3045 using an url-style path. Fixed
3046 v51: * cygwin detection now automated
3047 (using windows and &shell is bash)
3048 * customizable browser "file" rejection patterns
3049 * directory history
3050 * :[range]w url now supported (ie. netrw uses a
3051 FileWriteCmd event)
3052 * error messages have a "Press <cr> to continue" to
3053 allow them to be seen
3054 * directory browser displays no longer bother the
3055 swapfile
3056 * u/U commands to go up and down the history stack
3057 * history stack may be saved with viminfo with it's
3058 "!" option
3059 * bugfixes associated with unwanted [No Files]
3060 entries
3061 v50: * directories now displayed using buftype=nofile;
3062 should keep the directory names as-is
3063 * attempts to remove empty "[No File]" buffers
3064 leftover from :file ..name.. commands
3065 * bugfix: a "caps-lock" editing difficulty left in
3066 v49 was fixed
3067 * syntax highlighting for "Showing:" the hiding list
3068 included
3069 * bookmarks can now be retained if "!" is in the
3070 viminfo option
3071 v49: * will use ftp for http://.../ browsing
3072 v48: * One may use ftp to do remote host file browsing
3073 * (windows and !cygwin) remote browsing with ftp can
3074 now use the "dir" command internally to provide
3075 listings
3076 * g:netrw_keepdir now allows one to keep the initial
3077 current directory as the current directory
3078 (normally the local file browser makes the
3079 currently viewed directory the current directory)
3080 * g:netrw_alto and g:netrw_altv now support
3081 alternate placement of windows started with o or v
3082 * Nread ? and Nwrite ? now uses echomsg (instead of
3083 echo) so :messages can repeat showing the help
3084 * bugfix: avoids problems with partial matches of
3085 directory names to prior buffers with longer names
3086 * one can suppress error messages with g:netrw_quiet
3087 ctrl-h used
3088 * instead of <Leader>h for editing hiding list one
3089 may edit the sorting sequence with the S map, which
3090 now allows confirmation of deletion with
3091 [y(es) n(o) a(ll) q(uit)]
3092 * the "x" map now handles special file viewing with:
3093 (windows) rundll32 url.dll (gnome) gnome-open (kde)
3094 kfmclient If none of these are on the executable
3095 path, then netrwFileHandlers.vim is used.
3096 * directory bookmarking during both local and remote
3097 browsing implemented
3098 * one may view all, use the hiding list to suppress,
3099 or use the hiding list to show-only remote and
3100 local file/directory listings
3101 * improved unusual file and directory name handling
3102 preview window support
3103 v47: * now handles local browsing.
3104 v46: * now handles remote browsing
3105 * g:netrw_silent (if 1) will cause all transfers to
3106 be silent
3107 v45: * made the [user@]hostname:path form a bit more
3108 restrictive to better handle errors in using
3109 protocols (e.g. scp:usr@host:file was being
3110 recognized as an rcp request)
3111 v44: * changed from "rsync -a" to just "rsync"
3112 * somehow an editing error messed up the test to
3113 recognize use of the fetch method for NetRead.
3114 * more debugging statements included
3115 v43: * moved "Explanation" comments to <pi_netrw.txt> help
3116 file as "Network Reference" (|netrw-ref|)
3117 * <netrw.vim> now uses Dfunc() Decho() and Dret() for
3118 debugging
3119 * removed superfluous NetRestorePosn() calls
3120 v42: * now does BufReadPre and BufReadPost events on
3121 file:///* and file://localhost/*
3122 v41: * installed file:///* and file://localhost/* handling
3123 v40: * prevents redraw when a protocol error occurs so
3124 that the user may see it
3125 v39: * sftp support
3126 v38: * Now uses NetRestorePosn() calls with Nread/Nwrite
3127 commands
3128 * Temporary files now removed via bwipe! instead of
3129 bwipe (thanks to Dave Roberts)
3130 v37: * Claar's modifications which test if ftp is
3131 successful, otherwise give an error message
3132 * After a read, the alternate file was pointing to
3133 the temp file. The temp file buffer is now wiped
3134 out.
3135 * removed silent from transfer methods so user can
3136 see what's happening
3139 ==============================================================================
3140 12. Credits *netrw-credits* {{{1
3142 Vim editor by Bram Moolenaar (Thanks, Bram!)
3143 dav support by C Campbell
3144 fetch support by Bram Moolenaar and C Campbell
3145 ftp support by C Campbell <NdrOchip@ScampbellPfamily.AbizM>
3146 http support by Bram Moolenaar <bram@moolenaar.net>
3147 rcp
3148 rsync support by C Campbell (suggested by Erik Warendorph)
3149 scp support by raf <raf@comdyn.com.au>
3150 sftp support by C Campbell
3152 inputsecret(), BufReadCmd, BufWriteCmd contributed by C Campbell
3154 Jérôme Augé -- also using new buffer method with ftp+.netrc
3155 Bram Moolenaar -- obviously vim itself, :e and v:cmdarg use,
3156 fetch,...
3157 Yasuhiro Matsumoto -- pointing out undo+0r problem and a solution
3158 Erik Warendorph -- for several suggestions (g:netrw_..._cmd
3159 variables, rsync etc)
3160 Doug Claar -- modifications to test for success with ftp
3161 operation
3163 ==============================================================================
3164 Modelines: {{{1
3165 vim:tw=78:ts=8:ft=help:norl:fdm=marker