Annotation of src/usr.bin/ssh/scp.1, Revision 1.47
1.1 deraadt 1: .\" -*- nroff -*-
2: .\"
3: .\" scp.1
4: .\"
5: .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
6: .\"
7: .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8: .\" All rights reserved
9: .\"
10: .\" Created: Sun May 7 00:14:37 1995 ylo
11: .\"
1.46 djm 12: .\" $OpenBSD: scp.1,v 1.45 2008/06/14 19:42:10 dtucker Exp $
1.1 deraadt 13: .\"
1.47 ! reyk 14: .Dd $Mdocdate: July 12 2008 $
1.3 aaron 15: .Dt SCP 1
16: .Os
17: .Sh NAME
18: .Nm scp
19: .Nd secure copy (remote file copy program)
20: .Sh SYNOPSIS
21: .Nm scp
1.27 jmc 22: .Bk -words
1.29 jmc 23: .Op Fl 1246BCpqrv
24: .Op Fl c Ar cipher
1.19 stevesk 25: .Op Fl F Ar ssh_config
1.3 aaron 26: .Op Fl i Ar identity_file
1.25 markus 27: .Op Fl l Ar limit
1.17 stevesk 28: .Op Fl o Ar ssh_option
1.29 jmc 29: .Op Fl P Ar port
30: .Op Fl S Ar program
1.3 aaron 31: .Sm off
32: .Oo
1.29 jmc 33: .Op Ar user No @
1.3 aaron 34: .Ar host1 No :
35: .Oc Ns Ar file1
36: .Sm on
1.42 sobrado 37: .Ar ...
1.3 aaron 38: .Sm off
39: .Oo
1.29 jmc 40: .Op Ar user No @
1.3 aaron 41: .Ar host2 No :
42: .Oc Ar file2
43: .Sm on
1.27 jmc 44: .Ek
1.7 aaron 45: .Sh DESCRIPTION
1.3 aaron 46: .Nm
1.6 aaron 47: copies files between hosts on a network.
48: It uses
1.3 aaron 49: .Xr ssh 1
1.1 deraadt 50: for data transfer, and uses the same authentication and provides the
51: same security as
1.3 aaron 52: .Xr ssh 1 .
1.1 deraadt 53: Unlike
1.3 aaron 54: .Xr rcp 1 ,
55: .Nm
1.1 deraadt 56: will ask for passwords or passphrases if they are needed for
57: authentication.
1.3 aaron 58: .Pp
1.44 jmc 59: File names may contain a user and host specification to indicate
1.6 aaron 60: that the file is to be copied to/from that host.
1.44 jmc 61: Local file names can be made explicit using absolute or relative pathnames
62: to avoid
63: .Nm
64: treating file names containing
65: .Sq :\&
66: as host specifiers.
67: Copies between two remote hosts are also permitted.
1.3 aaron 68: .Pp
69: The options are as follows:
70: .Bl -tag -width Ds
1.29 jmc 71: .It Fl 1
72: Forces
73: .Nm
74: to use protocol 1.
75: .It Fl 2
76: Forces
77: .Nm
78: to use protocol 2.
79: .It Fl 4
80: Forces
81: .Nm
82: to use IPv4 addresses only.
83: .It Fl 6
84: Forces
1.3 aaron 85: .Nm
1.29 jmc 86: to use IPv6 addresses only.
1.3 aaron 87: .It Fl B
1.1 deraadt 88: Selects batch mode (prevents asking for passwords or passphrases).
1.3 aaron 89: .It Fl C
1.6 aaron 90: Compression enable.
91: Passes the
1.3 aaron 92: .Fl C
93: flag to
94: .Xr ssh 1
1.1 deraadt 95: to enable compression.
1.29 jmc 96: .It Fl c Ar cipher
97: Selects the cipher to use for encrypting the data transfer.
98: This option is directly passed to
99: .Xr ssh 1 .
1.19 stevesk 100: .It Fl F Ar ssh_config
101: Specifies an alternative
102: per-user configuration file for
103: .Nm ssh .
104: This option is directly passed to
105: .Xr ssh 1 .
1.29 jmc 106: .It Fl i Ar identity_file
1.46 djm 107: Selects the file from which the identity (private key) for public key
1.29 jmc 108: authentication is read.
109: This option is directly passed to
110: .Xr ssh 1 .
111: .It Fl l Ar limit
112: Limits the used bandwidth, specified in Kbit/s.
113: .It Fl o Ar ssh_option
114: Can be used to pass options to
115: .Nm ssh
116: in the format used in
117: .Xr ssh_config 5 .
118: This is useful for specifying options
119: for which there is no separate
120: .Nm scp
121: command-line flag.
122: For full details of the options listed below, and their possible values, see
123: .Xr ssh_config 5 .
124: .Pp
125: .Bl -tag -width Ds -offset indent -compact
126: .It AddressFamily
127: .It BatchMode
128: .It BindAddress
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.29 jmc 139: .It GlobalKnownHostsFile
140: .It GSSAPIAuthentication
141: .It GSSAPIDelegateCredentials
1.38 jmc 142: .It HashKnownHosts
1.29 jmc 143: .It Host
144: .It HostbasedAuthentication
145: .It HostKeyAlgorithms
146: .It HostKeyAlias
147: .It HostName
148: .It IdentityFile
1.33 markus 149: .It IdentitiesOnly
1.37 djm 150: .It KbdInteractiveDevices
1.29 jmc 151: .It LogLevel
152: .It MACs
153: .It NoHostAuthenticationForLocalhost
154: .It NumberOfPasswordPrompts
155: .It PasswordAuthentication
156: .It Port
157: .It PreferredAuthentications
158: .It Protocol
159: .It ProxyCommand
160: .It PubkeyAuthentication
1.47 ! reyk 161: .It RDomain
1.39 dtucker 162: .It RekeyLimit
1.29 jmc 163: .It RhostsRSAAuthentication
164: .It RSAAuthentication
1.35 jmc 165: .It SendEnv
1.32 markus 166: .It ServerAliveInterval
167: .It ServerAliveCountMax
1.29 jmc 168: .It SmartcardDevice
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.40 jmc 213: .Pp
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