Annotation of src/usr.bin/ssh/sftp.1, Revision 1.43
1.43 ! jmc 1: .\" $OpenBSD: sftp.1,v 1.42 2003/05/14 01:00:44 djm Exp $
1.1 djm 2: .\"
1.9 deraadt 3: .\" Copyright (c) 2001 Damien Miller. All rights reserved.
1.1 djm 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: .\"
1.14 stevesk 25: .Dd February 4, 2001
1.1 djm 26: .Dt SFTP 1
27: .Os
28: .Sh NAME
29: .Nm sftp
1.8 reinhard 30: .Nd Secure file transfer program
1.1 djm 31: .Sh SYNOPSIS
1.43 ! jmc 32: .Nm sftp
1.41 jmc 33: .Bk -words
1.29 markus 34: .Op Fl vC1
35: .Op Fl b Ar batchfile
36: .Op Fl o Ar ssh_option
37: .Op Fl s Ar subsystem | sftp_server
1.28 djm 38: .Op Fl B Ar buffer_size
1.25 stevesk 39: .Op Fl F Ar ssh_config
1.27 djm 40: .Op Fl P Ar sftp_server path
1.30 djm 41: .Op Fl R Ar num_requests
1.26 stevesk 42: .Op Fl S Ar program
43: .Ar host
1.41 jmc 44: .Ek
1.43 ! jmc 45: .Nm sftp
1.41 jmc 46: .Oo Oo Ar user Ns No @ Oc Ns
47: .Ar host Ns Oo : Ns Ar file Oo
48: .Ar file Oc Oc Oc
1.43 ! jmc 49: .Nm sftp
1.41 jmc 50: .Oo Oo Ar user Ns No @ Oc Ns
51: .Ar host Ns Oo : Ns Ar dir Ns
52: .Oo Ar / Oc Oc Oc
1.43 ! jmc 53: .Nm sftp
1.42 djm 54: .Fl b Ar batchfile
55: .Oo Ar user Ns No @ Oc Ns Ar host Ns
1.1 djm 56: .Sh DESCRIPTION
57: .Nm
58: is an interactive file transfer program, similar to
59: .Xr ftp 1 ,
60: which performs all operations over an encrypted
61: .Xr ssh 1
62: transport.
63: It may also use many features of ssh, such as public key authentication and
64: compression.
65: .Nm
66: connects and logs into the specified
1.18 stevesk 67: .Ar host ,
1.1 djm 68: then enters an interactive command mode.
1.15 mouring 69: .Pp
1.21 itojun 70: The second usage format will retrieve files automatically if a non-interactive
1.18 stevesk 71: authentication method is used; otherwise it will do so after
72: successful interactive authentication.
1.15 mouring 73: .Pp
1.42 djm 74: The third usage format allows the sftp client to start in a remote directory.
1.1 djm 75: .Pp
1.43 ! jmc 76: The final usage form allows for automated sessions using the
1.42 djm 77: .Fl b
78: option. In such cases, it is usually necessary to configure public key
1.43 ! jmc 79: authentication to obviate the need to enter a password at connection
! 80: time (see
1.42 djm 81: .Xr sshd 8
1.43 ! jmc 82: and
1.42 djm 83: .Xr ssh-keygen 1
84: for details.)
1.1 djm 85: The options are as follows:
86: .Bl -tag -width Ds
1.10 deraadt 87: .It Fl b Ar batchfile
88: Batch mode reads a series of commands from an input
1.13 stevesk 89: .Ar batchfile
1.10 deraadt 90: instead of
1.13 stevesk 91: .Em stdin .
92: Since it lacks user interaction it should be used in conjunction with
93: non-interactive authentication.
94: .Nm
1.21 itojun 95: will abort if any of the following
96: commands fail:
1.33 deraadt 97: .Ic get , put , rename , ln ,
1.41 jmc 98: .Ic rm , mkdir , chdir , ls ,
1.39 djm 99: .Ic lchdir , chmod , chown , chgrp , lpwd
1.10 deraadt 100: and
1.13 stevesk 101: .Ic lmkdir .
1.41 jmc 102: Termination on error can be suppressed on a command by command basis by
103: prefixing the command with a
104: .Ic '-'
1.39 djm 105: character (For example,
106: .Ic -rm /tmp/blah*
107: ).
1.1 djm 108: .It Fl o Ar ssh_option
1.23 stevesk 109: Can be used to pass options to
110: .Nm ssh
1.35 stevesk 111: in the format used in
112: .Xr ssh_config 5 .
113: This is useful for specifying options
1.23 stevesk 114: for which there is no separate
115: .Nm sftp
1.41 jmc 116: command-line flag. For example, to specify an alternate
1.26 stevesk 117: port use:
118: .Ic sftp -oPort=24 .
119: .It Fl s Ar subsystem | sftp_server
120: Specifies the SSH2 subsystem or the path for an sftp server
1.41 jmc 121: on the remote host. A path is useful for using sftp over
1.26 stevesk 122: protocol version 1, or when the remote
123: .Nm sshd
124: does not have an sftp subsystem configured.
1.29 markus 125: .It Fl v
126: Raise logging level. This option is also passed to ssh.
127: .It Fl B Ar buffer_size
1.41 jmc 128: Specify the size of the buffer that
1.29 markus 129: .Nm
130: uses when transferring files. Larger buffers require fewer round trips at
131: the cost of higher memory consumption. The default is 32768 bytes.
132: .It Fl C
133: Enables compression (via ssh's
134: .Fl C
135: flag).
136: .It Fl F Ar ssh_config
137: Specifies an alternative
138: per-user configuration file for
139: .Nm ssh .
140: This option is directly passed to
141: .Xr ssh 1 .
142: .It Fl P Ar sftp_server path
1.34 deraadt 143: Connect directly to a local
144: .Nm sftp-server
1.29 markus 145: (rather than via
146: .Nm ssh )
147: This option may be useful in debugging the client and server.
1.30 djm 148: .It Fl R Ar num_requests
1.34 deraadt 149: Specify how many requests may be outstanding at any one time. Increasing
1.30 djm 150: this may slightly improve file transfer speed but will increase memory
151: usage. The default is 16 outstanding requests.
1.26 stevesk 152: .It Fl S Ar program
153: Name of the
154: .Ar program
155: to use for the encrypted connection.
156: The program must understand
157: .Xr ssh 1
158: options.
1.29 markus 159: .It Fl 1
160: Specify the use of protocol version 1.
1.1 djm 161: .El
162: .Sh INTERACTIVE COMMANDS
1.2 djm 163: Once in interactive mode,
164: .Nm
1.21 itojun 165: understands a set of commands similar to those of
1.1 djm 166: .Xr ftp 1 .
1.6 djm 167: Commands are case insensitive and pathnames may be enclosed in quotes if they
168: contain spaces.
1.1 djm 169: .Bl -tag -width Ds
1.22 markus 170: .It Ic bye
171: Quit sftp.
1.3 deraadt 172: .It Ic cd Ar path
1.21 itojun 173: Change remote directory to
1.3 deraadt 174: .Ar path .
175: .It Ic lcd Ar path
1.21 itojun 176: Change local directory to
1.3 deraadt 177: .Ar path .
178: .It Ic chgrp Ar grp Ar path
1.21 itojun 179: Change group of file
1.5 stevesk 180: .Ar path
181: to
1.1 djm 182: .Ar grp .
183: .Ar grp
1.5 stevesk 184: must be a numeric GID.
1.3 deraadt 185: .It Ic chmod Ar mode Ar path
1.21 itojun 186: Change permissions of file
1.5 stevesk 187: .Ar path
188: to
1.3 deraadt 189: .Ar mode .
190: .It Ic chown Ar own Ar path
1.21 itojun 191: Change owner of file
1.5 stevesk 192: .Ar path
193: to
1.1 djm 194: .Ar own .
195: .Ar own
196: must be a numeric UID.
1.11 deraadt 197: .It Ic exit
198: Quit sftp.
1.7 djm 199: .It Xo Ic get
200: .Op Ar flags
201: .Ar remote-path
202: .Op Ar local-path
203: .Xc
1.1 djm 204: Retrieve the
1.5 stevesk 205: .Ar remote-path
1.1 djm 206: and store it on the local machine.
207: If the local
1.21 itojun 208: path name is not specified, it is given the same name it has on the
209: remote machine. If the
1.7 djm 210: .Fl P
211: flag is specified, then the file's full permission and access time are
212: copied too.
1.11 deraadt 213: .It Ic help
214: Display help text.
1.3 deraadt 215: .It Ic lls Op Ar ls-options Op Ar path
1.21 itojun 216: Display local directory listing of either
1.1 djm 217: .Ar path
218: or current directory if
219: .Ar path
1.5 stevesk 220: is not specified.
1.3 deraadt 221: .It Ic lmkdir Ar path
1.1 djm 222: Create local directory specified by
1.3 deraadt 223: .Ar path .
1.12 djm 224: .It Ic ln Ar oldpath Ar newpath
1.21 itojun 225: Create a symbolic link from
1.12 djm 226: .Ar oldpath
227: to
228: .Ar newpath .
1.3 deraadt 229: .It Ic lpwd
230: Print local working directory.
1.36 djm 231: .It Xo Ic ls
232: .Op Ar flags
233: .Op Ar path
234: .Xc
1.1 djm 235: Display remote directory listing of either
236: .Ar path
1.5 stevesk 237: or current directory if
238: .Ar path
1.36 djm 239: is not specified. If the
240: .Fl l
241: flag is specified, then display additional details including permissions
242: and ownership information.
1.3 deraadt 243: .It Ic lumask Ar umask
1.21 itojun 244: Set local umask to
1.3 deraadt 245: .Ar umask .
246: .It Ic mkdir Ar path
1.1 djm 247: Create remote directory specified by
1.3 deraadt 248: .Ar path .
1.40 fgsch 249: .It Ic progress
250: Toggle display of progress meter.
1.7 djm 251: .It Xo Ic put
252: .Op Ar flags
253: .Ar local-path
1.37 djm 254: .Op Ar remote-path
1.7 djm 255: .Xc
1.1 djm 256: Upload
1.5 stevesk 257: .Ar local-path
1.21 itojun 258: and store it on the remote machine. If the remote path name is not
259: specified, it is given the same name it has on the local machine. If the
1.7 djm 260: .Fl P
261: flag is specified, then the file's full permission and access time are
262: copied too.
1.3 deraadt 263: .It Ic pwd
264: Display remote working directory.
265: .It Ic quit
266: Quit sftp.
267: .It Ic rename Ar oldpath Ar newpath
1.1 djm 268: Rename remote file from
269: .Ar oldpath
270: to
1.3 deraadt 271: .Ar newpath .
272: .It Ic rmdir Ar path
1.1 djm 273: Remove remote directory specified by
1.3 deraadt 274: .Ar path .
275: .It Ic rm Ar path
1.1 djm 276: Delete remote file specified by
1.3 deraadt 277: .Ar path .
1.12 djm 278: .It Ic symlink Ar oldpath Ar newpath
1.21 itojun 279: Create a symbolic link from
1.12 djm 280: .Ar oldpath
281: to
282: .Ar newpath .
1.38 fgsch 283: .It Ic version
284: Display the
285: .Nm
286: protocol version.
1.1 djm 287: .It Ic ! Ar command
1.21 itojun 288: Execute
1.1 djm 289: .Ar command
1.3 deraadt 290: in local shell.
1.1 djm 291: .It Ic !
1.3 deraadt 292: Escape to local shell.
293: .It Ic ?
1.5 stevesk 294: Synonym for help.
1.4 itojun 295: .El
1.1 djm 296: .Sh SEE ALSO
1.17 markus 297: .Xr scp 1 ,
1.1 djm 298: .Xr ssh 1 ,
299: .Xr ssh-add 1 ,
300: .Xr ssh-keygen 1 ,
1.35 stevesk 301: .Xr ssh_config 5 ,
1.17 markus 302: .Xr sftp-server 8 ,
303: .Xr sshd 8
304: .Rs
1.20 deraadt 305: .%A T. Ylonen
306: .%A S. Lehtinen
1.17 markus 307: .%T "SSH File Transfer Protocol"
308: .%N draft-ietf-secsh-filexfer-00.txt
309: .%D January 2001
310: .%O work in progress material
311: .Re
![[BACK]](/icons/back.gif){kind=icon}
Return to sftp.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh