Annotation of src/crypto/external/bsd/openssh/dist/scp.1, Revision 1.12
1.7 christos 1: .\" $NetBSD: scp.1,v 1.6 2013/07/20 21:39:56 wiz Exp $
1.1 christos 2: .\" -*- nroff -*-
3: .\"
4: .\" scp.1
5: .\"
6: .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
7: .\"
8: .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
9: .\" All rights reserved
10: .\"
11: .\" Created: Sun May 7 00:14:37 1995 ylo
12: .\"
1.12 ! christos 13: .\" $OpenBSD: scp.1,v 1.71 2016/07/16 06:57:55 jmc Exp $
1.1 christos 14: .\"
1.12 ! christos 15: .Dd July 16 2016
1.1 christos 16: .Dt SCP 1
17: .Os
18: .Sh NAME
19: .Nm scp
20: .Nd secure copy (remote file copy program)
21: .Sh SYNOPSIS
22: .Nm scp
23: .Bk -words
1.4 christos 24: .Op Fl 12346BCpqrv
1.1 christos 25: .Op Fl c Ar cipher
26: .Op Fl F Ar ssh_config
27: .Op Fl i Ar identity_file
28: .Op Fl l Ar limit
29: .Op Fl o Ar ssh_option
30: .Op Fl P Ar port
31: .Op Fl S Ar program
32: .Sm off
33: .Oo
34: .Op Ar user No @
1.9 christos 35: .Ar host1 :
1.5 christos 36: .Oc Ar file1
1.1 christos 37: .Sm on
38: .Ar ...
39: .Sm off
40: .Oo
41: .Op Ar user No @
1.9 christos 42: .Ar host2 :
1.1 christos 43: .Oc Ar file2
44: .Sm on
45: .Ek
46: .Sh DESCRIPTION
47: .Nm
48: copies files between hosts on a network.
49: It uses
50: .Xr ssh 1
51: for data transfer, and uses the same authentication and provides the
52: same security as
53: .Xr ssh 1 .
54: .Nm
55: will ask for passwords or passphrases if they are needed for
56: authentication.
57: .Pp
58: File names may contain a user and host specification to indicate
59: that the file is to be copied to/from that host.
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.
67: .Pp
68: The options are as follows:
69: .Bl -tag -width Ds
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.4 christos 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.
82: Note that this option disables the progress meter.
1.1 christos 83: .It Fl 4
84: Forces
85: .Nm
86: to use IPv4 addresses only.
87: .It Fl 6
88: Forces
89: .Nm
90: to use IPv6 addresses only.
91: .It Fl B
92: Selects batch mode (prevents asking for passwords or passphrases).
93: .It Fl C
94: Compression enable.
95: Passes the
96: .Fl C
97: flag to
98: .Xr ssh 1
99: to enable compression.
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 .
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 .
110: .It Fl i Ar identity_file
111: Selects the file from which the identity (private key) for public key
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
1.8 christos 133: .It CanonicalDomains
134: .It CanonicalizeFallbackLocal
135: .It CanonicalizeHostname
136: .It CanonicalizeMaxDots
137: .It CanonicalizePermittedCNAMEs
1.11 christos 138: .It CertificateFile
1.1 christos 139: .It ChallengeResponseAuthentication
140: .It CheckHostIP
141: .It Cipher
142: .It Ciphers
143: .It Compression
144: .It CompressionLevel
145: .It ConnectionAttempts
146: .It ConnectTimeout
147: .It ControlMaster
148: .It ControlPath
1.5 christos 149: .It ControlPersist
1.1 christos 150: .It GlobalKnownHostsFile
151: .It GSSAPIAuthentication
152: .It GSSAPIDelegateCredentials
153: .It HashKnownHosts
154: .It Host
155: .It HostbasedAuthentication
1.9 christos 156: .It HostbasedKeyTypes
1.1 christos 157: .It HostKeyAlgorithms
158: .It HostKeyAlias
159: .It HostName
1.12 ! christos 160: .It IdentitiesOnly
! 161: .It IdentityAgent
1.1 christos 162: .It IdentityFile
1.4 christos 163: .It IPQoS
1.5 christos 164: .It KbdInteractiveAuthentication
1.1 christos 165: .It KbdInteractiveDevices
1.4 christos 166: .It KexAlgorithms
1.1 christos 167: .It LogLevel
168: .It MACs
169: .It NoHostAuthenticationForLocalhost
170: .It NumberOfPasswordPrompts
171: .It PasswordAuthentication
1.3 adam 172: .It PKCS11Provider
1.1 christos 173: .It Port
174: .It PreferredAuthentications
175: .It Protocol
176: .It ProxyCommand
1.12 ! christos 177: .It ProxyJump
1.10 christos 178: .It PubkeyAcceptedKeyTypes
1.1 christos 179: .It PubkeyAuthentication
180: .It RekeyLimit
181: .It RhostsRSAAuthentication
182: .It RSAAuthentication
183: .It SendEnv
184: .It ServerAliveInterval
185: .It ServerAliveCountMax
186: .It StrictHostKeyChecking
187: .It TCPKeepAlive
1.9 christos 188: .It UpdateHostKeys
1.1 christos 189: .It UsePrivilegedPort
190: .It User
191: .It UserKnownHostsFile
192: .It VerifyHostKeyDNS
193: .El
194: .It Fl P Ar port
195: Specifies the port to connect to on the remote host.
196: Note that this option is written with a capital
197: .Sq P ,
198: because
199: .Fl p
1.8 christos 200: is already reserved for preserving the times and modes of the file.
1.1 christos 201: .It Fl p
202: Preserves modification times, access times, and modes from the
203: original file.
204: .It Fl q
205: Quiet mode: disables the progress meter as well as warning and diagnostic
206: messages from
207: .Xr ssh 1 .
208: .It Fl r
209: Recursively copy entire directories.
210: Note that
211: .Nm
212: follows symbolic links encountered in the tree traversal.
213: .It Fl S Ar program
214: Name of
215: .Ar program
216: to use for the encrypted connection.
217: The program must understand
218: .Xr ssh 1
219: options.
220: .It Fl v
221: Verbose mode.
222: Causes
223: .Nm
224: and
225: .Xr ssh 1
226: to print debugging messages about their progress.
227: This is helpful in
228: debugging connection, authentication, and configuration problems.
229: .El
1.4 christos 230: .Sh EXIT STATUS
1.1 christos 231: .Ex -std scp
232: .Sh SEE ALSO
233: .Xr sftp 1 ,
234: .Xr ssh 1 ,
235: .Xr ssh-add 1 ,
236: .Xr ssh-agent 1 ,
237: .Xr ssh-keygen 1 ,
238: .Xr ssh_config 5 ,
239: .Xr sshd 8
240: .Sh HISTORY
241: .Nm
1.8 christos 242: is based on the rcp program in
243: .Bx
244: source code from the Regents of the University of California.
1.1 christos 245: .Sh AUTHORS
1.6 wiz 246: .An Timo Rinne Aq Mt tri@iki.fi
247: .An Tatu Ylonen Aq Mt ylo@cs.hut.fi
CVSweb <webmaster@jp.NetBSD.org>