markus@openbsd.org | 75e2168 | 2016-05-04 14:32:26 +0000 | [diff] [blame] | 1 | .\" $OpenBSD: sftp.1,v 1.103 2016/05/04 14:32:26 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 | .\" |
markus@openbsd.org | 75e2168 | 2016-05-04 14:32:26 +0000 | [diff] [blame] | 25 | .Dd $Mdocdate: May 4 2016 $ |
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 |
Damien Miller | f29238e | 2013-10-17 11:48:52 +1100 | [diff] [blame] | 34 | .Op Fl 1246aCfpqrv |
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 |
Darren Tucker | 46bbbe3 | 2009-10-07 08:21:48 +1100 | [diff] [blame] | 37 | .Op Fl c Ar cipher |
Darren Tucker | 282b402 | 2009-10-07 08:23:06 +1100 | [diff] [blame] | 38 | .Op Fl D Ar sftp_server_path |
Damien Miller | 81b6e78 | 2002-02-08 22:06:03 +1100 | [diff] [blame] | 39 | .Op Fl F Ar ssh_config |
Darren Tucker | c07138e | 2009-10-07 08:23:44 +1100 | [diff] [blame] | 40 | .Op Fl i Ar identity_file |
Damien Miller | 65e42f8 | 2010-09-24 22:15:11 +1000 | [diff] [blame] | 41 | .Op Fl l Ar limit |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 42 | .Op Fl o Ar ssh_option |
Darren Tucker | 282b402 | 2009-10-07 08:23:06 +1100 | [diff] [blame] | 43 | .Op Fl P Ar port |
Damien Miller | 16a1333 | 2002-02-13 14:03:56 +1100 | [diff] [blame] | 44 | .Op Fl R Ar num_requests |
Ben Lindstrom | 6a33763 | 2001-09-18 05:47:32 +0000 | [diff] [blame] | 45 | .Op Fl S Ar program |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 46 | .Op Fl s Ar subsystem | sftp_server |
Ben Lindstrom | 6a33763 | 2001-09-18 05:47:32 +0000 | [diff] [blame] | 47 | .Ar host |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 48 | .Ek |
Damien Miller | d6ead28 | 2003-05-14 19:30:38 +1000 | [diff] [blame] | 49 | .Nm sftp |
Damien Miller | 7ebfad7 | 2008-12-09 14:12:33 +1100 | [diff] [blame] | 50 | .Oo Ar user Ns @ Oc Ns |
| 51 | .Ar host Ns Op : Ns Ar |
Damien Miller | d6ead28 | 2003-05-14 19:30:38 +1000 | [diff] [blame] | 52 | .Nm sftp |
Damien Miller | 881adf7 | 2010-09-24 22:01:54 +1000 | [diff] [blame] | 53 | .Oo |
| 54 | .Ar user Ns @ Oc Ns |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 55 | .Ar host Ns Oo : Ns Ar dir Ns |
Damien Miller | 881adf7 | 2010-09-24 22:01:54 +1000 | [diff] [blame] | 56 | .Op Ar / |
| 57 | .Oc |
Damien Miller | d6ead28 | 2003-05-14 19:30:38 +1000 | [diff] [blame] | 58 | .Nm sftp |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 59 | .Fl b Ar batchfile |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 60 | .Oo Ar user Ns @ Oc Ns Ar host |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 61 | .Sh DESCRIPTION |
| 62 | .Nm |
| 63 | is an interactive file transfer program, similar to |
| 64 | .Xr ftp 1 , |
| 65 | which performs all operations over an encrypted |
| 66 | .Xr ssh 1 |
| 67 | transport. |
| 68 | It may also use many features of ssh, such as public key authentication and |
| 69 | compression. |
| 70 | .Nm |
| 71 | connects and logs into the specified |
Ben Lindstrom | aafff9c | 2001-05-06 03:01:02 +0000 | [diff] [blame] | 72 | .Ar host , |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 73 | then enters an interactive command mode. |
| 74 | .Pp |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 75 | The second usage format will retrieve files automatically if a non-interactive |
Ben Lindstrom | aafff9c | 2001-05-06 03:01:02 +0000 | [diff] [blame] | 76 | authentication method is used; otherwise it will do so after |
| 77 | successful interactive authentication. |
Ben Lindstrom | 63667f6 | 2001-04-13 00:00:14 +0000 | [diff] [blame] | 78 | .Pp |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 79 | The third usage format allows |
| 80 | .Nm |
| 81 | to start in a remote directory. |
Ben Lindstrom | 63667f6 | 2001-04-13 00:00:14 +0000 | [diff] [blame] | 82 | .Pp |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 83 | The final usage format allows for automated sessions using the |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 84 | .Fl b |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 85 | option. |
Damien Miller | 134eb81 | 2005-12-31 16:22:55 +1100 | [diff] [blame] | 86 | In such cases, it is necessary to configure non-interactive authentication |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 87 | to obviate the need to enter a password at connection time (see |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 88 | .Xr sshd 8 |
Damien Miller | d6ead28 | 2003-05-14 19:30:38 +1000 | [diff] [blame] | 89 | and |
Damien Miller | fb7508e | 2003-05-14 13:47:07 +1000 | [diff] [blame] | 90 | .Xr ssh-keygen 1 |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 91 | for details). |
Damien Miller | 58a77e2 | 2011-05-15 08:36:29 +1000 | [diff] [blame] | 92 | .Pp |
| 93 | Since some usage formats use colon characters to delimit host names from path |
| 94 | names, IPv6 addresses must be enclosed in square brackets to avoid ambiguity. |
| 95 | .Pp |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 96 | The options are as follows: |
| 97 | .Bl -tag -width Ds |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 98 | .It Fl 1 |
| 99 | Specify the use of protocol version 1. |
Darren Tucker | 46bbbe3 | 2009-10-07 08:21:48 +1100 | [diff] [blame] | 100 | .It Fl 2 |
| 101 | Specify the use of protocol version 2. |
| 102 | .It Fl 4 |
| 103 | Forces |
| 104 | .Nm |
| 105 | to use IPv4 addresses only. |
| 106 | .It Fl 6 |
| 107 | Forces |
| 108 | .Nm |
| 109 | to use IPv6 addresses only. |
Damien Miller | c6895c5 | 2013-08-21 02:40:21 +1000 | [diff] [blame] | 110 | .It Fl a |
Damien Miller | 798a025 | 2014-05-15 13:47:37 +1000 | [diff] [blame] | 111 | Attempt to continue interrupted transfers rather than overwriting |
Damien Miller | d875ff7 | 2014-05-15 13:47:15 +1000 | [diff] [blame] | 112 | existing partial or complete copies of files. |
Damien Miller | 798a025 | 2014-05-15 13:47:37 +1000 | [diff] [blame] | 113 | If the partial contents differ from those being transferred, |
Damien Miller | d875ff7 | 2014-05-15 13:47:15 +1000 | [diff] [blame] | 114 | then the resultant file is likely to be corrupt. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 115 | .It Fl B Ar buffer_size |
| 116 | Specify the size of the buffer that |
| 117 | .Nm |
| 118 | uses when transferring files. |
| 119 | Larger buffers require fewer round trips at the cost of higher |
| 120 | memory consumption. |
| 121 | The default is 32768 bytes. |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 122 | .It Fl b Ar batchfile |
| 123 | Batch mode reads a series of commands from an input |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 124 | .Ar batchfile |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 125 | instead of |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 126 | .Em stdin . |
| 127 | Since it lacks user interaction it should be used in conjunction with |
Damien Miller | 86a3968 | 2004-01-21 11:00:04 +1100 | [diff] [blame] | 128 | non-interactive authentication. |
Damien Miller | 44f75c1 | 2004-01-21 10:58:47 +1100 | [diff] [blame] | 129 | A |
Damien Miller | 86a3968 | 2004-01-21 11:00:04 +1100 | [diff] [blame] | 130 | .Ar batchfile |
| 131 | of |
| 132 | .Sq \- |
Damien Miller | 44f75c1 | 2004-01-21 10:58:47 +1100 | [diff] [blame] | 133 | may be used to indicate standard input. |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 134 | .Nm |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 135 | will abort if any of the following |
| 136 | commands fail: |
Damien Miller | d875ff7 | 2014-05-15 13:47:15 +1000 | [diff] [blame] | 137 | .Ic get , put , reget , reput, rename , ln , |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 138 | .Ic rm , mkdir , chdir , ls , |
Damien Miller | 64058cb | 2008-05-19 14:54:25 +1000 | [diff] [blame] | 139 | .Ic lchdir , chmod , chown , |
Darren Tucker | af1f909 | 2010-12-05 09:02:47 +1100 | [diff] [blame] | 140 | .Ic chgrp , lpwd , df , symlink , |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 141 | and |
Ben Lindstrom | 283cb82 | 2001-03-09 00:09:02 +0000 | [diff] [blame] | 142 | .Ic lmkdir . |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 143 | Termination on error can be suppressed on a command by command basis by |
| 144 | prefixing the command with a |
Damien Miller | 86a3968 | 2004-01-21 11:00:04 +1100 | [diff] [blame] | 145 | .Sq \- |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 146 | character (for example, |
| 147 | .Ic -rm /tmp/blah* ) . |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 148 | .It Fl C |
| 149 | Enables compression (via ssh's |
| 150 | .Fl C |
| 151 | flag). |
Darren Tucker | adba1ba | 2009-10-07 08:22:20 +1100 | [diff] [blame] | 152 | .It Fl c Ar cipher |
| 153 | Selects the cipher to use for encrypting the data transfers. |
| 154 | This option is directly passed to |
| 155 | .Xr ssh 1 . |
Darren Tucker | 282b402 | 2009-10-07 08:23:06 +1100 | [diff] [blame] | 156 | .It Fl D Ar sftp_server_path |
| 157 | Connect directly to a local sftp server |
| 158 | (rather than via |
| 159 | .Xr ssh 1 ) . |
| 160 | This option may be useful in debugging the client and server. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 161 | .It Fl F Ar ssh_config |
| 162 | Specifies an alternative |
| 163 | per-user configuration file for |
| 164 | .Xr ssh 1 . |
| 165 | This option is directly passed to |
| 166 | .Xr ssh 1 . |
Damien Miller | f29238e | 2013-10-17 11:48:52 +1100 | [diff] [blame] | 167 | .It Fl f |
| 168 | Requests that files be flushed to disk immediately after transfer. |
| 169 | When uploading files, this feature is only enabled if the server |
| 170 | implements the "fsync@openssh.com" extension. |
Darren Tucker | 46bbbe3 | 2009-10-07 08:21:48 +1100 | [diff] [blame] | 171 | .It Fl i Ar identity_file |
| 172 | Selects the file from which the identity (private key) for public key |
| 173 | authentication is read. |
| 174 | This option is directly passed to |
| 175 | .Xr ssh 1 . |
Damien Miller | 65e42f8 | 2010-09-24 22:15:11 +1000 | [diff] [blame] | 176 | .It Fl l Ar limit |
| 177 | Limits the used bandwidth, specified in Kbit/s. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 178 | .It Fl o Ar ssh_option |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 179 | Can be used to pass options to |
| 180 | .Nm ssh |
Ben Lindstrom | 3072aae | 2002-06-21 01:02:39 +0000 | [diff] [blame] | 181 | in the format used in |
| 182 | .Xr ssh_config 5 . |
| 183 | This is useful for specifying options |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 184 | for which there is no separate |
| 185 | .Nm sftp |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 186 | command-line flag. |
| 187 | For example, to specify an alternate port use: |
Ben Lindstrom | 6a33763 | 2001-09-18 05:47:32 +0000 | [diff] [blame] | 188 | .Ic sftp -oPort=24 . |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 189 | For full details of the options listed below, and their possible values, see |
| 190 | .Xr ssh_config 5 . |
| 191 | .Pp |
| 192 | .Bl -tag -width Ds -offset indent -compact |
| 193 | .It AddressFamily |
| 194 | .It BatchMode |
| 195 | .It BindAddress |
Damien Miller | c0049bd | 2013-10-23 16:29:59 +1100 | [diff] [blame] | 196 | .It CanonicalDomains |
| 197 | .It CanonicalizeFallbackLocal |
| 198 | .It CanonicalizeHostname |
| 199 | .It CanonicalizeMaxDots |
| 200 | .It CanonicalizePermittedCNAMEs |
jmc@openbsd.org | c5f7c08 | 2015-09-25 18:19:54 +0000 | [diff] [blame] | 201 | .It CertificateFile |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 202 | .It ChallengeResponseAuthentication |
| 203 | .It CheckHostIP |
| 204 | .It Cipher |
| 205 | .It Ciphers |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 206 | .It Compression |
| 207 | .It CompressionLevel |
| 208 | .It ConnectionAttempts |
Darren Tucker | 3d5cbb7 | 2004-05-03 09:13:15 +1000 | [diff] [blame] | 209 | .It ConnectTimeout |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 210 | .It ControlMaster |
| 211 | .It ControlPath |
Damien Miller | e577772 | 2011-09-22 21:34:15 +1000 | [diff] [blame] | 212 | .It ControlPersist |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 213 | .It GlobalKnownHostsFile |
| 214 | .It GSSAPIAuthentication |
| 215 | .It GSSAPIDelegateCredentials |
Damien Miller | 27e9c51 | 2005-03-02 12:04:16 +1100 | [diff] [blame] | 216 | .It HashKnownHosts |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 217 | .It Host |
| 218 | .It HostbasedAuthentication |
djm@openbsd.org | 46347ed | 2015-01-30 11:43:14 +0000 | [diff] [blame] | 219 | .It HostbasedKeyTypes |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 220 | .It HostKeyAlgorithms |
| 221 | .It HostKeyAlias |
| 222 | .It HostName |
markus@openbsd.org | 75e2168 | 2016-05-04 14:32:26 +0000 | [diff] [blame] | 223 | .It IdentityAgent |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 224 | .It IdentityFile |
Damien Miller | bd394c3 | 2004-03-08 23:12:36 +1100 | [diff] [blame] | 225 | .It IdentitiesOnly |
Damien Miller | 0a18473 | 2010-11-20 15:21:03 +1100 | [diff] [blame] | 226 | .It IPQoS |
Damien Miller | e577772 | 2011-09-22 21:34:15 +1000 | [diff] [blame] | 227 | .It KbdInteractiveAuthentication |
Darren Tucker | 636ca90 | 2004-11-05 20:22:00 +1100 | [diff] [blame] | 228 | .It KbdInteractiveDevices |
Damien Miller | 2beb32f | 2010-09-24 22:16:03 +1000 | [diff] [blame] | 229 | .It KexAlgorithms |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 230 | .It LogLevel |
| 231 | .It MACs |
| 232 | .It NoHostAuthenticationForLocalhost |
| 233 | .It NumberOfPasswordPrompts |
| 234 | .It PasswordAuthentication |
Damien Miller | 7ea845e | 2010-02-12 09:21:02 +1100 | [diff] [blame] | 235 | .It PKCS11Provider |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 236 | .It Port |
| 237 | .It PreferredAuthentications |
| 238 | .It Protocol |
| 239 | .It ProxyCommand |
| 240 | .It PubkeyAuthentication |
Darren Tucker | 62388b2 | 2006-01-20 11:31:47 +1100 | [diff] [blame] | 241 | .It RekeyLimit |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 242 | .It RhostsRSAAuthentication |
| 243 | .It RSAAuthentication |
Darren Tucker | 7a6c066 | 2004-05-02 22:14:03 +1000 | [diff] [blame] | 244 | .It SendEnv |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 245 | .It ServerAliveInterval |
| 246 | .It ServerAliveCountMax |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 247 | .It StrictHostKeyChecking |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 248 | .It TCPKeepAlive |
djm@openbsd.org | 1d1092b | 2015-01-26 12:16:36 +0000 | [diff] [blame] | 249 | .It UpdateHostKeys |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 250 | .It UsePrivilegedPort |
| 251 | .It User |
| 252 | .It UserKnownHostsFile |
| 253 | .It VerifyHostKeyDNS |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 254 | .El |
Darren Tucker | 282b402 | 2009-10-07 08:23:06 +1100 | [diff] [blame] | 255 | .It Fl P Ar port |
| 256 | Specifies the port to connect to on the remote host. |
Darren Tucker | 1b0dd17 | 2009-10-07 08:37:48 +1100 | [diff] [blame] | 257 | .It Fl p |
| 258 | Preserves modification times, access times, and modes from the |
| 259 | original files transferred. |
Darren Tucker | 46bbbe3 | 2009-10-07 08:21:48 +1100 | [diff] [blame] | 260 | .It Fl q |
| 261 | Quiet mode: disables the progress meter as well as warning and |
| 262 | diagnostic messages from |
| 263 | .Xr ssh 1 . |
Damien Miller | 16a1333 | 2002-02-13 14:03:56 +1100 | [diff] [blame] | 264 | .It Fl R Ar num_requests |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 265 | Specify how many requests may be outstanding at any one time. |
| 266 | Increasing this may slightly improve file transfer speed |
| 267 | but will increase memory usage. |
Damien Miller | 94717b0 | 2008-07-16 21:17:23 +1000 | [diff] [blame] | 268 | The default is 64 outstanding requests. |
Darren Tucker | 1b0dd17 | 2009-10-07 08:37:48 +1100 | [diff] [blame] | 269 | .It Fl r |
| 270 | Recursively copy entire directories when uploading and downloading. |
| 271 | Note that |
| 272 | .Nm |
| 273 | does not follow symbolic links encountered in the tree traversal. |
Ben Lindstrom | 6a33763 | 2001-09-18 05:47:32 +0000 | [diff] [blame] | 274 | .It Fl S Ar program |
| 275 | Name of the |
| 276 | .Ar program |
| 277 | to use for the encrypted connection. |
| 278 | The program must understand |
| 279 | .Xr ssh 1 |
| 280 | options. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 281 | .It Fl s Ar subsystem | sftp_server |
| 282 | Specifies the SSH2 subsystem or the path for an sftp server |
| 283 | on the remote host. |
| 284 | A path is useful for using |
| 285 | .Nm |
| 286 | over protocol version 1, or when the remote |
| 287 | .Xr sshd 8 |
| 288 | does not have an sftp subsystem configured. |
| 289 | .It Fl v |
| 290 | Raise logging level. |
| 291 | This option is also passed to ssh. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 292 | .El |
| 293 | .Sh INTERACTIVE COMMANDS |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 294 | Once in interactive mode, |
| 295 | .Nm |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 296 | understands a set of commands similar to those of |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 297 | .Xr ftp 1 . |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 298 | Commands are case insensitive. |
| 299 | Pathnames that contain spaces must be enclosed in quotes. |
| 300 | Any special characters contained within pathnames that are recognized by |
| 301 | .Xr glob 3 |
| 302 | must be escaped with backslashes |
| 303 | .Pq Sq \e . |
| 304 | .Bl -tag -width Ds |
Ben Lindstrom | 59e1249 | 2001-08-15 23:22:56 +0000 | [diff] [blame] | 305 | .It Ic bye |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 306 | Quit |
| 307 | .Nm sftp . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 308 | .It Ic cd Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 309 | Change remote directory to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 310 | .Ar path . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 311 | .It Ic chgrp Ar grp Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 312 | Change group of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 313 | .Ar path |
| 314 | to |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 315 | .Ar grp . |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 316 | .Ar path |
| 317 | may contain |
| 318 | .Xr glob 3 |
| 319 | characters and may match multiple files. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 320 | .Ar grp |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 321 | must be a numeric GID. |
| 322 | .It Ic chmod Ar mode Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 323 | Change permissions of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 324 | .Ar path |
| 325 | to |
| 326 | .Ar mode . |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 327 | .Ar path |
| 328 | may contain |
| 329 | .Xr glob 3 |
| 330 | characters and may match multiple files. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 331 | .It Ic chown Ar own Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 332 | Change owner of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 333 | .Ar path |
| 334 | to |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 335 | .Ar own . |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 336 | .Ar path |
| 337 | may contain |
| 338 | .Xr glob 3 |
| 339 | characters and may match multiple files. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 340 | .Ar own |
| 341 | must be a numeric UID. |
Damien Miller | d671e5a | 2008-05-19 14:53:33 +1000 | [diff] [blame] | 342 | .It Xo Ic df |
| 343 | .Op Fl hi |
| 344 | .Op Ar path |
| 345 | .Xc |
| 346 | Display usage information for the filesystem holding the current directory |
| 347 | (or |
| 348 | .Ar path |
| 349 | if specified). |
| 350 | If the |
| 351 | .Fl h |
| 352 | flag is specified, the capacity information will be displayed using |
| 353 | "human-readable" suffixes. |
| 354 | The |
| 355 | .Fl i |
| 356 | flag requests display of inode information in addition to capacity information. |
| 357 | This command is only supported on servers that implement the |
| 358 | .Dq statvfs@openssh.com |
| 359 | extension. |
Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame] | 360 | .It Ic exit |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 361 | Quit |
| 362 | .Nm sftp . |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 363 | .It Xo Ic get |
Damien Miller | f29238e | 2013-10-17 11:48:52 +1100 | [diff] [blame] | 364 | .Op Fl afPpr |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 365 | .Ar remote-path |
| 366 | .Op Ar local-path |
| 367 | .Xc |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 368 | Retrieve the |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 369 | .Ar remote-path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 370 | and store it on the local machine. |
| 371 | If the local |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 372 | 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] | 373 | remote machine. |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 374 | .Ar remote-path |
| 375 | may contain |
| 376 | .Xr glob 3 |
| 377 | characters and may match multiple files. |
| 378 | If it does and |
| 379 | .Ar local-path |
| 380 | is specified, then |
| 381 | .Ar local-path |
| 382 | must specify a directory. |
Darren Tucker | 1b0dd17 | 2009-10-07 08:37:48 +1100 | [diff] [blame] | 383 | .Pp |
Damien Miller | 0d03241 | 2013-07-25 11:56:52 +1000 | [diff] [blame] | 384 | If the |
| 385 | .Fl a |
| 386 | flag is specified, then attempt to resume partial transfers of existing files. |
| 387 | Note that resumption assumes that any partial copy of the local file matches |
| 388 | the remote copy. |
Damien Miller | eec8406 | 2013-08-21 02:39:39 +1000 | [diff] [blame] | 389 | If the remote file contents differ from the partial local copy then the |
| 390 | resultant file is likely to be corrupt. |
Damien Miller | 0d03241 | 2013-07-25 11:56:52 +1000 | [diff] [blame] | 391 | .Pp |
Damien Miller | f29238e | 2013-10-17 11:48:52 +1100 | [diff] [blame] | 392 | If the |
| 393 | .Fl f |
| 394 | flag is specified, then |
| 395 | .Xr fsync 2 |
Damien Miller | 1edcbf6 | 2013-10-18 10:17:17 +1100 | [diff] [blame] | 396 | will be called after the file transfer has completed to flush the file |
Damien Miller | f29238e | 2013-10-17 11:48:52 +1100 | [diff] [blame] | 397 | to disk. |
| 398 | .Pp |
Darren Tucker | b3b40a8 | 2009-10-07 08:39:09 +1100 | [diff] [blame] | 399 | If either the |
Darren Tucker | 05016b2 | 2009-10-07 08:38:23 +1100 | [diff] [blame] | 400 | .Fl P |
Darren Tucker | 1b0dd17 | 2009-10-07 08:37:48 +1100 | [diff] [blame] | 401 | or |
| 402 | .Fl p |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 403 | flag is specified, then full file permissions and access times are |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 404 | copied too. |
Darren Tucker | 1b0dd17 | 2009-10-07 08:37:48 +1100 | [diff] [blame] | 405 | .Pp |
| 406 | If the |
| 407 | .Fl r |
| 408 | flag is specified then directories will be copied recursively. |
| 409 | Note that |
| 410 | .Nm |
| 411 | does not follow symbolic links when performing recursive transfers. |
Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame] | 412 | .It Ic help |
| 413 | Display help text. |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 414 | .It Ic lcd Ar path |
| 415 | Change local directory to |
| 416 | .Ar path . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 417 | .It Ic lls Op Ar ls-options Op Ar path |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 418 | Display local directory listing of either |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 419 | .Ar path |
| 420 | or current directory if |
| 421 | .Ar path |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 422 | is not specified. |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 423 | .Ar ls-options |
| 424 | may contain any flags supported by the local system's |
| 425 | .Xr ls 1 |
| 426 | command. |
| 427 | .Ar path |
| 428 | may contain |
| 429 | .Xr glob 3 |
| 430 | characters and may match multiple files. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 431 | .It Ic lmkdir Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 432 | Create local directory specified by |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 433 | .Ar path . |
Darren Tucker | af1f909 | 2010-12-05 09:02:47 +1100 | [diff] [blame] | 434 | .It Xo Ic ln |
| 435 | .Op Fl s |
| 436 | .Ar oldpath |
| 437 | .Ar newpath |
| 438 | .Xc |
| 439 | Create a link from |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 440 | .Ar oldpath |
| 441 | to |
| 442 | .Ar newpath . |
Darren Tucker | af1f909 | 2010-12-05 09:02:47 +1100 | [diff] [blame] | 443 | If the |
| 444 | .Fl s |
| 445 | flag is specified the created link is a symbolic link, otherwise it is |
| 446 | a hard link. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 447 | .It Ic lpwd |
| 448 | Print local working directory. |
Damien Miller | e1a4981 | 2002-09-12 09:54:25 +1000 | [diff] [blame] | 449 | .It Xo Ic ls |
Darren Tucker | 75fe626 | 2010-01-15 11:42:51 +1100 | [diff] [blame] | 450 | .Op Fl 1afhlnrSt |
Damien Miller | e1a4981 | 2002-09-12 09:54:25 +1000 | [diff] [blame] | 451 | .Op Ar path |
| 452 | .Xc |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 453 | Display a remote directory listing of either |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 454 | .Ar path |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 455 | or the current directory if |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 456 | .Ar path |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 457 | is not specified. |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 458 | .Ar path |
| 459 | may contain |
| 460 | .Xr glob 3 |
| 461 | characters and may match multiple files. |
Darren Tucker | 15ca6e8 | 2004-06-22 13:08:21 +1000 | [diff] [blame] | 462 | .Pp |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 463 | The following flags are recognized and alter the behaviour of |
Darren Tucker | 15ca6e8 | 2004-06-22 13:08:21 +1000 | [diff] [blame] | 464 | .Ic ls |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 465 | accordingly: |
| 466 | .Bl -tag -width Ds |
| 467 | .It Fl 1 |
| 468 | Produce single columnar output. |
| 469 | .It Fl a |
| 470 | List files beginning with a dot |
| 471 | .Pq Sq \&. . |
| 472 | .It Fl f |
| 473 | Do not sort the listing. |
| 474 | The default sort order is lexicographical. |
Darren Tucker | 2901e2d | 2010-01-13 22:44:06 +1100 | [diff] [blame] | 475 | .It Fl h |
| 476 | When used with a long format option, use unit suffixes: Byte, Kilobyte, |
| 477 | Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce |
| 478 | the number of digits to four or fewer using powers of 2 for sizes (K=1024, |
| 479 | M=1048576, etc.). |
Darren Tucker | 75fe626 | 2010-01-15 11:42:51 +1100 | [diff] [blame] | 480 | .It Fl l |
| 481 | Display additional details including permissions |
| 482 | and ownership information. |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 483 | .It Fl n |
| 484 | Produce a long listing with user and group information presented |
| 485 | numerically. |
| 486 | .It Fl r |
| 487 | Reverse the sort order of the listing. |
| 488 | .It Fl S |
| 489 | Sort the listing by file size. |
| 490 | .It Fl t |
| 491 | Sort the listing by last modification time. |
| 492 | .El |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 493 | .It Ic lumask Ar umask |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 494 | Set local umask to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 495 | .Ar umask . |
| 496 | .It Ic mkdir Ar path |
| 497 | Create remote directory specified by |
| 498 | .Ar path . |
Damien Miller | 62d57f6 | 2003-01-10 21:43:24 +1100 | [diff] [blame] | 499 | .It Ic progress |
| 500 | Toggle display of progress meter. |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 501 | .It Xo Ic put |
Damien Miller | d875ff7 | 2014-05-15 13:47:15 +1000 | [diff] [blame] | 502 | .Op Fl afPpr |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 503 | .Ar local-path |
Ben Lindstrom | d576781 | 2002-12-23 02:23:37 +0000 | [diff] [blame] | 504 | .Op Ar remote-path |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 505 | .Xc |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 506 | Upload |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 507 | .Ar local-path |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 508 | and store it on the remote machine. |
| 509 | If the remote path name is not specified, it is given the same name it has |
| 510 | on the local machine. |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 511 | .Ar local-path |
| 512 | may contain |
| 513 | .Xr glob 3 |
| 514 | characters and may match multiple files. |
| 515 | If it does and |
| 516 | .Ar remote-path |
| 517 | is specified, then |
| 518 | .Ar remote-path |
| 519 | must specify a directory. |
Darren Tucker | 1b0dd17 | 2009-10-07 08:37:48 +1100 | [diff] [blame] | 520 | .Pp |
Damien Miller | f29238e | 2013-10-17 11:48:52 +1100 | [diff] [blame] | 521 | If the |
Damien Miller | 798a025 | 2014-05-15 13:47:37 +1000 | [diff] [blame] | 522 | .Fl a |
Damien Miller | d875ff7 | 2014-05-15 13:47:15 +1000 | [diff] [blame] | 523 | flag is specified, then attempt to resume partial |
| 524 | transfers of existing files. |
Damien Miller | 798a025 | 2014-05-15 13:47:37 +1000 | [diff] [blame] | 525 | Note that resumption assumes that any partial copy of the remote file |
Damien Miller | d875ff7 | 2014-05-15 13:47:15 +1000 | [diff] [blame] | 526 | matches the local copy. |
| 527 | If the local file contents differ from the remote local copy then |
| 528 | the resultant file is likely to be corrupt. |
| 529 | .Pp |
| 530 | If the |
Damien Miller | f29238e | 2013-10-17 11:48:52 +1100 | [diff] [blame] | 531 | .Fl f |
| 532 | flag is specified, then a request will be sent to the server to call |
| 533 | .Xr fsync 2 |
| 534 | after the file has been transferred. |
| 535 | Note that this is only supported by servers that implement |
| 536 | the "fsync@openssh.com" extension. |
| 537 | .Pp |
Darren Tucker | ddccfb4 | 2011-08-07 23:12:26 +1000 | [diff] [blame] | 538 | If either the |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 539 | .Fl P |
Darren Tucker | 1b0dd17 | 2009-10-07 08:37:48 +1100 | [diff] [blame] | 540 | or |
| 541 | .Fl p |
| 542 | flag is specified, then full file permissions and access times are |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 543 | copied too. |
Darren Tucker | 1b0dd17 | 2009-10-07 08:37:48 +1100 | [diff] [blame] | 544 | .Pp |
| 545 | If the |
| 546 | .Fl r |
| 547 | flag is specified then directories will be copied recursively. |
| 548 | Note that |
| 549 | .Nm |
| 550 | does not follow symbolic links when performing recursive transfers. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 551 | .It Ic pwd |
| 552 | Display remote working directory. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 553 | .It Ic quit |
Damien Miller | 5067792 | 2003-05-23 18:44:04 +1000 | [diff] [blame] | 554 | Quit |
| 555 | .Nm sftp . |
Damien Miller | 0d03241 | 2013-07-25 11:56:52 +1000 | [diff] [blame] | 556 | .It Xo Ic reget |
| 557 | .Op Fl Ppr |
| 558 | .Ar remote-path |
| 559 | .Op Ar local-path |
| 560 | .Xc |
| 561 | Resume download of |
| 562 | .Ar remote-path . |
| 563 | Equivalent to |
| 564 | .Ic get |
| 565 | with the |
| 566 | .Fl a |
| 567 | flag set. |
Damien Miller | d875ff7 | 2014-05-15 13:47:15 +1000 | [diff] [blame] | 568 | .It Xo Ic reput |
| 569 | .Op Fl Ppr |
| 570 | .Op Ar local-path |
| 571 | .Ar remote-path |
| 572 | .Xc |
| 573 | Resume upload of |
| 574 | .Op Ar local-path . |
| 575 | Equivalent to |
| 576 | .Ic put |
Damien Miller | 798a025 | 2014-05-15 13:47:37 +1000 | [diff] [blame] | 577 | with the |
Damien Miller | d875ff7 | 2014-05-15 13:47:15 +1000 | [diff] [blame] | 578 | .Fl a |
| 579 | flag set. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 580 | .It Ic rename Ar oldpath Ar newpath |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 581 | Rename remote file from |
| 582 | .Ar oldpath |
| 583 | to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 584 | .Ar newpath . |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 585 | .It Ic rm Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 586 | Delete remote file specified by |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 587 | .Ar path . |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 588 | .It Ic rmdir Ar path |
| 589 | Remove remote directory specified by |
| 590 | .Ar path . |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 591 | .It Ic symlink Ar oldpath Ar newpath |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 592 | Create a symbolic link from |
Damien Miller | 058316f | 2001-03-08 10:08:49 +1100 | [diff] [blame] | 593 | .Ar oldpath |
| 594 | to |
| 595 | .Ar newpath . |
Damien Miller | 6342180 | 2003-01-08 14:05:23 +1100 | [diff] [blame] | 596 | .It Ic version |
| 597 | Display the |
| 598 | .Nm |
| 599 | protocol version. |
Damien Miller | 62fd18a | 2009-01-28 16:14:09 +1100 | [diff] [blame] | 600 | .It Ic \&! Ns Ar command |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 601 | Execute |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 602 | .Ar command |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 603 | in local shell. |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 604 | .It Ic \&! |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 605 | Escape to local shell. |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 606 | .It Ic \&? |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 607 | Synonym for help. |
| 608 | .El |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 609 | .Sh SEE ALSO |
Darren Tucker | 1f20394 | 2003-10-15 15:50:42 +1000 | [diff] [blame] | 610 | .Xr ftp 1 , |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 611 | .Xr ls 1 , |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 612 | .Xr scp 1 , |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 613 | .Xr ssh 1 , |
| 614 | .Xr ssh-add 1 , |
| 615 | .Xr ssh-keygen 1 , |
Darren Tucker | 16e254d | 2004-12-06 22:46:45 +1100 | [diff] [blame] | 616 | .Xr glob 3 , |
Ben Lindstrom | 3072aae | 2002-06-21 01:02:39 +0000 | [diff] [blame] | 617 | .Xr ssh_config 5 , |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 618 | .Xr sftp-server 8 , |
| 619 | .Xr sshd 8 |
| 620 | .Rs |
Ben Lindstrom | 90fd060 | 2001-06-25 04:45:33 +0000 | [diff] [blame] | 621 | .%A T. Ylonen |
| 622 | .%A S. Lehtinen |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 623 | .%T "SSH File Transfer Protocol" |
| 624 | .%N draft-ietf-secsh-filexfer-00.txt |
| 625 | .%D January 2001 |
| 626 | .%O work in progress material |
| 627 | .Re |