crypto/openssh/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.71 2016/07/16 06:57:55 jmc Exp $
  12 .\"
  13 .Dd $Mdocdate: July 16 2016 $
  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 12346BCpqrv
  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 :
  34 .Oc Ar file1
  35 .Sm on
  36 .Ar ...
  37 .Sm off
  38 .Oo
  39 .Op Ar user No @
  40 .Ar host2 :
  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 .Nm
  53 will ask for passwords or passphrases if they are needed for
  54 authentication.
  55 .Pp
  56 File names may contain a user and host specification to indicate
  57 that the file is to be copied to/from that host.
  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.
  65 .Pp
  66 The options are as follows:
  67 .Bl -tag -width Ds
  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.
  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.
  80 Note that this option disables the progress meter.
  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.
  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
 109 Selects the file from which the identity (private key) for public key
 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
 131 .It CanonicalDomains
 132 .It CanonicalizeFallbackLocal
 133 .It CanonicalizeHostname
 134 .It CanonicalizeMaxDots
 135 .It CanonicalizePermittedCNAMEs
 136 .It CertificateFile
 137 .It ChallengeResponseAuthentication
 138 .It CheckHostIP
 139 .It Cipher
 140 .It Ciphers
 141 .It Compression
 142 .It CompressionLevel
 143 .It ConnectionAttempts
 144 .It ConnectTimeout
 145 .It ControlMaster
 146 .It ControlPath
 147 .It ControlPersist
 148 .It GlobalKnownHostsFile
 149 .It GSSAPIAuthentication
 150 .It GSSAPIDelegateCredentials
 151 .It HashKnownHosts
 152 .It Host
 153 .It HostbasedAuthentication
 154 .It HostbasedKeyTypes
 155 .It HostKeyAlgorithms
 156 .It HostKeyAlias
 157 .It HostName
 158 .It IdentitiesOnly
 159 .It IdentityAgent
 160 .It IdentityFile
 161 .It IPQoS
 162 .It KbdInteractiveAuthentication
 163 .It KbdInteractiveDevices
 164 .It KexAlgorithms
 165 .It LogLevel
 166 .It MACs
 167 .It NoHostAuthenticationForLocalhost
 168 .It NumberOfPasswordPrompts
 169 .It PasswordAuthentication
 170 .It PKCS11Provider
 171 .It Port
 172 .It PreferredAuthentications
 173 .It Protocol
 174 .It ProxyCommand
 175 .It ProxyJump
 176 .It PubkeyAcceptedKeyTypes
 177 .It PubkeyAuthentication
 178 .It RekeyLimit
 179 .It RhostsRSAAuthentication
 180 .It RSAAuthentication
 181 .It SendEnv
 182 .It ServerAliveInterval
 183 .It ServerAliveCountMax
 184 .It StrictHostKeyChecking
 185 .It TCPKeepAlive
 186 .It UpdateHostKeys
 187 .It UsePrivilegedPort
 188 .It User
 189 .It UserKnownHostsFile
 190 .It VerifyHostKeyDNS
 191 .El
 192 .It Fl P Ar port
 193 Specifies the port to connect to on the remote host.
 194 Note that this option is written with a capital
 195 .Sq P ,
 196 because
 197 .Fl p
 198 is already reserved for preserving the times and modes of the file.
 199 .It Fl p
 200 Preserves modification times, access times, and modes from the
 201 original file.
 202 .It Fl q
 203 Quiet mode: disables the progress meter as well as warning and diagnostic
 204 messages from
 205 .Xr ssh 1 .
 206 .It Fl r
 207 Recursively copy entire directories.
 208 Note that
 209 .Nm
 210 follows symbolic links encountered in the tree traversal.
 211 .It Fl S Ar program
 212 Name of
 213 .Ar program
 214 to use for the encrypted connection.
 215 The program must understand
 216 .Xr ssh 1
 217 options.
 218 .It Fl v
 219 Verbose mode.
 220 Causes
 221 .Nm
 222 and
 223 .Xr ssh 1
 224 to print debugging messages about their progress.
 225 This is helpful in
 226 debugging connection, authentication, and configuration problems.
 227 .El
 228 .Sh EXIT STATUS
 229 .Ex -std scp
 230 .Sh SEE ALSO
 231 .Xr sftp 1 ,
 232 .Xr ssh 1 ,
 233 .Xr ssh-add 1 ,
 234 .Xr ssh-agent 1 ,
 235 .Xr ssh-keygen 1 ,
 236 .Xr ssh_config 5 ,
 237 .Xr sshd 8
 238 .Sh HISTORY
 239 .Nm
 240 is based on the rcp program in
 241 .Bx
 242 source code from the Regents of the University of California.
 243 .Sh AUTHORS
 244 .An Timo Rinne Aq Mt tri@iki.fi
 245 .An Tatu Ylonen Aq Mt ylo@cs.hut.fi