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