- deraadt@cvs.openbsd.org 2006/08/03 03:34:42
[openssh-git.git] / scp.1
blob43662abeab8e77add03430ed94cc6a51019caae2
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.40 2006/07/18 07:56:28 jmc Exp $
13 .\"
14 .Dd September 25, 1999
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 .Op 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 Any file name may contain a host and user specification to indicate
60 that the file is to be copied to/from that host.
61 Copies between two remote hosts are permitted.
62 .Pp
63 The options are as follows:
64 .Bl -tag -width Ds
65 .It Fl 1
66 Forces
67 .Nm
68 to use protocol 1.
69 .It Fl 2
70 Forces
71 .Nm
72 to use protocol 2.
73 .It Fl 4
74 Forces
75 .Nm
76 to use IPv4 addresses only.
77 .It Fl 6
78 Forces
79 .Nm
80 to use IPv6 addresses only.
81 .It Fl B
82 Selects batch mode (prevents asking for passwords or passphrases).
83 .It Fl C
84 Compression enable.
85 Passes the
86 .Fl C
87 flag to
88 .Xr ssh 1
89 to enable compression.
90 .It Fl c Ar cipher
91 Selects the cipher to use for encrypting the data transfer.
92 This option is directly passed to
93 .Xr ssh 1 .
94 .It Fl F Ar ssh_config
95 Specifies an alternative
96 per-user configuration file for
97 .Nm ssh .
98 This option is directly passed to
99 .Xr ssh 1 .
100 .It Fl i Ar identity_file
101 Selects the file from which the identity (private key) for RSA
102 authentication is read.
103 This option is directly passed to
104 .Xr ssh 1 .
105 .It Fl l Ar limit
106 Limits the used bandwidth, specified in Kbit/s.
107 .It Fl o Ar ssh_option
108 Can be used to pass options to
109 .Nm ssh
110 in the format used in
111 .Xr ssh_config 5 .
112 This is useful for specifying options
113 for which there is no separate
114 .Nm scp
115 command-line flag.
116 For full details of the options listed below, and their possible values, see
117 .Xr ssh_config 5 .
119 .Bl -tag -width Ds -offset indent -compact
120 .It AddressFamily
121 .It BatchMode
122 .It BindAddress
123 .It ChallengeResponseAuthentication
124 .It CheckHostIP
125 .It Cipher
126 .It Ciphers
127 .It Compression
128 .It CompressionLevel
129 .It ConnectionAttempts
130 .It ConnectTimeout
131 .It ControlMaster
132 .It ControlPath
133 .It GlobalKnownHostsFile
134 .It GSSAPIAuthentication
135 .It GSSAPIDelegateCredentials
136 .It HashKnownHosts
137 .It Host
138 .It HostbasedAuthentication
139 .It HostKeyAlgorithms
140 .It HostKeyAlias
141 .It HostName
142 .It IdentityFile
143 .It IdentitiesOnly
144 .It KbdInteractiveDevices
145 .It LogLevel
146 .It MACs
147 .It NoHostAuthenticationForLocalhost
148 .It NumberOfPasswordPrompts
149 .It PasswordAuthentication
150 .It Port
151 .It PreferredAuthentications
152 .It Protocol
153 .It ProxyCommand
154 .It PubkeyAuthentication
155 .It RekeyLimit
156 .It RhostsRSAAuthentication
157 .It RSAAuthentication
158 .It SendEnv
159 .It ServerAliveInterval
160 .It ServerAliveCountMax
161 .It SmartcardDevice
162 .It StrictHostKeyChecking
163 .It TCPKeepAlive
164 .It UsePrivilegedPort
165 .It User
166 .It UserKnownHostsFile
167 .It VerifyHostKeyDNS
169 .It Fl P Ar port
170 Specifies the port to connect to on the remote host.
171 Note that this option is written with a capital
172 .Sq P ,
173 because
174 .Fl p
175 is already reserved for preserving the times and modes of the file in
176 .Xr rcp 1 .
177 .It Fl p
178 Preserves modification times, access times, and modes from the
179 original file.
180 .It Fl q
181 Disables the progress meter.
182 .It Fl r
183 Recursively copy entire directories.
184 .It Fl S Ar program
185 Name of
186 .Ar program
187 to use for the encrypted connection.
188 The program must understand
189 .Xr ssh 1
190 options.
191 .It Fl v
192 Verbose mode.
193 Causes
196 .Xr ssh 1
197 to print debugging messages about their progress.
198 This is helpful in
199 debugging connection, authentication, and configuration problems.
202 .Ex -std scp
203 .Sh SEE ALSO
204 .Xr rcp 1 ,
205 .Xr sftp 1 ,
206 .Xr ssh 1 ,
207 .Xr ssh-add 1 ,
208 .Xr ssh-agent 1 ,
209 .Xr ssh-keygen 1 ,
210 .Xr ssh_config 5 ,
211 .Xr sshd 8
212 .Sh HISTORY
214 is based on the
215 .Xr rcp 1
216 program in BSD source code from the Regents of the University of
217 California.
218 .Sh AUTHORS
219 .An Timo Rinne Aq tri@iki.fi
220 .An Tatu Ylonen Aq ylo@cs.hut.fi