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