Annotation of src/crypto/external/bsd/openssh/dist/scp.1, Revision 1.17
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.17 ! christos 13: .\" $OpenBSD: scp.1,v 1.80 2018/07/19 10:28:47 dtucker Exp $
1.1 christos 14: .\"
1.17 ! christos 15: .Dd July 19 2018
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
1.15 christos 23: .Op Fl 346BCpqrv
1.1 christos 24: .Op Fl c Ar cipher
25: .Op Fl F Ar ssh_config
26: .Op Fl i Ar identity_file
27: .Op Fl l Ar limit
28: .Op Fl o Ar ssh_option
29: .Op Fl P Ar port
30: .Op Fl S Ar program
1.16 christos 31: .Ar source ... target
1.1 christos 32: .Sh DESCRIPTION
33: .Nm
34: copies files between hosts on a network.
35: It uses
36: .Xr ssh 1
37: for data transfer, and uses the same authentication and provides the
38: same security as
39: .Xr ssh 1 .
40: .Nm
41: will ask for passwords or passphrases if they are needed for
42: authentication.
43: .Pp
1.16 christos 44: The
45: .Ar source
46: and
47: .Ar target
48: may be specified as a local pathname, a remote host with optional path
49: in the form
50: .Sm off
51: .Oo user @ Oc host : Op path ,
52: .Sm on
53: or a URI in the form
54: .Sm off
55: .No scp:// Oo user @ Oc host Oo : port Oc Op / path .
56: .Sm on
1.1 christos 57: Local file names can be made explicit using absolute or relative pathnames
58: to avoid
59: .Nm
60: treating file names containing
61: .Sq :\&
62: as host specifiers.
1.16 christos 63: .Pp
64: When copying between two remote hosts, if the URI format is used, a
65: .Ar port
66: may only be specified on the
67: .Ar target
68: if the
69: .Fl 3
70: option is used.
1.1 christos 71: .Pp
72: The options are as follows:
73: .Bl -tag -width Ds
1.4 christos 74: .It Fl 3
75: Copies between two remote hosts are transferred through the local host.
76: Without this option the data is copied directly between the two remote
77: hosts.
78: Note that this option disables the progress meter.
1.1 christos 79: .It Fl 4
80: Forces
81: .Nm
82: to use IPv4 addresses only.
83: .It Fl 6
84: Forces
85: .Nm
86: to use IPv6 addresses only.
87: .It Fl B
88: Selects batch mode (prevents asking for passwords or passphrases).
89: .It Fl C
90: Compression enable.
91: Passes the
92: .Fl C
93: flag to
94: .Xr ssh 1
95: to enable compression.
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 .
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 .
106: .It Fl i Ar identity_file
107: Selects the file from which the identity (private key) for public key
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
1.16 christos 129: .It BindInterface
1.8 christos 130: .It CanonicalDomains
131: .It CanonicalizeFallbackLocal
132: .It CanonicalizeHostname
133: .It CanonicalizeMaxDots
134: .It CanonicalizePermittedCNAMEs
1.11 christos 135: .It CertificateFile
1.1 christos 136: .It ChallengeResponseAuthentication
137: .It CheckHostIP
138: .It Ciphers
139: .It Compression
140: .It ConnectionAttempts
141: .It ConnectTimeout
142: .It ControlMaster
143: .It ControlPath
1.5 christos 144: .It ControlPersist
1.1 christos 145: .It GlobalKnownHostsFile
146: .It GSSAPIAuthentication
147: .It GSSAPIDelegateCredentials
148: .It HashKnownHosts
149: .It Host
150: .It HostbasedAuthentication
1.9 christos 151: .It HostbasedKeyTypes
1.1 christos 152: .It HostKeyAlgorithms
153: .It HostKeyAlias
154: .It HostName
1.12 christos 155: .It IdentitiesOnly
156: .It IdentityAgent
1.1 christos 157: .It IdentityFile
1.4 christos 158: .It IPQoS
1.5 christos 159: .It KbdInteractiveAuthentication
1.1 christos 160: .It KbdInteractiveDevices
1.4 christos 161: .It KexAlgorithms
1.1 christos 162: .It LogLevel
163: .It MACs
164: .It NoHostAuthenticationForLocalhost
165: .It NumberOfPasswordPrompts
166: .It PasswordAuthentication
1.3 adam 167: .It PKCS11Provider
1.1 christos 168: .It Port
169: .It PreferredAuthentications
170: .It ProxyCommand
1.12 christos 171: .It ProxyJump
1.10 christos 172: .It PubkeyAcceptedKeyTypes
1.1 christos 173: .It PubkeyAuthentication
174: .It RekeyLimit
175: .It SendEnv
176: .It ServerAliveInterval
177: .It ServerAliveCountMax
1.17 ! christos 178: .It SetEnv
1.1 christos 179: .It StrictHostKeyChecking
180: .It TCPKeepAlive
1.9 christos 181: .It UpdateHostKeys
1.1 christos 182: .It User
183: .It UserKnownHostsFile
184: .It VerifyHostKeyDNS
185: .El
186: .It Fl P Ar port
187: Specifies the port to connect to on the remote host.
188: Note that this option is written with a capital
189: .Sq P ,
190: because
191: .Fl p
1.8 christos 192: is already reserved for preserving the times and modes of the file.
1.1 christos 193: .It Fl p
194: Preserves modification times, access times, and modes from the
195: original file.
196: .It Fl q
197: Quiet mode: disables the progress meter as well as warning and diagnostic
198: messages from
199: .Xr ssh 1 .
200: .It Fl r
201: Recursively copy entire directories.
202: Note that
203: .Nm
204: follows symbolic links encountered in the tree traversal.
205: .It Fl S Ar program
206: Name of
207: .Ar program
208: to use for the encrypted connection.
209: The program must understand
210: .Xr ssh 1
211: options.
212: .It Fl v
213: Verbose mode.
214: Causes
215: .Nm
216: and
217: .Xr ssh 1
218: to print debugging messages about their progress.
219: This is helpful in
220: debugging connection, authentication, and configuration problems.
221: .El
1.4 christos 222: .Sh EXIT STATUS
1.1 christos 223: .Ex -std scp
224: .Sh SEE ALSO
225: .Xr sftp 1 ,
226: .Xr ssh 1 ,
227: .Xr ssh-add 1 ,
228: .Xr ssh-agent 1 ,
229: .Xr ssh-keygen 1 ,
230: .Xr ssh_config 5 ,
231: .Xr sshd 8
232: .Sh HISTORY
233: .Nm
1.8 christos 234: is based on the rcp program in
235: .Bx
236: source code from the Regents of the University of California.
1.1 christos 237: .Sh AUTHORS
1.6 wiz 238: .An Timo Rinne Aq Mt tri@iki.fi
239: .An Tatu Ylonen Aq Mt ylo@cs.hut.fi
CVSweb <webmaster@jp.NetBSD.org>