Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / 248dd13c4686bcf1c1b29533a7f5c2e4264083cf / . / scp.1
blob: b5191e318129fd8fd478041ef9eb708530981622 [file] [log] [blame]
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]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.\"
Damien Miller27e9c512005-03-02 12:04:16 +1100[diff] [blame]12.\" $OpenBSD: scp.1,v 1.38 2005/03/01 17:19:35 jmc Exp $
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]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
Damien Miller495dca32003-04-01 21:42:14 +1000[diff] [blame]22.Bk -words
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]23.Op Fl 1246BCpqrv
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]24.Op Fl c Ar cipher
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]25.Op Fl F Ar ssh_config
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]26.Op Fl i Ar identity_file
Damien Miller8ee66a22003-02-24 11:50:50 +1100[diff] [blame]27.Op Fl l Ar limit
Ben Lindstrom14c62eb2001-08-15 23:25:46 +0000[diff] [blame]28.Op Fl o Ar ssh_option
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]29.Op Fl P Ar port
30.Op Fl S Ar program
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]31.Sm off
32.Oo
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]33.Op Ar user No @
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]34.Ar host1 No :
35.Oc Ns Ar file1
36.Sm on
37.Op Ar ...
38.Sm off
39.Oo
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]40.Op Ar user No @
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]41.Ar host2 No :
42.Oc Ar file2
43.Sm on
Damien Miller495dca32003-04-01 21:42:14 +1000[diff] [blame]44.Ek
Damien Miller22c77262000-04-13 12:26:34 +1000[diff] [blame]45.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]46.Nm
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]47copies files between hosts on a network.
48It uses
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]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
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]60that the file is to be copied to/from that host.
61Copies between two remote hosts are permitted.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]62.Pp
63The options are as follows:
64.Bl -tag -width Ds
Damien Miller8e121472003-01-24 11:37:38 +1100[diff] [blame]65.It Fl 1
66Forces
67.Nm
68to use protocol 1.
69.It Fl 2
70Forces
71.Nm
72to use protocol 2.
Damien Miller34132e52000-01-14 15:45:46 +1100[diff] [blame]73.It Fl 4
74Forces
75.Nm
76to use IPv4 addresses only.
77.It Fl 6
78Forces
79.Nm
80to use IPv6 addresses only.
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]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
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]127.It Compression
128.It CompressionLevel
129.It ConnectionAttempts
Darren Tuckerc0796d72004-05-03 09:19:03 +1000[diff] [blame]130.It ConnectTimeout
Damien Miller0e220db2004-06-15 10:34:08 +1000[diff] [blame]131.It ControlMaster
132.It ControlPath
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]133.It GlobalKnownHostsFile
134.It GSSAPIAuthentication
135.It GSSAPIDelegateCredentials
Damien Miller27e9c512005-03-02 12:04:16 +1100[diff] [blame]136.It HashKnownHosts
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]137.It Host
138.It HostbasedAuthentication
139.It HostKeyAlgorithms
140.It HostKeyAlias
141.It HostName
142.It IdentityFile
Damien Millerbd394c32004-03-08 23:12:36 +1100[diff] [blame]143.It IdentitiesOnly
Darren Tucker636ca902004-11-05 20:22:00 +1100[diff] [blame]144.It KbdInteractiveDevices
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]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
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]155.It RhostsRSAAuthentication
156.It RSAAuthentication
Darren Tucker2e578f62004-05-13 13:03:04 +1000[diff] [blame]157.It SendEnv
Damien Miller509b0102003-12-17 16:33:10 +1100[diff] [blame]158.It ServerAliveInterval
159.It ServerAliveCountMax
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]160.It SmartcardDevice
161.It StrictHostKeyChecking
Damien Miller12c150e2003-12-17 16:31:10 +1100[diff] [blame]162.It TCPKeepAlive
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]163.It UsePrivilegedPort
164.It User
165.It UserKnownHostsFile
166.It VerifyHostKeyDNS
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]167.El
168.It Fl P Ar port
169Specifies the port to connect to on the remote host.
170Note that this option is written with a capital
171.Sq P ,
172because
173.Fl p
174is already reserved for preserving the times and modes of the file in
175.Xr rcp 1 .
176.It Fl p
177Preserves modification times, access times, and modes from the
178original file.
179.It Fl q
180Disables the progress meter.
181.It Fl r
182Recursively copy entire directories.
183.It Fl S Ar program
184Name of
185.Ar program
186to use for the encrypted connection.
187The program must understand
188.Xr ssh 1
189options.
190.It Fl v
191Verbose mode.
192Causes
193.Nm
194and
195.Xr ssh 1
196to print debugging messages about their progress.
197This is helpful in
198debugging connection, authentication, and configuration problems.
Damien Miller37023962000-07-11 17:31:38 +1000[diff] [blame]199.El
Damien Miller07a2d422002-02-05 12:16:15 +1100[diff] [blame]200.Sh DIAGNOSTICS
201.Nm
202exits with 0 on success or >0 if an error occurred.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]203.Sh SEE ALSO
204.Xr rcp 1 ,
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]205.Xr sftp 1 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]206.Xr ssh 1 ,
207.Xr ssh-add 1 ,
208.Xr ssh-agent 1 ,
209.Xr ssh-keygen 1 ,
Ben Lindstromc06bf702002-06-23 00:34:37 +0000[diff] [blame]210.Xr ssh_config 5 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]211.Xr sshd 8
Damien Millerf1ce5052003-06-11 22:04:39 +1000[diff] [blame]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
Damien Millerf1ce5052003-06-11 22:04:39 +1000[diff] [blame]220.An Tatu Ylonen Aq ylo@cs.hut.fi