]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - doc/man-pscp.but
Fix missing options in man pages.
[PuTTY.git] / 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{-l} \e{user}
69
70 \dd Set remote username to \e{user}.
71
72 \dt \cw{-batch}
73
74 \dd Disable interactive prompts.
75
76 \dt \cw{-pw} \e{password}
77
78 \dd Set remote password to \e{password}. \e{CAUTION:} this will likely
79 make the password visible to other users of the local machine (via
80 commands such as \q{\c{w}}).
81
82 \dt \cw{-1}
83
84 \dd Force use of SSH protocol version 1.
85
86 \dt \cw{-2}
87
88 \dd Force use of SSH protocol version 2.
89
90 \dt \cw{-4}, \cw{-6}
91
92 \dd Force use of IPv4 or IPv6 for network connections.
93
94 \dt \cw{-C}
95
96 \dd Enable SSH compression.
97
98 \dt \cw{-i} \e{keyfile}
99
100 \dd Private key file for user authentication. For SSH-2 keys, this key
101 file must be in PuTTY's PPK format, not OpenSSH's format or anyone
102 else's.
103
104 \lcont{ If you are using an authentication agent, you can also specify
105 a \e{public} key here (in RFC 4716 or OpenSSH format), to identify
106 which of the agent's keys to use. }
107
108 \dt \cw{\-noagent}
109
110 \dd Don't try to use an authentication agent.
111
112 \dt \cw{\-agent}
113
114 \dd Allow use of an authentication agent. (This option is only necessary
115 to override a setting in a saved session.)
116
117 \dt \cw{\-hostkey} \e{key}
118
119 \dd Specify an acceptable host public key. This option may be specified
120 multiple times; each key can be either a fingerprint (\cw{99:aa:bb:...}) or
121 a base64-encoded blob in OpenSSH's one-line format.
122
123 \lcont{ Specifying this option overrides automated host key
124 management; \e{only} the key(s) specified on the command-line will be
125 accepted (unless a saved session also overrides host keys, in which
126 case those will be added to), and the host key cache will not be
127 written. }
128
129 \dt \cw{-scp}
130
131 \dd Force use of SCP protocol.
132
133 \dt \cw{-sftp}
134
135 \dd Force use of SFTP protocol.
136
137 \dt \cw{\-sshlog} \e{logfile}
138
139 \dt \cw{\-sshrawlog} \e{logfile}
140
141 \dd These options make \cw{pscp} log protocol details to a file.
142 (Some of these may be sensitive, although by default an effort is made
143 to suppress obvious passwords.)
144
145 \lcont{
146 \cw{\-sshlog} logs decoded SSH packets and other events (those that
147 \cw{\-v} would print). \cw{\-sshrawlog} additionally logs the raw
148 encrypted packet data.
149 }
150
151 \S{pscp-manpage-more-information} MORE INFORMATION
152
153 For more information on \cw{pscp} it's probably best to go and look at
154 the manual on the PuTTY web page:
155
156 \W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/}
157
158 \S{pscp-manpage-bugs} BUGS
159
160 This man page isn't terribly complete. See the above web link for
161 better documentation.