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