# Vim documentation: pi_netrw

main help file

    *pi_netrw.txt*  For Vim version 6.2f.  Last change: Apr 03, 2003

    		  VIM REFERENCE MANUAL    by Charles E. Campbell, Jr.

    *ftp* *http* *scp* *rcp* *Nread* *Nwrite* *netrw* *netrw.vim* *network*

    Network-Oriented File Transfers with Vim

    1. Network-Oriented File Transfer			|netrw-xfer|
    2. Activation						|netrw-activate|
    3. Ex Commands						|netrw-ex|
    4. Variables						|netrw-var|
    5. User Options						|netrw-options|
    6. Debugging						|netrw-debug|

    The functionality mentioned here is done via using |standard-plugin|
    techniques.  This plugin is only available if

        set nocp			" 'compatible' is not set
        filetype plugin on		" plugins are enabled

    You can avoid loading this plugin by setting the "loaded_netrw" variable:

    	:let loaded_netrw = 1

    {Vi does not have any of this}

    ==============================================================================

    1. 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 and writing across networks using rcp, scp, ftp or ftp+<.netrc>,
    dav/cadaver, or rsync.

    http is currently supported read-only by using wget.

    Ftp, an old protocol, seems to be blessed by numerous implementations.
    Unfortunately, some implementations are noisy (ie., add junk to the end of the
    file).  Thus, concerned users may decide to write a NetReadFixup() function
    that will clean up after reading with their ftp.  Some Unix systems (ie.,
    FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is
    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, and http, one may use network-oriented file transfers
    transparently; ie.

    	vim rcp://[user@]machine/path
    	vim scp://[user@]machine/path

    If your ftp supports <.netrc>, then it too can be just as transparently used
    if the needed triad of machine name, user id, and password are present in that
    file.  Your ftp must be able to use the <.netrc> file on its own, however.

    	vim ftp://[user@]machine/path

    However, ftp will often need to query the user for the userid and password.
    The latter will be done "silently"; ie. asterisks will show up instead of the
    actually-typed-in password.  Netrw will retain the userid and password for
    subsequent read/writes from the most recent transfer so subsequent transfers
    (read/write) to or from that machine will take place without additional
    prompting.

       +==============================+==============================+============+
       |  Reading			  | Writing			 |  Uses      |
       +==============================+==============================+============+
       | RCP:			  |				 |	      |
       |  rcp://[user@]machine/path   | rcp://[user@]machine/path	 |  rcp       |
       |  :Nread rcp://machine/path   | :Nwrite rcp://machine/path	 |  rcp       |
       +------------------------------+------------------------------+------------+
       | SCP:			  |				 |	      |
       |  scp://[user@]machine/path   | scp://[user@]machine/path	 |  scp       |
       |  :Nread scp://machine/path   | :Nwrite scp://machine/path	 |  scp  (*1) |
       +------------------------------+------------------------------+------------+
       | FTP:			  |				 |	      |
     |	ftp://[user@]machine/path |	ftp://[user@]machine/path | ftp *2 |
     | :Nread	ftp://machine/path | :Nwrite	ftp://machine/path | ftp+.netrcYXXY
       |  :Nread machine path	  | :Nwrite machine path	 |  ftp+.netrcYXXY
       |  :Nread machine uid pass path| :Nwrite machine uid pass path|  ftp       ||||
       +------------------------------+------------------------------+------------+
       | FTP: if fetch is present...  |				 |	      |
     |	ftp://[user@]machine/path |	ftp://[user@]machine/path | fetch |
       +------------------------------+------------------------------+------------+
       | HTTP:			  |				 |	      |
     |	http://[user@]machine/path | | wget |
     | :Nread	http://machine/path | | wget |
       +------------------------------+------------------------------+------------+
       | HTTP: if fetch is present... |				 |	      |
     |	http://[user@]machine/path | | fetch |
       +------------------------------+------------------------------+------------+
       | DAV:			  |				 |	      |
       |  dav://machine/path	  |				 |  cadaver   |
       |  :Nread dav://machine/path   | :Nwrite dav://machine/path	 |  cadaver   |
       +------------------------------+------------------------------+------------+
       | RSYNC:			  |				 |	      |
       |  rsync://[user@]machine/path | rsync://[user@]machine/path  |  rsync     |
       |  :Nread rsync://machine/path | :Nwrite rsync://machine/path |  rsync     |
       +==============================+==============================+============+
    	(*1) For an absolute path use scp://machine//path.
    	(*2) if <.netrc> is present, it is assumed that it will
    	     work with your ftp client.  Otherwise the script will
    	     prompt for user-id and pasword.
    	(*3) for ftp, "machine" may be machine#port if a different
    	     port is needed than the standard ftp port

    Both the :Nread and the :Nwrite ex-commands can accept multiple filenames.

    NETRC							*netrw-netrc*

    The typical syntax for lines in a <.netrc> file is given as shown below.
    Ftp under Unix usually support <.netrc>; Windows' ftp usually doesn't.

    	machine {full machine name} login {user-id} password "{password}"
    	default			    login {user-id} password "{password}"

    Your ftp client must handle the use of <.netrc> on its own, but if the
    <.netrc> file exists, an ftp transfer will not ask for the user-id or
    password.

    	Note:
    	Since this file contains passwords, make very sure nobody else can
    	read this file!  Most programs will refuse to use a .netrc that is
    	readable for others.  Don't forget that the system administrator can
    	still read the file!

    PASSWORD						*netrw-passwd*

    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.

    ==============================================================================

    2. 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 bring
    up vim.

    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.

    	vim ftp://[user@]machine/path
    	...
    	:wq

    ==============================================================================

    3. Ex Commands						*netrw-ex*

    The usual read/write commands are supported.  There are also a couple of
    additional commands available.

    :[range]Nw
    				Write the specified lines to the current
    				file as specified in b:netrw_lastfile.

    :[range]Nw {netfile} [{netfile}]...
    				Write the specified lines to the {netfile}.

    :Nread
    				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.

    									*netrw-uidpass*
    :call NetUserPass()
    				If b:netrw_uid and b:netrw_passwd don't exist,
    				this function query the user for them.

    :call NetUserPass("userid")
    				This call will set the b:netrw_uid and, if
    				the password doesn't exist, will query the user for it.

    :call NetUserPass("userid","passwd")
    				This call will set both the b:netrw_uid and b:netrw_passwd.
    				The user-id and password are used by ftp transfers.  One may
    				effectively remove the user-id and password by using ""
    				strings.

    ==============================================================================

    4. Variables						*netrw-var*

    The script <netrw.vim> uses several variables which can affect <netrw.vim>'s
    behavior.  These variables are typically set in the user's <.vimrc> file:

    	g:netrw_uid		Holds current user-id for ftp.
    	g:netrw_passwd		Holds current password for ftp.
    	b:netrw_lastfile	Holds latest method/machine/path.
    	b:netrw_line		Holds current line number     (during NetWrite)
    	b:netrw_col		Holds current cursor position (during NetWrite)
    	g:netrw_ftp		=0 use default ftp	      (uid password)
    				=1 use alternate ftp	      (user uid password)
    				(see |netrw-options|)
    	g:netrw_ftpmode		="binary"		      (default)
    				="ascii"		      (your choice)
    	g:netrw_win95ftp	=0 use unix-style ftp even if win95/98/ME/etc
    				=1 use default method to do ftp
    	g:netrw_cygwin		=1 assume scp under windows is from cygwin
    							      (default/windows)
    				=0 assume scp under windows accepts windows
    				   style paths		      (default/else)
    	g:netrw_use_nt_rcp	=0 don't use WinNT/2K/XP's rcp (default)
    				=1 use WinNT/2K/XP's rcp, binary mode

    The following variables specify the external program to use handle the associated
    protocol (rcp, ftp, etc), plus any options.  Again, the user may vary these
    at will:

    	g:netrw_rcp_cmd		="rcp"
    	g:netrw_ftp_cmd		="ftp"
    	g:netrw_scp_cmd		="scp -q"
    	g:netrw_http_cmd	="wget -O"
    	g:netrw_dav_cmd		="cadaver"
    	g:netrw_rsync_cmd	="rsync -a"
    	g:netrw_fetch_cmd	=""   This variable is used for ftp and http
    				      reading only if it ends with "fetch -o"

    The script will also make use of the following variables internally,
    albeit temporarily.

    	g:netrw_method		Index indicating rcp/ftp+.netrc/ftp
    	g:netrw_machine		Holds machine name parsed from input
    	g:netrw_fname		Holds filename being accessed

    ==============================================================================

    5. User Options						*netrw-options*

        Option	      Type	  Setting	  Meaning
        ---------	      --------	  --------------  ---------------------------

        netrw_ftp	      variable	  =doesn't exist  userid set by "user userid"
    				  =0		  userid set by "user userid"
    				  =1		  userid set by "userid"

        NetReadFixup      function	  =doesn't exist  no change
    				  =exists	  Allows user to have files
    						  read via ftp automatically
    						  transformed however they wish
    						  by NetReadFixup()
        g:netrw_rcp_cmd    variable   ="rcp"
        g:netrw_ftp_cmd    variable   ="ftp"
        g:netrw_scp_cmd    variable   ="scp -q"
        g:netrw_http_cmd   variable   ="wget -O"
        g:netrw_dav_cmd    variable   ="cadaver"
        g:netrw_rsync_cmd  variable   ="rsync -a"
        g:netrw_fetch_cmd  variable   ="" This variable is used for ftp and http
    				      reading only if it ends with "fetch -o"

    The first two options both help with certain ftp's that give trouble
    otherwise.  In order to best understand how to use these options if ftp is
    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
    associated protocol (rcp, ftp, etc), plus any options.

    Netrw typically builds up lines of one of the following formats in a
    temporary file:

      IF g:netrw_ftp !exists or is not 1     IF g:netrw_ftp exists and is 1
      ----------------------------------     ------------------------------
           open machine [port]		      open machine [port]
           user userid password		      userid password
           [g:netrw_ftpmode]		      password
           get filename tempfile		      [g:netrw_ftpmode]
    					      get filename tempfile

    Netrw then executes the lines above by use of a filter:

    	:%! {g:netrw_ftp_cmd} -i [-n]

    where
    	g:netrw_ftp_cmd is usually "ftp",
    	-i tells ftp not to be interactive
    	-n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>)

    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 a
    userid, then try putting "let netrw_ftp=1" in your <.vimrc>.

    If your ftp for whatever reason generates unwanted lines (such as AUTH
    messages) you may write a NetReadFixup(tmpfile) function:

        function! NetReadFixup(method,line1,line2)
          if     method == 1 "rcp
          elseif method == 2 "ftp + <.netrc>
          elseif method == 3 "ftp + machine,uid,password,filename
          elseif method == 4 "scp
          elseif method == 5 "http/wget
          elseif method == 6 "dav/cadaver
          elseif method == 7 "rsync
          endif
        endfunction

    The NetReadFixup() function will be called if it exists and thus allows you
    to customize your reading process.  As a further example, <netrw.vim> contains
    just such a function to handle Windows 95 ftp.  For whatever reason, Windows
    95's ftp dumps four blank lines at the end of a transfer, and so it is
    desirable to automate their removal.  Here's some code taken from <netrw.vim>
    itself:

        if has("win95") && g:netrw_win95ftp
         fu! NetReadFixup(method, line1, line2)
           if method == 3   " ftp (no <.netrc>)
    	let fourblanklines= line2 - 3
    	silent fourblanklines.",".line2."g/^\s*/d"
           endif
         endfunction
        endif

    ==============================================================================

    6. Debugging						*netrw-debug*

    The <netrw.vim> script is typically available as:

    	/usr/local/share/vim/vim6x/plugin/netrw.vim

    which is loaded automatically at startup (assuming :set nocp).

    	1. Get the <Decho.vim> script, available as:

    	http://vim.sourceforge.net/scripts/script.php?script_id=120

    	   and put that into your local plugin directory

    	2. Edit the <netrw.vim> file as follows:

    		:g/DBG/s/^"//

    	   (to restore to normal, use  :g/DBG/s/^/"/ )

    	3. Then bring up vim and attempt a transfer.  A set of messages
    	   should appear concerning the steps that <netrw.vim> took in
    	   attempting to read/write your file over the network.  Please
    	   send that information to <netrw.vim>'s maintainer,

    		cec@NgrOyphSon.gPsfAc.nMasa.gov - NOSPAM

    ==============================================================================
    top - main help file