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