blob: ec6c139857addc710934ccf719aeb0ed679728b9 [file] [log] [blame]
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +02001*pi_netrw.txt* For Vim version 7.3c. Last change: 2010 Jul 27
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
Bram Moolenaar9964e462007-05-05 17:54:07 +00003 -----------------------------------------------------
4 NETRW REFERENCE MANUAL by Charles E. Campbell, Jr.
5 -----------------------------------------------------
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006Author: Charles E. Campbell, Jr. <NdrOchip@ScampbellPfamily.AbizM>
7 (remove NOSPAM from Campbell's email first)
8
Bram Moolenaar00a927d2010-05-14 23:24:24 +02009Copyright: Copyright (C) 1999-2010 Charles E Campbell, Jr *netrw-copyright*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010010 Permission is hereby granted to use and distribute this code, with
11 or without modifications, provided that this copyright notice is
12 copied with it. Like anything else that's free, netrw.vim,
13 netrwPlugin.vim, netrwFileHandlers.vim, netrwSettings.vim,
14 syntax/netrw.vim, and pi_netrw.txt are provided *as is* and comes
15 with no warranty of any kind, either expressed or implied. No
16 guarantees of merchantability. No guarantees of suitability for
17 any purpose. By using this plugin, you agree that in no event will
18 the copyright holder be liable for any damages resulting from the
19 use of this software.
Bram Moolenaar071d4272004-06-13 20:20:40 +000020
Bram Moolenaar1afcace2005-11-25 19:54:28 +000021
Bram Moolenaar00a927d2010-05-14 23:24:24 +020022 *dav* *ftp* *netrw-file* *rcp* *scp*
23 *davs* *http* *netrw.vim* *rsync* *sftp*
24 *fetch* *netrw* *network*
Bram Moolenaar071d4272004-06-13 20:20:40 +000025
26==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +0000271. Contents *netrw-contents* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar9964e462007-05-05 17:54:07 +0000291. Contents.............................................|netrw-contents|
302. Starting With Netrw..................................|netrw-start|
313. Netrw Reference......................................|netrw-ref|
Bram Moolenaar446cb832008-06-24 21:56:24 +000032 EXTERNAL APPLICATIONS AND PROTOCOLS................|netrw-externapp|
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +000033 READING............................................|netrw-read|
34 WRITING............................................|netrw-write|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010035 SOURCING...........................................|netrw-source|
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +000036 DIRECTORY LISTING..................................|netrw-dirlist|
37 CHANGING THE USERID AND PASSWORD...................|netrw-chgup|
Bram Moolenaar446cb832008-06-24 21:56:24 +000038 VARIABLES AND SETTINGS.............................|netrw-variables|
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +000039 PATHS..............................................|netrw-path|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000404. Network-Oriented File Transfer.......................|netrw-xfer|
Bram Moolenaar83bab712005-08-01 21:58:57 +000041 NETRC..............................................|netrw-netrc|
42 PASSWORD...........................................|netrw-passwd|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000435. Activation...........................................|netrw-activate|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000446. Transparent File Editing.............................|netrw-transparent|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000457. Ex Commands..........................................|netrw-ex|
468. Variables and Options................................|netrw-var|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000479. Browsing.............................................|netrw-browse|
48 Introduction To Browsing...........................|netrw-intro-browse|
49 Quick Reference: Maps..............................|netrw-browse-maps|
50 Quick Reference: Commands..........................|netrw-browse-cmds|
51 Bookmarking A Directory............................|netrw-mb|
Bram Moolenaar83bab712005-08-01 21:58:57 +000052 Browsing...........................................|netrw-cr|
Bram Moolenaar83bab712005-08-01 21:58:57 +000053 Browsing With A Horizontally Split Window..........|netrw-o|
Bram Moolenaar9964e462007-05-05 17:54:07 +000054 Browsing With A New Tab............................|netrw-t|
Bram Moolenaar446cb832008-06-24 21:56:24 +000055 Browsing With A Vertically Split Window............|netrw-v|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010056 Change Listing Style.(thin wide long tree).........|netrw-i|
Bram Moolenaar446cb832008-06-24 21:56:24 +000057 Changing To A Bookmarked Directory.................|netrw-gb|
Bram Moolenaar83bab712005-08-01 21:58:57 +000058 Changing To A Predecessor Directory................|netrw-u|
59 Changing To A Successor Directory..................|netrw-U|
Bram Moolenaar83bab712005-08-01 21:58:57 +000060 Customizing Browsing With A User Function..........|netrw-x|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010061 Deleting Bookmarks.................................|netrw-mB|
Bram Moolenaar446cb832008-06-24 21:56:24 +000062 Deleting Files Or Directories......................|netrw-D|
63 Directory Exploring Commands.......................|netrw-explore|
64 Exploring With Stars and Patterns..................|netrw-star|
65 Displaying Information About File..................|netrw-qf|
66 Edit File Or Directory Hiding List.................|netrw-ctrl-h|
67 Editing The Sorting Sequence.......................|netrw-S|
68 Going Up...........................................|netrw--|
69 Hiding Files Or Directories........................|netrw-a|
70 Improving Browsing.................................|netrw-ssh-hack|
71 Listing Bookmarks And History......................|netrw-qb|
72 Making A New Directory.............................|netrw-d|
Bram Moolenaar83bab712005-08-01 21:58:57 +000073 Making The Browsing Directory The Current Directory|netrw-c|
Bram Moolenaar446cb832008-06-24 21:56:24 +000074 Marking Files......................................|netrw-mf|
75 Marking Files By Regular Expression................|netrw-mr|
76 Marked Files: Arbitrary Command....................|netrw-mx|
77 Marked Files: Compression And Decompression........|netrw-mz|
78 Marked Files: Copying..............................|netrw-mc|
79 Marked Files: Diff.................................|netrw-md|
80 Marked Files: Editing..............................|netrw-me|
81 Marked Files: Grep.................................|netrw-mg|
82 Marked Files: Hiding and Unhiding by Suffix........|netrw-mh|
83 Marked Files: Moving...............................|netrw-mm|
84 Marked Files: Printing.............................|netrw-mp|
85 Marked Files: Sourcing.............................|netrw-ms|
86 Marked Files: Tagging..............................|netrw-mT|
87 Marked Files: Setting the Target Directory.........|netrw-mt|
88 Marked Files: Unmarking............................|netrw-mu|
89 Netrw Browser Variables............................|netrw-browser-var|
90 Netrw Browsing And Option Incompatibilities........|netrw-incompatible|
91 Netrw Settings.....................................|netrw-settings|
92 Obtaining A File...................................|netrw-O|
93 Preview Window.....................................|netrw-p|
94 Previous Window....................................|netrw-P|
95 Refreshing The Listing.............................|netrw-ctrl-l|
96 Renaming Files Or Directories......................|netrw-move|
97 Reversing Sorting Order............................|netrw-r|
98 Selecting Sorting Style............................|netrw-s|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010099 Setting Editing Window.............................|netrw-C|
Bram Moolenaar9964e462007-05-05 17:54:07 +000010010. Problems and Fixes...................................|netrw-problems|
Bram Moolenaar446cb832008-06-24 21:56:24 +000010111. Debugging Netrw Itself...............................|netrw-debug|
Bram Moolenaar9964e462007-05-05 17:54:07 +000010212. History..............................................|netrw-history|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010010313. Todo.................................................|netrw-todo|
10414. Credits..............................................|netrw-credits|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106{Vi does not have any of this}
107
108==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00001092. Starting With Netrw *netrw-start* {{{1
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000110
Bram Moolenaar446cb832008-06-24 21:56:24 +0000111Netrw makes reading files, writing files, browsing over a network, and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100112local browsing easy! First, make sure that you have plugins enabled, so
Bram Moolenaar446cb832008-06-24 21:56:24 +0000113you'll need to have at least the following in your <.vimrc>:
114(or see |netrw-activate|) >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000115
Bram Moolenaar9964e462007-05-05 17:54:07 +0000116 set nocp " 'compatible' is not set
117 filetype plugin on " plugins are enabled
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000118<
119(see |'cp'| and |:filetype-plugin-on|)
120
121Netrw supports "transparent" editing of files on other machines using urls
122(see |netrw-transparent|). As an example of this, let's assume you have an
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123account on some other machine; if you can use scp, try: >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000124
125 vim scp://hostname/path/to/file
126<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127Want to make ssh/scp easier to use? Check out |netrw-ssh-hack|!
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000128
Bram Moolenaar446cb832008-06-24 21:56:24 +0000129So, what if you have ftp, not ssh/scp? That's easy, too; try >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000130
131 vim ftp://hostname/path/to/file
132<
133Want to make ftp simpler to use? See if your ftp supports a file called
134<.netrc> -- typically it goes in your home directory, has read/write
135permissions for only the user to read (ie. not group, world, other, etc),
136and has lines resembling >
137
138 machine HOSTNAME login USERID password "PASSWORD"
139 machine HOSTNAME login USERID password "PASSWORD"
140 ...
Bram Moolenaar9964e462007-05-05 17:54:07 +0000141 default login USERID password "PASSWORD"
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000142<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000143Now about browsing -- when you just want to look around before editing a
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000144file. For browsing on your current host, just "edit" a directory: >
145
146 vim .
147 vim /home/userid/path
148<
149For browsing on a remote host, "edit" a directory (but make sure that
150the directory name is followed by a "/"): >
151
152 vim scp://hostname/
153 vim ftp://hostname/path/to/dir/
154<
155See |netrw-browse| for more!
156
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100157There are more protocols supported by netrw than just scp and ftp, too: see the
158next section, |netrw-externapp|, on how to use these external applications with
159netrw and vim.
160
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200161PREVENTING LOADING *netrw-noload*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000162
163If you want to use plugins, but for some reason don't wish to use netrw, then
164you need to avoid loading both the plugin and the autoload portions of netrw.
165You may do so by placing the following two lines in your <.vimrc>: >
166
167 :let g:loaded_netrw = 1
168 :let g:loaded_netrwPlugin = 1
169<
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000170
171==============================================================================
Bram Moolenaar00a927d2010-05-14 23:24:24 +02001723. Netrw Reference *netrw-ref* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100174 Netrw supports several protocols in addition to scp and ftp as mentioned
Bram Moolenaar446cb832008-06-24 21:56:24 +0000175 in |netrw-start|. These include dav, fetch, http,... well, just look
176 at the list in |netrw-externapp|. Each protocol is associated with a
177 variable which holds the default command supporting that protocol.
178
179EXTERNAL APPLICATIONS AND PROTOCOLS *netrw-externapp* {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000181 Protocol Variable Default Value
182 -------- ---------------- -------------
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100183 dav: *g:netrw_dav_cmd* = "cadaver" if cadaver is executable
184 dav: g:netrw_dav_cmd = "curl -o" elseif curl is available
185 fetch: *g:netrw_fetch_cmd* = "fetch -o" if fetch is available
186 ftp: *g:netrw_ftp_cmd* = "ftp"
187 http: *g:netrw_http_cmd* = "elinks" if elinks is available
188 http: g:netrw_http_cmd = "links" elseif links is available
189 http: g:netrw_http_cmd = "curl" elseif curl is available
190 http: g:netrw_http_cmd = "wget" elseif wget is available
191 http: g:netrw_http_cmd = "fetch" elseif fetch is available
192 rcp: *g:netrw_rcp_cmd* = "rcp"
193 rsync: *g:netrw_rsync_cmd* = "rsync -a"
194 scp: *g:netrw_scp_cmd* = "scp -q"
195 sftp: *g:netrw_sftp_cmd* = "sftp"
196
197 *g:netrw_http_xcmd* : the option string for http://... protocols are
198 specified via this variable and may be independently overridden. By
199 default, the option arguments for the http-handling commands are: >
200
201 elinks : "-source >"
202 links : "-source >"
203 curl : "-o"
204 wget : "-q -O"
205 fetch : "-o"
206<
207 For example, if your system has elinks, and you'd rather see the
208 page using an attempt at rendering the text, you may wish to have >
209 let g:netrw_http_xcmd= "-dump >"
210< in your .vimrc.
211
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212
Bram Moolenaar446cb832008-06-24 21:56:24 +0000213READING *netrw-read* *netrw-nread* {{{2
214
215 Generally, one may just use the url notation with a normal editing
216 command, such as >
217
218 :e ftp://[user@]machine/path
219<
220 Netrw also provides the Nread command:
221
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222 :Nread ? give help
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000223 :Nread "machine:path" uses rcp
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000224 :Nread "machine path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000225 :Nread "machine id password path" uses ftp
226 :Nread "dav://machine[:port]/path" uses cadaver
227 :Nread "fetch://[user@]machine/path" uses fetch
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000228 :Nread "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000229 :Nread "http://[user@]machine/path" uses http uses wget
230 :Nread "rcp://[user@]machine/path" uses rcp
231 :Nread "rsync://[user@]machine[:port]/path" uses rsync
232 :Nread "scp://[user@]machine[[:#]port]/path" uses scp
233 :Nread "sftp://[user@]machine/path" uses sftp
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234
Bram Moolenaar446cb832008-06-24 21:56:24 +0000235WRITING *netrw-write* *netrw-nwrite* {{{2
236
237 One may just use the url notation with a normal file writing
238 command, such as >
239
240 :w ftp://[user@]machine/path
241<
242 Netrw also provides the Nwrite command:
243
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000244 :Nwrite ? give help
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000245 :Nwrite "machine:path" uses rcp
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000246 :Nwrite "machine path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000247 :Nwrite "machine id password path" uses ftp
248 :Nwrite "dav://machine[:port]/path" uses cadaver
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000249 :Nwrite "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000250 :Nwrite "rcp://[user@]machine/path" uses rcp
251 :Nwrite "rsync://[user@]machine[:port]/path" uses rsync
252 :Nwrite "scp://[user@]machine[[:#]port]/path" uses scp
253 :Nwrite "sftp://[user@]machine/path" uses sftp
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254 http: not supported!
255
Bram Moolenaar446cb832008-06-24 21:56:24 +0000256SOURCING *netrw-source* {{{2
257
258 One may just use the url notation with the normal file sourcing
259 command, such as >
260
261 :so ftp://[user@]machine/path
262<
263 Netrw also provides the Nsource command:
264
Bram Moolenaar9964e462007-05-05 17:54:07 +0000265 :Nsource ? give help
266 :Nsource "dav://machine[:port]/path" uses cadaver
267 :Nsource "fetch://[user@]machine/path" uses fetch
268 :Nsource "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
269 :Nsource "http://[user@]machine/path" uses http uses wget
270 :Nsource "rcp://[user@]machine/path" uses rcp
271 :Nsource "rsync://[user@]machine[:port]/path" uses rsync
272 :Nsource "scp://[user@]machine[[:#]port]/path" uses scp
273 :Nsource "sftp://[user@]machine/path" uses sftp
274
Bram Moolenaar446cb832008-06-24 21:56:24 +0000275DIRECTORY LISTING *netrw-dirlist* {{{2
276
277 One may browse a directory to get a listing by simply attempting to
278 edit the directory: >
279
280 :e scp://[user]@hostname/path/
281 :e ftp://[user]@hostname/path/
282<
283 For remote directories (ie. those using scp or ftp), that trailing
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100284 "/" is necessary (the slash tells netrw to treat the argument as a
285 directory to browse instead of a file to download).
Bram Moolenaar446cb832008-06-24 21:56:24 +0000286
287 However, the Nread command can also be used to accomplish this:
288
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000289 :Nread [protocol]://[user]@hostname/path/
290
Bram Moolenaar446cb832008-06-24 21:56:24 +0000291 *netrw-login* *netrw-password*
292CHANGING USERID AND PASSWORD *netrw-chgup* *netrw-userpass* {{{2
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000293
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294 Attempts to use ftp will prompt you for a user-id and a password.
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000295 These will be saved in global variables g:netrw_uid and
Bram Moolenaar446cb832008-06-24 21:56:24 +0000296 s:netrw_passwd; subsequent uses of ftp will re-use those two items to
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000297 simplify the further use of ftp. However, if you need to use a
298 different user id and/or password, you'll want to call NetUserPass()
299 first. To work around the need to enter passwords, check if your ftp
300 supports a <.netrc> file in your home directory. Also see
301 |netrw-passwd| (and if you're using ssh/scp hoping to figure out how
Bram Moolenaar446cb832008-06-24 21:56:24 +0000302 to not need to use passwords, look at |netrw-ssh-hack|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303
304 :NetUserPass [uid [password]] -- prompts as needed
305 :call NetUserPass() -- prompts for uid and password
306 :call NetUserPass("uid") -- prompts for password
307 :call NetUserPass("uid","password") -- sets global uid and password
308
Bram Moolenaar446cb832008-06-24 21:56:24 +0000309NETRW VARIABLES AND SETTINGS *netrw-variables* {{{2
310(also see: |netrw-browser-var| |netrw-protocol| |netrw-settings| |netrw-var|)
Bram Moolenaar9964e462007-05-05 17:54:07 +0000311
Bram Moolenaar446cb832008-06-24 21:56:24 +0000312Netrw provides a lot of variables which allow you to customize netrw to your
313preferences. One way to look at them is via the command :NetrwSettings (see
314|netrw-settings|) which will display your current netrw settings. Most such
315settings are described below, in |netrw-browser-options|, and in
316|netrw-externapp|:
Bram Moolenaar9964e462007-05-05 17:54:07 +0000317
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100318 *b:netrw_lastfile* last file Network-read/written retained on a
319 per-buffer basis (supports plain :Nw )
320
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200321 *g:netrw_bufsettings* the settings that netrw buffers have
322 (default) noma nomod nonu nowrap ro nobl
323
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100324 *g:netrw_chgwin* specifies a window number where file edits will take
325 place. (also see |netrw-C|)
326 (default) not defined
327
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200328 *g:Netrw_funcref* specifies a function (or functions) to be called when
329 netrw edits a file. The file is first edited, and
330 then the function reference (|Funcref|) is called.
331 This variable may also hold a |List| of Funcrefs.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100332 (default) not defined
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200333>
334 Example: place in .vimrc; affects all file opening
335 fun! MyFuncRef()
336 endfun
337 let g:Netrw_funcref= function("MyFuncRef")
338<
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000339 *g:netrw_ftp* if it doesn't exist, use default ftp
340 =0 use default ftp (uid password)
341 =1 use alternate ftp method (user uid password)
342 If you're having trouble with ftp, try changing the
343 value of this variable to see if the alternate ftp
344 method works for your setup.
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000345
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100346 *g:netrw_ftpextracmd* default: doesn't exist
Bram Moolenaar9964e462007-05-05 17:54:07 +0000347 If this variable exists, then any string it contains
348 will be placed into the commands set to your ftp
349 client. As an example:
350 ="passive"
351
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000352 *g:netrw_ftpmode* ="binary" (default)
353 ="ascii"
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000354
Bram Moolenaar9964e462007-05-05 17:54:07 +0000355 *g:netrw_ignorenetrc* =0 (default for linux, cygwin)
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000356 =1 If you have a <.netrc> file but it doesn't work and
Bram Moolenaar446cb832008-06-24 21:56:24 +0000357 you want it ignored, then set this variable as
358 shown. (default for Windows + cmd.exe)
Bram Moolenaar9964e462007-05-05 17:54:07 +0000359
360 *g:netrw_menu* =0 disable netrw's menu
361 =1 (default) netrw's menu enabled
362
363 *g:netrw_nogx* if this variable exists, then the "gx" map will not
364 be available (see |netrw-gx|)
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000365
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100366 *g:netrw_uid* (ftp) user-id, retained on a per-vim-session basis
367 *s:netrw_passwd* (ftp) password, retained on a per-vim-session basis
Bram Moolenaar446cb832008-06-24 21:56:24 +0000368
369 *g:netrw_preview* =0 (default) preview window shown in a horizontally
370 split window
371 =1 preview window shown in a vertically split window.
372 Also affects the "previous window" (see |netrw-P|) in
373 the same way.
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000374
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000375 *g:netrw_scpport* = "-P" : option to use to set port for scp
376 *g:netrw_sshport* = "-p" : option to use to set port for ssh
377
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100378 *g:netrw_sepchr* =\0xff
379 =\0x01 for enc == euc-jp (and perhaps it should be for
380 others, too, please let me
381 know)
382 Separates priority codes from filenames internally.
383 See |netrw-p12|.
384
Bram Moolenaar446cb832008-06-24 21:56:24 +0000385 *g:netrw_silent* =0 : transfers done normally
386 =1 : transfers done silently
387
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000388 *g:netrw_use_errorwindow* =1 : messages from netrw will use a separate one
389 line window. This window provides reliable
390 delivery of messages. (default)
391 =0 : messages from netrw will use echoerr ;
392 messages don't always seem to show up this
393 way, but one doesn't have to quit the window.
394
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000395 *g:netrw_win95ftp* =1 if using Win95, will remove four trailing blank
396 lines that o/s's ftp "provides" on transfers
397 =0 force normal ftp behavior (no trailing line removal)
398
399 *g:netrw_cygwin* =1 assume scp under windows is from cygwin. Also
400 permits network browsing to use ls with time and
401 size sorting (default if windows)
402 =0 assume Windows' scp accepts windows-style paths
403 Network browsing uses dir instead of ls
404 This option is ignored if you're using unix
405
406 *g:netrw_use_nt_rcp* =0 don't use the rcp of WinNT, Win2000 and WinXP
Bram Moolenaar9964e462007-05-05 17:54:07 +0000407 =1 use WinNT's rcp in binary mode (default)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000408
Bram Moolenaar446cb832008-06-24 21:56:24 +0000409PATHS *netrw-path* {{{2
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000410
411Paths to files are generally user-directory relative for most protocols.
412It is possible that some protocol will make paths relative to some
413associated directory, however.
414>
415 example: vim scp://user@host/somefile
416 example: vim scp://user@host/subdir1/subdir2/somefile
417<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000418where "somefile" is in the "user"'s home directory. If you wish to get a
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000419file using root-relative paths, use the full path:
420>
421 example: vim scp://user@host//somefile
422 example: vim scp://user@host//subdir1/subdir2/somefile
423<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000424
425==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00004264. Network-Oriented File Transfer *netrw-xfer* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428Network-oriented file transfer under Vim is implemented by a VimL-based script
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000429(<netrw.vim>) using plugin techniques. It currently supports both reading and
430writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431dav/cadaver, rsync, or sftp.
432
433http is currently supported read-only via use of wget or fetch.
434
435<netrw.vim> is a standard plugin which acts as glue between Vim and the
436various file transfer programs. It uses autocommand events (BufReadCmd,
437FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. >
438
439 ex. vim ftp://hostname/path/to/file
440<
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000441The characters preceding the colon specify the protocol to use; in the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000442example, it's ftp. The <netrw.vim> script then formulates a command or a
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000443series of commands (typically ftp) which it issues to an external program
444(ftp, scp, etc) which does the actual file transfer/protocol. Files are read
445from/written to a temporary file (under Unix/Linux, /tmp/...) which the
446<netrw.vim> script will clean up.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000447
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100448Now, a word about Jan Minář's "FTP User Name and Password Disclosure"; first,
449ftp is not a secure protocol. User names and passwords are transmitted "in
450the clear" over the internet; any snooper tool can pick these up; this is not
451a netrw thing, this is a ftp thing. If you're concerned about this, please
452try to use scp or sftp instead.
453
454Netrw re-uses the user id and password during the same vim session and so long
455as the remote hostname remains the same.
456
457Jan seems to be a bit confused about how netrw handles ftp; normally multiple
458commands are performed in a "ftp session", and he seems to feel that the
459uid/password should only be retained over one ftp session. However, netrw
460does every ftp operation in a separate "ftp session"; so remembering the
461uid/password for just one "ftp session" would be the same as not remembering
462the uid/password at all. IMHO this would rapidly grow tiresome as one
463browsed remote directories, for example.
464
465On the other hand, thanks go to Jan M. for pointing out the many
466vulnerabilities that netrw (and vim itself) had had in handling "crafted"
467filenames. The |shellescape()| and |fnameescape()| functions were written in
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200468response by Bram Moolenaar to handle these sort of problems, and netrw has
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100469been modified to use them. Still, my advice is, if the "filename" looks like
470a vim command that you aren't comfortable with having executed, don't open it.
471
Bram Moolenaar9964e462007-05-05 17:54:07 +0000472 *netrw-putty* *netrw-pscp* *netrw-psftp*
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000473One may modify any protocol's implementing external application by setting a
474variable (ex. scp uses the variable g:netrw_scp_cmd, which is defaulted to
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000475"scp -q"). As an example, consider using PuTTY: >
Bram Moolenaar9964e462007-05-05 17:54:07 +0000476
477 let g:netrw_scp_cmd = '"c:\Program Files\PuTTY\pscp.exe" -q -batch'
478 let g:netrw_sftp_cmd= '"c:\Program Files\PuTTY\psftp.exe"'
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000479<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000480See |netrw-p8| for more about putty, pscp, psftp, etc.
481
Bram Moolenaar071d4272004-06-13 20:20:40 +0000482Ftp, an old protocol, seems to be blessed by numerous implementations.
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000483Unfortunately, some implementations are noisy (ie., add junk to the end of the
484file). Thus, concerned users may decide to write a NetReadFixup() function
485that will clean up after reading with their ftp. Some Unix systems (ie.,
486FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is
487not noisy and more convenient, actually, for <netrw.vim> to use.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100488Consequently, if "fetch" is available (ie. executable), it may be preferable
489to use it for ftp://... based transfers.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490
491For rcp, scp, sftp, and http, one may use network-oriented file transfers
Bram Moolenaar83bab712005-08-01 21:58:57 +0000492transparently; ie.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493>
494 vim rcp://[user@]machine/path
495 vim scp://[user@]machine/path
496<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100497If your ftp supports <.netrc>, then it too can be transparently used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498if the needed triad of machine name, user id, and password are present in
499that file. Your ftp must be able to use the <.netrc> file on its own, however.
500>
501 vim ftp://[user@]machine[[:#]portnumber]/path
502<
503However, ftp will often need to query the user for the userid and password.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000504The latter will be done "silently"; ie. asterisks will show up instead of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000505the actually-typed-in password. Netrw will retain the userid and password
506for subsequent read/writes from the most recent transfer so subsequent
507transfers (read/write) to or from that machine will take place without
508additional prompting.
509
510 *netrw-urls*
511 +=================================+============================+============+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000512 | Reading | Writing | Uses |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513 +=================================+============================+============+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000514 | DAV: | | |
515 | dav://host/path | | cadaver |
516 | :Nread dav://host/path | :Nwrite dav://host/path | cadaver |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517 +---------------------------------+----------------------------+------------+
Bram Moolenaar446cb832008-06-24 21:56:24 +0000518 | DAV + SSL: | | |
519 | davs://host/path | | cadaver |
520 | :Nread davs://host/path | :Nwrite davs://host/path | cadaver |
521 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000522 | FETCH: | | |
523 | fetch://[user@]host/path | | |
524 | fetch://[user@]host:http/path | Not Available | fetch |
525 | :Nread fetch://[user@]host/path| | |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000527 | FILE: | | |
528 | file:///* | file:///* | |
529 | file://localhost/* | file://localhost/* | |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000531 | FTP: (*3) | (*3) | |
532 | ftp://[user@]host/path | ftp://[user@]host/path | ftp (*2) |
533 | :Nread ftp://host/path | :Nwrite ftp://host/path | ftp+.netrc |
534 | :Nread host path | :Nwrite host path | ftp+.netrc |
535 | :Nread host uid pass path | :Nwrite host uid pass path | ftp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000537 | HTTP: wget is executable: (*4) | | |
538 | http://[user@]host/path | Not Available | wget |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000540 | HTTP: fetch is executable (*4) | | |
541 | http://[user@]host/path | Not Available | fetch |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000543 | RCP: | | |
544 | rcp://[user@]host/path | rcp://[user@]host/path | rcp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000546 | RSYNC: | | |
547 | rsync://[user@]host/path | rsync://[user@]host/path | rsync |
548 | :Nread rsync://host/path | :Nwrite rsync://host/path | rsync |
549 | :Nread rcp://host/path | :Nwrite rcp://host/path | rcp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000551 | SCP: | | |
552 | scp://[user@]host/path | scp://[user@]host/path | scp |
553 | :Nread scp://host/path | :Nwrite scp://host/path | scp (*1) |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000555 | SFTP: | | |
556 | sftp://[user@]host/path | sftp://[user@]host/path | sftp |
557 | :Nread sftp://host/path | :Nwrite sftp://host/path | sftp (*1) |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558 +=================================+============================+============+
559
560 (*1) For an absolute path use scp://machine//path.
561
562 (*2) if <.netrc> is present, it is assumed that it will
563 work with your ftp client. Otherwise the script will
Bram Moolenaar9964e462007-05-05 17:54:07 +0000564 prompt for user-id and password.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
Bram Moolenaar9964e462007-05-05 17:54:07 +0000566 (*3) for ftp, "machine" may be machine#port or machine:port
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 if a different port is needed than the standard ftp port
568
569 (*4) for http:..., if wget is available it will be used. Otherwise,
570 if fetch is available it will be used.
571
572Both the :Nread and the :Nwrite ex-commands can accept multiple filenames.
573
574
575NETRC *netrw-netrc*
576
Bram Moolenaar446cb832008-06-24 21:56:24 +0000577The <.netrc> file, typically located in your home directory, contains lines
578therein which map a hostname (machine name) to the user id and password you
579prefer to use with it.
580
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581The typical syntax for lines in a <.netrc> file is given as shown below.
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000582Ftp under Unix usually supports <.netrc>; ftp under Windows usually doesn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583>
584 machine {full machine name} login {user-id} password "{password}"
585 default login {user-id} password "{password}"
586
587Your ftp client must handle the use of <.netrc> on its own, but if the
588<.netrc> file exists, an ftp transfer will not ask for the user-id or
589password.
590
591 Note:
592 Since this file contains passwords, make very sure nobody else can
593 read this file! Most programs will refuse to use a .netrc that is
594 readable for others. Don't forget that the system administrator can
Bram Moolenaar446cb832008-06-24 21:56:24 +0000595 still read the file! Ie. for Linux/Unix: chmod 600 .netrc
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596
597
598PASSWORD *netrw-passwd*
599
600The script attempts to get passwords for ftp invisibly using |inputsecret()|,
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200601a built-in Vim function. See |netrw-uidpass| for how to change the password
Bram Moolenaar071d4272004-06-13 20:20:40 +0000602after one has set it.
603
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000604Unfortunately there doesn't appear to be a way for netrw to feed a password to
605scp. Thus every transfer via scp will require re-entry of the password.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000606However, |netrw-ssh-hack| can help with this problem.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607
608
609==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00006105. Activation *netrw-activate* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000612Network-oriented file transfers are available by default whenever Vim's
Bram Moolenaar446cb832008-06-24 21:56:24 +0000613|'nocompatible'| mode is enabled. Netrw's script files reside in your
614system's plugin, autoload, and syntax directories; just the
615plugin/netrwPlugin.vim script is sourced automatically whenever you bring up
616vim. The main script in autoload/netrw.vim is only loaded when you actually
617use netrw. I suggest that, at a minimum, you have at least the following in
618your <.vimrc> customization file: >
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000619
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000620 set nocp
621 if version >= 600
622 filetype plugin indent on
623 endif
624<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625
626==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00006276. Transparent File Editing *netrw-transparent* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628
629Transparent file transfers occur whenever a regular file read or write
Bram Moolenaar446cb832008-06-24 21:56:24 +0000630(invoked via an |:autocmd| for |BufReadCmd|, |BufWriteCmd|, or |SourceCmd|
631events) is made. Thus one may read, write, or source files across networks
632just as easily as if they were local files! >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633
634 vim ftp://[user@]machine/path
635 ...
636 :wq
637
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000638See |netrw-activate| for more on how to encourage your vim to use plugins
639such as netrw.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000641
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00006437. Ex Commands *netrw-ex* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000645The usual read/write commands are supported. There are also a few
Bram Moolenaar446cb832008-06-24 21:56:24 +0000646additional commands available. Often you won't need to use Nwrite or
Bram Moolenaar9964e462007-05-05 17:54:07 +0000647Nread as shown in |netrw-transparent| (ie. simply use >
648 :e url
649 :r url
650 :w url
651instead, as appropriate) -- see |netrw-urls|. In the explanations
652below, a {netfile} is an url to a remote file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200654 *:Nwrite* *:Nw*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000655:[range]Nw[rite] Write the specified lines to the current
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 file as specified in b:netrw_lastfile.
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200657 (related: |netrw-nwrite|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658
Bram Moolenaar446cb832008-06-24 21:56:24 +0000659:[range]Nw[rite] {netfile} [{netfile}]...
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 Write the specified lines to the {netfile}.
661
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200662 *:Nread* *:Nr*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100663:Nr[ead] Read the lines from the file specified in b:netrw_lastfile
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200664 into the current buffer. (related: |netrw-nread|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665
Bram Moolenaar446cb832008-06-24 21:56:24 +0000666:Nr[ead] {netfile} {netfile}...
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 Read the {netfile} after the current line.
668
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200669 *:Nsource* *:Ns*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000670:Ns[ource] {netfile}
Bram Moolenaar9964e462007-05-05 17:54:07 +0000671 Source the {netfile}.
672 To start up vim using a remote .vimrc, one may use
673 the following (all on one line) (tnx to Antoine Mechelynck) >
674 vim -u NORC -N
675 --cmd "runtime plugin/netrwPlugin.vim"
676 --cmd "source scp://HOSTNAME/.vimrc"
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200677< (related: |netrw-source|)
678
679:call NetUserPass() *NetUserPass()*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000680 If g:netrw_uid and s:netrw_passwd don't exist,
681 this function will query the user for them.
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200682 (related: |netrw-userpass|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683
684:call NetUserPass("userid")
Bram Moolenaar446cb832008-06-24 21:56:24 +0000685 This call will set the g:netrw_uid and, if
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686 the password doesn't exist, will query the user for it.
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200687 (related: |netrw-userpass|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688
689:call NetUserPass("userid","passwd")
Bram Moolenaar446cb832008-06-24 21:56:24 +0000690 This call will set both the g:netrw_uid and s:netrw_passwd.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691 The user-id and password are used by ftp transfers. One may
Bram Moolenaar446cb832008-06-24 21:56:24 +0000692 effectively remove the user-id and password by using empty
693 strings (ie. "").
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200694 (related: |netrw-userpass|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
Bram Moolenaar9964e462007-05-05 17:54:07 +0000696:NetrwSettings This command is described in |netrw-settings| -- used to
697 display netrw settings and change netrw behavior.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000698
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00007018. Variables and Options *netrw-options* *netrw-var* {{{1
702
703(if you're interested in the netrw browser settings, see: |netrw-browser-var|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704
Bram Moolenaar9964e462007-05-05 17:54:07 +0000705The <netrw.vim> script provides several variables which act as options to
Bram Moolenaar446cb832008-06-24 21:56:24 +0000706affect <netrw.vim>'s file transfer behavior. These variables typically may be
707set in the user's <.vimrc> file: (see also |netrw-settings| |netrw-protocol|)
Bram Moolenaar446cb832008-06-24 21:56:24 +0000708>
Bram Moolenaar9964e462007-05-05 17:54:07 +0000709 -------------
710 Netrw Options
711 -------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000712 Option Meaning
713 -------------- -----------------------------------------------
714<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000715 b:netrw_col Holds current cursor position (during NetWrite)
716 g:netrw_cygwin =1 assume scp under windows is from cygwin
717 (default/windows)
718 =0 assume scp under windows accepts windows
719 style paths (default/else)
720 g:netrw_ftp =0 use default ftp (uid password)
721 g:netrw_ftpmode ="binary" (default)
722 ="ascii" (your choice)
723 g:netrw_ignorenetrc =1 (default)
724 if you have a <.netrc> file but you don't
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725 want it used, then set this variable. Its
726 mere existence is enough to cause <.netrc>
727 to be ignored.
Bram Moolenaar9964e462007-05-05 17:54:07 +0000728 b:netrw_lastfile Holds latest method/machine/path.
729 b:netrw_line Holds current line number (during NetWrite)
Bram Moolenaar9964e462007-05-05 17:54:07 +0000730 g:netrw_silent =0 transfers done normally
731 =1 transfers done silently
732 g:netrw_uid Holds current user-id for ftp.
Bram Moolenaar9964e462007-05-05 17:54:07 +0000733 g:netrw_use_nt_rcp =0 don't use WinNT/2K/XP's rcp (default)
734 =1 use WinNT/2K/XP's rcp, binary mode
735 g:netrw_win95ftp =0 use unix-style ftp even if win95/98/ME/etc
736 =1 use default method to do ftp >
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000737 -----------------------------------------------------------------------
738<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739The script will also make use of the following variables internally, albeit
740temporarily.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000741>
742 -------------------
743 Temporary Variables
744 -------------------
745 Variable Meaning
746 -------- ------------------------------------
747<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100748 b:netrw_method Index indicating rcp/ftp+.netrc/ftp
749 w:netrw_method (same as b:netrw_method)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750 g:netrw_machine Holds machine name parsed from input
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100751 b:netrw_fname Holds filename being accessed >
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000752 ------------------------------------------------------------
753<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000754 *netrw-protocol*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000755
756Netrw supports a number of protocols. These protocols are invoked using the
757variables listed below, and may be modified by the user.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758>
759 ------------------------
Bram Moolenaar9964e462007-05-05 17:54:07 +0000760 Protocol Control Options
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761 ------------------------
Bram Moolenaar9964e462007-05-05 17:54:07 +0000762 Option Type Setting Meaning
763 --------- -------- -------------- ---------------------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000764<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000765 netrw_ftp variable =doesn't exist userid set by "user userid"
766 =0 userid set by "user userid"
767 =1 userid set by "userid"
768 NetReadFixup function =doesn't exist no change
769 =exists Allows user to have files
770 read via ftp automatically
771 transformed however they wish
772 by NetReadFixup()
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100773 g:netrw_dav_cmd variable ="cadaver" if cadaver is executable
774 g:netrw_dav_cmd variable ="curl -o" elseif curl is executable
Bram Moolenaar9964e462007-05-05 17:54:07 +0000775 g:netrw_fetch_cmd variable ="fetch -o" if fetch is available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 g:netrw_ftp_cmd variable ="ftp"
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000777 g:netrw_http_cmd variable ="fetch -o" if fetch is available
778 g:netrw_http_cmd variable ="wget -O" else if wget is available
Bram Moolenaar9964e462007-05-05 17:54:07 +0000779 g:netrw_list_cmd variable ="ssh USEPORT HOSTNAME ls -Fa"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 g:netrw_rcp_cmd variable ="rcp"
781 g:netrw_rsync_cmd variable ="rsync -a"
782 g:netrw_scp_cmd variable ="scp -q"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000783 g:netrw_sftp_cmd variable ="sftp" >
784 -------------------------------------------------------------------------
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785<
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000786 *netrw-ftp*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
Bram Moolenaar9964e462007-05-05 17:54:07 +0000788The g:netrw_..._cmd options (|g:netrw_ftp_cmd| and |g:netrw_sftp_cmd|)
789specify the external program to use handle the ftp protocol. They may
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200790include command line options (such as -p for passive mode). Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200792 let g:netrw_ftp_cmd= "ftp -p"
793<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000794Browsing is supported by using the |g:netrw_list_cmd|; the substring
795"HOSTNAME" will be changed via substitution with whatever the current request
796is for a hostname.
797
798Two options (|g:netrw_ftp| and |netrw-fixup|) both help with certain ftp's
799that give trouble . In order to best understand how to use these options if
800ftp is giving you troubles, a bit of discussion is provided on how netrw does
801ftp reads.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000802
803For ftp, netrw typically builds up lines of one of the following formats in a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804temporary file:
805>
806 IF g:netrw_ftp !exists or is not 1 IF g:netrw_ftp exists and is 1
807 ---------------------------------- ------------------------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000808<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000809 open machine [port] open machine [port]
810 user userid password userid password
811 [g:netrw_ftpmode] password
812 [g:netrw_extracmd] [g:netrw_ftpmode]
813 get filename tempfile [g:netrw_extracmd]
814 get filename tempfile >
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000815 ---------------------------------------------------------------------
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816<
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200817The |g:netrw_ftpmode| and |g:netrw_extracmd| are optional.
Bram Moolenaar9964e462007-05-05 17:54:07 +0000818
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819Netrw then executes the lines above by use of a filter:
820>
821 :%! {g:netrw_ftp_cmd} -i [-n]
822<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823where
824 g:netrw_ftp_cmd is usually "ftp",
825 -i tells ftp not to be interactive
826 -n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>)
827
828If <.netrc> exists it will be used to avoid having to query the user for
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000829userid and password. The transferred file is put into a temporary file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830The temporary file is then read into the main editing session window that
831requested it and the temporary file deleted.
832
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000833If your ftp doesn't accept the "user" command and immediately just demands a
834userid, then try putting "let netrw_ftp=1" in your <.vimrc>.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000836 *netrw-cadaver*
837To handle the SSL certificate dialog for untrusted servers, one may pull
838down the certificate and place it into /usr/ssl/cert.pem. This operation
839renders the server treatment as "trusted".
840
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000841 *netrw-fixup* *netreadfixup*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842If your ftp for whatever reason generates unwanted lines (such as AUTH
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100843messages) you may write a NetReadFixup() function:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844>
845 function! NetReadFixup(method,line1,line2)
846 " a:line1: first new line in current file
847 " a:line2: last new line in current file
848 if a:method == 1 "rcp
849 elseif a:method == 2 "ftp + <.netrc>
850 elseif a:method == 3 "ftp + machine,uid,password,filename
851 elseif a:method == 4 "scp
852 elseif a:method == 5 "http/wget
853 elseif a:method == 6 "dav/cadaver
854 elseif a:method == 7 "rsync
855 elseif a:method == 8 "fetch
856 elseif a:method == 9 "sftp
Bram Moolenaar9964e462007-05-05 17:54:07 +0000857 else " complain
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858 endif
859 endfunction
860>
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000861The NetReadFixup() function will be called if it exists and thus allows you to
862customize your reading process. As a further example, <netrw.vim> contains
863just such a function to handle Windows 95 ftp. For whatever reason, Windows
86495's ftp dumps four blank lines at the end of a transfer, and so it is
865desirable to automate their removal. Here's some code taken from <netrw.vim>
866itself:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867>
868 if has("win95") && g:netrw_win95ftp
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000869 fun! NetReadFixup(method, line1, line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870 if method == 3 " ftp (no <.netrc>)
Bram Moolenaar9964e462007-05-05 17:54:07 +0000871 let fourblanklines= line2 - 3
872 silent fourblanklines.",".line2."g/^\s*/d"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 endif
874 endfunction
875 endif
876>
877
878==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00008799. Browsing *netrw-browsing* *netrw-browse* *netrw-help* {{{1
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100880 *netrw-browser* *netrw-dir* *netrw-list*
Bram Moolenaar83bab712005-08-01 21:58:57 +0000881
Bram Moolenaar446cb832008-06-24 21:56:24 +0000882INTRODUCTION TO BROWSING *netrw-intro-browse* {{{2
883 (Quick References: |netrw-quickmaps| |netrw-quickcoms|)
Bram Moolenaar83bab712005-08-01 21:58:57 +0000884
Bram Moolenaar446cb832008-06-24 21:56:24 +0000885Netrw supports the browsing of directories on your local system and on remote
886hosts; browsing includes listing files and directories, entering directories,
887editing files therein, deleting files/directories, making new directories,
888moving (renaming) files and directories, copying files and directories, etc.
889One may mark files and execute any system command on them! The Netrw browser
890generally implements the previous explorer's maps and commands for remote
891directories, although details (such as pertinent global variable names)
892necessarily differ. To browse a directory, simply "edit" it! >
Bram Moolenaar269ec652004-07-29 08:43:53 +0000893
Bram Moolenaar446cb832008-06-24 21:56:24 +0000894 vim /your/directory/
895 vim .
896 vim c:\your\directory\
897<
898(Related topics: |netrw-cr| |netrw-o| |netrw-p| |netrw-P| |netrw-t|
899 |netrw-mf| |netrw-mx| |netrw-D| |netrw-R| |netrw-v| )
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000900
901The Netrw remote file and directory browser handles two protocols: ssh and
Bram Moolenaar446cb832008-06-24 21:56:24 +0000902ftp. The protocol in the url, if it is ftp, will cause netrw also to use ftp
903in its remote browsing. Specifying any other protocol will cause it to be
904used for file transfers; but the ssh protocol will be used to do remote
905browsing.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000906
Bram Moolenaar446cb832008-06-24 21:56:24 +0000907To use Netrw's remote directory browser, simply attempt to read a "file" with
908a trailing slash and it will be interpreted as a request to list a directory:
909>
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000910 vim [protocol]://[user@]hostname/path/
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000911<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000912where [protocol] is typically scp or ftp. As an example, try: >
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000913
Bram Moolenaar446cb832008-06-24 21:56:24 +0000914 vim ftp://ftp.home.vim.org/pub/vim/
915<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100916For local directories, the trailing slash is not required. Again, because it's
Bram Moolenaar446cb832008-06-24 21:56:24 +0000917easy to miss: to browse remote directories, the url must terminate with a
918slash!
Bram Moolenaar83bab712005-08-01 21:58:57 +0000919
Bram Moolenaar446cb832008-06-24 21:56:24 +0000920If you'd like to avoid entering the password repeatedly for remote directory
921listings with ssh or scp, see |netrw-ssh-hack|. To avoid password entry with
922ftp, see |netrw-netrc| (if your ftp supports it).
Bram Moolenaar83bab712005-08-01 21:58:57 +0000923
Bram Moolenaar446cb832008-06-24 21:56:24 +0000924There are several things you can do to affect the browser's display of files:
Bram Moolenaar83bab712005-08-01 21:58:57 +0000925
Bram Moolenaar446cb832008-06-24 21:56:24 +0000926 * To change the listing style, press the "i" key (|netrw-i|).
927 Currently there are four styles: thin, long, wide, and tree.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100928 To make that change "permanent", see |g:netrw_liststyle|.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000929
Bram Moolenaar446cb832008-06-24 21:56:24 +0000930 * To hide files (don't want to see those xyz~ files anymore?) see
931 |netrw-ctrl-h|.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000932
Bram Moolenaar446cb832008-06-24 21:56:24 +0000933 * Press s to sort files by name, time, or size.
934
935See |netrw-browse-cmds| for all the things you can do with netrw!
936
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100937 *netrw-getftype* *netrw-filigree* *netrw-ftype*
938The |getftype()| function is used to append a bit of filigree to indicate
939filetype to locally listed files:
940
941 directory : /
942 executable : *
943 fifo : |
944 links : @
945 sockets : =
946
947The filigree also affects the |g:netrw_sort_sequence|.
948
Bram Moolenaar446cb832008-06-24 21:56:24 +0000949
950QUICK HELP *netrw-quickhelp* {{{2
951 (Use ctrl-] to select a topic)~
952 Intro to Browsing...............................|netrw-intro-browse|
953 Quick Reference: Maps.........................|netrw-quickmap|
954 Quick Reference: Commands.....................|netrw-browse-cmds|
955 Hiding
956 Edit hiding list..............................|netrw-ctrl-h|
957 Hiding Files or Directories...................|netrw-a|
958 Hiding/Unhiding by suffix.....................|netrw-mh|
959 Hiding dot-files.............................|netrw-gh|
960 Listing Style
961 Select listing style (thin/long/wide/tree)....|netrw-i|
962 Associated setting variable...................|g:netrw_liststyle|
963 Shell command used to perform listing.........|g:netrw_list_cmd|
964 Quick file info...............................|netrw-qf|
965 Sorted by
966 Select sorting style (name/time/size).........|netrw-s|
967 Editing the sorting sequence..................|netrw-S|
Bram Moolenaarc236c162008-07-13 17:41:49 +0000968 Sorting options...............................|g:netrw_sort_options|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000969 Associated setting variable...................|g:netrw_sort_sequence|
970 Reverse sorting order.........................|netrw-r|
971
972
973 *netrw-quickmap* *netrw-quickmaps*
974QUICK REFERENCE: MAPS *netrw-browse-maps* {{{2
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000975>
Bram Moolenaar446cb832008-06-24 21:56:24 +0000976 --- ----------------- ----
977 Map Quick Explanation Link
978 --- ----------------- ----
979< <F1> Causes Netrw to issue help
980 <cr> Netrw will enter the directory or read the file |netrw-cr|
981 <del> Netrw will attempt to remove the file/directory |netrw-del|
982 - Makes Netrw go up one directory |netrw--|
983 a Toggles between normal display, |netrw-a|
984 hiding (suppress display of files matching g:netrw_list_hide)
985 showing (display only files which match g:netrw_list_hide)
986 c Make browsing directory the current directory |netrw-c|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100987 C Setting the editing window |netrw-C|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000988 d Make a directory |netrw-d|
989 D Attempt to remove the file(s)/directory(ies) |netrw-D|
990 gb Go to previous bookmarked directory |netrw-gb|
991 gh Quick hide/unhide of dot-files |netrw-gh|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000992 <c-h> Edit file hiding list |netrw-ctrl-h|
993 i Cycle between thin, long, wide, and tree listings |netrw-i|
994 <c-l> Causes Netrw to refresh the directory listing |netrw-ctrl-l|
995 mb Bookmark current directory |netrw-mb|
996 mc Copy marked files to marked-file target directory |netrw-mc|
997 md Apply diff to marked files (up to 3) |netrw-md|
998 me Place marked files on arg list and edit them |netrw-me|
999 mf Mark a file |netrw-mf|
1000 mh Toggle marked file suffices' presence on hiding list |netrw-mh|
1001 mm Move marked files to marked-file target directory |netrw-mm|
1002 mp Print marked files |netrw-mp|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001003 mr Mark files satisfying a shell-style |regexp| |netrw-mr|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001004 mt Current browsing directory becomes markfile target |netrw-mt|
1005 mT Apply ctags to marked files |netrw-mT|
1006 mu Unmark all marked files |netrw-mu|
1007 mx Apply arbitrary shell command to marked files |netrw-mx|
1008 mz Compress/decompress marked files |netrw-mz|
1009 o Enter the file/directory under the cursor in a new |netrw-o|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001010 browser window. A horizontal split is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001011 O Obtain a file specified by cursor |netrw-O|
1012 p Preview the file |netrw-p|
1013 P Browse in the previously used window |netrw-P|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001014 qb List bookmarked directories and history |netrw-qb|
1015 qf Display information on file |netrw-qf|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001016 r Reverse sorting order |netrw-r|
1017 R Rename the designed file(s)/directory(ies) |netrw-R|
1018 s Select sorting style: by name, time, or file size |netrw-s|
1019 S Specify suffix priority for name-sorting |netrw-S|
1020 t Enter the file/directory under the cursor in a new tab|netrw-t|
1021 u Change to recently-visited directory |netrw-u|
1022 U Change to subsequently-visited directory |netrw-U|
1023 v Enter the file/directory under the cursor in a new |netrw-v|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001024 browser window. A vertical split is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001025 x View file with an associated program |netrw-x|
1026
Bram Moolenaarc236c162008-07-13 17:41:49 +00001027 % Open a new file in netrw's current directory |netrw-%|
1028
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001029 *netrw-mouse* *netrw-leftmouse* *netrw-middlemouse* *netrw-rightmouse*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001030 <leftmouse> (gvim only) selects word under mouse as if a <cr>
1031 had been pressed (ie. edit file, change directory)
1032 <middlemouse> (gvim only) same as P selecting word under mouse;
1033 see |netrw-P|
1034 <rightmouse> (gvim only) delete file/directory using word under
1035 mouse
1036 <2-leftmouse> (gvim only) when:
1037 * in a netrw-selected file, AND
1038 * |g:netrw_retmap| == 1 AND
1039 * the user doesn't already have a <2-leftmouse> mapping
1040 defined before netrw is autoloaded,
1041 then a double clicked leftmouse button will return
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001042 to the netrw browser window. See |g:netrw_retmap|.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001043 <s-leftmouse> (gvim only) like mf, will mark files
1044
Bram Moolenaar00a927d2010-05-14 23:24:24 +02001045 (to disable mouse buttons while browsing: |g:netrw_mousemaps|)
1046
Bram Moolenaar446cb832008-06-24 21:56:24 +00001047 *netrw-quickcom* *netrw-quickcoms*
1048QUICK REFERENCE: COMMANDS *netrw-explore-cmds* *netrw-browse-cmds* {{{2
1049 :NetrwClean[!] ...........................................|netrw-clean|
1050 :NetrwSettings ...........................................|netrw-settings|
1051 :Explore[!] [dir] Explore directory of current file......|netrw-explore|
1052 :Hexplore[!] [dir] Horizontal Split & Explore.............|netrw-explore|
1053 :Nexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
1054 :Pexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
1055 :Rexplore Return to Explorer.....................|netrw-explore|
1056 :Sexplore[!] [dir] Split & Explore directory .............|netrw-explore|
1057 :Texplore[!] [dir] Tab & Explore..........................|netrw-explore|
1058 :Vexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
1059
1060BOOKMARKING A DIRECTORY *netrw-mb* *netrw-bookmark* *netrw-bookmarks* {{{2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001061
Bram Moolenaar446cb832008-06-24 21:56:24 +00001062One may easily "bookmark" a directory by using >
1063
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001064 mb
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00001065<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001066Bookmarks are retained in between sessions in a $HOME/.netrwbook file, and are
1067kept in sorted order.
1068
1069Related Topics:
1070 |netrw-gb| how to return (go) to a bookmark
1071 |netrw-mB| how to delete bookmarks
1072 |netrw-qb| how to list bookmarks
Bram Moolenaar4a85b412006-04-23 22:40:29 +00001073
1074
Bram Moolenaar446cb832008-06-24 21:56:24 +00001075BROWSING *netrw-cr* {{{2
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001076
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001077Browsing is simple: move the cursor onto a file or directory of interest.
Bram Moolenaar843ee412004-06-30 16:16:41 +00001078Hitting the <cr> (the return key) will select the file or directory.
1079Directories will themselves be listed, and files will be opened using the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001080protocol given in the original read request.
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001081
Bram Moolenaar446cb832008-06-24 21:56:24 +00001082 CAVEAT: There are four forms of listing (see |netrw-i|). Netrw assumes that
1083 two or more spaces delimit filenames and directory names for the long and
1084 wide listing formats. Thus, if your filename or directory name has two or
1085 more sequential spaces embedded in it, or any trailing spaces, then you'll
1086 need to use the "thin" format to select it.
Bram Moolenaar843ee412004-06-30 16:16:41 +00001087
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001088The |g:netrw_browse_split| option, which is zero by default, may be used to
Bram Moolenaar446cb832008-06-24 21:56:24 +00001089cause the opening of files to be done in a new window or tab instead of the
1090default. When the option is one or two, the splitting will be taken
1091horizontally or vertically, respectively. When the option is set to three, a
1092<cr> will cause the file to appear in a new tab.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001093
Bram Moolenaar83bab712005-08-01 21:58:57 +00001094
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001095When using the gui (gvim), one may select a file by pressing the <leftmouse>
1096button. In addition, if
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001097
Bram Moolenaar446cb832008-06-24 21:56:24 +00001098 *|g:netrw_retmap| == 1 AND (its default value is 0)
1099 * in a netrw-selected file, AND
1100 * the user doesn't already have a <2-leftmouse> mapping defined before
1101 netrw is loaded
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001102
Bram Moolenaar446cb832008-06-24 21:56:24 +00001103then a doubly-clicked leftmouse button will return to the netrw browser
1104window.
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001105
Bram Moolenaar446cb832008-06-24 21:56:24 +00001106Netrw attempts to speed up browsing, especially for remote browsing where one
1107may have to enter passwords, by keeping and re-using previously obtained
1108directory listing buffers. The |g:netrw_fastbrowse| variable is used to
1109control this behavior; one may have slow browsing (no buffer re-use), medium
1110speed browsing (re-use directory buffer listings only for remote directories),
1111and fast browsing (re-use directory buffer listings as often as possible).
1112The price for such re-use is that when changes are made (such as new files
1113are introduced into a directory), the listing may become out-of-date. One may
1114always refresh directory listing buffers by pressing ctrl-L (see
1115|netrw-ctrl-l|).
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001116
1117
Bram Moolenaar446cb832008-06-24 21:56:24 +00001118Related topics: |netrw-o| |netrw-p| |netrw-P| |netrw-t| |netrw-v|
1119Associated setting variables: |g:netrw_browse_split| |g:netrw_fastbrowse|
1120 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd|
1121 |g:netrw_ftp_timelist_cmd| |g:netrw_ssh_cmd|
1122 |g:netrw_ssh_browse_reject| |g:netrw_use_noswf|
1123
1124
1125BROWSING WITH A HORIZONTALLY SPLIT WINDOW *netrw-o* *netrw-horiz* {{{2
1126
1127Normally one enters a file or directory using the <cr>. However, the "o" map
1128allows one to open a new window to hold the new directory listing or file. A
1129horizontal split is used. (for vertical splitting, see |netrw-v|)
1130
1131Normally, the o key splits the window horizontally with the new window and
1132cursor at the top. To change to splitting the window horizontally with the
1133new window and cursor at the bottom, have
1134
1135 let g:netrw_alto = 1
1136
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001137in your <.vimrc>. (also see |netrw-t| |netrw-T| |netrw-v|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001138
1139Associated setting variables: |g:netrw_alto| |g:netrw_winsize|
1140
1141
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001142BROWSING WITH A NEW TAB *netrw-t* *netrw-T* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00001143
1144Normally one enters a file or directory using the <cr>. The "t" map
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001145allows one to open a new window holding the new directory listing or file in
1146a new tab. The "T" version puts the file or directory into a background tab
1147(see |gT|)
1148
1149Related actions: |netrw-o| |netrw-v|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001150
1151
1152BROWSING WITH A VERTICALLY SPLIT WINDOW *netrw-v* {{{2
1153
1154Normally one enters a file or directory using the <cr>. However, the "v" map
1155allows one to open a new window to hold the new directory listing or file. A
1156vertical split is used. (for horizontal splitting, see |netrw-o|)
1157
1158Normally, the v key splits the window vertically with the new window and
1159cursor at the left. To change to splitting the window vertically with the new
1160window and cursor at the right, have
1161
1162 let g:netrw_altv = 1
1163
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001164in your <.vimrc>. (also see: |netrw-o| |netrw-t| |netrw-T|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001165
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001166There is only one tree listing buffer; using "v" on a displayed subdirectory
Bram Moolenaar446cb832008-06-24 21:56:24 +00001167will split the screen, but the same buffer will be shown twice.
1168
1169Associated setting variable: |g:netrw_altv| |g:netrw_winsize|
1170
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001171
1172CHANGE LISTING STYLE (THIN LONG WIDE TREE) *netrw-i* {{{2
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001173
Bram Moolenaar9964e462007-05-05 17:54:07 +00001174The "i" map cycles between the thin, long, wide, and tree listing formats.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001175
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001176The thin listing format gives just the files' and directories' names.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001177
Bram Moolenaar8299df92004-07-10 09:47:34 +00001178The long listing is either based on the "ls" command via ssh for remote
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001179directories or displays the filename, file size (in bytes), and the time and
1180date of last modification for local directories. With the long listing
1181format, netrw is not able to recognize filenames which have trailing spaces.
1182Use the thin listing format for such files.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001183
Bram Moolenaar9964e462007-05-05 17:54:07 +00001184The wide listing format uses two or more contiguous spaces to delineate
1185filenames; when using that format, netrw won't be able to recognize or use
1186filenames which have two or more contiguous spaces embedded in the name or any
1187trailing spaces. The thin listing format will, however, work with such files.
1188This listing format is the most compact.
1189
1190The tree listing format has a top directory followed by files and directories
1191preceded by a "|". One may open and close directories by pressing the <cr>
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001192key while atop the directory name.
1193
1194One may make a preferred listing style your default; see |g:netrw_liststyle|.
1195As an example, by putting the following line in your .vimrc, >
1196 let g:netrw_liststyle= 4
1197the tree style will become your default listing style.
Bram Moolenaar8299df92004-07-10 09:47:34 +00001198
Bram Moolenaar446cb832008-06-24 21:56:24 +00001199Associated setting variables: |g:netrw_liststyle| |g:netrw_maxfilenamelen|
1200 |g:netrw_timefmt| |g:netrw_list_cmd|
Bram Moolenaar8299df92004-07-10 09:47:34 +00001201
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001202CHANGE FILE PERMISSION *netrw-gp* {{{2
1203
1204"gp" will ask you for a new permission for the file named under the cursor.
1205Currently, this only works for local files.
1206
1207Associated setting variables: |g:netrw_chgperm|
1208
Bram Moolenaar83bab712005-08-01 21:58:57 +00001209
Bram Moolenaar446cb832008-06-24 21:56:24 +00001210CHANGING TO A BOOKMARKED DIRECTORY *netrw-gb* {{{2
Bram Moolenaar843ee412004-06-30 16:16:41 +00001211
Bram Moolenaar446cb832008-06-24 21:56:24 +00001212To change directory back to a bookmarked directory, use
Bram Moolenaar843ee412004-06-30 16:16:41 +00001213
Bram Moolenaar446cb832008-06-24 21:56:24 +00001214 {cnt}gb
Bram Moolenaar843ee412004-06-30 16:16:41 +00001215
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001216Any count may be used to reference any of the bookmarks.
1217
1218Related Topics:
1219 |netrw-mB| how to delete bookmarks
1220 |netrw-mb| how to make a bookmark
1221 |netrw-qb| how to list bookmarks
Bram Moolenaar843ee412004-06-30 16:16:41 +00001222
Bram Moolenaar843ee412004-06-30 16:16:41 +00001223
Bram Moolenaar00a927d2010-05-14 23:24:24 +02001224CHANGING TO A PREDECESSOR DIRECTORY *netrw-u* *netrw-updir* {{{2
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001225
1226Every time you change to a new directory (new for the current session),
1227netrw will save the directory in a recently-visited directory history
Bram Moolenaar446cb832008-06-24 21:56:24 +00001228list (unless g:netrw_dirhistmax is zero; by default, it's ten). With the
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001229"u" map, one can change to an earlier directory (predecessor). To do
1230the opposite, see |netrw-U|.
1231
1232
Bram Moolenaar446cb832008-06-24 21:56:24 +00001233CHANGING TO A SUCCESSOR DIRECTORY *netrw-U* *netrw-downdir* {{{2
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001234
1235With the "U" map, one can change to a later directory (successor).
1236This map is the opposite of the "u" map. (see |netrw-u|) Use the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001237q map to list both the bookmarks and history. (see |netrw-qb|)
1238
1239
1240NETRW CLEAN *netrw-clean* *:NetrwClean*
1241
1242With :NetrwClean one may easily remove netrw from one's home directory;
1243more precisely, from the first directory on your |'runtimepath'|.
1244
1245With :NetrwClean!, netrw will remove netrw from all directories on your
1246|'runtimepath'|.
1247
1248With either form of the command, netrw will first ask for confirmation
1249that the removal is in fact what you want to do. If netrw doesn't have
1250permission to remove a file, it will issue an error message.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001251
Bram Moolenaar9964e462007-05-05 17:54:07 +00001252 *netrw-gx*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001253CUSTOMIZING BROWSING WITH A USER FUNCTION *netrw-x* *netrw-handler* {{{2
Bram Moolenaar9964e462007-05-05 17:54:07 +00001254 (also see |netrw_filehandler|)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001255
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001256Certain files, such as html, gif, jpeg, (word/office) doc, etc, files, are
1257best seen with a special handler (ie. a tool provided with your computer).
1258Netrw allows one to invoke such special handlers by: >
1259
1260 * when Exploring, hit the "x" key
1261 * when editing, hit gx with the cursor atop the special filename
Bram Moolenaar9964e462007-05-05 17:54:07 +00001262< (not available if the |g:netrw_nogx| variable exists)
1263
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001264Netrw determines which special handler by the following method:
1265
1266 * if |g:netrw_browsex_viewer| exists, then it will be used to attempt to
1267 view files. Examples of useful settings (place into your <.vimrc>): >
1268
1269 :let g:netrw_browsex_viewer= "kfmclient exec"
1270< or >
1271 :let g:netrw_browsex_viewer= "gnome-open"
1272<
1273 If g:netrw_browsex_viewer == '-', then netrwFileHandler() will be
1274 invoked first (see |netrw_filehandler|).
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001275
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001276 * for Windows 32 or 64, the url and FileProtocolHandler dlls are used.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001277 * for Gnome (with gnome-open): gnome-open is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001278 * for KDE (with kfmclient) : kfmclient is used.
1279 * for Mac OS X : open is used.
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001280 * otherwise the netrwFileHandler plugin is used.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001281
1282The file's suffix is used by these various approaches to determine an
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001283appropriate application to use to "handle" these files. Such things as
1284OpenOffice (*.sfx), visualization (*.jpg, *.gif, etc), and PostScript (*.ps,
1285*.eps) can be handled.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001286
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001287 *netrw_filehandler*
Bram Moolenaar9964e462007-05-05 17:54:07 +00001288
1289The "x" map applies a function to a file, based on its extension. Of course,
1290the handler function must exist for it to be called!
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001291>
1292 Ex. mypgm.html x ->
Bram Moolenaar9964e462007-05-05 17:54:07 +00001293 NFH_html("scp://user@host/some/path/mypgm.html")
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001294<
Bram Moolenaar9964e462007-05-05 17:54:07 +00001295Users may write their own netrw File Handler functions to support more
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001296suffixes with special handling. See <autoload/netrwFileHandlers.vim> for
Bram Moolenaar9964e462007-05-05 17:54:07 +00001297examples on how to make file handler functions. As an example: >
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001298
Bram Moolenaar9964e462007-05-05 17:54:07 +00001299 " NFH_suffix(filename)
1300 fun! NFH_suffix(filename)
1301 ..do something special with filename..
1302 endfun
1303<
1304These functions need to be defined in some file in your .vim/plugin
1305(vimfiles\plugin) directory. Vim's function names may not have punctuation
1306characters (except for the underscore) in them. To support suffices that
1307contain such characters, netrw will first convert the suffix using the
1308following table: >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001309
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001310 @ -> AT ! -> EXCLAMATION % -> PERCENT
1311 : -> COLON = -> EQUAL ? -> QUESTION
Bram Moolenaar9964e462007-05-05 17:54:07 +00001312 , -> COMMA - -> MINUS ; -> SEMICOLON
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001313 $ -> DOLLAR + -> PLUS ~ -> TILDE
1314<
Bram Moolenaar9964e462007-05-05 17:54:07 +00001315So, for example: >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001316
Bram Moolenaar9964e462007-05-05 17:54:07 +00001317 file.rcs,v -> NFH_rcsCOMMAv()
1318<
1319If more such translations are necessary, please send me email: >
1320 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
1321with a request.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001322
Bram Moolenaar446cb832008-06-24 21:56:24 +00001323Associated setting variable: |g:netrw_browsex_viewer|
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001324
Bram Moolenaar446cb832008-06-24 21:56:24 +00001325 *netrw-curdir*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001326DELETING BOOKMARKS *netrw-mB* {{{2
1327
1328To delete a bookmark, use >
1329
1330 {cnt}mB
1331<
1332Related Topics:
1333 |netrw-gb| how to return (go) to a bookmark
1334 |netrw-mb| how to make a bookmark
1335 |netrw-qb| how to list bookmarks
1336
1337
Bram Moolenaar446cb832008-06-24 21:56:24 +00001338DELETING FILES OR DIRECTORIES *netrw-delete* *netrw-D* *netrw-del* {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001339
Bram Moolenaar446cb832008-06-24 21:56:24 +00001340If files have not been marked with |netrw-mf|: (local marked file list)
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001341
Bram Moolenaar446cb832008-06-24 21:56:24 +00001342 Deleting/removing files and directories involves moving the cursor to the
1343 file/directory to be deleted and pressing "D". Directories must be empty
1344 first before they can be successfully removed. If the directory is a
1345 softlink to a directory, then netrw will make two requests to remove the
1346 directory before succeeding. Netrw will ask for confirmation before doing
1347 the removal(s). You may select a range of lines with the "V" command
1348 (visual selection), and then pressing "D".
Bram Moolenaar9964e462007-05-05 17:54:07 +00001349
Bram Moolenaar446cb832008-06-24 21:56:24 +00001350If files have been marked with |netrw-mf|: (local marked file list)
1351
1352 Marked files (and empty directories) will be deleted; again, you'll be
1353 asked to confirm the deletion before it actually takes place.
1354
1355The |g:netrw_rm_cmd|, |g:netrw_rmf_cmd|, and |g:netrw_rmdir_cmd| variables are
1356used to control the attempts to remove files and directories. The
1357g:netrw_rm_cmd is used with files, and its default value is:
1358
1359 g:netrw_rm_cmd: ssh HOSTNAME rm
1360
1361The g:netrw_rmdir_cmd variable is used to support the removal of directories.
1362Its default value is:
1363
1364 g:netrw_rmdir_cmd: ssh HOSTNAME rmdir
1365
1366If removing a directory fails with g:netrw_rmdir_cmd, netrw then will attempt
1367to remove it again using the g:netrw_rmf_cmd variable. Its default value is:
1368
1369 g:netrw_rmf_cmd: ssh HOSTNAME rm -f
1370
1371Associated setting variable: |g:netrw_local_rmdir| |g:netrw_rm_cmd|
1372 |g:netrw_rmdir_cmd| |g:netrw_ssh_cmd|
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001373
1374
Bram Moolenaar446cb832008-06-24 21:56:24 +00001375*netrw-explore* *netrw-hexplore* *netrw-nexplore* *netrw-pexplore*
1376*netrw-rexplore* *netrw-sexplore* *netrw-texplore* *netrw-vexplore*
1377DIRECTORY EXPLORATION COMMANDS {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001378
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001379 :[N]Explore[!] [dir]... Explore directory of current file *:Explore*
1380 :[N]Hexplore[!] [dir]... Horizontal Split & Explore *:Hexplore*
1381 :Rexplore ... Return to Explorer *:Rexplore*
1382 :[N]Sexplore[!] [dir]... Split&Explore current file's directory *:Sexplore*
1383 :Texplore [dir]... Tab & Explore *:Texplore*
1384 :[N]Vexplore[!] [dir]... Vertical Split & Explore *:Vexplore*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001385
1386 Used with :Explore **/pattern : (also see |netrw-starstar|)
1387 :Nexplore............. go to next matching file *:Nexplore*
1388 :Pexplore............. go to previous matching file *:Pexplore*
1389
1390:Explore will open the local-directory browser on the current file's
1391 directory (or on directory [dir] if specified). The window will be
1392 split only if the file has been modified, otherwise the browsing
1393 window will take over that window. Normally the splitting is taken
1394 horizontally.
1395:Explore! is like :Explore, but will use vertical splitting.
1396:Sexplore will always split the window before invoking the local-directory
1397 browser. As with Explore, the splitting is normally done
1398 horizontally.
1399:Sexplore! [dir] is like :Sexplore, but the splitting will be done vertically.
1400:Hexplore [dir] does an :Explore with |:belowright| horizontal splitting.
1401:Hexplore! [dir] does an :Explore with |:aboveleft| horizontal splitting.
1402:Vexplore [dir] does an :Explore with |:leftabove| vertical splitting.
1403:Vexplore! [dir] does an :Explore with |:rightbelow| vertical splitting.
1404:Texplore [dir] does a tabnew before generating the browser window
1405
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001406By default, these commands use the current file's directory. However, one may
1407explicitly provide a directory (path) to use.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001408
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001409The [N] will override |g:netrw_winsize| to specify the quantity of rows and/or
1410columns the new explorer window should have.
1411
1412Otherwise, the |g:netrw_winsize| variable, if it has been specified by the
1413user, is used to control the quantity of rows and/or columns new explorer
1414windows should have.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001415
1416:Rexplore This command is a little different from the others. When one
1417 edits a file, for example by pressing <cr> when atop a file in
1418 a netrw browser window, :Rexplore will return the display to
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001419 that of the last netrw browser window. It is a command version
1420 of the <2-leftmouse> map (which is only available under gvim and
Bram Moolenaar446cb832008-06-24 21:56:24 +00001421 cooperative terms).
1422
1423
1424*netrw-star* *netrw-starpat* *netrw-starstar* *netrw-starstarpat*
1425EXPLORING WITH STARS AND PATTERNS
1426
1427When Explore, Sexplore, Hexplore, or Vexplore are used with one of the
1428following four styles, Explore generates a list of files which satisfy
1429the request. >
1430
1431 */filepat files in current directory which satisfy filepat
1432 **/filepat files in current directory or below which satisfy the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001433 file pattern
Bram Moolenaar446cb832008-06-24 21:56:24 +00001434 *//pattern files in the current directory which contain the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001435 pattern (vimgrep is used)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001436 **//pattern files in the current directory or below which contain
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001437 the pattern (vimgrep is used)
Bram Moolenaar572cb562005-08-05 21:35:02 +00001438<
Bram Moolenaar446cb832008-06-24 21:56:24 +00001439The cursor will be placed on the first file in the list. One may then
1440continue to go to subsequent files on that list via |:Nexplore| or to
1441preceding files on that list with |:Pexplore|. Explore will update the
1442directory and place the cursor appropriately.
1443
1444A plain >
1445 :Explore
1446will clear the explore list.
1447
1448If your console or gui produces recognizable shift-up or shift-down sequences,
1449then you'll likely find using shift-downarrow and shift-uparrow convenient.
1450They're mapped by netrw:
1451
1452 <s-down> == Nexplore, and
1453 <s-up> == Pexplore.
1454
1455As an example, consider
1456>
1457 :Explore */*.c
1458 :Nexplore
1459 :Nexplore
1460 :Pexplore
1461<
1462The status line will show, on the right hand side of the status line, a
1463message like "Match 3 of 20".
1464
1465Associated setting variables: |g:netrw_keepdir| |g:netrw_browse_split|
1466 |g:netrw_fastbrowse| |g:netrw_ftp_browse_reject|
1467 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd|
1468 |g:netrw_ftp_timelist_cmd| |g:netrw_list_cmd|
1469 |g:netrw_liststyle|
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001470
1471
Bram Moolenaar446cb832008-06-24 21:56:24 +00001472DISPLAYING INFORMATION ABOUT FILE *netrw-qf* {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001473
Bram Moolenaar446cb832008-06-24 21:56:24 +00001474With the cursor atop a filename, pressing "qf" will reveal the file's size
1475and last modification timestamp. Currently this capability is only available
1476for local files.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001477
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001478
Bram Moolenaar446cb832008-06-24 21:56:24 +00001479EDIT FILE OR DIRECTORY HIDING LIST *netrw-ctrl-h* *netrw-edithide* {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001480
Bram Moolenaar446cb832008-06-24 21:56:24 +00001481The "<ctrl-h>" map brings up a requestor allowing the user to change the
1482file/directory hiding list contained in |g:netrw_list_hide|. The hiding list
1483consists of one or more patterns delimited by commas. Files and/or
1484directories satisfying these patterns will either be hidden (ie. not shown) or
1485be the only ones displayed (see |netrw-a|).
1486
1487The "gh" mapping (see |netrw-gh|) quickly alternates between the usual
1488hiding list and the hiding of files or directories that begin with ".".
1489
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001490As an example, >
1491 let g:netrw_list_hide= '\(^\|\s\s\)\zs\.\S\+'
1492Effectively, this makes the effect of a |netrw-gh| command the initial setting.
1493What it means:
1494
1495 \(^\|\s\s\) : if the line begins with the following, -or-
1496 two consecutive spaces are encountered
1497 \zs : start the hiding match now
1498 \. : if it now begins with a dot
1499 \S\+ : and is followed by one or more non-whitespace
1500 characters
1501
Bram Moolenaar446cb832008-06-24 21:56:24 +00001502Associated setting variables: |g:netrw_hide| |g:netrw_list_hide|
1503Associated topics: |netrw-a| |netrw-gh| |netrw-mh|
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001504
1505
Bram Moolenaar446cb832008-06-24 21:56:24 +00001506EDITING THE SORTING SEQUENCE *netrw-S* *netrw-sortsequence* {{{2
1507
1508When "Sorted by" is name, one may specify priority via the sorting sequence
1509(g:netrw_sort_sequence). The sorting sequence typically prioritizes the
1510name-listing by suffix, although any pattern will do. Patterns are delimited
1511by commas. The default sorting sequence is (all one line):
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001512
1513For Unix: >
1514 '[\/]$,\<core\%(\.\d\+\)\=,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$,
1515 \.info$,\.swp$,\.bak$,\~$'
1516<
1517Otherwise: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00001518 '[\/]$,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$,\.info$,
1519 \.swp$,\.bak$,\~$'
1520<
1521The lone * is where all filenames not covered by one of the other patterns
1522will end up. One may change the sorting sequence by modifying the
1523g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by
1524using the "S" map.
1525
Bram Moolenaarc236c162008-07-13 17:41:49 +00001526Related topics: |netrw-s| |netrw-S|
1527Associated setting variables: |g:netrw_sort_sequence| |g:netrw_sort_options|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001528
1529
1530GOING UP *netrw--* {{{2
1531
1532To go up a directory, press "-" or press the <cr> when atop the ../ directory
1533entry in the listing.
1534
1535Netrw will use the command in |g:netrw_list_cmd| to perform the directory
1536listing operation after changing HOSTNAME to the host specified by the
1537user-provided url. By default netrw provides the command as:
1538
1539 ssh HOSTNAME ls -FLa
1540
1541where the HOSTNAME becomes the [user@]hostname as requested by the attempt to
1542read. Naturally, the user may override this command with whatever is
1543preferred. The NetList function which implements remote browsing
1544expects that directories will be flagged by a trailing slash.
1545
1546
1547HIDING FILES OR DIRECTORIES *netrw-a* *netrw-hiding* {{{2
1548
1549Netrw's browsing facility allows one to use the hiding list in one of three
1550ways: ignore it, hide files which match, and show only those files which
1551match.
1552
1553If no files have been marked via |netrw-mf|:
1554
1555The "a" map allows the user to cycle through the three hiding modes.
1556
1557The |g:netrw_list_hide| variable holds a comma delimited list of patterns
1558based on regular expressions (ex. ^.*\.obj$,^\.) which specify the hiding list.
1559(also see |netrw-ctrl-h|) To set the hiding list, use the <c-h> map. As an
1560example, to hide files which begin with a ".", one may use the <c-h> map to
1561set the hiding list to '^\..*' (or one may put let g:netrw_list_hide= '^\..*'
1562in one's <.vimrc>). One may then use the "a" key to show all files, hide
1563matching files, or to show only the matching files.
1564
1565 Example: \.[ch]$
1566 This hiding list command will hide/show all *.c and *.h files.
1567
1568 Example: \.c$,\.h$
1569 This hiding list command will also hide/show all *.c and *.h
1570 files.
1571
1572Don't forget to use the "a" map to select the mode (normal/hiding/show) you
1573want!
1574
1575If files have been marked using |netrw-mf|, then this command will:
1576
1577 if showing all files or non-hidden files:
1578 modify the g:netrw_list_hide list by appending the marked files to it
1579 and showing only non-hidden files.
1580
1581 else if showing hidden files only:
1582 modify the g:netrw_list_hide list by removing the marked files from it
1583 and showing only non-hidden files.
1584 endif
1585
1586 *netrw-gh* *netrw-hide*
1587As a quick shortcut, one may press >
1588 gh
1589to toggle between hiding files which begin with a period (dot) and not hiding
1590them.
1591
1592Associated setting variable: |g:netrw_list_hide|
1593Associated topics: |netrw-a| |netrw-ctrl-h| |netrw-mh|
1594
1595IMPROVING BROWSING *netrw-listhack* *netrw-ssh-hack* {{{2
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001596
1597Especially with the remote directory browser, constantly entering the password
1598is tedious.
1599
Bram Moolenaar9964e462007-05-05 17:54:07 +00001600For Linux/Unix systems, the book "Linux Server Hacks - 100 industrial strength
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00001601tips & tools" by Rob Flickenger (O'Reilly, ISBN 0-596-00461-3) gives a tip
1602for setting up no-password ssh and scp and discusses associated security
Bram Moolenaar9964e462007-05-05 17:54:07 +00001603issues. It used to be available at http://hacks.oreilly.com/pub/h/66 ,
1604but apparently that address is now being redirected to some "hackzine".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001605I'll attempt a summary based on that article and on a communication from
1606Ben Schmidt:
Bram Moolenaar843ee412004-06-30 16:16:41 +00001607
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001608 1. Generate a public/private key pair on the local machine
1609 (ssh client): >
1610 ssh-keygen -t rsa
1611 (saving the file in ~/.ssh/id_rsa as prompted)
1612<
1613 2. Just hit the <CR> when asked for passphrase (twice) for no
1614 passphrase. If you do use a passphrase, you will also need to use
1615 ssh-agent so you only have to type the passphrase once per session.
1616 If you don't use a passphrase, simply logging onto your local
1617 computer or getting access to the keyfile in any way will suffice
1618 to access any ssh servers which have that key authorized for login.
1619
1620 3. This creates two files: >
1621 ~/.ssh/id_rsa
1622 ~/.ssh/id_rsa.pub
1623<
1624 4. On the target machine (ssh server): >
1625 cd
1626 mkdir -p .ssh
1627 chmod 0700 .ssh
1628<
1629 5. On your local machine (ssh client): (one line) >
1630 ssh {serverhostname}
1631 cat '>>' '~/.ssh/authorized_keys2' < ~/.ssh/id_rsa.pub
1632<
1633 or, for OpenSSH, (one line) >
1634 ssh {serverhostname}
1635 cat '>>' '~/.ssh/authorized_keys' < ~/.ssh/id_rsa.pub
1636<
1637You can test it out with >
1638 ssh {serverhostname}
1639and you should be log onto the server machine without further need to type
1640anything.
1641
1642If you decided to use a passphrase, do: >
1643 ssh-agent $SHELL
1644 ssh-add
1645 ssh {serverhostname}
1646You will be prompted for your key passphrase when you use ssh-add, but not
1647subsequently when you use ssh. For use with vim, you can use >
1648 ssh-agent vim
1649and, when next within vim, use >
1650 :!ssh-add
1651Alternatively, you can apply ssh-agent to the terminal you're planning on
1652running vim in: >
1653 ssh-agent xterm &
1654and do ssh-add whenever you need.
Bram Moolenaar843ee412004-06-30 16:16:41 +00001655
Bram Moolenaar9964e462007-05-05 17:54:07 +00001656For Windows, folks on the vim mailing list have mentioned that Pageant helps
1657with avoiding the constant need to enter the password.
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001658
Bram Moolenaar446cb832008-06-24 21:56:24 +00001659Kingston Fung wrote about another way to avoid constantly needing to enter
1660passwords:
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001661
Bram Moolenaar446cb832008-06-24 21:56:24 +00001662 In order to avoid the need to type in the password for scp each time, you
1663 provide a hack in the docs to set up a non password ssh account. I found a
1664 better way to do that: I can use a regular ssh account which uses a
1665 password to access the material without the need to key-in the password
1666 each time. It's good for security and convenience. I tried ssh public key
1667 authorization + ssh-agent, implementing this, and it works! Here are two
1668 links with instructions:
1669
1670 http://www.ibm.com/developerworks/library/l-keyc2/
1671 http://sial.org/howto/openssh/publickey-auth/
1672
1673
1674LISTING BOOKMARKS AND HISTORY *netrw-qb* *netrw-listbookmark* {{{2
1675
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001676Pressing "qb" (query bookmarks) will list both the bookmarked directories and
1677directory traversal history.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001678
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001679Related Topics:
1680 |netrw-gb| how to return (go) to a bookmark
1681 |netrw-mb| how to make a bookmark
1682 |netrw-mB| how to delete bookmarks
1683 |netrw-u| change to a predecessor directory via the history stack
1684 |netrw-U| change to a successor directory via the history stack
Bram Moolenaar446cb832008-06-24 21:56:24 +00001685
1686MAKING A NEW DIRECTORY *netrw-d* {{{2
1687
1688With the "d" map one may make a new directory either remotely (which depends
1689on the global variable g:netrw_mkdir_cmd) or locally (which depends on the
1690global variable g:netrw_local_mkdir). Netrw will issue a request for the new
1691directory's name. A bare <CR> at that point will abort the making of the
1692directory. Attempts to make a local directory that already exists (as either
1693a file or a directory) will be detected, reported on, and ignored.
1694
1695Currently, making a directory via ftp is not supported.
1696
1697Associated setting variable: |g:netrw_local_mkdir| |g:netrw_mkdir_cmd|
1698
1699
1700MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY *netrw-c* {{{2
1701
1702By default, |g:netrw_keepdir| is 1. This setting means that the current
1703directory will not track the browsing directory.
1704
1705Setting g:netrw_keepdir to 0 tells netrw to make vim's current directory to
1706track netrw's browsing directory.
1707
1708However, given the default setting for g:netrw_keepdir of 1 where netrw
1709maintains its own separate notion of the current directory, in order to make
1710the two directories the same, use the "c" map (just type c). That map will
1711set Vim's notion of the current directory to netrw's current browsing
1712directory.
1713
1714Associated setting variable: |g:netrw_keepdir|
1715
1716MARKING FILES *netrw-mf* {{{2
1717 (also see |netrw-mr|)
1718
1719One may mark files with the cursor atop a filename and then pressing "mf".
1720With gvim, one may also mark files with <s-leftmouse>. The following netrw
1721maps make use of marked files:
1722
1723 |netrw-a| Hide marked files/directories
1724 |netrw-D| Delete marked files/directories
1725 |netrw-mc| Copy marked files to target
1726 |netrw-md| Apply vimdiff to marked files
1727 |netrw-me| Edit marked files
1728 |netrw-mg| Apply vimgrep to marked files
1729 |netrw-mm| Move marked files
1730 |netrw-mp| Print marked files
1731 |netrw-mt| Set target for |netrw-mm| and |netrw-mc|
1732 |netrw-mT| Generate tags using marked files
1733 |netrw-mx| Apply shell command to marked files
1734 |netrw-mz| Compress/Decompress marked files
1735 |netrw-O| Obtain marked files
1736 |netrw-R| Rename marked files
1737
1738One may unmark files one at a time the same way one marks them; ie. place
1739the cursor atop a marked file and press "mf". This process also works
1740with <s-leftmouse> using gvim. One may unmark all files by pressing
1741"mu" (see |netrw-mu|).
1742
1743*markfilelist* *global_markfilelist* *local_markfilelist*
1744All marked files are entered onto the global marked file list; there is only
1745one such list. In addition, every netrw buffer also has its own local marked
1746file list; since netrw buffers are associated with specific directories, this
1747means that each directory has its own local marked file list. The various
1748commands which operate on marked files use one or the other of the marked file
1749lists.
1750
1751
1752MARKING FILES BY REGULAR EXPRESSION *netrw-mr* {{{2
1753 (also see |netrw-mf|)
1754
1755One may also mark files by pressing "mr"; netrw will then issue a prompt,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001756"Enter regexp: ". You may then enter a shell-style regular expression such
1757as *.c$ (see |glob()|). For remote systems, glob() doesn't work -- so netrw
1758converts "*" into ".*" (see |regexp|) and marks files based on that. In the
1759future I may make it possible to use |regexp|s instead of glob()-style
1760expressions (yet-another-option).
Bram Moolenaar446cb832008-06-24 21:56:24 +00001761
1762
1763MARKED FILES: ARBITRARY COMMAND *netrw-mx* {{{2
1764 (See |netrw-mf| and |netrw-mr| for how to mark files)
1765 (uses the local marked-file list)
1766
1767Upon activation of the "mx" map, netrw will query the user for some (external)
1768command to be applied to all marked files. All "%"s in the command will be
1769substituted with the name of each marked file in turn. If no "%"s are in the
1770command, then the command will be followed by a space and a marked filename.
1771
1772
1773MARKED FILES: COMPRESSION AND DECOMPRESSION *netrw-mz* {{{2
1774 (See |netrw-mf| and |netrw-mr| for how to mark files)
1775 (uses the local marked file list)
1776
1777If any marked files are compressed, then "mz" will decompress them.
1778If any marked files are decompressed, then "mz" will compress them
1779using the command specified by |g:netrw_compress|; by default,
1780that's "gzip".
1781
1782For decompression, netrw provides a |Dictionary| of suffices and their
1783associated decompressing utilities; see |g:netrw_decompress|.
1784
1785Associated setting variables: |g:netrw_compress| |g:netrw_decompress|
1786
1787MARKED FILES: COPYING *netrw-mc* {{{2
1788 (See |netrw-mf| and |netrw-mr| for how to mark files)
1789 (Uses the global marked file list)
1790
1791Select a target directory with mt (|netrw-mt|). Then change directory,
1792select file(s) (see |netrw-mf|), and press "mc".
1793
1794Associated setting variable: |g:netrw_localcopycmd| |g:netrw_ssh_cmd|
1795
1796MARKED FILES: DIFF *netrw-md* {{{2
1797 (See |netrw-mf| and |netrw-mr| for how to mark files)
1798 (uses the global marked file list)
1799
1800Use |vimdiff| to visualize difference between selected files (two or
1801three may be selected for this). Uses the global marked file list.
1802
1803MARKED FILES: EDITING *netrw-me* {{{2
1804 (See |netrw-mf| and |netrw-mr| for how to mark files)
1805 (uses the global marked file list)
1806
1807This command will place the marked files on the |arglist| and commence
1808editing them. One may return the to explorer window with |:Rexplore|.
1809
1810MARKED FILES: GREP *netrw-mg* {{{2
1811 (See |netrw-mf| and |netrw-mr| for how to mark files)
1812 (uses the global marked file list)
1813
1814This command will apply |:vimgrep| to the marked files. The command will ask
1815for the requested pattern; one may enter: >
1816 /pattern/[g][j]
1817 ! /pattern/[g][j]
1818 pattern
1819<
1820MARKED FILES: HIDING AND UNHIDING BY SUFFIX *netrw-mh* {{{2
1821 (See |netrw-mf| and |netrw-mr| for how to mark files)
1822 (uses the local marked file list)
1823
1824This command extracts the suffices of the marked files and toggles their
1825presence on the hiding list. Please note that marking the same suffix
1826this way multiple times will result in the suffix's presence being toggled
1827for each file (so an even quantity of marked files having the same suffix
1828is the same as not having bothered to select them at all).
1829
1830Related topics: |netrw-a| |g:netrw_list_hide|
1831
1832MARKED FILES: MOVING *netrw-mm* {{{2
1833 (See |netrw-mf| and |netrw-mr| for how to mark files)
1834 (uses the global marked file list)
1835
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001836 WARNING: moving files is more dangerous than copying them.
1837 A file being moved is first copied and then deleted; if the
1838 copy operation fails and the delete succeeds, you will lose
1839 the file. Either try things out with unimportant files
1840 first or do the copy and then delete yourself using mc and D.
1841 Use at your own risk!
1842
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001843Select a target directory with mt (|netrw-mt|). Then change directory,
Bram Moolenaar446cb832008-06-24 21:56:24 +00001844select file(s) (see |netrw-mf|), and press "mm".
1845
1846Associated setting variable: |g:netrw_localmovecmd| |g:netrw_ssh_cmd|
1847
1848MARKED FILES: PRINTING *netrw-mp* {{{2
1849 (See |netrw-mf| and |netrw-mr| for how to mark files)
1850 (uses the local marked file list)
1851
1852Netrw will apply the |:hardcopy| command to marked files. What it does
1853is open each file in a one-line window, execute hardcopy, then close the
1854one-line window.
1855
1856
1857MARKED FILES: SOURCING *netrw-ms* {{{2
1858 (See |netrw-mf| and |netrw-mr| for how to mark files)
1859 (uses the local marked file list)
1860
1861Netrw will source the marked files (using vim's |:source| command)
1862
1863
1864MARKED FILES: TAGGING *netrw-mT* {{{2
1865 (See |netrw-mf| and |netrw-mr| for how to mark files)
1866 (uses the global marked file list)
1867
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001868The "mT" mapping will apply the command in |g:netrw_ctags| (by default, it is
Bram Moolenaar446cb832008-06-24 21:56:24 +00001869"ctags") to marked files. For remote browsing, in order to create a tags file
1870netrw will use ssh (see |g:netrw_ssh_cmd|), and so ssh must be available for
1871this to work on remote systems. For your local system, see |ctags| on how to
1872get a version. I myself use hdrtags, currently available at
1873http://mysite.verizon.net/astronaut/src/index.html , and have >
1874
1875 let g:netrw_ctags= "hdrtag"
1876<
1877in my <.vimrc>.
1878
1879When a remote set of files are tagged, the resulting tags file is "obtained";
1880ie. a copy is transferred to the local system's directory. The local tags
1881file is then modified so that one may use it through the network. The
1882modification is concerns the names of the files in the tags; each filename is
1883preceded by the netrw-compatible url used to obtain it. When one subsequently
1884uses one of the go to tag actions (|tags|), the url will be used by netrw to
1885edit the desired file and go to the tag.
1886
Bram Moolenaarc236c162008-07-13 17:41:49 +00001887Associated setting variables: |g:netrw_ctags| |g:netrw_ssh_cmd|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001888
1889
1890MARKED FILES: SETTING THE TARGET DIRECTORY *netrw-mt* {{{2
1891 (See |netrw-mf| and |netrw-mr| for how to mark files)
1892
1893Set the marked file copy/move-to target (see |netrw-mc| and |netrw-mm|):
1894
1895 * if the cursor is atop a file name, then the netrw window's currently
1896 displayed directory is used for the copy/move-to target.
1897
1898 * also, if the cursor is in the banner, then the netrw window's currently
1899 displayed directory is used for the copy/move-to target.
1900
1901 * however, if the cursor is atop a directory name, then that directory is
1902 used for the copy/move-to target
1903
1904There is only one copy/move-to target per vim session; ie. the target is a
1905script variable (see |s:var|) and is shared between all netrw windows (in an
1906instance of vim).
1907
1908MARKED FILES: UNMARKING *netrw-mu* {{{2
1909 (See |netrw-mf| and |netrw-mr| for how to mark files)
1910
1911The "mu" mapping will unmark all currently marked files.
1912
1913
1914NETRW BROWSER VARIABLES *netrw-browser-options* *netrw-browser-var* {{{2
1915
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001916(if you're interested in the netrw file transfer settings, see |netrw-options|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001917
1918The <netrw.vim> browser provides settings in the form of variables which
1919you may modify; by placing these settings in your <.vimrc>, you may customize
1920your browsing preferences. (see also: |netrw-settings|)
1921>
1922 --- -----------
1923 Var Explanation
1924 --- -----------
1925< *g:netrw_alto* change from above splitting to below splitting
1926 by setting this variable (see |netrw-o|)
1927 default: =&sb (see |'sb'|)
1928
1929 *g:netrw_altv* change from left splitting to right splitting
1930 by setting this variable (see |netrw-v|)
1931 default: =&spr (see |'spr'|)
1932
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001933 *g:netrw_banner* enable/suppress the banner
1934 =0: suppress the banner
1935 =1: banner is enabled (default)
1936 NOTE: suppressing the banner is a new feature
1937 which may cause problems.
1938
Bram Moolenaar446cb832008-06-24 21:56:24 +00001939 *g:netrw_browse_split* when browsing, <cr> will open the file by:
1940 =0: re-using the same window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001941 =1: horizontally splitting the window first
1942 =2: vertically splitting the window first
Bram Moolenaar446cb832008-06-24 21:56:24 +00001943 =3: open file in new tab
1944 =4: act like "P" (ie. open previous window)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001945 Note that |g:netrw_preview| may be used
1946 to get vertical splitting instead of
1947 horizontal splitting.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001948
1949 *g:netrw_browsex_viewer* specify user's preference for a viewer: >
1950 "kfmclient exec"
1951 "gnome-open"
1952< If >
1953 "-"
1954< is used, then netrwFileHandler() will look for
1955 a script/function to handle the given
1956 extension. (see |netrw_filehandler|).
1957
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001958 *g:netrw_chgperm* Unix/Linux: "chmod PERM FILENAME"
1959 Windows: "cacls FILENAME /e /p PERM"
1960 Used to change access permission for a file.
1961
Bram Moolenaar446cb832008-06-24 21:56:24 +00001962 *g:netrw_compress* ="gzip"
1963 Will compress marked files with this
1964 command
1965
Bram Moolenaarc236c162008-07-13 17:41:49 +00001966 *g:netrw_ctags* ="ctags"
1967 The default external program used to create tags
1968
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001969 *g:netrw_cursorline* = 1 (default)
1970 will use the |'cursorline'| local setting when
1971 |g:netrw_liststyle| ==0 (thin listing) or
1972 |g:netrw_liststyle| ==1 (long listing) or
1973 |g:netrw_liststyle| ==3 (tree listing)
1974 (ie. doesn't affect the wide listing)
1975 =0: off
1976 =2: like ==1, but the wide listing gets both
1977 cursorline and |'cursorcolumn'|locally set
1978
Bram Moolenaar446cb832008-06-24 21:56:24 +00001979 *g:netrw_decompress* = { ".gz" : "gunzip" ,
1980 ".bz2" : "bunzip2" ,
1981 ".zip" : "unzip" ,
1982 ".tar" : "tar -xf"}
1983 A dictionary mapping suffices to
1984 decompression programs.
1985
1986 *g:netrw_fastbrowse* =0: slow speed directory browsing;
1987 never re-uses directory listings,
1988 always obtains directory listings.
1989 =1: medium speed directory browsing;
1990 re-use directory listings only
1991 when remote directory browsing.
1992 (default value)
1993 =2: fast directory browsing;
1994 only obtains directory listings when the
1995 directory hasn't been seen before
1996 (or |netrw-ctrl-l| is used).
1997
1998 Fast browsing retains old directory listing
1999 buffers so that they don't need to be
2000 re-acquired. This feature is especially
2001 important for remote browsing. However, if
2002 a file is introduced or deleted into or from
2003 such directories, the old directory buffer
2004 becomes out-of-date. One may always refresh
2005 such a directory listing with |netrw-ctrl-l|.
2006 This option gives the user the choice of
2007 trading off accuracy (ie. up-to-date listing)
2008 versus speed.
2009
2010 *g:netrw_fname_escape* =' ?&;%'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002011 Used on filenames before remote reading/writing
Bram Moolenaar446cb832008-06-24 21:56:24 +00002012
2013 *g:netrw_ftp_browse_reject* ftp can produce a number of errors and warnings
2014 that can show up as "directories" and "files"
2015 in the listing. This pattern is used to
2016 remove such embedded messages. By default its
2017 value is:
2018 '^total\s\+\d\+$\|
2019 ^Trying\s\+\d\+.*$\|
2020 ^KERBEROS_V\d rejected\|
2021 ^Security extensions not\|
2022 No such file\|
2023 : connect to address [0-9a-fA-F:]*
2024 : No route to host$'
2025
2026 *g:netrw_ftp_list_cmd* options for passing along to ftp for directory
2027 listing. Defaults:
2028 unix or g:netrw_cygwin set: : "ls -lF"
2029 otherwise "dir"
2030
2031
2032 *g:netrw_ftp_sizelist_cmd* options for passing along to ftp for directory
2033 listing, sorted by size of file.
2034 Defaults:
2035 unix or g:netrw_cygwin set: : "ls -slF"
2036 otherwise "dir"
2037
2038 *g:netrw_ftp_timelist_cmd* options for passing along to ftp for directory
2039 listing, sorted by time of last modification.
2040 Defaults:
2041 unix or g:netrw_cygwin set: : "ls -tlF"
2042 otherwise "dir"
2043
Bram Moolenaar00a927d2010-05-14 23:24:24 +02002044 *g:netrw_glob_escape* ='[]*?`{~$' (unix)
2045 ='[]*?`{$' (windows
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002046 These characters in directory names are
Bram Moolenaar446cb832008-06-24 21:56:24 +00002047 escaped before applying glob()
2048
2049 *g:netrw_hide* if true, the hiding list is used
2050 default: =0
2051
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002052 *g:netrw_home* The home directory for where bookmarks and
2053 history are saved (as .netrwbook and
2054 .netrwhist).
2055 default: the first directory on the
2056 |'runtimepath'|
2057
Bram Moolenaar446cb832008-06-24 21:56:24 +00002058 *g:netrw_keepdir* =1 (default) keep current directory immune from
2059 the browsing directory.
2060 =0 keep the current directory the same as the
2061 browsing directory.
2062 The current browsing directory is contained in
2063 b:netrw_curdir (also see |netrw-c|)
2064
2065 *g:netrw_list_cmd* command for listing remote directories
2066 default: (if ssh is executable)
2067 "ssh HOSTNAME ls -FLa"
2068
2069 *g:netrw_liststyle* Set the default listing style:
2070 = 0: thin listing (one file per line)
2071 = 1: long listing (one file per line with time
2072 stamp information and file size)
2073 = 2: wide listing (multiple files in columns)
2074 = 3: tree style listing
2075 *g:netrw_list_hide* comma separated pattern list for hiding files
2076 Patterns are regular expressions (see |regexp|)
2077 Example: let g:netrw_list_hide= '.*\.swp$'
2078 default: ""
2079
2080 *g:netrw_localcopycmd* ="cp" Linux/Unix/MacOS/Cygwin
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002081 ="copy" Windows
Bram Moolenaar446cb832008-06-24 21:56:24 +00002082 Copies marked files (|netrw-mf|) to target
2083 directory (|netrw-mt|, |netrw-mc|)
2084
2085 *g:netrw_localmovecmd* ="mv" Linux/Unix/MacOS/Cygwin
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002086 ="move" Windows
Bram Moolenaar446cb832008-06-24 21:56:24 +00002087 Moves marked files (|netrw-mf|) to target
2088 directory (|netrw-mt|, |netrw-mm|)
2089
2090 *g:netrw_local_mkdir* command for making a local directory
2091 default: "mkdir"
2092
2093 *g:netrw_local_rmdir* remove directory command (rmdir)
2094 default: "rmdir"
2095
2096 *g:netrw_maxfilenamelen* =32 by default, selected so as to make long
2097 listings fit on 80 column displays.
2098 If your screen is wider, and you have file
2099 or directory names longer than 32 bytes,
2100 you may set this option to keep listings
2101 columnar.
2102
2103 *g:netrw_mkdir_cmd* command for making a remote directory
2104 default: "ssh USEPORT HOSTNAME mkdir"
2105
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002106 *g:netrw_mousemaps* =1 (default) enables the mouse buttons
2107 while browsing:
2108 leftmouse : open file/directory
2109 shift-leftmouse : mark file
2110 middlemouse : same as P
2111 rightmouse : remove file/directory
2112 =0: disables mouse maps
2113
2114 *g:netrw_retmap* if it exists and is set to one, then:
2115 * if in a netrw-selected file, AND
2116 * no normal-mode <2-leftmouse> mapping exists,
2117 then the <2-leftmouse> will be mapped for easy
Bram Moolenaar446cb832008-06-24 21:56:24 +00002118 return to the netrw browser window.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002119 example: click once to select and open a file,
2120 double-click to return.
2121
2122 Note that one may instead choose to:
2123 * let g:netrw_retmap= 1, AND
2124 * nmap <silent> YourChoice <Plug>NetrwReturn
2125 and have another mapping instead of
2126 <2-leftmouse> to invoke the return.
2127
2128 You may also use the |:Rexplore| command to do
2129 the same thing.
2130
Bram Moolenaar446cb832008-06-24 21:56:24 +00002131 default: =0
2132
2133 *g:netrw_rm_cmd* command for removing files
2134 default: "ssh USEPORT HOSTNAME rm"
2135
2136 *g:netrw_rmdir_cmd* command for removing directories
2137 default: "ssh USEPORT HOSTNAME rmdir"
2138
2139 *g:netrw_rmf_cmd* command for removing softlinks
2140 default: "ssh USEPORT HOSTNAME rm -f"
2141
2142 *g:netrw_sort_by* sort by "name", "time", or "size"
2143 default: "name"
2144
2145 *g:netrw_sort_direction* sorting direction: "normal" or "reverse"
2146 default: "normal"
2147
Bram Moolenaarc236c162008-07-13 17:41:49 +00002148 *g:netrw_sort_options* sorting is done using |:sort|; this
2149 variable's value is appended to the
2150 sort command. Thus one may ignore case,
2151 for example, with the following in your
2152 .vimrc: >
2153 let g:netrw_sort_options="i"
2154< default: ""
2155
Bram Moolenaar446cb832008-06-24 21:56:24 +00002156 *g:netrw_sort_sequence* when sorting by name, first sort by the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002157 comma-separated pattern sequence. Note that
2158 the filigree added to indicate filetypes
2159 should be accounted for in your pattern.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002160 default: '[\/]$,*,\.bak$,\.o$,\.h$,
2161 \.info$,\.swp$,\.obj$'
2162
2163 *g:netrw_special_syntax* If true, then certain files will be shown
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002164 in special syntax in the browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00002165
2166 netrwBak : *.bak
2167 netrwCompress: *.gz *.bz2 *.Z *.zip
2168 netrwData : *.dat
2169 netrwHdr : *.h
2170 netrwLib : *.a *.so *.lib *.dll
2171 netrwMakefile: [mM]akefile *.mak
2172 netrwObj : *.o *.obj
2173 netrwTags : tags ANmenu ANtags
2174 netrwTilde : *~
2175 netrwTmp : tmp* *tmp
2176
2177 These syntax highlighting groups are linked
2178 to Folded or DiffChange by default
2179 (see |hl-Folded| and |hl-DiffChange|), but
2180 one may put lines like >
2181 hi link netrwCompress Visual
2182< into one's <.vimrc> to use one's own
2183 preferences.
2184
2185 *g:netrw_ssh_cmd* One may specify an executable command
2186 to use instead of ssh for remote actions
2187 such as listing, file removal, etc.
2188 default: ssh
2189
2190 *g:netrw_ssh_browse_reject* ssh can sometimes produce unwanted lines,
2191 messages, banners, and whatnot that one doesn't
2192 want masquerading as "directories" and "files".
2193 Use this pattern to remove such embedded
2194 messages. By default its value is:
2195 '^total\s\+\d\+$'
2196
2197
2198 *g:netrw_tmpfile_escape* =' &;'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002199 escape() is applied to all temporary files
Bram Moolenaar446cb832008-06-24 21:56:24 +00002200 to escape these characters.
2201
2202 *g:netrw_timefmt* specify format string to vim's strftime().
2203 The default, "%c", is "the preferred date
2204 and time representation for the current
2205 locale" according to my manpage entry for
2206 strftime(); however, not all are satisfied
2207 with it. Some alternatives:
2208 "%a %d %b %Y %T",
2209 " %a %Y-%m-%d %I-%M-%S %p"
2210 default: "%c"
2211
2212 *g:netrw_use_noswf* netrw normally avoids writing swapfiles
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002213 for browser buffers. However, under some
Bram Moolenaar446cb832008-06-24 21:56:24 +00002214 systems this apparently is causing nasty
2215 ml_get errors to appear; if you're getting
2216 ml_get errors, try putting
2217 let g:netrw_use_noswf= 0
2218 in your .vimrc.
2219
2220 *g:netrw_winsize* specify initial size of new windows made with
2221 "o" (see |netrw-o|), "v" (see |netrw-v|),
2222 |:Hexplore| or |:Vexplore|.
2223 default: ""
2224
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002225 *g:netrw_xstrlen* Controls how netrw computes string lengths,
2226 including multi-byte characters' string
Bram Moolenaar446cb832008-06-24 21:56:24 +00002227 length. (thanks to N Weibull, T Mechelynck)
2228 =0: uses Vim's built-in strlen()
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002229 =1: number of codepoints (Latin a + combining
Bram Moolenaar446cb832008-06-24 21:56:24 +00002230 circumflex is two codepoints) (DEFAULT)
2231 =2: number of spacing codepoints (Latin a +
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002232 combining circumflex is one spacing
Bram Moolenaar446cb832008-06-24 21:56:24 +00002233 codepoint; a hard tab is one; wide and
2234 narrow CJK are one each; etc.)
2235 =3: virtual length (counting tabs as anything
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002236 between 1 and |'tabstop'|, wide CJK as 2
Bram Moolenaar446cb832008-06-24 21:56:24 +00002237 rather than 1, Arabic alif as zero when
2238 immediately preceded by lam, one
2239 otherwise, etc)
2240
2241 *g:NetrwTopLvlMenu* This variable specifies the top level
2242 menu name; by default, it's "Netrw.". If
2243 you wish to change this, do so in your
2244 .vimrc.
2245
2246NETRW BROWSING AND OPTION INCOMPATIBILITIES *netrw-incompatible* {{{2
2247
2248Netrw has been designed to handle user options by saving them, setting the
2249options to something that's compatible with netrw's needs, and then restoring
2250them. However, the autochdir option: >
2251 :set acd
2252is problematical. Autochdir sets the current directory to that containing the
2253file you edit; this apparently also applies to directories. In other words,
2254autochdir sets the current directory to that containing the "file" (even if
2255that "file" is itself a directory).
2256
2257NETRW SETTINGS *netrw-settings* {{{2
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00002258
2259With the NetrwSettings.vim plugin, >
2260 :NetrwSettings
2261will bring up a window with the many variables that netrw uses for its
Bram Moolenaar1afcace2005-11-25 19:54:28 +00002262settings. You may change any of their values; when you save the file, the
2263settings therein will be used. One may also press "?" on any of the lines for
2264help on what each of the variables do.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00002265
Bram Moolenaar446cb832008-06-24 21:56:24 +00002266(also see: |netrw-browser-var| |netrw-protocol| |netrw-var| |netrw-variables|)
Bram Moolenaar9964e462007-05-05 17:54:07 +00002267
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00002268
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002269==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00002270OBTAINING A FILE *netrw-O* {{{2
2271
2272If there are no marked files:
2273
2274 When browsing a remote directory, one may obtain a file under the cursor
2275 (ie. get a copy on your local machine, but not edit it) by pressing the O
2276 key.
2277
2278If there are marked files:
2279
2280 The marked files will be obtained (ie. a copy will be transferred to your
2281 local machine, but not set up for editing).
2282
2283Only ftp and scp are supported for this operation (but since these two are
2284available for browsing, that shouldn't be a problem). The status bar will
2285then show, on its right hand side, a message like "Obtaining filename". The
2286statusline will be restored after the transfer is complete.
2287
2288Netrw can also "obtain" a file using the local browser. Netrw's display
2289of a directory is not necessarily the same as Vim's "current directory",
2290unless |g:netrw_keepdir| is set to 0 in the user's <.vimrc>. One may select
2291a file using the local browser (by putting the cursor on it) and pressing
2292"O" will then "obtain" the file; ie. copy it to Vim's current directory.
2293
2294Related topics:
2295 * To see what the current directory is, use |:pwd|
2296 * To make the currently browsed directory the current directory, see |netrw-c|
2297 * To automatically make the currently browsed directory the current
2298 directory, see |g:netrw_keepdir|.
2299
2300
Bram Moolenaarc236c162008-07-13 17:41:49 +00002301OPEN A NEW FILE IN NETRW'S CURRENT DIRECTORY *netrw-%*
2302
2303To open a file in netrw's current directory, press "%". This map will
2304query the user for a new filename; an empty file by that name will be
2305placed in the netrw's current directory (ie. b:netrw_curdir).
2306
2307
Bram Moolenaar446cb832008-06-24 21:56:24 +00002308PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2
2309
2310One may use a preview window by using the "p" key when the cursor is atop the
2311desired filename to be previewed. The display will then split to show both
2312the browser (where the cursor will remain) and the file (see |:pedit|).
2313By default, the split will be taken horizontally; one may use vertical
2314splitting if one has set |g:netrw_preview| first.
2315
Bram Moolenaar00a927d2010-05-14 23:24:24 +02002316An interesting set of netrw settings is: >
2317
2318 let g:netrw_preview = 1
2319 let g:netrw_liststyle = 3
2320 let g:netrw_winsize = 30
2321
2322These will:
2323 1. Make vertical splitting the default for previewing files
2324 2. Make the default listing style "tree"
2325 3. When a vertical preview window is opened, the directory listing
2326 will use only 30 columns; the rest of the window is used for the
2327 preview window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002328
2329PREVIOUS WINDOW *netrw-P* *netrw-prvwin* {{{2
2330
2331To edit a file or directory in the previously used (last accessed) window (see
2332:he |CTRL-W_p|), press a "P". If there's only one window, then the one window
2333will be horizontally split (above/below splitting is controlled by
2334|g:netrw_alto|, and its initial size is controlled by |g:netrw_winsize|).
2335
2336If there's more than one window, the previous window will be re-used on
2337the selected file/directory. If the previous window's associated buffer
2338has been modified, and there's only one window with that buffer, then
2339the user will be asked if s/he wishes to save the buffer first (yes,
2340no, or cancel).
2341
2342
2343REFRESHING THE LISTING *netrw-ctrl-l* *netrw-ctrl_l* {{{2
2344
2345To refresh either a local or remote directory listing, press ctrl-l (<c-l>) or
2346hit the <cr> when atop the ./ directory entry in the listing. One may also
2347refresh a local directory by using ":e .".
2348
2349
2350RENAMING FILES OR DIRECTORIES *netrw-move* *netrw-rename* *netrw-R* {{{2
2351
2352If there are no marked files: (see |netrw-mf|)
2353
2354 Renaming/moving files and directories involves moving the cursor to the
2355 file/directory to be moved (renamed) and pressing "R". You will then be
2356 queried for where you want the file/directory to be moved. You may select
2357 a range of lines with the "V" command (visual selection), and then
2358 pressing "R".
2359
2360If there are marked files: (see |netrw-mf|)
2361
2362 Marked files will be renamed (moved). You will be queried as above in
2363 order to specify where you want the file/directory to be moved.
2364
2365 WARNING:~
2366
2367 Note that moving files is a dangerous operation; copies are safer. That's
2368 because a "move" for remote files is actually a copy + delete -- and if
2369 the copy fails and the delete does not, you may lose the file.
2370
2371The g:netrw_rename_cmd variable is used to implement renaming. By default its
2372value is:
2373
2374 ssh HOSTNAME mv
2375
2376One may rename a block of files and directories by selecting them with
2377the V (|linewise-visual|).
2378
2379
2380REVERSING SORTING ORDER *netrw-r* *netrw-reverse* {{{2
2381
2382One may toggle between normal and reverse sorting order by pressing the
2383"r" key.
2384
2385Related topics: |netrw-s|
2386Associated setting variable: |g:netrw_sort_direction|
2387
2388
2389SELECTING SORTING STYLE *netrw-s* *netrw-sort* {{{2
2390
2391One may select the sorting style by name, time, or (file) size. The "s" map
2392allows one to circulate amongst the three choices; the directory listing will
2393automatically be refreshed to reflect the selected style.
2394
2395Related topics: |netrw-r| |netrw-S|
2396Associated setting variables: |g:netrw_sort_by| |g:netrw_sort_sequence|
2397
2398
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002399SETTING EDITING WINDOW *netrw-C* {{{2
2400
2401One may select a netrw window for editing with the "C" mapping, or by setting
2402g:netrw_chgwin to the selected window number. Subsequent selection of a file
2403to edit (|netrw-cr|) will use that window.
2404
2405Related topics: |netrw-cr|
2406Associated setting variables: |g:netrw_chgwin|
2407
2408
Bram Moolenaar446cb832008-06-24 21:56:24 +0000240910. Problems and Fixes *netrw-problems* {{{1
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002410
2411 (This section is likely to grow as I get feedback)
2412 (also see |netrw-debug|)
Bram Moolenaar488c6512005-08-11 20:09:58 +00002413 *netrw-p1*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002414 P1. I use windows 95, and my ftp dumps four blank lines at the
2415 end of every read.
2416
2417 See |netrw-fixup|, and put the following into your
2418 <.vimrc> file:
2419
2420 let g:netrw_win95ftp= 1
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00002421
Bram Moolenaar488c6512005-08-11 20:09:58 +00002422 *netrw-p2*
Bram Moolenaar9964e462007-05-05 17:54:07 +00002423 P2. I use Windows, and my network browsing with ftp doesn't sort by
2424 time or size! -or- The remote system is a Windows server; why
2425 don't I get sorts by time or size?
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002426
2427 Windows' ftp has a minimal support for ls (ie. it doesn't
2428 accept sorting options). It doesn't support the -F which
2429 gives an explanatory character (ABC/ for "ABC is a directory").
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002430 Netrw then uses "dir" to get both its thin and long listings.
Bram Moolenaar9964e462007-05-05 17:54:07 +00002431 If you think your ftp does support a full-up ls, put the
2432 following into your <.vimrc>: >
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002433
Bram Moolenaar9964e462007-05-05 17:54:07 +00002434 let g:netrw_ftp_list_cmd = "ls -lF"
2435 let g:netrw_ftp_timelist_cmd= "ls -tlF"
2436 let g:netrw_ftp_sizelist_cmd= "ls -slF"
2437<
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002438 Alternatively, if you have cygwin on your Windows box, put
Bram Moolenaar9964e462007-05-05 17:54:07 +00002439 into your <.vimrc>: >
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002440
2441 let g:netrw_cygwin= 1
Bram Moolenaar9964e462007-05-05 17:54:07 +00002442<
2443 This problem also occurs when the remote system is Windows.
2444 In this situation, the various g:netrw_ftp_[time|size]list_cmds
2445 are as shown above, but the remote system will not correctly
2446 modify its listing behavior.
2447
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002448
Bram Moolenaar488c6512005-08-11 20:09:58 +00002449 *netrw-p3*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002450 P3. I tried rcp://user@host/ (or protocol other than ftp) and netrw
2451 used ssh! That wasn't what I asked for...
2452
2453 Netrw has two methods for browsing remote directories: ssh
2454 and ftp. Unless you specify ftp specifically, ssh is used.
2455 When it comes time to do download a file (not just a directory
2456 listing), netrw will use the given protocol to do so.
2457
Bram Moolenaar488c6512005-08-11 20:09:58 +00002458 *netrw-p4*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002459 P4. I would like long listings to be the default.
2460
Bram Moolenaar446cb832008-06-24 21:56:24 +00002461 Put the following statement into your |.vimrc|: >
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002462
Bram Moolenaar446cb832008-06-24 21:56:24 +00002463 let g:netrw_liststyle= 1
2464<
2465 Check out |netrw-browser-var| for more customizations that
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002466 you can set.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002467
Bram Moolenaar488c6512005-08-11 20:09:58 +00002468 *netrw-p5*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002469 P5. My times come up oddly in local browsing
2470
2471 Does your system's strftime() accept the "%c" to yield dates
2472 such as "Sun Apr 27 11:49:23 1997"? If not, do a "man strftime"
2473 and find out what option should be used. Then put it into
Bram Moolenaar446cb832008-06-24 21:56:24 +00002474 your |.vimrc|: >
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002475
Bram Moolenaar446cb832008-06-24 21:56:24 +00002476 let g:netrw_timefmt= "%X" (where X is the option)
2477<
Bram Moolenaar488c6512005-08-11 20:09:58 +00002478 *netrw-p6*
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002479 P6. I want my current directory to track my browsing.
2480 How do I do that?
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002481
Bram Moolenaar446cb832008-06-24 21:56:24 +00002482 Put the following line in your |.vimrc|:
2483>
Bram Moolenaar433f7c82006-03-21 21:29:36 +00002484 let g:netrw_keepdir= 0
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002485<
Bram Moolenaar9964e462007-05-05 17:54:07 +00002486 *netrw-p7*
2487 P7. I use Chinese (or other non-ascii) characters in my filenames, and
2488 netrw (Explore, Sexplore, Hexplore, etc) doesn't display them!
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00002489
Bram Moolenaar9964e462007-05-05 17:54:07 +00002490 (taken from an answer provided by Wu Yongwei on the vim
2491 mailing list)
2492 I now see the problem. You code page is not 936, right? Vim
2493 seems only able to open files with names that are valid in the
2494 current code page, as are many other applications that do not
2495 use the Unicode version of Windows APIs. This is an OS-related
2496 issue. You should not have such problems when the system
2497 locale uses UTF-8, such as modern Linux distros.
2498
2499 (...it is one more reason to recommend that people use utf-8!)
2500
2501 *netrw-p8*
2502 P8. I'm getting "ssh is not executable on your system" -- what do I
2503 do?
2504
2505 (Dudley Fox) Most people I know use putty for windows ssh. It
2506 is a free ssh/telnet application. You can read more about it
2507 here:
2508
2509 http://www.chiark.greenend.org.uk/~sgtatham/putty/ Also:
2510
2511 (Marlin Unruh) This program also works for me. It's a single
2512 executable, so he/she can copy it into the Windows\System32
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002513 folder and create a shortcut to it.
Bram Moolenaar9964e462007-05-05 17:54:07 +00002514
2515 (Dudley Fox) You might also wish to consider plink, as it
2516 sounds most similar to what you are looking for. plink is an
2517 application in the putty suite.
2518
2519 http://the.earth.li/~sgtatham/putty/0.58/htmldoc/Chapter7.html#plink
2520
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002521 (Vissale Neang) Maybe you can try OpenSSH for windows, which
Bram Moolenaar9964e462007-05-05 17:54:07 +00002522 can be obtained from:
2523
2524 http://sshwindows.sourceforge.net/
2525
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002526 It doesn't need the full Cygwin package.
Bram Moolenaar9964e462007-05-05 17:54:07 +00002527
2528 (Antoine Mechelynck) For individual Unix-like programs needed
2529 for work in a native-Windows environment, I recommend getting
2530 them from the GnuWin32 project on sourceforge if it has them:
2531
2532 http://gnuwin32.sourceforge.net/
2533
2534 Unlike Cygwin, which sets up a Unix-like virtual machine on
2535 top of Windows, GnuWin32 is a rewrite of Unix utilities with
2536 Windows system calls, and its programs works quite well in the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002537 cmd.exe "Dos box".
Bram Moolenaar9964e462007-05-05 17:54:07 +00002538
2539 (dave) Download WinSCP and use that to connect to the server.
2540 In Preferences > Editors, set gvim as your editor:
2541
2542 - Click "Add..."
2543 - Set External Editor (adjust path as needed, include
2544 the quotes and !.! at the end):
2545 "c:\Program Files\Vim\vim70\gvim.exe" !.!
2546 - Check that the filetype in the box below is
2547 {asterisk}.{asterisk} (all files), or whatever types
2548 you want (cec: change {asterisk} to * ; I had to
2549 write it that way because otherwise the helptags
Bram Moolenaar446cb832008-06-24 21:56:24 +00002550 system thinks it's a tag)
2551 - Make sure it's at the top of the listbox (click it,
2552 then click "Up" if it's not)
Bram Moolenaar9964e462007-05-05 17:54:07 +00002553 If using the Norton Commander style, you just have to hit <F4>
2554 to edit a file in a local copy of gvim.
2555
2556 (Vit Gottwald) How to generate public/private key and save
2557 public key it on server: >
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +02002558 http://www.chiark.greenend.org.uk/~sgtatham/putty/0.60/htmldoc/Chapter8.html#pubkey-gettingready
2559 (8.3 Getting ready for public key authentication)
Bram Moolenaar9964e462007-05-05 17:54:07 +00002560<
Bram Moolenaar446cb832008-06-24 21:56:24 +00002561 How to use a private key with 'pscp': >
2562
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +02002563 http://www.chiark.greenend.org.uk/~sgtatham/putty/0.60/htmldoc/Chapter5.html
2564 (5.2.4 Using public key authentication with PSCP)
Bram Moolenaar9964e462007-05-05 17:54:07 +00002565<
Bram Moolenaar446cb832008-06-24 21:56:24 +00002566 (Ben Schmidt) I find the ssh included with cwRsync is
2567 brilliant, and install cwRsync or cwRsyncServer on most
2568 Windows systems I come across these days. I guess COPSSH,
2569 packed by the same person, is probably even better for use as
2570 just ssh on Windows, and probably includes sftp, etc. which I
2571 suspect the cwRsync doesn't, though it might
2572
Bram Moolenaar9964e462007-05-05 17:54:07 +00002573 (cec) To make proper use of these suggestions above, you will
2574 need to modify the following user-settable variables in your
2575 .vimrc:
2576
Bram Moolenaar446cb832008-06-24 21:56:24 +00002577 |g:netrw_ssh_cmd| |g:netrw_list_cmd| |g:netrw_mkdir_cmd|
2578 |g:netrw_rm_cmd| |g:netrw_rmdir_cmd| |g:netrw_rmf_cmd|
Bram Moolenaar9964e462007-05-05 17:54:07 +00002579
2580 The first one (|g:netrw_ssh_cmd|) is the most important; most
2581 of the others will use the string in g:netrw_ssh_cmd by
2582 default.
2583 *netrw-p9* *netrw-ml_get*
2584 P9. I'm browsing, changing directory, and bang! ml_get errors
2585 appear and I have to kill vim. Any way around this?
2586
2587 Normally netrw attempts to avoid writing swapfiles for
2588 its temporary directory buffers. However, on some systems
2589 this attempt appears to be causing ml_get errors to
2590 appear. Please try setting |g:netrw_use_noswf| to 0
2591 in your <.vimrc>: >
2592 let g:netrw_use_noswf= 0
2593<
Bram Moolenaar446cb832008-06-24 21:56:24 +00002594 *netrw-p10*
2595 P10. I'm being pestered with "[something] is a directory" and
2596 "Press ENTER or type command to continue" prompts...
2597
2598 The "[something] is a directory" prompt is issued by Vim,
2599 not by netrw, and there appears to be no way to work around
2600 it. Coupled with the default cmdheight of 1, this message
2601 causes the "Press ENTER..." prompt. So: read |hit-enter|;
2602 I also suggest that you set your |'cmdheight'| to 2 (or more) in
2603 your <.vimrc> file.
2604
2605 *netrw-p11*
2606 P11. I want to have two windows; a thin one on the left and my editing
2607 window on the right. How can I do this?
2608
2609 * Put the following line in your <.vimrc>:
2610 let g:netrw_altv = 1
2611 * Edit the current directory: :e .
2612 * Select some file, press v
2613 * Resize the windows as you wish (see |CTRL-W_<| and
2614 |CTRL-W_>|). If you're using gvim, you can drag
2615 the separating bar with your mouse.
2616 * When you want a new file, use ctrl-w h to go back to the
2617 netrw browser, select a file, then press P (see |CTRL-W_h|
2618 and |netrw-P|). If you're using gvim, you can press
2619 <leftmouse> in the browser window and then press the
2620 <middlemouse> to select the file.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002621
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002622 *netrw-p12*
2623 P12. My directory isn't sorting correctly, or unwanted letters are
2624 appearing in the listed filenames, or things aren't lining
2625 up properly in the wide listing, ...
2626
2627 This may be due to an encoding problem. I myself usually use
2628 utf-8, but really only use ascii (ie. bytes from 32-126).
2629 Multibyte encodings use two (or more) bytes per character.
2630 You may need to change |g:netrw_sepchr| and/or |g:netrw_xstrlen|.
2631
Bram Moolenaar00a927d2010-05-14 23:24:24 +02002632 *netrw-p13*
2633 P13. I'm a Windows + putty + ssh user, and when I attempt to browse,
2634 the directories are missing trailing "/"s so netrw treats them
2635 as file transfers instead of as attempts to browse
2636 subdirectories. How may I fix this?
2637
2638 (mikeyao) If you want to use vim via ssh and putty under Windows,
2639 try combining the use of pscp/psftp with plink. pscp/psftp will
2640 be used to connect and plink will be used to execute commands on
2641 the server, for example: list files and directory using 'ls'.
2642
2643 These are the settings I use to do this:
2644>
2645 " list files, it's the key setting, if you haven't set,
2646 " you will get a blank buffer
2647 let g:netrw_list_cmd = "plink HOSTNAME ls -Fa"
2648 " if you haven't add putty directory in system path, you should
2649 " specify scp/sftp command. For examples:
2650 "let g:netrw_sftp_cmd = "d:\\dev\\putty\\PSFTP.exe"
2651 "let g:netrw_scp_cmd = "d:\\dev\\putty\\PSCP.exe"
2652<
2653
2654
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002655==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +0000265611. Debugging Netrw Itself *netrw-debug* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657
2658The <netrw.vim> script is typically available as:
Bram Moolenaar488c6512005-08-11 20:09:58 +00002659>
Bram Moolenaar446cb832008-06-24 21:56:24 +00002660 /usr/local/share/vim/vim6x/plugin/netrwPlugin.vim
2661 /usr/local/share/vim/vim6x/autoload/netrw.vim
Bram Moolenaar488c6512005-08-11 20:09:58 +00002662< -or- >
Bram Moolenaar446cb832008-06-24 21:56:24 +00002663 /usr/local/share/vim/vim7x/plugin/netrwPlugin.vim
2664 /usr/local/share/vim/vim7x/autoload/netrw.vim
Bram Moolenaar488c6512005-08-11 20:09:58 +00002665<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666which is loaded automatically at startup (assuming :set nocp).
2667
2668 1. Get the <Decho.vim> script, available as:
2669
Bram Moolenaar446cb832008-06-24 21:56:24 +00002670 http://mysite.verizon.net/astronaut/vim/index.html#DECHO
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 or
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00002672 http://vim.sourceforge.net/scripts/script.php?script_id=120
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673
Bram Moolenaar446cb832008-06-24 21:56:24 +00002674 It now comes as a "vimball"; if you're using vim 7.0 or earlier,
2675 you'll need to update vimball, too. See
2676 http://mysite.verizon.net/astronaut/vim/index.html#VIMBALL
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00002677
Bram Moolenaar446cb832008-06-24 21:56:24 +00002678 2. Edit the <netrw.vim> file by typing: >
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002679
2680 vim netrw.vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 :DechoOn
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002682 :wq
Bram Moolenaar446cb832008-06-24 21:56:24 +00002683<
2684 To restore to normal non-debugging behavior, re-edit <netrw.vim>
2685 and type >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002687 vim netrw.vim
2688 :DechoOff
2689 :wq
Bram Moolenaar446cb832008-06-24 21:56:24 +00002690<
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002691 This command, provided by <Decho.vim>, will comment out all
2692 Decho-debugging statements (Dfunc(), Dret(), Decho(), Dredir()).
2693
Bram Moolenaar446cb832008-06-24 21:56:24 +00002694 3. Then bring up vim and attempt to evoke the problem by doing a
2695 transfer or doing some browsing. A set of messages should appear
2696 concerning the steps that <netrw.vim> took in attempting to
2697 read/write your file over the network in a separate tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698
Bram Moolenaar9964e462007-05-05 17:54:07 +00002699 To save the file, use >
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002700 :tabnext
Bram Moolenaar9964e462007-05-05 17:54:07 +00002701 :set bt=
2702 :w! DBG
2703< Please send that information to <netrw.vim>'s maintainer, >
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002704 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
Bram Moolenaar9964e462007-05-05 17:54:07 +00002705<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706==============================================================================
Bram Moolenaar9964e462007-05-05 17:54:07 +0000270712. History *netrw-history* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708
Bram Moolenaar477db062010-07-28 18:17:41 +02002709 v140: Jul 27, 2010 * (Lech Lorens) unexpected change of window
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +02002710 v139: May 14, 2010 * when viewing remote directory listings and
2711 changing listing style, going to tree listing
2712 mode was issuing two rather useless messages
2713 about the buffer name. They have now been
2714 silenced.
2715 * (Jean Johner) with "behave mswin", clicking
2716 on a filename in wide mode opened a new file
2717 with a missing first letter
2718 * (Britton Kerin) wanted netrw listings to be
2719 buflisted; the |g:netrw_bufsettings| option
2720 permits that.
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +02002721 Jun 18, 2010 * (Jan Steffens) added support for xz compression
2722 Jun 23, 2010 * vimdiff dir1 dir2 now works
Bram Moolenaar477db062010-07-28 18:17:41 +02002723 Jul 27, 2010 * (John Orr) pointed out that the intended maparg
2724 test for gx was actually testing for g rather
2725 than gx. Fixed.
Bram Moolenaar00a927d2010-05-14 23:24:24 +02002726 v138: May 01, 2010 * added the bomb setting to the Save-Set-Restore
2727 option handling (for Tony M)
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +02002728 May 14, 2010 * (Bram Moolenaar) netrw optionally sets cursorline
Bram Moolenaar00a927d2010-05-14 23:24:24 +02002729 (and sometimes cursorcolumn) for its display.
2730 This option setting was leaking through with
2731 remote file handling.
2732 v137: Dec 28, 2009 * modified the preview window handling for
2733 vertically split windows. The preview
2734 window will take up all but g:netrw_winsize
2735 columns of the original window; those
2736 g:netrw_winsize columns will be used for
2737 the netrw listing.
2738 * (Simon Dambe) removed "~" from
2739 |g:netrw_glob_escape| under Windows
2740 * (Bram Moolenaar) modified test for status bar
2741 click with leftmouse. Moved code to
2742 s:NetrwLeftmouse().
2743 Feb 24, 2010 * (for Jean Johner) added insert-mode maps; one
2744 can get into insert mode with netrw via
2745 ctrl-o :e .
2746 Mar 15, 2010 * (Dominique Pellé) Directory with backslashes such
2747 as foo\bar were not being entered/left properly
2748 Mar 15, 2010 * Using :Explore .. and causing two FocusGained
2749 events caused the directory to change. Fixed.
2750 Mar 22, 2010 * Last fix caused problems for *//pat and */filepat
2751 searches.
2752 Mar 30, 2010 * With :set hidden and changing listing styles 8
2753 times, the tree listing buffer was being marked
2754 as modified upon exit. Fixed.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002755 v136: Jan 14, 2009 * extended |g:Netrw_funcref| to also handle lists
2756 of function references
2757 Jan 14, 2009 * (reported by Marvin Renich) with spell check
2758 enabled, some filenamess will still being
2759 displayed as spelling errors.
2760 Apr 13, 2009 * (Björn Winckler) writing a file using
2761 remote scp caused syntax highlighting problem.
2762 Solution: avoid syntax/syntax.vim's
2763 au Filetype * syntax setting autocommand by
2764 checking that the current buffer has the
2765 netrw filetype before attempting a doau
2766 in s:NetrwSafeOptions().
2767 Apr 14, 2009 * (asgeo1) suggested the "T" map (|netrw-T|)
2768 Apr 14, 2009 * marking wasn't working on executable and
2769 other special filenames
2770 Apr 20, 2009 * (Dennis Benzinger) files opened via http have
2771 their syntax filetype auto-detected
2772 Jun 19, 2009 * (Yukihiro Nakadaira) help document improvements
2773 Jul 22, 2009 * g:netrw_browse_split will honor the
2774 |'equalalways'| setting.
2775 Jul 29, 2009 * implemented "I" mapping to toggle banner
2776 (this is experimental and still being debugged)
2777 Sep 19, 2009 * (Mike McEwan) writes via ftp now send both
2778 g:netrw_ftpmode and g:netrw_ftpextracmd (if the
2779 latter exists)
2780 Dec 02, 2009 * netrw uses vimgrep several places; it now uses
2781 "noautocmd vimgrep" (should be speedier).
2782 Dec 03, 2009 * changed back to using -source instead of -dump
2783 for elinks-using commands. (requested by James
2784 Vega and Karsten Hopp)
2785 v135: Oct 29, 2008 * using |simplify()| on directory names
2786 (supporting handling ".."s in directory names)
2787 Oct 31, 2008 * added special file highlighting for core dumps
2788 under Unix/Linux. The default sorting sequence
2789 now also gives core dumps priority.
2790 Nov 10, 2008 * uses a call to netrw#Nread() instead of Nread
2791 to avoid having to use fnameescape()
2792 * fixed a tree redrawing problem (open directory,
2793 open subdir, close subdir, close dir)
2794 Nov 19, 2008 * sprinkled some histdel("/",-1)s through the code
2795 in an attempt to prevent netrw from changing
2796 the search history.
2797 Jan 02, 2009 * |g:Netrw_funcref| included
2798 Jan 05, 2009 * Explore */ **/ *// **// all clear explorer
2799 variables
2800 Jan 05, 2009 * (Panagiotis Louridas) extended s:WinPath()
2801 to remove cygdrive from non-cygwin Windows
2802 paths. Improved the determination as to
2803 whether or not to do so.
2804 Jan 13, 2009 * included contains=@NoSpell in every syntax
2805 group for syntax/netrw.vim .
2806 v134: Sep 30, 2008 * (Sander Marechal) provided a bugfix involving
2807 the use of the |netrw-t| command with a remote
2808 directory.
2809 Sep 30, 2008 * using "x" on a remote jpg was failing; fixed.
2810 Oct 03, 2008 * bookmarks now go on a list and are stored to
2811 the first directory on the |'runtimepath'| in
2812 the hopes of making their retention reliable.
2813 History now also goes to that directory.
2814 Oct 07, 2008 * Included check that vim 7.0 or later is in use.
2815 Oct 07, 2008 * Improved |g:netrw_retmap| handling.
2816 Oct 12, 2008 * Based upon Sébastien Migniot's suggestion, if
2817 cadaver isn't available then netrw will try to
2818 use curl for the dav://... protocol.
2819 Oct 13, 2008 * added @*/ to netrw buffers' |'iskeyword'|setting
2820 This lets mf (|netrw-mf|) mark directories, links
2821 and executables.
2822 Oct 13, 2008 * avoids a second NetrwBrowse() refresh when
2823 g:netrw_fastbrowse is <= 1 (slow, medium speed)
2824 Oct 22, 2008 * |g:netrw_http_xcmd| may now be overridden
2825 independently of |g:netrw_http_cmd|.
2826 Oct 23, 2008 * [N] added to the various Explore commands to
2827 let users specify the width/height of new
2828 explorer windows, overriding |g:netrw_winsize|.
2829 v133: Aug 10, 2008 * NetReadFixup() for win95 was missing some "a:"s
2830 Aug 12, 2008 * (Jan Minář) an error condition in NetrwMethod()
2831 wasn't being used, resulting in "b:netrw_fname
2832 undefined" errors
2833 Aug 12, 2008 * (François Ingeirest) asked that "hi link" be
2834 changed to hi default link in the netrw syntax
2835 files.
2836 Aug 12, 2008 * using s:NetrwUnmarkList() more often. Filenames
2837 were being left on the global list when removed
2838 from the buffer-local lists.
2839 Aug 14, 2008 * (Joshua Clayton) an errant extra ")" was left in
2840 the rcp-handling portion of NetRead().
2841 Sep 03, 2008 * added |'cursorline'| highlighting to thin, long,
2842 and tree displays.
Bram Moolenaared39e1d2008-08-09 17:55:22 +00002843 v132: Aug 06, 2008 * Fixed marked file-based obtain
2844 Aug 08, 2008 * sourcing a file via ftp from a netrw-generated
2845 buffer (or any buffer with |'nobl'|) left an
2846 empty no-name buffer in its wake. Fixed.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002847 v130: Jul 31, 2008 * trying out elinks/links for http://host/
2848 requests. One problem: in-page links
2849 (such as with ...#LABEL) are not supported
2850 * verified that Bram's modified netrwPlugin works
2851 Aug 01, 2008 * fixed a bug: when sourcing a file via ftp, the
2852 "filter window" was left behind.
2853 v129: Jul 31, 2008 * bug found in non-mouse enabled vim and some
2854 local maps
2855 v128: Jul 30, 2008 * much work done in using shellescape() and
2856 fnameescape()
Bram Moolenaarc236c162008-07-13 17:41:49 +00002857 v126: Jun 30, 2008 * after having gone to a remote directory,
2858 <f1> was no longer taking one to the correct
2859 entry in the help (|netrw-quickhelp|). Fixed.
2860 Jul 01, 2008 * extracting the last filename from a wide listing
2861 missed the last letter when |'virtualedit'| not
2862 enabled.
2863 Jul 01, 2008 * vim foo/bar was creating [Scratch] buffers,
2864 where bar was also a directory
2865 Jul 01, 2008 * numerous additional changes were made to netrw
2866 to use fnameescape() and shellescape() instead
2867 of escape(). Not all changes have been tested
2868 as yet...
2869 Jul 01, 2008 * (James Vega reported) some problems with
2870 :NetrwSettings (due to no longer used setting
2871 variables).
2872 Jul 07, 2008 * Additional numerous changes to support security;
2873 shellescape(arg,1), etc.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002874 v125: Apr 07, 2008 * (Cristian Rigamonti) CR provides a patch; he
2875 noted that gx was failing since its call to
2876 netrw#NetBrowseX() wasn't updated to
2877 netrw#NetrwBrowseX().
2878 * (Stanis Trendelenburg) ST provides a patch to
2879 supports davs: (dav + ssl)
2880 * (Rick Choi) noted that directory names comprised
2881 of three digits were not being displayed by
2882 the internal browser. Fixed.
2883 * (Erik Falor) provided a patch to handle problems
2884 with changing directory and |'acd'| option.
2885 * (James Vega, Teemu Likonen) noted that netrw
2886 wasn't handling multi-byte filenames/directories
2887 correctly. Fixed.
2888 * (Rick) found problem with g:netrw_maxfilenamelen
2889 being overridden.
2890 * (James Vega) pointed out that netrw was
2891 misidentifying all files in a symbolically linked
2892 directory as being symbolically linked
2893 themselves. This particular problem was fixed;
2894 however, there are now situations where
2895 symbolically linked files will not be detected.
2896 Really need an internal vim function to do this
2897 identification.
2898 Apr 17, 2008 * When g:netrw_keepdir==0, current directory
2899 doesn't necessarily equal b:netrw_curdir
2900 initially. Problem is due to the patch directly
2901 above.
2902 * Fixed qf to handle case where b:netrw_curdir
2903 isn't the same as the current directory under
2904 linux/macosx.
2905 * New: |netrw-mg| (apply vimgrep to marked files)
2906 May 05, 2008 * (Rick) pointed out that a "setlocal ts=32" was
2907 interfering with g:netrw_maxfilenamelen
2908 May 05, 2008 * (James Vega) a file inside a linked directory
2909 was showing up as a symbolic link itself.
2910 May 22, 2008 * symbolic links, fifos, and sockets are now
2911 indicated by a trailing @, |, or =, respectively.
2912 Jun 06, 2008 * Removed numerous bugs from the marked file
2913 move and copy. Tested these changes under
2914 Unix only thus far.
2915 * :Rexplore returns to the screen position in the
2916 netrw listing from whence the file was edited
2917 v124: Apr 02, 2008 * (Adrian Rollett) change the line supporting the
2918 "x" action for mac to use g:netrw_shq
2919 v123: Feb 27, 2008 * Marked files now keeps a "global" marked file
2920 list. The global marked file list is used to
2921 support tag processing and vimdiff'ing
2922 (|netrw-md| |netrw-mt|)
2923 * Been insuring that mm and mc works with various
2924 combinations of local and remote directories
2925 * (Stefan Bittner) http://.../ should always have
2926 filetype "html" -- fixed.
2927 * (Stefan Bittner) a "?" in a http://.../ request
2928 wasn't being handled correctly. Fixed by
2929 removing ? from default |g:netrw_tmpfile_escape|.
2930 * (Nico Weber) % codes in http://.../ requests
2931 weren't being handled correctly. Fixed by
2932 including % in default |g:netrw_fname_escape|.
2933 * (Stefan Bittner) attempts to update Buffers.Refresh
2934 were failing because locale use changed the menu
2935 names. I implemented a workaround.
2936 v122: Feb 12, 2008 * bugfix - first sorting sequence match now has
2937 priority
2938 Feb 14, 2008 * bugfix - sorting sequence was effectively ignoring
2939 sequencing priority of anything following '*'
2940 * toggling a marked file was showing incorrect list
2941 (list was correct, but displayed matches weren't)
2942 * |g:netrw_special_syntax| implemented
2943 v121: Feb 11, 2008 * Bram M reported that :e file ... :e . would not
2944 retain the alternate file. Fixed -- I hope!
2945 * bugfix -- apparently v120 broke an explicit
2946 :Explore dirname
2947 v120: Jan 21, 2008 * |netrw-mt| changed to allow for target selection
2948 based on whether or not word under cursor is a
2949 directory or file, or if cursor is in banner
2950 area.
2951 * |netrw-mh| included (hiding by marked-file suffix)
2952 * functions moved about a bit (improved
2953 categorization)
2954 * executable files now displayed with trailing (*)
2955 * symbolically linked files now displayed with
2956 trailing (@)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002957 * Somewhen, s:NetrwMarkFileMove() got damaged. It
2958 * is now restored (missing an endif, for example).
Bram Moolenaar446cb832008-06-24 21:56:24 +00002959 * |netrw-mu| implemented (unmarking marked files)
2960 * many bugs have been removed from the marked file
2961 system (tnx to Mark S. for feedback)
2962 * |netrw-ms| implemented (sourcing marked files)
2963 * fixed use of P with tree listing style
2964 * multiple tree listing now supported
2965 * ./ suppressed
2966 * changed q -> qb (query bookmarks)
2967 * implemented |netrw-qf|
2968 * Explore now has four special list-generation
2969 modes: */filepat **/filepat
2970 *//pattern **//pattern
2971 * gh (|netrw-gh|) is a shortcut for toggling the
2972 hiding of files and directories beginning with a
2973 dot
2974 v119: Jan 10, 2008 * When g:netrw_keepdir is false,
2975 NetrwOptionsRestore() had a problem
2976 (Bill McCarthy)
2977 Jan 11, 2008 * Netrw now shows symbolic links with a trailing
2978 "@" and special highlighting.
2979 Jan 15, 2008 * Changed g:netrw_noretmap -> |g:netrw_retmap|.
2980 Changed: disabled by default at Bram's
2981 preference.
2982 v118: Jan 02, 2008 * Fixed a problem with Windows;
2983 :Explore c:/path/ would not work,
2984 but :Explore c:/path would.
2985 * Fixed a bug in s:NetrwOptionRestore() - lcd's
2986 argument wasn't being properly escaped so it
2987 wouldn't handle spaces in directory names.
2988 (Gary Johnson)
2989 v117: Jan 02, 2008 * Fixed a problem with P; had to include
2990 a b:netrw_curdir bypass (Bram Moolenaar)
2991 v116: Nov 27, 2007 * netrw#LocalBrowseCheck() has &ft=="netrw"
2992 check to prevent doing a directory listing
2993 (was getting unexpected directory refreshes
2994 in the middle of some function calls)
2995 * NetrwOptionRestore moved after e! filename
2996 in order to retain user options for editing
2997 in s:NetrwBrowseChgDir()
2998 Dec 12, 2007 * Bug fix -- netrw does a better job of retaining
2999 user options when editing files under the aegis
3000 of the browser
3001 v115: Oct 04, 2007 * Erik Remmelzwaal pointed out that the use of
3002 shellslash in s:GetTempfile() was incorrect
3003 Oct 11, 2007 * Tracked down and eliminated a bug with editing
3004 remote *.tar.gz and *.tar.bz2 files
3005 Oct 11, 2007 * g:netrw_localmovecmd wasn't being initialized
3006 properly, and g:netrw_localcopycmd was being
3007 overwritten.
3008 Oct 12, 2007 * Placed all :Rexplore and <2-leftmouse> setup
3009 in a new support function (s:SetRexDir()).
3010 Oct 15, 2007 * new: g:netrw_browse_split == 4; means <cr>
3011 based selection will use previous window
3012 Oct 20, 2007 * also checks on |'shellxquote'| to set g:netrw_shq
3013 Oct 24, 2007 * Explore handles path/**/filename
3014 Oct 27, 2007 * sourcing remote files often didn't work with ftp,
3015 turns out that b:netrw_method was undefined, so
3016 s:SaveBufVars and s:RestoreBufVars() fixed it.
3017 v114: Sep 28, 2007 * mT, the map that invokes tags, has been improved
3018 to support use of remote tags files.
3019 Oct 02, 2007 * changed Netrw menu to use more submenus
3020 v113: Sep 07, 2007 * worked out why the cursor position wasn't being
3021 saved and restored as intended after doing such
3022 things as deleting and renaming files.
3023 Sep 11, 2007 * Fixed bug which effectively disabled <c-l> and
3024 <c-h> maps
3025 Sep 18, 2007 * there used to be one NetrwOptionRestore() call at
3026 the end of the s:NetrwBrowseChgDir() function;
3027 they're now at the end of every if..elseif..else
3028 block. The edit-a-file one is not quite at the end
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003029 of its block; instead, it's just before the edit.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003030 Restores user options, then this new placement
3031 allows ftplugins, autocmds, etc to change settings
3032 (ex. ftplugin/cpp.vim sets cindent).
3033 Sep 19, 2007 * changed all strlen() calls to use s:Strlen(), a
3034 function which handles utf-8 wide characters
3035 correctly.
3036 Sep 20, 2007 * (Nico Weber) the "x" command has been extended
3037 to Mac's OS/X (macunix); it now uses open to
3038 handle |netrw-x| browsing with special files.
3039 Sep 22, 2007 * Added g:netrw_noretmap to netrw at Tony M's
3040 request.
3041 * Included path to NetrwRemoteRmFile()
3042 v112: Aug 18, 2007 * added mx (|netrw-mx|) for executing arbitrary
3043 commands on marked files
3044 Aug 22, 2007 * more option save/restore work for
3045 s:NetrwBrowseChgDir(); s:NetrwOptionSave()
3046 and s:NetrwOptionRestore() now take a parameter
3047 specifying the type of variables to be used for
3048 saving and restoring (either "w:" or "s:")
3049 Sep 04, 2007 * added the :NetrwClean[!] command
3050 v111: Jul 25, 2007 * using Windows but not using Cygwin, netrw does a
3051 "file bufname" where the bufname uses /s
3052 instead of \s; Vim "fixes" it by changing the
3053 bufname to use \s anyway. This meant that
3054 NetrwGetBuffer() didn't find the appropriately
3055 named buffer, and so would generate a new
3056 buffer listing; hence the cursor would appear
3057 to have been moved when doing a preview.
3058 * added <2-leftmouse> map to return to netrw's
3059 browser display
3060 Aug 16, 2007 * added the mark-file system, including
3061 maps for mf mp mt mz and mu. Modifications
3062 made to maps for a D O and R to support
3063 marked files.
3064 v110: May 10, 2007 * added [ and ] maps to NetrwTreeListing
3065 May 25, 2007 * |g:netrw_preview| included
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003066 May 29, 2007 * modified netrw#NetBrowseX to consistently use
Bram Moolenaarc236c162008-07-13 17:41:49 +00003067 g:netrw_shq instead of hardcoded quotes,
Bram Moolenaar446cb832008-06-24 21:56:24 +00003068 and modified the snippet that sets up redir
3069 so Windows machines use "nul" instead of
3070 "/dev/null".
3071 Jun 01, 2007 * fixed bug -- NetGetBuffer() wasn't always
3072 recognizing a buffer name match when it should,
3073 thus resulting in [Scratch] buffers.
3074 Jun 04, 2007 * Gary Johnson found a bugfix for the "c" mapping
3075 when the directory is to be made current but
3076 the name contains spaces.
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003077 v109: Mar 26, 2007 * if a directory name includes a "$" character,
3078 Explore() will use expand() in an attempt to
3079 decipher the name.
3080 May 07, 2007 * g:netrw_use_errorwindow now allows one to
Bram Moolenaar446cb832008-06-24 21:56:24 +00003081 have error messages go to a reliable window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003082 or to use a less reliable but recallable
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003083 echoerr method
3084 May 07, 2007 * g:netrw_scpport and g:netrw_sshport support
Bram Moolenaar446cb832008-06-24 21:56:24 +00003085 use of -P and -p, respectively, to set port
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003086 for scp/ssh.
Bram Moolenaar9964e462007-05-05 17:54:07 +00003087 v108: Jan 03, 2007 * included preview map (|netrw-p|), supporting
3088 remote browsing
3089 * netrw can now source remote files
3090 Jan 26, 2007 * Colton Jamieson noted that remote directory
3091 browsing did not support alternate port
3092 selection. This feature has now been extended
3093 to apply to all remote browsing commands via ssh.
3094 (list, remove/delete, rename)
3095 Jan 31, 2007 * Luis Florit reported that @* was an invalid
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003096 register. The @* register is now only saved and
3097 restored if |'guioptions'| contains "a".
Bram Moolenaar9964e462007-05-05 17:54:07 +00003098 Feb 02, 2007 * Fixed a bug that cropped up when writing files
3099 via scp using cygwin
3100 Feb 08, 2007 * tree listing mode managed to stop working again;
3101 fixed again!
3102 Feb 15, 2007 * Guido Van Hoecke reported that netrw didn't
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003103 handle browsing well with M$ ftp servers. He even
Bram Moolenaar9964e462007-05-05 17:54:07 +00003104 set up a temporary account for me to test with
3105 (thanks!). Netrw now can browse M$ ftp servers.
3106 v107: Oct 12, 2006 * bypassed the autowrite option
3107 Oct 24, 2006 * handles automatic decompression of *.gz and *.bz2
3108 files
3109 Nov 03, 2006 * Explore will highlight matching files when
3110 **/pattern is used (and if the |'hls'| option
3111 is set)
3112 Nov 09, 2006 * a debugging line, when enabled, was inadvertently
3113 bringing up help instead of simply reporting on
3114 list contents
3115 Nov 21, 2006 * tree listing improved (cursor remains put)
3116 Nov 27, 2006 * fixed b:netrw_curdir bug when repeated "i"s were
3117 pressed.
3118 Dec 15, 2006 * considerable qty of changes, mostly to share more
3119 code between local and remote browsing. Includes
3120 support for tree-style listing for both remote
3121 and local browsing.
3122 Dec 15, 2006 * Included Peter Bengtsson's modifications to
3123 support the Amiga.
3124 v106: Sep 21, 2006 * removed old v:version<700 code as netrw now
3125 requires vim 7.0
3126 * worked around a bug where register * was
3127 overwritten during local browsing
3128 v104: Sep 05, 2006 * as suggested by Rodolfo Borges, :Explore and
3129 variants will position the cursor on the file
3130 just having been edited
3131 * changed default |g:netrw_sort_sequence| order
3132 * changed b, Nb to simply mb (see |netrw-mb|)
3133 * changed B, NB to simply gb (see |netrw-gb|)
3134 * tree listing style (see |g:netrw_liststyle|)
3135 * attempts to retain the alternate file
3136 v103: Jul 26, 2006 * used Yakov Lerner's tip#1289 to improve netrw
3137 error message display
3138 * wide listings didn't handle files with backslashes
3139 in their names properly. A symptom was an
3140 inability to open files.
3141 Aug 09, 2006 * included "t" mapping for opening tabbed windows,
3142 both for remote and local browsing
3143 * changed netrw_longlist to netrw_liststyle
3144 Aug 15, 2006 * fixed one of the NB maps
3145 Aug 22, 2006 * changed *Explore commands to use -nargs=* instead
3146 of -nargs=?. Allows both -complete=dir _and_ the
3147 starstar arguments to work (-nargs=? seems to
3148 require one or the other).
3149 Aug 23, 2006 * copied all w:.. variables across splits to
3150 new windows
3151 Aug 25, 2006 * when g:netrw_browsex_viewer was '-'
3152 (see |g:netrw_browsex_viewer|) it wasn't causing
3153 netrwFileHandlers#Invoke() to be called as it
3154 was expected to. (tnx Steve Dugaro)
3155 Aug 29, 2006 * changed NetBrowseX() to use "setlocal ... noswf"
3156 instead of "set ... noswf" (tnx Benji Fisher)
3157 Aug 31, 2006 * tabs and fastbrowse<=1 didn't work together.
3158 v102: Jun 15, 2006 * chgd netrwPlugin to call netrw#LocalBrowseCheck()
3159 * bugfix: g:netrw_keepdir==0 had stopped working
3160 Jul 06, 2006 * bugfix: NetOptionSave/Restore now saves/restores
3161 the unnamed register (|registers|)
3162 Jul 07, 2006 * |g:netrw_menu| support included
3163 Jul 13, 2006 * :Texplore command implemented
3164 Jul 17, 2006 * NetSplit and (Local|Net)BrowseChgDir() were both
3165 splitting windows. This affected o, v, and
3166 g:netrw_browse_split.
3167 Jul 20, 2006 * works around wildignore setting (was causing
3168 netrw's local browser not to list wildignore'd
3169 files)
3170 Jul 24, 2006 * <leftmouse> acts as a <cr> for selecting a file
3171 <rightmouse> acts as a <del> for deleting a file
3172 v100: May 14, 2006 * when using Windows and shell==cmd.exe, the
3173 default for g:netrw_ignorenetrc is now 1
3174 * bugfix: unwanted ^Ms now removed
3175 (affected shell==cmd.exe - Windows)
3176 * added Bookmarks and History to the menu
3177 * an error message about non-existing
3178 w:netrw_longlist was appearing during attempts to
3179 Explore (fixed)
3180 * g:netrw_shq now available to make netrw use
3181 specified style of quotes for commands
3182 May 29, 2006 * user NFH_*() functions were inadvertently being
3183 ignored
3184 * fixed a Windows non-cygwin ftp handling problem.
3185 * hiding pattern candidate separators included some
3186 characters it shouldn't have (tnx to Osei Poku)
3187 Jun 01, 2006 * for browsing, netrw was supposed to use "dir"
3188 instead of "ls -lF" when using
3189 ftp+non-cygwin+windows. Fixed.
3190 * an inadvertently left-in-place debugging statement
3191 was preventing use of the "x" key with browsing.
3192 Jun 05, 2006 * g:netrw_nogx available to prevent making the gx
3193 map (see |g:netrw_nogx|)
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003194 * bugfix, Explore wouldn't change directory
Bram Moolenaar9964e462007-05-05 17:54:07 +00003195 properly (vim ., :Explore subdirname)
3196 Jun 06, 2006 * moved history to 2nd line in Netrw menu
3197 * fixed delete for unix-based systems
3198 Jun 07, 2006 * x key now works for windows-noncygwin-ftp
3199 Jun 08, 2006 * Explore */pat and **//pat now wraps
3200 v99: May 09, 2006 * g:netrw_browse_split=3 for opening files in new
3201 tabs implemented.
3202 May 12, 2006 * deletes temporary file at end of NetRead()
3203 * visual mode based Obtain implemented
3204 * added -complete=dir to the various Explore
3205 commands
3206 v98: May 02, 2006 * the "p" key didn't work properly when the browsing
3207 directory name had spaces in it.
3208 v97: May 01, 2006 * exists("&acd") now used to determine if
3209 the 'acd' option exists
3210 * "obtain" now works again under Windows
Bram Moolenaar446cb832008-06-24 21:56:24 +00003211 v96: * bugfix - the |'acd'| option is not always defined
3212 but is now bypassed only when it is
3213 v95: * bugfix - Hiding mode worked correctly (don't show
3214 any file matching any of the g:netrw_hide
3215 patterns), but showing mode was showing only those
3216 files that didn't match any of the g:netrw_hide
3217 patterns. Instead, it now shows all files that
3218 match any of the g:netrw_hide patterns (the
3219 difference between a logical and and logical or).
3220 v94: * bugfix - a Decho() had a missing quote; only
3221 affects things when debugging was enabled.
3222 v93: * bugfix - removed FocusGained event from causing a
3223 slow-browser refresh for Windows
3224 v92: * :Explore **//pattern implemented
3225 (**/filepattern was already taken)
3226 v91: * :Explore */pattern implemented
3227 * |'acd'| option bypassed
3228 v90: * mark ', as suggested by Yegappan Lakshmanan, used
3229 to help guarantee entry into the jump list when
3230 appropriate.
3231 * <s-down> and <s-up> are no longer defined until a
3232 :Explore **/pattern is used (if the user already
3233 has a map for them). They will be defined for new
3234 browser windows from that point forward.
3235 v89: * A <s-down>, <s-up>, :Nexplore, or a :Pexplore
3236 without having first done an :Explore **/pattern
3237 (see |netrw-starstar|) caused
3238 a lot of unhelpful error messages to appear
3239 v88: * moved DrChip.Netrw menu to Netrw. Now has
3240 priority 80 by default.
3241 g:NetrwTopLvlMenu == "Netrw" and can be changed
3242 by the user to suit. The priority is given by
3243 g:NetrwMenuPriority.
3244 * Changed filetype for browser displays from
3245 netrwlist to netrw.
3246 v87: * bug fix -- menus were partially disappearing
3247 v85: * bug fix -- missing an endif
3248 * bug fix -- handles spaces in names and directories
3249 when using ftp-based browsing
3250 v83: * disabled stop-acd handling; the change in directory
3251 handling may allow acd to be used again.
3252 * D was refusing to delete remote files/directories
3253 in wide listing mode.
3254 v81: * FocusGained also used to refresh/wipe local browser
3255 directory buffers
3256 * (bugfix) netrw was leaving [Scratch] buffers behind
3257 when the user had the "hidden" option set. The
3258 'hidden' option is now bypassed.
3259 v80: * ShellCmdPost event used in conjunction with
3260 g:netrw_fastbrowse to refresh/wipe local browser
3261 directory buffers.
3262 v79: * directories are now displayed with nowrap
3263 * (bugfix) if the column width was smaller than the
3264 largest file's name, then netrw would hang when
3265 using wide-listing mode - fixed
3266 * g:netrw_fastbrowse introduced
3267 v78: * progress has been made on allowing spaces inside
3268 directory names for remote work (reading, writing,
3269 browsing). (scp)
3270 v77: * Mikolaj Machowski fixed a bug in a substitute cmd
3271 * g:netrw_browsex_viewer implemented
3272 * Mikolaj Machowski pointed out that gnome-open is
3273 often executable under KDE systems, although it is
3274 effectively not functional. NetBrowseX now looks
3275 for "kicker" as a running process to determine if
3276 KDE is actually running.
3277 * Explorer's O functionality was inadvertently left
3278 out. Netrw now does the same thing, but with the
3279 "P" key.
3280 * added g:netrw_browse_split option
3281 * fixed a bug where the directory contained a "." but
3282 the file didn't (was treating the dirname from "."
3283 onwards as a suffix)
3284 v76: * "directory is missing" error message now restores
3285 echo highlighting
3286 v75: * file://... now conforms to RFC2396 (thanks to
3287 S. Zacchiroli)
3288 * if the binary option is set, then NetWrite() will
3289 only write the whole file (line numbers don't make
3290 sense with this). Supports writing of tar and zip
3291 files.
3292 v74: * bugfix (vim, then :Explore) now works
3293 * ctrl-L keeps cursor at same screen location (both
3294 local and remote browsing)
3295 * netrw now can read remote zip and tar files
3296 * Obtain now uses WinXP ftp+.netrc successfully
3297 v73: * bugfix -- scp://host/path/file was getting named
3298 incorrectly
3299 * netrw detects use of earlier-than-7.0 version of
3300 vim and issues a pertinent error message.
3301 * netrwSettings.vim is now uses autoloading. Only
3302 <netrwPlugin.vim> is needed as a pure plugin
3303 (ie. always loaded).
3304 v72: * bugfix -- formerly, one could prevent the loading
3305 of netrw by "let g:loaded_netrw=1"; when
3306 autoloading became supported, this feature was
3307 lost. It is now restored.
3308 v71: * bugfix -- made some "set nomodifiable"s into
3309 setlocal variants (allows :e somenewfile to be
3310 modifiable as usual)
3311 * NetrwSettings calls a netrw function, thereby
3312 assuring that netrw has loaded. However, if netrw
3313 does not load for whatever reason, then
3314 NetrwSettings will now issue a warning message.
3315 * For what reason I don't recall, when wget and fetch
3316 are both not present, and an attempt to read a
3317 http://... url is made, netrw exited. It now only
3318 returns.
3319 * When ch=1, on the second and subsequent uses of
3320 browsing Netrw would issue a blank line to clear
3321 the echo'd messages. This caused an annoying
3322 "Hit-Enter" prompt; now a blank line message
3323 is echo'd only if &ch>1.
3324 v70: * when using |netrw-O|, the "Obtaining filename"
3325 message is now shown using |hl-User9|. If User9
3326 has not been defined, netrw itself will define it.
3327 v69: * Bugfix: win95/98 machines were experiencing a
3328 "E121: Undefined variable: g:netrw_win95ftp"
3329 message
3330 v68: * double-click-leftmouse selects word under mouse
3331 v67: * Passwords which contain blanks will now be
3332 surrounded by double-quotes automatically (Yongwei)
3333 v66: * Netrw now seems to work with a few more Windows
3334 situations
3335 * O now obtains a file: remote browsing
3336 file -> local copy, locally browsing
3337 file -> current directory (see :pwd)
3338 * i now cycles between thin, long, and wide listing
3339 styles
3340 * NB and Nb are maps that are always available;
3341 corresponding B and b maps are only available when
3342 not using wide listing in order to allow them to
3343 be used for motions
3344 v65: * Browser functions now use NetOptionSave/Restore; in
3345 particular, netrw now works around the report
3346 setting
3347 v64: * Bugfix - browsing a "/" directory (Unix) yielded
3348 buffers named "[Scratch]" instead of "/"
3349 * Bugfix - remote browsing with ftp was omitting
3350 the ./ and ../
3351 v63: * netrw now takes advantage of autoload (needs 7.0)
3352 * Bugfix - using r (to reverse sort) working again
3353 v62: * Bugfix - spaces allowed again in directory names
3354 with g:netrw_keepdir=0. In fact, I've tested netrw
3355 with most ANSI punctuation marks for directory
3356 names.
3357 * Bugfix - NetrwSettings gave errors when
3358 g:netrw_silent had not be set.
3359 v61: * Document upgrade -- netrw variable-based settings
3360 all should have tags. Supports NetrwSettings cmd.
3361 * Several important variables are window-oriented.
3362 Netrw has to transfer these across a window split.
3363 See s:BufWinVars() and s:UseBufWinVars().
3364 v60: * When using the i map to switch between long and
3365 short listings, netrw will now keep cursor on same
3366 line
3367 * "Match # of #" now uses status line
3368 * :Explore **/*.c will now work from a
3369 non-netrw-browser window
3370 * :Explore **/patterns can now be run in separate
3371 browser windows
3372 * active banner (hit <cr> will cause various things
3373 to happen)
3374 v59: * bugfix -- another keepalt work-around installed
3375 (for vim6.3)
3376 * "Match # of #" for Explore **/pattern matches
3377 v58: * Explore and relatives can now handle
3378 **/somefilepattern (v7)
3379 * Nexplore and Pexplore introduced (v7). shift-down
3380 and shift-up cursor keys will invoke Nexplore and
3381 Pexplore, respectively.
3382 * bug fixed with o and v
3383 * autochdir only worked around for vim when it has
3384 been compiled with either
3385 |+netbeans_intg| or |+sun_workshop|
3386 * Under Windows, all directories and files were
3387 being preceded with a "/" when local browsing.
3388 Fixed.
3389 * When: syntax highlighting is off, laststatus=2, and
3390 remote browsing is used, sometimes the laststatus
3391 highlighting bleeds into the entire display. Work
3392 around - do an extra redraw in that case.
3393 * Bugfix: when g:netrw_keepdir=0, due to re-use of
3394 buffers, netrw didn't change the directory when it
3395 should've
3396 * Bugfix: D and R commands work again
3397 v57: * Explore and relatives can now handle RO files
3398 * reverse sort restored with vim7's sort command
3399 * g:netrw_keepdir now being used to keep the current
3400 directory unchanged as intended (sense change)
3401 * vim 6.3 still supported
3402 v56: * LocalBrowse now saves autochdir setting, unsets it,
3403 and restores it before returning.
3404 * using vim's rename() instead of system +
3405 local_rename variable
3406 * avoids changing directory when g:netrw_keepdir is
3407 false
3408 v55: * -bar used with :Explore :Sexplore etc to allow
3409 multiple commands to be separated by |s
3410 * browser listings now use the "nowrap" option
3411 * browser: some unuseful error messages now
3412 suppressed
3413 v54: * For backwards compatibility, Explore and Sexplore
3414 have been implemented. In addition, Hexplore and
3415 Vexplore commands are available, too.
3416 * <amatch> used instead of <afile> in the
3417 transparency support (BufReadCmd, FileReadCmd,
3418 FileWriteCmd)
3419 * ***netrw*** prepended to various error messages
3420 netrw may emit
3421 * g:netrw_port used instead of b:netrw_port for scp
3422 * any leading [:#] is removed from port numbers
3423 v53: * backslashes as well as slashes placed in various
3424 patterns (ex. g:netrw_sort_sequence) to better
3425 support Windows
3426 v52: * nonumber'ing now set for browsing buffers
3427 * when the hiding list hid all files, error messages
3428 ensued. Fixed
3429 * when browsing, swf is set, but directory is not
3430 set, when netrw was attempting to restore options,
3431 vim wanted to save a swapfile to a local directory
3432 using an url-style path. Fixed
3433 v51: * cygwin detection now automated
3434 (using windows and &shell is bash)
3435 * customizable browser "file" rejection patterns
3436 * directory history
3437 * :[range]w url now supported (ie. netrw uses a
3438 FileWriteCmd event)
3439 * error messages have a "Press <cr> to continue" to
3440 allow them to be seen
3441 * directory browser displays no longer bother the
3442 swapfile
3443 * u/U commands to go up and down the history stack
3444 * history stack may be saved with viminfo with it's
3445 "!" option
3446 * bugfixes associated with unwanted [No Files]
3447 entries
3448 v50: * directories now displayed using buftype=nofile;
3449 should keep the directory names as-is
3450 * attempts to remove empty "[No File]" buffers
3451 leftover from :file ..name.. commands
3452 * bugfix: a "caps-lock" editing difficulty left in
3453 v49 was fixed
3454 * syntax highlighting for "Showing:" the hiding list
3455 included
3456 * bookmarks can now be retained if "!" is in the
3457 viminfo option
3458 v49: * will use ftp for http://.../ browsing
3459 v48: * One may use ftp to do remote host file browsing
3460 * (windows and !cygwin) remote browsing with ftp can
3461 now use the "dir" command internally to provide
3462 listings
3463 * g:netrw_keepdir now allows one to keep the initial
3464 current directory as the current directory
3465 (normally the local file browser makes the
3466 currently viewed directory the current directory)
3467 * g:netrw_alto and g:netrw_altv now support
3468 alternate placement of windows started with o or v
3469 * Nread ? and Nwrite ? now uses echomsg (instead of
3470 echo) so :messages can repeat showing the help
3471 * bugfix: avoids problems with partial matches of
3472 directory names to prior buffers with longer names
3473 * one can suppress error messages with g:netrw_quiet
3474 ctrl-h used
3475 * instead of <Leader>h for editing hiding list one
3476 may edit the sorting sequence with the S map, which
3477 now allows confirmation of deletion with
3478 [y(es) n(o) a(ll) q(uit)]
3479 * the "x" map now handles special file viewing with:
3480 (windows) rundll32 url.dll (gnome) gnome-open (kde)
3481 kfmclient If none of these are on the executable
3482 path, then netrwFileHandlers.vim is used.
3483 * directory bookmarking during both local and remote
3484 browsing implemented
3485 * one may view all, use the hiding list to suppress,
3486 or use the hiding list to show-only remote and
3487 local file/directory listings
3488 * improved unusual file and directory name handling
3489 preview window support
3490 v47: * now handles local browsing.
3491 v46: * now handles remote browsing
3492 * g:netrw_silent (if 1) will cause all transfers to
3493 be silent
3494 v45: * made the [user@]hostname:path form a bit more
3495 restrictive to better handle errors in using
3496 protocols (e.g. scp:usr@host:file was being
3497 recognized as an rcp request)
3498 v44: * changed from "rsync -a" to just "rsync"
3499 * somehow an editing error messed up the test to
3500 recognize use of the fetch method for NetRead.
3501 * more debugging statements included
3502 v43: * moved "Explanation" comments to <pi_netrw.txt> help
3503 file as "Network Reference" (|netrw-ref|)
3504 * <netrw.vim> now uses Dfunc() Decho() and Dret() for
3505 debugging
3506 * removed superfluous NetRestorePosn() calls
3507 v42: * now does BufReadPre and BufReadPost events on
3508 file:///* and file://localhost/*
3509 v41: * installed file:///* and file://localhost/* handling
3510 v40: * prevents redraw when a protocol error occurs so
3511 that the user may see it
3512 v39: * sftp support
3513 v38: * Now uses NetRestorePosn() calls with Nread/Nwrite
3514 commands
3515 * Temporary files now removed via bwipe! instead of
3516 bwipe (thanks to Dave Roberts)
3517 v37: * Claar's modifications which test if ftp is
3518 successful, otherwise give an error message
3519 * After a read, the alternate file was pointing to
3520 the temp file. The temp file buffer is now wiped
3521 out.
3522 * removed silent from transfer methods so user can
3523 see what's happening
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524
3525
3526==============================================================================
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100352713. Todo *netrw-todo* {{{1
3528
352907/29/09 : banner :|g:netrw_banner| can be used to suppress the
3530 suppression banner. This feature is new and experimental,
3531 so its in the process of being debugged.
353209/04/09 : "gp" : See if it can be made to work for remote systems.
3533 : See if it can be made to work with marked files.
3534
3535==============================================================================
353614. Credits *netrw-credits* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537
3538 Vim editor by Bram Moolenaar (Thanks, Bram!)
3539 dav support by C Campbell
3540 fetch support by Bram Moolenaar and C Campbell
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003541 ftp support by C Campbell <NdrOchip@ScampbellPfamily.AbizM>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 http support by Bram Moolenaar <bram@moolenaar.net>
3543 rcp
3544 rsync support by C Campbell (suggested by Erik Warendorph)
3545 scp support by raf <raf@comdyn.com.au>
3546 sftp support by C Campbell
3547
3548 inputsecret(), BufReadCmd, BufWriteCmd contributed by C Campbell
3549
3550 Jérôme Augé -- also using new buffer method with ftp+.netrc
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003551 Bram Moolenaar -- obviously vim itself, :e and v:cmdarg use,
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003552 fetch,...
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 Yasuhiro Matsumoto -- pointing out undo+0r problem and a solution
3554 Erik Warendorph -- for several suggestions (g:netrw_..._cmd
3555 variables, rsync etc)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003556 Doug Claar -- modifications to test for success with ftp
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003557 operation
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558
3559==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00003560Modelines: {{{1
Bram Moolenaar83bab712005-08-01 21:58:57 +00003561 vim:tw=78:ts=8:ft=help:norl:fdm=marker