Damien Miller | bd394c3 | 2004-03-08 23:12:36 +1100 | [diff] [blame] | 1 | .\" $OpenBSD: sftp.1,v 1.52 2004/03/05 10:53:58 markus Exp $ |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 2 | .\" |
Ben Lindstrom | 92a2e38 | 2001-03-05 06:59:27 +0000 | [diff] [blame] | 3 | .\" Copyright (c) 2001 Damien Miller. All rights reserved. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 4 | .\" |
| 5 | .\" Redistribution and use in source and binary forms, with or without |
| 6 | .\" modification, are permitted provided that the following conditions |
| 7 | .\" are met: |
| 8 | .\" 1. Redistributions of source code must retain the above copyright |
| 9 | .\" notice, this list of conditions and the following disclaimer. |
| 10 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| 11 | .\" notice, this list of conditions and the following disclaimer in the |
| 12 | .\" documentation and/or other materials provided with the distribution. |
| 13 | .\" |
| 14 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| 15 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| 16 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| 17 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| 18 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 19 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 20 | .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 21 | .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 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. |
| 24 | .\" |
Ben Lindstrom | 8ffeacf | 2001-04-10 02:43:57 +0000 | [diff] [blame] | 25 | .Dd February 4, 2001 |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 26 | .Dt SFTP 1 |
| 27 | .Os |
| 28 | .Sh NAME |
| 29 | .Nm sftp |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 30 | .Nd secure file transfer program |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 31 | .Sh SYNOPSIS |
Damien Miller | d6ead28 | 2003-05-14 19:30:38 +1000 | [diff] [blame] | 32 | .Nm sftp |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 33 | .Bk -words |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 34 | .Op Fl 1Cv |
Damien Miller | 81b6e78 | 2002-02-08 22:06:03 +1100 | [diff] [blame] | 35 | .Op Fl B Ar buffer_size |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 36 | .Op Fl b Ar batchfile |
Damien Miller | 81b6e78 | 2002-02-08 22:06:03 +1100 | [diff] [blame] | 37 | .Op Fl F Ar ssh_config |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 38 | .Op Fl o Ar ssh_option |
| 39 | .Op Fl P Ar sftp_server_path |
Damien Miller | 16a1333 | 2002-02-13 14:03:56 +1100 | [diff] [blame] | 40 | .Op Fl R Ar num_requests |
Ben Lindstrom | 6a33763 | 2001-09-18 05:47:32 +0000 | [diff] [blame] | 41 | .Op Fl S Ar program |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 42 | .Op Fl s Ar subsystem | sftp_server |
Ben Lindstrom | 6a33763 | 2001-09-18 05:47:32 +0000 | [diff] [blame] | 43 | .Ar host |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 44 | .Ek |
Damien Miller | d6ead28 | 2003-05-14 19:30:38 +1000 | [diff] [blame] | 45 | .Nm sftp |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 46 | .Oo Oo Ar user Ns @ Oc Ns |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 47 | .Ar host Ns Oo : Ns Ar file Oo |
| 48 | .Ar file Oc Oc Oc |
Damien Miller | d6ead28 | 2003-05-14 19:30:38 +1000 | [diff] [blame] | 49 | .Nm sftp |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 50 | .Oo Oo Ar user Ns @ Oc Ns |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 51 | .Ar host Ns Oo : Ns Ar dir Ns |
| 52 | .Oo Ar / Oc Oc Oc |
Damien Miller | d6ead28 | 2003-05-14 19:30:38 +1000 | [diff] [blame] | 53 | .Nm sftp |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 54 | .Fl b Ar batchfile |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 55 | .Oo Ar user Ns @ Oc Ns Ar host |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 56 | .Sh DESCRIPTION |
| 57 | .Nm |
| 58 | is an interactive file transfer program, similar to |
| 59 | .Xr ftp 1 , |
| 60 | which performs all operations over an encrypted |
| 61 | .Xr ssh 1 |
| 62 | transport. |
| 63 | It may also use many features of ssh, such as public key authentication and |
| 64 | compression. |
| 65 | .Nm |
| 66 | connects and logs into the specified |
Ben Lindstrom | aafff9c | 2001-05-06 03:01:02 +0000 | [diff] [blame] | 67 | .Ar host , |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 68 | then enters an interactive command mode. |
| 69 | .Pp |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 70 | The second usage format will retrieve files automatically if a non-interactive |
Ben Lindstrom | aafff9c | 2001-05-06 03:01:02 +0000 | [diff] [blame] | 71 | authentication method is used; otherwise it will do so after |
| 72 | successful interactive authentication. |
Ben Lindstrom | 63667f6 | 2001-04-13 00:00:14 +0000 | [diff] [blame] | 73 | .Pp |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 74 | The third usage format allows the sftp client to start in a remote directory. |
Ben Lindstrom | 63667f6 | 2001-04-13 00:00:14 +0000 | [diff] [blame] | 75 | .Pp |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 76 | The final usage format allows for automated sessions using the |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 77 | .Fl b |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 78 | option. |
| 79 | In such cases, it is usually necessary to configure public key authentication |
| 80 | to obviate the need to enter a password at connection time (see |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 81 | .Xr sshd 8 |
Damien Miller | d6ead28 | 2003-05-14 19:30:38 +1000 | [diff] [blame] | 82 | and |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 83 | .Xr ssh-keygen 1 |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 84 | for details). |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 85 | The options are as follows: |
| 86 | .Bl -tag -width Ds |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 87 | .It Fl 1 |
| 88 | Specify the use of protocol version 1. |
| 89 | .It Fl B Ar buffer_size |
| 90 | Specify the size of the buffer that |
| 91 | .Nm |
| 92 | uses when transferring files. |
| 93 | Larger buffers require fewer round trips at the cost of higher |
| 94 | memory consumption. |
| 95 | The default is 32768 bytes. |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 96 | .It Fl b Ar batchfile |
| 97 | Batch mode reads a series of commands from an input |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 98 | .Ar batchfile |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 99 | instead of |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 100 | .Em stdin . |
| 101 | Since it lacks user interaction it should be used in conjunction with |
Damien Miller | 86a3968 | 2004-01-21 11:00:04 +1100 | [diff] [blame] | 102 | non-interactive authentication. |
Damien Miller | 44f75c1 | 2004-01-21 10:58:47 +1100 | [diff] [blame] | 103 | A |
Damien Miller | 86a3968 | 2004-01-21 11:00:04 +1100 | [diff] [blame] | 104 | .Ar batchfile |
| 105 | of |
| 106 | .Sq \- |
Damien Miller | 44f75c1 | 2004-01-21 10:58:47 +1100 | [diff] [blame] | 107 | may be used to indicate standard input. |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 108 | .Nm |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 109 | will abort if any of the following |
| 110 | commands fail: |
Ben Lindstrom | 3612bda | 2002-03-05 01:26:38 +0000 | [diff] [blame] | 111 | .Ic get , put , rename , ln , |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 112 | .Ic rm , mkdir , chdir , ls , |
Damien Miller | 956f3fb | 2003-01-10 21:40:00 +1100 | [diff] [blame] | 113 | .Ic lchdir , chmod , chown , chgrp , lpwd |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 114 | and |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 115 | .Ic lmkdir . |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 116 | Termination on error can be suppressed on a command by command basis by |
| 117 | prefixing the command with a |
Damien Miller | 86a3968 | 2004-01-21 11:00:04 +1100 | [diff] [blame] | 118 | .Sq \- |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 119 | character (for example, |
| 120 | .Ic -rm /tmp/blah* ) . |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 121 | .It Fl C |
| 122 | Enables compression (via ssh's |
| 123 | .Fl C |
| 124 | flag). |
| 125 | .It Fl F Ar ssh_config |
| 126 | Specifies an alternative |
| 127 | per-user configuration file for |
| 128 | .Xr ssh 1 . |
| 129 | This option is directly passed to |
| 130 | .Xr ssh 1 . |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 131 | .It Fl o Ar ssh_option |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 132 | Can be used to pass options to |
| 133 | .Nm ssh |
Ben Lindstrom | 3072aae | 2002-06-21 01:02:39 +0000 | [diff] [blame] | 134 | in the format used in |
| 135 | .Xr ssh_config 5 . |
| 136 | This is useful for specifying options |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 137 | for which there is no separate |
| 138 | .Nm sftp |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 139 | command-line flag. |
| 140 | For example, to specify an alternate port use: |
Ben Lindstrom | 6a33763 | 2001-09-18 05:47:32 +0000 | [diff] [blame] | 141 | .Ic sftp -oPort=24 . |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 142 | For full details of the options listed below, and their possible values, see |
| 143 | .Xr ssh_config 5 . |
| 144 | .Pp |
| 145 | .Bl -tag -width Ds -offset indent -compact |
| 146 | .It AddressFamily |
| 147 | .It BatchMode |
| 148 | .It BindAddress |
| 149 | .It ChallengeResponseAuthentication |
| 150 | .It CheckHostIP |
| 151 | .It Cipher |
| 152 | .It Ciphers |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 153 | .It Compression |
| 154 | .It CompressionLevel |
| 155 | .It ConnectionAttempts |
| 156 | .It ConnectionTimeout |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 157 | .It GlobalKnownHostsFile |
| 158 | .It GSSAPIAuthentication |
| 159 | .It GSSAPIDelegateCredentials |
| 160 | .It Host |
| 161 | .It HostbasedAuthentication |
| 162 | .It HostKeyAlgorithms |
| 163 | .It HostKeyAlias |
| 164 | .It HostName |
| 165 | .It IdentityFile |
Damien Miller | bd394c3 | 2004-03-08 23:12:36 +1100 | [diff] [blame] | 166 | .It IdentitiesOnly |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 167 | .It LogLevel |
| 168 | .It MACs |
| 169 | .It NoHostAuthenticationForLocalhost |
| 170 | .It NumberOfPasswordPrompts |
| 171 | .It PasswordAuthentication |
| 172 | .It Port |
| 173 | .It PreferredAuthentications |
| 174 | .It Protocol |
| 175 | .It ProxyCommand |
| 176 | .It PubkeyAuthentication |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 177 | .It RhostsRSAAuthentication |
| 178 | .It RSAAuthentication |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 179 | .It ServerAliveInterval |
| 180 | .It ServerAliveCountMax |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 181 | .It SmartcardDevice |
| 182 | .It StrictHostKeyChecking |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 183 | .It TCPKeepAlive |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 184 | .It UsePrivilegedPort |
| 185 | .It User |
| 186 | .It UserKnownHostsFile |
| 187 | .It VerifyHostKeyDNS |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 188 | .El |
| 189 | .It Fl P Ar sftp_server_path |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 190 | Connect directly to a local sftp server |
Damien Miller | 81b6e78 | 2002-02-08 22:06:03 +1100 | [diff] [blame] | 191 | (rather than via |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 192 | .Xr ssh 1 ) |
Damien Miller | 81b6e78 | 2002-02-08 22:06:03 +1100 | [diff] [blame] | 193 | This option may be useful in debugging the client and server. |
Damien Miller | 16a1333 | 2002-02-13 14:03:56 +1100 | [diff] [blame] | 194 | .It Fl R Ar num_requests |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 195 | Specify how many requests may be outstanding at any one time. |
| 196 | Increasing this may slightly improve file transfer speed |
| 197 | but will increase memory usage. |
| 198 | The default is 16 outstanding requests. |
Ben Lindstrom | 6a33763 | 2001-09-18 05:47:32 +0000 | [diff] [blame] | 199 | .It Fl S Ar program |
| 200 | Name of the |
| 201 | .Ar program |
| 202 | to use for the encrypted connection. |
| 203 | The program must understand |
| 204 | .Xr ssh 1 |
| 205 | options. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 206 | .It Fl s Ar subsystem | sftp_server |
| 207 | Specifies the SSH2 subsystem or the path for an sftp server |
| 208 | on the remote host. |
| 209 | A path is useful for using |
| 210 | .Nm |
| 211 | over protocol version 1, or when the remote |
| 212 | .Xr sshd 8 |
| 213 | does not have an sftp subsystem configured. |
| 214 | .It Fl v |
| 215 | Raise logging level. |
| 216 | This option is also passed to ssh. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 217 | .El |
| 218 | .Sh INTERACTIVE COMMANDS |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 219 | Once in interactive mode, |
| 220 | .Nm |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 221 | understands a set of commands similar to those of |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 222 | .Xr ftp 1 . |
Ben Lindstrom | 27cb1d0 | 2001-02-10 21:59:35 +0000 | [diff] [blame] | 223 | Commands are case insensitive and pathnames may be enclosed in quotes if they |
| 224 | contain spaces. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 225 | .Bl -tag -width "lmdir path" |
Ben Lindstrom | 59e1249 | 2001-08-15 23:22:56 +0000 | [diff] [blame] | 226 | .It Ic bye |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 227 | Quit |
| 228 | .Nm sftp . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 229 | .It Ic cd Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 230 | Change remote directory to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 231 | .Ar path . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 232 | .It Ic chgrp Ar grp Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 233 | Change group of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 234 | .Ar path |
| 235 | to |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 236 | .Ar grp . |
| 237 | .Ar grp |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 238 | must be a numeric GID. |
| 239 | .It Ic chmod Ar mode Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 240 | Change permissions of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 241 | .Ar path |
| 242 | to |
| 243 | .Ar mode . |
| 244 | .It Ic chown Ar own Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 245 | Change owner of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 246 | .Ar path |
| 247 | to |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 248 | .Ar own . |
| 249 | .Ar own |
| 250 | must be a numeric UID. |
Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame] | 251 | .It Ic exit |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 252 | Quit |
| 253 | .Nm sftp . |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 254 | .It Xo Ic get |
| 255 | .Op Ar flags |
| 256 | .Ar remote-path |
| 257 | .Op Ar local-path |
| 258 | .Xc |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 259 | Retrieve the |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 260 | .Ar remote-path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 261 | and store it on the local machine. |
| 262 | If the local |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 263 | path name is not specified, it is given the same name it has on the |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 264 | remote machine. |
| 265 | If the |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 266 | .Fl P |
| 267 | flag is specified, then the file's full permission and access time are |
| 268 | copied too. |
Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame] | 269 | .It Ic help |
| 270 | Display help text. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 271 | .It Ic lcd Ar path |
| 272 | Change local directory to |
| 273 | .Ar path . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 274 | .It Ic lls Op Ar ls-options Op Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 275 | Display local directory listing of either |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 276 | .Ar path |
| 277 | or current directory if |
| 278 | .Ar path |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 279 | is not specified. |
| 280 | .It Ic lmkdir Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 281 | Create local directory specified by |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 282 | .Ar path . |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 283 | .It Ic ln Ar oldpath Ar newpath |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 284 | Create a symbolic link from |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 285 | .Ar oldpath |
| 286 | to |
| 287 | .Ar newpath . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 288 | .It Ic lpwd |
| 289 | Print local working directory. |
Damien Miller | e1a4981 | 2002-09-12 09:54:25 +1000 | [diff] [blame] | 290 | .It Xo Ic ls |
| 291 | .Op Ar flags |
| 292 | .Op Ar path |
| 293 | .Xc |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 294 | Display remote directory listing of either |
| 295 | .Ar path |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 296 | or current directory if |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 297 | .Ar path |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 298 | is not specified. |
| 299 | If the |
Damien Miller | e1a4981 | 2002-09-12 09:54:25 +1000 | [diff] [blame] | 300 | .Fl l |
| 301 | flag is specified, then display additional details including permissions |
| 302 | and ownership information. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 303 | .It Ic lumask Ar umask |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 304 | Set local umask to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 305 | .Ar umask . |
| 306 | .It Ic mkdir Ar path |
| 307 | Create remote directory specified by |
| 308 | .Ar path . |
Damien Miller | 62d57f6 | 2003-01-10 21:43:24 +1100 | [diff] [blame] | 309 | .It Ic progress |
| 310 | Toggle display of progress meter. |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 311 | .It Xo Ic put |
| 312 | .Op Ar flags |
| 313 | .Ar local-path |
Ben Lindstrom | d576781 | 2002-12-23 02:23:37 +0000 | [diff] [blame] | 314 | .Op Ar remote-path |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 315 | .Xc |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 316 | Upload |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 317 | .Ar local-path |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 318 | and store it on the remote machine. |
| 319 | If the remote path name is not specified, it is given the same name it has |
| 320 | on the local machine. |
| 321 | If the |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 322 | .Fl P |
| 323 | flag is specified, then the file's full permission and access time are |
| 324 | copied too. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 325 | .It Ic pwd |
| 326 | Display remote working directory. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 327 | .It Ic quit |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 328 | Quit |
| 329 | .Nm sftp . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 330 | .It Ic rename Ar oldpath Ar newpath |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 331 | Rename remote file from |
| 332 | .Ar oldpath |
| 333 | to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 334 | .Ar newpath . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 335 | .It Ic rm Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 336 | Delete remote file specified by |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 337 | .Ar path . |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 338 | .It Ic rmdir Ar path |
| 339 | Remove remote directory specified by |
| 340 | .Ar path . |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 341 | .It Ic symlink Ar oldpath Ar newpath |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 342 | Create a symbolic link from |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 343 | .Ar oldpath |
| 344 | to |
| 345 | .Ar newpath . |
Damien Miller | 6342180 | 2003-01-08 14:05:23 +1100 | [diff] [blame] | 346 | .It Ic version |
| 347 | Display the |
| 348 | .Nm |
| 349 | protocol version. |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 350 | .It Ic \&! Ar command |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 351 | Execute |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 352 | .Ar command |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 353 | in local shell. |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 354 | .It Ic \&! |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 355 | Escape to local shell. |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 356 | .It Ic \&? |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 357 | Synonym for help. |
| 358 | .El |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 359 | .Sh SEE ALSO |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 360 | .Xr ftp 1 , |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 361 | .Xr scp 1 , |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 362 | .Xr ssh 1 , |
| 363 | .Xr ssh-add 1 , |
| 364 | .Xr ssh-keygen 1 , |
Ben Lindstrom | 3072aae | 2002-06-21 01:02:39 +0000 | [diff] [blame] | 365 | .Xr ssh_config 5 , |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 366 | .Xr sftp-server 8 , |
| 367 | .Xr sshd 8 |
| 368 | .Rs |
Ben Lindstrom | 90fd060 | 2001-06-25 04:45:33 +0000 | [diff] [blame] | 369 | .%A T. Ylonen |
| 370 | .%A S. Lehtinen |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 371 | .%T "SSH File Transfer Protocol" |
| 372 | .%N draft-ietf-secsh-filexfer-00.txt |
| 373 | .%D January 2001 |
| 374 | .%O work in progress material |
| 375 | .Re |