]>
Commit | Line | Data |
---|---|---|
bf740959 | 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 | .\" | |
16d64584 | 12 | .\" $OpenBSD: scp.1,v 1.49 2010/01/09 23:04:13 dtucker Exp $ |
bf740959 | 13 | .\" |
e473dcd1 | 14 | .Dd $Mdocdate$ |
bf740959 | 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 | |
a4e5acef | 22 | .Bk -words |
433e60ac | 23 | .Op Fl 1246BCpqrv |
bf740959 | 24 | .Op Fl c Ar cipher |
433e60ac | 25 | .Op Fl F Ar ssh_config |
bf740959 | 26 | .Op Fl i Ar identity_file |
bd9f564f | 27 | .Op Fl l Ar limit |
38539909 | 28 | .Op Fl o Ar ssh_option |
433e60ac | 29 | .Op Fl P Ar port |
30 | .Op Fl S Ar program | |
bf740959 | 31 | .Sm off |
32 | .Oo | |
433e60ac | 33 | .Op Ar user No @ |
bf740959 | 34 | .Ar host1 No : |
35 | .Oc Ns Ar file1 | |
36 | .Sm on | |
d0ac0d65 | 37 | .Ar ... |
bf740959 | 38 | .Sm off |
39 | .Oo | |
433e60ac | 40 | .Op Ar user No @ |
bf740959 | 41 | .Ar host2 No : |
42 | .Oc Ar file2 | |
43 | .Sm on | |
a4e5acef | 44 | .Ek |
f54651ce | 45 | .Sh DESCRIPTION |
bf740959 | 46 | .Nm |
4fe2af09 | 47 | copies files between hosts on a network. |
48 | It uses | |
bf740959 | 49 | .Xr ssh 1 |
50 | for data transfer, and uses the same authentication and provides the | |
51 | same security as | |
52 | .Xr ssh 1 . | |
53 | Unlike | |
54 | .Xr rcp 1 , | |
55 | .Nm | |
56 | will ask for passwords or passphrases if they are needed for | |
57 | authentication. | |
58 | .Pp | |
51402e76 | 59 | File names may contain a user and host specification to indicate |
4fe2af09 | 60 | that the file is to be copied to/from that host. |
51402e76 | 61 | Local file names can be made explicit using absolute or relative pathnames |
62 | to avoid | |
63 | .Nm | |
64 | treating file names containing | |
65 | .Sq :\& | |
66 | as host specifiers. | |
67 | Copies between two remote hosts are also permitted. | |
bf740959 | 68 | .Pp |
69 | The options are as follows: | |
70 | .Bl -tag -width Ds | |
433e60ac | 71 | .It Fl 1 |
72 | Forces | |
bf740959 | 73 | .Nm |
433e60ac | 74 | to use protocol 1. |
75 | .It Fl 2 | |
76 | Forces | |
77 | .Nm | |
78 | to use protocol 2. | |
79 | .It Fl 4 | |
80 | Forces | |
81 | .Nm | |
82 | to use IPv4 addresses only. | |
83 | .It Fl 6 | |
84 | Forces | |
85 | .Nm | |
86 | to use IPv6 addresses only. | |
bf740959 | 87 | .It Fl B |
88 | Selects batch mode (prevents asking for passwords or passphrases). | |
bf740959 | 89 | .It Fl C |
4fe2af09 | 90 | Compression enable. |
91 | Passes the | |
bf740959 | 92 | .Fl C |
93 | flag to | |
94 | .Xr ssh 1 | |
95 | to enable compression. | |
433e60ac | 96 | .It Fl c Ar cipher |
97 | Selects the cipher to use for encrypting the data transfer. | |
98 | This option is directly passed to | |
99 | .Xr ssh 1 . | |
f1278af7 | 100 | .It Fl F Ar ssh_config |
101 | Specifies an alternative | |
102 | per-user configuration file for | |
103 | .Nm ssh . | |
104 | This option is directly passed to | |
105 | .Xr ssh 1 . | |
433e60ac | 106 | .It Fl i Ar identity_file |
da9a823d | 107 | Selects the file from which the identity (private key) for public key |
433e60ac | 108 | authentication is read. |
109 | This option is directly passed to | |
110 | .Xr ssh 1 . | |
111 | .It Fl l Ar limit | |
112 | Limits the used bandwidth, specified in Kbit/s. | |
113 | .It Fl o Ar ssh_option | |
114 | Can be used to pass options to | |
115 | .Nm ssh | |
116 | in the format used in | |
117 | .Xr ssh_config 5 . | |
118 | This is useful for specifying options | |
119 | for which there is no separate | |
120 | .Nm scp | |
121 | command-line flag. | |
122 | For full details of the options listed below, and their possible values, see | |
123 | .Xr ssh_config 5 . | |
124 | .Pp | |
125 | .Bl -tag -width Ds -offset indent -compact | |
126 | .It AddressFamily | |
127 | .It BatchMode | |
128 | .It BindAddress | |
129 | .It ChallengeResponseAuthentication | |
130 | .It CheckHostIP | |
131 | .It Cipher | |
132 | .It Ciphers | |
433e60ac | 133 | .It Compression |
134 | .It CompressionLevel | |
135 | .It ConnectionAttempts | |
78f8c073 | 136 | .It ConnectTimeout |
5e96b616 | 137 | .It ControlMaster |
138 | .It ControlPath | |
433e60ac | 139 | .It GlobalKnownHostsFile |
140 | .It GSSAPIAuthentication | |
141 | .It GSSAPIDelegateCredentials | |
ba9d1100 | 142 | .It HashKnownHosts |
433e60ac | 143 | .It Host |
144 | .It HostbasedAuthentication | |
145 | .It HostKeyAlgorithms | |
146 | .It HostKeyAlias | |
147 | .It HostName | |
148 | .It IdentityFile | |
3a065ed0 | 149 | .It IdentitiesOnly |
396070f8 | 150 | .It KbdInteractiveDevices |
433e60ac | 151 | .It LogLevel |
152 | .It MACs | |
153 | .It NoHostAuthenticationForLocalhost | |
154 | .It NumberOfPasswordPrompts | |
155 | .It PasswordAuthentication | |
156 | .It Port | |
157 | .It PreferredAuthentications | |
158 | .It Protocol | |
159 | .It ProxyCommand | |
160 | .It PubkeyAuthentication | |
db175906 | 161 | .It RekeyLimit |
433e60ac | 162 | .It RhostsRSAAuthentication |
163 | .It RSAAuthentication | |
16cc4c93 | 164 | .It SendEnv |
5d8d32a3 | 165 | .It ServerAliveInterval |
166 | .It ServerAliveCountMax | |
433e60ac | 167 | .It SmartcardDevice |
168 | .It StrictHostKeyChecking | |
fd573618 | 169 | .It TCPKeepAlive |
433e60ac | 170 | .It UsePrivilegedPort |
171 | .It User | |
172 | .It UserKnownHostsFile | |
173 | .It VerifyHostKeyDNS | |
433e60ac | 174 | .El |
bf740959 | 175 | .It Fl P Ar port |
4fe2af09 | 176 | Specifies the port to connect to on the remote host. |
177 | Note that this option is written with a capital | |
bf740959 | 178 | .Sq P , |
179 | because | |
180 | .Fl p | |
181 | is already reserved for preserving the times and modes of the file in | |
182 | .Xr rcp 1 . | |
433e60ac | 183 | .It Fl p |
184 | Preserves modification times, access times, and modes from the | |
185 | original file. | |
186 | .It Fl q | |
127b07bd | 187 | Quiet mode: disables the progress meter as well as warning and diagnostic |
188 | messages from | |
189 | .Xr ssh 1 . | |
433e60ac | 190 | .It Fl r |
191 | Recursively copy entire directories. | |
49c5f262 | 192 | Note that |
193 | .Nm | |
194 | follows symbolic links encountered in the tree traversal. | |
b5e300c2 | 195 | .It Fl S Ar program |
196 | Name of | |
197 | .Ar program | |
94ec8c6b | 198 | to use for the encrypted connection. |
199 | The program must understand | |
2e73a022 | 200 | .Xr ssh 1 |
201 | options. | |
433e60ac | 202 | .It Fl v |
203 | Verbose mode. | |
204 | Causes | |
48e671d5 | 205 | .Nm |
433e60ac | 206 | and |
207 | .Xr ssh 1 | |
208 | to print debugging messages about their progress. | |
209 | This is helpful in | |
210 | debugging connection, authentication, and configuration problems. | |
089fbbd2 | 211 | .El |
578d2b99 | 212 | .Pp |
213 | .Ex -std scp | |
bf740959 | 214 | .Sh SEE ALSO |
215 | .Xr rcp 1 , | |
61e96248 | 216 | .Xr sftp 1 , |
bf740959 | 217 | .Xr ssh 1 , |
218 | .Xr ssh-add 1 , | |
219 | .Xr ssh-agent 1 , | |
220 | .Xr ssh-keygen 1 , | |
e4e83d70 | 221 | .Xr ssh_config 5 , |
bf740959 | 222 | .Xr sshd 8 |
be193d89 | 223 | .Sh HISTORY |
224 | .Nm | |
225 | is based on the | |
226 | .Xr rcp 1 | |
227 | program in BSD source code from the Regents of the University of | |
228 | California. | |
229 | .Sh AUTHORS | |
230 | .An Timo Rinne Aq tri@iki.fi | |
be193d89 | 231 | .An Tatu Ylonen Aq ylo@cs.hut.fi |