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