xref: /freebsd/crypto/openssh/scp.1 (revision a79b71281cd63ad7a6cc43a6d5673a2510b51630)
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.\" $Id: scp.1,v 1.7 2000/04/12 21:47:50 aaron 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.Op Fl pqrvC46
23.Op Fl P Ar port
24.Op Fl c Ar cipher
25.Op Fl i Ar identity_file
26.Sm off
27.Oo
28.Op Ar user@
29.Ar host1 No :
30.Oc Ns Ar file1
31.Sm on
32.Op Ar ...
33.Sm off
34.Oo
35.Op Ar user@
36.Ar host2 No :
37.Oc Ar file2
38.Sm on
39.Sh DESCRIPTION
40.Nm
41copies files between hosts on a network.
42It uses
43.Xr ssh 1
44for data transfer, and uses the same authentication and provides the
45same security as
46.Xr ssh 1 .
47Unlike
48.Xr rcp 1 ,
49.Nm
50will ask for passwords or passphrases if they are needed for
51authentication.
52.Pp
53Any file name may contain a host and user specification to indicate
54that the file is to be copied to/from that host.
55Copies between two remote hosts are permitted.
56.Pp
57The options are as follows:
58.Bl -tag -width Ds
59.It Fl c Ar cipher
60Selects the cipher to use for encrypting the data transfer.
61This option is directly passed to
62.Xr ssh 1 .
63.It Fl i Ar identity_file
64Selects the file from which the identity (private key) for RSA
65authentication is read.
66This option is directly passed to
67.Xr ssh 1 .
68.It Fl p
69Preserves modification times, access times, and modes from the
70original file.
71.It Fl r
72Recursively copy entire directories.
73.It Fl v
74Verbose mode.
75Causes
76.Nm
77and
78.Xr ssh 1
79to print debugging messages about their progress.
80This is helpful in
81debugging connection, authentication, and configuration problems.
82.It Fl B
83Selects batch mode (prevents asking for passwords or passphrases).
84.It Fl q
85Disables the progress meter.
86.It Fl C
87Compression enable.
88Passes the
89.Fl C
90flag to
91.Xr ssh 1
92to enable compression.
93.It Fl P Ar port
94Specifies the port to connect to on the remote host.
95Note that this option is written with a capital
96.Sq P ,
97because
98.Fl p
99is already reserved for preserving the times and modes of the file in
100.Xr rcp 1 .
101.It Fl 4
102Forces
103.Nm
104to use IPv4 addresses only.
105.It Fl 6
106Forces
107.Nm
108to use IPv6 addresses only.
109.Sh AUTHORS
110Timo Rinne <tri@iki.fi> and Tatu Ylonen <ylo@cs.hut.fi>
111.Sh HISTORY
112.Nm
113is based on the
114.Xr rcp 1
115program in BSD source code from the Regents of the University of
116California.
117.Sh SEE ALSO
118.Xr rcp 1 ,
119.Xr ssh 1 ,
120.Xr ssh-add 1 ,
121.Xr ssh-agent 1 ,
122.Xr ssh-keygen 1 ,
123.Xr sshd 8
124