1curlftpfs(1) CurlFtpFS Manual curlftpfs(1)
2
6 curlftpfs - mount a ftp host as a local directory
7
9 curlftpfs [options] host path
10
12 The program curlftpfs is a tool to mount remote ftp hosts as local
13 directories. It connects to the host FTP server and maps its directory
14 structure to the path directory.
15 curlftpfs is powered by libcurl for all transfer-related features. See
17 libcurl(3) for details. The filesystem part is implemented on top of
18 FUSE. See http://fuse.sourceforge.net/ for details.
19
21 -h/--help
22 Print help options.
23 -v/--verbose
25 Make libcurl print verbose debug output.
26 -V/--version
28 Print curlftpfs, libcurl and fuse versions.
29 -o Options are specified with a -o flag followed by a comma sepa‐
31 rated string of options.
32 cacert=<file>
34 (SSL) Pass a string naming a file holding one or more
35 certificates to verify the peer with.
36 Note that option is by default set to the system
38 path where libcurl's cacert bundle is assumed to be
39 stored, as established at build time.
40 capath=<directory>
42 (SSL) Tells curlftpfs to use the specified certificate
43 directory to verify the peer. The certificates must be in
44 PEM format, and the directory must have been processed
45 using the c_rehash utility supplied with openssl.
46 Using capath can allow curlftpfs to make connections much
47 more efficiently than using cacert if the cacert file
48 contains many CA certificates.
49 cert=<certificate>
51 (SSL) Tells curlftpfs to use the specified certificate
52 file. The default format is "PEM" and can be changed with
53 cert_type.
54 cert_type=<type>
56 (SSL) Tells curlftpfs what certificate type the provided
57 certificate is in. PEM, DER and ENG are recognized
58 types.
59 ciphers=<list of ciphers>
61 (SSL) Specifies which ciphers to use in the connection.
62 The list must be syntactically correct, it consists of
63 one or more cipher strings separated by colons. Commas
64 or spaces are also acceptable separators but colons are
65 normally used, , - and + can be used as operators.
66 Valid examples of cipher lists include 'RC4-SHA',
67 ´SHA1+DES', 'TLSv1' and 'DEFAULT'. The default list is
68 normally set when you compile OpenSSL.
69 Read up on SSL cipher list details on this URL:
71 http://www.openssl.org/docs/apps/ciphers.html
72 codepage=<name>
74 Sets the encoding the ftp server uses to encode file
75 names.
76 connect_timeout=<seconds>
78 Maximum time in seconds that you allow the connection to
79 the server to take. This only limits the connection
80 phase, once curlftpfs has connected this option is of no
81 more use.
82 disable_eprt
84 Tell curlftpfs to disable the use of the EPRT and LPRT
85 commands when doing active FTP transfers. Curlftpfs will
86 normally always first attempt to use EPRT, then LPRT
87 before using PORT, but with this option, it will use PORT
88 right away. EPRT and LPRT are extensions to the original
89 FTP protocol, may not work on all servers but enable more
90 functionality in a better way than the traditional PORT
91 command.
92 disable_epsv
94 Tell curlftpfs to disable the use of the EPSV command
95 when doing passive FTP transfers. Curlftpfs will normally
96 always first attempt to use EPSV before PASV, but with
97 this option, it will not try using EPSV.
98 engine=<name>
100 Select the OpenSSL crypto engine to use for cipher
101 operations. Use:
102 curl --engine list
103 to print a list of build-time supported engines.
104 Note that not all (or none) of the engines may be
105 available at run-time.
106 ftpfs_debug
108 Make curlftpfs print lots of debug information. Useful
109 only in conjunction with the -d option.
110 ftp_port=<address>
112 Reverses the initiator/listener roles when connecting
113 with ftp. This switch makes curlftpfs use the PORT com‐
114 mand instead of PASV. In practice, PORT tells the server
115 to connect to the client's specified address and port,
116 while PASV asks the server for an ip address and port to
117 connect to. <address> should be one of:
118 interface
120 i.e "eth0" to specify which interface's IP address
121 you want to use
122 IP address
124 i.e "192.168.10.1" to specify exact IP number
125 host name
127 i.e "my.host.domain" to specify machine
128 - make curlftpfs pick the same IP address that is
130 already used for the control connection
131 Disable the attempt to use the EPRT command instead of
133 PORT by using disable_eprt. EPRT is really PORT++.
134 httpproxy
136 Set the proxy type to HTTP. This is the default type.
137 interface=<name>
139 Pass a string as parameter. This set the interface name
140 to use as outgoing network interface. The name can
141 be an interface name, an IP address or a host name.
142 iocharset=<name>
144 Sets the charset used by the client side for codepage to
145 charset translation. Default: UTF8.
146 ipv4 If libcurl is capable of resolving an address to mul‐
148 tiple IP versions (which it is if it is ipv6-capable),
149 this option tells libcurl to resolve names to IPv4
150 addresses only.
151 ipv6 If libcurl is capable of resolving an address to mul‐
153 tiple IP versions (which it is if it is ipv6-capable),
154 this option tells libcurl to resolve names to IPv6
155 addresses only.
156 key=<key>
158 (SSL) Private key file name. Allows you to provide your
159 private key in this separate file. The default format is
160 "PEM" and can be changed with key_type.
161 key_type=<type>
163 (SSL) Pass a string in the format of your private key.
164 Supported formats are "PEM", "DER" and "ENG".
165 The format "ENG" enables you to load the private key
167 from a crypto engine. In this case key is used as an
168 identifier passed to the engine. You have to set the
169 crypto engine with engine option. "DER" format key file
170 currently does not work because of a bug in OpenSSL.
171 krb4=<level>
173 Enable kerberos4 authentication and use. The level must
174 be entered and should be one of 'clear', 'safe', 'confi‐
175 dential' or 'private'. Should you use a level that
176 is not one of these, 'private' will instead be used.
177 This option requires that the libcurl library was built
179 with kerberos4 support. This is not very common.
180 no_verify_hostname
182 (SSL) Curlftpfs will not verify the hostname when con‐
183 necting to a SSL enabled server.
184 no_verify_peer
186 (SSL) Curlftpfs will not verify the certificate when con‐
187 necting to a SSL enabled server.
188 pass=<password>
190 (SSL) Pass phrase for the private key.
191 proxy=<host[:port]>
193 Use specified HTTP proxy. If the port number is not
194 specified, it is assumed at port 1080.
195 This option overrides existing environment variables
197 that sets proxy to use. If there's an environment
198 variable setting a proxy, you can set proxy to "" to
199 override it.
200 This options implies the proxytunnel option.
202 Starting with libcurl version 7.14.1, the proxy host can
204 be specified the exact same way as the proxy environment
205 variables, including protocol prefix (http://) and
206 embedded user + password.
207 proxytunnel
209 Tells curlftpfs to use a tunnel proxy. This option is
210 implied by the proxy option but you need to set it manu‐
211 ally if you use the proxy environment variable.
212 proxy_anyauth
214 Tells curl to pick a suitable authentication method when
215 communicating with the given proxy. This will cause
216 an extra request/response round-trip.
217 proxy_basic
219 Tells curlftpfs to use HTTP Basic authentication when
220 communicating with the given proxy. Basic is the default
221 authentication method curlftpfs is used with proxies.
222 proxy_digest
224 Tells curlftpfs to use HTTP Digest authentication when
225 communicating with the given proxy.
226 proxy_ntlm
228 Tells curlftpfs to use HTTP NTLM authentication when
229 communicating with the given proxy.
230 proxy_user=<user:password>
232 Specify user and password to use for proxy authentica‐
233 tion.
234 skip_pasv_ip
236 Tell curlftpfs to not use the IP address the server sug‐
237 gests in its response to curlftpfs's PASV command when
238 curlftpfs connects the data connection. Instead
239 curlftpfs will re-use the same IP address it already uses
240 for the control connection.
241 socks4 Set the proxy type to SOCKS4.
243 socks5 Set the proxy type to SOCKS5.
245 ssl Make curlftpfs use SSL/TLS for both control and data con‐
247 nections.
248 sslv3 Forces curlftpfs to use SSL version 3 when negotiating
250 with a remote SSL server.
251 ssl_control
253 Make curlftpfs use SSL/TLS only for the control connec‐
254 tion.
255 ssl_try
257 Curlftpfs will try to use SSL/TLS for both the control
258 and data connections but if the server doesn't support
259 it, it will still connect unencrypted.
260 tcp_nodelay
262 Turn on the TCP_NODELAY option. See the
263 curl_easy_setopt(3) man page for details about this
264 option.
265 tlsv1 (SSL) Forces curlftpfs to use TLS version 1 when negoti‐
267 ating with a remote TLS server.
268 transform_symlinks
270 Append path to the absolute symlinks so that they still
271 point inside the ftp directory structure. Otherwise those
272 links will very probably be broken.
273 user=<user:password>
275 Specify user and password to use for server authen‐
276 tication. Overrides netrc configuration.
277 utf8 Try to transfer file list with UTF-8 encoding. Send OPTS
279 UTF8 ON at the beginning of file list transfer.
280
282 -d Enable FUSE debug output. Implies -f.
283 -f Run curlftpfs in foreground mode.
285 -r Mount read-only.
287 -s Disable multi-threaded operation.
289 -o Options are specified with a -o flag followed by a comma sepa‐
291 rated string of options.
292 allow_other
294 Allow access to other users. By default the mount point
295 is only accessible to the user that mounted it and not
296 even to root.
297 allow_root
299 Allow access to root user. By default the mount point is
300 only accessible to the user that mounted it and not even
301 to root.
302 debug enable debug output
304 direct_io
306 use direct I/O
307 fsname=NAME
309 set filesystem name in mtab
310 gid=N set file group
312 hard_remove
314 immediate removal (don't hide files)
315 kernel_cache
317 Let the kernel VFS do some caching of the files.
318 large_read
320 issue large read requests (2.4 only)
321 max_read=N
323 set maximum size of read requests
324 nonempty
326 allow mounts over non-empty file/dir
327 readdir_ino
329 try to fill in d_ino in readdir
330 uid=N set file owner
332 umask=M
334 set file permissions (octal)
335 use_ino
337 let filesystem set inode numbers
338
340 Robson Braga Araujo is the author and maintainer of CurlFtpFS.
341
343 http://curlftpfs.sourceforge.net
344
346 mount(8)
347CurlFtpFS 0.6.1 12 Apr 2006 curlftpfs(1)