Annotation of src/usr.bin/ssh/sftp.1, Revision 1.22
1.22 ! markus 1: .\" $OpenBSD: sftp.1,v 1.21 2001/06/23 17:48:18 itojun 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.3 deraadt 33: .Op Fl vC
1.10 deraadt 34: .Op Fl b Ar batchfile
1.1 djm 35: .Op Fl o Ar ssh_option
1.15 mouring 36: .Op Ar host
37: .Nm sftp
38: .Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]]
39: .Nm sftp
1.21 itojun 40: .Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]]
1.1 djm 41: .Sh DESCRIPTION
42: .Nm
43: is an interactive file transfer program, similar to
44: .Xr ftp 1 ,
45: which performs all operations over an encrypted
46: .Xr ssh 1
47: transport.
48: It may also use many features of ssh, such as public key authentication and
49: compression.
50: .Nm
51: connects and logs into the specified
1.18 stevesk 52: .Ar host ,
1.1 djm 53: then enters an interactive command mode.
1.15 mouring 54: .Pp
1.21 itojun 55: The second usage format will retrieve files automatically if a non-interactive
1.18 stevesk 56: authentication method is used; otherwise it will do so after
57: successful interactive authentication.
1.15 mouring 58: .Pp
59: The last usage format allows the sftp client to start in a remote directory.
1.1 djm 60: .Pp
61: The options are as follows:
62: .Bl -tag -width Ds
1.10 deraadt 63: .It Fl b Ar batchfile
64: Batch mode reads a series of commands from an input
1.13 stevesk 65: .Ar batchfile
1.10 deraadt 66: instead of
1.13 stevesk 67: .Em stdin .
68: Since it lacks user interaction it should be used in conjunction with
69: non-interactive authentication.
70: .Nm
1.21 itojun 71: will abort if any of the following
72: commands fail:
1.13 stevesk 73: .Ic get , put , rename , ln , rm , mkdir , chdir , lchdir
1.10 deraadt 74: and
1.13 stevesk 75: .Ic lmkdir .
1.11 deraadt 76: .It Fl C
1.21 itojun 77: Enables compression (via ssh's
1.11 deraadt 78: .Fl C
79: flag)
1.1 djm 80: .It Fl o Ar ssh_option
81: Specify an option to be directly passed to
82: .Xr ssh 1 .
1.11 deraadt 83: .It Fl v
84: Raise logging level. This option is also passed to ssh.
1.1 djm 85: .El
86: .Sh INTERACTIVE COMMANDS
1.2 djm 87: Once in interactive mode,
88: .Nm
1.21 itojun 89: understands a set of commands similar to those of
1.1 djm 90: .Xr ftp 1 .
1.6 djm 91: Commands are case insensitive and pathnames may be enclosed in quotes if they
92: contain spaces.
1.1 djm 93: .Bl -tag -width Ds
1.22 ! markus 94: .It Ic bye
! 95: Quit sftp.
1.3 deraadt 96: .It Ic cd Ar path
1.21 itojun 97: Change remote directory to
1.3 deraadt 98: .Ar path .
99: .It Ic lcd Ar path
1.21 itojun 100: Change local directory to
1.3 deraadt 101: .Ar path .
102: .It Ic chgrp Ar grp Ar path
1.21 itojun 103: Change group of file
1.5 stevesk 104: .Ar path
105: to
1.1 djm 106: .Ar grp .
107: .Ar grp
1.5 stevesk 108: must be a numeric GID.
1.3 deraadt 109: .It Ic chmod Ar mode Ar path
1.21 itojun 110: Change permissions of file
1.5 stevesk 111: .Ar path
112: to
1.3 deraadt 113: .Ar mode .
114: .It Ic chown Ar own Ar path
1.21 itojun 115: Change owner of file
1.5 stevesk 116: .Ar path
117: to
1.1 djm 118: .Ar own .
119: .Ar own
120: must be a numeric UID.
1.11 deraadt 121: .It Ic exit
122: Quit sftp.
1.7 djm 123: .It Xo Ic get
124: .Op Ar flags
125: .Ar remote-path
126: .Op Ar local-path
127: .Xc
1.1 djm 128: Retrieve the
1.5 stevesk 129: .Ar remote-path
1.1 djm 130: and store it on the local machine.
131: If the local
1.21 itojun 132: path name is not specified, it is given the same name it has on the
133: remote machine. If the
1.7 djm 134: .Fl P
135: flag is specified, then the file's full permission and access time are
136: copied too.
1.11 deraadt 137: .It Ic help
138: Display help text.
1.3 deraadt 139: .It Ic lls Op Ar ls-options Op Ar path
1.21 itojun 140: Display local directory listing of either
1.1 djm 141: .Ar path
142: or current directory if
143: .Ar path
1.5 stevesk 144: is not specified.
1.3 deraadt 145: .It Ic lmkdir Ar path
1.1 djm 146: Create local directory specified by
1.3 deraadt 147: .Ar path .
1.12 djm 148: .It Ic ln Ar oldpath Ar newpath
1.21 itojun 149: Create a symbolic link from
1.12 djm 150: .Ar oldpath
151: to
152: .Ar newpath .
1.3 deraadt 153: .It Ic lpwd
154: Print local working directory.
155: .It Ic ls Op Ar path
1.1 djm 156: Display remote directory listing of either
157: .Ar path
1.5 stevesk 158: or current directory if
159: .Ar path
160: is not specified.
1.3 deraadt 161: .It Ic lumask Ar umask
1.21 itojun 162: Set local umask to
1.3 deraadt 163: .Ar umask .
164: .It Ic mkdir Ar path
1.1 djm 165: Create remote directory specified by
1.3 deraadt 166: .Ar path .
1.7 djm 167: .It Xo Ic put
168: .Op Ar flags
169: .Ar local-path
170: .Op Ar local-path
171: .Xc
1.1 djm 172: Upload
1.5 stevesk 173: .Ar local-path
1.21 itojun 174: and store it on the remote machine. If the remote path name is not
175: specified, it is given the same name it has on the local machine. If the
1.7 djm 176: .Fl P
177: flag is specified, then the file's full permission and access time are
178: copied too.
1.3 deraadt 179: .It Ic pwd
180: Display remote working directory.
181: .It Ic quit
182: Quit sftp.
183: .It Ic rename Ar oldpath Ar newpath
1.1 djm 184: Rename remote file from
185: .Ar oldpath
186: to
1.3 deraadt 187: .Ar newpath .
188: .It Ic rmdir Ar path
1.1 djm 189: Remove remote directory specified by
1.3 deraadt 190: .Ar path .
191: .It Ic rm Ar path
1.1 djm 192: Delete remote file specified by
1.3 deraadt 193: .Ar path .
1.12 djm 194: .It Ic symlink Ar oldpath Ar newpath
1.21 itojun 195: Create a symbolic link from
1.12 djm 196: .Ar oldpath
197: to
198: .Ar newpath .
1.1 djm 199: .It Ic ! Ar command
1.21 itojun 200: Execute
1.1 djm 201: .Ar command
1.3 deraadt 202: in local shell.
1.1 djm 203: .It Ic !
1.3 deraadt 204: Escape to local shell.
205: .It Ic ?
1.5 stevesk 206: Synonym for help.
1.4 itojun 207: .El
1.1 djm 208: .Sh AUTHORS
209: Damien Miller <djm@mindrot.org>
210: .Sh SEE ALSO
1.17 markus 211: .Xr scp 1 ,
1.1 djm 212: .Xr ssh 1 ,
213: .Xr ssh-add 1 ,
214: .Xr ssh-keygen 1 ,
1.17 markus 215: .Xr sftp-server 8 ,
216: .Xr sshd 8
217: .Rs
1.20 deraadt 218: .%A T. Ylonen
219: .%A S. Lehtinen
1.17 markus 220: .%T "SSH File Transfer Protocol"
221: .%N draft-ietf-secsh-filexfer-00.txt
222: .%D January 2001
223: .%O work in progress material
224: .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