doc/man-pscp.but

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