Annotation of src/usr.bin/ssh/scp.1, Revision 1.64
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.64 ! djm 11: .\" $OpenBSD: scp.1,v 1.63 2015/01/16 16:20:23 schwarze Exp $
1.1 deraadt 12: .\"
1.64 ! djm 13: .Dd $Mdocdate: January 16 2015 $
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.55 markus 22: .Op Fl 12346BCpqrv
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.29 jmc 68: .It Fl 1
69: Forces
70: .Nm
71: to use protocol 1.
72: .It Fl 2
73: Forces
74: .Nm
75: to use protocol 2.
1.55 markus 76: .It Fl 3
77: Copies between two remote hosts are transferred through the local host.
78: Without this option the data is copied directly between the two remote
79: hosts.
1.56 jmc 80: Note that this option disables the progress meter.
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.
111: This option is directly passed to
112: .Xr ssh 1 .
113: .It Fl l Ar limit
114: Limits the used bandwidth, specified in Kbit/s.
115: .It Fl o Ar ssh_option
116: Can be used to pass options to
117: .Nm ssh
118: in the format used in
119: .Xr ssh_config 5 .
120: This is useful for specifying options
121: for which there is no separate
122: .Nm scp
123: command-line flag.
124: For full details of the options listed below, and their possible values, see
125: .Xr ssh_config 5 .
126: .Pp
127: .Bl -tag -width Ds -offset indent -compact
128: .It AddressFamily
129: .It BatchMode
130: .It BindAddress
1.61 djm 131: .It CanonicalDomains
132: .It CanonicalizeFallbackLocal
133: .It CanonicalizeHostname
134: .It CanonicalizeMaxDots
135: .It CanonicalizePermittedCNAMEs
1.29 jmc 136: .It ChallengeResponseAuthentication
137: .It CheckHostIP
138: .It Cipher
139: .It Ciphers
140: .It Compression
141: .It CompressionLevel
142: .It ConnectionAttempts
1.34 dtucker 143: .It ConnectTimeout
1.36 djm 144: .It ControlMaster
145: .It ControlPath
1.57 djm 146: .It ControlPersist
1.29 jmc 147: .It GlobalKnownHostsFile
148: .It GSSAPIAuthentication
149: .It GSSAPIDelegateCredentials
1.38 jmc 150: .It HashKnownHosts
1.29 jmc 151: .It Host
152: .It HostbasedAuthentication
153: .It HostKeyAlgorithms
154: .It HostKeyAlias
155: .It HostName
156: .It IdentityFile
1.33 markus 157: .It IdentitiesOnly
1.54 jmc 158: .It IPQoS
1.57 djm 159: .It KbdInteractiveAuthentication
1.37 djm 160: .It KbdInteractiveDevices
1.52 jmc 161: .It KexAlgorithms
1.29 jmc 162: .It LogLevel
163: .It MACs
164: .It NoHostAuthenticationForLocalhost
165: .It NumberOfPasswordPrompts
166: .It PasswordAuthentication
1.50 markus 167: .It PKCS11Provider
1.29 jmc 168: .It Port
169: .It PreferredAuthentications
170: .It Protocol
171: .It ProxyCommand
172: .It PubkeyAuthentication
1.39 dtucker 173: .It RekeyLimit
1.29 jmc 174: .It RhostsRSAAuthentication
175: .It RSAAuthentication
1.35 jmc 176: .It SendEnv
1.32 markus 177: .It ServerAliveInterval
178: .It ServerAliveCountMax
1.29 jmc 179: .It StrictHostKeyChecking
1.31 markus 180: .It TCPKeepAlive
1.29 jmc 181: .It UsePrivilegedPort
1.64 ! djm 182: .It UpdateHostKeys
1.29 jmc 183: .It User
184: .It UserKnownHostsFile
185: .It VerifyHostKeyDNS
186: .El
1.4 markus 187: .It Fl P Ar port
1.6 aaron 188: Specifies the port to connect to on the remote host.
189: Note that this option is written with a capital
1.3 aaron 190: .Sq P ,
191: because
192: .Fl p
1.62 tedu 193: is already reserved for preserving the times and modes of the file.
1.29 jmc 194: .It Fl p
195: Preserves modification times, access times, and modes from the
196: original file.
197: .It Fl q
1.43 djm 198: Quiet mode: disables the progress meter as well as warning and diagnostic
199: messages from
200: .Xr ssh 1 .
1.29 jmc 201: .It Fl r
202: Recursively copy entire directories.
1.45 dtucker 203: Note that
204: .Nm
205: follows symbolic links encountered in the tree traversal.
1.10 deraadt 206: .It Fl S Ar program
207: Name of
208: .Ar program
1.12 aaron 209: to use for the encrypted connection.
210: The program must understand
1.9 deraadt 211: .Xr ssh 1
212: options.
1.29 jmc 213: .It Fl v
214: Verbose mode.
215: Causes
1.24 markus 216: .Nm
1.29 jmc 217: and
218: .Xr ssh 1
219: to print debugging messages about their progress.
220: This is helpful in
221: debugging connection, authentication, and configuration problems.
1.8 aaron 222: .El
1.51 jmc 223: .Sh EXIT STATUS
1.40 jmc 224: .Ex -std scp
1.3 aaron 225: .Sh SEE ALSO
1.14 djm 226: .Xr sftp 1 ,
1.3 aaron 227: .Xr ssh 1 ,
228: .Xr ssh-add 1 ,
229: .Xr ssh-agent 1 ,
230: .Xr ssh-keygen 1 ,
1.23 stevesk 231: .Xr ssh_config 5 ,
1.3 aaron 232: .Xr sshd 8
1.28 jmc 233: .Sh HISTORY
234: .Nm
1.62 tedu 235: is based on the rcp program in
1.60 jmc 236: .Bx
237: source code from the Regents of the University of California.
1.28 jmc 238: .Sh AUTHORS
1.59 schwarze 239: .An Timo Rinne Aq Mt tri@iki.fi
240: .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