community
/
rclone
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: make command docs titles be one higher

This commit is contained in:
Nick Craig-Wood 2020-05-22 11:17:37 +01:00
parent 0a74f8022e
commit 050879f0ca
69 changed files with 436 additions and 431 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cmd/gendocs/gendocs.go
View File

@ -7,6 +7,7 @@ import (
"os" "os"
"path" "path"
"path/filepath" "path/filepath"
"regexp"
"strings" "strings"
"text/template" "text/template"
"time" "time"
@ -120,6 +121,8 @@ rclone.org website.`,
return err return err
} }
var outdentTitle = regexp.MustCompile(`(?m)^#(#+)`)
// Munge the files to add a link to the global flags page // Munge the files to add a link to the global flags page
err = filepath.Walk(out, func(path string, info os.FileInfo, err error) error { err = filepath.Walk(out, func(path string, info os.FileInfo, err error) error {
if err != nil { if err != nil {
@ -135,6 +138,8 @@ rclone.org website.`,
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO`, 1) ### SEE ALSO`, 1)
// outdent all the titles by one
doc = outdentTitle.ReplaceAllString(doc, `$1`)
err = ioutil.WriteFile(path, []byte(doc), 0777) err = ioutil.WriteFile(path, []byte(doc), 0777)
if err != nil { if err != nil {
return err return err

12
docs/content/commands/rclone.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone" title: "rclone"
description: "Show help for rclone commands, flags and backends." description: "Show help for rclone commands, flags and backends."
slug: rclone slug: rclone
url: /commands/rclone/ url: /commands/rclone/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/ and as part of making a release run "make commanddocs"
--- ---
## rclone # rclone
Show help for rclone commands, flags and backends. Show help for rclone commands, flags and backends.
### Synopsis ## Synopsis
Rclone syncs files to and from cloud storage providers as well as Rclone syncs files to and from cloud storage providers as well as
@ -25,7 +25,7 @@ documentation, changelog and configuration walkthroughs.
rclone [flags] rclone [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for rclone -h, --help help for rclone
@ -33,7 +33,7 @@ rclone [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone about](/commands/rclone_about/) - Get quota information from the remote. * [rclone about](/commands/rclone_about/) - Get quota information from the remote.
* [rclone authorize](/commands/rclone_authorize/) - Remote authorization. * [rclone authorize](/commands/rclone_authorize/) - Remote authorization.
@ -52,7 +52,7 @@ See the [global flags page](/flags/) for global options not listed here.
* [rclone deletefile](/commands/rclone_deletefile/) - Remove a single file from remote. * [rclone deletefile](/commands/rclone_deletefile/) - Remove a single file from remote.
* [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell.
* [rclone gendocs](/commands/rclone_gendocs/) - Output markdown docs for rclone to the directory supplied. * [rclone gendocs](/commands/rclone_gendocs/) - Output markdown docs for rclone to the directory supplied.
* [rclone hashsum](/commands/rclone_hashsum/) - Produces an hashsum file for all the objects in the path. * [rclone hashsum](/commands/rclone_hashsum/) - Produces a hashsum file for all the objects in the path.
* [rclone link](/commands/rclone_link/) - Generate public link to file/folder. * [rclone link](/commands/rclone_link/) - Generate public link to file/folder.
* [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file. * [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file.
* [rclone ls](/commands/rclone_ls/) - List the objects in the path with size and path. * [rclone ls](/commands/rclone_ls/) - List the objects in the path with size and path.

10
docs/content/commands/rclone_about.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone about" title: "rclone about"
description: "Get quota information from the remote." description: "Get quota information from the remote."
slug: rclone_about slug: rclone_about
url: /commands/rclone_about/ url: /commands/rclone_about/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/about/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/about/ and as part of making a release run "make commanddocs"
--- ---
## rclone about # rclone about
Get quota information from the remote. Get quota information from the remote.
### Synopsis ## Synopsis
Get quota information from the remote, like bytes used/free/quota and bytes Get quota information from the remote, like bytes used/free/quota and bytes
@ -60,7 +60,7 @@ Use the --json flag for a computer readable output, eg
rclone about remote: [flags] rclone about remote: [flags]
``` ```
### Options ## Options
``` ```
--full Full numbers instead of SI units --full Full numbers instead of SI units
@ -70,7 +70,7 @@ rclone about remote: [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_authorize.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone authorize" title: "rclone authorize"
description: "Remote authorization." description: "Remote authorization."
slug: rclone_authorize slug: rclone_authorize
url: /commands/rclone_authorize/ url: /commands/rclone_authorize/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/authorize/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/authorize/ and as part of making a release run "make commanddocs"
--- ---
## rclone authorize # rclone authorize
Remote authorization. Remote authorization.
### Synopsis ## Synopsis
Remote authorization. Used to authorize a remote or headless Remote authorization. Used to authorize a remote or headless
@ -24,7 +24,7 @@ link in default browser automatically.
rclone authorize [flags] rclone authorize [flags]
``` ```
### Options ## Options
``` ```
--auth-no-open-browser Do not automatically open auth link in default browser --auth-no-open-browser Do not automatically open auth link in default browser
@ -33,7 +33,7 @@ rclone authorize [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_backend.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone backend" title: "rclone backend"
description: "Run a backend specific command." description: "Run a backend specific command."
slug: rclone_backend slug: rclone_backend
url: /commands/rclone_backend/ url: /commands/rclone_backend/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/backend/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/backend/ and as part of making a release run "make commanddocs"
--- ---
## rclone backend # rclone backend
Run a backend specific command. Run a backend specific command.
### Synopsis ## Synopsis
This runs a backend specific command. The commands themselves (except This runs a backend specific command. The commands themselves (except
@ -44,7 +44,7 @@ Note to run these commands on a running backend then see
rclone backend <command> remote:path [opts] <args> [flags] rclone backend <command> remote:path [opts] <args> [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for backend -h, --help help for backend
@ -54,7 +54,7 @@ rclone backend <command> remote:path [opts] <args> [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_cat.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone cat" title: "rclone cat"
description: "Concatenates any files and sends them to stdout." description: "Concatenates any files and sends them to stdout."
slug: rclone_cat slug: rclone_cat
url: /commands/rclone_cat/ url: /commands/rclone_cat/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/cat/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/cat/ and as part of making a release run "make commanddocs"
--- ---
## rclone cat # rclone cat
Concatenates any files and sends them to stdout. Concatenates any files and sends them to stdout.
### Synopsis ## Synopsis
rclone cat sends any files to standard output. rclone cat sends any files to standard output.
@ -37,7 +37,7 @@ Note that if offset is negative it will count from the end, so
rclone cat remote:path [flags] rclone cat remote:path [flags]
``` ```
### Options ## Options
``` ```
--count int Only print N characters. (default -1) --count int Only print N characters. (default -1)
@ -50,7 +50,7 @@ rclone cat remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_check.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone check" title: "rclone check"
description: "Checks the files in the source and destination match." description: "Checks the files in the source and destination match."
slug: rclone_check slug: rclone_check
url: /commands/rclone_check/ url: /commands/rclone_check/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/check/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/check/ and as part of making a release run "make commanddocs"
--- ---
## rclone check # rclone check
Checks the files in the source and destination match. Checks the files in the source and destination match.
### Synopsis ## Synopsis
Checks the files in the source and destination match. It compares Checks the files in the source and destination match. It compares
@ -34,7 +34,7 @@ destination that are not in the source will not trigger an error.
rclone check source:path dest:path [flags] rclone check source:path dest:path [flags]
``` ```
### Options ## Options
``` ```
--download Check by downloading rather than with hash. --download Check by downloading rather than with hash.
@ -44,7 +44,7 @@ rclone check source:path dest:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_cleanup.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone cleanup" title: "rclone cleanup"
description: "Clean up the remote if possible" description: "Clean up the remote if possible"
slug: rclone_cleanup slug: rclone_cleanup
url: /commands/rclone_cleanup/ url: /commands/rclone_cleanup/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/cleanup/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/cleanup/ and as part of making a release run "make commanddocs"
--- ---
## rclone cleanup # rclone cleanup
Clean up the remote if possible Clean up the remote if possible
### Synopsis ## Synopsis
Clean up the remote if possible. Empty the trash or delete old file Clean up the remote if possible. Empty the trash or delete old file
@ -21,7 +21,7 @@ versions. Not supported by all remotes.
rclone cleanup remote:path [flags] rclone cleanup remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for cleanup -h, --help help for cleanup
@ -29,7 +29,7 @@ rclone cleanup remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_config.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config" title: "rclone config"
description: "Enter an interactive configuration session." description: "Enter an interactive configuration session."
slug: rclone_config slug: rclone_config
url: /commands/rclone_config/ url: /commands/rclone_config/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/ and as part of making a release run "make commanddocs"
--- ---
## rclone config # rclone config
Enter an interactive configuration session. Enter an interactive configuration session.
### Synopsis ## Synopsis
Enter an interactive configuration session where you can setup new Enter an interactive configuration session where you can setup new
remotes and manage existing ones. You may also set or remove a remotes and manage existing ones. You may also set or remove a
@ -21,7 +21,7 @@ password to protect your configuration.
rclone config [flags] rclone config [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for config -h, --help help for config
@ -29,7 +29,7 @@ rclone config [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
* [rclone config create](/commands/rclone_config_create/) - Create a new remote with name, type and options. * [rclone config create](/commands/rclone_config_create/) - Create a new remote with name, type and options.

10
docs/content/commands/rclone_config_create.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config create" title: "rclone config create"
description: "Create a new remote with name, type and options." description: "Create a new remote with name, type and options."
slug: rclone_config_create slug: rclone_config_create
url: /commands/rclone_config_create/ url: /commands/rclone_config_create/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/create/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/create/ and as part of making a release run "make commanddocs"
--- ---
## rclone config create # rclone config create
Create a new remote with name, type and options. Create a new remote with name, type and options.
### Synopsis ## Synopsis
Create a new remote of <name> with <type> and options. The options Create a new remote of <name> with <type> and options. The options
@ -48,7 +48,7 @@ using remote authorization you would do this:
rclone config create <name> <type> [<key> <value>]* [flags] rclone config create <name> <type> [<key> <value>]* [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for create -h, --help help for create
@ -58,7 +58,7 @@ rclone config create <name> <type> [<key> <value>]* [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_delete.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config delete" title: "rclone config delete"
description: "Delete an existing remote <name>." description: "Delete an existing remote <name>."
slug: rclone_config_delete slug: rclone_config_delete
url: /commands/rclone_config_delete/ url: /commands/rclone_config_delete/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/delete/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/delete/ and as part of making a release run "make commanddocs"
--- ---
## rclone config delete # rclone config delete
Delete an existing remote <name>. Delete an existing remote <name>.
### Synopsis ## Synopsis
Delete an existing remote <name>. Delete an existing remote <name>.
@ -18,7 +18,7 @@ Delete an existing remote <name>.
rclone config delete <name> [flags] rclone config delete <name> [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for delete -h, --help help for delete
@ -26,7 +26,7 @@ rclone config delete <name> [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_disconnect.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config disconnect" title: "rclone config disconnect"
description: "Disconnects user from remote" description: "Disconnects user from remote"
slug: rclone_config_disconnect slug: rclone_config_disconnect
url: /commands/rclone_config_disconnect/ url: /commands/rclone_config_disconnect/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/disconnect/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/disconnect/ and as part of making a release run "make commanddocs"
--- ---
## rclone config disconnect # rclone config disconnect
Disconnects user from remote Disconnects user from remote
### Synopsis ## Synopsis
This disconnects the remote: passed in to the cloud storage system. This disconnects the remote: passed in to the cloud storage system.
@ -24,7 +24,7 @@ To reconnect use "rclone config reconnect".
rclone config disconnect remote: [flags] rclone config disconnect remote: [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for disconnect -h, --help help for disconnect
@ -32,7 +32,7 @@ rclone config disconnect remote: [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_dump.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config dump" title: "rclone config dump"
description: "Dump the config file as JSON." description: "Dump the config file as JSON."
slug: rclone_config_dump slug: rclone_config_dump
url: /commands/rclone_config_dump/ url: /commands/rclone_config_dump/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/dump/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/dump/ and as part of making a release run "make commanddocs"
--- ---
## rclone config dump # rclone config dump
Dump the config file as JSON. Dump the config file as JSON.
### Synopsis ## Synopsis
Dump the config file as JSON. Dump the config file as JSON.
@ -18,7 +18,7 @@ Dump the config file as JSON.
rclone config dump [flags] rclone config dump [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for dump -h, --help help for dump
@ -26,7 +26,7 @@ rclone config dump [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_edit.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config edit" title: "rclone config edit"
description: "Enter an interactive configuration session." description: "Enter an interactive configuration session."
slug: rclone_config_edit slug: rclone_config_edit
url: /commands/rclone_config_edit/ url: /commands/rclone_config_edit/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/edit/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/edit/ and as part of making a release run "make commanddocs"
--- ---
## rclone config edit # rclone config edit
Enter an interactive configuration session. Enter an interactive configuration session.
### Synopsis ## Synopsis
Enter an interactive configuration session where you can setup new Enter an interactive configuration session where you can setup new
remotes and manage existing ones. You may also set or remove a remotes and manage existing ones. You may also set or remove a
@ -21,7 +21,7 @@ password to protect your configuration.
rclone config edit [flags] rclone config edit [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for edit -h, --help help for edit
@ -29,7 +29,7 @@ rclone config edit [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_file.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config file" title: "rclone config file"
description: "Show path of configuration file in use." description: "Show path of configuration file in use."
slug: rclone_config_file slug: rclone_config_file
url: /commands/rclone_config_file/ url: /commands/rclone_config_file/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/file/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/file/ and as part of making a release run "make commanddocs"
--- ---
## rclone config file # rclone config file
Show path of configuration file in use. Show path of configuration file in use.
### Synopsis ## Synopsis
Show path of configuration file in use. Show path of configuration file in use.
@ -18,7 +18,7 @@ Show path of configuration file in use.
rclone config file [flags] rclone config file [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for file -h, --help help for file
@ -26,7 +26,7 @@ rclone config file [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_password.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config password" title: "rclone config password"
description: "Update password in an existing remote." description: "Update password in an existing remote."
slug: rclone_config_password slug: rclone_config_password
url: /commands/rclone_config_password/ url: /commands/rclone_config_password/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/password/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/password/ and as part of making a release run "make commanddocs"
--- ---
## rclone config password # rclone config password
Update password in an existing remote. Update password in an existing remote.
### Synopsis ## Synopsis
Update an existing remote's password. The password Update an existing remote's password. The password
@ -28,7 +28,7 @@ both support obscuring passwords directly.
rclone config password <name> [<key> <value>]+ [flags] rclone config password <name> [<key> <value>]+ [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for password -h, --help help for password
@ -36,7 +36,7 @@ rclone config password <name> [<key> <value>]+ [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_providers.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config providers" title: "rclone config providers"
description: "List in JSON format all the providers and options." description: "List in JSON format all the providers and options."
slug: rclone_config_providers slug: rclone_config_providers
url: /commands/rclone_config_providers/ url: /commands/rclone_config_providers/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/providers/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/providers/ and as part of making a release run "make commanddocs"
--- ---
## rclone config providers # rclone config providers
List in JSON format all the providers and options. List in JSON format all the providers and options.
### Synopsis ## Synopsis
List in JSON format all the providers and options. List in JSON format all the providers and options.
@ -18,7 +18,7 @@ List in JSON format all the providers and options.
rclone config providers [flags] rclone config providers [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for providers -h, --help help for providers
@ -26,7 +26,7 @@ rclone config providers [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_reconnect.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config reconnect" title: "rclone config reconnect"
description: "Re-authenticates user with remote." description: "Re-authenticates user with remote."
slug: rclone_config_reconnect slug: rclone_config_reconnect
url: /commands/rclone_config_reconnect/ url: /commands/rclone_config_reconnect/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/reconnect/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/reconnect/ and as part of making a release run "make commanddocs"
--- ---
## rclone config reconnect # rclone config reconnect
Re-authenticates user with remote. Re-authenticates user with remote.
### Synopsis ## Synopsis
This reconnects remote: passed in to the cloud storage system. This reconnects remote: passed in to the cloud storage system.
@ -24,7 +24,7 @@ This normally means going through the interactive oauth flow again.
rclone config reconnect remote: [flags] rclone config reconnect remote: [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for reconnect -h, --help help for reconnect
@ -32,7 +32,7 @@ rclone config reconnect remote: [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_show.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config show" title: "rclone config show"
description: "Print (decrypted) config file, or the config for a single remote." description: "Print (decrypted) config file, or the config for a single remote."
slug: rclone_config_show slug: rclone_config_show
url: /commands/rclone_config_show/ url: /commands/rclone_config_show/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/show/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/show/ and as part of making a release run "make commanddocs"
--- ---
## rclone config show # rclone config show
Print (decrypted) config file, or the config for a single remote. Print (decrypted) config file, or the config for a single remote.
### Synopsis ## Synopsis
Print (decrypted) config file, or the config for a single remote. Print (decrypted) config file, or the config for a single remote.
@ -18,7 +18,7 @@ Print (decrypted) config file, or the config for a single remote.
rclone config show [<remote>] [flags] rclone config show [<remote>] [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for show -h, --help help for show
@ -26,7 +26,7 @@ rclone config show [<remote>] [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_update.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config update" title: "rclone config update"
description: "Update options in an existing remote." description: "Update options in an existing remote."
slug: rclone_config_update slug: rclone_config_update
url: /commands/rclone_config_update/ url: /commands/rclone_config_update/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/update/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/update/ and as part of making a release run "make commanddocs"
--- ---
## rclone config update # rclone config update
Update options in an existing remote. Update options in an existing remote.
### Synopsis ## Synopsis
Update an existing remote's options. The options should be passed in Update an existing remote's options. The options should be passed in
@ -44,7 +44,7 @@ require this add an extra parameter thus:
rclone config update <name> [<key> <value>]+ [flags] rclone config update <name> [<key> <value>]+ [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for update -h, --help help for update
@ -54,7 +54,7 @@ rclone config update <name> [<key> <value>]+ [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_config_userinfo.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone config userinfo" title: "rclone config userinfo"
description: "Prints info about logged in user of remote." description: "Prints info about logged in user of remote."
slug: rclone_config_userinfo slug: rclone_config_userinfo
url: /commands/rclone_config_userinfo/ url: /commands/rclone_config_userinfo/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/userinfo/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/userinfo/ and as part of making a release run "make commanddocs"
--- ---
## rclone config userinfo # rclone config userinfo
Prints info about logged in user of remote. Prints info about logged in user of remote.
### Synopsis ## Synopsis
This prints the details of the person logged in to the cloud storage This prints the details of the person logged in to the cloud storage
@ -21,7 +21,7 @@ system.
rclone config userinfo remote: [flags] rclone config userinfo remote: [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for userinfo -h, --help help for userinfo
@ -30,7 +30,7 @@ rclone config userinfo remote: [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.

10
docs/content/commands/rclone_copy.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone copy" title: "rclone copy"
description: "Copy files from source to dest, skipping already copied" description: "Copy files from source to dest, skipping already copied"
slug: rclone_copy slug: rclone_copy
url: /commands/rclone_copy/ url: /commands/rclone_copy/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/copy/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/copy/ and as part of making a release run "make commanddocs"
--- ---
## rclone copy # rclone copy
Copy files from source to dest, skipping already copied Copy files from source to dest, skipping already copied
### Synopsis ## Synopsis
Copy the source to the destination. Doesn't transfer Copy the source to the destination. Doesn't transfer
@ -67,7 +67,7 @@ recently very efficiently like this:
rclone copy source:path dest:path [flags] rclone copy source:path dest:path [flags]
``` ```
### Options ## Options
``` ```
--create-empty-src-dirs Create empty source dirs on destination after copy --create-empty-src-dirs Create empty source dirs on destination after copy
@ -76,7 +76,7 @@ rclone copy source:path dest:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_copyto.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone copyto" title: "rclone copyto"
description: "Copy files from source to dest, skipping already copied" description: "Copy files from source to dest, skipping already copied"
slug: rclone_copyto slug: rclone_copyto
url: /commands/rclone_copyto/ url: /commands/rclone_copyto/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/copyto/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/copyto/ and as part of making a release run "make commanddocs"
--- ---
## rclone copyto # rclone copyto
Copy files from source to dest, skipping already copied Copy files from source to dest, skipping already copied
### Synopsis ## Synopsis
If source:path is a file or directory then it copies it to a file or If source:path is a file or directory then it copies it to a file or
@ -46,7 +46,7 @@ destination.
rclone copyto source:path dest:path [flags] rclone copyto source:path dest:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for copyto -h, --help help for copyto
@ -54,7 +54,7 @@ rclone copyto source:path dest:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_copyurl.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone copyurl" title: "rclone copyurl"
description: "Copy url content to dest." description: "Copy url content to dest."
slug: rclone_copyurl slug: rclone_copyurl
url: /commands/rclone_copyurl/ url: /commands/rclone_copyurl/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/copyurl/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/copyurl/ and as part of making a release run "make commanddocs"
--- ---
## rclone copyurl # rclone copyurl
Copy url content to dest. Copy url content to dest.
### Synopsis ## Synopsis
Download a URL's content and copy it to the destination without saving Download a URL's content and copy it to the destination without saving
@ -31,7 +31,7 @@ output to be written to standard output.
rclone copyurl https://example.com dest:path [flags] rclone copyurl https://example.com dest:path [flags]
``` ```
### Options ## Options
``` ```
-a, --auto-filename Get the file name from the URL and use it for destination file path -a, --auto-filename Get the file name from the URL and use it for destination file path
@ -42,7 +42,7 @@ rclone copyurl https://example.com dest:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_cryptcheck.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone cryptcheck" title: "rclone cryptcheck"
description: "Cryptcheck checks the integrity of a crypted remote." description: "Cryptcheck checks the integrity of a crypted remote."
slug: rclone_cryptcheck slug: rclone_cryptcheck
url: /commands/rclone_cryptcheck/ url: /commands/rclone_cryptcheck/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/cryptcheck/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/cryptcheck/ and as part of making a release run "make commanddocs"
--- ---
## rclone cryptcheck # rclone cryptcheck
Cryptcheck checks the integrity of a crypted remote. Cryptcheck checks the integrity of a crypted remote.
### Synopsis ## Synopsis
rclone cryptcheck checks a remote against a crypted remote. This is rclone cryptcheck checks a remote against a crypted remote. This is
@ -45,7 +45,7 @@ destination that are not in the source will not trigger an error.
rclone cryptcheck remote:path cryptedremote:path [flags] rclone cryptcheck remote:path cryptedremote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for cryptcheck -h, --help help for cryptcheck
@ -54,7 +54,7 @@ rclone cryptcheck remote:path cryptedremote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_cryptdecode.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone cryptdecode" title: "rclone cryptdecode"
description: "Cryptdecode returns unencrypted file names." description: "Cryptdecode returns unencrypted file names."
slug: rclone_cryptdecode slug: rclone_cryptdecode
url: /commands/rclone_cryptdecode/ url: /commands/rclone_cryptdecode/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/cryptdecode/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/cryptdecode/ and as part of making a release run "make commanddocs"
--- ---
## rclone cryptdecode # rclone cryptdecode
Cryptdecode returns unencrypted file names. Cryptdecode returns unencrypted file names.
### Synopsis ## Synopsis
rclone cryptdecode returns unencrypted file names when provided with rclone cryptdecode returns unencrypted file names when provided with
@ -29,7 +29,7 @@ use it like this
rclone cryptdecode encryptedremote: encryptedfilename [flags] rclone cryptdecode encryptedremote: encryptedfilename [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for cryptdecode -h, --help help for cryptdecode
@ -38,7 +38,7 @@ rclone cryptdecode encryptedremote: encryptedfilename [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_dedupe.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone dedupe" title: "rclone dedupe"
description: "Interactively find duplicate files and delete/rename them." description: "Interactively find duplicate files and delete/rename them."
slug: rclone_dedupe slug: rclone_dedupe
url: /commands/rclone_dedupe/ url: /commands/rclone_dedupe/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/dedupe/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/dedupe/ and as part of making a release run "make commanddocs"
--- ---
## rclone dedupe # rclone dedupe
Interactively find duplicate files and delete/rename them. Interactively find duplicate files and delete/rename them.
### Synopsis ## Synopsis
By default `dedupe` interactively finds duplicate files and offers to By default `dedupe` interactively finds duplicate files and offers to
@ -99,7 +99,7 @@ Or
rclone dedupe [mode] remote:path [flags] rclone dedupe [mode] remote:path [flags]
``` ```
### Options ## Options
``` ```
--dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default "interactive") --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default "interactive")
@ -108,7 +108,7 @@ rclone dedupe [mode] remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_delete.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone delete" title: "rclone delete"
description: "Remove the contents of path." description: "Remove the contents of path."
slug: rclone_delete slug: rclone_delete
url: /commands/rclone_delete/ url: /commands/rclone_delete/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/delete/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/delete/ and as part of making a release run "make commanddocs"
--- ---
## rclone delete # rclone delete
Remove the contents of path. Remove the contents of path.
### Synopsis ## Synopsis
Remove the files in path. Unlike `purge` it obeys include/exclude Remove the files in path. Unlike `purge` it obeys include/exclude
@ -41,7 +41,7 @@ delete all files bigger than 100MBytes.
rclone delete remote:path [flags] rclone delete remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for delete -h, --help help for delete
@ -50,7 +50,7 @@ rclone delete remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_deletefile.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone deletefile" title: "rclone deletefile"
description: "Remove a single file from remote." description: "Remove a single file from remote."
slug: rclone_deletefile slug: rclone_deletefile
url: /commands/rclone_deletefile/ url: /commands/rclone_deletefile/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/deletefile/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/deletefile/ and as part of making a release run "make commanddocs"
--- ---
## rclone deletefile # rclone deletefile
Remove a single file from remote. Remove a single file from remote.
### Synopsis ## Synopsis
Remove a single file from remote. Unlike `delete` it cannot be used to Remove a single file from remote. Unlike `delete` it cannot be used to
@ -22,7 +22,7 @@ it will always be removed.
rclone deletefile remote:path [flags] rclone deletefile remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for deletefile -h, --help help for deletefile
@ -30,7 +30,7 @@ rclone deletefile remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_genautocomplete.md
View File

@ -1,23 +1,23 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone genautocomplete" title: "rclone genautocomplete"
description: "Output completion script for a given shell." description: "Output completion script for a given shell."
slug: rclone_genautocomplete slug: rclone_genautocomplete
url: /commands/rclone_genautocomplete/ url: /commands/rclone_genautocomplete/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/ and as part of making a release run "make commanddocs"
--- ---
## rclone genautocomplete # rclone genautocomplete
Output completion script for a given shell. Output completion script for a given shell.
### Synopsis ## Synopsis
Generates a shell completion script for rclone. Generates a shell completion script for rclone.
Run with --help to list the supported shells. Run with --help to list the supported shells.
### Options ## Options
``` ```
-h, --help help for genautocomplete -h, --help help for genautocomplete
@ -25,7 +25,7 @@ Run with --help to list the supported shells.
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
* [rclone genautocomplete bash](/commands/rclone_genautocomplete_bash/) - Output bash completion script for rclone. * [rclone genautocomplete bash](/commands/rclone_genautocomplete_bash/) - Output bash completion script for rclone.

10
docs/content/commands/rclone_genautocomplete_bash.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone genautocomplete bash" title: "rclone genautocomplete bash"
description: "Output bash completion script for rclone." description: "Output bash completion script for rclone."
slug: rclone_genautocomplete_bash slug: rclone_genautocomplete_bash
url: /commands/rclone_genautocomplete_bash/ url: /commands/rclone_genautocomplete_bash/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/bash/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/bash/ and as part of making a release run "make commanddocs"
--- ---
## rclone genautocomplete bash # rclone genautocomplete bash
Output bash completion script for rclone. Output bash completion script for rclone.
### Synopsis ## Synopsis
Generates a bash shell autocompletion script for rclone. Generates a bash shell autocompletion script for rclone.
@ -33,7 +33,7 @@ there.
rclone genautocomplete bash [output_file] [flags] rclone genautocomplete bash [output_file] [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for bash -h, --help help for bash
@ -41,7 +41,7 @@ rclone genautocomplete bash [output_file] [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell.

10
docs/content/commands/rclone_genautocomplete_fish.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone genautocomplete fish" title: "rclone genautocomplete fish"
description: "Output fish completion script for rclone." description: "Output fish completion script for rclone."
slug: rclone_genautocomplete_fish slug: rclone_genautocomplete_fish
url: /commands/rclone_genautocomplete_fish/ url: /commands/rclone_genautocomplete_fish/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/fish/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/fish/ and as part of making a release run "make commanddocs"
--- ---
## rclone genautocomplete fish # rclone genautocomplete fish
Output fish completion script for rclone. Output fish completion script for rclone.
### Synopsis ## Synopsis
Generates a fish autocompletion script for rclone. Generates a fish autocompletion script for rclone.
@ -33,7 +33,7 @@ there.
rclone genautocomplete fish [output_file] [flags] rclone genautocomplete fish [output_file] [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for fish -h, --help help for fish
@ -41,7 +41,7 @@ rclone genautocomplete fish [output_file] [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell.

10
docs/content/commands/rclone_genautocomplete_zsh.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone genautocomplete zsh" title: "rclone genautocomplete zsh"
description: "Output zsh completion script for rclone." description: "Output zsh completion script for rclone."
slug: rclone_genautocomplete_zsh slug: rclone_genautocomplete_zsh
url: /commands/rclone_genautocomplete_zsh/ url: /commands/rclone_genautocomplete_zsh/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/zsh/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/genautocomplete/zsh/ and as part of making a release run "make commanddocs"
--- ---
## rclone genautocomplete zsh # rclone genautocomplete zsh
Output zsh completion script for rclone. Output zsh completion script for rclone.
### Synopsis ## Synopsis
Generates a zsh autocompletion script for rclone. Generates a zsh autocompletion script for rclone.
@ -33,7 +33,7 @@ there.
rclone genautocomplete zsh [output_file] [flags] rclone genautocomplete zsh [output_file] [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for zsh -h, --help help for zsh
@ -41,7 +41,7 @@ rclone genautocomplete zsh [output_file] [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell.

10
docs/content/commands/rclone_gendocs.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone gendocs" title: "rclone gendocs"
description: "Output markdown docs for rclone to the directory supplied." description: "Output markdown docs for rclone to the directory supplied."
slug: rclone_gendocs slug: rclone_gendocs
url: /commands/rclone_gendocs/ url: /commands/rclone_gendocs/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/gendocs/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/gendocs/ and as part of making a release run "make commanddocs"
--- ---
## rclone gendocs # rclone gendocs
Output markdown docs for rclone to the directory supplied. Output markdown docs for rclone to the directory supplied.
### Synopsis ## Synopsis
This produces markdown docs for the rclone commands to the directory This produces markdown docs for the rclone commands to the directory
@ -21,7 +21,7 @@ rclone.org website.
rclone gendocs output_directory [flags] rclone gendocs output_directory [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for gendocs -h, --help help for gendocs
@ -29,7 +29,7 @@ rclone gendocs output_directory [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

14
docs/content/commands/rclone_hashsum.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone hashsum" title: "rclone hashsum"
description: "Produces an hashsum file for all the objects in the path." description: "Produces a hashsum file for all the objects in the path."
slug: rclone_hashsum slug: rclone_hashsum
url: /commands/rclone_hashsum/ url: /commands/rclone_hashsum/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/hashsum/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/hashsum/ and as part of making a release run "make commanddocs"
--- ---
## rclone hashsum # rclone hashsum
Produces an hashsum file for all the objects in the path. Produces a hashsum file for all the objects in the path.
### Synopsis ## Synopsis
Produces a hash file for all the objects in the path using the hash Produces a hash file for all the objects in the path using the hash
@ -35,7 +35,7 @@ Then
rclone hashsum <hash> remote:path [flags] rclone hashsum <hash> remote:path [flags]
``` ```
### Options ## Options
``` ```
--base64 Output base64 encoded hashsum --base64 Output base64 encoded hashsum
@ -44,7 +44,7 @@ rclone hashsum <hash> remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_link.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone link" title: "rclone link"
description: "Generate public link to file/folder." description: "Generate public link to file/folder."
slug: rclone_link slug: rclone_link
url: /commands/rclone_link/ url: /commands/rclone_link/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/link/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/link/ and as part of making a release run "make commanddocs"
--- ---
## rclone link # rclone link
Generate public link to file/folder. Generate public link to file/folder.
### Synopsis ## Synopsis
rclone link will create or retrieve a public link to the given file or folder. rclone link will create or retrieve a public link to the given file or folder.
@ -28,7 +28,7 @@ without account.
rclone link remote:path [flags] rclone link remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for link -h, --help help for link
@ -36,7 +36,7 @@ rclone link remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_listremotes.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone listremotes" title: "rclone listremotes"
description: "List all the remotes in the config file." description: "List all the remotes in the config file."
slug: rclone_listremotes slug: rclone_listremotes
url: /commands/rclone_listremotes/ url: /commands/rclone_listremotes/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/listremotes/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/listremotes/ and as part of making a release run "make commanddocs"
--- ---
## rclone listremotes # rclone listremotes
List all the remotes in the config file. List all the remotes in the config file.
### Synopsis ## Synopsis
rclone listremotes lists all the available remotes from the config file. rclone listremotes lists all the available remotes from the config file.
@ -22,7 +22,7 @@ When uses with the -l flag it lists the types too.
rclone listremotes [flags] rclone listremotes [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for listremotes -h, --help help for listremotes
@ -31,7 +31,7 @@ rclone listremotes [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_ls.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone ls" title: "rclone ls"
description: "List the objects in the path with size and path." description: "List the objects in the path with size and path."
slug: rclone_ls slug: rclone_ls
url: /commands/rclone_ls/ url: /commands/rclone_ls/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/ls/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/ls/ and as part of making a release run "make commanddocs"
--- ---
## rclone ls # rclone ls
List the objects in the path with size and path. List the objects in the path with size and path.
### Synopsis ## Synopsis
Lists the objects in the source path to standard output in a human Lists the objects in the source path to standard output in a human
@ -52,7 +52,7 @@ the bucket based remotes).
rclone ls remote:path [flags] rclone ls remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for ls -h, --help help for ls
@ -60,7 +60,7 @@ rclone ls remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_lsd.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone lsd" title: "rclone lsd"
description: "List all directories/containers/buckets in the path." description: "List all directories/containers/buckets in the path."
slug: rclone_lsd slug: rclone_lsd
url: /commands/rclone_lsd/ url: /commands/rclone_lsd/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsd/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsd/ and as part of making a release run "make commanddocs"
--- ---
## rclone lsd # rclone lsd
List all directories/containers/buckets in the path. List all directories/containers/buckets in the path.
### Synopsis ## Synopsis
Lists the directories in the source path to standard output. Does not Lists the directories in the source path to standard output. Does not
@ -62,7 +62,7 @@ the bucket based remotes).
rclone lsd remote:path [flags] rclone lsd remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for lsd -h, --help help for lsd
@ -71,7 +71,7 @@ rclone lsd remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_lsf.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone lsf" title: "rclone lsf"
description: "List directories and objects in remote:path formatted for parsing" description: "List directories and objects in remote:path formatted for parsing"
slug: rclone_lsf slug: rclone_lsf
url: /commands/rclone_lsf/ url: /commands/rclone_lsf/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsf/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsf/ and as part of making a release run "make commanddocs"
--- ---
## rclone lsf # rclone lsf
List directories and objects in remote:path formatted for parsing List directories and objects in remote:path formatted for parsing
### Synopsis ## Synopsis
List the contents of the source path (directories and objects) to List the contents of the source path (directories and objects) to
@ -135,7 +135,7 @@ the bucket based remotes).
rclone lsf remote:path [flags] rclone lsf remote:path [flags]
``` ```
### Options ## Options
``` ```
--absolute Put a leading / in front of path names. --absolute Put a leading / in front of path names.
@ -152,7 +152,7 @@ rclone lsf remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_lsjson.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone lsjson" title: "rclone lsjson"
description: "List directories and objects in the path in JSON format." description: "List directories and objects in the path in JSON format."
slug: rclone_lsjson slug: rclone_lsjson
url: /commands/rclone_lsjson/ url: /commands/rclone_lsjson/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsjson/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsjson/ and as part of making a release run "make commanddocs"
--- ---
## rclone lsjson # rclone lsjson
List directories and objects in the path in JSON format. List directories and objects in the path in JSON format.
### Synopsis ## Synopsis
List directories and objects in the path in JSON format. List directories and objects in the path in JSON format.
@ -103,7 +103,7 @@ the bucket based remotes).
rclone lsjson remote:path [flags] rclone lsjson remote:path [flags]
``` ```
### Options ## Options
``` ```
--dirs-only Show only directories in the listing. --dirs-only Show only directories in the listing.
@ -120,7 +120,7 @@ rclone lsjson remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_lsl.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone lsl" title: "rclone lsl"
description: "List the objects in path with modification time, size and path." description: "List the objects in path with modification time, size and path."
slug: rclone_lsl slug: rclone_lsl
url: /commands/rclone_lsl/ url: /commands/rclone_lsl/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsl/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsl/ and as part of making a release run "make commanddocs"
--- ---
## rclone lsl # rclone lsl
List the objects in path with modification time, size and path. List the objects in path with modification time, size and path.
### Synopsis ## Synopsis
Lists the objects in the source path to standard output in a human Lists the objects in the source path to standard output in a human
@ -52,7 +52,7 @@ the bucket based remotes).
rclone lsl remote:path [flags] rclone lsl remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for lsl -h, --help help for lsl
@ -60,7 +60,7 @@ rclone lsl remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_md5sum.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone md5sum" title: "rclone md5sum"
description: "Produces an md5sum file for all the objects in the path." description: "Produces an md5sum file for all the objects in the path."
slug: rclone_md5sum slug: rclone_md5sum
url: /commands/rclone_md5sum/ url: /commands/rclone_md5sum/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/md5sum/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/md5sum/ and as part of making a release run "make commanddocs"
--- ---
## rclone md5sum # rclone md5sum
Produces an md5sum file for all the objects in the path. Produces an md5sum file for all the objects in the path.
### Synopsis ## Synopsis
Produces an md5sum file for all the objects in the path. This Produces an md5sum file for all the objects in the path. This
@ -21,7 +21,7 @@ is in the same format as the standard md5sum tool produces.
rclone md5sum remote:path [flags] rclone md5sum remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for md5sum -h, --help help for md5sum
@ -29,7 +29,7 @@ rclone md5sum remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_mkdir.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone mkdir" title: "rclone mkdir"
description: "Make the path if it doesn't already exist." description: "Make the path if it doesn't already exist."
slug: rclone_mkdir slug: rclone_mkdir
url: /commands/rclone_mkdir/ url: /commands/rclone_mkdir/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/mkdir/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/mkdir/ and as part of making a release run "make commanddocs"
--- ---
## rclone mkdir # rclone mkdir
Make the path if it doesn't already exist. Make the path if it doesn't already exist.
### Synopsis ## Synopsis
Make the path if it doesn't already exist. Make the path if it doesn't already exist.
@ -18,7 +18,7 @@ Make the path if it doesn't already exist.
rclone mkdir remote:path [flags] rclone mkdir remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for mkdir -h, --help help for mkdir
@ -26,7 +26,7 @@ rclone mkdir remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

46
docs/content/commands/rclone_mount.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone mount" title: "rclone mount"
description: "Mount the remote as file system on a mountpoint." description: "Mount the remote as file system on a mountpoint."
slug: rclone_mount slug: rclone_mount
url: /commands/rclone_mount/ url: /commands/rclone_mount/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/mount/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/mount/ and as part of making a release run "make commanddocs"
--- ---
## rclone mount # rclone mount
Mount the remote as file system on a mountpoint. Mount the remote as file system on a mountpoint.
### Synopsis ## Synopsis
rclone mount allows Linux, FreeBSD, macOS and Windows to rclone mount allows Linux, FreeBSD, macOS and Windows to
@ -50,7 +50,7 @@ Stopping the mount manually:
# OS X # OS X
umount /path/to/local/mount umount /path/to/local/mount
### Installing on Windows ## Installing on Windows
To run rclone mount on Windows, you will need to To run rclone mount on Windows, you will need to
download and install [WinFsp](http://www.secfs.net/winfsp/). download and install [WinFsp](http://www.secfs.net/winfsp/).
@ -63,7 +63,7 @@ uses combination with
packages are by Bill Zissimopoulos who was very helpful during the packages are by Bill Zissimopoulos who was very helpful during the
implementation of rclone mount for Windows. implementation of rclone mount for Windows.
#### Windows caveats ### Windows caveats
Note that drives created as Administrator are not visible by other Note that drives created as Administrator are not visible by other
accounts (including the account that was elevated as accounts (including the account that was elevated as
@ -79,7 +79,7 @@ infrastructure](https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Archit
which creates drives accessible for everyone on the system or which creates drives accessible for everyone on the system or
alternatively using [the nssm service manager](https://nssm.cc/usage). alternatively using [the nssm service manager](https://nssm.cc/usage).
#### Mount as a network drive ### Mount as a network drive
By default, rclone will mount the remote as a normal drive. However, By default, rclone will mount the remote as a normal drive. However,
you can also mount it as a **Network Drive** (or **Network Share**, as you can also mount it as a **Network Drive** (or **Network Share**, as
@ -107,7 +107,7 @@ conflict and your mounted filesystems will overlap.
[Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping) [Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping)
### Limitations ## Limitations
Without the use of "--vfs-cache-mode" this can only write files Without the use of "--vfs-cache-mode" this can only write files
sequentially, it can only seek when reading. This means that many sequentially, it can only seek when reading. This means that many
@ -122,7 +122,7 @@ the directory cache.
Only supported on Linux, FreeBSD, OS X and Windows at the moment. Only supported on Linux, FreeBSD, OS X and Windows at the moment.
### rclone mount vs rclone sync/copy ## rclone mount vs rclone sync/copy
File systems expect things to be 100% reliable, whereas cloud storage File systems expect things to be 100% reliable, whereas cloud storage
systems are a long way from 100% reliable. The rclone sync/copy systems are a long way from 100% reliable. The rclone sync/copy
@ -131,7 +131,7 @@ can't use retries in the same way without making local copies of the
uploads. Look at the [file caching](#file-caching) uploads. Look at the [file caching](#file-caching)
for solutions to make mount more reliable. for solutions to make mount more reliable.
### Attribute caching ## Attribute caching
You can use the flag --attr-timeout to set the time the kernel caches You can use the flag --attr-timeout to set the time the kernel caches
the attributes (size, modification time etc) for directory entries. the attributes (size, modification time etc) for directory entries.
@ -163,12 +163,12 @@ then there is no chance of corruption.
This is the same as setting the attr_timeout option in mount.fuse. This is the same as setting the attr_timeout option in mount.fuse.
### Filters ## Filters
Note that all the rclone filters can be used to select a subset of the Note that all the rclone filters can be used to select a subset of the
files to be visible in the mount. files to be visible in the mount.
### systemd ## systemd
When running rclone mount as a systemd service, it is possible When running rclone mount as a systemd service, it is possible
to use Type=notify. In this case the service will enter the started state to use Type=notify. In this case the service will enter the started state
@ -176,7 +176,7 @@ after the mountpoint has been successfully set up.
Units having the rclone mount service specified as a requirement Units having the rclone mount service specified as a requirement
will see all files and folders immediately in this mode. will see all files and folders immediately in this mode.
### chunked reading ### ## chunked reading ###
--vfs-read-chunk-size will enable reading the source objects in parts. --vfs-read-chunk-size will enable reading the source objects in parts.
This can reduce the used download quota for some remotes by requesting only chunks This can reduce the used download quota for some remotes by requesting only chunks
@ -195,7 +195,7 @@ When --vfs-read-chunk-size-limit 500M is specified, the result would be
Chunked reading will only work with --vfs-cache-mode < full, as the file will always Chunked reading will only work with --vfs-cache-mode < full, as the file will always
be copied to the vfs cache before opening with --vfs-cache-mode full. be copied to the vfs cache before opening with --vfs-cache-mode full.
### Directory Cache ## Directory Cache
Using the `--dir-cache-time` flag, you can set how long a Using the `--dir-cache-time` flag, you can set how long a
directory should be considered up to date and not refreshed from the directory should be considered up to date and not refreshed from the
@ -221,7 +221,7 @@ Or individual files or directories:
rclone rc vfs/forget file=path/to/file dir=path/to/dir 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, The `--buffer-size` flag determines the amount of memory,
that will be used to buffer data in advance. that will be used to buffer data in advance.
@ -238,7 +238,7 @@ will be used.
The maximum memory used by rclone for buffering can be up to The maximum memory used by rclone for buffering can be up to
`--buffer-size * open files`. `--buffer-size * open files`.
### File Caching ## File Caching
These flags control the VFS file caching options. The VFS layer is 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 used by rclone mount to make a cloud storage system work more like a
@ -275,7 +275,7 @@ for two reasons. Firstly because it is only checked every
--vfs-cache-poll-interval. Secondly because open files cannot be --vfs-cache-poll-interval. Secondly because open files cannot be
evicted from the cache. 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 In this mode the cache will read directly from the remote and write
directly to the remote without caching anything on disk. directly to the remote without caching anything on disk.
@ -290,7 +290,7 @@ This will mean some operations are not possible
* Open modes O_APPEND, O_TRUNC are ignored * Open modes O_APPEND, O_TRUNC are ignored
* If an upload fails it can't be retried * 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 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 write will be buffered to disks. This means that files opened for
@ -303,7 +303,7 @@ These operations are not possible
* Files opened for write only will ignore O_APPEND, O_TRUNC * Files opened for write only will ignore O_APPEND, O_TRUNC
* If an upload fails it can't be retried * 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 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 the remote, write only and read/write files are buffered to disk
@ -313,7 +313,7 @@ This mode should support all normal file system operations.
If an upload fails it will be retried up to --low-level-retries times. 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 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. a file is opened for read it will be downloaded in its entirety first.
@ -331,7 +331,7 @@ This mode should support all normal file system operations.
If an upload or download fails it will be retried up to If an upload or download fails it will be retried up to
--low-level-retries times. --low-level-retries times.
### Case Sensitivity ## Case Sensitivity
Linux file systems are case-sensitive: two files can differ only Linux file systems are case-sensitive: two files can differ only
by case, and the exact case must be used when opening a file. by case, and the exact case must be used when opening a file.
@ -372,7 +372,7 @@ otherwise. If the flag is provided without a value, then it is "true".
rclone mount remote:path /path/to/mountpoint [flags] rclone mount remote:path /path/to/mountpoint [flags]
``` ```
### Options ## Options
``` ```
--allow-non-empty Allow mounting over a non-empty directory (not Windows). --allow-non-empty Allow mounting over a non-empty directory (not Windows).
@ -406,7 +406,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
--vfs-case-insensitive If a file name not found, find a case insensitive match. --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 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-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) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s)
--volname string Set the volume name (not supported by all OSes). --volname string Set the volume name (not supported by all OSes).
--write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used.
@ -414,7 +414,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

12
docs/content/commands/rclone_move.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone move" title: "rclone move"
description: "Move files from source to dest." description: "Move files from source to dest."
slug: rclone_move slug: rclone_move
url: /commands/rclone_move/ url: /commands/rclone_move/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/move/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/move/ and as part of making a release run "make commanddocs"
--- ---
## rclone move # rclone move
Move files from source to dest. Move files from source to dest.
### Synopsis ## Synopsis
Moves the contents of the source directory to the destination Moves the contents of the source directory to the destination
@ -19,7 +19,7 @@ the remote does not support a server side directory move operation.
If no filters are in use and if possible this will server side move If no filters are in use and if possible this will server side move
`source:path` into `dest:path`. After this `source:path` will no `source:path` into `dest:path`. After this `source:path` will no
longer longer exist. longer exist.
Otherwise for each file in `source:path` selected by the filters (if Otherwise for each file in `source:path` selected by the filters (if
any) this will move it into `dest:path`. If possible a server side any) this will move it into `dest:path`. If possible a server side
@ -44,7 +44,7 @@ can speed transfers up greatly.
rclone move source:path dest:path [flags] rclone move source:path dest:path [flags]
``` ```
### Options ## Options
``` ```
--create-empty-src-dirs Create empty source dirs on destination after move --create-empty-src-dirs Create empty source dirs on destination after move
@ -54,7 +54,7 @@ rclone move source:path dest:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_moveto.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone moveto" title: "rclone moveto"
description: "Move file or directory from source to dest." description: "Move file or directory from source to dest."
slug: rclone_moveto slug: rclone_moveto
url: /commands/rclone_moveto/ url: /commands/rclone_moveto/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/moveto/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/moveto/ and as part of making a release run "make commanddocs"
--- ---
## rclone moveto # rclone moveto
Move file or directory from source to dest. Move file or directory from source to dest.
### Synopsis ## Synopsis
If source:path is a file or directory then it moves it to a file or If source:path is a file or directory then it moves it to a file or
@ -49,7 +49,7 @@ transfer.
rclone moveto source:path dest:path [flags] rclone moveto source:path dest:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for moveto -h, --help help for moveto
@ -57,7 +57,7 @@ rclone moveto source:path dest:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_ncdu.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone ncdu" title: "rclone ncdu"
description: "Explore a remote with a text based user interface." description: "Explore a remote with a text based user interface."
slug: rclone_ncdu slug: rclone_ncdu
url: /commands/rclone_ncdu/ url: /commands/rclone_ncdu/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/ncdu/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/ncdu/ and as part of making a release run "make commanddocs"
--- ---
## rclone ncdu # rclone ncdu
Explore a remote with a text based user interface. Explore a remote with a text based user interface.
### Synopsis ## Synopsis
This displays a text based user interface allowing the navigation of a This displays a text based user interface allowing the navigation of a
@ -51,7 +51,7 @@ UI won't respond in the meantime since the deletion is done synchronously.
rclone ncdu remote:path [flags] rclone ncdu remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for ncdu -h, --help help for ncdu
@ -59,7 +59,7 @@ rclone ncdu remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_obscure.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone obscure" title: "rclone obscure"
description: "Obscure password for use in the rclone.conf" description: "Obscure password for use in the rclone.conf"
slug: rclone_obscure slug: rclone_obscure
url: /commands/rclone_obscure/ url: /commands/rclone_obscure/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/obscure/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/obscure/ and as part of making a release run "make commanddocs"
--- ---
## rclone obscure # rclone obscure
Obscure password for use in the rclone.conf Obscure password for use in the rclone.conf
### Synopsis ## Synopsis
Obscure password for use in the rclone.conf Obscure password for use in the rclone.conf
@ -18,7 +18,7 @@ Obscure password for use in the rclone.conf
rclone obscure password [flags] rclone obscure password [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for obscure -h, --help help for obscure
@ -26,7 +26,7 @@ rclone obscure password [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_purge.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone purge" title: "rclone purge"
description: "Remove the path and all of its contents." description: "Remove the path and all of its contents."
slug: rclone_purge slug: rclone_purge
url: /commands/rclone_purge/ url: /commands/rclone_purge/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/purge/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/purge/ and as part of making a release run "make commanddocs"
--- ---
## rclone purge # rclone purge
Remove the path and all of its contents. Remove the path and all of its contents.
### Synopsis ## Synopsis
Remove the path and all of its contents. Note that this does not obey Remove the path and all of its contents. Note that this does not obey
@ -22,7 +22,7 @@ you want to selectively delete files.
rclone purge remote:path [flags] rclone purge remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for purge -h, --help help for purge
@ -30,7 +30,7 @@ rclone purge remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_rc.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone rc" title: "rclone rc"
description: "Run a command against a running rclone." description: "Run a command against a running rclone."
slug: rclone_rc slug: rclone_rc
url: /commands/rclone_rc/ url: /commands/rclone_rc/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/rc/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/rc/ and as part of making a release run "make commanddocs"
--- ---
## rclone rc # rclone rc
Run a command against a running rclone. Run a command against a running rclone.
### Synopsis ## Synopsis
@ -67,7 +67,7 @@ Use "rclone rc" to see a list of all possible commands.
rclone rc commands parameter [flags] rclone rc commands parameter [flags]
``` ```
### Options ## Options
``` ```
-a, --arg stringArray Argument placed in the "arg" array. -a, --arg stringArray Argument placed in the "arg" array.
@ -83,7 +83,7 @@ rclone rc commands parameter [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_rcat.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone rcat" title: "rclone rcat"
description: "Copies standard input to file on remote." description: "Copies standard input to file on remote."
slug: rclone_rcat slug: rclone_rcat
url: /commands/rclone_rcat/ url: /commands/rclone_rcat/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/rcat/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/rcat/ and as part of making a release run "make commanddocs"
--- ---
## rclone rcat # rclone rcat
Copies standard input to file on remote. Copies standard input to file on remote.
### Synopsis ## Synopsis
rclone rcat reads from standard input (stdin) and copies it to a rclone rcat reads from standard input (stdin) and copies it to a
@ -40,7 +40,7 @@ a lot of data, you're better off caching locally and then
rclone rcat remote:path [flags] rclone rcat remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for rcat -h, --help help for rcat
@ -48,7 +48,7 @@ rclone rcat remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_rcd.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone rcd" title: "rclone rcd"
description: "Run rclone listening to remote control commands only." description: "Run rclone listening to remote control commands only."
slug: rclone_rcd slug: rclone_rcd
url: /commands/rclone_rcd/ url: /commands/rclone_rcd/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/rcd/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/rcd/ and as part of making a release run "make commanddocs"
--- ---
## rclone rcd # rclone rcd
Run rclone listening to remote control commands only. Run rclone listening to remote control commands only.
### Synopsis ## Synopsis
This runs rclone so that it only listens to remote control commands. This runs rclone so that it only listens to remote control commands.
@ -28,7 +28,7 @@ See the [rc documentation](/rc/) for more info on the rc flags.
rclone rcd <path to files to serve>* [flags] rclone rcd <path to files to serve>* [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for rcd -h, --help help for rcd
@ -36,7 +36,7 @@ rclone rcd <path to files to serve>* [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_rmdir.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone rmdir" title: "rclone rmdir"
description: "Remove the path if empty." description: "Remove the path if empty."
slug: rclone_rmdir slug: rclone_rmdir
url: /commands/rclone_rmdir/ url: /commands/rclone_rmdir/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/rmdir/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/rmdir/ and as part of making a release run "make commanddocs"
--- ---
## rclone rmdir # rclone rmdir
Remove the path if empty. Remove the path if empty.
### Synopsis ## Synopsis
Remove the path. Note that you can't remove a path with Remove the path. Note that you can't remove a path with
@ -20,7 +20,7 @@ objects in it, use purge for that.
rclone rmdir remote:path [flags] rclone rmdir remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for rmdir -h, --help help for rmdir
@ -28,7 +28,7 @@ rclone rmdir remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_rmdirs.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone rmdirs" title: "rclone rmdirs"
description: "Remove empty directories under the path." description: "Remove empty directories under the path."
slug: rclone_rmdirs slug: rclone_rmdirs
url: /commands/rclone_rmdirs/ url: /commands/rclone_rmdirs/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/rmdirs/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/rmdirs/ and as part of making a release run "make commanddocs"
--- ---
## rclone rmdirs # rclone rmdirs
Remove empty directories under the path. Remove empty directories under the path.
### Synopsis ## Synopsis
This removes any empty directories (or directories that only contain This removes any empty directories (or directories that only contain
empty directories) under the path that it finds, including the path if empty directories) under the path that it finds, including the path if
@ -27,7 +27,7 @@ empty directories in.
rclone rmdirs remote:path [flags] rclone rmdirs remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for rmdirs -h, --help help for rmdirs
@ -36,7 +36,7 @@ rclone rmdirs remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_serve.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone serve" title: "rclone serve"
description: "Serve a remote over a protocol." description: "Serve a remote over a protocol."
slug: rclone_serve slug: rclone_serve
url: /commands/rclone_serve/ url: /commands/rclone_serve/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/ and as part of making a release run "make commanddocs"
--- ---
## rclone serve # rclone serve
Serve a remote over a protocol. Serve a remote over a protocol.
### Synopsis ## Synopsis
rclone serve is used to serve a remote over a given protocol. This rclone serve is used to serve a remote over a given protocol. This
command requires the use of a subcommand to specify the protocol, eg command requires the use of a subcommand to specify the protocol, eg
@ -24,7 +24,7 @@ Each subcommand has its own options which you can see in their help.
rclone serve <protocol> [opts] <remote> [flags] rclone serve <protocol> [opts] <remote> [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for serve -h, --help help for serve
@ -32,7 +32,7 @@ rclone serve <protocol> [opts] <remote> [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
* [rclone serve dlna](/commands/rclone_serve_dlna/) - Serve remote:path over DLNA * [rclone serve dlna](/commands/rclone_serve_dlna/) - Serve remote:path over DLNA

30
docs/content/commands/rclone_serve_dlna.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone serve dlna" title: "rclone serve dlna"
description: "Serve remote:path over DLNA" description: "Serve remote:path over DLNA"
slug: rclone_serve_dlna slug: rclone_serve_dlna
url: /commands/rclone_serve_dlna/ url: /commands/rclone_serve_dlna/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/dlna/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/dlna/ and as part of making a release run "make commanddocs"
--- ---
## rclone serve dlna # rclone serve dlna
Serve remote:path over DLNA Serve remote:path over DLNA
### Synopsis ## Synopsis
rclone serve dlna is a DLNA media server for media stored in a rclone remote. Many rclone serve dlna is a DLNA media server for media stored in a rclone remote. Many
devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN
@ -22,7 +22,7 @@ file extensions. Additionally, there is no media transcoding support. This means
players might show files that they are not able to play back correctly. players might show files that they are not able to play back correctly.
### Server options ## Server options
Use --addr to specify which IP address and port the server should 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 listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all
@ -34,7 +34,7 @@ default "rclone (hostname)".
Use --log-trace in conjunction with -vv to enable additional debug Use --log-trace in conjunction with -vv to enable additional debug
logging of all UPNP traffic. logging of all UPNP traffic.
### Directory Cache ## Directory Cache
Using the `--dir-cache-time` flag, you can set how long a Using the `--dir-cache-time` flag, you can set how long a
directory should be considered up to date and not refreshed from the directory should be considered up to date and not refreshed from the
@ -60,7 +60,7 @@ Or individual files or directories:
rclone rc vfs/forget file=path/to/file dir=path/to/dir 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, The `--buffer-size` flag determines the amount of memory,
that will be used to buffer data in advance. that will be used to buffer data in advance.
@ -77,7 +77,7 @@ will be used.
The maximum memory used by rclone for buffering can be up to The maximum memory used by rclone for buffering can be up to
`--buffer-size * open files`. `--buffer-size * open files`.
### File Caching ## File Caching
These flags control the VFS file caching options. The VFS layer is 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 used by rclone mount to make a cloud storage system work more like a
@ -114,7 +114,7 @@ for two reasons. Firstly because it is only checked every
--vfs-cache-poll-interval. Secondly because open files cannot be --vfs-cache-poll-interval. Secondly because open files cannot be
evicted from the cache. 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 In this mode the cache will read directly from the remote and write
directly to the remote without caching anything on disk. directly to the remote without caching anything on disk.
@ -129,7 +129,7 @@ This will mean some operations are not possible
* Open modes O_APPEND, O_TRUNC are ignored * Open modes O_APPEND, O_TRUNC are ignored
* If an upload fails it can't be retried * 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 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 write will be buffered to disks. This means that files opened for
@ -142,7 +142,7 @@ These operations are not possible
* Files opened for write only will ignore O_APPEND, O_TRUNC * Files opened for write only will ignore O_APPEND, O_TRUNC
* If an upload fails it can't be retried * 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 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 the remote, write only and read/write files are buffered to disk
@ -152,7 +152,7 @@ This mode should support all normal file system operations.
If an upload fails it will be retried up to --low-level-retries times. 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 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. a file is opened for read it will be downloaded in its entirety first.
@ -170,7 +170,7 @@ This mode should support all normal file system operations.
If an upload or download fails it will be retried up to If an upload or download fails it will be retried up to
--low-level-retries times. --low-level-retries times.
### Case Sensitivity ## Case Sensitivity
Linux file systems are case-sensitive: two files can differ only Linux file systems are case-sensitive: two files can differ only
by case, and the exact case must be used when opening a file. by case, and the exact case must be used when opening a file.
@ -211,7 +211,7 @@ otherwise. If the flag is provided without a value, then it is "true".
rclone serve dlna remote:path [flags] rclone serve dlna remote:path [flags]
``` ```
### Options ## Options
``` ```
--addr string ip:port or :port to bind the DLNA http server to. (default ":7879") --addr string ip:port or :port to bind the DLNA http server to. (default ":7879")
@ -236,13 +236,13 @@ rclone serve dlna remote:path [flags]
--vfs-case-insensitive If a file name not found, find a case insensitive match. --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 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-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) --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 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. * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

34
docs/content/commands/rclone_serve_ftp.md
View File

@ -1,23 +1,23 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone serve ftp" title: "rclone serve ftp"
description: "Serve remote:path over FTP." description: "Serve remote:path over FTP."
slug: rclone_serve_ftp slug: rclone_serve_ftp
url: /commands/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" # 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. Serve remote:path over FTP.
### Synopsis ## Synopsis
rclone serve ftp implements a basic ftp server to serve the rclone serve ftp implements a basic ftp server to serve the
remote over FTP protocol. This can be viewed with a ftp client 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. 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 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 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 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. then using Authentication is advised - see the next section for info.
#### Authentication ### Authentication
By default this will serve files without needing a login. By default this will serve files without needing a login.
You can set a single username and password with the --user and --pass flags. 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 Using the `--dir-cache-time` flag, you can set how long a
directory should be considered up to date and not refreshed from the 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 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, The `--buffer-size` flag determines the amount of memory,
that will be used to buffer data in advance. 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 The maximum memory used by rclone for buffering can be up to
`--buffer-size * open files`. `--buffer-size * open files`.
### File Caching ## File Caching
These flags control the VFS file caching options. The VFS layer is 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 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 --vfs-cache-poll-interval. Secondly because open files cannot be
evicted from the cache. 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 In this mode the cache will read directly from the remote and write
directly to the remote without caching anything on disk. 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 * Open modes O_APPEND, O_TRUNC are ignored
* If an upload fails it can't be retried * 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 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 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 * Files opened for write only will ignore O_APPEND, O_TRUNC
* If an upload fails it can't be retried * 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 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 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. 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 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. 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 If an upload or download fails it will be retried up to
--low-level-retries times. --low-level-retries times.
### Case Sensitivity ## Case Sensitivity
Linux file systems are case-sensitive: two files can differ only Linux file systems are case-sensitive: two files can differ only
by case, and the exact case must be used when opening a file. 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" 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". 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 If you supply the parameter `--auth-proxy /path/to/program` then
rclone will use that program to generate backends on the fly which 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] rclone serve ftp remote:path [flags]
``` ```
### Options ## Options
``` ```
--addr string IPaddress:Port or :Port to bind server to. (default "localhost:2121") --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-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 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-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) --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 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. * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

36
docs/content/commands/rclone_serve_http.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone serve http" title: "rclone serve http"
description: "Serve the remote over HTTP." description: "Serve the remote over HTTP."
slug: rclone_serve_http slug: rclone_serve_http
url: /commands/rclone_serve_http/ url: /commands/rclone_serve_http/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/http/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/http/ and as part of making a release run "make commanddocs"
--- ---
## rclone serve http # rclone serve http
Serve the remote over HTTP. Serve the remote over HTTP.
### Synopsis ## Synopsis
rclone serve http implements a basic web server to serve the remote rclone serve http implements a basic web server to serve the remote
over HTTP. This can be viewed in a web browser or you can make a over HTTP. This can be viewed in a web browser or you can make a
@ -24,7 +24,7 @@ The server will log errors. Use -v to see access logs.
--bwlimit will be respected for file transfers. Use --stats to --bwlimit will be respected for file transfers. Use --stats to
control the stats printing. control the stats printing.
### Server options ## Server options
Use --addr to specify which IP address and port the server should 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 listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all
@ -72,7 +72,7 @@ to be used within the template to server pages:
|-- .Size | Size in Bytes of the entry. | |-- .Size | Size in Bytes of the entry. |
|-- .ModTime | The UTC timestamp of an entry. | |-- .ModTime | The UTC timestamp of an entry. |
#### Authentication ### Authentication
By default this will serve files without needing a login. By default this will serve files without needing a login.
@ -93,19 +93,19 @@ The password file can be updated while rclone is running.
Use --realm to set the authentication realm. Use --realm to set the authentication realm.
#### SSL/TLS ### SSL/TLS
By default this will serve over http. If you want you can serve over By default this will serve over http. If you want you can serve over
https. You will need to supply the --cert and --key flags. If you https. You will need to supply the --cert and --key flags. If you
wish to do client side certificate validation then you will need to wish to do client side certificate validation then you will need to
supply --client-ca also. supply --client-ca also.
--cert should be a either a PEM encoded certificate or a concatenation --cert should be either a PEM encoded certificate or a concatenation
of that with the CA certificate. --key should be the PEM encoded of that with the CA certificate. --key should be the PEM encoded
private key and --client-ca should be the PEM encoded client private key and --client-ca should be the PEM encoded client
certificate authority certificate. certificate authority certificate.
### Directory Cache ## Directory Cache
Using the `--dir-cache-time` flag, you can set how long a Using the `--dir-cache-time` flag, you can set how long a
directory should be considered up to date and not refreshed from the directory should be considered up to date and not refreshed from the
@ -131,7 +131,7 @@ Or individual files or directories:
rclone rc vfs/forget file=path/to/file dir=path/to/dir 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, The `--buffer-size` flag determines the amount of memory,
that will be used to buffer data in advance. that will be used to buffer data in advance.
@ -148,7 +148,7 @@ will be used.
The maximum memory used by rclone for buffering can be up to The maximum memory used by rclone for buffering can be up to
`--buffer-size * open files`. `--buffer-size * open files`.
### File Caching ## File Caching
These flags control the VFS file caching options. The VFS layer is 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 used by rclone mount to make a cloud storage system work more like a
@ -185,7 +185,7 @@ for two reasons. Firstly because it is only checked every
--vfs-cache-poll-interval. Secondly because open files cannot be --vfs-cache-poll-interval. Secondly because open files cannot be
evicted from the cache. 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 In this mode the cache will read directly from the remote and write
directly to the remote without caching anything on disk. directly to the remote without caching anything on disk.
@ -200,7 +200,7 @@ This will mean some operations are not possible
* Open modes O_APPEND, O_TRUNC are ignored * Open modes O_APPEND, O_TRUNC are ignored
* If an upload fails it can't be retried * 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 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 write will be buffered to disks. This means that files opened for
@ -213,7 +213,7 @@ These operations are not possible
* Files opened for write only will ignore O_APPEND, O_TRUNC * Files opened for write only will ignore O_APPEND, O_TRUNC
* If an upload fails it can't be retried * 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 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 the remote, write only and read/write files are buffered to disk
@ -223,7 +223,7 @@ This mode should support all normal file system operations.
If an upload fails it will be retried up to --low-level-retries times. 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 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. a file is opened for read it will be downloaded in its entirety first.
@ -241,7 +241,7 @@ This mode should support all normal file system operations.
If an upload or download fails it will be retried up to If an upload or download fails it will be retried up to
--low-level-retries times. --low-level-retries times.
### Case Sensitivity ## Case Sensitivity
Linux file systems are case-sensitive: two files can differ only Linux file systems are case-sensitive: two files can differ only
by case, and the exact case must be used when opening a file. by case, and the exact case must be used when opening a file.
@ -282,7 +282,7 @@ otherwise. If the flag is provided without a value, then it is "true".
rclone serve http remote:path [flags] rclone serve http remote:path [flags]
``` ```
### Options ## Options
``` ```
--addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080")
@ -317,13 +317,13 @@ rclone serve http remote:path [flags]
--vfs-case-insensitive If a file name not found, find a case insensitive match. --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 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-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) --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 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. * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

26
docs/content/commands/rclone_serve_restic.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone serve restic" title: "rclone serve restic"
description: "Serve the remote for restic's REST API." description: "Serve the remote for restic's REST API."
slug: rclone_serve_restic slug: rclone_serve_restic
url: /commands/rclone_serve_restic/ url: /commands/rclone_serve_restic/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/restic/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/restic/ and as part of making a release run "make commanddocs"
--- ---
## rclone serve restic # rclone serve restic
Serve the remote for restic's REST API. Serve the remote for restic's REST API.
### Synopsis ## Synopsis
rclone serve restic implements restic's REST backend API rclone serve restic implements restic's REST backend API
over HTTP. This allows restic to use rclone as a data storage over HTTP. This allows restic to use rclone as a data storage
@ -24,7 +24,7 @@ The server will log errors. Use -v to see access logs.
--bwlimit will be respected for file transfers. Use --stats to --bwlimit will be respected for file transfers. Use --stats to
control the stats printing. control the stats printing.
### Setting up rclone for use by restic ### ## Setting up rclone for use by restic ###
First [set up a remote for your chosen cloud provider](/docs/#configure). First [set up a remote for your chosen cloud provider](/docs/#configure).
@ -45,7 +45,7 @@ with use of the "--addr" flag.
You might wish to start this server on boot. You might wish to start this server on boot.
### Setting up restic to use rclone ### ## Setting up restic to use rclone ###
Now you can [follow the restic Now you can [follow the restic
instructions](http://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server) instructions](http://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server)
@ -74,7 +74,7 @@ For example:
duration: 0:00 duration: 0:00
snapshot 45c8fdd8 saved snapshot 45c8fdd8 saved
#### Multiple repositories #### ### Multiple repositories ####
Note that you can use the endpoint to host multiple repositories. Do Note that you can use the endpoint to host multiple repositories. Do
this by adding a directory name or path after the URL. Note that this by adding a directory name or path after the URL. Note that
@ -85,12 +85,12 @@ these **must** end with /. Eg
$ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/
# backup user2 stuff # backup user2 stuff
#### Private repositories #### ### Private repositories ####
The "--private-repos" flag can be used to limit users to repositories starting The "--private-repos" flag can be used to limit users to repositories starting
with a path of "/<username>/". with a path of "/<username>/".
### Server options ## Server options
Use --addr to specify which IP address and port the server should 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 listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all
@ -138,7 +138,7 @@ to be used within the template to server pages:
|-- .Size | Size in Bytes of the entry. | |-- .Size | Size in Bytes of the entry. |
|-- .ModTime | The UTC timestamp of an entry. | |-- .ModTime | The UTC timestamp of an entry. |
#### Authentication ### Authentication
By default this will serve files without needing a login. By default this will serve files without needing a login.
@ -159,14 +159,14 @@ The password file can be updated while rclone is running.
Use --realm to set the authentication realm. Use --realm to set the authentication realm.
#### SSL/TLS ### SSL/TLS
By default this will serve over http. If you want you can serve over By default this will serve over http. If you want you can serve over
https. You will need to supply the --cert and --key flags. If you https. You will need to supply the --cert and --key flags. If you
wish to do client side certificate validation then you will need to wish to do client side certificate validation then you will need to
supply --client-ca also. supply --client-ca also.
--cert should be a either a PEM encoded certificate or a concatenation --cert should be either a PEM encoded certificate or a concatenation
of that with the CA certificate. --key should be the PEM encoded of that with the CA certificate. --key should be the PEM encoded
private key and --client-ca should be the PEM encoded client private key and --client-ca should be the PEM encoded client
certificate authority certificate. certificate authority certificate.
@ -176,7 +176,7 @@ certificate authority certificate.
rclone serve restic remote:path [flags] rclone serve restic remote:path [flags]
``` ```
### Options ## Options
``` ```
--addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080")
@ -200,7 +200,7 @@ rclone serve restic remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. 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. * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

30
docs/content/commands/rclone_serve_sftp.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone serve sftp" title: "rclone serve sftp"
description: "Serve the remote over SFTP." description: "Serve the remote over SFTP."
slug: rclone_serve_sftp slug: rclone_serve_sftp
url: /commands/rclone_serve_sftp/ url: /commands/rclone_serve_sftp/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/sftp/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/sftp/ and as part of making a release run "make commanddocs"
--- ---
## rclone serve sftp # rclone serve sftp
Serve the remote over SFTP. Serve the remote over SFTP.
### Synopsis ## Synopsis
rclone serve sftp implements an SFTP server to serve the remote rclone serve sftp implements an SFTP server to serve the remote
over SFTP. This can be used with an SFTP client or you can make a over SFTP. This can be used with an SFTP client or you can make a
@ -44,7 +44,7 @@ Note that the default of "--vfs-cache-mode off" is fine for the rclone
sftp backend, but it may not be with other SFTP clients. sftp backend, but it may not be with other SFTP clients.
### Directory Cache ## Directory Cache
Using the `--dir-cache-time` flag, you can set how long a Using the `--dir-cache-time` flag, you can set how long a
directory should be considered up to date and not refreshed from the directory should be considered up to date and not refreshed from the
@ -70,7 +70,7 @@ Or individual files or directories:
rclone rc vfs/forget file=path/to/file dir=path/to/dir 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, The `--buffer-size` flag determines the amount of memory,
that will be used to buffer data in advance. that will be used to buffer data in advance.
@ -87,7 +87,7 @@ will be used.
The maximum memory used by rclone for buffering can be up to The maximum memory used by rclone for buffering can be up to
`--buffer-size * open files`. `--buffer-size * open files`.
### File Caching ## File Caching
These flags control the VFS file caching options. The VFS layer is 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 used by rclone mount to make a cloud storage system work more like a
@ -124,7 +124,7 @@ for two reasons. Firstly because it is only checked every
--vfs-cache-poll-interval. Secondly because open files cannot be --vfs-cache-poll-interval. Secondly because open files cannot be
evicted from the cache. 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 In this mode the cache will read directly from the remote and write
directly to the remote without caching anything on disk. directly to the remote without caching anything on disk.
@ -139,7 +139,7 @@ This will mean some operations are not possible
* Open modes O_APPEND, O_TRUNC are ignored * Open modes O_APPEND, O_TRUNC are ignored
* If an upload fails it can't be retried * 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 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 write will be buffered to disks. This means that files opened for
@ -152,7 +152,7 @@ These operations are not possible
* Files opened for write only will ignore O_APPEND, O_TRUNC * Files opened for write only will ignore O_APPEND, O_TRUNC
* If an upload fails it can't be retried * 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 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 the remote, write only and read/write files are buffered to disk
@ -162,7 +162,7 @@ This mode should support all normal file system operations.
If an upload fails it will be retried up to --low-level-retries times. 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 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. a file is opened for read it will be downloaded in its entirety first.
@ -180,7 +180,7 @@ This mode should support all normal file system operations.
If an upload or download fails it will be retried up to If an upload or download fails it will be retried up to
--low-level-retries times. --low-level-retries times.
### Case Sensitivity ## Case Sensitivity
Linux file systems are case-sensitive: two files can differ only Linux file systems are case-sensitive: two files can differ only
by case, and the exact case must be used when opening a file. by case, and the exact case must be used when opening a file.
@ -216,7 +216,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" 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". 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 If you supply the parameter `--auth-proxy /path/to/program` then
rclone will use that program to generate backends on the fly which rclone will use that program to generate backends on the fly which
@ -302,7 +302,7 @@ backend that rclone supports.
rclone serve sftp remote:path [flags] rclone serve sftp remote:path [flags]
``` ```
### Options ## Options
``` ```
--addr string IPaddress:Port or :Port to bind server to. (default "localhost:2022") --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2022")
@ -331,13 +331,13 @@ rclone serve sftp remote:path [flags]
--vfs-case-insensitive If a file name not found, find a case insensitive match. --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 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-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) --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 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. * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

42
docs/content/commands/rclone_serve_webdav.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone serve webdav" title: "rclone serve webdav"
description: "Serve remote:path over webdav." description: "Serve remote:path over webdav."
slug: rclone_serve_webdav slug: rclone_serve_webdav
url: /commands/rclone_serve_webdav/ url: /commands/rclone_serve_webdav/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/webdav/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/webdav/ and as part of making a release run "make commanddocs"
--- ---
## rclone serve webdav # rclone serve webdav
Serve remote:path over webdav. Serve remote:path over webdav.
### Synopsis ## Synopsis
rclone serve webdav implements a basic webdav server to serve the rclone serve webdav implements a basic webdav server to serve the
@ -18,9 +18,9 @@ remote over HTTP via the webdav protocol. This can be viewed with a
webdav client, through a web browser, or you can make a remote of webdav client, through a web browser, or you can make a remote of
type webdav to read and write it. type webdav to read and write it.
### Webdav options ## Webdav options
#### --etag-hash ### --etag-hash
This controls the ETag header. Without this flag the ETag will be This controls the ETag header. Without this flag the ETag will be
based on the ModTime and Size of the object. based on the ModTime and Size of the object.
@ -32,7 +32,7 @@ supported hash on the backend or you can use a named hash such as
Use "rclone hashsum" to see the full list. Use "rclone hashsum" to see the full list.
### Server options ## Server options
Use --addr to specify which IP address and port the server should 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 listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all
@ -80,7 +80,7 @@ to be used within the template to server pages:
|-- .Size | Size in Bytes of the entry. | |-- .Size | Size in Bytes of the entry. |
|-- .ModTime | The UTC timestamp of an entry. | |-- .ModTime | The UTC timestamp of an entry. |
#### Authentication ### Authentication
By default this will serve files without needing a login. By default this will serve files without needing a login.
@ -101,19 +101,19 @@ The password file can be updated while rclone is running.
Use --realm to set the authentication realm. Use --realm to set the authentication realm.
#### SSL/TLS ### SSL/TLS
By default this will serve over http. If you want you can serve over By default this will serve over http. If you want you can serve over
https. You will need to supply the --cert and --key flags. If you https. You will need to supply the --cert and --key flags. If you
wish to do client side certificate validation then you will need to wish to do client side certificate validation then you will need to
supply --client-ca also. supply --client-ca also.
--cert should be a either a PEM encoded certificate or a concatenation --cert should be either a PEM encoded certificate or a concatenation
of that with the CA certificate. --key should be the PEM encoded of that with the CA certificate. --key should be the PEM encoded
private key and --client-ca should be the PEM encoded client private key and --client-ca should be the PEM encoded client
certificate authority certificate. certificate authority certificate.
### Directory Cache ## Directory Cache
Using the `--dir-cache-time` flag, you can set how long a Using the `--dir-cache-time` flag, you can set how long a
directory should be considered up to date and not refreshed from the directory should be considered up to date and not refreshed from the
@ -139,7 +139,7 @@ Or individual files or directories:
rclone rc vfs/forget file=path/to/file dir=path/to/dir 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, The `--buffer-size` flag determines the amount of memory,
that will be used to buffer data in advance. that will be used to buffer data in advance.
@ -156,7 +156,7 @@ will be used.
The maximum memory used by rclone for buffering can be up to The maximum memory used by rclone for buffering can be up to
`--buffer-size * open files`. `--buffer-size * open files`.
### File Caching ## File Caching
These flags control the VFS file caching options. The VFS layer is 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 used by rclone mount to make a cloud storage system work more like a
@ -193,7 +193,7 @@ for two reasons. Firstly because it is only checked every
--vfs-cache-poll-interval. Secondly because open files cannot be --vfs-cache-poll-interval. Secondly because open files cannot be
evicted from the cache. 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 In this mode the cache will read directly from the remote and write
directly to the remote without caching anything on disk. directly to the remote without caching anything on disk.
@ -208,7 +208,7 @@ This will mean some operations are not possible
* Open modes O_APPEND, O_TRUNC are ignored * Open modes O_APPEND, O_TRUNC are ignored
* If an upload fails it can't be retried * 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 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 write will be buffered to disks. This means that files opened for
@ -221,7 +221,7 @@ These operations are not possible
* Files opened for write only will ignore O_APPEND, O_TRUNC * Files opened for write only will ignore O_APPEND, O_TRUNC
* If an upload fails it can't be retried * 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 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 the remote, write only and read/write files are buffered to disk
@ -231,7 +231,7 @@ This mode should support all normal file system operations.
If an upload fails it will be retried up to --low-level-retries times. 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 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. a file is opened for read it will be downloaded in its entirety first.
@ -249,7 +249,7 @@ This mode should support all normal file system operations.
If an upload or download fails it will be retried up to If an upload or download fails it will be retried up to
--low-level-retries times. --low-level-retries times.
### Case Sensitivity ## Case Sensitivity
Linux file systems are case-sensitive: two files can differ only Linux file systems are case-sensitive: two files can differ only
by case, and the exact case must be used when opening a file. by case, and the exact case must be used when opening a file.
@ -285,7 +285,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" 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". 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 If you supply the parameter `--auth-proxy /path/to/program` then
rclone will use that program to generate backends on the fly which rclone will use that program to generate backends on the fly which
@ -371,7 +371,7 @@ backend that rclone supports.
rclone serve webdav remote:path [flags] rclone serve webdav remote:path [flags]
``` ```
### Options ## Options
``` ```
--addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080")
@ -409,13 +409,13 @@ rclone serve webdav remote:path [flags]
--vfs-case-insensitive If a file name not found, find a case insensitive match. --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 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-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) --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 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. * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.

10
docs/content/commands/rclone_settier.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone settier" title: "rclone settier"
description: "Changes storage class/tier of objects in remote." description: "Changes storage class/tier of objects in remote."
slug: rclone_settier slug: rclone_settier
url: /commands/rclone_settier/ url: /commands/rclone_settier/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/settier/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/settier/ and as part of making a release run "make commanddocs"
--- ---
## rclone settier # rclone settier
Changes storage class/tier of objects in remote. Changes storage class/tier of objects in remote.
### Synopsis ## Synopsis
rclone settier changes storage tier or class at remote if supported. rclone settier changes storage tier or class at remote if supported.
@ -40,7 +40,7 @@ Or just provide remote directory and all files in directory will be tiered
rclone settier tier remote:path [flags] rclone settier tier remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for settier -h, --help help for settier
@ -48,7 +48,7 @@ rclone settier tier remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_sha1sum.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone sha1sum" title: "rclone sha1sum"
description: "Produces an sha1sum file for all the objects in the path." description: "Produces an sha1sum file for all the objects in the path."
slug: rclone_sha1sum slug: rclone_sha1sum
url: /commands/rclone_sha1sum/ url: /commands/rclone_sha1sum/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/sha1sum/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/sha1sum/ and as part of making a release run "make commanddocs"
--- ---
## rclone sha1sum # rclone sha1sum
Produces an sha1sum file for all the objects in the path. Produces an sha1sum file for all the objects in the path.
### Synopsis ## Synopsis
Produces an sha1sum file for all the objects in the path. This Produces an sha1sum file for all the objects in the path. This
@ -21,7 +21,7 @@ is in the same format as the standard sha1sum tool produces.
rclone sha1sum remote:path [flags] rclone sha1sum remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for sha1sum -h, --help help for sha1sum
@ -29,7 +29,7 @@ rclone sha1sum remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_size.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone size" title: "rclone size"
description: "Prints the total size and number of objects in remote:path." description: "Prints the total size and number of objects in remote:path."
slug: rclone_size slug: rclone_size
url: /commands/rclone_size/ url: /commands/rclone_size/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/size/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/size/ and as part of making a release run "make commanddocs"
--- ---
## rclone size # rclone size
Prints the total size and number of objects in remote:path. Prints the total size and number of objects in remote:path.
### Synopsis ## Synopsis
Prints the total size and number of objects in remote:path. Prints the total size and number of objects in remote:path.
@ -18,7 +18,7 @@ Prints the total size and number of objects in remote:path.
rclone size remote:path [flags] rclone size remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for size -h, --help help for size
@ -27,7 +27,7 @@ rclone size remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_sync.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone sync" title: "rclone sync"
description: "Make source and dest identical, modifying destination only." description: "Make source and dest identical, modifying destination only."
slug: rclone_sync slug: rclone_sync
url: /commands/rclone_sync/ url: /commands/rclone_sync/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/sync/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/sync/ and as part of making a release run "make commanddocs"
--- ---
## rclone sync # rclone sync
Make source and dest identical, modifying destination only. Make source and dest identical, modifying destination only.
### Synopsis ## Synopsis
Sync the source to the destination, changing the destination Sync the source to the destination, changing the destination
@ -39,7 +39,7 @@ go there.
rclone sync source:path dest:path [flags] rclone sync source:path dest:path [flags]
``` ```
### Options ## Options
``` ```
--create-empty-src-dirs Create empty source dirs on destination after sync --create-empty-src-dirs Create empty source dirs on destination after sync
@ -48,7 +48,7 @@ rclone sync source:path dest:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_touch.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone touch" title: "rclone touch"
description: "Create new file or change file modification time." description: "Create new file or change file modification time."
slug: rclone_touch slug: rclone_touch
url: /commands/rclone_touch/ url: /commands/rclone_touch/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/touch/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/touch/ and as part of making a release run "make commanddocs"
--- ---
## rclone touch # rclone touch
Create new file or change file modification time. Create new file or change file modification time.
### Synopsis ## Synopsis
Set the modification time on object(s) as specified by remote:path to Set the modification time on object(s) as specified by remote:path to
@ -33,7 +33,7 @@ Note that --timestamp is in UTC if you want local time then add the
rclone touch remote:path [flags] rclone touch remote:path [flags]
``` ```
### Options ## Options
``` ```
-h, --help help for touch -h, --help help for touch
@ -44,7 +44,7 @@ rclone touch remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_tree.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone tree" title: "rclone tree"
description: "List the contents of the remote in a tree like fashion." description: "List the contents of the remote in a tree like fashion."
slug: rclone_tree slug: rclone_tree
url: /commands/rclone_tree/ url: /commands/rclone_tree/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/tree/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/tree/ and as part of making a release run "make commanddocs"
--- ---
## rclone tree # rclone tree
List the contents of the remote in a tree like fashion. List the contents of the remote in a tree like fashion.
### Synopsis ## Synopsis
rclone tree lists the contents of a remote in a similar way to the rclone tree lists the contents of a remote in a similar way to the
@ -41,7 +41,7 @@ short options as they conflict with rclone's short options.
rclone tree remote:path [flags] rclone tree remote:path [flags]
``` ```
### Options ## Options
``` ```
-a, --all All files are listed (list . files too). -a, --all All files are listed (list . files too).
@ -69,7 +69,7 @@ rclone tree remote:path [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.

10
docs/content/commands/rclone_version.md
View File

@ -1,16 +1,16 @@
--- ---
date: 2020-05-18T10:38:09+01:00 date: 2020-05-22T09:52:00+01:00
title: "rclone version" title: "rclone version"
description: "Show the version number." description: "Show the version number."
slug: rclone_version slug: rclone_version
url: /commands/rclone_version/ url: /commands/rclone_version/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/version/ and as part of making a release run "make commanddocs" # autogenerated - DO NOT EDIT, instead edit the source code in cmd/version/ and as part of making a release run "make commanddocs"
--- ---
## rclone version # rclone version
Show the version number. Show the version number.
### Synopsis ## Synopsis
Show the version number, the go version and the architecture. Show the version number, the go version and the architecture.
@ -45,7 +45,7 @@ Or
rclone version [flags] rclone version [flags]
``` ```
### Options ## Options
``` ```
--check Check for new version. --check Check for new version.
@ -54,7 +54,7 @@ rclone version [flags]
See the [global flags page](/flags/) for global options not listed here. See the [global flags page](/flags/) for global options not listed here.
### SEE ALSO ## SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.