xref: /freebsd/crypto/openssh/scp.1 (revision f0a75d274af375d15b97b830966b99a02b7db911)
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
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
59Any file name may contain a host and user specification to indicate
60that the file is to be copied to/from that host.
61Copies between two remote hosts are permitted.
62.Pp
63The options are as follows:
64.Bl -tag -width Ds
65.It Fl 1
66Forces
67.Nm
68to use protocol 1.
69.It Fl 2
70Forces
71.Nm
72to use protocol 2.
73.It Fl 4
74Forces
75.Nm
76to use IPv4 addresses only.
77.It Fl 6
78Forces
79.Nm
80to use IPv6 addresses only.
81.It Fl B
82Selects batch mode (prevents asking for passwords or passphrases).
83.It Fl C
84Compression enable.
85Passes the
86.Fl C
87flag to
88.Xr ssh 1
89to enable compression.
90.It Fl c Ar cipher
91Selects the cipher to use for encrypting the data transfer.
92This option is directly passed to
93.Xr ssh 1 .
94.It Fl F Ar ssh_config
95Specifies an alternative
96per-user configuration file for
97.Nm ssh .
98This option is directly passed to
99.Xr ssh 1 .
100.It Fl i Ar identity_file
101Selects the file from which the identity (private key) for RSA
102authentication is read.
103This option is directly passed to
104.Xr ssh 1 .
105.It Fl l Ar limit
106Limits the used bandwidth, specified in Kbit/s.
107.It Fl o Ar ssh_option
108Can be used to pass options to
109.Nm ssh
110in the format used in
111.Xr ssh_config 5 .
112This is useful for specifying options
113for which there is no separate
114.Nm scp
115command-line flag.
116For full details of the options listed below, and their possible values, see
117.Xr ssh_config 5 .
118.Pp
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
168.El
169.It Fl P Ar port
170Specifies the port to connect to on the remote host.
171Note that this option is written with a capital
172.Sq P ,
173because
174.Fl p
175is already reserved for preserving the times and modes of the file in
176.Xr rcp 1 .
177.It Fl p
178Preserves modification times, access times, and modes from the
179original file.
180.It Fl q
181Disables the progress meter.
182.It Fl r
183Recursively copy entire directories.
184.It Fl S Ar program
185Name of
186.Ar program
187to use for the encrypted connection.
188The program must understand
189.Xr ssh 1
190options.
191.It Fl v
192Verbose mode.
193Causes
194.Nm
195and
196.Xr ssh 1
197to print debugging messages about their progress.
198This is helpful in
199debugging connection, authentication, and configuration problems.
200.El
201.Pp
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
213.Nm
214is based on the
215.Xr rcp 1
216program in BSD source code from the Regents of the University of
217California.
218.Sh AUTHORS
219.An Timo Rinne Aq tri@iki.fi
220.An Tatu Ylonen Aq ylo@cs.hut.fi
221