Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 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 | .\" |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 12 | .\" $OpenBSD: scp.1,v 1.27 2003/03/28 10:11:43 jmc Exp $ |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 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 |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 22 | .Bk -words |
Damien Miller | 8e12147 | 2003-01-24 11:37:38 +1100 | [diff] [blame] | 23 | .Op Fl pqrvBC1246 |
Ben Lindstrom | 1e24324 | 2001-09-18 05:38:44 +0000 | [diff] [blame] | 24 | .Op Fl F Ar ssh_config |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 25 | .Op Fl S Ar program |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 26 | .Op Fl P Ar port |
| 27 | .Op Fl c Ar cipher |
| 28 | .Op Fl i Ar identity_file |
Damien Miller | 8ee66a2 | 2003-02-24 11:50:50 +1100 | [diff] [blame] | 29 | .Op Fl l Ar limit |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 30 | .Op Fl o Ar ssh_option |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 31 | .Sm off |
| 32 | .Oo |
| 33 | .Op Ar user@ |
| 34 | .Ar host1 No : |
| 35 | .Oc Ns Ar file1 |
| 36 | .Sm on |
| 37 | .Op Ar ... |
| 38 | .Sm off |
| 39 | .Oo |
| 40 | .Op Ar user@ |
| 41 | .Ar host2 No : |
| 42 | .Oc Ar file2 |
| 43 | .Sm on |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 44 | .Ek |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 45 | .Sh DESCRIPTION |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 46 | .Nm |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 47 | copies files between hosts on a network. |
| 48 | It uses |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 49 | .Xr ssh 1 |
| 50 | for data transfer, and uses the same authentication and provides the |
| 51 | same security as |
| 52 | .Xr ssh 1 . |
| 53 | Unlike |
| 54 | .Xr rcp 1 , |
| 55 | .Nm |
| 56 | will ask for passwords or passphrases if they are needed for |
| 57 | authentication. |
| 58 | .Pp |
| 59 | Any file name may contain a host and user specification to indicate |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 60 | that the file is to be copied to/from that host. |
| 61 | Copies between two remote hosts are permitted. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 62 | .Pp |
| 63 | The options are as follows: |
| 64 | .Bl -tag -width Ds |
| 65 | .It Fl c Ar cipher |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 66 | Selects the cipher to use for encrypting the data transfer. |
| 67 | This option is directly passed to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 68 | .Xr ssh 1 . |
| 69 | .It Fl i Ar identity_file |
| 70 | Selects the file from which the identity (private key) for RSA |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 71 | authentication is read. |
| 72 | This option is directly passed to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 73 | .Xr ssh 1 . |
Damien Miller | 8ee66a2 | 2003-02-24 11:50:50 +1100 | [diff] [blame] | 74 | .It Fl l Ar limit |
| 75 | Limits the used bandwidth, specified in Kbit/s. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 76 | .It Fl p |
| 77 | Preserves modification times, access times, and modes from the |
| 78 | original file. |
| 79 | .It Fl r |
| 80 | Recursively copy entire directories. |
| 81 | .It Fl v |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 82 | Verbose mode. |
| 83 | Causes |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 84 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 85 | and |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 86 | .Xr ssh 1 |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 87 | to print debugging messages about their progress. |
| 88 | This is helpful in |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 89 | debugging connection, authentication, and configuration problems. |
| 90 | .It Fl B |
| 91 | Selects batch mode (prevents asking for passwords or passphrases). |
| 92 | .It Fl q |
| 93 | Disables the progress meter. |
| 94 | .It Fl C |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 95 | Compression enable. |
| 96 | Passes the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 97 | .Fl C |
| 98 | flag to |
| 99 | .Xr ssh 1 |
| 100 | to enable compression. |
Ben Lindstrom | 1e24324 | 2001-09-18 05:38:44 +0000 | [diff] [blame] | 101 | .It Fl F Ar ssh_config |
| 102 | Specifies an alternative |
| 103 | per-user configuration file for |
| 104 | .Nm ssh . |
| 105 | This option is directly passed to |
| 106 | .Xr ssh 1 . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 107 | .It Fl P Ar port |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 108 | Specifies the port to connect to on the remote host. |
| 109 | Note that this option is written with a capital |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 110 | .Sq P , |
| 111 | because |
| 112 | .Fl p |
| 113 | is already reserved for preserving the times and modes of the file in |
| 114 | .Xr rcp 1 . |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 115 | .It Fl S Ar program |
| 116 | Name of |
| 117 | .Ar program |
Damien Miller | 874d77b | 2000-10-14 16:23:11 +1100 | [diff] [blame] | 118 | to use for the encrypted connection. |
| 119 | The program must understand |
Damien Miller | ad833b3 | 2000-08-23 10:46:23 +1000 | [diff] [blame] | 120 | .Xr ssh 1 |
| 121 | options. |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 122 | .It Fl o Ar ssh_option |
| 123 | Can be used to pass options to |
| 124 | .Nm ssh |
Ben Lindstrom | 3072aae | 2002-06-21 01:02:39 +0000 | [diff] [blame] | 125 | in the format used in |
| 126 | .Xr ssh_config 5 . |
| 127 | This is useful for specifying options |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 128 | for which there is no separate |
| 129 | .Nm scp |
Damien Miller | 2eb26e8 | 2003-02-24 11:51:32 +1100 | [diff] [blame] | 130 | command-line flag. |
Damien Miller | 8e12147 | 2003-01-24 11:37:38 +1100 | [diff] [blame] | 131 | .It Fl 1 |
| 132 | Forces |
| 133 | .Nm |
| 134 | to use protocol 1. |
| 135 | .It Fl 2 |
| 136 | Forces |
| 137 | .Nm |
| 138 | to use protocol 2. |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 139 | .It Fl 4 |
| 140 | Forces |
| 141 | .Nm |
| 142 | to use IPv4 addresses only. |
| 143 | .It Fl 6 |
| 144 | Forces |
| 145 | .Nm |
| 146 | to use IPv6 addresses only. |
Damien Miller | 3702396 | 2000-07-11 17:31:38 +1000 | [diff] [blame] | 147 | .El |
Damien Miller | 07a2d42 | 2002-02-05 12:16:15 +1100 | [diff] [blame] | 148 | .Sh DIAGNOSTICS |
| 149 | .Nm |
| 150 | exits with 0 on success or >0 if an error occurred. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 151 | .Sh AUTHORS |
| 152 | Timo Rinne <tri@iki.fi> and Tatu Ylonen <ylo@cs.hut.fi> |
| 153 | .Sh HISTORY |
| 154 | .Nm |
| 155 | is based on the |
| 156 | .Xr rcp 1 |
| 157 | program in BSD source code from the Regents of the University of |
| 158 | California. |
| 159 | .Sh SEE ALSO |
| 160 | .Xr rcp 1 , |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 161 | .Xr sftp 1 , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 162 | .Xr ssh 1 , |
| 163 | .Xr ssh-add 1 , |
| 164 | .Xr ssh-agent 1 , |
| 165 | .Xr ssh-keygen 1 , |
Ben Lindstrom | c06bf70 | 2002-06-23 00:34:37 +0000 | [diff] [blame] | 166 | .Xr ssh_config 5 , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 167 | .Xr sshd 8 |