summaryrefslogtreecommitdiff
path: root/sftp.1
diff options
context:
space:
mode:
authormillert@openbsd.org <millert@openbsd.org>2017-10-21 23:06:24 +0000
committerDamien Miller <djm@mindrot.org>2017-10-23 16:10:08 +1100
commit887669ef032d63cf07f53cada216fa8a0c9a7d72 (patch)
tree089b20255da21a489d7bc796a8ee86bd0b8f028f /sftp.1
parentd27bff293cfeb2252f4c7a58babe5ad3262c6c98 (diff)
upstream commit
Add URI support to ssh, sftp and scp. For example ssh://user@host or sftp://user@host/path. The connection parameters described in draft-ietf-secsh-scp-sftp-ssh-uri-04 are not implemented since the ssh fingerprint format in the draft uses md5 with no way to specify the hash function type. OK djm@ Upstream-ID: 4ba3768b662d6722de59e6ecb00abf2d4bf9cacc
Diffstat (limited to 'sftp.1')
-rw-r--r--sftp.177
1 files changed, 40 insertions, 37 deletions
diff --git a/sftp.1 b/sftp.1
index c218376fb..49f7febf1 100644
--- a/sftp.1
+++ b/sftp.1
@@ -1,4 +1,4 @@
1.\" $OpenBSD: sftp.1,v 1.110 2017/05/03 21:49:18 naddy Exp $ 1.\" $OpenBSD: sftp.1,v 1.111 2017/10/21 23:06:24 millert Exp $
2.\" 2.\"
3.\" Copyright (c) 2001 Damien Miller. All rights reserved. 3.\" Copyright (c) 2001 Damien Miller. All rights reserved.
4.\" 4.\"
@@ -22,7 +22,7 @@
22.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 22.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 23.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24.\" 24.\"
25.Dd $Mdocdate: May 3 2017 $ 25.Dd $Mdocdate: October 21 2017 $
26.Dt SFTP 1 26.Dt SFTP 1
27.Os 27.Os
28.Sh NAME 28.Sh NAME
@@ -44,54 +44,52 @@
44.Op Fl R Ar num_requests 44.Op Fl R Ar num_requests
45.Op Fl S Ar program 45.Op Fl S Ar program
46.Op Fl s Ar subsystem | sftp_server 46.Op Fl s Ar subsystem | sftp_server
47.Ar host 47.Ar destination
48.Ek
49.Nm sftp
50.Oo Ar user Ns @ Oc Ns
51.Ar host Ns Op : Ns Ar
52.Nm sftp
53.Oo
54.Ar user Ns @ Oc Ns
55.Ar host Ns Oo : Ns Ar dir Ns
56.Op Ar /
57.Oc
58.Nm sftp
59.Fl b Ar batchfile
60.Oo Ar user Ns @ Oc Ns Ar host
61.Sh DESCRIPTION 48.Sh DESCRIPTION
62.Nm 49.Nm
63is an interactive file transfer program, similar to 50is a file transfer program, similar to
64.Xr ftp 1 , 51.Xr ftp 1 ,
65which performs all operations over an encrypted 52which performs all operations over an encrypted
66.Xr ssh 1 53.Xr ssh 1
67transport. 54transport.
68It may also use many features of ssh, such as public key authentication and 55It may also use many features of ssh, such as public key authentication and
69compression. 56compression.
70.Nm
71connects and logs into the specified
72.Ar host ,
73then enters an interactive command mode.
74.Pp 57.Pp
75The second usage format will retrieve files automatically if a non-interactive 58The
59.Ar destination
60may be specified either as
61.Oo Ar user Ns @ Oc Ns Ar host Ns Oo : Ns Ar path Oc
62or as an sftp URI in the form
63.No sftp:// Ns Oo Ar user Ns @ Oc Ns Ar host Ns
64.Oo : Ns Ar port Oc Ns Oo / Ns Ar path Oc .
65.Pp
66If the
67.Ar destination
68includes a
69.Ar path
70and it is not a directory,
71.Nm
72will retrieve files automatically if a non-interactive
76authentication method is used; otherwise it will do so after 73authentication method is used; otherwise it will do so after
77successful interactive authentication. 74successful interactive authentication.
78.Pp 75.Pp
79The third usage format allows 76If no
77.Ar path
78is specified, or if the
79.Ar path
80is a directory,
80.Nm 81.Nm
81to start in a remote directory. 82will log in to the specified
82.Pp 83.Ar host
83The final usage format allows for automated sessions using the 84and enter interactive command mode, changing to the remote directory
84.Fl b 85if one was specified.
85option. 86An optional trailing slash can be used to force the
86In such cases, it is necessary to configure non-interactive authentication 87.Ar path
87to obviate the need to enter a password at connection time (see 88to be interpreted as a directory.
88.Xr sshd 8
89and
90.Xr ssh-keygen 1
91for details).
92.Pp 89.Pp
93Since some usage formats use colon characters to delimit host names from path 90Since the destination formats use colon characters to delimit host
94names, IPv6 addresses must be enclosed in square brackets to avoid ambiguity. 91names from path names or port numbers, IPv6 addresses must be
92enclosed in square brackets to avoid ambiguity.
95.Pp 93.Pp
96The options are as follows: 94The options are as follows:
97.Bl -tag -width Ds 95.Bl -tag -width Ds
@@ -121,7 +119,12 @@ Batch mode reads a series of commands from an input
121instead of 119instead of
122.Em stdin . 120.Em stdin .
123Since it lacks user interaction it should be used in conjunction with 121Since it lacks user interaction it should be used in conjunction with
124non-interactive authentication. 122non-interactive authentication to obviate the need to enter a password
123at connection time (see
124.Xr sshd 8
125and
126.Xr ssh-keygen 1
127for details).
125A 128A
126.Ar batchfile 129.Ar batchfile
127of 130of