Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / d7686fd1fbe842baa8ce77f018c040d5e1d3438a / . / sftp.1
blob: 84edc4d67e081121ef596a9ef0da920c7ad91699 [file] [log] [blame]
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]1.\" $OpenBSD: sftp.1,v 1.5 2001/02/07 18:10:39 stevesk Exp $
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]2.\"
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 +1100[diff] [blame^]33.Op Fl vC
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]34.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 +1100[diff] [blame^]47.Ar hostname ,
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]48then enters an interactive command mode.
49.Pp
50The options are as follows:
51.Bl -tag -width Ds
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]52.It Fl v
53Raise logging level. This option is also passed to ssh.
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]54.It Fl C
55Enables compression (via ssh's
56.Fl C
57flag)
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]58.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 +1100[diff] [blame^]63Once in interactive mode,
64.Nm
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]65understands a set of commands similar to those of
66.Xr ftp 1 .
67Commands are case insensitive.
68.Bl -tag -width Ds
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]69.It Ic cd Ar path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]70Change remote directory to
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]71.Ar path .
72.It Ic lcd Ar path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]73Change local directory to
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]74.Ar path .
75.It Ic chgrp Ar grp Ar path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]76Change group of file
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]77.Ar path
78to
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]79.Ar grp .
80.Ar grp
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]81must be a numeric GID.
82.It Ic chmod Ar mode Ar path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]83Change permissions of file
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]84.Ar path
85to
86.Ar mode .
87.It Ic chown Ar own Ar path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]88Change owner of file
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]89.Ar path
90to
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]91.Ar own .
92.Ar own
93must be a numeric UID.
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]94.It Ic help
95Display help text.
96.It Ic get Ar remote-path Op Ar local-path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]97Retrieve the
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]98.Ar remote-path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]99and store it on the local machine.
100If the local
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]101path name is not specified, it is given the same name it has on the
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]102remote machine.
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]103.It Ic lls Op Ar ls-options Op Ar path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]104Display local directory listing of either
105.Ar path
106or current directory if
107.Ar path
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]108is not specified.
109.It Ic lmkdir Ar path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]110Create local directory specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]111.Ar path .
112.It Ic lpwd
113Print local working directory.
114.It Ic ls Op Ar path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]115Display remote directory listing of either
116.Ar path
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]117or current directory if
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]118.Ar path
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]119is not specified.
120.It Ic lumask Ar umask
121Set local umask to
122.Ar umask .
123.It Ic mkdir Ar path
124Create remote directory specified by
125.Ar path .
126.It Ic put Ar local-path Op Ar remote-path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]127Upload
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]128.Ar local-path
129and store it on the remote machine. If the remote path name is not specified,
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]130it is given the same name it has on the local machine.
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]131.It Ic pwd
132Display remote working directory.
133.It Ic exit
134Quit sftp.
135.It Ic quit
136Quit sftp.
137.It Ic rename Ar oldpath Ar newpath
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]138Rename remote file from
139.Ar oldpath
140to
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]141.Ar newpath .
142.It Ic rmdir Ar path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]143Remove remote directory specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]144.Ar path .
145.It Ic rm Ar path
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]146Delete remote file specified by
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]147.Ar path .
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]148.It Ic ! Ar command
149Execute
150.Ar command
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]151in local shell.
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]152.It Ic !
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]153Escape to local shell.
154.It Ic ?
155Synonym for help.
156.El
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]157.Sh AUTHORS
158Damien Miller <djm@mindrot.org>
159.Sh SEE ALSO
160.Xr ssh 1 ,
161.Xr ssh-add 1 ,
162.Xr ssh-keygen 1 ,
Damien Millerd7686fd2001-02-10 00:40:03 +1100[diff] [blame^]163.Xr sshd 8 ,
164.Xr scp 1
165