doc/man-psft.but

   1 \cfg{man-identity}{psftp}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite}
   2
   3 \H{psftp-manpage} Man page for PSFTP
   4
   5 \S{psftp-manpage-name} NAME
   6
   7 \cw{psftp} \- interactive SFTP (secure file transfer protocol) client
   8
   9 \S{psftp-manpage-synopsis} SYNOPSIS
  10
  11 \c psftp [options] [user@]host
  12 \e bbbbb  iiiiiii   iiiib iiii
  13
  14 \S{psftp-manpage-description} DESCRIPTION
  15
  16 \cw{psftp} is an interactive text-based client for the SSH-based SFTP
  17 (secure file transfer) protocol.
  18
  19 \S{psftp-manpage-options} OPTIONS
  20
  21 The command-line options supported by \cw{psftp} are:
  22
  23 \dt \cw{-V}
  24
  25 \dd Show version information and exit.
  26
  27 \dt \cw{-pgpfp}
  28
  29 \dd Display the fingerprints of the PuTTY PGP Master Keys and exit,
  30 to aid in verifying new files released by the PuTTY team.
  31
  32 \dt \cw{-b} \e{batchfile}
  33
  34 \dd Use specified batchfile.
  35
  36 \dt \cw{-bc}
  37
  38 \dd Output batchfile commands.
  39
  40 \dt \cw{-be}
  41
  42 \dd Don't stop batchfile processing on errors.
  43
  44 \dt \cw{-v}
  45
  46 \dd Show verbose messages.
  47
  48 \dt \cw{-load} \e{session}
  49
  50 \dd Load settings from saved session.
  51
  52 \dt \cw{-P} \e{port}
  53
  54 \dd Connect to port \e{port}.
  55
  56 \dt \cw{\-proxycmd} \e{command}
  57
  58 \dd Instead of making a TCP connection, use \e{command} as a proxy;
  59 network traffic will be redirected to the standard input and output
  60 of \e{command}. \e{command} must be a single word, so is likely to
  61 need quoting by the shell.
  62
  63 \lcont{
  64 The special strings \cw{%host} and \cw{%port} in \e{command} will be
  65 replaced by the hostname and port number you want to connect to; to get
  66 a literal \c{%} sign, enter \c{%%}.
  67
  68 Backslash escapes are also supported, such as sequences like \c{\\n}
  69 being replaced by a literal newline; to get a literal backslash,
  70 enter \c{\\\\}. (Further escaping may be required by the shell.)
  71
  72 (See the main PuTTY manual for full details of the supported \cw{%}-
  73 and backslash-delimited tokens, although most of them are probably not
  74 very useful in this context.)
  75 }
  76
  77 \dt \cw{-l} \e{user}
  78
  79 \dd Set remote username to \e{user}.
  80
  81 \dt \cw{-batch}
  82
  83 \dd Disable interactive prompts.
  84
  85 \dt \cw{-pw} \e{password}
  86
  87 \dd Set remote password to \e{password}. \e{CAUTION:} this will likely
  88 make the password visible to other users of the local machine (via
  89 commands such as \q{\c{w}}).
  90
  91 \dt \cw{-1}
  92
  93 \dd Force use of SSH protocol version 1.
  94
  95 \dt \cw{-2}
  96
  97 \dd Force use of SSH protocol version 2.
  98
  99 \dt \cw{-4}, \cw{-6}
 100
 101 \dd Force use of IPv4 or IPv6 for network connections.
 102
 103 \dt \cw{-C}
 104
 105 \dd Enable SSH compression.
 106
 107 \dt \cw{-i} \e{keyfile}
 108
 109 \dd Private key file for user authentication. For SSH-2 keys, this key
 110 file must be in PuTTY's PPK format, not OpenSSH's format or anyone
 111 else's.
 112
 113 \lcont{ If you are using an authentication agent, you can also specify
 114 a \e{public} key here (in RFC 4716 or OpenSSH format), to identify
 115 which of the agent's keys to use. }
 116
 117 \dt \cw{\-noagent}
 118
 119 \dd Don't try to use an authentication agent.
 120
 121 \dt \cw{\-agent}
 122
 123 \dd Allow use of an authentication agent. (This option is only necessary
 124 to override a setting in a saved session.)
 125
 126 \dt \cw{\-hostkey} \e{key}
 127
 128 \dd Specify an acceptable host public key. This option may be specified
 129 multiple times; each key can be either a fingerprint (\cw{99:aa:bb:...}) or
 130 a base64-encoded blob in OpenSSH's one-line format.
 131
 132 \lcont{ Specifying this option overrides automated host key
 133 management; \e{only} the key(s) specified on the command-line will be
 134 accepted (unless a saved session also overrides host keys, in which
 135 case those will be added to), and the host key cache will not be
 136 written. }
 137
 138 \dt \cw{\-sshlog} \e{logfile}
 139
 140 \dt \cw{\-sshrawlog} \e{logfile}
 141
 142 \dd These options make \cw{psftp} log protocol details to a file.
 143 (Some of these may be sensitive, although by default an effort is made
 144 to suppress obvious passwords.)
 145
 146 \lcont{
 147 \cw{\-sshlog} logs decoded SSH packets and other events (those that
 148 \cw{\-v} would print). \cw{\-sshrawlog} additionally logs the raw
 149 encrypted packet data.
 150 }
 151
 152 \S{psftp-manpage-commands} COMMANDS
 153
 154 For a list of commands available inside \cw{psftp}, type \cw{help}
 155 at the \cw{psftp>} prompt.
 156
 157 \S{psftp-manpage-more-information} MORE INFORMATION
 158
 159 For more information on \cw{psftp} it's probably best to go and look at
 160 the manual on the PuTTY web page:
 161
 162 \cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/}
 163
 164 \S{psftp-manpage-bugs} BUGS
 165
 166 This man page isn't terribly complete. See the above web link for
 167 better documentation.