| sftp.1 (113908) | sftp.1 (124208) |
|---|---|
| 1.\" $OpenBSD: sftp.1,v 1.41 2003/03/28 10:11:43 jmc Exp $ | 1.\" $OpenBSD: sftp.1,v 1.45 2003/09/02 18:50:06 jmc Exp $ |
| 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. --- 12 unchanged lines hidden (view full) --- 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 February 4, 2001 26.Dt SFTP 1 27.Os 28.Sh NAME 29.Nm sftp | 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. --- 12 unchanged lines hidden (view full) --- 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 February 4, 2001 26.Dt SFTP 1 27.Os 28.Sh NAME 29.Nm sftp |
| 30.Nd Secure file transfer program | 30.Nd secure file transfer program |
| 31.Sh SYNOPSIS 32.Nm sftp 33.Bk -words 34.Op Fl vC1 35.Op Fl b Ar batchfile 36.Op Fl o Ar ssh_option 37.Op Fl s Ar subsystem | sftp_server 38.Op Fl B Ar buffer_size 39.Op Fl F Ar ssh_config 40.Op Fl P Ar sftp_server path 41.Op Fl R Ar num_requests 42.Op Fl S Ar program 43.Ar host 44.Ek 45.Nm sftp | 31.Sh SYNOPSIS 32.Nm sftp 33.Bk -words 34.Op Fl vC1 35.Op Fl b Ar batchfile 36.Op Fl o Ar ssh_option 37.Op Fl s Ar subsystem | sftp_server 38.Op Fl B Ar buffer_size 39.Op Fl F Ar ssh_config 40.Op Fl P Ar sftp_server path 41.Op Fl R Ar num_requests 42.Op Fl S Ar program 43.Ar host 44.Ek 45.Nm sftp |
| 46.Oo Oo Ar user Ns No @ Oc Ns | 46.Oo Oo Ar user Ns @ Oc Ns |
| 47.Ar host Ns Oo : Ns Ar file Oo 48.Ar file Oc Oc Oc 49.Nm sftp | 47.Ar host Ns Oo : Ns Ar file Oo 48.Ar file Oc Oc Oc 49.Nm sftp |
| 50.Oo Oo Ar user Ns No @ Oc Ns | 50.Oo Oo Ar user Ns @ Oc Ns |
| 51.Ar host Ns Oo : Ns Ar dir Ns 52.Oo Ar / Oc Oc Oc | 51.Ar host Ns Oo : Ns Ar dir Ns 52.Oo Ar / Oc Oc Oc |
| 53.Nm sftp 54.Fl b Ar batchfile 55.Oo Ar user Ns @ Oc Ns Ar host |
|
| 53.Sh DESCRIPTION 54.Nm 55is an interactive file transfer program, similar to 56.Xr ftp 1 , 57which performs all operations over an encrypted 58.Xr ssh 1 59transport. 60It may also use many features of ssh, such as public key authentication and 61compression. 62.Nm 63connects and logs into the specified 64.Ar host , 65then enters an interactive command mode. 66.Pp 67The second usage format will retrieve files automatically if a non-interactive 68authentication method is used; otherwise it will do so after 69successful interactive authentication. 70.Pp | 56.Sh DESCRIPTION 57.Nm 58is an interactive file transfer program, similar to 59.Xr ftp 1 , 60which performs all operations over an encrypted 61.Xr ssh 1 62transport. 63It may also use many features of ssh, such as public key authentication and 64compression. 65.Nm 66connects and logs into the specified 67.Ar host , 68then enters an interactive command mode. 69.Pp 70The second usage format will retrieve files automatically if a non-interactive 71authentication method is used; otherwise it will do so after 72successful interactive authentication. 73.Pp |
| 71The last usage format allows the sftp client to start in a remote directory. | 74The third usage format allows the sftp client to start in a remote directory. |
| 72.Pp | 75.Pp |
| 76The final usage format allows for automated sessions using the 77.Fl b 78option. 79In such cases, it is usually necessary to configure public key authentication 80to obviate the need to enter a password at connection time (see 81.Xr sshd 8 82and 83.Xr ssh-keygen 1 84for details). |
|
| 73The options are as follows: 74.Bl -tag -width Ds 75.It Fl b Ar batchfile 76Batch mode reads a series of commands from an input 77.Ar batchfile 78instead of 79.Em stdin . 80Since it lacks user interaction it should be used in conjunction with 81non-interactive authentication. 82.Nm 83will abort if any of the following 84commands fail: 85.Ic get , put , rename , ln , 86.Ic rm , mkdir , chdir , ls , 87.Ic lchdir , chmod , chown , chgrp , lpwd 88and 89.Ic lmkdir . 90Termination on error can be suppressed on a command by command basis by 91prefixing the command with a | 85The options are as follows: 86.Bl -tag -width Ds 87.It Fl b Ar batchfile 88Batch mode reads a series of commands from an input 89.Ar batchfile 90instead of 91.Em stdin . 92Since it lacks user interaction it should be used in conjunction with 93non-interactive authentication. 94.Nm 95will abort if any of the following 96commands fail: 97.Ic get , put , rename , ln , 98.Ic rm , mkdir , chdir , ls , 99.Ic lchdir , chmod , chown , chgrp , lpwd 100and 101.Ic lmkdir . 102Termination on error can be suppressed on a command by command basis by 103prefixing the command with a |
| 92.Ic '-' 93character (For example, 94.Ic -rm /tmp/blah* 95). | 104.Sq Ic \- 105character (for example, 106.Ic -rm /tmp/blah* ) . |
| 96.It Fl o Ar ssh_option 97Can be used to pass options to 98.Nm ssh 99in the format used in 100.Xr ssh_config 5 . 101This is useful for specifying options 102for which there is no separate 103.Nm sftp | 107.It Fl o Ar ssh_option 108Can be used to pass options to 109.Nm ssh 110in the format used in 111.Xr ssh_config 5 . 112This is useful for specifying options 113for which there is no separate 114.Nm sftp |
| 104command-line flag. For example, to specify an alternate 105port use: | 115command-line flag. 116For example, to specify an alternate port use: |
| 106.Ic sftp -oPort=24 . 107.It Fl s Ar subsystem | sftp_server 108Specifies the SSH2 subsystem or the path for an sftp server | 117.Ic sftp -oPort=24 . 118.It Fl s Ar subsystem | sftp_server 119Specifies the SSH2 subsystem or the path for an sftp server |
| 109on the remote host. A path is useful for using sftp over 110protocol version 1, or when the remote 111.Nm sshd | 120on the remote host. 121A path is useful for using 122.Nm 123over protocol version 1, or when the remote 124.Xr sshd 8 |
| 112does not have an sftp subsystem configured. 113.It Fl v | 125does not have an sftp subsystem configured. 126.It Fl v |
| 114Raise logging level. This option is also passed to ssh. | 127Raise logging level. 128This option is also passed to ssh. |
| 115.It Fl B Ar buffer_size 116Specify the size of the buffer that 117.Nm | 129.It Fl B Ar buffer_size 130Specify the size of the buffer that 131.Nm |
| 118uses when transferring files. Larger buffers require fewer round trips at 119the cost of higher memory consumption. The default is 32768 bytes. | 132uses when transferring files. 133Larger buffers require fewer round trips at the cost of higher 134memory consumption. 135The default is 32768 bytes. |
| 120.It Fl C 121Enables compression (via ssh's 122.Fl C 123flag). 124.It Fl F Ar ssh_config 125Specifies an alternative 126per-user configuration file for | 136.It Fl C 137Enables compression (via ssh's 138.Fl C 139flag). 140.It Fl F Ar ssh_config 141Specifies an alternative 142per-user configuration file for |
| 127.Nm ssh . | 143.Xr ssh 1 . |
| 128This option is directly passed to 129.Xr ssh 1 . 130.It Fl P Ar sftp_server path | 144This option is directly passed to 145.Xr ssh 1 . 146.It Fl P Ar sftp_server path |
| 131Connect directly to a local 132.Nm sftp-server | 147Connect directly to a local sftp server |
| 133(rather than via | 148(rather than via |
| 134.Nm ssh ) | 149.Xr ssh 1 ) |
| 135This option may be useful in debugging the client and server. 136.It Fl R Ar num_requests | 150This option may be useful in debugging the client and server. 151.It Fl R Ar num_requests |
| 137Specify how many requests may be outstanding at any one time. Increasing 138this may slightly improve file transfer speed but will increase memory 139usage. The default is 16 outstanding requests. | 152Specify how many requests may be outstanding at any one time. 153Increasing this may slightly improve file transfer speed 154but will increase memory usage. 155The default is 16 outstanding requests. |
| 140.It Fl S Ar program 141Name of the 142.Ar program 143to use for the encrypted connection. 144The program must understand 145.Xr ssh 1 146options. 147.It Fl 1 148Specify the use of protocol version 1. 149.El 150.Sh INTERACTIVE COMMANDS 151Once in interactive mode, 152.Nm 153understands a set of commands similar to those of 154.Xr ftp 1 . 155Commands are case insensitive and pathnames may be enclosed in quotes if they 156contain spaces. 157.Bl -tag -width Ds 158.It Ic bye | 156.It Fl S Ar program 157Name of the 158.Ar program 159to use for the encrypted connection. 160The program must understand 161.Xr ssh 1 162options. 163.It Fl 1 164Specify the use of protocol version 1. 165.El 166.Sh INTERACTIVE COMMANDS 167Once in interactive mode, 168.Nm 169understands a set of commands similar to those of 170.Xr ftp 1 . 171Commands are case insensitive and pathnames may be enclosed in quotes if they 172contain spaces. 173.Bl -tag -width Ds 174.It Ic bye |
| 159Quit sftp. | 175Quit 176.Nm sftp . |
| 160.It Ic cd Ar path 161Change remote directory to 162.Ar path . 163.It Ic lcd Ar path 164Change local directory to 165.Ar path . 166.It Ic chgrp Ar grp Ar path 167Change group of file --- 10 unchanged lines hidden (view full) --- 178.It Ic chown Ar own Ar path 179Change owner of file 180.Ar path 181to 182.Ar own . 183.Ar own 184must be a numeric UID. 185.It Ic exit | 177.It Ic cd Ar path 178Change remote directory to 179.Ar path . 180.It Ic lcd Ar path 181Change local directory to 182.Ar path . 183.It Ic chgrp Ar grp Ar path 184Change group of file --- 10 unchanged lines hidden (view full) --- 195.It Ic chown Ar own Ar path 196Change owner of file 197.Ar path 198to 199.Ar own . 200.Ar own 201must be a numeric UID. 202.It Ic exit |
| 186Quit sftp. | 203Quit 204.Nm sftp . |
| 187.It Xo Ic get 188.Op Ar flags 189.Ar remote-path 190.Op Ar local-path 191.Xc 192Retrieve the 193.Ar remote-path 194and store it on the local machine. 195If the local 196path name is not specified, it is given the same name it has on the | 205.It Xo Ic get 206.Op Ar flags 207.Ar remote-path 208.Op Ar local-path 209.Xc 210Retrieve the 211.Ar remote-path 212and store it on the local machine. 213If the local 214path name is not specified, it is given the same name it has on the |
| 197remote machine. If the | 215remote machine. 216If the |
| 198.Fl P 199flag is specified, then the file's full permission and access time are 200copied too. 201.It Ic help 202Display help text. 203.It Ic lls Op Ar ls-options Op Ar path 204Display local directory listing of either 205.Ar path --- 13 unchanged lines hidden (view full) --- 219.It Xo Ic ls 220.Op Ar flags 221.Op Ar path 222.Xc 223Display remote directory listing of either 224.Ar path 225or current directory if 226.Ar path | 217.Fl P 218flag is specified, then the file's full permission and access time are 219copied too. 220.It Ic help 221Display help text. 222.It Ic lls Op Ar ls-options Op Ar path 223Display local directory listing of either 224.Ar path --- 13 unchanged lines hidden (view full) --- 238.It Xo Ic ls 239.Op Ar flags 240.Op Ar path 241.Xc 242Display remote directory listing of either 243.Ar path 244or current directory if 245.Ar path |
| 227is not specified. If the | 246is not specified. 247If the |
| 228.Fl l 229flag is specified, then display additional details including permissions 230and ownership information. 231.It Ic lumask Ar umask 232Set local umask to 233.Ar umask . 234.It Ic mkdir Ar path 235Create remote directory specified by 236.Ar path . 237.It Ic progress 238Toggle display of progress meter. 239.It Xo Ic put 240.Op Ar flags 241.Ar local-path 242.Op Ar remote-path 243.Xc 244Upload 245.Ar local-path | 248.Fl l 249flag is specified, then display additional details including permissions 250and ownership information. 251.It Ic lumask Ar umask 252Set local umask to 253.Ar umask . 254.It Ic mkdir Ar path 255Create remote directory specified by 256.Ar path . 257.It Ic progress 258Toggle display of progress meter. 259.It Xo Ic put 260.Op Ar flags 261.Ar local-path 262.Op Ar remote-path 263.Xc 264Upload 265.Ar local-path |
| 246and store it on the remote machine. If the remote path name is not 247specified, it is given the same name it has on the local machine. If the | 266and store it on the remote machine. 267If the remote path name is not specified, it is given the same name it has 268on the local machine. 269If the |
| 248.Fl P 249flag is specified, then the file's full permission and access time are 250copied too. 251.It Ic pwd 252Display remote working directory. 253.It Ic quit | 270.Fl P 271flag is specified, then the file's full permission and access time are 272copied too. 273.It Ic pwd 274Display remote working directory. 275.It Ic quit |
| 254Quit sftp. | 276Quit 277.Nm sftp . |
| 255.It Ic rename Ar oldpath Ar newpath 256Rename remote file from 257.Ar oldpath 258to 259.Ar newpath . 260.It Ic rmdir Ar path 261Remove remote directory specified by 262.Ar path . --- 4 unchanged lines hidden (view full) --- 267Create a symbolic link from 268.Ar oldpath 269to 270.Ar newpath . 271.It Ic version 272Display the 273.Nm 274protocol version. | 278.It Ic rename Ar oldpath Ar newpath 279Rename remote file from 280.Ar oldpath 281to 282.Ar newpath . 283.It Ic rmdir Ar path 284Remove remote directory specified by 285.Ar path . --- 4 unchanged lines hidden (view full) --- 290Create a symbolic link from 291.Ar oldpath 292to 293.Ar newpath . 294.It Ic version 295Display the 296.Nm 297protocol version. |
| 275.It Ic ! Ar command | 298.It Ic \&! Ar command |
| 276Execute 277.Ar command 278in local shell. | 299Execute 300.Ar command 301in local shell. |
| 279.It Ic ! | 302.It Ic \&! |
| 280Escape to local shell. | 303Escape to local shell. |
| 281.It Ic ? | 304.It Ic \&? |
| 282Synonym for help. 283.El | 305Synonym for help. 306.El |
| 284.Sh AUTHORS 285Damien Miller <djm@mindrot.org> | |
| 286.Sh SEE ALSO 287.Xr scp 1 , 288.Xr ssh 1 , 289.Xr ssh-add 1 , 290.Xr ssh-keygen 1 , 291.Xr ssh_config 5 , 292.Xr sftp-server 8 , 293.Xr sshd 8 294.Rs 295.%A T. Ylonen 296.%A S. Lehtinen 297.%T "SSH File Transfer Protocol" 298.%N draft-ietf-secsh-filexfer-00.txt 299.%D January 2001 300.%O work in progress material 301.Re | 307.Sh SEE ALSO 308.Xr scp 1 , 309.Xr ssh 1 , 310.Xr ssh-add 1 , 311.Xr ssh-keygen 1 , 312.Xr ssh_config 5 , 313.Xr sftp-server 8 , 314.Xr sshd 8 315.Rs 316.%A T. Ylonen 317.%A S. Lehtinen 318.%T "SSH File Transfer Protocol" 319.%N draft-ietf-secsh-filexfer-00.txt 320.%D January 2001 321.%O work in progress material 322.Re |