1.\" $OpenBSD: sftp.1,v 1.17 2001/04/22 13:32:27 markus Exp $ 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 February 4, 2001 26.Dt SFTP 1 27.Os 28.Sh NAME 29.Nm sftp 30.Nd Secure file transfer program 31.Sh SYNOPSIS 32.Nm sftp 33.Op Fl vC 34.Op Fl b Ar batchfile 35.Op Fl o Ar ssh_option 36.Op Ar host 37.Nm sftp 38.Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]] 39.Nm sftp 40.Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]] 41.Sh DESCRIPTION 42.Nm 43is an interactive file transfer program, similar to 44.Xr ftp 1 , 45which performs all operations over an encrypted 46.Xr ssh 1 47transport. 48It may also use many features of ssh, such as public key authentication and 49compression. 50.Nm 51connects and logs into the specified 52.Ar hostname , 53then enters an interactive command mode. 54.Pp 55The second usage format will fetch files automaticly if a non-interactive 56authentication is used, else it do so after an interactive authentication 57is used. 58.Pp 59The last usage format allows the sftp client to start in a remote directory. 60.Pp 61The options are as follows: 62.Bl -tag -width Ds 63.It Fl b Ar batchfile 64Batch mode reads a series of commands from an input 65.Ar batchfile 66instead of 67.Em stdin . 68Since it lacks user interaction it should be used in conjunction with 69non-interactive authentication. 70.Nm 71will abort if any of the following 72commands fail: 73.Ic get , put , rename , ln , rm , mkdir , chdir , lchdir 74and 75.Ic lmkdir . 76.It Fl C 77Enables compression (via ssh's 78.Fl C 79flag) 80.It Fl o Ar ssh_option 81Specify an option to be directly passed to 82.Xr ssh 1 . 83.It Fl v 84Raise logging level. This option is also passed to ssh. 85.El 86.Sh INTERACTIVE COMMANDS 87Once in interactive mode, 88.Nm 89understands a set of commands similar to those of 90.Xr ftp 1 . 91Commands are case insensitive and pathnames may be enclosed in quotes if they 92contain spaces. 93.Bl -tag -width Ds 94.It Ic cd Ar path 95Change remote directory to 96.Ar path . 97.It Ic lcd Ar path 98Change local directory to 99.Ar path . 100.It Ic chgrp Ar grp Ar path 101Change group of file 102.Ar path 103to 104.Ar grp . 105.Ar grp 106must be a numeric GID. 107.It Ic chmod Ar mode Ar path 108Change permissions of file 109.Ar path 110to 111.Ar mode . 112.It Ic chown Ar own Ar path 113Change owner of file 114.Ar path 115to 116.Ar own . 117.Ar own 118must be a numeric UID. 119.It Ic exit 120Quit sftp. 121.It Xo Ic get 122.Op Ar flags 123.Ar remote-path 124.Op Ar local-path 125.Xc 126Retrieve the 127.Ar remote-path 128and store it on the local machine. 129If the local 130path name is not specified, it is given the same name it has on the 131remote machine. If the 132.Fl P 133flag is specified, then the file's full permission and access time are 134copied too. 135.It Ic help 136Display help text. 137.It Ic lls Op Ar ls-options Op Ar path 138Display local directory listing of either 139.Ar path 140or current directory if 141.Ar path 142is not specified. 143.It Ic lmkdir Ar path 144Create local directory specified by 145.Ar path . 146.It Ic ln Ar oldpath Ar newpath 147Create a symbolic link from 148.Ar oldpath 149to 150.Ar newpath . 151.It Ic lpwd 152Print local working directory. 153.It Ic ls Op Ar path 154Display remote directory listing of either 155.Ar path 156or current directory if 157.Ar path 158is not specified. 159.It Ic lumask Ar umask 160Set local umask to 161.Ar umask . 162.It Ic mkdir Ar path 163Create remote directory specified by 164.Ar path . 165.It Xo Ic put 166.Op Ar flags 167.Ar local-path 168.Op Ar local-path 169.Xc 170Upload 171.Ar local-path 172and store it on the remote machine. If the remote path name is not 173specified, it is given the same name it has on the local machine. If the 174.Fl P 175flag is specified, then the file's full permission and access time are 176copied too. 177.It Ic pwd 178Display remote working directory. 179.It Ic quit 180Quit sftp. 181.It Ic rename Ar oldpath Ar newpath 182Rename remote file from 183.Ar oldpath 184to 185.Ar newpath . 186.It Ic rmdir Ar path 187Remove remote directory specified by 188.Ar path . 189.It Ic rm Ar path 190Delete remote file specified by 191.Ar path . 192.It Ic symlink Ar oldpath Ar newpath 193Create a symbolic link from 194.Ar oldpath 195to 196.Ar newpath . 197.It Ic ! Ar command 198Execute 199.Ar command 200in local shell. 201.It Ic ! 202Escape to local shell. 203.It Ic ? 204Synonym for help. 205.El 206.Sh AUTHORS 207Damien Miller <djm@mindrot.org> 208.Sh SEE ALSO 209.Xr scp 1 , 210.Xr ssh 1 , 211.Xr ssh-add 1 , 212.Xr ssh-keygen 1 , 213.Xr sftp-server 8 , 214.Xr sshd 8 215.Rs 216.%A T. Ylonen 217.%A S. Lehtinen 218.%T "SSH File Transfer Protocol" 219.%N draft-ietf-secsh-filexfer-00.txt 220.%D January 2001 221.%O work in progress material 222.Re 223