]>
Commit | Line | Data |
---|---|---|
bf740959 | 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 | .\" | |
00019895 | 12 | .\" $OpenBSD: scp.1,v 1.26 2003/01/28 17:24:51 stevesk Exp $ |
bf740959 | 13 | .\" |
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 | |
e6b15f23 | 22 | .Op Fl pqrvBC1246 |
f1278af7 | 23 | .Op Fl F Ar ssh_config |
b5e300c2 | 24 | .Op Fl S Ar program |
bf740959 | 25 | .Op Fl P Ar port |
26 | .Op Fl c Ar cipher | |
27 | .Op Fl i Ar identity_file | |
bd9f564f | 28 | .Op Fl l Ar limit |
38539909 | 29 | .Op Fl o Ar ssh_option |
bf740959 | 30 | .Sm off |
31 | .Oo | |
32 | .Op Ar user@ | |
33 | .Ar host1 No : | |
34 | .Oc Ns Ar file1 | |
35 | .Sm on | |
36 | .Op Ar ... | |
37 | .Sm off | |
38 | .Oo | |
39 | .Op Ar user@ | |
40 | .Ar host2 No : | |
41 | .Oc Ar file2 | |
42 | .Sm on | |
f54651ce | 43 | .Sh DESCRIPTION |
bf740959 | 44 | .Nm |
4fe2af09 | 45 | copies files between hosts on a network. |
46 | It uses | |
bf740959 | 47 | .Xr ssh 1 |
48 | for data transfer, and uses the same authentication and provides the | |
49 | same security as | |
50 | .Xr ssh 1 . | |
51 | Unlike | |
52 | .Xr rcp 1 , | |
53 | .Nm | |
54 | will ask for passwords or passphrases if they are needed for | |
55 | authentication. | |
56 | .Pp | |
57 | Any file name may contain a host and user specification to indicate | |
4fe2af09 | 58 | that the file is to be copied to/from that host. |
59 | Copies between two remote hosts are permitted. | |
bf740959 | 60 | .Pp |
61 | The options are as follows: | |
62 | .Bl -tag -width Ds | |
63 | .It Fl c Ar cipher | |
4fe2af09 | 64 | Selects the cipher to use for encrypting the data transfer. |
65 | This option is directly passed to | |
bf740959 | 66 | .Xr ssh 1 . |
67 | .It Fl i Ar identity_file | |
68 | Selects the file from which the identity (private key) for RSA | |
4fe2af09 | 69 | authentication is read. |
70 | This option is directly passed to | |
bf740959 | 71 | .Xr ssh 1 . |
bd9f564f | 72 | .It Fl l Ar limit |
73 | Limits the used bandwidth, specified in Kbit/s. | |
bf740959 | 74 | .It Fl p |
75 | Preserves modification times, access times, and modes from the | |
76 | original file. | |
77 | .It Fl r | |
78 | Recursively copy entire directories. | |
79 | .It Fl v | |
4fe2af09 | 80 | Verbose mode. |
81 | Causes | |
bf740959 | 82 | .Nm |
f54651ce | 83 | and |
bf740959 | 84 | .Xr ssh 1 |
4fe2af09 | 85 | to print debugging messages about their progress. |
86 | This is helpful in | |
bf740959 | 87 | debugging connection, authentication, and configuration problems. |
88 | .It Fl B | |
89 | Selects batch mode (prevents asking for passwords or passphrases). | |
90 | .It Fl q | |
91 | Disables the progress meter. | |
92 | .It Fl C | |
4fe2af09 | 93 | Compression enable. |
94 | Passes the | |
bf740959 | 95 | .Fl C |
96 | flag to | |
97 | .Xr ssh 1 | |
98 | to enable compression. | |
f1278af7 | 99 | .It Fl F Ar ssh_config |
100 | Specifies an alternative | |
101 | per-user configuration file for | |
102 | .Nm ssh . | |
103 | This option is directly passed to | |
104 | .Xr ssh 1 . | |
bf740959 | 105 | .It Fl P Ar port |
4fe2af09 | 106 | Specifies the port to connect to on the remote host. |
107 | Note that this option is written with a capital | |
bf740959 | 108 | .Sq P , |
109 | because | |
110 | .Fl p | |
111 | is already reserved for preserving the times and modes of the file in | |
112 | .Xr rcp 1 . | |
b5e300c2 | 113 | .It Fl S Ar program |
114 | Name of | |
115 | .Ar program | |
94ec8c6b | 116 | to use for the encrypted connection. |
117 | The program must understand | |
2e73a022 | 118 | .Xr ssh 1 |
119 | options. | |
38539909 | 120 | .It Fl o Ar ssh_option |
121 | Can be used to pass options to | |
122 | .Nm ssh | |
c21a7c4a | 123 | in the format used in |
124 | .Xr ssh_config 5 . | |
125 | This is useful for specifying options | |
38539909 | 126 | for which there is no separate |
127 | .Nm scp | |
00019895 | 128 | command-line flag. |
e6b15f23 | 129 | .It Fl 1 |
130 | Forces | |
131 | .Nm | |
132 | to use protocol 1. | |
133 | .It Fl 2 | |
134 | Forces | |
135 | .Nm | |
136 | to use protocol 2. | |
48e671d5 | 137 | .It Fl 4 |
138 | Forces | |
139 | .Nm | |
140 | to use IPv4 addresses only. | |
141 | .It Fl 6 | |
142 | Forces | |
143 | .Nm | |
144 | to use IPv6 addresses only. | |
089fbbd2 | 145 | .El |
16210ef7 | 146 | .Sh DIAGNOSTICS |
147 | .Nm | |
148 | exits with 0 on success or >0 if an error occurred. | |
bf740959 | 149 | .Sh AUTHORS |
150 | Timo Rinne <tri@iki.fi> and Tatu Ylonen <ylo@cs.hut.fi> | |
151 | .Sh HISTORY | |
152 | .Nm | |
153 | is based on the | |
154 | .Xr rcp 1 | |
155 | program in BSD source code from the Regents of the University of | |
156 | California. | |
157 | .Sh SEE ALSO | |
158 | .Xr rcp 1 , | |
61e96248 | 159 | .Xr sftp 1 , |
bf740959 | 160 | .Xr ssh 1 , |
161 | .Xr ssh-add 1 , | |
162 | .Xr ssh-agent 1 , | |
163 | .Xr ssh-keygen 1 , | |
e4e83d70 | 164 | .Xr ssh_config 5 , |
bf740959 | 165 | .Xr sshd 8 |