unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (SunOS-5.10)
Page:
Section:
Apropos / Subsearch:
optional field

sftp(1)                          User Commands                         sftp(1)



NAME
       sftp - secure file transfer program

SYNOPSIS
       sftp [options] [user@]host[:dir[/]]

       sftp [options] [user@]host[:file1 [file1 [file | dir2]]

DESCRIPTION
       The  sftp  utility  is an interactive file transfer program with a user
       interface similar to ftp(1) that uses the ssh(1) command  to  create  a
       secure connection to the server.

       sftp  implements  the  SSH  File  Transfer  Protocol as defined in IETF
       draft-ietf-secsh-filexfer. There is no relationship between the  proto-
       col used by sftp and the FTP protocol (RFC959) provided by ftp(1).

       The  first  usage  format  causes sftp to connect to the given host and
       enter an interactive mode. If a username was provided then  sftp  tries
       to log in as the given user. If a directory is provided then sftp tries
       to change the current directory on the server to  the  given  directory
       before entering the interactive mode.

       The  second  usage  format retrieves the given file from the server and
       copies it to the given target file or directory on  the  client.  If  a
       username is given sftp tries to log in as the given user.

OPTIONS
       The following options are supported:

       -1

           Specifies the use of protocol version 1.



       -b batchfile

           Batch  mode  reads  a  series  of  commands from an input batchfile
           instead of stdin. Since it lacks user  interaction,  it  should  be
           used  in  conjunction  with  non-interactive  authentication.  sftp
           aborts if any of the following commands fail: get, rm, and lmkdir.



       -B buffer_size

           Specifies the size of the buffer that sftp uses  when  transferring
           files.  Larger  buffers  require  fewer  round trips at the cost of
           higher memory consumption. The default is 32768 bytes.



       -C

           Enables compression, using the -C flag in ssh(1).



       -F ssh_config

           Specifies an alternative per-user configuration file for ssh.  This
           option is directly passed to ssh(1).



       -o ssh_option

           Specifies an option to be directly passed to ssh(1).



       -P sftp_server path

           Executes  the  given path as an sftp-server and uses a pipe, rather
           than an ssh connection, to communicate with it. This option can  be
           useful  in  debugging  the  sftp  client  and server. The -P and -S
           options are mutually exclusive.



       -R num_requests

           Specifies how many requests can be outstanding  at  any  one  time.
           Increasing  this  can  slightly  improve  file  transfer  speed but
           increases memory usage. The default is 16 outstanding requests.



       -S ssh program path

           Uses the given program instead of ssh(1) to  connect  to  the  sftp
           server. The -P and -S options are mutually exclusive.



       -s subsystem | sftp_server

           Specifies  the SSH2 subsystem or the path for an sftp server on the
           remote host. A path is useful for using sftp over protocol  version
           1,  or when the remote sshd does not have an sftp subsystem config-
           ured.



       -v

           Raises logging level. This option is also passed to ssh(1).



OPERANDS
       The following operands are supported:

       hostname | user@hostname

           The name of the host to which sftp connects and logs into.



INTERACTIVE COMMANDS
       Once in interactive mode, sftp understands a set of commands similar to
       those  of  ftp(1).  Commands  are case insensitive and pathnames can be
       enclosed in quotes if they contain spaces.

       bye

           Quits sftp.



       cd path

           Changes remote directory to path.



       lcd path

           Changes local directory to path.



       chgrp grp path

           Changes group of file path to grp. grp must be a numeric GID.



       chmod mode path

           Changes permissions of file path to mode.



       chown own path

           Changes owner of file path to own. own must be a numeric UID.



       help

           Displays help text.



       get [flags] remote-path [local-path]

           Retrieves the remote-path and stores it on the  local  machine.  If
           the  local path name is not specified, it is given the same name it
           has on the remote machine. If the -P flag is  specified,  then  the
           file's full permission and access time are copied too.



       lls [ls-options [path]]

           Displays  local  directory listing of either path or current direc-
           tory if path is not specified.



       lmkdir path

           Creates local directory specified by path.



       ln oldpath newpath

           Creates a link from oldpath to newpath.



       lpwd

           Prints local working directory.



       ls [flags] [path]

           Displays remote directory listing of either path or current  direc-
           tory if path is not specified.



       lumask umask

           Sets local umask to umask.



       mkdir path

           Creates remote directory specified by path.



       put [flags] local-path [local-path]

           Uploads  local-path  and  stores  it  on the remote machine. If the
           remote path name is not specified, it is given the same name it has
           on  the local machine. If the -P flag is specified, then the file's
           full permission and access time are copied too.



       pwd

           Displays remote working directory.



       exit

           Quits sftp.



       quit

           Quits sftp.



       rename oldpath newpath

           Renames remote file from oldpath to newpath.



       rmdir path

           Removes remote directory specified by path.



       rm path

           Deletes remote file specified by path.



       symlink oldpath newpath

           Creates a symbolic link from oldpath to newpath.



       ! command

           Executes command in local shell.



       !

           Escapes to local shell.



       ?

           Synonym for help.



EXIT STATUS
       The following exit values are returned:

       0        Successful completion.



       1        An error occurred.



ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:


       tab()    allbox;    cw(2.750000i)|     cw(2.750000i)     lw(2.750000i)|
       lw(2.750000i).    ATTRIBUTE  TYPEATTRIBUTE  VALUE  AvailabilitySUNWsshu
       Interface StabilityEvolving


SEE ALSO
       ftp(1),   scp(1),   ssh(1),   ssh-add(1),   ssh-keygen(1),    sshd(1M),
       attributes(5)

       To  view  license  terms,  attribution,  and copyright for OpenSSH, the
       default  path  is  /var/sadm/pkg/SUNWsshdr/install/copyright.  If   the
       Solaris  operating  environment  has been installed anywhere other than
       the default, modify the given path to access the file at the  installed
       location.

AUTHOR
       Damien Miller



SunOS 5.10                        15 Sep 2004                          sftp(1)