summaryrefslogtreecommitdiff
path: root/sftp.0
blob: 1680e489c80612c267142943c5a950e1cc425ba6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
SFTP(1)                   BSD General Commands Manual                  SFTP(1)

^[[1mNAME^[[0m
     ^[[1msftp ^[[22mM-bMM-^R Secure file transfer program

^[[1mSYNOPSIS^[[0m
     ^[[1msftp ^[[22m[^[[1mM-bMM-^RvC1^[[22m] [^[[1mM-bMM-^Rb ^[[4m^[[22mbatchfile^[[24m] [^[[1mM-bMM-^Ro ^[[4m^[[22mssh_option^[[24m] [^[[1mM-bMM-^Rs ^[[4m^[[22msubsystem^[[24m | ^[[4msftp_server^[[24m]
          [^[[1mM-bMM-^RB ^[[4m^[[22mbuffer_size^[[24m] [^[[1mM-bMM-^RF ^[[4m^[[22mssh_config^[[24m] [^[[1mM-bMM-^RP ^[[4m^[[22msftp_server^[[24m ^[[4mpath^[[24m]
          [^[[1mM-bMM-^RR ^[[4m^[[22mnum_requests^[[24m] [^[[1mM-bMM-^RS ^[[4m^[[22mprogram^[[24m] ^[[4mhost^[[0m
     ^[[1msftp ^[[22m[[^[[4muser^[[24m@]^[[4mhost^[[24m[:^[[4mfile^[[24m [^[[4mfile^[[24m]]]
     ^[[1msftp ^[[22m[[^[[4muser^[[24m@]^[[4mhost^[[24m[:^[[4mdir^[[24m[^[[4m/^[[24m]]]

^[[1mDESCRIPTION^[[0m
     ^[[1msftp ^[[22mis an interactive file transfer program, similar to ftp(1), which
     performs all operations over an encrypted ssh(1) transport.  It may also
     use many features of ssh, such as public key authentication and compresM-bM-^@M-^P
     sion.  ^[[1msftp ^[[22mconnects and logs into the specified ^[[4mhost^[[24m, then enters an
     interactive command mode.

     The second usage format will retrieve files automatically if a nonM-bM-^@M-^PinterM-bM-^@M-^P
     active authentication method is used; otherwise it will do so after sucM-bM-^@M-^P
     cessful interactive authentication.

     The last usage format allows the sftp client to start in a remote direcM-bM-^@M-^P
     tory.

     The options are as follows:

     ^[[1mM-bMM-^Rb ^[[4m^[[22mbatchfile^[[0m
             Batch mode reads a series of commands from an input ^[[4mbatchfile^[[0m
             instead of ^[[4mstdin^[[24m.  Since it lacks user interaction it should be
             used in conjunction with nonM-bM-^@M-^Pinteractive authentication.  ^[[1msftp^[[0m
             will abort if any of the following commands fail: ^[[1mget^[[22m, ^[[1mput^[[22m,
             ^[[1mrename^[[22m, ^[[1mln^[[22m, ^[[1mrm^[[22m, ^[[1mmkdir^[[22m, ^[[1mchdir^[[22m, ^[[1mls^[[22m, ^[[1mlchdir^[[22m, ^[[1mchmod^[[22m, ^[[1mchown^[[22m, ^[[1mchgrp^[[22m,
             ^[[1mlpwd ^[[22mand ^[[1mlmkdir^[[22m.  Termination on error can be suppressed on a
             command by command basis by prefixing the command with a ^[[1mM-bM-^@M-^YM-bM-^@M-^PM-bM-^@M-^Y^[[0m
             character (For example, ^[[1mM-bM-^@M-^Prm /tmp/blah* ^[[22m).

     ^[[1mM-bMM-^Ro ^[[4m^[[22mssh_option^[[0m
             Can be used to pass options to ^[[1mssh ^[[22min the format used in
             ssh_config(5).  This is useful for specifying options for which
             there is no separate ^[[1msftp ^[[22mcommandM-bM-^@M-^Pline flag.  For example, to
             specify an alternate port use: ^[[1msftp M-bM-^@M-^PoPort=24^[[22m.

     ^[[1mM-bMM-^Rs ^[[4m^[[22msubsystem^[[24m | ^[[4msftp_server^[[0m
             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 ^[[1msshd ^[[22mdoes not have an sftp subsysM-bM-^@M-^P
             tem configured.

     ^[[1mM-bMM-^Rv      ^[[22mRaise logging level. This option is also passed to ssh.

     ^[[1mM-bMM-^RB ^[[4m^[[22mbuffer_size^[[0m
             Specify  the size of the buffer that ^[[1msftp ^[[22muses when transferring
             files. Larger buffers require fewer round trips at the cost of
             higher memory consumption. The default is 32768 bytes.

     ^[[1mM-bMM-^RC      ^[[22mEnables compression (via sshM-bM-^@M-^Ys ^[[1mM-bMM-^RC ^[[22mflag).

     ^[[1mM-bMM-^RF ^[[4m^[[22mssh_config^[[0m
             Specifies an alternative perM-bM-^@M-^Puser configuration file for ^[[1mssh^[[22m.
             This option is directly passed to ssh(1).

     ^[[1mM-bMM-^RP ^[[4m^[[22msftp_server^[[24m ^[[4mpath^[[0m
             Connect directly to a local ^[[1msftpM-bM-^@M-^Pserver ^[[22m(rather than via ^[[1mssh^[[22m)
             This option may be useful in debugging the client and server.

     ^[[1mM-bMM-^RR ^[[4m^[[22mnum_requests^[[0m
             Specify how many requests may be outstanding at any one time.
             Increasing this may slightly improve file transfer speed but will
             increase memory usage. The default is 16 outstanding requests.

     ^[[1mM-bMM-^RS ^[[4m^[[22mprogram^[[0m
             Name of the ^[[4mprogram^[[24m to use for the encrypted connection.  The
             program must understand ssh(1) options.

     ^[[1mM-bMM-^R1      ^[[22mSpecify the use of protocol version 1.

^[[1mINTERACTIVE COMMANDS^[[0m
     Once in interactive mode, ^[[1msftp ^[[22munderstands a set of commands similar to
     those of ftp(1).  Commands are case insensitive and pathnames may be
     enclosed in quotes if they contain spaces.

     ^[[1mbye     ^[[22mQuit sftp.

     ^[[1mcd ^[[4m^[[22mpath^[[0m
             Change remote directory to ^[[4mpath^[[24m.

     ^[[1mlcd ^[[4m^[[22mpath^[[0m
             Change local directory to ^[[4mpath^[[24m.

     ^[[1mchgrp ^[[4m^[[22mgrp^[[24m ^[[4mpath^[[0m
             Change group of file ^[[4mpath^[[24m to ^[[4mgrp^[[24m.  ^[[4mgrp^[[24m must be a numeric GID.

     ^[[1mchmod ^[[4m^[[22mmode^[[24m ^[[4mpath^[[0m
             Change permissions of file ^[[4mpath^[[24m to ^[[4mmode^[[24m.

     ^[[1mchown ^[[4m^[[22mown^[[24m ^[[4mpath^[[0m
             Change owner of file ^[[4mpath^[[24m to ^[[4mown^[[24m.  ^[[4mown^[[24m must be a numeric UID.

     ^[[1mexit    ^[[22mQuit sftp.

     ^[[1mget ^[[22m[^[[4mflags^[[24m] ^[[4mremoteM-bM-^@M-^Ppath^[[24m [^[[4mlocalM-bM-^@M-^Ppath^[[24m]
             Retrieve the ^[[4mremoteM-bM-^@M-^Ppath^[[24m and store 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 ^[[1mM-bMM-^RP ^[[22mflag is specified, then
             the fileM-bM-^@M-^Ys full permission and access time are copied too.

     ^[[1mhelp    ^[[22mDisplay help text.

     ^[[1mlls ^[[22m[^[[4mlsM-bM-^@M-^Poptions^[[24m [^[[4mpath^[[24m]]
             Display local directory listing of either ^[[4mpath^[[24m or current direcM-bM-^@M-^P
             tory if ^[[4mpath^[[24m is not specified.

     ^[[1mlmkdir ^[[4m^[[22mpath^[[0m
             Create local directory specified by ^[[4mpath^[[24m.

     ^[[1mln ^[[4m^[[22moldpath^[[24m ^[[4mnewpath^[[0m
             Create a symbolic link from ^[[4moldpath^[[24m to ^[[4mnewpath^[[24m.

     ^[[1mlpwd    ^[[22mPrint local working directory.

     ^[[1mls ^[[22m[^[[4mflags^[[24m] [^[[4mpath^[[24m]
             Display remote directory listing of either ^[[4mpath^[[24m or current direcM-bM-^@M-^P
             tory if ^[[4mpath^[[24m is not specified. If the ^[[1mM-bMM-^Rl ^[[22mflag is specified, then
             display additional details including permissions and ownership
             information.

     ^[[1mlumask ^[[4m^[[22mumask^[[0m
             Set local umask to ^[[4mumask^[[24m.

     ^[[1mmkdir ^[[4m^[[22mpath^[[0m
             Create remote directory specified by ^[[4mpath^[[24m.

     ^[[1mprogress^[[0m
             Toggle display of progress meter.

     ^[[1mput ^[[22m[^[[4mflags^[[24m] ^[[4mlocalM-bM-^@M-^Ppath^[[24m [^[[4mremoteM-bM-^@M-^Ppath^[[24m]
             Upload ^[[4mlocalM-bM-^@M-^Ppath^[[24m and store 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 ^[[1mM-bMM-^RP ^[[22mflag is specified, then the
             fileM-bM-^@M-^Ys full permission and access time are copied too.

     ^[[1mpwd     ^[[22mDisplay remote working directory.

     ^[[1mquit    ^[[22mQuit sftp.

     ^[[1mrename ^[[4m^[[22moldpath^[[24m ^[[4mnewpath^[[0m
             Rename remote file from ^[[4moldpath^[[24m to ^[[4mnewpath^[[24m.

     ^[[1mrmdir ^[[4m^[[22mpath^[[0m
             Remove remote directory specified by ^[[4mpath^[[24m.

     ^[[1mrm ^[[4m^[[22mpath^[[0m
             Delete remote file specified by ^[[4mpath^[[24m.

     ^[[1msymlink ^[[4m^[[22moldpath^[[24m ^[[4mnewpath^[[0m
             Create a symbolic link from ^[[4moldpath^[[24m to ^[[4mnewpath^[[24m.

     ^[[1mversion^[[0m
             Display the ^[[1msftp ^[[22mprotocol version.

     ! ^[[4mcommand^[[0m
             Execute ^[[4mcommand^[[24m in local shell.

     !       Escape to local shell.

     ?       Synonym for help.

^[[1mAUTHORS^[[0m
     Damien Miller <djm@mindrot.org>

^[[1mSEE ALSO^[[0m
     scp(1), ssh(1), sshM-bM-^@M-^Padd(1), sshM-bM-^@M-^Pkeygen(1), ssh_config(5), sftpM-bM-^@M-^Pserver(8),
     sshd(8)

     T. Ylonen and S. Lehtinen, ^[[4mSSH^[[24m ^[[4mFile^[[24m ^[[4mTransfer^[[24m ^[[4mProtocol^[[24m, draftM-bM-^@M-^PietfM-bM-^@M-^PsecshM-bM-^@M-^P
     filexferM-bM-^@M-^P00.txt, January 2001, work in progress material.

BSD                            February 4, 2001                            BSD