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