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