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