| blob | 9ab0ae81f149b69264b9f1eb149b16769540ee4e |
1 *pi_netrw.txt* For Vim version 7.1. Last change: 2008 Feb 26
3 -----------------------------------------------------
4 NETRW REFERENCE MANUAL by Charles E. Campbell, Jr.
5 -----------------------------------------------------
8 *dav* *http* *network* *Nwrite* *netrw-file*
9 *fetch* *netrw* *Nread* *rcp* *scp*
10 *ftp* *netrw.vim* *Nsource* *rsync* *sftp*
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-browse-intro|
34 Quick Reference: Maps..............................|netrw-browse-maps|
35 Quick Reference: Commands..........................|netrw-browse-cmds|
36 Bookmarking A Directory............................|netrw-mb|
37 Browsing...........................................|netrw-cr|
38 Browsing With A Horizontally Split Window..........|netrw-o|
39 Browsing With A New Tab............................|netrw-t|
40 Browsing With A Vertically Split Window............|netrw-v|
41 Change Listing Style...............................|netrw-i|
42 Changing To A Bookmarked Directory.................|netrw-gb|
43 Changing To A Predecessor Directory................|netrw-u|
44 Changing To A Successor Directory..................|netrw-U|
45 Customizing Browsing With A User Function..........|netrw-x|
46 Deleting Files Or Directories......................|netrw-D|
47 Directory Exploring Commands.......................|netrw-explore|
48 Exploring With Stars and Patterns..................|netrw-star|
49 Displaying Information About File..................|netrw-qf|
50 Edit File Or Directory Hiding List.................|netrw-ctrl-h|
51 Editing The Sorting Sequence.......................|netrw-S|
52 Going Up...........................................|netrw--|
53 Hiding Files Or Directories........................|netrw-a|
54 Improving Browsing.................................|netrw-ssh-hack|
55 Listing Bookmarks And History......................|netrw-qb|
56 Making A New Directory.............................|netrw-d|
57 Making The Browsing Directory The Current Directory|netrw-c|
58 Marked Files: Compression And Decompression........|netrw-mz|
59 Marked Files: Printing.............................|netrw-mp|
60 Marked Files: Tagging..............................|netrw-mT|
61 Marked Files: Unmarking............................|netrw-mu|
62 Marking Files......................................|netrw-mf|
63 Marking Files By Regular Expression................|netrw-mr|
64 Netrw Browser Variables............................|netrw-browser-var|
65 Netrw Browsing And Option Incompatibilities........|netrw-incompatible|
66 Netrw Settings.....................................|netrw-settings|
67 Obtaining A File...................................|netrw-O|
68 Preview Window.....................................|netrw-p|
69 Previous Window....................................|netrw-P|
70 Refreshing The Listing.............................|netrw-ctrl-l|
71 Renaming Files Or Directories......................|netrw-move|
72 Reversing Sorting Order............................|netrw-r|
73 Selecting Sorting Style............................|netrw-s|
74 10. Problems and Fixes...................................|netrw-problems|
75 11. Debugging Netrw Itself...............................|netrw-debug|
76 12. History..............................................|netrw-history|
77 13. Credits..............................................|netrw-credits|
79 {Vi does not have any of this}
81 ==============================================================================
82 2. Starting With Netrw *netrw-start* {{{1
84 Netrw makes reading files, writing files, browsing over a network, and
85 browsing locally easy! First, make sure that you have plugins enabled, so
86 you'll need to have at least the following in your <.vimrc>:
87 (or see |netrw-activate|) >
89 set nocp " 'compatible' is not set
90 filetype plugin on " plugins are enabled
91 <
92 (see |'cp'| and |:filetype-plugin-on|)
94 Netrw supports "transparent" editing of files on other machines using urls
95 (see |netrw-transparent|). As an example of this, let's assume you have an
96 account on some other machine; if you can use scp, try: >
98 vim scp://hostname/path/to/file
99 <
100 Want to make ssh/scp easier to use? Check out |netrw-ssh-hack|!
102 So, what if you have ftp, not ssh/scp? That's easy, too; try >
104 vim ftp://hostname/path/to/file
105 <
106 Want to make ftp simpler to use? See if your ftp supports a file called
107 <.netrc> -- typically it goes in your home directory, has read/write
108 permissions for only the user to read (ie. not group, world, other, etc),
109 and has lines resembling >
111 machine HOSTNAME login USERID password "PASSWORD"
112 machine HOSTNAME login USERID password "PASSWORD"
113 ...
114 default login USERID password "PASSWORD"
115 <
116 Now about browsing -- when you just want to look around before editing a
117 file. For browsing on your current host, just "edit" a directory: >
119 vim .
120 vim /home/userid/path
121 <
122 For browsing on a remote host, "edit" a directory (but make sure that
123 the directory name is followed by a "/"): >
125 vim scp://hostname/
126 vim ftp://hostname/path/to/dir/
127 <
128 See |netrw-browse| for more!
130 There are more protocols supported by netrw just than scp and ftp, too: see the
131 next section, |netrw-externapp|, for how to use these external applications.
133 If you want to use plugins, but for some reason don't wish to use netrw, then
134 you need to avoid loading both the plugin and the autoload portions of netrw.
135 You may do so by placing the following two lines in your <.vimrc>: >
137 :let g:loaded_netrw = 1
138 :let g:loaded_netrwPlugin = 1
139 <
141 ==============================================================================
142 3. Netrw Reference *netrw-ref* {{{1
144 EXTERNAL APPLICATIONS AND PROTOCOLS *netrw-externapp* {{{2
146 Protocol Variable Default Value
147 -------- ---------------- -------------
148 dav: *g:netrw_dav_cmd* = "cadaver"
149 fetch: *g:netrw_fetch_cmd* = "fetch -o" if fetch is available
150 ftp: *g:netrw_ftp_cmd* = "ftp"
151 http: *g:netrw_http_cmd* = "curl -o" if curl is available
152 http: g:netrw_http_cmd = "wget -q -O" elseif wget is available
153 http: g:netrw_http_cmd = "fetch -o" elseif fetch is available
154 rcp: *g:netrw_rcp_cmd* = "rcp"
155 rsync: *g:netrw_rsync_cmd* = "rsync -a"
156 scp: *g:netrw_scp_cmd* = "scp -q"
157 sftp: *g:netrw_sftp_cmd* = "sftp"
159 READING *netrw-read* *netrw-nread* {{{2
161 Generally, one may just use the url notation with a normal editing
162 command, such as >
164 :e ftp://[user@]machine/path
165 <
166 Netrw also provides the Nread command:
168 :Nread ? give help
169 :Nread "machine:path" uses rcp
170 :Nread "machine path" uses ftp w/ <.netrc>
171 :Nread "machine id password path" uses ftp
172 :Nread "dav://machine[:port]/path" uses cadaver
173 :Nread "fetch://[user@]machine/path" uses fetch
174 :Nread "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
175 :Nread "http://[user@]machine/path" uses http uses wget
176 :Nread "rcp://[user@]machine/path" uses rcp
177 :Nread "rsync://[user@]machine[:port]/path" uses rsync
178 :Nread "scp://[user@]machine[[:#]port]/path" uses scp
179 :Nread "sftp://[user@]machine/path" uses sftp
181 WRITING *netrw-write* *netrw-nwrite* {{{2
183 Generally, one may just use the url notation with a normal file writing
184 command, such as >
186 :w ftp://[user@]machine/path
187 <
188 Netrw also provides the Nwrite command:
190 :Nwrite ? give help
191 :Nwrite "machine:path" uses rcp
192 :Nwrite "machine path" uses ftp w/ <.netrc>
193 :Nwrite "machine id password path" uses ftp
194 :Nwrite "dav://machine[:port]/path" uses cadaver
195 :Nwrite "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
196 :Nwrite "rcp://[user@]machine/path" uses rcp
197 :Nwrite "rsync://[user@]machine[:port]/path" uses rsync
198 :Nwrite "scp://[user@]machine[[:#]port]/path" uses scp
199 :Nwrite "sftp://[user@]machine/path" uses sftp
200 http: not supported!
202 SOURCING *netrw-source* {{{2
204 Generally, one may just use the url notation with the normal file
205 sourcing command, such as >
207 :so ftp://[user@]machine/path
208 <
209 Netrw also provides the Nsource command:
211 :Nsource ? give help
212 :Nsource "dav://machine[:port]/path" uses cadaver
213 :Nsource "fetch://[user@]machine/path" uses fetch
214 :Nsource "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
215 :Nsource "http://[user@]machine/path" uses http uses wget
216 :Nsource "rcp://[user@]machine/path" uses rcp
217 :Nsource "rsync://[user@]machine[:port]/path" uses rsync
218 :Nsource "scp://[user@]machine[[:#]port]/path" uses scp
219 :Nsource "sftp://[user@]machine/path" uses sftp
221 DIRECTORY LISTING *netrw-dirlist* {{{2
223 Generally, one may browse a directory to get a listing by simply
224 attempting to edit the directory: >
226 :e scp://[user]@hostname/path/
227 :e ftp://[user]@hostname/path/
228 <
229 However, the Nread command can also be used to accomplish this:
231 :Nread [protocol]://[user]@hostname/path/
233 *netrw-login* *netrw-password*
234 CHANGING USERID AND PASSWORD *netrw-chgup* *netrw-userpass* {{{2
236 Attempts to use ftp will prompt you for a user-id and a password.
237 These will be saved in global variables g:netrw_uid and
238 s:netrw_passwd; subsequent uses of ftp will re-use those two items to
239 simplify the further use of ftp. However, if you need to use a
240 different user id and/or password, you'll want to call NetUserPass()
241 first. To work around the need to enter passwords, check if your ftp
242 supports a <.netrc> file in your home directory. Also see
243 |netrw-passwd| (and if you're using ssh/scp hoping to figure out how
244 to not need to use passwords, look at |netrw-ssh-hack|).
246 :NetUserPass [uid [password]] -- prompts as needed
247 :call NetUserPass() -- prompts for uid and password
248 :call NetUserPass("uid") -- prompts for password
249 :call NetUserPass("uid","password") -- sets global uid and password
251 NETRW VARIABLES AND SETTINGS *netrw-variables* {{{2
253 (also see: |netrw-browser-var| |netrw-protocol| |netrw-settings| |netrw-var|)
255 *b:netrw_lastfile* last file Network-read/written retained on a per-buffer
256 basis (supports plain :Nw )
258 *g:netrw_ftp* if it doesn't exist, use default ftp
259 =0 use default ftp (uid password)
260 =1 use alternate ftp method (user uid password)
261 If you're having trouble with ftp, try changing the
262 value of this variable to see if the alternate ftp
263 method works for your setup.
265 *g:netrw_extracmd* default: doesn't exist
266 If this variable exists, then any string it contains
267 will be placed into the commands set to your ftp
268 client. As an example:
269 ="passive"
271 *g:netrw_ftpmode* ="binary" (default)
272 ="ascii"
274 *g:netrw_ignorenetrc* =0 (default for linux, cygwin)
275 =1 If you have a <.netrc> file but it doesn't work and
276 you want it ignored, then set this variable as
277 shown. (default for Windows + cmd.exe)
279 *g:netrw_menu* =0 disable netrw's menu
280 =1 (default) netrw's menu enabled
282 *g:netrw_nogx* if this variable exists, then the "gx" map will not
283 be available (see |netrw-gx|)
285 *g:netrw_uid* (ftp) user-id, retained on a per-session basis
286 *s:netrw_passwd* (ftp) password, retained on a per-session basis
288 *g:netrw_preview* =0 (default) preview window shown in a horizontally
289 split window
290 =1 preview window shown in a vertically split window.
291 Also affects the "previous window" (see |netrw-P|) in
292 the same way.
294 *g:netrw_shq* = "'" for Unix/Linux systems (ie. a single quote)
295 = "'" for Windows + cygwin systems (ie. a single quote)
296 = '"' for Windows systems, not using cygwin
297 (ie. a double quote)
298 Controls the quoting character used during scp and ftp
299 commands.
301 *g:netrw_scpport* = "-P" : option to use to set port for scp
302 *g:netrw_sshport* = "-p" : option to use to set port for ssh
304 *g:netrw_silent* =0 : transfers done normally
305 =1 : transfers done silently
307 *g:netrw_use_errorwindow* =1 : messages from netrw will use a separate one
308 line window. This window provides reliable
309 delivery of messages. (default)
310 =0 : messages from netrw will use echoerr ;
311 messages don't always seem to show up this
312 way, but one doesn't have to quit the window.
314 *g:netrw_win95ftp* =1 if using Win95, will remove four trailing blank
315 lines that o/s's ftp "provides" on transfers
316 =0 force normal ftp behavior (no trailing line removal)
318 *g:netrw_cygwin* =1 assume scp under windows is from cygwin. Also
319 permits network browsing to use ls with time and
320 size sorting (default if windows)
321 =0 assume Windows' scp accepts windows-style paths
322 Network browsing uses dir instead of ls
323 This option is ignored if you're using unix
325 *g:netrw_use_nt_rcp* =0 don't use the rcp of WinNT, Win2000 and WinXP
326 =1 use WinNT's rcp in binary mode (default)
328 PATHS *netrw-path* {{{2
330 Paths to files are generally user-directory relative for most protocols.
331 It is possible that some protocol will make paths relative to some
332 associated directory, however.
333 >
334 example: vim scp://user@host/somefile
335 example: vim scp://user@host/subdir1/subdir2/somefile
336 <
337 where "somefile" is in the "user"'s home directory. If you wish to get a
338 file using root-relative paths, use the full path:
339 >
340 example: vim scp://user@host//somefile
341 example: vim scp://user@host//subdir1/subdir2/somefile
342 <
344 ==============================================================================
345 4. Network-Oriented File Transfer *netrw-xfer* {{{1
347 Network-oriented file transfer under Vim is implemented by a VimL-based script
348 (<netrw.vim>) using plugin techniques. It currently supports both reading and
349 writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch,
350 dav/cadaver, rsync, or sftp.
352 http is currently supported read-only via use of wget or fetch.
354 <netrw.vim> is a standard plugin which acts as glue between Vim and the
355 various file transfer programs. It uses autocommand events (BufReadCmd,
356 FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. >
358 ex. vim ftp://hostname/path/to/file
359 <
360 The characters preceding the colon specify the protocol to use; in the
361 example, it's ftp. The <netrw.vim> script then formulates a command or a
362 series of commands (typically ftp) which it issues to an external program
363 (ftp, scp, etc) which does the actual file transfer/protocol. Files are read
364 from/written to a temporary file (under Unix/Linux, /tmp/...) which the
365 <netrw.vim> script will clean up.
367 *netrw-putty* *netrw-pscp* *netrw-psftp*
368 One may modify any protocol's implementing external application by setting a
369 variable (ex. scp uses the variable g:netrw_scp_cmd, which is defaulted to
370 "scp -q"). As an example, consider using PuTTY: >
372 let g:netrw_scp_cmd = '"c:\Program Files\PuTTY\pscp.exe" -q -batch'
373 let g:netrw_sftp_cmd= '"c:\Program Files\PuTTY\psftp.exe"'
374 <
375 See |netrw-p8| for more about putty, pscp, psftp, etc.
377 Ftp, an old protocol, seems to be blessed by numerous implementations.
378 Unfortunately, some implementations are noisy (ie., add junk to the end of the
379 file). Thus, concerned users may decide to write a NetReadFixup() function
380 that will clean up after reading with their ftp. Some Unix systems (ie.,
381 FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is
382 not noisy and more convenient, actually, for <netrw.vim> to use.
383 Consequently, if "fetch" is executable, it will be used to do reads for
384 ftp://... (and http://...) . See |netrw-var| for more about this.
386 For rcp, scp, sftp, and http, one may use network-oriented file transfers
387 transparently; ie.
388 >
389 vim rcp://[user@]machine/path
390 vim scp://[user@]machine/path
391 <
392 If your ftp supports <.netrc>, then it too can be just as transparently used
393 if the needed triad of machine name, user id, and password are present in
394 that file. Your ftp must be able to use the <.netrc> file on its own, however.
395 >
396 vim ftp://[user@]machine[[:#]portnumber]/path
397 <
398 However, ftp will often need to query the user for the userid and password.
399 The latter will be done "silently"; ie. asterisks will show up instead of
400 the actually-typed-in password. Netrw will retain the userid and password
401 for subsequent read/writes from the most recent transfer so subsequent
402 transfers (read/write) to or from that machine will take place without
403 additional prompting.
405 *netrw-urls*
406 +=================================+============================+============+
407 | Reading | Writing | Uses |
408 +=================================+============================+============+
409 | DAV: | | |
410 | dav://host/path | | cadaver |
411 | :Nread dav://host/path | :Nwrite dav://host/path | cadaver |
412 +---------------------------------+----------------------------+------------+
413 | FETCH: | | |
414 | fetch://[user@]host/path | | |
415 | fetch://[user@]host:http/path | Not Available | fetch |
416 | :Nread fetch://[user@]host/path| | |
417 +---------------------------------+----------------------------+------------+
418 | FILE: | | |
419 | file:///* | file:///* | |
420 | file://localhost/* | file://localhost/* | |
421 +---------------------------------+----------------------------+------------+
422 | FTP: (*3) | (*3) | |
423 | ftp://[user@]host/path | ftp://[user@]host/path | ftp (*2) |
424 | :Nread ftp://host/path | :Nwrite ftp://host/path | ftp+.netrc |
425 | :Nread host path | :Nwrite host path | ftp+.netrc |
426 | :Nread host uid pass path | :Nwrite host uid pass path | ftp |
427 +---------------------------------+----------------------------+------------+
428 | HTTP: wget is executable: (*4) | | |
429 | http://[user@]host/path | Not Available | wget |
430 +---------------------------------+----------------------------+------------+
431 | HTTP: fetch is executable (*4) | | |
432 | http://[user@]host/path | Not Available | fetch |
433 +---------------------------------+----------------------------+------------+
434 | RCP: | | |
435 | rcp://[user@]host/path | rcp://[user@]host/path | rcp |
436 +---------------------------------+----------------------------+------------+
437 | RSYNC: | | |
438 | rsync://[user@]host/path | rsync://[user@]host/path | rsync |
439 | :Nread rsync://host/path | :Nwrite rsync://host/path | rsync |
440 | :Nread rcp://host/path | :Nwrite rcp://host/path | rcp |
441 +---------------------------------+----------------------------+------------+
442 | SCP: | | |
443 | scp://[user@]host/path | scp://[user@]host/path | scp |
444 | :Nread scp://host/path | :Nwrite scp://host/path | scp (*1) |
445 +---------------------------------+----------------------------+------------+
446 | SFTP: | | |
447 | sftp://[user@]host/path | sftp://[user@]host/path | sftp |
448 | :Nread sftp://host/path | :Nwrite sftp://host/path | sftp (*1) |
449 +=================================+============================+============+
451 (*1) For an absolute path use scp://machine//path.
453 (*2) if <.netrc> is present, it is assumed that it will
454 work with your ftp client. Otherwise the script will
455 prompt for user-id and password.
457 (*3) for ftp, "machine" may be machine#port or machine:port
458 if a different port is needed than the standard ftp port
460 (*4) for http:..., if wget is available it will be used. Otherwise,
461 if fetch is available it will be used.
463 Both the :Nread and the :Nwrite ex-commands can accept multiple filenames.
466 NETRC *netrw-netrc*
468 The <.netrc> file, typically located in your home directory, contains lines
469 therein which map a hostname (machine name) to the user id and password you
470 prefer to use with it.
472 The typical syntax for lines in a <.netrc> file is given as shown below.
473 Ftp under Unix usually supports <.netrc>; ftp under Windows usually doesn't.
474 >
475 machine {full machine name} login {user-id} password "{password}"
476 default login {user-id} password "{password}"
478 Your ftp client must handle the use of <.netrc> on its own, but if the
479 <.netrc> file exists, an ftp transfer will not ask for the user-id or
480 password.
482 Note:
483 Since this file contains passwords, make very sure nobody else can
484 read this file! Most programs will refuse to use a .netrc that is
485 readable for others. Don't forget that the system administrator can
486 still read the file! Ie. for Linux/Unix: chmod 600 .netrc
489 PASSWORD *netrw-passwd*
491 The script attempts to get passwords for ftp invisibly using |inputsecret()|,
492 a built-in Vim function. See |netrw-uidpass| for how to change the password
493 after one has set it.
495 Unfortunately there doesn't appear to be a way for netrw to feed a password to
496 scp. Thus every transfer via scp will require re-entry of the password.
497 However, |netrw-ssh-hack| can help with this problem.
500 ==============================================================================
501 5. Activation *netrw-activate* {{{1
503 Network-oriented file transfers are available by default whenever Vim's
504 |'nocompatible'| mode is enabled. Netrw's script files reside in your
505 system's plugin, autoload, and syntax directories; just the
506 plugin/netrwPlugin.vim script is sourced automatically whenever you bring up
507 vim. The main script in autoload/netrw.vim is only loaded when you actually
508 use netrw. I suggest that, at a minimum, you have at least the following in
509 your <.vimrc> customization file: >
511 set nocp
512 if version >= 600
513 filetype plugin indent on
514 endif
515 <
517 ==============================================================================
518 6. Transparent File Editing *netrw-transparent* {{{1
520 Transparent file transfers occur whenever a regular file read or write
521 (invoked via an |:autocmd| for |BufReadCmd|, |BufWriteCmd|, or |SourceCmd|
522 events) is made. Thus one may read, write, or source files across networks
523 just as easily as if they were local files! >
525 vim ftp://[user@]machine/path
526 ...
527 :wq
529 See |netrw-activate| for more on how to encourage your vim to use plugins
530 such as netrw.
533 ==============================================================================
534 7. Ex Commands *netrw-ex* {{{1
536 The usual read/write commands are supported. There are also a few
537 additional commands available. Often you won't need to use Nwrite or
538 Nread as shown in |netrw-transparent| (ie. simply use >
539 :e url
540 :r url
541 :w url
542 instead, as appropriate) -- see |netrw-urls|. In the explanations
543 below, a {netfile} is an url to a remote file.
545 :[range]Nw[rite] Write the specified lines to the current
546 file as specified in b:netrw_lastfile.
548 :[range]Nw[rite] {netfile} [{netfile}]...
549 Write the specified lines to the {netfile}.
551 :Nr[ead] Read the specified lines into the current
552 buffer from the file specified in
553 b:netrw_lastfile.
555 :Nr[ead] {netfile} {netfile}...
556 Read the {netfile} after the current line.
558 :Ns[ource] {netfile}
559 Source the {netfile}.
560 To start up vim using a remote .vimrc, one may use
561 the following (all on one line) (tnx to Antoine Mechelynck) >
562 vim -u NORC -N
563 --cmd "runtime plugin/netrwPlugin.vim"
564 --cmd "source scp://HOSTNAME/.vimrc"
565 < *netrw-uidpass*
566 :call NetUserPass()
567 If g:netrw_uid and s:netrw_passwd don't exist,
568 this function will query the user for them.
570 :call NetUserPass("userid")
571 This call will set the g:netrw_uid and, if
572 the password doesn't exist, will query the user for it.
574 :call NetUserPass("userid","passwd")
575 This call will set both the g:netrw_uid and s:netrw_passwd.
576 The user-id and password are used by ftp transfers. One may
577 effectively remove the user-id and password by using empty
578 strings (ie. "").
580 :NetrwSettings This command is described in |netrw-settings| -- used to
581 display netrw settings and change netrw behavior.
584 ==============================================================================
585 8. Variables and Options *netrw-options* *netrw-var* {{{1
587 (if you're interested in the netrw browser settings, see: |netrw-browser-var|)
589 The <netrw.vim> script provides several variables which act as options to
590 affect <netrw.vim>'s file transfer behavior. These variables typically may be
591 set in the user's <.vimrc> file: (see also |netrw-settings| |netrw-protocol|)
593 >
595 -------------
596 Netrw Options
597 -------------
598 Option Meaning
599 -------------- -----------------------------------------------
600 <
601 b:netrw_col Holds current cursor position (during NetWrite)
602 g:netrw_cygwin =1 assume scp under windows is from cygwin
603 (default/windows)
604 =0 assume scp under windows accepts windows
605 style paths (default/else)
606 g:netrw_ftp =0 use default ftp (uid password)
607 g:netrw_ftpmode ="binary" (default)
608 ="ascii" (your choice)
609 g:netrw_ignorenetrc =1 (default)
610 if you have a <.netrc> file but you don't
611 want it used, then set this variable. Its
612 mere existence is enough to cause <.netrc>
613 to be ignored.
614 b:netrw_lastfile Holds latest method/machine/path.
615 b:netrw_line Holds current line number (during NetWrite)
616 g:netrw_passwd Holds current password for ftp.
617 g:netrw_silent =0 transfers done normally
618 =1 transfers done silently
619 g:netrw_uid Holds current user-id for ftp.
620 =1 use alternate ftp (user uid password)
621 (see |netrw-options|)
622 g:netrw_use_nt_rcp =0 don't use WinNT/2K/XP's rcp (default)
623 =1 use WinNT/2K/XP's rcp, binary mode
624 g:netrw_win95ftp =0 use unix-style ftp even if win95/98/ME/etc
625 =1 use default method to do ftp >
626 -----------------------------------------------------------------------
627 <
628 The script will also make use of the following variables internally, albeit
629 temporarily.
630 >
631 -------------------
632 Temporary Variables
633 -------------------
634 Variable Meaning
635 -------- ------------------------------------
636 <
637 g:netrw_method Index indicating rcp/ftp+.netrc/ftp
638 g:netrw_machine Holds machine name parsed from input
639 g:netrw_fname Holds filename being accessed >
640 ------------------------------------------------------------
641 <
642 *netrw-protocol*
644 Netrw supports a number of protocols. These protocols are invoked using the
645 variables listed below, and may be modified by the user.
646 >
647 ------------------------
648 Protocol Control Options
649 ------------------------
650 Option Type Setting Meaning
651 --------- -------- -------------- ---------------------------
652 <
653 netrw_ftp variable =doesn't exist userid set by "user userid"
654 =0 userid set by "user userid"
655 =1 userid set by "userid"
656 NetReadFixup function =doesn't exist no change
657 =exists Allows user to have files
658 read via ftp automatically
659 transformed however they wish
660 by NetReadFixup()
661 g:netrw_dav_cmd variable ="cadaver"
662 g:netrw_fetch_cmd variable ="fetch -o" if fetch is available
663 g:netrw_ftp_cmd variable ="ftp"
664 g:netrw_http_cmd variable ="fetch -o" if fetch is available
665 g:netrw_http_cmd variable ="wget -O" else if wget is available
666 g:netrw_list_cmd variable ="ssh USEPORT HOSTNAME ls -Fa"
667 g:netrw_rcp_cmd variable ="rcp"
668 g:netrw_rsync_cmd variable ="rsync -a"
669 g:netrw_scp_cmd variable ="scp -q"
670 g:netrw_sftp_cmd variable ="sftp" >
671 -------------------------------------------------------------------------
672 <
673 *netrw-ftp*
675 The g:netrw_..._cmd options (|g:netrw_ftp_cmd| and |g:netrw_sftp_cmd|)
676 specify the external program to use handle the ftp protocol. They may
677 include command line options (such as -p for passive mode).
679 Browsing is supported by using the |g:netrw_list_cmd|; the substring
680 "HOSTNAME" will be changed via substitution with whatever the current request
681 is for a hostname.
683 Two options (|g:netrw_ftp| and |netrw-fixup|) both help with certain ftp's
684 that give trouble . In order to best understand how to use these options if
685 ftp is giving you troubles, a bit of discussion is provided on how netrw does
686 ftp reads.
688 For ftp, netrw typically builds up lines of one of the following formats in a
689 temporary file:
690 >
691 IF g:netrw_ftp !exists or is not 1 IF g:netrw_ftp exists and is 1
692 ---------------------------------- ------------------------------
693 <
694 open machine [port] open machine [port]
695 user userid password userid password
696 [g:netrw_ftpmode] password
697 [g:netrw_extracmd] [g:netrw_ftpmode]
698 get filename tempfile [g:netrw_extracmd]
699 get filename tempfile >
700 ---------------------------------------------------------------------
701 <
702 The |g:netrw_ftpmode| and |g:netrw_extracmd| are optional.
704 Netrw then executes the lines above by use of a filter:
705 >
706 :%! {g:netrw_ftp_cmd} -i [-n]
707 <
708 where
709 g:netrw_ftp_cmd is usually "ftp",
710 -i tells ftp not to be interactive
711 -n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>)
713 If <.netrc> exists it will be used to avoid having to query the user for
714 userid and password. The transferred file is put into a temporary file.
715 The temporary file is then read into the main editing session window that
716 requested it and the temporary file deleted.
718 If your ftp doesn't accept the "user" command and immediately just demands a
719 userid, then try putting "let netrw_ftp=1" in your <.vimrc>.
721 *netrw-cadaver*
722 To handle the SSL certificate dialog for untrusted servers, one may pull
723 down the certificate and place it into /usr/ssl/cert.pem. This operation
724 renders the server treatment as "trusted".
726 *netrw-fixup* *netreadfixup*
727 If your ftp for whatever reason generates unwanted lines (such as AUTH
728 messages) you may write a NetReadFixup(tmpfile) function:
729 >
730 function! NetReadFixup(method,line1,line2)
731 " a:line1: first new line in current file
732 " a:line2: last new line in current file
733 if a:method == 1 "rcp
734 elseif a:method == 2 "ftp + <.netrc>
735 elseif a:method == 3 "ftp + machine,uid,password,filename
736 elseif a:method == 4 "scp
737 elseif a:method == 5 "http/wget
738 elseif a:method == 6 "dav/cadaver
739 elseif a:method == 7 "rsync
740 elseif a:method == 8 "fetch
741 elseif a:method == 9 "sftp
742 else " complain
743 endif
744 endfunction
745 >
746 The NetReadFixup() function will be called if it exists and thus allows you to
747 customize your reading process. As a further example, <netrw.vim> contains
748 just such a function to handle Windows 95 ftp. For whatever reason, Windows
749 95's ftp dumps four blank lines at the end of a transfer, and so it is
750 desirable to automate their removal. Here's some code taken from <netrw.vim>
751 itself:
752 >
753 if has("win95") && g:netrw_win95ftp
754 fun! NetReadFixup(method, line1, line2)
755 if method == 3 " ftp (no <.netrc>)
756 let fourblanklines= line2 - 3
757 silent fourblanklines.",".line2."g/^\s*/d"
758 endif
759 endfunction
760 endif
761 >
763 ==============================================================================
764 9. Browsing *netrw-browsing* *netrw-browse* *netrw-help* {{{1
765 *netrw-browser* *netrw-dir* *netrw-list*
767 INTRODUCTION TO BROWSING *netrw-browse-intro* {{{2
769 Netrw supports the browsing of directories on your local system and on remote
770 hosts; browsing includes listing files and directories, entering directories,
771 editing files therein, deleting files/directories, making new directories,
772 moving (renaming) files and directories, copying files and directories, etc.
773 One may mark files and execute any system command on them! The Netrw browser
774 generally implements the previous explorer's maps and commands for remote
775 directories, although details (such as pertinent global variable names)
776 necessarily differ. To browse a directory, simply "edit" it! >
778 vim /your/directory/
779 vim .
780 vim c:\your\directory\
781 <
782 (Related topics: |netrw-cr| |netrw-o| |netrw-p| |netrw-P| |netrw-t|
783 |netrw-mf| |netrw-mx| |netrw-D| |netrw-R| |netrw-v| )
785 The Netrw remote file and directory browser handles two protocols: ssh and
786 ftp. The protocol in the url, if it is ftp, will cause netrw also to use ftp
787 in its remote browsing. Specifying any other protocol will cause it to be
788 used for file transfers; but the ssh protocol will be used to do remote
789 browsing.
791 To use Netrw's remote directory browser, simply attempt to read a "file" with
792 a trailing slash and it will be interpreted as a request to list a directory:
793 >
794 vim [protocol]://[user@]hostname/path/
795 <
796 where [protocol] is typically scp or ftp. As an example, try: >
798 vim ftp://ftp.home.vim.org/pub/vim/
799 <
800 For local directories, the trailing slash is not required. Again, because its
801 easy to miss: to browse remote directories, the url must terminate with a
802 slash!
804 If you'd like to avoid entering the password repeatedly for remote directory
805 listings with ssh or scp, see |netrw-ssh-hack|. To avoid password entry with
806 ftp, see |netrw-netrc| (if your ftp supports it).
808 There are several things you can do to affect the browser's display of files:
810 * To change the listing style, press the "i" key (|netrw-i|).
811 Currently there are four styles: thin, long, wide, and tree.
813 * To hide files (don't want to see those xyz~ files anymore?) see
814 |netrw-ctrl-h|.
816 * Press s to sort files by name, time, or size.
818 See |netrw-browse-cmds| for all the things you can do with netrw!
821 QUICK REFERENCE: MAPS *netrw-browse-maps* {{{2
822 >
823 --- ----------------- ----
824 Map Quick Explanation Link
825 --- ----------------- ----
826 < <F1> Causes Netrw to issue help
827 <cr> Netrw will enter the directory or read the file |netrw-cr|
828 <del> Netrw will attempt to remove the file/directory |netrw-del|
829 - Makes Netrw go up one directory |netrw--|
830 a Toggles between normal display, |netrw-a|
831 hiding (suppress display of files matching g:netrw_list_hide)
832 showing (display only files which match g:netrw_list_hide)
833 c Make browsing directory the current directory |netrw-c|
834 d Make a directory |netrw-d|
835 D Attempt to remove the file(s)/directory(ies) |netrw-D|
836 gb Go to previous bookmarked directory |netrw-gb|
837 gi Display information on file |netrw-qf|
838 <c-h> Edit file hiding list |netrw-ctrl-h|
839 i Cycle between thin, long, wide, and tree listings |netrw-i|
840 <c-l> Causes Netrw to refresh the directory listing |netrw-ctrl-l|
841 mb Bookmark current directory |netrw-mb|
842 mc Copy marked files to marked-file target directory |netrw-mc|
843 md Apply diff to marked files (up to 3) |netrw-md|
844 me Place marked files on arg list and edit them |netrw-me|
845 mf Mark a file |netrw-mf|
846 mh Toggle marked file suffices' presence on hiding list |netrw-mh|
847 mm Move marked files to marked-file target directory |netrw-mm|
848 mp Print marked files |netrw-mp|
849 mr Mark files satisfying a |regexp| |netrw-mr|
850 mt Current browsing directory becomes markfile target |netrw-mt|
851 mT Apply ctags to marked files |netrw-mT|
852 mu Unmark all marked files |netrw-mu|
853 mx Apply arbitrary shell command to marked files |netrw-mx|
854 mz Compress/decompress marked files |netrw-mz|
855 o Enter the file/directory under the cursor in a new |netrw-o|
856 browser window. A horizontal split is used.
857 O Obtain a file specified by cursor |netrw-O|
858 p Preview the file |netrw-p|
859 P Browse in the previously used window |netrw-P|
860 q List bookmarked directories and history |netrw-qb|
861 r Reverse sorting order |netrw-r|
862 R Rename the designed file(s)/directory(ies) |netrw-R|
863 s Select sorting style: by name, time, or file size |netrw-s|
864 S Specify suffix priority for name-sorting |netrw-S|
865 t Enter the file/directory under the cursor in a new tab|netrw-t|
866 u Change to recently-visited directory |netrw-u|
867 U Change to subsequently-visited directory |netrw-U|
868 v Enter the file/directory under the cursor in a new |netrw-v|
869 browser window. A vertical split is used.
870 x View file with an associated program |netrw-x|
872 <leftmouse> (gvim only) selects word under mouse as if a <cr>
873 had been pressed (ie. edit file, change directory)
874 <middlemouse> (gvim only) same as P selecting word under mouse;
875 see |netrw-P|
876 <rightmouse> (gvim only) delete file/directory using word under
877 mouse
878 <2-leftmouse> (gvim only) when:
879 * in a netrw-selected file, AND
880 * |g:netrw_retmap| == 1 AND
881 * the user doesn't already have a <2-leftmouse> mapping
882 defined before netrw is autoloaded,
883 then a double clicked leftmouse button will return
884 to the netrw browser window.
885 <s-leftmouse> (gvim only) like mf, will mark files
887 QUICK REFERENCE: COMMANDS *netrw-explore-cmds* *netrw-browse-cmds* {{{2
888 :NetrwClean[!] ...........................................|netrw-clean|
889 :NetrwSettings ...........................................|netrw-settings|
890 :Explore[!] [dir] Explore directory of current file......|netrw-explore|
891 :Hexplore[!] [dir] Horizontal Split & Explore.............|netrw-explore|
892 :Nexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
893 :Pexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
894 :Rexplore Return to Explorer.....................|netrw-explore|
895 :Sexplore[!] [dir] Split & Explore directory .............|netrw-explore|
896 :Texplore[!] [dir] Tab & Explore..........................|netrw-explore|
897 :Vexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
899 BOOKMARKING A DIRECTORY *netrw-mb* *netrw-bookmark* *netrw-bookmarks* {{{2
900 One may easily "bookmark" a directory by using >
902 {cnt}mb
903 <
904 Any count may be used. One may use viminfo's "!" option to retain bookmarks
905 between vim sessions. See |netrw-gb| for how to return to a bookmark and
906 |netrw-qb| for how to list them.
909 BROWSING *netrw-cr* {{{2
911 Browsing is simple: move the cursor onto a file or directory of interest.
912 Hitting the <cr> (the return key) will select the file or directory.
913 Directories will themselves be listed, and files will be opened using the
914 protocol given in the original read request.
916 CAVEAT: There are four forms of listing (see |netrw-i|). Netrw assumes that
917 two or more spaces delimit filenames and directory names for the long and
918 wide listing formats. Thus, if your filename or directory name has two or
919 more sequential spaces embedded in it, or any trailing spaces, then you'll
920 need to use the "thin" format to select it.
922 The |g:netrw_browse_split| option, which is zero by default, may be used to
923 cause the opening of files to be done in a new window or tab instead of the
924 default. When the option is one or two, the splitting will be taken
925 horizontally or vertically, respectively. When the option is set to three, a
926 <cr> will cause the file to appear in a new tab.
929 When using the gui (gvim) one may select a file by pressing the <leftmouse>
930 button. In addtion, if
932 *|g:netrw_retmap| == 1 AND (its default value is 0)
933 * in a netrw-selected file, AND
934 * the user doesn't already have a <2-leftmouse> mapping defined before
935 netrw is loaded
937 then a doubly-clicked leftmouse button will return to the netrw browser
938 window.
940 Netrw attempts to speed up browsing, especially for remote browsing where one
941 may have to enter passwords, by keeping and re-using previously obtained
942 directory listing buffers. The |g:netrw_fastbrowse| variable is used to
943 control this behavior; one may have slow browsing (no buffer re-use), medium
944 speed browsing (re-use directory buffer listings only for remote directories),
945 and fast browsing (re-use directory buffer listings as often as possible).
946 The price for such re-use is that when changes are made (such as new files
947 are introduced into a directory), the listing may become out-of-date. One may
948 always refresh directory listing buffers by pressing ctrl-L (see
949 |netrw-ctrl-l|).
952 Related topics: |netrw-o| |netrw-p| |netrw-P| |netrw-t| |netrw-v|
953 Associated setting variables: |g:netrw_browse_split| |g:netrw_fastbrowse|
954 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd|
955 |g:netrw_ftp_timelist_cmd| |g:netrw_ssh_cmd|
956 |g:netrw_ssh_browse_reject| |g:netrw_use_noswf|
959 BROWSING WITH A HORIZONTALLY SPLIT WINDOW *netrw-o* *netrw-horiz* {{{2
961 Normally one enters a file or directory using the <cr>. However, the "o" map
962 allows one to open a new window to hold the new directory listing or file. A
963 horizontal split is used. (for vertical splitting, see |netrw-v|)
965 Normally, the o key splits the window horizontally with the new window and
966 cursor at the top. To change to splitting the window horizontally with the
967 new window and cursor at the bottom, have
969 let g:netrw_alto = 1
971 in your <.vimrc>. (also see |netrw-t| |netrw-v|)
973 There is only one tree listing buffer; using "o" on a displayed subdirectory
974 will split the screen, but the same buffer will be shown twice.
976 Associated setting variables: |g:netrw_alto| |g:netrw_winsize|
979 BROWSING WITH A NEW TAB *netrw-t* {{{2
981 Normally one enters a file or directory using the <cr>. The "t" map
982 allows one to open a new window hold the new directory listing or file in a
983 new tab. (also see: |netrw-o| |netrw-v|)
986 BROWSING WITH A VERTICALLY SPLIT WINDOW *netrw-v* {{{2
988 Normally one enters a file or directory using the <cr>. However, the "v" map
989 allows one to open a new window to hold the new directory listing or file. A
990 vertical split is used. (for horizontal splitting, see |netrw-o|)
992 Normally, the v key splits the window vertically with the new window and
993 cursor at the left. To change to splitting the window vertically with the new
994 window and cursor at the right, have
996 let g:netrw_altv = 1
998 in your <.vimrc>. (also see: |netrw-o| |netrw-t|)
1000 There is only one tree listing buffer; using "v" on a displayed subdirectory
1001 will split the screen, but the same buffer will be shown twice.
1003 Associated setting variable: |g:netrw_altv| |g:netrw_winsize|
1005 CHANGE LISTING STYLE *netrw-i* {{{2
1007 The "i" map cycles between the thin, long, wide, and tree listing formats.
1009 The short listing format gives just the files' and directories' names.
1011 The long listing is either based on the "ls" command via ssh for remote
1012 directories or displays the filename, file size (in bytes), and the time and
1013 date of last modification for local directories. With the long listing
1014 format, netrw is not able to recognize filenames which have trailing spaces.
1015 Use the thin listing format for such files.
1017 The wide listing format uses two or more contiguous spaces to delineate
1018 filenames; when using that format, netrw won't be able to recognize or use
1019 filenames which have two or more contiguous spaces embedded in the name or any
1020 trailing spaces. The thin listing format will, however, work with such files.
1021 This listing format is the most compact.
1023 The tree listing format has a top directory followed by files and directories
1024 preceded by a "|". One may open and close directories by pressing the <cr>
1025 key while atop the directory name. There is only one tree listing buffer;
1026 hence, using "v" or "o" on a subdirectory will only show the same buffer,
1027 twice.
1029 Associated setting variables: |g:netrw_liststyle| |g:netrw_maxfilenamelen|
1030 |g:netrw_timefmt| |g:netrw_list_cmd|
1033 CHANGING TO A BOOKMARKED DIRECTORY *netrw-gb* {{{2
1035 To change directory back to a bookmarked directory, use
1037 {cnt}gb
1039 Any count may be used to reference any of the bookmarks. See |netrw-mb| on
1040 how to bookmark a directory and |netrw-qb| on how to list bookmarks.
1043 CHANGING TO A PREDECESSOR DIRECTORY *netrw-u* *netrw-updir* {{{2
1045 Every time you change to a new directory (new for the current session),
1046 netrw will save the directory in a recently-visited directory history
1047 list (unless g:netrw_dirhistmax is zero; by default, it's ten). With the
1048 "u" map, one can change to an earlier directory (predecessor). To do
1049 the opposite, see |netrw-U|.
1052 CHANGING TO A SUCCESSOR DIRECTORY *netrw-U* *netrw-downdir* {{{2
1054 With the "U" map, one can change to a later directory (successor).
1055 This map is the opposite of the "u" map. (see |netrw-u|) Use the
1056 q map to list both the bookmarks and history. (see |netrw-qb|)
1059 NETRW CLEAN *netrw-clean* *:NetrwClean*
1061 With :NetrwClean one may easily remove netrw from one's home directory;
1062 more precisely, from the first directory on your |'runtimepath'|.
1064 With :NetrwClean!, netrw will remove netrw from all directories on your
1065 |'runtimepath'|.
1067 With either form of the command, netrw will first ask for confirmation
1068 that the removal is in fact what you want to do. If netrw doesn't have
1069 permission to remove a file, it will issue an error message.
1071 *netrw-gx*
1072 CUSTOMIZING BROWSING WITH A USER FUNCTION *netrw-x* *netrw-handler* {{{2
1073 (also see |netrw_filehandler|)
1075 Certain files, such as html, gif, jpeg, (word/office) doc, etc, files, are
1076 best seen with a special handler (ie. a tool provided with your computer).
1077 Netrw allows one to invoke such special handlers by: >
1079 * when Exploring, hit the "x" key
1080 * when editing, hit gx with the cursor atop the special filename
1081 < (not available if the |g:netrw_nogx| variable exists)
1083 Netrw determines which special handler by the following method:
1085 * if |g:netrw_browsex_viewer| exists, then it will be used to attempt to
1086 view files. Examples of useful settings (place into your <.vimrc>): >
1088 :let g:netrw_browsex_viewer= "kfmclient exec"
1089 < or >
1090 :let g:netrw_browsex_viewer= "gnome-open"
1091 <
1092 If g:netrw_browsex_viewer == '-', then netrwFileHandler() will be
1093 invoked first (see |netrw_filehandler|).
1095 * for Windows 32 or 64, the url and FileProtocolHandler dlls are used.
1096 * for Gnome (with gnome-open): gnome-open is used.
1097 * for KDE (with kfmclient) : kfmclient is used.
1098 * for Mac OS X : open is used.
1099 * otherwise the netrwFileHandler plugin is used.
1101 The file's suffix is used by these various approaches to determine an
1102 appropriate application to use to "handle" these files. Such things as
1103 OpenOffice (*.sfx), visualization (*.jpg, *.gif, etc), and PostScript (*.ps,
1104 *.eps) can be handled.
1106 *netrw_filehandler*
1108 The "x" map applies a function to a file, based on its extension. Of course,
1109 the handler function must exist for it to be called!
1110 >
1111 Ex. mypgm.html x ->
1112 NFH_html("scp://user@host/some/path/mypgm.html")
1113 <
1114 Users may write their own netrw File Handler functions to support more
1115 suffixes with special handling. See <plugin/netrwFileHandlers.vim> for
1116 examples on how to make file handler functions. As an example: >
1118 " NFH_suffix(filename)
1119 fun! NFH_suffix(filename)
1120 ..do something special with filename..
1121 endfun
1122 <
1123 These functions need to be defined in some file in your .vim/plugin
1124 (vimfiles\plugin) directory. Vim's function names may not have punctuation
1125 characters (except for the underscore) in them. To support suffices that
1126 contain such characters, netrw will first convert the suffix using the
1127 following table: >
1129 @ -> AT ! -> EXCLAMATION % -> PERCENT
1130 : -> COLON = -> EQUAL ? -> QUESTION
1131 , -> COMMA - -> MINUS ; -> SEMICOLON
1132 $ -> DOLLAR + -> PLUS ~ -> TILDE
1133 <
1134 So, for example: >
1136 file.rcs,v -> NFH_rcsCOMMAv()
1137 <
1138 If more such translations are necessary, please send me email: >
1139 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
1140 with a request.
1142 Associated setting variable: |g:netrw_browsex_viewer|
1144 *netrw-curdir*
1145 DELETING FILES OR DIRECTORIES *netrw-delete* *netrw-D* *netrw-del* {{{2
1147 If files have not been marked with |netrw-mf|:
1149 Deleting/removing files and directories involves moving the cursor to the
1150 file/directory to be deleted and pressing "D". Directories must be empty
1151 first before they can be successfully removed. If the directory is a
1152 softlink to a directory, then netrw will make two requests to remove the
1153 directory before succeeding. Netrw will ask for confirmation before doing
1154 the removal(s). You may select a range of lines with the "V" command
1155 (visual selection), and then pressing "D".
1157 If files have been marked with |netrw-mf|:
1159 Marked files (and empty directories) will be deleted; again, you'll be
1160 asked to confirm the deletion before it actually takes place.
1162 The g:netrw_rm_cmd, g:netrw_rmf_cmd, and g:netrw_rmdir_cmd variables are used
1163 to control the attempts to remove files and directories. The g:netrw_rm_cmd
1164 is used with files, and its default value is:
1166 g:netrw_rm_cmd: ssh HOSTNAME rm
1168 The g:netrw_rmdir_cmd variable is used to support the removal of directories.
1169 Its default value is:
1171 g:netrw_rmdir_cmd: ssh HOSTNAME rmdir
1173 If removing a directory fails with g:netrw_rmdir_cmd, netrw then will attempt
1174 to remove it again using the g:netrw_rmf_cmd variable. Its default value is:
1176 g:netrw_rmf_cmd: ssh HOSTNAME rm -f
1178 Associated setting variable: |g:netrw_local_rmdir| |g:netrw_rm_cmd|
1179 |g:netrw_rmdir_cmd| |g:netrw_ssh_cmd|
1182 *netrw-explore* *netrw-hexplore* *netrw-nexplore* *netrw-pexplore*
1183 *netrw-rexplore* *netrw-sexplore* *netrw-texplore* *netrw-vexplore*
1184 DIRECTORY EXPLORATION COMMANDS {{{2
1186 :Explore[!] [dir]... Explore directory of current file *:Explore*
1187 :Hexplore[!] [dir]... Horizontal Split & Explore *:Hexplore*
1188 :Rexplore ... Return to Explorer *:Rexplore*
1189 :Sexplore[!] [dir]... Split&Explore directory of current file *:Sexplore*
1190 :Texplore [dir]... Tab & Explore *:Texplore*
1191 :Vexplore[!] [dir]... Vertical Split & Explore *:Vexplore*
1193 Used with :Explore **/pattern : (also see |netrw-starstar|)
1194 :Nexplore............. go to next matching file *:Nexplore*
1195 :Pexplore............. go to previous matching file *:Pexplore*
1197 :Explore will open the local-directory browser on the current file's
1198 directory (or on directory [dir] if specified). The window will be
1199 split only if the file has been modified, otherwise the browsing
1200 window will take over that window. Normally the splitting is taken
1201 horizontally.
1202 :Explore! is like :Explore, but will use vertical splitting.
1203 :Sexplore will always split the window before invoking the local-directory
1204 browser. As with Explore, the splitting is normally done
1205 horizontally.
1206 :Sexplore! [dir] is like :Sexplore, but the splitting will be done vertically.
1207 :Hexplore [dir] does an :Explore with |:belowright| horizontal splitting.
1208 :Hexplore! [dir] does an :Explore with |:aboveleft| horizontal splitting.
1209 :Vexplore [dir] does an :Explore with |:leftabove| vertical splitting.
1210 :Vexplore! [dir] does an :Explore with |:rightbelow| vertical splitting.
1211 :Texplore [dir] does a tabnew before generating the browser window
1213 By default, these commands use the current file's directory. However, one
1214 may explicitly provide a directory (path) to use.
1216 The |g:netrw_winsize| variable also is used, if specified by the user, to
1217 size Hexplore and Vexplore windows.
1219 :Rexplore This command is a little different from the others. When one
1220 edits a file, for example by pressing <cr> when atop a file in
1221 a netrw browser window, :Rexplore will return the display to
1222 that of the last netrw browser window. Its a command version
1223 of <2-leftmouse> (which is only available under gvim and
1224 cooperative terms).
1227 *netrw-star* *netrw-starpat* *netrw-starstar* *netrw-starstarpat*
1228 EXPLORING WITH STARS AND PATTERNS
1230 When Explore, Sexplore, Hexplore, or Vexplore are used with one of the
1231 following four styles, Explore generates a list of files which satisfy
1232 the request. >
1234 */filepat files in current directory which satisfy filepat
1235 **/filepat files in current directory or below which satisfy the
1236 file pattern
1237 *//pattern files in the current directory which contain the
1238 pattern (vimgrep is used)
1239 **//pattern files in the current directory or below which contain
1240 the pattern (vimgrep is used)
1241 <
1242 The cursor will be placed on the first file in the list. One may then
1243 continue to go to subsequent files on that list via |:Nexplore| or to
1244 preceding files on that list with |:Pexplore|. Explore will update the
1245 directory and place the cursor appropriately.
1247 A plain >
1248 :Explore
1249 will clear the explore list.
1251 If your console or gui produces recognizable shift-up or shift-down sequences,
1252 then you'll likely find using shift-downarrow and shift-uparrow convenient.
1253 They're mapped by netrw:
1255 <s-down> == Nexplore, and
1256 <s-up> == Pexplore.
1258 As an example, consider
1259 >
1260 :Explore */*.c
1261 :Nexplore
1262 :Nexplore
1263 :Pexplore
1264 <
1265 The status line will show, on the right hand side of the status line, a
1266 message like "Match 3 of 20".
1268 Associated setting variables: |g:netrw_keepdir| |g:netrw_browse_split|
1269 |g:netrw_fastbrowse| |g:netrw_ftp_browse_reject|
1270 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd|
1271 |g:netrw_ftp_timelist_cmd| |g:netrw_list_cmd|
1272 |g:netrw_liststyle|
1275 DISPLAYING INFORMATION ABOUT FILE *netrw-qf* {{{2
1277 With the cursor atop a filename, pressing "qf" will reveal the file's size
1278 and last modification timestamp. Currently this capability is only available
1279 for local files.
1282 EDIT FILE OR DIRECTORY HIDING LIST *netrw-ctrl-h* *netrw-edithide* {{{2
1284 The "<ctrl-h>" map brings up a requestor allowing the user to change the
1285 file/directory hiding list. The hiding list consists of one or more patterns
1286 delimited by commas. Files and/or directories satisfying these patterns will
1287 either be hidden (ie. not shown) or be the only ones displayed (see
1288 |netrw-a|).
1290 Associated setting variable: |g:netrw_hide|
1293 EDITING THE SORTING SEQUENCE *netrw-S* *netrw-sortsequence* {{{2
1295 When "Sorted by" is name, one may specify priority via the sorting sequence
1296 (g:netrw_sort_sequence). The sorting sequence typically prioritizes the
1297 name-listing by suffix, although any pattern will do. Patterns are delimited
1298 by commas. The default sorting sequence is (all one line):
1299 >
1300 '[\/]$,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$,\.info$,
1301 \.swp$,\.bak$,\~$'
1302 <
1303 The lone * is where all filenames not covered by one of the other patterns
1304 will end up. One may change the sorting sequence by modifying the
1305 g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by
1306 using the "S" map.
1308 Related topics: |g:netrw-s| |g:netrw-S|
1309 Associated setting variable: |g:netrw_sort_sequence|
1312 GOING UP *netrw--* {{{2
1314 To go up a directory, press "-" or press the <cr> when atop the ../ directory
1315 entry in the listing.
1317 Netrw will use the command in |g:netrw_list_cmd| to perform the directory
1318 listing operation after changing HOSTNAME to the host specified by the
1319 user-provided url. By default netrw provides the command as:
1321 ssh HOSTNAME ls -FLa
1323 where the HOSTNAME becomes the [user@]hostname as requested by the attempt to
1324 read. Naturally, the user may override this command with whatever is
1325 preferred. The NetList function which implements remote browsing
1326 expects that directories will be flagged by a trailing slash.
1329 HIDING FILES OR DIRECTORIES *netrw-a* *netrw-hiding* {{{2
1331 Netrw's browsing facility allows one to use the hiding list in one of three
1332 ways: ignore it, hide files which match, and show only those files which
1333 match.
1335 If no files have been marked via |netrw-mf|:
1337 The "a" map allows the user to cycle through the three hiding modes.
1339 The |g:netrw_list_hide| variable holds a comma delimited list of patterns
1340 based on regular expressions (ex. ^.*\.obj$,^\.) which specify the hiding list.
1341 (also see |netrw-ctrl-h|) To set the hiding list, use the <c-h> map. As an
1342 example, to hide files which begin with a ".", one may use the <c-h> map to
1343 set the hiding list to '^\..*' (or one may put let g:netrw_list_hide= '^\..*'
1344 in one's <.vimrc>). One may then use the "a" key to show all files, hide
1345 matching files, or to show only the matching files.
1347 Example: \.[ch]$
1348 This hiding list command will hide/show all *.c and *.h files.
1350 Example: \.c$,\.h$
1351 This hiding list command will also hide/show all *.c and *.h
1352 files.
1354 Don't forget to use the "a" map to select the mode (normal/hiding/show) you
1355 want!
1357 If files have been marked using |netrw-mf|, then this command will:
1359 if showing all files or non-hidden files:
1360 modify the g:netrw_list_hide list by appending the marked files to it
1361 and showing only non-hidden files.
1363 else if showing hidden files only:
1364 modify the g:netrw_list_hide list by removing the marked files from it
1365 and showing only non-hidden files.
1366 endif
1368 *netrw-gh*
1369 As a quick shortcut, one may press >
1370 gh
1371 to toggle between hiding files which begin with a period (dot) or not.
1373 Associated setting variable: |g:netrw_list_hide|
1375 *netrw-ctrl_h*
1376 IMPROVING BROWSING *netrw-listhack* *netrw-ssh-hack* {{{2
1378 Especially with the remote directory browser, constantly entering the password
1379 is tedious.
1381 For Linux/Unix systems, the book "Linux Server Hacks - 100 industrial strength
1382 tips & tools" by Rob Flickenger (O'Reilly, ISBN 0-596-00461-3) gives a tip
1383 for setting up no-password ssh and scp and discusses associated security
1384 issues. It used to be available at http://hacks.oreilly.com/pub/h/66 ,
1385 but apparently that address is now being redirected to some "hackzine".
1386 I'll attempt a summary:
1388 1. Generate a public/private key pair on the ssh server:
1389 ssh-keygen -t rsa
1390 (saving the file in ~/.ssh/id_rsa is ok)
1391 2. Just hit the <CR> when asked for passphrase (twice).
1392 3. This creates two files:
1393 ~/.ssh/id_rsa
1394 ~/.ssh/id_rsa.pub
1395 4. On the client:
1396 cd
1397 mkdir .ssh
1398 chmod 0700 .ssh
1399 scp {serverhostname}:.ssh/id_rsa.pub .
1400 cat id_rsa.pub >> .ssh/authorized_keys2
1402 For Windows, folks on the vim mailing list have mentioned that Pageant helps
1403 with avoiding the constant need to enter the password.
1405 Kingston Fung wrote about another way to avoid constantly needing to enter
1406 passwords:
1408 In order to avoid the need to type in the password for scp each time, you
1409 provide a hack in the docs to set up a non password ssh account. I found a
1410 better way to do that: I can use a regular ssh account which uses a
1411 password to access the material without the need to key-in the password
1412 each time. It's good for security and convenience. I tried ssh public key
1413 authorization + ssh-agent, implementing this, and it works! Here are two
1414 links with instructions:
1416 http://www.ibm.com/developerworks/library/l-keyc2/
1417 http://sial.org/howto/openssh/publickey-auth/
1420 LISTING BOOKMARKS AND HISTORY *netrw-qb* *netrw-listbookmark* {{{2
1422 Pressing "qb" (query bookmarks) will list the bookmarked directories and
1423 directory traversal history (query).
1425 (see |netrw-mb|, |netrw-gb|, |netrw-u|, and |netrw-U|)
1428 MAKING A NEW DIRECTORY *netrw-d* {{{2
1430 With the "d" map one may make a new directory either remotely (which depends
1431 on the global variable g:netrw_mkdir_cmd) or locally (which depends on the
1432 global variable g:netrw_local_mkdir). Netrw will issue a request for the new
1433 directory's name. A bare <CR> at that point will abort the making of the
1434 directory. Attempts to make a local directory that already exists (as either
1435 a file or a directory) will be detected, reported on, and ignored.
1437 Associated setting variable: |g:netrw_local_mkdir| |g:netrw_mkdir_cmd|
1440 MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY *netrw-c* {{{2
1442 By default, |g:netrw_keepdir| is 1. This setting means that the current
1443 directory will not track the browsing directory.
1445 Setting g:netrw_keepdir to 0 tells netrw to make vim's current directory to
1446 track netrw's browsing directory.
1448 However, given the default setting for g:netrw_keepdir of 1 where netrw
1449 maintains its own separate notion of the current directory, in order to make
1450 the two directories the same, use the "c" map (just type c). That map will
1451 set Vim's notion of the current directory to netrw's current browsing
1452 directory.
1454 Associated setting variable: |g:netrw_keepdir|
1457 MARKED FILES: ARBITRARY COMMAND *netrw-mx* {{{2
1458 (See |netrw-mf| and |netrw-mr| for how to mark files)
1460 Upon activation of the "mx" map, netrw will query the user for some command to
1461 be applied to all marked files. All %s in the command will be substituted
1462 with the name of a marked file. If no %s are in the command, then the command
1463 will be followed by a space and a marked filename.
1466 MARKED FILES: COMPRESSION AND DECOMPRESSION *netrw-mz* {{{2
1467 (See |netrw-mf| and |netrw-mr| for how to mark files)
1469 If any marked files are compressed, then "mz" will decompress them.
1470 If any marked files are decompressed, then "mz" will compress them
1471 using the command specified by |g:netrw_compress|; by default,
1472 that's "gzip".
1474 For decompression, netrw provides a |Dictionary| of suffices and their
1475 associated decompressing utilities; see |g:netrw_decompress|.
1477 Associated setting variables: |g:netrw_compress| |g:netrw_decompress|
1479 MARKED FILES: COPYING *netrw-mc* {{{2
1480 (See |netrw-mf| and |netrw-mr| for how to mark files)
1482 Select a target directory with mt (|netrw-mt|). Then change directory,
1483 select file(s) (see |netrw-mf|), and press "mc".
1485 Associated setting variable: |g:netrw_localcopycmd| |g:netrw_ssh_cmd|
1487 MARKED FILES: DIFF *netrw-md* {{{2
1488 (See |netrw-mf| and |netrw-mr| for how to mark files)
1490 Use |vimdiff| to visualize difference between selected files (two or
1491 three may be selected for this).
1493 MARKED FILES: EDITING *netrw-me* {{{2
1494 (See |netrw-mf| and |netrw-mr| for how to mark files)
1496 This command will place the marked files on the |arglist| and commence
1497 editing them. One may return the to explorer window with |:Rexplore|.
1499 MARKED FILES: HIDING AND UNHIDING BY SUFFIX *netrw-mh* {{{2
1500 (See |netrw-mf| and |netrw-mr| for how to mark files)
1502 This command extracts the suffices of the marked files and toggles their
1503 presence on the hiding list. Please note that marking the same suffix
1504 this way multiple times will result in the suffix's presence being toggled
1505 for each file (so an even quantity of marked files having the same suffix
1506 is the same as not having bothered to select them at all).
1508 Related topics: |netrw-a| |g:netrw_list_hide|
1510 MARKED FILES: MOVING *netrw-mm* {{{2
1511 (See |netrw-mf| and |netrw-mr| for how to mark files)
1513 Select a target directory with mT (|netrw-mt|). Then change directory,
1514 select file(s) (see |netrw-mf|), and press "mm".
1516 Associated setting variable: |g:netrw_localmovecmd| |g:netrw_ssh_cmd|
1518 MARKED FILES: PRINTING *netrw-mp* {{{2
1519 (See |netrw-mf| and |netrw-mr| for how to mark files)
1521 Netrw will apply the |:hardcopy| command to marked files. What it does
1522 is open each file in a one-line window, execute hardcopy, then close the
1523 one-line window.
1526 MARKED FILES: SOURCING *netrw-ms* {{{2
1527 (See |netrw-mf| and |netrw-mr| for how to mark files)
1529 Netrw will source the marked files (using vim's |:source| command)
1532 MARKED FILES: TAGGING *netrw-mT* {{{2
1533 (See |netrw-mf| and |netrw-mr| for how to mark files)
1535 The "mt" mapping will apply the command in |g:netrw_ctags| (by default, its
1536 "ctags") to marked files. For remote browsing, in order to create a tags file
1537 netrw will use ssh (see |g:netrw_ssh_cmd|), and so ssh must be available for
1538 this to work on remote systems. For your local system, see |ctags| on how to
1539 get a version. I myself use hdrtags, currently available at
1540 http://mysite.verizon.net/astronaut/src/index.html , and have >
1542 let g:netrw_ctags= "hdrtag"
1543 <
1544 in my <.vimrc>.
1546 When a remote set of files are tagged, the resulting tags file is "obtained";
1547 ie. a copy is transferred to the local system's directory. The local tags
1548 file is then modified so that one may use it through the network. The
1549 modification is concerns the names of the files in the tags; each filename is
1550 preceded by the netrw-compatible url used to obtain it. When one subsequently
1551 uses one of the go to tag actions (|tags|), the url will be used by netrw to
1552 edit the desired file and go to the tag.
1554 Associated setting variables: |g:netrw_ctags| |g:netrw_ssh_cmd|
1557 MARKED FILES: SETTING THE TARGET DIRECTORY *netrw-mt* {{{2
1558 (See |netrw-mf| and |netrw-mr| for how to mark files)
1560 Set the marked file copy/move-to target (see |netrw-mc| and |netrw-mm|):
1562 * if the cursor is atop a file name, then the netrw window's currently
1563 displayed directory is used for the copy/move-to target.
1565 * also, if the cursor is in the banner, then the netrw window's currently
1566 displayed directory is used for the copy/move-to target.
1568 * however, if the cursor is atop a directory name, then that directory is
1569 used for the copy/move-to target
1571 There is only one copy/move-to target per vim session; ie. the target is a
1572 script variable (see |s:var|) and is shared between all netrw windows (in an
1573 instance of vim).
1575 MARKED FILES: UNMARKING *netrw-mu* {{{2
1576 (See |netrw-mf| and |netrw-mr| for how to mark files)
1578 The "mu" mapping will unmark all currently marked files.
1581 MARKING FILES *netrw-mf* {{{2
1582 (also see |netrw-mr|)
1584 One may mark files with the cursor atop a filename and then pressing "mf".
1585 With gvim, one may also mark files with <s-leftmouse>. The following netrw
1586 maps make use of marked files:
1588 |netrw-a| |netrw-O| |netrw-mc| |netrw-me| |netrw-mp| |netrw-mx|
1589 |netrw-D| |netrw-R| |netrw-md| |netrw-mm| |netrw-mT| |netrw-mz|
1591 One may unmark files one at a time the same way one marks them; ie. place
1592 the cursor atop a marked file and press "mf". This process also works
1593 with <s-leftmouse> using gvim. One may unmark all files by pressing
1594 "mu" (see |netrw-mu|).
1596 Two commands, |netrw-mc| and |netrw-mm|, copy/move marked files to a
1597 target directory (which can be set with |netrw-mt|).
1600 MARKING FILES BY REGULAR EXPRESSION *netrw-mr* {{{2
1601 (also see |netrw-mf|)
1603 One may also mark files by pressing "mr"; netrw will then issue a prompt,
1604 "Enter regexp: ". You may then enter a regular expression such as \.c$ .
1605 All files in the current directory will then be marked. Note that the
1606 regular expressions are vim-style |regexp| ones, not shell ones. So
1607 entering *.c probably isn't what you want!
1610 NETRW BROWSER VARIABLES *netrw-browser-options* *netrw-browser-var* {{{2
1612 (if you're interestd in the netrw file transfer settings, see |netrw-options|)
1614 The <netrw.vim> browser provides settings in the form of variables which
1615 you may modify; by placing these settings in your <.vimrc>, you may customize
1616 your browsing preferences. (see also: |netrw-settings|)
1617 >
1618 --- -----------
1619 Var Explanation
1620 --- -----------
1621 < *g:netrw_alto* change from above splitting to below splitting
1622 by setting this variable (see |netrw-o|)
1623 default: =&sb (see |'sb'|)
1625 *g:netrw_altv* change from left splitting to right splitting
1626 by setting this variable (see |netrw-v|)
1627 default: =&spr (see |'spr'|)
1629 *g:netrw_browse_split* when browsing, <cr> will open the file by:
1630 =0: re-using the same window
1631 =1: horizontally splitting the window first
1632 =2: vertically splitting the window first
1633 =3: open file in new tab
1634 =4: act like "P" (ie. open previous window)
1636 *g:netrw_browsex_viewer* specify user's preference for a viewer: >
1637 "kfmclient exec"
1638 "gnome-open"
1639 < If >
1640 "-"
1641 < is used, then netrwFileHandler() will look for
1642 a script/function to handle the given
1643 extension. (see |netrw_filehandler|).
1645 *g:netrw_compress* ="gzip"
1646 Will compress marked files with this
1647 command
1648 *g:netrw_decompress* = { ".gz" : "gunzip" ,
1649 ".bz2" : "bunzip2" ,
1650 ".zip" : "unzip" ,
1651 ".tar" : "tar -xf"}
1652 A dictionary mapping suffices to
1653 decompression programs.
1654 *g:netrw_fastbrowse* =0: slow speed browsing, never re-use
1655 directory listings; always obtain
1656 directory listings.
1657 =1: medium speed browsing, re-use directory
1658 listings only when remote browsing.
1659 (default value)
1660 =2: fast browsing, only obtains directory
1661 listings when the directory hasn't been
1662 seen before (or |netrw-ctrl-l| is used).
1663 Fast browsing retains old directory listing
1664 buffers so that they don't need to be
1665 re-acquired. This feature is especially
1666 important for remote browsing. However, if
1667 a file is introduced or deleted into or from
1668 such directories, the old directory buffer
1669 becomes out-of-date. One may always refresh
1670 such a directory listing with |netrw-ctrl-l|.
1671 This option gives the choice of the trade-off
1672 between accuracy and speed to the user.
1674 *g:netrw_ftp_browse_reject* ftp can produce a number of errors and warnings
1675 that can show up as "directories" and "files"
1676 in the listing. This pattern is used to
1677 remove such embedded messages. By default its
1678 value is:
1679 '^total\s\+\d\+$\|
1680 ^Trying\s\+\d\+.*$\|
1681 ^KERBEROS_V\d rejected\|
1682 ^Security extensions not\|
1683 No such file\|
1684 : connect to address [0-9a-fA-F:]*
1685 : No route to host$'
1687 *g:netrw_ftp_list_cmd* options for passing along to ftp for directory
1688 listing. Defaults:
1689 unix or g:netrw_cygwin set: : "ls -lF"
1690 otherwise "dir"
1693 *g:netrw_ftp_sizelist_cmd* options for passing along to ftp for directory
1694 listing, sorted by size of file.
1695 Defaults:
1696 unix or g:netrw_cygwin set: : "ls -slF"
1697 otherwise "dir"
1699 *g:netrw_ftp_timelist_cmd* options for passing along to ftp for directory
1700 listing, sorted by time of last modification.
1701 Defaults:
1702 unix or g:netrw_cygwin set: : "ls -tlF"
1703 otherwise "dir"
1705 *g:netrw_hide* if true, the hiding list is used
1706 default: =0
1708 *g:netrw_keepdir* =1 (default) keep current directory immune from
1709 the browsing directory.
1710 =0 keep the current directory the same as the
1711 browsing directory.
1712 The current browsing directory is contained in
1713 b:netrw_curdir (also see |netrw-c|)
1715 *g:netrw_list_cmd* command for listing remote directories
1716 default: (if ssh is executable)
1717 "ssh HOSTNAME ls -FLa"
1719 *g:netrw_liststyle* Set the default listing style:
1720 = 0: thin listing (one file per line)
1721 = 1: long listing (one file per line with time
1722 stamp information and file size)
1723 = 2: wide listing (multiple files in columns)
1724 = 3: tree style listing
1725 *g:netrw_list_hide* comma separated pattern list for hiding files
1726 Patterns are regular expressions (see |regexp|)
1727 Example: let g:netrw_list_hide= '.*\.swp$'
1728 default: ""
1730 *g:netrw_localcopycmd* ="cp" Linux/Unix/MacOS/Cygwin
1731 ="copy" Windows
1732 Copies marked files (|netrw-mf|) to target
1733 directory (|netrw-mt|, |netrw-mc|)
1735 *g:netrw_localmovecmd* ="mv" Linux/Unix/MacOS/Cygwin
1736 ="move" Windows
1737 Moves marked files (|netrw-mf|) to target
1738 directory (|netrw-mt|, |netrw-mm|)
1740 *g:netrw_local_mkdir* command for making a local directory
1741 default: "mkdir"
1743 *g:netrw_local_rmdir* remove directory command (rmdir)
1744 default: "rmdir"
1746 *g:netrw_maxfilenamelen* =32 by default, selected so as to make long
1747 listings fit on 80 column displays.
1748 If your screen is wider, and you have file
1749 or directory names longer than 32 bytes,
1750 you may set this option to keep listings
1751 columnar.
1753 *g:netrw_mkdir_cmd* command for making a remote directory
1754 default: "ssh USEPORT HOSTNAME mkdir"
1756 *g:netrw_retmap* if it exists and is set to one, then
1757 <2-leftmouse> will be mapped for easy
1758 return to the netrw browser window.
1759 (example: click once to select and open
1760 a file, double-click to return)
1761 default: =0
1763 *g:netrw_rm_cmd* command for removing files
1764 default: "ssh USEPORT HOSTNAME rm"
1766 *g:netrw_rmdir_cmd* command for removing directories
1767 default: "ssh USEPORT HOSTNAME rmdir"
1769 *g:netrw_rmf_cmd* command for removing softlinks
1770 default: "ssh USEPORT HOSTNAME rm -f"
1772 *g:netrw_sort_by* sort by "name", "time", or "size"
1773 default: "name"
1775 *g:netrw_sort_direction* sorting direction: "normal" or "reverse"
1776 default: "normal"
1778 *g:netrw_sort_sequence* when sorting by name, first sort by the
1779 comma-separated pattern sequence
1780 default: '[\/]$,*,\.bak$,\.o$,\.h$,
1781 \.info$,\.swp$,\.obj$'
1783 *g:netrw_special_syntax* If true, then certain files will be shown
1784 in special syntax in the browser:
1786 netrwBak : *.bak
1787 netrwCompress: *.gz *.bz2 *.Z *.zip
1788 netrwData : *.dat
1789 netrwHdr : *.h
1790 netrwLib : *.a *.so *.lib *.dll
1791 netrwMakefile: [mM]akefile *.mak
1792 netrwObj : *.o *.obj
1793 netrwTags : tags ANmenu ANtags
1794 netrwTilde : *~
1795 netrwTmp : tmp* *tmp
1797 These syntax highlighting groups are linked
1798 to Folded or DiffChange by default
1799 (see |hl-Folded| and |hl-DiffChange|), but
1800 one may put lines like >
1801 hi link netrwCompress Visual
1802 < into one's <.vimrc> to use one's own
1803 preferences.
1805 *g:netrw_ssh_cmd* One may specify an executable command
1806 to use instead of ssh for remote actions
1807 such as listing, file removal, etc.
1808 default: ssh
1810 *g:netrw_ssh_browse_reject* ssh can sometimes produce unwanted lines,
1811 messages, banners, and whatnot that one doesn't
1812 want masquerading as "directories" and "files".
1813 Use this pattern to remove such embedded
1814 messages. By default its value is:
1815 '^total\s\+\d\+$'
1817 *g:netrw_use_noswf* netrw normally avoids writing swapfiles
1818 for browser buffers. However, under some
1819 systems this apparently is causing nasty
1820 ml_get errors to appear; if you're getting
1821 ml_get errors, try putting
1822 let g:netrw_use_noswf= 0
1823 in your .vimrc.
1825 *g:netrw_timefmt* specify format string to vim's strftime().
1826 The default, "%c", is "the preferred date
1827 and time representation for the current
1828 locale" according to my manpage entry for
1829 strftime(); however, not all are satisfied
1830 with it. Some alternatives:
1831 "%a %d %b %Y %T",
1832 " %a %Y-%m-%d %I-%M-%S %p"
1833 default: "%c"
1835 *g:netrw_winsize* specify initial size of new windows made with
1836 "o" (see |netrw-o|), "v" (see |netrw-v|),
1837 |:Hexplore| or |:Vexplore|.
1838 default: ""
1840 *g:NetrwTopLvlMenu* This variable specifies the top level
1841 menu name; by default, it's "Netrw.". If
1842 you wish to change this, do so in your
1843 .vimrc.
1845 NETRW BROWSING AND OPTION INCOMPATIBILITIES *netrw-incompatible* {{{2
1847 Netrw has been designed to handle user options by saving them, setting the
1848 options to something that's compatible with netrw's needs, and then restoring
1849 them. However, the autochdir option: >
1850 :set acd
1851 is problematical. Autochdir sets the current directory to that containing the
1852 file you edit; this apparently also applies to directories. In other words,
1853 autochdir sets the current directory to that containing the "file" (even if
1854 that "file" is itself a directory).
1856 NETRW SETTINGS *netrw-settings* {{{2
1858 With the NetrwSettings.vim plugin, >
1859 :NetrwSettings
1860 will bring up a window with the many variables that netrw uses for its
1861 settings. You may change any of their values; when you save the file, the
1862 settings therein will be used. One may also press "?" on any of the lines for
1863 help on what each of the variables do.
1865 (also see: |netrw-browser-var| |netrw-protocol| |netrw-var| |netrw-variables|)
1868 ==============================================================================
1869 OBTAINING A FILE *netrw-O* {{{2
1871 If there are no marked files:
1873 When browsing a remote directory, one may obtain a file under the cursor
1874 (ie. get a copy on your local machine, but not edit it) by pressing the O
1875 key.
1877 If there are marked files:
1879 The marked files will be obtained (ie. a copy will be transferred to your
1880 local machine, but not set up for editing).
1882 Only ftp and scp are supported for this operation (but since these two are
1883 available for browsing, that shouldn't be a problem). The status bar will
1884 then show, on its right hand side, a message like "Obtaining filename". The
1885 statusline will be restored after the transfer is complete.
1887 Netrw can also "obtain" a file using the local browser. Netrw's display
1888 of a directory is not necessarily the same as Vim's "current directory",
1889 unless |g:netrw_keepdir| is set to 0 in the user's <.vimrc>. One may select
1890 a file using the local browser (by putting the cursor on it) and pressing
1891 "O" will then "obtain" the file; ie. copy it to Vim's current directory.
1893 Related topics:
1894 * To see what the current directory is, use |:pwd|
1895 * To make the currently browsed directory the current directory, see |netrw-c|
1896 * To automatically make the currently browsed directory the current
1897 directory, see |g:netrw_keepdir|.
1900 PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2
1902 One may use a preview window by using the "p" key when the cursor is atop the
1903 desired filename to be previewed. The display will then split to show both
1904 the browser (where the cursor will remain) and the file (see |:pedit|).
1905 By default, the split will be taken horizontally; one may use vertical
1906 splitting if one has set |g:netrw_preview| first.
1909 PREVIOUS WINDOW *netrw-P* *netrw-prvwin* {{{2
1911 To edit a file or directory in the previously used window (see :he |CTRL-W_P|),
1912 press a "P". If there's only one window, then the one window will be
1913 horizontally split (above/below splitting is controlled by |g:netrw_alto|,
1914 and its initial size is controlled by |g:netrw_winsize|).
1916 If there's more than one window, the previous window will be re-used on
1917 the selected file/directory. If the previous window's associated buffer
1918 has been modified, and there's only one window with that buffer, then
1919 the user will be asked if s/he wishes to save the buffer first (yes,
1920 no, or cancel).
1923 REFRESHING THE LISTING *netrw-ctrl-l* *netrw-ctrl_l* {{{2
1925 To refresh either a local or remote directory listing, press ctrl-l (<c-l>) or
1926 hit the <cr> when atop the ./ directory entry in the listing. One may also
1927 refresh a local directory by using ":e .".
1930 RENAMING FILES OR DIRECTORIES *netrw-move* *netrw-rename* *netrw-R* {{{2
1932 If there are no marked files: (see |netrw-mf|)
1934 Renaming/moving files and directories involves moving the cursor to the
1935 file/directory to be moved (renamed) and pressing "R". You will then be
1936 queried for where you want the file/directory to be moved. You may select
1937 a range of lines with the "V" command (visual selection), and then
1938 pressing "R".
1940 If there are marked files: (see |netrw-mf|)
1942 Marked files will be renamed (moved). You will be queried as above in
1943 order to specify where you want the file/directory to be moved.
1945 The g:netrw_rename_cmd variable is used to implement renaming. By default its
1946 value is:
1948 ssh HOSTNAME mv
1950 One may rename a block of files and directories by selecting them with
1951 the V (|linewise-visual|).
1954 REVERSING SORTING ORDER *netrw-r* *netrw-reverse* {{{2
1956 One may toggle between normal and reverse sorting order by pressing the
1957 "r" key.
1959 Related topics: |g:netrw-s|
1960 Associated setting variable: |g:netrw_sort_direction|
1963 SELECTING SORTING STYLE *netrw-s* *netrw-sort* {{{2
1965 One may select the sorting style by name, time, or (file) size. The "s" map
1966 allows one to circulate amongst the three choices; the directory listing will
1967 automatically be refreshed to reflect the selected style.
1969 Related topics: |g:netrw-r| |g:netrw-S|
1970 Associated setting variables: |g:netrw_sort_by| |g:netrw_sort_sequence|
1973 10. Problems and Fixes *netrw-problems* {{{1
1975 (This section is likely to grow as I get feedback)
1976 (also see |netrw-debug|)
1977 *netrw-p1*
1978 P1. I use windows 95, and my ftp dumps four blank lines at the
1979 end of every read.
1981 See |netrw-fixup|, and put the following into your
1982 <.vimrc> file:
1984 let g:netrw_win95ftp= 1
1986 *netrw-p2*
1987 P2. I use Windows, and my network browsing with ftp doesn't sort by
1988 time or size! -or- The remote system is a Windows server; why
1989 don't I get sorts by time or size?
1991 Windows' ftp has a minimal support for ls (ie. it doesn't
1992 accept sorting options). It doesn't support the -F which
1993 gives an explanatory character (ABC/ for "ABC is a directory").
1994 Netrw then uses "dir" to get both its short and long listings.
1995 If you think your ftp does support a full-up ls, put the
1996 following into your <.vimrc>: >
1998 let g:netrw_ftp_list_cmd = "ls -lF"
1999 let g:netrw_ftp_timelist_cmd= "ls -tlF"
2000 let g:netrw_ftp_sizelist_cmd= "ls -slF"
2001 <
2002 Alternatively, if you have cygwin on your Windows box, put
2003 into your <.vimrc>: >
2005 let g:netrw_cygwin= 1
2006 <
2007 This problem also occurs when the remote system is Windows.
2008 In this situation, the various g:netrw_ftp_[time|size]list_cmds
2009 are as shown above, but the remote system will not correctly
2010 modify its listing behavior.
2013 *netrw-p3*
2014 P3. I tried rcp://user@host/ (or protocol other than ftp) and netrw
2015 used ssh! That wasn't what I asked for...
2017 Netrw has two methods for browsing remote directories: ssh
2018 and ftp. Unless you specify ftp specifically, ssh is used.
2019 When it comes time to do download a file (not just a directory
2020 listing), netrw will use the given protocol to do so.
2022 *netrw-p4*
2023 P4. I would like long listings to be the default.
2025 Put the following statement into your |.vimrc|: >
2027 let g:netrw_liststyle= 1
2028 <
2029 Check out |netrw-browser-var| for more customizations that
2030 you can set.
2032 *netrw-p5*
2033 P5. My times come up oddly in local browsing
2035 Does your system's strftime() accept the "%c" to yield dates
2036 such as "Sun Apr 27 11:49:23 1997"? If not, do a "man strftime"
2037 and find out what option should be used. Then put it into
2038 your |.vimrc|: >
2040 let g:netrw_timefmt= "%X" (where X is the option)
2041 <
2042 *netrw-p6*
2043 P6. I want my current directory to track my browsing.
2044 How do I do that?
2046 Put the following line in your |.vimrc|:
2047 >
2048 let g:netrw_keepdir= 0
2049 <
2050 *netrw-p7*
2051 P7. I use Chinese (or other non-ascii) characters in my filenames, and
2052 netrw (Explore, Sexplore, Hexplore, etc) doesn't display them!
2054 (taken from an answer provided by Wu Yongwei on the vim
2055 mailing list)
2056 I now see the problem. You code page is not 936, right? Vim
2057 seems only able to open files with names that are valid in the
2058 current code page, as are many other applications that do not
2059 use the Unicode version of Windows APIs. This is an OS-related
2060 issue. You should not have such problems when the system
2061 locale uses UTF-8, such as modern Linux distros.
2063 (...it is one more reason to recommend that people use utf-8!)
2065 *netrw-p8*
2066 P8. I'm getting "ssh is not executable on your system" -- what do I
2067 do?
2069 (Dudley Fox) Most people I know use putty for windows ssh. It
2070 is a free ssh/telnet application. You can read more about it
2071 here:
2073 http://www.chiark.greenend.org.uk/~sgtatham/putty/ Also:
2075 (Marlin Unruh) This program also works for me. It's a single
2076 executable, so he/she can copy it into the Windows\System32
2077 folder and create a shortcut to it.
2079 (Dudley Fox) You might also wish to consider plink, as it
2080 sounds most similar to what you are looking for. plink is an
2081 application in the putty suite.
2083 http://the.earth.li/~sgtatham/putty/0.58/htmldoc/Chapter7.html#plink
2085 (Vissale Neang) Maybe you can try OpenSSH for windows, which
2086 can be obtained from:
2088 http://sshwindows.sourceforge.net/
2090 It doesn't need the full Cygwin package.
2092 (Antoine Mechelynck) For individual Unix-like programs needed
2093 for work in a native-Windows environment, I recommend getting
2094 them from the GnuWin32 project on sourceforge if it has them:
2096 http://gnuwin32.sourceforge.net/
2098 Unlike Cygwin, which sets up a Unix-like virtual machine on
2099 top of Windows, GnuWin32 is a rewrite of Unix utilities with
2100 Windows system calls, and its programs works quite well in the
2101 cmd.exe "Dos box".
2103 (dave) Download WinSCP and use that to connect to the server.
2104 In Preferences > Editors, set gvim as your editor:
2106 - Click "Add..."
2107 - Set External Editor (adjust path as needed, include
2108 the quotes and !.! at the end):
2109 "c:\Program Files\Vim\vim70\gvim.exe" !.!
2110 - Check that the filetype in the box below is
2111 {asterisk}.{asterisk} (all files), or whatever types
2112 you want (cec: change {asterisk} to * ; I had to
2113 write it that way because otherwise the helptags
2114 system thinks it's a tag)
2115 - Make sure it's at the top of the listbox (click it,
2116 then click "Up" if it's not)
2117 If using the Norton Commander style, you just have to hit <F4>
2118 to edit a file in a local copy of gvim.
2120 (Vit Gottwald) How to generate public/private key and save
2121 public key it on server: >
2122 http://www.tartarus.org/~simon/puttydoc/Chapter8.html#pubkey-gettingready
2123 8.3 Getting ready for public key authentication
2124 <
2125 How to use a private key with 'pscp': >
2127 http://www.tartarus.org/~simon/puttydoc/Chapter5.html
2128 5.2.4 Using public key authentication with PSCP
2129 <
2130 (Ben Schmidt) I find the ssh included with cwRsync is
2131 brilliant, and install cwRsync or cwRsyncServer on most
2132 Windows systems I come across these days. I guess COPSSH,
2133 packed by the same person, is probably even better for use as
2134 just ssh on Windows, and probably includes sftp, etc. which I
2135 suspect the cwRsync doesn't, though it might
2137 (cec) To make proper use of these suggestions above, you will
2138 need to modify the following user-settable variables in your
2139 .vimrc:
2141 |g:netrw_ssh_cmd| |g:netrw_list_cmd| |g:netrw_mkdir_cmd|
2142 |g:netrw_rm_cmd| |g:netrw_rmdir_cmd| |g:netrw_rmf_cmd|
2144 The first one (|g:netrw_ssh_cmd|) is the most important; most
2145 of the others will use the string in g:netrw_ssh_cmd by
2146 default.
2147 *netrw-p9* *netrw-ml_get*
2148 P9. I'm browsing, changing directory, and bang! ml_get errors
2149 appear and I have to kill vim. Any way around this?
2151 Normally netrw attempts to avoid writing swapfiles for
2152 its temporary directory buffers. However, on some systems
2153 this attempt appears to be causing ml_get errors to
2154 appear. Please try setting |g:netrw_use_noswf| to 0
2155 in your <.vimrc>: >
2156 let g:netrw_use_noswf= 0
2157 <
2158 *netrw-p10*
2159 P10. I'm being pestered with "[something] is a directory" and
2160 "Press ENTER or type command to continue" prompts...
2162 The "[something] is a directory" prompt is issued by Vim,
2163 not by netrw, and there appears to be no way to work around
2164 it. Coupled with the default cmdheight of 1, this message
2165 causes the "Press ENTER..." prompt. So: read |hit-enter|;
2166 I also suggest that you set your |'cmdheight'| to 2 (or more) in
2167 your <.vimrc> file.
2169 *netrw-p11*
2170 P11. I want to have two windows; a thin one on the left and my editing
2171 window on the right. How can I do this?
2173 * Put the following line in your <.vimrc>:
2174 let g:netrw_altv = 1
2175 * Edit the current directory: :e .
2176 * Select some file, press v
2177 * Resize the windows as you wish (see |ctrl-w_<| and
2178 |ctrl-w_>|). If you're using gvim, you can drag
2179 the separating bar with your mouse.
2180 * When you want a new file, use ctrl-w h to go back to the
2181 netrw browser, select a file, then press P (see |ctrl-w_h|
2182 and |netrw-P|). If you're using gvim, you can press
2183 <leftmouse> in the browser window and then press the
2184 <middlemouse> to select the file.
2186 ==============================================================================
2187 11. Debugging Netrw Itself *netrw-debug* {{{1
2189 The <netrw.vim> script is typically available as:
2190 >
2191 /usr/local/share/vim/vim6x/plugin/netrwPlugin.vim
2192 /usr/local/share/vim/vim6x/autoload/netrw.vim
2193 < -or- >
2194 /usr/local/share/vim/vim7x/plugin/netrwPlugin.vim
2195 /usr/local/share/vim/vim7x/autoload/netrw.vim
2196 <
2197 which is loaded automatically at startup (assuming :set nocp).
2199 1. Get the <Decho.vim> script, available as:
2201 http://mysite.verizon.net/astronaut/vim/index.html#DECHO
2202 or
2203 http://vim.sourceforge.net/scripts/script.php?script_id=120
2205 It now comes as a "vimball"; if you're using vim 7.0 or earlier,
2206 you'll need to update vimball, too. See
2207 http://mysite.verizon.net/astronaut/vim/index.html#VIMBALL
2209 2. Edit the <netrw.vim> file by typing: >
2211 vim netrw.vim
2212 :DechoOn
2213 :wq
2214 <
2215 To restore to normal non-debugging behavior, re-edit <netrw.vim>
2216 and type >
2218 vim netrw.vim
2219 :DechoOff
2220 :wq
2221 <
2222 This command, provided by <Decho.vim>, will comment out all
2223 Decho-debugging statements (Dfunc(), Dret(), Decho(), Dredir()).
2225 3. Then bring up vim and attempt to evoke the problem by doing a
2226 transfer or doing some browsing. A set of messages should appear
2227 concerning the steps that <netrw.vim> took in attempting to
2228 read/write your file over the network in a separate tab.
2230 To save the file, use >
2231 :wincmd j
2232 :set bt=
2233 :w! DBG
2234 < Please send that information to <netrw.vim>'s maintainer, >
2235 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
2236 <
2237 ==============================================================================
2238 12. History *netrw-history* {{{1
2240 v122: Feb 12, 2008 * bugfix - first sorting sequence match now has
2241 priority
2242 Feb 14, 2008 * bugfix - sorting sequence was effectively ignoring
2243 sequencing priority of anything following '*'
2244 * toggling a marked file was showing incorrect list
2245 (list was correct, but displayed matches weren't)
2246 * |g:netrw_special_syntax| implemented
2247 v121: Feb 11, 2008 * Bram M reported that :e file ... :e . would not
2248 retain the alternate file. Fixed -- I hope!
2249 * bugfix -- apparently v120 broke an explicit
2250 :Explore dirname
2251 v120: Jan 21, 2008 * |netrw-mt| changed to allow for target selection
2252 based on whether or not word under cursor is a
2253 directory or file, or if cursor is in banner
2254 area.
2255 * |netrw-mh| included (hiding by marked-file suffix)
2256 * functions moved about a bit (improved
2257 categorization)
2258 * executable files now displayed with trailing (*)
2259 * symbolically linked files now displayed with
2260 trailing (@)
2261 * Somewhen, s:NetrwMarkFileMove() got damaged. Its
2262 now restored (missing an endif, for example).
2263 * |netrw-mu| implemented (unmarking marked files)
2264 * many bugs have been removed from the marked file
2265 system (tnx to Mark S. for feedback)
2266 * |netrw-ms| implemented (sourcing marked files)
2267 * fixed use of P with tree listing style
2268 * multiple tree listing now supported
2269 * ./ suppressed
2270 * changed q -> qb (query bookmarks)
2271 * implemented |netrw-qf|
2272 * Explore now has four special list-generation
2273 modes: */filepat **/filepat
2274 *//pattern **//pattern
2275 * gh (|netrw-gh|) is a shortcut for toggling the
2276 hiding of files and directories beginning with a
2277 dot
2278 v119: Jan 10, 2008 * When g:netrw_keepdir is false,
2279 NetrwOptionsRestore() had a problem
2280 (Bill McCarthy)
2281 Jan 11, 2008 * Netrw now shows symbolic links with a trailing
2282 "@" and special highlighting.
2283 Jan 15, 2008 * Changed g:netrw_noretmap -> |g:netrw_retmap|.
2284 Changed: disabled by default at Bram's
2285 preference.
2286 v118: Jan 02, 2008 * Fixed a problem with Windows;
2287 :Explore c:/path/ would not work,
2288 but :Explore c:/path would.
2289 * Fixed a bug in s:NetrwOptionRestore() - lcd's
2290 argument wasn't being properly escaped so it
2291 wouldn't handle spaces in directory names.
2292 (Gary Johnson)
2293 v117: Jan 02, 2008 * Fixed a problem with P; had to include
2294 a b:netrw_curdir bypass (Bram Moolenaar)
2295 v116: Nov 27, 2007 * netrw#LocalBrowseCheck() has &ft=="netrw"
2296 check to prevent doing a directory listing
2297 (was getting unexpected directory refreshes
2298 in the middle of some function calls)
2299 * NetrwOptionRestore moved after e! filename
2300 in order to retain user options for editing
2301 in s:NetrwBrowseChgDir()
2302 Dec 12, 2007 * Bug fix -- netrw does a better job of retaining
2303 user options when editing files under the aegis
2304 of the browser
2305 v115: Oct 04, 2007 * Erik Remmelzwaal pointed out that the use of
2306 shellslash in s:GetTempfile() was incorrect
2307 Oct 11, 2007 * Tracked down and eliminated a bug with editing
2308 remote *.tar.gz and *.tar.bz2 files
2309 Oct 11, 2007 * g:netrw_localmovecmd wasn't being initialized
2310 properly, and g:netrw_localcopycmd was being
2311 overwritten.
2312 Oct 12, 2007 * Placed all :Rexplore and <2-leftmouse> setup
2313 in a new support function (s:SetRexDir()).
2314 Oct 15, 2007 * new: g:netrw_browse_split == 4; means <cr>
2315 based selection will use previous window
2316 Oct 20, 2007 * also checks on |'shellxquote'| to set g:netrw_shq
2317 Oct 24, 2007 * Explore handles path/**/filename
2318 Oct 27, 2007 * sourcing remote files often didn't work with ftp,
2319 turns out that b:netrw_method was undefined, so
2320 s:SaveBufVars and s:RestoreBufVars() fixed it.
2321 v114: Sep 28, 2007 * mT, the map that invokes tags, has been improved
2322 to support use of remote tags files.
2323 Oct 02, 2007 * changed Netrw menu to use more submenus
2324 v113: Sep 07, 2007 * worked out why the cursor position wasn't being
2325 saved and restored as intended after doing such
2326 things as deleting and renaming files.
2327 Sep 11, 2007 * Fixed bug which effectively disabled <c-l> and
2328 <c-h> maps
2329 Sep 18, 2007 * there used to be one NetrwOptionRestore() call at
2330 the end of the s:NetrwBrowseChgDir() function;
2331 they're now at the end of every if..elseif..else
2332 block. The edit-a-file one is not quite at the end
2333 of its block; instead, its just before the edit.
2334 Restores user options, then this new placement
2335 allows ftplugins, autocmds, etc to change settings
2336 (ex. ftplugin/cpp.vim sets cindent).
2337 Sep 19, 2007 * changed all strlen() calls to use s:Strlen(), a
2338 function which handles utf-8 wide characters
2339 correctly.
2340 Sep 20, 2007 * (Nico Weber) the "x" command has been extended
2341 to Mac's OS/X (macunix); it now uses open to
2342 handle |netrw-x| browsing with special files.
2343 Sep 22, 2007 * Added |g:netrw_noretmap| to netrw at Tony M's
2344 request.
2345 * Included path to NetrwRemoteRmFile()
2346 v112: Aug 18, 2007 * added mx (|netrw-mx|) for executing arbitrary
2347 commands on marked files
2348 Aug 22, 2007 * more option save/restore work for
2349 s:NetrwBrowseChgDir(); s:NetrwOptionSave()
2350 and s:NetrwOptionRestore() now take a parameter
2351 specifying the type of variables to be used for
2352 saving and restoring (either "w:" or "s:")
2353 Sep 04, 2007 * added the :NetrwClean[!] command
2354 v111: Jul 25, 2007 * using Windows but not using Cygwin, netrw does a
2355 "file bufname" where the bufname uses /s
2356 instead of \s; Vim "fixes" it by changing the
2357 bufname to use \s anyway. This meant that
2358 NetrwGetBuffer() didn't find the appropriately
2359 named buffer, and so would generate a new
2360 buffer listing; hence the cursor would appear
2361 to have been moved when doing a preview.
2362 * added <2-leftmouse> map to return to netrw's
2363 browser display
2364 Aug 16, 2007 * added the mark-file system, including
2365 maps for mf mp mt mz and mu. Modifications
2366 made to maps for a D O and R to support
2367 marked files.
2368 v110: May 10, 2007 * added [ and ] maps to NetrwTreeListing
2369 May 25, 2007 * |g:netrw_preview| included
2370 May 29, 2007 * modifed netrw#NetBrowseX to consistently use
2371 |g:netrw_shq| instead of hardcoded quotes,
2372 and modified the snippet that sets up redir
2373 so Windows machines use "nul" instead of
2374 "/dev/null".
2375 Jun 01, 2007 * fixed bug -- NetGetBuffer() wasn't always
2376 recognizing a buffer name match when it should,
2377 thus resulting in [Scratch] buffers.
2378 Jun 04, 2007 * Gary Johnson found a bugfix for the "c" mapping
2379 when the directory is to be made current but
2380 the name contains spaces.
2381 v109: Mar 26, 2007 * if a directory name includes a "$" character,
2382 Explore() will use expand() in an attempt to
2383 decipher the name.
2384 May 07, 2007 * g:netrw_use_errorwindow now allows one to
2385 have error messages go to a reliable window
2386 or to use a less reliable but recallable
2387 echoerr method
2388 May 07, 2007 * g:netrw_scpport and g:netrw_sshport support
2389 use of -P and -p, respectively, to set port
2390 for scp/ssh.
2391 v108: Jan 03, 2007 * included preview map (|netrw-p|), supporting
2392 remote browsing
2393 * netrw can now source remote files
2394 Jan 26, 2007 * Colton Jamieson noted that remote directory
2395 browsing did not support alternate port
2396 selection. This feature has now been extended
2397 to apply to all remote browsing commands via ssh.
2398 (list, remove/delete, rename)
2399 Jan 31, 2007 * Luis Florit reported that @* was an invalid
2400 register. The @* register is now only saved and
2401 restored if |'guioptions'| contains "a".
2402 Feb 02, 2007 * Fixed a bug that cropped up when writing files
2403 via scp using cygwin
2404 Feb 08, 2007 * tree listing mode managed to stop working again;
2405 fixed again!
2406 Feb 15, 2007 * Guido Van Hoecke reported that netrw didn't
2407 handle browsing well with M$ ftp servers. He even
2408 set up a temporary account for me to test with
2409 (thanks!). Netrw now can browse M$ ftp servers.
2410 v107: Oct 12, 2006 * bypassed the autowrite option
2411 Oct 24, 2006 * handles automatic decompression of *.gz and *.bz2
2412 files
2413 Nov 03, 2006 * Explore will highlight matching files when
2414 **/pattern is used (and if the |'hls'| option
2415 is set)
2416 Nov 09, 2006 * a debugging line, when enabled, was inadvertently
2417 bringing up help instead of simply reporting on
2418 list contents
2419 Nov 21, 2006 * tree listing improved (cursor remains put)
2420 Nov 27, 2006 * fixed b:netrw_curdir bug when repeated "i"s were
2421 pressed.
2422 Dec 15, 2006 * considerable qty of changes, mostly to share more
2423 code between local and remote browsing. Includes
2424 support for tree-style listing for both remote
2425 and local browsing.
2426 Dec 15, 2006 * Included Peter Bengtsson's modifications to
2427 support the Amiga.
2428 v106: Sep 21, 2006 * removed old v:version<700 code as netrw now
2429 requires vim 7.0
2430 * worked around a bug where register * was
2431 overwritten during local browsing
2432 v104: Sep 05, 2006 * as suggested by Rodolfo Borges, :Explore and
2433 variants will position the cursor on the file
2434 just having been edited
2435 * changed default |g:netrw_sort_sequence| order
2436 * changed b, Nb to simply mb (see |netrw-mb|)
2437 * changed B, NB to simply gb (see |netrw-gb|)
2438 * tree listing style (see |g:netrw_liststyle|)
2439 * attempts to retain the alternate file
2440 v103: Jul 26, 2006 * used Yakov Lerner's tip#1289 to improve netrw
2441 error message display
2442 * wide listings didn't handle files with backslashes
2443 in their names properly. A symptom was an
2444 inability to open files.
2445 Aug 09, 2006 * included "t" mapping for opening tabbed windows,
2446 both for remote and local browsing
2447 * changed netrw_longlist to netrw_liststyle
2448 Aug 15, 2006 * fixed one of the NB maps
2449 Aug 22, 2006 * changed *Explore commands to use -nargs=* instead
2450 of -nargs=?. Allows both -complete=dir _and_ the
2451 starstar arguments to work (-nargs=? seems to
2452 require one or the other).
2453 Aug 23, 2006 * copied all w:.. variables across splits to
2454 new windows
2455 Aug 25, 2006 * when g:netrw_browsex_viewer was '-'
2456 (see |g:netrw_browsex_viewer|) it wasn't causing
2457 netrwFileHandlers#Invoke() to be called as it
2458 was expected to. (tnx Steve Dugaro)
2459 Aug 29, 2006 * changed NetBrowseX() to use "setlocal ... noswf"
2460 instead of "set ... noswf" (tnx Benji Fisher)
2461 Aug 31, 2006 * tabs and fastbrowse<=1 didn't work together.
2462 v102: Jun 15, 2006 * chgd netrwPlugin to call netrw#LocalBrowseCheck()
2463 * bugfix: g:netrw_keepdir==0 had stopped working
2464 Jul 06, 2006 * bugfix: NetOptionSave/Restore now saves/restores
2465 the unnamed register (|registers|)
2466 Jul 07, 2006 * |g:netrw_menu| support included
2467 Jul 13, 2006 * :Texplore command implemented
2468 Jul 17, 2006 * NetSplit and (Local|Net)BrowseChgDir() were both
2469 splitting windows. This affected o, v, and
2470 g:netrw_browse_split.
2471 Jul 20, 2006 * works around wildignore setting (was causing
2472 netrw's local browser not to list wildignore'd
2473 files)
2474 Jul 24, 2006 * <leftmouse> acts as a <cr> for selecting a file
2475 <rightmouse> acts as a <del> for deleting a file
2476 v100: May 14, 2006 * when using Windows and shell==cmd.exe, the
2477 default for g:netrw_ignorenetrc is now 1
2478 * bugfix: unwanted ^Ms now removed
2479 (affected shell==cmd.exe - Windows)
2480 * added Bookmarks and History to the menu
2481 * an error message about non-existing
2482 w:netrw_longlist was appearing during attempts to
2483 Explore (fixed)
2484 * g:netrw_shq now available to make netrw use
2485 specified style of quotes for commands
2486 May 29, 2006 * user NFH_*() functions were inadvertently being
2487 ignored
2488 * fixed a Windows non-cygwin ftp handling problem.
2489 * hiding pattern candidate separators included some
2490 characters it shouldn't have (tnx to Osei Poku)
2491 Jun 01, 2006 * for browsing, netrw was supposed to use "dir"
2492 instead of "ls -lF" when using
2493 ftp+non-cygwin+windows. Fixed.
2494 * an inadvertently left-in-place debugging statement
2495 was preventing use of the "x" key with browsing.
2496 Jun 05, 2006 * g:netrw_nogx available to prevent making the gx
2497 map (see |g:netrw_nogx|)
2498 * bugfix, Explore wouldn't change directory
2499 properly (vim ., :Explore subdirname)
2500 Jun 06, 2006 * moved history to 2nd line in Netrw menu
2501 * fixed delete for unix-based systems
2502 Jun 07, 2006 * x key now works for windows-noncygwin-ftp
2503 Jun 08, 2006 * Explore */pat and **//pat now wraps
2504 v99: May 09, 2006 * g:netrw_browse_split=3 for opening files in new
2505 tabs implemented.
2506 May 12, 2006 * deletes temporary file at end of NetRead()
2507 * visual mode based Obtain implemented
2508 * added -complete=dir to the various Explore
2509 commands
2510 v98: May 02, 2006 * the "p" key didn't work properly when the browsing
2511 directory name had spaces in it.
2512 v97: May 01, 2006 * exists("&acd") now used to determine if
2513 the 'acd' option exists
2514 * "obtain" now works again under Windows
2515 v96: * bugfix - the |'acd'| option is not always defined
2516 but is now bypassed only when it is
2517 v95: * bugfix - Hiding mode worked correctly (don't show
2518 any file matching any of the g:netrw_hide
2519 patterns), but showing mode was showing only those
2520 files that didn't match any of the g:netrw_hide
2521 patterns. Instead, it now shows all files that
2522 match any of the g:netrw_hide patterns (the
2523 difference between a logical and and logical or).
2524 v94: * bugfix - a Decho() had a missing quote; only
2525 affects things when debugging was enabled.
2526 v93: * bugfix - removed FocusGained event from causing a
2527 slow-browser refresh for Windows
2528 v92: * :Explore **//pattern implemented
2529 (**/filepattern was already taken)
2530 v91: * :Explore */pattern implemented
2531 * |'acd'| option bypassed
2532 v90: * mark ', as suggested by Yegappan Lakshmanan, used
2533 to help guarantee entry into the jump list when
2534 appropriate.
2535 * <s-down> and <s-up> are no longer defined until a
2536 :Explore **/pattern is used (if the user already
2537 has a map for them). They will be defined for new
2538 browser windows from that point forward.
2539 v89: * A <s-down>, <s-up>, :Nexplore, or a :Pexplore
2540 without having first done an :Explore **/pattern
2541 (see |netrw-starstar|) caused
2542 a lot of unhelpful error messages to appear
2543 v88: * moved DrChip.Netrw menu to Netrw. Now has
2544 priority 80 by default.
2545 g:NetrwTopLvlMenu == "Netrw" and can be changed
2546 by the user to suit. The priority is given by
2547 g:NetrwMenuPriority.
2548 * Changed filetype for browser displays from
2549 netrwlist to netrw.
2550 v87: * bug fix -- menus were partially disappearing
2551 v85: * bug fix -- missing an endif
2552 * bug fix -- handles spaces in names and directories
2553 when using ftp-based browsing
2554 v83: * disabled stop-acd handling; the change in directory
2555 handling may allow acd to be used again.
2556 * D was refusing to delete remote files/directories
2557 in wide listing mode.
2558 v81: * FocusGained also used to refresh/wipe local browser
2559 directory buffers
2560 * (bugfix) netrw was leaving [Scratch] buffers behind
2561 when the user had the "hidden" option set. The
2562 'hidden' option is now bypassed.
2563 v80: * ShellCmdPost event used in conjunction with
2564 g:netrw_fastbrowse to refresh/wipe local browser
2565 directory buffers.
2566 v79: * directories are now displayed with nowrap
2567 * (bugfix) if the column width was smaller than the
2568 largest file's name, then netrw would hang when
2569 using wide-listing mode - fixed
2570 * g:netrw_fastbrowse introduced
2571 v78: * progress has been made on allowing spaces inside
2572 directory names for remote work (reading, writing,
2573 browsing). (scp)
2574 v77: * Mikolaj Machowski fixed a bug in a substitute cmd
2575 * g:netrw_browsex_viewer implemented
2576 * Mikolaj Machowski pointed out that gnome-open is
2577 often executable under KDE systems, although it is
2578 effectively not functional. NetBrowseX now looks
2579 for "kicker" as a running process to determine if
2580 KDE is actually running.
2581 * Explorer's O functionality was inadvertently left
2582 out. Netrw now does the same thing, but with the
2583 "P" key.
2584 * added g:netrw_browse_split option
2585 * fixed a bug where the directory contained a "." but
2586 the file didn't (was treating the dirname from "."
2587 onwards as a suffix)
2588 v76: * "directory is missing" error message now restores
2589 echo highlighting
2590 v75: * file://... now conforms to RFC2396 (thanks to
2591 S. Zacchiroli)
2592 * if the binary option is set, then NetWrite() will
2593 only write the whole file (line numbers don't make
2594 sense with this). Supports writing of tar and zip
2595 files.
2596 v74: * bugfix (vim, then :Explore) now works
2597 * ctrl-L keeps cursor at same screen location (both
2598 local and remote browsing)
2599 * netrw now can read remote zip and tar files
2600 * Obtain now uses WinXP ftp+.netrc successfully
2601 v73: * bugfix -- scp://host/path/file was getting named
2602 incorrectly
2603 * netrw detects use of earlier-than-7.0 version of
2604 vim and issues a pertinent error message.
2605 * netrwSettings.vim is now uses autoloading. Only
2606 <netrwPlugin.vim> is needed as a pure plugin
2607 (ie. always loaded).
2608 v72: * bugfix -- formerly, one could prevent the loading
2609 of netrw by "let g:loaded_netrw=1"; when
2610 autoloading became supported, this feature was
2611 lost. It is now restored.
2612 v71: * bugfix -- made some "set nomodifiable"s into
2613 setlocal variants (allows :e somenewfile to be
2614 modifiable as usual)
2615 * NetrwSettings calls a netrw function, thereby
2616 assuring that netrw has loaded. However, if netrw
2617 does not load for whatever reason, then
2618 NetrwSettings will now issue a warning message.
2619 * For what reason I don't recall, when wget and fetch
2620 are both not present, and an attempt to read a
2621 http://... url is made, netrw exited. It now only
2622 returns.
2623 * When ch=1, on the second and subsequent uses of
2624 browsing Netrw would issue a blank line to clear
2625 the echo'd messages. This caused an annoying
2626 "Hit-Enter" prompt; now a blank line message
2627 is echo'd only if &ch>1.
2628 v70: * when using |netrw-O|, the "Obtaining filename"
2629 message is now shown using |hl-User9|. If User9
2630 has not been defined, netrw itself will define it.
2631 v69: * Bugfix: win95/98 machines were experiencing a
2632 "E121: Undefined variable: g:netrw_win95ftp"
2633 message
2634 v68: * double-click-leftmouse selects word under mouse
2635 v67: * Passwords which contain blanks will now be
2636 surrounded by double-quotes automatically (Yongwei)
2637 v66: * Netrw now seems to work with a few more Windows
2638 situations
2639 * O now obtains a file: remote browsing
2640 file -> local copy, locally browsing
2641 file -> current directory (see :pwd)
2642 * i now cycles between thin, long, and wide listing
2643 styles
2644 * NB and Nb are maps that are always available;
2645 corresponding B and b maps are only available when
2646 not using wide listing in order to allow them to
2647 be used for motions
2648 v65: * Browser functions now use NetOptionSave/Restore; in
2649 particular, netrw now works around the report
2650 setting
2651 v64: * Bugfix - browsing a "/" directory (Unix) yielded
2652 buffers named "[Scratch]" instead of "/"
2653 * Bugfix - remote browsing with ftp was omitting
2654 the ./ and ../
2655 v63: * netrw now takes advantage of autoload (needs 7.0)
2656 * Bugfix - using r (to reverse sort) working again
2657 v62: * Bugfix - spaces allowed again in directory names
2658 with g:netrw_keepdir=0. In fact, I've tested netrw
2659 with most ANSI punctuation marks for directory
2660 names.
2661 * Bugfix - NetrwSettings gave errors when
2662 g:netrw_silent had not be set.
2663 v61: * Document upgrade -- netrw variable-based settings
2664 all should have tags. Supports NetrwSettings cmd.
2665 * Several important variables are window-oriented.
2666 Netrw has to transfer these across a window split.
2667 See s:BufWinVars() and s:UseBufWinVars().
2668 v60: * When using the i map to switch between long and
2669 short listings, netrw will now keep cursor on same
2670 line
2671 * "Match # of #" now uses status line
2672 * :Explore **/*.c will now work from a
2673 non-netrw-browser window
2674 * :Explore **/patterns can now be run in separate
2675 browser windows
2676 * active banner (hit <cr> will cause various things
2677 to happen)
2678 v59: * bugfix -- another keepalt work-around installed
2679 (for vim6.3)
2680 * "Match # of #" for Explore **/pattern matches
2681 v58: * Explore and relatives can now handle
2682 **/somefilepattern (v7)
2683 * Nexplore and Pexplore introduced (v7). shift-down
2684 and shift-up cursor keys will invoke Nexplore and
2685 Pexplore, respectively.
2686 * bug fixed with o and v
2687 * autochdir only worked around for vim when it has
2688 been compiled with either
2689 |+netbeans_intg| or |+sun_workshop|
2690 * Under Windows, all directories and files were
2691 being preceded with a "/" when local browsing.
2692 Fixed.
2693 * When: syntax highlighting is off, laststatus=2, and
2694 remote browsing is used, sometimes the laststatus
2695 highlighting bleeds into the entire display. Work
2696 around - do an extra redraw in that case.
2697 * Bugfix: when g:netrw_keepdir=0, due to re-use of
2698 buffers, netrw didn't change the directory when it
2699 should've
2700 * Bugfix: D and R commands work again
2701 v57: * Explore and relatives can now handle RO files
2702 * reverse sort restored with vim7's sort command
2703 * g:netrw_keepdir now being used to keep the current
2704 directory unchanged as intended (sense change)
2705 * vim 6.3 still supported
2706 v56: * LocalBrowse now saves autochdir setting, unsets it,
2707 and restores it before returning.
2708 * using vim's rename() instead of system +
2709 local_rename variable
2710 * avoids changing directory when g:netrw_keepdir is
2711 false
2712 v55: * -bar used with :Explore :Sexplore etc to allow
2713 multiple commands to be separated by |s
2714 * browser listings now use the "nowrap" option
2715 * browser: some unuseful error messages now
2716 suppressed
2717 v54: * For backwards compatibility, Explore and Sexplore
2718 have been implemented. In addition, Hexplore and
2719 Vexplore commands are available, too.
2720 * <amatch> used instead of <afile> in the
2721 transparency support (BufReadCmd, FileReadCmd,
2722 FileWriteCmd)
2723 * ***netrw*** prepended to various error messages
2724 netrw may emit
2725 * g:netrw_port used instead of b:netrw_port for scp
2726 * any leading [:#] is removed from port numbers
2727 v53: * backslashes as well as slashes placed in various
2728 patterns (ex. g:netrw_sort_sequence) to better
2729 support Windows
2730 v52: * nonumber'ing now set for browsing buffers
2731 * when the hiding list hid all files, error messages
2732 ensued. Fixed
2733 * when browsing, swf is set, but directory is not
2734 set, when netrw was attempting to restore options,
2735 vim wanted to save a swapfile to a local directory
2736 using an url-style path. Fixed
2737 v51: * cygwin detection now automated
2738 (using windows and &shell is bash)
2739 * customizable browser "file" rejection patterns
2740 * directory history
2741 * :[range]w url now supported (ie. netrw uses a
2742 FileWriteCmd event)
2743 * error messages have a "Press <cr> to continue" to
2744 allow them to be seen
2745 * directory browser displays no longer bother the
2746 swapfile
2747 * u/U commands to go up and down the history stack
2748 * history stack may be saved with viminfo with it's
2749 "!" option
2750 * bugfixes associated with unwanted [No Files]
2751 entries
2752 v50: * directories now displayed using buftype=nofile;
2753 should keep the directory names as-is
2754 * attempts to remove empty "[No File]" buffers
2755 leftover from :file ..name.. commands
2756 * bugfix: a "caps-lock" editing difficulty left in
2757 v49 was fixed
2758 * syntax highlighting for "Showing:" the hiding list
2759 included
2760 * bookmarks can now be retained if "!" is in the
2761 viminfo option
2762 v49: * will use ftp for http://.../ browsing
2763 v48: * One may use ftp to do remote host file browsing
2764 * (windows and !cygwin) remote browsing with ftp can
2765 now use the "dir" command internally to provide
2766 listings
2767 * g:netrw_keepdir now allows one to keep the initial
2768 current directory as the current directory
2769 (normally the local file browser makes the
2770 currently viewed directory the current directory)
2771 * g:netrw_alto and g:netrw_altv now support
2772 alternate placement of windows started with o or v
2773 * Nread ? and Nwrite ? now uses echomsg (instead of
2774 echo) so :messages can repeat showing the help
2775 * bugfix: avoids problems with partial matches of
2776 directory names to prior buffers with longer names
2777 * one can suppress error messages with g:netrw_quiet
2778 ctrl-h used
2779 * instead of <Leader>h for editing hiding list one
2780 may edit the sorting sequence with the S map, which
2781 now allows confirmation of deletion with
2782 [y(es) n(o) a(ll) q(uit)]
2783 * the "x" map now handles special file viewing with:
2784 (windows) rundll32 url.dll (gnome) gnome-open (kde)
2785 kfmclient If none of these are on the executable
2786 path, then netrwFileHandlers.vim is used.
2787 * directory bookmarking during both local and remote
2788 browsing implemented
2789 * one may view all, use the hiding list to suppress,
2790 or use the hiding list to show-only remote and
2791 local file/directory listings
2792 * improved unusual file and directory name handling
2793 preview window support
2794 v47: * now handles local browsing.
2795 v46: * now handles remote browsing
2796 * g:netrw_silent (if 1) will cause all transfers to
2797 be silent
2798 v45: * made the [user@]hostname:path form a bit more
2799 restrictive to better handle errors in using
2800 protocols (e.g. scp:usr@host:file was being
2801 recognized as an rcp request)
2802 v44: * changed from "rsync -a" to just "rsync"
2803 * somehow an editing error messed up the test to
2804 recognize use of the fetch method for NetRead.
2805 * more debugging statements included
2806 v43: * moved "Explanation" comments to <pi_netrw.txt> help
2807 file as "Network Reference" (|netrw-ref|)
2808 * <netrw.vim> now uses Dfunc() Decho() and Dret() for
2809 debugging
2810 * removed superfluous NetRestorePosn() calls
2811 v42: * now does BufReadPre and BufReadPost events on
2812 file:///* and file://localhost/*
2813 v41: * installed file:///* and file://localhost/* handling
2814 v40: * prevents redraw when a protocol error occurs so
2815 that the user may see it
2816 v39: * sftp support
2817 v38: * Now uses NetRestorePosn() calls with Nread/Nwrite
2818 commands
2819 * Temporary files now removed via bwipe! instead of
2820 bwipe (thanks to Dave Roberts)
2821 v37: * Claar's modifications which test if ftp is
2822 successful, otherwise give an error message
2823 * After a read, the alternate file was pointing to
2824 the temp file. The temp file buffer is now wiped
2825 out.
2826 * removed silent from transfer methods so user can
2827 see what's happening
2830 ==============================================================================
2831 12. Credits *netrw-credits* {{{1
2833 Vim editor by Bram Moolenaar (Thanks, Bram!)
2834 dav support by C Campbell
2835 fetch support by Bram Moolenaar and C Campbell
2836 ftp support by C Campbell <NdrOchip@ScampbellPfamily.AbizM>
2837 http support by Bram Moolenaar <bram@moolenaar.net>
2838 rcp
2839 rsync support by C Campbell (suggested by Erik Warendorph)
2840 scp support by raf <raf@comdyn.com.au>
2841 sftp support by C Campbell
2843 inputsecret(), BufReadCmd, BufWriteCmd contributed by C Campbell
2845 Jérôme Augé -- also using new buffer method with ftp+.netrc
2846 Bram Moolenaar -- obviously vim itself, :e and v:cmdarg use,
2847 fetch,...
2848 Yasuhiro Matsumoto -- pointing out undo+0r problem and a solution
2849 Erik Warendorph -- for several suggestions (g:netrw_..._cmd
2850 variables, rsync etc)
2851 Doug Claar -- modifications to test for success with ftp
2852 operation
2854 ==============================================================================
2855 Modelines: {{{1
2856 vim:tw=78:ts=8:ft=help:norl:fdm=marker