diff options
-rw-r--r-- | ChangeLog | 9 | ||||
-rw-r--r-- | sftp.1 | 77 |
2 files changed, 52 insertions, 34 deletions
@@ -1,6 +1,13 @@ | |||
1 | 20030523 | 1 | 20030523 |
2 | - (djm) Use VIS_SAFE on logged strings rather than default strnvis | 2 | - (djm) Use VIS_SAFE on logged strings rather than default strnvis |
3 | encoding (which encodes many more characters) | 3 | encoding (which encodes many more characters) |
4 | - OpenBSD CVS Sync | ||
5 | - jmc@cvs.openbsd.org 2003/05/20 12:03:35 | ||
6 | [sftp.1] | ||
7 | - new sentence, new line | ||
8 | - added .Xr's | ||
9 | - typos | ||
10 | ok djm@ | ||
4 | 11 | ||
5 | 20030520 | 12 | 20030520 |
6 | - (djm) OpenBSD CVS Sync | 13 | - (djm) OpenBSD CVS Sync |
@@ -1589,4 +1596,4 @@ | |||
1589 | save auth method before monitor_reset_key_state(); bugzilla bug #284; | 1596 | save auth method before monitor_reset_key_state(); bugzilla bug #284; |
1590 | ok provos@ | 1597 | ok provos@ |
1591 | 1598 | ||
1592 | $Id: ChangeLog,v 1.2745 2003/05/23 08:43:40 djm Exp $ | 1599 | $Id: ChangeLog,v 1.2746 2003/05/23 08:44:04 djm Exp $ |
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: sftp.1,v 1.43 2003/05/14 08:25:39 jmc Exp $ | 1 | .\" $OpenBSD: sftp.1,v 1.44 2003/05/20 12:03:35 jmc Exp $ |
2 | .\" | 2 | .\" |
3 | .\" Copyright (c) 2001 Damien Miller. All rights reserved. | 3 | .\" Copyright (c) 2001 Damien Miller. All rights reserved. |
4 | .\" | 4 | .\" |
@@ -27,7 +27,7 @@ | |||
27 | .Os | 27 | .Os |
28 | .Sh NAME | 28 | .Sh NAME |
29 | .Nm sftp | 29 | .Nm sftp |
30 | .Nd Secure file transfer program | 30 | .Nd secure file transfer program |
31 | .Sh SYNOPSIS | 31 | .Sh SYNOPSIS |
32 | .Nm sftp | 32 | .Nm sftp |
33 | .Bk -words | 33 | .Bk -words |
@@ -73,15 +73,15 @@ successful interactive authentication. | |||
73 | .Pp | 73 | .Pp |
74 | The third usage format allows the sftp client to start in a remote directory. | 74 | The third usage format allows the sftp client to start in a remote directory. |
75 | .Pp | 75 | .Pp |
76 | The final usage form allows for automated sessions using the | 76 | The final usage format allows for automated sessions using the |
77 | .Fl b | 77 | .Fl b |
78 | option. In such cases, it is usually necessary to configure public key | 78 | option. |
79 | authentication to obviate the need to enter a password at connection | 79 | In such cases, it is usually necessary to configure public key authentication |
80 | time (see | 80 | to obviate the need to enter a password at connection time (see |
81 | .Xr sshd 8 | 81 | .Xr sshd 8 |
82 | and | 82 | and |
83 | .Xr ssh-keygen 1 | 83 | .Xr ssh-keygen 1 |
84 | for details.) | 84 | for details). |
85 | The options are as follows: | 85 | The options are as follows: |
86 | .Bl -tag -width Ds | 86 | .Bl -tag -width Ds |
87 | .It Fl b Ar batchfile | 87 | .It Fl b Ar batchfile |
@@ -101,10 +101,9 @@ and | |||
101 | .Ic lmkdir . | 101 | .Ic lmkdir . |
102 | Termination on error can be suppressed on a command by command basis by | 102 | Termination on error can be suppressed on a command by command basis by |
103 | prefixing the command with a | 103 | prefixing the command with a |
104 | .Ic '-' | 104 | .Sq Ic \- |
105 | character (For example, | 105 | character (for example, |
106 | .Ic -rm /tmp/blah* | 106 | .Ic -rm /tmp/blah* ) . |
107 | ). | ||
108 | .It Fl o Ar ssh_option | 107 | .It Fl o Ar ssh_option |
109 | Can be used to pass options to | 108 | Can be used to pass options to |
110 | .Nm ssh | 109 | .Nm ssh |
@@ -113,22 +112,27 @@ in the format used in | |||
113 | This is useful for specifying options | 112 | This is useful for specifying options |
114 | for which there is no separate | 113 | for which there is no separate |
115 | .Nm sftp | 114 | .Nm sftp |
116 | command-line flag. For example, to specify an alternate | 115 | command-line flag. |
117 | port use: | 116 | For example, to specify an alternate port use: |
118 | .Ic sftp -oPort=24 . | 117 | .Ic sftp -oPort=24 . |
119 | .It Fl s Ar subsystem | sftp_server | 118 | .It Fl s Ar subsystem | sftp_server |
120 | Specifies the SSH2 subsystem or the path for an sftp server | 119 | Specifies the SSH2 subsystem or the path for an sftp server |
121 | on the remote host. A path is useful for using sftp over | 120 | on the remote host. |
122 | protocol version 1, or when the remote | 121 | A path is useful for using |
123 | .Nm sshd | 122 | .Nm |
123 | over protocol version 1, or when the remote | ||
124 | .Xr sshd 8 | ||
124 | does not have an sftp subsystem configured. | 125 | does not have an sftp subsystem configured. |
125 | .It Fl v | 126 | .It Fl v |
126 | Raise logging level. This option is also passed to ssh. | 127 | Raise logging level. |
128 | This option is also passed to ssh. | ||
127 | .It Fl B Ar buffer_size | 129 | .It Fl B Ar buffer_size |
128 | Specify the size of the buffer that | 130 | Specify the size of the buffer that |
129 | .Nm | 131 | .Nm |
130 | uses when transferring files. Larger buffers require fewer round trips at | 132 | uses when transferring files. |
131 | the cost of higher memory consumption. The default is 32768 bytes. | 133 | Larger buffers require fewer round trips at the cost of higher |
134 | memory consumption. | ||
135 | The default is 32768 bytes. | ||
132 | .It Fl C | 136 | .It Fl C |
133 | Enables compression (via ssh's | 137 | Enables compression (via ssh's |
134 | .Fl C | 138 | .Fl C |
@@ -136,19 +140,19 @@ flag). | |||
136 | .It Fl F Ar ssh_config | 140 | .It Fl F Ar ssh_config |
137 | Specifies an alternative | 141 | Specifies an alternative |
138 | per-user configuration file for | 142 | per-user configuration file for |
139 | .Nm ssh . | 143 | .Xr ssh 1 . |
140 | This option is directly passed to | 144 | This option is directly passed to |
141 | .Xr ssh 1 . | 145 | .Xr ssh 1 . |
142 | .It Fl P Ar sftp_server path | 146 | .It Fl P Ar sftp_server path |
143 | Connect directly to a local | 147 | Connect directly to a local sftp server |
144 | .Nm sftp-server | ||
145 | (rather than via | 148 | (rather than via |
146 | .Nm ssh ) | 149 | .Xr ssh 1 ) |
147 | This option may be useful in debugging the client and server. | 150 | This option may be useful in debugging the client and server. |
148 | .It Fl R Ar num_requests | 151 | .It Fl R Ar num_requests |
149 | Specify how many requests may be outstanding at any one time. Increasing | 152 | Specify how many requests may be outstanding at any one time. |
150 | this may slightly improve file transfer speed but will increase memory | 153 | Increasing this may slightly improve file transfer speed |
151 | usage. The default is 16 outstanding requests. | 154 | but will increase memory usage. |
155 | The default is 16 outstanding requests. | ||
152 | .It Fl S Ar program | 156 | .It Fl S Ar program |
153 | Name of the | 157 | Name of the |
154 | .Ar program | 158 | .Ar program |
@@ -168,7 +172,8 @@ Commands are case insensitive and pathnames may be enclosed in quotes if they | |||
168 | contain spaces. | 172 | contain spaces. |
169 | .Bl -tag -width Ds | 173 | .Bl -tag -width Ds |
170 | .It Ic bye | 174 | .It Ic bye |
171 | Quit sftp. | 175 | Quit |
176 | .Nm sftp . | ||
172 | .It Ic cd Ar path | 177 | .It Ic cd Ar path |
173 | Change remote directory to | 178 | Change remote directory to |
174 | .Ar path . | 179 | .Ar path . |
@@ -195,7 +200,8 @@ to | |||
195 | .Ar own | 200 | .Ar own |
196 | must be a numeric UID. | 201 | must be a numeric UID. |
197 | .It Ic exit | 202 | .It Ic exit |
198 | Quit sftp. | 203 | Quit |
204 | .Nm sftp . | ||
199 | .It Xo Ic get | 205 | .It Xo Ic get |
200 | .Op Ar flags | 206 | .Op Ar flags |
201 | .Ar remote-path | 207 | .Ar remote-path |
@@ -206,7 +212,8 @@ Retrieve the | |||
206 | and store it on the local machine. | 212 | and store it on the local machine. |
207 | If the local | 213 | If the local |
208 | path name is not specified, it is given the same name it has on the | 214 | path name is not specified, it is given the same name it has on the |
209 | remote machine. If the | 215 | remote machine. |
216 | If the | ||
210 | .Fl P | 217 | .Fl P |
211 | flag is specified, then the file's full permission and access time are | 218 | flag is specified, then the file's full permission and access time are |
212 | copied too. | 219 | copied too. |
@@ -236,7 +243,8 @@ Display remote directory listing of either | |||
236 | .Ar path | 243 | .Ar path |
237 | or current directory if | 244 | or current directory if |
238 | .Ar path | 245 | .Ar path |
239 | is not specified. If the | 246 | is not specified. |
247 | If the | ||
240 | .Fl l | 248 | .Fl l |
241 | flag is specified, then display additional details including permissions | 249 | flag is specified, then display additional details including permissions |
242 | and ownership information. | 250 | and ownership information. |
@@ -255,15 +263,18 @@ Toggle display of progress meter. | |||
255 | .Xc | 263 | .Xc |
256 | Upload | 264 | Upload |
257 | .Ar local-path | 265 | .Ar local-path |
258 | and store it on the remote machine. If the remote path name is not | 266 | and store it on the remote machine. |
259 | specified, it is given the same name it has on the local machine. If the | 267 | If the remote path name is not specified, it is given the same name it has |
268 | on the local machine. | ||
269 | If the | ||
260 | .Fl P | 270 | .Fl P |
261 | flag is specified, then the file's full permission and access time are | 271 | flag is specified, then the file's full permission and access time are |
262 | copied too. | 272 | copied too. |
263 | .It Ic pwd | 273 | .It Ic pwd |
264 | Display remote working directory. | 274 | Display remote working directory. |
265 | .It Ic quit | 275 | .It Ic quit |
266 | Quit sftp. | 276 | Quit |
277 | .Nm sftp . | ||
267 | .It Ic rename Ar oldpath Ar newpath | 278 | .It Ic rename Ar oldpath Ar newpath |
268 | Rename remote file from | 279 | Rename remote file from |
269 | .Ar oldpath | 280 | .Ar oldpath |