Annotation of src/usr.bin/ssh/scp.1, Revision 1.88
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.88 ! markus 11: .\" $OpenBSD: scp.1,v 1.87 2019/11/30 07:07:59 jmc Exp $
1.1 deraadt 12: .\"
1.88 ! markus 13: .Dd $Mdocdate: November 30 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.88 ! markus 77: Note that this option disables the progress meter and selects batch mode
! 78: for the second host, since
! 79: .Nm scp
! 80: cannot ask passwords or passphrases for both hosts.
1.29 jmc 81: .It Fl 4
82: Forces
83: .Nm
84: to use IPv4 addresses only.
85: .It Fl 6
86: Forces
1.3 aaron 87: .Nm
1.29 jmc 88: to use IPv6 addresses only.
1.3 aaron 89: .It Fl B
1.1 deraadt 90: Selects batch mode (prevents asking for passwords or passphrases).
1.3 aaron 91: .It Fl C
1.6 aaron 92: Compression enable.
93: Passes the
1.3 aaron 94: .Fl C
95: flag to
96: .Xr ssh 1
1.1 deraadt 97: to enable compression.
1.29 jmc 98: .It Fl c Ar cipher
99: Selects the cipher to use for encrypting the data transfer.
100: This option is directly passed to
101: .Xr ssh 1 .
1.19 stevesk 102: .It Fl F Ar ssh_config
103: Specifies an alternative
104: per-user configuration file for
105: .Nm ssh .
106: This option is directly passed to
107: .Xr ssh 1 .
1.29 jmc 108: .It Fl i Ar identity_file
1.46 djm 109: Selects the file from which the identity (private key) for public key
1.29 jmc 110: authentication is read.
1.82 tb 111: This option is directly passed to
112: .Xr ssh 1 .
113: .It Fl J Ar destination
1.84 jmc 114: Connect to the target host by first making an
1.82 tb 115: .Nm
116: connection to the jump host described by
117: .Ar destination
118: and then establishing a TCP forwarding to the ultimate destination from
119: there.
120: Multiple jump hops may be specified separated by comma characters.
121: This is a shortcut to specify a
122: .Cm ProxyJump
123: configuration directive.
1.29 jmc 124: This option is directly passed to
125: .Xr ssh 1 .
126: .It Fl l Ar limit
127: Limits the used bandwidth, specified in Kbit/s.
128: .It Fl o Ar ssh_option
129: Can be used to pass options to
130: .Nm ssh
131: in the format used in
132: .Xr ssh_config 5 .
133: This is useful for specifying options
134: for which there is no separate
135: .Nm scp
136: command-line flag.
137: For full details of the options listed below, and their possible values, see
138: .Xr ssh_config 5 .
139: .Pp
140: .Bl -tag -width Ds -offset indent -compact
141: .It AddressFamily
142: .It BatchMode
143: .It BindAddress
1.77 jmc 144: .It BindInterface
1.61 djm 145: .It CanonicalDomains
146: .It CanonicalizeFallbackLocal
147: .It CanonicalizeHostname
148: .It CanonicalizeMaxDots
149: .It CanonicalizePermittedCNAMEs
1.81 jmc 150: .It CASignatureAlgorithms
1.68 jmc 151: .It CertificateFile
1.29 jmc 152: .It ChallengeResponseAuthentication
153: .It CheckHostIP
154: .It Ciphers
155: .It Compression
1.74 naddy 156: .It ConnectionAttempts
1.34 dtucker 157: .It ConnectTimeout
1.36 djm 158: .It ControlMaster
159: .It ControlPath
1.57 djm 160: .It ControlPersist
1.29 jmc 161: .It GlobalKnownHostsFile
162: .It GSSAPIAuthentication
163: .It GSSAPIDelegateCredentials
1.38 jmc 164: .It HashKnownHosts
1.29 jmc 165: .It Host
166: .It HostbasedAuthentication
1.66 djm 167: .It HostbasedKeyTypes
1.29 jmc 168: .It HostKeyAlgorithms
169: .It HostKeyAlias
1.86 jmc 170: .It Hostname
1.70 jmc 171: .It IdentitiesOnly
1.69 markus 172: .It IdentityAgent
1.29 jmc 173: .It IdentityFile
1.54 jmc 174: .It IPQoS
1.57 djm 175: .It KbdInteractiveAuthentication
1.37 djm 176: .It KbdInteractiveDevices
1.52 jmc 177: .It KexAlgorithms
1.29 jmc 178: .It LogLevel
179: .It MACs
180: .It NoHostAuthenticationForLocalhost
181: .It NumberOfPasswordPrompts
182: .It PasswordAuthentication
1.50 markus 183: .It PKCS11Provider
1.29 jmc 184: .It Port
185: .It PreferredAuthentications
186: .It ProxyCommand
1.71 jmc 187: .It ProxyJump
1.67 markus 188: .It PubkeyAcceptedKeyTypes
1.29 jmc 189: .It PubkeyAuthentication
1.39 dtucker 190: .It RekeyLimit
1.35 jmc 191: .It SendEnv
1.32 markus 192: .It ServerAliveInterval
193: .It ServerAliveCountMax
1.79 jmc 194: .It SetEnv
1.29 jmc 195: .It StrictHostKeyChecking
1.31 markus 196: .It TCPKeepAlive
1.65 jmc 197: .It UpdateHostKeys
1.29 jmc 198: .It User
199: .It UserKnownHostsFile
200: .It VerifyHostKeyDNS
201: .El
1.4 markus 202: .It Fl P Ar port
1.6 aaron 203: Specifies the port to connect to on the remote host.
204: Note that this option is written with a capital
1.3 aaron 205: .Sq P ,
206: because
207: .Fl p
1.62 tedu 208: is already reserved for preserving the times and modes of the file.
1.29 jmc 209: .It Fl p
210: Preserves modification times, access times, and modes from the
211: original file.
212: .It Fl q
1.43 djm 213: Quiet mode: disables the progress meter as well as warning and diagnostic
214: messages from
215: .Xr ssh 1 .
1.29 jmc 216: .It Fl r
217: Recursively copy entire directories.
1.45 dtucker 218: Note that
219: .Nm
220: follows symbolic links encountered in the tree traversal.
1.10 deraadt 221: .It Fl S Ar program
222: Name of
223: .Ar program
1.12 aaron 224: to use for the encrypted connection.
225: The program must understand
1.9 deraadt 226: .Xr ssh 1
227: options.
1.85 djm 228: .It Fl T
229: Disable strict filename checking.
230: By default when copying files from a remote host to a local directory
231: .Nm
232: checks that the received filenames match those requested on the command-line
233: to prevent the remote end from sending unexpected or unwanted files.
234: Because of differences in how various operating systems and shells interpret
235: filename wildcards, these checks may cause wanted files to be rejected.
236: This option disables these checks at the expense of fully trusting that
237: the server will not send unexpected filenames.
1.29 jmc 238: .It Fl v
239: Verbose mode.
240: Causes
1.24 markus 241: .Nm
1.29 jmc 242: and
243: .Xr ssh 1
244: to print debugging messages about their progress.
245: This is helpful in
246: debugging connection, authentication, and configuration problems.
1.8 aaron 247: .El
1.51 jmc 248: .Sh EXIT STATUS
1.40 jmc 249: .Ex -std scp
1.3 aaron 250: .Sh SEE ALSO
1.14 djm 251: .Xr sftp 1 ,
1.3 aaron 252: .Xr ssh 1 ,
253: .Xr ssh-add 1 ,
254: .Xr ssh-agent 1 ,
255: .Xr ssh-keygen 1 ,
1.23 stevesk 256: .Xr ssh_config 5 ,
1.3 aaron 257: .Xr sshd 8
1.28 jmc 258: .Sh HISTORY
259: .Nm
1.62 tedu 260: is based on the rcp program in
1.60 jmc 261: .Bx
262: source code from the Regents of the University of California.
1.28 jmc 263: .Sh AUTHORS
1.59 schwarze 264: .An Timo Rinne Aq Mt tri@iki.fi
265: .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