crypto/external/bsd/openssh/dist/scp.1

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