source: trunk/third/ssh/scp.1 @ 12646

.\"  -*- 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
.\"
.\" $Id: scp.1,v 1.1.1.2 1999-03-08 17:42:59 danw Exp $
.\" $Log: not supported by cvs2svn $
.\" Revision 1.6  1998/07/08 00:42:13  kivinen
.\"     Changed to do similar commercial #ifdef processing than other
.\"     files. Added -a, -A, -Q, and -L. Added comment about
.\"     environment variables.
.\"
.\" Revision 1.5  1998/06/11 00:10:08  kivinen
.\"     Added -q option.
.\"
.\" Revision 1.4  1997/04/27  21:48:37  kivinen
.\"     Added F-SECURE stuff.
.\"
.\" Revision 1.3  1997/04/23 00:03:28  kivinen
.\"     Documented -S flag and -o flags.
.\"
.\" Revision 1.2  1997/03/25 05:41:20  kivinen
.\"     Fixed typo. Changed ylo's email to @ssh.fi.
.\"
.\" Revision 1.1.1.1  1996/02/18 21:38:13  ylo
.\"     Imported ssh-1.2.13.
.\"
.\" Revision 1.5  1995/08/29  22:30:46  ylo
.\"     Improved manual pages from Andrew Macpherson.
.\"
.\" Revision 1.4  1995/08/18  22:55:14  ylo
.\"     Added "-P port" option.
.\"
.\" Revision 1.3  1995/07/13  01:37:06  ylo
.\"     Removed "Last modified" header.
.\"     Added cvs log.
.\"
.\" $Endlog$
.\"
.\"
.\"
.\"
.\" #ifndef F_SECURE_COMMERCIAL
.TH SCP 1 "November 8, 1995" "SSH" "SSH"
.\" #endif F_SECURE_COMMERCIAL

.SH NAME
scp \- secure copy (remote file copy program)

.SH SYNOPSIS
.LP
.B scp
[\c
.B \-aAqQprvBCL\c
]
[\c
.BI \-S "\ path-to-ssh\c
]
[\c
.BI \-o "\ ssh-options\c
]
[\c
.BI \-P "\ port\c
]
[\c
.BI \-c "\ cipher\c
]
[\c
.BI \-i "\ identity\c
]
.if n .ti +5
[[\c
.B user@\c
]\c
.B host1:\c
]\c
.B filename1\c
\&.\|.\|.
[[\c
.B user@\c
]\c
.B host2:\c
]\c
.B filename2

.SH DESCRIPTION 
.LP
.B Scp
copies files between hosts on a network.  It uses
.B ssh
for data transfer, and uses the same authentication and provides the
same security as
.B ssh.
Unlike
.BR rcp ",
.B scp
will ask for passwords or passphrases if they are needed for
authentication.
.LP
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.

.SH OPTIONS

.TP 0.6i
.B \-a
Turn on statistics display for each file.
.TP
.B \-A
Turn off statistics display for each file.
.TP
.BI \-c "\ cipher
Selects the cipher to use for encrypting the data transfer.  This
option is directly passed to
.B ssh.
.TP
.BI \-i "\ identity_file
Selects the file from which the identity (private key) for RSA
authentication is read.  This option is directly passed to
.B ssh.
.TP
.B \-L
Use non privileged port. With this you cannot use
rhosts  or rsarhosts authentications, but it can be
used to bypass some firewalls that dont allow privileged
source ports to pass. Same as saying "-o UsePriviledgePort=no"
or -P to ssh; -L is used due to exhaustion of suitable letters.
.TP
.BI \-o "\ ssh-options
Ssh options passed to ssh.
.TP
.B \-p
Preserves modification times, access times, and modes from the
original file.
.TP
.B \-q
Turn off statistics display.
.TP
.B \-Q
Turn on statistics display.
.TP
.B \-r
Recursively copy entire directories.
.TP
.B \-v
Verbose mode.  Causes
.B scp
and 
.B ssh
to print debugging messages about their progress.  This is helpful in
debugging connection, authentication, and configuration problems.
.TP
.B \-B
Selects batch mode (prevents asking for passwords or passphrases).
.TP
.B \-C
Compression enable.  Passes the -C flag to
.B ssh
to enable compression.
.TP
.BI \-P "\ port
Specifies the port to connect to on the remote host.  Note that this
option is written with a capital P, because \-p is already reserved for
preserving the times and modes of the file in rcp.
.TP
.BI \-S "\ path-to-ssh
Specifies the path to ssh program.

.SH ENVIRONMENT VARIABLES
.LP
You can turn scp statistics on or off by setting
.B SSH_SCP_STATS
or
.B SSH_NO_SCP_STATS
environment variables. To turn on or off scp statistics for each file,
use 
.B SSH_ALL_SCP_STATS
or
.B SSH_NO_ALL_SCP_STATS
environment variables. The default value of the statistics can be set
when the ssh is configured. Next the scp checks those environment
variables and after that command line options. 

.SH AUTHORS
.LP
Timo Rinne <tri@iki.fi> and Tatu Ylonen <ylo@ssh.fi>

.SH DERIVATION
.LP
.B Scp
is based on the
.B rcp
program in BSD source code from the Regents of the University of
California.

.SH SEE ALSO
.LP
.BR ssh (1),
.BR sshd (8),
.BR ssh-keygen (1),
.BR ssh-agent (1),
.BR ssh-add (1),
.BR rcp (1)