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.62 2014/03/19 14:42:44 tedu Exp $
  12 .\"
  13 .Dd $Mdocdate: March 19 2014 $
  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 No :
  34 .Oc 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 .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 ChallengeResponseAuthentication
 137 .It CheckHostIP
 138 .It Cipher
 139 .It Ciphers
 140 .It Compression
 141 .It CompressionLevel
 142 .It ConnectionAttempts
 143 .It ConnectTimeout
 144 .It ControlMaster
 145 .It ControlPath
 146 .It ControlPersist
 147 .It GlobalKnownHostsFile
 148 .It GSSAPIAuthentication
 149 .It GSSAPIDelegateCredentials
 150 .It HashKnownHosts
 151 .It Host
 152 .It HostbasedAuthentication
 153 .It HostKeyAlgorithms
 154 .It HostKeyAlias
 155 .It HostName
 156 .It IdentityFile
 157 .It IdentitiesOnly
 158 .It IPQoS
 159 .It KbdInteractiveAuthentication
 160 .It KbdInteractiveDevices
 161 .It KexAlgorithms
 162 .It LogLevel
 163 .It MACs
 164 .It NoHostAuthenticationForLocalhost
 165 .It NumberOfPasswordPrompts
 166 .It PasswordAuthentication
 167 .It PKCS11Provider
 168 .It Port
 169 .It PreferredAuthentications
 170 .It Protocol
 171 .It ProxyCommand
 172 .It PubkeyAuthentication
 173 .It RekeyLimit
 174 .It RhostsRSAAuthentication
 175 .It RSAAuthentication
 176 .It SendEnv
 177 .It ServerAliveInterval
 178 .It ServerAliveCountMax
 179 .It StrictHostKeyChecking
 180 .It TCPKeepAlive
 181 .It UsePrivilegedPort
 182 .It User
 183 .It UserKnownHostsFile
 184 .It VerifyHostKeyDNS
 185 .El
 186 .It Fl P Ar port
 187 Specifies the port to connect to on the remote host.
 188 Note that this option is written with a capital
 189 .Sq P ,
 190 because
 191 .Fl p
 192 is already reserved for preserving the times and modes of the file.
 193 .It Fl p
 194 Preserves modification times, access times, and modes from the
 195 original file.
 196 .It Fl q
 197 Quiet mode: disables the progress meter as well as warning and diagnostic
 198 messages from
 199 .Xr ssh 1 .
 200 .It Fl r
 201 Recursively copy entire directories.
 202 Note that
 203 .Nm
 204 follows symbolic links encountered in the tree traversal.
 205 .It Fl S Ar program
 206 Name of
 207 .Ar program
 208 to use for the encrypted connection.
 209 The program must understand
 210 .Xr ssh 1
 211 options.
 212 .It Fl v
 213 Verbose mode.
 214 Causes
 215 .Nm
 216 and
 217 .Xr ssh 1
 218 to print debugging messages about their progress.
 219 This is helpful in
 220 debugging connection, authentication, and configuration problems.
 221 .El
 222 .Sh EXIT STATUS
 223 .Ex -std scp
 224 .Sh SEE ALSO
 225 .Xr sftp 1 ,
 226 .Xr ssh 1 ,
 227 .Xr ssh-add 1 ,
 228 .Xr ssh-agent 1 ,
 229 .Xr ssh-keygen 1 ,
 230 .Xr ssh_config 5 ,
 231 .Xr sshd 8
 232 .Sh HISTORY
 233 .Nm
 234 is based on the rcp program in
 235 .Bx
 236 source code from the Regents of the University of California.
 237 .Sh AUTHORS
 238 .An Timo Rinne Aq Mt tri@iki.fi
 239 .An Tatu Ylonen Aq Mt ylo@cs.hut.fi