xref: /dragonfly/crypto/openssh/scp.1 (revision 07a2f99c)
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.58 2011/09/05 07:01:44 jmc Exp $
12.\"
13.Dd $Mdocdate: September 5 2011 $
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 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 ControlPersist
144.It GlobalKnownHostsFile
145.It GSSAPIAuthentication
146.It GSSAPIDelegateCredentials
147.It HashKnownHosts
148.It Host
149.It HostbasedAuthentication
150.It HostKeyAlgorithms
151.It HostKeyAlias
152.It HostName
153.It IdentityFile
154.It IdentitiesOnly
155.It IPQoS
156.It KbdInteractiveAuthentication
157.It KbdInteractiveDevices
158.It KexAlgorithms
159.It LogLevel
160.It MACs
161.It NoHostAuthenticationForLocalhost
162.It NumberOfPasswordPrompts
163.It PasswordAuthentication
164.It PKCS11Provider
165.It Port
166.It PreferredAuthentications
167.It Protocol
168.It ProxyCommand
169.It PubkeyAuthentication
170.It RekeyLimit
171.It RhostsRSAAuthentication
172.It RSAAuthentication
173.It SendEnv
174.It ServerAliveInterval
175.It ServerAliveCountMax
176.It StrictHostKeyChecking
177.It TCPKeepAlive
178.It UsePrivilegedPort
179.It User
180.It UserKnownHostsFile
181.It VerifyHostKeyDNS
182.El
183.It Fl P Ar port
184Specifies the port to connect to on the remote host.
185Note that this option is written with a capital
186.Sq P ,
187because
188.Fl p
189is already reserved for preserving the times and modes of the file in
190.Xr rcp 1 .
191.It Fl p
192Preserves modification times, access times, and modes from the
193original file.
194.It Fl q
195Quiet mode: disables the progress meter as well as warning and diagnostic
196messages from
197.Xr ssh 1 .
198.It Fl r
199Recursively copy entire directories.
200Note that
201.Nm
202follows symbolic links encountered in the tree traversal.
203.It Fl S Ar program
204Name of
205.Ar program
206to use for the encrypted connection.
207The program must understand
208.Xr ssh 1
209options.
210.It Fl v
211Verbose mode.
212Causes
213.Nm
214and
215.Xr ssh 1
216to print debugging messages about their progress.
217This is helpful in
218debugging connection, authentication, and configuration problems.
219.El
220.Sh EXIT STATUS
221.Ex -std scp
222.Sh SEE ALSO
223.Xr rcp 1 ,
224.Xr sftp 1 ,
225.Xr ssh 1 ,
226.Xr ssh-add 1 ,
227.Xr ssh-agent 1 ,
228.Xr ssh-keygen 1 ,
229.Xr ssh_config 5 ,
230.Xr sshd 8
231.Sh HISTORY
232.Nm
233is based on the
234.Xr rcp 1
235program in BSD source code from the Regents of the University of
236California.
237.Sh AUTHORS
238.An Timo Rinne Aq tri@iki.fi
239.An Tatu Ylonen Aq ylo@cs.hut.fi
240