Documentation

[Peter Stephenson <pws@xxxxxxxxxxxxxxxxx>]

I have put the fully made documentation for 3.1.5-pws-3 --- nroff,
texinfo and info --- at

http://www.ifh.de/~pws/computing/zsh-3.1.5-pws-3.doc.tar.gz

You can untar it where you untarr'd the source file and it should all
go into the right place.  If you have yodl etc. you don't need this.
It's more than half the size of the source archive.

Included is a small fix for the zftp docs, as below.  Mainly this was
because makeinfo pointed out the `previous' pointer from mod_zftp.yo
was wrong.

*** Doc/Zsh/guide.yo.zftp2	Mon Oct 26 23:56:06 1998
--- Doc/Zsh/guide.yo	Mon Dec 14 17:24:48 1998
***************
*** 114,119 ****
--- 114,120 ----
  menu(The files Module)
  menu(The sched Module)
  menu(The stat Module)
+ menu(The zftp Module)
  menu(The zle Module)
  endmenu()
  texinode(The Z Shell Guide)(Introduction)(Top)(Top)
*** Doc/Zsh/mod_zftp.yo.zftp2	Tue Dec  8 15:45:18 1998
--- Doc/Zsh/mod_zftp.yo	Mon Dec 14 17:40:57 1998
***************
*** 1,4 ****
! texinode(The zftp Module)(The zle Module)(The stat module)(Zsh Modules)
  sect(The zftp Module)
  The tt(zftp) module makes available one builtin command:
  
--- 1,4 ----
! texinode(The zftp Module)(The zle Module)(The stat Module)(Zsh Modules)
  sect(The zftp Module)
  The tt(zftp) module makes available one builtin command:
  
***************
*** 26,33 ****
  cindex(zftp, subcommands)
  
  startitem()
! findex(zftp open)
! findex(FTP, starting a session)
  item(tt(open) var(host) [ var(user) [ var(password) [ var(account) ] ] ])(
  Open a new FTP session to var(host), which may be the name of a TCP/IP
  connected host or an IP number in the standard dot notation.
--- 26,32 ----
  cindex(zftp, subcommands)
  
  startitem()
! cindex(FTP, starting a session)
  item(tt(open) var(host) [ var(user) [ var(password) [ var(account) ] ] ])(
  Open a new FTP session to var(host), which may be the name of a TCP/IP
  connected host or an IP number in the standard dot notation.
***************
*** 213,220 ****
  
  subsect(Parameters)
  cindex(zftp, parameters)
! The following shell parameters are used by tt(zftp).  They are not
! special unless indicated.
  
  startitem()
  item(tt(ZFTP_TMOUT))(
--- 212,219 ----
  
  subsect(Parameters)
  cindex(zftp, parameters)
! The following shell parameters are used by tt(zftp).  Currently none
! of them are special.
  
  startitem()
  item(tt(ZFTP_TMOUT))(
***************
*** 382,388 ****
  vindex(ZFTP_SIZE)
  item(tt(ZFTP_SIZE))(
  The total size of the complete file being transferred:
! the same values as provided by the
  tt(remote) and tt(local) subcommands for a particular file.
  If the server cannot supply this value for a remote file being
  retrieved, it will not be set.  If input is from a pipe the value may
--- 381,387 ----
  vindex(ZFTP_SIZE)
  item(tt(ZFTP_SIZE))(
  The total size of the complete file being transferred:
! the same as the first value provided by the
  tt(remote) and tt(local) subcommands for a particular file.
  If the server cannot supply this value for a remote file being
  retrieved, it will not be set.  If input is from a pipe the value may
***************
*** 402,409 ****
  up.  It is otherwise never called twice with the same value of
  tt(ZFTP_COUNT).
  
! Sometimes the progress metre may cause disruption.  It is up to the
! user to decide whether the function should be defined.
  )
  
  subsect(Problems)
--- 401,409 ----
  up.  It is otherwise never called twice with the same value of
  tt(ZFTP_COUNT).
  
! Sometimes the progress meter may cause disruption.  It is up to the
! user to decide whether the function should be defined and to use
! tt(unfunction) when necessary.
  )
  
  subsect(Problems)

-- 
Peter Stephenson <pws@xxxxxxxxxxxxxxxxx>       Tel: +39 050 844536
WWW:  http://www.ifh.de/~pws/
Dipartimento di Fisica, Via Buonarroti 2, 56127 Pisa, Italy