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