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