- (bal) "extration" -> "extraction" in ssh-rand-helper.c; repoted by john

[openssh.git] / scp.1

diff --git a/scp.1 b/scp.1
index 235658342dfc517ec9684d4599ee81025ff3d672..a971500eebd30edfe101bd50691db5a630ebdb1c 100644 (file)
--- a/scp.1
+++ b/scp.1
@@ -9,7 +9,7 @@
 .\"
 .\" Created: Sun May  7 00:14:37 1995 ylo
 .\"
-.\" $OpenBSD: scp.1,v 1.15 2001/07/29 17:02:46 mouring Exp $
+.\" $OpenBSD: scp.1,v 1.28 2003/06/10 09:12:11 jmc Exp $
 .\"
 .Dd September 25, 1999
 .Dt SCP 1
@@ -19,12 +19,15 @@
 .Nd secure copy (remote file copy program)
 .Sh SYNOPSIS
 .Nm scp
-.Op Fl pqrvC46
+.Bk -words
+.Op Fl pqrvBC1246
+.Op Fl F Ar ssh_config
 .Op Fl S Ar program
 .Op Fl P Ar port
 .Op Fl c Ar cipher
 .Op Fl i Ar identity_file
-.Op Fl o Ar option
+.Op Fl l Ar limit
+.Op Fl o Ar ssh_option
 .Sm off
 .Oo
 .Op Ar user@
@@ -38,6 +41,7 @@
 .Ar host2 No :
 .Oc Ar file2
 .Sm on
+.Ek
 .Sh DESCRIPTION
 .Nm
 copies files between hosts on a network.
@@ -67,6 +71,8 @@ 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 p
 Preserves modification times, access times, and modes from the
 original file.
@@ -92,6 +98,12 @@ Passes the
 flag to
 .Xr ssh 1
 to enable compression.
+.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 P Ar port
 Specifies the port to connect to on the remote host.
 Note that this option is written with a capital
@@ -107,10 +119,23 @@ to use for the encrypted connection.
 The program must understand
 .Xr ssh 1
 options.
-.It Fl o Ar option
-Can be used to give options in the format used in the config file.
-Theses options are passed directly to
-.Xr ssh 1 .
+.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.
+.It Fl 1
+Forces
+.Nm
+to use protocol 1.
+.It Fl 2
+Forces
+.Nm
+to use protocol 2.
 .It Fl 4
 Forces
 .Nm
@@ -120,14 +145,9 @@ Forces
 .Nm
 to use IPv6 addresses only.
 .El
-.Sh AUTHORS
-Timo Rinne <tri@iki.fi> and Tatu Ylonen <ylo@cs.hut.fi>
-.Sh HISTORY
+.Sh DIAGNOSTICS
 .Nm
-is based on the
-.Xr rcp 1
-program in BSD source code from the Regents of the University of
-California.
+exits with 0 on success or >0 if an error occurred.
 .Sh SEE ALSO
 .Xr rcp 1 ,
 .Xr sftp 1 ,
@@ -135,4 +155,15 @@ California.
 .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
+and
+.An Tatu Ylonen Aq ylo@cs.hut.fi