1 .\" $OpenBSD: sftp.1,v 1.14 2001/04/09 00:42:05 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 o Ar ssh_option
36 .Op Ar hostname | user@hostname
39 is an interactive file transfer program, similar to
41 which performs all operations over an encrypted
44 It may also use many features of ssh, such as public key authentication and
47 connects and logs into the specified
49 then enters an interactive command mode.
51 The options are as follows:
54 Batch mode reads a series of commands from an input
58 Since it lacks user interaction it should be used in conjunction with
59 non-interactive authentication.
61 will abort if any of the following
63 .Ic get , put , rename , ln , rm , mkdir , chdir , lchdir
67 Enables compression (via ssh's
70 .It Fl o Ar ssh_option
71 Specify an option to be directly passed to
74 Raise logging level. This option is also passed to ssh.
76 .Sh INTERACTIVE COMMANDS
77 Once in interactive mode,
79 understands a set of commands similar to those of
81 Commands are case insensitive and pathnames may be enclosed in quotes if they
85 Change remote directory to
88 Change local directory to
90 .It Ic chgrp Ar grp Ar path
96 must be a numeric GID.
97 .It Ic chmod Ar mode Ar path
98 Change permissions of file
102 .It Ic chown Ar own Ar path
108 must be a numeric UID.
118 and store it on the local machine.
120 path name is not specified, it is given the same name it has on the
121 remote machine. If the
123 flag is specified, then the file's full permission and access time are
127 .It Ic lls Op Ar ls-options Op Ar path
128 Display local directory listing of either
130 or current directory if
133 .It Ic lmkdir Ar path
134 Create local directory specified by
136 .It Ic ln Ar oldpath Ar newpath
137 Create a symbolic link from
142 Print local working directory.
144 Display remote directory listing of either
146 or current directory if
149 .It Ic lumask Ar umask
153 Create remote directory specified by
162 and store it on the remote machine. If the remote path name is not
163 specified, it is given the same name it has on the local machine. If the
165 flag is specified, then the file's full permission and access time are
168 Display remote working directory.
171 .It Ic rename Ar oldpath Ar newpath
172 Rename remote file from
177 Remove remote directory specified by
180 Delete remote file specified by
182 .It Ic symlink Ar oldpath Ar newpath
183 Create a symbolic link from
192 Escape to local shell.
197 Damien Miller <djm@mindrot.org>