blob: 635c07b2e547bc6d46d55e13e182bc5583c99f65 [file] [log] [blame]
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +00001.\" $OpenBSD: sftp.1,v 1.7 2001/02/14 09:46:03 djm Exp $
Damien Miller33804262001-02-04 23:20:18 +11002.\"
3.\" Copyright (c) 2001 Damien Miller. All rights reserved.
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.\"
25.Dd Febuary 4, 2001
26.Dt SFTP 1
27.Os
28.Sh NAME
29.Nm sftp
30.Nd Secure file tranfer program
31.Sh SYNOPSIS
32.Nm sftp
Damien Millerd7686fd2001-02-10 00:40:03 +110033.Op Fl vC
Damien Miller33804262001-02-04 23:20:18 +110034.Op Fl o Ar ssh_option
35.Op Ar hostname | user@hostname
36.Sh DESCRIPTION
37.Nm
38is an interactive file transfer program, similar to
39.Xr ftp 1 ,
40which performs all operations over an encrypted
41.Xr ssh 1
42transport.
43It may also use many features of ssh, such as public key authentication and
44compression.
45.Nm
46connects and logs into the specified
Damien Millerd7686fd2001-02-10 00:40:03 +110047.Ar hostname ,
Damien Miller33804262001-02-04 23:20:18 +110048then enters an interactive command mode.
49.Pp
50The options are as follows:
51.Bl -tag -width Ds
Damien Millerd7686fd2001-02-10 00:40:03 +110052.It Fl v
53Raise logging level. This option is also passed to ssh.
Damien Miller33804262001-02-04 23:20:18 +110054.It Fl C
55Enables compression (via ssh's
56.Fl C
57flag)
Damien Miller33804262001-02-04 23:20:18 +110058.It Fl o Ar ssh_option
59Specify an option to be directly passed to
60.Xr ssh 1 .
61.El
62.Sh INTERACTIVE COMMANDS
Damien Millerd7686fd2001-02-10 00:40:03 +110063Once in interactive mode,
64.Nm
Damien Miller33804262001-02-04 23:20:18 +110065understands a set of commands similar to those of
66.Xr ftp 1 .
Ben Lindstrom27cb1d02001-02-10 21:59:35 +000067Commands are case insensitive and pathnames may be enclosed in quotes if they
68contain spaces.
Damien Miller33804262001-02-04 23:20:18 +110069.Bl -tag -width Ds
Damien Millerd7686fd2001-02-10 00:40:03 +110070.It Ic cd Ar path
Damien Miller33804262001-02-04 23:20:18 +110071Change remote directory to
Damien Millerd7686fd2001-02-10 00:40:03 +110072.Ar path .
73.It Ic lcd Ar path
Damien Miller33804262001-02-04 23:20:18 +110074Change local directory to
Damien Millerd7686fd2001-02-10 00:40:03 +110075.Ar path .
76.It Ic chgrp Ar grp Ar path
Damien Miller33804262001-02-04 23:20:18 +110077Change group of file
Damien Millerd7686fd2001-02-10 00:40:03 +110078.Ar path
79to
Damien Miller33804262001-02-04 23:20:18 +110080.Ar grp .
81.Ar grp
Damien Millerd7686fd2001-02-10 00:40:03 +110082must be a numeric GID.
83.It Ic chmod Ar mode Ar path
Damien Miller33804262001-02-04 23:20:18 +110084Change permissions of file
Damien Millerd7686fd2001-02-10 00:40:03 +110085.Ar path
86to
87.Ar mode .
88.It Ic chown Ar own Ar path
Damien Miller33804262001-02-04 23:20:18 +110089Change owner of file
Damien Millerd7686fd2001-02-10 00:40:03 +110090.Ar path
91to
Damien Miller33804262001-02-04 23:20:18 +110092.Ar own .
93.Ar own
94must be a numeric UID.
Damien Millerd7686fd2001-02-10 00:40:03 +110095.It Ic help
96Display help text.
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +000097.It Xo Ic get
98.Op Ar flags
99.Ar remote-path
100.Op Ar local-path
101.Xc
Damien Miller33804262001-02-04 23:20:18 +1100102Retrieve the
Damien Millerd7686fd2001-02-10 00:40:03 +1100103.Ar remote-path
Damien Miller33804262001-02-04 23:20:18 +1100104and store it on the local machine.
105If the local
Damien Millerd7686fd2001-02-10 00:40:03 +1100106path name is not specified, it is given the same name it has on the
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000107remote machine. If the
108.Fl P
109flag is specified, then the file's full permission and access time are
110copied too.
Damien Millerd7686fd2001-02-10 00:40:03 +1100111.It Ic lls Op Ar ls-options Op Ar path
Damien Miller33804262001-02-04 23:20:18 +1100112Display local directory listing of either
113.Ar path
114or current directory if
115.Ar path
Damien Millerd7686fd2001-02-10 00:40:03 +1100116is not specified.
117.It Ic lmkdir Ar path
Damien Miller33804262001-02-04 23:20:18 +1100118Create local directory specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100119.Ar path .
120.It Ic lpwd
121Print local working directory.
122.It Ic ls Op Ar path
Damien Miller33804262001-02-04 23:20:18 +1100123Display remote directory listing of either
124.Ar path
Damien Millerd7686fd2001-02-10 00:40:03 +1100125or current directory if
Damien Miller33804262001-02-04 23:20:18 +1100126.Ar path
Damien Millerd7686fd2001-02-10 00:40:03 +1100127is not specified.
128.It Ic lumask Ar umask
129Set local umask to
130.Ar umask .
131.It Ic mkdir Ar path
132Create remote directory specified by
133.Ar path .
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000134.It Xo Ic put
135.Op Ar flags
136.Ar local-path
137.Op Ar local-path
138.Xc
Damien Miller33804262001-02-04 23:20:18 +1100139Upload
Damien Millerd7686fd2001-02-10 00:40:03 +1100140.Ar local-path
141and store it on the remote machine. If the remote path name is not specified,
Ben Lindstrom9d4f2c82001-02-15 03:22:45 +0000142it is given the same name it has on the local machine. If the
143.Fl P
144flag is specified, then the file's full permission and access time are
145copied too.
Damien Millerd7686fd2001-02-10 00:40:03 +1100146.It Ic pwd
147Display remote working directory.
148.It Ic exit
149Quit sftp.
150.It Ic quit
151Quit sftp.
152.It Ic rename Ar oldpath Ar newpath
Damien Miller33804262001-02-04 23:20:18 +1100153Rename remote file from
154.Ar oldpath
155to
Damien Millerd7686fd2001-02-10 00:40:03 +1100156.Ar newpath .
157.It Ic rmdir Ar path
Damien Miller33804262001-02-04 23:20:18 +1100158Remove remote directory specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100159.Ar path .
160.It Ic rm Ar path
Damien Miller33804262001-02-04 23:20:18 +1100161Delete remote file specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100162.Ar path .
Damien Miller33804262001-02-04 23:20:18 +1100163.It Ic ! Ar command
164Execute
165.Ar command
Damien Millerd7686fd2001-02-10 00:40:03 +1100166in local shell.
Damien Miller33804262001-02-04 23:20:18 +1100167.It Ic !
Damien Millerd7686fd2001-02-10 00:40:03 +1100168Escape to local shell.
169.It Ic ?
170Synonym for help.
171.El
Damien Miller33804262001-02-04 23:20:18 +1100172.Sh AUTHORS
173Damien Miller <djm@mindrot.org>
174.Sh SEE ALSO
175.Xr ssh 1 ,
176.Xr ssh-add 1 ,
177.Xr ssh-keygen 1 ,
Damien Millerd7686fd2001-02-10 00:40:03 +1100178.Xr sshd 8 ,
179.Xr scp 1
180