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