sftp.1

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