Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame^] | 1 | *pi_netrw.txt* For Vim version 7.4. Last change: 2016 Apr 20 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 3 | ------------------------------------------------ |
| 4 | NETRW REFERENCE MANUAL by Charles E. Campbell |
| 5 | ------------------------------------------------ |
| 6 | Author: Charles E. Campbell <NdrOchip@ScampbellPfamily.AbizM> |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 7 | (remove NOSPAM from Campbell's email first) |
| 8 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 9 | Copyright: Copyright (C) 2016 Charles E Campbell *netrw-copyright* |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 10 | The VIM LICENSE applies to the files in this package, including |
| 11 | netrw.vim, pi_netrw.txt, netrwFileHandlers.vim, netrwSettings.vim, and |
| 12 | syntax/netrw.vim. Like anything else that's free, netrw.vim and its |
| 13 | associated files are provided *as is* and comes with no warranty of |
| 14 | any kind, either expressed or implied. No guarantees of |
| 15 | merchantability. No guarantees of suitability for any purpose. By |
| 16 | using this plugin, you agree that in no event will the copyright |
| 17 | holder be liable for any damages resulting from the use of this |
| 18 | software. Use at your own risk! |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 19 | |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 20 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 21 | *netrw* |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 22 | *dav* *ftp* *netrw-file* *rcp* *scp* |
| 23 | *davs* *http* *netrw.vim* *rsync* *sftp* |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 24 | *fetch* *network* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 25 | |
| 26 | ============================================================================== |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 27 | 1. Contents *netrw-contents* {{{1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 28 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 29 | 1. Contents..............................................|netrw-contents| |
| 30 | 2. Starting With Netrw...................................|netrw-start| |
| 31 | 3. Netrw Reference.......................................|netrw-ref| |
| 32 | EXTERNAL APPLICATIONS AND PROTOCOLS.................|netrw-externapp| |
| 33 | READING.............................................|netrw-read| |
| 34 | WRITING.............................................|netrw-write| |
| 35 | SOURCING............................................|netrw-source| |
| 36 | DIRECTORY LISTING...................................|netrw-dirlist| |
| 37 | CHANGING THE USERID AND PASSWORD....................|netrw-chgup| |
| 38 | VARIABLES AND SETTINGS..............................|netrw-variables| |
| 39 | PATHS...............................................|netrw-path| |
| 40 | 4. Network-Oriented File Transfer........................|netrw-xfer| |
| 41 | NETRC...............................................|netrw-netrc| |
| 42 | PASSWORD............................................|netrw-passwd| |
| 43 | 5. Activation............................................|netrw-activate| |
| 44 | 6. Transparent Remote File Editing.......................|netrw-transparent| |
| 45 | 7. Ex Commands...........................................|netrw-ex| |
| 46 | 8. Variables and Options.................................|netrw-variables| |
| 47 | 9. Browsing..............................................|netrw-browse| |
| 48 | Introduction To Browsing............................|netrw-intro-browse| |
| 49 | Quick Reference: Maps...............................|netrw-browse-maps| |
| 50 | Quick Reference: Commands...........................|netrw-browse-cmds| |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 51 | Banner Display......................................|netrw-I| |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 52 | Bookmarking A Directory.............................|netrw-mb| |
| 53 | Browsing............................................|netrw-cr| |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 54 | Squeezing the Current Tree-Listing Directory........|netrw-s-cr| |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 55 | Browsing With A Horizontally Split Window...........|netrw-o| |
| 56 | Browsing With A New Tab.............................|netrw-t| |
| 57 | Browsing With A Vertically Split Window.............|netrw-v| |
| 58 | Change Listing Style.(thin wide long tree)..........|netrw-i| |
| 59 | Changing To A Bookmarked Directory..................|netrw-gb| |
| 60 | Changing To A Predecessor Directory.................|netrw-u| |
| 61 | Changing To A Successor Directory...................|netrw-U| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 62 | Customizing Browsing With A Special Handler.........|netrw-x| |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 63 | Deleting Bookmarks..................................|netrw-mB| |
| 64 | Deleting Files Or Directories.......................|netrw-D| |
| 65 | Directory Exploring Commands........................|netrw-explore| |
| 66 | Exploring With Stars and Patterns...................|netrw-star| |
| 67 | Displaying Information About File...................|netrw-qf| |
| 68 | Edit File Or Directory Hiding List..................|netrw-ctrl-h| |
| 69 | Editing The Sorting Sequence........................|netrw-S| |
| 70 | Forcing treatment as a file or directory............|netrw-gd| |netrw-gf| |
| 71 | Going Up............................................|netrw--| |
| 72 | Hiding Files Or Directories.........................|netrw-a| |
| 73 | Improving Browsing..................................|netrw-ssh-hack| |
| 74 | Listing Bookmarks And History.......................|netrw-qb| |
| 75 | Making A New Directory..............................|netrw-d| |
| 76 | Making The Browsing Directory The Current Directory.|netrw-c| |
| 77 | Marking Files.......................................|netrw-mf| |
| 78 | Unmarking Files.....................................|netrw-mF| |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 79 | Marking Files By Location List......................|netrw-qL| |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 80 | Marking Files By QuickFix List......................|netrw-qF| |
| 81 | Marking Files By Regular Expression.................|netrw-mr| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 82 | Marked Files: Arbitrary Shell Command...............|netrw-mx| |
| 83 | Marked Files: Arbitrary Shell Command, En Bloc......|netrw-mX| |
| 84 | Marked Files: Arbitrary Vim Command.................|netrw-mv| |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 85 | Marked Files: Argument List.........................|netrw-ma| |netrw-mA| |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 86 | Marked Files: Compression And Decompression.........|netrw-mz| |
| 87 | Marked Files: Copying...............................|netrw-mc| |
| 88 | Marked Files: Diff..................................|netrw-md| |
| 89 | Marked Files: Editing...............................|netrw-me| |
| 90 | Marked Files: Grep..................................|netrw-mg| |
| 91 | Marked Files: Hiding and Unhiding by Suffix.........|netrw-mh| |
| 92 | Marked Files: Moving................................|netrw-mm| |
| 93 | Marked Files: Printing..............................|netrw-mp| |
| 94 | Marked Files: Sourcing..............................|netrw-ms| |
| 95 | Marked Files: Setting the Target Directory..........|netrw-mt| |
| 96 | Marked Files: Tagging...............................|netrw-mT| |
| 97 | Marked Files: Target Directory Using Bookmarks......|netrw-Tb| |
| 98 | Marked Files: Target Directory Using History........|netrw-Th| |
| 99 | Marked Files: Unmarking.............................|netrw-mu| |
| 100 | Netrw Browser Variables.............................|netrw-browser-var| |
| 101 | Netrw Browsing And Option Incompatibilities.........|netrw-incompatible| |
| 102 | Netrw Settings Window...............................|netrw-settings-window| |
| 103 | Obtaining A File....................................|netrw-O| |
| 104 | Preview Window......................................|netrw-p| |
| 105 | Previous Window.....................................|netrw-P| |
| 106 | Refreshing The Listing..............................|netrw-ctrl-l| |
| 107 | Reversing Sorting Order.............................|netrw-r| |
| 108 | Renaming Files Or Directories.......................|netrw-R| |
| 109 | Selecting Sorting Style.............................|netrw-s| |
| 110 | Setting Editing Window..............................|netrw-C| |
| 111 | 10. Problems and Fixes....................................|netrw-problems| |
| 112 | 11. Debugging Netrw Itself................................|netrw-debug| |
| 113 | 12. History...............................................|netrw-history| |
| 114 | 13. Todo..................................................|netrw-todo| |
| 115 | 14. Credits...............................................|netrw-credits| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 116 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 117 | {Vi does not have any of this} |
| 118 | |
| 119 | ============================================================================== |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 120 | 2. Starting With Netrw *netrw-start* {{{1 |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 121 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 122 | Netrw makes reading files, writing files, browsing over a network, and |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 123 | local browsing easy! First, make sure that you have plugins enabled, so |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 124 | you'll need to have at least the following in your <.vimrc>: |
| 125 | (or see |netrw-activate|) > |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 126 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 127 | set nocp " 'compatible' is not set |
| 128 | filetype plugin on " plugins are enabled |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 129 | < |
| 130 | (see |'cp'| and |:filetype-plugin-on|) |
| 131 | |
| 132 | Netrw supports "transparent" editing of files on other machines using urls |
| 133 | (see |netrw-transparent|). As an example of this, let's assume you have an |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 134 | account on some other machine; if you can use scp, try: > |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 135 | |
| 136 | vim scp://hostname/path/to/file |
| 137 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 138 | Want to make ssh/scp easier to use? Check out |netrw-ssh-hack|! |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 139 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 140 | So, what if you have ftp, not ssh/scp? That's easy, too; try > |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 141 | |
| 142 | vim ftp://hostname/path/to/file |
| 143 | < |
| 144 | Want to make ftp simpler to use? See if your ftp supports a file called |
| 145 | <.netrc> -- typically it goes in your home directory, has read/write |
| 146 | permissions for only the user to read (ie. not group, world, other, etc), |
| 147 | and has lines resembling > |
| 148 | |
| 149 | machine HOSTNAME login USERID password "PASSWORD" |
| 150 | machine HOSTNAME login USERID password "PASSWORD" |
| 151 | ... |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 152 | default login USERID password "PASSWORD" |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 153 | < |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 154 | Windows' ftp doesn't support .netrc; however, one may have in one's .vimrc: > |
| 155 | |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 156 | let g:netrw_ftp_cmd= 'c:\Windows\System32\ftp -s:C:\Users\MyUserName\MACHINE' |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 157 | < |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 158 | Netrw will substitute the host's machine name for "MACHINE" from the url it is |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 159 | attempting to open, and so one may specify > |
| 160 | userid |
| 161 | password |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 162 | for each site in a separate file: c:\Users\MyUserName\MachineName. |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 163 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 164 | Now about browsing -- when you just want to look around before editing a |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 165 | file. For browsing on your current host, just "edit" a directory: > |
| 166 | |
| 167 | vim . |
| 168 | vim /home/userid/path |
| 169 | < |
| 170 | For browsing on a remote host, "edit" a directory (but make sure that |
| 171 | the directory name is followed by a "/"): > |
| 172 | |
| 173 | vim scp://hostname/ |
| 174 | vim ftp://hostname/path/to/dir/ |
| 175 | < |
| 176 | See |netrw-browse| for more! |
| 177 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 178 | There are more protocols supported by netrw than just scp and ftp, too: see the |
| 179 | next section, |netrw-externapp|, on how to use these external applications with |
| 180 | netrw and vim. |
| 181 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 182 | PREVENTING LOADING *netrw-noload* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 183 | |
| 184 | If you want to use plugins, but for some reason don't wish to use netrw, then |
| 185 | you need to avoid loading both the plugin and the autoload portions of netrw. |
| 186 | You may do so by placing the following two lines in your <.vimrc>: > |
| 187 | |
| 188 | :let g:loaded_netrw = 1 |
| 189 | :let g:loaded_netrwPlugin = 1 |
| 190 | < |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 191 | |
| 192 | ============================================================================== |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 193 | 3. Netrw Reference *netrw-ref* {{{1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 194 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 195 | Netrw supports several protocols in addition to scp and ftp as mentioned |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 196 | in |netrw-start|. These include dav, fetch, http,... well, just look |
| 197 | at the list in |netrw-externapp|. Each protocol is associated with a |
| 198 | variable which holds the default command supporting that protocol. |
| 199 | |
| 200 | EXTERNAL APPLICATIONS AND PROTOCOLS *netrw-externapp* {{{2 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 201 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 202 | Protocol Variable Default Value |
| 203 | -------- ---------------- ------------- |
| 204 | dav: *g:netrw_dav_cmd* = "cadaver" if cadaver is executable |
| 205 | dav: g:netrw_dav_cmd = "curl -o" elseif curl is available |
| 206 | fetch: *g:netrw_fetch_cmd* = "fetch -o" if fetch is available |
| 207 | ftp: *g:netrw_ftp_cmd* = "ftp" |
| 208 | http: *g:netrw_http_cmd* = "elinks" if elinks is available |
| 209 | http: g:netrw_http_cmd = "links" elseif links is available |
| 210 | http: g:netrw_http_cmd = "curl" elseif curl is available |
| 211 | http: g:netrw_http_cmd = "wget" elseif wget is available |
| 212 | http: g:netrw_http_cmd = "fetch" elseif fetch is available |
| 213 | http: *g:netrw_http_put_cmd* = "curl -T" |
| 214 | rcp: *g:netrw_rcp_cmd* = "rcp" |
| 215 | rsync: *g:netrw_rsync_cmd* = "rsync -a" |
| 216 | scp: *g:netrw_scp_cmd* = "scp -q" |
| 217 | sftp: *g:netrw_sftp_cmd* = "sftp" |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 218 | file: *g:netrw_file_cmd* = "elinks" or "links" |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 219 | |
| 220 | *g:netrw_http_xcmd* : the option string for http://... protocols are |
| 221 | specified via this variable and may be independently overridden. By |
| 222 | default, the option arguments for the http-handling commands are: > |
| 223 | |
| 224 | elinks : "-source >" |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 225 | links : "-dump >" |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 226 | curl : "-o" |
| 227 | wget : "-q -O" |
| 228 | fetch : "-o" |
| 229 | < |
| 230 | For example, if your system has elinks, and you'd rather see the |
| 231 | page using an attempt at rendering the text, you may wish to have > |
| 232 | let g:netrw_http_xcmd= "-dump >" |
| 233 | < in your .vimrc. |
| 234 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 235 | g:netrw_http_put_cmd: this option specifies both the executable and |
| 236 | any needed options. This command does a PUT operation to the url. |
| 237 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 238 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 239 | READING *netrw-read* *netrw-nread* {{{2 |
| 240 | |
| 241 | Generally, one may just use the url notation with a normal editing |
| 242 | command, such as > |
| 243 | |
| 244 | :e ftp://[user@]machine/path |
| 245 | < |
| 246 | Netrw also provides the Nread command: |
| 247 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 248 | :Nread ? give help |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 249 | :Nread "machine:path" uses rcp |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 250 | :Nread "machine path" uses ftp w/ <.netrc> |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 251 | :Nread "machine id password path" uses ftp |
| 252 | :Nread "dav://machine[:port]/path" uses cadaver |
| 253 | :Nread "fetch://[user@]machine/path" uses fetch |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 254 | :Nread "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc> |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 255 | :Nread "http://[user@]machine/path" uses http uses wget |
| 256 | :Nread "rcp://[user@]machine/path" uses rcp |
| 257 | :Nread "rsync://[user@]machine[:port]/path" uses rsync |
| 258 | :Nread "scp://[user@]machine[[:#]port]/path" uses scp |
| 259 | :Nread "sftp://[user@]machine/path" uses sftp |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 260 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 261 | WRITING *netrw-write* *netrw-nwrite* {{{2 |
| 262 | |
| 263 | One may just use the url notation with a normal file writing |
| 264 | command, such as > |
| 265 | |
| 266 | :w ftp://[user@]machine/path |
| 267 | < |
| 268 | Netrw also provides the Nwrite command: |
| 269 | |
Bram Moolenaar | 433f7c8 | 2006-03-21 21:29:36 +0000 | [diff] [blame] | 270 | :Nwrite ? give help |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 271 | :Nwrite "machine:path" uses rcp |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 272 | :Nwrite "machine path" uses ftp w/ <.netrc> |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 273 | :Nwrite "machine id password path" uses ftp |
| 274 | :Nwrite "dav://machine[:port]/path" uses cadaver |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 275 | :Nwrite "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc> |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 276 | :Nwrite "rcp://[user@]machine/path" uses rcp |
| 277 | :Nwrite "rsync://[user@]machine[:port]/path" uses rsync |
| 278 | :Nwrite "scp://[user@]machine[[:#]port]/path" uses scp |
| 279 | :Nwrite "sftp://[user@]machine/path" uses sftp |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 280 | http: not supported! |
| 281 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 282 | SOURCING *netrw-source* {{{2 |
| 283 | |
| 284 | One may just use the url notation with the normal file sourcing |
| 285 | command, such as > |
| 286 | |
| 287 | :so ftp://[user@]machine/path |
| 288 | < |
| 289 | Netrw also provides the Nsource command: |
| 290 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 291 | :Nsource ? give help |
| 292 | :Nsource "dav://machine[:port]/path" uses cadaver |
| 293 | :Nsource "fetch://[user@]machine/path" uses fetch |
| 294 | :Nsource "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc> |
| 295 | :Nsource "http://[user@]machine/path" uses http uses wget |
| 296 | :Nsource "rcp://[user@]machine/path" uses rcp |
| 297 | :Nsource "rsync://[user@]machine[:port]/path" uses rsync |
| 298 | :Nsource "scp://[user@]machine[[:#]port]/path" uses scp |
| 299 | :Nsource "sftp://[user@]machine/path" uses sftp |
| 300 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 301 | DIRECTORY LISTING *netrw-trailingslash* *netrw-dirlist* {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 302 | |
| 303 | One may browse a directory to get a listing by simply attempting to |
| 304 | edit the directory: > |
| 305 | |
| 306 | :e scp://[user]@hostname/path/ |
| 307 | :e ftp://[user]@hostname/path/ |
| 308 | < |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 309 | For remote directory listings (ie. those using scp or ftp), that |
| 310 | trailing "/" is necessary (the slash tells netrw to treat the argument |
| 311 | as a directory to browse instead of as a file to download). |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 312 | |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 313 | The Nread command may also be used to accomplish this (again, that |
| 314 | trailing slash is necessary): > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 315 | |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 316 | :Nread [protocol]://[user]@hostname/path/ |
| 317 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 318 | *netrw-login* *netrw-password* |
| 319 | CHANGING USERID AND PASSWORD *netrw-chgup* *netrw-userpass* {{{2 |
Bram Moolenaar | 7aa9f6a | 2007-05-10 18:00:30 +0000 | [diff] [blame] | 320 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 321 | Attempts to use ftp will prompt you for a user-id and a password. |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 322 | These will be saved in global variables |g:netrw_uid| and |
| 323 | |s:netrw_passwd|; subsequent use of ftp will re-use those two strings, |
| 324 | thereby simplifying use of ftp. However, if you need to use a |
| 325 | different user id and/or password, you'll want to call |NetUserPass()| |
Bram Moolenaar | 7aa9f6a | 2007-05-10 18:00:30 +0000 | [diff] [blame] | 326 | first. To work around the need to enter passwords, check if your ftp |
| 327 | supports a <.netrc> file in your home directory. Also see |
| 328 | |netrw-passwd| (and if you're using ssh/scp hoping to figure out how |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 329 | to not need to use passwords for scp, look at |netrw-ssh-hack|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 330 | |
| 331 | :NetUserPass [uid [password]] -- prompts as needed |
| 332 | :call NetUserPass() -- prompts for uid and password |
| 333 | :call NetUserPass("uid") -- prompts for password |
| 334 | :call NetUserPass("uid","password") -- sets global uid and password |
| 335 | |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 336 | (Related topics: |ftp| |netrw-userpass| |netrw-start|) |
| 337 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 338 | NETRW VARIABLES AND SETTINGS *netrw-variables* {{{2 |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 339 | (Also see: |
| 340 | |netrw-browser-var| : netrw browser option variables |
| 341 | |netrw-protocol| : file transfer protocol option variables |
| 342 | |netrw-settings| : additional file transfer options |
| 343 | |netrw-browser-options| : these options affect browsing directories |
| 344 | ) |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 345 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 346 | Netrw provides a lot of variables which allow you to customize netrw to your |
| 347 | preferences. One way to look at them is via the command :NetrwSettings (see |
| 348 | |netrw-settings|) which will display your current netrw settings. Most such |
| 349 | settings are described below, in |netrw-browser-options|, and in |
| 350 | |netrw-externapp|: |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 351 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 352 | *b:netrw_lastfile* last file Network-read/written retained on a |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 353 | per-buffer basis (supports plain :Nw ) |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 354 | |
Bram Moolenaar | 5ac3b1a | 2010-07-27 22:50:36 +0200 | [diff] [blame] | 355 | *g:netrw_bufsettings* the settings that netrw buffers have |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 356 | (default) noma nomod nonu nowrap ro nobl |
Bram Moolenaar | 5ac3b1a | 2010-07-27 22:50:36 +0200 | [diff] [blame] | 357 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 358 | *g:netrw_chgwin* specifies a window number where subsequent file edits |
| 359 | will take place. (also see |netrw-C|) |
| 360 | (default) -1 |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 361 | |
Bram Moolenaar | 5ac3b1a | 2010-07-27 22:50:36 +0200 | [diff] [blame] | 362 | *g:Netrw_funcref* specifies a function (or functions) to be called when |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 363 | netrw edits a file. The file is first edited, and |
| 364 | then the function reference (|Funcref|) is called. |
| 365 | This variable may also hold a |List| of Funcrefs. |
| 366 | (default) not defined. (the capital in g:Netrw... |
| 367 | is required by its holding a function reference) |
Bram Moolenaar | 5ac3b1a | 2010-07-27 22:50:36 +0200 | [diff] [blame] | 368 | > |
| 369 | Example: place in .vimrc; affects all file opening |
| 370 | fun! MyFuncRef() |
| 371 | endfun |
| 372 | let g:Netrw_funcref= function("MyFuncRef") |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 373 | |
Bram Moolenaar | 5ac3b1a | 2010-07-27 22:50:36 +0200 | [diff] [blame] | 374 | < |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 375 | *g:Netrw_UserMaps* specifies a function or |List| of functions which can |
| 376 | be used to set up user-specified maps and functionality. |
| 377 | See |netrw-usermaps| |
| 378 | |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 379 | *g:netrw_ftp* if it doesn't exist, use default ftp |
| 380 | =0 use default ftp (uid password) |
| 381 | =1 use alternate ftp method (user uid password) |
| 382 | If you're having trouble with ftp, try changing the |
| 383 | value of this variable to see if the alternate ftp |
| 384 | method works for your setup. |
| 385 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 386 | *g:netrw_ftp_options* Chosen by default, these options are supposed to |
| 387 | turn interactive prompting off and to restrain ftp |
| 388 | from attempting auto-login upon initial connection. |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 389 | However, it appears that not all ftp implementations |
| 390 | support this (ex. ncftp). |
| 391 | ="-i -n" |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 392 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 393 | *g:netrw_ftpextracmd* default: doesn't exist |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 394 | If this variable exists, then any string it contains |
| 395 | will be placed into the commands set to your ftp |
| 396 | client. As an example: |
| 397 | ="passive" |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 398 | |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 399 | *g:netrw_ftpmode* ="binary" (default) |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 400 | ="ascii" |
Bram Moolenaar | f6cf987 | 2005-08-08 22:00:59 +0000 | [diff] [blame] | 401 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 402 | *g:netrw_ignorenetrc* =0 (default for linux, cygwin) |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 403 | =1 If you have a <.netrc> file but it doesn't work and |
| 404 | you want it ignored, then set this variable as |
| 405 | shown. (default for Windows + cmd.exe) |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 406 | |
| 407 | *g:netrw_menu* =0 disable netrw's menu |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 408 | =1 (default) netrw's menu enabled |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 409 | |
| 410 | *g:netrw_nogx* if this variable exists, then the "gx" map will not |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 411 | be available (see |netrw-gx|) |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 412 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 413 | *g:netrw_uid* (ftp) user-id, retained on a per-vim-session basis |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 414 | *s:netrw_passwd* (ftp) password, retained on a per-vim-session basis |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 415 | |
| 416 | *g:netrw_preview* =0 (default) preview window shown in a horizontally |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 417 | split window |
| 418 | =1 preview window shown in a vertically split window. |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 419 | Also affects the "previous window" (see |netrw-P|) |
| 420 | in the same way. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 421 | The |g:netrw_alto| variable may be used to provide |
| 422 | additional splitting control: |
| 423 | g:netrw_preview g:netrw_alto result |
| 424 | 0 0 |:aboveleft| |
| 425 | 0 1 |:belowright| |
| 426 | 1 0 |:topleft| |
| 427 | 1 1 |:botright| |
| 428 | To control sizing, see |g:netrw_winsize| |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 429 | |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 430 | *g:netrw_scpport* = "-P" : option to use to set port for scp |
| 431 | *g:netrw_sshport* = "-p" : option to use to set port for ssh |
Bram Moolenaar | 7aa9f6a | 2007-05-10 18:00:30 +0000 | [diff] [blame] | 432 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 433 | *g:netrw_sepchr* =\0xff |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 434 | =\0x01 for enc == euc-jp (and perhaps it should be for |
| 435 | others, too, please let me know) |
| 436 | Separates priority codes from filenames internally. |
| 437 | See |netrw-p12|. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 438 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 439 | *g:netrw_silent* =0 : transfers done normally |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 440 | =1 : transfers done silently |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 441 | |
Bram Moolenaar | 7aa9f6a | 2007-05-10 18:00:30 +0000 | [diff] [blame] | 442 | *g:netrw_use_errorwindow* =1 : messages from netrw will use a separate one |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 443 | line window. This window provides reliable |
Bram Moolenaar | 8ada2cc | 2010-07-29 20:43:36 +0200 | [diff] [blame] | 444 | delivery of messages. (default) |
| 445 | =0 : messages from netrw will use echoerr ; |
| 446 | messages don't always seem to show up this |
| 447 | way, but one doesn't have to quit the window. |
Bram Moolenaar | 7aa9f6a | 2007-05-10 18:00:30 +0000 | [diff] [blame] | 448 | |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 449 | *g:netrw_win95ftp* =1 if using Win95, will remove four trailing blank |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 450 | lines that o/s's ftp "provides" on transfers |
| 451 | =0 force normal ftp behavior (no trailing line removal) |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 452 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 453 | *g:netrw_cygwin* =1 assume scp under windows is from cygwin. Also |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 454 | permits network browsing to use ls with time and |
| 455 | size sorting (default if windows) |
| 456 | =0 assume Windows' scp accepts windows-style paths |
| 457 | Network browsing uses dir instead of ls |
| 458 | This option is ignored if you're using unix |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 459 | |
| 460 | *g:netrw_use_nt_rcp* =0 don't use the rcp of WinNT, Win2000 and WinXP |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 461 | =1 use WinNT's rcp in binary mode (default) |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 462 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 463 | PATHS *netrw-path* {{{2 |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 464 | |
| 465 | Paths to files are generally user-directory relative for most protocols. |
| 466 | It is possible that some protocol will make paths relative to some |
| 467 | associated directory, however. |
| 468 | > |
| 469 | example: vim scp://user@host/somefile |
| 470 | example: vim scp://user@host/subdir1/subdir2/somefile |
| 471 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 472 | where "somefile" is in the "user"'s home directory. If you wish to get a |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 473 | file using root-relative paths, use the full path: |
| 474 | > |
| 475 | example: vim scp://user@host//somefile |
| 476 | example: vim scp://user@host//subdir1/subdir2/somefile |
| 477 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 478 | |
| 479 | ============================================================================== |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 480 | 4. Network-Oriented File Transfer *netrw-xfer* {{{1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 481 | |
| 482 | Network-oriented file transfer under Vim is implemented by a VimL-based script |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 483 | (<netrw.vim>) using plugin techniques. It currently supports both reading and |
| 484 | writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 485 | dav/cadaver, rsync, or sftp. |
| 486 | |
| 487 | http is currently supported read-only via use of wget or fetch. |
| 488 | |
| 489 | <netrw.vim> is a standard plugin which acts as glue between Vim and the |
| 490 | various file transfer programs. It uses autocommand events (BufReadCmd, |
| 491 | FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. > |
| 492 | |
| 493 | ex. vim ftp://hostname/path/to/file |
| 494 | < |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 495 | The characters preceding the colon specify the protocol to use; in the |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 496 | example, it's ftp. The <netrw.vim> script then formulates a command or a |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 497 | series of commands (typically ftp) which it issues to an external program |
| 498 | (ftp, scp, etc) which does the actual file transfer/protocol. Files are read |
| 499 | from/written to a temporary file (under Unix/Linux, /tmp/...) which the |
| 500 | <netrw.vim> script will clean up. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 501 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 502 | Now, a word about Jan Minář's "FTP User Name and Password Disclosure"; first, |
| 503 | ftp is not a secure protocol. User names and passwords are transmitted "in |
| 504 | the clear" over the internet; any snooper tool can pick these up; this is not |
| 505 | a netrw thing, this is a ftp thing. If you're concerned about this, please |
| 506 | try to use scp or sftp instead. |
| 507 | |
| 508 | Netrw re-uses the user id and password during the same vim session and so long |
| 509 | as the remote hostname remains the same. |
| 510 | |
| 511 | Jan seems to be a bit confused about how netrw handles ftp; normally multiple |
| 512 | commands are performed in a "ftp session", and he seems to feel that the |
| 513 | uid/password should only be retained over one ftp session. However, netrw |
| 514 | does every ftp operation in a separate "ftp session"; so remembering the |
| 515 | uid/password for just one "ftp session" would be the same as not remembering |
| 516 | the uid/password at all. IMHO this would rapidly grow tiresome as one |
| 517 | browsed remote directories, for example. |
| 518 | |
| 519 | On the other hand, thanks go to Jan M. for pointing out the many |
| 520 | vulnerabilities that netrw (and vim itself) had had in handling "crafted" |
| 521 | filenames. The |shellescape()| and |fnameescape()| functions were written in |
Bram Moolenaar | 5ac3b1a | 2010-07-27 22:50:36 +0200 | [diff] [blame] | 522 | response by Bram Moolenaar to handle these sort of problems, and netrw has |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 523 | been modified to use them. Still, my advice is, if the "filename" looks like |
| 524 | a vim command that you aren't comfortable with having executed, don't open it. |
| 525 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 526 | *netrw-putty* *netrw-pscp* *netrw-psftp* |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 527 | One may modify any protocol's implementing external application by setting a |
| 528 | variable (ex. scp uses the variable g:netrw_scp_cmd, which is defaulted to |
Bram Moolenaar | 433f7c8 | 2006-03-21 21:29:36 +0000 | [diff] [blame] | 529 | "scp -q"). As an example, consider using PuTTY: > |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 530 | |
| 531 | let g:netrw_scp_cmd = '"c:\Program Files\PuTTY\pscp.exe" -q -batch' |
| 532 | let g:netrw_sftp_cmd= '"c:\Program Files\PuTTY\psftp.exe"' |
Bram Moolenaar | 433f7c8 | 2006-03-21 21:29:36 +0000 | [diff] [blame] | 533 | < |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 534 | (note: it has been reported that windows 7 with putty v0.6's "-batch" option |
| 535 | doesn't work, so its best to leave it off for that system) |
| 536 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 537 | See |netrw-p8| for more about putty, pscp, psftp, etc. |
| 538 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 539 | Ftp, an old protocol, seems to be blessed by numerous implementations. |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 540 | Unfortunately, some implementations are noisy (ie., add junk to the end of the |
| 541 | file). Thus, concerned users may decide to write a NetReadFixup() function |
| 542 | that will clean up after reading with their ftp. Some Unix systems (ie., |
| 543 | FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is |
| 544 | not noisy and more convenient, actually, for <netrw.vim> to use. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 545 | Consequently, if "fetch" is available (ie. executable), it may be preferable |
| 546 | to use it for ftp://... based transfers. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 547 | |
| 548 | For rcp, scp, sftp, and http, one may use network-oriented file transfers |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 549 | transparently; ie. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 550 | > |
| 551 | vim rcp://[user@]machine/path |
| 552 | vim scp://[user@]machine/path |
| 553 | < |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 554 | If your ftp supports <.netrc>, then it too can be transparently used |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 555 | if the needed triad of machine name, user id, and password are present in |
| 556 | that file. Your ftp must be able to use the <.netrc> file on its own, however. |
| 557 | > |
| 558 | vim ftp://[user@]machine[[:#]portnumber]/path |
| 559 | < |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 560 | Windows provides an ftp (typically c:\Windows\System32\ftp.exe) which uses |
| 561 | an option, -s:filename (filename can and probably should be a full path) |
| 562 | which contains ftp commands which will be automatically run whenever ftp |
| 563 | starts. You may use this feature to enter a user and password for one site: > |
| 564 | userid |
| 565 | password |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 566 | < *netrw-windows-netrc* *netrw-windows-s* |
| 567 | If |g:netrw_ftp_cmd| contains -s:[path/]MACHINE, then (on Windows machines |
| 568 | only) netrw will substitute the current machine name requested for ftp |
| 569 | connections for MACHINE. Hence one can have multiple machine.ftp files |
| 570 | containing login and password for ftp. Example: > |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 571 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 572 | let g:netrw_ftp_cmd= 'c:\Windows\System32\ftp -s:C:\Users\Myself\MACHINE' |
| 573 | vim ftp://myhost.somewhere.net/ |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 574 | |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 575 | will use a file > |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 576 | |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 577 | C:\Users\Myself\myhost.ftp |
| 578 | < |
| 579 | Often, ftp will need to query the user for the userid and password. |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 580 | The latter will be done "silently"; ie. asterisks will show up instead of |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 581 | the actually-typed-in password. Netrw will retain the userid and password |
| 582 | for subsequent read/writes from the most recent transfer so subsequent |
| 583 | transfers (read/write) to or from that machine will take place without |
| 584 | additional prompting. |
| 585 | |
| 586 | *netrw-urls* |
| 587 | +=================================+============================+============+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 588 | | Reading | Writing | Uses | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 589 | +=================================+============================+============+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 590 | | DAV: | | | |
| 591 | | dav://host/path | | cadaver | |
| 592 | | :Nread dav://host/path | :Nwrite dav://host/path | cadaver | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 593 | +---------------------------------+----------------------------+------------+ |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 594 | | DAV + SSL: | | | |
| 595 | | davs://host/path | | cadaver | |
| 596 | | :Nread davs://host/path | :Nwrite davs://host/path | cadaver | |
| 597 | +---------------------------------+----------------------------+------------+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 598 | | FETCH: | | | |
| 599 | | fetch://[user@]host/path | | | |
| 600 | | fetch://[user@]host:http/path | Not Available | fetch | |
| 601 | | :Nread fetch://[user@]host/path| | | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 602 | +---------------------------------+----------------------------+------------+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 603 | | FILE: | | | |
| 604 | | file:///* | file:///* | | |
| 605 | | file://localhost/* | file://localhost/* | | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 606 | +---------------------------------+----------------------------+------------+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 607 | | FTP: (*3) | (*3) | | |
| 608 | | ftp://[user@]host/path | ftp://[user@]host/path | ftp (*2) | |
| 609 | | :Nread ftp://host/path | :Nwrite ftp://host/path | ftp+.netrc | |
| 610 | | :Nread host path | :Nwrite host path | ftp+.netrc | |
| 611 | | :Nread host uid pass path | :Nwrite host uid pass path | ftp | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 612 | +---------------------------------+----------------------------+------------+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 613 | | HTTP: wget is executable: (*4) | | | |
| 614 | | http://[user@]host/path | Not Available | wget | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 615 | +---------------------------------+----------------------------+------------+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 616 | | HTTP: fetch is executable (*4) | | | |
| 617 | | http://[user@]host/path | Not Available | fetch | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 618 | +---------------------------------+----------------------------+------------+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 619 | | RCP: | | | |
| 620 | | rcp://[user@]host/path | rcp://[user@]host/path | rcp | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 621 | +---------------------------------+----------------------------+------------+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 622 | | RSYNC: | | | |
| 623 | | rsync://[user@]host/path | rsync://[user@]host/path | rsync | |
| 624 | | :Nread rsync://host/path | :Nwrite rsync://host/path | rsync | |
| 625 | | :Nread rcp://host/path | :Nwrite rcp://host/path | rcp | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 626 | +---------------------------------+----------------------------+------------+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 627 | | SCP: | | | |
| 628 | | scp://[user@]host/path | scp://[user@]host/path | scp | |
| 629 | | :Nread scp://host/path | :Nwrite scp://host/path | scp (*1) | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 630 | +---------------------------------+----------------------------+------------+ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 631 | | SFTP: | | | |
| 632 | | sftp://[user@]host/path | sftp://[user@]host/path | sftp | |
| 633 | | :Nread sftp://host/path | :Nwrite sftp://host/path | sftp (*1) | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 634 | +=================================+============================+============+ |
| 635 | |
| 636 | (*1) For an absolute path use scp://machine//path. |
| 637 | |
| 638 | (*2) if <.netrc> is present, it is assumed that it will |
| 639 | work with your ftp client. Otherwise the script will |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 640 | prompt for user-id and password. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 641 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 642 | (*3) for ftp, "machine" may be machine#port or machine:port |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 643 | if a different port is needed than the standard ftp port |
| 644 | |
| 645 | (*4) for http:..., if wget is available it will be used. Otherwise, |
| 646 | if fetch is available it will be used. |
| 647 | |
| 648 | Both the :Nread and the :Nwrite ex-commands can accept multiple filenames. |
| 649 | |
| 650 | |
| 651 | NETRC *netrw-netrc* |
| 652 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 653 | The <.netrc> file, typically located in your home directory, contains lines |
| 654 | therein which map a hostname (machine name) to the user id and password you |
| 655 | prefer to use with it. |
| 656 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 657 | The typical syntax for lines in a <.netrc> file is given as shown below. |
Bram Moolenaar | c01140a | 2006-03-24 22:21:52 +0000 | [diff] [blame] | 658 | Ftp under Unix usually supports <.netrc>; ftp under Windows usually doesn't. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 659 | > |
| 660 | machine {full machine name} login {user-id} password "{password}" |
| 661 | default login {user-id} password "{password}" |
| 662 | |
| 663 | Your ftp client must handle the use of <.netrc> on its own, but if the |
| 664 | <.netrc> file exists, an ftp transfer will not ask for the user-id or |
| 665 | password. |
| 666 | |
| 667 | Note: |
| 668 | Since this file contains passwords, make very sure nobody else can |
| 669 | read this file! Most programs will refuse to use a .netrc that is |
| 670 | readable for others. Don't forget that the system administrator can |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 671 | still read the file! Ie. for Linux/Unix: chmod 600 .netrc |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 672 | |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 673 | Even though Windows' ftp clients typically do not support .netrc, netrw has |
| 674 | a work-around: see |netrw-windows-s|. |
| 675 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 676 | |
| 677 | PASSWORD *netrw-passwd* |
| 678 | |
| 679 | The script attempts to get passwords for ftp invisibly using |inputsecret()|, |
Bram Moolenaar | 8ada2cc | 2010-07-29 20:43:36 +0200 | [diff] [blame] | 680 | a built-in Vim function. See |netrw-userpass| for how to change the password |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 681 | after one has set it. |
| 682 | |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 683 | Unfortunately there doesn't appear to be a way for netrw to feed a password to |
| 684 | scp. Thus every transfer via scp will require re-entry of the password. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 685 | However, |netrw-ssh-hack| can help with this problem. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 686 | |
| 687 | |
| 688 | ============================================================================== |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 689 | 5. Activation *netrw-activate* {{{1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 690 | |
Bram Moolenaar | c01140a | 2006-03-24 22:21:52 +0000 | [diff] [blame] | 691 | Network-oriented file transfers are available by default whenever Vim's |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 692 | |'nocompatible'| mode is enabled. Netrw's script files reside in your |
| 693 | system's plugin, autoload, and syntax directories; just the |
| 694 | plugin/netrwPlugin.vim script is sourced automatically whenever you bring up |
| 695 | vim. The main script in autoload/netrw.vim is only loaded when you actually |
| 696 | use netrw. I suggest that, at a minimum, you have at least the following in |
| 697 | your <.vimrc> customization file: > |
Bram Moolenaar | c01140a | 2006-03-24 22:21:52 +0000 | [diff] [blame] | 698 | |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 699 | set nocp |
| 700 | if version >= 600 |
| 701 | filetype plugin indent on |
| 702 | endif |
| 703 | < |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 704 | By also including the following lines in your .vimrc, one may have netrw |
| 705 | immediately activate when using [g]vim without any filenames, showing the |
| 706 | current directory: > |
| 707 | |
| 708 | " Augroup VimStartup: |
| 709 | augroup VimStartup |
| 710 | au! |
| 711 | au VimEnter * if expand("%") == "" | e . | endif |
| 712 | augroup END |
| 713 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 714 | |
| 715 | ============================================================================== |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 716 | 6. Transparent Remote File Editing *netrw-transparent* {{{1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 717 | |
| 718 | Transparent file transfers occur whenever a regular file read or write |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 719 | (invoked via an |:autocmd| for |BufReadCmd|, |BufWriteCmd|, or |SourceCmd| |
| 720 | events) is made. Thus one may read, write, or source files across networks |
| 721 | just as easily as if they were local files! > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 722 | |
| 723 | vim ftp://[user@]machine/path |
| 724 | ... |
| 725 | :wq |
| 726 | |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 727 | See |netrw-activate| for more on how to encourage your vim to use plugins |
| 728 | such as netrw. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 729 | |
Bram Moolenaar | c01140a | 2006-03-24 22:21:52 +0000 | [diff] [blame] | 730 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 731 | ============================================================================== |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 732 | 7. Ex Commands *netrw-ex* {{{1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 733 | |
Bram Moolenaar | c01140a | 2006-03-24 22:21:52 +0000 | [diff] [blame] | 734 | The usual read/write commands are supported. There are also a few |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 735 | additional commands available. Often you won't need to use Nwrite or |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 736 | Nread as shown in |netrw-transparent| (ie. simply use > |
| 737 | :e url |
| 738 | :r url |
| 739 | :w url |
| 740 | instead, as appropriate) -- see |netrw-urls|. In the explanations |
| 741 | below, a {netfile} is an url to a remote file. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 742 | |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 743 | *:Nwrite* *:Nw* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 744 | :[range]Nw[rite] Write the specified lines to the current |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 745 | file as specified in b:netrw_lastfile. |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 746 | (related: |netrw-nwrite|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 747 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 748 | :[range]Nw[rite] {netfile} [{netfile}]... |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 749 | Write the specified lines to the {netfile}. |
| 750 | |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 751 | *:Nread* *:Nr* |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 752 | :Nr[ead] Read the lines from the file specified in b:netrw_lastfile |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 753 | into the current buffer. (related: |netrw-nread|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 754 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 755 | :Nr[ead] {netfile} {netfile}... |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 756 | Read the {netfile} after the current line. |
| 757 | |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 758 | *:Nsource* *:Ns* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 759 | :Ns[ource] {netfile} |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 760 | Source the {netfile}. |
| 761 | To start up vim using a remote .vimrc, one may use |
| 762 | the following (all on one line) (tnx to Antoine Mechelynck) > |
| 763 | vim -u NORC -N |
| 764 | --cmd "runtime plugin/netrwPlugin.vim" |
| 765 | --cmd "source scp://HOSTNAME/.vimrc" |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 766 | < (related: |netrw-source|) |
| 767 | |
| 768 | :call NetUserPass() *NetUserPass()* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 769 | If g:netrw_uid and s:netrw_passwd don't exist, |
| 770 | this function will query the user for them. |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 771 | (related: |netrw-userpass|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 772 | |
| 773 | :call NetUserPass("userid") |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 774 | This call will set the g:netrw_uid and, if |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 775 | the password doesn't exist, will query the user for it. |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 776 | (related: |netrw-userpass|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 777 | |
| 778 | :call NetUserPass("userid","passwd") |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 779 | This call will set both the g:netrw_uid and s:netrw_passwd. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 780 | The user-id and password are used by ftp transfers. One may |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 781 | effectively remove the user-id and password by using empty |
| 782 | strings (ie. ""). |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 783 | (related: |netrw-userpass|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 784 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 785 | :NetrwSettings This command is described in |netrw-settings| -- used to |
| 786 | display netrw settings and change netrw behavior. |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 787 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 788 | |
| 789 | ============================================================================== |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 790 | 8. Variables and Options *netrw-var* *netrw-settings* {{{1 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 791 | |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 792 | (also see: |netrw-options| |netrw-variables| |netrw-protocol| |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 793 | |netrw-browser-settings| |netrw-browser-options| ) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 794 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 795 | The <netrw.vim> script provides several variables which act as options to |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 796 | affect <netrw.vim>'s file transfer behavior. These variables typically may be |
| 797 | set in the user's <.vimrc> file: (see also |netrw-settings| |netrw-protocol|) |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 798 | *netrw-options* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 799 | > |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 800 | ------------- |
| 801 | Netrw Options |
| 802 | ------------- |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 803 | Option Meaning |
| 804 | -------------- ----------------------------------------------- |
| 805 | < |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 806 | b:netrw_col Holds current cursor position (during NetWrite) |
| 807 | g:netrw_cygwin =1 assume scp under windows is from cygwin |
| 808 | (default/windows) |
| 809 | =0 assume scp under windows accepts windows |
| 810 | style paths (default/else) |
| 811 | g:netrw_ftp =0 use default ftp (uid password) |
| 812 | g:netrw_ftpmode ="binary" (default) |
| 813 | ="ascii" (your choice) |
| 814 | g:netrw_ignorenetrc =1 (default) |
| 815 | if you have a <.netrc> file but you don't |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 816 | want it used, then set this variable. Its |
| 817 | mere existence is enough to cause <.netrc> |
| 818 | to be ignored. |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 819 | b:netrw_lastfile Holds latest method/machine/path. |
| 820 | b:netrw_line Holds current line number (during NetWrite) |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 821 | g:netrw_silent =0 transfers done normally |
| 822 | =1 transfers done silently |
| 823 | g:netrw_uid Holds current user-id for ftp. |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 824 | g:netrw_use_nt_rcp =0 don't use WinNT/2K/XP's rcp (default) |
| 825 | =1 use WinNT/2K/XP's rcp, binary mode |
| 826 | g:netrw_win95ftp =0 use unix-style ftp even if win95/98/ME/etc |
| 827 | =1 use default method to do ftp > |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 828 | ----------------------------------------------------------------------- |
| 829 | < |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 830 | *netrw-internal-variables* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 831 | The script will also make use of the following variables internally, albeit |
| 832 | temporarily. |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 833 | > |
| 834 | ------------------- |
| 835 | Temporary Variables |
| 836 | ------------------- |
| 837 | Variable Meaning |
| 838 | -------- ------------------------------------ |
| 839 | < |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 840 | b:netrw_method Index indicating rcp/ftp+.netrc/ftp |
| 841 | w:netrw_method (same as b:netrw_method) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 842 | g:netrw_machine Holds machine name parsed from input |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 843 | b:netrw_fname Holds filename being accessed > |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 844 | ------------------------------------------------------------ |
| 845 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 846 | *netrw-protocol* |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 847 | |
| 848 | Netrw supports a number of protocols. These protocols are invoked using the |
| 849 | variables listed below, and may be modified by the user. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 850 | > |
| 851 | ------------------------ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 852 | Protocol Control Options |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 853 | ------------------------ |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 854 | Option Type Setting Meaning |
| 855 | --------- -------- -------------- --------------------------- |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 856 | < netrw_ftp variable =doesn't exist userid set by "user userid" |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 857 | =0 userid set by "user userid" |
| 858 | =1 userid set by "userid" |
| 859 | NetReadFixup function =doesn't exist no change |
| 860 | =exists Allows user to have files |
| 861 | read via ftp automatically |
| 862 | transformed however they wish |
| 863 | by NetReadFixup() |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 864 | g:netrw_dav_cmd var ="cadaver" if cadaver is executable |
| 865 | g:netrw_dav_cmd var ="curl -o" elseif curl is executable |
| 866 | g:netrw_fetch_cmd var ="fetch -o" if fetch is available |
| 867 | g:netrw_ftp_cmd var ="ftp" |
| 868 | g:netrw_http_cmd var ="fetch -o" if fetch is available |
| 869 | g:netrw_http_cmd var ="wget -O" else if wget is available |
| 870 | g:netrw_http_put_cmd var ="curl -T" |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 871 | |g:netrw_list_cmd| var ="ssh USEPORT HOSTNAME ls -Fa" |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 872 | g:netrw_rcp_cmd var ="rcp" |
| 873 | g:netrw_rsync_cmd var ="rsync -a" |
| 874 | g:netrw_scp_cmd var ="scp -q" |
| 875 | g:netrw_sftp_cmd var ="sftp" > |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 876 | ------------------------------------------------------------------------- |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 877 | < |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 878 | *netrw-ftp* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 879 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 880 | The g:netrw_..._cmd options (|g:netrw_ftp_cmd| and |g:netrw_sftp_cmd|) |
| 881 | specify the external program to use handle the ftp protocol. They may |
Bram Moolenaar | 5ac3b1a | 2010-07-27 22:50:36 +0200 | [diff] [blame] | 882 | include command line options (such as -p for passive mode). Example: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 883 | |
Bram Moolenaar | 5ac3b1a | 2010-07-27 22:50:36 +0200 | [diff] [blame] | 884 | let g:netrw_ftp_cmd= "ftp -p" |
| 885 | < |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 886 | Browsing is supported by using the |g:netrw_list_cmd|; the substring |
| 887 | "HOSTNAME" will be changed via substitution with whatever the current request |
| 888 | is for a hostname. |
| 889 | |
| 890 | Two options (|g:netrw_ftp| and |netrw-fixup|) both help with certain ftp's |
| 891 | that give trouble . In order to best understand how to use these options if |
| 892 | ftp is giving you troubles, a bit of discussion is provided on how netrw does |
| 893 | ftp reads. |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 894 | |
| 895 | For ftp, netrw typically builds up lines of one of the following formats in a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 896 | temporary file: |
| 897 | > |
| 898 | IF g:netrw_ftp !exists or is not 1 IF g:netrw_ftp exists and is 1 |
| 899 | ---------------------------------- ------------------------------ |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 900 | < |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 901 | open machine [port] open machine [port] |
| 902 | user userid password userid password |
| 903 | [g:netrw_ftpmode] password |
Bram Moolenaar | 8ada2cc | 2010-07-29 20:43:36 +0200 | [diff] [blame] | 904 | [g:netrw_ftpextracmd] [g:netrw_ftpmode] |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 905 | get filename tempfile [g:netrw_extracmd] |
| 906 | get filename tempfile > |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 907 | --------------------------------------------------------------------- |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 908 | < |
Bram Moolenaar | 8ada2cc | 2010-07-29 20:43:36 +0200 | [diff] [blame] | 909 | The |g:netrw_ftpmode| and |g:netrw_ftpextracmd| are optional. |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 910 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 911 | Netrw then executes the lines above by use of a filter: |
| 912 | > |
| 913 | :%! {g:netrw_ftp_cmd} -i [-n] |
| 914 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 915 | where |
| 916 | g:netrw_ftp_cmd is usually "ftp", |
| 917 | -i tells ftp not to be interactive |
| 918 | -n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>) |
| 919 | |
| 920 | If <.netrc> exists it will be used to avoid having to query the user for |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 921 | userid and password. The transferred file is put into a temporary file. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 922 | The temporary file is then read into the main editing session window that |
| 923 | requested it and the temporary file deleted. |
| 924 | |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 925 | If your ftp doesn't accept the "user" command and immediately just demands a |
| 926 | userid, then try putting "let netrw_ftp=1" in your <.vimrc>. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 927 | |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 928 | *netrw-cadaver* |
| 929 | To handle the SSL certificate dialog for untrusted servers, one may pull |
| 930 | down the certificate and place it into /usr/ssl/cert.pem. This operation |
| 931 | renders the server treatment as "trusted". |
| 932 | |
Bram Moolenaar | 433f7c8 | 2006-03-21 21:29:36 +0000 | [diff] [blame] | 933 | *netrw-fixup* *netreadfixup* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 934 | If your ftp for whatever reason generates unwanted lines (such as AUTH |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 935 | messages) you may write a NetReadFixup() function: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 936 | > |
| 937 | function! NetReadFixup(method,line1,line2) |
| 938 | " a:line1: first new line in current file |
| 939 | " a:line2: last new line in current file |
| 940 | if a:method == 1 "rcp |
| 941 | elseif a:method == 2 "ftp + <.netrc> |
| 942 | elseif a:method == 3 "ftp + machine,uid,password,filename |
| 943 | elseif a:method == 4 "scp |
| 944 | elseif a:method == 5 "http/wget |
| 945 | elseif a:method == 6 "dav/cadaver |
| 946 | elseif a:method == 7 "rsync |
| 947 | elseif a:method == 8 "fetch |
| 948 | elseif a:method == 9 "sftp |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 949 | else " complain |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 950 | endif |
| 951 | endfunction |
| 952 | > |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 953 | The NetReadFixup() function will be called if it exists and thus allows you to |
| 954 | customize your reading process. As a further example, <netrw.vim> contains |
| 955 | just such a function to handle Windows 95 ftp. For whatever reason, Windows |
| 956 | 95's ftp dumps four blank lines at the end of a transfer, and so it is |
| 957 | desirable to automate their removal. Here's some code taken from <netrw.vim> |
| 958 | itself: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 959 | > |
| 960 | if has("win95") && g:netrw_win95ftp |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 961 | fun! NetReadFixup(method, line1, line2) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 962 | if method == 3 " ftp (no <.netrc>) |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 963 | let fourblanklines= line2 - 3 |
| 964 | silent fourblanklines.",".line2."g/^\s*/d" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 965 | endif |
| 966 | endfunction |
| 967 | endif |
| 968 | > |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 969 | (Related topics: |ftp| |netrw-userpass| |netrw-start|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 970 | |
| 971 | ============================================================================== |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 972 | 9. Browsing *netrw-browsing* *netrw-browse* *netrw-help* {{{1 |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 973 | *netrw-browser* *netrw-dir* *netrw-list* |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 974 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 975 | INTRODUCTION TO BROWSING *netrw-intro-browse* {{{2 |
| 976 | (Quick References: |netrw-quickmaps| |netrw-quickcoms|) |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 977 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 978 | Netrw supports the browsing of directories on your local system and on remote |
| 979 | hosts; browsing includes listing files and directories, entering directories, |
| 980 | editing files therein, deleting files/directories, making new directories, |
| 981 | moving (renaming) files and directories, copying files and directories, etc. |
| 982 | One may mark files and execute any system command on them! The Netrw browser |
| 983 | generally implements the previous explorer's maps and commands for remote |
| 984 | directories, although details (such as pertinent global variable names) |
| 985 | necessarily differ. To browse a directory, simply "edit" it! > |
Bram Moolenaar | 269ec65 | 2004-07-29 08:43:53 +0000 | [diff] [blame] | 986 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 987 | vim /your/directory/ |
| 988 | vim . |
| 989 | vim c:\your\directory\ |
| 990 | < |
| 991 | (Related topics: |netrw-cr| |netrw-o| |netrw-p| |netrw-P| |netrw-t| |
| 992 | |netrw-mf| |netrw-mx| |netrw-D| |netrw-R| |netrw-v| ) |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 993 | |
| 994 | The Netrw remote file and directory browser handles two protocols: ssh and |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 995 | ftp. The protocol in the url, if it is ftp, will cause netrw also to use ftp |
| 996 | in its remote browsing. Specifying any other protocol will cause it to be |
| 997 | used for file transfers; but the ssh protocol will be used to do remote |
| 998 | browsing. |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 999 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1000 | To use Netrw's remote directory browser, simply attempt to read a "file" with |
| 1001 | a trailing slash and it will be interpreted as a request to list a directory: |
| 1002 | > |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 1003 | vim [protocol]://[user@]hostname/path/ |
Bram Moolenaar | 4ea8fe1 | 2006-03-09 22:32:39 +0000 | [diff] [blame] | 1004 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1005 | where [protocol] is typically scp or ftp. As an example, try: > |
Bram Moolenaar | 4ea8fe1 | 2006-03-09 22:32:39 +0000 | [diff] [blame] | 1006 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1007 | vim ftp://ftp.home.vim.org/pub/vim/ |
| 1008 | < |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1009 | For local directories, the trailing slash is not required. Again, because it's |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1010 | easy to miss: to browse remote directories, the url must terminate with a |
| 1011 | slash! |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 1012 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1013 | If you'd like to avoid entering the password repeatedly for remote directory |
| 1014 | listings with ssh or scp, see |netrw-ssh-hack|. To avoid password entry with |
| 1015 | ftp, see |netrw-netrc| (if your ftp supports it). |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 1016 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1017 | There are several things you can do to affect the browser's display of files: |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 1018 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1019 | * To change the listing style, press the "i" key (|netrw-i|). |
| 1020 | Currently there are four styles: thin, long, wide, and tree. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1021 | To make that change "permanent", see |g:netrw_liststyle|. |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 1022 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1023 | * To hide files (don't want to see those xyz~ files anymore?) see |
| 1024 | |netrw-ctrl-h|. |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 1025 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1026 | * Press s to sort files by name, time, or size. |
| 1027 | |
| 1028 | See |netrw-browse-cmds| for all the things you can do with netrw! |
| 1029 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1030 | *netrw-getftype* *netrw-filigree* *netrw-ftype* |
| 1031 | The |getftype()| function is used to append a bit of filigree to indicate |
| 1032 | filetype to locally listed files: |
| 1033 | |
| 1034 | directory : / |
| 1035 | executable : * |
| 1036 | fifo : | |
| 1037 | links : @ |
| 1038 | sockets : = |
| 1039 | |
| 1040 | The filigree also affects the |g:netrw_sort_sequence|. |
| 1041 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1042 | |
| 1043 | QUICK HELP *netrw-quickhelp* {{{2 |
| 1044 | (Use ctrl-] to select a topic)~ |
| 1045 | Intro to Browsing...............................|netrw-intro-browse| |
| 1046 | Quick Reference: Maps.........................|netrw-quickmap| |
| 1047 | Quick Reference: Commands.....................|netrw-browse-cmds| |
| 1048 | Hiding |
| 1049 | Edit hiding list..............................|netrw-ctrl-h| |
| 1050 | Hiding Files or Directories...................|netrw-a| |
| 1051 | Hiding/Unhiding by suffix.....................|netrw-mh| |
| 1052 | Hiding dot-files.............................|netrw-gh| |
| 1053 | Listing Style |
| 1054 | Select listing style (thin/long/wide/tree)....|netrw-i| |
| 1055 | Associated setting variable...................|g:netrw_liststyle| |
| 1056 | Shell command used to perform listing.........|g:netrw_list_cmd| |
| 1057 | Quick file info...............................|netrw-qf| |
| 1058 | Sorted by |
| 1059 | Select sorting style (name/time/size).........|netrw-s| |
| 1060 | Editing the sorting sequence..................|netrw-S| |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 1061 | Sorting options...............................|g:netrw_sort_options| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1062 | Associated setting variable...................|g:netrw_sort_sequence| |
| 1063 | Reverse sorting order.........................|netrw-r| |
| 1064 | |
| 1065 | |
| 1066 | *netrw-quickmap* *netrw-quickmaps* |
| 1067 | QUICK REFERENCE: MAPS *netrw-browse-maps* {{{2 |
Bram Moolenaar | f6cf987 | 2005-08-08 22:00:59 +0000 | [diff] [blame] | 1068 | > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1069 | --- ----------------- ---- |
| 1070 | Map Quick Explanation Link |
| 1071 | --- ----------------- ---- |
| 1072 | < <F1> Causes Netrw to issue help |
| 1073 | <cr> Netrw will enter the directory or read the file |netrw-cr| |
| 1074 | <del> Netrw will attempt to remove the file/directory |netrw-del| |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1075 | <c-h> Edit file hiding list |netrw-ctrl-h| |
| 1076 | <c-l> Causes Netrw to refresh the directory listing |netrw-ctrl-l| |
| 1077 | <c-r> Browse using a gvim server |netrw-ctrl-r| |
| 1078 | <c-tab> Shrink/expand a netrw/explore window |netrw-c-tab| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1079 | - Makes Netrw go up one directory |netrw--| |
| 1080 | a Toggles between normal display, |netrw-a| |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1081 | hiding (suppress display of files matching g:netrw_list_hide) |
| 1082 | showing (display only files which match g:netrw_list_hide) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1083 | c Make browsing directory the current directory |netrw-c| |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1084 | C Setting the editing window |netrw-C| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1085 | d Make a directory |netrw-d| |
| 1086 | D Attempt to remove the file(s)/directory(ies) |netrw-D| |
| 1087 | gb Go to previous bookmarked directory |netrw-gb| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1088 | gd Force treatment as directory |netrw-gd| |
| 1089 | gf Force treatment as file |netrw-gf| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1090 | gh Quick hide/unhide of dot-files |netrw-gh| |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1091 | gn Make top of tree the directory below the cursor |netrw-gn| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1092 | i Cycle between thin, long, wide, and tree listings |netrw-i| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1093 | mb Bookmark current directory |netrw-mb| |
| 1094 | mc Copy marked files to marked-file target directory |netrw-mc| |
| 1095 | md Apply diff to marked files (up to 3) |netrw-md| |
| 1096 | me Place marked files on arg list and edit them |netrw-me| |
| 1097 | mf Mark a file |netrw-mf| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1098 | mF Unmark files |netrw-mF| |
| 1099 | mg Apply vimgrep to marked files |netrw-mg| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1100 | mh Toggle marked file suffices' presence on hiding list |netrw-mh| |
| 1101 | mm Move marked files to marked-file target directory |netrw-mm| |
| 1102 | mp Print marked files |netrw-mp| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1103 | mr Mark files using a shell-style |regexp| |netrw-mr| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1104 | mt Current browsing directory becomes markfile target |netrw-mt| |
| 1105 | mT Apply ctags to marked files |netrw-mT| |
| 1106 | mu Unmark all marked files |netrw-mu| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1107 | mv Apply arbitrary vim command to marked files |netrw-mv| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1108 | mx Apply arbitrary shell command to marked files |netrw-mx| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1109 | mX Apply arbitrary shell command to marked files en bloc|netrw-mX| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1110 | mz Compress/decompress marked files |netrw-mz| |
| 1111 | o Enter the file/directory under the cursor in a new |netrw-o| |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1112 | browser window. A horizontal split is used. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1113 | O Obtain a file specified by cursor |netrw-O| |
| 1114 | p Preview the file |netrw-p| |
| 1115 | P Browse in the previously used window |netrw-P| |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1116 | qb List bookmarked directories and history |netrw-qb| |
| 1117 | qf Display information on file |netrw-qf| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1118 | qF Mark files using a quickfix list |netrw-qF| |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 1119 | qL Mark files using a |location-list| |netrw-qL| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1120 | r Reverse sorting order |netrw-r| |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1121 | R Rename the designated file(s)/directory(ies) |netrw-R| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1122 | s Select sorting style: by name, time, or file size |netrw-s| |
| 1123 | S Specify suffix priority for name-sorting |netrw-S| |
| 1124 | t Enter the file/directory under the cursor in a new tab|netrw-t| |
| 1125 | u Change to recently-visited directory |netrw-u| |
| 1126 | U Change to subsequently-visited directory |netrw-U| |
| 1127 | v Enter the file/directory under the cursor in a new |netrw-v| |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1128 | browser window. A vertical split is used. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1129 | x View file with an associated program |netrw-x| |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 1130 | X Execute filename under cursor via |system()| |netrw-X| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1131 | |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 1132 | % Open a new file in netrw's current directory |netrw-%| |
| 1133 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1134 | *netrw-mouse* *netrw-leftmouse* *netrw-middlemouse* *netrw-rightmouse* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1135 | <leftmouse> (gvim only) selects word under mouse as if a <cr> |
| 1136 | had been pressed (ie. edit file, change directory) |
| 1137 | <middlemouse> (gvim only) same as P selecting word under mouse; |
| 1138 | see |netrw-P| |
| 1139 | <rightmouse> (gvim only) delete file/directory using word under |
| 1140 | mouse |
| 1141 | <2-leftmouse> (gvim only) when: |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1142 | * in a netrw-selected file, AND |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1143 | * |g:netrw_retmap| == 1 AND |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1144 | * the user doesn't already have a <2-leftmouse> |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 1145 | mapping defined before netrw is autoloaded, |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1146 | then a double clicked leftmouse button will return |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1147 | to the netrw browser window. See |g:netrw_retmap|. |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1148 | <s-leftmouse> (gvim only) like mf, will mark files. Dragging |
| 1149 | the shifted leftmouse will mark multiple files. |
| 1150 | (see |netrw-mf|) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1151 | |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 1152 | (to disable mouse buttons while browsing: |g:netrw_mousemaps|) |
| 1153 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1154 | *netrw-quickcom* *netrw-quickcoms* |
| 1155 | QUICK REFERENCE: COMMANDS *netrw-explore-cmds* *netrw-browse-cmds* {{{2 |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1156 | :NetrwClean[!]............................................|netrw-clean| |
| 1157 | :NetrwSettings............................................|netrw-settings| |
| 1158 | :Ntree....................................................|netrw-ntree| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1159 | :Explore[!] [dir] Explore directory of current file......|netrw-explore| |
| 1160 | :Hexplore[!] [dir] Horizontal Split & Explore.............|netrw-explore| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1161 | :Lexplore[!] [dir] Left Explorer Toggle...................|netrw-explore| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1162 | :Nexplore[!] [dir] Vertical Split & Explore...............|netrw-explore| |
| 1163 | :Pexplore[!] [dir] Vertical Split & Explore...............|netrw-explore| |
| 1164 | :Rexplore Return to Explorer.....................|netrw-explore| |
| 1165 | :Sexplore[!] [dir] Split & Explore directory .............|netrw-explore| |
| 1166 | :Texplore[!] [dir] Tab & Explore..........................|netrw-explore| |
| 1167 | :Vexplore[!] [dir] Vertical Split & Explore...............|netrw-explore| |
| 1168 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 1169 | |
| 1170 | BANNER DISPLAY *netrw-I* |
| 1171 | |
| 1172 | One may toggle the banner display on and off by pressing "I". |
| 1173 | |
| 1174 | Also See: |g:netrw_banner| |
| 1175 | |
| 1176 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1177 | BOOKMARKING A DIRECTORY *netrw-mb* *netrw-bookmark* *netrw-bookmarks* {{{2 |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1178 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1179 | One may easily "bookmark" the currently browsed directory by using > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1180 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1181 | mb |
Bram Moolenaar | f6cf987 | 2005-08-08 22:00:59 +0000 | [diff] [blame] | 1182 | < |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1183 | *.netrwbook* |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1184 | Bookmarks are retained in between sessions in a $HOME/.netrwbook file, and are |
| 1185 | kept in sorted order. |
| 1186 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1187 | If there are marked files and/or directories, mb will add them to the bookmark |
| 1188 | list. |
| 1189 | |
| 1190 | *netrw-:NetrwMB* |
| 1191 | Addtionally, one may use :NetrwMB to bookmark files or directories. > |
| 1192 | |
| 1193 | :NetrwMB[!] [files/directories] |
| 1194 | |
| 1195 | < No bang: enters files/directories into Netrw's bookmark system |
| 1196 | |
| 1197 | No argument and in netrw buffer: |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1198 | if there are marked files : bookmark marked files |
| 1199 | otherwise : bookmark file/directory under cursor |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1200 | No argument and not in netrw buffer: bookmarks current open file |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1201 | Has arguments : |glob()|s each arg and bookmarks them |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1202 | |
| 1203 | With bang: deletes files/directories from Netrw's bookmark system |
| 1204 | |
| 1205 | The :NetrwMB command is available outside of netrw buffers (once netrw has been |
| 1206 | invoked in the session). |
| 1207 | |
| 1208 | The file ".netrwbook" holds bookmarks when netrw (and vim) is not active. By |
| 1209 | default, its stored on the first directory on the user's |'runtimepath'|. |
| 1210 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1211 | Related Topics: |
| 1212 | |netrw-gb| how to return (go) to a bookmark |
| 1213 | |netrw-mB| how to delete bookmarks |
| 1214 | |netrw-qb| how to list bookmarks |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1215 | |g:netrw_home| controls where .netrwbook is kept |
Bram Moolenaar | 4a85b41 | 2006-04-23 22:40:29 +0000 | [diff] [blame] | 1216 | |
| 1217 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 1218 | BROWSING *netrw-enter* *netrw-cr* {{{2 |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1219 | |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 1220 | Browsing is simple: move the cursor onto a file or directory of interest. |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 1221 | Hitting the <cr> (the return key) will select the file or directory. |
| 1222 | Directories will themselves be listed, and files will be opened using the |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1223 | protocol given in the original read request. |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 1224 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1225 | CAVEAT: There are four forms of listing (see |netrw-i|). Netrw assumes that |
| 1226 | two or more spaces delimit filenames and directory names for the long and |
| 1227 | wide listing formats. Thus, if your filename or directory name has two or |
| 1228 | more sequential spaces embedded in it, or any trailing spaces, then you'll |
| 1229 | need to use the "thin" format to select it. |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 1230 | |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 1231 | The |g:netrw_browse_split| option, which is zero by default, may be used to |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1232 | cause the opening of files to be done in a new window or tab instead of the |
| 1233 | default. When the option is one or two, the splitting will be taken |
| 1234 | horizontally or vertically, respectively. When the option is set to three, a |
| 1235 | <cr> will cause the file to appear in a new tab. |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 1236 | |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 1237 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1238 | When using the gui (gvim), one may select a file by pressing the <leftmouse> |
| 1239 | button. In addition, if |
Bram Moolenaar | 578b49e | 2005-09-10 19:22:57 +0000 | [diff] [blame] | 1240 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1241 | * |g:netrw_retmap| == 1 AND (its default value is 0) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1242 | * in a netrw-selected file, AND |
| 1243 | * the user doesn't already have a <2-leftmouse> mapping defined before |
| 1244 | netrw is loaded |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 1245 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1246 | then a doubly-clicked leftmouse button will return to the netrw browser |
| 1247 | window. |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 1248 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1249 | Netrw attempts to speed up browsing, especially for remote browsing where one |
| 1250 | may have to enter passwords, by keeping and re-using previously obtained |
| 1251 | directory listing buffers. The |g:netrw_fastbrowse| variable is used to |
| 1252 | control this behavior; one may have slow browsing (no buffer re-use), medium |
| 1253 | speed browsing (re-use directory buffer listings only for remote directories), |
| 1254 | and fast browsing (re-use directory buffer listings as often as possible). |
| 1255 | The price for such re-use is that when changes are made (such as new files |
| 1256 | are introduced into a directory), the listing may become out-of-date. One may |
| 1257 | always refresh directory listing buffers by pressing ctrl-L (see |
| 1258 | |netrw-ctrl-l|). |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 1259 | |
| 1260 | *netrw-s-cr* |
| 1261 | Squeezing the Current Tree-Listing Directory~ |
| 1262 | |
| 1263 | When the tree listing style is enabled (see |netrw-i|) and one is using |
| 1264 | gvim, then the <s-cr> mapping may be used to squeeze (close) the |
| 1265 | directory currently containing the cursor. |
| 1266 | |
| 1267 | Otherwise, one may remap a key combination of one's own choice to get |
| 1268 | this effect: > |
| 1269 | |
| 1270 | nmap <buffer> <silent> <nowait> YOURKEYCOMBO <Plug>NetrwTreeSqueeze |
| 1271 | < |
| 1272 | Put this line in $HOME/ftplugin/netrw/netrw.vim; it needs to be generated |
| 1273 | for netrw buffers only. |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1274 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1275 | Related topics: |
| 1276 | |netrw-ctrl-r| |netrw-o| |netrw-p| |
| 1277 | |netrw-P| |netrw-t| |netrw-v| |
| 1278 | Associated setting variables: |
| 1279 | |g:netrw_browse_split| |g:netrw_fastbrowse| |
| 1280 | |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd| |
| 1281 | |g:netrw_ftp_timelist_cmd| |g:netrw_ssh_browse_reject| |
| 1282 | |g:netrw_ssh_cmd| |g:netrw_use_noswf| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1283 | |
| 1284 | |
| 1285 | BROWSING WITH A HORIZONTALLY SPLIT WINDOW *netrw-o* *netrw-horiz* {{{2 |
| 1286 | |
| 1287 | Normally one enters a file or directory using the <cr>. However, the "o" map |
| 1288 | allows one to open a new window to hold the new directory listing or file. A |
| 1289 | horizontal split is used. (for vertical splitting, see |netrw-v|) |
| 1290 | |
| 1291 | Normally, the o key splits the window horizontally with the new window and |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 1292 | cursor at the top. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1293 | |
| 1294 | Associated setting variables: |g:netrw_alto| |g:netrw_winsize| |
| 1295 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1296 | Related topics: |
| 1297 | |netrw-ctrl-r| |netrw-o| |netrw-p| |
| 1298 | |netrw-P| |netrw-t| |netrw-v| |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 1299 | Associated setting variables: |
| 1300 | |g:netrw_alto| control above/below splitting |
| 1301 | |g:netrw_winsize| control initial sizing |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1302 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1303 | BROWSING WITH A NEW TAB *netrw-t* {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1304 | |
| 1305 | Normally one enters a file or directory using the <cr>. The "t" map |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1306 | allows one to open a new window holding the new directory listing or file in |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 1307 | a new tab. |
| 1308 | |
| 1309 | If you'd like to have the new listing in a background tab, use |gT|. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1310 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1311 | Related topics: |
| 1312 | |netrw-ctrl-r| |netrw-o| |netrw-p| |
| 1313 | |netrw-P| |netrw-t| |netrw-v| |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 1314 | Associated setting variables: |
| 1315 | |g:netrw_winsize| control initial sizing |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1316 | |
| 1317 | BROWSING WITH A VERTICALLY SPLIT WINDOW *netrw-v* {{{2 |
| 1318 | |
| 1319 | Normally one enters a file or directory using the <cr>. However, the "v" map |
| 1320 | allows one to open a new window to hold the new directory listing or file. A |
| 1321 | vertical split is used. (for horizontal splitting, see |netrw-o|) |
| 1322 | |
| 1323 | Normally, the v key splits the window vertically with the new window and |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 1324 | cursor at the left. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1325 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1326 | There is only one tree listing buffer; using "v" on a displayed subdirectory |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1327 | will split the screen, but the same buffer will be shown twice. |
| 1328 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1329 | Related topics: |
| 1330 | |netrw-ctrl-r| |netrw-o| |netrw-p| |
| 1331 | |netrw-P| |netrw-t| |netrw-v| |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 1332 | Associated setting variables: |
| 1333 | |g:netrw_altv| control right/left splitting |
| 1334 | |g:netrw_winsize| control initial sizing |
| 1335 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1336 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1337 | BROWSING USING A GVIM SERVER *netrw-ctrl-r* {{{2 |
| 1338 | |
| 1339 | One may keep a browsing gvim separate from the gvim being used to edit. |
| 1340 | Use the <c-r> map on a file (not a directory) in the netrw browser, and it |
| 1341 | will use a gvim server (see |g:netrw_servername|). Subsequent use of <cr> |
| 1342 | (see |netrw-cr|) will re-use that server for editing files. |
| 1343 | |
| 1344 | Related topics: |
| 1345 | |netrw-ctrl-r| |netrw-o| |netrw-p| |
| 1346 | |netrw-P| |netrw-t| |netrw-v| |
| 1347 | Associated setting variables: |
| 1348 | |g:netrw_servername| : sets name of server |
| 1349 | |g:netrw_browse_split| : controls how <cr> will open files |
| 1350 | |
| 1351 | |
| 1352 | CHANGE LISTING STYLE (THIN LONG WIDE TREE) *netrw-i* {{{2 |
Bram Moolenaar | 578b49e | 2005-09-10 19:22:57 +0000 | [diff] [blame] | 1353 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1354 | The "i" map cycles between the thin, long, wide, and tree listing formats. |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1355 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1356 | The thin listing format gives just the files' and directories' names. |
Bram Moolenaar | 578b49e | 2005-09-10 19:22:57 +0000 | [diff] [blame] | 1357 | |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 1358 | The long listing is either based on the "ls" command via ssh for remote |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 1359 | directories or displays the filename, file size (in bytes), and the time and |
| 1360 | date of last modification for local directories. With the long listing |
| 1361 | format, netrw is not able to recognize filenames which have trailing spaces. |
| 1362 | Use the thin listing format for such files. |
Bram Moolenaar | 578b49e | 2005-09-10 19:22:57 +0000 | [diff] [blame] | 1363 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1364 | The wide listing format uses two or more contiguous spaces to delineate |
| 1365 | filenames; when using that format, netrw won't be able to recognize or use |
| 1366 | filenames which have two or more contiguous spaces embedded in the name or any |
| 1367 | trailing spaces. The thin listing format will, however, work with such files. |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1368 | The wide listing format is the most compact. |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1369 | |
| 1370 | The tree listing format has a top directory followed by files and directories |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1371 | preceded by one or more "|"s, which indicate the directory depth. One may |
| 1372 | open and close directories by pressing the <cr> key while atop the directory |
| 1373 | name. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1374 | |
| 1375 | One may make a preferred listing style your default; see |g:netrw_liststyle|. |
| 1376 | As an example, by putting the following line in your .vimrc, > |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1377 | let g:netrw_liststyle= 3 |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1378 | the tree style will become your default listing style. |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 1379 | |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 1380 | One typical way to use the netrw tree display is to: > |
| 1381 | |
| 1382 | vim . |
| 1383 | (use i until a tree display shows) |
| 1384 | navigate to a file |
| 1385 | v (edit as desired in vertically split window) |
| 1386 | ctrl-w h (to return to the netrw listing) |
| 1387 | P (edit newly selected file in the previous window) |
| 1388 | ctrl-w h (to return to the netrw listing) |
| 1389 | P (edit newly selected file in the previous window) |
| 1390 | ...etc... |
| 1391 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1392 | Associated setting variables: |g:netrw_liststyle| |g:netrw_maxfilenamelen| |
| 1393 | |g:netrw_timefmt| |g:netrw_list_cmd| |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 1394 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1395 | CHANGE FILE PERMISSION *netrw-gp* {{{2 |
| 1396 | |
| 1397 | "gp" will ask you for a new permission for the file named under the cursor. |
| 1398 | Currently, this only works for local files. |
| 1399 | |
| 1400 | Associated setting variables: |g:netrw_chgperm| |
| 1401 | |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 1402 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1403 | CHANGING TO A BOOKMARKED DIRECTORY *netrw-gb* {{{2 |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 1404 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1405 | To change directory back to a bookmarked directory, use |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 1406 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1407 | {cnt}gb |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 1408 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1409 | Any count may be used to reference any of the bookmarks. |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 1410 | Note that |netrw-qb| shows both bookmarks and history; to go |
| 1411 | to a location stored in the history see |netrw-u| and |netrw-U|. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1412 | |
| 1413 | Related Topics: |
| 1414 | |netrw-mB| how to delete bookmarks |
| 1415 | |netrw-mb| how to make a bookmark |
| 1416 | |netrw-qb| how to list bookmarks |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 1417 | |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 1418 | |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 1419 | CHANGING TO A PREDECESSOR DIRECTORY *netrw-u* *netrw-updir* {{{2 |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 1420 | |
| 1421 | Every time you change to a new directory (new for the current session), |
| 1422 | netrw will save the directory in a recently-visited directory history |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 1423 | list (unless |g:netrw_dirhistmax| is zero; by default, it's ten). With the |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 1424 | "u" map, one can change to an earlier directory (predecessor). To do |
| 1425 | the opposite, see |netrw-U|. |
| 1426 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 1427 | The "u" map also accepts counts to go back in the history several slots. |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1428 | For your convenience, qb (see |netrw-qb|) lists the history number which may |
| 1429 | be used in that count. |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 1430 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1431 | *.netrwhist* |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 1432 | See |g:netrw_dirhistmax| for how to control the quantity of history stack |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1433 | slots. The file ".netrwhist" holds history when netrw (and vim) is not |
| 1434 | active. By default, its stored on the first directory on the user's |
| 1435 | |'runtimepath'|. |
| 1436 | |
| 1437 | Related Topics: |
| 1438 | |netrw-U| changing to a successor directory |
| 1439 | |g:netrw_home| controls where .netrwhist is kept |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 1440 | |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 1441 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1442 | CHANGING TO A SUCCESSOR DIRECTORY *netrw-U* *netrw-downdir* {{{2 |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 1443 | |
| 1444 | With the "U" map, one can change to a later directory (successor). |
| 1445 | This map is the opposite of the "u" map. (see |netrw-u|) Use the |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1446 | qb map to list both the bookmarks and history. (see |netrw-qb|) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1447 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 1448 | The "U" map also accepts counts to go forward in the history several slots. |
| 1449 | |
| 1450 | See |g:netrw_dirhistmax| for how to control the quantity of history stack |
| 1451 | slots. |
| 1452 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1453 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1454 | CHANGING TREE TOP *netrw-ntree* *:Ntree* *netrw-gn* {{{2 |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1455 | |
| 1456 | One may specify a new tree top for tree listings using > |
| 1457 | |
| 1458 | :Ntree [dirname] |
| 1459 | |
| 1460 | Without a "dirname", the current line is used (and any leading depth |
| 1461 | information is elided). |
| 1462 | With a "dirname", the specified directory name is used. |
| 1463 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1464 | The "gn" map will take the word below the cursor and use that for |
| 1465 | changing the top of the tree listing. |
| 1466 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1467 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1468 | NETRW CLEAN *netrw-clean* *:NetrwClean* {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1469 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1470 | With NetrwClean one may easily remove netrw from one's home directory; |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1471 | more precisely, from the first directory on your |'runtimepath'|. |
| 1472 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1473 | With NetrwClean!, netrw will attempt to remove netrw from all directories on |
| 1474 | your |'runtimepath'|. Of course, you have to have write/delete permissions |
| 1475 | correct to do this. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1476 | |
| 1477 | With either form of the command, netrw will first ask for confirmation |
| 1478 | that the removal is in fact what you want to do. If netrw doesn't have |
| 1479 | permission to remove a file, it will issue an error message. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 1480 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1481 | *netrw-gx* |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1482 | CUSTOMIZING BROWSING WITH A SPECIAL HANDLER *netrw-x* *netrw-handler* {{{2 |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1483 | (also see |netrw_filehandler|) |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1484 | |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 1485 | Certain files, such as html, gif, jpeg, (word/office) doc, etc, files, are |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1486 | best seen with a special handler (ie. a tool provided with your computer's |
| 1487 | operating system). Netrw allows one to invoke such special handlers by: > |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 1488 | |
| 1489 | * when Exploring, hit the "x" key |
| 1490 | * when editing, hit gx with the cursor atop the special filename |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1491 | < (latter not available if the |g:netrw_nogx| variable exists) |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1492 | |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 1493 | Netrw determines which special handler by the following method: |
| 1494 | |
| 1495 | * if |g:netrw_browsex_viewer| exists, then it will be used to attempt to |
| 1496 | view files. Examples of useful settings (place into your <.vimrc>): > |
| 1497 | |
| 1498 | :let g:netrw_browsex_viewer= "kfmclient exec" |
| 1499 | < or > |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1500 | :let g:netrw_browsex_viewer= "xdg-open" |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 1501 | < |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1502 | If g:netrw_browsex_viewer == '-', then netrwFileHandlers#Invoke() will be |
| 1503 | used instead (see |netrw_filehandler|). |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1504 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1505 | * for Windows 32 or 64, the url and FileProtocolHandler dlls are used. |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 1506 | * for Gnome (with gnome-open): gnome-open is used. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1507 | * for KDE (with kfmclient) : kfmclient is used |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1508 | * for Mac OS X : open is used. |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 1509 | * otherwise the netrwFileHandler plugin is used. |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 1510 | |
| 1511 | The file's suffix is used by these various approaches to determine an |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 1512 | appropriate application to use to "handle" these files. Such things as |
| 1513 | OpenOffice (*.sfx), visualization (*.jpg, *.gif, etc), and PostScript (*.ps, |
| 1514 | *.eps) can be handled. |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 1515 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1516 | The gx mapping extends to all buffers; apply "gx" while atop a word and netrw |
| 1517 | will apply a special handler to it (like "x" works when in a netrw buffer). |
| 1518 | One may also use visual mode (see |visual-start|) to select the text that the |
| 1519 | special handler will use. Normally gx uses expand("<cfile>") to pick up the |
| 1520 | text under the cursor; one may change what |expand()| uses via the |
| 1521 | |g:netrw_gx| variable. Alternatively, one may select the text to be used by |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 1522 | gx via first making a visual selection (see |visual-block|) or by changing |
| 1523 | the |'isfname'| option (which is global, so netrw doesn't modify it). |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1524 | |
| 1525 | Associated setting variables: |
| 1526 | |g:netrw_gx| control how gx picks up the text under the cursor |
| 1527 | |g:netrw_nogx| prevent gx map while editing |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame^] | 1528 | |g:netrw_suppress_gx_mesg| controls gx's suppression of browser messages |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1529 | |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 1530 | *netrw_filehandler* |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1531 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1532 | When |g:netrw_browsex_viewer| exists and is "-", then netrw will attempt to |
| 1533 | handle the special file with a vim function. The "x" map applies a function |
| 1534 | to a file, based on its extension. Of course, the handler function must exist |
| 1535 | for it to be called! |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1536 | > |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1537 | Ex. mypgm.html x -> NFH_html("scp://user@host/some/path/mypgm.html") |
| 1538 | |
| 1539 | < Users may write their own netrw File Handler functions to |
| 1540 | support more suffixes with special handling. See |
| 1541 | <autoload/netrwFileHandlers.vim> for examples on how to make |
| 1542 | file handler functions. As an example: > |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1543 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1544 | " NFH_suffix(filename) |
| 1545 | fun! NFH_suffix(filename) |
| 1546 | ..do something special with filename.. |
| 1547 | endfun |
| 1548 | < |
| 1549 | These functions need to be defined in some file in your .vim/plugin |
| 1550 | (vimfiles\plugin) directory. Vim's function names may not have punctuation |
| 1551 | characters (except for the underscore) in them. To support suffices that |
| 1552 | contain such characters, netrw will first convert the suffix using the |
| 1553 | following table: > |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 1554 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1555 | @ -> AT ! -> EXCLAMATION % -> PERCENT |
| 1556 | : -> COLON = -> EQUAL ? -> QUESTION |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1557 | , -> COMMA - -> MINUS ; -> SEMICOLON |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1558 | $ -> DOLLAR + -> PLUS ~ -> TILDE |
| 1559 | < |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1560 | So, for example: > |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 1561 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1562 | file.rcs,v -> NFH_rcsCOMMAv() |
| 1563 | < |
| 1564 | If more such translations are necessary, please send me email: > |
| 1565 | NdrOchip at ScampbellPfamily.AbizM - NOSPAM |
| 1566 | with a request. |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 1567 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1568 | Associated setting variable: |g:netrw_browsex_viewer| |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1569 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1570 | *netrw-curdir* |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1571 | DELETING BOOKMARKS *netrw-mB* {{{2 |
| 1572 | |
| 1573 | To delete a bookmark, use > |
| 1574 | |
| 1575 | {cnt}mB |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1576 | |
| 1577 | If there are marked files, then mB will remove them from the |
| 1578 | bookmark list. |
| 1579 | |
| 1580 | Alternatively, one may use :NetrwMB! (see |netrw-:NetrwMB|). > |
| 1581 | |
| 1582 | :NetrwMB! [files/directories] |
| 1583 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1584 | Related Topics: |
| 1585 | |netrw-gb| how to return (go) to a bookmark |
| 1586 | |netrw-mb| how to make a bookmark |
| 1587 | |netrw-qb| how to list bookmarks |
| 1588 | |
| 1589 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1590 | DELETING FILES OR DIRECTORIES *netrw-delete* *netrw-D* *netrw-del* {{{2 |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 1591 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1592 | If files have not been marked with |netrw-mf|: (local marked file list) |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 1593 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1594 | Deleting/removing files and directories involves moving the cursor to the |
| 1595 | file/directory to be deleted and pressing "D". Directories must be empty |
| 1596 | first before they can be successfully removed. If the directory is a |
| 1597 | softlink to a directory, then netrw will make two requests to remove the |
| 1598 | directory before succeeding. Netrw will ask for confirmation before doing |
| 1599 | the removal(s). You may select a range of lines with the "V" command |
| 1600 | (visual selection), and then pressing "D". |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1601 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1602 | If files have been marked with |netrw-mf|: (local marked file list) |
| 1603 | |
| 1604 | Marked files (and empty directories) will be deleted; again, you'll be |
| 1605 | asked to confirm the deletion before it actually takes place. |
| 1606 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1607 | A further approach is to delete files which match a pattern. |
| 1608 | |
| 1609 | * use :MF pattern (see |netrw-:MF|); then press "D". |
| 1610 | |
| 1611 | * use mr (see |netrw-mr|) which will prompt you for pattern. |
| 1612 | This will cause the matching files to be marked. Then, |
| 1613 | press "D". |
| 1614 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1615 | The |g:netrw_rm_cmd|, |g:netrw_rmf_cmd|, and |g:netrw_rmdir_cmd| variables are |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1616 | used to control the attempts to remove remote files and directories. The |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1617 | g:netrw_rm_cmd is used with files, and its default value is: |
| 1618 | |
| 1619 | g:netrw_rm_cmd: ssh HOSTNAME rm |
| 1620 | |
| 1621 | The g:netrw_rmdir_cmd variable is used to support the removal of directories. |
| 1622 | Its default value is: |
| 1623 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1624 | |g:netrw_rmdir_cmd|: ssh HOSTNAME rmdir |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1625 | |
| 1626 | If removing a directory fails with g:netrw_rmdir_cmd, netrw then will attempt |
| 1627 | to remove it again using the g:netrw_rmf_cmd variable. Its default value is: |
| 1628 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1629 | |g:netrw_rmf_cmd|: ssh HOSTNAME rm -f |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1630 | |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 1631 | Related topics: |netrw-d| |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 1632 | Associated setting variable: |g:netrw_localrmdir| |g:netrw_rm_cmd| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1633 | |g:netrw_rmdir_cmd| |g:netrw_ssh_cmd| |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 1634 | |
| 1635 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1636 | *netrw-explore* *netrw-hexplore* *netrw-nexplore* *netrw-pexplore* |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1637 | *netrw-rexplore* *netrw-sexplore* *netrw-texplore* *netrw-vexplore* *netrw-lexplore* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1638 | DIRECTORY EXPLORATION COMMANDS {{{2 |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 1639 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1640 | :[N]Explore[!] [dir]... Explore directory of current file *:Explore* |
| 1641 | :[N]Hexplore[!] [dir]... Horizontal Split & Explore *:Hexplore* |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1642 | :[N]Lexplore[!] [dir]... Left Explorer Toggle *:Lexplore* |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1643 | :[N]Sexplore[!] [dir]... Split&Explore current file's directory *:Sexplore* |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1644 | :[N]Vexplore[!] [dir]... Vertical Split & Explore *:Vexplore* |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1645 | :Texplore [dir]... Tab & Explore *:Texplore* |
| 1646 | :Rexplore ... Return to/from Explorer *:Rexplore* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1647 | |
| 1648 | Used with :Explore **/pattern : (also see |netrw-starstar|) |
| 1649 | :Nexplore............. go to next matching file *:Nexplore* |
| 1650 | :Pexplore............. go to previous matching file *:Pexplore* |
| 1651 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1652 | *netrw-:Explore* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1653 | :Explore will open the local-directory browser on the current file's |
| 1654 | directory (or on directory [dir] if specified). The window will be |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1655 | split only if the file has been modified and |'hidden'| is not set, |
| 1656 | otherwise the browsing window will take over that window. Normally |
| 1657 | the splitting is taken horizontally. |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1658 | Also see: |netrw-:Rexplore| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1659 | :Explore! is like :Explore, but will use vertical splitting. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1660 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1661 | *netrw-:Hexplore* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1662 | :Hexplore [dir] does an :Explore with |:belowright| horizontal splitting. |
| 1663 | :Hexplore! [dir] does an :Explore with |:aboveleft| horizontal splitting. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1664 | |
| 1665 | *netrw-:Lexplore* |
| 1666 | :[N]Lexplore [dir] toggles a full height Explorer window on the left hand side |
| 1667 | of the current tab. It will open a netrw window on the current |
| 1668 | directory if [dir] is omitted; a :Lexplore [dir] will show the |
| 1669 | specified directory in the left-hand side browser display no matter |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1670 | from which window the command is issued. |
| 1671 | |
| 1672 | By default, :Lexplore will change an uninitialized |g:netrw_chgwin| |
| 1673 | to 2; edits will thus preferentially be made in window#2. |
| 1674 | |
| 1675 | The [N] specifies a |g:netrw_winsize| just for the new :Lexplore |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1676 | window. |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1677 | |
| 1678 | Those who like this method often also often like tree style displays; |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1679 | see |g:netrw_liststyle|. |
| 1680 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1681 | Also see: |netrw-C| |g:netrw_browse_split| |g:netrw_wiw| |
| 1682 | |netrw-p| |netrw-P| |g:netrw_chgwin| |
| 1683 | |netrw-c-tab| |g:netrw_winsize| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1684 | |
| 1685 | :[N]Lexplore! is like :Lexplore, except that the full-height Explorer window |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 1686 | will open on the right hand side and an uninitialized |g:netrw_chgwin| |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1687 | will be set to 1. |
| 1688 | |
| 1689 | *netrw-:Sexplore* |
| 1690 | :[N]Sexplore will always split the window before invoking the local-directory |
| 1691 | browser. As with Explore, the splitting is normally done |
| 1692 | horizontally. |
| 1693 | :[N]Sexplore! [dir] is like :Sexplore, but the splitting will be done vertically. |
| 1694 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1695 | *netrw-:Texplore* |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1696 | :Texplore [dir] does a |:tabnew| before generating the browser window |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1697 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1698 | *netrw-:Vexplore* |
| 1699 | :[N]Vexplore [dir] does an :Explore with |:leftabove| vertical splitting. |
| 1700 | :[N]Vexplore! [dir] does an :Explore with |:rightbelow| vertical splitting. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1701 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1702 | The optional parameters are: |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1703 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1704 | [N]: This parameter will override |g:netrw_winsize| to specify the quantity of |
| 1705 | rows and/or columns the new explorer window should have. |
| 1706 | Otherwise, the |g:netrw_winsize| variable, if it has been specified by the |
| 1707 | user, is used to control the quantity of rows and/or columns new |
| 1708 | explorer windows should have. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1709 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1710 | [dir]: By default, these explorer commands use the current file's directory. |
| 1711 | However, one may explicitly provide a directory (path) to use instead; |
| 1712 | ie. > |
| 1713 | |
| 1714 | :Explore /some/path |
| 1715 | < |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1716 | *netrw-:Rexplore* |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1717 | :Rexplore This command is a little different from the other Explore commands |
| 1718 | as it doesn't necessarily open an Explorer window. |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1719 | |
| 1720 | Return to Explorer~ |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1721 | When one edits a file using netrw which can occur, for example, |
| 1722 | when pressing <cr> while the cursor is atop a filename in a netrw |
| 1723 | browser window, a :Rexplore issued while editing that file will |
| 1724 | return the display to that of the last netrw browser display in |
| 1725 | that window. |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1726 | |
| 1727 | Return from Explorer~ |
| 1728 | Conversely, when one is editing a directory, issuing a :Rexplore |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 1729 | will return to editing the file that was last edited in that |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1730 | window. |
| 1731 | |
| 1732 | The <2-leftmouse> map (which is only available under gvim and |
| 1733 | cooperative terms) does the same as :Rexplore. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1734 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1735 | Also see: |g:netrw_alto| |g:netrw_altv| |g:netrw_winsize| |
| 1736 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1737 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1738 | *netrw-star* *netrw-starpat* *netrw-starstar* *netrw-starstarpat* *netrw-grep* |
| 1739 | EXPLORING WITH STARS AND PATTERNS {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1740 | |
| 1741 | When Explore, Sexplore, Hexplore, or Vexplore are used with one of the |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 1742 | following four patterns Explore generates a list of files which satisfy the |
| 1743 | request for the local file system. These exploration patterns will not work |
| 1744 | with remote file browsing. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1745 | |
| 1746 | */filepat files in current directory which satisfy filepat |
| 1747 | **/filepat files in current directory or below which satisfy the |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1748 | file pattern |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1749 | *//pattern files in the current directory which contain the |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1750 | pattern (vimgrep is used) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1751 | **//pattern files in the current directory or below which contain |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1752 | the pattern (vimgrep is used) |
Bram Moolenaar | 572cb56 | 2005-08-05 21:35:02 +0000 | [diff] [blame] | 1753 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1754 | The cursor will be placed on the first file in the list. One may then |
| 1755 | continue to go to subsequent files on that list via |:Nexplore| or to |
| 1756 | preceding files on that list with |:Pexplore|. Explore will update the |
| 1757 | directory and place the cursor appropriately. |
| 1758 | |
| 1759 | A plain > |
| 1760 | :Explore |
| 1761 | will clear the explore list. |
| 1762 | |
| 1763 | If your console or gui produces recognizable shift-up or shift-down sequences, |
| 1764 | then you'll likely find using shift-downarrow and shift-uparrow convenient. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1765 | They're mapped by netrw as follows: |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1766 | |
| 1767 | <s-down> == Nexplore, and |
| 1768 | <s-up> == Pexplore. |
| 1769 | |
| 1770 | As an example, consider |
| 1771 | > |
| 1772 | :Explore */*.c |
| 1773 | :Nexplore |
| 1774 | :Nexplore |
| 1775 | :Pexplore |
| 1776 | < |
| 1777 | The status line will show, on the right hand side of the status line, a |
| 1778 | message like "Match 3 of 20". |
| 1779 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1780 | Associated setting variables: |
| 1781 | |g:netrw_keepdir| |g:netrw_browse_split| |
| 1782 | |g:netrw_fastbrowse| |g:netrw_ftp_browse_reject| |
| 1783 | |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd| |
| 1784 | |g:netrw_ftp_timelist_cmd| |g:netrw_list_cmd| |
| 1785 | |g:netrw_liststyle| |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 1786 | |
| 1787 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1788 | DISPLAYING INFORMATION ABOUT FILE *netrw-qf* {{{2 |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 1789 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1790 | With the cursor atop a filename, pressing "qf" will reveal the file's size |
| 1791 | and last modification timestamp. Currently this capability is only available |
| 1792 | for local files. |
Bram Moolenaar | 578b49e | 2005-09-10 19:22:57 +0000 | [diff] [blame] | 1793 | |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 1794 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1795 | EDIT FILE OR DIRECTORY HIDING LIST *netrw-ctrl-h* *netrw-edithide* {{{2 |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 1796 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1797 | The "<ctrl-h>" map brings up a requestor allowing the user to change the |
| 1798 | file/directory hiding list contained in |g:netrw_list_hide|. The hiding list |
| 1799 | consists of one or more patterns delimited by commas. Files and/or |
| 1800 | directories satisfying these patterns will either be hidden (ie. not shown) or |
| 1801 | be the only ones displayed (see |netrw-a|). |
| 1802 | |
| 1803 | The "gh" mapping (see |netrw-gh|) quickly alternates between the usual |
| 1804 | hiding list and the hiding of files or directories that begin with ".". |
| 1805 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1806 | As an example, > |
| 1807 | let g:netrw_list_hide= '\(^\|\s\s\)\zs\.\S\+' |
| 1808 | Effectively, this makes the effect of a |netrw-gh| command the initial setting. |
| 1809 | What it means: |
| 1810 | |
| 1811 | \(^\|\s\s\) : if the line begins with the following, -or- |
| 1812 | two consecutive spaces are encountered |
| 1813 | \zs : start the hiding match now |
| 1814 | \. : if it now begins with a dot |
| 1815 | \S\+ : and is followed by one or more non-whitespace |
| 1816 | characters |
| 1817 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1818 | Associated setting variables: |g:netrw_hide| |g:netrw_list_hide| |
| 1819 | Associated topics: |netrw-a| |netrw-gh| |netrw-mh| |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 1820 | |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 1821 | *netrw-sort-sequence* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1822 | EDITING THE SORTING SEQUENCE *netrw-S* *netrw-sortsequence* {{{2 |
| 1823 | |
| 1824 | When "Sorted by" is name, one may specify priority via the sorting sequence |
| 1825 | (g:netrw_sort_sequence). The sorting sequence typically prioritizes the |
| 1826 | name-listing by suffix, although any pattern will do. Patterns are delimited |
| 1827 | by commas. The default sorting sequence is (all one line): |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1828 | |
| 1829 | For Unix: > |
| 1830 | '[\/]$,\<core\%(\.\d\+\)\=,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$, |
| 1831 | \.info$,\.swp$,\.bak$,\~$' |
| 1832 | < |
| 1833 | Otherwise: > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1834 | '[\/]$,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$,\.info$, |
| 1835 | \.swp$,\.bak$,\~$' |
| 1836 | < |
| 1837 | The lone * is where all filenames not covered by one of the other patterns |
| 1838 | will end up. One may change the sorting sequence by modifying the |
| 1839 | g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by |
| 1840 | using the "S" map. |
| 1841 | |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 1842 | Related topics: |netrw-s| |netrw-S| |
| 1843 | Associated setting variables: |g:netrw_sort_sequence| |g:netrw_sort_options| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1844 | |
| 1845 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1846 | EXECUTING FILE UNDER CURSOR VIA SYSTEM() *netrw-X* {{{2 |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 1847 | |
| 1848 | Pressing X while the cursor is atop an executable file will yield a prompt |
| 1849 | using the filename asking for any arguments. Upon pressing a [return], netrw |
| 1850 | will then call |system()| with that command and arguments. The result will |
| 1851 | be displayed by |:echomsg|, and so |:messages| will repeat display of the |
| 1852 | result. Ansi escape sequences will be stripped out. |
| 1853 | |
| 1854 | |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 1855 | FORCING TREATMENT AS A FILE OR DIRECTORY *netrw-gd* *netrw-gf* {{{2 |
| 1856 | |
| 1857 | Remote symbolic links (ie. those listed via ssh or ftp) are problematic |
| 1858 | in that it is difficult to tell whether they link to a file or to a |
| 1859 | directory. |
| 1860 | |
| 1861 | To force treatment as a file: use > |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 1862 | gf |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 1863 | < |
| 1864 | To force treatment as a directory: use > |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 1865 | gd |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 1866 | < |
| 1867 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1868 | GOING UP *netrw--* {{{2 |
| 1869 | |
| 1870 | To go up a directory, press "-" or press the <cr> when atop the ../ directory |
| 1871 | entry in the listing. |
| 1872 | |
| 1873 | Netrw will use the command in |g:netrw_list_cmd| to perform the directory |
| 1874 | listing operation after changing HOSTNAME to the host specified by the |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1875 | user-prpvided url. By default netrw provides the command as: > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1876 | |
| 1877 | ssh HOSTNAME ls -FLa |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 1878 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1879 | where the HOSTNAME becomes the [user@]hostname as requested by the attempt to |
| 1880 | read. Naturally, the user may override this command with whatever is |
| 1881 | preferred. The NetList function which implements remote browsing |
| 1882 | expects that directories will be flagged by a trailing slash. |
| 1883 | |
| 1884 | |
| 1885 | HIDING FILES OR DIRECTORIES *netrw-a* *netrw-hiding* {{{2 |
| 1886 | |
| 1887 | Netrw's browsing facility allows one to use the hiding list in one of three |
| 1888 | ways: ignore it, hide files which match, and show only those files which |
| 1889 | match. |
| 1890 | |
| 1891 | If no files have been marked via |netrw-mf|: |
| 1892 | |
| 1893 | The "a" map allows the user to cycle through the three hiding modes. |
| 1894 | |
| 1895 | The |g:netrw_list_hide| variable holds a comma delimited list of patterns |
| 1896 | based on regular expressions (ex. ^.*\.obj$,^\.) which specify the hiding list. |
| 1897 | (also see |netrw-ctrl-h|) To set the hiding list, use the <c-h> map. As an |
| 1898 | example, to hide files which begin with a ".", one may use the <c-h> map to |
| 1899 | set the hiding list to '^\..*' (or one may put let g:netrw_list_hide= '^\..*' |
| 1900 | in one's <.vimrc>). One may then use the "a" key to show all files, hide |
| 1901 | matching files, or to show only the matching files. |
| 1902 | |
| 1903 | Example: \.[ch]$ |
| 1904 | This hiding list command will hide/show all *.c and *.h files. |
| 1905 | |
| 1906 | Example: \.c$,\.h$ |
| 1907 | This hiding list command will also hide/show all *.c and *.h |
| 1908 | files. |
| 1909 | |
| 1910 | Don't forget to use the "a" map to select the mode (normal/hiding/show) you |
| 1911 | want! |
| 1912 | |
| 1913 | If files have been marked using |netrw-mf|, then this command will: |
| 1914 | |
| 1915 | if showing all files or non-hidden files: |
| 1916 | modify the g:netrw_list_hide list by appending the marked files to it |
| 1917 | and showing only non-hidden files. |
| 1918 | |
| 1919 | else if showing hidden files only: |
| 1920 | modify the g:netrw_list_hide list by removing the marked files from it |
| 1921 | and showing only non-hidden files. |
| 1922 | endif |
| 1923 | |
| 1924 | *netrw-gh* *netrw-hide* |
| 1925 | As a quick shortcut, one may press > |
| 1926 | gh |
| 1927 | to toggle between hiding files which begin with a period (dot) and not hiding |
| 1928 | them. |
| 1929 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1930 | Associated setting variables: |g:netrw_list_hide| |g:netrw_hide| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1931 | Associated topics: |netrw-a| |netrw-ctrl-h| |netrw-mh| |
| 1932 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1933 | *netrw-gitignore* |
| 1934 | Netrw provides a helper function 'netrw_gitignore#Hide()' that, when used with |
| 1935 | |g:netrw_list_hide| automatically hides all git-ignored files. |
| 1936 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1937 | 'netrw_gitignore#Hide' searches for patterns in the following files: > |
| 1938 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1939 | './.gitignore' |
| 1940 | './.git/info/exclude' |
| 1941 | global gitignore file: `git config --global core.excludesfile` |
| 1942 | system gitignore file: `git config --system core.excludesfile` |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1943 | < |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1944 | Files that do not exist, are ignored. |
| 1945 | Git-ignore patterns are taken from existing files, and converted to patterns for |
| 1946 | hiding files. For example, if you had '*.log' in your '.gitignore' file, it |
| 1947 | would be converted to '.*\.log'. |
| 1948 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1949 | To use this function, simply assign its output to |g:netrw_list_hide| option. > |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1950 | |
| 1951 | Example: let g:netrw_list_hide= netrw_gitignore#Hide() |
| 1952 | Git-ignored files are hidden in Netrw. |
| 1953 | |
| 1954 | Example: let g:netrw_list_hide= netrw_gitignore#Hide('my_gitignore_file') |
| 1955 | Function can take additional files with git-ignore patterns. |
| 1956 | |
| 1957 | Example: g:netrw_list_hide= netrw_gitignore#Hide() . '.*\.swp$' |
| 1958 | Combining 'netrw_gitignore#Hide' with custom patterns. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 1959 | < |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 1960 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1961 | IMPROVING BROWSING *netrw-listhack* *netrw-ssh-hack* {{{2 |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1962 | |
| 1963 | Especially with the remote directory browser, constantly entering the password |
| 1964 | is tedious. |
| 1965 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1966 | For Linux/Unix systems, the book "Linux Server Hacks - 100 industrial strength |
Bram Moolenaar | 7aa9f6a | 2007-05-10 18:00:30 +0000 | [diff] [blame] | 1967 | tips & tools" by Rob Flickenger (O'Reilly, ISBN 0-596-00461-3) gives a tip |
| 1968 | for setting up no-password ssh and scp and discusses associated security |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 1969 | issues. It used to be available at http://hacks.oreilly.com/pub/h/66 , |
| 1970 | but apparently that address is now being redirected to some "hackzine". |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 1971 | I'll attempt a summary based on that article and on a communication from |
| 1972 | Ben Schmidt: |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 1973 | |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 1974 | 1. Generate a public/private key pair on the local machine |
| 1975 | (ssh client): > |
| 1976 | ssh-keygen -t rsa |
| 1977 | (saving the file in ~/.ssh/id_rsa as prompted) |
| 1978 | < |
| 1979 | 2. Just hit the <CR> when asked for passphrase (twice) for no |
| 1980 | passphrase. If you do use a passphrase, you will also need to use |
| 1981 | ssh-agent so you only have to type the passphrase once per session. |
| 1982 | If you don't use a passphrase, simply logging onto your local |
| 1983 | computer or getting access to the keyfile in any way will suffice |
| 1984 | to access any ssh servers which have that key authorized for login. |
| 1985 | |
| 1986 | 3. This creates two files: > |
| 1987 | ~/.ssh/id_rsa |
| 1988 | ~/.ssh/id_rsa.pub |
| 1989 | < |
| 1990 | 4. On the target machine (ssh server): > |
| 1991 | cd |
| 1992 | mkdir -p .ssh |
| 1993 | chmod 0700 .ssh |
| 1994 | < |
| 1995 | 5. On your local machine (ssh client): (one line) > |
| 1996 | ssh {serverhostname} |
| 1997 | cat '>>' '~/.ssh/authorized_keys2' < ~/.ssh/id_rsa.pub |
| 1998 | < |
| 1999 | or, for OpenSSH, (one line) > |
| 2000 | ssh {serverhostname} |
| 2001 | cat '>>' '~/.ssh/authorized_keys' < ~/.ssh/id_rsa.pub |
| 2002 | < |
| 2003 | You can test it out with > |
| 2004 | ssh {serverhostname} |
| 2005 | and you should be log onto the server machine without further need to type |
| 2006 | anything. |
| 2007 | |
| 2008 | If you decided to use a passphrase, do: > |
| 2009 | ssh-agent $SHELL |
| 2010 | ssh-add |
| 2011 | ssh {serverhostname} |
| 2012 | You will be prompted for your key passphrase when you use ssh-add, but not |
| 2013 | subsequently when you use ssh. For use with vim, you can use > |
| 2014 | ssh-agent vim |
| 2015 | and, when next within vim, use > |
| 2016 | :!ssh-add |
| 2017 | Alternatively, you can apply ssh-agent to the terminal you're planning on |
| 2018 | running vim in: > |
| 2019 | ssh-agent xterm & |
| 2020 | and do ssh-add whenever you need. |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 2021 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 2022 | For Windows, folks on the vim mailing list have mentioned that Pageant helps |
| 2023 | with avoiding the constant need to enter the password. |
Bram Moolenaar | 433f7c8 | 2006-03-21 21:29:36 +0000 | [diff] [blame] | 2024 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2025 | Kingston Fung wrote about another way to avoid constantly needing to enter |
| 2026 | passwords: |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 2027 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2028 | In order to avoid the need to type in the password for scp each time, you |
| 2029 | provide a hack in the docs to set up a non password ssh account. I found a |
| 2030 | better way to do that: I can use a regular ssh account which uses a |
| 2031 | password to access the material without the need to key-in the password |
| 2032 | each time. It's good for security and convenience. I tried ssh public key |
| 2033 | authorization + ssh-agent, implementing this, and it works! Here are two |
| 2034 | links with instructions: |
| 2035 | |
| 2036 | http://www.ibm.com/developerworks/library/l-keyc2/ |
| 2037 | http://sial.org/howto/openssh/publickey-auth/ |
| 2038 | |
| 2039 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2040 | Ssh hints: |
| 2041 | |
| 2042 | Thomer Gil has provided a hint on how to speed up netrw+ssh: |
| 2043 | http://thomer.com/howtos/netrw_ssh.html |
| 2044 | |
| 2045 | Alex Young has several hints on speeding ssh up: |
| 2046 | http://usevim.com/2012/03/16/editing-remote-files/ |
| 2047 | |
| 2048 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2049 | LISTING BOOKMARKS AND HISTORY *netrw-qb* *netrw-listbookmark* {{{2 |
| 2050 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2051 | Pressing "qb" (query bookmarks) will list both the bookmarked directories and |
| 2052 | directory traversal history. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2053 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2054 | Related Topics: |
| 2055 | |netrw-gb| how to return (go) to a bookmark |
| 2056 | |netrw-mb| how to make a bookmark |
| 2057 | |netrw-mB| how to delete bookmarks |
| 2058 | |netrw-u| change to a predecessor directory via the history stack |
| 2059 | |netrw-U| change to a successor directory via the history stack |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2060 | |
| 2061 | MAKING A NEW DIRECTORY *netrw-d* {{{2 |
| 2062 | |
| 2063 | With the "d" map one may make a new directory either remotely (which depends |
| 2064 | on the global variable g:netrw_mkdir_cmd) or locally (which depends on the |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 2065 | global variable g:netrw_localmkdir). Netrw will issue a request for the new |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2066 | directory's name. A bare <CR> at that point will abort the making of the |
| 2067 | directory. Attempts to make a local directory that already exists (as either |
| 2068 | a file or a directory) will be detected, reported on, and ignored. |
| 2069 | |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 2070 | Related topics: |netrw-D| |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2071 | Associated setting variables: |g:netrw_localmkdir| |g:netrw_mkdir_cmd| |
| 2072 | |g:netrw_remote_mkdir| |netrw-%| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2073 | |
| 2074 | |
| 2075 | MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY *netrw-c* {{{2 |
| 2076 | |
| 2077 | By default, |g:netrw_keepdir| is 1. This setting means that the current |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2078 | directory will not track the browsing directory. (done for backwards |
| 2079 | compatibility with v6's file explorer). |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2080 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2081 | Setting g:netrw_keepdir to 0 tells netrw to make vim's current directory |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2082 | track netrw's browsing directory. |
| 2083 | |
| 2084 | However, given the default setting for g:netrw_keepdir of 1 where netrw |
| 2085 | maintains its own separate notion of the current directory, in order to make |
| 2086 | the two directories the same, use the "c" map (just type c). That map will |
| 2087 | set Vim's notion of the current directory to netrw's current browsing |
| 2088 | directory. |
| 2089 | |
| 2090 | Associated setting variable: |g:netrw_keepdir| |
| 2091 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2092 | MARKING FILES *netrw-:MF* *netrw-mf* {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2093 | (also see |netrw-mr|) |
| 2094 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2095 | Netrw provides several ways to mark files: |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2096 | |
| 2097 | * One may mark files with the cursor atop a filename and |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2098 | then pressing "mf". |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2099 | |
| 2100 | * With gvim, in addition one may mark files with |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2101 | <s-leftmouse>. (see |netrw-mouse|) |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2102 | |
| 2103 | * One may use the :MF command, which takes a list of |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2104 | files (for local directories, the list may include |
| 2105 | wildcards -- see |glob()|) > |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2106 | |
| 2107 | :MF *.c |
| 2108 | < |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 2109 | (Note that :MF uses |<f-args>| to break the line |
| 2110 | at spaces) |
| 2111 | |
| 2112 | * Mark files using the |argument-list| (|netrw-mA|) |
| 2113 | |
| 2114 | * Mark files based upon a |location-list| (|netrw-qL|) |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2115 | |
| 2116 | * Mark files based upon the quickfix list (|netrw-qF|) |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 2117 | (|quickfix-error-lists|) |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2118 | |
| 2119 | The following netrw maps make use of marked files: |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2120 | |
| 2121 | |netrw-a| Hide marked files/directories |
| 2122 | |netrw-D| Delete marked files/directories |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 2123 | |netrw-ma| Move marked files' names to |arglist| |
| 2124 | |netrw-mA| Move |arglist| filenames to marked file list |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2125 | |netrw-mb| Append marked files to bookmarks |
| 2126 | |netrw-mB| Delete marked files from bookmarks |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2127 | |netrw-mc| Copy marked files to target |
| 2128 | |netrw-md| Apply vimdiff to marked files |
| 2129 | |netrw-me| Edit marked files |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2130 | |netrw-mF| Unmark marked files |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2131 | |netrw-mg| Apply vimgrep to marked files |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2132 | |netrw-mm| Move marked files to target |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2133 | |netrw-mp| Print marked files |
| 2134 | |netrw-mt| Set target for |netrw-mm| and |netrw-mc| |
| 2135 | |netrw-mT| Generate tags using marked files |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2136 | |netrw-mv| Apply vim command to marked files |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2137 | |netrw-mx| Apply shell command to marked files |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2138 | |netrw-mX| Apply shell command to marked files, en bloc |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2139 | |netrw-mz| Compress/Decompress marked files |
| 2140 | |netrw-O| Obtain marked files |
| 2141 | |netrw-R| Rename marked files |
| 2142 | |
| 2143 | One may unmark files one at a time the same way one marks them; ie. place |
| 2144 | the cursor atop a marked file and press "mf". This process also works |
| 2145 | with <s-leftmouse> using gvim. One may unmark all files by pressing |
| 2146 | "mu" (see |netrw-mu|). |
| 2147 | |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 2148 | Marked files are highlighted using the "netrwMarkFile" highlighting group, |
| 2149 | which by default is linked to "Identifier" (see Identifier under |
| 2150 | |group-name|). You may change the highlighting group by putting something |
| 2151 | like > |
| 2152 | |
| 2153 | highlight clear netrwMarkFile |
| 2154 | hi link netrwMarkFile ..whatever.. |
| 2155 | < |
| 2156 | into $HOME/.vim/after/syntax/netrw.vim . |
| 2157 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2158 | If the mouse is enabled and works with your vim, you may use <s-leftmouse> to |
| 2159 | mark one or more files. You may mark multiple files by dragging the shifted |
| 2160 | leftmouse. (see |netrw-mouse|) |
| 2161 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2162 | *markfilelist* *global_markfilelist* *local_markfilelist* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2163 | All marked files are entered onto the global marked file list; there is only |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2164 | one such list. In addition, every netrw buffer also has its own buffer-local |
| 2165 | marked file list; since netrw buffers are associated with specific |
| 2166 | directories, this means that each directory has its own local marked file |
| 2167 | list. The various commands which operate on marked files use one or the other |
| 2168 | of the marked file lists. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2169 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2170 | Known Problem: if one is using tree mode (|g:netrw_liststyle|) and several |
| 2171 | directories have files with the same name, then marking such a file will |
| 2172 | result in all such files being highlighted as if they were all marked. The |
| 2173 | |markfilelist|, however, will only have the selected file in it. This problem |
| 2174 | is unlikely to be fixed. |
| 2175 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2176 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2177 | UNMARKING FILES *netrw-mF* {{{2 |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2178 | (also see |netrw-mf|, |netrw-mu|) |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2179 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2180 | The "mF" command will unmark all files in the current buffer. One may also use |
| 2181 | mf (|netrw-mf|) on a specific, already marked, file to unmark just that file. |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2182 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 2183 | MARKING FILES BY LOCATION LIST *netrw-qL* {{{2 |
| 2184 | (also see |netrw-mf|) |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2185 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 2186 | One may convert |location-list|s into a marked file list using "qL". |
| 2187 | You may then proceed with commands such as me (|netrw-me|) to edit them. |
| 2188 | |
| 2189 | |
| 2190 | MARKING FILES BY QUICKFIX LIST *netrw-qF* {{{2 |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2191 | (also see |netrw-mf|) |
| 2192 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2193 | One may convert |quickfix-error-lists| into a marked file list using "qF". |
| 2194 | You may then proceed with commands such as me (|netrw-me|) to edit them. |
| 2195 | Quickfix error lists are generated, for example, by calls to |:vimgrep|. |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2196 | |
| 2197 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2198 | MARKING FILES BY REGULAR EXPRESSION *netrw-mr* {{{2 |
| 2199 | (also see |netrw-mf|) |
| 2200 | |
| 2201 | One may also mark files by pressing "mr"; netrw will then issue a prompt, |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2202 | "Enter regexp: ". You may then enter a shell-style regular expression such |
| 2203 | as *.c$ (see |glob()|). For remote systems, glob() doesn't work -- so netrw |
| 2204 | converts "*" into ".*" (see |regexp|) and marks files based on that. In the |
| 2205 | future I may make it possible to use |regexp|s instead of glob()-style |
| 2206 | expressions (yet-another-option). |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2207 | |
| 2208 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2209 | MARKED FILES, ARBITRARY VIM COMMAND *netrw-mv* {{{2 |
| 2210 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2211 | (uses the local marked-file list) |
| 2212 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2213 | The "mv" map causes netrw to execute an arbitrary vim command on each file on |
| 2214 | the local marked file list, individually: |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2215 | |
| 2216 | * 1split |
| 2217 | * sil! keepalt e file |
| 2218 | * run vim command |
| 2219 | * sil! keepalt wq! |
| 2220 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2221 | A prompt, "Enter vim command: ", will be issued to elicit the vim command |
| 2222 | you wish used. |
| 2223 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2224 | |
| 2225 | MARKED FILES, ARBITRARY SHELL COMMAND *netrw-mx* {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2226 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2227 | (uses the local marked-file list) |
| 2228 | |
| 2229 | Upon activation of the "mx" map, netrw will query the user for some (external) |
| 2230 | command to be applied to all marked files. All "%"s in the command will be |
| 2231 | substituted with the name of each marked file in turn. If no "%"s are in the |
| 2232 | command, then the command will be followed by a space and a marked filename. |
| 2233 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2234 | Example: |
| 2235 | (mark files) |
| 2236 | mx |
| 2237 | Enter command: cat |
| 2238 | |
| 2239 | The result is a series of shell commands: |
| 2240 | cat 'file1' |
| 2241 | cat 'file2' |
| 2242 | ... |
| 2243 | |
| 2244 | |
| 2245 | MARKED FILES, ARBITRARY SHELL COMMAND, EN BLOC *netrw-mX* {{{2 |
| 2246 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2247 | (uses the global marked-file list) |
| 2248 | |
| 2249 | Upon activation of the 'mX' map, netrw will query the user for some (external) |
| 2250 | command to be applied to all marked files on the global marked file list. The |
| 2251 | "en bloc" means that one command will be executed on all the files at once: > |
| 2252 | |
| 2253 | command files |
| 2254 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2255 | This approach is useful, for example, to select files and make a tarball: > |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2256 | |
| 2257 | (mark files) |
| 2258 | mX |
| 2259 | Enter command: tar cf mynewtarball.tar |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2260 | < |
| 2261 | The command that will be run with this example: |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2262 | |
| 2263 | tar cf mynewtarball.tar 'file1' 'file2' ... |
| 2264 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2265 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 2266 | MARKED FILES: ARGUMENT LIST *netrw-ma* *netrw-mA* |
| 2267 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2268 | (uses the global marked-file list) |
| 2269 | |
| 2270 | Using ma, one moves filenames from the marked file list to the argument list. |
| 2271 | Using mA, one moves filenames from the argument list to the marked file list. |
| 2272 | |
| 2273 | See Also: |netrw-qF| |argument-list| |:args| |
| 2274 | |
| 2275 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2276 | MARKED FILES: COMPRESSION AND DECOMPRESSION *netrw-mz* {{{2 |
| 2277 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2278 | (uses the local marked file list) |
| 2279 | |
| 2280 | If any marked files are compressed, then "mz" will decompress them. |
| 2281 | If any marked files are decompressed, then "mz" will compress them |
| 2282 | using the command specified by |g:netrw_compress|; by default, |
| 2283 | that's "gzip". |
| 2284 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 2285 | For decompression, netrw uses a |Dictionary| of suffices and their |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2286 | associated decompressing utilities; see |g:netrw_decompress|. |
| 2287 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2288 | Remember that one can mark multiple files by regular expression |
| 2289 | (see |netrw-mr|); this is particularly useful to facilitate compressing and |
| 2290 | decompressing a large number of files. |
| 2291 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2292 | Associated setting variables: |g:netrw_compress| |g:netrw_decompress| |
| 2293 | |
| 2294 | MARKED FILES: COPYING *netrw-mc* {{{2 |
| 2295 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2296 | (Uses the global marked file list) |
| 2297 | |
| 2298 | Select a target directory with mt (|netrw-mt|). Then change directory, |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 2299 | select file(s) (see |netrw-mf|), and press "mc". The copy is done |
| 2300 | from the current window (where one does the mf) to the target. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2301 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2302 | If one does not have a target directory set with |netrw-mt|, then netrw |
| 2303 | will query you for a directory to copy to. |
| 2304 | |
| 2305 | One may also copy directories and their contents (local only) to a target |
| 2306 | directory. |
| 2307 | |
| 2308 | Associated setting variables: |
| 2309 | |g:netrw_localcopycmd| |
| 2310 | |g:netrw_localcopydircmd| |
| 2311 | |g:netrw_ssh_cmd| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2312 | |
| 2313 | MARKED FILES: DIFF *netrw-md* {{{2 |
| 2314 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2315 | (uses the global marked file list) |
| 2316 | |
| 2317 | Use |vimdiff| to visualize difference between selected files (two or |
| 2318 | three may be selected for this). Uses the global marked file list. |
| 2319 | |
| 2320 | MARKED FILES: EDITING *netrw-me* {{{2 |
| 2321 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2322 | (uses the global marked file list) |
| 2323 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2324 | The "me" command will place the marked files on the |arglist| and commence |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2325 | editing them. One may return the to explorer window with |:Rexplore|. |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2326 | (use |:n| and |:p| to edit next and previous files in the arglist) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2327 | |
| 2328 | MARKED FILES: GREP *netrw-mg* {{{2 |
| 2329 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2330 | (uses the global marked file list) |
| 2331 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2332 | The "mg" command will apply |:vimgrep| to the marked files. |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2333 | The command will ask for the requested pattern; one may then enter: > |
| 2334 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2335 | /pattern/[g][j] |
| 2336 | ! /pattern/[g][j] |
| 2337 | pattern |
| 2338 | < |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2339 | With /pattern/, editing will start with the first item on the |quickfix| list |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 2340 | that vimgrep sets up (see |:copen|, |:cnext|, |:cprevious|, |:cclose|). The |:vimgrep| |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2341 | command is in use, so without 'g' each line is added to quickfix list only |
| 2342 | once; with 'g' every match is included. |
| 2343 | |
| 2344 | With /pattern/j, "mg" will winnow the current marked file list to just those |
| 2345 | marked files also possessing the specified pattern. Thus, one may use > |
| 2346 | |
| 2347 | mr ...file-pattern... |
| 2348 | mg /pattern/j |
| 2349 | < |
| 2350 | to have a marked file list satisfying the file-pattern but also restricted to |
| 2351 | files containing some desired pattern. |
| 2352 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2353 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2354 | MARKED FILES: HIDING AND UNHIDING BY SUFFIX *netrw-mh* {{{2 |
| 2355 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2356 | (uses the local marked file list) |
| 2357 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2358 | The "mh" command extracts the suffices of the marked files and toggles their |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2359 | presence on the hiding list. Please note that marking the same suffix |
| 2360 | this way multiple times will result in the suffix's presence being toggled |
| 2361 | for each file (so an even quantity of marked files having the same suffix |
| 2362 | is the same as not having bothered to select them at all). |
| 2363 | |
| 2364 | Related topics: |netrw-a| |g:netrw_list_hide| |
| 2365 | |
| 2366 | MARKED FILES: MOVING *netrw-mm* {{{2 |
| 2367 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2368 | (uses the global marked file list) |
| 2369 | |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 2370 | WARNING: moving files is more dangerous than copying them. |
| 2371 | A file being moved is first copied and then deleted; if the |
| 2372 | copy operation fails and the delete succeeds, you will lose |
| 2373 | the file. Either try things out with unimportant files |
| 2374 | first or do the copy and then delete yourself using mc and D. |
| 2375 | Use at your own risk! |
| 2376 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2377 | Select a target directory with mt (|netrw-mt|). Then change directory, |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 2378 | select file(s) (see |netrw-mf|), and press "mm". The move is done |
| 2379 | from the current window (where one does the mf) to the target. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2380 | |
| 2381 | Associated setting variable: |g:netrw_localmovecmd| |g:netrw_ssh_cmd| |
| 2382 | |
| 2383 | MARKED FILES: PRINTING *netrw-mp* {{{2 |
| 2384 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2385 | (uses the local marked file list) |
| 2386 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2387 | When "mp" is used, netrw will apply the |:hardcopy| command to marked files. |
| 2388 | What netrw does is open each file in a one-line window, execute hardcopy, then |
| 2389 | close the one-line window. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2390 | |
| 2391 | |
| 2392 | MARKED FILES: SOURCING *netrw-ms* {{{2 |
| 2393 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2394 | (uses the local marked file list) |
| 2395 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2396 | With "ms", netrw will source the marked files (using vim's |:source| command) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2397 | |
| 2398 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2399 | MARKED FILES: SETTING THE TARGET DIRECTORY *netrw-mt* {{{2 |
| 2400 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2401 | |
| 2402 | Set the marked file copy/move-to target (see |netrw-mc| and |netrw-mm|): |
| 2403 | |
| 2404 | * If the cursor is atop a file name, then the netrw window's currently |
| 2405 | displayed directory is used for the copy/move-to target. |
| 2406 | |
| 2407 | * Also, if the cursor is in the banner, then the netrw window's currently |
| 2408 | displayed directory is used for the copy/move-to target. |
| 2409 | Unless the target already is the current directory. In which case, |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2410 | typing "mf" clears the target. |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2411 | |
| 2412 | * However, if the cursor is atop a directory name, then that directory is |
| 2413 | used for the copy/move-to target |
| 2414 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2415 | * One may use the :MT [directory] command to set the target *netrw-:MT* |
| 2416 | This command uses |<q-args>|, so spaces in the directory name are |
| 2417 | permitted without escaping. |
| 2418 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2419 | * With mouse-enabled vim or with gvim, one may select a target by using |
| 2420 | <c-leftmouse> |
| 2421 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2422 | There is only one copy/move-to target at a time in a vim session; ie. the |
| 2423 | target is a script variable (see |s:var|) and is shared between all netrw |
| 2424 | windows (in an instance of vim). |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2425 | |
| 2426 | When using menus and gvim, netrw provides a "Targets" entry which allows one |
| 2427 | to pick a target from the list of bookmarks and history. |
| 2428 | |
| 2429 | Related topics: |
| 2430 | Marking Files......................................|netrw-mf| |
| 2431 | Marking Files by Regular Expression................|netrw-mr| |
| 2432 | Marked Files: Target Directory Using Bookmarks.....|netrw-Tb| |
| 2433 | Marked Files: Target Directory Using History.......|netrw-Th| |
| 2434 | |
| 2435 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2436 | MARKED FILES: TAGGING *netrw-mT* {{{2 |
| 2437 | (See |netrw-mf| and |netrw-mr| for how to mark files) |
| 2438 | (uses the global marked file list) |
| 2439 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2440 | The "mT" mapping will apply the command in |g:netrw_ctags| (by default, it is |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2441 | "ctags") to marked files. For remote browsing, in order to create a tags file |
| 2442 | netrw will use ssh (see |g:netrw_ssh_cmd|), and so ssh must be available for |
| 2443 | this to work on remote systems. For your local system, see |ctags| on how to |
| 2444 | get a version. I myself use hdrtags, currently available at |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 2445 | http://www.drchip.org/astronaut/src/index.html , and have > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2446 | |
| 2447 | let g:netrw_ctags= "hdrtag" |
| 2448 | < |
| 2449 | in my <.vimrc>. |
| 2450 | |
| 2451 | When a remote set of files are tagged, the resulting tags file is "obtained"; |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2452 | ie. a copy is transferred to the local system's directory. The now local tags |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2453 | file is then modified so that one may use it through the network. The |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2454 | modification made concerns the names of the files in the tags; each filename is |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2455 | preceded by the netrw-compatible url used to obtain it. When one subsequently |
| 2456 | uses one of the go to tag actions (|tags|), the url will be used by netrw to |
| 2457 | edit the desired file and go to the tag. |
| 2458 | |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 2459 | Associated setting variables: |g:netrw_ctags| |g:netrw_ssh_cmd| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2460 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2461 | MARKED FILES: TARGET DIRECTORY USING BOOKMARKS *netrw-Tb* {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2462 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2463 | Sets the marked file copy/move-to target. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2464 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2465 | The |netrw-qb| map will give you a list of bookmarks (and history). |
| 2466 | One may choose one of the bookmarks to become your marked file |
| 2467 | target by using [count]Tb (default count: 1). |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2468 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2469 | Related topics: |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2470 | Copying files to target............................|netrw-mc| |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2471 | Listing Bookmarks and History......................|netrw-qb| |
| 2472 | Marked Files: Setting The Target Directory.........|netrw-mt| |
| 2473 | Marked Files: Target Directory Using History.......|netrw-Th| |
| 2474 | Marking Files......................................|netrw-mf| |
| 2475 | Marking Files by Regular Expression................|netrw-mr| |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2476 | Moving files to target.............................|netrw-mm| |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2477 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2478 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2479 | MARKED FILES: TARGET DIRECTORY USING HISTORY *netrw-Th* {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2480 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2481 | Sets the marked file copy/move-to target. |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2482 | |
| 2483 | The |netrw-qb| map will give you a list of history (and bookmarks). |
| 2484 | One may choose one of the history entries to become your marked file |
| 2485 | target by using [count]Th (default count: 0; ie. the current directory). |
| 2486 | |
| 2487 | Related topics: |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2488 | Copying files to target............................|netrw-mc| |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2489 | Listing Bookmarks and History......................|netrw-qb| |
| 2490 | Marked Files: Setting The Target Directory.........|netrw-mt| |
| 2491 | Marked Files: Target Directory Using Bookmarks.....|netrw-Tb| |
| 2492 | Marking Files......................................|netrw-mf| |
| 2493 | Marking Files by Regular Expression................|netrw-mr| |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2494 | Moving files to target.............................|netrw-mm| |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2495 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2496 | |
| 2497 | MARKED FILES: UNMARKING *netrw-mu* {{{2 |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2498 | (See |netrw-mf|, |netrw-mF|) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2499 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2500 | The "mu" mapping will unmark all currently marked files. This command differs |
| 2501 | from "mF" as the latter only unmarks files in the current directory whereas |
| 2502 | "mu" will unmark global and all buffer-local marked files. |
| 2503 | (see |netrw-mF|) |
| 2504 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2505 | |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 2506 | *netrw-browser-settings* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2507 | NETRW BROWSER VARIABLES *netrw-browser-options* *netrw-browser-var* {{{2 |
| 2508 | |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 2509 | (if you're interested in the netrw file transfer settings, see |netrw-options| |
| 2510 | and |netrw-protocol|) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2511 | |
| 2512 | The <netrw.vim> browser provides settings in the form of variables which |
| 2513 | you may modify; by placing these settings in your <.vimrc>, you may customize |
| 2514 | your browsing preferences. (see also: |netrw-settings|) |
| 2515 | > |
| 2516 | --- ----------- |
| 2517 | Var Explanation |
| 2518 | --- ----------- |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2519 | < *g:netrw_altfile* some like |CTRL-^| to return to the last |
| 2520 | edited file. Choose that by setting this |
| 2521 | parameter to 1. |
| 2522 | Others like |CTRL-^| to return to the |
| 2523 | netrw browsing buffer. Choose that by setting |
| 2524 | this parameter to 0. |
| 2525 | default: =0 |
| 2526 | |
| 2527 | *g:netrw_alto* change from above splitting to below splitting |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2528 | by setting this variable (see |netrw-o|) |
| 2529 | default: =&sb (see |'sb'|) |
| 2530 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2531 | *g:netrw_altv* change from left splitting to right splitting |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2532 | by setting this variable (see |netrw-v|) |
| 2533 | default: =&spr (see |'spr'|) |
| 2534 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2535 | *g:netrw_banner* enable/suppress the banner |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2536 | =0: suppress the banner |
| 2537 | =1: banner is enabled (default) |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2538 | |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 2539 | *g:netrw_bannerbackslash* if this variable exists and is not zero, the |
| 2540 | banner will be displayed with backslashes |
| 2541 | rather than forward slashes. |
| 2542 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2543 | *g:netrw_browse_split* when browsing, <cr> will open the file by: |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2544 | =0: re-using the same window (default) |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2545 | =1: horizontally splitting the window first |
| 2546 | =2: vertically splitting the window first |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2547 | =3: open file in new tab |
| 2548 | =4: act like "P" (ie. open previous window) |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2549 | Note that |g:netrw_preview| may be used |
| 2550 | to get vertical splitting instead of |
| 2551 | horizontal splitting. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2552 | =[servername,tab-number,window-number] |
| 2553 | Given a |List| such as this, a remote server |
| 2554 | named by the "servername" will be used for |
| 2555 | editing. It will also use the specified tab |
| 2556 | and window numbers to perform editing |
| 2557 | (see |clientserver|, |netrw-ctrl-r|) |
| 2558 | This option does not affect |:Lexplore| |
| 2559 | windows. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2560 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2561 | Related topics: |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2562 | |g:netrw_alto| |g:netrw_altv| |
| 2563 | |netrw-C| |netrw-cr| |
| 2564 | |netrw-ctrl-r| |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2565 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2566 | *g:netrw_browsex_viewer* specify user's preference for a viewer: > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2567 | "kfmclient exec" |
| 2568 | "gnome-open" |
| 2569 | < If > |
| 2570 | "-" |
| 2571 | < is used, then netrwFileHandler() will look for |
| 2572 | a script/function to handle the given |
| 2573 | extension. (see |netrw_filehandler|). |
| 2574 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2575 | *g:netrw_chgperm* Unix/Linux: "chmod PERM FILENAME" |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2576 | Windows: "cacls FILENAME /e /p PERM" |
| 2577 | Used to change access permission for a file. |
| 2578 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2579 | *g:netrw_compress* ="gzip" |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2580 | Will compress marked files with this |
| 2581 | command |
| 2582 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2583 | *g:Netrw_corehandler* Allows one to specify something additional |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 2584 | to do when handling <core> files via netrw's |
| 2585 | browser's "x" command (see |netrw-x|). If |
| 2586 | present, g:Netrw_corehandler specifies |
| 2587 | either one or more function references |
| 2588 | (see |Funcref|). (the capital g:Netrw... |
| 2589 | is required its holding a function reference) |
| 2590 | |
| 2591 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2592 | *g:netrw_ctags* ="ctags" |
| 2593 | The default external program used to create |
| 2594 | tags |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 2595 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2596 | *g:netrw_cursor* = 2 (default) |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2597 | This option controls the use of the |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 2598 | |'cursorline'| (cul) and |'cursorcolumn'| |
| 2599 | (cuc) settings by netrw: |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2600 | |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 2601 | Value Thin-Long-Tree Wide |
| 2602 | =0 u-cul u-cuc u-cul u-cuc |
| 2603 | =1 u-cul u-cuc cul u-cuc |
| 2604 | =2 cul u-cuc cul u-cuc |
| 2605 | =3 cul u-cuc cul cuc |
| 2606 | =4 cul cuc cul cuc |
| 2607 | |
| 2608 | Where |
| 2609 | u-cul : user's |'cursorline'| setting used |
| 2610 | u-cuc : user's |'cursorcolumn'| setting used |
| 2611 | cul : |'cursorline'| locally set |
| 2612 | cuc : |'cursorcolumn'| locally set |
| 2613 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2614 | *g:netrw_decompress* = { ".gz" : "gunzip" , |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2615 | ".bz2" : "bunzip2" , |
| 2616 | ".zip" : "unzip" , |
| 2617 | ".tar" : "tar -xf"} |
| 2618 | A dictionary mapping suffices to |
| 2619 | decompression programs. |
| 2620 | |
Bram Moolenaar | adc2182 | 2011-04-01 18:03:16 +0200 | [diff] [blame] | 2621 | *g:netrw_dirhistmax* =10: controls maximum quantity of past |
| 2622 | history. May be zero to supppress |
| 2623 | history. |
| 2624 | (related: |netrw-qb| |netrw-u| |netrw-U|) |
| 2625 | |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 2626 | *g:netrw_dynamic_maxfilenamelen* =32: enables dynamic determination of |
| 2627 | |g:netrw_maxfilenamelen|, which affects |
| 2628 | local file long listing. |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2629 | |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 2630 | *g:netrw_errorlvl* =0: error levels greater than or equal to |
| 2631 | this are permitted to be displayed |
| 2632 | 0: notes |
| 2633 | 1: warnings |
| 2634 | 2: errors |
| 2635 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2636 | *g:netrw_fastbrowse* =0: slow speed directory browsing; |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2637 | never re-uses directory listings; |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2638 | always obtains directory listings. |
| 2639 | =1: medium speed directory browsing; |
| 2640 | re-use directory listings only |
| 2641 | when remote directory browsing. |
| 2642 | (default value) |
| 2643 | =2: fast directory browsing; |
| 2644 | only obtains directory listings when the |
| 2645 | directory hasn't been seen before |
| 2646 | (or |netrw-ctrl-l| is used). |
| 2647 | |
| 2648 | Fast browsing retains old directory listing |
| 2649 | buffers so that they don't need to be |
| 2650 | re-acquired. This feature is especially |
| 2651 | important for remote browsing. However, if |
| 2652 | a file is introduced or deleted into or from |
| 2653 | such directories, the old directory buffer |
| 2654 | becomes out-of-date. One may always refresh |
| 2655 | such a directory listing with |netrw-ctrl-l|. |
| 2656 | This option gives the user the choice of |
| 2657 | trading off accuracy (ie. up-to-date listing) |
| 2658 | versus speed. |
| 2659 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2660 | *g:netrw_ffkeep* (default: doesn't exist) |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2661 | If this variable exists and is zero, then |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2662 | netrw will not do a save and restore for |
| 2663 | |'fileformat'|. |
| 2664 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2665 | *g:netrw_fname_escape* =' ?&;%' |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2666 | Used on filenames before remote reading/writing |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2667 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2668 | *g:netrw_ftp_browse_reject* ftp can produce a number of errors and warnings |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2669 | that can show up as "directories" and "files" |
| 2670 | in the listing. This pattern is used to |
| 2671 | remove such embedded messages. By default its |
| 2672 | value is: |
| 2673 | '^total\s\+\d\+$\| |
| 2674 | ^Trying\s\+\d\+.*$\| |
| 2675 | ^KERBEROS_V\d rejected\| |
| 2676 | ^Security extensions not\| |
| 2677 | No such file\| |
| 2678 | : connect to address [0-9a-fA-F:]* |
| 2679 | : No route to host$' |
| 2680 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2681 | *g:netrw_ftp_list_cmd* options for passing along to ftp for directory |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2682 | listing. Defaults: |
| 2683 | unix or g:netrw_cygwin set: : "ls -lF" |
| 2684 | otherwise "dir" |
| 2685 | |
| 2686 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2687 | *g:netrw_ftp_sizelist_cmd* options for passing along to ftp for directory |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2688 | listing, sorted by size of file. |
| 2689 | Defaults: |
| 2690 | unix or g:netrw_cygwin set: : "ls -slF" |
| 2691 | otherwise "dir" |
| 2692 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2693 | *g:netrw_ftp_timelist_cmd* options for passing along to ftp for directory |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2694 | listing, sorted by time of last modification. |
| 2695 | Defaults: |
| 2696 | unix or g:netrw_cygwin set: : "ls -tlF" |
| 2697 | otherwise "dir" |
| 2698 | |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 2699 | *g:netrw_glob_escape* ='[]*?`{~$' (unix) |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 2700 | ='[]*?`{$' (windows |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2701 | These characters in directory names are |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2702 | escaped before applying glob() |
| 2703 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2704 | *g:netrw_gx* ="<cfile>" |
| 2705 | This option controls how gx (|netrw-gx|) picks |
| 2706 | up the text under the cursor. See |expand()| |
| 2707 | for possibilities. |
| 2708 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2709 | *g:netrw_hide* Controlled by the "a" map (see |netrw-a|) |
| 2710 | =0 : show all |
| 2711 | =1 : show not-hidden files |
| 2712 | =2 : show hidden files only |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2713 | default: =0 |
| 2714 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2715 | *g:netrw_home* The home directory for where bookmarks and |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2716 | history are saved (as .netrwbook and |
| 2717 | .netrwhist). |
| 2718 | default: the first directory on the |
| 2719 | |'runtimepath'| |
| 2720 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2721 | *g:netrw_keepdir* =1 (default) keep current directory immune from |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2722 | the browsing directory. |
| 2723 | =0 keep the current directory the same as the |
| 2724 | browsing directory. |
| 2725 | The current browsing directory is contained in |
| 2726 | b:netrw_curdir (also see |netrw-c|) |
| 2727 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2728 | *g:netrw_keepj* ="keepj" (default) netrw attempts to keep the |
| 2729 | |:jumps| table unaffected. |
| 2730 | ="" netrw will not use |:keepjumps| with |
| 2731 | exceptions only for the |
| 2732 | saving/restoration of position. |
| 2733 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2734 | *g:netrw_list_cmd* command for listing remote directories |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2735 | default: (if ssh is executable) |
| 2736 | "ssh HOSTNAME ls -FLa" |
| 2737 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2738 | *g:netrw_list_cmd_options* If this variable exists, then its contents are |
| 2739 | appended to the g:netrw_list_cmd. For |
| 2740 | example, use "2>/dev/null" to get rid of banner |
| 2741 | messages on unix systems. |
| 2742 | |
| 2743 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2744 | *g:netrw_liststyle* Set the default listing style: |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2745 | = 0: thin listing (one file per line) |
| 2746 | = 1: long listing (one file per line with time |
| 2747 | stamp information and file size) |
| 2748 | = 2: wide listing (multiple files in columns) |
| 2749 | = 3: tree style listing |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2750 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2751 | *g:netrw_list_hide* comma separated pattern list for hiding files |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2752 | Patterns are regular expressions (see |regexp|) |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2753 | There's some special support for git-ignore |
| 2754 | files: you may add the output from the helper |
| 2755 | function 'netrw_gitignore#Hide() automatically |
| 2756 | hiding all gitignored files. |
| 2757 | For more details see |netrw-gitignore|. |
| 2758 | |
| 2759 | Examples: |
| 2760 | let g:netrw_list_hide= '.*\.swp$' |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2761 | let g:netrw_list_hide= netrw_gitignore#Hide().'.*\.swp$' |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2762 | default: "" |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2763 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2764 | *g:netrw_localcopycmd* ="cp" Linux/Unix/MacOS/Cygwin |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2765 | ="copy" Windows |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2766 | Copies marked files (|netrw-mf|) to target |
| 2767 | directory (|netrw-mt|, |netrw-mc|) |
| 2768 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2769 | *g:netrw_localcopydircmd* ="cp -R" Linux/Unix/MacOS/Cygwin |
| 2770 | ="xcopy /e /c /h/ /i /k" Windows |
| 2771 | Copies directories to target directory. |
| 2772 | (|netrw-mc|, |netrw-mt|) |
| 2773 | |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 2774 | *g:netrw_localmkdir* command for making a local directory |
| 2775 | default: "mkdir" |
| 2776 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2777 | *g:netrw_localmovecmd* ="mv" Linux/Unix/MacOS/Cygwin |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2778 | ="move" Windows |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2779 | Moves marked files (|netrw-mf|) to target |
| 2780 | directory (|netrw-mt|, |netrw-mm|) |
| 2781 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2782 | *g:netrw_localrmdir* remove directory command (rmdir) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2783 | default: "rmdir" |
| 2784 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2785 | *g:netrw_maxfilenamelen* =32 by default, selected so as to make long |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2786 | listings fit on 80 column displays. |
| 2787 | If your screen is wider, and you have file |
| 2788 | or directory names longer than 32 bytes, |
| 2789 | you may set this option to keep listings |
| 2790 | columnar. |
| 2791 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2792 | *g:netrw_mkdir_cmd* command for making a remote directory |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 2793 | via ssh (also see |g:netrw_remote_mkdir|) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2794 | default: "ssh USEPORT HOSTNAME mkdir" |
| 2795 | |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 2796 | *g:netrw_mousemaps* =1 (default) enables mouse buttons while |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2797 | browsing to: |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2798 | leftmouse : open file/directory |
| 2799 | shift-leftmouse : mark file |
| 2800 | middlemouse : same as P |
| 2801 | rightmouse : remove file/directory |
| 2802 | =0: disables mouse maps |
| 2803 | |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 2804 | *g:netrw_nobeval* doesn't exist (default) |
| 2805 | If this variable exists, then balloon |
| 2806 | evaluation will be suppressed |
| 2807 | (see |'ballooneval'|) |
| 2808 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 2809 | *g:netrw_sizestyle* not defined: actual bytes (default) |
| 2810 | ="b" : actual bytes (default) |
| 2811 | ="h" : human-readable (ex. 5k, 4m, 3g) |
| 2812 | uses 1000 base |
| 2813 | ="H" : human-readable (ex. 5K, 4M, 3G) |
| 2814 | uses 1024 base |
| 2815 | The long listing (|netrw-i|) and query-file |
| 2816 | maps (|netrw-qf|) will display file size |
| 2817 | using the specified style. |
| 2818 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2819 | *g:netrw_usetab* if this variable exists and is non-zero, then |
| 2820 | the <tab> map supporting shrinking/expanding a |
| 2821 | Lexplore or netrw window will be enabled. |
| 2822 | (see |netrw-c-tab|) |
| 2823 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2824 | *g:netrw_remote_mkdir* command for making a remote directory |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 2825 | via ftp (also see |g:netrw_mkdir_cmd|) |
| 2826 | default: "mkdir" |
| 2827 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2828 | *g:netrw_retmap* if it exists and is set to one, then: |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2829 | * if in a netrw-selected file, AND |
| 2830 | * no normal-mode <2-leftmouse> mapping exists, |
| 2831 | then the <2-leftmouse> will be mapped for easy |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2832 | return to the netrw browser window. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2833 | example: click once to select and open a file, |
| 2834 | double-click to return. |
| 2835 | |
| 2836 | Note that one may instead choose to: |
| 2837 | * let g:netrw_retmap= 1, AND |
| 2838 | * nmap <silent> YourChoice <Plug>NetrwReturn |
| 2839 | and have another mapping instead of |
| 2840 | <2-leftmouse> to invoke the return. |
| 2841 | |
| 2842 | You may also use the |:Rexplore| command to do |
| 2843 | the same thing. |
| 2844 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2845 | default: =0 |
| 2846 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2847 | *g:netrw_rm_cmd* command for removing remote files |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2848 | default: "ssh USEPORT HOSTNAME rm" |
| 2849 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2850 | *g:netrw_rmdir_cmd* command for removing remote directories |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2851 | default: "ssh USEPORT HOSTNAME rmdir" |
| 2852 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2853 | *g:netrw_rmf_cmd* command for removing remote softlinks |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2854 | default: "ssh USEPORT HOSTNAME rm -f" |
| 2855 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 2856 | *g:netrw_servername* use this variable to provide a name for |
| 2857 | |netrw-ctrl-r| to use for its server. |
| 2858 | default: "NETRWSERVER" |
| 2859 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2860 | *g:netrw_sort_by* sort by "name", "time", "size", or |
| 2861 | "exten". |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2862 | default: "name" |
| 2863 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2864 | *g:netrw_sort_direction* sorting direction: "normal" or "reverse" |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2865 | default: "normal" |
| 2866 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2867 | *g:netrw_sort_options* sorting is done using |:sort|; this |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 2868 | variable's value is appended to the |
| 2869 | sort command. Thus one may ignore case, |
| 2870 | for example, with the following in your |
| 2871 | .vimrc: > |
| 2872 | let g:netrw_sort_options="i" |
| 2873 | < default: "" |
| 2874 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2875 | *g:netrw_sort_sequence* when sorting by name, first sort by the |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2876 | comma-separated pattern sequence. Note that |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2877 | any filigree added to indicate filetypes |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2878 | should be accounted for in your pattern. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2879 | default: '[\/]$,*,\.bak$,\.o$,\.h$, |
| 2880 | \.info$,\.swp$,\.obj$' |
| 2881 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2882 | *g:netrw_special_syntax* If true, then certain files will be shown |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 2883 | using special syntax in the browser: |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2884 | |
| 2885 | netrwBak : *.bak |
| 2886 | netrwCompress: *.gz *.bz2 *.Z *.zip |
| 2887 | netrwData : *.dat |
| 2888 | netrwHdr : *.h |
| 2889 | netrwLib : *.a *.so *.lib *.dll |
| 2890 | netrwMakefile: [mM]akefile *.mak |
| 2891 | netrwObj : *.o *.obj |
| 2892 | netrwTags : tags ANmenu ANtags |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2893 | netrwTilde : * |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2894 | netrwTmp : tmp* *tmp |
| 2895 | |
| 2896 | These syntax highlighting groups are linked |
| 2897 | to Folded or DiffChange by default |
| 2898 | (see |hl-Folded| and |hl-DiffChange|), but |
| 2899 | one may put lines like > |
| 2900 | hi link netrwCompress Visual |
| 2901 | < into one's <.vimrc> to use one's own |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2902 | preferences. Alternatively, one may |
| 2903 | put such specifications into |
| 2904 | .vim/after/syntax/netrw.vim. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2905 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2906 | As an example, I myself use a dark-background |
| 2907 | colorscheme with the following in |
| 2908 | .vim/after/syntax/netrw.vim: > |
| 2909 | |
| 2910 | hi netrwCompress term=NONE cterm=NONE gui=NONE ctermfg=10 guifg=green ctermbg=0 guibg=black |
| 2911 | hi netrwData term=NONE cterm=NONE gui=NONE ctermfg=9 guifg=blue ctermbg=0 guibg=black |
| 2912 | hi netrwHdr term=NONE cterm=NONE,italic gui=NONE guifg=SeaGreen1 |
| 2913 | hi netrwLex term=NONE cterm=NONE,italic gui=NONE guifg=SeaGreen1 |
| 2914 | hi netrwYacc term=NONE cterm=NONE,italic gui=NONE guifg=SeaGreen1 |
| 2915 | hi netrwLib term=NONE cterm=NONE gui=NONE ctermfg=14 guifg=yellow |
| 2916 | hi netrwObj term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red |
| 2917 | hi netrwTilde term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red |
| 2918 | hi netrwTmp term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red |
| 2919 | hi netrwTags term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red |
| 2920 | hi netrwDoc term=NONE cterm=NONE gui=NONE ctermfg=220 ctermbg=27 guifg=yellow2 guibg=Blue3 |
| 2921 | hi netrwSymLink term=NONE cterm=NONE gui=NONE ctermfg=220 ctermbg=27 guifg=grey60 |
| 2922 | < |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2923 | *g:netrw_ssh_browse_reject* ssh can sometimes produce unwanted lines, |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2924 | messages, banners, and whatnot that one doesn't |
| 2925 | want masquerading as "directories" and "files". |
| 2926 | Use this pattern to remove such embedded |
| 2927 | messages. By default its value is: |
| 2928 | '^total\s\+\d\+$' |
| 2929 | |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 2930 | *g:netrw_ssh_cmd* One may specify an executable command |
| 2931 | to use instead of ssh for remote actions |
| 2932 | such as listing, file removal, etc. |
| 2933 | default: ssh |
| 2934 | |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame^] | 2935 | *g:netrw_suppress_gx_mesg* =1 : browsers sometimes produce messages |
| 2936 | which are normally unwanted intermixed |
| 2937 | with the page. |
| 2938 | However, when using links, for example, |
| 2939 | those messages are what the browser produces. |
| 2940 | By setting this option to 0, netrw will not |
| 2941 | suppress browser messages. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2942 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2943 | *g:netrw_tmpfile_escape* =' &;' |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2944 | escape() is applied to all temporary files |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2945 | to escape these characters. |
| 2946 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2947 | *g:netrw_timefmt* specify format string to vim's strftime(). |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2948 | The default, "%c", is "the preferred date |
| 2949 | and time representation for the current |
| 2950 | locale" according to my manpage entry for |
| 2951 | strftime(); however, not all are satisfied |
| 2952 | with it. Some alternatives: |
| 2953 | "%a %d %b %Y %T", |
| 2954 | " %a %Y-%m-%d %I-%M-%S %p" |
| 2955 | default: "%c" |
| 2956 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2957 | *g:netrw_use_noswf* netrw normally avoids writing swapfiles |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2958 | for browser buffers. However, under some |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2959 | systems this apparently is causing nasty |
| 2960 | ml_get errors to appear; if you're getting |
| 2961 | ml_get errors, try putting |
| 2962 | let g:netrw_use_noswf= 0 |
| 2963 | in your .vimrc. |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 2964 | default: 1 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2965 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2966 | *g:netrw_winsize* specify initial size of new windows made with |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2967 | "o" (see |netrw-o|), "v" (see |netrw-v|), |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 2968 | |:Hexplore| or |:Vexplore|. The g:netrw_winsize |
| 2969 | is an integer describing the percentage of the |
| 2970 | current netrw buffer's window to be used for |
| 2971 | the new window. |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 2972 | If g:netrw_winsize is less than zero, then |
| 2973 | the absolute value of g:netrw_winsize lines |
| 2974 | or columns will be used for the new window. |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 2975 | If g:netrw_winsize is zero, then a normal |
| 2976 | split will be made (ie. |'equalalways'| will |
| 2977 | take effect, for example). |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 2978 | default: 50 (for 50%) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2979 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 2980 | *g:netrw_wiw* =1 specifies the minimum window width to use |
| 2981 | when shrinking a netrw/Lexplore window |
| 2982 | (see |netrw-c-tab|). |
| 2983 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 2984 | *g:netrw_xstrlen* Controls how netrw computes string lengths, |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2985 | including multi-byte characters' string |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2986 | length. (thanks to N Weibull, T Mechelynck) |
| 2987 | =0: uses Vim's built-in strlen() |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2988 | =1: number of codepoints (Latin a + combining |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2989 | circumflex is two codepoints) (DEFAULT) |
| 2990 | =2: number of spacing codepoints (Latin a + |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2991 | combining circumflex is one spacing |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2992 | codepoint; a hard tab is one; wide and |
| 2993 | narrow CJK are one each; etc.) |
| 2994 | =3: virtual length (counting tabs as anything |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2995 | between 1 and |'tabstop'|, wide CJK as 2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2996 | rather than 1, Arabic alif as zero when |
| 2997 | immediately preceded by lam, one |
| 2998 | otherwise, etc) |
| 2999 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 3000 | *g:NetrwTopLvlMenu* This variable specifies the top level |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3001 | menu name; by default, it's "Netrw.". If |
| 3002 | you wish to change this, do so in your |
| 3003 | .vimrc. |
| 3004 | |
| 3005 | NETRW BROWSING AND OPTION INCOMPATIBILITIES *netrw-incompatible* {{{2 |
| 3006 | |
| 3007 | Netrw has been designed to handle user options by saving them, setting the |
| 3008 | options to something that's compatible with netrw's needs, and then restoring |
| 3009 | them. However, the autochdir option: > |
| 3010 | :set acd |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3011 | is problematic. Autochdir sets the current directory to that containing the |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3012 | file you edit; this apparently also applies to directories. In other words, |
| 3013 | autochdir sets the current directory to that containing the "file" (even if |
| 3014 | that "file" is itself a directory). |
| 3015 | |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 3016 | NETRW SETTINGS WINDOW *netrw-settings-window* {{{2 |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 3017 | |
| 3018 | With the NetrwSettings.vim plugin, > |
| 3019 | :NetrwSettings |
| 3020 | will bring up a window with the many variables that netrw uses for its |
Bram Moolenaar | 1afcace | 2005-11-25 19:54:28 +0000 | [diff] [blame] | 3021 | settings. You may change any of their values; when you save the file, the |
| 3022 | settings therein will be used. One may also press "?" on any of the lines for |
| 3023 | help on what each of the variables do. |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 3024 | |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 3025 | (also see: |netrw-browser-var| |netrw-protocol| |netrw-variables|) |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3026 | |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 3027 | |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 3028 | ============================================================================== |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3029 | OBTAINING A FILE *netrw-obtain* *netrw-O* {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3030 | |
| 3031 | If there are no marked files: |
| 3032 | |
| 3033 | When browsing a remote directory, one may obtain a file under the cursor |
| 3034 | (ie. get a copy on your local machine, but not edit it) by pressing the O |
| 3035 | key. |
| 3036 | |
| 3037 | If there are marked files: |
| 3038 | |
| 3039 | The marked files will be obtained (ie. a copy will be transferred to your |
| 3040 | local machine, but not set up for editing). |
| 3041 | |
| 3042 | Only ftp and scp are supported for this operation (but since these two are |
| 3043 | available for browsing, that shouldn't be a problem). The status bar will |
| 3044 | then show, on its right hand side, a message like "Obtaining filename". The |
| 3045 | statusline will be restored after the transfer is complete. |
| 3046 | |
| 3047 | Netrw can also "obtain" a file using the local browser. Netrw's display |
| 3048 | of a directory is not necessarily the same as Vim's "current directory", |
| 3049 | unless |g:netrw_keepdir| is set to 0 in the user's <.vimrc>. One may select |
| 3050 | a file using the local browser (by putting the cursor on it) and pressing |
| 3051 | "O" will then "obtain" the file; ie. copy it to Vim's current directory. |
| 3052 | |
| 3053 | Related topics: |
| 3054 | * To see what the current directory is, use |:pwd| |
| 3055 | * To make the currently browsed directory the current directory, see |netrw-c| |
| 3056 | * To automatically make the currently browsed directory the current |
| 3057 | directory, see |g:netrw_keepdir|. |
| 3058 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3059 | *netrw-newfile* *netrw-createfile* |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3060 | OPEN A NEW FILE IN NETRW'S CURRENT DIRECTORY *netrw-%* {{{2 |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 3061 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3062 | To open a new file in netrw's current directory, press "%". This map |
| 3063 | will query the user for a new filename; an empty file by that name will |
| 3064 | be placed in the netrw's current directory (ie. b:netrw_curdir). |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 3065 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 3066 | Related topics: |netrw-d| |
| 3067 | |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 3068 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3069 | PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2 |
| 3070 | |
| 3071 | One may use a preview window by using the "p" key when the cursor is atop the |
| 3072 | desired filename to be previewed. The display will then split to show both |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3073 | the browser (where the cursor will remain) and the file (see |:pedit|). By |
| 3074 | default, the split will be taken horizontally; one may use vertical splitting |
| 3075 | if one has set |g:netrw_preview| first. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3076 | |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 3077 | An interesting set of netrw settings is: > |
| 3078 | |
| 3079 | let g:netrw_preview = 1 |
| 3080 | let g:netrw_liststyle = 3 |
| 3081 | let g:netrw_winsize = 30 |
| 3082 | |
| 3083 | These will: |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3084 | |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 3085 | 1. Make vertical splitting the default for previewing files |
| 3086 | 2. Make the default listing style "tree" |
| 3087 | 3. When a vertical preview window is opened, the directory listing |
Bram Moolenaar | 5b435d6 | 2012-04-05 17:33:26 +0200 | [diff] [blame] | 3088 | will use only 30% of the columns available; the rest of the window |
| 3089 | is used for the preview window. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3090 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3091 | Related: if you like this idea, you may also find :Lexplore |
| 3092 | (|netrw-:Lexplore|) or |g:netrw_chgwin| of interest |
| 3093 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 3094 | Also see: |g:netrw_chgwin| |netrw-P| |'previewwindow'| |CTRL-W_z| |:pclose| |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3095 | |
| 3096 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3097 | PREVIOUS WINDOW *netrw-P* *netrw-prvwin* {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3098 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 3099 | To edit a file or directory under the cursor in the previously used (last |
| 3100 | accessed) window (see :he |CTRL-W_p|), press a "P". If there's only one |
| 3101 | window, then the one window will be horizontally split (by default). |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3102 | |
| 3103 | If there's more than one window, the previous window will be re-used on |
| 3104 | the selected file/directory. If the previous window's associated buffer |
| 3105 | has been modified, and there's only one window with that buffer, then |
| 3106 | the user will be asked if s/he wishes to save the buffer first (yes, |
| 3107 | no, or cancel). |
| 3108 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 3109 | Related Actions |netrw-cr| |netrw-o| |netrw-t| |netrw-v| |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 3110 | Associated setting variables: |
| 3111 | |g:netrw_alto| control above/below splitting |
| 3112 | |g:netrw_altv| control right/left splitting |
| 3113 | |g:netrw_preview| control horizontal vs vertical splitting |
| 3114 | |g:netrw_winsize| control initial sizing |
| 3115 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3116 | Also see: |g:netrw_chgwin| |netrw-p| |
| 3117 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3118 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3119 | REFRESHING THE LISTING *netrw-refresh* *netrw-ctrl-l* *netrw-ctrl_l* {{{2 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3120 | |
| 3121 | To refresh either a local or remote directory listing, press ctrl-l (<c-l>) or |
| 3122 | hit the <cr> when atop the ./ directory entry in the listing. One may also |
| 3123 | refresh a local directory by using ":e .". |
| 3124 | |
| 3125 | |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 3126 | REVERSING SORTING ORDER *netrw-r* *netrw-reverse* {{{2 |
| 3127 | |
| 3128 | One may toggle between normal and reverse sorting order by pressing the |
| 3129 | "r" key. |
| 3130 | |
| 3131 | Related topics: |netrw-s| |
| 3132 | Associated setting variable: |g:netrw_sort_direction| |
| 3133 | |
| 3134 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3135 | RENAMING FILES OR DIRECTORIES *netrw-move* *netrw-rename* *netrw-R* {{{2 |
| 3136 | |
| 3137 | If there are no marked files: (see |netrw-mf|) |
| 3138 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3139 | Renaming files and directories involves moving the cursor to the |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3140 | file/directory to be moved (renamed) and pressing "R". You will then be |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3141 | queried for what you want the file/directory to be renamed to You may select |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3142 | a range of lines with the "V" command (visual selection), and then |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3143 | press "R"; you will be queried for each file as to what you want it |
| 3144 | renamed to. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3145 | |
| 3146 | If there are marked files: (see |netrw-mf|) |
| 3147 | |
| 3148 | Marked files will be renamed (moved). You will be queried as above in |
| 3149 | order to specify where you want the file/directory to be moved. |
| 3150 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3151 | If you answer a renaming query with a "s/frompattern/topattern/", then |
| 3152 | subsequent files on the marked file list will be renamed by taking each |
| 3153 | name, applying that substitute, and renaming each file to the result. |
| 3154 | As an example : > |
| 3155 | |
| 3156 | mr [query: reply with *.c] |
| 3157 | R [query: reply with s/^\(.*\)\.c$/\1.cpp/] |
| 3158 | < |
| 3159 | This example will mark all *.c files and then rename them to *.cpp |
| 3160 | files. |
| 3161 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3162 | The ctrl-X character has special meaning for renaming files: > |
| 3163 | |
| 3164 | <c-x> : a single ctrl-x tells netrw to ignore the portion of the response |
| 3165 | lying between the last '/' and the ctrl-x. |
| 3166 | |
| 3167 | <c-x><c-x> : a pair of contiguous ctrl-x's tells netrw to ignore any |
| 3168 | portion of the string preceding the double ctrl-x's. |
| 3169 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3170 | WARNING:~ |
| 3171 | |
| 3172 | Note that moving files is a dangerous operation; copies are safer. That's |
| 3173 | because a "move" for remote files is actually a copy + delete -- and if |
| 3174 | the copy fails and the delete does not, you may lose the file. |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3175 | Use at your own risk. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3176 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3177 | The g:netrw_rename_cmd variable is used to implement remote renaming. By |
| 3178 | default its value is: |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3179 | |
| 3180 | ssh HOSTNAME mv |
| 3181 | |
| 3182 | One may rename a block of files and directories by selecting them with |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3183 | V (|linewise-visual|) when using thin style |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3184 | |
| 3185 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3186 | SELECTING SORTING STYLE *netrw-s* *netrw-sort* {{{2 |
| 3187 | |
| 3188 | One may select the sorting style by name, time, or (file) size. The "s" map |
| 3189 | allows one to circulate amongst the three choices; the directory listing will |
| 3190 | automatically be refreshed to reflect the selected style. |
| 3191 | |
| 3192 | Related topics: |netrw-r| |netrw-S| |
| 3193 | Associated setting variables: |g:netrw_sort_by| |g:netrw_sort_sequence| |
| 3194 | |
| 3195 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3196 | SETTING EDITING WINDOW *netrw-editwindow* *netrw-C* *netrw-:NetrwC* {{{2 |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3197 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3198 | One may select a netrw window for editing with the "C" mapping, using the |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3199 | :NetrwC [win#] command, or by setting |g:netrw_chgwin| to the selected window |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3200 | number. Subsequent selection of a file to edit (|netrw-cr|) will use that |
| 3201 | window. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3202 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3203 | * C : by itself, will select the current window holding a netrw buffer |
| 3204 | for editing via |netrw-cr|. The C mapping is only available while in |
| 3205 | netrw buffers. |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 3206 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3207 | * [count]C : the count will be used as the window number to be used |
| 3208 | for subsequent editing via |netrw-cr|. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3209 | |
| 3210 | * :NetrwC will set |g:netrw_chgwin| to the current window |
| 3211 | |
| 3212 | * :NetrwC win# will set |g:netrw_chgwin| to the specified window |
| 3213 | number |
| 3214 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 3215 | Using > |
| 3216 | let g:netrw_chgwin= -1 |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3217 | will restore the default editing behavior |
| 3218 | (ie. editing will use the current window). |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 3219 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 3220 | Related topics: |netrw-cr| |g:netrw_browse_split| |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3221 | Associated setting variables: |g:netrw_chgwin| |
| 3222 | |
| 3223 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3224 | SHRINKING OR EXPANDING A NETRW OR LEXPLORE WINDOW *netrw-c-tab* {{{2 |
| 3225 | |
| 3226 | The <c-tab> key will toggle a netrw or |:Lexplore| window's width, |
| 3227 | but only if |g:netrw_usetab| exists and is non-zero (and, of course, |
| 3228 | only if your terminal supports differentiating <c-tab> from a plain |
| 3229 | <tab>). |
| 3230 | |
| 3231 | * If the current window is a netrw window, toggle its width |
| 3232 | (between |g:netrw_wiw| and its original width) |
| 3233 | |
| 3234 | * Else if there is a |:Lexplore| window in the current tab, toggle |
| 3235 | its width |
| 3236 | |
| 3237 | * Else bring up a |:Lexplore| window |
| 3238 | |
| 3239 | If |g:netrw_usetab| exists or is zero, or if there is a pre-existing mapping |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 3240 | for <c-tab>, then the <c-tab> will not be mapped. One may map something other |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3241 | than a <c-tab>, too: (but you'll still need to have had g:netrw_usetab set) > |
| 3242 | |
| 3243 | nmap <unique> (whatever) <Plug>NetrwShrink |
| 3244 | < |
| 3245 | Related topics: |:Lexplore| |
| 3246 | Associated setting variable: |g:netrw_usetab| |
| 3247 | |
| 3248 | |
| 3249 | USER SPECIFIED MAPS *netrw-usermaps* {{{1 |
| 3250 | |
| 3251 | One may make customized user maps. Specify a variable, |g:Netrw_UserMaps|, |
| 3252 | to hold a |List| of lists of keymap strings and function names: > |
| 3253 | |
| 3254 | [["keymap-sequence","ExampleUserMapFunc"],...] |
| 3255 | < |
| 3256 | When netrw is setting up maps for a netrw buffer, if |g:Netrw_UserMaps| |
| 3257 | exists, then the internal function netrw#UserMaps(islocal) is called. |
| 3258 | This function goes through all the entries in the |g:Netrw_UserMaps| list: |
| 3259 | |
| 3260 | * sets up maps: > |
| 3261 | nno <buffer> <silent> KEYMAP-SEQUENCE |
| 3262 | :call s:UserMaps(islocal,"ExampleUserMapFunc") |
| 3263 | < * refreshes if result from that function call is the string |
| 3264 | "refresh" |
| 3265 | * if the result string is not "", then that string will be |
| 3266 | executed (:exe result) |
| 3267 | * if the result is a List, then the above two actions on results |
| 3268 | will be taken for every string in the result List |
| 3269 | |
| 3270 | The user function is passed one argument; it resembles > |
| 3271 | |
| 3272 | fun! ExampleUserMapFunc(islocal) |
| 3273 | < |
| 3274 | where a:islocal is 1 if its a local-directory system call or 0 when |
| 3275 | remote-directory system call. |
| 3276 | |
| 3277 | Use netrw#Expose("varname") to access netrw-internal (script-local) |
| 3278 | variables. |
| 3279 | Use netrw#Modify("varname",newvalue) to change netrw-internal variables. |
| 3280 | Use netrw#Call("funcname"[,args]) to call a netrw-internal function with |
| 3281 | specified arguments. |
| 3282 | |
| 3283 | Example: Get a copy of netrw's marked file list: > |
| 3284 | |
| 3285 | let netrwmarkfilelist= netrw#Expose("netrwmarkfilelist") |
| 3286 | < |
| 3287 | Example: Modify the value of netrw's marked file list: > |
| 3288 | |
| 3289 | call netrw#Modify("netrwmarkfilelist",[]) |
| 3290 | < |
| 3291 | Example: Clear netrw's marked file list via a mapping on gu > |
| 3292 | " ExampleUserMap: {{{2 |
| 3293 | fun! ExampleUserMap(islocal) |
| 3294 | call netrw#Modify("netrwmarkfilelist",[]) |
| 3295 | call netrw#Modify('netrwmarkfilemtch_{bufnr("%")}',"") |
| 3296 | let retval= ["refresh"] |
| 3297 | return retval |
| 3298 | endfun |
| 3299 | let g:Netrw_UserMaps= [["gu","ExampleUserMap"]] |
| 3300 | < |
| 3301 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3302 | 10. Problems and Fixes *netrw-problems* {{{1 |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3303 | |
| 3304 | (This section is likely to grow as I get feedback) |
| 3305 | (also see |netrw-debug|) |
Bram Moolenaar | 488c651 | 2005-08-11 20:09:58 +0000 | [diff] [blame] | 3306 | *netrw-p1* |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3307 | P1. I use windows 95, and my ftp dumps four blank lines at the |
| 3308 | end of every read. |
| 3309 | |
| 3310 | See |netrw-fixup|, and put the following into your |
| 3311 | <.vimrc> file: |
| 3312 | |
| 3313 | let g:netrw_win95ftp= 1 |
Bram Moolenaar | f6cf987 | 2005-08-08 22:00:59 +0000 | [diff] [blame] | 3314 | |
Bram Moolenaar | 488c651 | 2005-08-11 20:09:58 +0000 | [diff] [blame] | 3315 | *netrw-p2* |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3316 | P2. I use Windows, and my network browsing with ftp doesn't sort by |
| 3317 | time or size! -or- The remote system is a Windows server; why |
| 3318 | don't I get sorts by time or size? |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3319 | |
| 3320 | Windows' ftp has a minimal support for ls (ie. it doesn't |
| 3321 | accept sorting options). It doesn't support the -F which |
| 3322 | gives an explanatory character (ABC/ for "ABC is a directory"). |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3323 | Netrw then uses "dir" to get both its thin and long listings. |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3324 | If you think your ftp does support a full-up ls, put the |
| 3325 | following into your <.vimrc>: > |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3326 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3327 | let g:netrw_ftp_list_cmd = "ls -lF" |
| 3328 | let g:netrw_ftp_timelist_cmd= "ls -tlF" |
| 3329 | let g:netrw_ftp_sizelist_cmd= "ls -slF" |
| 3330 | < |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3331 | Alternatively, if you have cygwin on your Windows box, put |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3332 | into your <.vimrc>: > |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3333 | |
| 3334 | let g:netrw_cygwin= 1 |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3335 | < |
| 3336 | This problem also occurs when the remote system is Windows. |
| 3337 | In this situation, the various g:netrw_ftp_[time|size]list_cmds |
| 3338 | are as shown above, but the remote system will not correctly |
| 3339 | modify its listing behavior. |
| 3340 | |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3341 | |
Bram Moolenaar | 488c651 | 2005-08-11 20:09:58 +0000 | [diff] [blame] | 3342 | *netrw-p3* |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3343 | P3. I tried rcp://user@host/ (or protocol other than ftp) and netrw |
| 3344 | used ssh! That wasn't what I asked for... |
| 3345 | |
| 3346 | Netrw has two methods for browsing remote directories: ssh |
| 3347 | and ftp. Unless you specify ftp specifically, ssh is used. |
| 3348 | When it comes time to do download a file (not just a directory |
| 3349 | listing), netrw will use the given protocol to do so. |
| 3350 | |
Bram Moolenaar | 488c651 | 2005-08-11 20:09:58 +0000 | [diff] [blame] | 3351 | *netrw-p4* |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3352 | P4. I would like long listings to be the default. |
| 3353 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3354 | Put the following statement into your |.vimrc|: > |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 3355 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3356 | let g:netrw_liststyle= 1 |
| 3357 | < |
| 3358 | Check out |netrw-browser-var| for more customizations that |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 3359 | you can set. |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3360 | |
Bram Moolenaar | 488c651 | 2005-08-11 20:09:58 +0000 | [diff] [blame] | 3361 | *netrw-p5* |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3362 | P5. My times come up oddly in local browsing |
| 3363 | |
| 3364 | Does your system's strftime() accept the "%c" to yield dates |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 3365 | such as "Sun Apr 27 11:49:23 1997"? If not, do a |
| 3366 | "man strftime" and find out what option should be used. Then |
| 3367 | put it into your |.vimrc|: > |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3368 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3369 | let g:netrw_timefmt= "%X" (where X is the option) |
| 3370 | < |
Bram Moolenaar | 488c651 | 2005-08-11 20:09:58 +0000 | [diff] [blame] | 3371 | *netrw-p6* |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 3372 | P6. I want my current directory to track my browsing. |
| 3373 | How do I do that? |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3374 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3375 | Put the following line in your |.vimrc|: |
| 3376 | > |
Bram Moolenaar | 433f7c8 | 2006-03-21 21:29:36 +0000 | [diff] [blame] | 3377 | let g:netrw_keepdir= 0 |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3378 | < |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3379 | *netrw-p7* |
| 3380 | P7. I use Chinese (or other non-ascii) characters in my filenames, and |
| 3381 | netrw (Explore, Sexplore, Hexplore, etc) doesn't display them! |
Bram Moolenaar | f6cf987 | 2005-08-08 22:00:59 +0000 | [diff] [blame] | 3382 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3383 | (taken from an answer provided by Wu Yongwei on the vim |
| 3384 | mailing list) |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3385 | I now see the problem. Your code page is not 936, right? Vim |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3386 | seems only able to open files with names that are valid in the |
| 3387 | current code page, as are many other applications that do not |
| 3388 | use the Unicode version of Windows APIs. This is an OS-related |
| 3389 | issue. You should not have such problems when the system |
| 3390 | locale uses UTF-8, such as modern Linux distros. |
| 3391 | |
| 3392 | (...it is one more reason to recommend that people use utf-8!) |
| 3393 | |
| 3394 | *netrw-p8* |
| 3395 | P8. I'm getting "ssh is not executable on your system" -- what do I |
| 3396 | do? |
| 3397 | |
| 3398 | (Dudley Fox) Most people I know use putty for windows ssh. It |
| 3399 | is a free ssh/telnet application. You can read more about it |
| 3400 | here: |
| 3401 | |
| 3402 | http://www.chiark.greenend.org.uk/~sgtatham/putty/ Also: |
| 3403 | |
| 3404 | (Marlin Unruh) This program also works for me. It's a single |
| 3405 | executable, so he/she can copy it into the Windows\System32 |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3406 | folder and create a shortcut to it. |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3407 | |
| 3408 | (Dudley Fox) You might also wish to consider plink, as it |
| 3409 | sounds most similar to what you are looking for. plink is an |
| 3410 | application in the putty suite. |
| 3411 | |
| 3412 | http://the.earth.li/~sgtatham/putty/0.58/htmldoc/Chapter7.html#plink |
| 3413 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3414 | (Vissale Neang) Maybe you can try OpenSSH for windows, which |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3415 | can be obtained from: |
| 3416 | |
| 3417 | http://sshwindows.sourceforge.net/ |
| 3418 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3419 | It doesn't need the full Cygwin package. |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3420 | |
| 3421 | (Antoine Mechelynck) For individual Unix-like programs needed |
| 3422 | for work in a native-Windows environment, I recommend getting |
| 3423 | them from the GnuWin32 project on sourceforge if it has them: |
| 3424 | |
| 3425 | http://gnuwin32.sourceforge.net/ |
| 3426 | |
| 3427 | Unlike Cygwin, which sets up a Unix-like virtual machine on |
| 3428 | top of Windows, GnuWin32 is a rewrite of Unix utilities with |
| 3429 | Windows system calls, and its programs works quite well in the |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3430 | cmd.exe "Dos box". |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3431 | |
| 3432 | (dave) Download WinSCP and use that to connect to the server. |
| 3433 | In Preferences > Editors, set gvim as your editor: |
| 3434 | |
| 3435 | - Click "Add..." |
| 3436 | - Set External Editor (adjust path as needed, include |
| 3437 | the quotes and !.! at the end): |
| 3438 | "c:\Program Files\Vim\vim70\gvim.exe" !.! |
| 3439 | - Check that the filetype in the box below is |
| 3440 | {asterisk}.{asterisk} (all files), or whatever types |
| 3441 | you want (cec: change {asterisk} to * ; I had to |
| 3442 | write it that way because otherwise the helptags |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3443 | system thinks it's a tag) |
| 3444 | - Make sure it's at the top of the listbox (click it, |
| 3445 | then click "Up" if it's not) |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3446 | If using the Norton Commander style, you just have to hit <F4> |
| 3447 | to edit a file in a local copy of gvim. |
| 3448 | |
| 3449 | (Vit Gottwald) How to generate public/private key and save |
| 3450 | public key it on server: > |
Bram Moolenaar | 5ac3b1a | 2010-07-27 22:50:36 +0200 | [diff] [blame] | 3451 | http://www.chiark.greenend.org.uk/~sgtatham/putty/0.60/htmldoc/Chapter8.html#pubkey-gettingready |
| 3452 | (8.3 Getting ready for public key authentication) |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3453 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3454 | How to use a private key with 'pscp': > |
| 3455 | |
Bram Moolenaar | 5ac3b1a | 2010-07-27 22:50:36 +0200 | [diff] [blame] | 3456 | http://www.chiark.greenend.org.uk/~sgtatham/putty/0.60/htmldoc/Chapter5.html |
| 3457 | (5.2.4 Using public key authentication with PSCP) |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3458 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3459 | (Ben Schmidt) I find the ssh included with cwRsync is |
| 3460 | brilliant, and install cwRsync or cwRsyncServer on most |
| 3461 | Windows systems I come across these days. I guess COPSSH, |
| 3462 | packed by the same person, is probably even better for use as |
| 3463 | just ssh on Windows, and probably includes sftp, etc. which I |
| 3464 | suspect the cwRsync doesn't, though it might |
| 3465 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3466 | (cec) To make proper use of these suggestions above, you will |
| 3467 | need to modify the following user-settable variables in your |
| 3468 | .vimrc: |
| 3469 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3470 | |g:netrw_ssh_cmd| |g:netrw_list_cmd| |g:netrw_mkdir_cmd| |
| 3471 | |g:netrw_rm_cmd| |g:netrw_rmdir_cmd| |g:netrw_rmf_cmd| |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3472 | |
| 3473 | The first one (|g:netrw_ssh_cmd|) is the most important; most |
| 3474 | of the others will use the string in g:netrw_ssh_cmd by |
| 3475 | default. |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3476 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3477 | *netrw-p9* *netrw-ml_get* |
| 3478 | P9. I'm browsing, changing directory, and bang! ml_get errors |
| 3479 | appear and I have to kill vim. Any way around this? |
| 3480 | |
| 3481 | Normally netrw attempts to avoid writing swapfiles for |
| 3482 | its temporary directory buffers. However, on some systems |
| 3483 | this attempt appears to be causing ml_get errors to |
| 3484 | appear. Please try setting |g:netrw_use_noswf| to 0 |
| 3485 | in your <.vimrc>: > |
| 3486 | let g:netrw_use_noswf= 0 |
| 3487 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3488 | *netrw-p10* |
| 3489 | P10. I'm being pestered with "[something] is a directory" and |
| 3490 | "Press ENTER or type command to continue" prompts... |
| 3491 | |
| 3492 | The "[something] is a directory" prompt is issued by Vim, |
| 3493 | not by netrw, and there appears to be no way to work around |
| 3494 | it. Coupled with the default cmdheight of 1, this message |
| 3495 | causes the "Press ENTER..." prompt. So: read |hit-enter|; |
| 3496 | I also suggest that you set your |'cmdheight'| to 2 (or more) in |
| 3497 | your <.vimrc> file. |
| 3498 | |
| 3499 | *netrw-p11* |
| 3500 | P11. I want to have two windows; a thin one on the left and my editing |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 3501 | window on the right. How may I accomplish this? |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3502 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3503 | You probably want netrw running as in a side window. If so, you |
| 3504 | will likely find that ":[N]Lexplore" does what you want. The |
| 3505 | optional "[N]" allows you to select the quantity of columns you |
Bram Moolenaar | d7464be | 2015-11-01 16:49:04 +0100 | [diff] [blame] | 3506 | wish the |:Lexplore|r window to start with (see |g:netrw_winsize| |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3507 | for how this parameter works). |
| 3508 | |
| 3509 | Previous solution: |
| 3510 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3511 | * Put the following line in your <.vimrc>: |
| 3512 | let g:netrw_altv = 1 |
| 3513 | * Edit the current directory: :e . |
| 3514 | * Select some file, press v |
| 3515 | * Resize the windows as you wish (see |CTRL-W_<| and |
| 3516 | |CTRL-W_>|). If you're using gvim, you can drag |
| 3517 | the separating bar with your mouse. |
| 3518 | * When you want a new file, use ctrl-w h to go back to the |
| 3519 | netrw browser, select a file, then press P (see |CTRL-W_h| |
| 3520 | and |netrw-P|). If you're using gvim, you can press |
| 3521 | <leftmouse> in the browser window and then press the |
| 3522 | <middlemouse> to select the file. |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3523 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3524 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3525 | *netrw-p12* |
| 3526 | P12. My directory isn't sorting correctly, or unwanted letters are |
| 3527 | appearing in the listed filenames, or things aren't lining |
| 3528 | up properly in the wide listing, ... |
| 3529 | |
| 3530 | This may be due to an encoding problem. I myself usually use |
| 3531 | utf-8, but really only use ascii (ie. bytes from 32-126). |
| 3532 | Multibyte encodings use two (or more) bytes per character. |
| 3533 | You may need to change |g:netrw_sepchr| and/or |g:netrw_xstrlen|. |
| 3534 | |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 3535 | *netrw-p13* |
| 3536 | P13. I'm a Windows + putty + ssh user, and when I attempt to browse, |
| 3537 | the directories are missing trailing "/"s so netrw treats them |
| 3538 | as file transfers instead of as attempts to browse |
| 3539 | subdirectories. How may I fix this? |
| 3540 | |
| 3541 | (mikeyao) If you want to use vim via ssh and putty under Windows, |
| 3542 | try combining the use of pscp/psftp with plink. pscp/psftp will |
| 3543 | be used to connect and plink will be used to execute commands on |
| 3544 | the server, for example: list files and directory using 'ls'. |
| 3545 | |
| 3546 | These are the settings I use to do this: |
| 3547 | > |
| 3548 | " list files, it's the key setting, if you haven't set, |
| 3549 | " you will get a blank buffer |
| 3550 | let g:netrw_list_cmd = "plink HOSTNAME ls -Fa" |
| 3551 | " if you haven't add putty directory in system path, you should |
| 3552 | " specify scp/sftp command. For examples: |
| 3553 | "let g:netrw_sftp_cmd = "d:\\dev\\putty\\PSFTP.exe" |
| 3554 | "let g:netrw_scp_cmd = "d:\\dev\\putty\\PSCP.exe" |
| 3555 | < |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 3556 | *netrw-p14* |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3557 | P14. I would like to speed up writes using Nwrite and scp/ssh |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 3558 | style connections. How? (Thomer M. Gil) |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 3559 | |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 3560 | Try using ssh's ControlMaster and ControlPath (see the ssh_config |
| 3561 | man page) to share multiple ssh connections over a single network |
| 3562 | connection. That cuts out the cryptographic handshake on each |
| 3563 | file write, sometimes speeding it up by an order of magnitude. |
| 3564 | (see http://thomer.com/howtos/netrw_ssh.html) |
| 3565 | (included by permission) |
| 3566 | |
| 3567 | Add the following to your ~/.ssh/config: > |
| 3568 | |
| 3569 | # you change "*" to the hostname you care about |
| 3570 | Host * |
| 3571 | ControlMaster auto |
| 3572 | ControlPath /tmp/%r@%h:%p |
| 3573 | |
| 3574 | < Then create an ssh connection to the host and leave it running: > |
| 3575 | |
| 3576 | ssh -N host.domain.com |
| 3577 | |
| 3578 | < Now remotely open a file with Vim's Netrw and enjoy the |
| 3579 | zippiness: > |
| 3580 | |
| 3581 | vim scp://host.domain.com//home/user/.bashrc |
| 3582 | < |
| 3583 | *netrw-p15* |
| 3584 | P15. How may I use a double-click instead of netrw's usual single click |
| 3585 | to open a file or directory? (Ben Fritz) |
| 3586 | |
| 3587 | First, disable netrw's mapping with > |
| 3588 | let g:netrw_mousemaps= 0 |
| 3589 | < and then create a netrw buffer only mapping in |
| 3590 | $HOME/.vim/after/ftplugin/netrw.vim: > |
| 3591 | nmap <buffer> <2-leftmouse> <CR> |
| 3592 | < Note that setting g:netrw_mousemaps to zero will turn off |
| 3593 | all netrw's mouse mappings, not just the <leftmouse> one. |
| 3594 | (see |g:netrw_mousemaps|) |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 3595 | |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 3596 | *netrw-p16* |
| 3597 | P16. When editing remote files (ex. :e ftp://hostname/path/file), |
| 3598 | under Windows I get an |E303| message complaining that its unable |
| 3599 | to open a swap file. |
| 3600 | |
| 3601 | (romainl) It looks like you are starting Vim from a protected |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3602 | directory. Start netrw from your $HOME or other writable |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 3603 | directory. |
| 3604 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3605 | *netrw-p17* |
| 3606 | P17. Netrw is closing buffers on its own. |
| 3607 | What steps will reproduce the problem? |
| 3608 | 1. :Explore, navigate directories, open a file |
| 3609 | 2. :Explore, open another file |
| 3610 | 3. Buffer opened in step 1 will be closed. o |
| 3611 | What is the expected output? What do you see instead? |
| 3612 | I expect both buffers to exist, but only the last one does. |
| 3613 | |
| 3614 | (Lance) Problem is caused by "set autochdir" in .vimrc. |
| 3615 | (drchip) I am able to duplicate this problem with |'acd'| set. |
| 3616 | It appears that the buffers are not exactly closed; |
| 3617 | a ":ls!" will show them (although ":ls" does not). |
| 3618 | |
| 3619 | *netrw-P18* |
| 3620 | P18. How to locally edit a file that's only available via |
| 3621 | another server accessible via ssh? |
| 3622 | See http://stackoverflow.com/questions/12469645/ |
| 3623 | "Using Vim to Remotely Edit A File on ServerB Only |
| 3624 | Accessible From ServerA" |
| 3625 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3626 | *netrw-P19* |
| 3627 | P19. How do I get numbering on in directory listings? |
| 3628 | With |g:netrw_bufsettings|, you can control netrw's buffer |
| 3629 | settings; try putting > |
| 3630 | let g:netrw_bufsettings="noma nomod nu nobl nowrap ro nornu" |
| 3631 | < in your .vimrc. If you'd like to have relative numbering |
| 3632 | instead, try > |
| 3633 | let g:netrw_bufsettings="noma nomod nonu nobl nowrap ro rnu" |
| 3634 | < |
| 3635 | *netrw-P20* |
| 3636 | P20. How may I have gvim start up showing a directory listing? |
| 3637 | Try putting the following code snippet into your .vimrc: > |
| 3638 | augroup VimStartup |
| 3639 | au! |
| 3640 | au VimEnter * if expand("%") == "" && argc() == 0 && |
| 3641 | \ (v:servername =~ 'GVIM\d*' || v:servername == "") |
| 3642 | \ | e . | endif |
| 3643 | augroup END |
| 3644 | < You may use Lexplore instead of "e" if you're so inclined. |
| 3645 | This snippet assumes that you have client-server enabled |
| 3646 | (ie. a "huge" vim version). |
| 3647 | |
| 3648 | *netrw-P21* |
| 3649 | P21. I've made a directory (or file) with an accented character, but |
| 3650 | netrw isn't letting me enter that directory/read that file: |
| 3651 | |
| 3652 | Its likely that the shell or o/s is using a different encoding |
| 3653 | than you have vim (netrw) using. A patch to vim supporting |
| 3654 | "systemencoding" may address this issue in the future; for |
| 3655 | now, just have netrw use the proper encoding. For example: > |
| 3656 | |
| 3657 | au FileType netrw set enc=latin1 |
| 3658 | < |
| 3659 | *netrw-P22* |
| 3660 | P22. I get an error message when I try to copy or move a file: |
| 3661 | |
| 3662 | **error** (netrw) tried using g:netrw_localcopycmd<cp>; it doesn't work! |
| 3663 | |
| 3664 | What's wrong? |
| 3665 | |
| 3666 | Netrw uses several system level commands to do things (see |
| 3667 | |
| 3668 | |g:netrw_localcopycmd|, |g:netrw_localmovecmd|, |
| 3669 | |g:netrw_localrmdir|, |g:netrw_mkdir_cmd|). |
| 3670 | |
| 3671 | You may need to adjust the default commands for one or more of |
| 3672 | these commands by setting them properly in your .vimrc. Another |
| 3673 | source of difficulty is that these commands use vim's local |
| 3674 | directory, which may not be the same as the browsing directory |
| 3675 | shown by netrw (see |g:netrw_keepdir|). |
| 3676 | |
| 3677 | |
Bram Moolenaar | c0197e2 | 2004-09-13 20:26:32 +0000 | [diff] [blame] | 3678 | ============================================================================== |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3679 | 11. Debugging Netrw Itself *netrw-debug* {{{1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3680 | |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3681 | Step 1: check that the problem you've encountered hasn't already been resolved |
| 3682 | by obtaining a copy of the latest (often developmental) netrw at: |
| 3683 | |
| 3684 | http://www.drchip.org/astronaut/vim/index.html#NETRW |
| 3685 | |
| 3686 | The <netrw.vim> script is typically installed on systems as something like: |
Bram Moolenaar | 488c651 | 2005-08-11 20:09:58 +0000 | [diff] [blame] | 3687 | > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3688 | /usr/local/share/vim/vim7x/plugin/netrwPlugin.vim |
| 3689 | /usr/local/share/vim/vim7x/autoload/netrw.vim |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3690 | (see output of :echo &rtp) |
Bram Moolenaar | 488c651 | 2005-08-11 20:09:58 +0000 | [diff] [blame] | 3691 | < |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3692 | which is loaded automatically at startup (assuming :set nocp). If you |
| 3693 | installed a new netrw, then it will be located at > |
| 3694 | |
| 3695 | $HOME/.vim/plugin/netrwPlugin.vim |
| 3696 | $HOME/.vim/autoload/netrw.vim |
| 3697 | < |
| 3698 | Step 2: assuming that you've installed the latest version of netrw, |
| 3699 | check that your problem is really due to netrw. Create a file |
| 3700 | called netrw.vimrc with the following contents: > |
| 3701 | |
| 3702 | set nocp |
| 3703 | so $HOME/.vim/plugin/netrwPlugin.vim |
| 3704 | < |
| 3705 | Then run netrw as follows: > |
| 3706 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 3707 | vim -u netrw.vimrc --noplugins -i NONE [some path here] |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3708 | < |
| 3709 | Perform whatever netrw commands you need to, and check that the problem is |
| 3710 | still present. This procedure sidesteps any issues due to personal .vimrc |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 3711 | settings, .viminfo file, and other plugins. If the problem does not appear, |
| 3712 | then you need to determine which setting in your .vimrc is causing the |
| 3713 | conflict with netrw or which plugin(s) is/are involved. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3714 | |
| 3715 | Step 3: If the problem still is present, then get a debugging trace from |
| 3716 | netrw: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3717 | |
| 3718 | 1. Get the <Decho.vim> script, available as: |
| 3719 | |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 3720 | http://www.drchip.org/astronaut/vim/index.html#DECHO |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3721 | or |
Bram Moolenaar | 482aaeb | 2005-09-29 18:26:07 +0000 | [diff] [blame] | 3722 | http://vim.sourceforge.net/scripts/script.php?script_id=120 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3723 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3724 | Decho.vim is provided as a "vimball"; see |vimball-intro|. |
Bram Moolenaar | f6cf987 | 2005-08-08 22:00:59 +0000 | [diff] [blame] | 3725 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3726 | 2. Edit the <netrw.vim> file by typing: > |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 3727 | |
| 3728 | vim netrw.vim |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3729 | :DechoOn |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 3730 | :wq |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3731 | < |
| 3732 | To restore to normal non-debugging behavior, re-edit <netrw.vim> |
| 3733 | and type > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3734 | |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 3735 | vim netrw.vim |
| 3736 | :DechoOff |
| 3737 | :wq |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3738 | < |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 3739 | This command, provided by <Decho.vim>, will comment out all |
| 3740 | Decho-debugging statements (Dfunc(), Dret(), Decho(), Dredir()). |
| 3741 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3742 | 3. Then bring up vim and attempt to evoke the problem by doing a |
| 3743 | transfer or doing some browsing. A set of messages should appear |
| 3744 | concerning the steps that <netrw.vim> took in attempting to |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3745 | read/write your file over the network in a separate tab or |
| 3746 | server vim window. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3747 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3748 | To save the file, use > |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 3749 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3750 | :tabnext |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3751 | :set bt= |
| 3752 | :w! DBG |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 3753 | |
| 3754 | < Furthermore, it'd be helpful if you would type > |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3755 | :Dsep <command> |
| 3756 | < where <command> is the command you're about to type next, |
| 3757 | thereby making it easier to associate which part of the |
| 3758 | debugging trace is due to which command. |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 3759 | |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3760 | Please send that information to <netrw.vim>'s maintainer along |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3761 | with the o/s you're using and the vim version that you're using |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3762 | (see |:version|) > |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 3763 | NdrOchip at ScampbellPfamily.AbizM - NOSPAM |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3764 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3765 | ============================================================================== |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 3766 | 12. History *netrw-history* {{{1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3767 | |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame^] | 3768 | v156: Feb 18, 2016 * Changed =~ to =~# where appropriate |
| 3769 | Feb 23, 2016 * s:ComposePath(base,subdir) now uses |
| 3770 | fnameescape() on the base portion |
| 3771 | Mar 01, 2016 * (gt_macki) reported where :Explore would |
| 3772 | make file unlisted. Fixed (tst943) |
| 3773 | Apr 04, 2016 * (reported by John Little) netrw normally |
| 3774 | suppresses browser messages, but sometimes |
| 3775 | those "messages" are what is wanted. |
| 3776 | See |g:netrw_suppress_gx_mesg| |
| 3777 | Apr 06, 2016 * (reported by Carlos Pita) deleting a remote |
| 3778 | file was giving an error message. Fixed. |
| 3779 | Apr 08, 2016 * (Charles Cooper) had a problem with an |
| 3780 | undefined b:netrw_curdir. He also provided |
| 3781 | a fix. |
| 3782 | Apr 20, 2016 * Changed s:NetrwGetBuffer(); now uses |
| 3783 | dictionaries. Also fixed the "No Name" |
| 3784 | buffer problem. |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 3785 | v155: Oct 29, 2015 * (Timur Fayzrakhmanov) reported that netrw's |
| 3786 | mapping of ctrl-l was not allowing refresh of |
| 3787 | other windows when it was done in a netrw |
| 3788 | window. |
| 3789 | Nov 05, 2015 * Improved s:TreeSqueezeDir() to use search() |
| 3790 | instead of a loop |
| 3791 | * NetrwBrowse() will return line to |
| 3792 | w:netrw_bannercnt if cursor ended up in |
| 3793 | banner |
| 3794 | Nov 16, 2015 * Added a <Plug>NetrwTreeSqueeze (|netrw-s-cr|) |
| 3795 | Nov 17, 2015 * Commented out imaps -- perhaps someone can |
| 3796 | tell me how they're useful and should be |
| 3797 | retained? |
| 3798 | Nov 20, 2015 * Added |netrw-ma| and |netrw-mA| support |
| 3799 | Nov 20, 2015 * gx (|netrw-gx|) on an url downloaded the |
| 3800 | file in addition to simply bringing up the |
| 3801 | url in a browser. Fixed. |
| 3802 | Nov 23, 2015 * Added |g:netrw_sizestyle| support |
| 3803 | Nov 27, 2015 * Inserted a lot of <c-u>s into various netrw |
| 3804 | maps. |
| 3805 | Jan 05, 2016 * |netrw-qL| implemented to mark files based |
| 3806 | upon |location-list|s; similar to |netrw-qF|. |
| 3807 | Jan 19, 2016 * using - call delete(directoryname,"d") - |
| 3808 | instead of using g:netrw_localrmdir if |
| 3809 | v7.4 + patch#1107 is available |
| 3810 | Jan 28, 2016 * changed to using |winsaveview()| and |
| 3811 | |winrestview()| |
| 3812 | Jan 28, 2016 * s:NetrwTreePath() now does a save and |
| 3813 | restore of view |
| 3814 | Feb 08, 2016 * Fixed a tree-listing problem with remote |
| 3815 | directories |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 3816 | v154: Feb 26, 2015 * (Yuri Kanivetsky) reported a situation where |
| 3817 | a file was not treated properly as a file |
| 3818 | due to g:netrw_keepdir == 1 |
| 3819 | Mar 25, 2015 * (requested by Ben Friz) one may now sort by |
| 3820 | extension |
| 3821 | Mar 28, 2015 * (requested by Matt Brooks) netrw has a lot |
| 3822 | of buffer-local mappings; however, some |
| 3823 | plugins (such as vim-surround) set up |
| 3824 | conflicting mappings that cause vim to wait. |
| 3825 | The "<nowait>" modifier has been included |
| 3826 | with most of netrw's mappings to avoid that |
| 3827 | delay. |
| 3828 | Jun 26, 2015 * |netrw-gn| mapping implemted |
| 3829 | * :Ntree NotADir resulted in having |
| 3830 | the tree listing expand in the error messages |
| 3831 | window. Fixed. |
| 3832 | Jun 29, 2015 * Attempting to delete a file remotely caused |
| 3833 | an error with "keepsol" mentioned; fixed. |
| 3834 | Jul 08, 2015 * Several changes to keep the |:jumps| table |
| 3835 | correct when working with |
| 3836 | |g:netrw_fastbrowse| set to 2 |
| 3837 | * wide listing with accented characters fixed |
| 3838 | (using %-S instead of %-s with a |printf()| |
| 3839 | Jul 13, 2015 * (Daniel Hahler) CheckIfKde() could be true |
| 3840 | but kfmclient not installed. Changed order |
| 3841 | in netrw#BrowseX(): checks if kde and |
| 3842 | kfmclient, then will use xdg-open on a unix |
| 3843 | system (if xdg-open is executable) |
| 3844 | Aug 11, 2015 * (McDonnell) tree listing mode wouldn't |
| 3845 | select a file in a open subdirectory. |
| 3846 | * (McDonnell) when multiple subdirectories |
| 3847 | were concurrently open in tree listing |
| 3848 | mode, a ctrl-L wouldn't refresh properly. |
| 3849 | * The netrw:target menu showed duplicate |
| 3850 | entries |
| 3851 | Oct 13, 2015 * (mattn) provided an exception to handle |
| 3852 | windows with shellslash set but no shell |
| 3853 | Oct 23, 2015 * if g:netrw_usetab and <c-tab> now used |
| 3854 | to control whether NetrwShrink is used |
| 3855 | (see |netrw-c-tab|) |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3856 | v153: May 13, 2014 * added another |g:netrw_ffkeep| usage {{{2 |
| 3857 | May 14, 2014 * changed s:PerformListing() so that it |
| 3858 | always sets ft=netrw for netrw buffers |
| 3859 | (ie. even when syntax highlighting is |
| 3860 | off, not available, etc) |
| 3861 | May 16, 2014 * introduced the |netrw-ctrl-r| functionality |
| 3862 | May 17, 2014 * introduced the |netrw-:NetrwMB| functionality |
| 3863 | * mb and mB (|netrw-mb|, |netrw-mB|) will |
| 3864 | add/remove marked files from bookmark list |
| 3865 | May 20, 2014 * (Enno Nagel) reported that :Lex <dirname> |
| 3866 | wasn't working. Fixed. |
| 3867 | May 26, 2014 * restored test to prevent leftmouse window |
| 3868 | resizing from causing refresh. |
| 3869 | (see s:NetrwLeftmouse()) |
| 3870 | * fixed problem where a refresh caused cursor |
| 3871 | to go just under the banner instead of |
| 3872 | staying put |
| 3873 | May 28, 2014 * (László Bimba) provided a patch for opening |
| 3874 | the |:Lexplore| window 100% high, optionally |
| 3875 | on the right, and will work with remote |
| 3876 | files. |
| 3877 | May 29, 2014 * implemented :NetrwC (see |netrw-:NetrwC|) |
| 3878 | Jun 01, 2014 * Removed some "silent"s from commands used |
| 3879 | to implemented scp://... and pscp://... |
| 3880 | directory listing. Permits request for |
| 3881 | password to appear. |
| 3882 | Jun 05, 2014 * (Enno Nagel) reported that user maps "/" |
| 3883 | caused problems with "b" and "w", which |
| 3884 | are mapped (for wide listings only) to |
| 3885 | skip over files rather than just words. |
| 3886 | Jun 10, 2014 * |g:netrw_gx| introduced to allow users to |
| 3887 | override default "<cfile>" with the gx |
| 3888 | (|netrw-gx|) map |
| 3889 | Jun 11, 2014 * gx (|netrw-gx|), with |'autowrite'| set, |
| 3890 | will write modified files. s:NetrwBrowseX() |
| 3891 | will now save, turn off, and restore the |
| 3892 | |'autowrite'| setting. |
| 3893 | Jun 13, 2014 * added visual map for gx use |
| 3894 | Jun 15, 2014 * (Enno Nagel) reported that with having hls |
| 3895 | set and wide listing style in use, that the |
| 3896 | b and w maps caused unwanted highlighting. |
| 3897 | Jul 05, 2014 * |netrw-mv| and |netrw-mX| commands included |
| 3898 | Jul 09, 2014 * |g:netrw_keepj| included, allowing optional |
| 3899 | keepj |
| 3900 | Jul 09, 2014 * fixing bugs due to previous update |
| 3901 | Jul 21, 2014 * (Bruno Sutic) provided an updated |
| 3902 | netrw_gitignore.vim |
| 3903 | Jul 30, 2014 * (Yavuz Yetim) reported that editing two |
| 3904 | remote files of the same name caused the |
| 3905 | second instance to have a "temporary" |
| 3906 | name. Fixed: now they use the same buffer. |
| 3907 | Sep 18, 2014 * (Yasuhiro Matsumoto) provided a patch which |
| 3908 | allows scp and windows local paths to work. |
| 3909 | Oct 07, 2014 * gx (see |netrw-gx|) when atop a directory, |
| 3910 | will now do |gf| instead |
| 3911 | Nov 06, 2014 * For cygwin: cygstart will be available for |
| 3912 | netrw#BrowseX() to use if its executable. |
| 3913 | Nov 07, 2014 * Began support for file://... urls. Will use |
| 3914 | |g:netrw_file_cmd| (typically elinks or links) |
| 3915 | Dec 02, 2014 * began work on having mc (|netrw-mc|) copy |
| 3916 | directories. Works for linux machines, |
| 3917 | cygwin+vim, but not for windows+gvim. |
| 3918 | Dec 02, 2014 * in tree mode, netrw was not opening |
| 3919 | directories via symbolic links. |
| 3920 | Dec 02, 2014 * added resolved link information to |
| 3921 | thin and tree modes |
| 3922 | Dec 30, 2014 * (issue#231) |:ls| was not showing |
| 3923 | remote-file buffers reliably. Fixed. |
| 3924 | v152: Apr 08, 2014 * uses the |'noswapfile'| option (requires {{{2 |
Bram Moolenaar | 1360030 | 2014-05-22 18:26:40 +0200 | [diff] [blame] | 3925 | vim 7.4 with patch 213) |
| 3926 | * (Enno Nagel) turn |'rnu'| off in netrw |
| 3927 | buffers. |
| 3928 | * (Quinn Strahl) suggested that netrw |
| 3929 | allow regular window splitting to occur, |
| 3930 | thereby allowing |'equalalways'| to take |
| 3931 | effect. |
| 3932 | * (qingtian zhao) normally, netrw will |
| 3933 | save and restore the |'fileformat'|; |
| 3934 | however, sometimes that isn't wanted |
| 3935 | Apr 14, 2014 * whenever netrw marks a buffer as ro, |
| 3936 | it will also mark it as nomod. |
| 3937 | Apr 16, 2014 * sftp protocol now supported by |
| 3938 | netrw#Obtain(); this means that one |
| 3939 | may use "mc" to copy a remote file |
| 3940 | to a local file using sftp, and that |
| 3941 | the |netrw-O| command can obtain remote |
| 3942 | files via sftp. |
| 3943 | * added [count]C support (see |netrw-C|) |
| 3944 | Apr 18, 2014 * when |g:netrw_chgwin| is one more than |
| 3945 | the last window, then vertically split |
| 3946 | the last window and use it as the |
| 3947 | chgwin window. |
| 3948 | May 09, 2014 * SavePosn was "saving filename under cursor" |
| 3949 | from a non-netrw window when using :Rex. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3950 | v151: Jan 22, 2014 * extended :Rexplore to return to buffer {{{2 |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3951 | prior to Explore or editing a directory |
| 3952 | * (Ken Takata) netrw gave error when |
| 3953 | clipboard was disabled. Sol'n: Placed |
| 3954 | several if has("clipboard") tests in. |
| 3955 | * Fixed ftp://X@Y@Z// problem; X@Y now |
| 3956 | part of user id, and only Z is part of |
| 3957 | hostname. |
| 3958 | * (A Loumiotis) reported that completion |
| 3959 | using a directory name containing spaces |
| 3960 | did not work. Fixed with a retry in |
| 3961 | netrw#Explore() which removes the |
| 3962 | backslashes vim inserted. |
| 3963 | Feb 26, 2014 * :Rexplore now records the current file |
| 3964 | using w:netrw_rexfile when returning via |
| 3965 | |:Rexplore| |
| 3966 | Mar 08, 2014 * (David Kotchan) provided some patches |
| 3967 | allowing netrw to work properly with |
| 3968 | windows shares. |
| 3969 | * Multiple one-liner help messages available |
| 3970 | by pressing <cr> while atop the "Quick |
| 3971 | Help" line |
| 3972 | * worked on ShellCmdPost, FocusGained event |
| 3973 | handling. |
| 3974 | * |:Lexplore| path: will be used to update |
| 3975 | a left-side netrw browsing directory. |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 3976 | Mar 12, 2014 * |netrw-s-cr|: use <s-cr> to close |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 3977 | tree directory implemented |
| 3978 | Mar 13, 2014 * (Tony Mechylynck) reported that using |
| 3979 | the browser with ftp on a directory, |
| 3980 | and selecting a gzipped txt file, that |
| 3981 | an E19 occurred (which was issued by |
| 3982 | gzip.vim). Fixed. |
| 3983 | Mar 14, 2014 * Implemented :MF and :MT (see |netrw-:MF| |
| 3984 | and |netrw-:MT|, respectively) |
| 3985 | Mar 17, 2014 * |:Ntree| [dir] wasn't working properly; fixed |
| 3986 | Mar 18, 2014 * Changed all uses of set to setl |
| 3987 | Mar 18, 2014 * Commented the netrw_btkeep line in |
| 3988 | s:NetrwOptionSave(); the effect is that |
| 3989 | netrw buffers will remain as |'bt'|=nofile. |
| 3990 | This should prevent swapfiles being created |
| 3991 | for netrw buffers. |
| 3992 | Mar 20, 2014 * Changed all uses of lcd to use s:NetrwLcd() |
| 3993 | instead. Consistent error handling results |
| 3994 | and it also handles Window's shares |
| 3995 | * Fixed |netrw-d| command when applied with ftp |
| 3996 | * https: support included for netrw#NetRead() |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 3997 | v150: Jul 12, 2013 * removed a "keepalt" to allow ":e #" to {{{2 |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 3998 | return to the netrw directory listing |
| 3999 | Jul 13, 2013 * (Jonas Diemer) suggested changing |
| 4000 | a <cWORD> to <cfile>. |
| 4001 | Jul 21, 2013 * (Yuri Kanivetsky) reported that netrw's |
| 4002 | use of mkdir did not produce directories |
Bram Moolenaar | a687837 | 2014-03-22 21:02:50 +0100 | [diff] [blame] | 4003 | following the user's umask. |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 4004 | Aug 27, 2013 * introduced |g:netrw_altfile| option |
| 4005 | Sep 05, 2013 * s:Strlen() now uses |strdisplaywidth()| |
| 4006 | when available, by default |
| 4007 | Sep 12, 2013 * (Selyano Baldo) reported that netrw wasn't |
| 4008 | opening some directories properly from the |
| 4009 | command line. |
| 4010 | Nov 09, 2013 * |:Lexplore| introduced |
| 4011 | * (Ondrej Platek) reported an issue with |
| 4012 | netrw's trees (P15). Fixed. |
| 4013 | * (Jorge Solis) reported that "t" in |
| 4014 | tree mode caused netrw to forget its |
| 4015 | line position. |
| 4016 | Dec 05, 2013 * Added <s-leftmouse> file marking |
| 4017 | (see |netrw-mf|) |
| 4018 | Dec 05, 2013 * (Yasuhiro Matsumoto) Explore should use |
| 4019 | strlen() instead s:Strlen() when handling |
| 4020 | multibyte chars with strpart() |
| 4021 | (ie. strpart() is byte oriented, not |
| 4022 | display-width oriented). |
| 4023 | Dec 09, 2013 * (Ken Takata) Provided a patch; File sizes |
| 4024 | and a portion of timestamps were wrongly |
| 4025 | highlighted with the directory color when |
| 4026 | setting `:let g:netrw_liststyle=1` on Windows. |
| 4027 | * (Paul Domaskis) noted that sometimes |
| 4028 | cursorline was activating in non-netrw |
| 4029 | windows. All but one setting of cursorline |
| 4030 | was done via setl; there was one that was |
| 4031 | overlooked. Fixed. |
| 4032 | Dec 24, 2013 * (esquifit) asked that netrw allow the |
| 4033 | /cygdrive prefix be a user-alterable |
| 4034 | parameter. |
| 4035 | Jan 02, 2014 * Fixed a problem with netrw-based ballon |
| 4036 | evaluation (ie. netrw#NetrwBaloonHelp() |
| 4037 | not having been loaded error messages) |
| 4038 | Jan 03, 2014 * Fixed a problem with tree listings |
| 4039 | * New command installed: |:Ntree| |
| 4040 | Jan 06, 2014 * (Ivan Brennan) reported a problem with |
| 4041 | |netrw-P|. Fixed. |
| 4042 | Jan 06, 2014 * Fixed a problem with |netrw-P| when the |
| 4043 | modified file was to be abandoned. |
| 4044 | Jan 15, 2014 * (Matteo Cavalleri) reported that when the |
| 4045 | banner is suppressed and tree listing is |
| 4046 | used, a blank line was left at the top of |
| 4047 | the display. Fixed. |
| 4048 | Jan 20, 2014 * (Gideon Go) reported that, in tree listing |
| 4049 | style, with a previous window open, that |
| 4050 | the wrong directory was being used to open |
| 4051 | a file. Fixed. (P21) |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 4052 | v149: Apr 18, 2013 * in wide listing format, now have maps for {{{2 |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 4053 | w and b to move to next/previous file |
| 4054 | Apr 26, 2013 * one may now copy files in the same |
| 4055 | directory; netrw will issue requests for |
| 4056 | what names the files should be copied under |
| 4057 | Apr 29, 2013 * Trying Benzinger's problem again. Seems |
| 4058 | that commenting out the BufEnter and |
| 4059 | installing VimEnter (only) works. Weird |
| 4060 | problem! (tree listing, vim -O Dir1 Dir2) |
| 4061 | May 01, 2013 * :Explore ftp://... wasn't working. Fixed. |
| 4062 | May 02, 2013 * introduced |g:netrw_bannerbackslash| as |
| 4063 | requested by Paul Domaskis. |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 4064 | Jul 03, 2013 * Explore now avoids splitting when a buffer |
| 4065 | will be hidden. |
Bram Moolenaar | 8feef4f | 2015-01-07 16:57:10 +0100 | [diff] [blame] | 4066 | v148: Apr 16, 2013 * changed Netrw's Style menu to allow direct {{{2 |
Bram Moolenaar | ff03419 | 2013-04-24 18:51:19 +0200 | [diff] [blame] | 4067 | choice of listing style, hiding style, and |
| 4068 | sorting style |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4069 | |
| 4070 | ============================================================================== |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 4071 | 13. Todo *netrw-todo* {{{1 |
| 4072 | |
| 4073 | 07/29/09 : banner :|g:netrw_banner| can be used to suppress the |
| 4074 | suppression banner. This feature is new and experimental, |
| 4075 | so its in the process of being debugged. |
| 4076 | 09/04/09 : "gp" : See if it can be made to work for remote systems. |
| 4077 | : See if it can be made to work with marked files. |
| 4078 | |
| 4079 | ============================================================================== |
| 4080 | 14. Credits *netrw-credits* {{{1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4081 | |
| 4082 | Vim editor by Bram Moolenaar (Thanks, Bram!) |
| 4083 | dav support by C Campbell |
| 4084 | fetch support by Bram Moolenaar and C Campbell |
Bram Moolenaar | 482aaeb | 2005-09-29 18:26:07 +0000 | [diff] [blame] | 4085 | ftp support by C Campbell <NdrOchip@ScampbellPfamily.AbizM> |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4086 | http support by Bram Moolenaar <bram@moolenaar.net> |
| 4087 | rcp |
| 4088 | rsync support by C Campbell (suggested by Erik Warendorph) |
| 4089 | scp support by raf <raf@comdyn.com.au> |
| 4090 | sftp support by C Campbell |
| 4091 | |
| 4092 | inputsecret(), BufReadCmd, BufWriteCmd contributed by C Campbell |
| 4093 | |
| 4094 | Jérôme Augé -- also using new buffer method with ftp+.netrc |
Bram Moolenaar | 482aaeb | 2005-09-29 18:26:07 +0000 | [diff] [blame] | 4095 | Bram Moolenaar -- obviously vim itself, :e and v:cmdarg use, |
Bram Moolenaar | 7aa9f6a | 2007-05-10 18:00:30 +0000 | [diff] [blame] | 4096 | fetch,... |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4097 | Yasuhiro Matsumoto -- pointing out undo+0r problem and a solution |
| 4098 | Erik Warendorph -- for several suggestions (g:netrw_..._cmd |
| 4099 | variables, rsync etc) |
Bram Moolenaar | 482aaeb | 2005-09-29 18:26:07 +0000 | [diff] [blame] | 4100 | Doug Claar -- modifications to test for success with ftp |
Bram Moolenaar | 7aa9f6a | 2007-05-10 18:00:30 +0000 | [diff] [blame] | 4101 | operation |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4102 | |
| 4103 | ============================================================================== |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4104 | Modelines: {{{1 |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 4105 | vim:tw=78:ts=8:ft=help:norl:fdm=marker |