Damien Miller | 32aa144 | 1999-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 | .\" |
jmc@openbsd.org@openbsd.org | 0b2e289 | 2017-10-25 06:19:46 +0000 | [diff] [blame] | 11 | .\" $OpenBSD: scp.1,v 1.76 2017/10/25 06:19:46 jmc Exp $ |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 12 | .\" |
jmc@openbsd.org@openbsd.org | 0b2e289 | 2017-10-25 06:19:46 +0000 | [diff] [blame] | 13 | .Dd $Mdocdate: October 25 2017 $ |
Damien Miller | 32aa144 | 1999-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 |
djm@openbsd.org | a3710d5 | 2017-04-30 23:28:12 +0000 | [diff] [blame] | 21 | .Op Fl 346BCpqrv |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 22 | .Op Fl c Ar cipher |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 23 | .Op Fl F Ar ssh_config |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 24 | .Op Fl i Ar identity_file |
Damien Miller | 8ee66a2 | 2003-02-24 11:50:50 +1100 | [diff] [blame] | 25 | .Op Fl l Ar limit |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 26 | .Op Fl o Ar ssh_option |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 27 | .Op Fl P Ar port |
| 28 | .Op Fl S Ar program |
jmc@openbsd.org@openbsd.org | 0b2e289 | 2017-10-25 06:19:46 +0000 | [diff] [blame] | 29 | .Ar source ... target |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 30 | .Sh DESCRIPTION |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 31 | .Nm |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 32 | copies files between hosts on a network. |
| 33 | It uses |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 34 | .Xr ssh 1 |
| 35 | for data transfer, and uses the same authentication and provides the |
| 36 | same security as |
| 37 | .Xr ssh 1 . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 38 | .Nm |
| 39 | will ask for passwords or passphrases if they are needed for |
| 40 | authentication. |
| 41 | .Pp |
millert@openbsd.org | 887669e | 2017-10-21 23:06:24 +0000 | [diff] [blame] | 42 | The |
jmc@openbsd.org@openbsd.org | 0b2e289 | 2017-10-25 06:19:46 +0000 | [diff] [blame] | 43 | .Ar source |
millert@openbsd.org | 887669e | 2017-10-21 23:06:24 +0000 | [diff] [blame] | 44 | and |
jmc@openbsd.org@openbsd.org | 0b2e289 | 2017-10-25 06:19:46 +0000 | [diff] [blame] | 45 | .Ar target |
millert@openbsd.org | 887669e | 2017-10-21 23:06:24 +0000 | [diff] [blame] | 46 | may be specified as a local pathname, a remote host with optional path |
| 47 | in the form |
jmc@openbsd.org@openbsd.org | 0b2e289 | 2017-10-25 06:19:46 +0000 | [diff] [blame] | 48 | .Sm off |
| 49 | .Oo user @ Oc host : Op path , |
| 50 | .Sm on |
| 51 | or a URI in the form |
| 52 | .Sm off |
| 53 | .No scp:// Oo user @ Oc host Oo : port Oc Op / path . |
| 54 | .Sm on |
Damien Miller | b508faa | 2008-02-10 22:28:45 +1100 | [diff] [blame] | 55 | Local file names can be made explicit using absolute or relative pathnames |
| 56 | to avoid |
| 57 | .Nm |
| 58 | treating file names containing |
| 59 | .Sq :\& |
| 60 | as host specifiers. |
millert@openbsd.org | 887669e | 2017-10-21 23:06:24 +0000 | [diff] [blame] | 61 | .Pp |
| 62 | When copying between two remote hosts, if the URI format is used, a |
| 63 | .Ar port |
| 64 | may only be specified on the |
| 65 | .Ar target |
| 66 | if the |
| 67 | .Fl 3 |
| 68 | option is used. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 69 | .Pp |
| 70 | The options are as follows: |
| 71 | .Bl -tag -width Ds |
Damien Miller | f121143 | 2011-01-06 22:40:30 +1100 | [diff] [blame] | 72 | .It Fl 3 |
| 73 | Copies between two remote hosts are transferred through the local host. |
| 74 | Without this option the data is copied directly between the two remote |
| 75 | hosts. |
Damien Miller | 907998d | 2011-01-06 22:41:21 +1100 | [diff] [blame] | 76 | Note that this option disables the progress meter. |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 77 | .It Fl 4 |
| 78 | Forces |
| 79 | .Nm |
| 80 | to use IPv4 addresses only. |
| 81 | .It Fl 6 |
| 82 | Forces |
| 83 | .Nm |
| 84 | to use IPv6 addresses only. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 85 | .It Fl B |
| 86 | Selects batch mode (prevents asking for passwords or passphrases). |
| 87 | .It Fl C |
| 88 | Compression enable. |
| 89 | Passes the |
| 90 | .Fl C |
| 91 | flag to |
| 92 | .Xr ssh 1 |
| 93 | to enable compression. |
| 94 | .It Fl c Ar cipher |
| 95 | Selects the cipher to use for encrypting the data transfer. |
| 96 | This option is directly passed to |
| 97 | .Xr ssh 1 . |
| 98 | .It Fl F Ar ssh_config |
| 99 | Specifies an alternative |
| 100 | per-user configuration file for |
| 101 | .Nm ssh . |
| 102 | This option is directly passed to |
| 103 | .Xr ssh 1 . |
| 104 | .It Fl i Ar identity_file |
Damien Miller | a034baf | 2008-07-12 17:12:49 +1000 | [diff] [blame] | 105 | Selects the file from which the identity (private key) for public key |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 106 | authentication is read. |
| 107 | This option is directly passed to |
| 108 | .Xr ssh 1 . |
| 109 | .It Fl l Ar limit |
| 110 | Limits the used bandwidth, specified in Kbit/s. |
| 111 | .It Fl o Ar ssh_option |
| 112 | Can be used to pass options to |
| 113 | .Nm ssh |
| 114 | in the format used in |
| 115 | .Xr ssh_config 5 . |
| 116 | This is useful for specifying options |
| 117 | for which there is no separate |
| 118 | .Nm scp |
| 119 | command-line flag. |
| 120 | For full details of the options listed below, and their possible values, see |
| 121 | .Xr ssh_config 5 . |
| 122 | .Pp |
| 123 | .Bl -tag -width Ds -offset indent -compact |
| 124 | .It AddressFamily |
| 125 | .It BatchMode |
| 126 | .It BindAddress |
Damien Miller | c0049bd | 2013-10-23 16:29:59 +1100 | [diff] [blame] | 127 | .It CanonicalDomains |
| 128 | .It CanonicalizeFallbackLocal |
| 129 | .It CanonicalizeHostname |
| 130 | .It CanonicalizeMaxDots |
| 131 | .It CanonicalizePermittedCNAMEs |
jmc@openbsd.org | c5f7c08 | 2015-09-25 18:19:54 +0000 | [diff] [blame] | 132 | .It CertificateFile |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 133 | .It ChallengeResponseAuthentication |
| 134 | .It CheckHostIP |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 135 | .It Ciphers |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 136 | .It Compression |
naddy@openbsd.org | 9a82e24 | 2017-05-03 21:49:18 +0000 | [diff] [blame] | 137 | .It ConnectionAttempts |
Darren Tucker | c0796d7 | 2004-05-03 09:19:03 +1000 | [diff] [blame] | 138 | .It ConnectTimeout |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 139 | .It ControlMaster |
| 140 | .It ControlPath |
Damien Miller | e577772 | 2011-09-22 21:34:15 +1000 | [diff] [blame] | 141 | .It ControlPersist |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 142 | .It GlobalKnownHostsFile |
| 143 | .It GSSAPIAuthentication |
| 144 | .It GSSAPIDelegateCredentials |
Damien Miller | 27e9c51 | 2005-03-02 12:04:16 +1100 | [diff] [blame] | 145 | .It HashKnownHosts |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 146 | .It Host |
| 147 | .It HostbasedAuthentication |
djm@openbsd.org | 46347ed | 2015-01-30 11:43:14 +0000 | [diff] [blame] | 148 | .It HostbasedKeyTypes |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 149 | .It HostKeyAlgorithms |
| 150 | .It HostKeyAlias |
| 151 | .It HostName |
jmc@openbsd.org | 772e6ce | 2016-06-29 17:14:28 +0000 | [diff] [blame] | 152 | .It IdentitiesOnly |
markus@openbsd.org | 75e2168 | 2016-05-04 14:32:26 +0000 | [diff] [blame] | 153 | .It IdentityAgent |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 154 | .It IdentityFile |
Damien Miller | 0a18473 | 2010-11-20 15:21:03 +1100 | [diff] [blame] | 155 | .It IPQoS |
Damien Miller | e577772 | 2011-09-22 21:34:15 +1000 | [diff] [blame] | 156 | .It KbdInteractiveAuthentication |
Darren Tucker | 636ca90 | 2004-11-05 20:22:00 +1100 | [diff] [blame] | 157 | .It KbdInteractiveDevices |
Damien Miller | 2beb32f | 2010-09-24 22:16:03 +1000 | [diff] [blame] | 158 | .It KexAlgorithms |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 159 | .It LogLevel |
| 160 | .It MACs |
| 161 | .It NoHostAuthenticationForLocalhost |
| 162 | .It NumberOfPasswordPrompts |
| 163 | .It PasswordAuthentication |
Damien Miller | 7ea845e | 2010-02-12 09:21:02 +1100 | [diff] [blame] | 164 | .It PKCS11Provider |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 165 | .It Port |
| 166 | .It PreferredAuthentications |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 167 | .It ProxyCommand |
jmc@openbsd.org | e4eb7d9 | 2016-07-16 06:57:55 +0000 | [diff] [blame] | 168 | .It ProxyJump |
markus@openbsd.org | 3a1638d | 2015-07-10 06:21:53 +0000 | [diff] [blame] | 169 | .It PubkeyAcceptedKeyTypes |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 170 | .It PubkeyAuthentication |
Darren Tucker | 62388b2 | 2006-01-20 11:31:47 +1100 | [diff] [blame] | 171 | .It RekeyLimit |
Darren Tucker | 2e578f6 | 2004-05-13 13:03:04 +1000 | [diff] [blame] | 172 | .It SendEnv |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 173 | .It ServerAliveInterval |
| 174 | .It ServerAliveCountMax |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 175 | .It StrictHostKeyChecking |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 176 | .It TCPKeepAlive |
djm@openbsd.org | 1d1092b | 2015-01-26 12:16:36 +0000 | [diff] [blame] | 177 | .It UpdateHostKeys |
jmc@openbsd.org | 9f7637f | 2015-01-26 13:55:29 +0000 | [diff] [blame] | 178 | .It UsePrivilegedPort |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 179 | .It User |
| 180 | .It UserKnownHostsFile |
| 181 | .It VerifyHostKeyDNS |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 182 | .El |
| 183 | .It Fl P Ar port |
| 184 | Specifies the port to connect to on the remote host. |
| 185 | Note that this option is written with a capital |
| 186 | .Sq P , |
| 187 | because |
| 188 | .Fl p |
Damien Miller | 6e1777f | 2014-04-20 13:02:58 +1000 | [diff] [blame] | 189 | is already reserved for preserving the times and modes of the file. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 190 | .It Fl p |
| 191 | Preserves modification times, access times, and modes from the |
| 192 | original file. |
| 193 | .It Fl q |
Damien Miller | 4cd24c7 | 2008-02-10 22:22:29 +1100 | [diff] [blame] | 194 | Quiet mode: disables the progress meter as well as warning and diagnostic |
| 195 | messages from |
| 196 | .Xr ssh 1 . |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 197 | .It Fl r |
| 198 | Recursively copy entire directories. |
Damien Miller | c7ce0da | 2008-06-16 07:55:06 +1000 | [diff] [blame] | 199 | Note that |
| 200 | .Nm |
| 201 | follows symbolic links encountered in the tree traversal. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 202 | .It Fl S Ar program |
| 203 | Name of |
| 204 | .Ar program |
| 205 | to use for the encrypted connection. |
| 206 | The program must understand |
| 207 | .Xr ssh 1 |
| 208 | options. |
| 209 | .It Fl v |
| 210 | Verbose mode. |
| 211 | Causes |
| 212 | .Nm |
| 213 | and |
| 214 | .Xr ssh 1 |
| 215 | to print debugging messages about their progress. |
| 216 | This is helpful in |
| 217 | debugging connection, authentication, and configuration problems. |
Damien Miller | 3702396 | 2000-07-11 17:31:38 +1000 | [diff] [blame] | 218 | .El |
Damien Miller | 390f153 | 2010-09-10 11:17:54 +1000 | [diff] [blame] | 219 | .Sh EXIT STATUS |
Damien Miller | 22d47ab | 2006-07-24 14:04:36 +1000 | [diff] [blame] | 220 | .Ex -std scp |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 221 | .Sh SEE ALSO |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 222 | .Xr sftp 1 , |
Damien Miller | 32aa144 | 1999-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 Lindstrom | c06bf70 | 2002-06-23 00:34:37 +0000 | [diff] [blame] | 227 | .Xr ssh_config 5 , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 228 | .Xr sshd 8 |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 229 | .Sh HISTORY |
| 230 | .Nm |
Damien Miller | 6e1777f | 2014-04-20 13:02:58 +1000 | [diff] [blame] | 231 | is based on the rcp program in |
Damien Miller | b7727df | 2013-08-21 02:43:49 +1000 | [diff] [blame] | 232 | .Bx |
| 233 | source code from the Regents of the University of California. |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 234 | .Sh AUTHORS |
Damien Miller | bf836e5 | 2013-07-18 16:14:13 +1000 | [diff] [blame] | 235 | .An Timo Rinne Aq Mt tri@iki.fi |
| 236 | .An Tatu Ylonen Aq Mt ylo@cs.hut.fi |