Annotation of src/usr.bin/ssh/sftp.1, Revision 1.39
1.39 ! djm 1: .\" $OpenBSD: sftp.1,v 1.38 2003/01/07 23:42:54 fgsch 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 ,
1.39 ! djm 80: .Ic rm , mkdir , chdir , ls ,
! 81: .Ic lchdir , chmod , chown , chgrp , lpwd
1.10 deraadt 82: and
1.13 stevesk 83: .Ic lmkdir .
1.39 ! djm 84: Termination on error can be suppressed on a command by command basis by
! 85: prefixing the command with a
! 86: .Ic '-'
! 87: character (For example,
! 88: .Ic -rm /tmp/blah*
! 89: ).
1.1 djm 90: .It Fl o Ar ssh_option
1.23 stevesk 91: Can be used to pass options to
92: .Nm ssh
1.35 stevesk 93: in the format used in
94: .Xr ssh_config 5 .
95: This is useful for specifying options
1.23 stevesk 96: for which there is no separate
97: .Nm sftp
1.26 stevesk 98: command-line flag. For example, to specify an alternate
99: port use:
100: .Ic sftp -oPort=24 .
101: .It Fl s Ar subsystem | sftp_server
102: Specifies the SSH2 subsystem or the path for an sftp server
103: on the remote host. A path is useful for using sftp over
104: protocol version 1, or when the remote
105: .Nm sshd
106: does not have an sftp subsystem configured.
1.29 markus 107: .It Fl v
108: Raise logging level. This option is also passed to ssh.
109: .It Fl B Ar buffer_size
1.34 deraadt 110: Specify the size of the buffer that
1.29 markus 111: .Nm
112: uses when transferring files. Larger buffers require fewer round trips at
113: the cost of higher memory consumption. The default is 32768 bytes.
114: .It Fl C
115: Enables compression (via ssh's
116: .Fl C
117: flag).
118: .It Fl F Ar ssh_config
119: Specifies an alternative
120: per-user configuration file for
121: .Nm ssh .
122: This option is directly passed to
123: .Xr ssh 1 .
124: .It Fl P Ar sftp_server path
1.34 deraadt 125: Connect directly to a local
126: .Nm sftp-server
1.29 markus 127: (rather than via
128: .Nm ssh )
129: This option may be useful in debugging the client and server.
1.30 djm 130: .It Fl R Ar num_requests
1.34 deraadt 131: Specify how many requests may be outstanding at any one time. Increasing
1.30 djm 132: this may slightly improve file transfer speed but will increase memory
133: usage. The default is 16 outstanding requests.
1.26 stevesk 134: .It Fl S Ar program
135: Name of the
136: .Ar program
137: to use for the encrypted connection.
138: The program must understand
139: .Xr ssh 1
140: options.
1.29 markus 141: .It Fl 1
142: Specify the use of protocol version 1.
1.1 djm 143: .El
144: .Sh INTERACTIVE COMMANDS
1.2 djm 145: Once in interactive mode,
146: .Nm
1.21 itojun 147: understands a set of commands similar to those of
1.1 djm 148: .Xr ftp 1 .
1.6 djm 149: Commands are case insensitive and pathnames may be enclosed in quotes if they
150: contain spaces.
1.1 djm 151: .Bl -tag -width Ds
1.22 markus 152: .It Ic bye
153: Quit sftp.
1.3 deraadt 154: .It Ic cd Ar path
1.21 itojun 155: Change remote directory to
1.3 deraadt 156: .Ar path .
157: .It Ic lcd Ar path
1.21 itojun 158: Change local directory to
1.3 deraadt 159: .Ar path .
160: .It Ic chgrp Ar grp Ar path
1.21 itojun 161: Change group of file
1.5 stevesk 162: .Ar path
163: to
1.1 djm 164: .Ar grp .
165: .Ar grp
1.5 stevesk 166: must be a numeric GID.
1.3 deraadt 167: .It Ic chmod Ar mode Ar path
1.21 itojun 168: Change permissions of file
1.5 stevesk 169: .Ar path
170: to
1.3 deraadt 171: .Ar mode .
172: .It Ic chown Ar own Ar path
1.21 itojun 173: Change owner of file
1.5 stevesk 174: .Ar path
175: to
1.1 djm 176: .Ar own .
177: .Ar own
178: must be a numeric UID.
1.11 deraadt 179: .It Ic exit
180: Quit sftp.
1.7 djm 181: .It Xo Ic get
182: .Op Ar flags
183: .Ar remote-path
184: .Op Ar local-path
185: .Xc
1.1 djm 186: Retrieve the
1.5 stevesk 187: .Ar remote-path
1.1 djm 188: and store it on the local machine.
189: If the local
1.21 itojun 190: path name is not specified, it is given the same name it has on the
191: remote machine. If the
1.7 djm 192: .Fl P
193: flag is specified, then the file's full permission and access time are
194: copied too.
1.11 deraadt 195: .It Ic help
196: Display help text.
1.3 deraadt 197: .It Ic lls Op Ar ls-options Op Ar path
1.21 itojun 198: Display local directory listing of either
1.1 djm 199: .Ar path
200: or current directory if
201: .Ar path
1.5 stevesk 202: is not specified.
1.3 deraadt 203: .It Ic lmkdir Ar path
1.1 djm 204: Create local directory specified by
1.3 deraadt 205: .Ar path .
1.12 djm 206: .It Ic ln Ar oldpath Ar newpath
1.21 itojun 207: Create a symbolic link from
1.12 djm 208: .Ar oldpath
209: to
210: .Ar newpath .
1.3 deraadt 211: .It Ic lpwd
212: Print local working directory.
1.36 djm 213: .It Xo Ic ls
214: .Op Ar flags
215: .Op Ar path
216: .Xc
1.1 djm 217: Display remote directory listing of either
218: .Ar path
1.5 stevesk 219: or current directory if
220: .Ar path
1.36 djm 221: is not specified. If the
222: .Fl l
223: flag is specified, then display additional details including permissions
224: and ownership information.
1.3 deraadt 225: .It Ic lumask Ar umask
1.21 itojun 226: Set local umask to
1.3 deraadt 227: .Ar umask .
228: .It Ic mkdir Ar path
1.1 djm 229: Create remote directory specified by
1.3 deraadt 230: .Ar path .
1.7 djm 231: .It Xo Ic put
232: .Op Ar flags
233: .Ar local-path
1.37 djm 234: .Op Ar remote-path
1.7 djm 235: .Xc
1.1 djm 236: Upload
1.5 stevesk 237: .Ar local-path
1.21 itojun 238: and store it on the remote machine. If the remote path name is not
239: specified, it is given the same name it has on the local machine. If the
1.7 djm 240: .Fl P
241: flag is specified, then the file's full permission and access time are
242: copied too.
1.3 deraadt 243: .It Ic pwd
244: Display remote working directory.
245: .It Ic quit
246: Quit sftp.
247: .It Ic rename Ar oldpath Ar newpath
1.1 djm 248: Rename remote file from
249: .Ar oldpath
250: to
1.3 deraadt 251: .Ar newpath .
252: .It Ic rmdir Ar path
1.1 djm 253: Remove remote directory specified by
1.3 deraadt 254: .Ar path .
255: .It Ic rm Ar path
1.1 djm 256: Delete remote file specified by
1.3 deraadt 257: .Ar path .
1.12 djm 258: .It Ic symlink Ar oldpath Ar newpath
1.21 itojun 259: Create a symbolic link from
1.12 djm 260: .Ar oldpath
261: to
262: .Ar newpath .
1.38 fgsch 263: .It Ic version
264: Display the
265: .Nm
266: protocol version.
1.1 djm 267: .It Ic ! Ar command
1.21 itojun 268: Execute
1.1 djm 269: .Ar command
1.3 deraadt 270: in local shell.
1.1 djm 271: .It Ic !
1.3 deraadt 272: Escape to local shell.
273: .It Ic ?
1.5 stevesk 274: Synonym for help.
1.4 itojun 275: .El
1.1 djm 276: .Sh AUTHORS
277: Damien Miller <djm@mindrot.org>
278: .Sh SEE ALSO
1.17 markus 279: .Xr scp 1 ,
1.1 djm 280: .Xr ssh 1 ,
281: .Xr ssh-add 1 ,
282: .Xr ssh-keygen 1 ,
1.35 stevesk 283: .Xr ssh_config 5 ,
1.17 markus 284: .Xr sftp-server 8 ,
285: .Xr sshd 8
286: .Rs
1.20 deraadt 287: .%A T. Ylonen
288: .%A S. Lehtinen
1.17 markus 289: .%T "SSH File Transfer Protocol"
290: .%N draft-ietf-secsh-filexfer-00.txt
291: .%D January 2001
292: .%O work in progress material
293: .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