blob: 23c634e028103694296cb6d62986e96805863f2c [file] [log] [blame]
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001*pi_netrw.txt* For Vim version 7.0. Last change: Mar 21, 2006
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3 VIM REFERENCE MANUAL by Charles E. Campbell, Jr.
4
Bram Moolenaar1afcace2005-11-25 19:54:28 +00005
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006*dav* *http* *network* *rcp* *scp*
7*fetch* *netrw* *Nread* *rsync* *sftp*
8*ftp* *netrw.vim* *Nwrite* *netrw-file*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009
10==============================================================================
110. Contents *netrw-contents*
12
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000131. Starting With Netrw..................................|netrw-start|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000142. Netrw Reference......................................|netrw-ref|
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +000015 CONTROLLING EXTERNAL APPLICATIONS..................|netrw-externapp|
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +000016 READING............................................|netrw-read|
17 WRITING............................................|netrw-write|
18 DIRECTORY LISTING..................................|netrw-dirlist|
19 CHANGING THE USERID AND PASSWORD...................|netrw-chgup|
20 VARIABLES..........................................|netrw-variables|
21 PATHS..............................................|netrw-path|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000223. Network-Oriented File Transfer.......................|netrw-xfer|
Bram Moolenaar83bab712005-08-01 21:58:57 +000023 NETRC..............................................|netrw-netrc|
24 PASSWORD...........................................|netrw-passwd|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000254. Activation...........................................|netrw-activate|
265. Transparent File Transfer............................|netrw-transparent|
276. Ex Commands..........................................|netrw-ex|
287. Variables and Options................................|netrw-var|
298. Directory Browsing...................................|netrw-browse| {{{1
Bram Moolenaar83bab712005-08-01 21:58:57 +000030 Maps...............................................|netrw-maps|
31 Exploring..........................................|netrw-explore-cmds|
32 Quick Reference Commands Table.....................|netrw-browse-cmds|
33 Netrw Browser Variables............................|netrw-browse-var|
34 Introduction To Directory Browsing.................|netrw-browse-intro|
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +000035 Netrw Browsing And Option Incompatibilities........|netrw-incompatible|
Bram Moolenaar83bab712005-08-01 21:58:57 +000036 Directory Exploring Commands.......................|netrw-explore|
37 Refreshing The Listing.............................|netrw-ctrl-l|
38 Going Up...........................................|netrw--|
39 Browsing...........................................|netrw-cr|
Bram Moolenaar578b49e2005-09-10 19:22:57 +000040 Obtaining A File...................................|netrw-O|
41 Thin, Long, and Wide Listings......................|netrw-i|
Bram Moolenaar83bab712005-08-01 21:58:57 +000042 Making A New Directory.............................|netrw-d|
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +000043 Deleting Files Or Directories......................|netrw-D|
Bram Moolenaar83bab712005-08-01 21:58:57 +000044 Renaming Files Or Directories......................|netrw-move|
Bram Moolenaar482aaeb2005-09-29 18:26:07 +000045 Hiding Files Or Directories........................|netrw-a|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +000046 Edit File Or Directory Hiding List.................|netrw-ctrl-h|
Bram Moolenaar83bab712005-08-01 21:58:57 +000047 Browsing With A Horizontally Split Window..........|netrw-o|
48 Preview Window.....................................|netrw-p|
49 Selecting Sorting Style............................|netrw-s|
50 Editing The Sorting Sequence.......................|netrw-S|
51 Reversing Sorting Order............................|netrw-r|
52 Changing To A Predecessor Directory................|netrw-u|
53 Changing To A Successor Directory..................|netrw-U|
54 Browsing With A Vertically Split Window............|netrw-v|
55 Customizing Browsing With A User Function..........|netrw-x|
56 Making The Browsing Directory The Current Directory|netrw-c|
Bram Moolenaar578b49e2005-09-10 19:22:57 +000057 Bookmarking A Directory............................|netrw-b| |netrw-Nb|
58 Changing To A Bookmarked Directory.................|netrw-B| |netrw-NB|
Bram Moolenaar83bab712005-08-01 21:58:57 +000059 Listing Bookmarks And History......................|netrw-q|
Bram Moolenaar578b49e2005-09-10 19:22:57 +000060 Improving Directory Browsing.......................|netrw-listhack| }}}1
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000619. Problems and Fixes...................................|netrw-problems|
6210. Debugging............................................|netrw-debug|
6311. History..............................................|netrw-history|
6412. Credits..............................................|netrw-credits|
Bram Moolenaar071d4272004-06-13 20:20:40 +000065
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +000066The Netrw plugin is generally sourced automatically as it is a
67|standard-plugin|. That said, to make use of netrw, one must
68have plugins available which can be done with the following
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +000069two lines in your <.vimrc>: >
Bram Moolenaar071d4272004-06-13 20:20:40 +000070
Bram Moolenaar69a7cb42004-06-20 12:51:53 +000071 set nocp " 'compatible' is not set
72 filetype plugin on " plugins are enabled
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +000073<
Bram Moolenaar071d4272004-06-13 20:20:40 +000074You can avoid loading this plugin by setting the "loaded_netrw" variable
75in your <.vimrc> file: >
76
77 :let loaded_netrw = 1
78
79{Vi does not have any of this}
80
81==============================================================================
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000821. Starting With Netrw *netrw-start*
83
84Netrw makes reading, writing, and browsing over a network connection easy!
85First, make sure that you have plugins enabled, so you'll need to have at
86least the following in your <.vimrc>: (or see |netrw-activate|) >
87
88 set nocp " 'compatible' is not set
89 filetype plugin on " plugins are enabled
90<
91(see |'cp'| and |:filetype-plugin-on|)
92
93Netrw supports "transparent" editing of files on other machines using urls
94(see |netrw-transparent|). As an example of this, let's assume you have an
95account on some other machine; try >
96
97 vim scp://hostname/path/to/file
98<
99if you have an ssh connection. Want to make ssh/scp easier to use? Check
100out |netrw-listhack|!
101
102What if you have ftp, not ssh/scp? That's easy, too; try >
103
104 vim ftp://hostname/path/to/file
105<
106Want 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
108permissions for only the user to read (ie. not group, world, other, etc),
109and has lines resembling >
110
111 machine HOSTNAME login USERID password "PASSWORD"
112 machine HOSTNAME login USERID password "PASSWORD"
113 ...
114 default login USERID password "PASSWORD"
115<
116How about browsing -- ie. you just want to look around before editing a
117file. For browsing on your current host, just "edit" a directory: >
118
119 vim .
120 vim /home/userid/path
121<
122For browsing on a remote host, "edit" a directory (but make sure that
123the directory name is followed by a "/"): >
124
125 vim scp://hostname/
126 vim ftp://hostname/path/to/dir/
127<
128See |netrw-browse| for more!
129
130There's more protocols supported than scp and ftp, too: see the next
131section, |netrw-externapp|.
132
133==============================================================================
1342. Netrw Reference *netrw-ref*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000136CONTROLLING EXTERNAL APPLICATIONS *netrw-externapp*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000137
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000138 Protocol Variable Default Value
139 -------- ---------------- -------------
140 dav: *g:netrw_dav_cmd* = "cadaver"
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000141 fetch: *g:netrw_fetch_cmd* = "fetch -o" if fetch is available
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000142 ftp: *g:netrw_ftp_cmd* = "ftp"
143 http: *g:netrw_http_cmd* = "fetch -o" if fetch is available
144 http: g:netrw_http_cmd = "wget -q -O" If wget is available
145 rcp: *g:netrw_rcp_cmd* = "rcp"
146 rsync: *g:netrw_rsync_cmd* = "rsync -a"
147 scp: *g:netrw_scp_cmd* = "scp -q"
148 sftp: *g:netrw_sftp_cmd* = "sftp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000150READING *netrw-read* *netrw-nread*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151 :Nread ? give help
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000152 :Nread "machine:path" uses rcp
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000153 :Nread "machine path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000154 :Nread "machine id password path" uses ftp
155 :Nread "dav://machine[:port]/path" uses cadaver
156 :Nread "fetch://[user@]machine/path" uses fetch
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000157 :Nread "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000158 :Nread "http://[user@]machine/path" uses http uses wget
159 :Nread "rcp://[user@]machine/path" uses rcp
160 :Nread "rsync://[user@]machine[:port]/path" uses rsync
161 :Nread "scp://[user@]machine[[:#]port]/path" uses scp
162 :Nread "sftp://[user@]machine/path" uses sftp
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000164WRITING *netrw-write* *netrw-nwrite*
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000165 :Nwrite ? give help
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000166 :Nwrite "machine:path" uses rcp
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000167 :Nwrite "machine path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000168 :Nwrite "machine id password path" uses ftp
169 :Nwrite "dav://machine[:port]/path" uses cadaver
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000170 :Nwrite "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000171 :Nwrite "rcp://[user@]machine/path" uses rcp
172 :Nwrite "rsync://[user@]machine[:port]/path" uses rsync
173 :Nwrite "scp://[user@]machine[[:#]port]/path" uses scp
174 :Nwrite "sftp://[user@]machine/path" uses sftp
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175 http: not supported!
176
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000177DIRECTORY LISTING *netrw-dirlist*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000178 :Nread [protocol]://[user]@hostname/path/
179
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000180 CHANGING USERID AND PASSWORD *netrw-chgup*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181 Attempts to use ftp will prompt you for a user-id and a password.
182 These will be saved in g:netrw_uid and g:netrw_passwd Subsequent uses
183 of ftp will re-use those. If you need to use a different user id
184 and/or password, you'll want to call NetUserPass() first.
185
186 :NetUserPass [uid [password]] -- prompts as needed
187 :call NetUserPass() -- prompts for uid and password
188 :call NetUserPass("uid") -- prompts for password
189 :call NetUserPass("uid","password") -- sets global uid and password
190
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000191VARIABLES *netrw-variables*
192 *b:netrw_lastfile* last file Network-read/written retained on a per-buffer
193 basis (supports plain :Nw )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000195 *s:netrw_line* during :Nw/NetWrite, holds current line number
196 *s:netrw_col* during :Nw/NetWrite, holds current column number
197 s:netrw_line and s:netrw_col are used to
198 restore the cursor position on writes
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000199
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000200 *g:netrw_ftp* if it doesn't exist, use default ftp
201 =0 use default ftp (uid password)
202 =1 use alternate ftp method (user uid password)
203 If you're having trouble with ftp, try changing the
204 value of this variable to see if the alternate ftp
205 method works for your setup.
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000206
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000207 *g:netrw_ftpmode* ="binary" (default)
208 ="ascii"
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000209
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000210 *g:netrw_ignorenetrc* =0 (default)
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000211 =1 If you have a <.netrc> file but it doesn't work and
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000212 you want it ignored, then set this variable as shown.
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000213
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000214 *g:netrw_uid* (ftp) user-id, retained on a per-session basis
215 *g:netrw_passwd* (ftp) password, retained on a per-session basis
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000216
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000217 *g:netrw_win95ftp* =1 if using Win95, will remove four trailing blank
218 lines that o/s's ftp "provides" on transfers
219 =0 force normal ftp behavior (no trailing line removal)
220
221 *g:netrw_cygwin* =1 assume scp under windows is from cygwin. Also
222 permits network browsing to use ls with time and
223 size sorting (default if windows)
224 =0 assume Windows' scp accepts windows-style paths
225 Network browsing uses dir instead of ls
226 This option is ignored if you're using unix
227
228 *g:netrw_use_nt_rcp* =0 don't use the rcp of WinNT, Win2000 and WinXP
229 =1 use WinNT's rcp in binary mode (default)
230
231PATHS *netrw-path*
232
233Paths to files are generally user-directory relative for most protocols.
234It is possible that some protocol will make paths relative to some
235associated directory, however.
236>
237 example: vim scp://user@host/somefile
238 example: vim scp://user@host/subdir1/subdir2/somefile
239<
240where "somefile" is the "user"'s home directory. If you wish to get a
241file using root-relative paths, use the full path:
242>
243 example: vim scp://user@host//somefile
244 example: vim scp://user@host//subdir1/subdir2/somefile
245<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246
247==============================================================================
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00002483. Network-Oriented File Transfer *netrw-xfer*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249
250Network-oriented file transfer under Vim is implemented by a VimL-based script
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000251(<netrw.vim>) using plugin techniques. It currently supports both reading and
252writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253dav/cadaver, rsync, or sftp.
254
255http is currently supported read-only via use of wget or fetch.
256
257<netrw.vim> is a standard plugin which acts as glue between Vim and the
258various file transfer programs. It uses autocommand events (BufReadCmd,
259FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. >
260
261 ex. vim ftp://hostname/path/to/file
262<
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000263The characters preceding the colon specify the protocol to use; in the
264example, its ftp. The <netrw.vim> script then formulates a command or a
265series of commands (typically ftp) which it issues to an external program
266(ftp, scp, etc) which does the actual file transfer/protocol. Files are read
267from/written to a temporary file (under Unix/Linux, /tmp/...) which the
268<netrw.vim> script will clean up.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000270 *netrw-putty* *netrw-pscp*
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000271One may modify any protocol's implementing external application by setting a
272variable (ex. scp uses the variable g:netrw_scp_cmd, which is defaulted to
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000273"scp -q"). As an example, consider using PuTTY: >
274 let g:netrw_scp_cmd= '"c:\Program Files\PuTTY\pscp.exe" -q -batch'
275<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276Ftp, an old protocol, seems to be blessed by numerous implementations.
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000277Unfortunately, some implementations are noisy (ie., add junk to the end of the
278file). Thus, concerned users may decide to write a NetReadFixup() function
279that will clean up after reading with their ftp. Some Unix systems (ie.,
280FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is
281not noisy and more convenient, actually, for <netrw.vim> to use.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282Consequently, if "fetch" is executable, it will be used to do reads for
283ftp://... (and http://...) . See |netrw-var| for more about this.
284
285For rcp, scp, sftp, and http, one may use network-oriented file transfers
Bram Moolenaar83bab712005-08-01 21:58:57 +0000286transparently; ie.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000287>
288 vim rcp://[user@]machine/path
289 vim scp://[user@]machine/path
290<
291If your ftp supports <.netrc>, then it too can be just as transparently used
292if the needed triad of machine name, user id, and password are present in
293that file. Your ftp must be able to use the <.netrc> file on its own, however.
294>
295 vim ftp://[user@]machine[[:#]portnumber]/path
296<
297However, ftp will often need to query the user for the userid and password.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000298The latter will be done "silently"; ie. asterisks will show up instead of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299the actually-typed-in password. Netrw will retain the userid and password
300for subsequent read/writes from the most recent transfer so subsequent
301transfers (read/write) to or from that machine will take place without
302additional prompting.
303
304 *netrw-urls*
305 +=================================+============================+============+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000306 | Reading | Writing | Uses |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 +=================================+============================+============+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000308 | DAV: | | |
309 | dav://host/path | | cadaver |
310 | :Nread dav://host/path | :Nwrite dav://host/path | cadaver |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 +---------------------------------+----------------------------+------------+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000312 | FETCH: | | |
313 | fetch://[user@]host/path | | |
314 | fetch://[user@]host:http/path | Not Available | fetch |
315 | :Nread fetch://[user@]host/path| | |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 +---------------------------------+----------------------------+------------+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000317 | FILE: | | |
318 | file:///* | file:///* | |
319 | file://localhost/* | file://localhost/* | |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 +---------------------------------+----------------------------+------------+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000321 | FTP: (*3) | (*3) | |
322 | ftp://[user@]host/path | ftp://[user@]host/path | ftp (*2) |
323 | :Nread ftp://host/path | :Nwrite ftp://host/path | ftp+.netrc |
324 | :Nread host path | :Nwrite host path | ftp+.netrc |
325 | :Nread host uid pass path | :Nwrite host uid pass path | ftp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 +---------------------------------+----------------------------+------------+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000327 | HTTP: wget is executable: (*4) | | |
328 | http://[user@]host/path | Not Available | wget |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329 +---------------------------------+----------------------------+------------+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000330 | HTTP: fetch is executable (*4) | | |
331 | http://[user@]host/path | Not Available | fetch |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332 +---------------------------------+----------------------------+------------+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000333 | RCP: | | |
334 | rcp://[user@]host/path | rcp://[user@]host/path | rcp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335 +---------------------------------+----------------------------+------------+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000336 | RSYNC: | | |
337 | rsync://[user@]host/path | rsync://[user@]host/path | rsync |
338 | :Nread rsync://host/path | :Nwrite rsync://host/path | rsync |
339 | :Nread rcp://host/path | :Nwrite rcp://host/path | rcp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000340 +---------------------------------+----------------------------+------------+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000341 | SCP: | | |
342 | scp://[user@]host/path | scp://[user@]host/path | scp |
343 | :Nread scp://host/path | :Nwrite scp://host/path | scp (*1) |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 +---------------------------------+----------------------------+------------+
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000345 | SFTP: | | |
346 | sftp://[user@]host/path | sftp://[user@]host/path | sftp |
347 | :Nread sftp://host/path | :Nwrite sftp://host/path | sftp (*1) |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348 +=================================+============================+============+
349
350 (*1) For an absolute path use scp://machine//path.
351
352 (*2) if <.netrc> is present, it is assumed that it will
353 work with your ftp client. Otherwise the script will
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000354 prompt for user-id and pasword.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000356 (*3) for ftp, "machine" may be machine#port or machine:port
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357 if a different port is needed than the standard ftp port
358
359 (*4) for http:..., if wget is available it will be used. Otherwise,
360 if fetch is available it will be used.
361
362Both the :Nread and the :Nwrite ex-commands can accept multiple filenames.
363
364
365NETRC *netrw-netrc*
366
367The typical syntax for lines in a <.netrc> file is given as shown below.
368Ftp under Unix usually support <.netrc>; Windows' ftp usually doesn't.
369>
370 machine {full machine name} login {user-id} password "{password}"
371 default login {user-id} password "{password}"
372
373Your ftp client must handle the use of <.netrc> on its own, but if the
374<.netrc> file exists, an ftp transfer will not ask for the user-id or
375password.
376
377 Note:
378 Since this file contains passwords, make very sure nobody else can
379 read this file! Most programs will refuse to use a .netrc that is
380 readable for others. Don't forget that the system administrator can
381 still read the file!
382
383
384PASSWORD *netrw-passwd*
385
386The script attempts to get passwords for ftp invisibly using |inputsecret()|,
387a built-in Vim function. See |netrw-uidpass| for how to change the password
388after one has set it.
389
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000390Unfortunately there doesn't appear to be a way for netrw to feed a password to
391scp. Thus every transfer via scp will require re-entry of the password.
392However, |netrw-listhack| can help with this problem.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393
394
395==============================================================================
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00003964. Activation *netrw-activate*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398Network-oriented file transfers are available by default whenever
399|'nocompatible'| mode is enabled. The <netrw.vim> file resides in your
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000400system's vim-plugin directory and is sourced automatically whenever you bring
401up vim. I suggest that, at a minimum, you have at least the following in your
402<.vimrc> customization file: >
403 set nocp
404 if version >= 600
405 filetype plugin indent on
406 endif
407<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408
409==============================================================================
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00004105. Transparent File Transfer *netrw-transparent*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411
412Transparent file transfers occur whenever a regular file read or write
413(invoked via an |:autocmd| for |BufReadCmd| or |BufWriteCmd| events) is made.
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000414Thus one may use files across networks just as simply as if they were local. >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415
416 vim ftp://[user@]machine/path
417 ...
418 :wq
419
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000420See |netrw-activate| for more on how to encourage your vim to use plugins
421such as netrw.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422
423==============================================================================
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00004246. Ex Commands *netrw-ex*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425
426The usual read/write commands are supported. There are also a couple of
427additional commands available.
428
429:[range]Nw Write the specified lines to the current
430 file as specified in b:netrw_lastfile.
431
432:[range]Nw {netfile} [{netfile}]...
433 Write the specified lines to the {netfile}.
434
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000435:Nread Read the specified lines into the current
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436 buffer from the file specified in
437 b:netrw_lastfile.
438
439:Nread {netfile} {netfile}...
440 Read the {netfile} after the current line.
441
Bram Moolenaar482aaeb2005-09-29 18:26:07 +0000442 *netrw-uidpass*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443:call NetUserPass()
444 If b:netrw_uid and b:netrw_passwd don't exist,
445 this function query the user for them.
446
447:call NetUserPass("userid")
448 This call will set the b:netrw_uid and, if
449 the password doesn't exist, will query the user for it.
450
451:call NetUserPass("userid","passwd")
452 This call will set both the b:netrw_uid and b:netrw_passwd.
453 The user-id and password are used by ftp transfers. One may
454 effectively remove the user-id and password by using ""
455 strings.
456
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000457:NetrwSettings This command is desribed in |netrw-settings| -- used to
458 display netrw settings and change netrw behavior
459
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460
461==============================================================================
Bram Moolenaar433f7c82006-03-21 21:29:36 +00004627. Variables and Options *netrw-options* *netrw-var*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463
464The script <netrw.vim> uses several variables which can affect <netrw.vim>'s
465behavior. These variables typically may be set in the user's <.vimrc> file:
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000466(also see |netrw-settings|) >
467
468 -------------
469 Netrw Options
470 -------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000471 Option Meaning
472 -------------- -----------------------------------------------
473<
474 b:netrw_col Holds current cursor position (during NetWrite)
475 g:netrw_cygwin =1 assume scp under windows is from cygwin
476 (default/windows)
477 =0 assume scp under windows accepts windows
478 style paths (default/else)
479 g:netrw_ftp =0 use default ftp (uid password)
480 g:netrw_ftpmode ="binary" (default)
481 ="ascii" (your choice)
482 g:netrw_ignorenetrc =1 (default)
483 if you have a <.netrc> file but you don't
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484 want it used, then set this variable. Its
485 mere existence is enough to cause <.netrc>
486 to be ignored.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000487 b:netrw_lastfile Holds latest method/machine/path.
488 b:netrw_line Holds current line number (during NetWrite)
489 g:netrw_passwd Holds current password for ftp.
490 g:netrw_silent =0 transfers done normally
491 =1 transfers done silently
492 g:netrw_uid Holds current user-id for ftp.
Bram Moolenaar482aaeb2005-09-29 18:26:07 +0000493 =1 use alternate ftp (user uid password)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000494 (see |netrw-options|)
495 g:netrw_use_nt_rcp =0 don't use WinNT/2K/XP's rcp (default)
496 =1 use WinNT/2K/XP's rcp, binary mode
497 g:netrw_win95ftp =0 use unix-style ftp even if win95/98/ME/etc
498 =1 use default method to do ftp >
499 -----------------------------------------------------------------------
500<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501The script will also make use of the following variables internally, albeit
502temporarily.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000503>
504 -------------------
505 Temporary Variables
506 -------------------
507 Variable Meaning
508 -------- ------------------------------------
509<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510 g:netrw_method Index indicating rcp/ftp+.netrc/ftp
511 g:netrw_machine Holds machine name parsed from input
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000512 g:netrw_fname Holds filename being accessed >
513 ------------------------------------------------------------
514<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515 *netrw-protocol*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000516
517Netrw supports a number of protocols. These protocols are invoked using the
518variables listed below, and may be modified by the user.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519>
520 ------------------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000521 Protocol Control Options
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522 ------------------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000523 Option Type Setting Meaning
524 --------- -------- -------------- ---------------------------
525<
526 netrw_ftp variable =doesn't exist userid set by "user userid"
527 =0 userid set by "user userid"
528 =1 userid set by "userid"
529 NetReadFixup function =doesn't exist no change
530 =exists Allows user to have files
531 read via ftp automatically
532 transformed however they wish
533 by NetReadFixup()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534 g:netrw_dav_cmd variable ="cadaver"
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000535 g:netrw_fetch_cmd variable ="fetch -o" if fetch is available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536 g:netrw_ftp_cmd variable ="ftp"
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000537 g:netrw_http_cmd variable ="fetch -o" if fetch is available
538 g:netrw_http_cmd variable ="wget -O" else if wget is available
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000539 g:netrw_list_cmd variable ="ssh HOSTNAME ls -Fa"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540 g:netrw_rcp_cmd variable ="rcp"
541 g:netrw_rsync_cmd variable ="rsync -a"
542 g:netrw_scp_cmd variable ="scp -q"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000543 g:netrw_sftp_cmd variable ="sftp" >
544 -------------------------------------------------------------------------
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545<
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000546 *netrw-ftp*
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000547The first two options (netrw_ftp and NetReadFixup) both help with certain
548ftp's that give trouble otherwise. In order to best understand how to use
549these options if ftp is giving you troubles, a bit of discussion follows on
550how netrw does ftp reads.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000552The g:netrw_..._cmd variables specify the external program to use handle the
553associated protocol (rcp, ftp, etc), plus any options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000555The g:netrw_list_cmd's HOSTNAME entry will be changed via substitution with
556whatever the current request is for a hostname.
557
558For ftp, netrw typically builds up lines of one of the following formats in a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559temporary file:
560>
561 IF g:netrw_ftp !exists or is not 1 IF g:netrw_ftp exists and is 1
562 ---------------------------------- ------------------------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000563<
564 open machine [port] open machine [port]
565 user userid password userid password
566 [g:netrw_ftpmode] password
567 get filename tempfile [g:netrw_ftpmode]
568 get filename tempfile >
569 ---------------------------------------------------------------------
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570<
571Netrw then executes the lines above by use of a filter:
572>
573 :%! {g:netrw_ftp_cmd} -i [-n]
574<
575
576where
577 g:netrw_ftp_cmd is usually "ftp",
578 -i tells ftp not to be interactive
579 -n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>)
580
581If <.netrc> exists it will be used to avoid having to query the user for
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000582userid and password. The transferred file is put into a temporary file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583The temporary file is then read into the main editing session window that
584requested it and the temporary file deleted.
585
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000586If your ftp doesn't accept the "user" command and immediately just demands a
587userid, then try putting "let netrw_ftp=1" in your <.vimrc>.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000589 *netrw-cadaver*
590To handle the SSL certificate dialog for untrusted servers, one may pull
591down the certificate and place it into /usr/ssl/cert.pem. This operation
592renders the server treatment as "trusted".
593
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000594 *netrw-fixup* *netreadfixup*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595If your ftp for whatever reason generates unwanted lines (such as AUTH
596messages) you may write a NetReadFixup(tmpfile) function:
597>
598 function! NetReadFixup(method,line1,line2)
599 " a:line1: first new line in current file
600 " a:line2: last new line in current file
601 if a:method == 1 "rcp
602 elseif a:method == 2 "ftp + <.netrc>
603 elseif a:method == 3 "ftp + machine,uid,password,filename
604 elseif a:method == 4 "scp
605 elseif a:method == 5 "http/wget
606 elseif a:method == 6 "dav/cadaver
607 elseif a:method == 7 "rsync
608 elseif a:method == 8 "fetch
609 elseif a:method == 9 "sftp
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000610 else " complain
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 endif
612 endfunction
613>
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000614The NetReadFixup() function will be called if it exists and thus allows you to
615customize your reading process. As a further example, <netrw.vim> contains
616just such a function to handle Windows 95 ftp. For whatever reason, Windows
61795's ftp dumps four blank lines at the end of a transfer, and so it is
618desirable to automate their removal. Here's some code taken from <netrw.vim>
619itself:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620>
621 if has("win95") && g:netrw_win95ftp
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000622 fun! NetReadFixup(method, line1, line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623 if method == 3 " ftp (no <.netrc>)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000624 let fourblanklines= line2 - 3
625 silent fourblanklines.",".line2."g/^\s*/d"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626 endif
627 endfunction
628 endif
629>
630
631==============================================================================
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006328. Directory Browsing *netrw-browse* *netrw-dir* *netrw-list* *netrw-help*
Bram Moolenaar83bab712005-08-01 21:58:57 +0000633
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000634MAPS *netrw-maps*
635 <F1>.............Help.......................................|netrw-help|
Bram Moolenaar83bab712005-08-01 21:58:57 +0000636 <cr>.............Browsing...................................|netrw-cr|
637 <del>............Deleting Files or Directories..............|netrw-delete|
638 -................Going Up...................................|netrw--|
639 a................Hiding Files or Directories................|netrw-a|
640 b................Bookmarking a Directory....................|netrw-b|
641 B................Changing to a Bookmarked Directory.........|netrw-B|
642 c................Make Browsing Directory The Current Dir....|netrw-c|
643 d................Make A New Directory.......................|netrw-d|
644 D................Deleting Files or Directories..............|netrw-D|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000645 <c-h>............Edit File/Directory Hiding List............|netrw-ctrl-h|
Bram Moolenaar83bab712005-08-01 21:58:57 +0000646 i................Long Listing...............................|netrw-i|
647 <c-l>............Refreshing the Listing.....................|netrw-ctrl-l|
648 o................Browsing with a Horizontal Split...........|netrw-o|
649 p................Preview Window.............................|netrw-p|
650 q................Listing Bookmarks and History..............|netrw-q|
651 r................Reversing Sorting Order....................|netrw-r|
652 R................Renaming Files or Directories..............|netrw-R|
653 s................Selecting Sorting Style....................|netrw-s|
654 S................Editing the Sorting Sequence...............|netrw-S|
655 u................Changing to a Predecessor Directory........|netrw-u|
656 U................Changing to a Successor Directory..........|netrw-U|
657 v................Browsing with a Vertical Split.............|netrw-v|
658 x................Customizing Browsing.......................|netrw-x|
659
660 COMMANDS *netrw-explore-cmds*
Bram Moolenaar488c6512005-08-11 20:09:58 +0000661 :Explore[!] [dir] Explore directory of current file........|netrw-explore|
662 :Sexplore[!] [dir] Split & Explore directory ...............|netrw-explore|
663 :Hexplore[!] [dir] Horizontal Split & Explore...............|netrw-explore|
664 :Vexplore[!] [dir] Vertical Split & Explore.................|netrw-explore|
665 :Pexplore[!] [dir] Vertical Split & Explore.................|netrw-explore|
666 :Nexplore[!] [dir] Vertical Split & Explore.................|netrw-explore|
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000667 :NetrwSettings.............................................|netrw-settings|
Bram Moolenaar269ec652004-07-29 08:43:53 +0000668
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000669QUICK REFERENCE COMMANDS TABLE *netrw-browse-cmds*
Bram Moolenaar843ee412004-06-30 16:16:41 +0000670>
Bram Moolenaar8299df92004-07-10 09:47:34 +0000671 ------- -----------
Bram Moolenaar843ee412004-06-30 16:16:41 +0000672 Command Explanation
673 ------- -----------
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000674< <F1> Causes Netrw to issue help
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000675 <cr> Netrw will enter the directory or read the file |netrw-cr|
676 <del> Netrw will attempt to remove the file/directory |netrw-del|
677 - Makes Netrw go up one directory |netrw--|
678 a Toggles between normal display, |netrw-a|
679 hiding (suppress display of files matching g:netrw_list_hide)
680 showing (display only files which match g:netrw_list_hide)
681 b bookmark current directory; use Nb if compact listing
682 in use |netrw-b|
683 B go to previous bookmarked directory; use Nb if compact
684 listing is in use |netrw-B|
685 c Make current browsing directory the current directory |netrw-c|
686 d Make a directory |netrw-d|
687 D Netrw will attempt to remove the file(s)/directory(ies) |netrw-D|
688 <c-h> Edit file hiding list |netrw-ctrl-h|
689 i Toggles between long and short listing |netrw-i|
690 <c-l> Causes Netrw to refresh the directory listing |netrw-ctrl-l|
691 Nb Same as b, but always available |netrw-Nb|
692 NB Same as B, but always available |netrw-NB|
Bram Moolenaar843ee412004-06-30 16:16:41 +0000693 o Enter the file/directory under the cursor in a new browser
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000694 window. A horizontal split is used. |netrw-o|
695 O Obtain a file specified by cursor |netrw-O|
696 p Preview the file |netrw-p|
697 P Browse in the previously used window |netrw-P|
698 r Reverse sorting order |netrw-r|
699 R Rename the designed file(s)/directory(ies) |netrw-R|
700 s Select sorting style: by name, time, or file size |netrw-s|
701 S Specify suffix priority for name-sorting |netrw-S|
702 u Change to recently-visited directory |netrw-u|
703 U Change to subsequently-visited directory |netrw-U|
Bram Moolenaar843ee412004-06-30 16:16:41 +0000704 v Enter the file/directory under the cursor in a new browser
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000705 window. A vertical split is used. |netrw-v|
706 x Apply a function to a file. (special browsers) |netrw-x|
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000707
Bram Moolenaar269ec652004-07-29 08:43:53 +0000708NETRW BROWSER VARIABLES *netrw-browse-var*
Bram Moolenaar843ee412004-06-30 16:16:41 +0000709>
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000710 --- -----------
711 Var Explanation
712 --- -----------
713< *g:netrw_alto* change from above splitting to below splitting
714 by setting this variable (see |netrw-o|)
715 default: =0
Bram Moolenaar83bab712005-08-01 21:58:57 +0000716
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000717 *g:netrw_altv* change from left splitting to right splitting
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000718 by setting this variable (see |netrw-v|)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000719 default: =0
Bram Moolenaar83bab712005-08-01 21:58:57 +0000720
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000721 *g:netrw_browse_split* when browsing, <cr> will open the file by:
722 =0: re-using the same window
723 =1: horizontally splitting the window first
724 =2: vertically splitting the window first
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000725
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000726 *g:netrw_browsex_viewer* specify user's preference for a viewer: >
727 "kfmclient exec"
728 "gnome-open"
729< If >
730 "-"
731< is used, then netrwFileHandler() will look for
732 a script/function to handle the given
733 extension. (see |netrw_filehandler|).
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000734
735 *g:netrw_fastbrowse* =0: slow speed browsing, never re-use
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000736 directory listings; always obtain
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000737 directory listings.
738 =1: medium speed browsing, re-use directory
739 listings only when remote browsing.
740 (default value)
741 =2: fast browsing, only obtains directory
742 listings when the directory hasn't been
743 seen before (or |netrw-ctrl-l| is used).
744 Fast browsing retains old directory listing
745 buffers so that they don't need to be
746 re-acquired. This feature is especially
747 important for remote browsing. However, if
748 a file is introduced or deleted into or from
749 such directories, the old directory buffer
750 becomes out-of-date. One may always refresh
751 such a directory listing with |netrw-ctrl-l|.
752 This option gives the choice of the trade-off
753 between accuracy and speed to the user.
754
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000755 *g:netrw_ftp_browse_reject* ftp can produce a number of errors and warnings
756 that can show up as "directories" and "files"
757 in the listing. This pattern is used to
758 remove such embedded messages. By default its
759 value is:
760 '^total\s\+\d\+$\|
761 ^Trying\s\+\d\+.*$\|
762 ^KERBEROS_V\d rejected\|
763 ^Security extensions not\|
764 No such file\|
765 : connect to address [0-9a-fA-F:]*
766 : No route to host$'
Bram Moolenaar83bab712005-08-01 21:58:57 +0000767
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000768 *g:netrw_ftp_list_cmd* options for passing along to ftp for directory
769 listing. Defaults:
770 unix or g:netrw_cygwin set: : "ls -lF"
771 otherwise "dir"
772
773 *g:netrw_hide* if true, the hiding list is used
774 default: =0
Bram Moolenaar83bab712005-08-01 21:58:57 +0000775
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000776 *g:netrw_keepdir* =1 (default) keep current directory immune from
777 the browsing directory.
778 =0 keep the current directory the same as the
779 browsing directory.
780 The current browsing directory is contained in
781 b:netrw_curdir
Bram Moolenaar83bab712005-08-01 21:58:57 +0000782
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000783 *g:netrw_list_cmd* command for listing remote directories
784 default: (if ssh is executable)
785 "ssh HOSTNAME ls -FLa"
Bram Moolenaar83bab712005-08-01 21:58:57 +0000786
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000787 *g:netrw_longlist* if =1, then long listing will be default
Bram Moolenaar83bab712005-08-01 21:58:57 +0000788
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000789 *g:netrw_list_hide* comma separated pattern list for hiding files
790 default: ""
Bram Moolenaar83bab712005-08-01 21:58:57 +0000791
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000792 *g:netrw_local_mkdir* command for making a local directory
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000793 default: "mkdir"
Bram Moolenaar83bab712005-08-01 21:58:57 +0000794
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000795 *g:netrw_local_rmdir* remove directory command (rmdir)
796 default: "rmdir"
Bram Moolenaar83bab712005-08-01 21:58:57 +0000797
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000798 *g:netrw_maxfilenamelen* =32 by default, selected so as to make long
799 listings fit on 80 column displays.
800 If your screen is wider, and you have file
801 or directory names longer than 32 bytes,
802 you may set this option to keep listings
803 columnar.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000804
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000805 *g:netrw_mkdir_cmd* command for making a remote directory
806 default: "ssh HOSTNAME mkdir"
Bram Moolenaar83bab712005-08-01 21:58:57 +0000807
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000808 *g:netrw_rm_cmd* command for removing files
809 default: "ssh HOSTNAME rm"
Bram Moolenaar83bab712005-08-01 21:58:57 +0000810
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000811 *g:netrw_rmdir_cmd* command for removing directories
812 default: "ssh HOSTNAME rmdir"
Bram Moolenaar83bab712005-08-01 21:58:57 +0000813
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000814 *g:netrw_rmf_cmd* command for removing softlinks
815 default: "ssh HOSTNAME rm -f"
Bram Moolenaar83bab712005-08-01 21:58:57 +0000816
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000817 *g:netrw_sort_by* sort by "name", "time", or "size"
818 default: "name"
Bram Moolenaar83bab712005-08-01 21:58:57 +0000819
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000820 *g:netrw_sort_direction* sorting direction: "normal" or "reverse"
821 default: "normal"
Bram Moolenaar83bab712005-08-01 21:58:57 +0000822
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000823 *g:netrw_sort_sequence* when sorting by name, first sort by the
824 comma-separated pattern sequence
825 default: '[\/]$,*,\.bak$,\.o$,\.h$,
826 \.info$,\.swp$,\.obj$'
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000827
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000828 *g:netrw_ssh_cmd* One may specify an executable command
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000829 to use instead of ssh for remote actions
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000830 such as listing, file removal, etc.
831 default: ssh
832
833 *g:netrw_ssh_browse_reject* ssh can sometimes produce unwanted lines,
834 messages, banners, and whatnot that one doesn't
835 want masquerading as "directories" and "files".
836 Use this pattern to remove such embedded
837 messages. By default its value is:
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000838 '^total\s\+\d\+$'
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000839
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000840 *g:netrw_timefmt* specify format string to strftime() (%c)
841 default: "%c"
Bram Moolenaar83bab712005-08-01 21:58:57 +0000842
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000843 *g:netrw_winsize* specify initial size of new o/v windows
844 default: ""
Bram Moolenaar83bab712005-08-01 21:58:57 +0000845
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000846 *g:DrChipTopLvlMenu* This variable specifies the top level
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000847 submenu name; by default, its "DrChip.".
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000848 If you wish to change this, do so in your
849 .vimrc. It affects all of my plugins which
850 have menus.
851
Bram Moolenaar83bab712005-08-01 21:58:57 +0000852INTRODUCTION TO DIRECTORY BROWSING *netrw-browse-intro*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000853
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000854Netrw supports the browsing of directories on the local system and on remote
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000855hosts, including listing files and directories, entering directories, editing
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000856files therein, deleting files/directories, making new directories, and moving
857(renaming) files and directories. The Netrw browser generally implements the
858previous explorer maps and commands for remote directories, although details
859(such as pertinent global variable names) necessarily differ.
860
861The Netrw remote file and directory browser handles two protocols: ssh and
862ftp. The protocol in the url, if it is ftp, will cause netrw to use ftp
863in its remote browsing. Any other protocol will be used for file transfers,
864but otherwise the ssh protocol will be used to do remote directory browsing.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000865
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000866To use Netrw's remote directory browser, simply attempt to read a "file" with a
Bram Moolenaar843ee412004-06-30 16:16:41 +0000867trailing slash and it will be interpreted as a request to list a directory:
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000868
869 vim [protocol]://[user@]hostname/path/
870
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000871For local directories, the trailing slash is not required.
872
873If you'd like to avoid entering the password in for remote directory listings
874with ssh or scp, see |netrw-listhack|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000875
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000876
877NETRW BROWSING AND OPTION INCOMPATIBILITIES *netrw-incompatible*
878
879Netrw will not work properly with >
880
881 :set acd
882 :set fo=...ta...
883<
884If either of these options are present when browsing is attempted, netrw
885will change them by using noacd and removing the ta suboptions from the
Bram Moolenaara94bc432006-03-10 21:42:59 +0000886|'formatoptions'|.
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000887
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000888 *netrw-explore* *netrw-pexplore*
889 *netrw-hexplore* *netrw-sexplore*
890DIRECTORY EXPLORING COMMANDS *netrw-nexplore* *netrw-vexplore*
Bram Moolenaar83bab712005-08-01 21:58:57 +0000891
Bram Moolenaar488c6512005-08-11 20:09:58 +0000892 :Explore[!] [dir]... Explore directory of current file *:Explore*
893 :Sexplore[!] [dir]... Split&Explore directory of current file *:Sexplore*
894 :Hexplore[!] [dir]... Horizontal Split & Explore *:Hexplore*
895 :Vexplore[!] [dir]... Vertical Split & Explore *:Vexplore*
Bram Moolenaar83bab712005-08-01 21:58:57 +0000896
Bram Moolenaar488c6512005-08-11 20:09:58 +0000897 Used with :Explore **/pattern :
898 :Nexplore............. go to next matching file *:Nexplore*
899 :Pexplore............. go to previous matching file *:Pexplore*
Bram Moolenaar83bab712005-08-01 21:58:57 +0000900
Bram Moolenaar488c6512005-08-11 20:09:58 +0000901:Explore will open the local-directory browser on the current file's
902 directory (or on directory [dir] if specified). The window will be
903 split only if the file has been modified, otherwise the browsing
904 window will take over that window. Normally the splitting is taken
905 horizontally.
906:Explore! is like :Explore, but will use vertical splitting.
907:Sexplore will always split the window before invoking the local-directory
908 browser. As with Explore, the splitting is normally done
909 horizontally.
910:Sexplore! [dir] is like :Sexplore, but the splitting will be done vertically.
911:Hexplore [dir] does an :Explore with |:belowright| horizontal splitting.
912:Hexplore! [dir] does an :Explore with |:aboveleft| horizontal splitting.
913:Vexplore [dir] does an :Explore with |:leftabove| vertical splitting.
914:Vexplore! [dir] does an :Explore with |:rightbelow| vertical splitting.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000915
Bram Moolenaar488c6512005-08-11 20:09:58 +0000916By default, these commands use the current file's directory. However, one
917may explicitly provide a directory (path) to use.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000918
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000919(Following needs v7.0 or later) *netrw-starstar*
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000920When Explore, Sexplore, Hexplore, or Vexplore are used with a **,
921such as:
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000922>
923 :Explore **/filename_pattern
924<
925netrw will attempt to find a (sub)directory which matches the filename
926pattern. Internally, it produces a list of files which match the pattern
927and their paths; to that extent it resembles the Unix operation:
928>
929 find $(pwd) -name "$1" -exec "echo" "{}" ";" 2> /dev/null
930<
931The directory display is updated to show the subdirectory containing a
932matching file. One may then proceed to the next (or previous) matching files'
933directories by using Nexplore or Pexplore, respectively. If your console or
934gui produces recognizable shift-up or shift-down sequences, then you'll likely
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000935find using shift-downarrow and shift-uparrow convenient. They're mapped by
936netrw:
Bram Moolenaar572cb562005-08-05 21:35:02 +0000937
938 <s-down> == Nexplore, and
939 <s-up> == Pexplore.
940
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000941As an example, consider
942>
Bram Moolenaar572cb562005-08-05 21:35:02 +0000943 :Explore **/*.c
944 :Nexplore
945 :Nexplore
946 :Pexplore
947<
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000948The status line will show, on the right hand side of the status line, a
949message like "Match 3 of 20".
950
Bram Moolenaar83bab712005-08-01 21:58:57 +0000951
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000952REFRESHING THE LISTING *netrw-ctrl-l*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000953
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000954To refresh either a local or remote directory listing, press ctrl-l (<c-l>) or
955hit the <cr> when atop the ./ directory entry in the listing. One may also
956refresh a local directory by using ":e .".
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000957
958
959GOING UP *netrw--*
960
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000961To go up a directory, press "-" or press the <cr> when atop the ../ directory
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000962entry in the listing.
963
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000964Netrw will use the command in |g:netrw_list_cmd| to perform the directory
965listing operation after changing HOSTNAME to the host specified by the
966user-provided url. By default netrw provides the command as:
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000967
Bram Moolenaar843ee412004-06-30 16:16:41 +0000968 ssh HOSTNAME ls -FLa
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000969
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000970where the HOSTNAME becomes the [user@]hostname as requested by the attempt to
971read. Naturally, the user may override this command with whatever is
972preferred. The NetList function which implements remote directory browsing
973expects that directories will be flagged by a trailing slash.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000974
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000975
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000976BROWSING *netrw-cr*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000977
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000978Browsing is simple: move the cursor onto a file or directory of interest.
Bram Moolenaar843ee412004-06-30 16:16:41 +0000979Hitting the <cr> (the return key) will select the file or directory.
980Directories will themselves be listed, and files will be opened using the
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000981protocol given in the original read request.
982
983 CAVEAT: There are three forms of listing (see |netrw-i|). Netrw assumes
984 that two or more spaces delimit filenames and directory names for the long
985 and wide listing formats. Thus, if your filename or directory name has two
986 or more spaces embedded in it, or any trailing spaces, then you'll need to
987 use the "thin" format to select it.
Bram Moolenaar843ee412004-06-30 16:16:41 +0000988
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000989The |g:netrw_browse_split| option, which is zero by default, may be used to
990cause the opening of files to be done in a new window. The splitting will
991be done horizontally if the option is one and vertically if the option is
992two.
993
Bram Moolenaar83bab712005-08-01 21:58:57 +0000994
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000995OBTAINING A FILE *netrw-O*
996
997When browsing a remote directory, one may obtain a file under the cursor (ie.
998get a copy on your local machine, but not edit it) by pressing the O key.
999Only ftp and scp are supported for this operation (but since these two are
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001000available for browsing, that shouldn't be a problem). The status bar
1001will then show, on its right hand side, a message like "Obtaining filename".
1002The statusline will be restored after the transfer is complete.
1003
1004Netrw can also "obtain" a file using the local browser. Netrw's display
1005of a directory is not necessarily the same as Vim's "current directory",
1006unless |g:netrw_keepdir| is set to 0 in the user's <.vimrc>. One may select
1007a file using the local browser (by putting the cursor on it) and pressing
1008"O" will then "obtain" the file; ie. copy it to Vim's current directory.
1009
1010Related topics:
1011 * To see what the current directory is, use |:pwd|
1012 * To make the currently browsed directory the current directory, see |netrw-c|
1013 * To automatically make the currently browsed directory the current
1014 directory, see |g:netrw_keepdir|.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001015
1016
1017THIN, LONG, AND WIDE LISTINGS *netrw-i*
1018
1019The "i" map cycles between the thin, long, and wide listing formats.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001020
Bram Moolenaar8299df92004-07-10 09:47:34 +00001021The short listing format gives just the files' and directories' names.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001022
Bram Moolenaar8299df92004-07-10 09:47:34 +00001023The long listing is either based on the "ls" command via ssh for remote
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001024directories or displays the filename, file size (in bytes), and the time and
1025date of last modification for local directories. With the long listing
1026format, netrw is not able to recognize filenames which have trailing spaces.
1027Use the thin listing format for such files.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001028
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001029The wide listing format has a multi-column display of the various files in the
1030netrw current directory, rather like the Unix "ls" presents. In this mode the
1031"b" and "B" maps are not available; instead, use Nb (|netrw-Nb|) and NB
1032(|netrw-NB|). The wide listing format uses two or more contiguous spaces to
1033delineate filenames; when using that format, netrw won't be able to recognize
1034or use filenames which have two or more contiguous spaces embedded in the name
1035or any trailing spaces. The thin listing format will, however, work with such
1036files.
Bram Moolenaar8299df92004-07-10 09:47:34 +00001037
1038
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001039MAKING A NEW DIRECTORY *netrw-d*
Bram Moolenaar8299df92004-07-10 09:47:34 +00001040
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001041With the "d" map one may make a new directory either remotely (which depends
1042on the global variable g:netrw_mkdir_cmd) or locally (which depends on the
1043global variable g:netrw_local_mkdir). Netrw will issue a request for the new
1044directory's name. A bare <CR> at that point will abort the making of the
Bram Moolenaar8299df92004-07-10 09:47:34 +00001045directory. Attempts to make a local directory that already exists (as either
1046a file or a directory) will be detected, reported on, and ignored.
1047
Bram Moolenaar83bab712005-08-01 21:58:57 +00001048
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001049DELETING FILES OR DIRECTORIES *netrw-delete* *netrw-D* *netrw-del*
Bram Moolenaar843ee412004-06-30 16:16:41 +00001050
1051Deleting/removing files and directories involves moving the cursor to the
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001052file/directory to be deleted and pressing "D". Directories must be empty
1053first before they can be successfully removed. If the directory is a softlink
1054to a directory, then netrw will make two requests to remove the directory
1055before succeeding. Netrw will ask for confirmation before doing the
1056removal(s). You may select a range of lines with the "V" command (visual
1057selection), and then pressing "D".
Bram Moolenaar843ee412004-06-30 16:16:41 +00001058
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001059The g:netrw_rm_cmd, g:netrw_rmf_cmd, and g:netrw_rmdir_cmd variables are used
1060to control the attempts to remove files and directories. The g:netrw_rm_cmd
1061is used with files, and its default value is:
Bram Moolenaar843ee412004-06-30 16:16:41 +00001062
1063 g:netrw_rm_cmd: ssh HOSTNAME rm
1064
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001065The g:netrw_rmdir_cmd variable is used to support the removal of directories.
1066Its default value is:
Bram Moolenaar843ee412004-06-30 16:16:41 +00001067
1068 g:netrw_rmdir_cmd: ssh HOSTNAME rmdir
1069
1070If removing a directory fails with g:netrw_rmdir_cmd, netrw then will attempt
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001071to remove it again using the g:netrw_rmf_cmd variable. Its default value is:
Bram Moolenaar843ee412004-06-30 16:16:41 +00001072
1073 g:netrw_rmf_cmd: ssh HOSTNAME rm -f
1074
Bram Moolenaar843ee412004-06-30 16:16:41 +00001075
Bram Moolenaar8299df92004-07-10 09:47:34 +00001076RENAMING FILES OR DIRECTORIES *netrw-move* *netrw-rename* *netrw-R*
Bram Moolenaar843ee412004-06-30 16:16:41 +00001077
1078Renaming/moving files and directories involves moving the cursor to the
1079file/directory to be moved (renamed) and pressing "R". You will then be
1080queried for where you want the file/directory to be moved. You may select a
1081range of lines with the "V" command (visual selection), and then pressing "R".
1082
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001083The g:netrw_rename_cmd variable is used to implement renaming. By default its
Bram Moolenaar843ee412004-06-30 16:16:41 +00001084value is:
1085
1086 ssh HOSTNAME mv
1087
Bram Moolenaar269ec652004-07-29 08:43:53 +00001088One may rename a block of files and directories by selecting them with
1089the V (|linewise-visual|).
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001090
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001091
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001092HIDING FILES OR DIRECTORIES *netrw-a*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001093
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001094Netrw's browsing facility allows one to use the hiding list in one of three
1095ways: ignore it, hide files which match, and show only those files which
1096match. The "a" map allows the user to cycle about these three ways.
Bram Moolenaar83bab712005-08-01 21:58:57 +00001097
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001098The g:netrw_list_hide variable holds a comma delimited list of patterns (ex.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001099\.obj) which specify the hiding list. (also see |netrw-ctrl-h|) To set the hiding
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001100list, use the <c-h> map. As an example, to hide files which begin with a ".",
1101one may use the <c-h> map to set the hiding list to '^\..*' (or one may put
1102let g:netrw_list_hide= '^\..*' in one's <.vimrc>). One may then use the "a"
1103key to show all files, hide matching files, or to show only the matching
1104files.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001105
1106
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001107EDIT FILE OR DIRECTORY HIDING LIST *netrw-ctrl-h* *netrw-edithide*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001108
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001109The "<ctrl-h>" map brings up a requestor allowing the user to change the
Bram Moolenaar269ec652004-07-29 08:43:53 +00001110file/directory hiding list. The hiding list consists of one or more patterns
1111delimited by commas. Files and/or directories satisfying these patterns will
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001112either be hidden (ie. not shown) or be the only ones displayed (see
1113|netrw-a|).
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001114
1115
Bram Moolenaar83bab712005-08-01 21:58:57 +00001116BROWSING WITH A HORIZONTALLY SPLIT WINDOW *netrw-o* *netrw-horiz*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001117
Bram Moolenaar269ec652004-07-29 08:43:53 +00001118Normally one enters a file or directory using the <cr>. However, the "o" map
1119allows one to open a new window to hold the new directory listing or file. A
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001120horizontal split is used. (for vertical splitting, see |netrw-v|)
1121
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001122Normally, the o key splits the window horizontally with the new window and
1123cursor at the top. To change to splitting the window horizontally with the
1124new window and cursor at the bottom, have
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001125
1126 let g:netrw_alto = 1
1127
1128in your <.vimrc>.
1129
Bram Moolenaar83bab712005-08-01 21:58:57 +00001130
1131PREVIEW WINDOW *netrw-p* *netrw-preview*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001132
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001133One may use a preview window (currently only for local browsing) by using the
1134"p" key when the cursor is atop the desired filename to be previewed.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001135
1136
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001137PREVIOUS WINDOW *netrw-P* *netrw-prvwin*
1138
Bram Moolenaara94bc432006-03-10 21:42:59 +00001139To edit a file or directory in the previously used window (see :he |CTRL-W_P|),
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001140press a "P". If there's only one window, then the one window will be
Bram Moolenaara94bc432006-03-10 21:42:59 +00001141horizontally split (above/below splitting is controlled by |g:netrw_alto|,
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001142and its initial size is controlled by |g:netrw_winsize|).
1143
1144If there's more than one window, the previous window will be re-used on
1145the selected file/directory. If the previous window's associated buffer
1146has been modified, and there's only one window with that buffer, then
1147the user will be asked if s/he wishes to save the buffer first (yes,
1148no, or cancel).
1149
1150
Bram Moolenaar83bab712005-08-01 21:58:57 +00001151SELECTING SORTING STYLE *netrw-s* *netrw-sort*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001152
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001153One may select the sorting style by name, time, or (file) size. The "s" map
1154allows one to circulate amongst the three choices; the directory listing will
1155automatically be refreshed to reflect the selected style.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001156
1157
Bram Moolenaar83bab712005-08-01 21:58:57 +00001158EDITING THE SORTING SEQUENCE *netrw-S* *netrw-sortsequence*
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001159
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001160When "Sorted by" is name, one may specify priority via the sorting sequence
1161(g:netrw_sort_sequence). The sorting sequence typically prioritizes the
1162name-listing by suffix, although any pattern will do. Patterns are delimited
1163by commas. The default sorting sequence is:
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001164>
Bram Moolenaar488c6512005-08-11 20:09:58 +00001165 [\/]$,*,\.bak$,\.o$,\.h$,\.info$,\.swp$,\.obj$
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001166<
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001167The lone * is where all filenames not covered by one of the other patterns
1168will end up. One may change the sorting sequence by modifying the
1169g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by
1170using the "S" map.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001171
1172
Bram Moolenaar83bab712005-08-01 21:58:57 +00001173REVERSING SORTING ORDER *netrw-r* *netrw-reverse*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001174
1175One may toggle between normal and reverse sorting order by pressing the
1176"r" key.
1177
1178
Bram Moolenaar83bab712005-08-01 21:58:57 +00001179CHANGING TO A PREDECESSOR DIRECTORY *netrw-u* *netrw-updir*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001180
1181Every time you change to a new directory (new for the current session),
1182netrw will save the directory in a recently-visited directory history
1183list (unless g:netrw_dirhistmax is zero; by default, its ten). With the
1184"u" map, one can change to an earlier directory (predecessor). To do
1185the opposite, see |netrw-U|.
1186
1187
Bram Moolenaar83bab712005-08-01 21:58:57 +00001188CHANGING TO A SUCCESSOR DIRECTORY *netrw-U* *netrw-downdir*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001189
1190With the "U" map, one can change to a later directory (successor).
1191This map is the opposite of the "u" map. (see |netrw-u|) Use the
1192q map to list both the bookmarks and history. (see |netrw-q|)
1193
1194
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001195BROWSING WITH A VERTICALLY SPLIT WINDOW *netrw-v*
1196
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001197Normally one enters a file or directory using the <cr>. However, the "v" map
1198allows one to open a new window to hold the new directory listing or file. A
1199vertical split is used. (for horizontal splitting, see |netrw-o|)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001200
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001201Normally, the v key splits the window vertically with the new window and
1202cursor at the left. To change to splitting the window vertically with the new
1203window and cursor at the right, have
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001204
1205 let g:netrw_altv = 1
1206
1207in your <.vimrc>.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001208
1209
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001210CUSTOMIZING BROWSING WITH A USER FUNCTION *netrw-x* *netrw-handler* *gx*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001211
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001212Certain files, such as html, gif, jpeg, (word/office) doc, etc, files, are
1213best seen with a special handler (ie. a tool provided with your computer).
1214Netrw allows one to invoke such special handlers by: >
1215
1216 * when Exploring, hit the "x" key
1217 * when editing, hit gx with the cursor atop the special filename
1218<
1219Netrw determines which special handler by the following method:
1220
1221 * if |g:netrw_browsex_viewer| exists, then it will be used to attempt to
1222 view files. Examples of useful settings (place into your <.vimrc>): >
1223
1224 :let g:netrw_browsex_viewer= "kfmclient exec"
1225< or >
1226 :let g:netrw_browsex_viewer= "gnome-open"
1227<
1228 If g:netrw_browsex_viewer == '-', then netrwFileHandler() will be
1229 invoked first (see |netrw_filehandler|).
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001230
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001231 * for Windows 32 or 64, the url and FileProtocolHandler dlls are used.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001232 * for Gnome (with gnome-open): gnome-open is used.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001233 * for KDE (with kfmclient): kfmclient is used.
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001234 * otherwise the netrwFileHandler plugin is used.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001235
1236The file's suffix is used by these various approaches to determine an
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001237appropriate application to use to "handle" these files. Such things as
1238OpenOffice (*.sfx), visualization (*.jpg, *.gif, etc), and PostScript (*.ps,
1239*.eps) can be handled.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001240
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001241 *netrw_filehandler*
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001242The netrwFileHandler applies a user-defined function to a file, based on its
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001243extension. Of course, the handler function must exist for it to be called!
1244>
1245 Ex. mypgm.html x ->
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001246 netrwFileHandler_html("scp://user@host/some/path/mypgm.html")
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001247<
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001248See the <plugin/netrwFileHandlers.vim> for an example of how to handle an html
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001249file with mozilla.
1250
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001251One may write custom netrwFileHandlers; please look at the >
1252
1253 plugin/netrwFileHandlers.vim
1254
1255script for examples. If its likely to be generally useful, please feel free
1256to forward a copy to me for future inclusion in the distribution.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001257
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001258
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001259MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY *netrw-c* *netrw-curdir*
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001260
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001261By default, g:netrw_keepdir is 1. This setting means that the current
1262directory will not track the browsing directory. However, setting
1263g:netrw_keepdir to 0 (say, in your <.vimrc>) will tell netrw to have the
1264currently browsed directory be the current directory.
1265
1266With the default setting for g:netrw_keepdir, in order to make the two
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001267directories the same, use the "c" map (just type c). That map will set the
1268current directory to the current browsing directory.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001269
1270
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001271BOOKMARKING A DIRECTORY *netrw-b* *netrw-bookmark* *netrw-bookmarks*
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001272 *netrw-Nb*
Bram Moolenaar572cb562005-08-05 21:35:02 +00001273One may easily "bookmark" a directory by using >
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001274
1275 {cnt}b
Bram Moolenaar572cb562005-08-05 21:35:02 +00001276<
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001277Any count may be used. One may use viminfo's "!" option to retain bookmarks
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001278between vim sessions. See |netrw-B| for how to return to a bookmark and
1279|netrw-q| for how to list them.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001280
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001281When wide listing is in use (see |netrw-i|), then the b map is not available;
1282instead, use {cnt}Nb.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001283
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001284
1285CHANGING TO A BOOKMARKED DIRECTORY *netrw-NB* *netrw-B*
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001286
1287To change directory back to a bookmarked directory, use
1288
1289 {cnt}B
1290
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001291Any count may be used to reference any of the bookmarks. See |netrw-b| on
1292how to bookmark a directory and |netrw-q| on how to list bookmarks.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001293
1294When wide listing is in use (see |netrw-i|), then the B map is not available;
1295instead, use {cnt}NB.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001296
1297
Bram Moolenaar83bab712005-08-01 21:58:57 +00001298LISTING BOOKMARKS AND HISTORY *netrw-q* *netrw-listbookmark*
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001299
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001300Pressing "q" will list the bookmarked directories and directory traversal
1301history (query). (see |netrw-b|, |netrw-B|, |netrw-u|, and |netrw-U|)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001302
1303
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001304IMPROVING DIRECTORY BROWSING *netrw-listhack*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001305
1306Especially with the remote directory browser, constantly entering the password
1307is tedious.
1308
Bram Moolenaar843ee412004-06-30 16:16:41 +00001309For Linux/Unix systems, I suggest looking into
1310
1311 http://hacks.oreilly.com/pub/h/66
1312
1313It gives a tip for setting up password-less use of ssh and scp, and discusses
1314the associated security issues.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001315
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001316For Windows, the vim mailing list has mentioned that Pageant helps with
1317avoiding the constant need to enter the password.
1318
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001319
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001320NETRW SETTINGS *netrw-settings*
1321
1322With the NetrwSettings.vim plugin, >
1323 :NetrwSettings
1324will bring up a window with the many variables that netrw uses for its
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001325settings. You may change any of their values; when you save the file, the
1326settings therein will be used. One may also press "?" on any of the lines for
1327help on what each of the variables do.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001328
1329
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001330==============================================================================
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +000013319. Problems and Fixes *netrw-problems*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001332
1333 (This section is likely to grow as I get feedback)
1334 (also see |netrw-debug|)
Bram Moolenaar488c6512005-08-11 20:09:58 +00001335 *netrw-p1*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001336 P1. I use windows 95, and my ftp dumps four blank lines at the
1337 end of every read.
1338
1339 See |netrw-fixup|, and put the following into your
1340 <.vimrc> file:
1341
1342 let g:netrw_win95ftp= 1
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00001343
Bram Moolenaar488c6512005-08-11 20:09:58 +00001344 *netrw-p2*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001345 P2. I use windows, and my network browsing with ftp doesn't sort by
1346 time or size
1347
1348 Windows' ftp has a minimal support for ls (ie. it doesn't
1349 accept sorting options). It doesn't support the -F which
1350 gives an explanatory character (ABC/ for "ABC is a directory").
1351 Netrw uses dir to get its short and long listings. If you
1352 think your ftp does support a full-up ls, put the following
1353 into your <.vimrc>:
1354
1355 let g:netrw_ftp_list_cmd= "ls -lF"
1356
1357 Alternatively, if you have cygwin on your Windows box, put
1358 into your <.vimrc>:
1359
1360 let g:netrw_cygwin= 1
1361
Bram Moolenaar488c6512005-08-11 20:09:58 +00001362 *netrw-p3*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001363 P3. I tried rcp://user@host/ (or protocol other than ftp) and netrw
1364 used ssh! That wasn't what I asked for...
1365
1366 Netrw has two methods for browsing remote directories: ssh
1367 and ftp. Unless you specify ftp specifically, ssh is used.
1368 When it comes time to do download a file (not just a directory
1369 listing), netrw will use the given protocol to do so.
1370
Bram Moolenaar488c6512005-08-11 20:09:58 +00001371 *netrw-p4*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001372 P4. I would like long listings to be the default.
1373
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001374 let g:netrw_longlist=1
1375
1376 Check out |netrw-browse-var| for more customizations that
1377 you can set.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001378
Bram Moolenaar488c6512005-08-11 20:09:58 +00001379 *netrw-p5*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001380 P5. My times come up oddly in local browsing
1381
1382 Does your system's strftime() accept the "%c" to yield dates
1383 such as "Sun Apr 27 11:49:23 1997"? If not, do a "man strftime"
1384 and find out what option should be used. Then put it into
1385 your <.vimrc>:
1386 let g:netrw_timefmt= "%X" (where X is the option)
1387
Bram Moolenaar488c6512005-08-11 20:09:58 +00001388 *netrw-p6*
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001389 P6. I want my current directory to track my browsing.
1390 How do I do that?
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001391
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001392 let g:netrw_keepdir= 0
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00001393
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001394
1395==============================================================================
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000139610. Debugging *netrw-debug*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397
1398The <netrw.vim> script is typically available as:
Bram Moolenaar488c6512005-08-11 20:09:58 +00001399>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400 /usr/local/share/vim/vim6x/plugin/netrw.vim
Bram Moolenaar488c6512005-08-11 20:09:58 +00001401< -or- >
1402 /usr/local/share/vim/vim7x/plugin/netrw.vim
1403<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404which is loaded automatically at startup (assuming :set nocp).
1405
1406 1. Get the <Decho.vim> script, available as:
1407
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001408 http://mysite.verizon.net/astronaut/vim/index.html#vimlinks_scripts
1409 as "Decho, a vimL debugging aid"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 or
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001411 http://vim.sourceforge.net/scripts/script.php?script_id=120
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001413 and put it into your local plugin directory.
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00001414
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001415 2. <Decho.vim> itself needs the <cecutil.vim> script, so you'll need
1416 to put it into your .vim/plugin, too. You may obtain it from:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001418 http://mysite.verizon.net/astronaut/vim/index.html#VimFuncs
1419 as "DrC's Utilities"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001420
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001421 3. Edit the <netrw.vim> file by typing:
1422
1423 vim netrw.vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 :DechoOn
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001425 :wq
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001427 To restore to normal non-debugging behavior, edit <netrw.vim>
1428 by typing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001430 vim netrw.vim
1431 :DechoOff
1432 :wq
1433
1434 This command, provided by <Decho.vim>, will comment out all
1435 Decho-debugging statements (Dfunc(), Dret(), Decho(), Dredir()).
1436
1437 4. Then bring up vim and attempt a transfer. A set of messages
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 should appear concerning the steps that <netrw.vim> took in
1439 attempting to read/write your file over the network. Please
1440 send that information to <netrw.vim>'s maintainer,
1441
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001442 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443
1444==============================================================================
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000144511. History *netrw-history* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001447 v81: * FocusGained also used to refresh/wipe local browser directory
1448 buffers
1449 * (bugfix) netrw was leaving [Scratch] buffers behind when the
1450 the user had the "hidden" option set. The 'hidden' option is
1451 now bypassed.
1452 v80: * ShellCmdPost event used in conjunction with g:netrw_fastbrowse
1453 to refresh/wipe local browser directory buffers.
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +00001454 v79: * directories are now displayed with nowrap
1455 * (bugfix) if the column width was smaller than the largest
1456 file's name, then netrw would hang when using wide-listing
1457 mode - fixed
1458 * g:netrw_fastbrowse introduced
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001459 v78: * progress has been made on allowing spaces inside directory
1460 names for remote work (reading, writing, browsing). (scp)
1461 v77: * Mikolaj Machowski fixed a bug in a substitute command
1462 * g:netrw_browsex_viewer implemented
1463 * Mikolaj Machowski pointed out that gnome-open is often
1464 executable under KDE systems, although it is effectively
1465 not functional. NetBrowseX now looks for "kicker" as
1466 a running process to determine if KDE is actually the
1467 really running.
1468 * Explorer's O functionality was inadvertently left out.
1469 Netrw now does the same thing, but with the "P" key.
1470 * added g:netrw_browse_split option
1471 * fixed a bug where the directory contained a "." but
1472 the file didn't (was treating the dirname from "."
1473 onwards as a suffix)
Bram Moolenaar36c31f72005-11-28 23:01:53 +00001474 v76: * "directory is missing" error message now restores echo
1475 highlighting
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001476 v75: * file://... now conforms to RFC2396 (thanks to S. Zacchiroli)
1477 * if the binary option is set, then NetWrite() will only write
1478 the whole file (line numbers don't make sense with this).
1479 Supports writing of tar and zip files.
1480 v74: * bugfix (vim, then :Explore) now works
1481 * ctrl-L keeps cursor at same screen location (both local and
1482 remote browsing)
1483 * netrw now can read remote zip and tar files
1484 * Obtain now uses WinXP ftp+.netrc successfully
1485 v73: * bugfix -- scp://host/path/file was getting named incorrectly
1486 * netrw detects use of earlier-than-7.0 version of vim and issues
1487 a pertinent error message.
1488 * netrwSettings.vim is now uses autoloading. Only
1489 <netrwPlugin.vim> is needed as a pure plugin
1490 (ie. always loaded).
1491 v72: * bugfix -- formerly, one could prevent the loading of netrw
1492 by "let g:loaded_netrw=1"; when autoloading became supported,
1493 this feature was lost. It is now restored.
1494 v71: * bugfix -- made some "set nomodifiable"s into setlocal variants
1495 (allows :e somenewfile to be modifiable as usual)
1496 * NetrwSettings calls a netrw function, thereby assuring that
1497 netrw has loaded. However, if netrw does not load for whatever
1498 reason, then NetrwSettings will now issue a warning message.
1499 * For what reason I don't recall, when wget and fetch are both
1500 not present, and an attempt to read a http://... url is made,
1501 netrw exited. It now only returns.
1502 * When ch=1, on the second and subsequent uses of browsing Netrw
1503 would issue a blank line to clear the echo'd messages. This
1504 caused an annoying "Hit-Enter" prompt; now a blank line message
1505 is echo'd only if &ch>1.
1506 v70: * when using |netrw-O|, the "Obtaining filename" message is now
1507 shown using |hl-User9|. If User9 has not been defined, netrw
1508 will define it.
1509 v69: * Bugfix: win95/98 machines were experiencing a
1510 "E121: Undefined variable: g:netrw_win95ftp" message
1511 v68: * double-click-leftmouse selects word under mouse
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001512 v67: * Passwords which contain blanks will now be surrounded by
1513 double-quotes automatically (Yongwei)
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001514 v66: * Netrw now seems to work with a few more Windows situations
1515 * O now obtains a file: remote browsing file -> local copy,
1516 locally browsing file -> current directory (see :pwd)
1517 * i now cycles between thin, long, and wide listing styles
1518 * NB and Nb are maps that are always available; corresponding
1519 B and b maps are only available when not using wide listing
1520 in order to allow them to be used for motions
1521 v65: * Browser functions now use NetOptionSave/Restore; in particular,
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00001522 netrw now works around the report setting
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001523 v64: * Bugfix - browsing a "/" directory (Unix) yielded buffers
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00001524 named "[Scratch]" instead of "/"
1525 * Bugfix - remote browsing with ftp was omitting the ./ and ../
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001526 v63: * netrw now takes advantage of autoload (and requires 7.0)
1527 * Bugfix - using r (to reverse sort) working again
1528 v62: * Bugfix - spaces allowed again in directory names with
1529 g:netrw_keepdir=0. In fact, I've tested netrw (again)
1530 with most ANSI punctuation marks for directory names.
1531 * Bugfix - NetrwSettings gave errors when g:netrw_silent
1532 had not be set.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00001533 v61: * document upgrade -- netrw variable-based settings all should
1534 have tags. Supports NetrwSettings command.
1535 * several important variables are window-oriented. Netrw has
1536 to transfer these across a window split. See s:BufWinVars()
1537 and s:UseBufWinVars().
Bram Moolenaar488c6512005-08-11 20:09:58 +00001538 v60: * when using the i map to switch between long and short listings,
1539 netrw will now keep cursor on same line
1540 * "Match # of #" now uses status line
1541 * :Explore **/*.c will now work from a non-netrw-browser window
1542 * :Explore **/patterns can now be run in separate browser windows
1543 * active banner (hit <cr> will cause various things to happen)
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00001544 v59: * bugfix -- another keepalt work-around installed (for vim6.3)
1545 * "Match # of #" for Explore **/pattern matches
Bram Moolenaar572cb562005-08-05 21:35:02 +00001546 v58: * Explore and relatives can now handle **/somefilepattern (v7)
1547 * Nexplore and Pexplore introduced (v7). shift-down and shift-up
1548 cursor keys will invoke Nexplore and Pexplore, respectively.
1549 * bug fixed with o and v
1550 * autochdir only worked around for vim when it has been
1551 compiled with either |+netbeans_intg| or |+sun_workshop|
1552 * Under Windows, all directories and files were being preceded
1553 with a "/" when local browsing. Fixed.
1554 * When: syntax highlighting is off, laststatus=2, and remote
1555 browsing is used, sometimes the laststatus highlighting
1556 bleeds into the entire display. Work around - do an extra
1557 redraw in that case.
1558 * Bugfix: when g:netrw_keepdir=0, due to re-use of buffers,
1559 netrw didn't change the directory when it should've
1560 * Bugfix: D and R commands work again
Bram Moolenaar1d94f9b2005-08-04 21:29:45 +00001561 v57: * Explore and relatives can now handle RO files
1562 * reverse sort restored with vim7's sort command
1563 * g:netrw_keepdir now being used to keep the current directory
1564 unchanged as intended (sense change)
1565 * vim 6.3 still supported
Bram Moolenaar83bab712005-08-01 21:58:57 +00001566 v56: * LocalBrowse now saves autochdir setting, unsets it, and
1567 restores it before returning.
1568 * using vim's rename() instead of system + local_rename variable
Bram Moolenaar1d94f9b2005-08-04 21:29:45 +00001569 * avoids changing directory when g:netrw_keepdir is false
Bram Moolenaar83bab712005-08-01 21:58:57 +00001570 v55: * -bar used with :Explore :Sexplore etc to allow multiple
1571 commands to be separated by |s
1572 * browser listings now use the "nowrap" option
1573 * browser: some unuseful error messages now suppressed
1574 v54: * For backwards compatibility, Explore and Sexplore have been
1575 implemented. In addition, Hexplore and Vexplore commands
1576 are available, too.
1577 * <amatch> used instead of <afile> in the transparency
1578 support (BufReadCmd, FileReadCmd, FileWriteCmd)
1579 * ***netrw*** prepended to various error messages netrw may emit
1580 * g:netrw_port used instead of b:netrw_port for scp
1581 * any leading [:#] is removed from port numbers
1582 v53: * backslashes as well as slashes placed in various patterns
1583 (ex. g:netrw_sort_sequence) to better support Windows
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001584 v52: * nonumber'ing now set for browsing buffers
1585 * when the hiding list hid all files, error messages ensued. Fixed
1586 * when browsing, swf is set, but directory is not set, when netrw
1587 was attempting to restore options, vim wanted to save a swapfile
1588 to a local directory using an url-style path. Fixed
1589 v51: * cygwin detection now automated (using windows and &shell is bash)
1590 * customizable browser "file" rejection patterns
1591 * directory history
1592 * :[range]w url now supported (ie. netrw has a FileWriteCmd event)
1593 * error messages have a "Press <cr> to continue" to allow them
1594 to be seen
1595 * directory browser displays no longer bother the swapfile
1596 * u/U commands to go up and down the history stack
1597 * history stack may be saved with viminfo with its "!" option
1598 * bugfixes associated with unwanted [No Files] entries
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001599 v50: * directories now displayed using buftype=nofile; should keep the
1600 directory names as-is
1601 * attempts to remove empty "[No File]" buffers leftover
1602 from :file ..name.. commands
1603 * bugfix: a "caps-lock" editing difficulty left in v49 was fixed
1604 * syntax highlighting for "Showing:" the hiding list included
1605 * bookmarks can now be retained if "!" is in the viminfo option
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001606 v49: * will use ftp for http://.../ browsing v48:
1607 * One may use ftp to do remote host file browsing
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001608 * (windows and !cygwin) remote browsing with ftp can now use
1609 the "dir" command internally to provide listings
1610 * g:netrw_keepdir now allows one to keep the initial current
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001611 directory as the current directory (normally the local file
1612 browser makes the currently viewed directory the current
1613 directory)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001614 * g:netrw_alto and g:netrw_altv now support alternate placement
1615 of windows started with o or v
1616 * Nread ? and Nwrite ? now uses echomsg (instead of echo) so
1617 :messages can repeat showing the help
1618 * bugfix: avoids problems with partial matches of directory names
1619 to prior buffers with longer names
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001620 * one can suppress error messages with g:netrw_quiet ctrl-h used
1621 * instead of <Leader>h for editing hiding list one may edit the
1622 * sorting sequence with the S map now allows confirmation of
1623 * deletion with [y(es) n(o) a(ll) q(uit)] the "x" map now handles
1624 * special file viewing with:
1625 (windows) rundll32 url.dll (gnome) gnome-open (kde)
1626 kfmclient If none of these are on the executable path, then
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001627 netrwFileHandlers.vim is used.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001628 * directory bookmarking during both local and remote browsing
1629 implemented
1630 * one may view all, use the hiding list to suppress, or use the
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001631 hiding list to show-only remote and local file/directory
1632 listings
1633 * improved unusual file and directory name handling preview
1634 * window support
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001635 v47: * now handles local directory browsing.
1636 v46: * now handles remote directory browsing
1637 * g:netrw_silent (if 1) will cause all transfers to be silent
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001638 v45: * made the [user@]hostname:path form a bit more restrictive to
1639 better handle errors in using protocols (e.g. scp:usr@host:file
1640 was being recognized as an rcp request) v44: * changed from
1641 "rsync -a" to just "rsync"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001642 * somehow an editing error messed up the test to recognize
1643 use of the fetch method for NetRead.
1644 * more debugging statements included
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001645 v43: * moved "Explanation" comments to <pi_netrw.txt> help file as
1646 "Network Reference" (|netrw-ref|)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001647 * <netrw.vim> now uses Dfunc() Decho() and Dret() for debugging
1648 * removed superfluous NetRestorePosn() calls
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001649 v42: * now does BufReadPre and BufReadPost events on file:///* and
1650 file://localhost/* v41: * installed file:///* and
1651 file://localhost/* handling v40: * prevents redraw when a
1652 protocol error occurs so that the user may see it v39: * sftp
1653 support v38: * Now uses NetRestorePosn() calls with
1654 Nread/Nwrite commands
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001655 * Temporary files now removed via bwipe! instead of bwipe
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001656 (thanks to Dave Roberts) v37: * Claar's modifications which
1657 test if ftp is successful, otherwise give an error message
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001658 * After a read, the alternate file was pointing to the temp file.
1659 The temp file buffer is now wiped out.
1660 * removed silent from transfer methods so user can see what's
1661 happening
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662
1663
1664==============================================================================
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000166511. Credits *netrw-credits* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001666
1667 Vim editor by Bram Moolenaar (Thanks, Bram!)
1668 dav support by C Campbell
1669 fetch support by Bram Moolenaar and C Campbell
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001670 ftp support by C Campbell <NdrOchip@ScampbellPfamily.AbizM>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 http support by Bram Moolenaar <bram@moolenaar.net>
1672 rcp
1673 rsync support by C Campbell (suggested by Erik Warendorph)
1674 scp support by raf <raf@comdyn.com.au>
1675 sftp support by C Campbell
1676
1677 inputsecret(), BufReadCmd, BufWriteCmd contributed by C Campbell
1678
1679 Jérôme Augé -- also using new buffer method with ftp+.netrc
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001680 Bram Moolenaar -- obviously vim itself, :e and v:cmdarg use,
1681 fetch,...
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 Yasuhiro Matsumoto -- pointing out undo+0r problem and a solution
1683 Erik Warendorph -- for several suggestions (g:netrw_..._cmd
1684 variables, rsync etc)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001685 Doug Claar -- modifications to test for success with ftp
1686 operation
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687
1688==============================================================================
Bram Moolenaar83bab712005-08-01 21:58:57 +00001689 vim:tw=78:ts=8:ft=help:norl:fdm=marker