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