Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / 1a3d14f6b44a494037c7deab485abe6496bf2c60 / . / scp.1
blob: b80ad8bfcfdc7a99dc67ad505dda05ff482594e0 [file] [log] [blame]
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]1.\"
2.\" scp.1
3.\"
4.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
5.\"
6.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7.\" All rights reserved
8.\"
9.\" Created: Sun May 7 00:14:37 1995 ylo
10.\"
jmc@openbsd.org9f7637f2015-01-26 13:55:29 +0000[diff] [blame]11.\" $OpenBSD: scp.1,v 1.65 2015/01/26 13:55:29 jmc Exp $
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]12.\"
djm@openbsd.org1d1092b2015-01-26 12:16:36 +0000[diff] [blame]13.Dd $Mdocdate: January 26 2015 $
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]14.Dt SCP 1
15.Os
16.Sh NAME
17.Nm scp
18.Nd secure copy (remote file copy program)
19.Sh SYNOPSIS
20.Nm scp
Damien Miller495dca32003-04-01 21:42:14 +1000[diff] [blame]21.Bk -words
Damien Millerf1211432011-01-06 22:40:30 +1100[diff] [blame]22.Op Fl 12346BCpqrv
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]23.Op Fl c Ar cipher
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]24.Op Fl F Ar ssh_config
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]25.Op Fl i Ar identity_file
Damien Miller8ee66a22003-02-24 11:50:50 +1100[diff] [blame]26.Op Fl l Ar limit
Ben Lindstrom14c62eb2001-08-15 23:25:46 +0000[diff] [blame]27.Op Fl o Ar ssh_option
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]28.Op Fl P Ar port
29.Op Fl S Ar program
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]30.Sm off
31.Oo
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]32.Op Ar user No @
schwarze@openbsd.org369d61f2015-01-16 16:20:23 +0000[diff] [blame]33.Ar host1 :
Damien Millere0296732011-09-22 21:34:56 +1000[diff] [blame]34.Oc Ar file1
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]35.Sm on
Damien Miller647d97b2007-08-08 14:29:58 +1000[diff] [blame]36.Ar ...
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]37.Sm off
38.Oo
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]39.Op Ar user No @
schwarze@openbsd.org369d61f2015-01-16 16:20:23 +0000[diff] [blame]40.Ar host2 :
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]41.Oc Ar file2
42.Sm on
Damien Miller495dca32003-04-01 21:42:14 +1000[diff] [blame]43.Ek
Damien Miller22c77262000-04-13 12:26:34 +1000[diff] [blame]44.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]45.Nm
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]46copies files between hosts on a network.
47It uses
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]48.Xr ssh 1
49for data transfer, and uses the same authentication and provides the
50same security as
51.Xr ssh 1 .
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]52.Nm
53will ask for passwords or passphrases if they are needed for
54authentication.
55.Pp
Damien Millerb508faa2008-02-10 22:28:45 +1100[diff] [blame]56File names may contain a user and host specification to indicate
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]57that the file is to be copied to/from that host.
Damien Millerb508faa2008-02-10 22:28:45 +1100[diff] [blame]58Local file names can be made explicit using absolute or relative pathnames
59to avoid
60.Nm
61treating file names containing
62.Sq :\&
63as host specifiers.
64Copies between two remote hosts are also permitted.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]65.Pp
66The options are as follows:
67.Bl -tag -width Ds
Damien Miller8e121472003-01-24 11:37:38 +1100[diff] [blame]68.It Fl 1
69Forces
70.Nm
71to use protocol 1.
72.It Fl 2
73Forces
74.Nm
75to use protocol 2.
Damien Millerf1211432011-01-06 22:40:30 +1100[diff] [blame]76.It Fl 3
77Copies between two remote hosts are transferred through the local host.
78Without this option the data is copied directly between the two remote
79hosts.
Damien Miller907998d2011-01-06 22:41:21 +1100[diff] [blame]80Note that this option disables the progress meter.
Damien Miller34132e52000-01-14 15:45:46 +1100[diff] [blame]81.It Fl 4
82Forces
83.Nm
84to use IPv4 addresses only.
85.It Fl 6
86Forces
87.Nm
88to use IPv6 addresses only.
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]89.It Fl B
90Selects batch mode (prevents asking for passwords or passphrases).
91.It Fl C
92Compression enable.
93Passes the
94.Fl C
95flag to
96.Xr ssh 1
97to enable compression.
98.It Fl c Ar cipher
99Selects the cipher to use for encrypting the data transfer.
100This option is directly passed to
101.Xr ssh 1 .
102.It Fl F Ar ssh_config
103Specifies an alternative
104per-user configuration file for
105.Nm ssh .
106This option is directly passed to
107.Xr ssh 1 .
108.It Fl i Ar identity_file
Damien Millera034baf2008-07-12 17:12:49 +1000[diff] [blame]109Selects the file from which the identity (private key) for public key
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]110authentication is read.
111This option is directly passed to
112.Xr ssh 1 .
113.It Fl l Ar limit
114Limits the used bandwidth, specified in Kbit/s.
115.It Fl o Ar ssh_option
116Can be used to pass options to
117.Nm ssh
118in the format used in
119.Xr ssh_config 5 .
120This is useful for specifying options
121for which there is no separate
122.Nm scp
123command-line flag.
124For full details of the options listed below, and their possible values, see
125.Xr ssh_config 5 .
126.Pp
127.Bl -tag -width Ds -offset indent -compact
128.It AddressFamily
129.It BatchMode
130.It BindAddress
Damien Millerc0049bd2013-10-23 16:29:59 +1100[diff] [blame]131.It CanonicalDomains
132.It CanonicalizeFallbackLocal
133.It CanonicalizeHostname
134.It CanonicalizeMaxDots
135.It CanonicalizePermittedCNAMEs
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]136.It ChallengeResponseAuthentication
137.It CheckHostIP
138.It Cipher
139.It Ciphers
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]140.It Compression
141.It CompressionLevel
142.It ConnectionAttempts
Darren Tuckerc0796d72004-05-03 09:19:03 +1000[diff] [blame]143.It ConnectTimeout
Damien Miller0e220db2004-06-15 10:34:08 +1000[diff] [blame]144.It ControlMaster
145.It ControlPath
Damien Millere5777722011-09-22 21:34:15 +1000[diff] [blame]146.It ControlPersist
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]147.It GlobalKnownHostsFile
148.It GSSAPIAuthentication
149.It GSSAPIDelegateCredentials
Damien Miller27e9c512005-03-02 12:04:16 +1100[diff] [blame]150.It HashKnownHosts
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]151.It Host
152.It HostbasedAuthentication
153.It HostKeyAlgorithms
154.It HostKeyAlias
155.It HostName
156.It IdentityFile
Damien Millerbd394c32004-03-08 23:12:36 +1100[diff] [blame]157.It IdentitiesOnly
Damien Miller0a184732010-11-20 15:21:03 +1100[diff] [blame]158.It IPQoS
Damien Millere5777722011-09-22 21:34:15 +1000[diff] [blame]159.It KbdInteractiveAuthentication
Darren Tucker636ca902004-11-05 20:22:00 +1100[diff] [blame]160.It KbdInteractiveDevices
Damien Miller2beb32f2010-09-24 22:16:03 +1000[diff] [blame]161.It KexAlgorithms
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]162.It LogLevel
163.It MACs
164.It NoHostAuthenticationForLocalhost
165.It NumberOfPasswordPrompts
166.It PasswordAuthentication
Damien Miller7ea845e2010-02-12 09:21:02 +1100[diff] [blame]167.It PKCS11Provider
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]168.It Port
169.It PreferredAuthentications
170.It Protocol
171.It ProxyCommand
172.It PubkeyAuthentication
Darren Tucker62388b22006-01-20 11:31:47 +1100[diff] [blame]173.It RekeyLimit
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]174.It RhostsRSAAuthentication
175.It RSAAuthentication
Darren Tucker2e578f62004-05-13 13:03:04 +1000[diff] [blame]176.It SendEnv
Damien Miller509b0102003-12-17 16:33:10 +1100[diff] [blame]177.It ServerAliveInterval
178.It ServerAliveCountMax
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]179.It StrictHostKeyChecking
Damien Miller12c150e2003-12-17 16:31:10 +1100[diff] [blame]180.It TCPKeepAlive
djm@openbsd.org1d1092b2015-01-26 12:16:36 +0000[diff] [blame]181.It UpdateHostKeys
jmc@openbsd.org9f7637f2015-01-26 13:55:29 +0000[diff] [blame]182.It UsePrivilegedPort
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]183.It User
184.It UserKnownHostsFile
185.It VerifyHostKeyDNS
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]186.El
187.It Fl P Ar port
188Specifies the port to connect to on the remote host.
189Note that this option is written with a capital
190.Sq P ,
191because
192.Fl p
Damien Miller6e1777f2014-04-20 13:02:58 +1000[diff] [blame]193is already reserved for preserving the times and modes of the file.
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]194.It Fl p
195Preserves modification times, access times, and modes from the
196original file.
197.It Fl q
Damien Miller4cd24c72008-02-10 22:22:29 +1100[diff] [blame]198Quiet mode: disables the progress meter as well as warning and diagnostic
199messages from
200.Xr ssh 1 .
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]201.It Fl r
202Recursively copy entire directories.
Damien Millerc7ce0da2008-06-16 07:55:06 +1000[diff] [blame]203Note that
204.Nm
205follows symbolic links encountered in the tree traversal.
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]206.It Fl S Ar program
207Name of
208.Ar program
209to use for the encrypted connection.
210The program must understand
211.Xr ssh 1
212options.
213.It Fl v
214Verbose mode.
215Causes
216.Nm
217and
218.Xr ssh 1
219to print debugging messages about their progress.
220This is helpful in
221debugging connection, authentication, and configuration problems.
Damien Miller37023962000-07-11 17:31:38 +1000[diff] [blame]222.El
Damien Miller390f1532010-09-10 11:17:54 +1000[diff] [blame]223.Sh EXIT STATUS
Damien Miller22d47ab2006-07-24 14:04:36 +1000[diff] [blame]224.Ex -std scp
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]225.Sh SEE ALSO
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]226.Xr sftp 1 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]227.Xr ssh 1 ,
228.Xr ssh-add 1 ,
229.Xr ssh-agent 1 ,
230.Xr ssh-keygen 1 ,
Ben Lindstromc06bf702002-06-23 00:34:37 +0000[diff] [blame]231.Xr ssh_config 5 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]232.Xr sshd 8
Damien Millerf1ce5052003-06-11 22:04:39 +1000[diff] [blame]233.Sh HISTORY
234.Nm
Damien Miller6e1777f2014-04-20 13:02:58 +1000[diff] [blame]235is based on the rcp program in
Damien Millerb7727df2013-08-21 02:43:49 +1000[diff] [blame]236.Bx
237source code from the Regents of the University of California.
Damien Millerf1ce5052003-06-11 22:04:39 +1000[diff] [blame]238.Sh AUTHORS
Damien Millerbf836e52013-07-18 16:14:13 +1000[diff] [blame]239.An Timo Rinne Aq Mt tri@iki.fi
240.An Tatu Ylonen Aq Mt ylo@cs.hut.fi