Annotation of src/usr.bin/ssh/sftp.1, Revision 1.52
1.52 ! markus 1: .\" $OpenBSD: sftp.1,v 1.51 2004/01/13 12:17:33 jmc 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.44 jmc 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.46 jmc 34: .Op Fl 1Cv
35: .Op Fl B Ar buffer_size
1.29 markus 36: .Op Fl b Ar batchfile
1.46 jmc 37: .Op Fl F Ar ssh_config
1.29 markus 38: .Op Fl o Ar ssh_option
1.46 jmc 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
1.46 jmc 42: .Op Fl s Ar subsystem | sftp_server
1.26 stevesk 43: .Ar host
1.41 jmc 44: .Ek
1.43 jmc 45: .Nm sftp
1.45 jmc 46: .Oo Oo Ar user Ns @ Oc Ns
1.41 jmc 47: .Ar host Ns Oo : Ns Ar file Oo
48: .Ar file Oc Oc Oc
1.43 jmc 49: .Nm sftp
1.45 jmc 50: .Oo Oo Ar user Ns @ Oc Ns
1.41 jmc 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
1.45 jmc 55: .Oo Ar user Ns @ Oc Ns Ar host
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.44 jmc 76: The final usage format allows for automated sessions using the
1.42 djm 77: .Fl b
1.44 jmc 78: option.
79: In such cases, it is usually necessary to configure public key authentication
80: to obviate the need to enter a password at connection time (see
1.42 djm 81: .Xr sshd 8
1.43 jmc 82: and
1.42 djm 83: .Xr ssh-keygen 1
1.44 jmc 84: for details).
1.1 djm 85: The options are as follows:
86: .Bl -tag -width Ds
1.46 jmc 87: .It Fl 1
88: Specify the use of protocol version 1.
89: .It Fl B Ar buffer_size
90: Specify the size of the buffer that
91: .Nm
92: uses when transferring files.
93: Larger buffers require fewer round trips at the cost of higher
94: memory consumption.
95: The default is 32768 bytes.
1.10 deraadt 96: .It Fl b Ar batchfile
97: Batch mode reads a series of commands from an input
1.13 stevesk 98: .Ar batchfile
1.10 deraadt 99: instead of
1.13 stevesk 100: .Em stdin .
101: Since it lacks user interaction it should be used in conjunction with
1.51 jmc 102: non-interactive authentication.
1.50 djm 103: A
1.51 jmc 104: .Ar batchfile
105: of
106: .Sq \-
1.50 djm 107: may be used to indicate standard input.
1.13 stevesk 108: .Nm
1.21 itojun 109: will abort if any of the following
110: commands fail:
1.33 deraadt 111: .Ic get , put , rename , ln ,
1.41 jmc 112: .Ic rm , mkdir , chdir , ls ,
1.39 djm 113: .Ic lchdir , chmod , chown , chgrp , lpwd
1.10 deraadt 114: and
1.13 stevesk 115: .Ic lmkdir .
1.41 jmc 116: Termination on error can be suppressed on a command by command basis by
117: prefixing the command with a
1.51 jmc 118: .Sq \-
1.44 jmc 119: character (for example,
120: .Ic -rm /tmp/blah* ) .
1.46 jmc 121: .It Fl C
122: Enables compression (via ssh's
123: .Fl C
124: flag).
125: .It Fl F Ar ssh_config
126: Specifies an alternative
127: per-user configuration file for
128: .Xr ssh 1 .
129: This option is directly passed to
130: .Xr ssh 1 .
1.1 djm 131: .It Fl o Ar ssh_option
1.23 stevesk 132: Can be used to pass options to
133: .Nm ssh
1.35 stevesk 134: in the format used in
135: .Xr ssh_config 5 .
136: This is useful for specifying options
1.23 stevesk 137: for which there is no separate
138: .Nm sftp
1.44 jmc 139: command-line flag.
140: For example, to specify an alternate port use:
1.26 stevesk 141: .Ic sftp -oPort=24 .
1.46 jmc 142: For full details of the options listed below, and their possible values, see
143: .Xr ssh_config 5 .
144: .Pp
145: .Bl -tag -width Ds -offset indent -compact
146: .It AddressFamily
147: .It BatchMode
148: .It BindAddress
149: .It ChallengeResponseAuthentication
150: .It CheckHostIP
151: .It Cipher
152: .It Ciphers
153: .It Compression
154: .It CompressionLevel
155: .It ConnectionAttempts
156: .It ConnectionTimeout
157: .It GlobalKnownHostsFile
158: .It GSSAPIAuthentication
159: .It GSSAPIDelegateCredentials
160: .It Host
161: .It HostbasedAuthentication
162: .It HostKeyAlgorithms
163: .It HostKeyAlias
164: .It HostName
165: .It IdentityFile
1.52 ! markus 166: .It IdentitiesOnly
1.46 jmc 167: .It LogLevel
168: .It MACs
169: .It NoHostAuthenticationForLocalhost
170: .It NumberOfPasswordPrompts
171: .It PasswordAuthentication
172: .It Port
173: .It PreferredAuthentications
174: .It Protocol
175: .It ProxyCommand
176: .It PubkeyAuthentication
177: .It RhostsRSAAuthentication
178: .It RSAAuthentication
1.49 markus 179: .It ServerAliveInterval
180: .It ServerAliveCountMax
1.46 jmc 181: .It SmartcardDevice
182: .It StrictHostKeyChecking
1.48 markus 183: .It TCPKeepAlive
1.46 jmc 184: .It UsePrivilegedPort
185: .It User
186: .It UserKnownHostsFile
187: .It VerifyHostKeyDNS
188: .El
189: .It Fl P Ar sftp_server_path
1.44 jmc 190: Connect directly to a local sftp server
1.29 markus 191: (rather than via
1.44 jmc 192: .Xr ssh 1 )
1.29 markus 193: This option may be useful in debugging the client and server.
1.30 djm 194: .It Fl R Ar num_requests
1.44 jmc 195: Specify how many requests may be outstanding at any one time.
196: Increasing this may slightly improve file transfer speed
197: but will increase memory usage.
198: The default is 16 outstanding requests.
1.26 stevesk 199: .It Fl S Ar program
200: Name of the
201: .Ar program
202: to use for the encrypted connection.
203: The program must understand
204: .Xr ssh 1
205: options.
1.46 jmc 206: .It Fl s Ar subsystem | sftp_server
207: Specifies the SSH2 subsystem or the path for an sftp server
208: on the remote host.
209: A path is useful for using
210: .Nm
211: over protocol version 1, or when the remote
212: .Xr sshd 8
213: does not have an sftp subsystem configured.
214: .It Fl v
215: Raise logging level.
216: This option is also passed to ssh.
1.1 djm 217: .El
218: .Sh INTERACTIVE COMMANDS
1.2 djm 219: Once in interactive mode,
220: .Nm
1.21 itojun 221: understands a set of commands similar to those of
1.1 djm 222: .Xr ftp 1 .
1.6 djm 223: Commands are case insensitive and pathnames may be enclosed in quotes if they
224: contain spaces.
1.46 jmc 225: .Bl -tag -width "lmdir path"
1.22 markus 226: .It Ic bye
1.44 jmc 227: Quit
228: .Nm sftp .
1.3 deraadt 229: .It Ic cd Ar path
1.21 itojun 230: Change remote directory to
1.3 deraadt 231: .Ar path .
232: .It Ic chgrp Ar grp Ar path
1.21 itojun 233: Change group of file
1.5 stevesk 234: .Ar path
235: to
1.1 djm 236: .Ar grp .
237: .Ar grp
1.5 stevesk 238: must be a numeric GID.
1.3 deraadt 239: .It Ic chmod Ar mode Ar path
1.21 itojun 240: Change permissions of file
1.5 stevesk 241: .Ar path
242: to
1.3 deraadt 243: .Ar mode .
244: .It Ic chown Ar own Ar path
1.21 itojun 245: Change owner of file
1.5 stevesk 246: .Ar path
247: to
1.1 djm 248: .Ar own .
249: .Ar own
250: must be a numeric UID.
1.11 deraadt 251: .It Ic exit
1.44 jmc 252: Quit
253: .Nm sftp .
1.7 djm 254: .It Xo Ic get
255: .Op Ar flags
256: .Ar remote-path
257: .Op Ar local-path
258: .Xc
1.1 djm 259: Retrieve the
1.5 stevesk 260: .Ar remote-path
1.1 djm 261: and store it on the local machine.
262: If the local
1.21 itojun 263: path name is not specified, it is given the same name it has on the
1.44 jmc 264: remote machine.
265: If the
1.7 djm 266: .Fl P
267: flag is specified, then the file's full permission and access time are
268: copied too.
1.11 deraadt 269: .It Ic help
270: Display help text.
1.46 jmc 271: .It Ic lcd Ar path
272: Change local directory to
273: .Ar path .
1.3 deraadt 274: .It Ic lls Op Ar ls-options Op Ar path
1.21 itojun 275: Display local directory listing of either
1.1 djm 276: .Ar path
277: or current directory if
278: .Ar path
1.5 stevesk 279: is not specified.
1.3 deraadt 280: .It Ic lmkdir Ar path
1.1 djm 281: Create local directory specified by
1.3 deraadt 282: .Ar path .
1.12 djm 283: .It Ic ln Ar oldpath Ar newpath
1.21 itojun 284: Create a symbolic link from
1.12 djm 285: .Ar oldpath
286: to
287: .Ar newpath .
1.3 deraadt 288: .It Ic lpwd
289: Print local working directory.
1.36 djm 290: .It Xo Ic ls
291: .Op Ar flags
292: .Op Ar path
293: .Xc
1.1 djm 294: Display remote directory listing of either
295: .Ar path
1.5 stevesk 296: or current directory if
297: .Ar path
1.44 jmc 298: is not specified.
299: If the
1.36 djm 300: .Fl l
301: flag is specified, then display additional details including permissions
302: and ownership information.
1.3 deraadt 303: .It Ic lumask Ar umask
1.21 itojun 304: Set local umask to
1.3 deraadt 305: .Ar umask .
306: .It Ic mkdir Ar path
1.1 djm 307: Create remote directory specified by
1.3 deraadt 308: .Ar path .
1.40 fgsch 309: .It Ic progress
310: Toggle display of progress meter.
1.7 djm 311: .It Xo Ic put
312: .Op Ar flags
313: .Ar local-path
1.37 djm 314: .Op Ar remote-path
1.7 djm 315: .Xc
1.1 djm 316: Upload
1.5 stevesk 317: .Ar local-path
1.44 jmc 318: and store it on the remote machine.
319: If the remote path name is not specified, it is given the same name it has
320: on the local machine.
321: If the
1.7 djm 322: .Fl P
323: flag is specified, then the file's full permission and access time are
324: copied too.
1.3 deraadt 325: .It Ic pwd
326: Display remote working directory.
327: .It Ic quit
1.44 jmc 328: Quit
329: .Nm sftp .
1.3 deraadt 330: .It Ic rename Ar oldpath Ar newpath
1.1 djm 331: Rename remote file from
332: .Ar oldpath
333: to
1.3 deraadt 334: .Ar newpath .
1.46 jmc 335: .It Ic rm Ar path
336: Delete remote file specified by
337: .Ar path .
1.3 deraadt 338: .It Ic rmdir Ar path
1.1 djm 339: Remove remote directory specified by
1.3 deraadt 340: .Ar path .
1.12 djm 341: .It Ic symlink Ar oldpath Ar newpath
1.21 itojun 342: Create a symbolic link from
1.12 djm 343: .Ar oldpath
344: to
345: .Ar newpath .
1.38 fgsch 346: .It Ic version
347: Display the
348: .Nm
349: protocol version.
1.45 jmc 350: .It Ic \&! Ar command
1.21 itojun 351: Execute
1.1 djm 352: .Ar command
1.3 deraadt 353: in local shell.
1.45 jmc 354: .It Ic \&!
1.3 deraadt 355: Escape to local shell.
1.45 jmc 356: .It Ic \&?
1.5 stevesk 357: Synonym for help.
1.4 itojun 358: .El
1.1 djm 359: .Sh SEE ALSO
1.46 jmc 360: .Xr ftp 1 ,
1.17 markus 361: .Xr scp 1 ,
1.1 djm 362: .Xr ssh 1 ,
363: .Xr ssh-add 1 ,
364: .Xr ssh-keygen 1 ,
1.35 stevesk 365: .Xr ssh_config 5 ,
1.17 markus 366: .Xr sftp-server 8 ,
367: .Xr sshd 8
368: .Rs
1.20 deraadt 369: .%A T. Ylonen
370: .%A S. Lehtinen
1.17 markus 371: .%T "SSH File Transfer Protocol"
372: .%N draft-ietf-secsh-filexfer-00.txt
373: .%D January 2001
374: .%O work in progress material
375: .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