From ffdeb1c25728c722567d6f9de2d714f3f1f2a4de Mon Sep 17 00:00:00 2001 From: Jun-ichi Takimoto Date: Tue, 12 May 2015 00:36:18 +0900 Subject: 35075: improve manual format also fixed a ChangeLog entry for 35034 (2015-05-06) --- Doc/Zsh/zftpsys.yo | 52 ++++++++++++++++++++++++++-------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) (limited to 'Doc/Zsh/zftpsys.yo') diff --git a/Doc/Zsh/zftpsys.yo b/Doc/Zsh/zftpsys.yo index 56308302c..00062e43d 100644 --- a/Doc/Zsh/zftpsys.yo +++ b/Doc/Zsh/zftpsys.yo @@ -75,10 +75,10 @@ are treated literally (a single `tt(-)' is treated as an argument). subsect(Opening a connection) startitem() findex(zfparams) -item(tt(zfparams [ var(host) [ var(user) [ var(password) ... ] ] ]))( +item(tt(zfparams) [ var(host) [ var(user) [ var(password) ... ] ] ])( Set or show the parameters for a future tt(zfopen) with no arguments. If no arguments are given, the current parameters are displayed (the password -will be shown as a line of asterisks). If a host is given, and either the +will be shown as a line of asterisks). If a var(host) is given, and either the var(user) or var(password) is not, they will be prompted for; also, any parameter given as `tt(?)' will be prompted for, and if the `tt(?)' is followed by a string, that will be used as the prompt. As tt(zfopen) calls @@ -90,7 +90,7 @@ also cause the memory of the last directory (and so on) on the other host to be deleted. ) findex(zfopen) -item(tt(zfopen [ -1 ] [ var(host) [ var(user) [ var(password) [ var(account) ] ] ] ]))( +item(tt(zfopen) [ tt(-1) ] [ var(host) [ var(user) [ var(password) [ var(account) ] ] ] ])( If var(host) is present, open a connection to that host under username var(user) with password var(password) (and, on the rare occasions when it is necessary, account var(account)). If a necessary parameter is missing or @@ -119,7 +119,7 @@ to trigger recognition of the var(path). Note prefixes other than slash beyond var(host) are significant in var(path). ) findex(zfanon) -item(tt(zfanon [ -1 ] var(host)))( +item(tt(zfanon) [ tt(-1) ] var(host))( Open a connection var(host) for anonymous FTP. The username used is `tt(anonymous)'. The password (which will be reported the first time) is generated as var(user)tt(@)var(host); this is then stored in the shell @@ -131,9 +131,9 @@ enditem() subsect(Directory management) startitem() findex(zfcd) -xitem(tt(zfcd [ var(dir) ])) +xitem(tt(zfcd) [ var(dir) ]) xitem(tt(zfcd -)) -item(tt(zfcd var(old) var(new)))( +item(tt(zfcd) var(old) var(new))( Change the current directory on the remote server: this is implemented to have many of the features of the shell builtin tt(cd). @@ -168,7 +168,7 @@ For example, if the current local directory is tt(~/foo/bar), then tt(zfhere) performs the effect of `tt(zfcd ~/foo/bar)'. ) findex(zfdir) -item(tt(zfdir [ -rfd ] [ - ] [ var(dir-options) ] [ var(dir) ]))( +item(tt(zfdir) [ tt(-rfd) ] [ tt(-) ] [ var(dir-options) ] [ var(dir) ])( Produce a long directory listing. The arguments var(dir-options) and var(dir) are passed directly to the server and their effect is implementation dependent, but specifying a particular remote directory @@ -207,7 +207,7 @@ or binary. With an argument, change the type: the types `tt(A)' or `tt(IMAGE)' for binary data are understood case-insensitively. ) findex(zfstat) -item(tt(zfstat) [ -v ])( +item(tt(zfstat) [ tt(-v) ])( Show the status of the current or last connection, as well as the status of some of tt(zftp)'s status variables. With the tt(-v) option, a more verbose listing is produced by querying the server for its version of @@ -224,7 +224,7 @@ see the description of the function tt(zfrtime) below for more information. startitem() findex(zfget) -item(tt(zfget [ -Gtc ] var(file1) ...))( +item(tt(zfget) [ tt(-Gtc) ] var(file1) ...)( Retrieve all the listed files var(file1) ... one at a time from the remote server. If a file contains a `tt(/)', the full name is passed to the remote server, but the file is stored locally under the name given by the @@ -233,7 +233,7 @@ be sent as a single stream to standard output; in this case the tt(-t) option has no effect. ) findex(zfuget) -item(tt(zfuget [ -Gvst ] var(file1) ...))( +item(tt(zfuget) [ tt(-Gvst) ] var(file1) ...)( As tt(zfget), but only retrieve files where the version on the remote server is newer (has a later modification time), or where the local file does not exist. If the remote file is older but the files have different @@ -244,7 +244,7 @@ option tt(-v), the command prints more information about the files while it is working out whether or not to transfer them. ) findex(zfcget) -item(tt(zfcget [ -Gt ] var(file1) ...))( +item(tt(zfcget) [ tt(-Gt) ] var(file1) ...)( As tt(zfget), but if any of the local files exists, and is shorter than the corresponding remote file, the command assumes that it is the result of a partially completed transfer and attempts to transfer the rest of the @@ -254,8 +254,8 @@ Note that this requires a commonly implemented, but non-standard, version of the FTP protocol, so is not guaranteed to work on all servers. ) findex(zfgcp) -xitem(tt(zfgcp [ -Gt ] var(remote-file) var(local-file))) -item(tt(zfgcp [ -Gt ] var(rfile1) ... var(ldir)))( +xitem(tt(zfgcp) [ tt(-Gt) ] var(remote-file) var(local-file)) +item(tt(zfgcp) [ tt(-Gt) ] var(rfile1) ... var(ldir))( This retrieves files from the remote server with arguments behaving similarly to the tt(cp) command. @@ -271,7 +271,7 @@ enditem() subsect(Sending files) startitem() findex(zfput) -item(tt(zfput [ -r ] var(file1) ...))( +item(tt(zfput) [ tt(-r) ] var(file1) ...)( Send all the var(file1) ... given separately to the remote server. If a filename contains a `tt(/)', the full filename is used locally to find the file, but only the basename is used for the remote file name. @@ -282,13 +282,13 @@ with `tt(.)'. This requires that the remote machine understand UNIX file semantics, since `tt(/)' is used as a directory separator. ) findex(zfuput) -item(tt(zfuput [ -vs ] var(file1) ...))( +item(tt(zfuput) [ tt(-vs) ] var(file1) ...)( As tt(zfput), but only send files which are newer than their local equivalents, or if the remote file does not exist. The logic is the same as for tt(zfuget), but reversed between local and remote files. ) findex(zfcput) -item(tt(zfcput var(file1) ...))( +item(tt(zfcput) var(file1) ...)( As tt(zfput), but if any remote file already exists and is shorter than the local equivalent, assume it is the result of an incomplete transfer and send the rest of the file to append to the existing part. As the FTP @@ -296,8 +296,8 @@ append command is part of the standard set, this is in principle more likely to work than tt(zfcget). ) findex(zfpcp) -xitem(tt(zfpcp var(local-file) var(remote-file))) -item(tt(zfpcp var(lfile1) ... var(rdir)))( +xitem(tt(zfpcp) var(local-file) var(remote-file)) +item(tt(zfpcp) var(lfile1) ... var(rdir))( This sends files to the remote server with arguments behaving similarly to the tt(cp) command. @@ -381,7 +381,7 @@ directory where your zsh startup files live (usually tt(~)). startitem() findex(zfmark) -item(tt(zfmark [ )var(bookmark)tt( ]))( +item(tt(zfmark) [ var(bookmark) ])( If given an argument, mark the current host, user and directory under the name var(bookmark) for later use by tt(zfgoto). If there is no connection open, use the values for the last connection immediately before it was @@ -394,7 +394,7 @@ this is the format in which they are stored, and the file may be edited directly. ) findex(zfgoto) -item(tt(zfgoto [ -n ] )var(bookmark))( +item(tt(zfgoto) [ tt(-n) ] var(bookmark))( Return to the location given by var(bookmark), as previously set by tt(zfmark). If the location has user `tt(ftp)' or `tt(anonymous)', open the connection with tt(zfanon), so that no password is required. If the @@ -417,13 +417,13 @@ alter tt(zftp_chpwd) and tt(zftp_progress), in particular. startitem() findex(zfinit) -item(tt(zfinit [ -n ]))( +item(tt(zfinit) [ tt(-n) ])( As described above, this is used to initialize the zftp function system. The tt(-n) option should be used if the zftp command is already built into the shell. ) findex(zfautocheck) -item(tt(zfautocheck [ -dn ]))( +item(tt(zfautocheck) [ tt(-dn) ])( This function is called to implement automatic reopening behaviour, as described in more detail below. The options must appear in the first argument; tt(-n) prevents the command from changing to the old directory, @@ -458,7 +458,7 @@ were any matches, the same variable will be set to the expanded set of filenames on return. ) findex(zfrtime) -item(tt(zfrtime var(lfile) var(rfile) [ var(time) ]))( +item(tt(zfrtime) var(lfile) var(rfile) [ var(time) ])( Set the local file var(lfile) to have the same modification time as the remote file var(rfile), or the explicit time var(time) in FTP format tt(CCYYMMDDhhmmSS) for the GMT timezone. This uses the shell's @@ -556,12 +556,12 @@ As described for tt(progress), tt(zfinit) will force this to default to 1. ) kindex(remote-glob, zftp style) item(tt(remote-glob))( -If set to `1', `yes' or `true', filename generation (globbing) is +If set to `tt(1)', `tt(yes)' or `tt(true)', filename generation (globbing) is performed on the remote machine instead of by zsh itself; see below. ) kindex(titlebar, zftp style) item(tt(titlebar))( -If set to `1', `yes' or `true', tt(zftp_chpwd) will put the remote host and +If set to `tt(1)', `tt(yes)' or `tt(true)', tt(zftp_chpwd) will put the remote host and remote directory into the titlebar of terminal emulators such as xterm or sun-cmd that allow this. @@ -569,7 +569,7 @@ As described for tt(progress), tt(zfinit) will force this to default to 1. ) kindex(chpwd, zftp style) item(tt(chpwd))( -If set to `1' `yes' or `true', tt(zftp_chpwd) will call the function +If set to `tt(1)' `tt(yes)' or `tt(true)', tt(zftp_chpwd) will call the function tt(chpwd) when a connection is closed. This is useful if the remote host details were put into the terminal title bar by tt(zftp_chpwd) and your usual tt(chpwd) also modifies the title bar. -- cgit 1.4.1