Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / 1f20394e92afa417c1201506f9ae8683170ac496 / . / scp.1
blob: bdc413337629c299a8f3a3b397e3bb99327b5f57 [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.\"
Darren Tucker1f203942003-10-15 15:50:42 +1000[diff] [blame^]12.\" $OpenBSD: scp.1,v 1.29 2003/10/08 08:27:36 jmc Exp $
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]13.\"
14.Dd September 25, 1999
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
37.Op Ar ...
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
59Any file name may contain a host and user specification to indicate
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]60that the file is to be copied to/from that host.
61Copies between two remote hosts are permitted.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]62.Pp
63The options are as follows:
64.Bl -tag -width Ds
Damien Miller8e121472003-01-24 11:37:38 +1100[diff] [blame]65.It Fl 1
66Forces
67.Nm
68to use protocol 1.
69.It Fl 2
70Forces
71.Nm
72to use protocol 2.
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
101Selects the file from which the identity (private key) for RSA
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
123.It ChallengeResponseAuthentication
124.It CheckHostIP
125.It Cipher
126.It Ciphers
127.It ClearAllForwardings
128.It Compression
129.It CompressionLevel
130.It ConnectionAttempts
131.It ConnectionTimeout
132.It DynamicForward
133.It EscapeChar
134.It ForwardAgent
135.It ForwardX11
136.It GatewayPorts
137.It GlobalKnownHostsFile
138.It GSSAPIAuthentication
139.It GSSAPIDelegateCredentials
140.It Host
141.It HostbasedAuthentication
142.It HostKeyAlgorithms
143.It HostKeyAlias
144.It HostName
145.It IdentityFile
146.It KeepAlive
147.It LocalForward
148.It LogLevel
149.It MACs
150.It NoHostAuthenticationForLocalhost
151.It NumberOfPasswordPrompts
152.It PasswordAuthentication
153.It Port
154.It PreferredAuthentications
155.It Protocol
156.It ProxyCommand
157.It PubkeyAuthentication
158.It RemoteForward
159.It RhostsRSAAuthentication
160.It RSAAuthentication
161.It SmartcardDevice
162.It StrictHostKeyChecking
163.It UsePrivilegedPort
164.It User
165.It UserKnownHostsFile
166.It VerifyHostKeyDNS
167.It XAuthLocation
168.El
169.It Fl P Ar port
170Specifies the port to connect to on the remote host.
171Note that this option is written with a capital
172.Sq P ,
173because
174.Fl p
175is already reserved for preserving the times and modes of the file in
176.Xr rcp 1 .
177.It Fl p
178Preserves modification times, access times, and modes from the
179original file.
180.It Fl q
181Disables the progress meter.
182.It Fl r
183Recursively copy entire directories.
184.It Fl S Ar program
185Name of
186.Ar program
187to use for the encrypted connection.
188The program must understand
189.Xr ssh 1
190options.
191.It Fl v
192Verbose mode.
193Causes
194.Nm
195and
196.Xr ssh 1
197to print debugging messages about their progress.
198This is helpful in
199debugging connection, authentication, and configuration problems.
Damien Miller37023962000-07-11 17:31:38 +1000[diff] [blame]200.El
Damien Miller07a2d422002-02-05 12:16:15 +1100[diff] [blame]201.Sh DIAGNOSTICS
202.Nm
203exits with 0 on success or >0 if an error occurred.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]204.Sh SEE ALSO
205.Xr rcp 1 ,
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]206.Xr sftp 1 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]207.Xr ssh 1 ,
208.Xr ssh-add 1 ,
209.Xr ssh-agent 1 ,
210.Xr ssh-keygen 1 ,
Ben Lindstromc06bf702002-06-23 00:34:37 +0000[diff] [blame]211.Xr ssh_config 5 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]212.Xr sshd 8
Damien Millerf1ce5052003-06-11 22:04:39 +1000[diff] [blame]213.Sh HISTORY
214.Nm
215is based on the
216.Xr rcp 1
217program in BSD source code from the Regents of the University of
218California.
219.Sh AUTHORS
220.An Timo Rinne Aq tri@iki.fi
Damien Millerf1ce5052003-06-11 22:04:39 +1000[diff] [blame]221.An Tatu Ylonen Aq ylo@cs.hut.fi