Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / f382362e8dfb6b277f16779ab1936399d7f2af78 / . / scp.1
blob: 0431c7807fa1e10fb1f49e20f9267e3553374917 [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.\"
djm@openbsd.orga3710d52017-04-30 23:28:12 +0000[diff] [blame]11.\" $OpenBSD: scp.1,v 1.72 2017/04/30 23:28:12 djm Exp $
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]12.\"
djm@openbsd.orga3710d52017-04-30 23:28:12 +0000[diff] [blame]13.Dd $Mdocdate: April 30 2017 $
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
djm@openbsd.orga3710d52017-04-30 23:28:12 +0000[diff] [blame]22.Op Fl 346BCpqrv
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 Millerf1211432011-01-06 22:40:30 +1100[diff] [blame]68.It Fl 3
69Copies between two remote hosts are transferred through the local host.
70Without this option the data is copied directly between the two remote
71hosts.
Damien Miller907998d2011-01-06 22:41:21 +1100[diff] [blame]72Note that this option disables the progress meter.
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
Damien Millera034baf2008-07-12 17:12:49 +1000[diff] [blame]101Selects the file from which the identity (private key) for public key
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]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
Damien Millerc0049bd2013-10-23 16:29:59 +1100[diff] [blame]123.It CanonicalDomains
124.It CanonicalizeFallbackLocal
125.It CanonicalizeHostname
126.It CanonicalizeMaxDots
127.It CanonicalizePermittedCNAMEs
jmc@openbsd.orgc5f7c082015-09-25 18:19:54 +0000[diff] [blame]128.It CertificateFile
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]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
Damien Millere5777722011-09-22 21:34:15 +1000[diff] [blame]139.It ControlPersist
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]140.It GlobalKnownHostsFile
141.It GSSAPIAuthentication
142.It GSSAPIDelegateCredentials
Damien Miller27e9c512005-03-02 12:04:16 +1100[diff] [blame]143.It HashKnownHosts
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]144.It Host
145.It HostbasedAuthentication
djm@openbsd.org46347ed2015-01-30 11:43:14 +0000[diff] [blame]146.It HostbasedKeyTypes
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]147.It HostKeyAlgorithms
148.It HostKeyAlias
149.It HostName
jmc@openbsd.org772e6ce2016-06-29 17:14:28 +0000[diff] [blame]150.It IdentitiesOnly
markus@openbsd.org75e21682016-05-04 14:32:26 +0000[diff] [blame]151.It IdentityAgent
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]152.It IdentityFile
Damien Miller0a184732010-11-20 15:21:03 +1100[diff] [blame]153.It IPQoS
Damien Millere5777722011-09-22 21:34:15 +1000[diff] [blame]154.It KbdInteractiveAuthentication
Darren Tucker636ca902004-11-05 20:22:00 +1100[diff] [blame]155.It KbdInteractiveDevices
Damien Miller2beb32f2010-09-24 22:16:03 +1000[diff] [blame]156.It KexAlgorithms
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]157.It LogLevel
158.It MACs
159.It NoHostAuthenticationForLocalhost
160.It NumberOfPasswordPrompts
161.It PasswordAuthentication
Damien Miller7ea845e2010-02-12 09:21:02 +1100[diff] [blame]162.It PKCS11Provider
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]163.It Port
164.It PreferredAuthentications
165.It Protocol
166.It ProxyCommand
jmc@openbsd.orge4eb7d92016-07-16 06:57:55 +0000[diff] [blame]167.It ProxyJump
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000[diff] [blame]168.It PubkeyAcceptedKeyTypes
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]169.It PubkeyAuthentication
Darren Tucker62388b22006-01-20 11:31:47 +1100[diff] [blame]170.It RekeyLimit
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]171.It RhostsRSAAuthentication
172.It RSAAuthentication
Darren Tucker2e578f62004-05-13 13:03:04 +1000[diff] [blame]173.It SendEnv
Damien Miller509b0102003-12-17 16:33:10 +1100[diff] [blame]174.It ServerAliveInterval
175.It ServerAliveCountMax
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]176.It StrictHostKeyChecking
Damien Miller12c150e2003-12-17 16:31:10 +1100[diff] [blame]177.It TCPKeepAlive
djm@openbsd.org1d1092b2015-01-26 12:16:36 +0000[diff] [blame]178.It UpdateHostKeys
jmc@openbsd.org9f7637f2015-01-26 13:55:29 +0000[diff] [blame]179.It UsePrivilegedPort
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]180.It User
181.It UserKnownHostsFile
182.It VerifyHostKeyDNS
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]183.El
184.It Fl P Ar port
185Specifies the port to connect to on the remote host.
186Note that this option is written with a capital
187.Sq P ,
188because
189.Fl p
Damien Miller6e1777f2014-04-20 13:02:58 +1000[diff] [blame]190is already reserved for preserving the times and modes of the file.
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]191.It Fl p
192Preserves modification times, access times, and modes from the
193original file.
194.It Fl q
Damien Miller4cd24c72008-02-10 22:22:29 +1100[diff] [blame]195Quiet mode: disables the progress meter as well as warning and diagnostic
196messages from
197.Xr ssh 1 .
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]198.It Fl r
199Recursively copy entire directories.
Damien Millerc7ce0da2008-06-16 07:55:06 +1000[diff] [blame]200Note that
201.Nm
202follows symbolic links encountered in the tree traversal.
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame]203.It Fl S Ar program
204Name of
205.Ar program
206to use for the encrypted connection.
207The program must understand
208.Xr ssh 1
209options.
210.It Fl v
211Verbose mode.
212Causes
213.Nm
214and
215.Xr ssh 1
216to print debugging messages about their progress.
217This is helpful in
218debugging connection, authentication, and configuration problems.
Damien Miller37023962000-07-11 17:31:38 +1000[diff] [blame]219.El
Damien Miller390f1532010-09-10 11:17:54 +1000[diff] [blame]220.Sh EXIT STATUS
Damien Miller22d47ab2006-07-24 14:04:36 +1000[diff] [blame]221.Ex -std scp
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]222.Sh SEE ALSO
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]223.Xr sftp 1 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]224.Xr ssh 1 ,
225.Xr ssh-add 1 ,
226.Xr ssh-agent 1 ,
227.Xr ssh-keygen 1 ,
Ben Lindstromc06bf702002-06-23 00:34:37 +0000[diff] [blame]228.Xr ssh_config 5 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]229.Xr sshd 8
Damien Millerf1ce5052003-06-11 22:04:39 +1000[diff] [blame]230.Sh HISTORY
231.Nm
Damien Miller6e1777f2014-04-20 13:02:58 +1000[diff] [blame]232is based on the rcp program in
Damien Millerb7727df2013-08-21 02:43:49 +1000[diff] [blame]233.Bx
234source code from the Regents of the University of California.
Damien Millerf1ce5052003-06-11 22:04:39 +1000[diff] [blame]235.Sh AUTHORS
Damien Millerbf836e52013-07-18 16:14:13 +1000[diff] [blame]236.An Timo Rinne Aq Mt tri@iki.fi
237.An Tatu Ylonen Aq Mt ylo@cs.hut.fi