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.61 2013/10/20 09:51:26 djm Exp $
  12 .\"
  13 .Dd October 20, 2013
  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 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 3
  79 Copies between two remote hosts are transferred through the local host.
  80 Without this option the data is copied directly between the two remote
  81 hosts.
  82 Note that this option disables the progress meter.
  83 .It Fl 4
  84 Forces
  85 .Nm
  86 to use IPv4 addresses only.
  87 .It Fl 6
  88 Forces
  89 .Nm
  90 to use IPv6 addresses only.
  91 .It Fl B
  92 Selects batch mode (prevents asking for passwords or passphrases).
  93 .It Fl C
  94 Compression enable.
  95 Passes the
  96 .Fl C
  97 flag to
  98 .Xr ssh 1
  99 to enable compression.
 100 .It Fl c Ar cipher
 101 Selects the cipher to use for encrypting the data transfer.
 102 This option is directly passed to
 103 .Xr ssh 1 .
 104 .It Fl F Ar ssh_config
 105 Specifies an alternative
 106 per-user configuration file for
 107 .Nm ssh .
 108 This option is directly passed to
 109 .Xr ssh 1 .
 110 .It Fl i Ar identity_file
 111 Selects the file from which the identity (private key) for public key
 112 authentication is read.
 113 This option is directly passed to
 114 .Xr ssh 1 .
 115 .It Fl l Ar limit
 116 Limits the used bandwidth, specified in Kbit/s.
 117 .It Fl o Ar ssh_option
 118 Can be used to pass options to
 119 .Nm ssh
 120 in the format used in
 121 .Xr ssh_config 5 .
 122 This is useful for specifying options
 123 for which there is no separate
 124 .Nm scp
 125 command-line flag.
 126 For full details of the options listed below, and their possible values, see
 127 .Xr ssh_config 5 .
 128 .Pp
 129 .Bl -tag -width Ds -offset indent -compact
 130 .It AddressFamily
 131 .It BatchMode
 132 .It BindAddress
 133 .It CanonicalDomains
 134 .It CanonicalizeFallbackLocal
 135 .It CanonicalizeHostname
 136 .It CanonicalizeMaxDots
 137 .It CanonicalizePermittedCNAMEs
 138 .It ChallengeResponseAuthentication
 139 .It CheckHostIP
 140 .It Cipher
 141 .It Ciphers
 142 .It Compression
 143 .It CompressionLevel
 144 .It ConnectionAttempts
 145 .It ConnectTimeout
 146 .It ControlMaster
 147 .It ControlPath
 148 .It ControlPersist
 149 .It GlobalKnownHostsFile
 150 .It GSSAPIAuthentication
 151 .It GSSAPIDelegateCredentials
 152 .It HashKnownHosts
 153 .It Host
 154 .It HostbasedAuthentication
 155 .It HostKeyAlgorithms
 156 .It HostKeyAlias
 157 .It HostName
 158 .It IdentityFile
 159 .It IdentitiesOnly
 160 .It IPQoS
 161 .It KbdInteractiveAuthentication
 162 .It KbdInteractiveDevices
 163 .It KexAlgorithms
 164 .It LogLevel
 165 .It MACs
 166 .It NoHostAuthenticationForLocalhost
 167 .It NumberOfPasswordPrompts
 168 .It PasswordAuthentication
 169 .It PKCS11Provider
 170 .It Port
 171 .It PreferredAuthentications
 172 .It Protocol
 173 .It ProxyCommand
 174 .It PubkeyAuthentication
 175 .It RekeyLimit
 176 .It RhostsRSAAuthentication
 177 .It RSAAuthentication
 178 .It SendEnv
 179 .It ServerAliveInterval
 180 .It ServerAliveCountMax
 181 .It StrictHostKeyChecking
 182 .It TCPKeepAlive
 183 .It UsePrivilegedPort
 184 .It User
 185 .It UserKnownHostsFile
 186 .It VerifyHostKeyDNS
 187 .El
 188 .It Fl P Ar port
 189 Specifies the port to connect to on the remote host.
 190 Note that this option is written with a capital
 191 .Sq P ,
 192 because
 193 .Fl p
 194 is already reserved for preserving the times and modes of the file in
 195 .Xr rcp 1 .
 196 .It Fl p
 197 Preserves modification times, access times, and modes from the
 198 original file.
 199 .It Fl q
 200 Quiet mode: disables the progress meter as well as warning and diagnostic
 201 messages from
 202 .Xr ssh 1 .
 203 .It Fl r
 204 Recursively copy entire directories.
 205 Note that
 206 .Nm
 207 follows symbolic links encountered in the tree traversal.
 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.
 224 .El
 225 .Sh EXIT STATUS
 226 .Ex -std scp
 227 .Sh SEE ALSO
 228 .Xr rcp 1 ,
 229 .Xr sftp 1 ,
 230 .Xr ssh 1 ,
 231 .Xr ssh-add 1 ,
 232 .Xr ssh-agent 1 ,
 233 .Xr ssh-keygen 1 ,
 234 .Xr ssh_config 5 ,
 235 .Xr sshd 8
 236 .Sh HISTORY
 237 .Nm
 238 is based on the
 239 .Xr rcp 1
 240 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