usr/src/man/man1/scp.1

   1 '\" te
   2 .\" To view license terms, attribution, and copyright for OpenSSH, the default path is /var/sadm/pkg/SUNWsshdr/install/copyright. If the Solaris operating environment has been installed anywhere other than the default, modify the given path to access the file at the
   3 .\" installed location.
   4 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved.
   5 .TH SCP 1 "Jun 22, 2007"
   6 .SH NAME
   7 scp \- secure copy (remote file copy program)
   8 .SH SYNOPSIS
   9 .LP
  10 .nf
  11 \fBscp\fR [\fB-pqrvBC46\fR] [\fB-F\fR \fIssh_config\fR] [\fB-S\fR \fIprogram\fR] [\fB-P\fR \fIport\fR]
  12      [\fB-c\fR \fIcipher\fR] [\fB-i\fR \fIidentity_file\fR] [\fB-o\fR \fIssh_option\fR]
  13      [ [\fIuser\fR@]\fIhost1\fR:]\fIfile1\fR []... [ [\fIuser\fR@]\fIhost2\fR:]\fIfile2\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBscp\fR utility copies files between hosts on a network. It uses
  20 \fBssh\fR(1) for data transfer, and uses the same authentication and provides
  21 the same security as \fBssh\fR(1). Unlike \fBrcp\fR(1), \fBscp\fR will ask for
  22 passwords or passphrases if they are needed for authentication.
  23 .sp
  24 .LP
  25 Any file name may contain a host and user specification to indicate that the
  26 file is to be copied to/from that host. Copies between two remote hosts are
  27 permitted.
  28 .SH OPTIONS
  29 .sp
  30 .LP
  31 The following options are supported:
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fB-4\fR\fR
  36 .ad
  37 .RS 20n
  38 Forces \fBscp\fR to use IPv4 addresses only.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB-6\fR\fR
  45 .ad
  46 .RS 20n
  47 Forces \fBscp\fR to use IPv6 addresses only.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fB-B\fR\fR
  54 .ad
  55 .RS 20n
  56 Selects batch mode. (Prevents asking for passwords or passphrases.)
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fB-c\fR \fIcipher\fR\fR
  63 .ad
  64 .RS 20n
  65 Selects the cipher to use for encrypting the data transfer. This option is
  66 directly passed to \fBssh\fR(1).
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fB-C\fR\fR
  73 .ad
  74 .RS 20n
  75 Compression enable. Passes the \fB-C\fR flag to \fBssh\fR(1) to enable
  76 compression.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fB-F\fR \fIssh_config\fR\fR
  83 .ad
  84 .RS 20n
  85 Specifies an alternative per-user configuration file for \fBssh\fR(1.).
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fB-i\fR \fIidentity_file\fR\fR
  92 .ad
  93 .RS 20n
  94 Selects the file from which the identity (private key) for \fBRSA\fR
  95 authentication is read. This option is directly passed to \fBssh\fR(1).
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fB-o\fR \fIssh_option\fR\fR
 102 .ad
 103 .RS 20n
 104 The given option is directly passed to \fBssh\fR(1).
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fB-p\fR\fR
 111 .ad
 112 .RS 20n
 113 Preserves modification times, access times, and modes from the original file.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB-P\fR \fIport\fR\fR
 120 .ad
 121 .RS 20n
 122 Specifies the port to connect to on the remote host. Notice that this option is
 123 written with a capital `P', because \fB-p\fR is already reserved for preserving
 124 the times and modes of the file in \fBrcp\fR(1).
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fB-q\fR\fR
 131 .ad
 132 .RS 20n
 133 Disables the progress meter.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fB-r\fR\fR
 140 .ad
 141 .RS 20n
 142 Recursively copies entire directories.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB-S\fR \fIprogram\fR\fR
 149 .ad
 150 .RS 20n
 151 Specifies the name of the program to use for the encrypted connection. The
 152 program must understand \fBssh\fR(1) options.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fB-v\fR\fR
 159 .ad
 160 .RS 20n
 161 Verbose mode. Causes \fBscp\fR and \fBssh\fR(1) to print debugging messages
 162 about their progress. This is helpful in debugging connection, authentication,
 163 and configuration problems.
 164 .RE
 165
 166 .SH OPERANDS
 167 .sp
 168 .LP
 169 The following operands are supported:
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fIhost1, host2,\fR...\fR
 174 .ad
 175 .RS 20n
 176 The name(s) of the host from or to which the file is to be copied.
 177 .RE
 178
 179 .sp
 180 .ne 2
 181 .na
 182 \fB\fIfile1, file2,\fR...\fR
 183 .ad
 184 .RS 20n
 185 The file(s) to be copied.
 186 .RE
 187
 188 .SH EXIT STATUS
 189 .sp
 190 .LP
 191 The following exit values are returned:
 192 .sp
 193 .ne 2
 194 .na
 195 \fB\fB0\fR\fR
 196 .ad
 197 .RS 5n
 198 Successful completion.
 199 .RE
 200
 201 .sp
 202 .ne 2
 203 .na
 204 \fB\fB1\fR\fR
 205 .ad
 206 .RS 5n
 207 An error occurred.
 208 .RE
 209
 210 .SH ATTRIBUTES
 211 .sp
 212 .LP
 213 See \fBattributes\fR(5) for descriptions of the following attributes:
 214 .sp
 215
 216 .sp
 217 .TS
 218 box;
 219 c | c
 220 l | l .
 221 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 222 _
 223 Interface Stability     Evolving
 224 .TE
 225
 226 .SH SEE ALSO
 227 .sp
 228 .LP
 229 \fBrcp\fR(1), \fBssh\fR(1), \fBssh-add\fR(1), \fBssh-agent\fR(1),
 230 \fBssh-keygen\fR(1), \fBsshd\fR(1M), \fBssh_config\fR(4), \fBattributes\fR(5)
 231 .SH NOTES
 232 .sp
 233 .LP
 234 Generally, use of \fBscp\fR with password or keyboard-interactive
 235 authentication  method and two remote hosts does not work. It does work with
 236 either the \fBpubkey\fR,  \fBhostbased\fR or \fBgssapi-keyex\fR authentication
 237 method. For the \fBpubkey\fR authentication  method, either private keys not
 238 protected by a passphrase, or an explicit \fBssh\fR  agent forwarding have to
 239 be used. The \fBgssapi-keyex\fR authentication method  works with the
 240 \fBkerberos_v5\fR GSS-API mechanism, but only if  the
 241 \fBGSSAPIDelegateCredentials\fR option is enabled.