blob: a0e699ba7954a160cf546bdc7d9b7afd3d8de360 [file] [log] [blame]
Damien Miller32aa1441999-10-29 09:15:49 +10001.\" -*- 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.\"
Damien Miller34132e52000-01-14 15:45:46 +110012.\" $Id: scp.1.in,v 1.2 2000/01/14 04:45:51 damien Exp $
Damien Miller32aa1441999-10-29 09:15:49 +100013.\"
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
Damien Miller34132e52000-01-14 15:45:46 +110022.Op Fl pqrvC46
Damien Miller32aa1441999-10-29 09:15:49 +100023.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. It uses
42.Xr ssh 1
43for data transfer, and uses the same authentication and provides the
44same security as
45.Xr ssh 1 .
46Unlike
47.Xr rcp 1 ,
48.Nm
49will ask for passwords or passphrases if they are needed for
50authentication.
51.Pp
52Any file name may contain a host and user specification to indicate
53that the file is to be copied to/from that host. Copies between two
54remote hosts are permitted.
55.Pp
56The options are as follows:
57.Bl -tag -width Ds
58.It Fl c Ar cipher
59Selects the cipher to use for encrypting the data transfer. This
60option is directly passed to
61.Xr ssh 1 .
62.It Fl i Ar identity_file
63Selects the file from which the identity (private key) for RSA
64authentication is read. This option is directly passed to
65.Xr ssh 1 .
66.It Fl p
67Preserves modification times, access times, and modes from the
68original file.
69.It Fl r
70Recursively copy entire directories.
71.It Fl v
72Verbose mode. Causes
73.Nm
74and
75.Xr ssh 1
76to print debugging messages about their progress. This is helpful in
77debugging connection, authentication, and configuration problems.
78.It Fl B
79Selects batch mode (prevents asking for passwords or passphrases).
80.It Fl q
81Disables the progress meter.
82.It Fl C
83Compression enable. Passes the
84.Fl C
85flag to
86.Xr ssh 1
87to enable compression.
88.It Fl P Ar port
89Specifies the port to connect to on the remote host. Note that this
90option is written with a capital
91.Sq P ,
92because
93.Fl p
94is already reserved for preserving the times and modes of the file in
95.Xr rcp 1 .
Damien Miller34132e52000-01-14 15:45:46 +110096.It Fl 4
97Forces
98.Nm
99to use IPv4 addresses only.
100.It Fl 6
101Forces
102.Nm
103to use IPv6 addresses only.
Damien Miller32aa1441999-10-29 09:15:49 +1000104.Sh AUTHORS
105Timo Rinne <tri@iki.fi> and Tatu Ylonen <ylo@cs.hut.fi>
106.Sh HISTORY
107.Nm
108is based on the
109.Xr rcp 1
110program in BSD source code from the Regents of the University of
111California.
112.Sh SEE ALSO
113.Xr rcp 1 ,
114.Xr ssh 1 ,
115.Xr ssh-add 1 ,
116.Xr ssh-agent 1 ,
117.Xr ssh-keygen 1 ,
118.Xr sshd 8