From 050879f0ca61056510afdffa0bd94c7c9ed4f535 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Fri, 22 May 2020 11:17:37 +0100 Subject: [PATCH] docs: make command docs titles be one higher --- cmd/gendocs/gendocs.go | 5 ++ docs/content/commands/rclone.md | 12 ++--- docs/content/commands/rclone_about.md | 10 ++-- docs/content/commands/rclone_authorize.md | 10 ++-- docs/content/commands/rclone_backend.md | 10 ++-- docs/content/commands/rclone_cat.md | 10 ++-- docs/content/commands/rclone_check.md | 10 ++-- docs/content/commands/rclone_cleanup.md | 10 ++-- docs/content/commands/rclone_config.md | 10 ++-- docs/content/commands/rclone_config_create.md | 10 ++-- docs/content/commands/rclone_config_delete.md | 10 ++-- .../commands/rclone_config_disconnect.md | 10 ++-- docs/content/commands/rclone_config_dump.md | 10 ++-- docs/content/commands/rclone_config_edit.md | 10 ++-- docs/content/commands/rclone_config_file.md | 10 ++-- .../commands/rclone_config_password.md | 10 ++-- .../commands/rclone_config_providers.md | 10 ++-- .../commands/rclone_config_reconnect.md | 10 ++-- docs/content/commands/rclone_config_show.md | 10 ++-- docs/content/commands/rclone_config_update.md | 10 ++-- .../commands/rclone_config_userinfo.md | 10 ++-- docs/content/commands/rclone_copy.md | 10 ++-- docs/content/commands/rclone_copyto.md | 10 ++-- docs/content/commands/rclone_copyurl.md | 10 ++-- docs/content/commands/rclone_cryptcheck.md | 10 ++-- docs/content/commands/rclone_cryptdecode.md | 10 ++-- docs/content/commands/rclone_dedupe.md | 10 ++-- docs/content/commands/rclone_delete.md | 10 ++-- docs/content/commands/rclone_deletefile.md | 10 ++-- .../commands/rclone_genautocomplete.md | 10 ++-- .../commands/rclone_genautocomplete_bash.md | 10 ++-- .../commands/rclone_genautocomplete_fish.md | 10 ++-- .../commands/rclone_genautocomplete_zsh.md | 10 ++-- docs/content/commands/rclone_gendocs.md | 10 ++-- docs/content/commands/rclone_hashsum.md | 14 +++--- docs/content/commands/rclone_link.md | 10 ++-- docs/content/commands/rclone_listremotes.md | 10 ++-- docs/content/commands/rclone_ls.md | 10 ++-- docs/content/commands/rclone_lsd.md | 10 ++-- docs/content/commands/rclone_lsf.md | 10 ++-- docs/content/commands/rclone_lsjson.md | 10 ++-- docs/content/commands/rclone_lsl.md | 10 ++-- docs/content/commands/rclone_md5sum.md | 10 ++-- docs/content/commands/rclone_mkdir.md | 10 ++-- docs/content/commands/rclone_mount.md | 46 +++++++++---------- docs/content/commands/rclone_move.md | 12 ++--- docs/content/commands/rclone_moveto.md | 10 ++-- docs/content/commands/rclone_ncdu.md | 10 ++-- docs/content/commands/rclone_obscure.md | 10 ++-- docs/content/commands/rclone_purge.md | 10 ++-- docs/content/commands/rclone_rc.md | 10 ++-- docs/content/commands/rclone_rcat.md | 10 ++-- docs/content/commands/rclone_rcd.md | 10 ++-- docs/content/commands/rclone_rmdir.md | 10 ++-- docs/content/commands/rclone_rmdirs.md | 10 ++-- docs/content/commands/rclone_serve.md | 10 ++-- docs/content/commands/rclone_serve_dlna.md | 30 ++++++------ docs/content/commands/rclone_serve_ftp.md | 34 +++++++------- docs/content/commands/rclone_serve_http.md | 36 +++++++-------- docs/content/commands/rclone_serve_restic.md | 26 +++++------ docs/content/commands/rclone_serve_sftp.md | 30 ++++++------ docs/content/commands/rclone_serve_webdav.md | 42 ++++++++--------- docs/content/commands/rclone_settier.md | 10 ++-- docs/content/commands/rclone_sha1sum.md | 10 ++-- docs/content/commands/rclone_size.md | 10 ++-- docs/content/commands/rclone_sync.md | 10 ++-- docs/content/commands/rclone_touch.md | 10 ++-- docs/content/commands/rclone_tree.md | 10 ++-- docs/content/commands/rclone_version.md | 10 ++-- 69 files changed, 436 insertions(+), 431 deletions(-) diff --git a/cmd/gendocs/gendocs.go b/cmd/gendocs/gendocs.go index f83a78914..36ebe8027 100644 --- a/cmd/gendocs/gendocs.go +++ b/cmd/gendocs/gendocs.go @@ -7,6 +7,7 @@ import ( "os" "path" "path/filepath" + "regexp" "strings" "text/template" "time" @@ -120,6 +121,8 @@ rclone.org website.`, return err } + var outdentTitle = regexp.MustCompile(`(?m)^#(#+)`) + // 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 { if err != nil { @@ -135,6 +138,8 @@ rclone.org website.`, See the [global flags page](/flags/) for global options not listed here. ### SEE ALSO`, 1) + // outdent all the titles by one + doc = outdentTitle.ReplaceAllString(doc, `$1`) err = ioutil.WriteFile(path, []byte(doc), 0777) if err != nil { return err diff --git a/docs/content/commands/rclone.md b/docs/content/commands/rclone.md index 40f7214fc..705ebc1cc 100644 --- a/docs/content/commands/rclone.md +++ b/docs/content/commands/rclone.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone" description: "Show help for rclone commands, flags and backends." slug: 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" --- -## rclone +# rclone Show help for rclone commands, flags and backends. -### Synopsis +## Synopsis Rclone syncs files to and from cloud storage providers as well as @@ -25,7 +25,7 @@ documentation, changelog and configuration walkthroughs. rclone [flags] ``` -### Options +## Options ``` -h, --help help for rclone @@ -33,7 +33,7 @@ rclone [flags] 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 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 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 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 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. diff --git a/docs/content/commands/rclone_about.md b/docs/content/commands/rclone_about.md index b4fed4f65..c12c74c6d 100644 --- a/docs/content/commands/rclone_about.md +++ b/docs/content/commands/rclone_about.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone about" description: "Get quota information from the remote." slug: 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" --- -## rclone about +# rclone about Get quota information from the remote. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_authorize.md b/docs/content/commands/rclone_authorize.md index 43bea1b66..c67a1ea84 100644 --- a/docs/content/commands/rclone_authorize.md +++ b/docs/content/commands/rclone_authorize.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone authorize" description: "Remote authorization." slug: 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" --- -## rclone authorize +# rclone authorize Remote authorization. -### Synopsis +## Synopsis Remote authorization. Used to authorize a remote or headless @@ -24,7 +24,7 @@ link in default browser automatically. rclone authorize [flags] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_backend.md b/docs/content/commands/rclone_backend.md index 991695033..415f72854 100644 --- a/docs/content/commands/rclone_backend.md +++ b/docs/content/commands/rclone_backend.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone backend" description: "Run a backend specific command." slug: 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" --- -## rclone backend +# rclone backend Run a backend specific command. -### Synopsis +## Synopsis 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 remote:path [opts] [flags] ``` -### Options +## Options ``` -h, --help help for backend @@ -54,7 +54,7 @@ rclone backend remote:path [opts] [flags] 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. diff --git a/docs/content/commands/rclone_cat.md b/docs/content/commands/rclone_cat.md index aa60ffa88..2b229806f 100644 --- a/docs/content/commands/rclone_cat.md +++ b/docs/content/commands/rclone_cat.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone cat" description: "Concatenates any files and sends them to stdout." slug: 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" --- -## rclone cat +# rclone cat Concatenates any files and sends them to stdout. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_check.md b/docs/content/commands/rclone_check.md index 0784fa3f5..2bf483f4b 100644 --- a/docs/content/commands/rclone_check.md +++ b/docs/content/commands/rclone_check.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone check" description: "Checks the files in the source and destination match." slug: 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" --- -## rclone check +# rclone check Checks the files in the source and destination match. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_cleanup.md b/docs/content/commands/rclone_cleanup.md index 2ea558f06..b593b80b6 100644 --- a/docs/content/commands/rclone_cleanup.md +++ b/docs/content/commands/rclone_cleanup.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone cleanup" description: "Clean up the remote if possible" slug: 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" --- -## rclone cleanup +# rclone cleanup Clean up the remote if possible -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_config.md b/docs/content/commands/rclone_config.md index e440bb43c..027049506 100644 --- a/docs/content/commands/rclone_config.md +++ b/docs/content/commands/rclone_config.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config" description: "Enter an interactive configuration session." slug: 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" --- -## rclone config +# rclone config Enter an interactive configuration session. -### Synopsis +## Synopsis Enter an interactive configuration session where you can setup new remotes and manage existing ones. You may also set or remove a @@ -21,7 +21,7 @@ password to protect your configuration. rclone config [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [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. diff --git a/docs/content/commands/rclone_config_create.md b/docs/content/commands/rclone_config_create.md index aff9eb16c..94424f300 100644 --- a/docs/content/commands/rclone_config_create.md +++ b/docs/content/commands/rclone_config_create.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config create" description: "Create a new remote with name, type and options." slug: 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" --- -## rclone config create +# rclone config create Create a new remote with name, type and options. -### Synopsis +## Synopsis Create a new remote of with and options. The options @@ -48,7 +48,7 @@ using remote authorization you would do this: rclone config create [ ]* [flags] ``` -### Options +## Options ``` -h, --help help for create @@ -58,7 +58,7 @@ rclone config create [ ]* [flags] 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. diff --git a/docs/content/commands/rclone_config_delete.md b/docs/content/commands/rclone_config_delete.md index 1be422e55..92111dbb2 100644 --- a/docs/content/commands/rclone_config_delete.md +++ b/docs/content/commands/rclone_config_delete.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config delete" description: "Delete an existing remote ." slug: 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" --- -## rclone config delete +# rclone config delete Delete an existing remote . -### Synopsis +## Synopsis Delete an existing remote . @@ -18,7 +18,7 @@ Delete an existing remote . rclone config delete [flags] ``` -### Options +## Options ``` -h, --help help for delete @@ -26,7 +26,7 @@ rclone config delete [flags] 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. diff --git a/docs/content/commands/rclone_config_disconnect.md b/docs/content/commands/rclone_config_disconnect.md index e15c07b56..46a8f2a33 100644 --- a/docs/content/commands/rclone_config_disconnect.md +++ b/docs/content/commands/rclone_config_disconnect.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config disconnect" description: "Disconnects user from remote" slug: 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" --- -## rclone config disconnect +# rclone config disconnect Disconnects user from remote -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. diff --git a/docs/content/commands/rclone_config_dump.md b/docs/content/commands/rclone_config_dump.md index 75f265190..c0bd07ca6 100644 --- a/docs/content/commands/rclone_config_dump.md +++ b/docs/content/commands/rclone_config_dump.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config dump" description: "Dump the config file as JSON." slug: 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" --- -## rclone config dump +# rclone config dump Dump the config file as JSON. -### Synopsis +## Synopsis Dump the config file as JSON. @@ -18,7 +18,7 @@ Dump the config file as JSON. rclone config dump [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. diff --git a/docs/content/commands/rclone_config_edit.md b/docs/content/commands/rclone_config_edit.md index 40900bbcb..11feb27ce 100644 --- a/docs/content/commands/rclone_config_edit.md +++ b/docs/content/commands/rclone_config_edit.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config edit" description: "Enter an interactive configuration session." slug: 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" --- -## rclone config edit +# rclone config edit Enter an interactive configuration session. -### Synopsis +## Synopsis Enter an interactive configuration session where you can setup new 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. diff --git a/docs/content/commands/rclone_config_file.md b/docs/content/commands/rclone_config_file.md index 156f59f5d..4d2fb9943 100644 --- a/docs/content/commands/rclone_config_file.md +++ b/docs/content/commands/rclone_config_file.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config file" description: "Show path of configuration file in use." slug: 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" --- -## rclone config file +# rclone config file Show path of configuration file in use. -### Synopsis +## Synopsis Show path of configuration file in use. @@ -18,7 +18,7 @@ Show path of configuration file in use. rclone config file [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. diff --git a/docs/content/commands/rclone_config_password.md b/docs/content/commands/rclone_config_password.md index f50fec2c9..f6e3d69ad 100644 --- a/docs/content/commands/rclone_config_password.md +++ b/docs/content/commands/rclone_config_password.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config password" description: "Update password in an existing remote." slug: 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" --- -## rclone config password +# rclone config password Update password in an existing remote. -### Synopsis +## Synopsis Update an existing remote's password. The password @@ -28,7 +28,7 @@ both support obscuring passwords directly. rclone config password [ ]+ [flags] ``` -### Options +## Options ``` -h, --help help for password @@ -36,7 +36,7 @@ rclone config password [ ]+ [flags] 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. diff --git a/docs/content/commands/rclone_config_providers.md b/docs/content/commands/rclone_config_providers.md index 98576f642..dd0f330fe 100644 --- a/docs/content/commands/rclone_config_providers.md +++ b/docs/content/commands/rclone_config_providers.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config providers" description: "List in JSON format all the providers and options." slug: 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" --- -## rclone config providers +# rclone config providers List in JSON format all the providers and options. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. diff --git a/docs/content/commands/rclone_config_reconnect.md b/docs/content/commands/rclone_config_reconnect.md index 2e3a0c6e9..213a255ab 100644 --- a/docs/content/commands/rclone_config_reconnect.md +++ b/docs/content/commands/rclone_config_reconnect.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config reconnect" description: "Re-authenticates user with remote." slug: 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" --- -## rclone config reconnect +# rclone config reconnect Re-authenticates user with remote. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. diff --git a/docs/content/commands/rclone_config_show.md b/docs/content/commands/rclone_config_show.md index f2efabc95..f1e108737 100644 --- a/docs/content/commands/rclone_config_show.md +++ b/docs/content/commands/rclone_config_show.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config show" description: "Print (decrypted) config file, or the config for a single remote." slug: 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" --- -## rclone config show +# rclone config show Print (decrypted) config file, or the config for a single remote. -### Synopsis +## Synopsis 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 [] [flags] ``` -### Options +## Options ``` -h, --help help for show @@ -26,7 +26,7 @@ rclone config show [] [flags] 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. diff --git a/docs/content/commands/rclone_config_update.md b/docs/content/commands/rclone_config_update.md index e5cb07e26..e557e878b 100644 --- a/docs/content/commands/rclone_config_update.md +++ b/docs/content/commands/rclone_config_update.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config update" description: "Update options in an existing remote." slug: 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" --- -## rclone config update +# rclone config update Update options in an existing remote. -### Synopsis +## Synopsis 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 [ ]+ [flags] ``` -### Options +## Options ``` -h, --help help for update @@ -54,7 +54,7 @@ rclone config update [ ]+ [flags] 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. diff --git a/docs/content/commands/rclone_config_userinfo.md b/docs/content/commands/rclone_config_userinfo.md index 7c3fc91af..94c3e48da 100644 --- a/docs/content/commands/rclone_config_userinfo.md +++ b/docs/content/commands/rclone_config_userinfo.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone config userinfo" description: "Prints info about logged in user of remote." slug: 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" --- -## rclone config userinfo +# rclone config userinfo Prints info about logged in user of remote. -### Synopsis +## Synopsis This prints the details of the person logged in to the cloud storage @@ -21,7 +21,7 @@ system. rclone config userinfo remote: [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. diff --git a/docs/content/commands/rclone_copy.md b/docs/content/commands/rclone_copy.md index 0b970e7bc..23c45538f 100644 --- a/docs/content/commands/rclone_copy.md +++ b/docs/content/commands/rclone_copy.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone copy" description: "Copy files from source to dest, skipping already copied" slug: 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" --- -## rclone copy +# rclone copy Copy files from source to dest, skipping already copied -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_copyto.md b/docs/content/commands/rclone_copyto.md index 203a72f44..18eed5d66 100644 --- a/docs/content/commands/rclone_copyto.md +++ b/docs/content/commands/rclone_copyto.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone copyto" description: "Copy files from source to dest, skipping already copied" slug: 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" --- -## rclone copyto +# rclone copyto 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 @@ -46,7 +46,7 @@ destination. rclone copyto source:path dest:path [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_copyurl.md b/docs/content/commands/rclone_copyurl.md index 45c0ca7ef..4935a4ca6 100644 --- a/docs/content/commands/rclone_copyurl.md +++ b/docs/content/commands/rclone_copyurl.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone copyurl" description: "Copy url content to dest." slug: 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" --- -## rclone copyurl +# rclone copyurl Copy url content to dest. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_cryptcheck.md b/docs/content/commands/rclone_cryptcheck.md index 55e1d2d5c..0211d5522 100644 --- a/docs/content/commands/rclone_cryptcheck.md +++ b/docs/content/commands/rclone_cryptcheck.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone cryptcheck" description: "Cryptcheck checks the integrity of a crypted remote." slug: 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" --- -## rclone cryptcheck +# rclone cryptcheck Cryptcheck checks the integrity of a crypted remote. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_cryptdecode.md b/docs/content/commands/rclone_cryptdecode.md index aa68edab8..693033093 100644 --- a/docs/content/commands/rclone_cryptdecode.md +++ b/docs/content/commands/rclone_cryptdecode.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone cryptdecode" description: "Cryptdecode returns unencrypted file names." slug: 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" --- -## rclone cryptdecode +# rclone cryptdecode Cryptdecode returns unencrypted file names. -### Synopsis +## Synopsis rclone cryptdecode returns unencrypted file names when provided with @@ -29,7 +29,7 @@ use it like this rclone cryptdecode encryptedremote: encryptedfilename [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_dedupe.md b/docs/content/commands/rclone_dedupe.md index 16561fbab..7e933d9d0 100644 --- a/docs/content/commands/rclone_dedupe.md +++ b/docs/content/commands/rclone_dedupe.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone dedupe" description: "Interactively find duplicate files and delete/rename them." slug: 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" --- -## rclone dedupe +# rclone dedupe Interactively find duplicate files and delete/rename them. -### Synopsis +## Synopsis By default `dedupe` interactively finds duplicate files and offers to @@ -99,7 +99,7 @@ Or rclone dedupe [mode] remote:path [flags] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_delete.md b/docs/content/commands/rclone_delete.md index 86d43b06d..fa64e1f3b 100644 --- a/docs/content/commands/rclone_delete.md +++ b/docs/content/commands/rclone_delete.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone delete" description: "Remove the contents of path." slug: 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" --- -## rclone delete +# rclone delete Remove the contents of path. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_deletefile.md b/docs/content/commands/rclone_deletefile.md index c76029705..3c5d23950 100644 --- a/docs/content/commands/rclone_deletefile.md +++ b/docs/content/commands/rclone_deletefile.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone deletefile" description: "Remove a single file from remote." slug: 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" --- -## rclone deletefile +# rclone deletefile Remove a single file from remote. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_genautocomplete.md b/docs/content/commands/rclone_genautocomplete.md index ed9346264..958bec4af 100644 --- a/docs/content/commands/rclone_genautocomplete.md +++ b/docs/content/commands/rclone_genautocomplete.md @@ -1,23 +1,23 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone genautocomplete" description: "Output completion script for a given shell." slug: 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" --- -## rclone genautocomplete +# rclone genautocomplete Output completion script for a given shell. -### Synopsis +## Synopsis Generates a shell completion script for rclone. Run with --help to list the supported shells. -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. * [rclone genautocomplete bash](/commands/rclone_genautocomplete_bash/) - Output bash completion script for rclone. diff --git a/docs/content/commands/rclone_genautocomplete_bash.md b/docs/content/commands/rclone_genautocomplete_bash.md index be76195b0..2149119b2 100644 --- a/docs/content/commands/rclone_genautocomplete_bash.md +++ b/docs/content/commands/rclone_genautocomplete_bash.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone genautocomplete bash" description: "Output bash completion script for rclone." slug: 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" --- -## rclone genautocomplete bash +# rclone genautocomplete bash Output bash completion script for rclone. -### Synopsis +## Synopsis Generates a bash shell autocompletion script for rclone. @@ -33,7 +33,7 @@ there. rclone genautocomplete bash [output_file] [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. diff --git a/docs/content/commands/rclone_genautocomplete_fish.md b/docs/content/commands/rclone_genautocomplete_fish.md index d5ca19fcb..4ec23f01a 100644 --- a/docs/content/commands/rclone_genautocomplete_fish.md +++ b/docs/content/commands/rclone_genautocomplete_fish.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone genautocomplete fish" description: "Output fish completion script for rclone." slug: 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" --- -## rclone genautocomplete fish +# rclone genautocomplete fish Output fish completion script for rclone. -### Synopsis +## Synopsis Generates a fish autocompletion script for rclone. @@ -33,7 +33,7 @@ there. rclone genautocomplete fish [output_file] [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. diff --git a/docs/content/commands/rclone_genautocomplete_zsh.md b/docs/content/commands/rclone_genautocomplete_zsh.md index 78f1816c9..22082b1d1 100644 --- a/docs/content/commands/rclone_genautocomplete_zsh.md +++ b/docs/content/commands/rclone_genautocomplete_zsh.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone genautocomplete zsh" description: "Output zsh completion script for rclone." slug: 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" --- -## rclone genautocomplete zsh +# rclone genautocomplete zsh Output zsh completion script for rclone. -### Synopsis +## Synopsis Generates a zsh autocompletion script for rclone. @@ -33,7 +33,7 @@ there. rclone genautocomplete zsh [output_file] [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. diff --git a/docs/content/commands/rclone_gendocs.md b/docs/content/commands/rclone_gendocs.md index 5f4fc99cb..cd5e82b7b 100644 --- a/docs/content/commands/rclone_gendocs.md +++ b/docs/content/commands/rclone_gendocs.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone gendocs" description: "Output markdown docs for rclone to the directory supplied." slug: 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" --- -## rclone gendocs +# rclone gendocs Output markdown docs for rclone to the directory supplied. -### Synopsis +## Synopsis This produces markdown docs for the rclone commands to the directory @@ -21,7 +21,7 @@ rclone.org website. rclone gendocs output_directory [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_hashsum.md b/docs/content/commands/rclone_hashsum.md index bb174e52d..8127f1213 100644 --- a/docs/content/commands/rclone_hashsum.md +++ b/docs/content/commands/rclone_hashsum.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 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 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" --- -## 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 @@ -35,7 +35,7 @@ Then rclone hashsum remote:path [flags] ``` -### Options +## Options ``` --base64 Output base64 encoded hashsum @@ -44,7 +44,7 @@ rclone hashsum remote:path [flags] 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. diff --git a/docs/content/commands/rclone_link.md b/docs/content/commands/rclone_link.md index 6c6bf848c..e99a3a376 100644 --- a/docs/content/commands/rclone_link.md +++ b/docs/content/commands/rclone_link.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone link" description: "Generate public link to file/folder." slug: 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" --- -## rclone link +# rclone link Generate public link to file/folder. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_listremotes.md b/docs/content/commands/rclone_listremotes.md index 63b7535da..3b0af32d6 100644 --- a/docs/content/commands/rclone_listremotes.md +++ b/docs/content/commands/rclone_listremotes.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone listremotes" description: "List all the remotes in the config file." slug: 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" --- -## rclone listremotes +# rclone listremotes List all the remotes in the config file. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_ls.md b/docs/content/commands/rclone_ls.md index db44dc999..5407eba5e 100644 --- a/docs/content/commands/rclone_ls.md +++ b/docs/content/commands/rclone_ls.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone ls" description: "List the objects in the path with size and path." slug: 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" --- -## rclone ls +# rclone ls 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 @@ -52,7 +52,7 @@ the bucket based remotes). rclone ls remote:path [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_lsd.md b/docs/content/commands/rclone_lsd.md index 03b884450..c2a2c25fc 100644 --- a/docs/content/commands/rclone_lsd.md +++ b/docs/content/commands/rclone_lsd.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone lsd" description: "List all directories/containers/buckets in the path." slug: 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" --- -## rclone lsd +# rclone lsd List all directories/containers/buckets in the path. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_lsf.md b/docs/content/commands/rclone_lsf.md index 74cca7000..3311bd2ad 100644 --- a/docs/content/commands/rclone_lsf.md +++ b/docs/content/commands/rclone_lsf.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone lsf" description: "List directories and objects in remote:path formatted for parsing" slug: 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" --- -## rclone lsf +# rclone lsf List directories and objects in remote:path formatted for parsing -### Synopsis +## Synopsis List the contents of the source path (directories and objects) to @@ -135,7 +135,7 @@ the bucket based remotes). rclone lsf remote:path [flags] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_lsjson.md b/docs/content/commands/rclone_lsjson.md index 87dba57bc..0edf316f0 100644 --- a/docs/content/commands/rclone_lsjson.md +++ b/docs/content/commands/rclone_lsjson.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone lsjson" description: "List directories and objects in the path in JSON format." slug: 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" --- -## rclone lsjson +# rclone lsjson List directories and objects in the path in JSON format. -### Synopsis +## Synopsis List directories and objects in the path in JSON format. @@ -103,7 +103,7 @@ the bucket based remotes). rclone lsjson remote:path [flags] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_lsl.md b/docs/content/commands/rclone_lsl.md index fa1eec09c..f523517f8 100644 --- a/docs/content/commands/rclone_lsl.md +++ b/docs/content/commands/rclone_lsl.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone lsl" description: "List the objects in path with modification time, size and path." slug: 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" --- -## rclone lsl +# rclone lsl 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 @@ -52,7 +52,7 @@ the bucket based remotes). rclone lsl remote:path [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_md5sum.md b/docs/content/commands/rclone_md5sum.md index 24c945774..8011cfa9a 100644 --- a/docs/content/commands/rclone_md5sum.md +++ b/docs/content/commands/rclone_md5sum.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone md5sum" description: "Produces an md5sum file for all the objects in the path." slug: 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" --- -## rclone md5sum +# rclone md5sum 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 @@ -21,7 +21,7 @@ is in the same format as the standard md5sum tool produces. rclone md5sum remote:path [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_mkdir.md b/docs/content/commands/rclone_mkdir.md index 57fd278d6..1ec015e08 100644 --- a/docs/content/commands/rclone_mkdir.md +++ b/docs/content/commands/rclone_mkdir.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone mkdir" description: "Make the path if it doesn't already exist." slug: 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" --- -## rclone mkdir +# rclone mkdir Make the path if it doesn't already exist. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_mount.md b/docs/content/commands/rclone_mount.md index 253fffbc2..424ec39d5 100644 --- a/docs/content/commands/rclone_mount.md +++ b/docs/content/commands/rclone_mount.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone mount" description: "Mount the remote as file system on a mountpoint." slug: 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" --- -## rclone mount +# rclone mount Mount the remote as file system on a mountpoint. -### Synopsis +## Synopsis rclone mount allows Linux, FreeBSD, macOS and Windows to @@ -50,7 +50,7 @@ Stopping the mount manually: # OS X umount /path/to/local/mount -### Installing on Windows +## Installing on Windows To run rclone mount on Windows, you will need to 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 implementation of rclone mount for Windows. -#### Windows caveats +### Windows caveats Note that drives created as Administrator are not visible by other 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 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, 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) -### Limitations +## Limitations Without the use of "--vfs-cache-mode" this can only write files 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. -### rclone mount vs rclone sync/copy +## rclone mount vs rclone sync/copy File systems expect things to be 100% reliable, whereas cloud storage 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) 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 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. -### Filters +## Filters Note that all the rclone filters can be used to select a subset of the files to be visible in the mount. -### systemd +## systemd 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 @@ -176,7 +176,7 @@ after the mountpoint has been successfully set up. Units having the rclone mount service specified as a requirement 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. 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 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 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 -### File Buffering +## File Buffering The `--buffer-size` flag determines the amount of memory, 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 `--buffer-size * open files`. -### File Caching +## File Caching These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a @@ -275,7 +275,7 @@ for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache. -#### --vfs-cache-mode off +### --vfs-cache-mode off In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk. @@ -290,7 +290,7 @@ This will mean some operations are not possible * Open modes O_APPEND, O_TRUNC are ignored * If an upload fails it can't be retried -#### --vfs-cache-mode minimal +### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for @@ -303,7 +303,7 @@ These operations are not possible * Files opened for write only will ignore O_APPEND, O_TRUNC * If an upload fails it can't be retried -#### --vfs-cache-mode writes +### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk @@ -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. -#### --vfs-cache-mode full +### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first. @@ -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 --low-level-retries times. -### Case Sensitivity +## Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. @@ -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] ``` -### Options +## Options ``` --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-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) - --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 5ms) + --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) --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. @@ -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_move.md b/docs/content/commands/rclone_move.md index bba35aa30..2853b766b 100644 --- a/docs/content/commands/rclone_move.md +++ b/docs/content/commands/rclone_move.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone move" description: "Move files from source to dest." slug: 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" --- -## rclone move +# rclone move Move files from source to dest. -### Synopsis +## Synopsis 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 `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 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] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_moveto.md b/docs/content/commands/rclone_moveto.md index 52ac8fc62..556cefe7a 100644 --- a/docs/content/commands/rclone_moveto.md +++ b/docs/content/commands/rclone_moveto.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone moveto" description: "Move file or directory from source to dest." slug: 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" --- -## rclone moveto +# rclone moveto 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 @@ -49,7 +49,7 @@ transfer. rclone moveto source:path dest:path [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_ncdu.md b/docs/content/commands/rclone_ncdu.md index 176783045..02103e146 100644 --- a/docs/content/commands/rclone_ncdu.md +++ b/docs/content/commands/rclone_ncdu.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone ncdu" description: "Explore a remote with a text based user interface." slug: 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" --- -## rclone ncdu +# rclone ncdu Explore a remote with a text based user interface. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_obscure.md b/docs/content/commands/rclone_obscure.md index 92783b880..2ae7af971 100644 --- a/docs/content/commands/rclone_obscure.md +++ b/docs/content/commands/rclone_obscure.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone obscure" description: "Obscure password for use in the rclone.conf" slug: 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" --- -## rclone obscure +# rclone obscure Obscure password for use in the rclone.conf -### Synopsis +## Synopsis Obscure password for use in the rclone.conf @@ -18,7 +18,7 @@ Obscure password for use in the rclone.conf rclone obscure password [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_purge.md b/docs/content/commands/rclone_purge.md index 2b25b58a3..249890eba 100644 --- a/docs/content/commands/rclone_purge.md +++ b/docs/content/commands/rclone_purge.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone purge" description: "Remove the path and all of its contents." slug: 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" --- -## rclone purge +# rclone purge Remove the path and all of its contents. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_rc.md b/docs/content/commands/rclone_rc.md index 91510aa46..cf076481d 100644 --- a/docs/content/commands/rclone_rc.md +++ b/docs/content/commands/rclone_rc.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone rc" description: "Run a command against a running rclone." slug: 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" --- -## rclone rc +# rclone rc 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_rcat.md b/docs/content/commands/rclone_rcat.md index 0728f3c60..c604db76b 100644 --- a/docs/content/commands/rclone_rcat.md +++ b/docs/content/commands/rclone_rcat.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone rcat" description: "Copies standard input to file on remote." slug: 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" --- -## rclone rcat +# rclone rcat Copies standard input to file on remote. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_rcd.md b/docs/content/commands/rclone_rcd.md index 7c64e2826..8cdc2498f 100644 --- a/docs/content/commands/rclone_rcd.md +++ b/docs/content/commands/rclone_rcd.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone rcd" description: "Run rclone listening to remote control commands only." slug: 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" --- -## rclone rcd +# rclone rcd Run rclone listening to remote control commands only. -### Synopsis +## Synopsis 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 * [flags] ``` -### Options +## Options ``` -h, --help help for rcd @@ -36,7 +36,7 @@ rclone rcd * [flags] 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. diff --git a/docs/content/commands/rclone_rmdir.md b/docs/content/commands/rclone_rmdir.md index 779cfcba5..9fe0de2ca 100644 --- a/docs/content/commands/rclone_rmdir.md +++ b/docs/content/commands/rclone_rmdir.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone rmdir" description: "Remove the path if empty." slug: 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" --- -## rclone rmdir +# rclone rmdir Remove the path if empty. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_rmdirs.md b/docs/content/commands/rclone_rmdirs.md index 5e38ca125..e3d187e13 100644 --- a/docs/content/commands/rclone_rmdirs.md +++ b/docs/content/commands/rclone_rmdirs.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone rmdirs" description: "Remove empty directories under the path." slug: 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" --- -## rclone rmdirs +# rclone rmdirs Remove empty directories under the path. -### Synopsis +## Synopsis This removes any empty directories (or directories that only contain empty directories) under the path that it finds, including the path if @@ -27,7 +27,7 @@ empty directories in. rclone rmdirs remote:path [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_serve.md b/docs/content/commands/rclone_serve.md index 6b69efdac..3817e1266 100644 --- a/docs/content/commands/rclone_serve.md +++ b/docs/content/commands/rclone_serve.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone serve" description: "Serve a remote over a protocol." slug: 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" --- -## rclone serve +# rclone serve Serve a remote over a protocol. -### Synopsis +## Synopsis 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 @@ -24,7 +24,7 @@ Each subcommand has its own options which you can see in their help. rclone serve [opts] [flags] ``` -### Options +## Options ``` -h, --help help for serve @@ -32,7 +32,7 @@ rclone serve [opts] [flags] 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 serve dlna](/commands/rclone_serve_dlna/) - Serve remote:path over DLNA diff --git a/docs/content/commands/rclone_serve_dlna.md b/docs/content/commands/rclone_serve_dlna.md index 5401b7e72..ce9a62861 100644 --- a/docs/content/commands/rclone_serve_dlna.md +++ b/docs/content/commands/rclone_serve_dlna.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone serve dlna" description: "Serve remote:path over DLNA" slug: 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" --- -## rclone serve dlna +# rclone serve dlna Serve remote:path over DLNA -### Synopsis +## Synopsis 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 @@ -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. -### Server options +## Server options Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all @@ -34,7 +34,7 @@ default "rclone (hostname)". Use --log-trace in conjunction with -vv to enable additional debug logging of all UPNP traffic. -### Directory Cache +## Directory Cache Using the `--dir-cache-time` flag, you can set how long a directory should be considered up to date and not refreshed from the @@ -60,7 +60,7 @@ Or individual files or directories: rclone rc vfs/forget file=path/to/file dir=path/to/dir -### File Buffering +## File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. @@ -77,7 +77,7 @@ will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. -### File Caching +## File Caching These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a @@ -114,7 +114,7 @@ for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache. -#### --vfs-cache-mode off +### --vfs-cache-mode off In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk. @@ -129,7 +129,7 @@ This will mean some operations are not possible * Open modes O_APPEND, O_TRUNC are ignored * If an upload fails it can't be retried -#### --vfs-cache-mode minimal +### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for @@ -142,7 +142,7 @@ These operations are not possible * Files opened for write only will ignore O_APPEND, O_TRUNC * If an upload fails it can't be retried -#### --vfs-cache-mode writes +### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk @@ -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. -#### --vfs-cache-mode full +### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first. @@ -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 --low-level-retries times. -### Case Sensitivity +## Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. @@ -211,7 +211,7 @@ otherwise. If the flag is provided without a value, then it is "true". rclone serve dlna remote:path [flags] ``` -### Options +## Options ``` --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-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) - --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 5ms) + --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) ``` See the [global flags page](/flags/) for global options not listed here. -### SEE ALSO +## SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. diff --git a/docs/content/commands/rclone_serve_ftp.md b/docs/content/commands/rclone_serve_ftp.md index eb9f6517d..d8cffb3fd 100644 --- a/docs/content/commands/rclone_serve_ftp.md +++ b/docs/content/commands/rclone_serve_ftp.md @@ -1,23 +1,23 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone serve ftp" description: "Serve remote:path over FTP." slug: rclone_serve_ftp url: /commands/rclone_serve_ftp/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/ftp/ and as part of making a release run "make commanddocs" --- -## rclone serve ftp +# rclone serve ftp Serve remote:path over FTP. -### Synopsis +## Synopsis rclone serve ftp implements a basic ftp server to serve the remote over FTP protocol. This can be viewed with a ftp client or you can make a remote of type ftp to read and write it. -### Server options +## Server options Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all @@ -27,13 +27,13 @@ IPs. By default it only listens on localhost. You can use port If you set --addr to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info. -#### Authentication +### Authentication By default this will serve files without needing a login. You can set a single username and password with the --user and --pass flags. -### Directory Cache +## Directory Cache Using the `--dir-cache-time` flag, you can set how long a directory should be considered up to date and not refreshed from the @@ -59,7 +59,7 @@ Or individual files or directories: rclone rc vfs/forget file=path/to/file dir=path/to/dir -### File Buffering +## File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. @@ -76,7 +76,7 @@ will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. -### File Caching +## File Caching These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a @@ -113,7 +113,7 @@ for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache. -#### --vfs-cache-mode off +### --vfs-cache-mode off In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk. @@ -128,7 +128,7 @@ This will mean some operations are not possible * Open modes O_APPEND, O_TRUNC are ignored * If an upload fails it can't be retried -#### --vfs-cache-mode minimal +### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for @@ -141,7 +141,7 @@ These operations are not possible * Files opened for write only will ignore O_APPEND, O_TRUNC * If an upload fails it can't be retried -#### --vfs-cache-mode writes +### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk @@ -151,7 +151,7 @@ This mode should support all normal file system operations. If an upload fails it will be retried up to --low-level-retries times. -#### --vfs-cache-mode full +### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first. @@ -169,7 +169,7 @@ This mode should support all normal file system operations. If an upload or download fails it will be retried up to --low-level-retries times. -### Case Sensitivity +## Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. @@ -205,7 +205,7 @@ If the flag is not provided on command line, then its default value depends on the operating system where rclone runs: "true" on Windows and MacOS, "false" otherwise. If the flag is provided without a value, then it is "true". -### Auth Proxy +## Auth Proxy If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which @@ -291,7 +291,7 @@ backend that rclone supports. rclone serve ftp remote:path [flags] ``` -### Options +## Options ``` --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2121") @@ -319,13 +319,13 @@ rclone serve ftp remote:path [flags] --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) - --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 5ms) + --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) ``` See the [global flags page](/flags/) for global options not listed here. -### SEE ALSO +## SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. diff --git a/docs/content/commands/rclone_serve_http.md b/docs/content/commands/rclone_serve_http.md index 308ca7573..5b18d73c3 100644 --- a/docs/content/commands/rclone_serve_http.md +++ b/docs/content/commands/rclone_serve_http.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone serve http" description: "Serve the remote over HTTP." slug: 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" --- -## rclone serve http +# rclone serve http Serve the remote over HTTP. -### Synopsis +## Synopsis 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 @@ -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 control the stats printing. -### Server options +## Server options Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all @@ -72,7 +72,7 @@ to be used within the template to server pages: |-- .Size | Size in Bytes of the entry. | |-- .ModTime | The UTC timestamp of an entry. | -#### Authentication +### Authentication 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. -#### SSL/TLS +### SSL/TLS 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 wish to do client side certificate validation then you will need to 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 private key and --client-ca should be the PEM encoded client certificate authority certificate. -### Directory Cache +## Directory Cache Using the `--dir-cache-time` flag, you can set how long a directory should be considered up to date and not refreshed from the @@ -131,7 +131,7 @@ Or individual files or directories: rclone rc vfs/forget file=path/to/file dir=path/to/dir -### File Buffering +## File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. @@ -148,7 +148,7 @@ will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. -### File Caching +## File Caching These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a @@ -185,7 +185,7 @@ for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache. -#### --vfs-cache-mode off +### --vfs-cache-mode off In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk. @@ -200,7 +200,7 @@ This will mean some operations are not possible * Open modes O_APPEND, O_TRUNC are ignored * If an upload fails it can't be retried -#### --vfs-cache-mode minimal +### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for @@ -213,7 +213,7 @@ These operations are not possible * Files opened for write only will ignore O_APPEND, O_TRUNC * If an upload fails it can't be retried -#### --vfs-cache-mode writes +### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk @@ -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. -#### --vfs-cache-mode full +### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first. @@ -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 --low-level-retries times. -### Case Sensitivity +## Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. @@ -282,7 +282,7 @@ otherwise. If the flag is provided without a value, then it is "true". rclone serve http remote:path [flags] ``` -### Options +## Options ``` --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-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) - --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 5ms) + --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) ``` See the [global flags page](/flags/) for global options not listed here. -### SEE ALSO +## SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. diff --git a/docs/content/commands/rclone_serve_restic.md b/docs/content/commands/rclone_serve_restic.md index 8ba81d1ef..72b8a7f1b 100644 --- a/docs/content/commands/rclone_serve_restic.md +++ b/docs/content/commands/rclone_serve_restic.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone serve restic" description: "Serve the remote for restic's REST API." slug: 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" --- -## rclone serve restic +# rclone serve restic Serve the remote for restic's REST API. -### Synopsis +## Synopsis rclone serve restic implements restic's REST backend API 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 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). @@ -45,7 +45,7 @@ with use of the "--addr" flag. 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 instructions](http://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server) @@ -74,7 +74,7 @@ For example: duration: 0:00 snapshot 45c8fdd8 saved -#### Multiple repositories #### +### Multiple repositories #### 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 @@ -85,12 +85,12 @@ these **must** end with /. Eg $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ # backup user2 stuff -#### Private repositories #### +### Private repositories #### The "--private-repos" flag can be used to limit users to repositories starting with a path of "//". -### Server options +## Server options Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all @@ -138,7 +138,7 @@ to be used within the template to server pages: |-- .Size | Size in Bytes of the entry. | |-- .ModTime | The UTC timestamp of an entry. | -#### Authentication +### Authentication 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. -#### SSL/TLS +### SSL/TLS 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 wish to do client side certificate validation then you will need to 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 private key and --client-ca should be the PEM encoded client certificate authority certificate. @@ -176,7 +176,7 @@ certificate authority certificate. rclone serve restic remote:path [flags] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. diff --git a/docs/content/commands/rclone_serve_sftp.md b/docs/content/commands/rclone_serve_sftp.md index c2f20c312..0af03623c 100644 --- a/docs/content/commands/rclone_serve_sftp.md +++ b/docs/content/commands/rclone_serve_sftp.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone serve sftp" description: "Serve the remote over SFTP." slug: 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" --- -## rclone serve sftp +# rclone serve sftp Serve the remote over SFTP. -### Synopsis +## Synopsis 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 @@ -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. -### Directory Cache +## Directory Cache Using the `--dir-cache-time` flag, you can set how long a directory should be considered up to date and not refreshed from the @@ -70,7 +70,7 @@ Or individual files or directories: rclone rc vfs/forget file=path/to/file dir=path/to/dir -### File Buffering +## File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. @@ -87,7 +87,7 @@ will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. -### File Caching +## File Caching These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a @@ -124,7 +124,7 @@ for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache. -#### --vfs-cache-mode off +### --vfs-cache-mode off In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk. @@ -139,7 +139,7 @@ This will mean some operations are not possible * Open modes O_APPEND, O_TRUNC are ignored * If an upload fails it can't be retried -#### --vfs-cache-mode minimal +### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for @@ -152,7 +152,7 @@ These operations are not possible * Files opened for write only will ignore O_APPEND, O_TRUNC * If an upload fails it can't be retried -#### --vfs-cache-mode writes +### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk @@ -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. -#### --vfs-cache-mode full +### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first. @@ -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 --low-level-retries times. -### Case Sensitivity +## Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. @@ -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" otherwise. If the flag is provided without a value, then it is "true". -### Auth Proxy +## Auth Proxy If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which @@ -302,7 +302,7 @@ backend that rclone supports. rclone serve sftp remote:path [flags] ``` -### Options +## Options ``` --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-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) - --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 5ms) + --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) ``` See the [global flags page](/flags/) for global options not listed here. -### SEE ALSO +## SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. diff --git a/docs/content/commands/rclone_serve_webdav.md b/docs/content/commands/rclone_serve_webdav.md index c389fc714..8e55c8f03 100644 --- a/docs/content/commands/rclone_serve_webdav.md +++ b/docs/content/commands/rclone_serve_webdav.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone serve webdav" description: "Serve remote:path over webdav." slug: 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" --- -## rclone serve webdav +# rclone serve webdav Serve remote:path over webdav. -### Synopsis +## Synopsis 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 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 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. -### Server options +## Server options Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all @@ -80,7 +80,7 @@ to be used within the template to server pages: |-- .Size | Size in Bytes of the entry. | |-- .ModTime | The UTC timestamp of an entry. | -#### Authentication +### Authentication 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. -#### SSL/TLS +### SSL/TLS 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 wish to do client side certificate validation then you will need to 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 private key and --client-ca should be the PEM encoded client certificate authority certificate. -### Directory Cache +## Directory Cache Using the `--dir-cache-time` flag, you can set how long a directory should be considered up to date and not refreshed from the @@ -139,7 +139,7 @@ Or individual files or directories: rclone rc vfs/forget file=path/to/file dir=path/to/dir -### File Buffering +## File Buffering The `--buffer-size` flag determines the amount of memory, that will be used to buffer data in advance. @@ -156,7 +156,7 @@ will be used. The maximum memory used by rclone for buffering can be up to `--buffer-size * open files`. -### File Caching +## File Caching These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a @@ -193,7 +193,7 @@ for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache. -#### --vfs-cache-mode off +### --vfs-cache-mode off In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk. @@ -208,7 +208,7 @@ This will mean some operations are not possible * Open modes O_APPEND, O_TRUNC are ignored * If an upload fails it can't be retried -#### --vfs-cache-mode minimal +### --vfs-cache-mode minimal This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for @@ -221,7 +221,7 @@ These operations are not possible * Files opened for write only will ignore O_APPEND, O_TRUNC * If an upload fails it can't be retried -#### --vfs-cache-mode writes +### --vfs-cache-mode writes In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk @@ -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. -#### --vfs-cache-mode full +### --vfs-cache-mode full In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first. @@ -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 --low-level-retries times. -### Case Sensitivity +## Case Sensitivity Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file. @@ -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" otherwise. If the flag is provided without a value, then it is "true". -### Auth Proxy +## Auth Proxy If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which @@ -371,7 +371,7 @@ backend that rclone supports. rclone serve webdav remote:path [flags] ``` -### Options +## Options ``` --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-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) - --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 5ms) + --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) ``` See the [global flags page](/flags/) for global options not listed here. -### SEE ALSO +## SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. diff --git a/docs/content/commands/rclone_settier.md b/docs/content/commands/rclone_settier.md index 07145434f..228305b8f 100644 --- a/docs/content/commands/rclone_settier.md +++ b/docs/content/commands/rclone_settier.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone settier" description: "Changes storage class/tier of objects in remote." slug: 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" --- -## rclone settier +# rclone settier Changes storage class/tier of objects in remote. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_sha1sum.md b/docs/content/commands/rclone_sha1sum.md index 7a2224a6e..539534cc6 100644 --- a/docs/content/commands/rclone_sha1sum.md +++ b/docs/content/commands/rclone_sha1sum.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone sha1sum" description: "Produces an sha1sum file for all the objects in the path." slug: 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" --- -## rclone sha1sum +# rclone sha1sum 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 @@ -21,7 +21,7 @@ is in the same format as the standard sha1sum tool produces. rclone sha1sum remote:path [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_size.md b/docs/content/commands/rclone_size.md index 421a885dd..774e134eb 100644 --- a/docs/content/commands/rclone_size.md +++ b/docs/content/commands/rclone_size.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone size" description: "Prints the total size and number of objects in remote:path." slug: 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" --- -## rclone size +# rclone size Prints the total size and number of objects in remote:path. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_sync.md b/docs/content/commands/rclone_sync.md index f36062433..9d23f15ad 100644 --- a/docs/content/commands/rclone_sync.md +++ b/docs/content/commands/rclone_sync.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone sync" description: "Make source and dest identical, modifying destination only." slug: 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" --- -## rclone sync +# rclone sync Make source and dest identical, modifying destination only. -### Synopsis +## Synopsis Sync the source to the destination, changing the destination @@ -39,7 +39,7 @@ go there. rclone sync source:path dest:path [flags] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_touch.md b/docs/content/commands/rclone_touch.md index a8e18cfcb..4cab3a96d 100644 --- a/docs/content/commands/rclone_touch.md +++ b/docs/content/commands/rclone_touch.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone touch" description: "Create new file or change file modification time." slug: 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" --- -## rclone touch +# rclone touch Create new file or change file modification time. -### Synopsis +## Synopsis 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] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_tree.md b/docs/content/commands/rclone_tree.md index e35ce498d..248ad56b1 100644 --- a/docs/content/commands/rclone_tree.md +++ b/docs/content/commands/rclone_tree.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone tree" description: "List the contents of the remote in a tree like fashion." slug: 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" --- -## rclone tree +# rclone tree 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 @@ -41,7 +41,7 @@ short options as they conflict with rclone's short options. rclone tree remote:path [flags] ``` -### Options +## Options ``` -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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. diff --git a/docs/content/commands/rclone_version.md b/docs/content/commands/rclone_version.md index 5d554ec19..1a97fb700 100644 --- a/docs/content/commands/rclone_version.md +++ b/docs/content/commands/rclone_version.md @@ -1,16 +1,16 @@ --- -date: 2020-05-18T10:38:09+01:00 +date: 2020-05-22T09:52:00+01:00 title: "rclone version" description: "Show the version number." slug: 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" --- -## rclone version +# rclone version Show the version number. -### Synopsis +## Synopsis Show the version number, the go version and the architecture. @@ -45,7 +45,7 @@ Or rclone version [flags] ``` -### Options +## Options ``` --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 ALSO +## SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.