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