blob: 7eb9970abcb9e53283ee69adbe5f53dec6c1252c [file] [log] [blame]
Damien Miller798a0252014-05-15 13:47:37 +10001.\" $OpenBSD: sftp.1,v 1.99 2014/04/22 14:16:30 jmc Exp $
Damien Miller33804262001-02-04 23:20:18 +11002.\"
Ben Lindstrom92a2e382001-03-05 06:59:27 +00003.\" Copyright (c) 2001 Damien Miller. All rights reserved.
Damien Miller33804262001-02-04 23:20:18 +11004.\"
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.\"
Damien Millerd875ff72014-05-15 13:47:15 +100025.Dd $Mdocdate: April 22 2014 $
Damien Miller33804262001-02-04 23:20:18 +110026.Dt SFTP 1
27.Os
28.Sh NAME
29.Nm sftp
Damien Miller50677922003-05-23 18:44:04 +100030.Nd secure file transfer program
Damien Miller33804262001-02-04 23:20:18 +110031.Sh SYNOPSIS
Damien Millerd6ead282003-05-14 19:30:38 +100032.Nm sftp
Damien Miller495dca32003-04-01 21:42:14 +100033.Bk -words
Damien Millerf29238e2013-10-17 11:48:52 +110034.Op Fl 1246aCfpqrv
Damien Miller81b6e782002-02-08 22:06:03 +110035.Op Fl B Ar buffer_size
Darren Tucker1f203942003-10-15 15:50:42 +100036.Op Fl b Ar batchfile
Darren Tucker46bbbe32009-10-07 08:21:48 +110037.Op Fl c Ar cipher
Darren Tucker282b4022009-10-07 08:23:06 +110038.Op Fl D Ar sftp_server_path
Damien Miller81b6e782002-02-08 22:06:03 +110039.Op Fl F Ar ssh_config
Darren Tuckerc07138e2009-10-07 08:23:44 +110040.Op Fl i Ar identity_file
Damien Miller65e42f82010-09-24 22:15:11 +100041.Op Fl l Ar limit
Darren Tucker1f203942003-10-15 15:50:42 +100042.Op Fl o Ar ssh_option
Darren Tucker282b4022009-10-07 08:23:06 +110043.Op Fl P Ar port
Damien Miller16a13332002-02-13 14:03:56 +110044.Op Fl R Ar num_requests
Ben Lindstrom6a337632001-09-18 05:47:32 +000045.Op Fl S Ar program
Darren Tucker1f203942003-10-15 15:50:42 +100046.Op Fl s Ar subsystem | sftp_server
Ben Lindstrom6a337632001-09-18 05:47:32 +000047.Ar host
Damien Miller495dca32003-04-01 21:42:14 +100048.Ek
Damien Millerd6ead282003-05-14 19:30:38 +100049.Nm sftp
Damien Miller7ebfad72008-12-09 14:12:33 +110050.Oo Ar user Ns @ Oc Ns
51.Ar host Ns Op : Ns Ar
Damien Millerd6ead282003-05-14 19:30:38 +100052.Nm sftp
Damien Miller881adf72010-09-24 22:01:54 +100053.Oo
54.Ar user Ns @ Oc Ns
Damien Miller495dca32003-04-01 21:42:14 +100055.Ar host Ns Oo : Ns Ar dir Ns
Damien Miller881adf72010-09-24 22:01:54 +100056.Op Ar /
57.Oc
Damien Millerd6ead282003-05-14 19:30:38 +100058.Nm sftp
Damien Millerfb7508e2003-05-14 13:47:07 +100059.Fl b Ar batchfile
Damien Millerc2b98272003-09-03 12:13:30 +100060.Oo Ar user Ns @ Oc Ns Ar host
Damien Miller33804262001-02-04 23:20:18 +110061.Sh DESCRIPTION
62.Nm
63is an interactive file transfer program, similar to
64.Xr ftp 1 ,
65which performs all operations over an encrypted
66.Xr ssh 1
67transport.
68It may also use many features of ssh, such as public key authentication and
69compression.
70.Nm
71connects and logs into the specified
Ben Lindstromaafff9c2001-05-06 03:01:02 +000072.Ar host ,
Damien Miller33804262001-02-04 23:20:18 +110073then enters an interactive command mode.
74.Pp
Ben Lindstrom24643222001-06-25 05:08:11 +000075The second usage format will retrieve files automatically if a non-interactive
Ben Lindstromaafff9c2001-05-06 03:01:02 +000076authentication method is used; otherwise it will do so after
77successful interactive authentication.
Ben Lindstrom63667f62001-04-13 00:00:14 +000078.Pp
Darren Tucker16e254d2004-12-06 22:46:45 +110079The third usage format allows
80.Nm
81to start in a remote directory.
Ben Lindstrom63667f62001-04-13 00:00:14 +000082.Pp
Damien Miller50677922003-05-23 18:44:04 +100083The final usage format allows for automated sessions using the
Damien Millerfb7508e2003-05-14 13:47:07 +100084.Fl b
Damien Miller50677922003-05-23 18:44:04 +100085option.
Damien Miller134eb812005-12-31 16:22:55 +110086In such cases, it is necessary to configure non-interactive authentication
Damien Miller50677922003-05-23 18:44:04 +100087to obviate the need to enter a password at connection time (see
Damien Millerfb7508e2003-05-14 13:47:07 +100088.Xr sshd 8
Damien Millerd6ead282003-05-14 19:30:38 +100089and
Damien Millerfb7508e2003-05-14 13:47:07 +100090.Xr ssh-keygen 1
Damien Miller50677922003-05-23 18:44:04 +100091for details).
Damien Miller58a77e22011-05-15 08:36:29 +100092.Pp
93Since some usage formats use colon characters to delimit host names from path
94names, IPv6 addresses must be enclosed in square brackets to avoid ambiguity.
95.Pp
Damien Miller33804262001-02-04 23:20:18 +110096The options are as follows:
97.Bl -tag -width Ds
Darren Tucker1f203942003-10-15 15:50:42 +100098.It Fl 1
99Specify the use of protocol version 1.
Darren Tucker46bbbe32009-10-07 08:21:48 +1100100.It Fl 2
101Specify the use of protocol version 2.
102.It Fl 4
103Forces
104.Nm
105to use IPv4 addresses only.
106.It Fl 6
107Forces
108.Nm
109to use IPv6 addresses only.
Damien Millerc6895c52013-08-21 02:40:21 +1000110.It Fl a
Damien Miller798a0252014-05-15 13:47:37 +1000111Attempt to continue interrupted transfers rather than overwriting
Damien Millerd875ff72014-05-15 13:47:15 +1000112existing partial or complete copies of files.
Damien Miller798a0252014-05-15 13:47:37 +1000113If the partial contents differ from those being transferred,
Damien Millerd875ff72014-05-15 13:47:15 +1000114then the resultant file is likely to be corrupt.
Darren Tucker1f203942003-10-15 15:50:42 +1000115.It Fl B Ar buffer_size
116Specify the size of the buffer that
117.Nm
118uses when transferring files.
119Larger buffers require fewer round trips at the cost of higher
120memory consumption.
121The default is 32768 bytes.
Ben Lindstrom562c26b2001-03-07 01:26:48 +0000122.It Fl b Ar batchfile
123Batch mode reads a series of commands from an input
Ben Lindstrom283cb822001-03-09 00:09:02 +0000124.Ar batchfile
Ben Lindstrom562c26b2001-03-07 01:26:48 +0000125instead of
Ben Lindstrom283cb822001-03-09 00:09:02 +0000126.Em stdin .
127Since it lacks user interaction it should be used in conjunction with
Damien Miller86a39682004-01-21 11:00:04 +1100128non-interactive authentication.
Damien Miller44f75c12004-01-21 10:58:47 +1100129A
Damien Miller86a39682004-01-21 11:00:04 +1100130.Ar batchfile
131of
132.Sq \-
Damien Miller44f75c12004-01-21 10:58:47 +1100133may be used to indicate standard input.
Ben Lindstrom283cb822001-03-09 00:09:02 +0000134.Nm
Ben Lindstrom24643222001-06-25 05:08:11 +0000135will abort if any of the following
136commands fail:
Damien Millerd875ff72014-05-15 13:47:15 +1000137.Ic get , put , reget , reput, rename , ln ,
Damien Miller495dca32003-04-01 21:42:14 +1000138.Ic rm , mkdir , chdir , ls ,
Damien Miller64058cb2008-05-19 14:54:25 +1000139.Ic lchdir , chmod , chown ,
Darren Tuckeraf1f9092010-12-05 09:02:47 +1100140.Ic chgrp , lpwd , df , symlink ,
Ben Lindstrom562c26b2001-03-07 01:26:48 +0000141and
Ben Lindstrom283cb822001-03-09 00:09:02 +0000142.Ic lmkdir .
Damien Miller495dca32003-04-01 21:42:14 +1000143Termination on error can be suppressed on a command by command basis by
144prefixing the command with a
Damien Miller86a39682004-01-21 11:00:04 +1100145.Sq \-
Damien Miller50677922003-05-23 18:44:04 +1000146character (for example,
147.Ic -rm /tmp/blah* ) .
Darren Tucker1f203942003-10-15 15:50:42 +1000148.It Fl C
149Enables compression (via ssh's
150.Fl C
151flag).
Darren Tuckeradba1ba2009-10-07 08:22:20 +1100152.It Fl c Ar cipher
153Selects the cipher to use for encrypting the data transfers.
154This option is directly passed to
155.Xr ssh 1 .
Darren Tucker282b4022009-10-07 08:23:06 +1100156.It Fl D Ar sftp_server_path
157Connect directly to a local sftp server
158(rather than via
159.Xr ssh 1 ) .
160This option may be useful in debugging the client and server.
Darren Tucker1f203942003-10-15 15:50:42 +1000161.It Fl F Ar ssh_config
162Specifies an alternative
163per-user configuration file for
164.Xr ssh 1 .
165This option is directly passed to
166.Xr ssh 1 .
Damien Millerf29238e2013-10-17 11:48:52 +1100167.It Fl f
168Requests that files be flushed to disk immediately after transfer.
169When uploading files, this feature is only enabled if the server
170implements the "fsync@openssh.com" extension.
Darren Tucker46bbbe32009-10-07 08:21:48 +1100171.It Fl i Ar identity_file
172Selects the file from which the identity (private key) for public key
173authentication is read.
174This option is directly passed to
175.Xr ssh 1 .
Damien Miller65e42f82010-09-24 22:15:11 +1000176.It Fl l Ar limit
177Limits the used bandwidth, specified in Kbit/s.
Damien Miller33804262001-02-04 23:20:18 +1100178.It Fl o Ar ssh_option
Ben Lindstrom14c62eb2001-08-15 23:25:46 +0000179Can be used to pass options to
180.Nm ssh
Ben Lindstrom3072aae2002-06-21 01:02:39 +0000181in the format used in
182.Xr ssh_config 5 .
183This is useful for specifying options
Ben Lindstrom14c62eb2001-08-15 23:25:46 +0000184for which there is no separate
185.Nm sftp
Damien Miller50677922003-05-23 18:44:04 +1000186command-line flag.
187For example, to specify an alternate port use:
Ben Lindstrom6a337632001-09-18 05:47:32 +0000188.Ic sftp -oPort=24 .
Darren Tucker1f203942003-10-15 15:50:42 +1000189For 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 Millerc0049bd2013-10-23 16:29:59 +1100196.It CanonicalDomains
197.It CanonicalizeFallbackLocal
198.It CanonicalizeHostname
199.It CanonicalizeMaxDots
200.It CanonicalizePermittedCNAMEs
Darren Tucker1f203942003-10-15 15:50:42 +1000201.It ChallengeResponseAuthentication
202.It CheckHostIP
203.It Cipher
204.It Ciphers
Darren Tucker1f203942003-10-15 15:50:42 +1000205.It Compression
206.It CompressionLevel
207.It ConnectionAttempts
Darren Tucker3d5cbb72004-05-03 09:13:15 +1000208.It ConnectTimeout
Damien Miller0e220db2004-06-15 10:34:08 +1000209.It ControlMaster
210.It ControlPath
Damien Millere5777722011-09-22 21:34:15 +1000211.It ControlPersist
Darren Tucker1f203942003-10-15 15:50:42 +1000212.It GlobalKnownHostsFile
213.It GSSAPIAuthentication
214.It GSSAPIDelegateCredentials
Damien Miller27e9c512005-03-02 12:04:16 +1100215.It HashKnownHosts
Darren Tucker1f203942003-10-15 15:50:42 +1000216.It Host
217.It HostbasedAuthentication
218.It HostKeyAlgorithms
219.It HostKeyAlias
220.It HostName
221.It IdentityFile
Damien Millerbd394c32004-03-08 23:12:36 +1100222.It IdentitiesOnly
Damien Miller0a184732010-11-20 15:21:03 +1100223.It IPQoS
Damien Millere5777722011-09-22 21:34:15 +1000224.It KbdInteractiveAuthentication
Darren Tucker636ca902004-11-05 20:22:00 +1100225.It KbdInteractiveDevices
Damien Miller2beb32f2010-09-24 22:16:03 +1000226.It KexAlgorithms
Darren Tucker1f203942003-10-15 15:50:42 +1000227.It LogLevel
228.It MACs
229.It NoHostAuthenticationForLocalhost
230.It NumberOfPasswordPrompts
231.It PasswordAuthentication
Damien Miller7ea845e2010-02-12 09:21:02 +1100232.It PKCS11Provider
Darren Tucker1f203942003-10-15 15:50:42 +1000233.It Port
234.It PreferredAuthentications
235.It Protocol
236.It ProxyCommand
237.It PubkeyAuthentication
Darren Tucker62388b22006-01-20 11:31:47 +1100238.It RekeyLimit
Darren Tucker1f203942003-10-15 15:50:42 +1000239.It RhostsRSAAuthentication
240.It RSAAuthentication
Darren Tucker7a6c0662004-05-02 22:14:03 +1000241.It SendEnv
Damien Miller509b0102003-12-17 16:33:10 +1100242.It ServerAliveInterval
243.It ServerAliveCountMax
Darren Tucker1f203942003-10-15 15:50:42 +1000244.It StrictHostKeyChecking
Damien Miller12c150e2003-12-17 16:31:10 +1100245.It TCPKeepAlive
Darren Tucker1f203942003-10-15 15:50:42 +1000246.It UsePrivilegedPort
247.It User
248.It UserKnownHostsFile
249.It VerifyHostKeyDNS
Darren Tucker1f203942003-10-15 15:50:42 +1000250.El
Darren Tucker282b4022009-10-07 08:23:06 +1100251.It Fl P Ar port
252Specifies the port to connect to on the remote host.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100253.It Fl p
254Preserves modification times, access times, and modes from the
255original files transferred.
Darren Tucker46bbbe32009-10-07 08:21:48 +1100256.It Fl q
257Quiet mode: disables the progress meter as well as warning and
258diagnostic messages from
259.Xr ssh 1 .
Damien Miller16a13332002-02-13 14:03:56 +1100260.It Fl R Ar num_requests
Damien Miller50677922003-05-23 18:44:04 +1000261Specify how many requests may be outstanding at any one time.
262Increasing this may slightly improve file transfer speed
263but will increase memory usage.
Damien Miller94717b02008-07-16 21:17:23 +1000264The default is 64 outstanding requests.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100265.It Fl r
266Recursively copy entire directories when uploading and downloading.
267Note that
268.Nm
269does not follow symbolic links encountered in the tree traversal.
Ben Lindstrom6a337632001-09-18 05:47:32 +0000270.It Fl S Ar program
271Name of the
272.Ar program
273to use for the encrypted connection.
274The program must understand
275.Xr ssh 1
276options.
Darren Tucker1f203942003-10-15 15:50:42 +1000277.It Fl s Ar subsystem | sftp_server
278Specifies the SSH2 subsystem or the path for an sftp server
279on the remote host.
280A path is useful for using
281.Nm
282over protocol version 1, or when the remote
283.Xr sshd 8
284does not have an sftp subsystem configured.
285.It Fl v
286Raise logging level.
287This option is also passed to ssh.
Damien Miller33804262001-02-04 23:20:18 +1100288.El
289.Sh INTERACTIVE COMMANDS
Damien Millerd7686fd2001-02-10 00:40:03 +1100290Once in interactive mode,
291.Nm
Ben Lindstrom24643222001-06-25 05:08:11 +0000292understands a set of commands similar to those of
Damien Miller33804262001-02-04 23:20:18 +1100293.Xr ftp 1 .
Darren Tucker16e254d2004-12-06 22:46:45 +1100294Commands are case insensitive.
295Pathnames that contain spaces must be enclosed in quotes.
296Any special characters contained within pathnames that are recognized by
297.Xr glob 3
298must be escaped with backslashes
299.Pq Sq \e .
300.Bl -tag -width Ds
Ben Lindstrom59e12492001-08-15 23:22:56 +0000301.It Ic bye
Damien Miller50677922003-05-23 18:44:04 +1000302Quit
303.Nm sftp .
Damien Millerd7686fd2001-02-10 00:40:03 +1100304.It Ic cd Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000305Change remote directory to
Damien Millerd7686fd2001-02-10 00:40:03 +1100306.Ar path .
Damien Millerd7686fd2001-02-10 00:40:03 +1100307.It Ic chgrp Ar grp Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000308Change group of file
Damien Millerd7686fd2001-02-10 00:40:03 +1100309.Ar path
310to
Damien Miller33804262001-02-04 23:20:18 +1100311.Ar grp .
Darren Tucker16e254d2004-12-06 22:46:45 +1100312.Ar path
313may contain
314.Xr glob 3
315characters and may match multiple files.
Damien Miller33804262001-02-04 23:20:18 +1100316.Ar grp
Damien Millerd7686fd2001-02-10 00:40:03 +1100317must be a numeric GID.
318.It Ic chmod Ar mode Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000319Change permissions of file
Damien Millerd7686fd2001-02-10 00:40:03 +1100320.Ar path
321to
322.Ar mode .
Darren Tucker16e254d2004-12-06 22:46:45 +1100323.Ar path
324may contain
325.Xr glob 3
326characters and may match multiple files.
Damien Millerd7686fd2001-02-10 00:40:03 +1100327.It Ic chown Ar own Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000328Change owner of file
Damien Millerd7686fd2001-02-10 00:40:03 +1100329.Ar path
330to
Damien Miller33804262001-02-04 23:20:18 +1100331.Ar own .
Darren Tucker16e254d2004-12-06 22:46:45 +1100332.Ar path
333may contain
334.Xr glob 3
335characters and may match multiple files.
Damien Miller33804262001-02-04 23:20:18 +1100336.Ar own
337must be a numeric UID.
Damien Millerd671e5a2008-05-19 14:53:33 +1000338.It Xo Ic df
339.Op Fl hi
340.Op Ar path
341.Xc
342Display usage information for the filesystem holding the current directory
343(or
344.Ar path
345if specified).
346If the
347.Fl h
348flag is specified, the capacity information will be displayed using
349"human-readable" suffixes.
350The
351.Fl i
352flag requests display of inode information in addition to capacity information.
353This command is only supported on servers that implement the
354.Dq statvfs@openssh.com
355extension.
Ben Lindstromc9b6eab2001-03-07 01:29:17 +0000356.It Ic exit
Damien Miller50677922003-05-23 18:44:04 +1000357Quit
358.Nm sftp .
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000359.It Xo Ic get
Damien Millerf29238e2013-10-17 11:48:52 +1100360.Op Fl afPpr
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000361.Ar remote-path
362.Op Ar local-path
363.Xc
Damien Miller33804262001-02-04 23:20:18 +1100364Retrieve the
Damien Millerd7686fd2001-02-10 00:40:03 +1100365.Ar remote-path
Damien Miller33804262001-02-04 23:20:18 +1100366and store it on the local machine.
367If the local
Ben Lindstrom24643222001-06-25 05:08:11 +0000368path name is not specified, it is given the same name it has on the
Damien Miller50677922003-05-23 18:44:04 +1000369remote machine.
Darren Tucker16e254d2004-12-06 22:46:45 +1100370.Ar remote-path
371may contain
372.Xr glob 3
373characters and may match multiple files.
374If it does and
375.Ar local-path
376is specified, then
377.Ar local-path
378must specify a directory.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100379.Pp
Damien Miller0d032412013-07-25 11:56:52 +1000380If the
381.Fl a
382flag is specified, then attempt to resume partial transfers of existing files.
383Note that resumption assumes that any partial copy of the local file matches
384the remote copy.
Damien Millereec84062013-08-21 02:39:39 +1000385If the remote file contents differ from the partial local copy then the
386resultant file is likely to be corrupt.
Damien Miller0d032412013-07-25 11:56:52 +1000387.Pp
Damien Millerf29238e2013-10-17 11:48:52 +1100388If the
389.Fl f
390flag is specified, then
391.Xr fsync 2
Damien Miller1edcbf62013-10-18 10:17:17 +1100392will be called after the file transfer has completed to flush the file
Damien Millerf29238e2013-10-17 11:48:52 +1100393to disk.
394.Pp
Darren Tuckerb3b40a82009-10-07 08:39:09 +1100395If either the
Darren Tucker05016b22009-10-07 08:38:23 +1100396.Fl P
Darren Tucker1b0dd172009-10-07 08:37:48 +1100397or
398.Fl p
Darren Tucker16e254d2004-12-06 22:46:45 +1100399flag is specified, then full file permissions and access times are
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000400copied too.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100401.Pp
402If the
403.Fl r
404flag is specified then directories will be copied recursively.
405Note that
406.Nm
407does not follow symbolic links when performing recursive transfers.
Ben Lindstromc9b6eab2001-03-07 01:29:17 +0000408.It Ic help
409Display help text.
Darren Tucker1f203942003-10-15 15:50:42 +1000410.It Ic lcd Ar path
411Change local directory to
412.Ar path .
Damien Millerd7686fd2001-02-10 00:40:03 +1100413.It Ic lls Op Ar ls-options Op Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000414Display local directory listing of either
Damien Miller33804262001-02-04 23:20:18 +1100415.Ar path
416or current directory if
417.Ar path
Damien Millerd7686fd2001-02-10 00:40:03 +1100418is not specified.
Darren Tucker16e254d2004-12-06 22:46:45 +1100419.Ar ls-options
420may contain any flags supported by the local system's
421.Xr ls 1
422command.
423.Ar path
424may contain
425.Xr glob 3
426characters and may match multiple files.
Damien Millerd7686fd2001-02-10 00:40:03 +1100427.It Ic lmkdir Ar path
Damien Miller33804262001-02-04 23:20:18 +1100428Create local directory specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100429.Ar path .
Darren Tuckeraf1f9092010-12-05 09:02:47 +1100430.It Xo Ic ln
431.Op Fl s
432.Ar oldpath
433.Ar newpath
434.Xc
435Create a link from
Damien Miller058316f2001-03-08 10:08:49 +1100436.Ar oldpath
437to
438.Ar newpath .
Darren Tuckeraf1f9092010-12-05 09:02:47 +1100439If the
440.Fl s
441flag is specified the created link is a symbolic link, otherwise it is
442a hard link.
Damien Millerd7686fd2001-02-10 00:40:03 +1100443.It Ic lpwd
444Print local working directory.
Damien Millere1a49812002-09-12 09:54:25 +1000445.It Xo Ic ls
Darren Tucker75fe6262010-01-15 11:42:51 +1100446.Op Fl 1afhlnrSt
Damien Millere1a49812002-09-12 09:54:25 +1000447.Op Ar path
448.Xc
Darren Tucker16e254d2004-12-06 22:46:45 +1100449Display a remote directory listing of either
Damien Miller33804262001-02-04 23:20:18 +1100450.Ar path
Darren Tucker16e254d2004-12-06 22:46:45 +1100451or the current directory if
Damien Miller33804262001-02-04 23:20:18 +1100452.Ar path
Damien Miller50677922003-05-23 18:44:04 +1000453is not specified.
Darren Tucker16e254d2004-12-06 22:46:45 +1100454.Ar path
455may contain
456.Xr glob 3
457characters and may match multiple files.
Darren Tucker15ca6e82004-06-22 13:08:21 +1000458.Pp
Darren Tucker16e254d2004-12-06 22:46:45 +1100459The following flags are recognized and alter the behaviour of
Darren Tucker15ca6e82004-06-22 13:08:21 +1000460.Ic ls
Darren Tucker16e254d2004-12-06 22:46:45 +1100461accordingly:
462.Bl -tag -width Ds
463.It Fl 1
464Produce single columnar output.
465.It Fl a
466List files beginning with a dot
467.Pq Sq \&. .
468.It Fl f
469Do not sort the listing.
470The default sort order is lexicographical.
Darren Tucker2901e2d2010-01-13 22:44:06 +1100471.It Fl h
472When used with a long format option, use unit suffixes: Byte, Kilobyte,
473Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
474the number of digits to four or fewer using powers of 2 for sizes (K=1024,
475M=1048576, etc.).
Darren Tucker75fe6262010-01-15 11:42:51 +1100476.It Fl l
477Display additional details including permissions
478and ownership information.
Darren Tucker16e254d2004-12-06 22:46:45 +1100479.It Fl n
480Produce a long listing with user and group information presented
481numerically.
482.It Fl r
483Reverse the sort order of the listing.
484.It Fl S
485Sort the listing by file size.
486.It Fl t
487Sort the listing by last modification time.
488.El
Damien Millerd7686fd2001-02-10 00:40:03 +1100489.It Ic lumask Ar umask
Ben Lindstrom24643222001-06-25 05:08:11 +0000490Set local umask to
Damien Millerd7686fd2001-02-10 00:40:03 +1100491.Ar umask .
492.It Ic mkdir Ar path
493Create remote directory specified by
494.Ar path .
Damien Miller62d57f62003-01-10 21:43:24 +1100495.It Ic progress
496Toggle display of progress meter.
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000497.It Xo Ic put
Damien Millerd875ff72014-05-15 13:47:15 +1000498.Op Fl afPpr
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000499.Ar local-path
Ben Lindstromd5767812002-12-23 02:23:37 +0000500.Op Ar remote-path
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000501.Xc
Damien Miller33804262001-02-04 23:20:18 +1100502Upload
Damien Millerd7686fd2001-02-10 00:40:03 +1100503.Ar local-path
Damien Miller50677922003-05-23 18:44:04 +1000504and store it on the remote machine.
505If the remote path name is not specified, it is given the same name it has
506on the local machine.
Darren Tucker16e254d2004-12-06 22:46:45 +1100507.Ar local-path
508may contain
509.Xr glob 3
510characters and may match multiple files.
511If it does and
512.Ar remote-path
513is specified, then
514.Ar remote-path
515must specify a directory.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100516.Pp
Damien Millerf29238e2013-10-17 11:48:52 +1100517If the
Damien Miller798a0252014-05-15 13:47:37 +1000518.Fl a
Damien Millerd875ff72014-05-15 13:47:15 +1000519flag is specified, then attempt to resume partial
520transfers of existing files.
Damien Miller798a0252014-05-15 13:47:37 +1000521Note that resumption assumes that any partial copy of the remote file
Damien Millerd875ff72014-05-15 13:47:15 +1000522matches the local copy.
523If the local file contents differ from the remote local copy then
524the resultant file is likely to be corrupt.
525.Pp
526If the
Damien Millerf29238e2013-10-17 11:48:52 +1100527.Fl f
528flag is specified, then a request will be sent to the server to call
529.Xr fsync 2
530after the file has been transferred.
531Note that this is only supported by servers that implement
532the "fsync@openssh.com" extension.
533.Pp
Darren Tuckerddccfb42011-08-07 23:12:26 +1000534If either the
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000535.Fl P
Darren Tucker1b0dd172009-10-07 08:37:48 +1100536or
537.Fl p
538flag is specified, then full file permissions and access times are
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000539copied too.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100540.Pp
541If the
542.Fl r
543flag is specified then directories will be copied recursively.
544Note that
545.Nm
546does not follow symbolic links when performing recursive transfers.
Damien Millerd7686fd2001-02-10 00:40:03 +1100547.It Ic pwd
548Display remote working directory.
Damien Millerd7686fd2001-02-10 00:40:03 +1100549.It Ic quit
Damien Miller50677922003-05-23 18:44:04 +1000550Quit
551.Nm sftp .
Damien Miller0d032412013-07-25 11:56:52 +1000552.It Xo Ic reget
553.Op Fl Ppr
554.Ar remote-path
555.Op Ar local-path
556.Xc
557Resume download of
558.Ar remote-path .
559Equivalent to
560.Ic get
561with the
562.Fl a
563flag set.
Damien Millerd875ff72014-05-15 13:47:15 +1000564.It Xo Ic reput
565.Op Fl Ppr
566.Op Ar local-path
567.Ar remote-path
568.Xc
569Resume upload of
570.Op Ar local-path .
571Equivalent to
572.Ic put
Damien Miller798a0252014-05-15 13:47:37 +1000573with the
Damien Millerd875ff72014-05-15 13:47:15 +1000574.Fl a
575flag set.
Damien Millerd7686fd2001-02-10 00:40:03 +1100576.It Ic rename Ar oldpath Ar newpath
Damien Miller33804262001-02-04 23:20:18 +1100577Rename remote file from
578.Ar oldpath
579to
Damien Millerd7686fd2001-02-10 00:40:03 +1100580.Ar newpath .
Damien Millerd7686fd2001-02-10 00:40:03 +1100581.It Ic rm Ar path
Damien Miller33804262001-02-04 23:20:18 +1100582Delete remote file specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100583.Ar path .
Darren Tucker1f203942003-10-15 15:50:42 +1000584.It Ic rmdir Ar path
585Remove remote directory specified by
586.Ar path .
Damien Miller058316f2001-03-08 10:08:49 +1100587.It Ic symlink Ar oldpath Ar newpath
Ben Lindstrom24643222001-06-25 05:08:11 +0000588Create a symbolic link from
Damien Miller058316f2001-03-08 10:08:49 +1100589.Ar oldpath
590to
591.Ar newpath .
Damien Miller63421802003-01-08 14:05:23 +1100592.It Ic version
593Display the
594.Nm
595protocol version.
Damien Miller62fd18a2009-01-28 16:14:09 +1100596.It Ic \&! Ns Ar command
Ben Lindstrom24643222001-06-25 05:08:11 +0000597Execute
Damien Miller33804262001-02-04 23:20:18 +1100598.Ar command
Damien Millerd7686fd2001-02-10 00:40:03 +1100599in local shell.
Damien Millerc2b98272003-09-03 12:13:30 +1000600.It Ic \&!
Damien Millerd7686fd2001-02-10 00:40:03 +1100601Escape to local shell.
Damien Millerc2b98272003-09-03 12:13:30 +1000602.It Ic \&?
Damien Millerd7686fd2001-02-10 00:40:03 +1100603Synonym for help.
604.El
Damien Miller33804262001-02-04 23:20:18 +1100605.Sh SEE ALSO
Darren Tucker1f203942003-10-15 15:50:42 +1000606.Xr ftp 1 ,
Darren Tucker16e254d2004-12-06 22:46:45 +1100607.Xr ls 1 ,
Ben Lindstrom160ec622001-04-22 17:17:46 +0000608.Xr scp 1 ,
Damien Miller33804262001-02-04 23:20:18 +1100609.Xr ssh 1 ,
610.Xr ssh-add 1 ,
611.Xr ssh-keygen 1 ,
Darren Tucker16e254d2004-12-06 22:46:45 +1100612.Xr glob 3 ,
Ben Lindstrom3072aae2002-06-21 01:02:39 +0000613.Xr ssh_config 5 ,
Ben Lindstrom160ec622001-04-22 17:17:46 +0000614.Xr sftp-server 8 ,
615.Xr sshd 8
616.Rs
Ben Lindstrom90fd0602001-06-25 04:45:33 +0000617.%A T. Ylonen
618.%A S. Lehtinen
Ben Lindstrom160ec622001-04-22 17:17:46 +0000619.%T "SSH File Transfer Protocol"
620.%N draft-ietf-secsh-filexfer-00.txt
621.%D January 2001
622.%O work in progress material
623.Re