sftp.1

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