annotate runtime/doc/pi_netrw.txt @ 24:8ff7fd162d3c v7.0016

updated for version 7.0016
author vimboss
date Mon, 13 Sep 2004 20:26:32 +0000
parents cc049b00ee70
children 404aac550f35
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1 *pi_netrw.txt For Vim version 6.2. Last change: Sep 10, 2004
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 VIM REFERENCE MANUAL by Charles E. Campbell, Jr.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
6 *dav* *http* *network* *rcp* *scp*
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
7 *fetch* *netrw* *Nread* *rsync* *sftp*
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
8 *ftp* *netrw.vim* *Nwrite* *netrw-file*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 0. Contents *netrw-contents*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 1. Netrw Reference.....................................|netrw-ref|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 2. Network-Oriented File Transfer......................|netrw-xfer|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 3. Activation..........................................|netrw-activate|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 4. Transparent File Transfer...........................|netrw-transparent|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 5. Ex Commands.........................................|netrw-ex|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 6. Variables and Options...............................|netrw-var|
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
19 7. Directory Browser...................................|netrw-browse|
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
20 8. Problems and Fixes..................................|netrw-problems|
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
21 9. Debugging...........................................|netrw-debug|
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
22 10. History.............................................|netrw-history|
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
23 11. Credits.............................................|netrw-credits|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 The functionality mentioned here is done via using |standard-plugin|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 techniques. This plugin is only available if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
28 set nocp " 'compatible' is not set
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
29 filetype plugin on " plugins are enabled
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 You can avoid loading this plugin by setting the "loaded_netrw" variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 in your <.vimrc> file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 :let loaded_netrw = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 {Vi does not have any of this}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 1. Netrw Reference *netrw-ref*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 OPTIONS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 let g:netrw_ftp =0 use ftp (default) (uid password)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 =1 use alternate ftp method (user uid password)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 If you're having trouble with ftp, try changing the value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45 of this variable in your <.vimrc> to change methods
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 let g:netrw_ignorenetrc= 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 If you have a <.netrc> file but it doesn't work and you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 want it ignored, then set this variable as shown. Its mere
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 existence is enough to cause <.netrc> to be ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 Controlling External Applications
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
54 Protocol Variable Default Value
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
55 -------- ---------------- -------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
56 dav: g:netrw_dav_cmd = "cadaver"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
57 fetch: g:netrw_fetch_cmd = "fetch -o"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
58 ftp: g:netrw_ftp_cmd = "ftp"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
59 http: g:netrw_http_cmd = "fetch -o" if fetch is available
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
60 http: g:netrw_http_cmd = "wget -q -O" If wget is available
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
61 rcp: g:netrw_rcp_cmd = "rcp"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
62 rsync: g:netrw_rsync_cmd = "rsync -a"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
63 scp: g:netrw_scp_cmd = "scp -q"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 sftp: g:netrw_sftp_cmd = "sftp"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
66 READING *netrw-read* *netrw-nread*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 :Nread ? give help
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
68 :Nread "machine:path" uses rcp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
69 :Nread "machine path" uses ftp with <.netrc>
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
70 :Nread "machine id password path" uses ftp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
71 :Nread "dav://machine[:port]/path" uses cadaver
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
72 :Nread "fetch://[user@]machine/path" uses fetch
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
73 :Nread "ftp://[user@]machine[[:#]port]/path" uses ftp autodetects <.netrc>
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
74 :Nread "http://[user@]machine/path" uses http uses wget
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
75 :Nread "rcp://[user@]machine/path" uses rcp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
76 :Nread "rsync://[user@]machine[:port]/path" uses rsync
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
77 :Nread "scp://[user@]machine[[:#]port]/path" uses scp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
78 :Nread "sftp://[user@]machine/path" uses sftp
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
80 WRITING *netrw-write* *netrw-nwrite*
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
81 :Nwrite ? give help
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
82 :Nwrite "machine:path" uses rcp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
83 :Nwrite "machine path" uses ftp with <.netrc>
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
84 :Nwrite "machine id password path" uses ftp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
85 :Nwrite "dav://machine[:port]/path" uses cadaver
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
86 :Nwrite "ftp://[user@]machine[[:#]port]/path" uses ftp autodetects <.netrc>
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
87 :Nwrite "rcp://[user@]machine/path" uses rcp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
88 :Nwrite "rsync://[user@]machine[:port]/path" uses rsync
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
89 :Nwrite "scp://[user@]machine[[:#]port]/path" uses scp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
90 :Nwrite "sftp://[user@]machine/path" uses sftp
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 http: not supported!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
93 DIRECTORY LISTING
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
94 :Nread [protocol]://[user]@hostname/path/
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
95
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 USER AND PASSWORD CHANGING
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97 Attempts to use ftp will prompt you for a user-id and a password.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 These will be saved in g:netrw_uid and g:netrw_passwd Subsequent uses
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99 of ftp will re-use those. If you need to use a different user id
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 and/or password, you'll want to call NetUserPass() first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 :NetUserPass [uid [password]] -- prompts as needed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 :call NetUserPass() -- prompts for uid and password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 :call NetUserPass("uid") -- prompts for password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105 :call NetUserPass("uid","password") -- sets global uid and password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
107 VARIABLES *netrw-variables*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 b:netrw_lastfile last file Network-read/written retained on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109 a per-buffer basis (supports plain :Nw )
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 s:netrw_line during Nw/NetWrite, holds current line number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 s:netrw_col during Nw/NetWrite, holds current column number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 s:netrw_line and s:netrw_col are used to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113 restore the cursor position on writes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 g:netrw_ftp if it doesn't exist, use default ftp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 =0 use default ftp (uid password)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116 =1 use alternate ftp method (user uid password)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117 g:netrw_ftpmode ="binary" (default)
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
118 ="ascii"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 g:netrw_uid (ftp) user-id, retained on a per-session basis
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120 g:netrw_passwd (ftp) password, retained on a per-session basis
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
121 g:netrw_win95ftp =1 if using Win95, will remove four trailing blank
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
122 lines that o/s's ftp "provides" on transfers
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
123 =0 force normal ftp behavior (no trailing line
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
124 removal)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
125 g:netrw_cygwin =1 assume scp under windows is from cygwin
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
126 Also permits network browsing to use
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
127 ls with time and size sorting
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 (default if windows)
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
129 =0 assume Windows' scp accepts windows-style paths
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
130 Network browsing uses dir instead of ls
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
131 This option is ignored if you're using unix
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
132 g:netrw_use_nt_rcp=0 don't use the rcp of WinNT, Win2000 and WinXP
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
133 =1 use WinNT's rcp in binary mode (default)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
135 PATHS *netrw-path*
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
136
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
137 Paths to files are generally user-directory relative for most protocols.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
138 It is possible that some protocol will make paths relative to some
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
139 associated directory, however.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
140
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
141 example: vim scp://user@host/somefile
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
142 example: vim scp://user@host/subdir1/subdir2/somefile
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
143
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
144 where "somefile" is the "user"'s home directory. If you wish to get a
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
145 file using root-relative paths, use the full path:
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
146
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
147 example: vim scp://user@host//somefile
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
148 example: vim scp://user@host//subdir1/subdir2/somefile
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
149
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 2. Network-Oriented File Transfer *netrw-xfer*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154 Network-oriented file transfer under Vim is implemented by a VimL-based script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155 (<netrw.vim>) using plugin techniques. It currently supports both reading
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156 and writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
157 dav/cadaver, rsync, or sftp.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
158
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
159 http is currently supported read-only via use of wget or fetch.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
160
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
161 <netrw.vim> is a standard plugin which acts as glue between Vim and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
162 various file transfer programs. It uses autocommand events (BufReadCmd,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
163 FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
164
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
165 ex. vim ftp://hostname/path/to/file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
166 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
167 The characters preceding the colon specify the protocol to use;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
168 in the example, its ftp. The <netrw.vim> script then formulates
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
169 a command or a series of commands (typically ftp) which it issues
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
170 to an external program (ftp, scp, etc) which does the actual file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
171 transfer/protocol. Files are read from/written to a temporary file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
172 (under Unix/Linux, /tmp/...) which the <netrw.vim> script will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
173 clean up.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
174
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
175 One may modify any protocol's implementing external application
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
176 by setting a variable (ex. scp uses the variable g:netrw_scp_cmd,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
177 which is defaulted to "scp -q").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
178
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
179 Ftp, an old protocol, seems to be blessed by numerous implementations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
180 Unfortunately, some implementations are noisy (ie., add junk to the end
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181 of the file). Thus, concerned users may decide to write a NetReadFixup()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182 function that will clean up after reading with their ftp. Some Unix systems
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183 (ie., FreeBSD) provide a utility called "fetch" which uses the ftp protocol
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
184 but is not noisy and more convenient, actually, for <netrw.vim> to use.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
185 Consequently, if "fetch" is executable, it will be used to do reads for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
186 ftp://... (and http://...) . See |netrw-var| for more about this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
187
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
188 For rcp, scp, sftp, and http, one may use network-oriented file transfers
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
189 transparently; ie.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
190 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
191 vim rcp://[user@]machine/path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
192 vim scp://[user@]machine/path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
193 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
194 If your ftp supports <.netrc>, then it too can be just as transparently used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
195 if the needed triad of machine name, user id, and password are present in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
196 that file. Your ftp must be able to use the <.netrc> file on its own, however.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
197 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
198 vim ftp://[user@]machine[[:#]portnumber]/path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
199 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
200 However, ftp will often need to query the user for the userid and password.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
201 The latter will be done "silently"; ie. asterisks will show up instead of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
202 the actually-typed-in password. Netrw will retain the userid and password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
203 for subsequent read/writes from the most recent transfer so subsequent
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
204 transfers (read/write) to or from that machine will take place without
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
205 additional prompting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
206
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
207 *netrw-urls*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
208 +=================================+============================+============+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
209 | Reading | Writing | Uses |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
210 +=================================+============================+============+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
211 | DAV: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
212 | dav://host/path | | cadaver |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
213 | :Nread dav://host/path | :Nwrite dav://host/path | cadaver |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
214 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
215 | FETCH: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
216 | fetch://[user@]host/path | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
217 | fetch://[user@]host:http/path | Not Available | fetch |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
218 | :Nread fetch://[user@]host/path| | |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
219 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
220 | FILE: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
221 | file:///* | file:///* | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
222 | file://localhost/* | file://localhost/* | |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
223 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
224 | FTP: (*3) | (*3) | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
225 | ftp://[user@]host/path | ftp://[user@]host/path | ftp (*2) |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
226 | :Nread ftp://host/path | :Nwrite ftp://host/path | ftp+.netrc |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
227 | :Nread host path | :Nwrite host path | ftp+.netrc |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
228 | :Nread host uid pass path | :Nwrite host uid pass path | ftp |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
229 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
230 | HTTP: wget is executable: (*4) | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
231 | http://[user@]host/path | Not Available | wget |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
232 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
233 | HTTP: fetch is executable (*4) | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
234 | http://[user@]host/path | Not Available | fetch |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
235 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
236 | RCP: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
237 | rcp://[user@]host/path | rcp://[user@]host/path | rcp |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
238 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
239 | RSYNC: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
240 | rsync://[user@]host/path | rsync://[user@]host/path | rsync |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
241 | :Nread rsync://host/path | :Nwrite rsync://host/path | rsync |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
242 | :Nread rcp://host/path | :Nwrite rcp://host/path | rcp |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
243 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
244 | SCP: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
245 | scp://[user@]host/path | scp://[user@]host/path | scp |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
246 | :Nread scp://host/path | :Nwrite scp://host/path | scp (*1) |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
247 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
248 | SFTP: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
249 | sftp://[user@]host/path | sftp://[user@]host/path | sftp |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
250 | :Nread sftp://host/path | :Nwrite sftp://host/path | sftp (*1) |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
251 +=================================+============================+============+
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
252
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
253 (*1) For an absolute path use scp://machine//path.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
254
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
255 (*2) if <.netrc> is present, it is assumed that it will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
256 work with your ftp client. Otherwise the script will
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
257 prompt for user-id and pasword.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
258
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
259 (*3) for ftp, "machine" may be machine#port or machine:port
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
260 if a different port is needed than the standard ftp port
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
261
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
262 (*4) for http:..., if wget is available it will be used. Otherwise,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
263 if fetch is available it will be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
264
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
265 Both the :Nread and the :Nwrite ex-commands can accept multiple filenames.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
266
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
267
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
268 NETRC *netrw-netrc*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
269
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
270 The typical syntax for lines in a <.netrc> file is given as shown below.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
271 Ftp under Unix usually support <.netrc>; Windows' ftp usually doesn't.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
272 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
273 machine {full machine name} login {user-id} password "{password}"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
274 default login {user-id} password "{password}"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
275
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
276 Your ftp client must handle the use of <.netrc> on its own, but if the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
277 <.netrc> file exists, an ftp transfer will not ask for the user-id or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
278 password.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
279
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
280 Note:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
281 Since this file contains passwords, make very sure nobody else can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
282 read this file! Most programs will refuse to use a .netrc that is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
283 readable for others. Don't forget that the system administrator can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
284 still read the file!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
285
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
286
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
287 PASSWORD *netrw-passwd*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
288
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
289 The script attempts to get passwords for ftp invisibly using |inputsecret()|,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
290 a built-in Vim function. See |netrw-uidpass| for how to change the password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
291 after one has set it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
292
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
293 Unfortunately there doesn't appear to be a way for netrw to feed a password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
294 to scp. Thus every transfer via scp will require re-entry of the password.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
295
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
296
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
297 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
298 3. Activation *netrw-activate*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
299
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
300 Network-oriented file transfers are available by default whenever
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
301 |'nocompatible'| mode is enabled. The <netrw.vim> file resides in your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
302 system's vim-plugin directory and is sourced automatically whenever you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
303 bring up vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
304
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
305
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
306 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
307 4. Transparent File Transfer *netrw-transparent*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
308
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
309 Transparent file transfers occur whenever a regular file read or write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
310 (invoked via an |:autocmd| for |BufReadCmd| or |BufWriteCmd| events) is made.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
311 Thus one may use files across networks as if they were local. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
312
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
313 vim ftp://[user@]machine/path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
314 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
315 :wq
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
316
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
317
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
318 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
319 5. Ex Commands *netrw-ex*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
320
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
321 The usual read/write commands are supported. There are also a couple of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
322 additional commands available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
323
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
324 :[range]Nw Write the specified lines to the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
325 file as specified in b:netrw_lastfile.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
326
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
327 :[range]Nw {netfile} [{netfile}]...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
328 Write the specified lines to the {netfile}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
329
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
330 :Nread
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
331 Read the specified lines into the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
332 buffer from the file specified in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
333 b:netrw_lastfile.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
334
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
335 :Nread {netfile} {netfile}...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
336 Read the {netfile} after the current line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
337
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
338 *netrw-uidpass*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
339 :call NetUserPass()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
340 If b:netrw_uid and b:netrw_passwd don't exist,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
341 this function query the user for them.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
342
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
343 :call NetUserPass("userid")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
344 This call will set the b:netrw_uid and, if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
345 the password doesn't exist, will query the user for it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
346
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
347 :call NetUserPass("userid","passwd")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
348 This call will set both the b:netrw_uid and b:netrw_passwd.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
349 The user-id and password are used by ftp transfers. One may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
350 effectively remove the user-id and password by using ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
351 strings.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
352
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
353
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
354 ==============================================================================
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
355 6. Variables and Options *netrw-options* *netrw-var*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
356
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
357 The script <netrw.vim> uses several variables which can affect <netrw.vim>'s
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
358 behavior. These variables typically may be set in the user's <.vimrc> file:
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
359 >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
360 -------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
361 Netrw Options
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
362 -------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
363 Option Meaning
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
364 -------------- -----------------------------------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
365 <
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
366 b:netrw_col Holds current cursor position (during NetWrite)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
367 g:netrw_cygwin =1 assume scp under windows is from cygwin
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
368 (default/windows)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
369 =0 assume scp under windows accepts windows
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
370 style paths (default/else)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
371 g:netrw_ftp =0 use default ftp (uid password)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
372 g:netrw_ftpmode ="binary" (default)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
373 ="ascii" (your choice)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
374 g:netrw_ignorenetrc =1 (default)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
375 if you have a <.netrc> file but you don't
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
376 want it used, then set this variable. Its
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
377 mere existence is enough to cause <.netrc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
378 to be ignored.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
379 b:netrw_lastfile Holds latest method/machine/path.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
380 b:netrw_line Holds current line number (during NetWrite)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
381 g:netrw_passwd Holds current password for ftp.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
382 g:netrw_silent =0 transfers done normally
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
383 =1 transfers done silently
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
384 g:netrw_uid Holds current user-id for ftp.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
385 =1 use alternate ftp (user uid password)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
386 (see |netrw-options|)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
387 g:netrw_use_nt_rcp =0 don't use WinNT/2K/XP's rcp (default)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
388 =1 use WinNT/2K/XP's rcp, binary mode
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
389 g:netrw_win95ftp =0 use unix-style ftp even if win95/98/ME/etc
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
390 =1 use default method to do ftp >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
391 -----------------------------------------------------------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
392 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
393 The script will also make use of the following variables internally, albeit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
394 temporarily.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
395 >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
396 -------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
397 Temporary Variables
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
398 -------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
399 Variable Meaning
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
400 -------- ------------------------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
401 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
402 g:netrw_method Index indicating rcp/ftp+.netrc/ftp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
403 g:netrw_machine Holds machine name parsed from input
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
404 g:netrw_fname Holds filename being accessed >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
405 ------------------------------------------------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
406 <
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
407 *netrw-protocol*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
408
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
409 Netrw supports a number of protocols. These protocols are invoked using the
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
410 variables listed below, and may be modified by the user.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
411 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
412 ------------------------
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
413 Protocol Control Options
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
414 ------------------------
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
415 Option Type Setting Meaning
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
416 --------- -------- -------------- ---------------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
417 <
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
418 netrw_ftp variable =doesn't exist userid set by "user userid"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
419 =0 userid set by "user userid"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
420 =1 userid set by "userid"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
421 NetReadFixup function =doesn't exist no change
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
422 =exists Allows user to have files
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
423 read via ftp automatically
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
424 transformed however they wish
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
425 by NetReadFixup()
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
426 g:netrw_dav_cmd variable ="cadaver"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
427 g:netrw_fetch_cmd variable ="fetch -o"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
428 g:netrw_ftp_cmd variable ="ftp"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
429 g:netrw_http_cmd variable ="fetch -o" else if fetch is executable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
430 g:netrw_http_cmd variable ="wget -O" if wget is executable
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
431 g:netrw_list_cmd variable ="ssh HOSTNAME ls -Fa"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
432 g:netrw_rcp_cmd variable ="rcp"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
433 g:netrw_rsync_cmd variable ="rsync -a"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
434 g:netrw_scp_cmd variable ="scp -q"
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
435 g:netrw_sftp_cmd variable ="sftp" >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
436 -------------------------------------------------------------------------
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
437 <
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
438 *netrw-ftp*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
439 The first two options both help with certain ftp's that give trouble otherwise.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
440 In order to best understand how to use these options if ftp is giving you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
441 troubles, a bit of discussion follows on how netrw does ftp reads.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
442
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
443 The g:netrw_..._cmd variables specify the external program to use handle
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
444 the associated protocol (rcp, ftp, etc), plus any options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
445
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
446 The g:netrw_list_cmd's HOSTNAME entry will be changed via substitution with
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
447 whatever the current request is for a hostname.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
448
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
449 For ftp, netrw typically builds up lines of one of the following formats in a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
450 temporary file:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
451 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
452 IF g:netrw_ftp !exists or is not 1 IF g:netrw_ftp exists and is 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
453 ---------------------------------- ------------------------------
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
454 <
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
455 open machine [port] open machine [port]
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
456 user userid password userid password
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
457 [g:netrw_ftpmode] password
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
458 get filename tempfile [g:netrw_ftpmode]
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
459 get filename tempfile >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
460 ---------------------------------------------------------------------
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
461 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
462 Netrw then executes the lines above by use of a filter:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
463 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
464 :%! {g:netrw_ftp_cmd} -i [-n]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
465 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
466
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
467 where
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
468 g:netrw_ftp_cmd is usually "ftp",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
469 -i tells ftp not to be interactive
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
470 -n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
471
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
472 If <.netrc> exists it will be used to avoid having to query the user for
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
473 userid and password. The transferred file is put into a temporary file.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
474 The temporary file is then read into the main editing session window that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
475 requested it and the temporary file deleted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
476
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
477 If your ftp doesn't accept the "user" command and immediately just demands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
478 a userid, then try putting "let netrw_ftp=1" in your <.vimrc>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
479
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
480 *netrw-cadaver*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
481 To handle the SSL certificate dialog for untrusted servers, one may pull
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
482 down the certificate and place it into /usr/ssl/cert.pem. This operation
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
483 renders the server treatment as "trusted".
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
484
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
485 *netrw-fixup*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
486 If your ftp for whatever reason generates unwanted lines (such as AUTH
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
487 messages) you may write a NetReadFixup(tmpfile) function:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
488 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
489 function! NetReadFixup(method,line1,line2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
490 " a:line1: first new line in current file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
491 " a:line2: last new line in current file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
492 if a:method == 1 "rcp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
493 elseif a:method == 2 "ftp + <.netrc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
494 elseif a:method == 3 "ftp + machine,uid,password,filename
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
495 elseif a:method == 4 "scp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
496 elseif a:method == 5 "http/wget
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
497 elseif a:method == 6 "dav/cadaver
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
498 elseif a:method == 7 "rsync
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
499 elseif a:method == 8 "fetch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
500 elseif a:method == 9 "sftp
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
501 else " complain
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
502 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
503 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
504 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
505 The NetReadFixup() function will be called if it exists and thus allows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
506 you to customize your reading process. As a further example, <netrw.vim>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
507 contains just such a function to handle Windows 95 ftp. For whatever
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
508 reason, Windows 95's ftp dumps four blank lines at the end of a transfer,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
509 and so it is desirable to automate their removal. Here's some code taken
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
510 from <netrw.vim> itself:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
511 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
512 if has("win95") && g:netrw_win95ftp
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
513 fun! NetReadFixup(method, line1, line2)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
514 if method == 3 " ftp (no <.netrc>)
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
515 let fourblanklines= line2 - 3
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
516 silent fourblanklines.",".line2."g/^\s*/d"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
517 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
518 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
519 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
520 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
521
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
522 ==============================================================================
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
523 7. Directory Browser *netrw-browse* *netrw-dir* *netrw-list* *netrw-help*
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
524 ?..........Help....................................|netrw-help|
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
525 <cr>.......Browsing................................|netrw-cr|
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
526 <del>......Deleting Files or Directories...........|netrw-delete|
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
527 -..........Going Up................................|netrw--|
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
528 a..........Hiding Files or Directories.............|netrw-a|
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
529 b..........Bookmarking a Directory.................|netrw-b|
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
530 B..........Changing to a Bookmarked Directory......|netrw-B|
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
531 c..........Make Browsing Directory The Current Dir.|netrw-c|
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
532 d..........Make A New Directory....................|netrw-d|
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
533 D..........Deleting Files or Directories...........|netrw-D|
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
534 <c-h>......Edit File/Directory Hiding List.........|netrw-h|
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
535 i..........Long Listing............................|netrw-i|
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
536 <c-l>......Refreshing the Listing..................|netrw-ctrl-l|
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
537 o..........Browsing with a Horizontal Split........|netrw-o|
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
538 p..........Preview Window..........................|netrw-p|
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
539 q..........Listing Bookmarks.......................|netrw-q|
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
540 r..........Reversing Sorting Order.................|netrw-r|
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
541 R..........Renaming Files or Directories...........|netrw-R|
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
542 s..........Selecting Sorting Style.................|netrw-s|
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
543 S..........Editing the Sorting Sequence............|netrw-S|
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
544 v..........Browsing with a Vertical Split..........|netrw-v|
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
545 x..........Customizing Browsing....................|netrw-x|
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
546
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
547 QUICK REFERENCE COMMANDS TABLE *netrw-browse-cmds*
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
548 >
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
549 ------- -----------
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
550 Command Explanation
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
551 ------- -----------
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
552 < ? Causes Netrw to issue help
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
553 <cr> Netrw will enter the directory or read the file
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
554 <del> Netrw will attempt to remove the file/directory
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
555 d Make a directory
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
556 D Netrw will attempt to remove the file(s)/directory(ies)
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
557 R Netrw will attempt to rename the file(s)/directory(ies)
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
558 - Makes Netrw go up one directory
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
559 a Toggles between normal display,
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
560 hiding (suppress display of files matching g:netrw_list_hide)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
561 showing (display only files which match g:netrw_list_hide)
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
562 c Make current browsing directory the current directory
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
563 <c-h> Edit file hiding list
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
564 i Toggles between long and short listing
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
565 <c-l> Causes Netrw to refresh the directory listing
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
566 o Enter the file/directory under the cursor in a new browser
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
567 window. A horizontal split is used.
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
568 r Reverse sorting order
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
569 s Select sorting style: by name, time, or file size
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
570 v Enter the file/directory under the cursor in a new browser
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
571 window. A vertical split is used.
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
572 x Apply a function to a file.
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
573
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
574 NETRW BROWSER VARIABLES *netrw-browse-var*
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
575 >
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
576 --- -----------
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
577 Var Explanation
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
578 --- -----------
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
579 < g:netrw_alto change from above splitting to
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
580 below splitting by setting this
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
581 variable (see |netrw-o|)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
582 g:netrw_altv change from left splitting to
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
583 right splitting by setting this
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
584 variable (see |netrw-v|)
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
585 g:netrw_ftp_browse_reject ftp can produce a number of errors
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
586 and warnings that can show up as
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
587 "directories" and "files" in the
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
588 listing. This pattern is used to
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
589 remove such embedded messages.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
590 g:netrw_keepdir keep current directory immune from the
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
591 browsing directory. The browsing
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
592 directory is contained in b:netrw_curdir
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
593 g:netrw_list_cmd command for listing remote directories
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
594 g:netrw_ftp_list_cmd options for passing along to ftp for
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
595 directory listing. Defaults:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
596 unix or g:netrw_cygwin set: : "ls -lF"
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
597 otherwise "dir"
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
598 g:netrw_list_hide comma separated list of patterns for
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
599 hiding files
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
600 g:netrw_local_mkdir command for making a local directory
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
601 g:netrw_local_rmdir remove directory command (rmdir)
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
602 g:netrw_local_rename rename file/directory command
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
603 unix-default: rm win32-default: ren
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
604 g:netrw_mkdir_cmd command for making a remote directory
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
605 g:netrw_rm_cmd command for removing files
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
606 g:netrw_rmdir_cmd command for removing directories
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
607 g:netrw_rmf_cmd command for removing softlinks
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
608 g:netrw_hide if true, the hiding list is used
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
609 g:netrw_sort_by sort by "name", "time", or "size"
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
610 g:netrw_sort_direction sorting direction: "normal" or "reverse"
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
611 g:netrw_sort_sequence when sorting by name, first sort by the
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
612 comma-separated pattern sequence
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
613 g:netrw_timefmt specify format string to strftime() (%c)
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
614 g:netrw_winsize specify initial size of new o/v windows
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
615
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
616 INTRODUCTION TO DIRECTORY BROWSING
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
617
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
618 Netrw supports the browsing of directories on the local system and on remote
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
619 hosts, including generating listing directories, entering directories, editing
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
620 files therein, deleting files/directories, making new directories, and moving
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
621 (renaming) files and directories. The Netrw browser generally implements the
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
622 previous explorer maps and commands for remote directories, although details
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
623 (such as pertinent global variable names) necessarily differ.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
624
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
625 The Netrw remote file and directory browser handles two protocols: ssh and
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
626 ftp. The protocol in the url, if it is ftp, will cause netrw to use ftp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
627 in its remote browsing. Any other protocol will be used for file transfers,
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
628 but otherwise the ssh protocol will be used to do remote directory browsing.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
629
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
630 To enter the netrw directory browser, simply attempt to read a "file" with a
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
631 trailing slash and it will be interpreted as a request to list a directory:
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
632
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
633 vim [protocol]://[user@]hostname/path/
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
634
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
635 If you'd like to avoid entering the password in for directory listings, scp,
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
636 ssh interaction, etc, see |netrw-list-hack|.
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
637
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
638 REFRESHING THE LISTING *netrw-ctrl-l*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
639
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
640 To refresh either a local or remote directory listing, press ctrl-l (<c-l>) or
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
641 hit the <cr> when atop the ./ directory entry in the listing. One may also
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
642 refresh a local directory by using ":e .".
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
643
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
644
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
645 GOING UP *netrw--*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
646
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
647 To go up a directory, press - or his the <cr> when atop the ../ directory
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
648 entry in the listing.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
649
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
650 Netrw will modify the command in *g:netrw_list_cmd* to perform the directory
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
651 listing operation. By default the command is:
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
652
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
653 ssh HOSTNAME ls -FLa
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
654
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
655 where the HOSTNAME becomes the [user@]hostname as requested by the attempt to
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
656 read. Naturally, the user may override this command with whatever is
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
657 preferred. The NetList function which implements remote directory browsing
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
658 expects that directories will be flagged by a trailing slash.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
659
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
660
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
661 BROWSING *netrw-cr*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
662
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
663 Browsing is simple: move the cursor onto a file or directory of interest.
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
664 Hitting the <cr> (the return key) will select the file or directory.
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
665 Directories will themselves be listed, and files will be opened using the
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
666 protocol given in the original read request.
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
667
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
668 LONG VS SHORT LISTING *netrw-i*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
669
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
670 The short listing format gives just the files' and directories' names.
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
671 The long listing is either based on the "ls" command via ssh for remote
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
672 directories or displays the filename, file size (in bytes), and the
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
673 time and date of last modification for local directories.
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
674
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
675
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
676 MAKING A NEW DIRECTORY *netrw-d*
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
677
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
678 With the "d" map one may make a new directory either remotely (which
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
679 depends on the global variable g:netrw_mkdir_cmd) or locally (which depends on
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
680 the global variable g:netrw_local_mkdir). Netrw will issue a request for the
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
681 new directory's name. A bare <CR> at that point will abort the making of the
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
682 directory. Attempts to make a local directory that already exists (as either
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
683 a file or a directory) will be detected, reported on, and ignored.
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
684
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
685 DELETING FILES OR DIRECTORIES *netrw-delete* *netrw-D*
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
686
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
687 Deleting/removing files and directories involves moving the cursor to the
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
688 file/directory to be deleted and pressing "D". Directories must be empty first
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
689 before they can be successfully removed. If the directory is a softlink to a
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
690 directory, then netrw will make two requests to remove the directory before
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
691 succeeding. Netrw will ask for confirmation before doing the removal(s).
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
692 You may select a range of lines with the "V" command (visual selection),
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
693 and then pressing "D".
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
694
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
695 *g:netrw_rm_cmd*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
696 The g:netrw_rm_cmd, g:netrw_rmf_cmd, and g:netrw_rmdir_cmd variables are used
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
697 to control the attempts to remove files and directories. The g:netrw_rm_cmd
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
698 is used with files, and its default value is:
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
699
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
700 g:netrw_rm_cmd: ssh HOSTNAME rm
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
701
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
702 *g:netrw_rmdir_cmd*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
703 The g:netrw_rmdir_cmd variable is used to support the removal of directories.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
704 Its default value is:
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
705
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
706 g:netrw_rmdir_cmd: ssh HOSTNAME rmdir
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
707
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
708 *g:netrw_rmf_cmd*
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
709 If removing a directory fails with g:netrw_rmdir_cmd, netrw then will attempt
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
710 to remove it again using the g:netrw_rmf_cmd variable. Its default value is:
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
711
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
712 g:netrw_rmf_cmd: ssh HOSTNAME rm -f
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
713
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
714
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
715 RENAMING FILES OR DIRECTORIES *netrw-move* *netrw-rename* *netrw-R*
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
716
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
717 Renaming/moving files and directories involves moving the cursor to the
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
718 file/directory to be moved (renamed) and pressing "R". You will then be
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
719 queried for where you want the file/directory to be moved. You may select a
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
720 range of lines with the "V" command (visual selection), and then pressing "R".
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
721
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
722 The g:netrw_rename_cmd variable is used to implement renaming. By default its
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
723 value is:
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
724
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
725 ssh HOSTNAME mv
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
726
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
727 One may rename a block of files and directories by selecting them with
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
728 the V (|linewise-visual|).
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
729
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
730
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
731 HIDING FILES OR DIRECTORIES *g:netrw-a* *g:netrw_list_hide*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
732
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
733 Netrw's browsing facility allows one to use the hiding list in one of
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
734 three ways: ignore it, hide files which match, and show only those files
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
735 which match. The g:netrw_list_hide variable holds a comma delimited list
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
736 of patterns (ex. \.obj) which specify the hiding list. (also see |netrw-h|)
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
737
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
738
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
739 EDIT FILE OR DIRECTORY HIDING LIST *netrw-h*
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
740
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
741 The "<ctrl-h>" map brings up a requestor allowing the user to change the
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
742 file/directory hiding list. The hiding list consists of one or more patterns
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
743 delimited by commas. Files and/or directories satisfying these patterns will
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
744 be hidden (ie. not shown).
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
745
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
746
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
747 BROWSING WITH A HORIZONTALLY SPLIT WINDOW *netrw-o*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
748
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
749 Normally one enters a file or directory using the <cr>. However, the "o" map
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
750 allows one to open a new window to hold the new directory listing or file. A
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
751 horizontal split is used. (for vertical splitting, see |netrw-v|)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
752
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
753 Normally, the o key splits the window horizontally with the new window
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
754 and cursor at the top. To change to splitting the window horizontally
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
755 with the new window and cursor at the bottom, have
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
756
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
757 let g:netrw_alto = 1
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
758
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
759 in your <.vimrc>.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
760
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
761 PREVIEW WINDOW
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
762
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
763 One may use a preview window (currently only for local browsing) by using
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
764 the "p" key when the cursor is atop the desired filename to be previewed.
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
765
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
766
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
767 SELECTING SORTING STYLE *netrw-s*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
768
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
769 One may select the sorting style by name, time, or (file) size. The
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
770 "s" map allows one to circulate among the three choices; the directory
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
771 listing will automatically be refreshed to reflect the selected style.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
772
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
773
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
774 EDITING THE SORTING SEQUENCE *netrw-S*
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
775
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
776 When "Sorted by" is name, one may specify priority via the sorting
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
777 sequence (g:netrw_sort_sequence). The sorting sequence typically
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
778 prioritizes the name-listing by suffix, although any pattern will do.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
779 Patterns are delimited by commas. The default sorting sequence is:
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
780 >
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
781 /$,*,\.bak$,\.o$,\.h$,\.info$,\.swp$,\.obj$
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
782 <
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
783 The lone * is where all filenames not covered by one of the other
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
784 patterns will end up. One may change the sorting sequence by modifying
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
785 the g:netrw_sort_sequence variable (either manually or in your <.vimrc>)
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
786 or by using the "S" map.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
787
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
788
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
789 REVERSING SORTING ORDER *netrw-r*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
790
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
791 One may toggle between normal and reverse sorting order by pressing the
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
792 "r" key.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
793
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
794
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
795 BROWSING WITH A VERTICALLY SPLIT WINDOW *netrw-v*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
796
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
797 Normally one enters a file or directory using the <cr>. However, the "v"
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
798 map allows one to open a new window to hold the new directory listing or
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
799 file. A vertical split is used. (for horizontal splitting, see |netrw-o|)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
800
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
801 Normally, the v key splits the window vertically with the new window
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
802 and cursor at the left. To change to splitting the window vertically
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
803 with the new window and cursor at the right, have
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
804
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
805 let g:netrw_altv = 1
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
806
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
807 in your <.vimrc>.
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
808
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
809
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
810 CUSTOMIZING BROWSING WITH A USER FUNCTION *netrw-x*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
811
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
812 One may "enter" a file with a special handler, thereby firing up a browser or
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
813 other application, for example, on a file by hitting the "x" key. Presumably
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
814 one could write handlers that would start OpenOffice programs (oowriter), etc,
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
815 based on the file's extension coupled with the user's hitting the "x" key atop
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
816 the file.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
817
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
818 The Netrw executor applies a user-defined function to a file, based on its
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
819 extension. Of course, the handler function must exist for it to be called!
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
820 >
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
821 Ex. mypgm.html x ->
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
822 NetrwFileHandler_html("scp://user@host/some/path/mypgm.html")
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
823 <
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
824 See the <plugin/NetrwFileHandlers.vim> for an example of how to handle an html
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
825 file with mozilla.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
826
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
827
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
828 MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY *netrw-c*
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
829
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
830 By default, g:netrw_keepdir is 0. This setting means that the current
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
831 directory will track the browsing directory. However, setting g:netrw_keepdir
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
832 to 1 (say, in your <.vimrc>) will keep the current directory independent
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
833 of the browsing directory. In that case, in order to make the two
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
834 directories the same, use the "c" map (just type c).
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
835
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
836
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
837 BOOKMARKING A DIRECTORY *netrw-b*
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
838
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
839 One may easily "bookmark" a directory by using
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
840
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
841 {cnt}b
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
842
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
843 Any count may be used.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
844
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
845
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
846 CHANGING TO A BOOKMARKED DIRECTORY *netrw-B*
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
847
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
848 To change directory back to a bookmarked directory, use
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
849
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
850 {cnt}B
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
851
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
852 Any count may be used.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
853
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
854
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
855 LISTING BOOKMARKS *netrw-q*
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
856
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
857 Pressing "q" will list the bookmarked directories. (query)
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
858
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
859
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
860 IMPROVING DIRECTORY BROWSING *netrw-list-hack*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
861
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
862 Especially with the remote directory browser, constantly entering the password
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
863 is tedious.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
864
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
865 For Linux/Unix systems, I suggest looking into
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
866
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
867 http://hacks.oreilly.com/pub/h/66
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
868
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
869 It gives a tip for setting up password-less use of ssh and scp, and discusses
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
870 the associated security issues.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
871
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
872
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
873 ==============================================================================
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
874 8. Problems and Fixes *netrw-problems*
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
875
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
876 (This section is likely to grow as I get feedback)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
877 (also see |netrw-debug|)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
878
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
879 P1. I use windows 95, and my ftp dumps four blank lines at the
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
880 end of every read.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
881
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
882 See |netrw-fixup|, and put the following into your
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
883 <.vimrc> file:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
884
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
885 let g:netrw_win95ftp= 1
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
886
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
887
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
888
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
889 P2. I use windows, and my network browsing with ftp doesn't sort by
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
890 time or size
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
891
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
892 Windows' ftp has a minimal support for ls (ie. it doesn't
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
893 accept sorting options). It doesn't support the -F which
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
894 gives an explanatory character (ABC/ for "ABC is a directory").
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
895 Netrw uses dir to get its short and long listings. If you
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
896 think your ftp does support a full-up ls, put the following
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
897 into your <.vimrc>:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
898
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
899 let g:netrw_ftp_list_cmd= "ls -lF"
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
900
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
901 Alternatively, if you have cygwin on your Windows box, put
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
902 into your <.vimrc>:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
903
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
904 let g:netrw_cygwin= 1
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
905
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
906 P3. I tried rcp://user@host/ (or protocol other than ftp) and netrw
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
907 used ssh! That wasn't what I asked for...
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
908
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
909 Netrw has two methods for browsing remote directories: ssh
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
910 and ftp. Unless you specify ftp specifically, ssh is used.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
911 When it comes time to do download a file (not just a directory
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
912 listing), netrw will use the given protocol to do so.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
913
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
914 P4. I would like long listings to be the default.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
915
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
916 let g:netrw_longlist=1
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
917
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
918 P5. My times come up oddly in local browsing
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
919
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
920 Does your system's strftime() accept the "%c" to yield dates
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
921 such as "Sun Apr 27 11:49:23 1997"? If not, do a "man strftime"
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
922 and find out what option should be used. Then put it into
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
923 your <.vimrc>:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
924 let g:netrw_timefmt= "%X" (where X is the option)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
925
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
926 P6. I don't want my current directory changing just because I'm
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
927 browsing somewhere.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
928
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
929 let g:netrw_keepdir= 1
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
930
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
931
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
932 ==============================================================================
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
933 9. Debugging *netrw-debug*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
934
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
935 The <netrw.vim> script is typically available as:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
936
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
937 /usr/local/share/vim/vim6x/plugin/netrw.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
938
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
939 which is loaded automatically at startup (assuming :set nocp).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
940
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
941 1. Get the <Decho.vim> script, available as:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
942
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
943 http://mysite.verizon.net/astronaut/vim/index.html#vimlinks_scripts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
944 as "Decho, a vimL debugging aid"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
945 or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
946 http://vim.sourceforge.net/scripts/script.php?script_id=120
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
947
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
948 and put it into your local plugin directory.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
949
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
950 2. <Decho.vim> itself needs the <cecutil.vim> script, so you'll need
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
951 to put it into your .vim/plugin, too. You may obtain it from:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
952
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
953 http://mysite.verizon.net/astronaut/vim/index.html#VimFuncs
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
954 as "DrC's Utilities"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
955
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
956 3. Edit the <netrw.vim> file by typing:
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
957
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
958 vim netrw.vim
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
959 :DechoOn
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
960 :wq
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
961
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
962 To restore to normal non-debugging behavior, edit <netrw.vim>
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
963 by typing
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
964
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
965 vim netrw.vim
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
966 :DechoOff
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
967 :wq
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
968
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
969 This command, provided by <Decho.vim>, will comment out all
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
970 Decho-debugging statements (Dfunc(), Dret(), Decho(), Dredir()).
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
971
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
972 4. Then bring up vim and attempt a transfer. A set of messages
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
973 should appear concerning the steps that <netrw.vim> took in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
974 attempting to read/write your file over the network. Please
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
975 send that information to <netrw.vim>'s maintainer,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
976
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
977 drchipNOSPAM at campbellfamily.biz - NOSPAM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
978
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
979 ==============================================================================
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
980 10. History *netrw-history*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
981
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
982 v48: * One may use ftp to do remote host file browsing
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
983 * (windows and !cygwin) remote browsing with ftp can now use
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
984 the "dir" command internally to provide listings
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
985 * g:netrw_keepdir now allows one to keep the initial current
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
986 directory as the current directory (normally the local
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
987 file browser makes the currently viewed directory the
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
988 current directory)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
989 * g:netrw_alto and g:netrw_altv now support alternate placement
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
990 of windows started with o or v
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
991 * Nread ? and Nwrite ? now uses echomsg (instead of echo) so
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
992 :messages can repeat showing the help
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
993 * bugfix: avoids problems with partial matches of directory names
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
994 to prior buffers with longer names
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
995 * one can suppress error messages with g:netrw_quiet
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
996 * ctrl-h used instead of <Leader>h for editing hiding list
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
997 * one may edit the sorting sequence with the S map
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
998 * now allows confirmation of deletion with [y(es) n(o) a(ll) q(uit)]
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
999 * the "x" map now handles special file viewing with:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1000 (windows) rundll32 url.dll
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1001 (gnome) gnome-open
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1002 (kde) kfmclient
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1003 If none of these are on the executable path, then
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1004 NetrwFileHandlers.vim is used.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1005 * directory bookmarking during both local and remote browsing
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1006 implemented
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1007 * one may view all, use the hiding list to suppress, or use the
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1008 hiding list to show-only remote and local file/directory listings
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1009 * improved unusual file and directory name handling
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1010 * preview window support
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
1011 v47: * now handles local directory browsing.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1012 v46: * now handles remote directory browsing
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1013 * g:netrw_silent (if 1) will cause all transfers to be silent'd
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1014 v45: * made the [user@]hostname:path form a bit more restrictive
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1015 to better handle errors in using protocols
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1016 (e.g. scp:usr@host:file was being recognized as an rcp request)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1017 v44: * changed from "rsync -a" to just "rsync"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1018 * somehow an editing error messed up the test to recognize
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1019 use of the fetch method for NetRead.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1020 * more debugging statements included
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1021 v43: * moved "Explanation" comments to <pi_netrw.txt> help file
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1022 as "Network Reference" (|netrw-ref|)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1023 * <netrw.vim> now uses Dfunc() Decho() and Dret() for debugging
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1024 * removed superfluous NetRestorePosn() calls
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1025 v42: * now does BufReadPre and BufReadPost events on file:///*
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1026 and file://localhost/*
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1027 v41: * installed file:///* and file://localhost/* handling
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1028 v40: * prevents redraw when a protocol error occurs so that the
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1029 user may see it
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1030 v39: * sftp support
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1031 v38: * Now uses NetRestorePosn() calls with Nread/Nwrite commands
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1032 * Temporary files now removed via bwipe! instead of bwipe
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1033 (thanks to Dave Roberts)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1034 v37: * Claar's modifications which test if ftp is successful, otherwise
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1035 give an error message
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1036 * After a read, the alternate file was pointing to the temp file.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1037 The temp file buffer is now wiped out.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1038 * removed silent from transfer methods so user can see what's
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1039 happening
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1040
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1041
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1042 ==============================================================================
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1043 11. Credits *netrw-credits*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1044
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1045 Vim editor by Bram Moolenaar (Thanks, Bram!)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1046 dav support by C Campbell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1047 fetch support by Bram Moolenaar and C Campbell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1048 ftp support by C Campbell <NdrOchip@ScampbellPfamily.AbizM> - NOSPAM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1049 http support by Bram Moolenaar <bram@moolenaar.net>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1050 rcp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1051 rsync support by C Campbell (suggested by Erik Warendorph)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1052 scp support by raf <raf@comdyn.com.au>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1053 sftp support by C Campbell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1054
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1055 inputsecret(), BufReadCmd, BufWriteCmd contributed by C Campbell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1056
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1057 Jérôme Augé -- also using new buffer method with ftp+.netrc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1058 Bram Moolenaar -- obviously vim itself, :e and v:cmdarg use, fetch,...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1059 Yasuhiro Matsumoto -- pointing out undo+0r problem and a solution
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1060 Erik Warendorph -- for several suggestions (g:netrw_..._cmd
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1061 variables, rsync etc)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1062 Doug Claar -- modifications to test for success with ftp operation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1063
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1064 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1065 vim:tw=78:ts=8:ft=help:norl: