Annotation of src/usr.bin/ssh/sftp.1, Revision 1.1
1.1 ! djm 1: .\" $OpenBSD$
! 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
! 33: .Op Fl v Li | Fl C
! 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
! 47: .Ar hostname
! 48: then enters an interactive command mode.
! 49: .Pp
! 50: The options are as follows:
! 51: .Bl -tag -width Ds
! 52: .It Fl C
! 53: Enables compression (via ssh's
! 54: .Fl C
! 55: flag)
! 56: .It Fl v
! 57: Raise logging level. This option is also passed to ssh.
! 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
! 63: Once in interactive mode
! 64: .Nm ,
! 65: understands a set of commands similar to those of
! 66: .Xr ftp 1 .
! 67: Commands are case insensitive.
! 68: .Bl -tag -width Ds
! 69: .It Ic CD Ar path
! 70: Change remote directory to
! 71: .Ar path
! 72: .It Ic LCD Ar path
! 73: Change local directory to
! 74: .Ar path
! 75: .It Ic CHGRP Ar grp Ar path
! 76: Change group of file
! 77: .Ar path to
! 78: .Ar grp .
! 79: .Ar grp
! 80: must be numeric.
! 81: .It Ic CHMOD Ar mode Ar path
! 82: Change permissions of file
! 83: .Ar path to
! 84: .Ar mode
! 85: .It Ic CHOWN Ar own Ar path
! 86: Change owner of file
! 87: .Ar path to
! 88: .Ar own .
! 89: .Ar own
! 90: must be a numeric UID.
! 91: .It Ic HELP
! 92: Display help text
! 93: .It Ic GET Ar remote-file Op Ar local-file
! 94: Retrieve the
! 95: .Ar remote-file
! 96: and store it on the local machine.
! 97: If the local
! 98: file name is not specified, it is given the same name it has on the
! 99: remote machine.
! 100: .It Ic LLS Op Ar ls-options Op Ar path
! 101: Display local directory listing of either
! 102: .Ar path
! 103: or current directory if
! 104: .Ar path
! 105: was not specified.
! 106: .It Ic LMKDIR Ar path
! 107: Create local directory specified by
! 108: .Ar path
! 109: .It Ic LPWD
! 110: Print local working directory
! 111: .It Ic LS Op Ar path
! 112: Display remote directory listing of either
! 113: .Ar path
! 114: or current directory, is
! 115: .Ar path not specified.
! 116: .It Ic LUMASK Ar umask
! 117: Set local umask to
! 118: .Ar umask
! 119: .It Ic MKDIR Ar path
! 120: Create remote directory specified by
! 121: .Ar path
! 122: .It Ic PUT local-file Op Ar remote-file
! 123: Upload
! 124: .Ar local-file
! 125: and store it on the remote machine. If the local file name is not specified,
! 126: it is given the same name it has on the local machine.
! 127: .It Ic PWD
! 128: Display remote working directory
! 129: .It Ic EXIT
! 130: Quit sftp
! 131: .It Ic QUIT
! 132: Quit sftp
! 133: .It Ic RENAME Ar oldpath Ar newpath
! 134: Rename remote file from
! 135: .Ar oldpath
! 136: to
! 137: .Ar newpath
! 138: .It Ic RMDIR Ar path
! 139: Remove remote directory specified by
! 140: .Ar path
! 141: .It Ic RM Ar path
! 142: Delete remote file specified by
! 143: .Ar path
! 144: .It Ic ! Ar command
! 145: Execute
! 146: .Ar command
! 147: in local shell
! 148: .It Ic !
! 149: Escape to local shell
! 150: .Sh AUTHORS
! 151: Damien Miller <djm@mindrot.org>
! 152: .Sh SEE ALSO
! 153: .Xr ssh 1 ,
! 154: .Xr ssh-add 1 ,
! 155: .Xr ssh-keygen 1 ,
! 156: .Xr sshd 8
![[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