diff options
Diffstat (limited to 'sftp.1')
-rw-r--r-- | sftp.1 | 77 |
1 files changed, 40 insertions, 37 deletions
@@ -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 |
63 | is an interactive file transfer program, similar to | 50 | is a file transfer program, similar to |
64 | .Xr ftp 1 , | 51 | .Xr ftp 1 , |
65 | which performs all operations over an encrypted | 52 | which performs all operations over an encrypted |
66 | .Xr ssh 1 | 53 | .Xr ssh 1 |
67 | transport. | 54 | transport. |
68 | It may also use many features of ssh, such as public key authentication and | 55 | It may also use many features of ssh, such as public key authentication and |
69 | compression. | 56 | compression. |
70 | .Nm | ||
71 | connects and logs into the specified | ||
72 | .Ar host , | ||
73 | then enters an interactive command mode. | ||
74 | .Pp | 57 | .Pp |
75 | The second usage format will retrieve files automatically if a non-interactive | 58 | The |
59 | .Ar destination | ||
60 | may be specified either as | ||
61 | .Oo Ar user Ns @ Oc Ns Ar host Ns Oo : Ns Ar path Oc | ||
62 | or 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 | ||
66 | If the | ||
67 | .Ar destination | ||
68 | includes a | ||
69 | .Ar path | ||
70 | and it is not a directory, | ||
71 | .Nm | ||
72 | will retrieve files automatically if a non-interactive | ||
76 | authentication method is used; otherwise it will do so after | 73 | authentication method is used; otherwise it will do so after |
77 | successful interactive authentication. | 74 | successful interactive authentication. |
78 | .Pp | 75 | .Pp |
79 | The third usage format allows | 76 | If no |
77 | .Ar path | ||
78 | is specified, or if the | ||
79 | .Ar path | ||
80 | is a directory, | ||
80 | .Nm | 81 | .Nm |
81 | to start in a remote directory. | 82 | will log in to the specified |
82 | .Pp | 83 | .Ar host |
83 | The final usage format allows for automated sessions using the | 84 | and enter interactive command mode, changing to the remote directory |
84 | .Fl b | 85 | if one was specified. |
85 | option. | 86 | An optional trailing slash can be used to force the |
86 | In such cases, it is necessary to configure non-interactive authentication | 87 | .Ar path |
87 | to obviate the need to enter a password at connection time (see | 88 | to be interpreted as a directory. |
88 | .Xr sshd 8 | ||
89 | and | ||
90 | .Xr ssh-keygen 1 | ||
91 | for details). | ||
92 | .Pp | 89 | .Pp |
93 | Since some usage formats use colon characters to delimit host names from path | 90 | Since the destination formats use colon characters to delimit host |
94 | names, IPv6 addresses must be enclosed in square brackets to avoid ambiguity. | 91 | names from path names or port numbers, IPv6 addresses must be |
92 | enclosed in square brackets to avoid ambiguity. | ||
95 | .Pp | 93 | .Pp |
96 | The options are as follows: | 94 | The 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 | |||
121 | instead of | 119 | instead of |
122 | .Em stdin . | 120 | .Em stdin . |
123 | Since it lacks user interaction it should be used in conjunction with | 121 | Since it lacks user interaction it should be used in conjunction with |
124 | non-interactive authentication. | 122 | non-interactive authentication to obviate the need to enter a password |
123 | at connection time (see | ||
124 | .Xr sshd 8 | ||
125 | and | ||
126 | .Xr ssh-keygen 1 | ||
127 | for details). | ||
125 | A | 128 | A |
126 | .Ar batchfile | 129 | .Ar batchfile |
127 | of | 130 | of |