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