Darren Tucker | aa4d5ed | 2007-06-05 18:27:13 +1000 | [diff] [blame] | 1 | .\" $OpenBSD: sftp.1,v 1.64 2007/05/31 19:20:16 jmc 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 | .\" |
Darren Tucker | aa4d5ed | 2007-06-05 18:27:13 +1000 | [diff] [blame] | 25 | .Dd $Mdocdate: May 31 2007 $ |
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 |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 74 | The third usage format allows |
| 75 | .Nm |
| 76 | to start in a remote directory. |
Ben Lindstrom | 63667f6 | 2001-04-13 00:00:14 +0000 | [diff] [blame] | 77 | .Pp |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 78 | The final usage format allows for automated sessions using the |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 79 | .Fl b |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 80 | option. |
Damien Miller | 134eb81 | 2005-12-31 16:22:55 +1100 | [diff] [blame] | 81 | In such cases, it is necessary to configure non-interactive authentication |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 82 | to obviate the need to enter a password at connection time (see |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 83 | .Xr sshd 8 |
Damien Miller | d6ead28 | 2003-05-14 19:30:38 +1000 | [diff] [blame] | 84 | and |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 85 | .Xr ssh-keygen 1 |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 86 | for details). |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 87 | The options are as follows: |
| 88 | .Bl -tag -width Ds |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 89 | .It Fl 1 |
| 90 | Specify the use of protocol version 1. |
| 91 | .It Fl B Ar buffer_size |
| 92 | Specify the size of the buffer that |
| 93 | .Nm |
| 94 | uses when transferring files. |
| 95 | Larger buffers require fewer round trips at the cost of higher |
| 96 | memory consumption. |
| 97 | The default is 32768 bytes. |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 98 | .It Fl b Ar batchfile |
| 99 | Batch mode reads a series of commands from an input |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 100 | .Ar batchfile |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 101 | instead of |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 102 | .Em stdin . |
| 103 | Since it lacks user interaction it should be used in conjunction with |
Damien Miller | 86a3968 | 2004-01-21 11:00:04 +1100 | [diff] [blame] | 104 | non-interactive authentication. |
Damien Miller | 44f75c1 | 2004-01-21 10:58:47 +1100 | [diff] [blame] | 105 | A |
Damien Miller | 86a3968 | 2004-01-21 11:00:04 +1100 | [diff] [blame] | 106 | .Ar batchfile |
| 107 | of |
| 108 | .Sq \- |
Damien Miller | 44f75c1 | 2004-01-21 10:58:47 +1100 | [diff] [blame] | 109 | may be used to indicate standard input. |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 110 | .Nm |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 111 | will abort if any of the following |
| 112 | commands fail: |
Ben Lindstrom | 3612bda | 2002-03-05 01:26:38 +0000 | [diff] [blame] | 113 | .Ic get , put , rename , ln , |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 114 | .Ic rm , mkdir , chdir , ls , |
Damien Miller | 956f3fb | 2003-01-10 21:40:00 +1100 | [diff] [blame] | 115 | .Ic lchdir , chmod , chown , chgrp , lpwd |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 116 | and |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 117 | .Ic lmkdir . |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 118 | Termination on error can be suppressed on a command by command basis by |
| 119 | prefixing the command with a |
Damien Miller | 86a3968 | 2004-01-21 11:00:04 +1100 | [diff] [blame] | 120 | .Sq \- |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 121 | character (for example, |
| 122 | .Ic -rm /tmp/blah* ) . |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 123 | .It Fl C |
| 124 | Enables compression (via ssh's |
| 125 | .Fl C |
| 126 | flag). |
| 127 | .It Fl F Ar ssh_config |
| 128 | Specifies an alternative |
| 129 | per-user configuration file for |
| 130 | .Xr ssh 1 . |
| 131 | This option is directly passed to |
| 132 | .Xr ssh 1 . |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 133 | .It Fl o Ar ssh_option |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 134 | Can be used to pass options to |
| 135 | .Nm ssh |
Ben Lindstrom | 3072aae | 2002-06-21 01:02:39 +0000 | [diff] [blame] | 136 | in the format used in |
| 137 | .Xr ssh_config 5 . |
| 138 | This is useful for specifying options |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 139 | for which there is no separate |
| 140 | .Nm sftp |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 141 | command-line flag. |
| 142 | For example, to specify an alternate port use: |
Ben Lindstrom | 6a33763 | 2001-09-18 05:47:32 +0000 | [diff] [blame] | 143 | .Ic sftp -oPort=24 . |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 144 | For full details of the options listed below, and their possible values, see |
| 145 | .Xr ssh_config 5 . |
| 146 | .Pp |
| 147 | .Bl -tag -width Ds -offset indent -compact |
| 148 | .It AddressFamily |
| 149 | .It BatchMode |
| 150 | .It BindAddress |
| 151 | .It ChallengeResponseAuthentication |
| 152 | .It CheckHostIP |
| 153 | .It Cipher |
| 154 | .It Ciphers |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 155 | .It Compression |
| 156 | .It CompressionLevel |
| 157 | .It ConnectionAttempts |
Darren Tucker | 3d5cbb7 | 2004-05-03 09:13:15 +1000 | [diff] [blame] | 158 | .It ConnectTimeout |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 159 | .It ControlMaster |
| 160 | .It ControlPath |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 161 | .It GlobalKnownHostsFile |
| 162 | .It GSSAPIAuthentication |
| 163 | .It GSSAPIDelegateCredentials |
Damien Miller | 27e9c51 | 2005-03-02 12:04:16 +1100 | [diff] [blame] | 164 | .It HashKnownHosts |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 165 | .It Host |
| 166 | .It HostbasedAuthentication |
| 167 | .It HostKeyAlgorithms |
| 168 | .It HostKeyAlias |
| 169 | .It HostName |
| 170 | .It IdentityFile |
Damien Miller | bd394c3 | 2004-03-08 23:12:36 +1100 | [diff] [blame] | 171 | .It IdentitiesOnly |
Darren Tucker | 636ca90 | 2004-11-05 20:22:00 +1100 | [diff] [blame] | 172 | .It KbdInteractiveDevices |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 173 | .It LogLevel |
| 174 | .It MACs |
| 175 | .It NoHostAuthenticationForLocalhost |
| 176 | .It NumberOfPasswordPrompts |
| 177 | .It PasswordAuthentication |
| 178 | .It Port |
| 179 | .It PreferredAuthentications |
| 180 | .It Protocol |
| 181 | .It ProxyCommand |
| 182 | .It PubkeyAuthentication |
Darren Tucker | 62388b2 | 2006-01-20 11:31:47 +1100 | [diff] [blame] | 183 | .It RekeyLimit |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 184 | .It RhostsRSAAuthentication |
| 185 | .It RSAAuthentication |
Darren Tucker | 7a6c066 | 2004-05-02 22:14:03 +1000 | [diff] [blame] | 186 | .It SendEnv |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 187 | .It ServerAliveInterval |
| 188 | .It ServerAliveCountMax |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 189 | .It SmartcardDevice |
| 190 | .It StrictHostKeyChecking |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 191 | .It TCPKeepAlive |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 192 | .It UsePrivilegedPort |
| 193 | .It User |
| 194 | .It UserKnownHostsFile |
| 195 | .It VerifyHostKeyDNS |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 196 | .El |
| 197 | .It Fl P Ar sftp_server_path |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 198 | Connect directly to a local sftp server |
Damien Miller | 81b6e78 | 2002-02-08 22:06:03 +1100 | [diff] [blame] | 199 | (rather than via |
Darren Tucker | 0133a72 | 2004-12-06 22:44:32 +1100 | [diff] [blame] | 200 | .Xr ssh 1 ) . |
Damien Miller | 81b6e78 | 2002-02-08 22:06:03 +1100 | [diff] [blame] | 201 | This option may be useful in debugging the client and server. |
Damien Miller | 16a1333 | 2002-02-13 14:03:56 +1100 | [diff] [blame] | 202 | .It Fl R Ar num_requests |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 203 | Specify how many requests may be outstanding at any one time. |
| 204 | Increasing this may slightly improve file transfer speed |
| 205 | but will increase memory usage. |
| 206 | The default is 16 outstanding requests. |
Ben Lindstrom | 6a33763 | 2001-09-18 05:47:32 +0000 | [diff] [blame] | 207 | .It Fl S Ar program |
| 208 | Name of the |
| 209 | .Ar program |
| 210 | to use for the encrypted connection. |
| 211 | The program must understand |
| 212 | .Xr ssh 1 |
| 213 | options. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 214 | .It Fl s Ar subsystem | sftp_server |
| 215 | Specifies the SSH2 subsystem or the path for an sftp server |
| 216 | on the remote host. |
| 217 | A path is useful for using |
| 218 | .Nm |
| 219 | over protocol version 1, or when the remote |
| 220 | .Xr sshd 8 |
| 221 | does not have an sftp subsystem configured. |
| 222 | .It Fl v |
| 223 | Raise logging level. |
| 224 | This option is also passed to ssh. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 225 | .El |
| 226 | .Sh INTERACTIVE COMMANDS |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 227 | Once in interactive mode, |
| 228 | .Nm |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 229 | understands a set of commands similar to those of |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 230 | .Xr ftp 1 . |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 231 | Commands are case insensitive. |
| 232 | Pathnames that contain spaces must be enclosed in quotes. |
| 233 | Any special characters contained within pathnames that are recognized by |
| 234 | .Xr glob 3 |
| 235 | must be escaped with backslashes |
| 236 | .Pq Sq \e . |
| 237 | .Bl -tag -width Ds |
Ben Lindstrom | 59e1249 | 2001-08-15 23:22:56 +0000 | [diff] [blame] | 238 | .It Ic bye |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 239 | Quit |
| 240 | .Nm sftp . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 241 | .It Ic cd Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 242 | Change remote directory to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 243 | .Ar path . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 244 | .It Ic chgrp Ar grp Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 245 | Change group 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 grp . |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 249 | .Ar path |
| 250 | may contain |
| 251 | .Xr glob 3 |
| 252 | characters and may match multiple files. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 253 | .Ar grp |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 254 | must be a numeric GID. |
| 255 | .It Ic chmod Ar mode Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 256 | Change permissions of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 257 | .Ar path |
| 258 | to |
| 259 | .Ar mode . |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 260 | .Ar path |
| 261 | may contain |
| 262 | .Xr glob 3 |
| 263 | characters and may match multiple files. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 264 | .It Ic chown Ar own Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 265 | Change owner of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 266 | .Ar path |
| 267 | to |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 268 | .Ar own . |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 269 | .Ar path |
| 270 | may contain |
| 271 | .Xr glob 3 |
| 272 | characters and may match multiple files. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 273 | .Ar own |
| 274 | must be a numeric UID. |
Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame] | 275 | .It Ic exit |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 276 | Quit |
| 277 | .Nm sftp . |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 278 | .It Xo Ic get |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 279 | .Op Fl P |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 280 | .Ar remote-path |
| 281 | .Op Ar local-path |
| 282 | .Xc |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 283 | Retrieve the |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 284 | .Ar remote-path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 285 | and store it on the local machine. |
| 286 | If the local |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 287 | 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] | 288 | remote machine. |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 289 | .Ar remote-path |
| 290 | may contain |
| 291 | .Xr glob 3 |
| 292 | characters and may match multiple files. |
| 293 | If it does and |
| 294 | .Ar local-path |
| 295 | is specified, then |
| 296 | .Ar local-path |
| 297 | must specify a directory. |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 298 | If the |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 299 | .Fl P |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 300 | flag is specified, then full file permissions and access times are |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 301 | copied too. |
Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame] | 302 | .It Ic help |
| 303 | Display help text. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 304 | .It Ic lcd Ar path |
| 305 | Change local directory to |
| 306 | .Ar path . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 307 | .It Ic lls Op Ar ls-options Op Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 308 | Display local directory listing of either |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 309 | .Ar path |
| 310 | or current directory if |
| 311 | .Ar path |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 312 | is not specified. |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 313 | .Ar ls-options |
| 314 | may contain any flags supported by the local system's |
| 315 | .Xr ls 1 |
| 316 | command. |
| 317 | .Ar path |
| 318 | may contain |
| 319 | .Xr glob 3 |
| 320 | characters and may match multiple files. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 321 | .It Ic lmkdir Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 322 | Create local directory specified by |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 323 | .Ar path . |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 324 | .It Ic ln Ar oldpath Ar newpath |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 325 | Create a symbolic link from |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 326 | .Ar oldpath |
| 327 | to |
| 328 | .Ar newpath . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 329 | .It Ic lpwd |
| 330 | Print local working directory. |
Damien Miller | e1a4981 | 2002-09-12 09:54:25 +1000 | [diff] [blame] | 331 | .It Xo Ic ls |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 332 | .Op Fl 1aflnrSt |
Damien Miller | e1a4981 | 2002-09-12 09:54:25 +1000 | [diff] [blame] | 333 | .Op Ar path |
| 334 | .Xc |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 335 | Display a remote directory listing of either |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 336 | .Ar path |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 337 | or the current directory if |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 338 | .Ar path |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 339 | is not specified. |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 340 | .Ar path |
| 341 | may contain |
| 342 | .Xr glob 3 |
| 343 | characters and may match multiple files. |
Darren Tucker | 15ca6e8 | 2004-06-22 13:08:21 +1000 | [diff] [blame] | 344 | .Pp |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 345 | The following flags are recognized and alter the behaviour of |
Darren Tucker | 15ca6e8 | 2004-06-22 13:08:21 +1000 | [diff] [blame] | 346 | .Ic ls |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 347 | accordingly: |
| 348 | .Bl -tag -width Ds |
| 349 | .It Fl 1 |
| 350 | Produce single columnar output. |
| 351 | .It Fl a |
| 352 | List files beginning with a dot |
| 353 | .Pq Sq \&. . |
| 354 | .It Fl f |
| 355 | Do not sort the listing. |
| 356 | The default sort order is lexicographical. |
| 357 | .It Fl l |
| 358 | Display additional details including permissions |
| 359 | and ownership information. |
| 360 | .It Fl n |
| 361 | Produce a long listing with user and group information presented |
| 362 | numerically. |
| 363 | .It Fl r |
| 364 | Reverse the sort order of the listing. |
| 365 | .It Fl S |
| 366 | Sort the listing by file size. |
| 367 | .It Fl t |
| 368 | Sort the listing by last modification time. |
| 369 | .El |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 370 | .It Ic lumask Ar umask |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 371 | Set local umask to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 372 | .Ar umask . |
| 373 | .It Ic mkdir Ar path |
| 374 | Create remote directory specified by |
| 375 | .Ar path . |
Damien Miller | 62d57f6 | 2003-01-10 21:43:24 +1100 | [diff] [blame] | 376 | .It Ic progress |
| 377 | Toggle display of progress meter. |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 378 | .It Xo Ic put |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 379 | .Op Fl P |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 380 | .Ar local-path |
Ben Lindstrom | d576781 | 2002-12-23 02:23:37 +0000 | [diff] [blame] | 381 | .Op Ar remote-path |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 382 | .Xc |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 383 | Upload |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 384 | .Ar local-path |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 385 | and store it on the remote machine. |
| 386 | If the remote path name is not specified, it is given the same name it has |
| 387 | on the local machine. |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 388 | .Ar local-path |
| 389 | may contain |
| 390 | .Xr glob 3 |
| 391 | characters and may match multiple files. |
| 392 | If it does and |
| 393 | .Ar remote-path |
| 394 | is specified, then |
| 395 | .Ar remote-path |
| 396 | must specify a directory. |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 397 | If the |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 398 | .Fl P |
| 399 | flag is specified, then the file's full permission and access time are |
| 400 | copied too. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 401 | .It Ic pwd |
| 402 | Display remote working directory. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 403 | .It Ic quit |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 404 | Quit |
| 405 | .Nm sftp . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 406 | .It Ic rename Ar oldpath Ar newpath |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 407 | Rename remote file from |
| 408 | .Ar oldpath |
| 409 | to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 410 | .Ar newpath . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 411 | .It Ic rm Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 412 | Delete remote file specified by |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 413 | .Ar path . |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 414 | .It Ic rmdir Ar path |
| 415 | Remove remote directory specified by |
| 416 | .Ar path . |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 417 | .It Ic symlink Ar oldpath Ar newpath |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 418 | Create a symbolic link from |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 419 | .Ar oldpath |
| 420 | to |
| 421 | .Ar newpath . |
Damien Miller | 6342180 | 2003-01-08 14:05:23 +1100 | [diff] [blame] | 422 | .It Ic version |
| 423 | Display the |
| 424 | .Nm |
| 425 | protocol version. |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 426 | .It Ic \&! Ar command |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 427 | Execute |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 428 | .Ar command |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 429 | in local shell. |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 430 | .It Ic \&! |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 431 | Escape to local shell. |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 432 | .It Ic \&? |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 433 | Synonym for help. |
| 434 | .El |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 435 | .Sh SEE ALSO |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 436 | .Xr ftp 1 , |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 437 | .Xr ls 1 , |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 438 | .Xr scp 1 , |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 439 | .Xr ssh 1 , |
| 440 | .Xr ssh-add 1 , |
| 441 | .Xr ssh-keygen 1 , |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 442 | .Xr glob 3 , |
Ben Lindstrom | 3072aae | 2002-06-21 01:02:39 +0000 | [diff] [blame] | 443 | .Xr ssh_config 5 , |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 444 | .Xr sftp-server 8 , |
| 445 | .Xr sshd 8 |
| 446 | .Rs |
Ben Lindstrom | 90fd060 | 2001-06-25 04:45:33 +0000 | [diff] [blame] | 447 | .%A T. Ylonen |
| 448 | .%A S. Lehtinen |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 449 | .%T "SSH File Transfer Protocol" |
| 450 | .%N draft-ietf-secsh-filexfer-00.txt |
| 451 | .%D January 2001 |
| 452 | .%O work in progress material |
| 453 | .Re |