blob: 3f309fe0329c8f245fc2cade4e1cb3cd401b5eed [file] [log] [blame]
Adam Langleyd0592972015-03-30 14:49:51 -07001SCP(1) General Commands Manual SCP(1)
Greg Hartmanbd77cf72015-02-25 13:21:06 -08002
3NAME
Adam Langleyd0592972015-03-30 14:49:51 -07004 scp M-bM-^@M-^S secure copy (remote file copy program)
Greg Hartmanbd77cf72015-02-25 13:21:06 -08005
6SYNOPSIS
7 scp [-12346BCpqrv] [-c cipher] [-F ssh_config] [-i identity_file]
8 [-l limit] [-o ssh_option] [-P port] [-S program]
9 [[user@]host1:]file1 ... [[user@]host2:]file2
10
11DESCRIPTION
12 scp copies files between hosts on a network. It uses ssh(1) for data
13 transfer, and uses the same authentication and provides the same security
Adam Langleyd0592972015-03-30 14:49:51 -070014 as ssh(1). scp will ask for passwords or passphrases if they are needed
15 for authentication.
Greg Hartmanbd77cf72015-02-25 13:21:06 -080016
17 File names may contain a user and host specification to indicate that the
18 file is to be copied to/from that host. Local file names can be made
19 explicit using absolute or relative pathnames to avoid scp treating file
Adam Langleyd0592972015-03-30 14:49:51 -070020 names containing M-bM-^@M-^X:M-bM-^@M-^Y as host specifiers. Copies between two remote hosts
Greg Hartmanbd77cf72015-02-25 13:21:06 -080021 are also permitted.
22
23 The options are as follows:
24
25 -1 Forces scp to use protocol 1.
26
27 -2 Forces scp to use protocol 2.
28
29 -3 Copies between two remote hosts are transferred through the local
30 host. Without this option the data is copied directly between
31 the two remote hosts. Note that this option disables the
32 progress meter.
33
34 -4 Forces scp to use IPv4 addresses only.
35
36 -6 Forces scp to use IPv6 addresses only.
37
38 -B Selects batch mode (prevents asking for passwords or
39 passphrases).
40
41 -C Compression enable. Passes the -C flag to ssh(1) to enable
42 compression.
43
44 -c cipher
45 Selects the cipher to use for encrypting the data transfer. This
46 option is directly passed to ssh(1).
47
48 -F ssh_config
49 Specifies an alternative per-user configuration file for ssh.
50 This option is directly passed to ssh(1).
51
52 -i identity_file
53 Selects the file from which the identity (private key) for public
54 key authentication is read. This option is directly passed to
55 ssh(1).
56
57 -l limit
58 Limits the used bandwidth, specified in Kbit/s.
59
60 -o ssh_option
61 Can be used to pass options to ssh in the format used in
62 ssh_config(5). This is useful for specifying options for which
63 there is no separate scp command-line flag. For full details of
64 the options listed below, and their possible values, see
65 ssh_config(5).
66
67 AddressFamily
68 BatchMode
69 BindAddress
Adam Langleyd0592972015-03-30 14:49:51 -070070 CanonicalDomains
71 CanonicalizeFallbackLocal
72 CanonicalizeHostname
73 CanonicalizeMaxDots
74 CanonicalizePermittedCNAMEs
Greg Hartmanbd77cf72015-02-25 13:21:06 -080075 ChallengeResponseAuthentication
76 CheckHostIP
77 Cipher
78 Ciphers
79 Compression
80 CompressionLevel
81 ConnectionAttempts
82 ConnectTimeout
83 ControlMaster
84 ControlPath
Adam Langleyd0592972015-03-30 14:49:51 -070085 ControlPersist
Greg Hartmanbd77cf72015-02-25 13:21:06 -080086 GlobalKnownHostsFile
87 GSSAPIAuthentication
88 GSSAPIDelegateCredentials
89 HashKnownHosts
90 Host
91 HostbasedAuthentication
Adam Langleyd0592972015-03-30 14:49:51 -070092 HostbasedKeyTypes
Greg Hartmanbd77cf72015-02-25 13:21:06 -080093 HostKeyAlgorithms
94 HostKeyAlias
95 HostName
96 IdentityFile
97 IdentitiesOnly
98 IPQoS
Adam Langleyd0592972015-03-30 14:49:51 -070099 KbdInteractiveAuthentication
Greg Hartmanbd77cf72015-02-25 13:21:06 -0800100 KbdInteractiveDevices
101 KexAlgorithms
102 LogLevel
103 MACs
104 NoHostAuthenticationForLocalhost
105 NumberOfPasswordPrompts
106 PasswordAuthentication
107 PKCS11Provider
108 Port
109 PreferredAuthentications
110 Protocol
111 ProxyCommand
112 PubkeyAuthentication
113 RekeyLimit
114 RhostsRSAAuthentication
115 RSAAuthentication
116 SendEnv
117 ServerAliveInterval
118 ServerAliveCountMax
119 StrictHostKeyChecking
120 TCPKeepAlive
Adam Langleyd0592972015-03-30 14:49:51 -0700121 UpdateHostKeys
Greg Hartmanbd77cf72015-02-25 13:21:06 -0800122 UsePrivilegedPort
123 User
124 UserKnownHostsFile
125 VerifyHostKeyDNS
126
127 -P port
128 Specifies the port to connect to on the remote host. Note that
Adam Langleyd0592972015-03-30 14:49:51 -0700129 this option is written with a capital M-bM-^@M-^XPM-bM-^@M-^Y, because -p is already
130 reserved for preserving the times and modes of the file.
Greg Hartmanbd77cf72015-02-25 13:21:06 -0800131
132 -p Preserves modification times, access times, and modes from the
133 original file.
134
135 -q Quiet mode: disables the progress meter as well as warning and
136 diagnostic messages from ssh(1).
137
138 -r Recursively copy entire directories. Note that scp follows
139 symbolic links encountered in the tree traversal.
140
141 -S program
142 Name of program to use for the encrypted connection. The program
143 must understand ssh(1) options.
144
145 -v Verbose mode. Causes scp and ssh(1) to print debugging messages
146 about their progress. This is helpful in debugging connection,
147 authentication, and configuration problems.
148
149EXIT STATUS
Adam Langleyd0592972015-03-30 14:49:51 -0700150 The scp utility exitsM-BM- 0 on success, andM-BM- >0 if an error occurs.
Greg Hartmanbd77cf72015-02-25 13:21:06 -0800151
152SEE ALSO
Adam Langleyd0592972015-03-30 14:49:51 -0700153 sftp(1), ssh(1), ssh-add(1), ssh-agent(1), ssh-keygen(1), ssh_config(5),
154 sshd(8)
Greg Hartmanbd77cf72015-02-25 13:21:06 -0800155
156HISTORY
Adam Langleyd0592972015-03-30 14:49:51 -0700157 scp is based on the rcp program in BSD source code from the Regents of
Greg Hartmanbd77cf72015-02-25 13:21:06 -0800158 the University of California.
159
160AUTHORS
161 Timo Rinne <tri@iki.fi>
162 Tatu Ylonen <ylo@cs.hut.fi>
163
Adam Langleyd0592972015-03-30 14:49:51 -0700164OpenBSD 5.7 January 30, 2015 OpenBSD 5.7