Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / 700dcfa3e0a98be44f2e3675849055984f04a70a / . / scp.1
blob: bc5e259f54fef9d72d44becf8c50ad62f2e96b4a [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 Miller7ea845e2010-02-12 09:21:02 +1100[diff] [blame]12.\" $OpenBSD: scp.1,v 1.50 2010/02/08 10:50:20 markus Exp $
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]13.\"
Damien Miller7ea845e2010-02-12 09:21:02 +1100[diff] [blame]14.Dd $Mdocdate: February 8 2010 $
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]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
Damien Miller647d97b2007-08-08 14:29:58 +1000[diff] [blame]37.Ar ...
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]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
Damien Millerb508faa2008-02-10 22:28:45 +1100[diff] [blame]59File names may contain a user and host specification to indicate
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]60that the file is to be copied to/from that host.
Damien Millerb508faa2008-02-10 22:28:45 +1100[diff] [blame]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.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]68.Pp
69The options are as follows:
70.Bl -tag -width Ds
Damien Miller8e121472003-01-24 11:37:38 +1100[diff] [blame]71.It Fl 1
72Forces
73.Nm
74to use protocol 1.
75.It Fl 2
76Forces
77.Nm
78to use protocol 2.
Damien Miller34132e52000-01-14 15:45:46 +1100[diff] [blame]79.It Fl 4
80Forces
81.Nm
82to use IPv4 addresses only.
83.It Fl 6
84Forces
85.Nm
86to use IPv6 addresses only.
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]87.It Fl B
88Selects batch mode (prevents asking for passwords or passphrases).
89.It Fl C
90Compression enable.
91Passes the
92.Fl C
93flag to
94.Xr ssh 1
95to enable compression.
96.It Fl c Ar cipher
97Selects the cipher to use for encrypting the data transfer.
98This option is directly passed to
99.Xr ssh 1 .
100.It Fl F Ar ssh_config
101Specifies an alternative
102per-user configuration file for
103.Nm ssh .
104This option is directly passed to
105.Xr ssh 1 .
106.It Fl i Ar identity_file
Damien Millera034baf2008-07-12 17:12:49 +1000[diff] [blame]107Selects the file from which the identity (private key) for public key
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]108authentication is read.
109This option is directly passed to
110.Xr ssh 1 .
111.It Fl l Ar limit
112Limits the used bandwidth, specified in Kbit/s.
113.It Fl o Ar ssh_option
114Can be used to pass options to
115.Nm ssh
116in the format used in
117.Xr ssh_config 5 .
118This is useful for specifying options
119for which there is no separate
120.Nm scp
121command-line flag.
122For full details of the options listed below, and their possible values, see
123.Xr ssh_config 5 .
124.Pp
125.Bl -tag -width Ds -offset indent -compact
126.It AddressFamily
127.It BatchMode
128.It BindAddress
129.It ChallengeResponseAuthentication
130.It CheckHostIP
131.It Cipher
132.It Ciphers
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]133.It Compression
134.It CompressionLevel
135.It ConnectionAttempts
Darren Tuckerc0796d72004-05-03 09:19:03 +1000[diff] [blame]136.It ConnectTimeout
Damien Miller0e220db2004-06-15 10:34:08 +1000[diff] [blame]137.It ControlMaster
138.It ControlPath
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]139.It GlobalKnownHostsFile
140.It GSSAPIAuthentication
141.It GSSAPIDelegateCredentials
Damien Miller27e9c512005-03-02 12:04:16 +1100[diff] [blame]142.It HashKnownHosts
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]143.It Host
144.It HostbasedAuthentication
145.It HostKeyAlgorithms
146.It HostKeyAlias
147.It HostName
148.It IdentityFile
Damien Millerbd394c32004-03-08 23:12:36 +1100[diff] [blame]149.It IdentitiesOnly
Darren Tucker636ca902004-11-05 20:22:00 +1100[diff] [blame]150.It KbdInteractiveDevices
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]151.It LogLevel
152.It MACs
153.It NoHostAuthenticationForLocalhost
154.It NumberOfPasswordPrompts
155.It PasswordAuthentication
Damien Miller7ea845e2010-02-12 09:21:02 +1100[diff] [blame]156.It PKCS11Provider
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]157.It Port
158.It PreferredAuthentications
159.It Protocol
160.It ProxyCommand
161.It PubkeyAuthentication
Darren Tucker62388b22006-01-20 11:31:47 +1100[diff] [blame]162.It RekeyLimit
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]163.It RhostsRSAAuthentication
164.It RSAAuthentication
Darren Tucker2e578f62004-05-13 13:03:04 +1000[diff] [blame]165.It SendEnv
Damien Miller509b0102003-12-17 16:33:10 +1100[diff] [blame]166.It ServerAliveInterval
167.It ServerAliveCountMax
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]168.It StrictHostKeyChecking
Damien Miller12c150e2003-12-17 16:31:10 +1100[diff] [blame]169.It TCPKeepAlive
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]170.It UsePrivilegedPort
171.It User
172.It UserKnownHostsFile
173.It VerifyHostKeyDNS
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]174.El
175.It Fl P Ar port
176Specifies the port to connect to on the remote host.
177Note that this option is written with a capital
178.Sq P ,
179because
180.Fl p
181is already reserved for preserving the times and modes of the file in
182.Xr rcp 1 .
183.It Fl p
184Preserves modification times, access times, and modes from the
185original file.
186.It Fl q
Damien Miller4cd24c72008-02-10 22:22:29 +1100[diff] [blame]187Quiet mode: disables the progress meter as well as warning and diagnostic
188messages from
189.Xr ssh 1 .
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]190.It Fl r
191Recursively copy entire directories.
Damien Millerc7ce0da2008-06-16 07:55:06 +1000[diff] [blame]192Note that
193.Nm
194follows symbolic links encountered in the tree traversal.
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]195.It Fl S Ar program
196Name of
197.Ar program
198to use for the encrypted connection.
199The program must understand
200.Xr ssh 1
201options.
202.It Fl v
203Verbose mode.
204Causes
205.Nm
206and
207.Xr ssh 1
208to print debugging messages about their progress.
209This is helpful in
210debugging connection, authentication, and configuration problems.
Damien Miller37023962000-07-11 17:31:38 +1000[diff] [blame]211.El
Damien Miller22d47ab2006-07-24 14:04:36 +1000[diff] [blame]212.Pp
213.Ex -std scp
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]214.Sh SEE ALSO
215.Xr rcp 1 ,
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]216.Xr sftp 1 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]217.Xr ssh 1 ,
218.Xr ssh-add 1 ,
219.Xr ssh-agent 1 ,
220.Xr ssh-keygen 1 ,
Ben Lindstromc06bf702002-06-23 00:34:37 +0000[diff] [blame]221.Xr ssh_config 5 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]222.Xr sshd 8
Damien Millerf1ce5052003-06-11 22:04:39 +1000[diff] [blame]223.Sh HISTORY
224.Nm
225is based on the
226.Xr rcp 1
227program in BSD source code from the Regents of the University of
228California.
229.Sh AUTHORS
230.An Timo Rinne Aq tri@iki.fi
Damien Millerf1ce5052003-06-11 22:04:39 +1000[diff] [blame]231.An Tatu Ylonen Aq ylo@cs.hut.fi