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.85 2019/01/26 22:41:28 djm Exp $
  12 .\"
  13 .Dd $Mdocdate: January 26 2019 $
  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 .Op Fl 346BCpqrTv
  22 .Op Fl c Ar cipher
  23 .Op Fl F Ar ssh_config
  24 .Op Fl i Ar identity_file
  25 .Op Fl J Ar destination
  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 .Ar source ... target
  31 .Sh DESCRIPTION
  32 .Nm
  33 copies files between hosts on a network.
  34 It uses
  35 .Xr ssh 1
  36 for data transfer, and uses the same authentication and provides the
  37 same security as
  38 .Xr ssh 1 .
  39 .Nm
  40 will ask for passwords or passphrases if they are needed for
  41 authentication.
  42 .Pp
  43 The
  44 .Ar source
  45 and
  46 .Ar target
  47 may be specified as a local pathname, a remote host with optional path
  48 in the form
  49 .Sm off
  50 .Oo user @ Oc host : Op path ,
  51 .Sm on
  52 or a URI in the form
  53 .Sm off
  54 .No scp:// Oo user @ Oc host Oo : port Oc Op / path .
  55 .Sm on
  56 Local file names can be made explicit using absolute or relative pathnames
  57 to avoid
  58 .Nm
  59 treating file names containing
  60 .Sq :\&
  61 as host specifiers.
  62 .Pp
  63 When copying between two remote hosts, if the URI format is used, a
  64 .Ar port
  65 may only be specified on the
  66 .Ar target
  67 if the
  68 .Fl 3
  69 option is used.
  70 .Pp
  71 The options are as follows:
  72 .Bl -tag -width Ds
  73 .It Fl 3
  74 Copies between two remote hosts are transferred through the local host.
  75 Without this option the data is copied directly between the two remote
  76 hosts.
  77 Note that this option disables the progress meter.
  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 J Ar destination
 111 Connect to the target host by first making an
 112 .Nm
 113 connection to the jump host described by
 114 .Ar destination
 115 and then establishing a TCP forwarding to the ultimate destination from
 116 there.
 117 Multiple jump hops may be specified separated by comma characters.
 118 This is a shortcut to specify a
 119 .Cm ProxyJump
 120 configuration directive.
 121 This option is directly passed to
 122 .Xr ssh 1 .
 123 .It Fl l Ar limit
 124 Limits the used bandwidth, specified in Kbit/s.
 125 .It Fl o Ar ssh_option
 126 Can be used to pass options to
 127 .Nm ssh
 128 in the format used in
 129 .Xr ssh_config 5 .
 130 This is useful for specifying options
 131 for which there is no separate
 132 .Nm scp
 133 command-line flag.
 134 For full details of the options listed below, and their possible values, see
 135 .Xr ssh_config 5 .
 136 .Pp
 137 .Bl -tag -width Ds -offset indent -compact
 138 .It AddressFamily
 139 .It BatchMode
 140 .It BindAddress
 141 .It BindInterface
 142 .It CanonicalDomains
 143 .It CanonicalizeFallbackLocal
 144 .It CanonicalizeHostname
 145 .It CanonicalizeMaxDots
 146 .It CanonicalizePermittedCNAMEs
 147 .It CASignatureAlgorithms
 148 .It CertificateFile
 149 .It ChallengeResponseAuthentication
 150 .It CheckHostIP
 151 .It Ciphers
 152 .It Compression
 153 .It ConnectionAttempts
 154 .It ConnectTimeout
 155 .It ControlMaster
 156 .It ControlPath
 157 .It ControlPersist
 158 .It GlobalKnownHostsFile
 159 .It GSSAPIAuthentication
 160 .It GSSAPIDelegateCredentials
 161 .It HashKnownHosts
 162 .It Host
 163 .It HostbasedAuthentication
 164 .It HostbasedKeyTypes
 165 .It HostKeyAlgorithms
 166 .It HostKeyAlias
 167 .It HostName
 168 .It IdentitiesOnly
 169 .It IdentityAgent
 170 .It IdentityFile
 171 .It IPQoS
 172 .It KbdInteractiveAuthentication
 173 .It KbdInteractiveDevices
 174 .It KexAlgorithms
 175 .It LogLevel
 176 .It MACs
 177 .It NoHostAuthenticationForLocalhost
 178 .It NumberOfPasswordPrompts
 179 .It PasswordAuthentication
 180 .It PKCS11Provider
 181 .It Port
 182 .It PreferredAuthentications
 183 .It ProxyCommand
 184 .It ProxyJump
 185 .It PubkeyAcceptedKeyTypes
 186 .It PubkeyAuthentication
 187 .It RekeyLimit
 188 .It SendEnv
 189 .It ServerAliveInterval
 190 .It ServerAliveCountMax
 191 .It SetEnv
 192 .It StrictHostKeyChecking
 193 .It TCPKeepAlive
 194 .It UpdateHostKeys
 195 .It User
 196 .It UserKnownHostsFile
 197 .It VerifyHostKeyDNS
 198 .El
 199 .It Fl P Ar port
 200 Specifies the port to connect to on the remote host.
 201 Note that this option is written with a capital
 202 .Sq P ,
 203 because
 204 .Fl p
 205 is already reserved for preserving the times and modes of the file.
 206 .It Fl p
 207 Preserves modification times, access times, and modes from the
 208 original file.
 209 .It Fl q
 210 Quiet mode: disables the progress meter as well as warning and diagnostic
 211 messages from
 212 .Xr ssh 1 .
 213 .It Fl r
 214 Recursively copy entire directories.
 215 Note that
 216 .Nm
 217 follows symbolic links encountered in the tree traversal.
 218 .It Fl S Ar program
 219 Name of
 220 .Ar program
 221 to use for the encrypted connection.
 222 The program must understand
 223 .Xr ssh 1
 224 options.
 225 .It Fl T
 226 Disable strict filename checking.
 227 By default when copying files from a remote host to a local directory
 228 .Nm
 229 checks that the received filenames match those requested on the command-line
 230 to prevent the remote end from sending unexpected or unwanted files.
 231 Because of differences in how various operating systems and shells interpret
 232 filename wildcards, these checks may cause wanted files to be rejected.
 233 This option disables these checks at the expense of fully trusting that
 234 the server will not send unexpected filenames.
 235 .It Fl v
 236 Verbose mode.
 237 Causes
 238 .Nm
 239 and
 240 .Xr ssh 1
 241 to print debugging messages about their progress.
 242 This is helpful in
 243 debugging connection, authentication, and configuration problems.
 244 .El
 245 .Sh EXIT STATUS
 246 .Ex -std scp
 247 .Sh SEE ALSO
 248 .Xr sftp 1 ,
 249 .Xr ssh 1 ,
 250 .Xr ssh-add 1 ,
 251 .Xr ssh-agent 1 ,
 252 .Xr ssh-keygen 1 ,
 253 .Xr ssh_config 5 ,
 254 .Xr sshd 8
 255 .Sh HISTORY
 256 .Nm
 257 is based on the rcp program in
 258 .Bx
 259 source code from the Regents of the University of California.
 260 .Sh AUTHORS
 261 .An Timo Rinne Aq Mt tri@iki.fi
 262 .An Tatu Ylonen Aq Mt ylo@cs.hut.fi