Annotation of src/usr.bin/ssh/scp.1, Revision 1.87
1.1 deraadt 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: .\"
1.87 ! jmc 11: .\" $OpenBSD: scp.1,v 1.86 2019/06/12 11:31:50 jmc Exp $
1.1 deraadt 12: .\"
1.87 ! jmc 13: .Dd $Mdocdate: June 12 2019 $
1.3 aaron 14: .Dt SCP 1
15: .Os
16: .Sh NAME
17: .Nm scp
1.87 ! jmc 18: .Nd OpenSSH secure file copy
1.3 aaron 19: .Sh SYNOPSIS
20: .Nm scp
1.85 djm 21: .Op Fl 346BCpqrTv
1.29 jmc 22: .Op Fl c Ar cipher
1.19 stevesk 23: .Op Fl F Ar ssh_config
1.84 jmc 24: .Op Fl i Ar identity_file
1.83 tb 25: .Op Fl J Ar destination
1.25 markus 26: .Op Fl l Ar limit
1.17 stevesk 27: .Op Fl o Ar ssh_option
1.29 jmc 28: .Op Fl P Ar port
29: .Op Fl S Ar program
1.76 jmc 30: .Ar source ... target
1.7 aaron 31: .Sh DESCRIPTION
1.3 aaron 32: .Nm
1.6 aaron 33: copies files between hosts on a network.
34: It uses
1.3 aaron 35: .Xr ssh 1
1.1 deraadt 36: for data transfer, and uses the same authentication and provides the
37: same security as
1.3 aaron 38: .Xr ssh 1 .
39: .Nm
1.1 deraadt 40: will ask for passwords or passphrases if they are needed for
41: authentication.
1.3 aaron 42: .Pp
1.75 millert 43: The
1.76 jmc 44: .Ar source
45: and
1.75 millert 46: .Ar target
47: may be specified as a local pathname, a remote host with optional path
48: in the form
1.76 jmc 49: .Sm off
50: .Oo user @ Oc host : Op path ,
51: .Sm on
52: or a URI in the form
53: .Sm off
54: .No scp:// Oo user @ Oc host Oo : port Oc Op / path .
55: .Sm on
1.44 jmc 56: Local file names can be made explicit using absolute or relative pathnames
57: to avoid
58: .Nm
59: treating file names containing
60: .Sq :\&
61: as host specifiers.
1.75 millert 62: .Pp
63: When copying between two remote hosts, if the URI format is used, a
64: .Ar port
65: may only be specified on the
66: .Ar target
67: if the
68: .Fl 3
69: option is used.
1.3 aaron 70: .Pp
71: The options are as follows:
72: .Bl -tag -width Ds
1.55 markus 73: .It Fl 3
74: Copies between two remote hosts are transferred through the local host.
75: Without this option the data is copied directly between the two remote
76: hosts.
1.56 jmc 77: Note that this option disables the progress meter.
1.29 jmc 78: .It Fl 4
79: Forces
80: .Nm
81: to use IPv4 addresses only.
82: .It Fl 6
83: Forces
1.3 aaron 84: .Nm
1.29 jmc 85: to use IPv6 addresses only.
1.3 aaron 86: .It Fl B
1.1 deraadt 87: Selects batch mode (prevents asking for passwords or passphrases).
1.3 aaron 88: .It Fl C
1.6 aaron 89: Compression enable.
90: Passes the
1.3 aaron 91: .Fl C
92: flag to
93: .Xr ssh 1
1.1 deraadt 94: to enable compression.
1.29 jmc 95: .It Fl c Ar cipher
96: Selects the cipher to use for encrypting the data transfer.
97: This option is directly passed to
98: .Xr ssh 1 .
1.19 stevesk 99: .It Fl F Ar ssh_config
100: Specifies an alternative
101: per-user configuration file for
102: .Nm ssh .
103: This option is directly passed to
104: .Xr ssh 1 .
1.29 jmc 105: .It Fl i Ar identity_file
1.46 djm 106: Selects the file from which the identity (private key) for public key
1.29 jmc 107: authentication is read.
1.82 tb 108: This option is directly passed to
109: .Xr ssh 1 .
110: .It Fl J Ar destination
1.84 jmc 111: Connect to the target host by first making an
1.82 tb 112: .Nm
113: connection to the jump host described by
114: .Ar destination
115: and then establishing a TCP forwarding to the ultimate destination from
116: there.
117: Multiple jump hops may be specified separated by comma characters.
118: This is a shortcut to specify a
119: .Cm ProxyJump
120: configuration directive.
1.29 jmc 121: This option is directly passed to
122: .Xr ssh 1 .
123: .It Fl l Ar limit
124: Limits the used bandwidth, specified in Kbit/s.
125: .It Fl o Ar ssh_option
126: Can be used to pass options to
127: .Nm ssh
128: in the format used in
129: .Xr ssh_config 5 .
130: This is useful for specifying options
131: for which there is no separate
132: .Nm scp
133: command-line flag.
134: For full details of the options listed below, and their possible values, see
135: .Xr ssh_config 5 .
136: .Pp
137: .Bl -tag -width Ds -offset indent -compact
138: .It AddressFamily
139: .It BatchMode
140: .It BindAddress
1.77 jmc 141: .It BindInterface
1.61 djm 142: .It CanonicalDomains
143: .It CanonicalizeFallbackLocal
144: .It CanonicalizeHostname
145: .It CanonicalizeMaxDots
146: .It CanonicalizePermittedCNAMEs
1.81 jmc 147: .It CASignatureAlgorithms
1.68 jmc 148: .It CertificateFile
1.29 jmc 149: .It ChallengeResponseAuthentication
150: .It CheckHostIP
151: .It Ciphers
152: .It Compression
1.74 naddy 153: .It ConnectionAttempts
1.34 dtucker 154: .It ConnectTimeout
1.36 djm 155: .It ControlMaster
156: .It ControlPath
1.57 djm 157: .It ControlPersist
1.29 jmc 158: .It GlobalKnownHostsFile
159: .It GSSAPIAuthentication
160: .It GSSAPIDelegateCredentials
1.38 jmc 161: .It HashKnownHosts
1.29 jmc 162: .It Host
163: .It HostbasedAuthentication
1.66 djm 164: .It HostbasedKeyTypes
1.29 jmc 165: .It HostKeyAlgorithms
166: .It HostKeyAlias
1.86 jmc 167: .It Hostname
1.70 jmc 168: .It IdentitiesOnly
1.69 markus 169: .It IdentityAgent
1.29 jmc 170: .It IdentityFile
1.54 jmc 171: .It IPQoS
1.57 djm 172: .It KbdInteractiveAuthentication
1.37 djm 173: .It KbdInteractiveDevices
1.52 jmc 174: .It KexAlgorithms
1.29 jmc 175: .It LogLevel
176: .It MACs
177: .It NoHostAuthenticationForLocalhost
178: .It NumberOfPasswordPrompts
179: .It PasswordAuthentication
1.50 markus 180: .It PKCS11Provider
1.29 jmc 181: .It Port
182: .It PreferredAuthentications
183: .It ProxyCommand
1.71 jmc 184: .It ProxyJump
1.67 markus 185: .It PubkeyAcceptedKeyTypes
1.29 jmc 186: .It PubkeyAuthentication
1.39 dtucker 187: .It RekeyLimit
1.35 jmc 188: .It SendEnv
1.32 markus 189: .It ServerAliveInterval
190: .It ServerAliveCountMax
1.79 jmc 191: .It SetEnv
1.29 jmc 192: .It StrictHostKeyChecking
1.31 markus 193: .It TCPKeepAlive
1.65 jmc 194: .It UpdateHostKeys
1.29 jmc 195: .It User
196: .It UserKnownHostsFile
197: .It VerifyHostKeyDNS
198: .El
1.4 markus 199: .It Fl P Ar port
1.6 aaron 200: Specifies the port to connect to on the remote host.
201: Note that this option is written with a capital
1.3 aaron 202: .Sq P ,
203: because
204: .Fl p
1.62 tedu 205: is already reserved for preserving the times and modes of the file.
1.29 jmc 206: .It Fl p
207: Preserves modification times, access times, and modes from the
208: original file.
209: .It Fl q
1.43 djm 210: Quiet mode: disables the progress meter as well as warning and diagnostic
211: messages from
212: .Xr ssh 1 .
1.29 jmc 213: .It Fl r
214: Recursively copy entire directories.
1.45 dtucker 215: Note that
216: .Nm
217: follows symbolic links encountered in the tree traversal.
1.10 deraadt 218: .It Fl S Ar program
219: Name of
220: .Ar program
1.12 aaron 221: to use for the encrypted connection.
222: The program must understand
1.9 deraadt 223: .Xr ssh 1
224: options.
1.85 djm 225: .It Fl T
226: Disable strict filename checking.
227: By default when copying files from a remote host to a local directory
228: .Nm
229: checks that the received filenames match those requested on the command-line
230: to prevent the remote end from sending unexpected or unwanted files.
231: Because of differences in how various operating systems and shells interpret
232: filename wildcards, these checks may cause wanted files to be rejected.
233: This option disables these checks at the expense of fully trusting that
234: the server will not send unexpected filenames.
1.29 jmc 235: .It Fl v
236: Verbose mode.
237: Causes
1.24 markus 238: .Nm
1.29 jmc 239: and
240: .Xr ssh 1
241: to print debugging messages about their progress.
242: This is helpful in
243: debugging connection, authentication, and configuration problems.
1.8 aaron 244: .El
1.51 jmc 245: .Sh EXIT STATUS
1.40 jmc 246: .Ex -std scp
1.3 aaron 247: .Sh SEE ALSO
1.14 djm 248: .Xr sftp 1 ,
1.3 aaron 249: .Xr ssh 1 ,
250: .Xr ssh-add 1 ,
251: .Xr ssh-agent 1 ,
252: .Xr ssh-keygen 1 ,
1.23 stevesk 253: .Xr ssh_config 5 ,
1.3 aaron 254: .Xr sshd 8
1.28 jmc 255: .Sh HISTORY
256: .Nm
1.62 tedu 257: is based on the rcp program in
1.60 jmc 258: .Bx
259: source code from the Regents of the University of California.
1.28 jmc 260: .Sh AUTHORS
1.59 schwarze 261: .An Timo Rinne Aq Mt tri@iki.fi
262: .An Tatu Ylonen Aq Mt ylo@cs.hut.fi
![[BACK]](/icons/back.gif){kind=icon}
Return to scp.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh