X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/3af9746312c67c3d5d4c4aac7e60ab4bec80ae5d..70637309a61321d83a4d0576b875b7dcb7085fa5:/doc/psftp.but diff --git a/doc/psftp.but b/doc/psftp.but index 57ba0fa5..0b9f0700 100644 --- a/doc/psftp.but +++ b/doc/psftp.but @@ -1,4 +1,4 @@ -\versionid $Id: psftp.but,v 1.3 2001/12/16 13:33:04 simon Exp $ +\define{versionidpsftp} \versionid $Id$ \C{psftp} Using PSFTP to transfer files securely @@ -49,45 +49,13 @@ any server: At this point you can type \c{open server.example.com} or \c{open fred@server.example.com} to start a session. -The following sections describe PSFTP's command-line options. +PSFTP accepts all the general command line options supported by the +PuTTY tools, except the ones which make no sense in a file transfer +utility. See \k{using-general-opts} for a description of these +options. (The ones not supported by PSFTP are clearly marked.) -\S{psftp-option-l} \c{-l}: specify a user name - -The \c{-l} option is an alternative way to specify the user name to -log in as, on the command line. Instead of typing \c{psftp -user@host}, you can also type \c{psftp host -l user}. - -This option does not work in the \c{open} command once PSFTP has -started. - -\S{psftp-option-P} \c{-P}: specify a port number - -If the \c{host} you specify is a saved session, PSFTP uses any port -number specified in that saved session. If not, PSFTP uses the -default SSH port, 22. The \c{-P} option allows you specify the port -number to connect to for PSFTP's SSH connection. - -\S{psftp-option-v}\c{-v}: show verbose messages - -The \c{-v} option to PSFTP makes it print verbose information about -the establishing of the SSH connection. The information displayed is -equivalent to what is shown in the PuTTY Event Log -(\k{using-eventlog}). - -This information may be useful for debugging problems with PSFTP. - -\S{psftp-option-pw} \c{-pw}: specify a password - -If a password is required to connect to the \c{host}, PSFTP will -interactively prompt you for it. However, this may not always be -appropriate. If you are running PSFTP as part of some automated -job, it will not be possible to enter a password by hand. The -\c{-pw} option to PSFTP lets you specify the password to use on the -command line. - -Since specifying passwords in scripts is a bad idea for security -reasons, you might want instead to consider using public-key -authentication; see \k{psftp-pubkey}. +PSFTP also supports some of its own options. The following sections +describe PSFTP's specific command-line options. \S{psftp-option-b} \c{-b}: specify a file containing batch commands @@ -153,6 +121,18 @@ processing even if a command fails to complete successfully. You might want this to happen if you wanted to delete a file and didn't care if it was already not present, for example. +\S{psftp-usage-options-batch}\c{-batch}: avoid interactive prompts + +If you use the \c{-batch} option, PSFTP will never give an +interactive prompt while establishing the connection. If the +server's host key is invalid, for example (see \k{gs-hostkey}), then +the connection will simply be abandoned instead of asking you what +to do next. + +This may help PSFTP's behaviour when it is used in automated +scripts: using \c{-batch}, if something goes wrong at connection +time, the batch job will fail rather than hang. + \H{psftp-commands} Running PSFTP Once you have started your PSFTP session, you will see a \c{psftp>} @@ -235,8 +215,12 @@ operate on. For example, if you type \c{get filename.dat} then PSFTP will look for \c{filename.dat} in your remote working directory on the server. -To change your remote working directory, use the \c{cd} command. To -display your current remote working directory, type \c{pwd}. +To change your remote working directory, use the \c{cd} command. If +you don't provide an argument, \c{cd} will return you to your home +directory on the server (more precisely, the remote directory you were +in at the start of the connection). + +To display your current remote working directory, type \c{pwd}. \S{psftp-cmd-lcd} The \c{lcd} and \c{lpwd} commands: changing the local working directory @@ -429,7 +413,7 @@ using the Windows \c{ren} command to rename files on your local PC. \H{psftp-pubkey} Using public key authentication with PSFTP Like PuTTY, PSFTP can authenticate using a public key instead of a -password. There are two ways you can do this. +password. There are three ways you can do this. Firstly, PSFTP can use PuTTY saved sessions in place of hostnames. So you might do this: @@ -443,7 +427,11 @@ username to log in as (see \k{config-username}). hostname: type \c{psftp sessionname}, where \c{sessionname} is replaced by the name of your saved session. -Secondly, PSFTP will attempt to authenticate using Pageant if Pageant +Secondly, you can supply the name of a private key file on the command +line, with the \c{-i} option. See \k{using-cmdline-identity} for more +information. + +Thirdly, PSFTP will attempt to authenticate using Pageant if Pageant is running (see \k{pageant}). So you would do this: \b Ensure Pageant is running, and has your private key stored in it.