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