Annotation of src/usr.bin/ssh/scp.1, Revision 1.73
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.73 ! jmc 11: .\" $OpenBSD: scp.1,v 1.72 2017/04/30 23:28:12 djm Exp $
1.1 deraadt 12: .\"
1.73 ! jmc 13: .Dd $Mdocdate: April 30 2017 $
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 Ciphers
132: .It Compression
1.34 dtucker 133: .It ConnectTimeout
1.36 djm 134: .It ControlMaster
135: .It ControlPath
1.57 djm 136: .It ControlPersist
1.29 jmc 137: .It GlobalKnownHostsFile
138: .It GSSAPIAuthentication
139: .It GSSAPIDelegateCredentials
1.38 jmc 140: .It HashKnownHosts
1.29 jmc 141: .It Host
142: .It HostbasedAuthentication
1.66 djm 143: .It HostbasedKeyTypes
1.29 jmc 144: .It HostKeyAlgorithms
145: .It HostKeyAlias
146: .It HostName
1.70 jmc 147: .It IdentitiesOnly
1.69 markus 148: .It IdentityAgent
1.29 jmc 149: .It IdentityFile
1.54 jmc 150: .It IPQoS
1.57 djm 151: .It KbdInteractiveAuthentication
1.37 djm 152: .It KbdInteractiveDevices
1.52 jmc 153: .It KexAlgorithms
1.29 jmc 154: .It LogLevel
155: .It MACs
156: .It NoHostAuthenticationForLocalhost
157: .It NumberOfPasswordPrompts
158: .It PasswordAuthentication
1.50 markus 159: .It PKCS11Provider
1.29 jmc 160: .It Port
161: .It PreferredAuthentications
162: .It ProxyCommand
1.71 jmc 163: .It ProxyJump
1.67 markus 164: .It PubkeyAcceptedKeyTypes
1.29 jmc 165: .It PubkeyAuthentication
1.39 dtucker 166: .It RekeyLimit
1.35 jmc 167: .It SendEnv
1.32 markus 168: .It ServerAliveInterval
169: .It ServerAliveCountMax
1.29 jmc 170: .It StrictHostKeyChecking
1.31 markus 171: .It TCPKeepAlive
1.65 jmc 172: .It UpdateHostKeys
1.29 jmc 173: .It UsePrivilegedPort
174: .It User
175: .It UserKnownHostsFile
176: .It VerifyHostKeyDNS
177: .El
1.4 markus 178: .It Fl P Ar port
1.6 aaron 179: Specifies the port to connect to on the remote host.
180: Note that this option is written with a capital
1.3 aaron 181: .Sq P ,
182: because
183: .Fl p
1.62 tedu 184: is already reserved for preserving the times and modes of the file.
1.29 jmc 185: .It Fl p
186: Preserves modification times, access times, and modes from the
187: original file.
188: .It Fl q
1.43 djm 189: Quiet mode: disables the progress meter as well as warning and diagnostic
190: messages from
191: .Xr ssh 1 .
1.29 jmc 192: .It Fl r
193: Recursively copy entire directories.
1.45 dtucker 194: Note that
195: .Nm
196: follows symbolic links encountered in the tree traversal.
1.10 deraadt 197: .It Fl S Ar program
198: Name of
199: .Ar program
1.12 aaron 200: to use for the encrypted connection.
201: The program must understand
1.9 deraadt 202: .Xr ssh 1
203: options.
1.29 jmc 204: .It Fl v
205: Verbose mode.
206: Causes
1.24 markus 207: .Nm
1.29 jmc 208: and
209: .Xr ssh 1
210: to print debugging messages about their progress.
211: This is helpful in
212: debugging connection, authentication, and configuration problems.
1.8 aaron 213: .El
1.51 jmc 214: .Sh EXIT STATUS
1.40 jmc 215: .Ex -std scp
1.3 aaron 216: .Sh SEE ALSO
1.14 djm 217: .Xr sftp 1 ,
1.3 aaron 218: .Xr ssh 1 ,
219: .Xr ssh-add 1 ,
220: .Xr ssh-agent 1 ,
221: .Xr ssh-keygen 1 ,
1.23 stevesk 222: .Xr ssh_config 5 ,
1.3 aaron 223: .Xr sshd 8
1.28 jmc 224: .Sh HISTORY
225: .Nm
1.62 tedu 226: is based on the rcp program in
1.60 jmc 227: .Bx
228: source code from the Regents of the University of California.
1.28 jmc 229: .Sh AUTHORS
1.59 schwarze 230: .An Timo Rinne Aq Mt tri@iki.fi
231: .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