From 4ee6de5c3ea9e2f9b3e5446c040640b8830ea497 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Thu, 20 Jun 2019 16:18:02 +0100 Subject: [PATCH] docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273 --- Makefile | 2 +- bin/make_manual.py | 1 + cmd/gendocs/gendocs.go | 60 ++- cmd/help.go | 40 +- docs/content/commands/rclone.md | 5 +- docs/content/commands/rclone_about.md | 5 +- docs/content/commands/rclone_authorize.md | 5 +- docs/content/commands/rclone_cachestats.md | 5 +- docs/content/commands/rclone_cat.md | 5 +- docs/content/commands/rclone_check.md | 5 +- docs/content/commands/rclone_cleanup.md | 5 +- docs/content/commands/rclone_config.md | 5 +- docs/content/commands/rclone_config_create.md | 5 +- docs/content/commands/rclone_config_delete.md | 5 +- docs/content/commands/rclone_config_dump.md | 5 +- docs/content/commands/rclone_config_edit.md | 5 +- docs/content/commands/rclone_config_file.md | 5 +- .../commands/rclone_config_password.md | 5 +- .../commands/rclone_config_providers.md | 5 +- docs/content/commands/rclone_config_show.md | 5 +- docs/content/commands/rclone_config_update.md | 5 +- docs/content/commands/rclone_copy.md | 5 +- docs/content/commands/rclone_copyto.md | 5 +- docs/content/commands/rclone_copyurl.md | 5 +- docs/content/commands/rclone_cryptcheck.md | 5 +- docs/content/commands/rclone_cryptdecode.md | 5 +- docs/content/commands/rclone_dbhashsum.md | 5 +- docs/content/commands/rclone_dedupe.md | 5 +- docs/content/commands/rclone_delete.md | 5 +- docs/content/commands/rclone_deletefile.md | 5 +- .../commands/rclone_genautocomplete.md | 5 +- .../commands/rclone_genautocomplete_bash.md | 5 +- .../commands/rclone_genautocomplete_zsh.md | 5 +- docs/content/commands/rclone_gendocs.md | 5 +- docs/content/commands/rclone_hashsum.md | 5 +- docs/content/commands/rclone_link.md | 5 +- docs/content/commands/rclone_listremotes.md | 5 +- docs/content/commands/rclone_ls.md | 5 +- docs/content/commands/rclone_lsd.md | 5 +- docs/content/commands/rclone_lsf.md | 5 +- docs/content/commands/rclone_lsjson.md | 5 +- docs/content/commands/rclone_lsl.md | 5 +- docs/content/commands/rclone_md5sum.md | 5 +- docs/content/commands/rclone_mkdir.md | 5 +- docs/content/commands/rclone_mount.md | 5 +- docs/content/commands/rclone_move.md | 5 +- docs/content/commands/rclone_moveto.md | 5 +- docs/content/commands/rclone_ncdu.md | 5 +- docs/content/commands/rclone_obscure.md | 5 +- docs/content/commands/rclone_purge.md | 5 +- docs/content/commands/rclone_rc.md | 5 +- docs/content/commands/rclone_rcat.md | 5 +- docs/content/commands/rclone_rcd.md | 5 +- docs/content/commands/rclone_rmdir.md | 5 +- docs/content/commands/rclone_rmdirs.md | 5 +- docs/content/commands/rclone_serve.md | 5 +- docs/content/commands/rclone_serve_dlna.md | 5 +- docs/content/commands/rclone_serve_ftp.md | 5 +- docs/content/commands/rclone_serve_http.md | 5 +- docs/content/commands/rclone_serve_restic.md | 5 +- docs/content/commands/rclone_serve_sftp.md | 5 +- docs/content/commands/rclone_serve_webdav.md | 5 +- docs/content/commands/rclone_settier.md | 5 +- docs/content/commands/rclone_sha1sum.md | 5 +- docs/content/commands/rclone_size.md | 5 +- docs/content/commands/rclone_sync.md | 5 +- docs/content/commands/rclone_touch.md | 5 +- docs/content/commands/rclone_tree.md | 5 +- docs/content/commands/rclone_version.md | 5 +- docs/content/flags.md | 346 ++++++++++++++++++ docs/layouts/chrome/navbar.html | 1 + 71 files changed, 640 insertions(+), 135 deletions(-) create mode 100755 docs/content/flags.md diff --git a/Makefile b/Makefile index 3cefc2625..4274a2108 100644 --- a/Makefile +++ b/Makefile @@ -95,7 +95,7 @@ MANUAL.txt: MANUAL.md pandoc -s --from markdown --to plain MANUAL.md -o MANUAL.txt commanddocs: rclone - XDG_CACHE_HOME="" XDG_CONFIG_HOME="" HOME="\$$HOME" USER="\$$USER" rclone gendocs docs/content/commands/ + XDG_CACHE_HOME="" XDG_CONFIG_HOME="" HOME="\$$HOME" USER="\$$USER" rclone gendocs docs/content/ backenddocs: rclone bin/make_backend_docs.py XDG_CACHE_HOME="" XDG_CONFIG_HOME="" HOME="\$$HOME" USER="\$$USER" ./bin/make_backend_docs.py diff --git a/bin/make_manual.py b/bin/make_manual.py index 92092809a..e03b03412 100755 --- a/bin/make_manual.py +++ b/bin/make_manual.py @@ -20,6 +20,7 @@ docs = [ "filtering.md", "rc.md", "overview.md", + "flags.md", # Keep these alphabetical by full name "alias.md", diff --git a/cmd/gendocs/gendocs.go b/cmd/gendocs/gendocs.go index 3068a2536..e9071ea92 100644 --- a/cmd/gendocs/gendocs.go +++ b/cmd/gendocs/gendocs.go @@ -1,7 +1,9 @@ package gendocs import ( + "bytes" "fmt" + "io/ioutil" "os" "path" "path/filepath" @@ -35,12 +37,32 @@ supplied. These are in a format suitable for hugo to render into the rclone.org website.`, RunE: func(command *cobra.Command, args []string) error { cmd.CheckArgs(1, 1, command, args) - out := args[0] + now := time.Now().Format(time.RFC3339) + + // Create the directory structure + root := args[0] + out := filepath.Join(root, "commands") err := os.MkdirAll(out, 0777) if err != nil { return err } - now := time.Now().Format(time.RFC3339) + + // Write the flags page + var buf bytes.Buffer + cmd.Root.SetOutput(&buf) + cmd.Root.SetArgs([]string{"help", "flags"}) + cmd.GeneratingDocs = true + err = cmd.Root.Execute() + if err != nil { + return err + } + flagsHelp := strings.Replace(buf.String(), "YYYY-MM-DD", now, -1) + err = ioutil.WriteFile(filepath.Join(root, "flags.md"), []byte(flagsHelp), 0777) + if err != nil { + return err + } + + // markup for the docs files prepender := func(filename string) string { name := filepath.Base(filename) base := strings.TrimSuffix(name, path.Ext(name)) @@ -51,10 +73,42 @@ rclone.org website.`, base := strings.TrimSuffix(name, path.Ext(name)) return "/commands/" + strings.ToLower(base) + "/" } + // Hide all of the root entries flags cmd.Root.Flags().VisitAll(func(flag *pflag.Flag) { flag.Hidden = true }) - return doc.GenMarkdownTreeCustom(cmd.Root, out, prepender, linkHandler) + err = doc.GenMarkdownTreeCustom(cmd.Root, out, prepender, linkHandler) + if err != nil { + return err + } + + // 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 { + return err + } + if !info.IsDir() { + b, err := ioutil.ReadFile(path) + if err != nil { + return err + } + doc := string(b) + doc = strings.Replace(doc, "\n### SEE ALSO", ` +See the [global flags page](/flags/) for global options not listed here. + +### SEE ALSO`, 1) + err = ioutil.WriteFile(path, []byte(doc), 0777) + if err != nil { + return err + } + } + return nil + }) + if err != nil { + return err + } + + return nil }, } diff --git a/cmd/help.go b/cmd/help.go index bb5d83cdf..17d0c120b 100644 --- a/cmd/help.go +++ b/cmd/help.go @@ -33,6 +33,7 @@ documentation, changelog and configuration walkthroughs. atexit.Run() }, BashCompletionFunction: bashCompletionFunc, + DisableAutoGenTag: true, } const ( @@ -74,6 +75,10 @@ __rclone_custom_func() { ` ) +// GeneratingDocs is set by rclone gendocs to alter the format of the +// output suitable for the documentation. +var GeneratingDocs = false + // root help command var helpCommand = &cobra.Command{ Use: "help", @@ -100,7 +105,11 @@ var helpFlags = &cobra.Command{ } flagsRe = re } - Root.SetOutput(os.Stdout) + if GeneratingDocs { + Root.SetUsageTemplate(docFlagsTemplate) + } else { + Root.SetOutput(os.Stdout) + } _ = command.Usage() }, } @@ -222,6 +231,35 @@ Use "rclone help flags" for to see the global flags. Use "rclone help backends" for a list of supported services. ` +var docFlagsTemplate = `--- +title: "Global Flags" +description: "Rclone Global Flags" +date: "YYYY-MM-DD" +--- + +# Global Flags + +This describes the global flags available to every rclone command +split into two groups, non backend and backend flags. + +## Non Backend Flags + +These flags are available for every command. + +` + "```" + ` +{{(backendFlags . false).FlagUsages | trimTrailingWhitespaces}} +` + "```" + ` + +## Backend Flags + +These flags are available for every command. They control the backends +and may be set in the config file. + +` + "```" + ` +{{(backendFlags . true).FlagUsages | trimTrailingWhitespaces}} +` + "```" + ` +` + // show all the backends func showBackends() { fmt.Printf("All rclone backends:\n\n") diff --git a/docs/content/commands/rclone.md b/docs/content/commands/rclone.md index a23a742ee..0b5a182e2 100644 --- a/docs/content/commands/rclone.md +++ b/docs/content/commands/rclone.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone" slug: rclone url: /commands/rclone/ @@ -29,6 +29,8 @@ rclone [flags] -h, --help help for rclone ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone about](/commands/rclone_about/) - Get quota information from the remote. @@ -79,4 +81,3 @@ rclone [flags] * [rclone tree](/commands/rclone_tree/) - List the contents of the remote in a tree like fashion. * [rclone version](/commands/rclone_version/) - Show the version number. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_about.md b/docs/content/commands/rclone_about.md index 9deadd9a0..00a41045f 100644 --- a/docs/content/commands/rclone_about.md +++ b/docs/content/commands/rclone_about.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone about" slug: rclone_about url: /commands/rclone_about/ @@ -66,8 +66,9 @@ rclone about remote: [flags] --json Format output as JSON ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_authorize.md b/docs/content/commands/rclone_authorize.md index 9f567d5bb..d9d122090 100644 --- a/docs/content/commands/rclone_authorize.md +++ b/docs/content/commands/rclone_authorize.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone authorize" slug: rclone_authorize url: /commands/rclone_authorize/ @@ -25,8 +25,9 @@ rclone authorize [flags] -h, --help help for authorize ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_cachestats.md b/docs/content/commands/rclone_cachestats.md index 164aed93c..4139908f6 100644 --- a/docs/content/commands/rclone_cachestats.md +++ b/docs/content/commands/rclone_cachestats.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone cachestats" slug: rclone_cachestats url: /commands/rclone_cachestats/ @@ -24,8 +24,9 @@ rclone cachestats source: [flags] -h, --help help for cachestats ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_cat.md b/docs/content/commands/rclone_cat.md index 984f86525..bcb54e215 100644 --- a/docs/content/commands/rclone_cat.md +++ b/docs/content/commands/rclone_cat.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone cat" slug: rclone_cat url: /commands/rclone_cat/ @@ -46,8 +46,9 @@ rclone cat remote:path [flags] --tail int Only print the last N characters. ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_check.md b/docs/content/commands/rclone_check.md index 1549a90e9..2537db5d8 100644 --- a/docs/content/commands/rclone_check.md +++ b/docs/content/commands/rclone_check.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone check" slug: rclone_check url: /commands/rclone_check/ @@ -40,8 +40,9 @@ rclone check source:path dest:path [flags] --one-way Check one way only, source files must exist on remote ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_cleanup.md b/docs/content/commands/rclone_cleanup.md index bb896da09..2c84c96ec 100644 --- a/docs/content/commands/rclone_cleanup.md +++ b/docs/content/commands/rclone_cleanup.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone cleanup" slug: rclone_cleanup url: /commands/rclone_cleanup/ @@ -25,8 +25,9 @@ rclone cleanup remote:path [flags] -h, --help help for cleanup ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_config.md b/docs/content/commands/rclone_config.md index 2dc80388f..42b9f5dc4 100644 --- a/docs/content/commands/rclone_config.md +++ b/docs/content/commands/rclone_config.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone config" slug: rclone_config url: /commands/rclone_config/ @@ -25,6 +25,8 @@ rclone config [flags] -h, --help help for config ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. @@ -38,4 +40,3 @@ rclone config [flags] * [rclone config show](/commands/rclone_config_show/) - Print (decrypted) config file, or the config for a single remote. * [rclone config update](/commands/rclone_config_update/) - Update options in an existing remote. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_config_create.md b/docs/content/commands/rclone_config_create.md index 155f1bcc8..ce56d0a2b 100644 --- a/docs/content/commands/rclone_config_create.md +++ b/docs/content/commands/rclone_config_create.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone config create" slug: rclone_config_create url: /commands/rclone_config_create/ @@ -42,8 +42,9 @@ rclone config create [ ]* [flags] -h, --help help for create ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_config_delete.md b/docs/content/commands/rclone_config_delete.md index e9f4b8a80..141cddd52 100644 --- a/docs/content/commands/rclone_config_delete.md +++ b/docs/content/commands/rclone_config_delete.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone config delete" slug: rclone_config_delete url: /commands/rclone_config_delete/ @@ -22,8 +22,9 @@ rclone config delete [flags] -h, --help help for delete ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_config_dump.md b/docs/content/commands/rclone_config_dump.md index 2ea26b167..7d8d239e7 100644 --- a/docs/content/commands/rclone_config_dump.md +++ b/docs/content/commands/rclone_config_dump.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone config dump" slug: rclone_config_dump url: /commands/rclone_config_dump/ @@ -22,8 +22,9 @@ rclone config dump [flags] -h, --help help for dump ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_config_edit.md b/docs/content/commands/rclone_config_edit.md index 55190f226..1b45cdf72 100644 --- a/docs/content/commands/rclone_config_edit.md +++ b/docs/content/commands/rclone_config_edit.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone config edit" slug: rclone_config_edit url: /commands/rclone_config_edit/ @@ -25,8 +25,9 @@ rclone config edit [flags] -h, --help help for edit ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_config_file.md b/docs/content/commands/rclone_config_file.md index 6a60b863e..9f1df9ef9 100644 --- a/docs/content/commands/rclone_config_file.md +++ b/docs/content/commands/rclone_config_file.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone config file" slug: rclone_config_file url: /commands/rclone_config_file/ @@ -22,8 +22,9 @@ rclone config file [flags] -h, --help help for file ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_config_password.md b/docs/content/commands/rclone_config_password.md index b4605af89..333dd4211 100644 --- a/docs/content/commands/rclone_config_password.md +++ b/docs/content/commands/rclone_config_password.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone config password" slug: rclone_config_password url: /commands/rclone_config_password/ @@ -32,8 +32,9 @@ rclone config password [ ]+ [flags] -h, --help help for password ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_config_providers.md b/docs/content/commands/rclone_config_providers.md index f0de6b01d..c7dec02f0 100644 --- a/docs/content/commands/rclone_config_providers.md +++ b/docs/content/commands/rclone_config_providers.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone config providers" slug: rclone_config_providers url: /commands/rclone_config_providers/ @@ -22,8 +22,9 @@ rclone config providers [flags] -h, --help help for providers ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_config_show.md b/docs/content/commands/rclone_config_show.md index fd40f9b85..e28686463 100644 --- a/docs/content/commands/rclone_config_show.md +++ b/docs/content/commands/rclone_config_show.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone config show" slug: rclone_config_show url: /commands/rclone_config_show/ @@ -22,8 +22,9 @@ rclone config show [] [flags] -h, --help help for show ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_config_update.md b/docs/content/commands/rclone_config_update.md index 83ef29474..98a812caa 100644 --- a/docs/content/commands/rclone_config_update.md +++ b/docs/content/commands/rclone_config_update.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone config update" slug: rclone_config_update url: /commands/rclone_config_update/ @@ -38,8 +38,9 @@ rclone config update [ ]+ [flags] -h, --help help for update ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_copy.md b/docs/content/commands/rclone_copy.md index f7dde01d6..97c363c05 100644 --- a/docs/content/commands/rclone_copy.md +++ b/docs/content/commands/rclone_copy.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone copy" slug: rclone_copy url: /commands/rclone_copy/ @@ -72,8 +72,9 @@ rclone copy source:path dest:path [flags] -h, --help help for copy ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_copyto.md b/docs/content/commands/rclone_copyto.md index dcba537bf..1cb6ac66e 100644 --- a/docs/content/commands/rclone_copyto.md +++ b/docs/content/commands/rclone_copyto.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone copyto" slug: rclone_copyto url: /commands/rclone_copyto/ @@ -50,8 +50,9 @@ rclone copyto source:path dest:path [flags] -h, --help help for copyto ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_copyurl.md b/docs/content/commands/rclone_copyurl.md index 200a7c3d9..e30929c09 100644 --- a/docs/content/commands/rclone_copyurl.md +++ b/docs/content/commands/rclone_copyurl.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone copyurl" slug: rclone_copyurl url: /commands/rclone_copyurl/ @@ -25,8 +25,9 @@ rclone copyurl https://example.com dest:path [flags] -h, --help help for copyurl ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_cryptcheck.md b/docs/content/commands/rclone_cryptcheck.md index fc22e71bd..404cf13ef 100644 --- a/docs/content/commands/rclone_cryptcheck.md +++ b/docs/content/commands/rclone_cryptcheck.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone cryptcheck" slug: rclone_cryptcheck url: /commands/rclone_cryptcheck/ @@ -50,8 +50,9 @@ rclone cryptcheck remote:path cryptedremote:path [flags] --one-way Check one way only, source files must exist on destination ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_cryptdecode.md b/docs/content/commands/rclone_cryptdecode.md index 227ad6538..9725d18b3 100644 --- a/docs/content/commands/rclone_cryptdecode.md +++ b/docs/content/commands/rclone_cryptdecode.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone cryptdecode" slug: rclone_cryptdecode url: /commands/rclone_cryptdecode/ @@ -34,8 +34,9 @@ rclone cryptdecode encryptedremote: encryptedfilename [flags] --reverse Reverse cryptdecode, encrypts filenames ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_dbhashsum.md b/docs/content/commands/rclone_dbhashsum.md index 9ffd652e6..cfed8946c 100644 --- a/docs/content/commands/rclone_dbhashsum.md +++ b/docs/content/commands/rclone_dbhashsum.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone dbhashsum" slug: rclone_dbhashsum url: /commands/rclone_dbhashsum/ @@ -27,8 +27,9 @@ rclone dbhashsum remote:path [flags] -h, --help help for dbhashsum ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_dedupe.md b/docs/content/commands/rclone_dedupe.md index 30ed31c37..3a36895f5 100644 --- a/docs/content/commands/rclone_dedupe.md +++ b/docs/content/commands/rclone_dedupe.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone dedupe" slug: rclone_dedupe url: /commands/rclone_dedupe/ @@ -103,8 +103,9 @@ rclone dedupe [mode] remote:path [flags] -h, --help help for dedupe ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_delete.md b/docs/content/commands/rclone_delete.md index 3f2b1f6a1..584c7d4cc 100644 --- a/docs/content/commands/rclone_delete.md +++ b/docs/content/commands/rclone_delete.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone delete" slug: rclone_delete url: /commands/rclone_delete/ @@ -43,8 +43,9 @@ rclone delete remote:path [flags] -h, --help help for delete ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_deletefile.md b/docs/content/commands/rclone_deletefile.md index 1cf478093..5897162e4 100644 --- a/docs/content/commands/rclone_deletefile.md +++ b/docs/content/commands/rclone_deletefile.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone deletefile" slug: rclone_deletefile url: /commands/rclone_deletefile/ @@ -26,8 +26,9 @@ rclone deletefile remote:path [flags] -h, --help help for deletefile ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_genautocomplete.md b/docs/content/commands/rclone_genautocomplete.md index 6ee5ba670..a9faf8c2d 100644 --- a/docs/content/commands/rclone_genautocomplete.md +++ b/docs/content/commands/rclone_genautocomplete.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone genautocomplete" slug: rclone_genautocomplete url: /commands/rclone_genautocomplete/ @@ -21,10 +21,11 @@ Run with --help to list the supported shells. -h, --help help for genautocomplete ``` +See the [global flags page](/flags/) for global options not listed here. + ### 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. * [rclone genautocomplete zsh](/commands/rclone_genautocomplete_zsh/) - Output zsh completion script for rclone. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_genautocomplete_bash.md b/docs/content/commands/rclone_genautocomplete_bash.md index f3bc5f91c..1245b4540 100644 --- a/docs/content/commands/rclone_genautocomplete_bash.md +++ b/docs/content/commands/rclone_genautocomplete_bash.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone genautocomplete bash" slug: rclone_genautocomplete_bash url: /commands/rclone_genautocomplete_bash/ @@ -37,8 +37,9 @@ rclone genautocomplete bash [output_file] [flags] -h, --help help for bash ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_genautocomplete_zsh.md b/docs/content/commands/rclone_genautocomplete_zsh.md index 09fa8ab00..024fb90e8 100644 --- a/docs/content/commands/rclone_genautocomplete_zsh.md +++ b/docs/content/commands/rclone_genautocomplete_zsh.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone genautocomplete zsh" slug: rclone_genautocomplete_zsh url: /commands/rclone_genautocomplete_zsh/ @@ -37,8 +37,9 @@ rclone genautocomplete zsh [output_file] [flags] -h, --help help for zsh ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_gendocs.md b/docs/content/commands/rclone_gendocs.md index 29bd804d7..b8cc4d0b2 100644 --- a/docs/content/commands/rclone_gendocs.md +++ b/docs/content/commands/rclone_gendocs.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone gendocs" slug: rclone_gendocs url: /commands/rclone_gendocs/ @@ -25,8 +25,9 @@ rclone gendocs output_directory [flags] -h, --help help for gendocs ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_hashsum.md b/docs/content/commands/rclone_hashsum.md index 5f2b2dd7d..2462f8b6c 100644 --- a/docs/content/commands/rclone_hashsum.md +++ b/docs/content/commands/rclone_hashsum.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone hashsum" slug: rclone_hashsum url: /commands/rclone_hashsum/ @@ -39,8 +39,9 @@ rclone hashsum remote:path [flags] -h, --help help for hashsum ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_link.md b/docs/content/commands/rclone_link.md index ae1cd610e..be2283a27 100644 --- a/docs/content/commands/rclone_link.md +++ b/docs/content/commands/rclone_link.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone link" slug: rclone_link url: /commands/rclone_link/ @@ -32,8 +32,9 @@ rclone link remote:path [flags] -h, --help help for link ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_listremotes.md b/docs/content/commands/rclone_listremotes.md index bc7e2d99e..c9a9019e9 100644 --- a/docs/content/commands/rclone_listremotes.md +++ b/docs/content/commands/rclone_listremotes.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone listremotes" slug: rclone_listremotes url: /commands/rclone_listremotes/ @@ -27,8 +27,9 @@ rclone listremotes [flags] --long Show the type as well as names. ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_ls.md b/docs/content/commands/rclone_ls.md index a04d51eb2..a323c5ec2 100644 --- a/docs/content/commands/rclone_ls.md +++ b/docs/content/commands/rclone_ls.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone ls" slug: rclone_ls url: /commands/rclone_ls/ @@ -56,8 +56,9 @@ rclone ls remote:path [flags] -h, --help help for ls ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_lsd.md b/docs/content/commands/rclone_lsd.md index cb42c676f..3d9269424 100644 --- a/docs/content/commands/rclone_lsd.md +++ b/docs/content/commands/rclone_lsd.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone lsd" slug: rclone_lsd url: /commands/rclone_lsd/ @@ -67,8 +67,9 @@ rclone lsd remote:path [flags] -R, --recursive Recurse into the listing. ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_lsf.md b/docs/content/commands/rclone_lsf.md index 96bda7416..1091ed1d5 100644 --- a/docs/content/commands/rclone_lsf.md +++ b/docs/content/commands/rclone_lsf.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone lsf" slug: rclone_lsf url: /commands/rclone_lsf/ @@ -148,8 +148,9 @@ rclone lsf remote:path [flags] -s, --separator string Separator for the items in the format. (default ";") ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_lsjson.md b/docs/content/commands/rclone_lsjson.md index 8f515855e..631aff8b4 100644 --- a/docs/content/commands/rclone_lsjson.md +++ b/docs/content/commands/rclone_lsjson.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone lsjson" slug: rclone_lsjson url: /commands/rclone_lsjson/ @@ -104,8 +104,9 @@ rclone lsjson remote:path [flags] -R, --recursive Recurse into the listing. ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_lsl.md b/docs/content/commands/rclone_lsl.md index c93a2b069..0914ecf8e 100644 --- a/docs/content/commands/rclone_lsl.md +++ b/docs/content/commands/rclone_lsl.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone lsl" slug: rclone_lsl url: /commands/rclone_lsl/ @@ -56,8 +56,9 @@ rclone lsl remote:path [flags] -h, --help help for lsl ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_md5sum.md b/docs/content/commands/rclone_md5sum.md index fa59aa929..61a157c83 100644 --- a/docs/content/commands/rclone_md5sum.md +++ b/docs/content/commands/rclone_md5sum.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone md5sum" slug: rclone_md5sum url: /commands/rclone_md5sum/ @@ -25,8 +25,9 @@ rclone md5sum remote:path [flags] -h, --help help for md5sum ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_mkdir.md b/docs/content/commands/rclone_mkdir.md index d4a73e56f..9bdee3457 100644 --- a/docs/content/commands/rclone_mkdir.md +++ b/docs/content/commands/rclone_mkdir.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone mkdir" slug: rclone_mkdir url: /commands/rclone_mkdir/ @@ -22,8 +22,9 @@ rclone mkdir remote:path [flags] -h, --help help for mkdir ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_mount.md b/docs/content/commands/rclone_mount.md index c7d3e3d3a..3a923fbbe 100644 --- a/docs/content/commands/rclone_mount.md +++ b/docs/content/commands/rclone_mount.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone mount" slug: rclone_mount url: /commands/rclone_mount/ @@ -331,8 +331,9 @@ rclone mount remote:path /path/to/mountpoint [flags] --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_move.md b/docs/content/commands/rclone_move.md index a765563bc..83f9c264a 100644 --- a/docs/content/commands/rclone_move.md +++ b/docs/content/commands/rclone_move.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone move" slug: rclone_move url: /commands/rclone_move/ @@ -50,8 +50,9 @@ rclone move source:path dest:path [flags] -h, --help help for move ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_moveto.md b/docs/content/commands/rclone_moveto.md index 534a8750e..69ff931bd 100644 --- a/docs/content/commands/rclone_moveto.md +++ b/docs/content/commands/rclone_moveto.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone moveto" slug: rclone_moveto url: /commands/rclone_moveto/ @@ -53,8 +53,9 @@ rclone moveto source:path dest:path [flags] -h, --help help for moveto ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_ncdu.md b/docs/content/commands/rclone_ncdu.md index d0e239f1f..2b8fa195c 100644 --- a/docs/content/commands/rclone_ncdu.md +++ b/docs/content/commands/rclone_ncdu.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone ncdu" slug: rclone_ncdu url: /commands/rclone_ncdu/ @@ -53,8 +53,9 @@ rclone ncdu remote:path [flags] -h, --help help for ncdu ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_obscure.md b/docs/content/commands/rclone_obscure.md index 62a620df1..6cb31de19 100644 --- a/docs/content/commands/rclone_obscure.md +++ b/docs/content/commands/rclone_obscure.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone obscure" slug: rclone_obscure url: /commands/rclone_obscure/ @@ -22,8 +22,9 @@ rclone obscure password [flags] -h, --help help for obscure ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_purge.md b/docs/content/commands/rclone_purge.md index c46e5c003..10c77e768 100644 --- a/docs/content/commands/rclone_purge.md +++ b/docs/content/commands/rclone_purge.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone purge" slug: rclone_purge url: /commands/rclone_purge/ @@ -26,8 +26,9 @@ rclone purge remote:path [flags] -h, --help help for purge ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_rc.md b/docs/content/commands/rclone_rc.md index 55388ba02..37c67bfd5 100644 --- a/docs/content/commands/rclone_rc.md +++ b/docs/content/commands/rclone_rc.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone rc" slug: rclone_rc url: /commands/rclone_rc/ @@ -54,8 +54,9 @@ rclone rc commands parameter [flags] --user string Username to use to rclone remote control. ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_rcat.md b/docs/content/commands/rclone_rcat.md index e25061fe0..8873865dc 100644 --- a/docs/content/commands/rclone_rcat.md +++ b/docs/content/commands/rclone_rcat.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone rcat" slug: rclone_rcat url: /commands/rclone_rcat/ @@ -44,8 +44,9 @@ rclone rcat remote:path [flags] -h, --help help for rcat ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_rcd.md b/docs/content/commands/rclone_rcd.md index dc02753af..679b0687e 100644 --- a/docs/content/commands/rclone_rcd.md +++ b/docs/content/commands/rclone_rcd.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone rcd" slug: rclone_rcd url: /commands/rclone_rcd/ @@ -32,8 +32,9 @@ rclone rcd * [flags] -h, --help help for rcd ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_rmdir.md b/docs/content/commands/rclone_rmdir.md index ae4c9a7e3..594c57548 100644 --- a/docs/content/commands/rclone_rmdir.md +++ b/docs/content/commands/rclone_rmdir.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone rmdir" slug: rclone_rmdir url: /commands/rclone_rmdir/ @@ -24,8 +24,9 @@ rclone rmdir remote:path [flags] -h, --help help for rmdir ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_rmdirs.md b/docs/content/commands/rclone_rmdirs.md index 3125b3c1a..7f87e23d2 100644 --- a/docs/content/commands/rclone_rmdirs.md +++ b/docs/content/commands/rclone_rmdirs.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone rmdirs" slug: rclone_rmdirs url: /commands/rclone_rmdirs/ @@ -32,8 +32,9 @@ rclone rmdirs remote:path [flags] --leave-root Do not remove root directory if empty ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_serve.md b/docs/content/commands/rclone_serve.md index a9e1706c5..845cce00d 100644 --- a/docs/content/commands/rclone_serve.md +++ b/docs/content/commands/rclone_serve.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone serve" slug: rclone_serve url: /commands/rclone_serve/ @@ -28,6 +28,8 @@ rclone serve [opts] [flags] -h, --help help for serve ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. @@ -38,4 +40,3 @@ rclone serve [opts] [flags] * [rclone serve sftp](/commands/rclone_serve_sftp/) - Serve the remote over SFTP. * [rclone serve webdav](/commands/rclone_serve_webdav/) - Serve remote:path over webdav. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_serve_dlna.md b/docs/content/commands/rclone_serve_dlna.md index 577173eac..91ee77cf7 100644 --- a/docs/content/commands/rclone_serve_dlna.md +++ b/docs/content/commands/rclone_serve_dlna.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone serve dlna" slug: rclone_serve_dlna url: /commands/rclone_serve_dlna/ @@ -197,8 +197,9 @@ rclone serve dlna remote:path [flags] --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) ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_serve_ftp.md b/docs/content/commands/rclone_serve_ftp.md index 3e1a500d0..a7b55e6bf 100644 --- a/docs/content/commands/rclone_serve_ftp.md +++ b/docs/content/commands/rclone_serve_ftp.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone serve ftp" slug: rclone_serve_ftp url: /commands/rclone_serve_ftp/ @@ -198,8 +198,9 @@ rclone serve ftp remote:path [flags] --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) ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_serve_http.md b/docs/content/commands/rclone_serve_http.md index 5500f95f0..e56b642c7 100644 --- a/docs/content/commands/rclone_serve_http.md +++ b/docs/content/commands/rclone_serve_http.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone serve http" slug: rclone_serve_http url: /commands/rclone_serve_http/ @@ -245,8 +245,9 @@ rclone serve http remote:path [flags] --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) ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_serve_restic.md b/docs/content/commands/rclone_serve_restic.md index b6f2676fe..87b379c44 100644 --- a/docs/content/commands/rclone_serve_restic.md +++ b/docs/content/commands/rclone_serve_restic.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone serve restic" slug: rclone_serve_restic url: /commands/rclone_serve_restic/ @@ -163,8 +163,9 @@ rclone serve restic remote:path [flags] --user string User name for authentication. ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_serve_sftp.md b/docs/content/commands/rclone_serve_sftp.md index bc6b8870f..4b3a98c60 100644 --- a/docs/content/commands/rclone_serve_sftp.md +++ b/docs/content/commands/rclone_serve_sftp.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone serve sftp" slug: rclone_serve_sftp url: /commands/rclone_serve_sftp/ @@ -210,8 +210,9 @@ rclone serve sftp remote:path [flags] --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) ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_serve_webdav.md b/docs/content/commands/rclone_serve_webdav.md index c68229bc4..ba6c1fbd1 100644 --- a/docs/content/commands/rclone_serve_webdav.md +++ b/docs/content/commands/rclone_serve_webdav.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone serve webdav" slug: rclone_serve_webdav url: /commands/rclone_serve_webdav/ @@ -255,8 +255,9 @@ rclone serve webdav remote:path [flags] --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) ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_settier.md b/docs/content/commands/rclone_settier.md index e68157d6c..02177cb71 100644 --- a/docs/content/commands/rclone_settier.md +++ b/docs/content/commands/rclone_settier.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone settier" slug: rclone_settier url: /commands/rclone_settier/ @@ -44,8 +44,9 @@ rclone settier tier remote:path [flags] -h, --help help for settier ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_sha1sum.md b/docs/content/commands/rclone_sha1sum.md index 9f6a2bfc4..435ec6e13 100644 --- a/docs/content/commands/rclone_sha1sum.md +++ b/docs/content/commands/rclone_sha1sum.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone sha1sum" slug: rclone_sha1sum url: /commands/rclone_sha1sum/ @@ -25,8 +25,9 @@ rclone sha1sum remote:path [flags] -h, --help help for sha1sum ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_size.md b/docs/content/commands/rclone_size.md index e15c5081c..99a94a1ea 100644 --- a/docs/content/commands/rclone_size.md +++ b/docs/content/commands/rclone_size.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone size" slug: rclone_size url: /commands/rclone_size/ @@ -23,8 +23,9 @@ rclone size remote:path [flags] --json format output as JSON ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_sync.md b/docs/content/commands/rclone_sync.md index cae8abeaf..533173047 100644 --- a/docs/content/commands/rclone_sync.md +++ b/docs/content/commands/rclone_sync.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone sync" slug: rclone_sync url: /commands/rclone_sync/ @@ -44,8 +44,9 @@ rclone sync source:path dest:path [flags] -h, --help help for sync ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_touch.md b/docs/content/commands/rclone_touch.md index a4f1aafd5..58ee616f7 100644 --- a/docs/content/commands/rclone_touch.md +++ b/docs/content/commands/rclone_touch.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone touch" slug: rclone_touch url: /commands/rclone_touch/ @@ -24,8 +24,9 @@ rclone touch remote:path [flags] -t, --timestamp string Change the modification times to the specified time instead of the current time of day. The argument is of the form 'YYMMDD' (ex. 17.10.30) or 'YYYY-MM-DDTHH:MM:SS' (ex. 2006-01-02T15:04:05) ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_tree.md b/docs/content/commands/rclone_tree.md index 09a6568fe..e667f480e 100644 --- a/docs/content/commands/rclone_tree.md +++ b/docs/content/commands/rclone_tree.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone tree" slug: rclone_tree url: /commands/rclone_tree/ @@ -65,8 +65,9 @@ rclone tree remote:path [flags] --version Sort files alphanumerically by version. ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/commands/rclone_version.md b/docs/content/commands/rclone_version.md index 2492f35e0..ca2bee0e7 100644 --- a/docs/content/commands/rclone_version.md +++ b/docs/content/commands/rclone_version.md @@ -1,5 +1,5 @@ --- -date: 2019-06-15T12:00:42+01:00 +date: 2019-06-20T16:09:42+01:00 title: "rclone version" slug: rclone_version url: /commands/rclone_version/ @@ -50,8 +50,9 @@ rclone version [flags] -h, --help help for version ``` +See the [global flags page](/flags/) for global options not listed here. + ### SEE ALSO * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/flags.md b/docs/content/flags.md new file mode 100755 index 000000000..e3317a8fd --- /dev/null +++ b/docs/content/flags.md @@ -0,0 +1,346 @@ +--- +title: "Global Flags" +description: "Rclone Global Flags" +date: "2019-06-20T16:09:42+01:00" +--- + +# Global Flags + +This describes the global flags available to every rclone command. + +## Non Backend Flags + +These flags are available for every command. + +``` + --ask-password Allow prompt for password for encrypted configuration. (default true) + --auto-confirm If enabled, do not request console confirmation. + --backup-dir string Make backups into hierarchy based in DIR. + --bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. + --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer. (default 16M) + --bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. + --ca-cert string CA certificate used to verify servers + --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") + --checkers int Number of checkers to run in parallel. (default 8) + -c, --checksum Skip based on checksum (if available) & size, not mod-time & size + --client-cert string Client SSL certificate (PEM) for mutual TLS auth + --client-key string Client SSL private key (PEM) for mutual TLS auth + --config string Config file. (default "$HOME/.config/rclone/rclone.conf") + --contimeout duration Connect timeout (default 1m0s) + --cpuprofile string Write cpu profile to file + --delete-after When synchronizing, delete files on destination after transferring (default) + --delete-before When synchronizing, delete files on destination before transferring + --delete-during When synchronizing, delete files during transfer + --delete-excluded Delete files on dest excluded from sync + --disable string Disable a comma separated list of features. Use help to see a list. + -n, --dry-run Do a trial run with no permanent changes + --dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles + --dump-bodies Dump HTTP headers and bodies - may contain sensitive info + --dump-headers Dump HTTP headers - may contain sensitive info + --exclude stringArray Exclude files matching pattern + --exclude-from stringArray Read exclude patterns from file + --exclude-if-present string Exclude directories if filename is present + --fast-list Use recursive list if available. Uses more memory but fewer transactions. + --files-from stringArray Read list of source-file names from file + -f, --filter stringArray Add a file-filtering rule + --filter-from stringArray Read filtering patterns from a file + --ignore-case Ignore case in filters (case insensitive) + --ignore-case-sync Ignore case when synchronizing + --ignore-checksum Skip post copy check of checksums. + --ignore-errors delete even if there are I/O errors + --ignore-existing Skip all files that exist on destination + --ignore-size Ignore size when skipping use mod-time or checksum. + -I, --ignore-times Don't skip files that match size and time - transfer all files + --immutable Do not modify files. Fail if existing files have been modified. + --include stringArray Include files matching pattern + --include-from stringArray Read include patterns from file + --log-file string Log everything to this file + --log-format string Comma separated list of log format options (default "date,time") + --log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE") + --low-level-retries int Number of low level retries to do. (default 10) + --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) + --max-backlog int Maximum number of objects in sync or check backlog. (default 10000) + --max-delete int When synchronizing, limit the number of deletes (default -1) + --max-depth int If set limits the recursion depth to this. (default -1) + --max-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off) + --max-transfer SizeSuffix Maximum size of data to transfer. (default off) + --memprofile string Write memory profile to file + --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) + --min-size SizeSuffix Only transfer files bigger than this in k or suffix b|k|M|G (default off) + --modify-window duration Max time diff to be considered the same (default 1ns) + --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size. (default 250M) + --multi-thread-streams int Max number of streams to use for multi-thread downloads. (default 4) + --no-check-certificate Do not verify the server SSL certificate. Insecure. + --no-gzip-encoding Don't set Accept-Encoding: gzip. + --no-traverse Don't traverse destination file system on copy. + --no-update-modtime Don't update destination mod-time if files identical. + -P, --progress Show progress during transfer. + -q, --quiet Print as little stuff as possible + --rc Enable the remote control server. + --rc-addr string IPaddress:Port or :Port to bind server to. (default "localhost:5572") + --rc-cert string SSL PEM key (concatenation of certificate and CA certificate) + --rc-client-ca string Client certificate authority to verify clients with + --rc-files string Path to local files to serve on the HTTP server. + --rc-htpasswd string htpasswd file - if not provided no authentication is done + --rc-job-expire-duration duration expire finished async jobs older than this value (default 1m0s) + --rc-job-expire-interval duration interval to check for expired async jobs (default 10s) + --rc-key string SSL PEM Private key + --rc-max-header-bytes int Maximum size of request header (default 4096) + --rc-no-auth Don't require auth for certain methods. + --rc-pass string Password for authentication. + --rc-realm string realm for authentication (default "rclone") + --rc-serve Enable the serving of remote objects. + --rc-server-read-timeout duration Timeout for server reading data (default 1h0m0s) + --rc-server-write-timeout duration Timeout for server writing data (default 1h0m0s) + --rc-user string User name for authentication. + --retries int Retry operations this many times if they fail (default 3) + --retries-sleep duration Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) + --size-only Skip based on size only, not mod-time or checksum + --stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s) + --stats-file-name-length int Max file name length in stats. 0 for no limit (default 45) + --stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO") + --stats-one-line Make the stats fit on one line. + --stats-one-line-date Enables --stats-one-line and add current date/time prefix. + --stats-one-line-date-format string Enables --stats-one-line-date and uses custom formatted date. Enclose date string in double quotes ("). See https://golang.org/pkg/time/#Time.Format + --stats-unit string Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes") + --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k) + --suffix string Suffix for use with --backup-dir. + --suffix-keep-extension Preserve the extension when using --suffix. + --syslog Use Syslog for logging + --syslog-facility string Facility for syslog, eg KERN,USER,... (default "DAEMON") + --timeout duration IO idle timeout (default 5m0s) + --tpslimit float Limit HTTP transactions per second to this. + --tpslimit-burst int Max burst of transactions for --tpslimit. (default 1) + --track-renames When synchronizing, track file renames and do a server side move if possible + --transfers int Number of file transfers to run in parallel. (default 4) + -u, --update Skip files that are newer on the destination. + --use-cookies Enable session cookiejar. + --use-mmap Use mmap allocator (see docs). + --use-server-modtime Use server modified time instead of object metadata + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.48.0-012-g2192f468-gphotos-beta") + -v, --verbose count Print lots more stuff (repeat for more) +``` + +## Backend Flags + +These flags are available for every command. They control the backends +and may be set in the config file. + +``` + --acd-auth-url string Auth server URL. + --acd-client-id string Amazon Application Client ID. + --acd-client-secret string Amazon Application Client Secret. + --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) + --acd-token-url string Token server url. + --acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) + --alias-remote string Remote or path to alias. + --azureblob-access-tier string Access tier of blob: hot, cool or archive. + --azureblob-account string Storage Account Name (leave blank to use connection string or SAS URL) + --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) + --azureblob-endpoint string Endpoint for the service + --azureblob-key string Storage Account Key (leave blank to use connection string or SAS URL) + --azureblob-list-chunk int Size of blob list. (default 5000) + --azureblob-sas-url string SAS URL for container level access only + --azureblob-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) + --b2-account string Account ID or Application Key ID + --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) + --b2-disable-checksum Disable checksums for large (> upload cutoff) files + --b2-download-url string Custom endpoint for downloads. + --b2-endpoint string Endpoint for the service. + --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. + --b2-key string Application Key + --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging. + --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) + --b2-versions Include old versions in directory listings. + --box-client-id string Box App Client Id. + --box-client-secret string Box App Client Secret + --box-commit-retries int Max number of times to try committing a multipart file. (default 100) + --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) + --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) + --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming. + --cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend") + --cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M) + --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) + --cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend") + --cache-db-purge Clear all the cached data for this remote on start. + --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) + --cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) + --cache-plex-insecure string Skip all certificate verifications when connecting to the Plex server + --cache-plex-password string The password of the Plex user + --cache-plex-url string The URL of the Plex server + --cache-plex-username string The username of the Plex user + --cache-read-retries int How many times to retry a read from a cache storage. (default 10) + --cache-remote string Remote to cache. + --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) + --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded. + --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) + --cache-workers int How many workers should run in parallel to download chunks. (default 4) + --cache-writes Cache file data on writes through the FS + -L, --copy-links Follow symlinks and copy the pointed to item. + --crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true) + --crypt-filename-encryption string How to encrypt the filenames. (default "standard") + --crypt-password string Password or pass phrase for encryption. + --crypt-password2 string Password or pass phrase for salt. Optional but recommended. + --crypt-remote string Remote to encrypt/decrypt. + --crypt-show-mapping For all files listed show how the names encrypt. + --drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. + --drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. + --drive-alternate-export Use alternate export URLs for google documents export., + --drive-auth-owner-only Only consider files owned by the authenticated user. + --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) + --drive-client-id string Google Application Client Id + --drive-client-secret string Google Application Client Secret + --drive-export-formats string Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg") + --drive-formats string Deprecated: see export_formats + --drive-impersonate string Impersonate this user when using a service account. + --drive-import-formats string Comma separated list of preferred formats for uploading Google docs. + --drive-keep-revision-forever Keep new head revision of each file forever. + --drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000) + --drive-pacer-burst int Number of API calls to allow without sleeping. (default 100) + --drive-pacer-min-sleep Duration Minimum time to sleep between API calls. (default 100ms) + --drive-root-folder-id string ID of the root folder + --drive-scope string Scope that rclone should use when requesting access from drive. + --drive-server-side-across-configs Allow server side operations (eg copy) to work across different drive configs. + --drive-service-account-credentials string Service Account Credentials JSON blob + --drive-service-account-file string Service Account Credentials JSON file path + --drive-shared-with-me Only show files that are shared with me. + --drive-size-as-quota Show storage quota usage for file size. + --drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only. + --drive-skip-gdocs Skip google documents in all listings. + --drive-team-drive string ID of the Team Drive + --drive-trashed-only Only show files that are in the trash. + --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) + --drive-use-created-date Use file created date instead of modified date., + --drive-use-trash Send files to the trash instead of deleting permanently. (default true) + --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download. (default off) + --dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) + --dropbox-client-id string Dropbox App Client Id + --dropbox-client-secret string Dropbox App Client Secret + --dropbox-impersonate string Impersonate this user when using a business account. + --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited + --ftp-host string FTP host to connect to + --ftp-no-check-certificate Do not verify the TLS certificate of the server + --ftp-pass string FTP password + --ftp-port string FTP port, leave blank to use default (21) + --ftp-tls Use FTP over TLS (Implicit) + --ftp-user string FTP username, leave blank for current username, $USER + --gcs-bucket-acl string Access Control List for new buckets. + --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. + --gcs-client-id string Google Application Client Id + --gcs-client-secret string Google Application Client Secret + --gcs-location string Location for the newly created buckets. + --gcs-object-acl string Access Control List for new objects. + --gcs-project-number string Project number. + --gcs-service-account-file string Service Account Credentials JSON file path + --gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage. + --gphotos-client-id string Google Application Client Id + --gphotos-client-secret string Google Application Client Secret + --gphotos-read-size Set to read the size of media items. + --http-no-slash Set this if the site doesn't end directories with / + --http-url string URL of http host to connect to + --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + --hubic-client-id string Hubic Client Id + --hubic-client-secret string Hubic Client Secret + --hubic-no-chunk Don't chunk files during streaming upload. + --jottacloud-hard-delete Delete files permanently rather than putting them into the trash. + --jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M) + --jottacloud-unlink Remove existing public link to file/folder with link command rather than creating. + --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) + --jottacloud-user string User Name: + --koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net") + --koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used. + --koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) + --koofr-user string Your Koofr user name + -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension + --local-case-insensitive Force the filesystem to report itself as case insensitive + --local-case-sensitive Force the filesystem to report itself as case sensitive. + --local-no-check-updated Don't check to see if the files change during upload + --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) + --local-nounc string Disable UNC (long path names) conversion on Windows + --mega-debug Output more debug from Mega. + --mega-hard-delete Delete files permanently rather than putting them into the trash. + --mega-pass string Password. + --mega-user string User name + -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only). + --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k. (default 10M) + --onedrive-client-id string Microsoft App Client Id + --onedrive-client-secret string Microsoft App Client Secret + --onedrive-drive-id string The ID of the drive to use + --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) + --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. + --opendrive-password string Password. + --opendrive-username string Username + --pcloud-client-id string Pcloud App Client Id + --pcloud-client-secret string Pcloud App Client Secret + --qingstor-access-key-id string QingStor Access Key ID + --qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M) + --qingstor-connection-retries int Number of connection retries. (default 3) + --qingstor-endpoint string Enter a endpoint URL to connection QingStor API. + --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. + --qingstor-secret-access-key string QingStor Secret Access Key (password) + --qingstor-upload-concurrency int Concurrency for multipart uploads. (default 1) + --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + --qingstor-zone string Zone to connect to. + --s3-access-key-id string AWS Access Key ID. + --s3-acl string Canned ACL used when creating buckets and storing or copying objects. + --s3-bucket-acl string Canned ACL used when creating buckets. + --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) + --s3-disable-checksum Don't store MD5 checksum with object metadata + --s3-endpoint string Endpoint for S3 API. + --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). + --s3-force-path-style If true use path style access if false use virtual hosted style. (default true) + --s3-location-constraint string Location constraint - must be set to match the Region. + --s3-provider string Choose your S3 provider. + --s3-region string Region to connect to. + --s3-secret-access-key string AWS Secret Access Key (password) + --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. + --s3-session-token string An AWS session token + --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key. + --s3-storage-class string The storage class to use when storing new objects in S3. + --s3-upload-concurrency int Concurrency for multipart uploads. (default 4) + --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. + --s3-v2-auth If true use v2 authentication. + --sftp-ask-password Allow asking for SFTP password when needed. + --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. + --sftp-host string SSH host to connect to + --sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent. + --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. + --sftp-key-use-agent When set forces the usage of the ssh-agent. + --sftp-pass string SSH password, leave blank to use ssh-agent. + --sftp-path-override string Override path used by SSH connection. + --sftp-port string SSH port, leave blank to use default (22) + --sftp-set-modtime Set the modified time on the remote if set. (default true) + --sftp-use-insecure-cipher Enable the use of the aes128-cbc cipher. This cipher is insecure and may allow plaintext data to be recovered by an attacker. + --sftp-user string SSH username, leave blank for current username, ncw + --skip-links Don't warn about skipped symlinks. + --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) + --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) + --swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) + --swift-auth string Authentication URL for server (OS_AUTH_URL). + --swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) + --swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) + --swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + --swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) + --swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public") + --swift-env-auth Get swift credentials from environment variables in standard OpenStack form. + --swift-key string API key or password (OS_PASSWORD). + --swift-no-chunk Don't chunk files during streaming upload. + --swift-region string Region name - optional (OS_REGION_NAME) + --swift-storage-policy string The storage policy to use when creating a new container + --swift-storage-url string Storage URL - optional (OS_STORAGE_URL) + --swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) + --swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) + --swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) + --swift-user string User name to log in (OS_USERNAME). + --swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). + --union-remotes string List of space separated remotes. + --webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon) + --webdav-pass string Password. + --webdav-url string URL of http host to connect to + --webdav-user string User name + --webdav-vendor string Name of the Webdav site/service/software you are using + --yandex-client-id string Yandex Client Id + --yandex-client-secret string Yandex Client Secret + --yandex-unlink Remove existing public link to file/folder with link command rather than creating. +``` diff --git a/docs/layouts/chrome/navbar.html b/docs/layouts/chrome/navbar.html index 441940a05..55aa94076 100644 --- a/docs/layouts/chrome/navbar.html +++ b/docs/layouts/chrome/navbar.html @@ -22,6 +22,7 @@
  • Changelog
  • Bugs
  • FAQ
    • +
  • Flags
  • Licence
  • Authors
  • Donate