1 .\" $OpenBSD: sftp.1,v 1.26 2001/09/17 20:38:09 stevesk Exp $
3 .\" Copyright (c) 2001 Damien Miller. All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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.
30 .Nd Secure file transfer program
35 .Op Fl F Ar ssh_config
36 .Op Fl o Ar ssh_option
37 .Op Fl s Ar subsystem | sftp_server
41 .Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]]
43 .Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]]
46 is an interactive file transfer program, similar to
48 which performs all operations over an encrypted
51 It may also use many features of ssh, such as public key authentication and
54 connects and logs into the specified
56 then enters an interactive command mode.
58 The second usage format will retrieve files automatically if a non-interactive
59 authentication method is used; otherwise it will do so after
60 successful interactive authentication.
62 The last usage format allows the sftp client to start in a remote directory.
64 The options are as follows:
67 Specify the use of protocol version 1.
69 Batch mode reads a series of commands from an input
73 Since it lacks user interaction it should be used in conjunction with
74 non-interactive authentication.
76 will abort if any of the following
78 .Ic get , put , rename , ln , rm , mkdir , chdir , lchdir
82 Enables compression (via ssh's
85 .It Fl F Ar ssh_config
86 Specifies an alternative
87 per-user configuration file for
89 This option is directly passed to
91 .It Fl o Ar ssh_option
92 Can be used to pass options to
94 in the format used in the
96 configuration file. This is useful for specifying options
97 for which there is no separate
99 command-line flag. For example, to specify an alternate
102 .It Fl s Ar subsystem | sftp_server
103 Specifies the SSH2 subsystem or the path for an sftp server
104 on the remote host. A path is useful for using sftp over
105 protocol version 1, or when the remote
107 does not have an sftp subsystem configured.
111 to use for the encrypted connection.
112 The program must understand
116 Raise logging level. This option is also passed to ssh.
118 .Sh INTERACTIVE COMMANDS
119 Once in interactive mode,
121 understands a set of commands similar to those of
123 Commands are case insensitive and pathnames may be enclosed in quotes if they
129 Change remote directory to
132 Change local directory to
134 .It Ic chgrp Ar grp Ar path
140 must be a numeric GID.
141 .It Ic chmod Ar mode Ar path
142 Change permissions of file
146 .It Ic chown Ar own Ar path
152 must be a numeric UID.
162 and store it on the local machine.
164 path name is not specified, it is given the same name it has on the
165 remote machine. If the
167 flag is specified, then the file's full permission and access time are
171 .It Ic lls Op Ar ls-options Op Ar path
172 Display local directory listing of either
174 or current directory if
177 .It Ic lmkdir Ar path
178 Create local directory specified by
180 .It Ic ln Ar oldpath Ar newpath
181 Create a symbolic link from
186 Print local working directory.
188 Display remote directory listing of either
190 or current directory if
193 .It Ic lumask Ar umask
197 Create remote directory specified by
206 and store it on the remote machine. If the remote path name is not
207 specified, it is given the same name it has on the local machine. If the
209 flag is specified, then the file's full permission and access time are
212 Display remote working directory.
215 .It Ic rename Ar oldpath Ar newpath
216 Rename remote file from
221 Remove remote directory specified by
224 Delete remote file specified by
226 .It Ic symlink Ar oldpath Ar newpath
227 Create a symbolic link from
236 Escape to local shell.
241 Damien Miller <djm@mindrot.org>
252 .%T "SSH File Transfer Protocol"
253 .%N draft-ietf-secsh-filexfer-00.txt
255 .%O work in progress material