summaryrefslogtreecommitdiff
path: root/sftp.0
diff options
context:
space:
mode:
Diffstat (limited to 'sftp.0')
-rw-r--r--sftp.0180
1 files changed, 180 insertions, 0 deletions
diff --git a/sftp.0 b/sftp.0
new file mode 100644
index 000000000..1680e489c
--- /dev/null
+++ b/sftp.0
@@ -0,0 +1,180 @@
1SFTP(1) BSD General Commands Manual SFTP(1)
2
3^[[1mNAME^[[0m
4 ^[[1msftp ^[[22mM-bMM-^R Secure file transfer program
5
6^[[1mSYNOPSIS^[[0m
7 ^[[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]
8 [^[[1mM-bMM-^RB ^[[4m^[[22mbuffer_size^[[24m] [^[[1mM-bMM-^RF ^[[4m^[[22mssh_config^[[24m] [^[[1mM-bMM-^RP ^[[4m^[[22msftp_server^[[24m ^[[4mpath^[[24m]
9 [^[[1mM-bMM-^RR ^[[4m^[[22mnum_requests^[[24m] [^[[1mM-bMM-^RS ^[[4m^[[22mprogram^[[24m] ^[[4mhost^[[0m
10 ^[[1msftp ^[[22m[[^[[4muser^[[24m@]^[[4mhost^[[24m[:^[[4mfile^[[24m [^[[4mfile^[[24m]]]
11 ^[[1msftp ^[[22m[[^[[4muser^[[24m@]^[[4mhost^[[24m[:^[[4mdir^[[24m[^[[4m/^[[24m]]]
12
13^[[1mDESCRIPTION^[[0m
14 ^[[1msftp ^[[22mis an interactive file transfer program, similar to ftp(1), which
15 performs all operations over an encrypted ssh(1) transport. It may also
16 use many features of ssh, such as public key authentication and compresM-bM-^@M-^P
17 sion. ^[[1msftp ^[[22mconnects and logs into the specified ^[[4mhost^[[24m, then enters an
18 interactive command mode.
19
20 The second usage format will retrieve files automatically if a nonM-bM-^@M-^PinterM-bM-^@M-^P
21 active authentication method is used; otherwise it will do so after sucM-bM-^@M-^P
22 cessful interactive authentication.
23
24 The last usage format allows the sftp client to start in a remote direcM-bM-^@M-^P
25 tory.
26
27 The options are as follows:
28
29 ^[[1mM-bMM-^Rb ^[[4m^[[22mbatchfile^[[0m
30 Batch mode reads a series of commands from an input ^[[4mbatchfile^[[0m
31 instead of ^[[4mstdin^[[24m. Since it lacks user interaction it should be
32 used in conjunction with nonM-bM-^@M-^Pinteractive authentication. ^[[1msftp^[[0m
33 will abort if any of the following commands fail: ^[[1mget^[[22m, ^[[1mput^[[22m,
34 ^[[1mrename^[[22m, ^[[1mln^[[22m, ^[[1mrm^[[22m, ^[[1mmkdir^[[22m, ^[[1mchdir^[[22m, ^[[1mls^[[22m, ^[[1mlchdir^[[22m, ^[[1mchmod^[[22m, ^[[1mchown^[[22m, ^[[1mchgrp^[[22m,
35 ^[[1mlpwd ^[[22mand ^[[1mlmkdir^[[22m. Termination on error can be suppressed on a
36 command by command basis by prefixing the command with a ^[[1mM-bM-^@M-^YM-bM-^@M-^PM-bM-^@M-^Y^[[0m
37 character (For example, ^[[1mM-bM-^@M-^Prm /tmp/blah* ^[[22m).
38
39 ^[[1mM-bMM-^Ro ^[[4m^[[22mssh_option^[[0m
40 Can be used to pass options to ^[[1mssh ^[[22min the format used in
41 ssh_config(5). This is useful for specifying options for which
42 there is no separate ^[[1msftp ^[[22mcommandM-bM-^@M-^Pline flag. For example, to
43 specify an alternate port use: ^[[1msftp M-bM-^@M-^PoPort=24^[[22m.
44
45 ^[[1mM-bMM-^Rs ^[[4m^[[22msubsystem^[[24m | ^[[4msftp_server^[[0m
46 Specifies the SSH2 subsystem or the path for an sftp server on
47 the remote host. A path is useful for using sftp over protocol
48 version 1, or when the remote ^[[1msshd ^[[22mdoes not have an sftp subsysM-bM-^@M-^P
49 tem configured.
50
51 ^[[1mM-bMM-^Rv ^[[22mRaise logging level. This option is also passed to ssh.
52
53 ^[[1mM-bMM-^RB ^[[4m^[[22mbuffer_size^[[0m
54 Specify the size of the buffer that ^[[1msftp ^[[22muses when transferring
55 files. Larger buffers require fewer round trips at the cost of
56 higher memory consumption. The default is 32768 bytes.
57
58 ^[[1mM-bMM-^RC ^[[22mEnables compression (via sshM-bM-^@M-^Ys ^[[1mM-bMM-^RC ^[[22mflag).
59
60 ^[[1mM-bMM-^RF ^[[4m^[[22mssh_config^[[0m
61 Specifies an alternative perM-bM-^@M-^Puser configuration file for ^[[1mssh^[[22m.
62 This option is directly passed to ssh(1).
63
64 ^[[1mM-bMM-^RP ^[[4m^[[22msftp_server^[[24m ^[[4mpath^[[0m
65 Connect directly to a local ^[[1msftpM-bM-^@M-^Pserver ^[[22m(rather than via ^[[1mssh^[[22m)
66 This option may be useful in debugging the client and server.
67
68 ^[[1mM-bMM-^RR ^[[4m^[[22mnum_requests^[[0m
69 Specify how many requests may be outstanding at any one time.
70 Increasing this may slightly improve file transfer speed but will
71 increase memory usage. The default is 16 outstanding requests.
72
73 ^[[1mM-bMM-^RS ^[[4m^[[22mprogram^[[0m
74 Name of the ^[[4mprogram^[[24m to use for the encrypted connection. The
75 program must understand ssh(1) options.
76
77 ^[[1mM-bMM-^R1 ^[[22mSpecify the use of protocol version 1.
78
79^[[1mINTERACTIVE COMMANDS^[[0m
80 Once in interactive mode, ^[[1msftp ^[[22munderstands a set of commands similar to
81 those of ftp(1). Commands are case insensitive and pathnames may be
82 enclosed in quotes if they contain spaces.
83
84 ^[[1mbye ^[[22mQuit sftp.
85
86 ^[[1mcd ^[[4m^[[22mpath^[[0m
87 Change remote directory to ^[[4mpath^[[24m.
88
89 ^[[1mlcd ^[[4m^[[22mpath^[[0m
90 Change local directory to ^[[4mpath^[[24m.
91
92 ^[[1mchgrp ^[[4m^[[22mgrp^[[24m ^[[4mpath^[[0m
93 Change group of file ^[[4mpath^[[24m to ^[[4mgrp^[[24m. ^[[4mgrp^[[24m must be a numeric GID.
94
95 ^[[1mchmod ^[[4m^[[22mmode^[[24m ^[[4mpath^[[0m
96 Change permissions of file ^[[4mpath^[[24m to ^[[4mmode^[[24m.
97
98 ^[[1mchown ^[[4m^[[22mown^[[24m ^[[4mpath^[[0m
99 Change owner of file ^[[4mpath^[[24m to ^[[4mown^[[24m. ^[[4mown^[[24m must be a numeric UID.
100
101 ^[[1mexit ^[[22mQuit sftp.
102
103 ^[[1mget ^[[22m[^[[4mflags^[[24m] ^[[4mremoteM-bM-^@M-^Ppath^[[24m [^[[4mlocalM-bM-^@M-^Ppath^[[24m]
104 Retrieve the ^[[4mremoteM-bM-^@M-^Ppath^[[24m and store it on the local machine. If
105 the local path name is not specified, it is given the same name
106 it has on the remote machine. If the ^[[1mM-bMM-^RP ^[[22mflag is specified, then
107 the fileM-bM-^@M-^Ys full permission and access time are copied too.
108
109 ^[[1mhelp ^[[22mDisplay help text.
110
111 ^[[1mlls ^[[22m[^[[4mlsM-bM-^@M-^Poptions^[[24m [^[[4mpath^[[24m]]
112 Display local directory listing of either ^[[4mpath^[[24m or current direcM-bM-^@M-^P
113 tory if ^[[4mpath^[[24m is not specified.
114
115 ^[[1mlmkdir ^[[4m^[[22mpath^[[0m
116 Create local directory specified by ^[[4mpath^[[24m.
117
118 ^[[1mln ^[[4m^[[22moldpath^[[24m ^[[4mnewpath^[[0m
119 Create a symbolic link from ^[[4moldpath^[[24m to ^[[4mnewpath^[[24m.
120
121 ^[[1mlpwd ^[[22mPrint local working directory.
122
123 ^[[1mls ^[[22m[^[[4mflags^[[24m] [^[[4mpath^[[24m]
124 Display remote directory listing of either ^[[4mpath^[[24m or current direcM-bM-^@M-^P
125 tory if ^[[4mpath^[[24m is not specified. If the ^[[1mM-bMM-^Rl ^[[22mflag is specified, then
126 display additional details including permissions and ownership
127 information.
128
129 ^[[1mlumask ^[[4m^[[22mumask^[[0m
130 Set local umask to ^[[4mumask^[[24m.
131
132 ^[[1mmkdir ^[[4m^[[22mpath^[[0m
133 Create remote directory specified by ^[[4mpath^[[24m.
134
135 ^[[1mprogress^[[0m
136 Toggle display of progress meter.
137
138 ^[[1mput ^[[22m[^[[4mflags^[[24m] ^[[4mlocalM-bM-^@M-^Ppath^[[24m [^[[4mremoteM-bM-^@M-^Ppath^[[24m]
139 Upload ^[[4mlocalM-bM-^@M-^Ppath^[[24m and store it on the remote machine. If the
140 remote path name is not specified, it is given the same name it
141 has on the local machine. If the ^[[1mM-bMM-^RP ^[[22mflag is specified, then the
142 fileM-bM-^@M-^Ys full permission and access time are copied too.
143
144 ^[[1mpwd ^[[22mDisplay remote working directory.
145
146 ^[[1mquit ^[[22mQuit sftp.
147
148 ^[[1mrename ^[[4m^[[22moldpath^[[24m ^[[4mnewpath^[[0m
149 Rename remote file from ^[[4moldpath^[[24m to ^[[4mnewpath^[[24m.
150
151 ^[[1mrmdir ^[[4m^[[22mpath^[[0m
152 Remove remote directory specified by ^[[4mpath^[[24m.
153
154 ^[[1mrm ^[[4m^[[22mpath^[[0m
155 Delete remote file specified by ^[[4mpath^[[24m.
156
157 ^[[1msymlink ^[[4m^[[22moldpath^[[24m ^[[4mnewpath^[[0m
158 Create a symbolic link from ^[[4moldpath^[[24m to ^[[4mnewpath^[[24m.
159
160 ^[[1mversion^[[0m
161 Display the ^[[1msftp ^[[22mprotocol version.
162
163 ! ^[[4mcommand^[[0m
164 Execute ^[[4mcommand^[[24m in local shell.
165
166 ! Escape to local shell.
167
168 ? Synonym for help.
169
170^[[1mAUTHORS^[[0m
171 Damien Miller <djm@mindrot.org>
172
173^[[1mSEE ALSO^[[0m
174 scp(1), ssh(1), sshM-bM-^@M-^Padd(1), sshM-bM-^@M-^Pkeygen(1), ssh_config(5), sftpM-bM-^@M-^Pserver(8),
175 sshd(8)
176
177 T. Ylonen and S. Lehtinen, ^[[4mSSH^[[24m ^[[4mFile^[[24m ^[[4mTransfer^[[24m ^[[4mProtocol^[[24m, draftM-bM-^@M-^PietfM-bM-^@M-^PsecshM-bM-^@M-^P
178 filexferM-bM-^@M-^P00.txt, January 2001, work in progress material.
179
180BSD February 4, 2001 BSD
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-01 01:21:05 +0000