Annotation of src/usr.bin/ssh/sftp.1, Revision 1.13.2.1
1.13.2.1! jason 1: .\" $OpenBSD: sftp.1,v 1.8 2001/02/17 15:24:40 reinhard Exp $
1.1 djm 2: .\"
1.13.2.1! jason 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: .\"
25: .Dd Febuary 4, 2001
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.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.13.2.1! jason 52: .It Fl v
! 53: Raise logging level. This option is also passed to ssh.
1.11 deraadt 54: .It Fl C
55: Enables compression (via ssh's
56: .Fl C
57: flag)
1.1 djm 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.13.2.1! jason 95: .It Ic help
! 96: Display help text.
1.7 djm 97: .It Xo Ic get
98: .Op Ar flags
99: .Ar remote-path
100: .Op Ar local-path
101: .Xc
1.1 djm 102: Retrieve the
1.5 stevesk 103: .Ar remote-path
1.1 djm 104: and store it on the local machine.
105: If the local
1.5 stevesk 106: path name is not specified, it is given the same name it has on the
1.7 djm 107: remote machine. If the
108: .Fl P
109: flag is specified, then the file's full permission and access time are
110: copied too.
1.3 deraadt 111: .It Ic lls Op Ar ls-options Op Ar path
1.1 djm 112: Display local directory listing of either
113: .Ar path
114: or current directory if
115: .Ar path
1.5 stevesk 116: is not specified.
1.3 deraadt 117: .It Ic lmkdir Ar path
1.1 djm 118: Create local directory specified by
1.3 deraadt 119: .Ar path .
120: .It Ic lpwd
121: Print local working directory.
122: .It Ic ls Op Ar path
1.1 djm 123: Display remote directory listing of either
124: .Ar path
1.5 stevesk 125: or current directory if
126: .Ar path
127: is not specified.
1.3 deraadt 128: .It Ic lumask Ar umask
1.1 djm 129: Set local umask to
1.3 deraadt 130: .Ar umask .
131: .It Ic mkdir Ar path
1.1 djm 132: Create remote directory specified by
1.3 deraadt 133: .Ar path .
1.7 djm 134: .It Xo Ic put
135: .Op Ar flags
136: .Ar local-path
137: .Op Ar local-path
138: .Xc
1.1 djm 139: Upload
1.5 stevesk 140: .Ar local-path
1.13.2.1! jason 141: and store it on the remote machine. If the remote path name is not specified,
! 142: it is given the same name it has on the local machine. If the
1.7 djm 143: .Fl P
144: flag is specified, then the file's full permission and access time are
145: copied too.
1.3 deraadt 146: .It Ic pwd
147: Display remote working directory.
1.13.2.1! jason 148: .It Ic exit
! 149: Quit sftp.
1.3 deraadt 150: .It Ic quit
151: Quit sftp.
152: .It Ic rename Ar oldpath Ar newpath
1.1 djm 153: Rename remote file from
154: .Ar oldpath
155: to
1.3 deraadt 156: .Ar newpath .
157: .It Ic rmdir Ar path
1.1 djm 158: Remove remote directory specified by
1.3 deraadt 159: .Ar path .
160: .It Ic rm Ar path
1.1 djm 161: Delete remote file specified by
1.3 deraadt 162: .Ar path .
1.1 djm 163: .It Ic ! Ar command
164: Execute
165: .Ar command
1.3 deraadt 166: in local shell.
1.1 djm 167: .It Ic !
1.3 deraadt 168: Escape to local shell.
169: .It Ic ?
1.5 stevesk 170: Synonym for help.
1.4 itojun 171: .El
1.1 djm 172: .Sh AUTHORS
173: Damien Miller <djm@mindrot.org>
174: .Sh SEE ALSO
175: .Xr ssh 1 ,
176: .Xr ssh-add 1 ,
177: .Xr ssh-keygen 1 ,
1.3 deraadt 178: .Xr sshd 8 ,
179: .Xr scp 1
180:
![[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