| 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 | .\" |
|---|
| 12 | .\" $OpenBSD: scp.1,v 1.23 2002/06/22 16:41:57 stevesk Exp $ |
|---|
| 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 |
|---|
| 22 | .Op Fl pqrvBC46 |
|---|
| 23 | .Op Fl F Ar ssh_config |
|---|
| 24 | .Op Fl S Ar program |
|---|
| 25 | .Op Fl P Ar port |
|---|
| 26 | .Op Fl c Ar cipher |
|---|
| 27 | .Op Fl i Ar identity_file |
|---|
| 28 | .Op Fl o Ar ssh_option |
|---|
| 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 |
|---|
| 42 | .Sh DESCRIPTION |
|---|
| 43 | .Nm |
|---|
| 44 | copies files between hosts on a network. |
|---|
| 45 | It uses |
|---|
| 46 | .Xr ssh 1 |
|---|
| 47 | for data transfer, and uses the same authentication and provides the |
|---|
| 48 | same security as |
|---|
| 49 | .Xr ssh 1 . |
|---|
| 50 | Unlike |
|---|
| 51 | .Xr rcp 1 , |
|---|
| 52 | .Nm |
|---|
| 53 | will ask for passwords or passphrases if they are needed for |
|---|
| 54 | authentication. |
|---|
| 55 | .Pp |
|---|
| 56 | Any file name may contain a host and user specification to indicate |
|---|
| 57 | that the file is to be copied to/from that host. |
|---|
| 58 | Copies between two remote hosts are permitted. |
|---|
| 59 | .Pp |
|---|
| 60 | The options are as follows: |
|---|
| 61 | .Bl -tag -width Ds |
|---|
| 62 | .It Fl c Ar cipher |
|---|
| 63 | Selects the cipher to use for encrypting the data transfer. |
|---|
| 64 | This option is directly passed to |
|---|
| 65 | .Xr ssh 1 . |
|---|
| 66 | .It Fl i Ar identity_file |
|---|
| 67 | Selects the file from which the identity (private key) for RSA |
|---|
| 68 | authentication is read. |
|---|
| 69 | This option is directly passed to |
|---|
| 70 | .Xr ssh 1 . |
|---|
| 71 | .It Fl p |
|---|
| 72 | Preserves modification times, access times, and modes from the |
|---|
| 73 | original file. |
|---|
| 74 | .It Fl r |
|---|
| 75 | Recursively copy entire directories. |
|---|
| 76 | .It Fl v |
|---|
| 77 | Verbose mode. |
|---|
| 78 | Causes |
|---|
| 79 | .Nm |
|---|
| 80 | and |
|---|
| 81 | .Xr ssh 1 |
|---|
| 82 | to print debugging messages about their progress. |
|---|
| 83 | This is helpful in |
|---|
| 84 | debugging connection, authentication, and configuration problems. |
|---|
| 85 | .It Fl B |
|---|
| 86 | Selects batch mode (prevents asking for passwords or passphrases). |
|---|
| 87 | .It Fl q |
|---|
| 88 | Disables the progress meter. |
|---|
| 89 | .It Fl C |
|---|
| 90 | Compression enable. |
|---|
| 91 | Passes the |
|---|
| 92 | .Fl C |
|---|
| 93 | flag to |
|---|
| 94 | .Xr ssh 1 |
|---|
| 95 | to enable compression. |
|---|
| 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 . |
|---|
| 102 | .It Fl P Ar port |
|---|
| 103 | Specifies the port to connect to on the remote host. |
|---|
| 104 | Note that this option is written with a capital |
|---|
| 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 . |
|---|
| 110 | .It Fl S Ar program |
|---|
| 111 | Name of |
|---|
| 112 | .Ar program |
|---|
| 113 | to use for the encrypted connection. |
|---|
| 114 | The program must understand |
|---|
| 115 | .Xr ssh 1 |
|---|
| 116 | options. |
|---|
| 117 | .It Fl o Ar ssh_option |
|---|
| 118 | Can be used to pass options to |
|---|
| 119 | .Nm ssh |
|---|
| 120 | in the format used in |
|---|
| 121 | .Xr ssh_config 5 . |
|---|
| 122 | This is useful for specifying options |
|---|
| 123 | for which there is no separate |
|---|
| 124 | .Nm scp |
|---|
| 125 | command-line flag. For example, forcing the use of protocol |
|---|
| 126 | version 1 is specified using |
|---|
| 127 | .Ic scp -oProtocol=1 . |
|---|
| 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. |
|---|
| 136 | .El |
|---|
| 137 | .Sh DIAGNOSTICS |
|---|
| 138 | .Nm |
|---|
| 139 | exits with 0 on success or >0 if an error occurred. |
|---|
| 140 | .Sh AUTHORS |
|---|
| 141 | Timo Rinne <tri@iki.fi> and Tatu Ylonen <ylo@cs.hut.fi> |
|---|
| 142 | .Sh HISTORY |
|---|
| 143 | .Nm |
|---|
| 144 | is based on the |
|---|
| 145 | .Xr rcp 1 |
|---|
| 146 | program in BSD source code from the Regents of the University of |
|---|
| 147 | California. |
|---|
| 148 | .Sh SEE ALSO |
|---|
| 149 | .Xr rcp 1 , |
|---|
| 150 | .Xr sftp 1 , |
|---|
| 151 | .Xr ssh 1 , |
|---|
| 152 | .Xr ssh-add 1 , |
|---|
| 153 | .Xr ssh-agent 1 , |
|---|
| 154 | .Xr ssh-keygen 1 , |
|---|
| 155 | .Xr ssh_config 5 , |
|---|
| 156 | .Xr sshd 8 |
|---|
