Annotation of src/usr.bin/ssh/sftp.1, Revision 1.6
1.6 ! djm 1: .\" $OpenBSD: sftp.1,v 1.5 2001/02/07 18:10:39 stevesk Exp $
1.1 djm 2: .\"
3: .\" Copyright (c) 2001 Damien Miller. All rights reserved.
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: .\"
25: .Dd Febuary 4, 2001
26: .Dt SFTP 1
27: .Os
28: .Sh NAME
29: .Nm sftp
30: .Nd Secure file tranfer program
31: .Sh SYNOPSIS
32: .Nm sftp
1.3 deraadt 33: .Op Fl vC
1.1 djm 34: .Op Fl o Ar ssh_option
35: .Op Ar hostname | user@hostname
36: .Sh DESCRIPTION
37: .Nm
38: is an interactive file transfer program, similar to
39: .Xr ftp 1 ,
40: which performs all operations over an encrypted
41: .Xr ssh 1
42: transport.
43: It may also use many features of ssh, such as public key authentication and
44: compression.
45: .Nm
46: connects and logs into the specified
1.5 stevesk 47: .Ar hostname ,
1.1 djm 48: then enters an interactive command mode.
49: .Pp
50: The options are as follows:
51: .Bl -tag -width Ds
1.5 stevesk 52: .It Fl v
53: Raise logging level. This option is also passed to ssh.
1.1 djm 54: .It Fl C
55: Enables compression (via ssh's
56: .Fl C
57: flag)
58: .It Fl o Ar ssh_option
59: Specify an option to be directly passed to
60: .Xr ssh 1 .
61: .El
62: .Sh INTERACTIVE COMMANDS
1.2 djm 63: Once in interactive mode,
64: .Nm
1.1 djm 65: understands a set of commands similar to those of
66: .Xr ftp 1 .
1.6 ! djm 67: Commands are case insensitive and pathnames may be enclosed in quotes if they
! 68: contain spaces.
1.1 djm 69: .Bl -tag -width Ds
1.3 deraadt 70: .It Ic cd Ar path
1.1 djm 71: Change remote directory to
1.3 deraadt 72: .Ar path .
73: .It Ic lcd Ar path
1.1 djm 74: Change local directory to
1.3 deraadt 75: .Ar path .
76: .It Ic chgrp Ar grp Ar path
1.1 djm 77: Change group of file
1.5 stevesk 78: .Ar path
79: to
1.1 djm 80: .Ar grp .
81: .Ar grp
1.5 stevesk 82: must be a numeric GID.
1.3 deraadt 83: .It Ic chmod Ar mode Ar path
1.1 djm 84: Change permissions of file
1.5 stevesk 85: .Ar path
86: to
1.3 deraadt 87: .Ar mode .
88: .It Ic chown Ar own Ar path
1.1 djm 89: Change owner of file
1.5 stevesk 90: .Ar path
91: to
1.1 djm 92: .Ar own .
93: .Ar own
94: must be a numeric UID.
1.3 deraadt 95: .It Ic help
96: Display help text.
1.5 stevesk 97: .It Ic get Ar remote-path Op Ar local-path
1.1 djm 98: Retrieve the
1.5 stevesk 99: .Ar remote-path
1.1 djm 100: and store it on the local machine.
101: If the local
1.5 stevesk 102: path name is not specified, it is given the same name it has on the
1.1 djm 103: remote machine.
1.3 deraadt 104: .It Ic lls Op Ar ls-options Op Ar path
1.1 djm 105: Display local directory listing of either
106: .Ar path
107: or current directory if
108: .Ar path
1.5 stevesk 109: is not specified.
1.3 deraadt 110: .It Ic lmkdir Ar path
1.1 djm 111: Create local directory specified by
1.3 deraadt 112: .Ar path .
113: .It Ic lpwd
114: Print local working directory.
115: .It Ic ls Op Ar path
1.1 djm 116: Display remote directory listing of either
117: .Ar path
1.5 stevesk 118: or current directory if
119: .Ar path
120: is not specified.
1.3 deraadt 121: .It Ic lumask Ar umask
1.1 djm 122: Set local umask to
1.3 deraadt 123: .Ar umask .
124: .It Ic mkdir Ar path
1.1 djm 125: Create remote directory specified by
1.3 deraadt 126: .Ar path .
1.5 stevesk 127: .It Ic put Ar local-path Op Ar remote-path
1.1 djm 128: Upload
1.5 stevesk 129: .Ar local-path
130: and store it on the remote machine. If the remote path name is not specified,
1.1 djm 131: it is given the same name it has on the local machine.
1.3 deraadt 132: .It Ic pwd
133: Display remote working directory.
134: .It Ic exit
135: Quit sftp.
136: .It Ic quit
137: Quit sftp.
138: .It Ic rename Ar oldpath Ar newpath
1.1 djm 139: Rename remote file from
140: .Ar oldpath
141: to
1.3 deraadt 142: .Ar newpath .
143: .It Ic rmdir Ar path
1.1 djm 144: Remove remote directory specified by
1.3 deraadt 145: .Ar path .
146: .It Ic rm Ar path
1.1 djm 147: Delete remote file specified by
1.3 deraadt 148: .Ar path .
1.1 djm 149: .It Ic ! Ar command
150: Execute
151: .Ar command
1.3 deraadt 152: in local shell.
1.1 djm 153: .It Ic !
1.3 deraadt 154: Escape to local shell.
155: .It Ic ?
1.5 stevesk 156: Synonym for help.
1.4 itojun 157: .El
1.1 djm 158: .Sh AUTHORS
159: Damien Miller <djm@mindrot.org>
160: .Sh SEE ALSO
161: .Xr ssh 1 ,
162: .Xr ssh-add 1 ,
163: .Xr ssh-keygen 1 ,
1.3 deraadt 164: .Xr sshd 8 ,
165: .Xr scp 1
166:
![[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