blob: ab8b186af85c23ae1692816278792bc6410ce3ec [file] [log] [blame]
jmc@openbsd.org772e6ce2016-06-29 17:14:28 +00001.\" $OpenBSD: sftp.1,v 1.104 2016/06/29 17:14:28 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.\"
jmc@openbsd.org772e6ce2016-06-29 17:14:28 +000025.Dd $Mdocdate: June 29 2016 $
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
jmc@openbsd.orgc5f7c082015-09-25 18:19:54 +0000201.It CertificateFile
Darren Tucker1f203942003-10-15 15:50:42 +1000202.It ChallengeResponseAuthentication
203.It CheckHostIP
204.It Cipher
205.It Ciphers
Darren Tucker1f203942003-10-15 15:50:42 +1000206.It Compression
207.It CompressionLevel
208.It ConnectionAttempts
Darren Tucker3d5cbb72004-05-03 09:13:15 +1000209.It ConnectTimeout
Damien Miller0e220db2004-06-15 10:34:08 +1000210.It ControlMaster
211.It ControlPath
Damien Millere5777722011-09-22 21:34:15 +1000212.It ControlPersist
Darren Tucker1f203942003-10-15 15:50:42 +1000213.It GlobalKnownHostsFile
214.It GSSAPIAuthentication
215.It GSSAPIDelegateCredentials
Damien Miller27e9c512005-03-02 12:04:16 +1100216.It HashKnownHosts
Darren Tucker1f203942003-10-15 15:50:42 +1000217.It Host
218.It HostbasedAuthentication
djm@openbsd.org46347ed2015-01-30 11:43:14 +0000219.It HostbasedKeyTypes
Darren Tucker1f203942003-10-15 15:50:42 +1000220.It HostKeyAlgorithms
221.It HostKeyAlias
222.It HostName
jmc@openbsd.org772e6ce2016-06-29 17:14:28 +0000223.It IdentitiesOnly
markus@openbsd.org75e21682016-05-04 14:32:26 +0000224.It IdentityAgent
Darren Tucker1f203942003-10-15 15:50:42 +1000225.It IdentityFile
Damien Miller0a184732010-11-20 15:21:03 +1100226.It IPQoS
Damien Millere5777722011-09-22 21:34:15 +1000227.It KbdInteractiveAuthentication
Darren Tucker636ca902004-11-05 20:22:00 +1100228.It KbdInteractiveDevices
Damien Miller2beb32f2010-09-24 22:16:03 +1000229.It KexAlgorithms
Darren Tucker1f203942003-10-15 15:50:42 +1000230.It LogLevel
231.It MACs
232.It NoHostAuthenticationForLocalhost
233.It NumberOfPasswordPrompts
234.It PasswordAuthentication
Damien Miller7ea845e2010-02-12 09:21:02 +1100235.It PKCS11Provider
Darren Tucker1f203942003-10-15 15:50:42 +1000236.It Port
237.It PreferredAuthentications
238.It Protocol
239.It ProxyCommand
240.It PubkeyAuthentication
Darren Tucker62388b22006-01-20 11:31:47 +1100241.It RekeyLimit
Darren Tucker1f203942003-10-15 15:50:42 +1000242.It RhostsRSAAuthentication
243.It RSAAuthentication
Darren Tucker7a6c0662004-05-02 22:14:03 +1000244.It SendEnv
Damien Miller509b0102003-12-17 16:33:10 +1100245.It ServerAliveInterval
246.It ServerAliveCountMax
Darren Tucker1f203942003-10-15 15:50:42 +1000247.It StrictHostKeyChecking
Damien Miller12c150e2003-12-17 16:31:10 +1100248.It TCPKeepAlive
djm@openbsd.org1d1092b2015-01-26 12:16:36 +0000249.It UpdateHostKeys
Darren Tucker1f203942003-10-15 15:50:42 +1000250.It UsePrivilegedPort
251.It User
252.It UserKnownHostsFile
253.It VerifyHostKeyDNS
Darren Tucker1f203942003-10-15 15:50:42 +1000254.El
Darren Tucker282b4022009-10-07 08:23:06 +1100255.It Fl P Ar port
256Specifies the port to connect to on the remote host.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100257.It Fl p
258Preserves modification times, access times, and modes from the
259original files transferred.
Darren Tucker46bbbe32009-10-07 08:21:48 +1100260.It Fl q
261Quiet mode: disables the progress meter as well as warning and
262diagnostic messages from
263.Xr ssh 1 .
Damien Miller16a13332002-02-13 14:03:56 +1100264.It Fl R Ar num_requests
Damien Miller50677922003-05-23 18:44:04 +1000265Specify how many requests may be outstanding at any one time.
266Increasing this may slightly improve file transfer speed
267but will increase memory usage.
Damien Miller94717b02008-07-16 21:17:23 +1000268The default is 64 outstanding requests.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100269.It Fl r
270Recursively copy entire directories when uploading and downloading.
271Note that
272.Nm
273does not follow symbolic links encountered in the tree traversal.
Ben Lindstrom6a337632001-09-18 05:47:32 +0000274.It Fl S Ar program
275Name of the
276.Ar program
277to use for the encrypted connection.
278The program must understand
279.Xr ssh 1
280options.
Darren Tucker1f203942003-10-15 15:50:42 +1000281.It Fl s Ar subsystem | sftp_server
282Specifies the SSH2 subsystem or the path for an sftp server
283on the remote host.
284A path is useful for using
285.Nm
286over protocol version 1, or when the remote
287.Xr sshd 8
288does not have an sftp subsystem configured.
289.It Fl v
290Raise logging level.
291This option is also passed to ssh.
Damien Miller33804262001-02-04 23:20:18 +1100292.El
293.Sh INTERACTIVE COMMANDS
Damien Millerd7686fd2001-02-10 00:40:03 +1100294Once in interactive mode,
295.Nm
Ben Lindstrom24643222001-06-25 05:08:11 +0000296understands a set of commands similar to those of
Damien Miller33804262001-02-04 23:20:18 +1100297.Xr ftp 1 .
Darren Tucker16e254d2004-12-06 22:46:45 +1100298Commands are case insensitive.
299Pathnames that contain spaces must be enclosed in quotes.
300Any special characters contained within pathnames that are recognized by
301.Xr glob 3
302must be escaped with backslashes
303.Pq Sq \e .
304.Bl -tag -width Ds
Ben Lindstrom59e12492001-08-15 23:22:56 +0000305.It Ic bye
Damien Miller50677922003-05-23 18:44:04 +1000306Quit
307.Nm sftp .
Damien Millerd7686fd2001-02-10 00:40:03 +1100308.It Ic cd Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000309Change remote directory to
Damien Millerd7686fd2001-02-10 00:40:03 +1100310.Ar path .
Damien Millerd7686fd2001-02-10 00:40:03 +1100311.It Ic chgrp Ar grp Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000312Change group of file
Damien Millerd7686fd2001-02-10 00:40:03 +1100313.Ar path
314to
Damien Miller33804262001-02-04 23:20:18 +1100315.Ar grp .
Darren Tucker16e254d2004-12-06 22:46:45 +1100316.Ar path
317may contain
318.Xr glob 3
319characters and may match multiple files.
Damien Miller33804262001-02-04 23:20:18 +1100320.Ar grp
Damien Millerd7686fd2001-02-10 00:40:03 +1100321must be a numeric GID.
322.It Ic chmod Ar mode Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000323Change permissions of file
Damien Millerd7686fd2001-02-10 00:40:03 +1100324.Ar path
325to
326.Ar mode .
Darren Tucker16e254d2004-12-06 22:46:45 +1100327.Ar path
328may contain
329.Xr glob 3
330characters and may match multiple files.
Damien Millerd7686fd2001-02-10 00:40:03 +1100331.It Ic chown Ar own Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000332Change owner of file
Damien Millerd7686fd2001-02-10 00:40:03 +1100333.Ar path
334to
Damien Miller33804262001-02-04 23:20:18 +1100335.Ar own .
Darren Tucker16e254d2004-12-06 22:46:45 +1100336.Ar path
337may contain
338.Xr glob 3
339characters and may match multiple files.
Damien Miller33804262001-02-04 23:20:18 +1100340.Ar own
341must be a numeric UID.
Damien Millerd671e5a2008-05-19 14:53:33 +1000342.It Xo Ic df
343.Op Fl hi
344.Op Ar path
345.Xc
346Display usage information for the filesystem holding the current directory
347(or
348.Ar path
349if specified).
350If the
351.Fl h
352flag is specified, the capacity information will be displayed using
353"human-readable" suffixes.
354The
355.Fl i
356flag requests display of inode information in addition to capacity information.
357This command is only supported on servers that implement the
358.Dq statvfs@openssh.com
359extension.
Ben Lindstromc9b6eab2001-03-07 01:29:17 +0000360.It Ic exit
Damien Miller50677922003-05-23 18:44:04 +1000361Quit
362.Nm sftp .
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000363.It Xo Ic get
Damien Millerf29238e2013-10-17 11:48:52 +1100364.Op Fl afPpr
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000365.Ar remote-path
366.Op Ar local-path
367.Xc
Damien Miller33804262001-02-04 23:20:18 +1100368Retrieve the
Damien Millerd7686fd2001-02-10 00:40:03 +1100369.Ar remote-path
Damien Miller33804262001-02-04 23:20:18 +1100370and store it on the local machine.
371If the local
Ben Lindstrom24643222001-06-25 05:08:11 +0000372path name is not specified, it is given the same name it has on the
Damien Miller50677922003-05-23 18:44:04 +1000373remote machine.
Darren Tucker16e254d2004-12-06 22:46:45 +1100374.Ar remote-path
375may contain
376.Xr glob 3
377characters and may match multiple files.
378If it does and
379.Ar local-path
380is specified, then
381.Ar local-path
382must specify a directory.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100383.Pp
Damien Miller0d032412013-07-25 11:56:52 +1000384If the
385.Fl a
386flag is specified, then attempt to resume partial transfers of existing files.
387Note that resumption assumes that any partial copy of the local file matches
388the remote copy.
Damien Millereec84062013-08-21 02:39:39 +1000389If the remote file contents differ from the partial local copy then the
390resultant file is likely to be corrupt.
Damien Miller0d032412013-07-25 11:56:52 +1000391.Pp
Damien Millerf29238e2013-10-17 11:48:52 +1100392If the
393.Fl f
394flag is specified, then
395.Xr fsync 2
Damien Miller1edcbf62013-10-18 10:17:17 +1100396will be called after the file transfer has completed to flush the file
Damien Millerf29238e2013-10-17 11:48:52 +1100397to disk.
398.Pp
Darren Tuckerb3b40a82009-10-07 08:39:09 +1100399If either the
Darren Tucker05016b22009-10-07 08:38:23 +1100400.Fl P
Darren Tucker1b0dd172009-10-07 08:37:48 +1100401or
402.Fl p
Darren Tucker16e254d2004-12-06 22:46:45 +1100403flag is specified, then full file permissions and access times are
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000404copied too.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100405.Pp
406If the
407.Fl r
408flag is specified then directories will be copied recursively.
409Note that
410.Nm
411does not follow symbolic links when performing recursive transfers.
Ben Lindstromc9b6eab2001-03-07 01:29:17 +0000412.It Ic help
413Display help text.
Darren Tucker1f203942003-10-15 15:50:42 +1000414.It Ic lcd Ar path
415Change local directory to
416.Ar path .
Damien Millerd7686fd2001-02-10 00:40:03 +1100417.It Ic lls Op Ar ls-options Op Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000418Display local directory listing of either
Damien Miller33804262001-02-04 23:20:18 +1100419.Ar path
420or current directory if
421.Ar path
Damien Millerd7686fd2001-02-10 00:40:03 +1100422is not specified.
Darren Tucker16e254d2004-12-06 22:46:45 +1100423.Ar ls-options
424may contain any flags supported by the local system's
425.Xr ls 1
426command.
427.Ar path
428may contain
429.Xr glob 3
430characters and may match multiple files.
Damien Millerd7686fd2001-02-10 00:40:03 +1100431.It Ic lmkdir Ar path
Damien Miller33804262001-02-04 23:20:18 +1100432Create local directory specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100433.Ar path .
Darren Tuckeraf1f9092010-12-05 09:02:47 +1100434.It Xo Ic ln
435.Op Fl s
436.Ar oldpath
437.Ar newpath
438.Xc
439Create a link from
Damien Miller058316f2001-03-08 10:08:49 +1100440.Ar oldpath
441to
442.Ar newpath .
Darren Tuckeraf1f9092010-12-05 09:02:47 +1100443If the
444.Fl s
445flag is specified the created link is a symbolic link, otherwise it is
446a hard link.
Damien Millerd7686fd2001-02-10 00:40:03 +1100447.It Ic lpwd
448Print local working directory.
Damien Millere1a49812002-09-12 09:54:25 +1000449.It Xo Ic ls
Darren Tucker75fe6262010-01-15 11:42:51 +1100450.Op Fl 1afhlnrSt
Damien Millere1a49812002-09-12 09:54:25 +1000451.Op Ar path
452.Xc
Darren Tucker16e254d2004-12-06 22:46:45 +1100453Display a remote directory listing of either
Damien Miller33804262001-02-04 23:20:18 +1100454.Ar path
Darren Tucker16e254d2004-12-06 22:46:45 +1100455or the current directory if
Damien Miller33804262001-02-04 23:20:18 +1100456.Ar path
Damien Miller50677922003-05-23 18:44:04 +1000457is not specified.
Darren Tucker16e254d2004-12-06 22:46:45 +1100458.Ar path
459may contain
460.Xr glob 3
461characters and may match multiple files.
Darren Tucker15ca6e82004-06-22 13:08:21 +1000462.Pp
Darren Tucker16e254d2004-12-06 22:46:45 +1100463The following flags are recognized and alter the behaviour of
Darren Tucker15ca6e82004-06-22 13:08:21 +1000464.Ic ls
Darren Tucker16e254d2004-12-06 22:46:45 +1100465accordingly:
466.Bl -tag -width Ds
467.It Fl 1
468Produce single columnar output.
469.It Fl a
470List files beginning with a dot
471.Pq Sq \&. .
472.It Fl f
473Do not sort the listing.
474The default sort order is lexicographical.
Darren Tucker2901e2d2010-01-13 22:44:06 +1100475.It Fl h
476When used with a long format option, use unit suffixes: Byte, Kilobyte,
477Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
478the number of digits to four or fewer using powers of 2 for sizes (K=1024,
479M=1048576, etc.).
Darren Tucker75fe6262010-01-15 11:42:51 +1100480.It Fl l
481Display additional details including permissions
482and ownership information.
Darren Tucker16e254d2004-12-06 22:46:45 +1100483.It Fl n
484Produce a long listing with user and group information presented
485numerically.
486.It Fl r
487Reverse the sort order of the listing.
488.It Fl S
489Sort the listing by file size.
490.It Fl t
491Sort the listing by last modification time.
492.El
Damien Millerd7686fd2001-02-10 00:40:03 +1100493.It Ic lumask Ar umask
Ben Lindstrom24643222001-06-25 05:08:11 +0000494Set local umask to
Damien Millerd7686fd2001-02-10 00:40:03 +1100495.Ar umask .
496.It Ic mkdir Ar path
497Create remote directory specified by
498.Ar path .
Damien Miller62d57f62003-01-10 21:43:24 +1100499.It Ic progress
500Toggle display of progress meter.
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000501.It Xo Ic put
Damien Millerd875ff72014-05-15 13:47:15 +1000502.Op Fl afPpr
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000503.Ar local-path
Ben Lindstromd5767812002-12-23 02:23:37 +0000504.Op Ar remote-path
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000505.Xc
Damien Miller33804262001-02-04 23:20:18 +1100506Upload
Damien Millerd7686fd2001-02-10 00:40:03 +1100507.Ar local-path
Damien Miller50677922003-05-23 18:44:04 +1000508and store it on the remote machine.
509If the remote path name is not specified, it is given the same name it has
510on the local machine.
Darren Tucker16e254d2004-12-06 22:46:45 +1100511.Ar local-path
512may contain
513.Xr glob 3
514characters and may match multiple files.
515If it does and
516.Ar remote-path
517is specified, then
518.Ar remote-path
519must specify a directory.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100520.Pp
Damien Millerf29238e2013-10-17 11:48:52 +1100521If the
Damien Miller798a0252014-05-15 13:47:37 +1000522.Fl a
Damien Millerd875ff72014-05-15 13:47:15 +1000523flag is specified, then attempt to resume partial
524transfers of existing files.
Damien Miller798a0252014-05-15 13:47:37 +1000525Note that resumption assumes that any partial copy of the remote file
Damien Millerd875ff72014-05-15 13:47:15 +1000526matches the local copy.
527If the local file contents differ from the remote local copy then
528the resultant file is likely to be corrupt.
529.Pp
530If the
Damien Millerf29238e2013-10-17 11:48:52 +1100531.Fl f
532flag is specified, then a request will be sent to the server to call
533.Xr fsync 2
534after the file has been transferred.
535Note that this is only supported by servers that implement
536the "fsync@openssh.com" extension.
537.Pp
Darren Tuckerddccfb42011-08-07 23:12:26 +1000538If either the
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000539.Fl P
Darren Tucker1b0dd172009-10-07 08:37:48 +1100540or
541.Fl p
542flag is specified, then full file permissions and access times are
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000543copied too.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100544.Pp
545If the
546.Fl r
547flag is specified then directories will be copied recursively.
548Note that
549.Nm
550does not follow symbolic links when performing recursive transfers.
Damien Millerd7686fd2001-02-10 00:40:03 +1100551.It Ic pwd
552Display remote working directory.
Damien Millerd7686fd2001-02-10 00:40:03 +1100553.It Ic quit
Damien Miller50677922003-05-23 18:44:04 +1000554Quit
555.Nm sftp .
Damien Miller0d032412013-07-25 11:56:52 +1000556.It Xo Ic reget
557.Op Fl Ppr
558.Ar remote-path
559.Op Ar local-path
560.Xc
561Resume download of
562.Ar remote-path .
563Equivalent to
564.Ic get
565with the
566.Fl a
567flag set.
Damien Millerd875ff72014-05-15 13:47:15 +1000568.It Xo Ic reput
569.Op Fl Ppr
570.Op Ar local-path
571.Ar remote-path
572.Xc
573Resume upload of
574.Op Ar local-path .
575Equivalent to
576.Ic put
Damien Miller798a0252014-05-15 13:47:37 +1000577with the
Damien Millerd875ff72014-05-15 13:47:15 +1000578.Fl a
579flag set.
Damien Millerd7686fd2001-02-10 00:40:03 +1100580.It Ic rename Ar oldpath Ar newpath
Damien Miller33804262001-02-04 23:20:18 +1100581Rename remote file from
582.Ar oldpath
583to
Damien Millerd7686fd2001-02-10 00:40:03 +1100584.Ar newpath .
Damien Millerd7686fd2001-02-10 00:40:03 +1100585.It Ic rm Ar path
Damien Miller33804262001-02-04 23:20:18 +1100586Delete remote file specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100587.Ar path .
Darren Tucker1f203942003-10-15 15:50:42 +1000588.It Ic rmdir Ar path
589Remove remote directory specified by
590.Ar path .
Damien Miller058316f2001-03-08 10:08:49 +1100591.It Ic symlink Ar oldpath Ar newpath
Ben Lindstrom24643222001-06-25 05:08:11 +0000592Create a symbolic link from
Damien Miller058316f2001-03-08 10:08:49 +1100593.Ar oldpath
594to
595.Ar newpath .
Damien Miller63421802003-01-08 14:05:23 +1100596.It Ic version
597Display the
598.Nm
599protocol version.
Damien Miller62fd18a2009-01-28 16:14:09 +1100600.It Ic \&! Ns Ar command
Ben Lindstrom24643222001-06-25 05:08:11 +0000601Execute
Damien Miller33804262001-02-04 23:20:18 +1100602.Ar command
Damien Millerd7686fd2001-02-10 00:40:03 +1100603in local shell.
Damien Millerc2b98272003-09-03 12:13:30 +1000604.It Ic \&!
Damien Millerd7686fd2001-02-10 00:40:03 +1100605Escape to local shell.
Damien Millerc2b98272003-09-03 12:13:30 +1000606.It Ic \&?
Damien Millerd7686fd2001-02-10 00:40:03 +1100607Synonym for help.
608.El
Damien Miller33804262001-02-04 23:20:18 +1100609.Sh SEE ALSO
Darren Tucker1f203942003-10-15 15:50:42 +1000610.Xr ftp 1 ,
Darren Tucker16e254d2004-12-06 22:46:45 +1100611.Xr ls 1 ,
Ben Lindstrom160ec622001-04-22 17:17:46 +0000612.Xr scp 1 ,
Damien Miller33804262001-02-04 23:20:18 +1100613.Xr ssh 1 ,
614.Xr ssh-add 1 ,
615.Xr ssh-keygen 1 ,
Darren Tucker16e254d2004-12-06 22:46:45 +1100616.Xr glob 3 ,
Ben Lindstrom3072aae2002-06-21 01:02:39 +0000617.Xr ssh_config 5 ,
Ben Lindstrom160ec622001-04-22 17:17:46 +0000618.Xr sftp-server 8 ,
619.Xr sshd 8
620.Rs
Ben Lindstrom90fd0602001-06-25 04:45:33 +0000621.%A T. Ylonen
622.%A S. Lehtinen
Ben Lindstrom160ec622001-04-22 17:17:46 +0000623.%T "SSH File Transfer Protocol"
624.%N draft-ietf-secsh-filexfer-00.txt
625.%D January 2001
626.%O work in progress material
627.Re