scp.1

   1 .\"  -*- nroff -*-
   2 .\"
   3 .\" scp.1
   4 .\"
   5 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   6 .\"
   7 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   8 .\"                    All rights reserved
   9 .\"
  10 .\" Created: Sun May  7 00:14:37 1995 ylo
  11 .\"
  12 .\" $OpenBSD: scp.1,v 1.47 2009/10/28 16:38:18 reyk Exp $
  13 .\"
  14 .Dd $Mdocdate: October 28 2009 $
  15 .Dt SCP 1
  16 .Os
  17 .Sh NAME
  18 .Nm scp
  19 .Nd secure copy (remote file copy program)
  20 .Sh SYNOPSIS
  21 .Nm scp
  22 .Bk -words
  23 .Op Fl 1246BCpqrv
  24 .Op Fl c Ar cipher
  25 .Op Fl F Ar ssh_config
  26 .Op Fl i Ar identity_file
  27 .Op Fl l Ar limit
  28 .Op Fl o Ar ssh_option
  29 .Op Fl P Ar port
  30 .Op Fl S Ar program
  31 .Sm off
  32 .Oo
  33 .Op Ar user No @
  34 .Ar host1 No :
  35 .Oc Ns Ar file1
  36 .Sm on
  37 .Ar ...
  38 .Sm off
  39 .Oo
  40 .Op Ar user No @
  41 .Ar host2 No :
  42 .Oc Ar file2
  43 .Sm on
  44 .Ek
  45 .Sh DESCRIPTION
  46 .Nm
  47 copies files between hosts on a network.
  48 It uses
  49 .Xr ssh 1
  50 for data transfer, and uses the same authentication and provides the
  51 same security as
  52 .Xr ssh 1 .
  53 Unlike
  54 .Xr rcp 1 ,
  55 .Nm
  56 will ask for passwords or passphrases if they are needed for
  57 authentication.
  58 .Pp
  59 File names may contain a user and host specification to indicate
  60 that the file is to be copied to/from that host.
  61 Local file names can be made explicit using absolute or relative pathnames
  62 to avoid
  63 .Nm
  64 treating file names containing
  65 .Sq :\&
  66 as host specifiers.
  67 Copies between two remote hosts are also permitted.
  68 .Pp
  69 The options are as follows:
  70 .Bl -tag -width Ds
  71 .It Fl 1
  72 Forces
  73 .Nm
  74 to use protocol 1.
  75 .It Fl 2
  76 Forces
  77 .Nm
  78 to use protocol 2.
  79 .It Fl 4
  80 Forces
  81 .Nm
  82 to use IPv4 addresses only.
  83 .It Fl 6
  84 Forces
  85 .Nm
  86 to use IPv6 addresses only.
  87 .It Fl B
  88 Selects batch mode (prevents asking for passwords or passphrases).
  89 .It Fl C
  90 Compression enable.
  91 Passes the
  92 .Fl C
  93 flag to
  94 .Xr ssh 1
  95 to enable compression.
  96 .It Fl c Ar cipher
  97 Selects the cipher to use for encrypting the data transfer.
  98 This option is directly passed to
  99 .Xr ssh 1 .
 100 .It Fl F Ar ssh_config
 101 Specifies an alternative
 102 per-user configuration file for
 103 .Nm ssh .
 104 This option is directly passed to
 105 .Xr ssh 1 .
 106 .It Fl i Ar identity_file
 107 Selects the file from which the identity (private key) for public key
 108 authentication is read.
 109 This option is directly passed to
 110 .Xr ssh 1 .
 111 .It Fl l Ar limit
 112 Limits the used bandwidth, specified in Kbit/s.
 113 .It Fl o Ar ssh_option
 114 Can be used to pass options to
 115 .Nm ssh
 116 in the format used in
 117 .Xr ssh_config 5 .
 118 This is useful for specifying options
 119 for which there is no separate
 120 .Nm scp
 121 command-line flag.
 122 For full details of the options listed below, and their possible values, see
 123 .Xr ssh_config 5 .
 124 .Pp
 125 .Bl -tag -width Ds -offset indent -compact
 126 .It AddressFamily
 127 .It BatchMode
 128 .It BindAddress
 129 .It ChallengeResponseAuthentication
 130 .It CheckHostIP
 131 .It Cipher
 132 .It Ciphers
 133 .It Compression
 134 .It CompressionLevel
 135 .It ConnectionAttempts
 136 .It ConnectTimeout
 137 .It ControlMaster
 138 .It ControlPath
 139 .It GlobalKnownHostsFile
 140 .It GSSAPIAuthentication
 141 .It GSSAPIDelegateCredentials
 142 .It HashKnownHosts
 143 .It Host
 144 .It HostbasedAuthentication
 145 .It HostKeyAlgorithms
 146 .It HostKeyAlias
 147 .It HostName
 148 .It IdentityFile
 149 .It IdentitiesOnly
 150 .It KbdInteractiveDevices
 151 .It LogLevel
 152 .It MACs
 153 .It NoHostAuthenticationForLocalhost
 154 .It NumberOfPasswordPrompts
 155 .It PasswordAuthentication
 156 .It Port
 157 .It PreferredAuthentications
 158 .It Protocol
 159 .It ProxyCommand
 160 .It PubkeyAuthentication
 161 .It RDomain
 162 .It RekeyLimit
 163 .It RhostsRSAAuthentication
 164 .It RSAAuthentication
 165 .It SendEnv
 166 .It ServerAliveInterval
 167 .It ServerAliveCountMax
 168 .It SmartcardDevice
 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 .Pp
 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