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