docs: update all auto generated docs

This commit is contained in:
Nick Craig-Wood 2020-05-25 11:59:33 +01:00
parent 256d17eba8
commit 4d6af44045
70 changed files with 98 additions and 96 deletions

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone"
description: "Show help for rclone commands, flags and backends."
slug: rclone

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone about"
description: "Get quota information from the remote."
slug: rclone_about

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone authorize"
description: "Remote authorization."
slug: rclone_authorize

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone backend"
description: "Run a backend specific command."
slug: rclone_backend

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone cat"
description: "Concatenates any files and sends them to stdout."
slug: rclone_cat

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone check"
description: "Checks the files in the source and destination match."
slug: rclone_check

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone cleanup"
description: "Clean up the remote if possible"
slug: rclone_cleanup

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config"
description: "Enter an interactive configuration session."
slug: rclone_config

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config create"
description: "Create a new remote with name, type and options."
slug: rclone_config_create
@ -14,7 +14,7 @@ Create a new remote with name, type and options.
Create a new remote of `name` with `type` and options. The options
should be passed in in pairs of `key` `value`.
should be passed in pairs of `key` `value`.
For example to make a swift remote of name myremote using auto config
you would do:

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config delete"
description: "Delete an existing remote `name`."
slug: rclone_config_delete

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config disconnect"
description: "Disconnects user from remote"
slug: rclone_config_disconnect

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config dump"
description: "Dump the config file as JSON."
slug: rclone_config_dump

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config edit"
description: "Enter an interactive configuration session."
slug: rclone_config_edit

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config file"
description: "Show path of configuration file in use."
slug: rclone_config_file

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config password"
description: "Update password in an existing remote."
slug: rclone_config_password
@ -14,7 +14,7 @@ Update password in an existing remote.
Update an existing remote's password. The password
should be passed in in pairs of `key` `value`.
should be passed in pairs of `key` `value`.
For example to set password of a remote of name myremote you would do:

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config providers"
description: "List in JSON format all the providers and options."
slug: rclone_config_providers

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config reconnect"
description: "Re-authenticates user with remote."
slug: rclone_config_reconnect

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config show"
description: "Print (decrypted) config file, or the config for a single remote."
slug: rclone_config_show

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config update"
description: "Update options in an existing remote."
slug: rclone_config_update

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone config userinfo"
description: "Prints info about logged in user of remote."
slug: rclone_config_userinfo

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone copy"
description: "Copy files from source to dest, skipping already copied"
slug: rclone_copy

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone copyto"
description: "Copy files from source to dest, skipping already copied"
slug: rclone_copyto

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone copyurl"
description: "Copy url content to dest."
slug: rclone_copyurl
@ -16,7 +16,7 @@ Copy url content to dest.
Download a URL's content and copy it to the destination without saving
it in temporary storage.
Setting --auto-filename will cause the file name to be retreived from
Setting --auto-filename will cause the file name to be retrieved from
the from URL (after any redirections) and used in the destination
path.

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone cryptcheck"
description: "Cryptcheck checks the integrity of a crypted remote."
slug: rclone_cryptcheck

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone cryptdecode"
description: "Cryptdecode returns unencrypted file names."
slug: rclone_cryptdecode

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone dedupe"
description: "Interactively find duplicate files and delete/rename them."
slug: rclone_dedupe

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone delete"
description: "Remove the contents of path."
slug: rclone_delete

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone deletefile"
description: "Remove a single file from remote."
slug: rclone_deletefile

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone genautocomplete"
description: "Output completion script for a given shell."
slug: rclone_genautocomplete

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone genautocomplete bash"
description: "Output bash completion script for rclone."
slug: rclone_genautocomplete_bash

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone genautocomplete fish"
description: "Output fish completion script for rclone."
slug: rclone_genautocomplete_fish

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone genautocomplete zsh"
description: "Output zsh completion script for rclone."
slug: rclone_genautocomplete_zsh

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone gendocs"
description: "Output markdown docs for rclone to the directory supplied."
slug: rclone_gendocs

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone hashsum"
description: "Produces a hashsum file for all the objects in the path."
slug: rclone_hashsum

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone link"
description: "Generate public link to file/folder."
slug: rclone_link

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone listremotes"
description: "List all the remotes in the config file."
slug: rclone_listremotes

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone ls"
description: "List the objects in the path with size and path."
slug: rclone_ls

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone lsd"
description: "List all directories/containers/buckets in the path."
slug: rclone_lsd

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone lsf"
description: "List directories and objects in remote:path formatted for parsing"
slug: rclone_lsf

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone lsjson"
description: "List directories and objects in the path in JSON format."
slug: rclone_lsjson

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone lsl"
description: "List the objects in path with modification time, size and path."
slug: rclone_lsl

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone md5sum"
description: "Produces an md5sum file for all the objects in the path."
slug: rclone_md5sum

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone mkdir"
description: "Make the path if it doesn't already exist."
slug: rclone_mkdir

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone mount"
description: "Mount the remote as file system on a mountpoint."
slug: rclone_mount
@ -55,7 +55,7 @@ Stopping the mount manually:
To run rclone mount on Windows, you will need to
download and install [WinFsp](http://www.secfs.net/winfsp/).
WinFsp is an [open source](https://github.com/billziss-gh/winfsp)
[WinFsp](https://github.com/billziss-gh/winfsp) is an open source
Windows File System Proxy which makes it easy to write user space file
systems for Windows. It provides a FUSE emulation layer which rclone
uses combination with
@ -342,7 +342,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS
Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -364,7 +364,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false"
on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true".

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone move"
description: "Move files from source to dest."
slug: rclone_move

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone moveto"
description: "Move file or directory from source to dest."
slug: rclone_moveto

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone ncdu"
description: "Explore a remote with a text based user interface."
slug: rclone_ncdu

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone obscure"
description: "Obscure password for use in the rclone.conf"
slug: rclone_obscure

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone purge"
description: "Remove the path and all of its contents."
slug: rclone_purge

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone rc"
description: "Run a command against a running rclone."
slug: rclone_rc

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone rcat"
description: "Copies standard input to file on remote."
slug: rclone_rcat

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone rcd"
description: "Run rclone listening to remote control commands only."
slug: rclone_rcd

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone rmdir"
description: "Remove the path if empty."
slug: rclone_rmdir

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone rmdirs"
description: "Remove empty directories under the path."
slug: rclone_rmdirs

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone serve"
description: "Serve a remote over a protocol."
slug: rclone_serve

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone serve dlna"
description: "Serve remote:path over DLNA"
slug: rclone_serve_dlna
@ -12,7 +12,7 @@ Serve remote:path over DLNA
## Synopsis
rclone serve dlna is a DLNA media server for media stored in a rclone remote. Many
rclone serve dlna is a DLNA media server for media stored in an rclone remote. Many
devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN
and play audio/video from it. VLC is also supported. Service discovery uses UDP multicast
packets (SSDP) and will thus only work on LANs.
@ -181,7 +181,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS
Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -203,7 +203,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false"
on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true".

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone serve ftp"
description: "Serve remote:path over FTP."
slug: rclone_serve_ftp
@ -180,7 +180,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS
Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -202,7 +202,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false"
on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true".
## Auth Proxy
@ -272,7 +272,7 @@ that since `_obscure` is set to `pass`, rclone will obscure the `pass`
parameter before creating the backend (which is required for sftp
backends).
The progam can manipulate the supplied `user` in any way, for example
The program can manipulate the supplied `user` in any way, for example
to make proxy to many different sftp backends, you could make the
`user` be `user@example.com` and then set the `host` to `example.com`
in the output and the user to `user`. For security you'd probably want

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone serve http"
description: "Serve the remote over HTTP."
slug: rclone_serve_http
@ -252,7 +252,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS
Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -274,7 +274,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false"
on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true".

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone serve restic"
description: "Serve the remote for restic's REST API."
slug: rclone_serve_restic

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone serve sftp"
description: "Serve the remote over SFTP."
slug: rclone_serve_sftp
@ -191,7 +191,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS
Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -213,7 +213,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false"
on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true".
## Auth Proxy
@ -283,7 +283,7 @@ that since `_obscure` is set to `pass`, rclone will obscure the `pass`
parameter before creating the backend (which is required for sftp
backends).
The progam can manipulate the supplied `user` in any way, for example
The program can manipulate the supplied `user` in any way, for example
to make proxy to many different sftp backends, you could make the
`user` be `user@example.com` and then set the `host` to `example.com`
in the output and the user to `user`. For security you'd probably want

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone serve webdav"
description: "Serve remote:path over webdav."
slug: rclone_serve_webdav
@ -260,7 +260,7 @@ although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS
Usually file systems on macOS are case-insensitive. It is possible to make macOS
file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these
@ -282,7 +282,7 @@ may differ from case sensitivity of a file system mounted by rclone (the source)
The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false"
on the operating system where rclone runs: "true" on Windows and macOS, "false"
otherwise. If the flag is provided without a value, then it is "true".
## Auth Proxy
@ -352,7 +352,7 @@ that since `_obscure` is set to `pass`, rclone will obscure the `pass`
parameter before creating the backend (which is required for sftp
backends).
The progam can manipulate the supplied `user` in any way, for example
The program can manipulate the supplied `user` in any way, for example
to make proxy to many different sftp backends, you could make the
`user` be `user@example.com` and then set the `host` to `example.com`
in the output and the user to `user`. For security you'd probably want

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone settier"
description: "Changes storage class/tier of objects in remote."
slug: rclone_settier

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone sha1sum"
description: "Produces an sha1sum file for all the objects in the path."
slug: rclone_sha1sum

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone size"
description: "Prints the total size and number of objects in remote:path."
slug: rclone_size

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone sync"
description: "Make source and dest identical, modifying destination only."
slug: rclone_sync

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone touch"
description: "Create new file or change file modification time."
slug: rclone_touch

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone tree"
description: "List the contents of the remote in a tree like fashion."
slug: rclone_tree

View File

@ -1,5 +1,5 @@
---
date: 2020-05-22T15:09:46+01:00
date: 2020-05-25T12:06:00+01:00
title: "rclone version"
description: "Show the version number."
slug: rclone_version

View File

@ -1,7 +1,7 @@
---
title: "Global Flags"
description: "Rclone Global Flags"
date: "2020-05-22T15:09:46+01:00"
date: "2020-05-25T12:06:00+01:00"
---
# Global Flags
@ -22,6 +22,7 @@ These flags are available for every command.
--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")
--check-first Do all the checks before starting transfers.
--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
@ -144,7 +145,7 @@ These flags are available for every command.
--use-json-log Use json log format.
--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.51.0-383-g3bc9a985-new-docs-beta")
--user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.51.0-411-gaebb535f-new-docs-beta")
-v, --verbose count Print lots more stuff (repeat for more)
```
@ -204,7 +205,7 @@ and may be set in the config file.
--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-insecure string Skip all certificate verification 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
@ -388,7 +389,7 @@ and may be set in the config file.
--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-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3.
--s3-sse-customer-key string If using SSE-C you must provide the secret encyption key used to encrypt/decrypt your data.
--s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data.
--s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum.
--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.
@ -396,13 +397,14 @@ and may be set in the config file.
--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.
--seafile-create-library Should create library if it doesn't exist
--seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled)
--seafile-create-library Should rclone create a library if it doesn't exist
--seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
--seafile-library string Name of the library. Leave blank to access all non-encrypted libraries.
--seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line.
--seafile-pass string Password
--seafile-url string URL of seafile host to connect to
--seafile-user string User name
--seafile-user string User name (usually email address)
--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

View File

@ -316,7 +316,7 @@ command:
rclone backend noop . -o echo=yes -o blue path1 path2
Note that arguments must be preceeded by the "-a" flag
Note that arguments must be preceded by the "-a" flag
See the [backend](/commands/rclone_backend/) command for more information.
@ -629,7 +629,7 @@ Returns the following values:
"bytes": total transferred bytes for this file,
"checked": if the transfer is only checked (skipped, deleted),
"timestamp": integer representing millisecond unix epoch,
"error": string description of the error (empty if successfull),
"error": string description of the error (empty if successful),
"jobid": id of the job that this transfer belongs to
}
]