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