xref: /freebsd/crypto/openssh/scp.1 (revision 6af83ee0d2941d18880b6aaa2b4facd1d30c6106)
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.36 2004/06/13 15:03:02 djm 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 Host
137.It HostbasedAuthentication
138.It HostKeyAlgorithms
139.It HostKeyAlias
140.It HostName
141.It IdentityFile
142.It IdentitiesOnly
143.It LogLevel
144.It MACs
145.It NoHostAuthenticationForLocalhost
146.It NumberOfPasswordPrompts
147.It PasswordAuthentication
148.It Port
149.It PreferredAuthentications
150.It Protocol
151.It ProxyCommand
152.It PubkeyAuthentication
153.It RhostsRSAAuthentication
154.It RSAAuthentication
155.It SendEnv
156.It ServerAliveInterval
157.It ServerAliveCountMax
158.It SmartcardDevice
159.It StrictHostKeyChecking
160.It TCPKeepAlive
161.It UsePrivilegedPort
162.It User
163.It UserKnownHostsFile
164.It VerifyHostKeyDNS
165.El
166.It Fl P Ar port
167Specifies the port to connect to on the remote host.
168Note that this option is written with a capital
169.Sq P ,
170because
171.Fl p
172is already reserved for preserving the times and modes of the file in
173.Xr rcp 1 .
174.It Fl p
175Preserves modification times, access times, and modes from the
176original file.
177.It Fl q
178Disables the progress meter.
179.It Fl r
180Recursively copy entire directories.
181.It Fl S Ar program
182Name of
183.Ar program
184to use for the encrypted connection.
185The program must understand
186.Xr ssh 1
187options.
188.It Fl v
189Verbose mode.
190Causes
191.Nm
192and
193.Xr ssh 1
194to print debugging messages about their progress.
195This is helpful in
196debugging connection, authentication, and configuration problems.
197.El
198.Sh DIAGNOSTICS
199.Nm
200exits with 0 on success or >0 if an error occurred.
201.Sh SEE ALSO
202.Xr rcp 1 ,
203.Xr sftp 1 ,
204.Xr ssh 1 ,
205.Xr ssh-add 1 ,
206.Xr ssh-agent 1 ,
207.Xr ssh-keygen 1 ,
208.Xr ssh_config 5 ,
209.Xr sshd 8
210.Sh HISTORY
211.Nm
212is based on the
213.Xr rcp 1
214program in BSD source code from the Regents of the University of
215California.
216.Sh AUTHORS
217.An Timo Rinne Aq tri@iki.fi
218.An Tatu Ylonen Aq ylo@cs.hut.fi
219