sftp.1

   1 .\" $OpenBSD: sftp.1,v 1.5 2001/02/07 18:10:39 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 tranfer program
  31 .Sh SYNOPSIS
  32 .Nm sftp
  33 .Op Fl vC
  34 .Op Fl o Ar ssh_option
  35 .Op Ar hostname | user@hostname
  36 .Sh DESCRIPTION
  37 .Nm
  38 is an interactive file transfer program, similar to
  39 .Xr ftp 1 ,
  40 which performs all operations over an encrypted
  41 .Xr ssh 1
  42 transport.
  43 It may also use many features of ssh, such as public key authentication and
  44 compression.
  45 .Nm
  46 connects and logs into the specified
  47 .Ar hostname ,
  48 then enters an interactive command mode.
  49 .Pp
  50 The options are as follows:
  51 .Bl -tag -width Ds
  52 .It Fl v
  53 Raise logging level. This option is also passed to ssh.
  54 .It Fl C
  55 Enables compression (via ssh's
  56 .Fl C
  57 flag)
  58 .It Fl o Ar ssh_option
  59 Specify an option to be directly passed to
  60 .Xr ssh 1 .
  61 .El
  62 .Sh INTERACTIVE COMMANDS
  63 Once in interactive mode,
  64 .Nm
  65 understands a set of commands similar to those of
  66 .Xr ftp 1 .
  67 Commands are case insensitive.
  68 .Bl -tag -width Ds
  69 .It Ic cd Ar path
  70 Change remote directory to
  71 .Ar path .
  72 .It Ic lcd Ar path
  73 Change local directory to
  74 .Ar path .
  75 .It Ic chgrp Ar grp Ar path
  76 Change group of file
  77 .Ar path
  78 to
  79 .Ar grp .
  80 .Ar grp
  81 must be a numeric GID.
  82 .It Ic chmod Ar mode Ar path
  83 Change permissions of file
  84 .Ar path
  85 to
  86 .Ar mode .
  87 .It Ic chown Ar own Ar path
  88 Change owner of file
  89 .Ar path
  90 to
  91 .Ar own .
  92 .Ar own
  93 must be a numeric UID.
  94 .It Ic help
  95 Display help text.
  96 .It Ic get Ar remote-path Op Ar local-path
  97 Retrieve the
  98 .Ar remote-path
  99 and store it on the local machine.
 100 If the local
 101 path name is not specified, it is given the same name it has on the
 102 remote machine.
 103 .It Ic lls Op Ar ls-options Op Ar path
 104 Display local directory listing of either
 105 .Ar path
 106 or current directory if
 107 .Ar path
 108 is not specified.
 109 .It Ic lmkdir Ar path
 110 Create local directory specified by
 111 .Ar path .
 112 .It Ic lpwd
 113 Print local working directory.
 114 .It Ic ls Op Ar path
 115 Display remote directory listing of either
 116 .Ar path
 117 or current directory if
 118 .Ar path
 119 is not specified.
 120 .It Ic lumask Ar umask
 121 Set local umask to
 122 .Ar umask .
 123 .It Ic mkdir Ar path
 124 Create remote directory specified by
 125 .Ar path .
 126 .It Ic put Ar local-path Op Ar remote-path
 127 Upload
 128 .Ar local-path
 129 and store it on the remote machine. If the remote path name is not specified,
 130 it is given the same name it has on the local machine.
 131 .It Ic pwd
 132 Display remote working directory.
 133 .It Ic exit
 134 Quit sftp.
 135 .It Ic quit
 136 Quit sftp.
 137 .It Ic rename Ar oldpath Ar newpath
 138 Rename remote file from
 139 .Ar oldpath
 140 to
 141 .Ar newpath .
 142 .It Ic rmdir Ar path
 143 Remove remote directory specified by
 144 .Ar path .
 145 .It Ic rm Ar path
 146 Delete remote file specified by
 147 .Ar path .
 148 .It Ic ! Ar command
 149 Execute
 150 .Ar command
 151 in local shell.
 152 .It Ic !
 153 Escape to local shell.
 154 .It Ic ?
 155 Synonym for help.
 156 .El
 157 .Sh AUTHORS
 158 Damien Miller <djm@mindrot.org>
 159 .Sh SEE ALSO
 160 .Xr ssh 1 ,
 161 .Xr ssh-add 1 ,
 162 .Xr ssh-keygen 1 ,
 163 .Xr sshd 8 ,
 164 .Xr scp 1
 165