scp.1

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