vim: runtime/doc/pi_netrw.txt comparison

comparison runtime/doc/pi_netrw.txt @ 559:8ec588470508

updated for version 7.0159

author	vimboss
date	Fri, 25 Nov 2005 19:54:28 +0000
parents	862863033fdd
children	db92c5cc4f66

comparison

equal deleted inserted replaced

-:7ccb59c211b7
+:8ec588470508
-*pi_netrw.txt*  For Vim version 7.0.  Last change: Aug 31, 2005
+*pi_netrw.txt*  For Vim version 7.0.  Last change: Oct 19, 2005
 		VIM REFERENCE MANUAL    by Charles E. Campbell, Jr.
 *dav*           *http*          *network*       *rcp*           *scp*
 *fetch*         *netrw*         *Nread*         *rsync*         *sftp*
 *ftp*           *netrw.vim*     *Nwrite*        *netrw-file*
 PASSWORD...........................................|netrw-passwd|
 3.  Activation...........................................|netrw-activate|
 4.  Transparent File Transfer............................|netrw-transparent|
 5.  Ex Commands..........................................|netrw-ex|
 6.  Variables and Options................................|netrw-var|
-7.  Directory Browser....................................|netrw-browse| {{{1
+7.  Directory Browsing...................................|netrw-browse| {{{1
 Maps...............................................|netrw-maps|
 Exploring..........................................|netrw-explore-cmds|
 Quick Reference Commands Table.....................|netrw-browse-cmds|
 Netrw Browser Variables............................|netrw-browse-var|
 Introduction To Directory Browsing.................|netrw-browse-intro|
 ==============================================================================
 2. Network-Oriented File Transfer				*netrw-xfer*
 Network-oriented file transfer under Vim is implemented by a VimL-based script
-(<netrw.vim>) using plugin techniques.  It currently supports both reading
+(<netrw.vim>) using plugin techniques.  It currently supports both reading and
-and writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch,
+writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch,
 dav/cadaver, rsync, or sftp.
 http is currently supported read-only via use of wget or fetch.
 <netrw.vim> is a standard plugin which acts as glue between Vim and the
 various file transfer programs.  It uses autocommand events (BufReadCmd,
 FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. >
 	ex. vim ftp://hostname/path/to/file
 <
-The characters preceding the colon specify the protocol to use;
+The characters preceding the colon specify the protocol to use; in the
-in the example, its ftp.  The <netrw.vim> script then formulates
+example, its ftp.  The <netrw.vim> script then formulates a command or a
-a command or a series of commands (typically ftp) which it issues
+series of commands (typically ftp) which it issues to an external program
-to an external program (ftp, scp, etc) which does the actual file
+(ftp, scp, etc) which does the actual file transfer/protocol.  Files are read
-transfer/protocol.  Files are read from/written to a temporary file
+from/written to a temporary file (under Unix/Linux, /tmp/...) which the
-(under Unix/Linux, /tmp/...) which the <netrw.vim> script will
+<netrw.vim> script will clean up.
-clean up.
+One may modify any protocol's implementing external application by setting a
-One may modify any protocol's implementing external application
+variable (ex. scp uses the variable g:netrw_scp_cmd, which is defaulted to
-by setting a variable (ex. scp uses the variable g:netrw_scp_cmd,
+"scp -q").
-which is defaulted to "scp -q").
 Ftp, an old protocol, seems to be blessed by numerous implementations.
-Unfortunately, some implementations are noisy (ie., add junk to the end
+Unfortunately, some implementations are noisy (ie., add junk to the end of the
-of the file).  Thus, concerned users may decide to write a NetReadFixup()
+file).  Thus, concerned users may decide to write a NetReadFixup() function
-function that will clean up after reading with their ftp.  Some Unix systems
+that will clean up after reading with their ftp.  Some Unix systems (ie.,
-(ie., FreeBSD) provide a utility called "fetch" which uses the ftp protocol
+FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is
-but is not noisy and more convenient, actually, for <netrw.vim> to use.
+not noisy and more convenient, actually, for <netrw.vim> to use.
 Consequently, if "fetch" is executable, it will be used to do reads for
 ftp://... (and http://...) .  See |netrw-var| for more about this.
 For rcp, scp, sftp, and http, one may use network-oriented file transfers
 transparently; ie.
 The script attempts to get passwords for ftp invisibly using |inputsecret()|,
 a built-in Vim function.  See |netrw-uidpass| for how to change the password
 after one has set it.
-Unfortunately there doesn't appear to be a way for netrw to feed a password
+Unfortunately there doesn't appear to be a way for netrw to feed a password to
-to scp.  Thus every transfer via scp will require re-entry of the password.
+scp.  Thus every transfer via scp will require re-entry of the password.
+However, |netrw-listhack| can help with this problem.
 ==============================================================================
 3. Activation						*netrw-activate*
 Network-oriented file transfers are available by default whenever
 |'nocompatible'| mode is enabled.  The <netrw.vim> file resides in your
-system's vim-plugin directory and is sourced automatically whenever you
+system's vim-plugin directory and is sourced automatically whenever you bring
-bring up vim.
+up vim.  I suggest that, at a minimum, you have at least the following in your
+<.vimrc> customization file: >
+	set nocp
+	if version >= 600
+	  filetype plugin indent on
+	endif
+<
 ==============================================================================
 4. Transparent File Transfer				*netrw-transparent*
 Transparent file transfers occur whenever a regular file read or write
 (invoked via an |:autocmd| for |BufReadCmd| or |BufWriteCmd| events) is made.
-Thus one may use files across networks as if they were local. >
+Thus one may use files across networks just as simply as if they were local. >
 	vim ftp://[user@]machine/path
 	...
 	:wq
+See |netrw-activate| for more on how to encourage your vim to use plugins
+such as netrw.
 ==============================================================================
 5. Ex Commands						*netrw-ex*
 The usual read/write commands are supported.  There are also a couple of
 		file as specified in b:netrw_lastfile.
 :[range]Nw {netfile} [{netfile}]...
 		Write the specified lines to the {netfile}.
-:Nread
+:Nread		Read the specified lines into the current
-		Read the specified lines into the current
 		buffer from the file specified in
 		b:netrw_lastfile.
 :Nread {netfile} {netfile}...
 		Read the {netfile} after the current line.
 ==============================================================================
 6. Variables and Options       			*netrw-options* *netrw-var*
 The script <netrw.vim> uses several variables which can affect <netrw.vim>'s
 behavior.  These variables typically may be set in the user's <.vimrc> file:
->
+(also see |netrw-settings|) >
--------------
-	Netrw Options
+-------------
--------------
+Netrw Options
+-------------
 	Option			Meaning
 	--------------		-----------------------------------------------
 <
 b:netrw_col             Holds current cursor position (during NetWrite)
 g:netrw_cygwin          =1 assume scp under windows is from cygwin
 g:netrw_scp_cmd    variable   ="scp -q"
 g:netrw_sftp_cmd   variable   ="sftp" >
 -------------------------------------------------------------------------
 <
 								*netrw-ftp*
-The first two options both help with certain ftp's that give trouble otherwise.
+The first two options both help with certain ftp's that give trouble
-In order to best understand how to use these options if ftp is giving you
+otherwise.  In order to best understand how to use these options if ftp is
-troubles, a bit of discussion follows on how netrw does ftp reads.
+giving you troubles, a bit of discussion follows on how netrw does ftp reads.
-The g:netrw_..._cmd variables specify the external program to use handle
+The g:netrw_..._cmd variables specify the external program to use handle the
-the associated protocol (rcp, ftp, etc), plus any options.
+associated protocol (rcp, ftp, etc), plus any options.
 The g:netrw_list_cmd's HOSTNAME entry will be changed via substitution with
 whatever the current request is for a hostname.
 For ftp, netrw typically builds up lines of one of the following formats in a
 If <.netrc> exists it will be used to avoid having to query the user for
 userid and password.  The transferred file is put into a temporary file.
 The temporary file is then read into the main editing session window that
 requested it and the temporary file deleted.
-If your ftp doesn't accept the "user" command and immediately just demands
+If your ftp doesn't accept the "user" command and immediately just demands a
-a userid, then try putting "let netrw_ftp=1" in your <.vimrc>.
+userid, then try putting "let netrw_ftp=1" in your <.vimrc>.
 								*netrw-cadaver*
 To handle the SSL certificate dialog for untrusted servers, one may pull
 down the certificate and place it into /usr/ssl/cert.pem.  This operation
 renders the server treatment as "trusted".
 elseif a:method == 9 "sftp
 else               " complain
 endif
 endfunction
 >
-The NetReadFixup() function will be called if it exists and thus allows
+The NetReadFixup() function will be called if it exists and thus allows you to
-you to customize your reading process.  As a further example, <netrw.vim>
+customize your reading process.  As a further example, <netrw.vim> contains
-contains just such a function to handle Windows 95 ftp.  For whatever
+just such a function to handle Windows 95 ftp.  For whatever reason, Windows
-reason, Windows 95's ftp dumps four blank lines at the end of a transfer,
+95's ftp dumps four blank lines at the end of a transfer, and so it is
-and so it is desirable to automate their removal.  Here's some code taken
+desirable to automate their removal.  Here's some code taken from <netrw.vim>
-from <netrw.vim> itself:
+itself:
 >
 if has("win95") && g:netrw_win95ftp
 fun! NetReadFixup(method, line1, line2)
 if method == 3   " ftp (no <.netrc>)
 let fourblanklines= line2 - 3
 endfunction
 endif
 >
 ==============================================================================
-7. Directory Browser	*netrw-browse* *netrw-dir* *netrw-list* *netrw-help*
+7. Directory Browsing	*netrw-browse* *netrw-dir* *netrw-list* *netrw-help*
 MAPS   								*netrw-maps*
 ?................Help.......................................|netrw-help|
 <cr>.............Browsing...................................|netrw-cr|
 <del>............Deleting Files or Directories..............|netrw-delete|
 				 ^Security extensions not\|
 				 No such file\|
 				 : connect to address [0-9a-fA-F:]*
 				 : No route to host$'
+*g:netrw_ftp_list_cmd*	options for passing along to ftp for directory
+				listing.  Defaults:
+				 unix or g:netrw_cygwin set: : "ls -lF"
+				 otherwise                     "dir"
+*g:netrw_hide*			if true, the hiding list is used
+				 default: =0
+*g:netrw_keepdir*		=1 (default) keep current directory immune from
+				   the browsing directory.
+				=0 keep the current directory the same as the
+				   browsing directory.
+				The current browsing directory is contained in
+				b:netrw_curdir
+*g:netrw_list_cmd*		command for listing remote directories
+				 default: (if ssh is executable)
+				          "ssh HOSTNAME ls -FLa"
+*g:netrw_longlist*		if =1, then long listing will be default
+*g:netrw_list_hide*		comma separated pattern list for hiding files
+				 default: ""
+*g:netrw_local_mkdir*		command for making a local directory
+				 default: "mkdir"
+*g:netrw_local_rmdir*		remove directory command (rmdir)
+				 default: "rmdir"
+*g:netrw_maxfilenamelen*	=32 by default, selected so as to make long
+				    listings fit on 80 column displays.
+				If your screen is wider, and you have file
+				or directory names longer than 32 bytes,
+				you may set this option to keep listings
+				columnar.
+*g:netrw_mkdir_cmd*		command for making a remote directory
+				 default: "ssh HOSTNAME mkdir"
+*g:netrw_rm_cmd*		command for removing files
+				 default: "ssh HOSTNAME rm"
+*g:netrw_rmdir_cmd*		command for removing directories
+				 default: "ssh HOSTNAME rmdir"
+*g:netrw_rmf_cmd*		 command for removing softlinks
+				 default: "ssh HOSTNAME rm -f"
+*g:netrw_sort_by*		sort by "name", "time", or "size"
+				 default: "name"
+*g:netrw_sort_direction*	sorting direction: "normal" or "reverse"
+				 default: "normal"
+*g:netrw_sort_sequence*	when sorting by name, first sort by the
+				comma-separated pattern sequence
+				 default: '[\/]$,*,\.bak$,\.o$,\.h$,
+				           \.info$,\.swp$,\.obj$'
+*g:netrw_ssh_cmd*		One may specify an executable command
+				to use instead of ssh for remote actions
+				such as listing, file removal, etc.
+				 default: ssh
 *g:netrw_ssh_browse_reject*	ssh can sometimes produce unwanted lines,
 				messages, banners, and whatnot that one doesn't
 				want masquerading as "directories" and "files".
 				Use this pattern to remove such embedded
 				messages.  By default its value is:
 					 '^total\s\+\d\+$'
-*g:netrw_keepdir*		=1 (default) keep current directory immune from
-				   the browsing directory.
-				=0 keep the current directory the same as the
-				   browsing directory.
-				The current browsing directory is contained in
-				b:netrw_curdir
-*g:netrw_list_cmd*		command for listing remote directories
-				 default: (if ssh is executable)
-				          "ssh HOSTNAME ls -FLa"
-*g:netrw_longlist*		if =1, then long listing will be default
-*g:netrw_ftp_list_cmd*	options for passing along to ftp for directory
-				listing.  Defaults:
-				 unix or g:netrw_cygwin set: : "ls -lF"
-				 otherwise                     "dir"
-*g:netrw_list_hide*		comma separated pattern list for hiding files
-				 default: ""
-*g:netrw_local_mkdir*		command for making a local directory
-				 default: "ssh HOSTNAME mkdir"
-*g:netrw_local_rmdir*		remove directory command (rmdir)
-				 default: "rmdir"
-*g:netrw_maxfilenamelen*	=32 by default, selected so as to make long
-				    listings fit on 80 column displays.
-				If your screen is wider, and you have file
-				or directory names longer than 32 bytes,
-				you may set this option to keep listings
-				columnar.
-*g:netrw_mkdir_cmd*		command for making a remote directory
-				 default: "ssh HOSTNAME mkdir"
-*g:netrw_rm_cmd*		command for removing files
-				 default: "ssh HOSTNAME rm"
-*g:netrw_rmdir_cmd*		command for removing directories
-				 default: "ssh HOSTNAME rmdir"
-*g:netrw_rmf_cmd*		 command for removing softlinks
-				 default: "ssh HOSTNAME rm -f"
-*g:netrw_hide*			if true, the hiding list is used
-				 default: =0
-*g:netrw_sort_by*		sort by "name", "time", or "size"
-				 default: "name"
-*g:netrw_sort_direction*	sorting direction: "normal" or "reverse"
-				 default: "normal"
-*g:netrw_sort_sequence*	when sorting by name, first sort by the
-				comma-separated pattern sequence
-				 default: '[\/]$,*,\.bak$,\.o$,\.h$,
-				           \.info$,\.swp$,\.obj$'
 *g:netrw_timefmt*		specify format string to strftime() (%c)
 				 default: "%c"
 *g:netrw_winsize*		specify initial size of new o/v windows
 				 default: ""
 INTRODUCTION TO DIRECTORY BROWSING			*netrw-browse-intro*
 Netrw supports the browsing of directories on the local system and on remote
-hosts, including generating listing directories, entering directories, editing
+hosts, including listing files and directories, entering directories, editing
 files therein, deleting files/directories, making new directories, and moving
 (renaming) files and directories.  The Netrw browser generally implements the
 previous explorer maps and commands for remote directories, although details
 (such as pertinent global variable names) necessarily differ.
 The Netrw remote file and directory browser handles two protocols: ssh and
 ftp.  The protocol in the url, if it is ftp, will cause netrw to use ftp
 in its remote browsing.  Any other protocol will be used for file transfers,
 but otherwise the ssh protocol will be used to do remote directory browsing.
-To enter the netrw directory browser, simply attempt to read a "file" with a
+To use Netrw's remote directory browser, simply attempt to read a "file" with a
 trailing slash and it will be interpreted as a request to list a directory:
 	vim [protocol]://[user@]hostname/path/
-If you'd like to avoid entering the password in for directory listings, scp,
+For local directories, the trailing slash is not required.
-ssh interaction, etc, see |netrw-listhack|.
+If you'd like to avoid entering the password in for remote directory listings
+with ssh or scp, see |netrw-listhack|.
 				*netrw-explore*  *netrw-pexplore*
 				*netrw-hexplore* *netrw-sexplore*
 DIRECTORY EXPLORING COMMANDS	*netrw-nexplore* *netrw-vexplore*
 By default, these commands use the current file's directory.  However, one
 may explicitly provide a directory (path) to use.
 (Following needs v7.0 or later)			*netrw-starstar*
-When Explore, Sexplore, Hexplore, or Vexplore are used like
+When Explore, Sexplore, Hexplore, or Vexplore are used with a **,
+such as:
 >
 	:Explore **/filename_pattern
 <
 netrw will attempt to find a (sub)directory which matches the filename
 pattern.  Internally, it produces a list of files which match the pattern
 <
 The directory display is updated to show the subdirectory containing a
 matching file.  One may then proceed to the next (or previous) matching files'
 directories by using Nexplore or Pexplore, respectively.  If your console or
 gui produces recognizable shift-up or shift-down sequences, then you'll likely
-find the following mappings convenient:
+find using shift-downarrow and shift-uparrow convenient.  They're mapped by
+netrw:
 	<s-down>  == Nexplore, and
 	<s-up>    == Pexplore.
 As an example, consider
 refresh a local directory by using ":e .".
 GOING UP						*netrw--*
-To go up a directory, press - or his the <cr> when atop the ../ directory
+To go up a directory, press "-" or press the <cr> when atop the ../ directory
 entry in the listing.
-Netrw will modify the command in |g:netrw_list_cmd| to perform the directory
+Netrw will use the command in |g:netrw_list_cmd| to perform the directory
-listing operation.  By default the command is:
+listing operation after changing HOSTNAME to the host specified by the
+user-provided url.  By default netrw provides the command as:
 	ssh HOSTNAME ls -FLa
 where the HOSTNAME becomes the [user@]hostname as requested by the attempt to
 read.  Naturally, the user may override this command with whatever is
 BROWSING 							*netrw-cr*
 Browsing is simple: move the cursor onto a file or directory of interest.
 Hitting the <cr> (the return key) will select the file or directory.
 Directories will themselves be listed, and files will be opened using the
 protocol given in the original read request.
+CAVEAT: There are three forms of listing (see |netrw-i|).  Netrw assumes
+that two or more spaces delimit filenames and directory names for the long
+and wide listing formats.  Thus, if your filename or directory name has two
+or more spaces embedded in it, or any trailing spaces, then you'll need to
+use the "thin" format to select it.
 OBTAINING A FILE						*netrw-O*
 When browsing a remote directory, one may obtain a file under the cursor (ie.
 get a copy on your local machine, but not edit it) by pressing the O key.
 Only ftp and scp are supported for this operation (but since these two are
-available for browsing, that shouldn't be a problem).
+available for browsing, that shouldn't be a problem).  The status bar
+will then show, on its right hand side, a message like "Obtaining filename".
+The statusline will be restored after the transfer is complete.
+Netrw can also "obtain" a file using the local browser.  Netrw's display
+of a directory is not necessarily the same as Vim's "current directory",
+unless |g:netrw_keepdir| is set to 0 in the user's <.vimrc>.  One may select
+a file using the local browser (by putting the cursor on it) and pressing
+"O" will then "obtain" the file; ie. copy it to Vim's current directory.
+Related topics:
+* To see what the current directory is, use |:pwd|
+* To make the currently browsed directory the current directory, see |netrw-c|
+* To automatically make the currently browsed directory the current
+directory, see |g:netrw_keepdir|.
 THIN, LONG, AND WIDE LISTINGS					*netrw-i*
 The "i" map cycles between the thin, long, and wide listing formats.
 The short listing format gives just the files' and directories' names.
 The long listing is either based on the "ls" command via ssh for remote
-directories or displays the filename, file size (in bytes), and the
+directories or displays the filename, file size (in bytes), and the time and
-time and date of last modification for local directories.
+date of last modification for local directories.  With the long listing
+format, netrw is not able to recognize filenames which have trailing spaces.
-The wide listing format has a multi-column display of the various
+Use the thin listing format for such files.
-files in the netrw current directory, rather like the Unix "ls" presents.
-In this mode the "b" and "B" maps are not available; instead, use
+The wide listing format has a multi-column display of the various files in the
-Nb (|netrw-Nb|) and NB (|netrw-NB|).
+netrw current directory, rather like the Unix "ls" presents.  In this mode the
+"b" and "B" maps are not available; instead, use Nb (|netrw-Nb|) and NB
+(|netrw-NB|).  The wide listing format uses two or more contiguous spaces to
+delineate filenames; when using that format, netrw won't be able to recognize
+or use filenames which have two or more contiguous spaces embedded in the name
+or any trailing spaces.  The thin listing format will, however, work with such
+files.
 MAKING A NEW DIRECTORY						*netrw-d*
-With the "d" map one may make a new directory either remotely (which
+With the "d" map one may make a new directory either remotely (which depends
-depends on the global variable g:netrw_mkdir_cmd) or locally (which depends on
+on the global variable g:netrw_mkdir_cmd) or locally (which depends on the
-the global variable g:netrw_local_mkdir).  Netrw will issue a request for the
+global variable g:netrw_local_mkdir).  Netrw will issue a request for the new
-new directory's name.  A bare <CR> at that point will abort the making of the
+directory's name.  A bare <CR> at that point will abort the making of the
 directory.  Attempts to make a local directory that already exists (as either
 a file or a directory) will be detected, reported on, and ignored.
 DELETING FILES OR DIRECTORIES			*netrw-delete* *netrw-D*
 Deleting/removing files and directories involves moving the cursor to the
-file/directory to be deleted and pressing "D".  Directories must be empty first
+file/directory to be deleted and pressing "D".  Directories must be empty
-before they can be successfully removed.  If the directory is a softlink to a
+first before they can be successfully removed.  If the directory is a softlink
-directory, then netrw will make two requests to remove the directory before
+to a directory, then netrw will make two requests to remove the directory
-succeeding.  Netrw will ask for confirmation before doing the removal(s).
+before succeeding.  Netrw will ask for confirmation before doing the
-You may select a range of lines with the "V" command (visual selection),
+removal(s).  You may select a range of lines with the "V" command (visual
-and then pressing "D".
+selection), and then pressing "D".
 The g:netrw_rm_cmd, g:netrw_rmf_cmd, and g:netrw_rmdir_cmd variables are used
 to control the attempts to remove files and directories.  The g:netrw_rm_cmd
 is used with files, and its default value is:
 the V (|linewise-visual|).
 HIDING FILES OR DIRECTORIES				*netrw-a*
-Netrw's browsing facility allows one to use the hiding list in one of
+Netrw's browsing facility allows one to use the hiding list in one of three
-three ways: ignore it, hide files which match, and show only those files
+ways: ignore it, hide files which match, and show only those files which
-which match.  The "a" map allows the user to cycle about these three ways.
+match.  The "a" map allows the user to cycle about these three ways.
-The g:netrw_list_hide variable holds a comma delimited list of patterns
+The g:netrw_list_hide variable holds a comma delimited list of patterns (ex.
-(ex. \.obj) which specify the hiding list. (also see |netrw-h|)  To
+\.obj) which specify the hiding list. (also see |netrw-h|)  To set the hiding
-set the hiding list, use the <c-h> map.  As an example, to hide files
+list, use the <c-h> map.  As an example, to hide files which begin with a ".",
-which begin with a ".", one may use the <c-h> map to set the hiding
+one may use the <c-h> map to set the hiding list to '^\..*' (or one may put
-list to '^\..*' (or one may put  let g:netrw_list_hide= '^\..*' in
+let g:netrw_list_hide= '^\..*' in one's <.vimrc>).  One may then use the "a"
-one's <.vimrc>).  One may then use the "a" key to show all files,
+key to show all files, hide matching files, or to show only the matching
-hide matching files, or to show only the matching files.
+files.
 EDIT FILE OR DIRECTORY HIDING LIST		*netrw-h* *netrw-edithide*
 The "<ctrl-h>" map brings up a requestor allowing the user to change the
 file/directory hiding list.  The hiding list consists of one or more patterns
 delimited by commas.  Files and/or directories satisfying these patterns will
-either be hidden (ie. not shown) or be the only ones displayed (see |netrw-a|).
+either be hidden (ie. not shown) or be the only ones displayed (see
+|netrw-a|).
 BROWSING WITH A HORIZONTALLY SPLIT WINDOW		*netrw-o* *netrw-horiz*
 Normally one enters a file or directory using the <cr>.  However, the "o" map
 allows one to open a new window to hold the new directory listing or file.  A
 horizontal split is used.  (for vertical splitting, see |netrw-v|)
-Normally, the o key splits the window horizontally with the new window
+Normally, the o key splits the window horizontally with the new window and
-and cursor at the top.  To change to splitting the window horizontally
+cursor at the top.  To change to splitting the window horizontally with the
-with the new window and cursor at the bottom, have
+new window and cursor at the bottom, have
 	let g:netrw_alto = 1
 in your <.vimrc>.
 PREVIEW WINDOW					*netrw-p* *netrw-preview*
-One may use a preview window (currently only for local browsing) by using
+One may use a preview window (currently only for local browsing) by using the
-the "p" key when the cursor is atop the desired filename to be previewed.
+"p" key when the cursor is atop the desired filename to be previewed.
 SELECTING SORTING STYLE				*netrw-s* *netrw-sort*
-One may select the sorting style by name, time, or (file) size.  The
+One may select the sorting style by name, time, or (file) size.  The "s" map
-"s" map allows one to circulate amongst the three choices; the directory
+allows one to circulate amongst the three choices; the directory listing will
-listing will automatically be refreshed to reflect the selected style.
+automatically be refreshed to reflect the selected style.
 EDITING THE SORTING SEQUENCE		*netrw-S* *netrw-sortsequence*
-When "Sorted by" is name, one may specify priority via the sorting
+When "Sorted by" is name, one may specify priority via the sorting sequence
-sequence (g:netrw_sort_sequence).  The sorting sequence typically
+(g:netrw_sort_sequence).  The sorting sequence typically prioritizes the
-prioritizes the name-listing by suffix, although any pattern will do.
+name-listing by suffix, although any pattern will do.  Patterns are delimited
-Patterns are delimited by commas.  The default sorting sequence is:
+by commas.  The default sorting sequence is:
 >
 	[\/]$,*,\.bak$,\.o$,\.h$,\.info$,\.swp$,\.obj$
 <
-The lone * is where all filenames not covered by one of the other
+The lone * is where all filenames not covered by one of the other patterns
-patterns will end up.  One may change the sorting sequence by modifying
+will end up.  One may change the sorting sequence by modifying the
-the g:netrw_sort_sequence variable (either manually or in your <.vimrc>)
+g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by
-or by using the "S" map.
+using the "S" map.
 REVERSING SORTING ORDER			*netrw-r* *netrw-reverse*
 One may toggle between normal and reverse sorting order by pressing the
 q map to list both the bookmarks and history. (see |netrw-q|)
 BROWSING WITH A VERTICALLY SPLIT WINDOW				*netrw-v*
-Normally one enters a file or directory using the <cr>.  However, the "v"
+Normally one enters a file or directory using the <cr>.  However, the "v" map
-map allows one to open a new window to hold the new directory listing or
+allows one to open a new window to hold the new directory listing or file.  A
-file.  A vertical split is used.  (for horizontal splitting, see |netrw-o|)
+vertical split is used.  (for horizontal splitting, see |netrw-o|)
-Normally, the v key splits the window vertically with the new window
+Normally, the v key splits the window vertically with the new window and
-and cursor at the left.  To change to splitting the window vertically
+cursor at the left.  To change to splitting the window vertically with the new
-with the new window and cursor at the right, have
+window and cursor at the right, have
 	let g:netrw_altv = 1
 in your <.vimrc>.
 handler varies:
 * for Windows 32 or 64, the url and FileProtocolHandler dlls are used.
 * for KDE (with kfmclient): kfmclient is used.
 * for Gnome (with gnome-open): gnome-open is used.
-* otherwise the NetrwFileHandler plugin is used.
+* otherwise the netrwFileHandler plugin is used.
 The file's suffix is used by these various approaches to determine an
-appropriate application to use to "handle" these files.  Such things
+appropriate application to use to "handle" these files.  Such things as
-as OpenOffice (*.sfx), visualization (*.jpg, *.gif, etc), and PostScript
+OpenOffice (*.sfx), visualization (*.jpg, *.gif, etc), and PostScript (*.ps,
-(*.ps, *.eps) can be handled.
+*.eps) can be handled.
-The NetrwFileHandler applies a user-defined function to a file, based on its
+The netrwFileHandler applies a user-defined function to a file, based on its
 extension.  Of course, the handler function must exist for it to be called!
 >
 Ex. mypgm.html   x ->
-NetrwFileHandler_html("scp://user@host/some/path/mypgm.html")
+netrwFileHandler_html("scp://user@host/some/path/mypgm.html")
 <
-See the <plugin/NetrwFileHandlers.vim> for an example of how to handle an html
+See the <plugin/netrwFileHandlers.vim> for an example of how to handle an html
 file with mozilla.
-One may write custom NetrwFileHandlers; please look at the
+One may write custom netrwFileHandlers; please look at the
-plugin/NetrwFileHandlers.vim script for examples.  If its likely to be
+plugin/netrwFileHandlers.vim script for examples.  If its likely to be
 generally useful, please feel free to forward a copy to me for future
 inclusion in the distribution.
 MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY	*netrw-c* *netrw-curdir*
 directory will not track the browsing directory.  However, setting
 g:netrw_keepdir to 0 (say, in your <.vimrc>) will tell netrw to have the
 currently browsed directory be the current directory.
 With the default setting for g:netrw_keepdir, in order to make the two
-directories the same, use the "c" map (just type c).  That map will set
+directories the same, use the "c" map (just type c).  That map will set the
-the current directory to the current browsing directory.
+current directory to the current browsing directory.
 BOOKMARKING A DIRECTORY		*netrw-b* *netrw-bookmark* *netrw-bookmarks*
 							*netrw-Nb*
 One may easily "bookmark" a directory by using >
 To change directory back to a bookmarked directory, use
 	{cnt}B
-Any count may be used to reference any of the bookmarks.  See |netrw-b|
+Any count may be used to reference any of the bookmarks.  See |netrw-b| on
-for how to bookmark a directory and |netrw-q| for how to list them.
+how to bookmark a directory and |netrw-q| on how to list bookmarks.
 When wide listing is in use (see |netrw-i|), then the B map is not available;
 instead, use {cnt}NB.
 NETRW SETTINGS						*netrw-settings*
 With the NetrwSettings.vim plugin, >
 	:NetrwSettings
 will bring up a window with the many variables that netrw uses for its
-settings.  You may change any of their values; when you save the file,
+settings.  You may change any of their values; when you save the file, the
-the settings therein will be used.  One may also press "?" on any of
+settings therein will be used.  One may also press "?" on any of the lines for
-the lines for help on what each of the variables do.
+help on what each of the variables do.
 ==============================================================================
 8. Problems and Fixes						*netrw-problems*
 		NdrOchip at ScampbellPfamily.AbizM - NOSPAM
 ==============================================================================
 10. History						*netrw-history*
+	v75: * file://... now conforms to RFC2396 (thanks to S. Zacchiroli)
+	     * if the binary option is set, then NetWrite() will only write
+	       the whole file (line numbers don't make sense with this).
+	       Supports writing of tar and zip files.
+	v74: * bugfix (vim, then :Explore) now works
+	     * ctrl-L keeps cursor at same screen location (both local and
+	       remote browsing)
+	     * netrw now can read remote zip and tar files
+	     * Obtain now uses WinXP ftp+.netrc successfully
+	v73: * bugfix -- scp://host/path/file was getting named incorrectly
+	     * netrw detects use of earlier-than-7.0 version of vim and issues
+	       a pertinent error message.
+	     * netrwSettings.vim is now uses autoloading.  Only
+	       <netrwPlugin.vim> is needed as a pure plugin
+	       (ie. always loaded).
+	v72: * bugfix -- formerly, one could prevent the loading of netrw
+	       by "let g:loaded_netrw=1"; when autoloading became supported,
+	       this feature was lost.  It is now restored.
+	v71: * bugfix -- made some "set nomodifiable"s into setlocal variants
+	       (allows :e somenewfile  to be modifiable as usual)
+	     * NetrwSettings calls a netrw function, thereby assuring that
+	       netrw has loaded.  However, if netrw does not load for whatever
+	       reason, then NetrwSettings will now issue a warning message.
+	     * For what reason I don't recall, when wget and fetch are both
+	       not present, and an attempt to read a http://... url is made,
+	       netrw exited.  It now only returns.
+	     * When ch=1, on the second and subsequent uses of browsing Netrw
+	       would issue a blank line to clear the echo'd messages.  This
+	       caused an annoying "Hit-Enter" prompt; now a blank line message
+	       is echo'd only if &ch>1.
+	v70: * when using |netrw-O|, the "Obtaining filename" message is now
+	       shown using |hl-User9|.  If User9 has not been defined, netrw
+	       will define it.
+	v69: * Bugfix: win95/98 machines were experiencing a
+	       "E121: Undefined variable: g:netrw_win95ftp" message
+	v68: * double-click-leftmouse selects word under mouse
 	v67: * Passwords which contain blanks will now be surrounded by
 	       double-quotes automatically (Yongwei)
 	v66: * Netrw now seems to work with a few more Windows situations
 	     * O now obtains a file: remote browsing file -> local copy,
 	       locally browsing file -> current directory (see :pwd)
 	     * sorting sequence with the S map now allows confirmation of
 	     * deletion with [y(es) n(o) a(ll) q(uit)] the "x" map now handles
 	     * special file viewing with:
 	       (windows) rundll32 url.dll (gnome)   gnome-open (kde)
 	       kfmclient If none of these are on the executable path, then
-	       NetrwFileHandlers.vim is used.
+	       netrwFileHandlers.vim is used.
 	     * directory bookmarking during both local and remote browsing
 	       implemented
 	     * one may view all, use the hiding list to suppress, or use the
 	       hiding list to show-only remote and local file/directory
 	       listings

Mercurial > vim

comparison runtime/doc/pi_netrw.txt @ 559:8ec588470508