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