- (dtucker) Bug #1725: explicitly link libX11 into gnome-ssh-askpass2 using
[openssh-git.git] / scp.1
blobbc5e259f54fef9d72d44becf8c50ad62f2e96b4a
1 .\"  -*- nroff -*-
2 .\"
3 .\" scp.1
4 .\"
5 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
6 .\"
7 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8 .\"                    All rights reserved
9 .\"
10 .\" Created: Sun May  7 00:14:37 1995 ylo
11 .\"
12 .\" $OpenBSD: scp.1,v 1.50 2010/02/08 10:50:20 markus Exp $
13 .\"
14 .Dd $Mdocdate: February 8 2010 $
15 .Dt SCP 1
16 .Os
17 .Sh NAME
18 .Nm scp
19 .Nd secure copy (remote file copy program)
20 .Sh SYNOPSIS
21 .Nm scp
22 .Bk -words
23 .Op Fl 1246BCpqrv
24 .Op Fl c Ar cipher
25 .Op Fl F Ar ssh_config
26 .Op Fl i Ar identity_file
27 .Op Fl l Ar limit
28 .Op Fl o Ar ssh_option
29 .Op Fl P Ar port
30 .Op Fl S Ar program
31 .Sm off
32 .Oo
33 .Op Ar user No @
34 .Ar host1 No :
35 .Oc Ns Ar file1
36 .Sm on
37 .Ar ...
38 .Sm off
39 .Oo
40 .Op Ar user No @
41 .Ar host2 No :
42 .Oc Ar file2
43 .Sm on
44 .Ek
45 .Sh DESCRIPTION
46 .Nm
47 copies files between hosts on a network.
48 It uses
49 .Xr ssh 1
50 for data transfer, and uses the same authentication and provides the
51 same security as
52 .Xr ssh 1 .
53 Unlike
54 .Xr rcp 1 ,
55 .Nm
56 will ask for passwords or passphrases if they are needed for
57 authentication.
58 .Pp
59 File names may contain a user and host specification to indicate
60 that the file is to be copied to/from that host.
61 Local file names can be made explicit using absolute or relative pathnames
62 to avoid
63 .Nm
64 treating file names containing
65 .Sq :\&
66 as host specifiers.
67 Copies between two remote hosts are also permitted.
68 .Pp
69 The options are as follows:
70 .Bl -tag -width Ds
71 .It Fl 1
72 Forces
73 .Nm
74 to use protocol 1.
75 .It Fl 2
76 Forces
77 .Nm
78 to use protocol 2.
79 .It Fl 4
80 Forces
81 .Nm
82 to use IPv4 addresses only.
83 .It Fl 6
84 Forces
85 .Nm
86 to use IPv6 addresses only.
87 .It Fl B
88 Selects batch mode (prevents asking for passwords or passphrases).
89 .It Fl C
90 Compression enable.
91 Passes the
92 .Fl C
93 flag to
94 .Xr ssh 1
95 to enable compression.
96 .It Fl c Ar cipher
97 Selects the cipher to use for encrypting the data transfer.
98 This option is directly passed to
99 .Xr ssh 1 .
100 .It Fl F Ar ssh_config
101 Specifies an alternative
102 per-user configuration file for
103 .Nm ssh .
104 This option is directly passed to
105 .Xr ssh 1 .
106 .It Fl i Ar identity_file
107 Selects the file from which the identity (private key) for public key
108 authentication is read.
109 This option is directly passed to
110 .Xr ssh 1 .
111 .It Fl l Ar limit
112 Limits the used bandwidth, specified in Kbit/s.
113 .It Fl o Ar ssh_option
114 Can be used to pass options to
115 .Nm ssh
116 in the format used in
117 .Xr ssh_config 5 .
118 This is useful for specifying options
119 for which there is no separate
120 .Nm scp
121 command-line flag.
122 For full details of the options listed below, and their possible values, see
123 .Xr ssh_config 5 .
125 .Bl -tag -width Ds -offset indent -compact
126 .It AddressFamily
127 .It BatchMode
128 .It BindAddress
129 .It ChallengeResponseAuthentication
130 .It CheckHostIP
131 .It Cipher
132 .It Ciphers
133 .It Compression
134 .It CompressionLevel
135 .It ConnectionAttempts
136 .It ConnectTimeout
137 .It ControlMaster
138 .It ControlPath
139 .It GlobalKnownHostsFile
140 .It GSSAPIAuthentication
141 .It GSSAPIDelegateCredentials
142 .It HashKnownHosts
143 .It Host
144 .It HostbasedAuthentication
145 .It HostKeyAlgorithms
146 .It HostKeyAlias
147 .It HostName
148 .It IdentityFile
149 .It IdentitiesOnly
150 .It KbdInteractiveDevices
151 .It LogLevel
152 .It MACs
153 .It NoHostAuthenticationForLocalhost
154 .It NumberOfPasswordPrompts
155 .It PasswordAuthentication
156 .It PKCS11Provider
157 .It Port
158 .It PreferredAuthentications
159 .It Protocol
160 .It ProxyCommand
161 .It PubkeyAuthentication
162 .It RekeyLimit
163 .It RhostsRSAAuthentication
164 .It RSAAuthentication
165 .It SendEnv
166 .It ServerAliveInterval
167 .It ServerAliveCountMax
168 .It StrictHostKeyChecking
169 .It TCPKeepAlive
170 .It UsePrivilegedPort
171 .It User
172 .It UserKnownHostsFile
173 .It VerifyHostKeyDNS
175 .It Fl P Ar port
176 Specifies the port to connect to on the remote host.
177 Note that this option is written with a capital
178 .Sq P ,
179 because
180 .Fl p
181 is already reserved for preserving the times and modes of the file in
182 .Xr rcp 1 .
183 .It Fl p
184 Preserves modification times, access times, and modes from the
185 original file.
186 .It Fl q
187 Quiet mode: disables the progress meter as well as warning and diagnostic
188 messages from
189 .Xr ssh 1 .
190 .It Fl r
191 Recursively copy entire directories.
192 Note that
194 follows symbolic links encountered in the tree traversal.
195 .It Fl S Ar program
196 Name of
197 .Ar program
198 to use for the encrypted connection.
199 The program must understand
200 .Xr ssh 1
201 options.
202 .It Fl v
203 Verbose mode.
204 Causes
207 .Xr ssh 1
208 to print debugging messages about their progress.
209 This is helpful in
210 debugging connection, authentication, and configuration problems.
213 .Ex -std scp
214 .Sh SEE ALSO
215 .Xr rcp 1 ,
216 .Xr sftp 1 ,
217 .Xr ssh 1 ,
218 .Xr ssh-add 1 ,
219 .Xr ssh-agent 1 ,
220 .Xr ssh-keygen 1 ,
221 .Xr ssh_config 5 ,
222 .Xr sshd 8
223 .Sh HISTORY
225 is based on the
226 .Xr rcp 1
227 program in BSD source code from the Regents of the University of
228 California.
229 .Sh AUTHORS
230 .An Timo Rinne Aq tri@iki.fi
231 .An Tatu Ylonen Aq ylo@cs.hut.fi