blob: 7635af288a9488095145921b46c28011a95cf309 [file] [log] [blame]
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001*pi_netrw.txt* For Vim version 7.2. Last change: 2009 Dec 28
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
9Copyright: Copyright (C) 2009 Charles E Campbell, Jr *netrw-copyright*
10 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 Moolenaar446cb832008-06-24 21:56:24 +000022*dav* *ftp* *netrw-file* *Nread* *rcp* *scp*
23*davs* *http* *netrw.vim* *Nsource* *rsync* *sftp*
24*fetch* *netrw* *network* *Nwrite*
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
161PREVENTING LOADING
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 Moolenaar446cb832008-06-24 21:56:24 +00001723. 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
321 *g:netrw_chgwin* specifies a window number where file edits will take
322 place. (also see |netrw-C|)
323 (default) not defined
324
325 *g:Netrw_funcref* specifies a function to be called when netrw edits
326 a file. The file is first edited, and then the
327 function reference (|Funcref|) is called.
328 (default) not defined
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000330 *g:netrw_ftp* if it doesn't exist, use default ftp
331 =0 use default ftp (uid password)
332 =1 use alternate ftp method (user uid password)
333 If you're having trouble with ftp, try changing the
334 value of this variable to see if the alternate ftp
335 method works for your setup.
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000336
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100337 *g:netrw_ftpextracmd* default: doesn't exist
Bram Moolenaar9964e462007-05-05 17:54:07 +0000338 If this variable exists, then any string it contains
339 will be placed into the commands set to your ftp
340 client. As an example:
341 ="passive"
342
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000343 *g:netrw_ftpmode* ="binary" (default)
344 ="ascii"
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000345
Bram Moolenaar9964e462007-05-05 17:54:07 +0000346 *g:netrw_ignorenetrc* =0 (default for linux, cygwin)
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000347 =1 If you have a <.netrc> file but it doesn't work and
Bram Moolenaar446cb832008-06-24 21:56:24 +0000348 you want it ignored, then set this variable as
349 shown. (default for Windows + cmd.exe)
Bram Moolenaar9964e462007-05-05 17:54:07 +0000350
351 *g:netrw_menu* =0 disable netrw's menu
352 =1 (default) netrw's menu enabled
353
354 *g:netrw_nogx* if this variable exists, then the "gx" map will not
355 be available (see |netrw-gx|)
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000356
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100357 *g:netrw_uid* (ftp) user-id, retained on a per-vim-session basis
358 *s:netrw_passwd* (ftp) password, retained on a per-vim-session basis
Bram Moolenaar446cb832008-06-24 21:56:24 +0000359
360 *g:netrw_preview* =0 (default) preview window shown in a horizontally
361 split window
362 =1 preview window shown in a vertically split window.
363 Also affects the "previous window" (see |netrw-P|) in
364 the same way.
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000365
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000366 *g:netrw_scpport* = "-P" : option to use to set port for scp
367 *g:netrw_sshport* = "-p" : option to use to set port for ssh
368
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100369 *g:netrw_sepchr* =\0xff
370 =\0x01 for enc == euc-jp (and perhaps it should be for
371 others, too, please let me
372 know)
373 Separates priority codes from filenames internally.
374 See |netrw-p12|.
375
Bram Moolenaar446cb832008-06-24 21:56:24 +0000376 *g:netrw_silent* =0 : transfers done normally
377 =1 : transfers done silently
378
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000379 *g:netrw_use_errorwindow* =1 : messages from netrw will use a separate one
380 line window. This window provides reliable
381 delivery of messages. (default)
382 =0 : messages from netrw will use echoerr ;
383 messages don't always seem to show up this
384 way, but one doesn't have to quit the window.
385
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000386 *g:netrw_win95ftp* =1 if using Win95, will remove four trailing blank
387 lines that o/s's ftp "provides" on transfers
388 =0 force normal ftp behavior (no trailing line removal)
389
390 *g:netrw_cygwin* =1 assume scp under windows is from cygwin. Also
391 permits network browsing to use ls with time and
392 size sorting (default if windows)
393 =0 assume Windows' scp accepts windows-style paths
394 Network browsing uses dir instead of ls
395 This option is ignored if you're using unix
396
397 *g:netrw_use_nt_rcp* =0 don't use the rcp of WinNT, Win2000 and WinXP
Bram Moolenaar9964e462007-05-05 17:54:07 +0000398 =1 use WinNT's rcp in binary mode (default)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000399
Bram Moolenaar446cb832008-06-24 21:56:24 +0000400PATHS *netrw-path* {{{2
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000401
402Paths to files are generally user-directory relative for most protocols.
403It is possible that some protocol will make paths relative to some
404associated directory, however.
405>
406 example: vim scp://user@host/somefile
407 example: vim scp://user@host/subdir1/subdir2/somefile
408<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000409where "somefile" is in the "user"'s home directory. If you wish to get a
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000410file using root-relative paths, use the full path:
411>
412 example: vim scp://user@host//somefile
413 example: vim scp://user@host//subdir1/subdir2/somefile
414<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415
416==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00004174. Network-Oriented File Transfer *netrw-xfer* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000418
419Network-oriented file transfer under Vim is implemented by a VimL-based script
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000420(<netrw.vim>) using plugin techniques. It currently supports both reading and
421writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422dav/cadaver, rsync, or sftp.
423
424http is currently supported read-only via use of wget or fetch.
425
426<netrw.vim> is a standard plugin which acts as glue between Vim and the
427various file transfer programs. It uses autocommand events (BufReadCmd,
428FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. >
429
430 ex. vim ftp://hostname/path/to/file
431<
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000432The characters preceding the colon specify the protocol to use; in the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000433example, it's ftp. The <netrw.vim> script then formulates a command or a
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000434series of commands (typically ftp) which it issues to an external program
435(ftp, scp, etc) which does the actual file transfer/protocol. Files are read
436from/written to a temporary file (under Unix/Linux, /tmp/...) which the
437<netrw.vim> script will clean up.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100439Now, a word about Jan Minář's "FTP User Name and Password Disclosure"; first,
440ftp is not a secure protocol. User names and passwords are transmitted "in
441the clear" over the internet; any snooper tool can pick these up; this is not
442a netrw thing, this is a ftp thing. If you're concerned about this, please
443try to use scp or sftp instead.
444
445Netrw re-uses the user id and password during the same vim session and so long
446as the remote hostname remains the same.
447
448Jan seems to be a bit confused about how netrw handles ftp; normally multiple
449commands are performed in a "ftp session", and he seems to feel that the
450uid/password should only be retained over one ftp session. However, netrw
451does every ftp operation in a separate "ftp session"; so remembering the
452uid/password for just one "ftp session" would be the same as not remembering
453the uid/password at all. IMHO this would rapidly grow tiresome as one
454browsed remote directories, for example.
455
456On the other hand, thanks go to Jan M. for pointing out the many
457vulnerabilities that netrw (and vim itself) had had in handling "crafted"
458filenames. The |shellescape()| and |fnameescape()| functions were written in
459response by Bram Moolenaar to handle these sort of problems, and netrw has
460been modified to use them. Still, my advice is, if the "filename" looks like
461a vim command that you aren't comfortable with having executed, don't open it.
462
Bram Moolenaar9964e462007-05-05 17:54:07 +0000463 *netrw-putty* *netrw-pscp* *netrw-psftp*
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000464One may modify any protocol's implementing external application by setting a
465variable (ex. scp uses the variable g:netrw_scp_cmd, which is defaulted to
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000466"scp -q"). As an example, consider using PuTTY: >
Bram Moolenaar9964e462007-05-05 17:54:07 +0000467
468 let g:netrw_scp_cmd = '"c:\Program Files\PuTTY\pscp.exe" -q -batch'
469 let g:netrw_sftp_cmd= '"c:\Program Files\PuTTY\psftp.exe"'
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000470<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000471See |netrw-p8| for more about putty, pscp, psftp, etc.
472
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473Ftp, an old protocol, seems to be blessed by numerous implementations.
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000474Unfortunately, some implementations are noisy (ie., add junk to the end of the
475file). Thus, concerned users may decide to write a NetReadFixup() function
476that will clean up after reading with their ftp. Some Unix systems (ie.,
477FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is
478not noisy and more convenient, actually, for <netrw.vim> to use.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100479Consequently, if "fetch" is available (ie. executable), it may be preferable
480to use it for ftp://... based transfers.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000481
482For rcp, scp, sftp, and http, one may use network-oriented file transfers
Bram Moolenaar83bab712005-08-01 21:58:57 +0000483transparently; ie.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484>
485 vim rcp://[user@]machine/path
486 vim scp://[user@]machine/path
487<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100488If your ftp supports <.netrc>, then it too can be transparently used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000489if the needed triad of machine name, user id, and password are present in
490that file. Your ftp must be able to use the <.netrc> file on its own, however.
491>
492 vim ftp://[user@]machine[[:#]portnumber]/path
493<
494However, ftp will often need to query the user for the userid and password.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000495The latter will be done "silently"; ie. asterisks will show up instead of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496the actually-typed-in password. Netrw will retain the userid and password
497for subsequent read/writes from the most recent transfer so subsequent
498transfers (read/write) to or from that machine will take place without
499additional prompting.
500
501 *netrw-urls*
502 +=================================+============================+============+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000503 | Reading | Writing | Uses |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504 +=================================+============================+============+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000505 | DAV: | | |
506 | dav://host/path | | cadaver |
507 | :Nread dav://host/path | :Nwrite dav://host/path | cadaver |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508 +---------------------------------+----------------------------+------------+
Bram Moolenaar446cb832008-06-24 21:56:24 +0000509 | DAV + SSL: | | |
510 | davs://host/path | | cadaver |
511 | :Nread davs://host/path | :Nwrite davs://host/path | cadaver |
512 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000513 | FETCH: | | |
514 | fetch://[user@]host/path | | |
515 | fetch://[user@]host:http/path | Not Available | fetch |
516 | :Nread fetch://[user@]host/path| | |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000518 | FILE: | | |
519 | file:///* | file:///* | |
520 | file://localhost/* | file://localhost/* | |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000522 | FTP: (*3) | (*3) | |
523 | ftp://[user@]host/path | ftp://[user@]host/path | ftp (*2) |
524 | :Nread ftp://host/path | :Nwrite ftp://host/path | ftp+.netrc |
525 | :Nread host path | :Nwrite host path | ftp+.netrc |
526 | :Nread host uid pass path | :Nwrite host uid pass path | ftp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000528 | HTTP: wget is executable: (*4) | | |
529 | http://[user@]host/path | Not Available | wget |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000531 | HTTP: fetch is executable (*4) | | |
532 | http://[user@]host/path | Not Available | fetch |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000534 | RCP: | | |
535 | rcp://[user@]host/path | rcp://[user@]host/path | rcp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000537 | RSYNC: | | |
538 | rsync://[user@]host/path | rsync://[user@]host/path | rsync |
539 | :Nread rsync://host/path | :Nwrite rsync://host/path | rsync |
540 | :Nread rcp://host/path | :Nwrite rcp://host/path | rcp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000542 | SCP: | | |
543 | scp://[user@]host/path | scp://[user@]host/path | scp |
544 | :Nread scp://host/path | :Nwrite scp://host/path | scp (*1) |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000546 | SFTP: | | |
547 | sftp://[user@]host/path | sftp://[user@]host/path | sftp |
548 | :Nread sftp://host/path | :Nwrite sftp://host/path | sftp (*1) |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549 +=================================+============================+============+
550
551 (*1) For an absolute path use scp://machine//path.
552
553 (*2) if <.netrc> is present, it is assumed that it will
554 work with your ftp client. Otherwise the script will
Bram Moolenaar9964e462007-05-05 17:54:07 +0000555 prompt for user-id and password.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556
Bram Moolenaar9964e462007-05-05 17:54:07 +0000557 (*3) for ftp, "machine" may be machine#port or machine:port
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558 if a different port is needed than the standard ftp port
559
560 (*4) for http:..., if wget is available it will be used. Otherwise,
561 if fetch is available it will be used.
562
563Both the :Nread and the :Nwrite ex-commands can accept multiple filenames.
564
565
566NETRC *netrw-netrc*
567
Bram Moolenaar446cb832008-06-24 21:56:24 +0000568The <.netrc> file, typically located in your home directory, contains lines
569therein which map a hostname (machine name) to the user id and password you
570prefer to use with it.
571
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572The typical syntax for lines in a <.netrc> file is given as shown below.
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000573Ftp under Unix usually supports <.netrc>; ftp under Windows usually doesn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000574>
575 machine {full machine name} login {user-id} password "{password}"
576 default login {user-id} password "{password}"
577
578Your ftp client must handle the use of <.netrc> on its own, but if the
579<.netrc> file exists, an ftp transfer will not ask for the user-id or
580password.
581
582 Note:
583 Since this file contains passwords, make very sure nobody else can
584 read this file! Most programs will refuse to use a .netrc that is
585 readable for others. Don't forget that the system administrator can
Bram Moolenaar446cb832008-06-24 21:56:24 +0000586 still read the file! Ie. for Linux/Unix: chmod 600 .netrc
Bram Moolenaar071d4272004-06-13 20:20:40 +0000587
588
589PASSWORD *netrw-passwd*
590
591The script attempts to get passwords for ftp invisibly using |inputsecret()|,
592a built-in Vim function. See |netrw-uidpass| for how to change the password
593after one has set it.
594
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000595Unfortunately there doesn't appear to be a way for netrw to feed a password to
596scp. Thus every transfer via scp will require re-entry of the password.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000597However, |netrw-ssh-hack| can help with this problem.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
599
600==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00006015. Activation *netrw-activate* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000602
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000603Network-oriented file transfers are available by default whenever Vim's
Bram Moolenaar446cb832008-06-24 21:56:24 +0000604|'nocompatible'| mode is enabled. Netrw's script files reside in your
605system's plugin, autoload, and syntax directories; just the
606plugin/netrwPlugin.vim script is sourced automatically whenever you bring up
607vim. The main script in autoload/netrw.vim is only loaded when you actually
608use netrw. I suggest that, at a minimum, you have at least the following in
609your <.vimrc> customization file: >
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000610
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000611 set nocp
612 if version >= 600
613 filetype plugin indent on
614 endif
615<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616
617==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00006186. Transparent File Editing *netrw-transparent* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619
620Transparent file transfers occur whenever a regular file read or write
Bram Moolenaar446cb832008-06-24 21:56:24 +0000621(invoked via an |:autocmd| for |BufReadCmd|, |BufWriteCmd|, or |SourceCmd|
622events) is made. Thus one may read, write, or source files across networks
623just as easily as if they were local files! >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624
625 vim ftp://[user@]machine/path
626 ...
627 :wq
628
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000629See |netrw-activate| for more on how to encourage your vim to use plugins
630such as netrw.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000632
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00006347. Ex Commands *netrw-ex* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000636The usual read/write commands are supported. There are also a few
Bram Moolenaar446cb832008-06-24 21:56:24 +0000637additional commands available. Often you won't need to use Nwrite or
Bram Moolenaar9964e462007-05-05 17:54:07 +0000638Nread as shown in |netrw-transparent| (ie. simply use >
639 :e url
640 :r url
641 :w url
642instead, as appropriate) -- see |netrw-urls|. In the explanations
643below, a {netfile} is an url to a remote file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644
Bram Moolenaar446cb832008-06-24 21:56:24 +0000645:[range]Nw[rite] Write the specified lines to the current
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 file as specified in b:netrw_lastfile.
647
Bram Moolenaar446cb832008-06-24 21:56:24 +0000648:[range]Nw[rite] {netfile} [{netfile}]...
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 Write the specified lines to the {netfile}.
650
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100651:Nr[ead] Read the lines from the file specified in b:netrw_lastfile
652 into the current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653
Bram Moolenaar446cb832008-06-24 21:56:24 +0000654:Nr[ead] {netfile} {netfile}...
Bram Moolenaar071d4272004-06-13 20:20:40 +0000655 Read the {netfile} after the current line.
656
Bram Moolenaar446cb832008-06-24 21:56:24 +0000657:Ns[ource] {netfile}
Bram Moolenaar9964e462007-05-05 17:54:07 +0000658 Source the {netfile}.
659 To start up vim using a remote .vimrc, one may use
660 the following (all on one line) (tnx to Antoine Mechelynck) >
661 vim -u NORC -N
662 --cmd "runtime plugin/netrwPlugin.vim"
663 --cmd "source scp://HOSTNAME/.vimrc"
664< *netrw-uidpass*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665:call NetUserPass()
Bram Moolenaar446cb832008-06-24 21:56:24 +0000666 If g:netrw_uid and s:netrw_passwd don't exist,
667 this function will query the user for them.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668
669:call NetUserPass("userid")
Bram Moolenaar446cb832008-06-24 21:56:24 +0000670 This call will set the g:netrw_uid and, if
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671 the password doesn't exist, will query the user for it.
672
673:call NetUserPass("userid","passwd")
Bram Moolenaar446cb832008-06-24 21:56:24 +0000674 This call will set both the g:netrw_uid and s:netrw_passwd.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675 The user-id and password are used by ftp transfers. One may
Bram Moolenaar446cb832008-06-24 21:56:24 +0000676 effectively remove the user-id and password by using empty
677 strings (ie. "").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678
Bram Moolenaar9964e462007-05-05 17:54:07 +0000679:NetrwSettings This command is described in |netrw-settings| -- used to
680 display netrw settings and change netrw behavior.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000681
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682
683==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00006848. Variables and Options *netrw-options* *netrw-var* {{{1
685
686(if you're interested in the netrw browser settings, see: |netrw-browser-var|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687
Bram Moolenaar9964e462007-05-05 17:54:07 +0000688The <netrw.vim> script provides several variables which act as options to
Bram Moolenaar446cb832008-06-24 21:56:24 +0000689affect <netrw.vim>'s file transfer behavior. These variables typically may be
690set in the user's <.vimrc> file: (see also |netrw-settings| |netrw-protocol|)
691
692>
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000693
Bram Moolenaar9964e462007-05-05 17:54:07 +0000694 -------------
695 Netrw Options
696 -------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000697 Option Meaning
698 -------------- -----------------------------------------------
699<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000700 b:netrw_col Holds current cursor position (during NetWrite)
701 g:netrw_cygwin =1 assume scp under windows is from cygwin
702 (default/windows)
703 =0 assume scp under windows accepts windows
704 style paths (default/else)
705 g:netrw_ftp =0 use default ftp (uid password)
706 g:netrw_ftpmode ="binary" (default)
707 ="ascii" (your choice)
708 g:netrw_ignorenetrc =1 (default)
709 if you have a <.netrc> file but you don't
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710 want it used, then set this variable. Its
711 mere existence is enough to cause <.netrc>
712 to be ignored.
Bram Moolenaar9964e462007-05-05 17:54:07 +0000713 b:netrw_lastfile Holds latest method/machine/path.
714 b:netrw_line Holds current line number (during NetWrite)
Bram Moolenaar9964e462007-05-05 17:54:07 +0000715 g:netrw_silent =0 transfers done normally
716 =1 transfers done silently
717 g:netrw_uid Holds current user-id for ftp.
Bram Moolenaar9964e462007-05-05 17:54:07 +0000718 g:netrw_use_nt_rcp =0 don't use WinNT/2K/XP's rcp (default)
719 =1 use WinNT/2K/XP's rcp, binary mode
720 g:netrw_win95ftp =0 use unix-style ftp even if win95/98/ME/etc
721 =1 use default method to do ftp >
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000722 -----------------------------------------------------------------------
723<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724The script will also make use of the following variables internally, albeit
725temporarily.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000726>
727 -------------------
728 Temporary Variables
729 -------------------
730 Variable Meaning
731 -------- ------------------------------------
732<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100733 b:netrw_method Index indicating rcp/ftp+.netrc/ftp
734 w:netrw_method (same as b:netrw_method)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 g:netrw_machine Holds machine name parsed from input
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100736 b:netrw_fname Holds filename being accessed >
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000737 ------------------------------------------------------------
738<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000739 *netrw-protocol*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000740
741Netrw supports a number of protocols. These protocols are invoked using the
742variables listed below, and may be modified by the user.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743>
744 ------------------------
Bram Moolenaar9964e462007-05-05 17:54:07 +0000745 Protocol Control Options
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 ------------------------
Bram Moolenaar9964e462007-05-05 17:54:07 +0000747 Option Type Setting Meaning
748 --------- -------- -------------- ---------------------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000749<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000750 netrw_ftp variable =doesn't exist userid set by "user userid"
751 =0 userid set by "user userid"
752 =1 userid set by "userid"
753 NetReadFixup function =doesn't exist no change
754 =exists Allows user to have files
755 read via ftp automatically
756 transformed however they wish
757 by NetReadFixup()
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100758 g:netrw_dav_cmd variable ="cadaver" if cadaver is executable
759 g:netrw_dav_cmd variable ="curl -o" elseif curl is executable
Bram Moolenaar9964e462007-05-05 17:54:07 +0000760 g:netrw_fetch_cmd variable ="fetch -o" if fetch is available
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761 g:netrw_ftp_cmd variable ="ftp"
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000762 g:netrw_http_cmd variable ="fetch -o" if fetch is available
763 g:netrw_http_cmd variable ="wget -O" else if wget is available
Bram Moolenaar9964e462007-05-05 17:54:07 +0000764 g:netrw_list_cmd variable ="ssh USEPORT HOSTNAME ls -Fa"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 g:netrw_rcp_cmd variable ="rcp"
766 g:netrw_rsync_cmd variable ="rsync -a"
767 g:netrw_scp_cmd variable ="scp -q"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000768 g:netrw_sftp_cmd variable ="sftp" >
769 -------------------------------------------------------------------------
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770<
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000771 *netrw-ftp*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772
Bram Moolenaar9964e462007-05-05 17:54:07 +0000773The g:netrw_..._cmd options (|g:netrw_ftp_cmd| and |g:netrw_sftp_cmd|)
774specify the external program to use handle the ftp protocol. They may
775include command line options (such as -p for passive mode).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
Bram Moolenaar9964e462007-05-05 17:54:07 +0000777Browsing is supported by using the |g:netrw_list_cmd|; the substring
778"HOSTNAME" will be changed via substitution with whatever the current request
779is for a hostname.
780
781Two options (|g:netrw_ftp| and |netrw-fixup|) both help with certain ftp's
782that give trouble . In order to best understand how to use these options if
783ftp is giving you troubles, a bit of discussion is provided on how netrw does
784ftp reads.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000785
786For ftp, netrw typically builds up lines of one of the following formats in a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787temporary file:
788>
789 IF g:netrw_ftp !exists or is not 1 IF g:netrw_ftp exists and is 1
790 ---------------------------------- ------------------------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000791<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000792 open machine [port] open machine [port]
793 user userid password userid password
794 [g:netrw_ftpmode] password
795 [g:netrw_extracmd] [g:netrw_ftpmode]
796 get filename tempfile [g:netrw_extracmd]
797 get filename tempfile >
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000798 ---------------------------------------------------------------------
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000800The |g:netrw_ftpmode| and |g:netrw_extracmd| are optional.
801
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802Netrw then executes the lines above by use of a filter:
803>
804 :%! {g:netrw_ftp_cmd} -i [-n]
805<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806where
807 g:netrw_ftp_cmd is usually "ftp",
808 -i tells ftp not to be interactive
809 -n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>)
810
811If <.netrc> exists it will be used to avoid having to query the user for
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000812userid and password. The transferred file is put into a temporary file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813The temporary file is then read into the main editing session window that
814requested it and the temporary file deleted.
815
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000816If your ftp doesn't accept the "user" command and immediately just demands a
817userid, then try putting "let netrw_ftp=1" in your <.vimrc>.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000819 *netrw-cadaver*
820To handle the SSL certificate dialog for untrusted servers, one may pull
821down the certificate and place it into /usr/ssl/cert.pem. This operation
822renders the server treatment as "trusted".
823
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000824 *netrw-fixup* *netreadfixup*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825If your ftp for whatever reason generates unwanted lines (such as AUTH
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100826messages) you may write a NetReadFixup() function:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827>
828 function! NetReadFixup(method,line1,line2)
829 " a:line1: first new line in current file
830 " a:line2: last new line in current file
831 if a:method == 1 "rcp
832 elseif a:method == 2 "ftp + <.netrc>
833 elseif a:method == 3 "ftp + machine,uid,password,filename
834 elseif a:method == 4 "scp
835 elseif a:method == 5 "http/wget
836 elseif a:method == 6 "dav/cadaver
837 elseif a:method == 7 "rsync
838 elseif a:method == 8 "fetch
839 elseif a:method == 9 "sftp
Bram Moolenaar9964e462007-05-05 17:54:07 +0000840 else " complain
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 endif
842 endfunction
843>
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000844The NetReadFixup() function will be called if it exists and thus allows you to
845customize your reading process. As a further example, <netrw.vim> contains
846just such a function to handle Windows 95 ftp. For whatever reason, Windows
84795's ftp dumps four blank lines at the end of a transfer, and so it is
848desirable to automate their removal. Here's some code taken from <netrw.vim>
849itself:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850>
851 if has("win95") && g:netrw_win95ftp
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000852 fun! NetReadFixup(method, line1, line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 if method == 3 " ftp (no <.netrc>)
Bram Moolenaar9964e462007-05-05 17:54:07 +0000854 let fourblanklines= line2 - 3
855 silent fourblanklines.",".line2."g/^\s*/d"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 endif
857 endfunction
858 endif
859>
860
861==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00008629. Browsing *netrw-browsing* *netrw-browse* *netrw-help* {{{1
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100863 *netrw-browser* *netrw-dir* *netrw-list*
Bram Moolenaar83bab712005-08-01 21:58:57 +0000864
Bram Moolenaar446cb832008-06-24 21:56:24 +0000865INTRODUCTION TO BROWSING *netrw-intro-browse* {{{2
866 (Quick References: |netrw-quickmaps| |netrw-quickcoms|)
Bram Moolenaar83bab712005-08-01 21:58:57 +0000867
Bram Moolenaar446cb832008-06-24 21:56:24 +0000868Netrw supports the browsing of directories on your local system and on remote
869hosts; browsing includes listing files and directories, entering directories,
870editing files therein, deleting files/directories, making new directories,
871moving (renaming) files and directories, copying files and directories, etc.
872One may mark files and execute any system command on them! The Netrw browser
873generally implements the previous explorer's maps and commands for remote
874directories, although details (such as pertinent global variable names)
875necessarily differ. To browse a directory, simply "edit" it! >
Bram Moolenaar269ec652004-07-29 08:43:53 +0000876
Bram Moolenaar446cb832008-06-24 21:56:24 +0000877 vim /your/directory/
878 vim .
879 vim c:\your\directory\
880<
881(Related topics: |netrw-cr| |netrw-o| |netrw-p| |netrw-P| |netrw-t|
882 |netrw-mf| |netrw-mx| |netrw-D| |netrw-R| |netrw-v| )
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000883
884The Netrw remote file and directory browser handles two protocols: ssh and
Bram Moolenaar446cb832008-06-24 21:56:24 +0000885ftp. The protocol in the url, if it is ftp, will cause netrw also to use ftp
886in its remote browsing. Specifying any other protocol will cause it to be
887used for file transfers; but the ssh protocol will be used to do remote
888browsing.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000889
Bram Moolenaar446cb832008-06-24 21:56:24 +0000890To use Netrw's remote directory browser, simply attempt to read a "file" with
891a trailing slash and it will be interpreted as a request to list a directory:
892>
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000893 vim [protocol]://[user@]hostname/path/
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000894<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000895where [protocol] is typically scp or ftp. As an example, try: >
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000896
Bram Moolenaar446cb832008-06-24 21:56:24 +0000897 vim ftp://ftp.home.vim.org/pub/vim/
898<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100899For local directories, the trailing slash is not required. Again, because it's
Bram Moolenaar446cb832008-06-24 21:56:24 +0000900easy to miss: to browse remote directories, the url must terminate with a
901slash!
Bram Moolenaar83bab712005-08-01 21:58:57 +0000902
Bram Moolenaar446cb832008-06-24 21:56:24 +0000903If you'd like to avoid entering the password repeatedly for remote directory
904listings with ssh or scp, see |netrw-ssh-hack|. To avoid password entry with
905ftp, see |netrw-netrc| (if your ftp supports it).
Bram Moolenaar83bab712005-08-01 21:58:57 +0000906
Bram Moolenaar446cb832008-06-24 21:56:24 +0000907There are several things you can do to affect the browser's display of files:
Bram Moolenaar83bab712005-08-01 21:58:57 +0000908
Bram Moolenaar446cb832008-06-24 21:56:24 +0000909 * To change the listing style, press the "i" key (|netrw-i|).
910 Currently there are four styles: thin, long, wide, and tree.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100911 To make that change "permanent", see |g:netrw_liststyle|.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000912
Bram Moolenaar446cb832008-06-24 21:56:24 +0000913 * To hide files (don't want to see those xyz~ files anymore?) see
914 |netrw-ctrl-h|.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000915
Bram Moolenaar446cb832008-06-24 21:56:24 +0000916 * Press s to sort files by name, time, or size.
917
918See |netrw-browse-cmds| for all the things you can do with netrw!
919
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100920 *netrw-getftype* *netrw-filigree* *netrw-ftype*
921The |getftype()| function is used to append a bit of filigree to indicate
922filetype to locally listed files:
923
924 directory : /
925 executable : *
926 fifo : |
927 links : @
928 sockets : =
929
930The filigree also affects the |g:netrw_sort_sequence|.
931
Bram Moolenaar446cb832008-06-24 21:56:24 +0000932
933QUICK HELP *netrw-quickhelp* {{{2
934 (Use ctrl-] to select a topic)~
935 Intro to Browsing...............................|netrw-intro-browse|
936 Quick Reference: Maps.........................|netrw-quickmap|
937 Quick Reference: Commands.....................|netrw-browse-cmds|
938 Hiding
939 Edit hiding list..............................|netrw-ctrl-h|
940 Hiding Files or Directories...................|netrw-a|
941 Hiding/Unhiding by suffix.....................|netrw-mh|
942 Hiding dot-files.............................|netrw-gh|
943 Listing Style
944 Select listing style (thin/long/wide/tree)....|netrw-i|
945 Associated setting variable...................|g:netrw_liststyle|
946 Shell command used to perform listing.........|g:netrw_list_cmd|
947 Quick file info...............................|netrw-qf|
948 Sorted by
949 Select sorting style (name/time/size).........|netrw-s|
950 Editing the sorting sequence..................|netrw-S|
Bram Moolenaarc236c162008-07-13 17:41:49 +0000951 Sorting options...............................|g:netrw_sort_options|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000952 Associated setting variable...................|g:netrw_sort_sequence|
953 Reverse sorting order.........................|netrw-r|
954
955
956 *netrw-quickmap* *netrw-quickmaps*
957QUICK REFERENCE: MAPS *netrw-browse-maps* {{{2
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000958>
Bram Moolenaar446cb832008-06-24 21:56:24 +0000959 --- ----------------- ----
960 Map Quick Explanation Link
961 --- ----------------- ----
962< <F1> Causes Netrw to issue help
963 <cr> Netrw will enter the directory or read the file |netrw-cr|
964 <del> Netrw will attempt to remove the file/directory |netrw-del|
965 - Makes Netrw go up one directory |netrw--|
966 a Toggles between normal display, |netrw-a|
967 hiding (suppress display of files matching g:netrw_list_hide)
968 showing (display only files which match g:netrw_list_hide)
969 c Make browsing directory the current directory |netrw-c|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100970 C Setting the editing window |netrw-C|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000971 d Make a directory |netrw-d|
972 D Attempt to remove the file(s)/directory(ies) |netrw-D|
973 gb Go to previous bookmarked directory |netrw-gb|
974 gh Quick hide/unhide of dot-files |netrw-gh|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000975 <c-h> Edit file hiding list |netrw-ctrl-h|
976 i Cycle between thin, long, wide, and tree listings |netrw-i|
977 <c-l> Causes Netrw to refresh the directory listing |netrw-ctrl-l|
978 mb Bookmark current directory |netrw-mb|
979 mc Copy marked files to marked-file target directory |netrw-mc|
980 md Apply diff to marked files (up to 3) |netrw-md|
981 me Place marked files on arg list and edit them |netrw-me|
982 mf Mark a file |netrw-mf|
983 mh Toggle marked file suffices' presence on hiding list |netrw-mh|
984 mm Move marked files to marked-file target directory |netrw-mm|
985 mp Print marked files |netrw-mp|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100986 mr Mark files satisfying a shell-style |regexp| |netrw-mr|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000987 mt Current browsing directory becomes markfile target |netrw-mt|
988 mT Apply ctags to marked files |netrw-mT|
989 mu Unmark all marked files |netrw-mu|
990 mx Apply arbitrary shell command to marked files |netrw-mx|
991 mz Compress/decompress marked files |netrw-mz|
992 o Enter the file/directory under the cursor in a new |netrw-o|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100993 browser window. A horizontal split is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000994 O Obtain a file specified by cursor |netrw-O|
995 p Preview the file |netrw-p|
996 P Browse in the previously used window |netrw-P|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100997 qb List bookmarked directories and history |netrw-qb|
998 qf Display information on file |netrw-qf|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000999 r Reverse sorting order |netrw-r|
1000 R Rename the designed file(s)/directory(ies) |netrw-R|
1001 s Select sorting style: by name, time, or file size |netrw-s|
1002 S Specify suffix priority for name-sorting |netrw-S|
1003 t Enter the file/directory under the cursor in a new tab|netrw-t|
1004 u Change to recently-visited directory |netrw-u|
1005 U Change to subsequently-visited directory |netrw-U|
1006 v Enter the file/directory under the cursor in a new |netrw-v|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001007 browser window. A vertical split is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001008 x View file with an associated program |netrw-x|
1009
Bram Moolenaarc236c162008-07-13 17:41:49 +00001010 % Open a new file in netrw's current directory |netrw-%|
1011
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001012 *netrw-mouse* *netrw-leftmouse* *netrw-middlemouse* *netrw-rightmouse*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001013 <leftmouse> (gvim only) selects word under mouse as if a <cr>
1014 had been pressed (ie. edit file, change directory)
1015 <middlemouse> (gvim only) same as P selecting word under mouse;
1016 see |netrw-P|
1017 <rightmouse> (gvim only) delete file/directory using word under
1018 mouse
1019 <2-leftmouse> (gvim only) when:
1020 * in a netrw-selected file, AND
1021 * |g:netrw_retmap| == 1 AND
1022 * the user doesn't already have a <2-leftmouse> mapping
1023 defined before netrw is autoloaded,
1024 then a double clicked leftmouse button will return
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001025 to the netrw browser window. See |g:netrw_retmap|.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001026 <s-leftmouse> (gvim only) like mf, will mark files
1027
1028 *netrw-quickcom* *netrw-quickcoms*
1029QUICK REFERENCE: COMMANDS *netrw-explore-cmds* *netrw-browse-cmds* {{{2
1030 :NetrwClean[!] ...........................................|netrw-clean|
1031 :NetrwSettings ...........................................|netrw-settings|
1032 :Explore[!] [dir] Explore directory of current file......|netrw-explore|
1033 :Hexplore[!] [dir] Horizontal Split & Explore.............|netrw-explore|
1034 :Nexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
1035 :Pexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
1036 :Rexplore Return to Explorer.....................|netrw-explore|
1037 :Sexplore[!] [dir] Split & Explore directory .............|netrw-explore|
1038 :Texplore[!] [dir] Tab & Explore..........................|netrw-explore|
1039 :Vexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
1040
1041BOOKMARKING A DIRECTORY *netrw-mb* *netrw-bookmark* *netrw-bookmarks* {{{2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001042
Bram Moolenaar446cb832008-06-24 21:56:24 +00001043One may easily "bookmark" a directory by using >
1044
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001045 mb
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00001046<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001047Bookmarks are retained in between sessions in a $HOME/.netrwbook file, and are
1048kept in sorted order.
1049
1050Related Topics:
1051 |netrw-gb| how to return (go) to a bookmark
1052 |netrw-mB| how to delete bookmarks
1053 |netrw-qb| how to list bookmarks
Bram Moolenaar4a85b412006-04-23 22:40:29 +00001054
1055
Bram Moolenaar446cb832008-06-24 21:56:24 +00001056BROWSING *netrw-cr* {{{2
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001057
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001058Browsing is simple: move the cursor onto a file or directory of interest.
Bram Moolenaar843ee412004-06-30 16:16:41 +00001059Hitting the <cr> (the return key) will select the file or directory.
1060Directories will themselves be listed, and files will be opened using the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001061protocol given in the original read request.
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001062
Bram Moolenaar446cb832008-06-24 21:56:24 +00001063 CAVEAT: There are four forms of listing (see |netrw-i|). Netrw assumes that
1064 two or more spaces delimit filenames and directory names for the long and
1065 wide listing formats. Thus, if your filename or directory name has two or
1066 more sequential spaces embedded in it, or any trailing spaces, then you'll
1067 need to use the "thin" format to select it.
Bram Moolenaar843ee412004-06-30 16:16:41 +00001068
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001069The |g:netrw_browse_split| option, which is zero by default, may be used to
Bram Moolenaar446cb832008-06-24 21:56:24 +00001070cause the opening of files to be done in a new window or tab instead of the
1071default. When the option is one or two, the splitting will be taken
1072horizontally or vertically, respectively. When the option is set to three, a
1073<cr> will cause the file to appear in a new tab.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001074
Bram Moolenaar83bab712005-08-01 21:58:57 +00001075
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001076When using the gui (gvim), one may select a file by pressing the <leftmouse>
1077button. In addition, if
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001078
Bram Moolenaar446cb832008-06-24 21:56:24 +00001079 *|g:netrw_retmap| == 1 AND (its default value is 0)
1080 * in a netrw-selected file, AND
1081 * the user doesn't already have a <2-leftmouse> mapping defined before
1082 netrw is loaded
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001083
Bram Moolenaar446cb832008-06-24 21:56:24 +00001084then a doubly-clicked leftmouse button will return to the netrw browser
1085window.
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001086
Bram Moolenaar446cb832008-06-24 21:56:24 +00001087Netrw attempts to speed up browsing, especially for remote browsing where one
1088may have to enter passwords, by keeping and re-using previously obtained
1089directory listing buffers. The |g:netrw_fastbrowse| variable is used to
1090control this behavior; one may have slow browsing (no buffer re-use), medium
1091speed browsing (re-use directory buffer listings only for remote directories),
1092and fast browsing (re-use directory buffer listings as often as possible).
1093The price for such re-use is that when changes are made (such as new files
1094are introduced into a directory), the listing may become out-of-date. One may
1095always refresh directory listing buffers by pressing ctrl-L (see
1096|netrw-ctrl-l|).
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001097
1098
Bram Moolenaar446cb832008-06-24 21:56:24 +00001099Related topics: |netrw-o| |netrw-p| |netrw-P| |netrw-t| |netrw-v|
1100Associated setting variables: |g:netrw_browse_split| |g:netrw_fastbrowse|
1101 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd|
1102 |g:netrw_ftp_timelist_cmd| |g:netrw_ssh_cmd|
1103 |g:netrw_ssh_browse_reject| |g:netrw_use_noswf|
1104
1105
1106BROWSING WITH A HORIZONTALLY SPLIT WINDOW *netrw-o* *netrw-horiz* {{{2
1107
1108Normally one enters a file or directory using the <cr>. However, the "o" map
1109allows one to open a new window to hold the new directory listing or file. A
1110horizontal split is used. (for vertical splitting, see |netrw-v|)
1111
1112Normally, the o key splits the window horizontally with the new window and
1113cursor at the top. To change to splitting the window horizontally with the
1114new window and cursor at the bottom, have
1115
1116 let g:netrw_alto = 1
1117
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001118in your <.vimrc>. (also see |netrw-t| |netrw-T| |netrw-v|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001119
1120Associated setting variables: |g:netrw_alto| |g:netrw_winsize|
1121
1122
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001123BROWSING WITH A NEW TAB *netrw-t* *netrw-T* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00001124
1125Normally one enters a file or directory using the <cr>. The "t" map
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001126allows one to open a new window holding the new directory listing or file in
1127a new tab. The "T" version puts the file or directory into a background tab
1128(see |gT|)
1129
1130Related actions: |netrw-o| |netrw-v|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001131
1132
1133BROWSING WITH A VERTICALLY SPLIT WINDOW *netrw-v* {{{2
1134
1135Normally one enters a file or directory using the <cr>. However, the "v" map
1136allows one to open a new window to hold the new directory listing or file. A
1137vertical split is used. (for horizontal splitting, see |netrw-o|)
1138
1139Normally, the v key splits the window vertically with the new window and
1140cursor at the left. To change to splitting the window vertically with the new
1141window and cursor at the right, have
1142
1143 let g:netrw_altv = 1
1144
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001145in your <.vimrc>. (also see: |netrw-o| |netrw-t| |netrw-T|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001146
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001147There is only one tree listing buffer; using "v" on a displayed subdirectory
Bram Moolenaar446cb832008-06-24 21:56:24 +00001148will split the screen, but the same buffer will be shown twice.
1149
1150Associated setting variable: |g:netrw_altv| |g:netrw_winsize|
1151
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001152
1153CHANGE LISTING STYLE (THIN LONG WIDE TREE) *netrw-i* {{{2
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001154
Bram Moolenaar9964e462007-05-05 17:54:07 +00001155The "i" map cycles between the thin, long, wide, and tree listing formats.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001156
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001157The thin listing format gives just the files' and directories' names.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001158
Bram Moolenaar8299df92004-07-10 09:47:34 +00001159The long listing is either based on the "ls" command via ssh for remote
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001160directories or displays the filename, file size (in bytes), and the time and
1161date of last modification for local directories. With the long listing
1162format, netrw is not able to recognize filenames which have trailing spaces.
1163Use the thin listing format for such files.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001164
Bram Moolenaar9964e462007-05-05 17:54:07 +00001165The wide listing format uses two or more contiguous spaces to delineate
1166filenames; when using that format, netrw won't be able to recognize or use
1167filenames which have two or more contiguous spaces embedded in the name or any
1168trailing spaces. The thin listing format will, however, work with such files.
1169This listing format is the most compact.
1170
1171The tree listing format has a top directory followed by files and directories
1172preceded by a "|". One may open and close directories by pressing the <cr>
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001173key while atop the directory name.
1174
1175One may make a preferred listing style your default; see |g:netrw_liststyle|.
1176As an example, by putting the following line in your .vimrc, >
1177 let g:netrw_liststyle= 4
1178the tree style will become your default listing style.
Bram Moolenaar8299df92004-07-10 09:47:34 +00001179
Bram Moolenaar446cb832008-06-24 21:56:24 +00001180Associated setting variables: |g:netrw_liststyle| |g:netrw_maxfilenamelen|
1181 |g:netrw_timefmt| |g:netrw_list_cmd|
Bram Moolenaar8299df92004-07-10 09:47:34 +00001182
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001183CHANGE FILE PERMISSION *netrw-gp* {{{2
1184
1185"gp" will ask you for a new permission for the file named under the cursor.
1186Currently, this only works for local files.
1187
1188Associated setting variables: |g:netrw_chgperm|
1189
Bram Moolenaar83bab712005-08-01 21:58:57 +00001190
Bram Moolenaar446cb832008-06-24 21:56:24 +00001191CHANGING TO A BOOKMARKED DIRECTORY *netrw-gb* {{{2
Bram Moolenaar843ee412004-06-30 16:16:41 +00001192
Bram Moolenaar446cb832008-06-24 21:56:24 +00001193To change directory back to a bookmarked directory, use
Bram Moolenaar843ee412004-06-30 16:16:41 +00001194
Bram Moolenaar446cb832008-06-24 21:56:24 +00001195 {cnt}gb
Bram Moolenaar843ee412004-06-30 16:16:41 +00001196
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001197Any count may be used to reference any of the bookmarks.
1198
1199Related Topics:
1200 |netrw-mB| how to delete bookmarks
1201 |netrw-mb| how to make a bookmark
1202 |netrw-qb| how to list bookmarks
Bram Moolenaar843ee412004-06-30 16:16:41 +00001203
Bram Moolenaar843ee412004-06-30 16:16:41 +00001204
Bram Moolenaar446cb832008-06-24 21:56:24 +00001205CHANGING TO A PREDECESSOR DIRECTORY *netrw-u* *netrw-updir* {{{2
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001206
1207Every time you change to a new directory (new for the current session),
1208netrw will save the directory in a recently-visited directory history
Bram Moolenaar446cb832008-06-24 21:56:24 +00001209list (unless g:netrw_dirhistmax is zero; by default, it's ten). With the
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001210"u" map, one can change to an earlier directory (predecessor). To do
1211the opposite, see |netrw-U|.
1212
1213
Bram Moolenaar446cb832008-06-24 21:56:24 +00001214CHANGING TO A SUCCESSOR DIRECTORY *netrw-U* *netrw-downdir* {{{2
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001215
1216With the "U" map, one can change to a later directory (successor).
1217This map is the opposite of the "u" map. (see |netrw-u|) Use the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001218q map to list both the bookmarks and history. (see |netrw-qb|)
1219
1220
1221NETRW CLEAN *netrw-clean* *:NetrwClean*
1222
1223With :NetrwClean one may easily remove netrw from one's home directory;
1224more precisely, from the first directory on your |'runtimepath'|.
1225
1226With :NetrwClean!, netrw will remove netrw from all directories on your
1227|'runtimepath'|.
1228
1229With either form of the command, netrw will first ask for confirmation
1230that the removal is in fact what you want to do. If netrw doesn't have
1231permission to remove a file, it will issue an error message.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001232
Bram Moolenaar9964e462007-05-05 17:54:07 +00001233 *netrw-gx*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001234CUSTOMIZING BROWSING WITH A USER FUNCTION *netrw-x* *netrw-handler* {{{2
Bram Moolenaar9964e462007-05-05 17:54:07 +00001235 (also see |netrw_filehandler|)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001236
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001237Certain files, such as html, gif, jpeg, (word/office) doc, etc, files, are
1238best seen with a special handler (ie. a tool provided with your computer).
1239Netrw allows one to invoke such special handlers by: >
1240
1241 * when Exploring, hit the "x" key
1242 * when editing, hit gx with the cursor atop the special filename
Bram Moolenaar9964e462007-05-05 17:54:07 +00001243< (not available if the |g:netrw_nogx| variable exists)
1244
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001245Netrw determines which special handler by the following method:
1246
1247 * if |g:netrw_browsex_viewer| exists, then it will be used to attempt to
1248 view files. Examples of useful settings (place into your <.vimrc>): >
1249
1250 :let g:netrw_browsex_viewer= "kfmclient exec"
1251< or >
1252 :let g:netrw_browsex_viewer= "gnome-open"
1253<
1254 If g:netrw_browsex_viewer == '-', then netrwFileHandler() will be
1255 invoked first (see |netrw_filehandler|).
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001256
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001257 * for Windows 32 or 64, the url and FileProtocolHandler dlls are used.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001258 * for Gnome (with gnome-open): gnome-open is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001259 * for KDE (with kfmclient) : kfmclient is used.
1260 * for Mac OS X : open is used.
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001261 * otherwise the netrwFileHandler plugin is used.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001262
1263The file's suffix is used by these various approaches to determine an
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001264appropriate application to use to "handle" these files. Such things as
1265OpenOffice (*.sfx), visualization (*.jpg, *.gif, etc), and PostScript (*.ps,
1266*.eps) can be handled.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001267
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001268 *netrw_filehandler*
Bram Moolenaar9964e462007-05-05 17:54:07 +00001269
1270The "x" map applies a function to a file, based on its extension. Of course,
1271the handler function must exist for it to be called!
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001272>
1273 Ex. mypgm.html x ->
Bram Moolenaar9964e462007-05-05 17:54:07 +00001274 NFH_html("scp://user@host/some/path/mypgm.html")
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001275<
Bram Moolenaar9964e462007-05-05 17:54:07 +00001276Users may write their own netrw File Handler functions to support more
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001277suffixes with special handling. See <autoload/netrwFileHandlers.vim> for
Bram Moolenaar9964e462007-05-05 17:54:07 +00001278examples on how to make file handler functions. As an example: >
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001279
Bram Moolenaar9964e462007-05-05 17:54:07 +00001280 " NFH_suffix(filename)
1281 fun! NFH_suffix(filename)
1282 ..do something special with filename..
1283 endfun
1284<
1285These functions need to be defined in some file in your .vim/plugin
1286(vimfiles\plugin) directory. Vim's function names may not have punctuation
1287characters (except for the underscore) in them. To support suffices that
1288contain such characters, netrw will first convert the suffix using the
1289following table: >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001290
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001291 @ -> AT ! -> EXCLAMATION % -> PERCENT
1292 : -> COLON = -> EQUAL ? -> QUESTION
Bram Moolenaar9964e462007-05-05 17:54:07 +00001293 , -> COMMA - -> MINUS ; -> SEMICOLON
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001294 $ -> DOLLAR + -> PLUS ~ -> TILDE
1295<
Bram Moolenaar9964e462007-05-05 17:54:07 +00001296So, for example: >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001297
Bram Moolenaar9964e462007-05-05 17:54:07 +00001298 file.rcs,v -> NFH_rcsCOMMAv()
1299<
1300If more such translations are necessary, please send me email: >
1301 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
1302with a request.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00001303
Bram Moolenaar446cb832008-06-24 21:56:24 +00001304Associated setting variable: |g:netrw_browsex_viewer|
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001305
Bram Moolenaar446cb832008-06-24 21:56:24 +00001306 *netrw-curdir*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001307DELETING BOOKMARKS *netrw-mB* {{{2
1308
1309To delete a bookmark, use >
1310
1311 {cnt}mB
1312<
1313Related Topics:
1314 |netrw-gb| how to return (go) to a bookmark
1315 |netrw-mb| how to make a bookmark
1316 |netrw-qb| how to list bookmarks
1317
1318
Bram Moolenaar446cb832008-06-24 21:56:24 +00001319DELETING FILES OR DIRECTORIES *netrw-delete* *netrw-D* *netrw-del* {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001320
Bram Moolenaar446cb832008-06-24 21:56:24 +00001321If files have not been marked with |netrw-mf|: (local marked file list)
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001322
Bram Moolenaar446cb832008-06-24 21:56:24 +00001323 Deleting/removing files and directories involves moving the cursor to the
1324 file/directory to be deleted and pressing "D". Directories must be empty
1325 first before they can be successfully removed. If the directory is a
1326 softlink to a directory, then netrw will make two requests to remove the
1327 directory before succeeding. Netrw will ask for confirmation before doing
1328 the removal(s). You may select a range of lines with the "V" command
1329 (visual selection), and then pressing "D".
Bram Moolenaar9964e462007-05-05 17:54:07 +00001330
Bram Moolenaar446cb832008-06-24 21:56:24 +00001331If files have been marked with |netrw-mf|: (local marked file list)
1332
1333 Marked files (and empty directories) will be deleted; again, you'll be
1334 asked to confirm the deletion before it actually takes place.
1335
1336The |g:netrw_rm_cmd|, |g:netrw_rmf_cmd|, and |g:netrw_rmdir_cmd| variables are
1337used to control the attempts to remove files and directories. The
1338g:netrw_rm_cmd is used with files, and its default value is:
1339
1340 g:netrw_rm_cmd: ssh HOSTNAME rm
1341
1342The g:netrw_rmdir_cmd variable is used to support the removal of directories.
1343Its default value is:
1344
1345 g:netrw_rmdir_cmd: ssh HOSTNAME rmdir
1346
1347If removing a directory fails with g:netrw_rmdir_cmd, netrw then will attempt
1348to remove it again using the g:netrw_rmf_cmd variable. Its default value is:
1349
1350 g:netrw_rmf_cmd: ssh HOSTNAME rm -f
1351
1352Associated setting variable: |g:netrw_local_rmdir| |g:netrw_rm_cmd|
1353 |g:netrw_rmdir_cmd| |g:netrw_ssh_cmd|
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001354
1355
Bram Moolenaar446cb832008-06-24 21:56:24 +00001356*netrw-explore* *netrw-hexplore* *netrw-nexplore* *netrw-pexplore*
1357*netrw-rexplore* *netrw-sexplore* *netrw-texplore* *netrw-vexplore*
1358DIRECTORY EXPLORATION COMMANDS {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001359
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001360 :[N]Explore[!] [dir]... Explore directory of current file *:Explore*
1361 :[N]Hexplore[!] [dir]... Horizontal Split & Explore *:Hexplore*
1362 :Rexplore ... Return to Explorer *:Rexplore*
1363 :[N]Sexplore[!] [dir]... Split&Explore current file's directory *:Sexplore*
1364 :Texplore [dir]... Tab & Explore *:Texplore*
1365 :[N]Vexplore[!] [dir]... Vertical Split & Explore *:Vexplore*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001366
1367 Used with :Explore **/pattern : (also see |netrw-starstar|)
1368 :Nexplore............. go to next matching file *:Nexplore*
1369 :Pexplore............. go to previous matching file *:Pexplore*
1370
1371:Explore will open the local-directory browser on the current file's
1372 directory (or on directory [dir] if specified). The window will be
1373 split only if the file has been modified, otherwise the browsing
1374 window will take over that window. Normally the splitting is taken
1375 horizontally.
1376:Explore! is like :Explore, but will use vertical splitting.
1377:Sexplore will always split the window before invoking the local-directory
1378 browser. As with Explore, the splitting is normally done
1379 horizontally.
1380:Sexplore! [dir] is like :Sexplore, but the splitting will be done vertically.
1381:Hexplore [dir] does an :Explore with |:belowright| horizontal splitting.
1382:Hexplore! [dir] does an :Explore with |:aboveleft| horizontal splitting.
1383:Vexplore [dir] does an :Explore with |:leftabove| vertical splitting.
1384:Vexplore! [dir] does an :Explore with |:rightbelow| vertical splitting.
1385:Texplore [dir] does a tabnew before generating the browser window
1386
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001387By default, these commands use the current file's directory. However, one may
1388explicitly provide a directory (path) to use.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001389
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001390The [N] will override |g:netrw_winsize| to specify the quantity of rows and/or
1391columns the new explorer window should have.
1392
1393Otherwise, the |g:netrw_winsize| variable, if it has been specified by the
1394user, is used to control the quantity of rows and/or columns new explorer
1395windows should have.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001396
1397:Rexplore This command is a little different from the others. When one
1398 edits a file, for example by pressing <cr> when atop a file in
1399 a netrw browser window, :Rexplore will return the display to
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001400 that of the last netrw browser window. It is a command version
1401 of the <2-leftmouse> map (which is only available under gvim and
Bram Moolenaar446cb832008-06-24 21:56:24 +00001402 cooperative terms).
1403
1404
1405*netrw-star* *netrw-starpat* *netrw-starstar* *netrw-starstarpat*
1406EXPLORING WITH STARS AND PATTERNS
1407
1408When Explore, Sexplore, Hexplore, or Vexplore are used with one of the
1409following four styles, Explore generates a list of files which satisfy
1410the request. >
1411
1412 */filepat files in current directory which satisfy filepat
1413 **/filepat files in current directory or below which satisfy the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001414 file pattern
Bram Moolenaar446cb832008-06-24 21:56:24 +00001415 *//pattern files in the current directory which contain the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001416 pattern (vimgrep is used)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001417 **//pattern files in the current directory or below which contain
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001418 the pattern (vimgrep is used)
Bram Moolenaar572cb562005-08-05 21:35:02 +00001419<
Bram Moolenaar446cb832008-06-24 21:56:24 +00001420The cursor will be placed on the first file in the list. One may then
1421continue to go to subsequent files on that list via |:Nexplore| or to
1422preceding files on that list with |:Pexplore|. Explore will update the
1423directory and place the cursor appropriately.
1424
1425A plain >
1426 :Explore
1427will clear the explore list.
1428
1429If your console or gui produces recognizable shift-up or shift-down sequences,
1430then you'll likely find using shift-downarrow and shift-uparrow convenient.
1431They're mapped by netrw:
1432
1433 <s-down> == Nexplore, and
1434 <s-up> == Pexplore.
1435
1436As an example, consider
1437>
1438 :Explore */*.c
1439 :Nexplore
1440 :Nexplore
1441 :Pexplore
1442<
1443The status line will show, on the right hand side of the status line, a
1444message like "Match 3 of 20".
1445
1446Associated setting variables: |g:netrw_keepdir| |g:netrw_browse_split|
1447 |g:netrw_fastbrowse| |g:netrw_ftp_browse_reject|
1448 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd|
1449 |g:netrw_ftp_timelist_cmd| |g:netrw_list_cmd|
1450 |g:netrw_liststyle|
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001451
1452
Bram Moolenaar446cb832008-06-24 21:56:24 +00001453DISPLAYING INFORMATION ABOUT FILE *netrw-qf* {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001454
Bram Moolenaar446cb832008-06-24 21:56:24 +00001455With the cursor atop a filename, pressing "qf" will reveal the file's size
1456and last modification timestamp. Currently this capability is only available
1457for local files.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001458
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001459
Bram Moolenaar446cb832008-06-24 21:56:24 +00001460EDIT FILE OR DIRECTORY HIDING LIST *netrw-ctrl-h* *netrw-edithide* {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001461
Bram Moolenaar446cb832008-06-24 21:56:24 +00001462The "<ctrl-h>" map brings up a requestor allowing the user to change the
1463file/directory hiding list contained in |g:netrw_list_hide|. The hiding list
1464consists of one or more patterns delimited by commas. Files and/or
1465directories satisfying these patterns will either be hidden (ie. not shown) or
1466be the only ones displayed (see |netrw-a|).
1467
1468The "gh" mapping (see |netrw-gh|) quickly alternates between the usual
1469hiding list and the hiding of files or directories that begin with ".".
1470
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001471As an example, >
1472 let g:netrw_list_hide= '\(^\|\s\s\)\zs\.\S\+'
1473Effectively, this makes the effect of a |netrw-gh| command the initial setting.
1474What it means:
1475
1476 \(^\|\s\s\) : if the line begins with the following, -or-
1477 two consecutive spaces are encountered
1478 \zs : start the hiding match now
1479 \. : if it now begins with a dot
1480 \S\+ : and is followed by one or more non-whitespace
1481 characters
1482
Bram Moolenaar446cb832008-06-24 21:56:24 +00001483Associated setting variables: |g:netrw_hide| |g:netrw_list_hide|
1484Associated topics: |netrw-a| |netrw-gh| |netrw-mh|
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001485
1486
Bram Moolenaar446cb832008-06-24 21:56:24 +00001487EDITING THE SORTING SEQUENCE *netrw-S* *netrw-sortsequence* {{{2
1488
1489When "Sorted by" is name, one may specify priority via the sorting sequence
1490(g:netrw_sort_sequence). The sorting sequence typically prioritizes the
1491name-listing by suffix, although any pattern will do. Patterns are delimited
1492by commas. The default sorting sequence is (all one line):
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001493
1494For Unix: >
1495 '[\/]$,\<core\%(\.\d\+\)\=,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$,
1496 \.info$,\.swp$,\.bak$,\~$'
1497<
1498Otherwise: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00001499 '[\/]$,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$,\.info$,
1500 \.swp$,\.bak$,\~$'
1501<
1502The lone * is where all filenames not covered by one of the other patterns
1503will end up. One may change the sorting sequence by modifying the
1504g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by
1505using the "S" map.
1506
Bram Moolenaarc236c162008-07-13 17:41:49 +00001507Related topics: |netrw-s| |netrw-S|
1508Associated setting variables: |g:netrw_sort_sequence| |g:netrw_sort_options|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001509
1510
1511GOING UP *netrw--* {{{2
1512
1513To go up a directory, press "-" or press the <cr> when atop the ../ directory
1514entry in the listing.
1515
1516Netrw will use the command in |g:netrw_list_cmd| to perform the directory
1517listing operation after changing HOSTNAME to the host specified by the
1518user-provided url. By default netrw provides the command as:
1519
1520 ssh HOSTNAME ls -FLa
1521
1522where the HOSTNAME becomes the [user@]hostname as requested by the attempt to
1523read. Naturally, the user may override this command with whatever is
1524preferred. The NetList function which implements remote browsing
1525expects that directories will be flagged by a trailing slash.
1526
1527
1528HIDING FILES OR DIRECTORIES *netrw-a* *netrw-hiding* {{{2
1529
1530Netrw's browsing facility allows one to use the hiding list in one of three
1531ways: ignore it, hide files which match, and show only those files which
1532match.
1533
1534If no files have been marked via |netrw-mf|:
1535
1536The "a" map allows the user to cycle through the three hiding modes.
1537
1538The |g:netrw_list_hide| variable holds a comma delimited list of patterns
1539based on regular expressions (ex. ^.*\.obj$,^\.) which specify the hiding list.
1540(also see |netrw-ctrl-h|) To set the hiding list, use the <c-h> map. As an
1541example, to hide files which begin with a ".", one may use the <c-h> map to
1542set the hiding list to '^\..*' (or one may put let g:netrw_list_hide= '^\..*'
1543in one's <.vimrc>). One may then use the "a" key to show all files, hide
1544matching files, or to show only the matching files.
1545
1546 Example: \.[ch]$
1547 This hiding list command will hide/show all *.c and *.h files.
1548
1549 Example: \.c$,\.h$
1550 This hiding list command will also hide/show all *.c and *.h
1551 files.
1552
1553Don't forget to use the "a" map to select the mode (normal/hiding/show) you
1554want!
1555
1556If files have been marked using |netrw-mf|, then this command will:
1557
1558 if showing all files or non-hidden files:
1559 modify the g:netrw_list_hide list by appending the marked files to it
1560 and showing only non-hidden files.
1561
1562 else if showing hidden files only:
1563 modify the g:netrw_list_hide list by removing the marked files from it
1564 and showing only non-hidden files.
1565 endif
1566
1567 *netrw-gh* *netrw-hide*
1568As a quick shortcut, one may press >
1569 gh
1570to toggle between hiding files which begin with a period (dot) and not hiding
1571them.
1572
1573Associated setting variable: |g:netrw_list_hide|
1574Associated topics: |netrw-a| |netrw-ctrl-h| |netrw-mh|
1575
1576IMPROVING BROWSING *netrw-listhack* *netrw-ssh-hack* {{{2
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001577
1578Especially with the remote directory browser, constantly entering the password
1579is tedious.
1580
Bram Moolenaar9964e462007-05-05 17:54:07 +00001581For Linux/Unix systems, the book "Linux Server Hacks - 100 industrial strength
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00001582tips & tools" by Rob Flickenger (O'Reilly, ISBN 0-596-00461-3) gives a tip
1583for setting up no-password ssh and scp and discusses associated security
Bram Moolenaar9964e462007-05-05 17:54:07 +00001584issues. It used to be available at http://hacks.oreilly.com/pub/h/66 ,
1585but apparently that address is now being redirected to some "hackzine".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001586I'll attempt a summary based on that article and on a communication from
1587Ben Schmidt:
Bram Moolenaar843ee412004-06-30 16:16:41 +00001588
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001589 1. Generate a public/private key pair on the local machine
1590 (ssh client): >
1591 ssh-keygen -t rsa
1592 (saving the file in ~/.ssh/id_rsa as prompted)
1593<
1594 2. Just hit the <CR> when asked for passphrase (twice) for no
1595 passphrase. If you do use a passphrase, you will also need to use
1596 ssh-agent so you only have to type the passphrase once per session.
1597 If you don't use a passphrase, simply logging onto your local
1598 computer or getting access to the keyfile in any way will suffice
1599 to access any ssh servers which have that key authorized for login.
1600
1601 3. This creates two files: >
1602 ~/.ssh/id_rsa
1603 ~/.ssh/id_rsa.pub
1604<
1605 4. On the target machine (ssh server): >
1606 cd
1607 mkdir -p .ssh
1608 chmod 0700 .ssh
1609<
1610 5. On your local machine (ssh client): (one line) >
1611 ssh {serverhostname}
1612 cat '>>' '~/.ssh/authorized_keys2' < ~/.ssh/id_rsa.pub
1613<
1614 or, for OpenSSH, (one line) >
1615 ssh {serverhostname}
1616 cat '>>' '~/.ssh/authorized_keys' < ~/.ssh/id_rsa.pub
1617<
1618You can test it out with >
1619 ssh {serverhostname}
1620and you should be log onto the server machine without further need to type
1621anything.
1622
1623If you decided to use a passphrase, do: >
1624 ssh-agent $SHELL
1625 ssh-add
1626 ssh {serverhostname}
1627You will be prompted for your key passphrase when you use ssh-add, but not
1628subsequently when you use ssh. For use with vim, you can use >
1629 ssh-agent vim
1630and, when next within vim, use >
1631 :!ssh-add
1632Alternatively, you can apply ssh-agent to the terminal you're planning on
1633running vim in: >
1634 ssh-agent xterm &
1635and do ssh-add whenever you need.
Bram Moolenaar843ee412004-06-30 16:16:41 +00001636
Bram Moolenaar9964e462007-05-05 17:54:07 +00001637For Windows, folks on the vim mailing list have mentioned that Pageant helps
1638with avoiding the constant need to enter the password.
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001639
Bram Moolenaar446cb832008-06-24 21:56:24 +00001640Kingston Fung wrote about another way to avoid constantly needing to enter
1641passwords:
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001642
Bram Moolenaar446cb832008-06-24 21:56:24 +00001643 In order to avoid the need to type in the password for scp each time, you
1644 provide a hack in the docs to set up a non password ssh account. I found a
1645 better way to do that: I can use a regular ssh account which uses a
1646 password to access the material without the need to key-in the password
1647 each time. It's good for security and convenience. I tried ssh public key
1648 authorization + ssh-agent, implementing this, and it works! Here are two
1649 links with instructions:
1650
1651 http://www.ibm.com/developerworks/library/l-keyc2/
1652 http://sial.org/howto/openssh/publickey-auth/
1653
1654
1655LISTING BOOKMARKS AND HISTORY *netrw-qb* *netrw-listbookmark* {{{2
1656
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001657Pressing "qb" (query bookmarks) will list both the bookmarked directories and
1658directory traversal history.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001659
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001660Related Topics:
1661 |netrw-gb| how to return (go) to a bookmark
1662 |netrw-mb| how to make a bookmark
1663 |netrw-mB| how to delete bookmarks
1664 |netrw-u| change to a predecessor directory via the history stack
1665 |netrw-U| change to a successor directory via the history stack
Bram Moolenaar446cb832008-06-24 21:56:24 +00001666
1667MAKING A NEW DIRECTORY *netrw-d* {{{2
1668
1669With the "d" map one may make a new directory either remotely (which depends
1670on the global variable g:netrw_mkdir_cmd) or locally (which depends on the
1671global variable g:netrw_local_mkdir). Netrw will issue a request for the new
1672directory's name. A bare <CR> at that point will abort the making of the
1673directory. Attempts to make a local directory that already exists (as either
1674a file or a directory) will be detected, reported on, and ignored.
1675
1676Currently, making a directory via ftp is not supported.
1677
1678Associated setting variable: |g:netrw_local_mkdir| |g:netrw_mkdir_cmd|
1679
1680
1681MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY *netrw-c* {{{2
1682
1683By default, |g:netrw_keepdir| is 1. This setting means that the current
1684directory will not track the browsing directory.
1685
1686Setting g:netrw_keepdir to 0 tells netrw to make vim's current directory to
1687track netrw's browsing directory.
1688
1689However, given the default setting for g:netrw_keepdir of 1 where netrw
1690maintains its own separate notion of the current directory, in order to make
1691the two directories the same, use the "c" map (just type c). That map will
1692set Vim's notion of the current directory to netrw's current browsing
1693directory.
1694
1695Associated setting variable: |g:netrw_keepdir|
1696
1697MARKING FILES *netrw-mf* {{{2
1698 (also see |netrw-mr|)
1699
1700One may mark files with the cursor atop a filename and then pressing "mf".
1701With gvim, one may also mark files with <s-leftmouse>. The following netrw
1702maps make use of marked files:
1703
1704 |netrw-a| Hide marked files/directories
1705 |netrw-D| Delete marked files/directories
1706 |netrw-mc| Copy marked files to target
1707 |netrw-md| Apply vimdiff to marked files
1708 |netrw-me| Edit marked files
1709 |netrw-mg| Apply vimgrep to marked files
1710 |netrw-mm| Move marked files
1711 |netrw-mp| Print marked files
1712 |netrw-mt| Set target for |netrw-mm| and |netrw-mc|
1713 |netrw-mT| Generate tags using marked files
1714 |netrw-mx| Apply shell command to marked files
1715 |netrw-mz| Compress/Decompress marked files
1716 |netrw-O| Obtain marked files
1717 |netrw-R| Rename marked files
1718
1719One may unmark files one at a time the same way one marks them; ie. place
1720the cursor atop a marked file and press "mf". This process also works
1721with <s-leftmouse> using gvim. One may unmark all files by pressing
1722"mu" (see |netrw-mu|).
1723
1724*markfilelist* *global_markfilelist* *local_markfilelist*
1725All marked files are entered onto the global marked file list; there is only
1726one such list. In addition, every netrw buffer also has its own local marked
1727file list; since netrw buffers are associated with specific directories, this
1728means that each directory has its own local marked file list. The various
1729commands which operate on marked files use one or the other of the marked file
1730lists.
1731
1732
1733MARKING FILES BY REGULAR EXPRESSION *netrw-mr* {{{2
1734 (also see |netrw-mf|)
1735
1736One may also mark files by pressing "mr"; netrw will then issue a prompt,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001737"Enter regexp: ". You may then enter a shell-style regular expression such
1738as *.c$ (see |glob()|). For remote systems, glob() doesn't work -- so netrw
1739converts "*" into ".*" (see |regexp|) and marks files based on that. In the
1740future I may make it possible to use |regexp|s instead of glob()-style
1741expressions (yet-another-option).
Bram Moolenaar446cb832008-06-24 21:56:24 +00001742
1743
1744MARKED FILES: ARBITRARY COMMAND *netrw-mx* {{{2
1745 (See |netrw-mf| and |netrw-mr| for how to mark files)
1746 (uses the local marked-file list)
1747
1748Upon activation of the "mx" map, netrw will query the user for some (external)
1749command to be applied to all marked files. All "%"s in the command will be
1750substituted with the name of each marked file in turn. If no "%"s are in the
1751command, then the command will be followed by a space and a marked filename.
1752
1753
1754MARKED FILES: COMPRESSION AND DECOMPRESSION *netrw-mz* {{{2
1755 (See |netrw-mf| and |netrw-mr| for how to mark files)
1756 (uses the local marked file list)
1757
1758If any marked files are compressed, then "mz" will decompress them.
1759If any marked files are decompressed, then "mz" will compress them
1760using the command specified by |g:netrw_compress|; by default,
1761that's "gzip".
1762
1763For decompression, netrw provides a |Dictionary| of suffices and their
1764associated decompressing utilities; see |g:netrw_decompress|.
1765
1766Associated setting variables: |g:netrw_compress| |g:netrw_decompress|
1767
1768MARKED FILES: COPYING *netrw-mc* {{{2
1769 (See |netrw-mf| and |netrw-mr| for how to mark files)
1770 (Uses the global marked file list)
1771
1772Select a target directory with mt (|netrw-mt|). Then change directory,
1773select file(s) (see |netrw-mf|), and press "mc".
1774
1775Associated setting variable: |g:netrw_localcopycmd| |g:netrw_ssh_cmd|
1776
1777MARKED FILES: DIFF *netrw-md* {{{2
1778 (See |netrw-mf| and |netrw-mr| for how to mark files)
1779 (uses the global marked file list)
1780
1781Use |vimdiff| to visualize difference between selected files (two or
1782three may be selected for this). Uses the global marked file list.
1783
1784MARKED FILES: EDITING *netrw-me* {{{2
1785 (See |netrw-mf| and |netrw-mr| for how to mark files)
1786 (uses the global marked file list)
1787
1788This command will place the marked files on the |arglist| and commence
1789editing them. One may return the to explorer window with |:Rexplore|.
1790
1791MARKED FILES: GREP *netrw-mg* {{{2
1792 (See |netrw-mf| and |netrw-mr| for how to mark files)
1793 (uses the global marked file list)
1794
1795This command will apply |:vimgrep| to the marked files. The command will ask
1796for the requested pattern; one may enter: >
1797 /pattern/[g][j]
1798 ! /pattern/[g][j]
1799 pattern
1800<
1801MARKED FILES: HIDING AND UNHIDING BY SUFFIX *netrw-mh* {{{2
1802 (See |netrw-mf| and |netrw-mr| for how to mark files)
1803 (uses the local marked file list)
1804
1805This command extracts the suffices of the marked files and toggles their
1806presence on the hiding list. Please note that marking the same suffix
1807this way multiple times will result in the suffix's presence being toggled
1808for each file (so an even quantity of marked files having the same suffix
1809is the same as not having bothered to select them at all).
1810
1811Related topics: |netrw-a| |g:netrw_list_hide|
1812
1813MARKED FILES: MOVING *netrw-mm* {{{2
1814 (See |netrw-mf| and |netrw-mr| for how to mark files)
1815 (uses the global marked file list)
1816
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001817 WARNING: moving files is more dangerous than copying them.
1818 A file being moved is first copied and then deleted; if the
1819 copy operation fails and the delete succeeds, you will lose
1820 the file. Either try things out with unimportant files
1821 first or do the copy and then delete yourself using mc and D.
1822 Use at your own risk!
1823
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001824Select a target directory with mt (|netrw-mt|). Then change directory,
Bram Moolenaar446cb832008-06-24 21:56:24 +00001825select file(s) (see |netrw-mf|), and press "mm".
1826
1827Associated setting variable: |g:netrw_localmovecmd| |g:netrw_ssh_cmd|
1828
1829MARKED FILES: PRINTING *netrw-mp* {{{2
1830 (See |netrw-mf| and |netrw-mr| for how to mark files)
1831 (uses the local marked file list)
1832
1833Netrw will apply the |:hardcopy| command to marked files. What it does
1834is open each file in a one-line window, execute hardcopy, then close the
1835one-line window.
1836
1837
1838MARKED FILES: SOURCING *netrw-ms* {{{2
1839 (See |netrw-mf| and |netrw-mr| for how to mark files)
1840 (uses the local marked file list)
1841
1842Netrw will source the marked files (using vim's |:source| command)
1843
1844
1845MARKED FILES: TAGGING *netrw-mT* {{{2
1846 (See |netrw-mf| and |netrw-mr| for how to mark files)
1847 (uses the global marked file list)
1848
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001849The "mT" mapping will apply the command in |g:netrw_ctags| (by default, it is
Bram Moolenaar446cb832008-06-24 21:56:24 +00001850"ctags") to marked files. For remote browsing, in order to create a tags file
1851netrw will use ssh (see |g:netrw_ssh_cmd|), and so ssh must be available for
1852this to work on remote systems. For your local system, see |ctags| on how to
1853get a version. I myself use hdrtags, currently available at
1854http://mysite.verizon.net/astronaut/src/index.html , and have >
1855
1856 let g:netrw_ctags= "hdrtag"
1857<
1858in my <.vimrc>.
1859
1860When a remote set of files are tagged, the resulting tags file is "obtained";
1861ie. a copy is transferred to the local system's directory. The local tags
1862file is then modified so that one may use it through the network. The
1863modification is concerns the names of the files in the tags; each filename is
1864preceded by the netrw-compatible url used to obtain it. When one subsequently
1865uses one of the go to tag actions (|tags|), the url will be used by netrw to
1866edit the desired file and go to the tag.
1867
Bram Moolenaarc236c162008-07-13 17:41:49 +00001868Associated setting variables: |g:netrw_ctags| |g:netrw_ssh_cmd|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001869
1870
1871MARKED FILES: SETTING THE TARGET DIRECTORY *netrw-mt* {{{2
1872 (See |netrw-mf| and |netrw-mr| for how to mark files)
1873
1874Set the marked file copy/move-to target (see |netrw-mc| and |netrw-mm|):
1875
1876 * if the cursor is atop a file name, then the netrw window's currently
1877 displayed directory is used for the copy/move-to target.
1878
1879 * also, if the cursor is in the banner, then the netrw window's currently
1880 displayed directory is used for the copy/move-to target.
1881
1882 * however, if the cursor is atop a directory name, then that directory is
1883 used for the copy/move-to target
1884
1885There is only one copy/move-to target per vim session; ie. the target is a
1886script variable (see |s:var|) and is shared between all netrw windows (in an
1887instance of vim).
1888
1889MARKED FILES: UNMARKING *netrw-mu* {{{2
1890 (See |netrw-mf| and |netrw-mr| for how to mark files)
1891
1892The "mu" mapping will unmark all currently marked files.
1893
1894
1895NETRW BROWSER VARIABLES *netrw-browser-options* *netrw-browser-var* {{{2
1896
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001897(if you're interested in the netrw file transfer settings, see |netrw-options|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001898
1899The <netrw.vim> browser provides settings in the form of variables which
1900you may modify; by placing these settings in your <.vimrc>, you may customize
1901your browsing preferences. (see also: |netrw-settings|)
1902>
1903 --- -----------
1904 Var Explanation
1905 --- -----------
1906< *g:netrw_alto* change from above splitting to below splitting
1907 by setting this variable (see |netrw-o|)
1908 default: =&sb (see |'sb'|)
1909
1910 *g:netrw_altv* change from left splitting to right splitting
1911 by setting this variable (see |netrw-v|)
1912 default: =&spr (see |'spr'|)
1913
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001914 *g:netrw_banner* enable/suppress the banner
1915 =0: suppress the banner
1916 =1: banner is enabled (default)
1917 NOTE: suppressing the banner is a new feature
1918 which may cause problems.
1919
Bram Moolenaar446cb832008-06-24 21:56:24 +00001920 *g:netrw_browse_split* when browsing, <cr> will open the file by:
1921 =0: re-using the same window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001922 =1: horizontally splitting the window first
1923 =2: vertically splitting the window first
Bram Moolenaar446cb832008-06-24 21:56:24 +00001924 =3: open file in new tab
1925 =4: act like "P" (ie. open previous window)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001926 Note that |g:netrw_preview| may be used
1927 to get vertical splitting instead of
1928 horizontal splitting.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001929
1930 *g:netrw_browsex_viewer* specify user's preference for a viewer: >
1931 "kfmclient exec"
1932 "gnome-open"
1933< If >
1934 "-"
1935< is used, then netrwFileHandler() will look for
1936 a script/function to handle the given
1937 extension. (see |netrw_filehandler|).
1938
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001939 *g:netrw_chgperm* Unix/Linux: "chmod PERM FILENAME"
1940 Windows: "cacls FILENAME /e /p PERM"
1941 Used to change access permission for a file.
1942
Bram Moolenaar446cb832008-06-24 21:56:24 +00001943 *g:netrw_compress* ="gzip"
1944 Will compress marked files with this
1945 command
1946
Bram Moolenaarc236c162008-07-13 17:41:49 +00001947 *g:netrw_ctags* ="ctags"
1948 The default external program used to create tags
1949
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001950 *g:netrw_cursorline* = 1 (default)
1951 will use the |'cursorline'| local setting when
1952 |g:netrw_liststyle| ==0 (thin listing) or
1953 |g:netrw_liststyle| ==1 (long listing) or
1954 |g:netrw_liststyle| ==3 (tree listing)
1955 (ie. doesn't affect the wide listing)
1956 =0: off
1957 =2: like ==1, but the wide listing gets both
1958 cursorline and |'cursorcolumn'|locally set
1959
Bram Moolenaar446cb832008-06-24 21:56:24 +00001960 *g:netrw_decompress* = { ".gz" : "gunzip" ,
1961 ".bz2" : "bunzip2" ,
1962 ".zip" : "unzip" ,
1963 ".tar" : "tar -xf"}
1964 A dictionary mapping suffices to
1965 decompression programs.
1966
1967 *g:netrw_fastbrowse* =0: slow speed directory browsing;
1968 never re-uses directory listings,
1969 always obtains directory listings.
1970 =1: medium speed directory browsing;
1971 re-use directory listings only
1972 when remote directory browsing.
1973 (default value)
1974 =2: fast directory browsing;
1975 only obtains directory listings when the
1976 directory hasn't been seen before
1977 (or |netrw-ctrl-l| is used).
1978
1979 Fast browsing retains old directory listing
1980 buffers so that they don't need to be
1981 re-acquired. This feature is especially
1982 important for remote browsing. However, if
1983 a file is introduced or deleted into or from
1984 such directories, the old directory buffer
1985 becomes out-of-date. One may always refresh
1986 such a directory listing with |netrw-ctrl-l|.
1987 This option gives the user the choice of
1988 trading off accuracy (ie. up-to-date listing)
1989 versus speed.
1990
1991 *g:netrw_fname_escape* =' ?&;%'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001992 Used on filenames before remote reading/writing
Bram Moolenaar446cb832008-06-24 21:56:24 +00001993
1994 *g:netrw_ftp_browse_reject* ftp can produce a number of errors and warnings
1995 that can show up as "directories" and "files"
1996 in the listing. This pattern is used to
1997 remove such embedded messages. By default its
1998 value is:
1999 '^total\s\+\d\+$\|
2000 ^Trying\s\+\d\+.*$\|
2001 ^KERBEROS_V\d rejected\|
2002 ^Security extensions not\|
2003 No such file\|
2004 : connect to address [0-9a-fA-F:]*
2005 : No route to host$'
2006
2007 *g:netrw_ftp_list_cmd* options for passing along to ftp for directory
2008 listing. Defaults:
2009 unix or g:netrw_cygwin set: : "ls -lF"
2010 otherwise "dir"
2011
2012
2013 *g:netrw_ftp_sizelist_cmd* options for passing along to ftp for directory
2014 listing, sorted by size of file.
2015 Defaults:
2016 unix or g:netrw_cygwin set: : "ls -slF"
2017 otherwise "dir"
2018
2019 *g:netrw_ftp_timelist_cmd* options for passing along to ftp for directory
2020 listing, sorted by time of last modification.
2021 Defaults:
2022 unix or g:netrw_cygwin set: : "ls -tlF"
2023 otherwise "dir"
2024
2025 *g:netrw_glob_escape* ='[]*?`{~$'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002026 These characters in directory names are
Bram Moolenaar446cb832008-06-24 21:56:24 +00002027 escaped before applying glob()
2028
2029 *g:netrw_hide* if true, the hiding list is used
2030 default: =0
2031
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002032 *g:netrw_home* The home directory for where bookmarks and
2033 history are saved (as .netrwbook and
2034 .netrwhist).
2035 default: the first directory on the
2036 |'runtimepath'|
2037
Bram Moolenaar446cb832008-06-24 21:56:24 +00002038 *g:netrw_keepdir* =1 (default) keep current directory immune from
2039 the browsing directory.
2040 =0 keep the current directory the same as the
2041 browsing directory.
2042 The current browsing directory is contained in
2043 b:netrw_curdir (also see |netrw-c|)
2044
2045 *g:netrw_list_cmd* command for listing remote directories
2046 default: (if ssh is executable)
2047 "ssh HOSTNAME ls -FLa"
2048
2049 *g:netrw_liststyle* Set the default listing style:
2050 = 0: thin listing (one file per line)
2051 = 1: long listing (one file per line with time
2052 stamp information and file size)
2053 = 2: wide listing (multiple files in columns)
2054 = 3: tree style listing
2055 *g:netrw_list_hide* comma separated pattern list for hiding files
2056 Patterns are regular expressions (see |regexp|)
2057 Example: let g:netrw_list_hide= '.*\.swp$'
2058 default: ""
2059
2060 *g:netrw_localcopycmd* ="cp" Linux/Unix/MacOS/Cygwin
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002061 ="copy" Windows
Bram Moolenaar446cb832008-06-24 21:56:24 +00002062 Copies marked files (|netrw-mf|) to target
2063 directory (|netrw-mt|, |netrw-mc|)
2064
2065 *g:netrw_localmovecmd* ="mv" Linux/Unix/MacOS/Cygwin
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002066 ="move" Windows
Bram Moolenaar446cb832008-06-24 21:56:24 +00002067 Moves marked files (|netrw-mf|) to target
2068 directory (|netrw-mt|, |netrw-mm|)
2069
2070 *g:netrw_local_mkdir* command for making a local directory
2071 default: "mkdir"
2072
2073 *g:netrw_local_rmdir* remove directory command (rmdir)
2074 default: "rmdir"
2075
2076 *g:netrw_maxfilenamelen* =32 by default, selected so as to make long
2077 listings fit on 80 column displays.
2078 If your screen is wider, and you have file
2079 or directory names longer than 32 bytes,
2080 you may set this option to keep listings
2081 columnar.
2082
2083 *g:netrw_mkdir_cmd* command for making a remote directory
2084 default: "ssh USEPORT HOSTNAME mkdir"
2085
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002086 *g:netrw_mousemaps* =1 (default) enables the mouse buttons
2087 while browsing:
2088 leftmouse : open file/directory
2089 shift-leftmouse : mark file
2090 middlemouse : same as P
2091 rightmouse : remove file/directory
2092 =0: disables mouse maps
2093
2094 *g:netrw_retmap* if it exists and is set to one, then:
2095 * if in a netrw-selected file, AND
2096 * no normal-mode <2-leftmouse> mapping exists,
2097 then the <2-leftmouse> will be mapped for easy
Bram Moolenaar446cb832008-06-24 21:56:24 +00002098 return to the netrw browser window.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002099 example: click once to select and open a file,
2100 double-click to return.
2101
2102 Note that one may instead choose to:
2103 * let g:netrw_retmap= 1, AND
2104 * nmap <silent> YourChoice <Plug>NetrwReturn
2105 and have another mapping instead of
2106 <2-leftmouse> to invoke the return.
2107
2108 You may also use the |:Rexplore| command to do
2109 the same thing.
2110
Bram Moolenaar446cb832008-06-24 21:56:24 +00002111 default: =0
2112
2113 *g:netrw_rm_cmd* command for removing files
2114 default: "ssh USEPORT HOSTNAME rm"
2115
2116 *g:netrw_rmdir_cmd* command for removing directories
2117 default: "ssh USEPORT HOSTNAME rmdir"
2118
2119 *g:netrw_rmf_cmd* command for removing softlinks
2120 default: "ssh USEPORT HOSTNAME rm -f"
2121
2122 *g:netrw_sort_by* sort by "name", "time", or "size"
2123 default: "name"
2124
2125 *g:netrw_sort_direction* sorting direction: "normal" or "reverse"
2126 default: "normal"
2127
Bram Moolenaarc236c162008-07-13 17:41:49 +00002128 *g:netrw_sort_options* sorting is done using |:sort|; this
2129 variable's value is appended to the
2130 sort command. Thus one may ignore case,
2131 for example, with the following in your
2132 .vimrc: >
2133 let g:netrw_sort_options="i"
2134< default: ""
2135
Bram Moolenaar446cb832008-06-24 21:56:24 +00002136 *g:netrw_sort_sequence* when sorting by name, first sort by the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002137 comma-separated pattern sequence. Note that
2138 the filigree added to indicate filetypes
2139 should be accounted for in your pattern.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002140 default: '[\/]$,*,\.bak$,\.o$,\.h$,
2141 \.info$,\.swp$,\.obj$'
2142
2143 *g:netrw_special_syntax* If true, then certain files will be shown
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002144 in special syntax in the browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00002145
2146 netrwBak : *.bak
2147 netrwCompress: *.gz *.bz2 *.Z *.zip
2148 netrwData : *.dat
2149 netrwHdr : *.h
2150 netrwLib : *.a *.so *.lib *.dll
2151 netrwMakefile: [mM]akefile *.mak
2152 netrwObj : *.o *.obj
2153 netrwTags : tags ANmenu ANtags
2154 netrwTilde : *~
2155 netrwTmp : tmp* *tmp
2156
2157 These syntax highlighting groups are linked
2158 to Folded or DiffChange by default
2159 (see |hl-Folded| and |hl-DiffChange|), but
2160 one may put lines like >
2161 hi link netrwCompress Visual
2162< into one's <.vimrc> to use one's own
2163 preferences.
2164
2165 *g:netrw_ssh_cmd* One may specify an executable command
2166 to use instead of ssh for remote actions
2167 such as listing, file removal, etc.
2168 default: ssh
2169
2170 *g:netrw_ssh_browse_reject* ssh can sometimes produce unwanted lines,
2171 messages, banners, and whatnot that one doesn't
2172 want masquerading as "directories" and "files".
2173 Use this pattern to remove such embedded
2174 messages. By default its value is:
2175 '^total\s\+\d\+$'
2176
2177
2178 *g:netrw_tmpfile_escape* =' &;'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002179 escape() is applied to all temporary files
Bram Moolenaar446cb832008-06-24 21:56:24 +00002180 to escape these characters.
2181
2182 *g:netrw_timefmt* specify format string to vim's strftime().
2183 The default, "%c", is "the preferred date
2184 and time representation for the current
2185 locale" according to my manpage entry for
2186 strftime(); however, not all are satisfied
2187 with it. Some alternatives:
2188 "%a %d %b %Y %T",
2189 " %a %Y-%m-%d %I-%M-%S %p"
2190 default: "%c"
2191
2192 *g:netrw_use_noswf* netrw normally avoids writing swapfiles
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002193 for browser buffers. However, under some
Bram Moolenaar446cb832008-06-24 21:56:24 +00002194 systems this apparently is causing nasty
2195 ml_get errors to appear; if you're getting
2196 ml_get errors, try putting
2197 let g:netrw_use_noswf= 0
2198 in your .vimrc.
2199
2200 *g:netrw_winsize* specify initial size of new windows made with
2201 "o" (see |netrw-o|), "v" (see |netrw-v|),
2202 |:Hexplore| or |:Vexplore|.
2203 default: ""
2204
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002205 *g:netrw_xstrlen* Controls how netrw computes string lengths,
2206 including multi-byte characters' string
Bram Moolenaar446cb832008-06-24 21:56:24 +00002207 length. (thanks to N Weibull, T Mechelynck)
2208 =0: uses Vim's built-in strlen()
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002209 =1: number of codepoints (Latin a + combining
Bram Moolenaar446cb832008-06-24 21:56:24 +00002210 circumflex is two codepoints) (DEFAULT)
2211 =2: number of spacing codepoints (Latin a +
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002212 combining circumflex is one spacing
Bram Moolenaar446cb832008-06-24 21:56:24 +00002213 codepoint; a hard tab is one; wide and
2214 narrow CJK are one each; etc.)
2215 =3: virtual length (counting tabs as anything
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002216 between 1 and |'tabstop'|, wide CJK as 2
Bram Moolenaar446cb832008-06-24 21:56:24 +00002217 rather than 1, Arabic alif as zero when
2218 immediately preceded by lam, one
2219 otherwise, etc)
2220
2221 *g:NetrwTopLvlMenu* This variable specifies the top level
2222 menu name; by default, it's "Netrw.". If
2223 you wish to change this, do so in your
2224 .vimrc.
2225
2226NETRW BROWSING AND OPTION INCOMPATIBILITIES *netrw-incompatible* {{{2
2227
2228Netrw has been designed to handle user options by saving them, setting the
2229options to something that's compatible with netrw's needs, and then restoring
2230them. However, the autochdir option: >
2231 :set acd
2232is problematical. Autochdir sets the current directory to that containing the
2233file you edit; this apparently also applies to directories. In other words,
2234autochdir sets the current directory to that containing the "file" (even if
2235that "file" is itself a directory).
2236
2237NETRW SETTINGS *netrw-settings* {{{2
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00002238
2239With the NetrwSettings.vim plugin, >
2240 :NetrwSettings
2241will bring up a window with the many variables that netrw uses for its
Bram Moolenaar1afcace2005-11-25 19:54:28 +00002242settings. You may change any of their values; when you save the file, the
2243settings therein will be used. One may also press "?" on any of the lines for
2244help on what each of the variables do.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00002245
Bram Moolenaar446cb832008-06-24 21:56:24 +00002246(also see: |netrw-browser-var| |netrw-protocol| |netrw-var| |netrw-variables|)
Bram Moolenaar9964e462007-05-05 17:54:07 +00002247
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00002248
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002249==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00002250OBTAINING A FILE *netrw-O* {{{2
2251
2252If there are no marked files:
2253
2254 When browsing a remote directory, one may obtain a file under the cursor
2255 (ie. get a copy on your local machine, but not edit it) by pressing the O
2256 key.
2257
2258If there are marked files:
2259
2260 The marked files will be obtained (ie. a copy will be transferred to your
2261 local machine, but not set up for editing).
2262
2263Only ftp and scp are supported for this operation (but since these two are
2264available for browsing, that shouldn't be a problem). The status bar will
2265then show, on its right hand side, a message like "Obtaining filename". The
2266statusline will be restored after the transfer is complete.
2267
2268Netrw can also "obtain" a file using the local browser. Netrw's display
2269of a directory is not necessarily the same as Vim's "current directory",
2270unless |g:netrw_keepdir| is set to 0 in the user's <.vimrc>. One may select
2271a file using the local browser (by putting the cursor on it) and pressing
2272"O" will then "obtain" the file; ie. copy it to Vim's current directory.
2273
2274Related topics:
2275 * To see what the current directory is, use |:pwd|
2276 * To make the currently browsed directory the current directory, see |netrw-c|
2277 * To automatically make the currently browsed directory the current
2278 directory, see |g:netrw_keepdir|.
2279
2280
Bram Moolenaarc236c162008-07-13 17:41:49 +00002281OPEN A NEW FILE IN NETRW'S CURRENT DIRECTORY *netrw-%*
2282
2283To open a file in netrw's current directory, press "%". This map will
2284query the user for a new filename; an empty file by that name will be
2285placed in the netrw's current directory (ie. b:netrw_curdir).
2286
2287
Bram Moolenaar446cb832008-06-24 21:56:24 +00002288PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2
2289
2290One may use a preview window by using the "p" key when the cursor is atop the
2291desired filename to be previewed. The display will then split to show both
2292the browser (where the cursor will remain) and the file (see |:pedit|).
2293By default, the split will be taken horizontally; one may use vertical
2294splitting if one has set |g:netrw_preview| first.
2295
2296
2297PREVIOUS WINDOW *netrw-P* *netrw-prvwin* {{{2
2298
2299To edit a file or directory in the previously used (last accessed) window (see
2300:he |CTRL-W_p|), press a "P". If there's only one window, then the one window
2301will be horizontally split (above/below splitting is controlled by
2302|g:netrw_alto|, and its initial size is controlled by |g:netrw_winsize|).
2303
2304If there's more than one window, the previous window will be re-used on
2305the selected file/directory. If the previous window's associated buffer
2306has been modified, and there's only one window with that buffer, then
2307the user will be asked if s/he wishes to save the buffer first (yes,
2308no, or cancel).
2309
2310
2311REFRESHING THE LISTING *netrw-ctrl-l* *netrw-ctrl_l* {{{2
2312
2313To refresh either a local or remote directory listing, press ctrl-l (<c-l>) or
2314hit the <cr> when atop the ./ directory entry in the listing. One may also
2315refresh a local directory by using ":e .".
2316
2317
2318RENAMING FILES OR DIRECTORIES *netrw-move* *netrw-rename* *netrw-R* {{{2
2319
2320If there are no marked files: (see |netrw-mf|)
2321
2322 Renaming/moving files and directories involves moving the cursor to the
2323 file/directory to be moved (renamed) and pressing "R". You will then be
2324 queried for where you want the file/directory to be moved. You may select
2325 a range of lines with the "V" command (visual selection), and then
2326 pressing "R".
2327
2328If there are marked files: (see |netrw-mf|)
2329
2330 Marked files will be renamed (moved). You will be queried as above in
2331 order to specify where you want the file/directory to be moved.
2332
2333 WARNING:~
2334
2335 Note that moving files is a dangerous operation; copies are safer. That's
2336 because a "move" for remote files is actually a copy + delete -- and if
2337 the copy fails and the delete does not, you may lose the file.
2338
2339The g:netrw_rename_cmd variable is used to implement renaming. By default its
2340value is:
2341
2342 ssh HOSTNAME mv
2343
2344One may rename a block of files and directories by selecting them with
2345the V (|linewise-visual|).
2346
2347
2348REVERSING SORTING ORDER *netrw-r* *netrw-reverse* {{{2
2349
2350One may toggle between normal and reverse sorting order by pressing the
2351"r" key.
2352
2353Related topics: |netrw-s|
2354Associated setting variable: |g:netrw_sort_direction|
2355
2356
2357SELECTING SORTING STYLE *netrw-s* *netrw-sort* {{{2
2358
2359One may select the sorting style by name, time, or (file) size. The "s" map
2360allows one to circulate amongst the three choices; the directory listing will
2361automatically be refreshed to reflect the selected style.
2362
2363Related topics: |netrw-r| |netrw-S|
2364Associated setting variables: |g:netrw_sort_by| |g:netrw_sort_sequence|
2365
2366
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002367SETTING EDITING WINDOW *netrw-C* {{{2
2368
2369One may select a netrw window for editing with the "C" mapping, or by setting
2370g:netrw_chgwin to the selected window number. Subsequent selection of a file
2371to edit (|netrw-cr|) will use that window.
2372
2373Related topics: |netrw-cr|
2374Associated setting variables: |g:netrw_chgwin|
2375
2376
Bram Moolenaar446cb832008-06-24 21:56:24 +0000237710. Problems and Fixes *netrw-problems* {{{1
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002378
2379 (This section is likely to grow as I get feedback)
2380 (also see |netrw-debug|)
Bram Moolenaar488c6512005-08-11 20:09:58 +00002381 *netrw-p1*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002382 P1. I use windows 95, and my ftp dumps four blank lines at the
2383 end of every read.
2384
2385 See |netrw-fixup|, and put the following into your
2386 <.vimrc> file:
2387
2388 let g:netrw_win95ftp= 1
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00002389
Bram Moolenaar488c6512005-08-11 20:09:58 +00002390 *netrw-p2*
Bram Moolenaar9964e462007-05-05 17:54:07 +00002391 P2. I use Windows, and my network browsing with ftp doesn't sort by
2392 time or size! -or- The remote system is a Windows server; why
2393 don't I get sorts by time or size?
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002394
2395 Windows' ftp has a minimal support for ls (ie. it doesn't
2396 accept sorting options). It doesn't support the -F which
2397 gives an explanatory character (ABC/ for "ABC is a directory").
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002398 Netrw then uses "dir" to get both its thin and long listings.
Bram Moolenaar9964e462007-05-05 17:54:07 +00002399 If you think your ftp does support a full-up ls, put the
2400 following into your <.vimrc>: >
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002401
Bram Moolenaar9964e462007-05-05 17:54:07 +00002402 let g:netrw_ftp_list_cmd = "ls -lF"
2403 let g:netrw_ftp_timelist_cmd= "ls -tlF"
2404 let g:netrw_ftp_sizelist_cmd= "ls -slF"
2405<
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002406 Alternatively, if you have cygwin on your Windows box, put
Bram Moolenaar9964e462007-05-05 17:54:07 +00002407 into your <.vimrc>: >
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002408
2409 let g:netrw_cygwin= 1
Bram Moolenaar9964e462007-05-05 17:54:07 +00002410<
2411 This problem also occurs when the remote system is Windows.
2412 In this situation, the various g:netrw_ftp_[time|size]list_cmds
2413 are as shown above, but the remote system will not correctly
2414 modify its listing behavior.
2415
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002416
Bram Moolenaar488c6512005-08-11 20:09:58 +00002417 *netrw-p3*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002418 P3. I tried rcp://user@host/ (or protocol other than ftp) and netrw
2419 used ssh! That wasn't what I asked for...
2420
2421 Netrw has two methods for browsing remote directories: ssh
2422 and ftp. Unless you specify ftp specifically, ssh is used.
2423 When it comes time to do download a file (not just a directory
2424 listing), netrw will use the given protocol to do so.
2425
Bram Moolenaar488c6512005-08-11 20:09:58 +00002426 *netrw-p4*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002427 P4. I would like long listings to be the default.
2428
Bram Moolenaar446cb832008-06-24 21:56:24 +00002429 Put the following statement into your |.vimrc|: >
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002430
Bram Moolenaar446cb832008-06-24 21:56:24 +00002431 let g:netrw_liststyle= 1
2432<
2433 Check out |netrw-browser-var| for more customizations that
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002434 you can set.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002435
Bram Moolenaar488c6512005-08-11 20:09:58 +00002436 *netrw-p5*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002437 P5. My times come up oddly in local browsing
2438
2439 Does your system's strftime() accept the "%c" to yield dates
2440 such as "Sun Apr 27 11:49:23 1997"? If not, do a "man strftime"
2441 and find out what option should be used. Then put it into
Bram Moolenaar446cb832008-06-24 21:56:24 +00002442 your |.vimrc|: >
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002443
Bram Moolenaar446cb832008-06-24 21:56:24 +00002444 let g:netrw_timefmt= "%X" (where X is the option)
2445<
Bram Moolenaar488c6512005-08-11 20:09:58 +00002446 *netrw-p6*
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002447 P6. I want my current directory to track my browsing.
2448 How do I do that?
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002449
Bram Moolenaar446cb832008-06-24 21:56:24 +00002450 Put the following line in your |.vimrc|:
2451>
Bram Moolenaar433f7c82006-03-21 21:29:36 +00002452 let g:netrw_keepdir= 0
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002453<
Bram Moolenaar9964e462007-05-05 17:54:07 +00002454 *netrw-p7*
2455 P7. I use Chinese (or other non-ascii) characters in my filenames, and
2456 netrw (Explore, Sexplore, Hexplore, etc) doesn't display them!
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00002457
Bram Moolenaar9964e462007-05-05 17:54:07 +00002458 (taken from an answer provided by Wu Yongwei on the vim
2459 mailing list)
2460 I now see the problem. You code page is not 936, right? Vim
2461 seems only able to open files with names that are valid in the
2462 current code page, as are many other applications that do not
2463 use the Unicode version of Windows APIs. This is an OS-related
2464 issue. You should not have such problems when the system
2465 locale uses UTF-8, such as modern Linux distros.
2466
2467 (...it is one more reason to recommend that people use utf-8!)
2468
2469 *netrw-p8*
2470 P8. I'm getting "ssh is not executable on your system" -- what do I
2471 do?
2472
2473 (Dudley Fox) Most people I know use putty for windows ssh. It
2474 is a free ssh/telnet application. You can read more about it
2475 here:
2476
2477 http://www.chiark.greenend.org.uk/~sgtatham/putty/ Also:
2478
2479 (Marlin Unruh) This program also works for me. It's a single
2480 executable, so he/she can copy it into the Windows\System32
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002481 folder and create a shortcut to it.
Bram Moolenaar9964e462007-05-05 17:54:07 +00002482
2483 (Dudley Fox) You might also wish to consider plink, as it
2484 sounds most similar to what you are looking for. plink is an
2485 application in the putty suite.
2486
2487 http://the.earth.li/~sgtatham/putty/0.58/htmldoc/Chapter7.html#plink
2488
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002489 (Vissale Neang) Maybe you can try OpenSSH for windows, which
Bram Moolenaar9964e462007-05-05 17:54:07 +00002490 can be obtained from:
2491
2492 http://sshwindows.sourceforge.net/
2493
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002494 It doesn't need the full Cygwin package.
Bram Moolenaar9964e462007-05-05 17:54:07 +00002495
2496 (Antoine Mechelynck) For individual Unix-like programs needed
2497 for work in a native-Windows environment, I recommend getting
2498 them from the GnuWin32 project on sourceforge if it has them:
2499
2500 http://gnuwin32.sourceforge.net/
2501
2502 Unlike Cygwin, which sets up a Unix-like virtual machine on
2503 top of Windows, GnuWin32 is a rewrite of Unix utilities with
2504 Windows system calls, and its programs works quite well in the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002505 cmd.exe "Dos box".
Bram Moolenaar9964e462007-05-05 17:54:07 +00002506
2507 (dave) Download WinSCP and use that to connect to the server.
2508 In Preferences > Editors, set gvim as your editor:
2509
2510 - Click "Add..."
2511 - Set External Editor (adjust path as needed, include
2512 the quotes and !.! at the end):
2513 "c:\Program Files\Vim\vim70\gvim.exe" !.!
2514 - Check that the filetype in the box below is
2515 {asterisk}.{asterisk} (all files), or whatever types
2516 you want (cec: change {asterisk} to * ; I had to
2517 write it that way because otherwise the helptags
Bram Moolenaar446cb832008-06-24 21:56:24 +00002518 system thinks it's a tag)
2519 - Make sure it's at the top of the listbox (click it,
2520 then click "Up" if it's not)
Bram Moolenaar9964e462007-05-05 17:54:07 +00002521 If using the Norton Commander style, you just have to hit <F4>
2522 to edit a file in a local copy of gvim.
2523
2524 (Vit Gottwald) How to generate public/private key and save
2525 public key it on server: >
2526 http://www.tartarus.org/~simon/puttydoc/Chapter8.html#pubkey-gettingready
2527 8.3 Getting ready for public key authentication
2528<
Bram Moolenaar446cb832008-06-24 21:56:24 +00002529 How to use a private key with 'pscp': >
2530
Bram Moolenaar9964e462007-05-05 17:54:07 +00002531 http://www.tartarus.org/~simon/puttydoc/Chapter5.html
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002532 5.2.4 Using public key authentication with PSCP
Bram Moolenaar9964e462007-05-05 17:54:07 +00002533<
Bram Moolenaar446cb832008-06-24 21:56:24 +00002534 (Ben Schmidt) I find the ssh included with cwRsync is
2535 brilliant, and install cwRsync or cwRsyncServer on most
2536 Windows systems I come across these days. I guess COPSSH,
2537 packed by the same person, is probably even better for use as
2538 just ssh on Windows, and probably includes sftp, etc. which I
2539 suspect the cwRsync doesn't, though it might
2540
Bram Moolenaar9964e462007-05-05 17:54:07 +00002541 (cec) To make proper use of these suggestions above, you will
2542 need to modify the following user-settable variables in your
2543 .vimrc:
2544
Bram Moolenaar446cb832008-06-24 21:56:24 +00002545 |g:netrw_ssh_cmd| |g:netrw_list_cmd| |g:netrw_mkdir_cmd|
2546 |g:netrw_rm_cmd| |g:netrw_rmdir_cmd| |g:netrw_rmf_cmd|
Bram Moolenaar9964e462007-05-05 17:54:07 +00002547
2548 The first one (|g:netrw_ssh_cmd|) is the most important; most
2549 of the others will use the string in g:netrw_ssh_cmd by
2550 default.
2551 *netrw-p9* *netrw-ml_get*
2552 P9. I'm browsing, changing directory, and bang! ml_get errors
2553 appear and I have to kill vim. Any way around this?
2554
2555 Normally netrw attempts to avoid writing swapfiles for
2556 its temporary directory buffers. However, on some systems
2557 this attempt appears to be causing ml_get errors to
2558 appear. Please try setting |g:netrw_use_noswf| to 0
2559 in your <.vimrc>: >
2560 let g:netrw_use_noswf= 0
2561<
Bram Moolenaar446cb832008-06-24 21:56:24 +00002562 *netrw-p10*
2563 P10. I'm being pestered with "[something] is a directory" and
2564 "Press ENTER or type command to continue" prompts...
2565
2566 The "[something] is a directory" prompt is issued by Vim,
2567 not by netrw, and there appears to be no way to work around
2568 it. Coupled with the default cmdheight of 1, this message
2569 causes the "Press ENTER..." prompt. So: read |hit-enter|;
2570 I also suggest that you set your |'cmdheight'| to 2 (or more) in
2571 your <.vimrc> file.
2572
2573 *netrw-p11*
2574 P11. I want to have two windows; a thin one on the left and my editing
2575 window on the right. How can I do this?
2576
2577 * Put the following line in your <.vimrc>:
2578 let g:netrw_altv = 1
2579 * Edit the current directory: :e .
2580 * Select some file, press v
2581 * Resize the windows as you wish (see |CTRL-W_<| and
2582 |CTRL-W_>|). If you're using gvim, you can drag
2583 the separating bar with your mouse.
2584 * When you want a new file, use ctrl-w h to go back to the
2585 netrw browser, select a file, then press P (see |CTRL-W_h|
2586 and |netrw-P|). If you're using gvim, you can press
2587 <leftmouse> in the browser window and then press the
2588 <middlemouse> to select the file.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002589
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002590 *netrw-p12*
2591 P12. My directory isn't sorting correctly, or unwanted letters are
2592 appearing in the listed filenames, or things aren't lining
2593 up properly in the wide listing, ...
2594
2595 This may be due to an encoding problem. I myself usually use
2596 utf-8, but really only use ascii (ie. bytes from 32-126).
2597 Multibyte encodings use two (or more) bytes per character.
2598 You may need to change |g:netrw_sepchr| and/or |g:netrw_xstrlen|.
2599
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002600==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +0000260111. Debugging Netrw Itself *netrw-debug* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602
2603The <netrw.vim> script is typically available as:
Bram Moolenaar488c6512005-08-11 20:09:58 +00002604>
Bram Moolenaar446cb832008-06-24 21:56:24 +00002605 /usr/local/share/vim/vim6x/plugin/netrwPlugin.vim
2606 /usr/local/share/vim/vim6x/autoload/netrw.vim
Bram Moolenaar488c6512005-08-11 20:09:58 +00002607< -or- >
Bram Moolenaar446cb832008-06-24 21:56:24 +00002608 /usr/local/share/vim/vim7x/plugin/netrwPlugin.vim
2609 /usr/local/share/vim/vim7x/autoload/netrw.vim
Bram Moolenaar488c6512005-08-11 20:09:58 +00002610<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611which is loaded automatically at startup (assuming :set nocp).
2612
2613 1. Get the <Decho.vim> script, available as:
2614
Bram Moolenaar446cb832008-06-24 21:56:24 +00002615 http://mysite.verizon.net/astronaut/vim/index.html#DECHO
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 or
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00002617 http://vim.sourceforge.net/scripts/script.php?script_id=120
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618
Bram Moolenaar446cb832008-06-24 21:56:24 +00002619 It now comes as a "vimball"; if you're using vim 7.0 or earlier,
2620 you'll need to update vimball, too. See
2621 http://mysite.verizon.net/astronaut/vim/index.html#VIMBALL
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00002622
Bram Moolenaar446cb832008-06-24 21:56:24 +00002623 2. Edit the <netrw.vim> file by typing: >
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002624
2625 vim netrw.vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 :DechoOn
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002627 :wq
Bram Moolenaar446cb832008-06-24 21:56:24 +00002628<
2629 To restore to normal non-debugging behavior, re-edit <netrw.vim>
2630 and type >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002632 vim netrw.vim
2633 :DechoOff
2634 :wq
Bram Moolenaar446cb832008-06-24 21:56:24 +00002635<
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002636 This command, provided by <Decho.vim>, will comment out all
2637 Decho-debugging statements (Dfunc(), Dret(), Decho(), Dredir()).
2638
Bram Moolenaar446cb832008-06-24 21:56:24 +00002639 3. Then bring up vim and attempt to evoke the problem by doing a
2640 transfer or doing some browsing. A set of messages should appear
2641 concerning the steps that <netrw.vim> took in attempting to
2642 read/write your file over the network in a separate tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643
Bram Moolenaar9964e462007-05-05 17:54:07 +00002644 To save the file, use >
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002645 :tabnext
Bram Moolenaar9964e462007-05-05 17:54:07 +00002646 :set bt=
2647 :w! DBG
2648< Please send that information to <netrw.vim>'s maintainer, >
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002649 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
Bram Moolenaar9964e462007-05-05 17:54:07 +00002650<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651==============================================================================
Bram Moolenaar9964e462007-05-05 17:54:07 +0000265212. History *netrw-history* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002654 v136: Jan 14, 2009 * extended |g:Netrw_funcref| to also handle lists
2655 of function references
2656 Jan 14, 2009 * (reported by Marvin Renich) with spell check
2657 enabled, some filenamess will still being
2658 displayed as spelling errors.
2659 Apr 13, 2009 * (Björn Winckler) writing a file using
2660 remote scp caused syntax highlighting problem.
2661 Solution: avoid syntax/syntax.vim's
2662 au Filetype * syntax setting autocommand by
2663 checking that the current buffer has the
2664 netrw filetype before attempting a doau
2665 in s:NetrwSafeOptions().
2666 Apr 14, 2009 * (asgeo1) suggested the "T" map (|netrw-T|)
2667 Apr 14, 2009 * marking wasn't working on executable and
2668 other special filenames
2669 Apr 20, 2009 * (Dennis Benzinger) files opened via http have
2670 their syntax filetype auto-detected
2671 Jun 19, 2009 * (Yukihiro Nakadaira) help document improvements
2672 Jul 22, 2009 * g:netrw_browse_split will honor the
2673 |'equalalways'| setting.
2674 Jul 29, 2009 * implemented "I" mapping to toggle banner
2675 (this is experimental and still being debugged)
2676 Sep 19, 2009 * (Mike McEwan) writes via ftp now send both
2677 g:netrw_ftpmode and g:netrw_ftpextracmd (if the
2678 latter exists)
2679 Dec 02, 2009 * netrw uses vimgrep several places; it now uses
2680 "noautocmd vimgrep" (should be speedier).
2681 Dec 03, 2009 * changed back to using -source instead of -dump
2682 for elinks-using commands. (requested by James
2683 Vega and Karsten Hopp)
2684 v135: Oct 29, 2008 * using |simplify()| on directory names
2685 (supporting handling ".."s in directory names)
2686 Oct 31, 2008 * added special file highlighting for core dumps
2687 under Unix/Linux. The default sorting sequence
2688 now also gives core dumps priority.
2689 Nov 10, 2008 * uses a call to netrw#Nread() instead of Nread
2690 to avoid having to use fnameescape()
2691 * fixed a tree redrawing problem (open directory,
2692 open subdir, close subdir, close dir)
2693 Nov 19, 2008 * sprinkled some histdel("/",-1)s through the code
2694 in an attempt to prevent netrw from changing
2695 the search history.
2696 Jan 02, 2009 * |g:Netrw_funcref| included
2697 Jan 05, 2009 * Explore */ **/ *// **// all clear explorer
2698 variables
2699 Jan 05, 2009 * (Panagiotis Louridas) extended s:WinPath()
2700 to remove cygdrive from non-cygwin Windows
2701 paths. Improved the determination as to
2702 whether or not to do so.
2703 Jan 13, 2009 * included contains=@NoSpell in every syntax
2704 group for syntax/netrw.vim .
2705 v134: Sep 30, 2008 * (Sander Marechal) provided a bugfix involving
2706 the use of the |netrw-t| command with a remote
2707 directory.
2708 Sep 30, 2008 * using "x" on a remote jpg was failing; fixed.
2709 Oct 03, 2008 * bookmarks now go on a list and are stored to
2710 the first directory on the |'runtimepath'| in
2711 the hopes of making their retention reliable.
2712 History now also goes to that directory.
2713 Oct 07, 2008 * Included check that vim 7.0 or later is in use.
2714 Oct 07, 2008 * Improved |g:netrw_retmap| handling.
2715 Oct 12, 2008 * Based upon Sébastien Migniot's suggestion, if
2716 cadaver isn't available then netrw will try to
2717 use curl for the dav://... protocol.
2718 Oct 13, 2008 * added @*/ to netrw buffers' |'iskeyword'|setting
2719 This lets mf (|netrw-mf|) mark directories, links
2720 and executables.
2721 Oct 13, 2008 * avoids a second NetrwBrowse() refresh when
2722 g:netrw_fastbrowse is <= 1 (slow, medium speed)
2723 Oct 22, 2008 * |g:netrw_http_xcmd| may now be overridden
2724 independently of |g:netrw_http_cmd|.
2725 Oct 23, 2008 * [N] added to the various Explore commands to
2726 let users specify the width/height of new
2727 explorer windows, overriding |g:netrw_winsize|.
2728 v133: Aug 10, 2008 * NetReadFixup() for win95 was missing some "a:"s
2729 Aug 12, 2008 * (Jan Minář) an error condition in NetrwMethod()
2730 wasn't being used, resulting in "b:netrw_fname
2731 undefined" errors
2732 Aug 12, 2008 * (François Ingeirest) asked that "hi link" be
2733 changed to hi default link in the netrw syntax
2734 files.
2735 Aug 12, 2008 * using s:NetrwUnmarkList() more often. Filenames
2736 were being left on the global list when removed
2737 from the buffer-local lists.
2738 Aug 14, 2008 * (Joshua Clayton) an errant extra ")" was left in
2739 the rcp-handling portion of NetRead().
2740 Sep 03, 2008 * added |'cursorline'| highlighting to thin, long,
2741 and tree displays.
Bram Moolenaared39e1d2008-08-09 17:55:22 +00002742 v132: Aug 06, 2008 * Fixed marked file-based obtain
2743 Aug 08, 2008 * sourcing a file via ftp from a netrw-generated
2744 buffer (or any buffer with |'nobl'|) left an
2745 empty no-name buffer in its wake. Fixed.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002746 v130: Jul 31, 2008 * trying out elinks/links for http://host/
2747 requests. One problem: in-page links
2748 (such as with ...#LABEL) are not supported
2749 * verified that Bram's modified netrwPlugin works
2750 Aug 01, 2008 * fixed a bug: when sourcing a file via ftp, the
2751 "filter window" was left behind.
2752 v129: Jul 31, 2008 * bug found in non-mouse enabled vim and some
2753 local maps
2754 v128: Jul 30, 2008 * much work done in using shellescape() and
2755 fnameescape()
Bram Moolenaarc236c162008-07-13 17:41:49 +00002756 v126: Jun 30, 2008 * after having gone to a remote directory,
2757 <f1> was no longer taking one to the correct
2758 entry in the help (|netrw-quickhelp|). Fixed.
2759 Jul 01, 2008 * extracting the last filename from a wide listing
2760 missed the last letter when |'virtualedit'| not
2761 enabled.
2762 Jul 01, 2008 * vim foo/bar was creating [Scratch] buffers,
2763 where bar was also a directory
2764 Jul 01, 2008 * numerous additional changes were made to netrw
2765 to use fnameescape() and shellescape() instead
2766 of escape(). Not all changes have been tested
2767 as yet...
2768 Jul 01, 2008 * (James Vega reported) some problems with
2769 :NetrwSettings (due to no longer used setting
2770 variables).
2771 Jul 07, 2008 * Additional numerous changes to support security;
2772 shellescape(arg,1), etc.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002773 v125: Apr 07, 2008 * (Cristian Rigamonti) CR provides a patch; he
2774 noted that gx was failing since its call to
2775 netrw#NetBrowseX() wasn't updated to
2776 netrw#NetrwBrowseX().
2777 * (Stanis Trendelenburg) ST provides a patch to
2778 supports davs: (dav + ssl)
2779 * (Rick Choi) noted that directory names comprised
2780 of three digits were not being displayed by
2781 the internal browser. Fixed.
2782 * (Erik Falor) provided a patch to handle problems
2783 with changing directory and |'acd'| option.
2784 * (James Vega, Teemu Likonen) noted that netrw
2785 wasn't handling multi-byte filenames/directories
2786 correctly. Fixed.
2787 * (Rick) found problem with g:netrw_maxfilenamelen
2788 being overridden.
2789 * (James Vega) pointed out that netrw was
2790 misidentifying all files in a symbolically linked
2791 directory as being symbolically linked
2792 themselves. This particular problem was fixed;
2793 however, there are now situations where
2794 symbolically linked files will not be detected.
2795 Really need an internal vim function to do this
2796 identification.
2797 Apr 17, 2008 * When g:netrw_keepdir==0, current directory
2798 doesn't necessarily equal b:netrw_curdir
2799 initially. Problem is due to the patch directly
2800 above.
2801 * Fixed qf to handle case where b:netrw_curdir
2802 isn't the same as the current directory under
2803 linux/macosx.
2804 * New: |netrw-mg| (apply vimgrep to marked files)
2805 May 05, 2008 * (Rick) pointed out that a "setlocal ts=32" was
2806 interfering with g:netrw_maxfilenamelen
2807 May 05, 2008 * (James Vega) a file inside a linked directory
2808 was showing up as a symbolic link itself.
2809 May 22, 2008 * symbolic links, fifos, and sockets are now
2810 indicated by a trailing @, |, or =, respectively.
2811 Jun 06, 2008 * Removed numerous bugs from the marked file
2812 move and copy. Tested these changes under
2813 Unix only thus far.
2814 * :Rexplore returns to the screen position in the
2815 netrw listing from whence the file was edited
2816 v124: Apr 02, 2008 * (Adrian Rollett) change the line supporting the
2817 "x" action for mac to use g:netrw_shq
2818 v123: Feb 27, 2008 * Marked files now keeps a "global" marked file
2819 list. The global marked file list is used to
2820 support tag processing and vimdiff'ing
2821 (|netrw-md| |netrw-mt|)
2822 * Been insuring that mm and mc works with various
2823 combinations of local and remote directories
2824 * (Stefan Bittner) http://.../ should always have
2825 filetype "html" -- fixed.
2826 * (Stefan Bittner) a "?" in a http://.../ request
2827 wasn't being handled correctly. Fixed by
2828 removing ? from default |g:netrw_tmpfile_escape|.
2829 * (Nico Weber) % codes in http://.../ requests
2830 weren't being handled correctly. Fixed by
2831 including % in default |g:netrw_fname_escape|.
2832 * (Stefan Bittner) attempts to update Buffers.Refresh
2833 were failing because locale use changed the menu
2834 names. I implemented a workaround.
2835 v122: Feb 12, 2008 * bugfix - first sorting sequence match now has
2836 priority
2837 Feb 14, 2008 * bugfix - sorting sequence was effectively ignoring
2838 sequencing priority of anything following '*'
2839 * toggling a marked file was showing incorrect list
2840 (list was correct, but displayed matches weren't)
2841 * |g:netrw_special_syntax| implemented
2842 v121: Feb 11, 2008 * Bram M reported that :e file ... :e . would not
2843 retain the alternate file. Fixed -- I hope!
2844 * bugfix -- apparently v120 broke an explicit
2845 :Explore dirname
2846 v120: Jan 21, 2008 * |netrw-mt| changed to allow for target selection
2847 based on whether or not word under cursor is a
2848 directory or file, or if cursor is in banner
2849 area.
2850 * |netrw-mh| included (hiding by marked-file suffix)
2851 * functions moved about a bit (improved
2852 categorization)
2853 * executable files now displayed with trailing (*)
2854 * symbolically linked files now displayed with
2855 trailing (@)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002856 * Somewhen, s:NetrwMarkFileMove() got damaged. It
2857 * is now restored (missing an endif, for example).
Bram Moolenaar446cb832008-06-24 21:56:24 +00002858 * |netrw-mu| implemented (unmarking marked files)
2859 * many bugs have been removed from the marked file
2860 system (tnx to Mark S. for feedback)
2861 * |netrw-ms| implemented (sourcing marked files)
2862 * fixed use of P with tree listing style
2863 * multiple tree listing now supported
2864 * ./ suppressed
2865 * changed q -> qb (query bookmarks)
2866 * implemented |netrw-qf|
2867 * Explore now has four special list-generation
2868 modes: */filepat **/filepat
2869 *//pattern **//pattern
2870 * gh (|netrw-gh|) is a shortcut for toggling the
2871 hiding of files and directories beginning with a
2872 dot
2873 v119: Jan 10, 2008 * When g:netrw_keepdir is false,
2874 NetrwOptionsRestore() had a problem
2875 (Bill McCarthy)
2876 Jan 11, 2008 * Netrw now shows symbolic links with a trailing
2877 "@" and special highlighting.
2878 Jan 15, 2008 * Changed g:netrw_noretmap -> |g:netrw_retmap|.
2879 Changed: disabled by default at Bram's
2880 preference.
2881 v118: Jan 02, 2008 * Fixed a problem with Windows;
2882 :Explore c:/path/ would not work,
2883 but :Explore c:/path would.
2884 * Fixed a bug in s:NetrwOptionRestore() - lcd's
2885 argument wasn't being properly escaped so it
2886 wouldn't handle spaces in directory names.
2887 (Gary Johnson)
2888 v117: Jan 02, 2008 * Fixed a problem with P; had to include
2889 a b:netrw_curdir bypass (Bram Moolenaar)
2890 v116: Nov 27, 2007 * netrw#LocalBrowseCheck() has &ft=="netrw"
2891 check to prevent doing a directory listing
2892 (was getting unexpected directory refreshes
2893 in the middle of some function calls)
2894 * NetrwOptionRestore moved after e! filename
2895 in order to retain user options for editing
2896 in s:NetrwBrowseChgDir()
2897 Dec 12, 2007 * Bug fix -- netrw does a better job of retaining
2898 user options when editing files under the aegis
2899 of the browser
2900 v115: Oct 04, 2007 * Erik Remmelzwaal pointed out that the use of
2901 shellslash in s:GetTempfile() was incorrect
2902 Oct 11, 2007 * Tracked down and eliminated a bug with editing
2903 remote *.tar.gz and *.tar.bz2 files
2904 Oct 11, 2007 * g:netrw_localmovecmd wasn't being initialized
2905 properly, and g:netrw_localcopycmd was being
2906 overwritten.
2907 Oct 12, 2007 * Placed all :Rexplore and <2-leftmouse> setup
2908 in a new support function (s:SetRexDir()).
2909 Oct 15, 2007 * new: g:netrw_browse_split == 4; means <cr>
2910 based selection will use previous window
2911 Oct 20, 2007 * also checks on |'shellxquote'| to set g:netrw_shq
2912 Oct 24, 2007 * Explore handles path/**/filename
2913 Oct 27, 2007 * sourcing remote files often didn't work with ftp,
2914 turns out that b:netrw_method was undefined, so
2915 s:SaveBufVars and s:RestoreBufVars() fixed it.
2916 v114: Sep 28, 2007 * mT, the map that invokes tags, has been improved
2917 to support use of remote tags files.
2918 Oct 02, 2007 * changed Netrw menu to use more submenus
2919 v113: Sep 07, 2007 * worked out why the cursor position wasn't being
2920 saved and restored as intended after doing such
2921 things as deleting and renaming files.
2922 Sep 11, 2007 * Fixed bug which effectively disabled <c-l> and
2923 <c-h> maps
2924 Sep 18, 2007 * there used to be one NetrwOptionRestore() call at
2925 the end of the s:NetrwBrowseChgDir() function;
2926 they're now at the end of every if..elseif..else
2927 block. The edit-a-file one is not quite at the end
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002928 of its block; instead, it's just before the edit.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002929 Restores user options, then this new placement
2930 allows ftplugins, autocmds, etc to change settings
2931 (ex. ftplugin/cpp.vim sets cindent).
2932 Sep 19, 2007 * changed all strlen() calls to use s:Strlen(), a
2933 function which handles utf-8 wide characters
2934 correctly.
2935 Sep 20, 2007 * (Nico Weber) the "x" command has been extended
2936 to Mac's OS/X (macunix); it now uses open to
2937 handle |netrw-x| browsing with special files.
2938 Sep 22, 2007 * Added g:netrw_noretmap to netrw at Tony M's
2939 request.
2940 * Included path to NetrwRemoteRmFile()
2941 v112: Aug 18, 2007 * added mx (|netrw-mx|) for executing arbitrary
2942 commands on marked files
2943 Aug 22, 2007 * more option save/restore work for
2944 s:NetrwBrowseChgDir(); s:NetrwOptionSave()
2945 and s:NetrwOptionRestore() now take a parameter
2946 specifying the type of variables to be used for
2947 saving and restoring (either "w:" or "s:")
2948 Sep 04, 2007 * added the :NetrwClean[!] command
2949 v111: Jul 25, 2007 * using Windows but not using Cygwin, netrw does a
2950 "file bufname" where the bufname uses /s
2951 instead of \s; Vim "fixes" it by changing the
2952 bufname to use \s anyway. This meant that
2953 NetrwGetBuffer() didn't find the appropriately
2954 named buffer, and so would generate a new
2955 buffer listing; hence the cursor would appear
2956 to have been moved when doing a preview.
2957 * added <2-leftmouse> map to return to netrw's
2958 browser display
2959 Aug 16, 2007 * added the mark-file system, including
2960 maps for mf mp mt mz and mu. Modifications
2961 made to maps for a D O and R to support
2962 marked files.
2963 v110: May 10, 2007 * added [ and ] maps to NetrwTreeListing
2964 May 25, 2007 * |g:netrw_preview| included
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002965 May 29, 2007 * modified netrw#NetBrowseX to consistently use
Bram Moolenaarc236c162008-07-13 17:41:49 +00002966 g:netrw_shq instead of hardcoded quotes,
Bram Moolenaar446cb832008-06-24 21:56:24 +00002967 and modified the snippet that sets up redir
2968 so Windows machines use "nul" instead of
2969 "/dev/null".
2970 Jun 01, 2007 * fixed bug -- NetGetBuffer() wasn't always
2971 recognizing a buffer name match when it should,
2972 thus resulting in [Scratch] buffers.
2973 Jun 04, 2007 * Gary Johnson found a bugfix for the "c" mapping
2974 when the directory is to be made current but
2975 the name contains spaces.
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00002976 v109: Mar 26, 2007 * if a directory name includes a "$" character,
2977 Explore() will use expand() in an attempt to
2978 decipher the name.
2979 May 07, 2007 * g:netrw_use_errorwindow now allows one to
Bram Moolenaar446cb832008-06-24 21:56:24 +00002980 have error messages go to a reliable window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002981 or to use a less reliable but recallable
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00002982 echoerr method
2983 May 07, 2007 * g:netrw_scpport and g:netrw_sshport support
Bram Moolenaar446cb832008-06-24 21:56:24 +00002984 use of -P and -p, respectively, to set port
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00002985 for scp/ssh.
Bram Moolenaar9964e462007-05-05 17:54:07 +00002986 v108: Jan 03, 2007 * included preview map (|netrw-p|), supporting
2987 remote browsing
2988 * netrw can now source remote files
2989 Jan 26, 2007 * Colton Jamieson noted that remote directory
2990 browsing did not support alternate port
2991 selection. This feature has now been extended
2992 to apply to all remote browsing commands via ssh.
2993 (list, remove/delete, rename)
2994 Jan 31, 2007 * Luis Florit reported that @* was an invalid
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00002995 register. The @* register is now only saved and
2996 restored if |'guioptions'| contains "a".
Bram Moolenaar9964e462007-05-05 17:54:07 +00002997 Feb 02, 2007 * Fixed a bug that cropped up when writing files
2998 via scp using cygwin
2999 Feb 08, 2007 * tree listing mode managed to stop working again;
3000 fixed again!
3001 Feb 15, 2007 * Guido Van Hoecke reported that netrw didn't
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003002 handle browsing well with M$ ftp servers. He even
Bram Moolenaar9964e462007-05-05 17:54:07 +00003003 set up a temporary account for me to test with
3004 (thanks!). Netrw now can browse M$ ftp servers.
3005 v107: Oct 12, 2006 * bypassed the autowrite option
3006 Oct 24, 2006 * handles automatic decompression of *.gz and *.bz2
3007 files
3008 Nov 03, 2006 * Explore will highlight matching files when
3009 **/pattern is used (and if the |'hls'| option
3010 is set)
3011 Nov 09, 2006 * a debugging line, when enabled, was inadvertently
3012 bringing up help instead of simply reporting on
3013 list contents
3014 Nov 21, 2006 * tree listing improved (cursor remains put)
3015 Nov 27, 2006 * fixed b:netrw_curdir bug when repeated "i"s were
3016 pressed.
3017 Dec 15, 2006 * considerable qty of changes, mostly to share more
3018 code between local and remote browsing. Includes
3019 support for tree-style listing for both remote
3020 and local browsing.
3021 Dec 15, 2006 * Included Peter Bengtsson's modifications to
3022 support the Amiga.
3023 v106: Sep 21, 2006 * removed old v:version<700 code as netrw now
3024 requires vim 7.0
3025 * worked around a bug where register * was
3026 overwritten during local browsing
3027 v104: Sep 05, 2006 * as suggested by Rodolfo Borges, :Explore and
3028 variants will position the cursor on the file
3029 just having been edited
3030 * changed default |g:netrw_sort_sequence| order
3031 * changed b, Nb to simply mb (see |netrw-mb|)
3032 * changed B, NB to simply gb (see |netrw-gb|)
3033 * tree listing style (see |g:netrw_liststyle|)
3034 * attempts to retain the alternate file
3035 v103: Jul 26, 2006 * used Yakov Lerner's tip#1289 to improve netrw
3036 error message display
3037 * wide listings didn't handle files with backslashes
3038 in their names properly. A symptom was an
3039 inability to open files.
3040 Aug 09, 2006 * included "t" mapping for opening tabbed windows,
3041 both for remote and local browsing
3042 * changed netrw_longlist to netrw_liststyle
3043 Aug 15, 2006 * fixed one of the NB maps
3044 Aug 22, 2006 * changed *Explore commands to use -nargs=* instead
3045 of -nargs=?. Allows both -complete=dir _and_ the
3046 starstar arguments to work (-nargs=? seems to
3047 require one or the other).
3048 Aug 23, 2006 * copied all w:.. variables across splits to
3049 new windows
3050 Aug 25, 2006 * when g:netrw_browsex_viewer was '-'
3051 (see |g:netrw_browsex_viewer|) it wasn't causing
3052 netrwFileHandlers#Invoke() to be called as it
3053 was expected to. (tnx Steve Dugaro)
3054 Aug 29, 2006 * changed NetBrowseX() to use "setlocal ... noswf"
3055 instead of "set ... noswf" (tnx Benji Fisher)
3056 Aug 31, 2006 * tabs and fastbrowse<=1 didn't work together.
3057 v102: Jun 15, 2006 * chgd netrwPlugin to call netrw#LocalBrowseCheck()
3058 * bugfix: g:netrw_keepdir==0 had stopped working
3059 Jul 06, 2006 * bugfix: NetOptionSave/Restore now saves/restores
3060 the unnamed register (|registers|)
3061 Jul 07, 2006 * |g:netrw_menu| support included
3062 Jul 13, 2006 * :Texplore command implemented
3063 Jul 17, 2006 * NetSplit and (Local|Net)BrowseChgDir() were both
3064 splitting windows. This affected o, v, and
3065 g:netrw_browse_split.
3066 Jul 20, 2006 * works around wildignore setting (was causing
3067 netrw's local browser not to list wildignore'd
3068 files)
3069 Jul 24, 2006 * <leftmouse> acts as a <cr> for selecting a file
3070 <rightmouse> acts as a <del> for deleting a file
3071 v100: May 14, 2006 * when using Windows and shell==cmd.exe, the
3072 default for g:netrw_ignorenetrc is now 1
3073 * bugfix: unwanted ^Ms now removed
3074 (affected shell==cmd.exe - Windows)
3075 * added Bookmarks and History to the menu
3076 * an error message about non-existing
3077 w:netrw_longlist was appearing during attempts to
3078 Explore (fixed)
3079 * g:netrw_shq now available to make netrw use
3080 specified style of quotes for commands
3081 May 29, 2006 * user NFH_*() functions were inadvertently being
3082 ignored
3083 * fixed a Windows non-cygwin ftp handling problem.
3084 * hiding pattern candidate separators included some
3085 characters it shouldn't have (tnx to Osei Poku)
3086 Jun 01, 2006 * for browsing, netrw was supposed to use "dir"
3087 instead of "ls -lF" when using
3088 ftp+non-cygwin+windows. Fixed.
3089 * an inadvertently left-in-place debugging statement
3090 was preventing use of the "x" key with browsing.
3091 Jun 05, 2006 * g:netrw_nogx available to prevent making the gx
3092 map (see |g:netrw_nogx|)
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003093 * bugfix, Explore wouldn't change directory
Bram Moolenaar9964e462007-05-05 17:54:07 +00003094 properly (vim ., :Explore subdirname)
3095 Jun 06, 2006 * moved history to 2nd line in Netrw menu
3096 * fixed delete for unix-based systems
3097 Jun 07, 2006 * x key now works for windows-noncygwin-ftp
3098 Jun 08, 2006 * Explore */pat and **//pat now wraps
3099 v99: May 09, 2006 * g:netrw_browse_split=3 for opening files in new
3100 tabs implemented.
3101 May 12, 2006 * deletes temporary file at end of NetRead()
3102 * visual mode based Obtain implemented
3103 * added -complete=dir to the various Explore
3104 commands
3105 v98: May 02, 2006 * the "p" key didn't work properly when the browsing
3106 directory name had spaces in it.
3107 v97: May 01, 2006 * exists("&acd") now used to determine if
3108 the 'acd' option exists
3109 * "obtain" now works again under Windows
Bram Moolenaar446cb832008-06-24 21:56:24 +00003110 v96: * bugfix - the |'acd'| option is not always defined
3111 but is now bypassed only when it is
3112 v95: * bugfix - Hiding mode worked correctly (don't show
3113 any file matching any of the g:netrw_hide
3114 patterns), but showing mode was showing only those
3115 files that didn't match any of the g:netrw_hide
3116 patterns. Instead, it now shows all files that
3117 match any of the g:netrw_hide patterns (the
3118 difference between a logical and and logical or).
3119 v94: * bugfix - a Decho() had a missing quote; only
3120 affects things when debugging was enabled.
3121 v93: * bugfix - removed FocusGained event from causing a
3122 slow-browser refresh for Windows
3123 v92: * :Explore **//pattern implemented
3124 (**/filepattern was already taken)
3125 v91: * :Explore */pattern implemented
3126 * |'acd'| option bypassed
3127 v90: * mark ', as suggested by Yegappan Lakshmanan, used
3128 to help guarantee entry into the jump list when
3129 appropriate.
3130 * <s-down> and <s-up> are no longer defined until a
3131 :Explore **/pattern is used (if the user already
3132 has a map for them). They will be defined for new
3133 browser windows from that point forward.
3134 v89: * A <s-down>, <s-up>, :Nexplore, or a :Pexplore
3135 without having first done an :Explore **/pattern
3136 (see |netrw-starstar|) caused
3137 a lot of unhelpful error messages to appear
3138 v88: * moved DrChip.Netrw menu to Netrw. Now has
3139 priority 80 by default.
3140 g:NetrwTopLvlMenu == "Netrw" and can be changed
3141 by the user to suit. The priority is given by
3142 g:NetrwMenuPriority.
3143 * Changed filetype for browser displays from
3144 netrwlist to netrw.
3145 v87: * bug fix -- menus were partially disappearing
3146 v85: * bug fix -- missing an endif
3147 * bug fix -- handles spaces in names and directories
3148 when using ftp-based browsing
3149 v83: * disabled stop-acd handling; the change in directory
3150 handling may allow acd to be used again.
3151 * D was refusing to delete remote files/directories
3152 in wide listing mode.
3153 v81: * FocusGained also used to refresh/wipe local browser
3154 directory buffers
3155 * (bugfix) netrw was leaving [Scratch] buffers behind
3156 when the user had the "hidden" option set. The
3157 'hidden' option is now bypassed.
3158 v80: * ShellCmdPost event used in conjunction with
3159 g:netrw_fastbrowse to refresh/wipe local browser
3160 directory buffers.
3161 v79: * directories are now displayed with nowrap
3162 * (bugfix) if the column width was smaller than the
3163 largest file's name, then netrw would hang when
3164 using wide-listing mode - fixed
3165 * g:netrw_fastbrowse introduced
3166 v78: * progress has been made on allowing spaces inside
3167 directory names for remote work (reading, writing,
3168 browsing). (scp)
3169 v77: * Mikolaj Machowski fixed a bug in a substitute cmd
3170 * g:netrw_browsex_viewer implemented
3171 * Mikolaj Machowski pointed out that gnome-open is
3172 often executable under KDE systems, although it is
3173 effectively not functional. NetBrowseX now looks
3174 for "kicker" as a running process to determine if
3175 KDE is actually running.
3176 * Explorer's O functionality was inadvertently left
3177 out. Netrw now does the same thing, but with the
3178 "P" key.
3179 * added g:netrw_browse_split option
3180 * fixed a bug where the directory contained a "." but
3181 the file didn't (was treating the dirname from "."
3182 onwards as a suffix)
3183 v76: * "directory is missing" error message now restores
3184 echo highlighting
3185 v75: * file://... now conforms to RFC2396 (thanks to
3186 S. Zacchiroli)
3187 * if the binary option is set, then NetWrite() will
3188 only write the whole file (line numbers don't make
3189 sense with this). Supports writing of tar and zip
3190 files.
3191 v74: * bugfix (vim, then :Explore) now works
3192 * ctrl-L keeps cursor at same screen location (both
3193 local and remote browsing)
3194 * netrw now can read remote zip and tar files
3195 * Obtain now uses WinXP ftp+.netrc successfully
3196 v73: * bugfix -- scp://host/path/file was getting named
3197 incorrectly
3198 * netrw detects use of earlier-than-7.0 version of
3199 vim and issues a pertinent error message.
3200 * netrwSettings.vim is now uses autoloading. Only
3201 <netrwPlugin.vim> is needed as a pure plugin
3202 (ie. always loaded).
3203 v72: * bugfix -- formerly, one could prevent the loading
3204 of netrw by "let g:loaded_netrw=1"; when
3205 autoloading became supported, this feature was
3206 lost. It is now restored.
3207 v71: * bugfix -- made some "set nomodifiable"s into
3208 setlocal variants (allows :e somenewfile to be
3209 modifiable as usual)
3210 * NetrwSettings calls a netrw function, thereby
3211 assuring that netrw has loaded. However, if netrw
3212 does not load for whatever reason, then
3213 NetrwSettings will now issue a warning message.
3214 * For what reason I don't recall, when wget and fetch
3215 are both not present, and an attempt to read a
3216 http://... url is made, netrw exited. It now only
3217 returns.
3218 * When ch=1, on the second and subsequent uses of
3219 browsing Netrw would issue a blank line to clear
3220 the echo'd messages. This caused an annoying
3221 "Hit-Enter" prompt; now a blank line message
3222 is echo'd only if &ch>1.
3223 v70: * when using |netrw-O|, the "Obtaining filename"
3224 message is now shown using |hl-User9|. If User9
3225 has not been defined, netrw itself will define it.
3226 v69: * Bugfix: win95/98 machines were experiencing a
3227 "E121: Undefined variable: g:netrw_win95ftp"
3228 message
3229 v68: * double-click-leftmouse selects word under mouse
3230 v67: * Passwords which contain blanks will now be
3231 surrounded by double-quotes automatically (Yongwei)
3232 v66: * Netrw now seems to work with a few more Windows
3233 situations
3234 * O now obtains a file: remote browsing
3235 file -> local copy, locally browsing
3236 file -> current directory (see :pwd)
3237 * i now cycles between thin, long, and wide listing
3238 styles
3239 * NB and Nb are maps that are always available;
3240 corresponding B and b maps are only available when
3241 not using wide listing in order to allow them to
3242 be used for motions
3243 v65: * Browser functions now use NetOptionSave/Restore; in
3244 particular, netrw now works around the report
3245 setting
3246 v64: * Bugfix - browsing a "/" directory (Unix) yielded
3247 buffers named "[Scratch]" instead of "/"
3248 * Bugfix - remote browsing with ftp was omitting
3249 the ./ and ../
3250 v63: * netrw now takes advantage of autoload (needs 7.0)
3251 * Bugfix - using r (to reverse sort) working again
3252 v62: * Bugfix - spaces allowed again in directory names
3253 with g:netrw_keepdir=0. In fact, I've tested netrw
3254 with most ANSI punctuation marks for directory
3255 names.
3256 * Bugfix - NetrwSettings gave errors when
3257 g:netrw_silent had not be set.
3258 v61: * Document upgrade -- netrw variable-based settings
3259 all should have tags. Supports NetrwSettings cmd.
3260 * Several important variables are window-oriented.
3261 Netrw has to transfer these across a window split.
3262 See s:BufWinVars() and s:UseBufWinVars().
3263 v60: * When using the i map to switch between long and
3264 short listings, netrw will now keep cursor on same
3265 line
3266 * "Match # of #" now uses status line
3267 * :Explore **/*.c will now work from a
3268 non-netrw-browser window
3269 * :Explore **/patterns can now be run in separate
3270 browser windows
3271 * active banner (hit <cr> will cause various things
3272 to happen)
3273 v59: * bugfix -- another keepalt work-around installed
3274 (for vim6.3)
3275 * "Match # of #" for Explore **/pattern matches
3276 v58: * Explore and relatives can now handle
3277 **/somefilepattern (v7)
3278 * Nexplore and Pexplore introduced (v7). shift-down
3279 and shift-up cursor keys will invoke Nexplore and
3280 Pexplore, respectively.
3281 * bug fixed with o and v
3282 * autochdir only worked around for vim when it has
3283 been compiled with either
3284 |+netbeans_intg| or |+sun_workshop|
3285 * Under Windows, all directories and files were
3286 being preceded with a "/" when local browsing.
3287 Fixed.
3288 * When: syntax highlighting is off, laststatus=2, and
3289 remote browsing is used, sometimes the laststatus
3290 highlighting bleeds into the entire display. Work
3291 around - do an extra redraw in that case.
3292 * Bugfix: when g:netrw_keepdir=0, due to re-use of
3293 buffers, netrw didn't change the directory when it
3294 should've
3295 * Bugfix: D and R commands work again
3296 v57: * Explore and relatives can now handle RO files
3297 * reverse sort restored with vim7's sort command
3298 * g:netrw_keepdir now being used to keep the current
3299 directory unchanged as intended (sense change)
3300 * vim 6.3 still supported
3301 v56: * LocalBrowse now saves autochdir setting, unsets it,
3302 and restores it before returning.
3303 * using vim's rename() instead of system +
3304 local_rename variable
3305 * avoids changing directory when g:netrw_keepdir is
3306 false
3307 v55: * -bar used with :Explore :Sexplore etc to allow
3308 multiple commands to be separated by |s
3309 * browser listings now use the "nowrap" option
3310 * browser: some unuseful error messages now
3311 suppressed
3312 v54: * For backwards compatibility, Explore and Sexplore
3313 have been implemented. In addition, Hexplore and
3314 Vexplore commands are available, too.
3315 * <amatch> used instead of <afile> in the
3316 transparency support (BufReadCmd, FileReadCmd,
3317 FileWriteCmd)
3318 * ***netrw*** prepended to various error messages
3319 netrw may emit
3320 * g:netrw_port used instead of b:netrw_port for scp
3321 * any leading [:#] is removed from port numbers
3322 v53: * backslashes as well as slashes placed in various
3323 patterns (ex. g:netrw_sort_sequence) to better
3324 support Windows
3325 v52: * nonumber'ing now set for browsing buffers
3326 * when the hiding list hid all files, error messages
3327 ensued. Fixed
3328 * when browsing, swf is set, but directory is not
3329 set, when netrw was attempting to restore options,
3330 vim wanted to save a swapfile to a local directory
3331 using an url-style path. Fixed
3332 v51: * cygwin detection now automated
3333 (using windows and &shell is bash)
3334 * customizable browser "file" rejection patterns
3335 * directory history
3336 * :[range]w url now supported (ie. netrw uses a
3337 FileWriteCmd event)
3338 * error messages have a "Press <cr> to continue" to
3339 allow them to be seen
3340 * directory browser displays no longer bother the
3341 swapfile
3342 * u/U commands to go up and down the history stack
3343 * history stack may be saved with viminfo with it's
3344 "!" option
3345 * bugfixes associated with unwanted [No Files]
3346 entries
3347 v50: * directories now displayed using buftype=nofile;
3348 should keep the directory names as-is
3349 * attempts to remove empty "[No File]" buffers
3350 leftover from :file ..name.. commands
3351 * bugfix: a "caps-lock" editing difficulty left in
3352 v49 was fixed
3353 * syntax highlighting for "Showing:" the hiding list
3354 included
3355 * bookmarks can now be retained if "!" is in the
3356 viminfo option
3357 v49: * will use ftp for http://.../ browsing
3358 v48: * One may use ftp to do remote host file browsing
3359 * (windows and !cygwin) remote browsing with ftp can
3360 now use the "dir" command internally to provide
3361 listings
3362 * g:netrw_keepdir now allows one to keep the initial
3363 current directory as the current directory
3364 (normally the local file browser makes the
3365 currently viewed directory the current directory)
3366 * g:netrw_alto and g:netrw_altv now support
3367 alternate placement of windows started with o or v
3368 * Nread ? and Nwrite ? now uses echomsg (instead of
3369 echo) so :messages can repeat showing the help
3370 * bugfix: avoids problems with partial matches of
3371 directory names to prior buffers with longer names
3372 * one can suppress error messages with g:netrw_quiet
3373 ctrl-h used
3374 * instead of <Leader>h for editing hiding list one
3375 may edit the sorting sequence with the S map, which
3376 now allows confirmation of deletion with
3377 [y(es) n(o) a(ll) q(uit)]
3378 * the "x" map now handles special file viewing with:
3379 (windows) rundll32 url.dll (gnome) gnome-open (kde)
3380 kfmclient If none of these are on the executable
3381 path, then netrwFileHandlers.vim is used.
3382 * directory bookmarking during both local and remote
3383 browsing implemented
3384 * one may view all, use the hiding list to suppress,
3385 or use the hiding list to show-only remote and
3386 local file/directory listings
3387 * improved unusual file and directory name handling
3388 preview window support
3389 v47: * now handles local browsing.
3390 v46: * now handles remote browsing
3391 * g:netrw_silent (if 1) will cause all transfers to
3392 be silent
3393 v45: * made the [user@]hostname:path form a bit more
3394 restrictive to better handle errors in using
3395 protocols (e.g. scp:usr@host:file was being
3396 recognized as an rcp request)
3397 v44: * changed from "rsync -a" to just "rsync"
3398 * somehow an editing error messed up the test to
3399 recognize use of the fetch method for NetRead.
3400 * more debugging statements included
3401 v43: * moved "Explanation" comments to <pi_netrw.txt> help
3402 file as "Network Reference" (|netrw-ref|)
3403 * <netrw.vim> now uses Dfunc() Decho() and Dret() for
3404 debugging
3405 * removed superfluous NetRestorePosn() calls
3406 v42: * now does BufReadPre and BufReadPost events on
3407 file:///* and file://localhost/*
3408 v41: * installed file:///* and file://localhost/* handling
3409 v40: * prevents redraw when a protocol error occurs so
3410 that the user may see it
3411 v39: * sftp support
3412 v38: * Now uses NetRestorePosn() calls with Nread/Nwrite
3413 commands
3414 * Temporary files now removed via bwipe! instead of
3415 bwipe (thanks to Dave Roberts)
3416 v37: * Claar's modifications which test if ftp is
3417 successful, otherwise give an error message
3418 * After a read, the alternate file was pointing to
3419 the temp file. The temp file buffer is now wiped
3420 out.
3421 * removed silent from transfer methods so user can
3422 see what's happening
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423
3424
3425==============================================================================
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100342613. Todo *netrw-todo* {{{1
3427
342807/29/09 : banner :|g:netrw_banner| can be used to suppress the
3429 suppression banner. This feature is new and experimental,
3430 so its in the process of being debugged.
343109/04/09 : "gp" : See if it can be made to work for remote systems.
3432 : See if it can be made to work with marked files.
3433
3434==============================================================================
343514. Credits *netrw-credits* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436
3437 Vim editor by Bram Moolenaar (Thanks, Bram!)
3438 dav support by C Campbell
3439 fetch support by Bram Moolenaar and C Campbell
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003440 ftp support by C Campbell <NdrOchip@ScampbellPfamily.AbizM>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 http support by Bram Moolenaar <bram@moolenaar.net>
3442 rcp
3443 rsync support by C Campbell (suggested by Erik Warendorph)
3444 scp support by raf <raf@comdyn.com.au>
3445 sftp support by C Campbell
3446
3447 inputsecret(), BufReadCmd, BufWriteCmd contributed by C Campbell
3448
3449 Jérôme Augé -- also using new buffer method with ftp+.netrc
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003450 Bram Moolenaar -- obviously vim itself, :e and v:cmdarg use,
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003451 fetch,...
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 Yasuhiro Matsumoto -- pointing out undo+0r problem and a solution
3453 Erik Warendorph -- for several suggestions (g:netrw_..._cmd
3454 variables, rsync etc)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003455 Doug Claar -- modifications to test for success with ftp
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00003456 operation
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457
3458==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00003459Modelines: {{{1
Bram Moolenaar83bab712005-08-01 21:58:57 +00003460 vim:tw=78:ts=8:ft=help:norl:fdm=marker