Annotation of src/usr.bin/ssh/scp.1, Revision 1.58
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.58 ! jmc 11: .\" $OpenBSD: scp.1,v 1.57 2011/09/05 05:56:13 djm Exp $
1.1 deraadt 12: .\"
1.58 ! jmc 13: .Dd $Mdocdate: September 5 2011 $
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.3 aaron 33: .Ar host1 No :
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.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.
1.55 markus 78: .It Fl 3
79: Copies between two remote hosts are transferred through the local host.
80: Without this option the data is copied directly between the two remote
81: hosts.
1.56 jmc 82: Note that this option disables the progress meter.
1.29 jmc 83: .It Fl 4
84: Forces
85: .Nm
86: to use IPv4 addresses only.
87: .It Fl 6
88: Forces
1.3 aaron 89: .Nm
1.29 jmc 90: to use IPv6 addresses only.
1.3 aaron 91: .It Fl B
1.1 deraadt 92: Selects batch mode (prevents asking for passwords or passphrases).
1.3 aaron 93: .It Fl C
1.6 aaron 94: Compression enable.
95: Passes the
1.3 aaron 96: .Fl C
97: flag to
98: .Xr ssh 1
1.1 deraadt 99: to enable compression.
1.29 jmc 100: .It Fl c Ar cipher
101: Selects the cipher to use for encrypting the data transfer.
102: This option is directly passed to
103: .Xr ssh 1 .
1.19 stevesk 104: .It Fl F Ar ssh_config
105: Specifies an alternative
106: per-user configuration file for
107: .Nm ssh .
108: This option is directly passed to
109: .Xr ssh 1 .
1.29 jmc 110: .It Fl i Ar identity_file
1.46 djm 111: Selects the file from which the identity (private key) for public key
1.29 jmc 112: authentication is read.
113: This option is directly passed to
114: .Xr ssh 1 .
115: .It Fl l Ar limit
116: Limits the used bandwidth, specified in Kbit/s.
117: .It Fl o Ar ssh_option
118: Can be used to pass options to
119: .Nm ssh
120: in the format used in
121: .Xr ssh_config 5 .
122: This is useful for specifying options
123: for which there is no separate
124: .Nm scp
125: command-line flag.
126: For full details of the options listed below, and their possible values, see
127: .Xr ssh_config 5 .
128: .Pp
129: .Bl -tag -width Ds -offset indent -compact
130: .It AddressFamily
131: .It BatchMode
132: .It BindAddress
133: .It ChallengeResponseAuthentication
134: .It CheckHostIP
135: .It Cipher
136: .It Ciphers
137: .It Compression
138: .It CompressionLevel
139: .It ConnectionAttempts
1.34 dtucker 140: .It ConnectTimeout
1.36 djm 141: .It ControlMaster
142: .It ControlPath
1.57 djm 143: .It ControlPersist
1.29 jmc 144: .It GlobalKnownHostsFile
145: .It GSSAPIAuthentication
146: .It GSSAPIDelegateCredentials
1.38 jmc 147: .It HashKnownHosts
1.29 jmc 148: .It Host
149: .It HostbasedAuthentication
150: .It HostKeyAlgorithms
151: .It HostKeyAlias
152: .It HostName
153: .It IdentityFile
1.33 markus 154: .It IdentitiesOnly
1.54 jmc 155: .It IPQoS
1.57 djm 156: .It KbdInteractiveAuthentication
1.37 djm 157: .It KbdInteractiveDevices
1.52 jmc 158: .It KexAlgorithms
1.29 jmc 159: .It LogLevel
160: .It MACs
161: .It NoHostAuthenticationForLocalhost
162: .It NumberOfPasswordPrompts
163: .It PasswordAuthentication
1.50 markus 164: .It PKCS11Provider
1.29 jmc 165: .It Port
166: .It PreferredAuthentications
167: .It Protocol
168: .It ProxyCommand
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.29 jmc 178: .It UsePrivilegedPort
179: .It User
180: .It UserKnownHostsFile
181: .It VerifyHostKeyDNS
182: .El
1.4 markus 183: .It Fl P Ar port
1.6 aaron 184: Specifies the port to connect to on the remote host.
185: Note that this option is written with a capital
1.3 aaron 186: .Sq P ,
187: because
188: .Fl p
189: is already reserved for preserving the times and modes of the file in
190: .Xr rcp 1 .
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
223: .Xr rcp 1 ,
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
233: is based on the
234: .Xr rcp 1
235: program in BSD source code from the Regents of the University of
236: California.
237: .Sh AUTHORS
238: .An Timo Rinne Aq tri@iki.fi
239: .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