| .\" $OpenBSD: sftp.1,v 1.13 2001/03/08 20:44:48 stevesk Exp $ |
| .\" |
| .\" Copyright (c) 2001 Damien Miller. All rights reserved. |
| .\" |
| .\" Redistribution and use in source and binary forms, with or without |
| .\" modification, are permitted provided that the following conditions |
| .\" are met: |
| .\" 1. Redistributions of source code must retain the above copyright |
| .\" notice, this list of conditions and the following disclaimer. |
| .\" 2. Redistributions in binary form must reproduce the above copyright |
| .\" notice, this list of conditions and the following disclaimer in the |
| .\" documentation and/or other materials provided with the distribution. |
| .\" |
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| .\" |
| .Dd Febuary 4, 2001 |
| .Dt SFTP 1 |
| .Os |
| .Sh NAME |
| .Nm sftp |
| .Nd Secure file transfer program |
| .Sh SYNOPSIS |
| .Nm sftp |
| .Op Fl vC |
| .Op Fl b Ar batchfile |
| .Op Fl o Ar ssh_option |
| .Op Ar hostname | user@hostname |
| .Sh DESCRIPTION |
| .Nm |
| is an interactive file transfer program, similar to |
| .Xr ftp 1 , |
| which performs all operations over an encrypted |
| .Xr ssh 1 |
| transport. |
| It may also use many features of ssh, such as public key authentication and |
| compression. |
| .Nm |
| connects and logs into the specified |
| .Ar hostname , |
| then enters an interactive command mode. |
| .Pp |
| The options are as follows: |
| .Bl -tag -width Ds |
| .It Fl b Ar batchfile |
| Batch mode reads a series of commands from an input |
| .Ar batchfile |
| instead of |
| .Em stdin . |
| Since it lacks user interaction it should be used in conjunction with |
| non-interactive authentication. |
| .Nm |
| will abort if any of the following |
| commands fail: |
| .Ic get , put , rename , ln , rm , mkdir , chdir , lchdir |
| and |
| .Ic lmkdir . |
| .It Fl C |
| Enables compression (via ssh's |
| .Fl C |
| flag) |
| .It Fl o Ar ssh_option |
| Specify an option to be directly passed to |
| .Xr ssh 1 . |
| .It Fl v |
| Raise logging level. This option is also passed to ssh. |
| .El |
| .Sh INTERACTIVE COMMANDS |
| Once in interactive mode, |
| .Nm |
| understands a set of commands similar to those of |
| .Xr ftp 1 . |
| Commands are case insensitive and pathnames may be enclosed in quotes if they |
| contain spaces. |
| .Bl -tag -width Ds |
| .It Ic cd Ar path |
| Change remote directory to |
| .Ar path . |
| .It Ic lcd Ar path |
| Change local directory to |
| .Ar path . |
| .It Ic chgrp Ar grp Ar path |
| Change group of file |
| .Ar path |
| to |
| .Ar grp . |
| .Ar grp |
| must be a numeric GID. |
| .It Ic chmod Ar mode Ar path |
| Change permissions of file |
| .Ar path |
| to |
| .Ar mode . |
| .It Ic chown Ar own Ar path |
| Change owner of file |
| .Ar path |
| to |
| .Ar own . |
| .Ar own |
| must be a numeric UID. |
| .It Ic exit |
| Quit sftp. |
| .It Xo Ic get |
| .Op Ar flags |
| .Ar remote-path |
| .Op Ar local-path |
| .Xc |
| Retrieve the |
| .Ar remote-path |
| and store it on the local machine. |
| If the local |
| path name is not specified, it is given the same name it has on the |
| remote machine. If the |
| .Fl P |
| flag is specified, then the file's full permission and access time are |
| copied too. |
| .It Ic help |
| Display help text. |
| .It Ic lls Op Ar ls-options Op Ar path |
| Display local directory listing of either |
| .Ar path |
| or current directory if |
| .Ar path |
| is not specified. |
| .It Ic lmkdir Ar path |
| Create local directory specified by |
| .Ar path . |
| .It Ic ln Ar oldpath Ar newpath |
| Create a symbolic link from |
| .Ar oldpath |
| to |
| .Ar newpath . |
| .It Ic lpwd |
| Print local working directory. |
| .It Ic ls Op Ar path |
| Display remote directory listing of either |
| .Ar path |
| or current directory if |
| .Ar path |
| is not specified. |
| .It Ic lumask Ar umask |
| Set local umask to |
| .Ar umask . |
| .It Ic mkdir Ar path |
| Create remote directory specified by |
| .Ar path . |
| .It Xo Ic put |
| .Op Ar flags |
| .Ar local-path |
| .Op Ar local-path |
| .Xc |
| Upload |
| .Ar local-path |
| and store it on the remote machine. If the remote path name is not |
| specified, it is given the same name it has on the local machine. If the |
| .Fl P |
| flag is specified, then the file's full permission and access time are |
| copied too. |
| .It Ic pwd |
| Display remote working directory. |
| .It Ic quit |
| Quit sftp. |
| .It Ic rename Ar oldpath Ar newpath |
| Rename remote file from |
| .Ar oldpath |
| to |
| .Ar newpath . |
| .It Ic rmdir Ar path |
| Remove remote directory specified by |
| .Ar path . |
| .It Ic rm Ar path |
| Delete remote file specified by |
| .Ar path . |
| .It Ic symlink Ar oldpath Ar newpath |
| Create a symbolic link from |
| .Ar oldpath |
| to |
| .Ar newpath . |
| .It Ic ! Ar command |
| Execute |
| .Ar command |
| in local shell. |
| .It Ic ! |
| Escape to local shell. |
| .It Ic ? |
| Synonym for help. |
| .El |
| .Sh AUTHORS |
| Damien Miller <djm@mindrot.org> |
| .Sh SEE ALSO |
| .Xr ssh 1 , |
| .Xr sftp-server 8 , |
| .Xr ssh-add 1 , |
| .Xr ssh-keygen 1 , |
| .Xr sshd 8 , |
| .Xr scp 1 |
| |