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