Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame^] | 1 | .\" $OpenBSD: sftp.1,v 1.11 2001/03/06 15:10:42 deraadt Exp $ |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 2 | .\" |
Ben Lindstrom | 92a2e38 | 2001-03-05 06:59:27 +0000 | [diff] [blame] | 3 | .\" Copyright (c) 2001 Damien Miller. All rights reserved. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 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 |
Damien Miller | 225736c | 2001-02-19 21:51:08 +1100 | [diff] [blame] | 30 | .Nd Secure file transfer program |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 31 | .Sh SYNOPSIS |
| 32 | .Nm sftp |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 33 | .Op Fl vC |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 34 | .Op Fl b Ar batchfile |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 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 |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 48 | .Ar hostname , |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 49 | then enters an interactive command mode. |
| 50 | .Pp |
| 51 | The options are as follows: |
| 52 | .Bl -tag -width Ds |
Ben Lindstrom | 562c26b | 2001-03-07 01:26:48 +0000 | [diff] [blame] | 53 | .It Fl b Ar batchfile |
| 54 | Batch mode reads a series of commands from an input |
| 55 | .Fn batchfile |
| 56 | instead of |
| 57 | .Fn stdin . |
| 58 | Since it lacks user interaction it should be used in conjuction with a |
| 59 | non-interactive authentication. Sftp will abort if any of the following |
| 60 | commands fail: |
| 61 | .Pa get, put, rename, rm, mkdir, chdir, lchdir |
| 62 | and |
| 63 | .Pa lmkdir. |
Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame^] | 64 | .It Fl C |
| 65 | Enables compression (via ssh's |
| 66 | .Fl C |
| 67 | flag) |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 68 | .It Fl o Ar ssh_option |
| 69 | Specify an option to be directly passed to |
| 70 | .Xr ssh 1 . |
Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame^] | 71 | .It Fl v |
| 72 | Raise logging level. This option is also passed to ssh. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 73 | .El |
| 74 | .Sh INTERACTIVE COMMANDS |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 75 | Once in interactive mode, |
| 76 | .Nm |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 77 | understands a set of commands similar to those of |
| 78 | .Xr ftp 1 . |
Ben Lindstrom | 27cb1d0 | 2001-02-10 21:59:35 +0000 | [diff] [blame] | 79 | Commands are case insensitive and pathnames may be enclosed in quotes if they |
| 80 | contain spaces. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 81 | .Bl -tag -width Ds |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 82 | .It Ic cd Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 83 | Change remote directory to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 84 | .Ar path . |
| 85 | .It Ic lcd Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 86 | Change local directory to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 87 | .Ar path . |
| 88 | .It Ic chgrp Ar grp Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 89 | Change group of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 90 | .Ar path |
| 91 | to |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 92 | .Ar grp . |
| 93 | .Ar grp |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 94 | must be a numeric GID. |
| 95 | .It Ic chmod Ar mode Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 96 | Change permissions of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 97 | .Ar path |
| 98 | to |
| 99 | .Ar mode . |
| 100 | .It Ic chown Ar own Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 101 | Change owner of file |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 102 | .Ar path |
| 103 | to |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 104 | .Ar own . |
| 105 | .Ar own |
| 106 | must be a numeric UID. |
Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame^] | 107 | .It Ic exit |
| 108 | Quit sftp. |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 109 | .It Xo Ic get |
| 110 | .Op Ar flags |
| 111 | .Ar remote-path |
| 112 | .Op Ar local-path |
| 113 | .Xc |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 114 | Retrieve the |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 115 | .Ar remote-path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 116 | and store it on the local machine. |
| 117 | If the local |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 118 | path name is not specified, it is given the same name it has on the |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 119 | remote machine. If the |
| 120 | .Fl P |
| 121 | flag is specified, then the file's full permission and access time are |
| 122 | copied too. |
Ben Lindstrom | c9b6eab | 2001-03-07 01:29:17 +0000 | [diff] [blame^] | 123 | .It Ic help |
| 124 | Display help text. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 125 | .It Ic lls Op Ar ls-options Op Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 126 | Display local directory listing of either |
| 127 | .Ar path |
| 128 | or current directory if |
| 129 | .Ar path |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 130 | is not specified. |
| 131 | .It Ic lmkdir Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 132 | Create local directory specified by |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 133 | .Ar path . |
| 134 | .It Ic lpwd |
| 135 | Print local working directory. |
| 136 | .It Ic ls Op Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 137 | Display remote directory listing of either |
| 138 | .Ar path |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 139 | or current directory if |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 140 | .Ar path |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 141 | is not specified. |
| 142 | .It Ic lumask Ar umask |
| 143 | Set local umask to |
| 144 | .Ar umask . |
| 145 | .It Ic mkdir Ar path |
| 146 | Create remote directory specified by |
| 147 | .Ar path . |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 148 | .It Xo Ic put |
| 149 | .Op Ar flags |
| 150 | .Ar local-path |
| 151 | .Op Ar local-path |
| 152 | .Xc |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 153 | Upload |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 154 | .Ar local-path |
| 155 | and store it on the remote machine. If the remote path name is not specified, |
Ben Lindstrom | 9d4f2c8 | 2001-02-15 03:22:45 +0000 | [diff] [blame] | 156 | it is given the same name it has on the local machine. If the |
| 157 | .Fl P |
| 158 | flag is specified, then the file's full permission and access time are |
| 159 | copied too. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 160 | .It Ic pwd |
| 161 | Display remote working directory. |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 162 | .It Ic quit |
| 163 | Quit sftp. |
| 164 | .It Ic rename Ar oldpath Ar newpath |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 165 | Rename remote file from |
| 166 | .Ar oldpath |
| 167 | to |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 168 | .Ar newpath . |
| 169 | .It Ic rmdir Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 170 | Remove remote directory specified by |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 171 | .Ar path . |
| 172 | .It Ic rm Ar path |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 173 | Delete remote file specified by |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 174 | .Ar path . |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 175 | .It Ic ! Ar command |
| 176 | Execute |
| 177 | .Ar command |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 178 | in local shell. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 179 | .It Ic ! |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 180 | Escape to local shell. |
| 181 | .It Ic ? |
| 182 | Synonym for help. |
| 183 | .El |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 184 | .Sh AUTHORS |
| 185 | Damien Miller <djm@mindrot.org> |
| 186 | .Sh SEE ALSO |
| 187 | .Xr ssh 1 , |
| 188 | .Xr ssh-add 1 , |
| 189 | .Xr ssh-keygen 1 , |
Damien Miller | d7686fd | 2001-02-10 00:40:03 +1100 | [diff] [blame] | 190 | .Xr sshd 8 , |
| 191 | .Xr scp 1 |
| 192 | |