mirror of
https://github.com/rclone/rclone.git
synced 2025-12-06 00:03:32 +00:00
docs: make command docs titles be one higher
This commit is contained in:
@@ -1,23 +1,23 @@
|
||||
---
|
||||
date: 2020-05-18T10:38:09+01:00
|
||||
date: 2020-05-22T09:52:00+01:00
|
||||
title: "rclone serve ftp"
|
||||
description: "Serve remote:path over FTP."
|
||||
slug: rclone_serve_ftp
|
||||
url: /commands/rclone_serve_ftp/
|
||||
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/ftp/ and as part of making a release run "make commanddocs"
|
||||
---
|
||||
## rclone serve ftp
|
||||
# rclone serve ftp
|
||||
|
||||
Serve remote:path over FTP.
|
||||
|
||||
### Synopsis
|
||||
## Synopsis
|
||||
|
||||
|
||||
rclone serve ftp implements a basic ftp server to serve the
|
||||
remote over FTP protocol. This can be viewed with a ftp client
|
||||
or you can make a remote of type ftp to read and write it.
|
||||
|
||||
### Server options
|
||||
## Server options
|
||||
|
||||
Use --addr to specify which IP address and port the server should
|
||||
listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all
|
||||
@@ -27,13 +27,13 @@ IPs. By default it only listens on localhost. You can use port
|
||||
If you set --addr to listen on a public or LAN accessible IP address
|
||||
then using Authentication is advised - see the next section for info.
|
||||
|
||||
#### Authentication
|
||||
### Authentication
|
||||
|
||||
By default this will serve files without needing a login.
|
||||
|
||||
You can set a single username and password with the --user and --pass flags.
|
||||
|
||||
### Directory Cache
|
||||
## Directory Cache
|
||||
|
||||
Using the `--dir-cache-time` flag, you can set how long a
|
||||
directory should be considered up to date and not refreshed from the
|
||||
@@ -59,7 +59,7 @@ Or individual files or directories:
|
||||
|
||||
rclone rc vfs/forget file=path/to/file dir=path/to/dir
|
||||
|
||||
### File Buffering
|
||||
## File Buffering
|
||||
|
||||
The `--buffer-size` flag determines the amount of memory,
|
||||
that will be used to buffer data in advance.
|
||||
@@ -76,7 +76,7 @@ will be used.
|
||||
The maximum memory used by rclone for buffering can be up to
|
||||
`--buffer-size * open files`.
|
||||
|
||||
### File Caching
|
||||
## File Caching
|
||||
|
||||
These flags control the VFS file caching options. The VFS layer is
|
||||
used by rclone mount to make a cloud storage system work more like a
|
||||
@@ -113,7 +113,7 @@ for two reasons. Firstly because it is only checked every
|
||||
--vfs-cache-poll-interval. Secondly because open files cannot be
|
||||
evicted from the cache.
|
||||
|
||||
#### --vfs-cache-mode off
|
||||
### --vfs-cache-mode off
|
||||
|
||||
In this mode the cache will read directly from the remote and write
|
||||
directly to the remote without caching anything on disk.
|
||||
@@ -128,7 +128,7 @@ This will mean some operations are not possible
|
||||
* Open modes O_APPEND, O_TRUNC are ignored
|
||||
* If an upload fails it can't be retried
|
||||
|
||||
#### --vfs-cache-mode minimal
|
||||
### --vfs-cache-mode minimal
|
||||
|
||||
This is very similar to "off" except that files opened for read AND
|
||||
write will be buffered to disks. This means that files opened for
|
||||
@@ -141,7 +141,7 @@ These operations are not possible
|
||||
* Files opened for write only will ignore O_APPEND, O_TRUNC
|
||||
* If an upload fails it can't be retried
|
||||
|
||||
#### --vfs-cache-mode writes
|
||||
### --vfs-cache-mode writes
|
||||
|
||||
In this mode files opened for read only are still read directly from
|
||||
the remote, write only and read/write files are buffered to disk
|
||||
@@ -151,7 +151,7 @@ This mode should support all normal file system operations.
|
||||
|
||||
If an upload fails it will be retried up to --low-level-retries times.
|
||||
|
||||
#### --vfs-cache-mode full
|
||||
### --vfs-cache-mode full
|
||||
|
||||
In this mode all reads and writes are buffered to and from disk. When
|
||||
a file is opened for read it will be downloaded in its entirety first.
|
||||
@@ -169,7 +169,7 @@ This mode should support all normal file system operations.
|
||||
If an upload or download fails it will be retried up to
|
||||
--low-level-retries times.
|
||||
|
||||
### Case Sensitivity
|
||||
## Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
by case, and the exact case must be used when opening a file.
|
||||
@@ -205,7 +205,7 @@ If the flag is not provided on command line, then its default value depends
|
||||
on the operating system where rclone runs: "true" on Windows and MacOS, "false"
|
||||
otherwise. If the flag is provided without a value, then it is "true".
|
||||
|
||||
### Auth Proxy
|
||||
## Auth Proxy
|
||||
|
||||
If you supply the parameter `--auth-proxy /path/to/program` then
|
||||
rclone will use that program to generate backends on the fly which
|
||||
@@ -291,7 +291,7 @@ backend that rclone supports.
|
||||
rclone serve ftp remote:path [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
## Options
|
||||
|
||||
```
|
||||
--addr string IPaddress:Port or :Port to bind server to. (default "localhost:2121")
|
||||
@@ -319,13 +319,13 @@ rclone serve ftp remote:path [flags]
|
||||
--vfs-case-insensitive If a file name not found, find a case insensitive match.
|
||||
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M)
|
||||
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)
|
||||
--vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 5ms)
|
||||
--vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms)
|
||||
--vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s)
|
||||
```
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
### SEE ALSO
|
||||
## SEE ALSO
|
||||
|
||||
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user