blob: a6210c50026c3e3dd5f2b2035212e93e38038ace [file] [log] [blame]
kn@openbsd.orgddf1b792018-07-23 19:02:49 +00001.\" $OpenBSD: sftp.1,v 1.118 2018/07/23 19:02:49 kn 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.\"
kn@openbsd.orgddf1b792018-07-23 19:02:49 +000025.Dd $Mdocdate: July 23 2018 $
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
djm@openbsd.org3575f0b2017-05-02 08:54:19 +000033.Op Fl 46aCfpqrv
Damien Miller81b6e782002-02-08 22:06:03 +110034.Op Fl B Ar buffer_size
Darren Tucker1f203942003-10-15 15:50:42 +100035.Op Fl b Ar batchfile
Darren Tucker46bbbe32009-10-07 08:21:48 +110036.Op Fl c Ar cipher
Darren Tucker282b4022009-10-07 08:23:06 +110037.Op Fl D Ar sftp_server_path
Damien Miller81b6e782002-02-08 22:06:03 +110038.Op Fl F Ar ssh_config
Darren Tuckerc07138e2009-10-07 08:23:44 +110039.Op Fl i Ar identity_file
Damien Miller65e42f82010-09-24 22:15:11 +100040.Op Fl l Ar limit
Darren Tucker1f203942003-10-15 15:50:42 +100041.Op Fl o Ar ssh_option
Darren Tucker282b4022009-10-07 08:23:06 +110042.Op Fl P Ar port
Damien Miller16a13332002-02-13 14:03:56 +110043.Op Fl R Ar num_requests
Ben Lindstrom6a337632001-09-18 05:47:32 +000044.Op Fl S Ar program
Darren Tucker1f203942003-10-15 15:50:42 +100045.Op Fl s Ar subsystem | sftp_server
millert@openbsd.org887669e2017-10-21 23:06:24 +000046.Ar destination
Damien Miller33804262001-02-04 23:20:18 +110047.Sh DESCRIPTION
48.Nm
millert@openbsd.org887669e2017-10-21 23:06:24 +000049is a file transfer program, similar to
Damien Miller33804262001-02-04 23:20:18 +110050.Xr ftp 1 ,
51which performs all operations over an encrypted
52.Xr ssh 1
53transport.
54It may also use many features of ssh, such as public key authentication and
55compression.
Damien Miller33804262001-02-04 23:20:18 +110056.Pp
millert@openbsd.org887669e2017-10-21 23:06:24 +000057The
58.Ar destination
59may be specified either as
jmc@openbsd.org@openbsd.org0b2e2892017-10-25 06:19:46 +000060.Sm off
61.Oo user @ Oc host Op : path
62.Sm on
63or as a URI in the form
64.Sm off
65.No sftp:// Oo user @ Oc host Oo : port Oc Op / path .
66.Sm on
millert@openbsd.org887669e2017-10-21 23:06:24 +000067.Pp
68If the
69.Ar destination
70includes a
71.Ar path
72and it is not a directory,
73.Nm
74will retrieve files automatically if a non-interactive
Ben Lindstromaafff9c2001-05-06 03:01:02 +000075authentication method is used; otherwise it will do so after
76successful interactive authentication.
Ben Lindstrom63667f62001-04-13 00:00:14 +000077.Pp
millert@openbsd.org887669e2017-10-21 23:06:24 +000078If no
79.Ar path
80is specified, or if the
81.Ar path
82is a directory,
Darren Tucker16e254d2004-12-06 22:46:45 +110083.Nm
millert@openbsd.org887669e2017-10-21 23:06:24 +000084will log in to the specified
85.Ar host
86and enter interactive command mode, changing to the remote directory
87if one was specified.
88An optional trailing slash can be used to force the
89.Ar path
90to be interpreted as a directory.
Ben Lindstrom63667f62001-04-13 00:00:14 +000091.Pp
millert@openbsd.org887669e2017-10-21 23:06:24 +000092Since the destination formats use colon characters to delimit host
93names from path names or port numbers, IPv6 addresses must be
94enclosed in square brackets to avoid ambiguity.
Damien Miller58a77e22011-05-15 08:36:29 +100095.Pp
Damien Miller33804262001-02-04 23:20:18 +110096The options are as follows:
97.Bl -tag -width Ds
Darren Tucker46bbbe32009-10-07 08:21:48 +110098.It Fl 4
99Forces
100.Nm
101to use IPv4 addresses only.
102.It Fl 6
103Forces
104.Nm
105to use IPv6 addresses only.
Damien Millerc6895c52013-08-21 02:40:21 +1000106.It Fl a
Damien Miller798a0252014-05-15 13:47:37 +1000107Attempt to continue interrupted transfers rather than overwriting
Damien Millerd875ff72014-05-15 13:47:15 +1000108existing partial or complete copies of files.
Damien Miller798a0252014-05-15 13:47:37 +1000109If the partial contents differ from those being transferred,
Damien Millerd875ff72014-05-15 13:47:15 +1000110then the resultant file is likely to be corrupt.
Darren Tucker1f203942003-10-15 15:50:42 +1000111.It Fl B Ar buffer_size
112Specify the size of the buffer that
113.Nm
114uses when transferring files.
115Larger buffers require fewer round trips at the cost of higher
116memory consumption.
117The default is 32768 bytes.
Ben Lindstrom562c26b2001-03-07 01:26:48 +0000118.It Fl b Ar batchfile
119Batch mode reads a series of commands from an input
Ben Lindstrom283cb822001-03-09 00:09:02 +0000120.Ar batchfile
Ben Lindstrom562c26b2001-03-07 01:26:48 +0000121instead of
Ben Lindstrom283cb822001-03-09 00:09:02 +0000122.Em stdin .
123Since it lacks user interaction it should be used in conjunction with
millert@openbsd.org887669e2017-10-21 23:06:24 +0000124non-interactive authentication to obviate the need to enter a password
125at connection time (see
126.Xr sshd 8
127and
128.Xr ssh-keygen 1
129for details).
Damien Miller44f75c12004-01-21 10:58:47 +1100130A
Damien Miller86a39682004-01-21 11:00:04 +1100131.Ar batchfile
132of
133.Sq \-
Damien Miller44f75c12004-01-21 10:58:47 +1100134may be used to indicate standard input.
Ben Lindstrom283cb822001-03-09 00:09:02 +0000135.Nm
Ben Lindstrom24643222001-06-25 05:08:11 +0000136will abort if any of the following
137commands fail:
Damien Millerd875ff72014-05-15 13:47:15 +1000138.Ic get , put , reget , reput, rename , ln ,
Damien Miller495dca32003-04-01 21:42:14 +1000139.Ic rm , mkdir , chdir , ls ,
Damien Miller64058cb2008-05-19 14:54:25 +1000140.Ic lchdir , chmod , chown ,
Darren Tuckeraf1f9092010-12-05 09:02:47 +1100141.Ic chgrp , lpwd , df , symlink ,
Ben Lindstrom562c26b2001-03-07 01:26:48 +0000142and
Ben Lindstrom283cb822001-03-09 00:09:02 +0000143.Ic lmkdir .
Damien Miller495dca32003-04-01 21:42:14 +1000144Termination on error can be suppressed on a command by command basis by
145prefixing the command with a
Damien Miller86a39682004-01-21 11:00:04 +1100146.Sq \-
Damien Miller50677922003-05-23 18:44:04 +1000147character (for example,
148.Ic -rm /tmp/blah* ) .
Darren Tucker1f203942003-10-15 15:50:42 +1000149.It Fl C
150Enables compression (via ssh's
151.Fl C
152flag).
Darren Tuckeradba1ba2009-10-07 08:22:20 +1100153.It Fl c Ar cipher
154Selects the cipher to use for encrypting the data transfers.
155This option is directly passed to
156.Xr ssh 1 .
Darren Tucker282b4022009-10-07 08:23:06 +1100157.It Fl D Ar sftp_server_path
158Connect directly to a local sftp server
159(rather than via
160.Xr ssh 1 ) .
161This option may be useful in debugging the client and server.
Darren Tucker1f203942003-10-15 15:50:42 +1000162.It Fl F Ar ssh_config
163Specifies an alternative
164per-user configuration file for
165.Xr ssh 1 .
166This option is directly passed to
167.Xr ssh 1 .
Damien Millerf29238e2013-10-17 11:48:52 +1100168.It Fl f
169Requests that files be flushed to disk immediately after transfer.
170When uploading files, this feature is only enabled if the server
171implements the "fsync@openssh.com" extension.
Darren Tucker46bbbe32009-10-07 08:21:48 +1100172.It Fl i Ar identity_file
173Selects the file from which the identity (private key) for public key
174authentication is read.
175This option is directly passed to
176.Xr ssh 1 .
Damien Miller65e42f82010-09-24 22:15:11 +1000177.It Fl l Ar limit
178Limits the used bandwidth, specified in Kbit/s.
Damien Miller33804262001-02-04 23:20:18 +1100179.It Fl o Ar ssh_option
Ben Lindstrom14c62eb2001-08-15 23:25:46 +0000180Can be used to pass options to
181.Nm ssh
Ben Lindstrom3072aae2002-06-21 01:02:39 +0000182in the format used in
183.Xr ssh_config 5 .
184This is useful for specifying options
Ben Lindstrom14c62eb2001-08-15 23:25:46 +0000185for which there is no separate
186.Nm sftp
Damien Miller50677922003-05-23 18:44:04 +1000187command-line flag.
188For example, to specify an alternate port use:
Ben Lindstrom6a337632001-09-18 05:47:32 +0000189.Ic sftp -oPort=24 .
Darren Tucker1f203942003-10-15 15:50:42 +1000190For full details of the options listed below, and their possible values, see
191.Xr ssh_config 5 .
192.Pp
193.Bl -tag -width Ds -offset indent -compact
194.It AddressFamily
195.It BatchMode
196.It BindAddress
jmc@openbsd.org7d330a12018-02-23 07:38:09 +0000197.It BindInterface
Damien Millerc0049bd2013-10-23 16:29:59 +1100198.It CanonicalDomains
199.It CanonicalizeFallbackLocal
200.It CanonicalizeHostname
201.It CanonicalizeMaxDots
202.It CanonicalizePermittedCNAMEs
jmc@openbsd.orgc5f7c082015-09-25 18:19:54 +0000203.It CertificateFile
Darren Tucker1f203942003-10-15 15:50:42 +1000204.It ChallengeResponseAuthentication
205.It CheckHostIP
Darren Tucker1f203942003-10-15 15:50:42 +1000206.It Ciphers
Darren Tucker1f203942003-10-15 15:50:42 +1000207.It Compression
naddy@openbsd.org9a82e242017-05-03 21:49:18 +0000208.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
Darren Tucker1f203942003-10-15 15:50:42 +1000238.It ProxyCommand
jmc@openbsd.orge4eb7d92016-07-16 06:57:55 +0000239.It ProxyJump
jmc@openbsd.org42b690b2017-05-02 14:06:37 +0000240.It PubkeyAcceptedKeyTypes
Darren Tucker1f203942003-10-15 15:50:42 +1000241.It PubkeyAuthentication
Darren Tucker62388b22006-01-20 11:31:47 +1100242.It RekeyLimit
Darren Tucker7a6c0662004-05-02 22:14:03 +1000243.It SendEnv
Damien Miller509b0102003-12-17 16:33:10 +1100244.It ServerAliveInterval
245.It ServerAliveCountMax
jmc@openbsd.orgacf42602018-06-09 06:36:31 +0000246.It SetEnv
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 User
251.It UserKnownHostsFile
252.It VerifyHostKeyDNS
Darren Tucker1f203942003-10-15 15:50:42 +1000253.El
Darren Tucker282b4022009-10-07 08:23:06 +1100254.It Fl P Ar port
255Specifies the port to connect to on the remote host.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100256.It Fl p
257Preserves modification times, access times, and modes from the
258original files transferred.
Darren Tucker46bbbe32009-10-07 08:21:48 +1100259.It Fl q
260Quiet mode: disables the progress meter as well as warning and
261diagnostic messages from
262.Xr ssh 1 .
Damien Miller16a13332002-02-13 14:03:56 +1100263.It Fl R Ar num_requests
Damien Miller50677922003-05-23 18:44:04 +1000264Specify how many requests may be outstanding at any one time.
265Increasing this may slightly improve file transfer speed
266but will increase memory usage.
Damien Miller94717b02008-07-16 21:17:23 +1000267The default is 64 outstanding requests.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100268.It Fl r
269Recursively copy entire directories when uploading and downloading.
270Note that
271.Nm
272does not follow symbolic links encountered in the tree traversal.
Ben Lindstrom6a337632001-09-18 05:47:32 +0000273.It Fl S Ar program
274Name of the
275.Ar program
276to use for the encrypted connection.
277The program must understand
278.Xr ssh 1
279options.
Darren Tucker1f203942003-10-15 15:50:42 +1000280.It Fl s Ar subsystem | sftp_server
281Specifies the SSH2 subsystem or the path for an sftp server
282on the remote host.
jmc@openbsd.org2b6f7992017-05-03 06:32:02 +0000283A path is useful when the remote
Darren Tucker1f203942003-10-15 15:50:42 +1000284.Xr sshd 8
285does not have an sftp subsystem configured.
286.It Fl v
287Raise logging level.
288This option is also passed to ssh.
Damien Miller33804262001-02-04 23:20:18 +1100289.El
290.Sh INTERACTIVE COMMANDS
Damien Millerd7686fd2001-02-10 00:40:03 +1100291Once in interactive mode,
292.Nm
Ben Lindstrom24643222001-06-25 05:08:11 +0000293understands a set of commands similar to those of
Damien Miller33804262001-02-04 23:20:18 +1100294.Xr ftp 1 .
Darren Tucker16e254d2004-12-06 22:46:45 +1100295Commands are case insensitive.
296Pathnames that contain spaces must be enclosed in quotes.
297Any special characters contained within pathnames that are recognized by
298.Xr glob 3
299must be escaped with backslashes
300.Pq Sq \e .
301.Bl -tag -width Ds
Ben Lindstrom59e12492001-08-15 23:22:56 +0000302.It Ic bye
Damien Miller50677922003-05-23 18:44:04 +1000303Quit
304.Nm sftp .
djm@openbsd.org@openbsd.orgfbe8e7a2017-11-03 03:46:52 +0000305.It Ic cd Op Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000306Change remote directory to
Damien Millerd7686fd2001-02-10 00:40:03 +1100307.Ar path .
djm@openbsd.org@openbsd.orgfbe8e7a2017-11-03 03:46:52 +0000308If
309.Ar path
310is not specified, then change directory to the one the session started in.
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
kn@openbsd.orgddf1b792018-07-23 19:02:49 +0000318.Xr glob 7
Darren Tucker16e254d2004-12-06 22:46:45 +1100319characters 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
kn@openbsd.orgddf1b792018-07-23 19:02:49 +0000329.Xr glob 7
Darren Tucker16e254d2004-12-06 22:46:45 +1100330characters 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
kn@openbsd.orgddf1b792018-07-23 19:02:49 +0000338.Xr glob 7
Darren Tucker16e254d2004-12-06 22:46:45 +1100339characters 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
kn@openbsd.orgddf1b792018-07-23 19:02:49 +0000376.Xr glob 7
Darren Tucker16e254d2004-12-06 22:46:45 +1100377characters 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.
djm@openbsd.org@openbsd.orgfbe8e7a2017-11-03 03:46:52 +0000414.It Ic lcd Op Ar path
Darren Tucker1f203942003-10-15 15:50:42 +1000415Change local directory to
416.Ar path .
djm@openbsd.org@openbsd.orgfbe8e7a2017-11-03 03:46:52 +0000417If
418.Ar path
419is not specified, then change directory to the local user's home directory.
Damien Millerd7686fd2001-02-10 00:40:03 +1100420.It Ic lls Op Ar ls-options Op Ar path
Ben Lindstrom24643222001-06-25 05:08:11 +0000421Display local directory listing of either
Damien Miller33804262001-02-04 23:20:18 +1100422.Ar path
423or current directory if
424.Ar path
Damien Millerd7686fd2001-02-10 00:40:03 +1100425is not specified.
Darren Tucker16e254d2004-12-06 22:46:45 +1100426.Ar ls-options
427may contain any flags supported by the local system's
428.Xr ls 1
429command.
430.Ar path
431may contain
kn@openbsd.orgddf1b792018-07-23 19:02:49 +0000432.Xr glob 7
Darren Tucker16e254d2004-12-06 22:46:45 +1100433characters and may match multiple files.
Damien Millerd7686fd2001-02-10 00:40:03 +1100434.It Ic lmkdir Ar path
Damien Miller33804262001-02-04 23:20:18 +1100435Create local directory specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100436.Ar path .
Darren Tuckeraf1f9092010-12-05 09:02:47 +1100437.It Xo Ic ln
438.Op Fl s
439.Ar oldpath
440.Ar newpath
441.Xc
442Create a link from
Damien Miller058316f2001-03-08 10:08:49 +1100443.Ar oldpath
444to
445.Ar newpath .
Darren Tuckeraf1f9092010-12-05 09:02:47 +1100446If the
447.Fl s
448flag is specified the created link is a symbolic link, otherwise it is
449a hard link.
Damien Millerd7686fd2001-02-10 00:40:03 +1100450.It Ic lpwd
451Print local working directory.
Damien Millere1a49812002-09-12 09:54:25 +1000452.It Xo Ic ls
Darren Tucker75fe6262010-01-15 11:42:51 +1100453.Op Fl 1afhlnrSt
Damien Millere1a49812002-09-12 09:54:25 +1000454.Op Ar path
455.Xc
Darren Tucker16e254d2004-12-06 22:46:45 +1100456Display a remote directory listing of either
Damien Miller33804262001-02-04 23:20:18 +1100457.Ar path
Darren Tucker16e254d2004-12-06 22:46:45 +1100458or the current directory if
Damien Miller33804262001-02-04 23:20:18 +1100459.Ar path
Damien Miller50677922003-05-23 18:44:04 +1000460is not specified.
Darren Tucker16e254d2004-12-06 22:46:45 +1100461.Ar path
462may contain
kn@openbsd.orgddf1b792018-07-23 19:02:49 +0000463.Xr glob 7
Darren Tucker16e254d2004-12-06 22:46:45 +1100464characters and may match multiple files.
Darren Tucker15ca6e82004-06-22 13:08:21 +1000465.Pp
Darren Tucker16e254d2004-12-06 22:46:45 +1100466The following flags are recognized and alter the behaviour of
Darren Tucker15ca6e82004-06-22 13:08:21 +1000467.Ic ls
Darren Tucker16e254d2004-12-06 22:46:45 +1100468accordingly:
469.Bl -tag -width Ds
470.It Fl 1
471Produce single columnar output.
472.It Fl a
473List files beginning with a dot
474.Pq Sq \&. .
475.It Fl f
476Do not sort the listing.
477The default sort order is lexicographical.
Darren Tucker2901e2d2010-01-13 22:44:06 +1100478.It Fl h
479When used with a long format option, use unit suffixes: Byte, Kilobyte,
480Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
481the number of digits to four or fewer using powers of 2 for sizes (K=1024,
482M=1048576, etc.).
Darren Tucker75fe6262010-01-15 11:42:51 +1100483.It Fl l
484Display additional details including permissions
485and ownership information.
Darren Tucker16e254d2004-12-06 22:46:45 +1100486.It Fl n
487Produce a long listing with user and group information presented
488numerically.
489.It Fl r
490Reverse the sort order of the listing.
491.It Fl S
492Sort the listing by file size.
493.It Fl t
494Sort the listing by last modification time.
495.El
Damien Millerd7686fd2001-02-10 00:40:03 +1100496.It Ic lumask Ar umask
Ben Lindstrom24643222001-06-25 05:08:11 +0000497Set local umask to
Damien Millerd7686fd2001-02-10 00:40:03 +1100498.Ar umask .
499.It Ic mkdir Ar path
500Create remote directory specified by
501.Ar path .
Damien Miller62d57f62003-01-10 21:43:24 +1100502.It Ic progress
503Toggle display of progress meter.
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000504.It Xo Ic put
Damien Millerd875ff72014-05-15 13:47:15 +1000505.Op Fl afPpr
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000506.Ar local-path
Ben Lindstromd5767812002-12-23 02:23:37 +0000507.Op Ar remote-path
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000508.Xc
Damien Miller33804262001-02-04 23:20:18 +1100509Upload
Damien Millerd7686fd2001-02-10 00:40:03 +1100510.Ar local-path
Damien Miller50677922003-05-23 18:44:04 +1000511and store it on the remote machine.
512If the remote path name is not specified, it is given the same name it has
513on the local machine.
Darren Tucker16e254d2004-12-06 22:46:45 +1100514.Ar local-path
515may contain
kn@openbsd.orgddf1b792018-07-23 19:02:49 +0000516.Xr glob 7
Darren Tucker16e254d2004-12-06 22:46:45 +1100517characters and may match multiple files.
518If it does and
519.Ar remote-path
520is specified, then
521.Ar remote-path
522must specify a directory.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100523.Pp
Damien Millerf29238e2013-10-17 11:48:52 +1100524If the
Damien Miller798a0252014-05-15 13:47:37 +1000525.Fl a
Damien Millerd875ff72014-05-15 13:47:15 +1000526flag is specified, then attempt to resume partial
527transfers of existing files.
Damien Miller798a0252014-05-15 13:47:37 +1000528Note that resumption assumes that any partial copy of the remote file
Damien Millerd875ff72014-05-15 13:47:15 +1000529matches the local copy.
530If the local file contents differ from the remote local copy then
531the resultant file is likely to be corrupt.
532.Pp
533If the
Damien Millerf29238e2013-10-17 11:48:52 +1100534.Fl f
535flag is specified, then a request will be sent to the server to call
536.Xr fsync 2
537after the file has been transferred.
538Note that this is only supported by servers that implement
539the "fsync@openssh.com" extension.
540.Pp
Darren Tuckerddccfb42011-08-07 23:12:26 +1000541If either the
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000542.Fl P
Darren Tucker1b0dd172009-10-07 08:37:48 +1100543or
544.Fl p
545flag is specified, then full file permissions and access times are
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000546copied too.
Darren Tucker1b0dd172009-10-07 08:37:48 +1100547.Pp
548If the
549.Fl r
550flag is specified then directories will be copied recursively.
551Note that
552.Nm
553does not follow symbolic links when performing recursive transfers.
Damien Millerd7686fd2001-02-10 00:40:03 +1100554.It Ic pwd
555Display remote working directory.
Damien Millerd7686fd2001-02-10 00:40:03 +1100556.It Ic quit
Damien Miller50677922003-05-23 18:44:04 +1000557Quit
558.Nm sftp .
Damien Miller0d032412013-07-25 11:56:52 +1000559.It Xo Ic reget
560.Op Fl Ppr
561.Ar remote-path
562.Op Ar local-path
563.Xc
564Resume download of
565.Ar remote-path .
566Equivalent to
567.Ic get
568with the
569.Fl a
570flag set.
Damien Millerd875ff72014-05-15 13:47:15 +1000571.It Xo Ic reput
572.Op Fl Ppr
573.Op Ar local-path
574.Ar remote-path
575.Xc
576Resume upload of
577.Op Ar local-path .
578Equivalent to
579.Ic put
Damien Miller798a0252014-05-15 13:47:37 +1000580with the
Damien Millerd875ff72014-05-15 13:47:15 +1000581.Fl a
582flag set.
Damien Millerd7686fd2001-02-10 00:40:03 +1100583.It Ic rename Ar oldpath Ar newpath
Damien Miller33804262001-02-04 23:20:18 +1100584Rename remote file from
585.Ar oldpath
586to
Damien Millerd7686fd2001-02-10 00:40:03 +1100587.Ar newpath .
Damien Millerd7686fd2001-02-10 00:40:03 +1100588.It Ic rm Ar path
Damien Miller33804262001-02-04 23:20:18 +1100589Delete remote file specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100590.Ar path .
Darren Tucker1f203942003-10-15 15:50:42 +1000591.It Ic rmdir Ar path
592Remove remote directory specified by
593.Ar path .
Damien Miller058316f2001-03-08 10:08:49 +1100594.It Ic symlink Ar oldpath Ar newpath
Ben Lindstrom24643222001-06-25 05:08:11 +0000595Create a symbolic link from
Damien Miller058316f2001-03-08 10:08:49 +1100596.Ar oldpath
597to
598.Ar newpath .
Damien Miller63421802003-01-08 14:05:23 +1100599.It Ic version
600Display the
601.Nm
602protocol version.
Damien Miller62fd18a2009-01-28 16:14:09 +1100603.It Ic \&! Ns Ar command
Ben Lindstrom24643222001-06-25 05:08:11 +0000604Execute
Damien Miller33804262001-02-04 23:20:18 +1100605.Ar command
Damien Millerd7686fd2001-02-10 00:40:03 +1100606in local shell.
Damien Millerc2b98272003-09-03 12:13:30 +1000607.It Ic \&!
Damien Millerd7686fd2001-02-10 00:40:03 +1100608Escape to local shell.
Damien Millerc2b98272003-09-03 12:13:30 +1000609.It Ic \&?
Damien Millerd7686fd2001-02-10 00:40:03 +1100610Synonym for help.
611.El
Damien Miller33804262001-02-04 23:20:18 +1100612.Sh SEE ALSO
Darren Tucker1f203942003-10-15 15:50:42 +1000613.Xr ftp 1 ,
Darren Tucker16e254d2004-12-06 22:46:45 +1100614.Xr ls 1 ,
Ben Lindstrom160ec622001-04-22 17:17:46 +0000615.Xr scp 1 ,
Damien Miller33804262001-02-04 23:20:18 +1100616.Xr ssh 1 ,
617.Xr ssh-add 1 ,
618.Xr ssh-keygen 1 ,
kn@openbsd.orgddf1b792018-07-23 19:02:49 +0000619.Xr glob 7 ,
Ben Lindstrom3072aae2002-06-21 01:02:39 +0000620.Xr ssh_config 5 ,
Ben Lindstrom160ec622001-04-22 17:17:46 +0000621.Xr sftp-server 8 ,
622.Xr sshd 8
623.Rs
Ben Lindstrom90fd0602001-06-25 04:45:33 +0000624.%A T. Ylonen
625.%A S. Lehtinen
Ben Lindstrom160ec622001-04-22 17:17:46 +0000626.%T "SSH File Transfer Protocol"
627.%N draft-ietf-secsh-filexfer-00.txt
628.%D January 2001
629.%O work in progress material
630.Re