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