Annotation of src/usr.bin/ssh/scp.1, Revision 1.32
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.32 ! markus 12: .\" $OpenBSD: scp.1,v 1.31 2003/12/09 21:53:36 markus Exp $
1.1 deraadt 13: .\"
1.3 aaron 14: .Dd September 25, 1999
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
37: .Op Ar ...
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.1 deraadt 59: Any file name may contain a host and user specification to indicate
1.6 aaron 60: that the file is to be copied to/from that host.
61: Copies between two remote hosts are permitted.
1.3 aaron 62: .Pp
63: The options are as follows:
64: .Bl -tag -width Ds
1.29 jmc 65: .It Fl 1
66: Forces
67: .Nm
68: to use protocol 1.
69: .It Fl 2
70: Forces
71: .Nm
72: to use protocol 2.
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
101: Selects the file from which the identity (private key) for RSA
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
123: .It ChallengeResponseAuthentication
124: .It CheckHostIP
125: .It Cipher
126: .It Ciphers
127: .It Compression
128: .It CompressionLevel
129: .It ConnectionAttempts
130: .It ConnectionTimeout
131: .It GlobalKnownHostsFile
132: .It GSSAPIAuthentication
133: .It GSSAPIDelegateCredentials
134: .It Host
135: .It HostbasedAuthentication
136: .It HostKeyAlgorithms
137: .It HostKeyAlias
138: .It HostName
139: .It IdentityFile
140: .It LogLevel
141: .It MACs
142: .It NoHostAuthenticationForLocalhost
143: .It NumberOfPasswordPrompts
144: .It PasswordAuthentication
145: .It Port
146: .It PreferredAuthentications
147: .It Protocol
148: .It ProxyCommand
149: .It PubkeyAuthentication
150: .It RhostsRSAAuthentication
151: .It RSAAuthentication
1.32 ! markus 152: .It ServerAliveInterval
! 153: .It ServerAliveCountMax
1.29 jmc 154: .It SmartcardDevice
155: .It StrictHostKeyChecking
1.31 markus 156: .It TCPKeepAlive
1.29 jmc 157: .It UsePrivilegedPort
158: .It User
159: .It UserKnownHostsFile
160: .It VerifyHostKeyDNS
161: .El
1.4 markus 162: .It Fl P Ar port
1.6 aaron 163: Specifies the port to connect to on the remote host.
164: Note that this option is written with a capital
1.3 aaron 165: .Sq P ,
166: because
167: .Fl p
168: is already reserved for preserving the times and modes of the file in
169: .Xr rcp 1 .
1.29 jmc 170: .It Fl p
171: Preserves modification times, access times, and modes from the
172: original file.
173: .It Fl q
174: Disables the progress meter.
175: .It Fl r
176: Recursively copy entire directories.
1.10 deraadt 177: .It Fl S Ar program
178: Name of
179: .Ar program
1.12 aaron 180: to use for the encrypted connection.
181: The program must understand
1.9 deraadt 182: .Xr ssh 1
183: options.
1.29 jmc 184: .It Fl v
185: Verbose mode.
186: Causes
1.24 markus 187: .Nm
1.29 jmc 188: and
189: .Xr ssh 1
190: to print debugging messages about their progress.
191: This is helpful in
192: debugging connection, authentication, and configuration problems.
1.8 aaron 193: .El
1.21 markus 194: .Sh DIAGNOSTICS
195: .Nm
196: exits with 0 on success or >0 if an error occurred.
1.3 aaron 197: .Sh SEE ALSO
198: .Xr rcp 1 ,
1.14 djm 199: .Xr sftp 1 ,
1.3 aaron 200: .Xr ssh 1 ,
201: .Xr ssh-add 1 ,
202: .Xr ssh-agent 1 ,
203: .Xr ssh-keygen 1 ,
1.23 stevesk 204: .Xr ssh_config 5 ,
1.3 aaron 205: .Xr sshd 8
1.28 jmc 206: .Sh HISTORY
207: .Nm
208: is based on the
209: .Xr rcp 1
210: program in BSD source code from the Regents of the University of
211: California.
212: .Sh AUTHORS
213: .An Timo Rinne Aq tri@iki.fi
214: .An Tatu Ylonen Aq ylo@cs.hut.fi