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