| .\" -*- nroff -*- |
| .\" |
| .\" scp.1 |
| .\" |
| .\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
| .\" |
| .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| .\" All rights reserved |
| .\" |
| .\" Created: Sun May 7 00:14:37 1995 ylo |
| .\" |
| .\" $OpenBSD: scp.1,v 1.38 2005/03/01 17:19:35 jmc Exp $ |
| .\" |
| .Dd September 25, 1999 |
| .Dt SCP 1 |
| .Os |
| .Sh NAME |
| .Nm scp |
| .Nd secure copy (remote file copy program) |
| .Sh SYNOPSIS |
| .Nm scp |
| .Bk -words |
| .Op Fl 1246BCpqrv |
| .Op Fl c Ar cipher |
| .Op Fl F Ar ssh_config |
| .Op Fl i Ar identity_file |
| .Op Fl l Ar limit |
| .Op Fl o Ar ssh_option |
| .Op Fl P Ar port |
| .Op Fl S Ar program |
| .Sm off |
| .Oo |
| .Op Ar user No @ |
| .Ar host1 No : |
| .Oc Ns Ar file1 |
| .Sm on |
| .Op Ar ... |
| .Sm off |
| .Oo |
| .Op Ar user No @ |
| .Ar host2 No : |
| .Oc Ar file2 |
| .Sm on |
| .Ek |
| .Sh DESCRIPTION |
| .Nm |
| copies files between hosts on a network. |
| It uses |
| .Xr ssh 1 |
| for data transfer, and uses the same authentication and provides the |
| same security as |
| .Xr ssh 1 . |
| Unlike |
| .Xr rcp 1 , |
| .Nm |
| will ask for passwords or passphrases if they are needed for |
| authentication. |
| .Pp |
| Any file name may contain a host and user specification to indicate |
| that the file is to be copied to/from that host. |
| Copies between two remote hosts are permitted. |
| .Pp |
| The options are as follows: |
| .Bl -tag -width Ds |
| .It Fl 1 |
| Forces |
| .Nm |
| to use protocol 1. |
| .It Fl 2 |
| Forces |
| .Nm |
| to use protocol 2. |
| .It Fl 4 |
| Forces |
| .Nm |
| to use IPv4 addresses only. |
| .It Fl 6 |
| Forces |
| .Nm |
| to use IPv6 addresses only. |
| .It Fl B |
| Selects batch mode (prevents asking for passwords or passphrases). |
| .It Fl C |
| Compression enable. |
| Passes the |
| .Fl C |
| flag to |
| .Xr ssh 1 |
| to enable compression. |
| .It Fl c Ar cipher |
| Selects the cipher to use for encrypting the data transfer. |
| This option is directly passed to |
| .Xr ssh 1 . |
| .It Fl F Ar ssh_config |
| Specifies an alternative |
| per-user configuration file for |
| .Nm ssh . |
| This option is directly passed to |
| .Xr ssh 1 . |
| .It Fl i Ar identity_file |
| Selects the file from which the identity (private key) for RSA |
| authentication is read. |
| This option is directly passed to |
| .Xr ssh 1 . |
| .It Fl l Ar limit |
| Limits the used bandwidth, specified in Kbit/s. |
| .It Fl o Ar ssh_option |
| Can be used to pass options to |
| .Nm ssh |
| in the format used in |
| .Xr ssh_config 5 . |
| This is useful for specifying options |
| for which there is no separate |
| .Nm scp |
| command-line flag. |
| For full details of the options listed below, and their possible values, see |
| .Xr ssh_config 5 . |
| .Pp |
| .Bl -tag -width Ds -offset indent -compact |
| .It AddressFamily |
| .It BatchMode |
| .It BindAddress |
| .It ChallengeResponseAuthentication |
| .It CheckHostIP |
| .It Cipher |
| .It Ciphers |
| .It Compression |
| .It CompressionLevel |
| .It ConnectionAttempts |
| .It ConnectTimeout |
| .It ControlMaster |
| .It ControlPath |
| .It GlobalKnownHostsFile |
| .It GSSAPIAuthentication |
| .It GSSAPIDelegateCredentials |
| .It HashKnownHosts |
| .It Host |
| .It HostbasedAuthentication |
| .It HostKeyAlgorithms |
| .It HostKeyAlias |
| .It HostName |
| .It IdentityFile |
| .It IdentitiesOnly |
| .It KbdInteractiveDevices |
| .It LogLevel |
| .It MACs |
| .It NoHostAuthenticationForLocalhost |
| .It NumberOfPasswordPrompts |
| .It PasswordAuthentication |
| .It Port |
| .It PreferredAuthentications |
| .It Protocol |
| .It ProxyCommand |
| .It PubkeyAuthentication |
| .It RhostsRSAAuthentication |
| .It RSAAuthentication |
| .It SendEnv |
| .It ServerAliveInterval |
| .It ServerAliveCountMax |
| .It SmartcardDevice |
| .It StrictHostKeyChecking |
| .It TCPKeepAlive |
| .It UsePrivilegedPort |
| .It User |
| .It UserKnownHostsFile |
| .It VerifyHostKeyDNS |
| .El |
| .It Fl P Ar port |
| Specifies the port to connect to on the remote host. |
| Note that this option is written with a capital |
| .Sq P , |
| because |
| .Fl p |
| is already reserved for preserving the times and modes of the file in |
| .Xr rcp 1 . |
| .It Fl p |
| Preserves modification times, access times, and modes from the |
| original file. |
| .It Fl q |
| Disables the progress meter. |
| .It Fl r |
| Recursively copy entire directories. |
| .It Fl S Ar program |
| Name of |
| .Ar program |
| to use for the encrypted connection. |
| The program must understand |
| .Xr ssh 1 |
| options. |
| .It Fl v |
| Verbose mode. |
| Causes |
| .Nm |
| and |
| .Xr ssh 1 |
| to print debugging messages about their progress. |
| This is helpful in |
| debugging connection, authentication, and configuration problems. |
| .El |
| .Sh DIAGNOSTICS |
| .Nm |
| exits with 0 on success or >0 if an error occurred. |
| .Sh SEE ALSO |
| .Xr rcp 1 , |
| .Xr sftp 1 , |
| .Xr ssh 1 , |
| .Xr ssh-add 1 , |
| .Xr ssh-agent 1 , |
| .Xr ssh-keygen 1 , |
| .Xr ssh_config 5 , |
| .Xr sshd 8 |
| .Sh HISTORY |
| .Nm |
| is based on the |
| .Xr rcp 1 |
| program in BSD source code from the Regents of the University of |
| California. |
| .Sh AUTHORS |
| .An Timo Rinne Aq tri@iki.fi |
| .An Tatu Ylonen Aq ylo@cs.hut.fi |
