freebsd-dev/crypto/openssh/scp.1

246 lines
5.0 KiB
Groff
Raw Normal View History

2000-02-24 14:29:47 +00:00
.\"
.\" 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
.\"
2014-01-30 10:56:49 +00:00
.\" $OpenBSD: scp.1,v 1.61 2013/10/20 09:51:26 djm Exp $
2000-02-24 14:29:47 +00:00
.\"
2014-01-31 13:12:02 +00:00
.Dd October 20, 2013
2000-02-24 14:29:47 +00:00
.Dt SCP 1
.Os
.Sh NAME
.Nm scp
.Nd secure copy (remote file copy program)
.Sh SYNOPSIS
.Nm scp
.Bk -words
2011-02-17 11:47:40 +00:00
.Op Fl 12346BCpqrv
2000-02-24 14:29:47 +00:00
.Op Fl c Ar cipher
2004-02-26 10:38:49 +00:00
.Op Fl F Ar ssh_config
2000-02-24 14:29:47 +00:00
.Op Fl i Ar identity_file
.Op Fl l Ar limit
2002-03-18 09:55:03 +00:00
.Op Fl o Ar ssh_option
2004-02-26 10:38:49 +00:00
.Op Fl P Ar port
.Op Fl S Ar program
2000-02-24 14:29:47 +00:00
.Sm off
.Oo
2004-02-26 10:38:49 +00:00
.Op Ar user No @
2000-02-24 14:29:47 +00:00
.Ar host1 No :
2012-08-29 15:46:01 +00:00
.Oc Ar file1
2000-02-24 14:29:47 +00:00
.Sm on
.Ar ...
2000-02-24 14:29:47 +00:00
.Sm off
.Oo
2004-02-26 10:38:49 +00:00
.Op Ar user No @
2000-02-24 14:29:47 +00:00
.Ar host2 No :
.Oc Ar file2
.Sm on
.Ek
2000-05-15 04:37:24 +00:00
.Sh DESCRIPTION
2000-02-24 14:29:47 +00:00
.Nm
copies files between hosts on a network.
It uses
2000-02-24 14:29:47 +00:00
.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
File names may contain a user and host specification to indicate
that the file is to be copied to/from that host.
Local file names can be made explicit using absolute or relative pathnames
to avoid
.Nm
treating file names containing
.Sq :\&
as host specifiers.
Copies between two remote hosts are also permitted.
2000-02-24 14:29:47 +00:00
.Pp
The options are as follows:
.Bl -tag -width Ds
2004-02-26 10:38:49 +00:00
.It Fl 1
Forces
2000-02-24 14:29:47 +00:00
.Nm
2004-02-26 10:38:49 +00:00
to use protocol 1.
.It Fl 2
Forces
.Nm
to use protocol 2.
2011-02-17 11:47:40 +00:00
.It Fl 3
Copies between two remote hosts are transferred through the local host.
Without this option the data is copied directly between the two remote
hosts.
Note that this option disables the progress meter.
2004-02-26 10:38:49 +00:00
.It Fl 4
Forces
.Nm
to use IPv4 addresses only.
.It Fl 6
Forces
.Nm
to use IPv6 addresses only.
2000-02-24 14:29:47 +00:00
.It Fl B
Selects batch mode (prevents asking for passwords or passphrases).
.It Fl C
Compression enable.
Passes the
2000-02-24 14:29:47 +00:00
.Fl C
flag to
.Xr ssh 1
to enable compression.
2004-02-26 10:38:49 +00:00
.It Fl c Ar cipher
Selects the cipher to use for encrypting the data transfer.
This option is directly passed to
.Xr ssh 1 .
2002-03-18 09:55:03 +00:00
.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 .
2004-02-26 10:38:49 +00:00
.It Fl i Ar identity_file
2008-07-23 09:33:08 +00:00
Selects the file from which the identity (private key) for public key
2004-02-26 10:38:49 +00:00
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
2014-01-30 10:56:49 +00:00
.It CanonicalDomains
.It CanonicalizeFallbackLocal
.It CanonicalizeHostname
.It CanonicalizeMaxDots
.It CanonicalizePermittedCNAMEs
2004-02-26 10:38:49 +00:00
.It ChallengeResponseAuthentication
.It CheckHostIP
.It Cipher
.It Ciphers
.It Compression
.It CompressionLevel
.It ConnectionAttempts
2004-10-28 16:03:53 +00:00
.It ConnectTimeout
.It ControlMaster
.It ControlPath
2012-08-29 15:46:01 +00:00
.It ControlPersist
2004-02-26 10:38:49 +00:00
.It GlobalKnownHostsFile
.It GSSAPIAuthentication
.It GSSAPIDelegateCredentials
2005-06-05 15:40:50 +00:00
.It HashKnownHosts
2004-02-26 10:38:49 +00:00
.It Host
.It HostbasedAuthentication
.It HostKeyAlgorithms
.It HostKeyAlias
.It HostName
.It IdentityFile
2004-04-20 09:35:04 +00:00
.It IdentitiesOnly
2011-02-17 11:47:40 +00:00
.It IPQoS
2012-08-29 15:46:01 +00:00
.It KbdInteractiveAuthentication
2005-06-05 15:40:50 +00:00
.It KbdInteractiveDevices
2011-02-17 11:47:40 +00:00
.It KexAlgorithms
2004-02-26 10:38:49 +00:00
.It LogLevel
.It MACs
.It NoHostAuthenticationForLocalhost
.It NumberOfPasswordPrompts
.It PasswordAuthentication
2010-03-08 11:19:52 +00:00
.It PKCS11Provider
2004-02-26 10:38:49 +00:00
.It Port
.It PreferredAuthentications
.It Protocol
.It ProxyCommand
.It PubkeyAuthentication
2006-03-22 19:46:12 +00:00
.It RekeyLimit
2004-02-26 10:38:49 +00:00
.It RhostsRSAAuthentication
.It RSAAuthentication
2004-10-28 16:03:53 +00:00
.It SendEnv
2004-02-26 10:38:49 +00:00
.It ServerAliveInterval
.It ServerAliveCountMax
.It StrictHostKeyChecking
.It TCPKeepAlive
.It UsePrivilegedPort
.It User
.It UserKnownHostsFile
.It VerifyHostKeyDNS
.El
2000-02-24 14:29:47 +00:00
.It Fl P Ar port
Specifies the port to connect to on the remote host.
Note that this option is written with a capital
2000-02-24 14:29:47 +00:00
.Sq P ,
because
.Fl p
is already reserved for preserving the times and modes of the file in
.Xr rcp 1 .
2004-02-26 10:38:49 +00:00
.It Fl p
Preserves modification times, access times, and modes from the
original file.
.It Fl q
Quiet mode: disables the progress meter as well as warning and diagnostic
messages from
.Xr ssh 1 .
2004-02-26 10:38:49 +00:00
.It Fl r
Recursively copy entire directories.
2008-07-23 09:33:08 +00:00
Note that
.Nm
follows symbolic links encountered in the tree traversal.
.It Fl S Ar program
Name of
.Ar program
to use for the encrypted connection.
The program must understand
.Xr ssh 1
options.
2004-02-26 10:38:49 +00:00
.It Fl v
Verbose mode.
Causes
2000-02-24 14:29:47 +00:00
.Nm
2004-02-26 10:38:49 +00:00
and
.Xr ssh 1
to print debugging messages about their progress.
This is helpful in
debugging connection, authentication, and configuration problems.
.El
2011-02-17 11:47:40 +00:00
.Sh EXIT STATUS
2006-09-30 13:29:51 +00:00
.Ex -std scp
2000-02-24 14:29:47 +00:00
.Sh SEE ALSO
.Xr rcp 1 ,
.Xr sftp 1 ,
2000-02-24 14:29:47 +00:00
.Xr ssh 1 ,
.Xr ssh-add 1 ,
.Xr ssh-agent 1 ,
.Xr ssh-keygen 1 ,
2002-06-29 11:34:13 +00:00
.Xr ssh_config 5 ,
2000-02-24 14:29:47 +00:00
.Xr sshd 8
2004-01-07 11:10:17 +00:00
.Sh HISTORY
.Nm
is based on the
.Xr rcp 1
2014-01-30 10:56:49 +00:00
program in
.Bx
source code from the Regents of the University of California.
2004-01-07 11:10:17 +00:00
.Sh AUTHORS
2013-09-18 17:27:38 +00:00
.An Timo Rinne Aq Mt tri@iki.fi
.An Tatu Ylonen Aq Mt ylo@cs.hut.fi