diff --git a/MANUAL.html b/MANUAL.html index b74934154..b1f0b5e99 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -17,7 +17,7 @@

rclone(1) User Manual

Nick Craig-Wood

-

Apr 13, 2019

+

Jun 15, 2019

Rclone

Logo

@@ -55,6 +55,7 @@
  • put.io
  • QingStor
  • Rackspace Cloud Files
    • +
  • rsync.net
  • Scaleway
  • SFTP
  • Wasabi
    • @@ -71,10 +72,12 @@
  • Sync (one way) mode to make a directory identical
  • Check mode to check for file hash equality
  • Can sync to and from network, eg two different cloud accounts
    • -
  • (Encryption) backend
    • -
  • (Cache) backend
    • -
  • (Union) backend
    • +
  • Encryption backend
    • +
  • Cache backend
    • +
  • Union backend
  • Optional FUSE mount (rclone mount)
    • +
  • Multi-threaded downloads to local disk
    • +
  • Can serve local or remote files over HTTP/WebDav/FTP/SFTP/dlna

    • Links

    +

    –s3-use-accelerate-endpoint

    +

    If true use the AWS S3 accelerated endpoint.

    +

    See: AWS S3 Transfer acceleration

    +

    Anonymous access to public buckets

    If you want to use rclone to access a public bucket, configure with a blank access_key_id and secret_access_key. Your config should end up looking like this:

    @@ -5209,7 +5751,7 @@ rclone copy /path/to/files spaces:my-new-space
  • Select “s3” storage.
    • Choose a number from below, or type in your own value
-    1 / Alias for a existing remote
+    1 / Alias for an existing remote
     \ "alias"
     2 / Amazon Drive
     \ "amazon cloud drive"
@@ -5686,7 +6228,7 @@ y/e/d> y

    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.

    Modified time

    The modified time is stored as metadata on the object as X-Bz-Info-src_last_modified_millis as milliseconds since 1970-01-01 in the Backblaze standard. Other tools should be able to use this as a modified time.

    -

    Modified times are used in syncing and are fully supported except in the case of updating a modification time on an existing object. In this case the object will be uploaded again as B2 doesn’t have an API method to set the modification time independent of doing an upload.

    +

    Modified times are used in syncing and are fully supported. Note that if a modification time needs to be updated on an object then it will create a new version of the object.

    SHA1 checksums

    The SHA1 checksums of the files are checked on upload and download and will be used in the syncing process.

    Large files (bigger than the limit in --b2-upload-cutoff) which are uploaded in chunks will store their SHA1 on the object as X-Bz-Info-large_file_sha1 as recommended by Backblaze.

    @@ -5699,6 +6241,7 @@ y/e/d> y

    Versions

    When rclone uploads a new version of a file it creates a new version of it. Likewise when you delete a file, the old version will be marked hidden and still be available. Conversely, you may opt in to a “hard delete” of files with the --b2-hard-delete flag which would permanently remove the file instead of hiding it.

    Old versions of files, where available, are visible using the --b2-versions flag.

    +

    NB Note that --b2-versions does not work with crypt at the moment #1627. Using –backup-dir with rclone is the recommended way of working around this.

    If you wish to remove all the old versions then you can use the rclone cleanup remote:bucket command which will delete all the old versions of files, leaving the current ones intact. You can also supply a path and only old versions under that path will be deleted, eg rclone cleanup remote:bucket/path/to/stuff.

    Note that cleanup will remove partially uploaded files from the bucket if they are more than a day old.

    When you purge a bucket, the current and the old versions will be deleted then the bucket will be deleted.

    @@ -6343,7 +6886,7 @@ chunk_total_size = 10G
  • Config: db_path
  • Env Var: RCLONE_CACHE_DB_PATH
  • Type: string
    • -
  • Default: “/home/ncw/.cache/rclone/cache-backend”
    • +
  • Default: “$HOME/.cache/rclone/cache-backend”

    • –cache-chunk-path

    Directory to cache chunk files.

    @@ -6353,7 +6896,7 @@ chunk_total_size = 10G
  • Config: chunk_path
  • Env Var: RCLONE_CACHE_CHUNK_PATH
  • Type: string
    • -
  • Default: “/home/ncw/.cache/rclone/cache-backend”
    • +
  • Default: “$HOME/.cache/rclone/cache-backend”

    • –cache-db-purge

    Clear all the cached data for this remote on start.

    @@ -6918,45 +7461,27 @@ q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. +Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value - 1 / Amazon Drive - \ "amazon cloud drive" - 2 / Amazon S3 (also Dreamhost, Ceph, Minio) - \ "s3" - 3 / Backblaze B2 - \ "b2" - 4 / Dropbox - \ "dropbox" - 5 / Encrypt/Decrypt a remote - \ "crypt" - 6 / FTP Connection +[snip] +10 / FTP Connection \ "ftp" - 7 / Google Cloud Storage (this is not Google Drive) - \ "google cloud storage" - 8 / Google Drive - \ "drive" - 9 / Hubic - \ "hubic" -10 / Local Disk - \ "local" -11 / Microsoft OneDrive - \ "onedrive" -12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) - \ "swift" -13 / SSH/SFTP Connection - \ "sftp" -14 / Yandex Disk - \ "yandex" +[snip] Storage> ftp +** See help for ftp backend at: https://rclone.org/ftp/ ** + FTP host to connect to +Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Connect to ftp.example.com \ "ftp.example.com" host> ftp.example.com FTP username, leave blank for current username, ncw -user> +Enter a string value. Press Enter for the default (""). +user> FTP port, leave blank to use default (21) -port> +Enter a string value. Press Enter for the default (""). +port> FTP password y) Yes type in my own password g) Generate random password @@ -6965,12 +7490,14 @@ Enter the password: password: Confirm the password: password: +Use FTP over TLS (Implicit) +Enter a boolean value (true or false). Press Enter for the default ("false"). +tls> Remote config -------------------- [remote] +type = ftp host = ftp.example.com -user = -port = pass = *** ENCRYPTED *** -------------------- y) Yes this is OK @@ -6990,6 +7517,8 @@ y/e/d> y

    FTP does not support modified times. Any times you see on the server will be time of upload.

    Checksums

    FTP does not support any checksums.

    +

    Implicit TLS

    +

    FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled in the config for the remote. The default FTPS port is 990 so the port will likely have to be explictly set in the config for the remote.

    Standard Options

    Here are the standard options specific to ftp (FTP Connection).

    @@ -7009,7 +7538,7 @@ y/e/d> y

    –ftp-user

    -

    FTP username, leave blank for current username, ncw

    +

    FTP username, leave blank for current username, $USER

    +

    –ftp-tls

    +

    Use FTP over TLS (Implicit)

    +

    Advanced Options

    Here are the advanced options specific to ftp (FTP Connection).

    –ftp-concurrency

    @@ -7042,6 +7579,14 @@ y/e/d> y
  • Type: int
  • Default: 0
    • +

    –ftp-no-check-certificate

    +

    Do not verify the TLS certificate of the server

    +

    Limitations

    Note that since FTP isn’t HTTP based the following flags don’t work with it: --dump-headers, --dump-bodies, --dump-auth

    @@ -7049,6 +7594,7 @@ y/e/d> y

    Note that --bind isn’t supported.

    FTP could support server side move but doesn’t yet.

    Note that the ftp backend does not support the ftp_proxy environment variable yet.

    +

    Note that while implicit FTP over TLS is supported, explicit FTP over TLS is not.

    Google Cloud Storage

    Paths are specified as remote:bucket (or remote: for the lsd command.) You may put subdirectories in too, eg remote:bucket/path/to/dir.

    The initial setup for google cloud storage involves getting a token from Google Cloud Storage which you need to do in your browser. rclone config walks you through it.

    @@ -7690,6 +8236,7 @@ trashed=false and 'c' in parents

    By default rclone will send all files to the trash when deleting files. If deleting them permanently is required then use the --drive-use-trash=false flag, or set the equivalent environment variable.

    Emptying trash

    If you wish to empty your trash you can use the rclone cleanup remote: command which will permanently delete all your trashed files. This command does not take any path arguments.

    +

    Note that Google Drive takes some time (minutes to days) to empty the trash even though the command returns within a few seconds. No output is echoed, so there will be no confirmation even using -v or -vv.

    Quota information

    To view your current quota you can use the rclone about remote: command which will display your usage limit (quota), the usage in Google Drive, the size of all files in the Trash and the space used by other Google services such as Gmail. This command does not take any path arguments.

    Import/Export of google documents

    @@ -7698,7 +8245,7 @@ trashed=false and 'c' in parents

    When choosing a format, rclone runs down the list provided in order and chooses the first file format the doc can be exported as from the list. If the file can’t be exported to a format on the formats list, then rclone will choose a format from the default list.

    If you prefer an archive copy then you might use --drive-export-formats pdf, or if you prefer openoffice/libreoffice formats you might use --drive-export-formats ods,odt,odp.

    Note that rclone adds the extension to the google doc, so if it is called My Spreadsheet on google docs, it will be exported as My Spreadsheet.xlsx or My Spreadsheet.pdf etc.

    -

    When importing files into Google Drive, rclone will conververt all files with an extension in --drive-import-formats to their associated document type. rclone will not convert any files by default, since the conversion is lossy process.

    +

    When importing files into Google Drive, rclone will convert all files with an extension in --drive-import-formats to their associated document type. rclone will not convert any files by default, since the conversion is lossy process.

    The conversion must result in a file with the same extension when the --drive-export-formats rules are applied to the uploaded document.

    Here are some examples for allowed and prohibited conversions.

    @@ -8156,6 +8703,15 @@ trashed=false and 'c' in parents
  • Type: bool
  • Default: false
    • +

    –drive-size-as-quota

    +

    Show storage quota usage for file size.

    +

    The storage used by a file is the size of the current version plus any older versions that have been set to keep forever.

    +

    –drive-v2-download-min-size

    If Object’s are greater, use drive v2 API to download.

    +

    –drive-server-side-across-configs

    +

    Allow server side operations (eg copy) to work across different drive configs.

    +

    This can be useful if you wish to do a server side copy between two different Google drives. Note that this isn’t enabled by default because it isn’t easy to tell if it will work beween any two configurations.

    +

    Limitations

    Drive has quite a lot of rate limiting. This causes rclone to be limited to transferring about 2 files per second only. Individual files may be transferred much faster at 100s of MBytes/s but lots of small files can take a long time.

    @@ -8475,26 +9040,20 @@ n) New remote s) Set configuration password q) Quit config n/s/q> n -name> remote +name> jotta Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] -13 / JottaCloud +14 / JottaCloud \ "jottacloud" [snip] Storage> jottacloud -User Name +** See help for jottacloud backend at: https://rclone.org/jottacloud/ ** + +User Name: Enter a string value. Press Enter for the default (""). -user> user -The mountpoint to use. -Enter a string value. Press Enter for the default (""). -Choose a number from below, or type in your own value - 1 / Will be synced by the official client. - \ "Sync" - 2 / Archive - \ "Archive" -mountpoint> Archive +user> user@email.tld Edit advanced config? (y/n) y) Yes n) No @@ -8508,16 +9067,35 @@ Rclone has it's own Jottacloud API KEY which works fine as long as one only y) Yes n) No y/n> y -Your Jottacloud password is only required during config and will not be stored. +Your Jottacloud password is only required during setup and will not be stored. password: + +Do you want to use a non standard device/mountpoint e.g. for accessing files uploaded using the official Jottacloud client? + +y) Yes +n) No +y/n> y +Please select the device to use. Normally this will be Jotta +Choose a number from below, or type in an existing value + 1 > DESKTOP-3H31129 + 2 > test1 + 3 > Jotta +Devices> 3 +Please select the mountpoint to user. Normally this will be Archive +Choose a number from below, or type in an existing value + 1 > Archive + 2 > Shared + 3 > Sync +Mountpoints> 1 -------------------- -[remote] +[jotta] type = jottacloud -user = olihey -mountpoint = Archive +user = 0xC4KE@gmail.com client_id = ..... client_secret = ........ token = {........} +device = Jotta +mountpoint = Archive -------------------- y) Yes this is OK e) Edit this remote @@ -8530,6 +9108,8 @@ y/e/d> y
    rclone ls remote:

    To copy a local directory to an Jottacloud directory called backup

    rclone copy /home/source remote:backup
    +

    Devices and Mountpoints

    +

    The official Jottacloud client registers a device for each computer you install it on and then creates a mountpoint for each folder you select for Backup. The web interface uses a special device called Jotta for the Archive, Sync and Shared mountpoints. In most cases you’ll want to use the Jotta/Archive device/mounpoint however if you want to access files uploaded by the official rclone provides the option to select other devices and mountpoints during config.

    –fast-list

    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.

    Note that the implementation in Jottacloud always uses only a single API request to get the entire list, so for large folders this could lead to long wait time before the first results are shown.

    @@ -8556,25 +9136,6 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    –jottacloud-mountpoint

    -

    The mountpoint to use.

    -

    Advanced Options

    Here are the advanced options specific to jottacloud (JottaCloud).

    –jottacloud-md5-memory-limit

    @@ -8634,7 +9195,7 @@ Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / A stackable unification remote, which can appear to merge the contents of several remotes \ "union" - 2 / Alias for a existing remote + 2 / Alias for an existing remote \ "alias" 3 / Amazon Drive \ "amazon cloud drive" @@ -8780,7 +9341,7 @@ n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" [snip] 14 / Mega @@ -8825,6 +9386,17 @@ y/e/d> y

    Mega can have two files with exactly the same name and path (unlike a normal file system).

    Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.

    Use rclone dedupe to fix duplicated files.

    +

    Failure to log-in

    +

    Mega remotes seem to get blocked (reject logins) under “heavy use”. We haven’t worked out the exact blocking rules but it seems to be related to fast paced, sucessive rclone commands.

    +

    For example, executing this command 90 times in a row rclone link remote:file will cause the remote to become “blocked”. This is not an abnormal situation, for example if you wish to get the public links of a directory with hundred of files… After more or less a week, the remote will remote accept rclone logins normally again.

    +

    You can mitigate this issue by mounting the remote it with rclone mount. This will log-in when mounting and a log-out when unmounting only. You can also run rclone rcd and then use rclone rc to run the commands over the API to avoid logging in each time.

    +

    Rclone does not currently close mega sessions (you can see them in the web interface), however closing the sessions does not solve the issue.

    +

    If you space rclone commands by 3 seconds it will avoid blocking the remote. We haven’t identified the exact blocking rules, so perhaps one could execute the command 80 times without waiting and avoid blocking by waiting 3 seconds, then continuing…

    +

    Note that this has been observed by trial and error and might not be set in stone.

    +

    Other tools seem not to produce this blocking effect, as they use a different working approach (state-based, using sessionIDs instead of log-in) which isn’t compatible with the current stateless rclone approach.

    +

    Note that once blocked, the use of other tools (such as megacmd) is not a sure workaround: following megacmd login times have been observed in sucession for blocked remote: 7 minutes, 20 min, 30min, 30 min, 30min. Web access looks unaffected though.

    +

    Investigation is continuing in relation to workarounds based on timeouts, pacers, retrials and tpslimits - if you discover something relevant, please post on the forum.

    +

    So, if rclone was working nicely and suddenly you are unable to log-in and you are sure the user and the password are correct, likely you have got the remote blocked for a while.

    Standard Options

    Here are the standard options specific to mega (Mega).

    @@ -9063,10 +9635,10 @@ Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value ... -17 / Microsoft OneDrive +18 / Microsoft OneDrive \ "onedrive" ... -Storage> 17 +Storage> 18 Microsoft App Client Id Leave blank normally. Enter a string value. Press Enter for the default (""). @@ -10120,7 +10692,7 @@ y/e/d> y

    SFTP is the Secure (or SSH) File Transfer Protocol.

    SFTP runs over SSH v2 and is installed as standard with most modern SSH installations.

    Paths are specified as remote:path. If the path does not begin with a / it is relative to the home directory of the user. An empty path remote: refers to the user’s home directory.

    -

    Note that some SFTP servers will need the leading / - Synology is a good example of this.

    +

    "Note that some SFTP servers will need the leading / - Synology is a good example of this. rsync.net, on the other hand, requires users to OMIT the leading /.

    Here is an example of making an SFTP configuration. First run

    rclone config

    This will guide you through an interactive setup process.

    @@ -10352,6 +10924,7 @@ y/e/d> y

    Limitations

    SFTP supports checksums if the same login has shell access and md5sum or sha1sum as well as echo are in the remote’s PATH. This remote checksumming (file hashing) is recommended and enabled by default. Disabling the checksumming may be required if you are connecting to SFTP servers which are not under your control, and to which the execution of remote commands is prohibited. Set the configuration option disable_hashcheck to true to disable checksumming.

    +

    SFTP also supports about if the same login has shell access and df are in the remote’s PATH. about will return the total space, free space, and used space on the remote for the disk of the specified path on the remote or, if not set, the disk of the root on the remote. about will fail if it does not have shell access or if df is not in the remote’s PATH.

    Note that some SFTP servers (eg Synology) the paths are different for SSH and SFTP so the hashes can’t be calculated properly. For them using disable_hashcheck is a good idea.

    The only ssh agent supported under Windows is Putty’s pageant.

    The Go SSH library disables the use of the aes128-cbc cipher by default, due to security concerns. This can be re-enabled on a per-connection basis by setting the use_insecure_cipher setting in the configuration file to true. Further details on the insecurity of this cipher can be found [in this paper] (http://www.isg.rhul.ac.uk/~kp/SandPfinal.pdf).

    @@ -10377,7 +10950,7 @@ n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" 2 / Amazon Drive \ "amazon cloud drive" @@ -10965,6 +11538,133 @@ $ tree /tmp/b

    Changelog

    +

    v1.48.0 - 2019-06-15

    +

    v1.47.0 - 2019-04-13

    Contact the rclone project

    Forum

    diff --git a/MANUAL.md b/MANUAL.md index 08fb9380c..e572de5bb 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -1,6 +1,6 @@ % rclone(1) User Manual % Nick Craig-Wood -% Apr 13, 2019 +% Jun 15, 2019 Rclone ====== @@ -41,6 +41,7 @@ Rclone is a command line program to sync files and directories to and from: * put.io * QingStor * Rackspace Cloud Files +* rsync.net * Scaleway * SFTP * Wasabi @@ -57,10 +58,12 @@ Features * [Sync](https://rclone.org/commands/rclone_sync/) (one way) mode to make a directory identical * [Check](https://rclone.org/commands/rclone_check/) mode to check for file hash equality * Can sync to and from network, eg two different cloud accounts - * ([Encryption](https://rclone.org/crypt/)) backend - * ([Cache](https://rclone.org/cache/)) backend - * ([Union](https://rclone.org/union/)) backend + * [Encryption](https://rclone.org/crypt/) backend + * [Cache](https://rclone.org/cache/) backend + * [Union](https://rclone.org/union/) backend * Optional FUSE mount ([rclone mount](https://rclone.org/commands/rclone_mount/)) + * Multi-threaded downloads to local disk + * Can [serve](https://rclone.org/commands/rclone_serve/) local or remote files over [HTTP](https://rclone.org/commands/rclone_serve_http/)/[WebDav](https://rclone.org/commands/rclone_serve_webdav/)/[FTP](https://rclone.org/commands/rclone_serve_ftp/)/[SFTP](https://rclone.org/commands/rclone_serve_sftp/)/[dlna](https://rclone.org/commands/rclone_serve_dlna/) Links @@ -273,6 +276,21 @@ rclone config [flags] -h, --help help for config ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. +* [rclone config create](https://rclone.org/commands/rclone_config_create/) - Create a new remote with name, type and options. +* [rclone config delete](https://rclone.org/commands/rclone_config_delete/) - Delete an existing remote . +* [rclone config dump](https://rclone.org/commands/rclone_config_dump/) - Dump the config file as JSON. +* [rclone config edit](https://rclone.org/commands/rclone_config_edit/) - Enter an interactive configuration session. +* [rclone config file](https://rclone.org/commands/rclone_config_file/) - Show path of configuration file in use. +* [rclone config password](https://rclone.org/commands/rclone_config_password/) - Update password in an existing remote. +* [rclone config providers](https://rclone.org/commands/rclone_config_providers/) - List in JSON format all the providers and options. +* [rclone config show](https://rclone.org/commands/rclone_config_show/) - Print (decrypted) config file, or the config for a single remote. +* [rclone config update](https://rclone.org/commands/rclone_config_update/) - Update options in an existing remote. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone copy Copy files from source to dest, skipping already copied @@ -341,6 +359,12 @@ rclone copy source:path dest:path [flags] -h, --help help for copy ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone sync Make source and dest identical, modifying destination only. @@ -381,6 +405,12 @@ rclone sync source:path dest:path [flags] -h, --help help for sync ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone move Move files from source to dest. @@ -427,6 +457,12 @@ rclone move source:path dest:path [flags] -h, --help help for move ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone delete Remove the contents of path. @@ -466,6 +502,12 @@ rclone delete remote:path [flags] -h, --help help for delete ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone purge Remove the path and all of its contents. @@ -488,6 +530,12 @@ rclone purge remote:path [flags] -h, --help help for purge ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone mkdir Make the path if it doesn't already exist. @@ -506,6 +554,12 @@ rclone mkdir remote:path [flags] -h, --help help for mkdir ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone rmdir Remove the path if empty. @@ -526,6 +580,12 @@ rclone rmdir remote:path [flags] -h, --help help for rmdir ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone check Checks the files in the source and destination match. @@ -562,6 +622,12 @@ rclone check source:path dest:path [flags] --one-way Check one way only, source files must exist on remote ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone ls List the objects in the path with size and path. @@ -581,7 +647,7 @@ Eg 37600 fubuwic -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. There are several related list commands @@ -614,6 +680,12 @@ rclone ls remote:path [flags] -h, --help help for ls ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone lsd List all directories/containers/buckets in the path. @@ -643,7 +715,7 @@ Or If you just want the directory names use "rclone lsf --dirs-only". -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. There are several related list commands @@ -677,6 +749,12 @@ rclone lsd remote:path [flags] -R, --recursive Recurse into the listing. ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone lsl List the objects in path with modification time, size and path. @@ -696,7 +774,7 @@ Eg 37600 2016-06-25 18:55:40.814629136 fubuwic -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. There are several related list commands @@ -729,6 +807,12 @@ rclone lsl remote:path [flags] -h, --help help for lsl ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone md5sum Produces an md5sum file for all the objects in the path. @@ -750,6 +834,12 @@ rclone md5sum remote:path [flags] -h, --help help for md5sum ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone sha1sum Produces an sha1sum file for all the objects in the path. @@ -771,6 +861,12 @@ rclone sha1sum remote:path [flags] -h, --help help for sha1sum ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone size Prints the total size and number of objects in remote:path. @@ -790,6 +886,12 @@ rclone size remote:path [flags] --json format output as JSON ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone version Show the version number. @@ -836,6 +938,12 @@ rclone version [flags] -h, --help help for version ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone cleanup Clean up the remote if possible @@ -857,6 +965,12 @@ rclone cleanup remote:path [flags] -h, --help help for cleanup ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone dedupe Interactively find duplicate files and delete/rename them. @@ -956,6 +1070,12 @@ rclone dedupe [mode] remote:path [flags] -h, --help help for dedupe ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone about Get quota information from the remote. @@ -1018,6 +1138,12 @@ rclone about remote: [flags] --json Format output as JSON ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone authorize Remote authorization. @@ -1039,6 +1165,12 @@ rclone authorize [flags] -h, --help help for authorize ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone cachestats Print cache stats for a remote @@ -1059,6 +1191,12 @@ rclone cachestats source: [flags] -h, --help help for cachestats ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone cat Concatenates any files and sends them to stdout. @@ -1101,6 +1239,12 @@ rclone cat remote:path [flags] --tail int Only print the last N characters. ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone config create Create a new remote with name, type and options. @@ -1120,6 +1264,9 @@ Note that if the config process would normally ask a question the default is taken. Each time that happens rclone will print a message saying how to affect the value taken. +If any of the parameters passed is a password field, then rclone will +automatically obscure them before putting them in the config file. + So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this: @@ -1136,6 +1283,12 @@ rclone config create [ ]* [flags] -h, --help help for create ``` +### SEE ALSO + +* [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone config delete Delete an existing remote . @@ -1154,6 +1307,12 @@ rclone config delete [flags] -h, --help help for delete ``` +### SEE ALSO + +* [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone config dump Dump the config file as JSON. @@ -1172,6 +1331,12 @@ rclone config dump [flags] -h, --help help for dump ``` +### SEE ALSO + +* [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone config edit Enter an interactive configuration session. @@ -1193,6 +1358,12 @@ rclone config edit [flags] -h, --help help for edit ``` +### SEE ALSO + +* [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone config file Show path of configuration file in use. @@ -1211,6 +1382,12 @@ rclone config file [flags] -h, --help help for file ``` +### SEE ALSO + +* [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone config password Update password in an existing remote. @@ -1225,6 +1402,9 @@ For example to set password of a remote of name myremote you would do: rclone config password myremote fieldname mypassword +This command is obsolete now that "config update" and "config create" +both support obscuring passwords directly. + ``` rclone config password [ ]+ [flags] @@ -1236,6 +1416,12 @@ rclone config password [ ]+ [flags] -h, --help help for password ``` +### SEE ALSO + +* [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone config providers List in JSON format all the providers and options. @@ -1254,6 +1440,12 @@ rclone config providers [flags] -h, --help help for providers ``` +### SEE ALSO + +* [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone config show Print (decrypted) config file, or the config for a single remote. @@ -1272,6 +1464,12 @@ rclone config show [] [flags] -h, --help help for show ``` +### SEE ALSO + +* [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone config update Update options in an existing remote. @@ -1282,10 +1480,14 @@ Update options in an existing remote. Update an existing remote's options. The options should be passed in in pairs of . -For example to update the env_auth field of a remote of name myremote you would do: +For example to update the env_auth field of a remote of name myremote +you would do: rclone config update myremote swift env_auth true +If any of the parameters passed is a password field, then rclone will +automatically obscure them before putting them in the config file. + If the remote uses oauth the token will be updated, if you don't require this add an extra parameter thus: @@ -1302,6 +1504,12 @@ rclone config update [ ]+ [flags] -h, --help help for update ``` +### SEE ALSO + +* [rclone config](https://rclone.org/commands/rclone_config/) - Enter an interactive configuration session. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone copyto Copy files from source to dest, skipping already copied @@ -1348,6 +1556,12 @@ rclone copyto source:path dest:path [flags] -h, --help help for copyto ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone copyurl Copy url content to dest. @@ -1369,6 +1583,12 @@ rclone copyurl https://example.com dest:path [flags] -h, --help help for copyurl ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone cryptcheck Cryptcheck checks the integrity of a crypted remote. @@ -1415,6 +1635,12 @@ rclone cryptcheck remote:path cryptedremote:path [flags] --one-way Check one way only, source files must exist on destination ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone cryptdecode Cryptdecode returns unencrypted file names. @@ -1445,6 +1671,12 @@ rclone cryptdecode encryptedremote: encryptedfilename [flags] --reverse Reverse cryptdecode, encrypts filenames ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone dbhashsum Produces a Dropbox hash file for all the objects in the path. @@ -1468,6 +1700,12 @@ rclone dbhashsum remote:path [flags] -h, --help help for dbhashsum ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone deletefile Remove a single file from remote. @@ -1490,6 +1728,12 @@ rclone deletefile remote:path [flags] -h, --help help for deletefile ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone genautocomplete Output completion script for a given shell. @@ -1507,6 +1751,14 @@ Run with --help to list the supported shells. -h, --help help for genautocomplete ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. +* [rclone genautocomplete bash](https://rclone.org/commands/rclone_genautocomplete_bash/) - Output bash completion script for rclone. +* [rclone genautocomplete zsh](https://rclone.org/commands/rclone_genautocomplete_zsh/) - Output zsh completion script for rclone. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone genautocomplete bash Output bash completion script for rclone. @@ -1540,6 +1792,12 @@ rclone genautocomplete bash [output_file] [flags] -h, --help help for bash ``` +### SEE ALSO + +* [rclone genautocomplete](https://rclone.org/commands/rclone_genautocomplete/) - Output completion script for a given shell. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone genautocomplete zsh Output zsh completion script for rclone. @@ -1573,6 +1831,12 @@ rclone genautocomplete zsh [output_file] [flags] -h, --help help for zsh ``` +### SEE ALSO + +* [rclone genautocomplete](https://rclone.org/commands/rclone_genautocomplete/) - Output completion script for a given shell. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone gendocs Output markdown docs for rclone to the directory supplied. @@ -1594,6 +1858,12 @@ rclone gendocs output_directory [flags] -h, --help help for gendocs ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone hashsum Produces an hashsum file for all the objects in the path. @@ -1629,6 +1899,12 @@ rclone hashsum remote:path [flags] -h, --help help for hashsum ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone link Generate public link to file/folder. @@ -1657,6 +1933,12 @@ rclone link remote:path [flags] -h, --help help for link ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone listremotes List all the remotes in the config file. @@ -1680,6 +1962,12 @@ rclone listremotes [flags] --long Show the type as well as names. ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone lsf List directories and objects in remote:path formatted for parsing @@ -1713,6 +2001,7 @@ output: o - Original ID of underlying object m - MimeType of object if known e - encrypted name + T - tier of storage if known, eg "Hot" or "Cool" So if you wanted the path, size and modification time, you would use --format "pst", or maybe --format "tsp" to put the path last. @@ -1781,7 +2070,7 @@ those only (without traversing the whole directory structure): rclone copy --files-from new_files /path/to/local remote:path -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. There are several related list commands @@ -1823,6 +2112,12 @@ rclone lsf remote:path [flags] -s, --separator string Separator for the items in the format. (default ";") ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone lsjson List directories and objects in the path in JSON format. @@ -1841,13 +2136,16 @@ The output is an array of Items, where each Item looks like this }, "ID": "y2djkhiujf83u33", "OrigID": "UYOJVTUW00Q1RzTDA", + "IsBucket" : false, "IsDir" : false, "MimeType" : "application/octet-stream", "ModTime" : "2017-05-31T16:15:57.034468261+01:00", "Name" : "file.txt", "Encrypted" : "v0qpsdq8anpci8n929v3uu9338", + "EncryptedPath" : "kja9098349023498/v0qpsdq8anpci8n929v3uu9338", "Path" : "full/path/goes/here/file.txt", - "Size" : 6 + "Size" : 6, + "Tier" : "hot", } If --hash is not specified the Hashes property won't be emitted. @@ -1865,6 +2163,10 @@ If "remote:path" contains the file "subfolder/file.txt", the Path for "file.txt" will be "subfolder/file.txt", not "remote:path/subfolder/file.txt". When used without --recursive the Path will always be the same as Name. +If the directory is a bucket in a bucket based backend, then +"IsBucket" will be set to true. This key won't be present unless it is +"true". + The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the @@ -1876,7 +2178,7 @@ will be shown ("2017-05-31T16:15:57+01:00"). The whole output can be processed as a JSON blob, or alternatively it can be processed line by line as each item is written one to a line. -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. There are several related list commands @@ -1916,6 +2218,12 @@ rclone lsjson remote:path [flags] -R, --recursive Recurse into the listing. ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone mount Mount the remote as file system on a mountpoint. @@ -2222,7 +2530,7 @@ rclone mount remote:path /path/to/mountpoint [flags] --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required. - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for mount --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k) --no-checksum Don't compare checksums on up/download. @@ -2231,7 +2539,7 @@ rclone mount remote:path /path/to/mountpoint [flags] -o, --option stringArray Option for libfuse/WinFsp. Repeat if required. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -2243,6 +2551,12 @@ 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 ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone moveto Move file or directory from source to dest. @@ -2254,7 +2568,7 @@ If source:path is a file or directory then it moves it to a file or directory named dest:path. This can be used to rename files or upload single files to other than -their existing name. If the source is a directory then it acts exacty +their existing name. If the source is a directory then it acts exactly like the move command. So @@ -2292,6 +2606,12 @@ rclone moveto source:path dest:path [flags] -h, --help help for moveto ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone ncdu Explore a remote with a text based user interface. @@ -2341,6 +2661,12 @@ rclone ncdu remote:path [flags] -h, --help help for ncdu ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone obscure Obscure password for use in the rclone.conf @@ -2359,6 +2685,12 @@ rclone obscure password [flags] -h, --help help for obscure ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone rc Run a command against a running rclone. @@ -2385,6 +2717,12 @@ The --json parameter can be used to pass in a JSON blob as an input instead of key=value arguments. This is the only way of passing in more complicated values. +Use --loopback to connect to the rclone instance running "rclone rc". +This is very useful for testing commands without having to run an +rclone rc server, eg: + + rclone rc --loopback operations/about fs=/ + Use "rclone rc" to see a list of all possible commands. ``` @@ -2396,12 +2734,19 @@ rclone rc commands parameter [flags] ``` -h, --help help for rc --json string Input JSON - use instead of key=value args. + --loopback If set connect to this rclone instance not via HTTP. --no-output If set don't output the JSON result. --pass string Password to use to connect to rclone remote control. --url string URL to connect to rclone remote control. (default "http://localhost:5572/") --user string Username to use to rclone remote control. ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone rcat Copies standard input to file on remote. @@ -2442,6 +2787,12 @@ rclone rcat remote:path [flags] -h, --help help for rcat ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone rcd Run rclone listening to remote control commands only. @@ -2470,6 +2821,12 @@ rclone rcd * [flags] -h, --help help for rcd ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone rmdirs Remove empty directories under the path. @@ -2498,6 +2855,12 @@ rclone rmdirs remote:path [flags] --leave-root Do not remove root directory if empty ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone serve Serve a remote over a protocol. @@ -2522,6 +2885,18 @@ rclone serve [opts] [flags] -h, --help help for serve ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. +* [rclone serve dlna](https://rclone.org/commands/rclone_serve_dlna/) - Serve remote:path over DLNA +* [rclone serve ftp](https://rclone.org/commands/rclone_serve_ftp/) - Serve remote:path over FTP. +* [rclone serve http](https://rclone.org/commands/rclone_serve_http/) - Serve the remote over HTTP. +* [rclone serve restic](https://rclone.org/commands/rclone_serve_restic/) - Serve the remote for restic's REST API. +* [rclone serve sftp](https://rclone.org/commands/rclone_serve_sftp/) - Serve the remote over SFTP. +* [rclone serve webdav](https://rclone.org/commands/rclone_serve_webdav/) - Serve remote:path over webdav. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone serve dlna Serve remote:path over DLNA @@ -2544,6 +2919,11 @@ Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. +Use --name to choose the friendly server name, which is by +default "rclone (hostname)". + +Use --log-trace in conjunction with -vv to enable additional debug +logging of all UPNP traffic. ### Directory Cache @@ -2691,14 +3071,16 @@ rclone serve dlna remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for dlna + --log-trace enable trace logging of SOAP traffic + --name string name of DLNA server --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -2708,6 +3090,12 @@ 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 ALSO + +* [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone serve ftp Serve remote:path over FTP. @@ -2881,7 +3269,7 @@ rclone serve ftp remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for ftp --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). @@ -2889,8 +3277,9 @@ rclone serve ftp remote:path [flags] --pass string Password for authentication. (empty value allow every password) --passive-port string Passive port range to use. (default "30000-32000") --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) + --public-ip string Public IP address to advertise for passive connections. --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --user string User name for authentication. (default "anonymous") --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) @@ -2901,6 +3290,12 @@ 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 ALSO + +* [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone serve http Serve the remote over HTTP. @@ -3117,7 +3512,7 @@ rclone serve http remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for http --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -3131,7 +3526,7 @@ rclone serve http remote:path [flags] --realm string realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) @@ -3142,6 +3537,12 @@ 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 ALSO + +* [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone serve restic Serve the remote for restic's REST API. @@ -3199,14 +3600,14 @@ For example: $ export RESTIC_PASSWORD=yourpassword $ restic init created restic backend 8b1a4b56ae at rest:http://localhost:8080/ - + Please note that knowledge of your password is required to access the repository. Losing your password means that your data is irrecoverably lost. $ restic backup /path/to/files/to/backup scan [/path/to/files/to/backup] scanned 189 directories, 312 files in 0:00 - [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 + [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 duration: 0:00 snapshot 45c8fdd8 saved @@ -3221,6 +3622,10 @@ these **must** end with /. Eg $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ # backup user2 stuff +#### Private repositories #### + +The "--private-repos" flag can be used to limit users to repositories starting +with a path of "//". ### Server options @@ -3289,6 +3694,7 @@ rclone serve restic remote:path [flags] --key string SSL PEM Private key --max-header-bytes int Maximum size of request header (default 4096) --pass string Password for authentication. + --private-repos users can only access their private repo --realm string realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) @@ -3296,6 +3702,224 @@ rclone serve restic remote:path [flags] --user string User name for authentication. ``` +### SEE ALSO + +* [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + +## rclone serve sftp + +Serve the remote over SFTP. + +### Synopsis + +rclone serve sftp implements an SFTP server to serve the remote +over SFTP. This can be used with an SFTP client or you can make a +remote of type sftp to use with it. + +You can use the filter flags (eg --include, --exclude) to control what +is served. + +The server will log errors. Use -v to see access logs. + +--bwlimit will be respected for file transfers. Use --stats to +control the stats printing. + +You must provide some means of authentication, either with --user/--pass, +an authorized keys file (specify location with --authorized-keys - the +default is the same as ssh) or set the --no-auth flag for no +authentication when logging in. + +Note that this also implements a small number of shell commands so +that it can provide md5sum/sha1sum/df information for the rclone sftp +backend. This means that is can support SHA1SUMs, MD5SUMs and the +about command when paired with the rclone sftp backend. + +If you don't supply a --key then rclone will generate one and cache it +for later use. + +By default the server binds to localhost:2022 - if you want it to be +reachable externally then supply "--addr :2022" for example. + +Note that the default of "--vfs-cache-mode off" is fine for the rclone +sftp backend, but it may not be with other SFTP clients. + + +### Directory Cache + +Using the `--dir-cache-time` flag, you can set how long a +directory should be considered up to date and not refreshed from the +backend. Changes made locally in the mount may appear immediately or +invalidate the cache. However, changes done on the remote will only +be picked up once the cache expires. + +Alternatively, you can send a `SIGHUP` signal to rclone for +it to flush all directory caches, regardless of how old they are. +Assuming only one rclone instance is running, you can reset the cache +like this: + + kill -SIGHUP $(pidof rclone) + +If you configure rclone with a [remote control](/rc) then you can use +rclone rc to flush the whole directory cache: + + rclone rc vfs/forget + +Or individual files or directories: + + rclone rc vfs/forget file=path/to/file dir=path/to/dir + +### File Buffering + +The `--buffer-size` flag determines the amount of memory, +that will be used to buffer data in advance. + +Each open file descriptor will try to keep the specified amount of +data in memory at all times. The buffered data is bound to one file +descriptor and won't be shared between multiple open file descriptors +of the same file. + +This flag is a upper limit for the used memory per file descriptor. +The buffer will only use memory for data that is downloaded but not +not yet read. If the buffer is empty, only a small amount of memory +will be used. +The maximum memory used by rclone for buffering can be up to +`--buffer-size * open files`. + +### File Caching + +These flags control the VFS file caching options. The VFS layer is +used by rclone mount to make a cloud storage system work more like a +normal file system. + +You'll need to enable VFS caching if you want, for example, to read +and write simultaneously to a file. See below for more details. + +Note that the VFS cache works in addition to the cache backend and you +may find that you need one or the other or both. + + --cache-dir string Directory rclone will use for caching. + --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) + --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") + --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-cache-max-size int Max total size of objects in the cache. (default off) + +If run with `-vv` rclone will print the location of the file cache. The +files are stored in the user cache file area which is OS dependent but +can be controlled with `--cache-dir` or setting the appropriate +environment variable. + +The cache has 4 different modes selected by `--vfs-cache-mode`. +The higher the cache mode the more compatible rclone becomes at the +cost of using disk space. + +Note that files are written back to the remote only when they are +closed so if rclone is quit or dies with open files then these won't +get written back to the remote. However they will still be in the on +disk cache. + +If using --vfs-cache-max-size note that the cache may exceed this size +for two reasons. Firstly because it is only checked every +--vfs-cache-poll-interval. Secondly because open files cannot be +evicted from the cache. + +#### --vfs-cache-mode off + +In this mode the cache will read directly from the remote and write +directly to the remote without caching anything on disk. + +This will mean some operations are not possible + + * Files can't be opened for both read AND write + * Files opened for write can't be seeked + * Existing files opened for write must have O_TRUNC set + * Files open for read with O_TRUNC will be opened write only + * Files open for write only will behave as if O_TRUNC was supplied + * Open modes O_APPEND, O_TRUNC are ignored + * If an upload fails it can't be retried + +#### --vfs-cache-mode minimal + +This is very similar to "off" except that files opened for read AND +write will be buffered to disks. This means that files opened for +write will be a lot more compatible, but uses the minimal disk space. + +These operations are not possible + + * Files opened for write only can't be seeked + * Existing files opened for write must have O_TRUNC set + * Files opened for write only will ignore O_APPEND, O_TRUNC + * If an upload fails it can't be retried + +#### --vfs-cache-mode writes + +In this mode files opened for read only are still read directly from +the remote, write only and read/write files are buffered to disk +first. + +This mode should support all normal file system operations. + +If an upload fails it will be retried up to --low-level-retries times. + +#### --vfs-cache-mode full + +In this mode all reads and writes are buffered to and from disk. When +a file is opened for read it will be downloaded in its entirety first. + +This may be appropriate for your needs, or you may prefer to look at +the cache backend which does a much more sophisticated job of caching, +including caching directory hierarchies and chunks of files. + +In this mode, unlike the others, when a file is written to the disk, +it will be kept on the disk after it is written to the remote. It +will be purged on a schedule according to `--vfs-cache-max-age`. + +This mode should support all normal file system operations. + +If an upload or download fails it will be retried up to +--low-level-retries times. + + +``` +rclone serve sftp remote:path [flags] +``` + +### Options + +``` + --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2022") + --authorized-keys string Authorized keys file (default "~/.ssh/authorized_keys") + --dir-cache-time duration Time to cache directory entries for. (default 5m0s) + --dir-perms FileMode Directory permissions (default 0777) + --file-perms FileMode File permissions (default 0666) + --gid uint32 Override the gid field set by the filesystem. (default 1000) + -h, --help help for sftp + --key string SSH private key file (leave blank to auto generate) + --no-auth Allow connections with no authentication if set. + --no-checksum Don't compare checksums on up/download. + --no-modtime Don't read/write the modification time (can speed things up). + --no-seek Don't allow seeking in files. + --pass string Password for authentication. + --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) + --read-only Mount read-only. + --uid uint32 Override the uid field set by the filesystem. (default 1000) + --umask int Override the permission bits set by the filesystem. (default 2) + --user string User name for authentication. + --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) + --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) + --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) + --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) + --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) +``` + +### SEE ALSO + +* [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone serve webdav Serve remote:path over webdav. @@ -3305,8 +3929,8 @@ Serve remote:path over webdav. rclone serve webdav implements a basic webdav server to serve the remote over HTTP via the webdav protocol. This can be viewed with a -webdav client or you can make a remote of type webdav to read and -write it. +webdav client, through a web browser, or you can make a remote of +type webdav to read and write it. ### Webdav options @@ -3519,9 +4143,10 @@ rclone serve webdav remote:path [flags] --client-ca string Client certificate authority to verify clients with --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) + --disable-dir-list Disable HTML directory list on GET request for a directory --etag-hash string Which hash to use for the ETag, or auto or blank for off --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for webdav --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -3535,7 +4160,7 @@ rclone serve webdav remote:path [flags] --realm string realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) @@ -3546,6 +4171,12 @@ 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 ALSO + +* [rclone serve](https://rclone.org/commands/rclone_serve/) - Serve a remote over a protocol. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone settier Changes storage class/tier of objects in remote. @@ -3558,7 +4189,7 @@ Few cloud storage services provides different storage classes on objects, for example AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive, Google Cloud Storage, Regional Storage, Nearline, Coldline etc. -Note that, certain tier chages make objects not available to access immediately. +Note that, certain tier changes make objects not available to access immediately. For example tiering to archive in azure blob storage makes objects in frozen state, user can restore by setting tier to Hot/Cool, similarly S3 to Glacier makes object inaccessible.true @@ -3586,6 +4217,12 @@ rclone settier tier remote:path [flags] -h, --help help for settier ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone touch Create new file or change file modification time. @@ -3606,6 +4243,12 @@ 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 ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + ## rclone tree List the contents of the remote in a tree like fashion. @@ -3667,6 +4310,12 @@ rclone tree remote:path [flags] --version Sort files alphanumerically by version. ``` +### SEE ALSO + +* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends. + +###### Auto generated by spf13/cobra on 15-Jun-2019 + Copying single files -------------------- @@ -4013,7 +4662,11 @@ Specify the location of the rclone config file. Normally the config file is in your home directory as a file called `.config/rclone/rclone.conf` (or `.rclone.conf` if created with an older version). If `$XDG_CONFIG_HOME` is set it will be at -`$XDG_CONFIG_HOME/rclone/rclone.conf` +`$XDG_CONFIG_HOME/rclone/rclone.conf`. + +If there is a file `rclone.conf` in the same directory as the rclone +executable it will be preferred. This file must be created manually +for Rclone to use it, it will never be created automatically. If you run `rclone config file` you will see where the default location is for you. @@ -4061,6 +4714,12 @@ Do a trial run with no permanent changes. Use this to see what rclone would do without actually doing it. Useful when setting up the `sync` command which deletes files in the destination. +### --ignore-case-sync ### + +Using this option will cause rclone to ignore the case of the files +when synchronizing so files will not be copied/synced when the +existing filenames are the same, even if the casing is different. + ### --ignore-checksum ### Normally rclone will check that the checksums of transferred files @@ -4235,6 +4894,49 @@ if you are reading and writing to an OS X filing system this will be This command line flag allows you to override that computed default. +### --multi-thread-cutoff=SIZE ### + +When downloading files to the local backend above this size, rclone +will use multiple threads to download the file. (default 250M) + +Rclone preallocates the file (using `fallocate(FALLOC_FL_KEEP_SIZE)` +on unix or `NTSetInformationFile` on Windows both of which takes no +time) then each thread writes directly into the file at the correct +place. This means that rclone won't create fragmented or sparse files +and there won't be any assembly time at the end of the transfer. + +The number of threads used to dowload is controlled by +`--multi-thread-streams`. + +Use `-vv` if you wish to see info about the threads. + +This will work with the `sync`/`copy`/`move` commands and friends +`copyto`/`moveto`. Multi thread downloads will be used with `rclone +mount` and `rclone serve` if `--vfs-cache-mode` is set to `writes` or +above. + +**NB** that this **only** works for a local destination but will work +with any source. + +### --multi-thread-streams=N ### + +When using multi thread downloads (see above `--multi-thread-cutoff`) +this sets the maximum number of streams to use. Set to `0` to disable +multi thread downloads. (Default 4) + +Exactly how many streams rclone uses for the download depends on the +size of the file. To calculate the number of download streams Rclone +divides the size of the file by the `--multi-thread-cutoff` and rounds +up, up to the maximum set with `--multi-thread-streams`. + +So if `--multi-thread-cutoff 250MB` and `--multi-thread-streams 4` are +in effect (the defaults): + +- 0MB.250MB files will be downloaded with 1 stream +- 250MB..500MB files will be downloaded with 2 streams +- 500MB..750MB files will be downloaded with 3 streams +- 750MB+ files will be downloaded with 4 streams + ### --no-gzip-encoding ### Don't set `Accept-Encoding: gzip`. This means that rclone won't ask @@ -4361,6 +5063,18 @@ section](#logging) for more info on log levels. When this is specified, rclone condenses the stats into a single line showing the most important stats only. +### --stats-one-line-date ### + +When this is specified, rclone enables the single-line stats and prepends +the display with a date string. The default is `2006/01/02 15:04:05 - ` + +### --stats-one-line-date-format ### + +When this is specified, rclone enables the single-line stats and prepends +the display with a user-supplied date string. The date string MUST be +enclosed in quotes. Follow [golang specs](https://golang.org/pkg/time/#Time.Format) for +date formatting syntax. + ### --stats-unit=bits|bytes ### By default, data transfer rates will be printed in bytes/second. @@ -5598,6 +6312,14 @@ style. Default Off. +### --rc-job-expire-duration=DURATION + +Expire finished async jobs older than DURATION (default 60s). + +### --rc-job-expire-interval=DURATION + +Interval duration to check for expired async jobs (default 10s). + ### --rc-no-auth By default rclone will require authorisation to have been set up on @@ -5765,7 +6487,6 @@ Show statistics for the cache remote. This takes the following parameters - name - name of remote -- type - type of new remote - type - type of the new remote @@ -5816,7 +6537,6 @@ Authentication is required for this call. This takes the following parameters - name - name of remote -- type - type of new remote See the [config password command](https://rclone.org/commands/rclone_config_password/) command for more information on the above. @@ -5837,7 +6557,6 @@ Authentication is required for this call. This takes the following parameters - name - name of remote -- type - type of new remote See the [config update command](https://rclone.org/commands/rclone_config_update/) command for more information on the above. @@ -5965,10 +6684,11 @@ Results This takes the following parameters - fs - a remote name string eg "drive:" -- remote - a path within that remote eg "dir" The result is as returned from rclone about --json +See the [about command](https://rclone.org/commands/rclone_size/) command for more information on the above. + Authentication is required for this call. ### operations/cleanup: Remove trashed files in the remote or path @@ -6025,6 +6745,63 @@ See the [deletefile command](https://rclone.org/commands/rclone_deletefile/) com Authentication is required for this call. +### operations/fsinfo: Return information about the remote + +This takes the following parameters + +- fs - a remote name string eg "drive:" + +This returns info about the remote passed in; + +``` +{ + // optional features and whether they are available or not + "Features": { + "About": true, + "BucketBased": false, + "CanHaveEmptyDirectories": true, + "CaseInsensitive": false, + "ChangeNotify": false, + "CleanUp": false, + "Copy": false, + "DirCacheFlush": false, + "DirMove": true, + "DuplicateFiles": false, + "GetTier": false, + "ListR": false, + "MergeDirs": false, + "Move": true, + "OpenWriterAt": true, + "PublicLink": false, + "Purge": true, + "PutStream": true, + "PutUnchecked": false, + "ReadMimeType": false, + "ServerSideAcrossConfigs": false, + "SetTier": false, + "SetWrapper": false, + "UnWrap": false, + "WrapFs": false, + "WriteMimeType": false + }, + // Names of hashes available + "Hashes": [ + "MD5", + "SHA-1", + "DropboxHash", + "QuickXorHash" + ], + "Name": "local", // Name as created + "Precision": 1, // Precision of timestamps in ns + "Root": "/", // Path as created + "String": "Local file system at /" // how the remote will appear in logs +} +``` + +This command does not have a command line equivalent so use this instead: + + rclone rc --loopback operations/fsinfo fs=remote: + ### operations/list: List the given remote and path in JSON format This takes the following parameters @@ -6043,7 +6820,7 @@ The result is - list - This is an array of objects as described in the lsjson command -See the lsjson command for more information on the above and examples. +See the [lsjson command](https://rclone.org/commands/rclone_lsjson/) for more information on the above and examples. Authentication is required for this call. @@ -6632,7 +7409,7 @@ operations more efficient. | ---------------------------- |:-----:|:----:|:----:|:-------:|:-------:|:-----:|:------------:|:------------:|:-----:| | Amazon Drive | Yes | No | Yes | Yes | No [#575](https://github.com/ncw/rclone/issues/575) | No | No | No [#2178](https://github.com/ncw/rclone/issues/2178) | No | | Amazon S3 | No | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/ncw/rclone/issues/2178) | No | -| Backblaze B2 | No | No | No | No | Yes | Yes | Yes | No [#2178](https://github.com/ncw/rclone/issues/2178) | No | +| Backblaze B2 | No | Yes | No | No | Yes | Yes | Yes | No [#2178](https://github.com/ncw/rclone/issues/2178) | No | | Box | Yes | Yes | Yes | Yes | No [#575](https://github.com/ncw/rclone/issues/575) | No | Yes | Yes | No | | Dropbox | Yes | Yes | Yes | Yes | No [#575](https://github.com/ncw/rclone/issues/575) | No | Yes | Yes | Yes | | FTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/ncw/rclone/issues/2178) | No | @@ -6641,14 +7418,14 @@ operations more efficient. | HTTP | No | No | No | No | No | No | No | No [#2178](https://github.com/ncw/rclone/issues/2178) | No | | Hubic | Yes † | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/ncw/rclone/issues/2178) | Yes | | Jottacloud | Yes | Yes | Yes | Yes | No | Yes | No | Yes | Yes | -| Mega | Yes | No | Yes | Yes | No | No | No | No [#2178](https://github.com/ncw/rclone/issues/2178) | Yes | +| Mega | Yes | No | Yes | Yes | Yes | No | No | No [#2178](https://github.com/ncw/rclone/issues/2178) | Yes | | Microsoft Azure Blob Storage | Yes | Yes | No | No | No | Yes | No | No [#2178](https://github.com/ncw/rclone/issues/2178) | No | | Microsoft OneDrive | Yes | Yes | Yes | Yes | No [#575](https://github.com/ncw/rclone/issues/575) | No | No | Yes | Yes | | OpenDrive | Yes | Yes | Yes | Yes | No | No | No | No | No | | Openstack Swift | Yes † | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/ncw/rclone/issues/2178) | Yes | | pCloud | Yes | Yes | Yes | Yes | Yes | No | No | No [#2178](https://github.com/ncw/rclone/issues/2178) | Yes | | QingStor | No | Yes | No | No | No | Yes | No | No [#2178](https://github.com/ncw/rclone/issues/2178) | No | -| SFTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/ncw/rclone/issues/2178) | No | +| SFTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/ncw/rclone/issues/2178) | Yes | | WebDAV | Yes | Yes | Yes | Yes | No | No | Yes ‡ | No [#2178](https://github.com/ncw/rclone/issues/2178) | Yes | | Yandex Disk | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | | The local filesystem | Yes | No | Yes | Yes | No | No | Yes | No | Yes | @@ -6762,7 +7539,7 @@ n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" 2 / Amazon Drive \ "amazon cloud drive" @@ -6852,7 +7629,7 @@ Copy another local directory to the alias directory called source ### Standard Options -Here are the standard options specific to alias (Alias for a existing remote). +Here are the standard options specific to alias (Alias for an existing remote). #### --alias-remote @@ -7217,7 +7994,7 @@ n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" 2 / Amazon Drive \ "amazon cloud drive" @@ -7427,6 +8204,11 @@ files whose local modtime is newer than the time it was last uploaded. The modified time is stored as metadata on the object as `X-Amz-Meta-Mtime` as floating point since the epoch accurate to 1 ns. +If the modification time needs to be updated rclone will attempt to perform a server +side copy to update the modification if the object can be copied in a single part. +In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive +storage the object will be uploaded rather than copied. + ### Multipart uploads ### rclone supports multipart uploads with S3 which means that it can @@ -7559,6 +8341,9 @@ tries to access data from the glacier storage class you will see an error like b In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) the object(s) in question before using rclone. +Note that rclone only speaks the S3 API it does not speak the Glacier +Vault API, so rclone cannot directly access Glacier Vaults. + ### Standard Options @@ -7859,6 +8644,8 @@ Required when using an S3 clone. - Wasabi US East endpoint - "s3.us-west-1.wasabisys.com" - Wasabi US West endpoint + - "s3.eu-central-1.wasabisys.com" + - Wasabi EU Central endpoint #### --s3-location-constraint @@ -8220,6 +9007,17 @@ Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. - Type: bool - Default: false +#### --s3-use-accelerate-endpoint + +If true use the AWS S3 accelerated endpoint. + +See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) + +- Config: use_accelerate_endpoint +- Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT +- Type: bool +- Default: false + ### Anonymous access to public buckets ### @@ -8399,7 +9197,7 @@ To configure access to IBM COS S3, follow the steps below: 3. Select "s3" storage. ``` Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" 2 / Amazon Drive \ "amazon cloud drive" @@ -8986,10 +9784,9 @@ The modified time is stored as metadata on the object as in the Backblaze standard. Other tools should be able to use this as a modified time. -Modified times are used in syncing and are fully supported except in -the case of updating a modification time on an existing object. In -this case the object will be uploaded again as B2 doesn't have an API -method to set the modification time independent of doing an upload. +Modified times are used in syncing and are fully supported. Note that +if a modification time needs to be updated on an object then it will +create a new version of the object. ### SHA1 checksums ### @@ -9040,6 +9837,11 @@ the file instead of hiding it. Old versions of files, where available, are visible using the `--b2-versions` flag. +**NB** Note that `--b2-versions` does not work with crypt at the +moment [#1627](https://github.com/ncw/rclone/issues/1627). Using +[--backup-dir](/docs/#backup-dir-dir) with rclone is the recommended +way of working around this. + If you wish to remove all the old versions then you can use the `rclone cleanup remote:bucket` command which will delete all the old versions of files, leaving the current ones intact. You can also @@ -9985,7 +10787,7 @@ The remote name is used as the DB file name. - Config: db_path - Env Var: RCLONE_CACHE_DB_PATH - Type: string -- Default: "/home/ncw/.cache/rclone/cache-backend" +- Default: "$HOME/.cache/rclone/cache-backend" #### --cache-chunk-path @@ -10001,7 +10803,7 @@ then "--cache-chunk-path" will use the same path as "--cache-db-path". - Config: chunk_path - Env Var: RCLONE_CACHE_CHUNK_PATH - Type: string -- Default: "/home/ncw/.cache/rclone/cache-backend" +- Default: "$HOME/.cache/rclone/cache-backend" #### --cache-db-purge @@ -10889,45 +11691,27 @@ q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. +Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value - 1 / Amazon Drive - \ "amazon cloud drive" - 2 / Amazon S3 (also Dreamhost, Ceph, Minio) - \ "s3" - 3 / Backblaze B2 - \ "b2" - 4 / Dropbox - \ "dropbox" - 5 / Encrypt/Decrypt a remote - \ "crypt" - 6 / FTP Connection +[snip] +10 / FTP Connection \ "ftp" - 7 / Google Cloud Storage (this is not Google Drive) - \ "google cloud storage" - 8 / Google Drive - \ "drive" - 9 / Hubic - \ "hubic" -10 / Local Disk - \ "local" -11 / Microsoft OneDrive - \ "onedrive" -12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) - \ "swift" -13 / SSH/SFTP Connection - \ "sftp" -14 / Yandex Disk - \ "yandex" +[snip] Storage> ftp +** See help for ftp backend at: https://rclone.org/ftp/ ** + FTP host to connect to +Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Connect to ftp.example.com \ "ftp.example.com" host> ftp.example.com FTP username, leave blank for current username, ncw -user> +Enter a string value. Press Enter for the default (""). +user> FTP port, leave blank to use default (21) -port> +Enter a string value. Press Enter for the default (""). +port> FTP password y) Yes type in my own password g) Generate random password @@ -10936,12 +11720,14 @@ Enter the password: password: Confirm the password: password: +Use FTP over TLS (Implicit) +Enter a boolean value (true or false). Press Enter for the default ("false"). +tls> Remote config -------------------- [remote] +type = ftp host = ftp.example.com -user = -port = pass = *** ENCRYPTED *** -------------------- y) Yes this is OK @@ -10978,6 +11764,12 @@ will be time of upload. FTP does not support any checksums. +### Implicit TLS ### + +FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled +in the config for the remote. The default FTPS port is `990` so the +port will likely have to be explictly set in the config for the remote. + ### Standard Options @@ -10997,7 +11789,7 @@ FTP host to connect to #### --ftp-user -FTP username, leave blank for current username, ncw +FTP username, leave blank for current username, $USER - Config: user - Env Var: RCLONE_FTP_USER @@ -11022,6 +11814,15 @@ FTP password - Type: string - Default: "" +#### --ftp-tls + +Use FTP over TLS (Implicit) + +- Config: tls +- Env Var: RCLONE_FTP_TLS +- Type: bool +- Default: false + ### Advanced Options Here are the advanced options specific to ftp (FTP Connection). @@ -11035,6 +11836,15 @@ Maximum number of FTP simultaneous connections, 0 for unlimited - Type: int - Default: 0 +#### --ftp-no-check-certificate + +Do not verify the TLS certificate of the server + +- Config: no_check_certificate +- Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE +- Type: bool +- Default: false + ### Limitations ### @@ -11051,6 +11861,9 @@ FTP could support server side move but doesn't yet. Note that the ftp backend does not support the `ftp_proxy` environment variable yet. +Note that while implicit FTP over TLS is supported, +explicit FTP over TLS is not. + Google Cloud Storage ------------------------------------------------- @@ -11860,6 +12673,10 @@ If you wish to empty your trash you can use the `rclone cleanup remote:` command which will permanently delete all your trashed files. This command does not take any path arguments. +Note that Google Drive takes some time (minutes to days) to empty the +trash even though the command returns within a few seconds. No output +is echoed, so there will be no confirmation even using -v or -vv. + ### Quota information ### To view your current quota you can use the `rclone about remote:` @@ -11890,7 +12707,7 @@ Note that rclone adds the extension to the google doc, so if it is called `My Spreadsheet` on google docs, it will be exported as `My Spreadsheet.xlsx` or `My Spreadsheet.pdf` etc. -When importing files into Google Drive, rclone will conververt all +When importing files into Google Drive, rclone will convert all files with an extension in `--drive-import-formats` to their associated document type. rclone will not convert any files by default, since the conversion @@ -12280,6 +13097,18 @@ Keep new head revision of each file forever. - Type: bool - Default: false +#### --drive-size-as-quota + +Show storage quota usage for file size. + +The storage used by a file is the size of the current version plus any +older versions that have been set to keep forever. + +- Config: size_as_quota +- Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA +- Type: bool +- Default: false + #### --drive-v2-download-min-size If Object's are greater, use drive v2 API to download. @@ -12307,6 +13136,20 @@ Number of API calls to allow without sleeping. - Type: int - Default: 100 +#### --drive-server-side-across-configs + +Allow server side operations (eg copy) to work across different drive configs. + +This can be useful if you wish to do a server side copy between two +different Google drives. Note that this isn't enabled by default +because it isn't easy to tell if it will work beween any two +configurations. + +- Config: server_side_across_configs +- Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS +- Type: bool +- Default: false + ### Limitations ### @@ -12784,26 +13627,20 @@ n) New remote s) Set configuration password q) Quit config n/s/q> n -name> remote +name> jotta Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] -13 / JottaCloud +14 / JottaCloud \ "jottacloud" [snip] Storage> jottacloud -User Name +** See help for jottacloud backend at: https://rclone.org/jottacloud/ ** + +User Name: Enter a string value. Press Enter for the default (""). -user> user -The mountpoint to use. -Enter a string value. Press Enter for the default (""). -Choose a number from below, or type in your own value - 1 / Will be synced by the official client. - \ "Sync" - 2 / Archive - \ "Archive" -mountpoint> Archive +user> user@email.tld Edit advanced config? (y/n) y) Yes n) No @@ -12817,16 +13654,35 @@ Rclone has it's own Jottacloud API KEY which works fine as long as one only uses y) Yes n) No y/n> y -Your Jottacloud password is only required during config and will not be stored. +Your Jottacloud password is only required during setup and will not be stored. password: + +Do you want to use a non standard device/mountpoint e.g. for accessing files uploaded using the official Jottacloud client? + +y) Yes +n) No +y/n> y +Please select the device to use. Normally this will be Jotta +Choose a number from below, or type in an existing value + 1 > DESKTOP-3H31129 + 2 > test1 + 3 > Jotta +Devices> 3 +Please select the mountpoint to user. Normally this will be Archive +Choose a number from below, or type in an existing value + 1 > Archive + 2 > Shared + 3 > Sync +Mountpoints> 1 -------------------- -[remote] +[jotta] type = jottacloud -user = olihey -mountpoint = Archive +user = 0xC4KE@gmail.com client_id = ..... client_secret = ........ token = {........} +device = Jotta +mountpoint = Archive -------------------- y) Yes this is OK e) Edit this remote @@ -12847,6 +13703,11 @@ To copy a local directory to an Jottacloud directory called backup rclone copy /home/source remote:backup +### Devices and Mountpoints ### + +The official Jottacloud client registers a device for each computer you install it on and then creates a mountpoint for each folder you select for Backup. +The web interface uses a special device called Jotta for the Archive, Sync and Shared mountpoints. In most cases you'll want to use the Jotta/Archive device/mounpoint however if you want to access files uploaded by the official rclone provides the option to select other devices and mountpoints during config. + ### --fast-list ### This remote supports `--fast-list` which allows you to use fewer @@ -12908,20 +13769,6 @@ User Name: - Type: string - Default: "" -#### --jottacloud-mountpoint - -The mountpoint to use. - -- Config: mountpoint -- Env Var: RCLONE_JOTTACLOUD_MOUNTPOINT -- Type: string -- Default: "" -- Examples: - - "Sync" - - Will be synced by the official client. - - "Archive" - - Archive - ### Advanced Options Here are the advanced options specific to jottacloud (JottaCloud). @@ -13008,7 +13855,7 @@ Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / A stackable unification remote, which can appear to merge the contents of several remotes \ "union" - 2 / Alias for a existing remote + 2 / Alias for an existing remote \ "alias" 3 / Amazon Drive \ "amazon cloud drive" @@ -13193,7 +14040,7 @@ n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" [snip] 14 / Mega @@ -13257,6 +14104,52 @@ messages in the log about duplicates. Use `rclone dedupe` to fix duplicated files. +### Failure to log-in ### + +Mega remotes seem to get blocked (reject logins) under "heavy use". +We haven't worked out the exact blocking rules but it seems to be +related to fast paced, sucessive rclone commands. + +For example, executing this command 90 times in a row `rclone link +remote:file` will cause the remote to become "blocked". This is not an +abnormal situation, for example if you wish to get the public links of +a directory with hundred of files... After more or less a week, the +remote will remote accept rclone logins normally again. + +You can mitigate this issue by mounting the remote it with `rclone +mount`. This will log-in when mounting and a log-out when unmounting +only. You can also run `rclone rcd` and then use `rclone rc` to run +the commands over the API to avoid logging in each time. + +Rclone does not currently close mega sessions (you can see them in the +web interface), however closing the sessions does not solve the issue. + +If you space rclone commands by 3 seconds it will avoid blocking the +remote. We haven't identified the exact blocking rules, so perhaps one +could execute the command 80 times without waiting and avoid blocking +by waiting 3 seconds, then continuing... + +Note that this has been observed by trial and error and might not be +set in stone. + +Other tools seem not to produce this blocking effect, as they use a +different working approach (state-based, using sessionIDs instead of +log-in) which isn't compatible with the current stateless rclone +approach. + +Note that once blocked, the use of other tools (such as megacmd) is +not a sure workaround: following megacmd login times have been +observed in sucession for blocked remote: 7 minutes, 20 min, 30min, 30 +min, 30min. Web access looks unaffected though. + +Investigation is continuing in relation to workarounds based on +timeouts, pacers, retrials and tpslimits - if you discover something +relevant, please post on the forum. + +So, if rclone was working nicely and suddenly you are unable to log-in +and you are sure the user and the password are correct, likely you +have got the remote blocked for a while. + ### Standard Options @@ -13627,10 +14520,10 @@ Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value ... -17 / Microsoft OneDrive +18 / Microsoft OneDrive \ "onedrive" ... -Storage> 17 +Storage> 18 Microsoft App Client Id Leave blank normally. Enter a string value. Press Enter for the default (""). @@ -15008,8 +15901,9 @@ Paths are specified as `remote:path`. If the path does not begin with a `/` it is relative to the home directory of the user. An empty path `remote:` refers to the user's home directory. -Note that some SFTP servers will need the leading `/` - Synology is a -good example of this. +"Note that some SFTP servers will need the leading / - Synology is a +good example of this. rsync.net, on the other hand, requires users to +OMIT the leading /. Here is an example of making an SFTP configuration. First run @@ -15309,6 +16203,14 @@ which are not under your control, and to which the execution of remote commands is prohibited. Set the configuration option `disable_hashcheck` to `true` to disable checksumming. +SFTP also supports `about` if the same login has shell +access and `df` are in the remote's PATH. `about` will +return the total space, free space, and used space on the remote +for the disk of the specified path on the remote or, if not set, +the disk of the root on the remote. +`about` will fail if it does not have shell +access or if `df` is not in the remote's PATH. + Note that some SFTP servers (eg Synology) the paths are different for SSH and SFTP so the hashes can't be calculated properly. For them using `disable_hashcheck` is a good idea. @@ -15370,7 +16272,7 @@ n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" 2 / Amazon Drive \ "amazon cloud drive" @@ -16255,6 +17157,91 @@ Don't cross filesystem boundaries (unix/macOS only). # Changelog +## v1.48.0 - 2019-06-15 + +* New commands + * serve sftp: Serve an rclone remote over SFTP (Nick Craig-Wood) +* New Features + * Multi threaded downloads to local storage (Nick Craig-Wood) + * controlled with `--multi-thread-cutoff` and `--multi-thread-streams` + * Use rclone.conf from rclone executable directory to enable portable use (albertony) + * Allow sync of a file and a directory with the same name (forgems) + * this is common on bucket based remotes, eg s3, gcs + * Add `--ignore-case-sync` for forced case insensitivity (garry415) + * Implement `--stats-one-line-date` and `--stats-one-line-date-format` (Peter Berbec) + * Log an ERROR for all commands which exit with non-zero status (Nick Craig-Wood) + * Use go-homedir to read the home directory more reliably (Nick Craig-Wood) + * Enable creating encrypted config through external script invocation (Wojciech Smigielski) + * build: Drop support for go1.8 (Nick Craig-Wood) + * config: Make config create/update encrypt passwords where necessary (Nick Craig-Wood) + * copyurl: Honor `--no-check-certificate` (Stefan Breunig) + * install: Linux skip man pages if no mandb (didil) + * lsf: Support showing the Tier of the object (Nick Craig-Wood) + * lsjson + * Added EncryptedPath to output (calisro) + * Support showing the Tier of the object (Nick Craig-Wood) + * Add IsBucket field for bucket based remote listing of the root (Nick Craig-Wood) + * rc + * Add `--loopback` flag to run commands directly without a server (Nick Craig-Wood) + * Add operations/fsinfo: Return information about the remote (Nick Craig-Wood) + * Skip auth for OPTIONS request (Nick Craig-Wood) + * cmd/providers: Add DefaultStr, ValueStr and Type fields (Nick Craig-Wood) + * jobs: Make job expiry timeouts configurable (Aleksandar Jankovic) + * serve dlna reworked and improved (Dan Walters) + * serve ftp: add `--ftp-public-ip` flag to specify public IP (calistri) + * serve restic: Add support for `--private-repos` in `serve restic` (Florian Apolloner) + * serve webdav: Combine serve webdav and serve http (Gary Kim) + * size: Ignore negative sizes when calculating total (Garry McNulty) +* Bug Fixes + * Make move and copy individual files obey `--backup-dir` (Nick Craig-Wood) + * If `--ignore-checksum` is in effect, don't calculate checksum (Nick Craig-Wood) + * moveto: Fix case-insensitive same remote move (Gary Kim) + * rc: Fix serving bucket based objects with `--rc-serve` (Nick Craig-Wood) + * serve webdav: Fix serveDir not being updated with changes from webdav (Gary Kim) +* Mount + * Fix poll interval documentation (Animosity022) +* VFS + * Make WriteAt for non cached files work with non-sequential writes (Nick Craig-Wood) +* Local + * Only calculate the required hashes for big speedup (Nick Craig-Wood) + * Log errors when listing instead of returning an error (Nick Craig-Wood) + * Fix preallocate warning on Linux with ZFS (Nick Craig-Wood) +* Crypt + * Make rclone dedupe work through crypt (Nick Craig-Wood) + * Fix wrapping of ChangeNotify to decrypt directories properly (Nick Craig-Wood) + * Support PublicLink (rclone link) of underlying backend (Nick Craig-Wood) + * Implement Optional methods SetTier, GetTier (Nick Craig-Wood) +* B2 + * Implement server side copy (Nick Craig-Wood) + * Implement SetModTime (Nick Craig-Wood) +* Drive + * Fix move and copy from TeamDrive to GDrive (Fionera) + * Add notes that cleanup works in the background on drive (Nick Craig-Wood) + * Add `--drive-server-side-across-configs` to default back to old server side copy semantics by default (Nick Craig-Wood) + * Add `--drive-size-as-quota` to show storage quota usage for file size (Garry McNulty) +* FTP + * Add FTP List timeout (Jeff Quinn) + * Add FTP over TLS support (Gary Kim) + * Add `--ftp-no-check-certificate` option for FTPS (Gary Kim) +* Google Cloud Storage + * Fix upload errors when uploading pre 1970 files (Nick Craig-Wood) +* Jottacloud + * Add support for selecting device and mountpoint. (buengese) +* Mega + * Add cleanup support (Gary Kim) +* Onedrive + * More accurately check if root is found (Cnly) +* S3 + * Suppport S3 Accelerated endpoints with `--s3-use-accelerate-endpoint` (Nick Craig-Wood) + * Add config info for Wasabi's EU Central endpoint (Robert Marko) + * Make SetModTime work for GLACIER while syncing (Philip Harvey) +* SFTP + * Add About support (Gary Kim) + * Fix about parsing of `df` results so it can cope with -ve results (Nick Craig-Wood) + * Send custom client version and debug server version (Nick Craig-Wood) +* WebDAV + * Retry on 423 Locked errors (Nick Craig-Wood) + ## v1.47.0 - 2019-04-13 * New backends @@ -18249,6 +19236,22 @@ synced. By default rclone only gets 10,000 files ahead in a sync so as not to use up too much memory. You can change this default with the [--max-backlog](/docs/#max-backlog-n) flag. +### Rclone is using too much memory or appears to have a memory leak + +Rclone is written in Go which uses a garbage collector. The default +settings for the garbage collector mean that it runs when the heap +size has doubled. + +However it is possible to tune the garbage collector to use less +memory by [setting GOGC](https://dave.cheney.net/tag/gogc) to a lower +value, say `export GOGC=20`. This will make the garbage collector +work harder, reducing memory size at the expense of CPU usage. + +The most common cause of rclone using lots of memory is a single +directory with thousands or millions of files in. Rclone has to load +this entirely into memory as rclone objects. Each Rclone object takes +0.5k-1k of memory. + License ------- @@ -18523,6 +19526,20 @@ Contributors * xopez <28950736+xopez@users.noreply.github.com> * Ben Boeckel * Manu + * Kyle E. Mitchell + * Gary Kim + * Jon + * Jeff Quinn + * Peter Berbec + * didil <1284255+didil@users.noreply.github.com> + * id01 + * Robert Marko + * Philip Harvey <32467456+pharveybattelle@users.noreply.github.com> + * JorisE + * garry415 + * forgems + * Florian Apolloner + * Aleksandar Jankovic # Contact the rclone project # diff --git a/MANUAL.txt b/MANUAL.txt index f4ac65098..f66f32efc 100644 --- a/MANUAL.txt +++ b/MANUAL.txt @@ -1,6 +1,6 @@ rclone(1) User Manual Nick Craig-Wood -Apr 13, 2019 +Jun 15, 2019 @@ -44,6 +44,7 @@ from: - put.io - QingStor - Rackspace Cloud Files +- rsync.net - Scaleway - SFTP - Wasabi @@ -60,10 +61,12 @@ Features - Sync (one way) mode to make a directory identical - Check mode to check for file hash equality - Can sync to and from network, eg two different cloud accounts -- (Encryption) backend -- (Cache) backend -- (Union) backend +- Encryption backend +- Cache backend +- Union backend - Optional FUSE mount (rclone mount) +- Multi-threaded downloads to local disk +- Can serve local or remote files over HTTP/WebDav/FTP/SFTP/dlna Links @@ -278,6 +281,24 @@ Options -h, --help help for config +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. +- rclone config create - Create a new remote with name, type and + options. +- rclone config delete - Delete an existing remote . +- rclone config dump - Dump the config file as JSON. +- rclone config edit - Enter an interactive configuration session. +- rclone config file - Show path of configuration file in use. +- rclone config password - Update password in an existing remote. +- rclone config providers - List in JSON format all the providers and + options. +- rclone config show - Print (decrypted) config file, or the config + for a single remote. +- rclone config update - Update options in an existing remote. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone copy @@ -339,6 +360,12 @@ Options --create-empty-src-dirs Create empty source dirs on destination after copy -h, --help help for copy +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone sync @@ -374,6 +401,12 @@ Options --create-empty-src-dirs Create empty source dirs on destination after sync -h, --help help for sync +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone move @@ -414,6 +447,12 @@ Options --delete-empty-src-dirs Delete empty source dirs after move -h, --help help for move +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone delete @@ -448,6 +487,12 @@ Options -h, --help help for delete +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone purge @@ -465,6 +510,12 @@ Options -h, --help help for purge +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone mkdir @@ -480,6 +531,12 @@ Options -h, --help help for mkdir +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone rmdir @@ -496,6 +553,12 @@ Options -h, --help help for rmdir +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone check @@ -528,6 +591,12 @@ Options -h, --help help for check --one-way Check one way only, source files must exist on remote +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone ls @@ -546,7 +615,7 @@ Eg 94467 diwogej7 37600 fubuwic -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. There are several related list commands @@ -575,6 +644,12 @@ Options -h, --help help for ls +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone lsd @@ -603,7 +678,7 @@ Or If you just want the directory names use “rclone lsf –dirs-only”. -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. There are several related list commands @@ -633,6 +708,12 @@ Options -h, --help help for lsd -R, --recursive Recurse into the listing. +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone lsl @@ -652,7 +733,7 @@ Eg 94467 2016-06-25 18:55:43.046609333 diwogej7 37600 2016-06-25 18:55:40.814629136 fubuwic -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. There are several related list commands @@ -681,6 +762,12 @@ Options -h, --help help for lsl +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone md5sum @@ -697,6 +784,12 @@ Options -h, --help help for md5sum +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone sha1sum @@ -713,6 +806,12 @@ Options -h, --help help for sha1sum +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone size @@ -729,6 +828,12 @@ Options -h, --help help for size --json format output as JSON +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone version @@ -769,6 +874,12 @@ Options --check Check for new version. -h, --help help for version +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone cleanup @@ -785,6 +896,12 @@ Options -h, --help help for cleanup +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone dedupe @@ -887,6 +1004,12 @@ Options --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|rename. (default "interactive") -h, --help help for dedupe +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone about @@ -944,6 +1067,12 @@ Options -h, --help help for about --json Format output as JSON +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone authorize @@ -960,6 +1089,12 @@ Options -h, --help help for authorize +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone cachestats @@ -975,6 +1110,12 @@ Options -h, --help help for cachestats +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone cat @@ -1012,6 +1153,12 @@ Options --offset int Start printing at offset N (or from end if -ve). --tail int Only print the last N characters. +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone config create @@ -1031,6 +1178,9 @@ Note that if the config process would normally ask a question the default is taken. Each time that happens rclone will print a message saying how to affect the value taken. +If any of the parameters passed is a password field, then rclone will +automatically obscure them before putting them in the config file. + So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this: @@ -1042,6 +1192,12 @@ Options -h, --help help for create +SEE ALSO + +- rclone config - Enter an interactive configuration session. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone config delete @@ -1057,6 +1213,12 @@ Options -h, --help help for delete +SEE ALSO + +- rclone config - Enter an interactive configuration session. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone config dump @@ -1072,6 +1234,12 @@ Options -h, --help help for dump +SEE ALSO + +- rclone config - Enter an interactive configuration session. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone config edit @@ -1089,6 +1257,12 @@ Options -h, --help help for edit +SEE ALSO + +- rclone config - Enter an interactive configuration session. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone config file @@ -1104,6 +1278,12 @@ Options -h, --help help for file +SEE ALSO + +- rclone config - Enter an interactive configuration session. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone config password @@ -1118,12 +1298,21 @@ For example to set password of a remote of name myremote you would do: rclone config password myremote fieldname mypassword +This command is obsolete now that “config update” and “config create” +both support obscuring passwords directly. + rclone config password [ ]+ [flags] Options -h, --help help for password +SEE ALSO + +- rclone config - Enter an interactive configuration session. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone config providers @@ -1139,6 +1328,12 @@ Options -h, --help help for providers +SEE ALSO + +- rclone config - Enter an interactive configuration session. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone config show @@ -1154,6 +1349,12 @@ Options -h, --help help for show +SEE ALSO + +- rclone config - Enter an interactive configuration session. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone config update @@ -1169,6 +1370,9 @@ you would do: rclone config update myremote swift env_auth true +If any of the parameters passed is a password field, then rclone will +automatically obscure them before putting them in the config file. + If the remote uses oauth the token will be updated, if you don’t require this add an extra parameter thus: @@ -1180,6 +1384,12 @@ Options -h, --help help for update +SEE ALSO + +- rclone config - Enter an interactive configuration session. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone copyto @@ -1220,6 +1430,12 @@ Options -h, --help help for copyto +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone copyurl @@ -1236,6 +1452,12 @@ Options -h, --help help for copyurl +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone cryptcheck @@ -1278,6 +1500,12 @@ Options -h, --help help for cryptcheck --one-way Check one way only, source files must exist on destination +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone cryptdecode @@ -1303,6 +1531,12 @@ Options -h, --help help for cryptdecode --reverse Reverse cryptdecode, encrypts filenames +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone dbhashsum @@ -1320,6 +1554,12 @@ Options -h, --help help for dbhashsum +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone deletefile @@ -1337,6 +1577,12 @@ Options -h, --help help for deletefile +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone genautocomplete @@ -1351,6 +1597,16 @@ Options -h, --help help for genautocomplete +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. +- rclone genautocomplete bash - Output bash completion script for + rclone. +- rclone genautocomplete zsh - Output zsh completion script for + rclone. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone genautocomplete bash @@ -1378,6 +1634,12 @@ Options -h, --help help for bash +SEE ALSO + +- rclone genautocomplete - Output completion script for a given shell. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone genautocomplete zsh @@ -1405,6 +1667,12 @@ Options -h, --help help for zsh +SEE ALSO + +- rclone genautocomplete - Output completion script for a given shell. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone gendocs @@ -1422,6 +1690,12 @@ Options -h, --help help for gendocs +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone hashsum @@ -1452,6 +1726,12 @@ Options -h, --help help for hashsum +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone link @@ -1476,6 +1756,12 @@ Options -h, --help help for link +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone listremotes @@ -1494,6 +1780,12 @@ Options -h, --help help for listremotes --long Show the type as well as names. +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone lsf @@ -1526,6 +1818,7 @@ just the path, but you can use these parameters to control the output: o - Original ID of underlying object m - MimeType of object if known e - encrypted name + T - tier of storage if known, eg "Hot" or "Cool" So if you wanted the path, size and modification time, you would use –format “pst”, or maybe –format “tsp” to put the path last. @@ -1592,7 +1885,7 @@ only (without traversing the whole directory structure): rclone lsf --absolute --files-only --max-age 1d /path/to/local > new_files rclone copy --files-from new_files /path/to/local remote:path -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. There are several related list commands @@ -1630,6 +1923,12 @@ Options -R, --recursive Recurse into the listing. -s, --separator string Separator for the items in the format. (default ";") +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone lsjson @@ -1644,11 +1943,12 @@ The output is an array of Items, where each Item looks like this { “Hashes” : { “SHA-1” : “f572d396fae9206628714fb2ce00f72e94f2258f”, “MD5” : “b1946ac92492d2347c6235b4d2611184”, “DropboxHash” : “ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc” }, -“ID”: “y2djkhiujf83u33”, “OrigID”: “UYOJVTUW00Q1RzTDA”, “IsDir” : false, -“MimeType” : “application/octet-stream”, “ModTime” : -“2017-05-31T16:15:57.034468261+01:00”, “Name” : “file.txt”, “Encrypted” -: “v0qpsdq8anpci8n929v3uu9338”, “Path” : “full/path/goes/here/file.txt”, -“Size” : 6 } +“ID”: “y2djkhiujf83u33”, “OrigID”: “UYOJVTUW00Q1RzTDA”, “IsBucket” : +false, “IsDir” : false, “MimeType” : “application/octet-stream”, +“ModTime” : “2017-05-31T16:15:57.034468261+01:00”, “Name” : “file.txt”, +“Encrypted” : “v0qpsdq8anpci8n929v3uu9338”, “EncryptedPath” : +“kja9098349023498/v0qpsdq8anpci8n929v3uu9338”, “Path” : +“full/path/goes/here/file.txt”, “Size” : 6, “Tier” : “hot”, } If –hash is not specified the Hashes property won’t be emitted. @@ -1668,6 +1968,9 @@ Path for “file.txt” will be “subfolder/file.txt”, not “remote:path/subfolder/file.txt”. When used without –recursive the Path will always be the same as Name. +If the directory is a bucket in a bucket based backend, then “IsBucket” +will be set to true. This key won’t be present unless it is “true”. + The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the @@ -1679,7 +1982,7 @@ the nearest second (Dropbox, Box, WebDav etc) no digits will be shown The whole output can be processed as a JSON blob, or alternatively it can be processed line by line as each item is written one to a line. -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. There are several related list commands @@ -1715,6 +2018,12 @@ Options --original Show the ID of the underlying Object. -R, --recursive Recurse into the listing. +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone mount @@ -2010,7 +2319,7 @@ Options --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required. - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for mount --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k) --no-checksum Don't compare checksums on up/download. @@ -2019,7 +2328,7 @@ Options -o, --option stringArray Option for libfuse/WinFsp. Repeat if required. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -2030,6 +2339,12 @@ Options --volname string Set the volume name (not supported by all OSes). --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone moveto @@ -2041,7 +2356,7 @@ If source:path is a file or directory then it moves it to a file or directory named dest:path. This can be used to rename files or upload single files to other than -their existing name. If the source is a directory then it acts exacty +their existing name. If the source is a directory then it acts exactly like the move command. So @@ -2073,6 +2388,12 @@ Options -h, --help help for moveto +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone ncdu @@ -2114,6 +2435,12 @@ Options -h, --help help for ncdu +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone obscure @@ -2129,6 +2456,12 @@ Options -h, --help help for obscure +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone rc @@ -2154,6 +2487,12 @@ The –json parameter can be used to pass in a JSON blob as an input instead of key=value arguments. This is the only way of passing in more complicated values. +Use –loopback to connect to the rclone instance running “rclone rc”. +This is very useful for testing commands without having to run an rclone +rc server, eg: + + rclone rc --loopback operations/about fs=/ + Use “rclone rc” to see a list of all possible commands. rclone rc commands parameter [flags] @@ -2162,11 +2501,18 @@ Options -h, --help help for rc --json string Input JSON - use instead of key=value args. + --loopback If set connect to this rclone instance not via HTTP. --no-output If set don't output the JSON result. --pass string Password to use to connect to rclone remote control. --url string URL to connect to rclone remote control. (default "http://localhost:5572/") --user string Username to use to rclone remote control. +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone rcat @@ -2202,6 +2548,12 @@ Options -h, --help help for rcat +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone rcd @@ -2225,6 +2577,12 @@ Options -h, --help help for rcd +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone rmdirs @@ -2249,6 +2607,12 @@ Options -h, --help help for rmdirs --leave-root Do not remove root directory if empty +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone serve @@ -2269,6 +2633,18 @@ Options -h, --help help for serve +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. +- rclone serve dlna - Serve remote:path over DLNA +- rclone serve ftp - Serve remote:path over FTP. +- rclone serve http - Serve the remote over HTTP. +- rclone serve restic - Serve the remote for restic’s REST API. +- rclone serve sftp - Serve the remote over SFTP. +- rclone serve webdav - Serve remote:path over webdav. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone serve dlna @@ -2292,6 +2668,12 @@ Server options Use –addr to specify which IP address and port the server should listen on, eg –addr 1.2.3.4:8000 or –addr :8080 to listen to all IPs. +Use –name to choose the friendly server name, which is by default +“rclone (hostname)”. + +Use –log-trace in conjunction with -vv to enable additional debug +logging of all UPNP traffic. + Directory Cache Using the --dir-cache-time flag, you can set how long a directory should @@ -2431,14 +2813,16 @@ Options --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for dlna + --log-trace enable trace logging of SOAP traffic + --name string name of DLNA server --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -2447,6 +2831,12 @@ Options --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) +SEE ALSO + +- rclone serve - Serve a remote over a protocol. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone serve ftp @@ -2614,7 +3004,7 @@ Options --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for ftp --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). @@ -2622,8 +3012,9 @@ Options --pass string Password for authentication. (empty value allow every password) --passive-port string Passive port range to use. (default "30000-32000") --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) + --public-ip string Public IP address to advertise for passive connections. --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --user string User name for authentication. (default "anonymous") --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) @@ -2633,6 +3024,12 @@ Options --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) +SEE ALSO + +- rclone serve - Serve a remote over a protocol. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone serve http @@ -2843,7 +3240,7 @@ Options --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for http --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -2857,7 +3254,7 @@ Options --realm string realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) @@ -2867,6 +3264,12 @@ Options --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) +SEE ALSO + +- rclone serve - Serve a remote over a protocol. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone serve restic @@ -2929,7 +3332,7 @@ For example: $ restic backup /path/to/files/to/backup scan [/path/to/files/to/backup] scanned 189 directories, 312 files in 0:00 - [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 + [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 duration: 0:00 snapshot 45c8fdd8 saved @@ -2944,6 +3347,11 @@ MUST end with /. Eg $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ # backup user2 stuff +Private repositories + +The “–private-repos” flag can be used to limit users to repositories +starting with a path of “//”. + Server options Use –addr to specify which IP address and port the server should listen @@ -3007,12 +3415,223 @@ Options --key string SSL PEM Private key --max-header-bytes int Maximum size of request header (default 4096) --pass string Password for authentication. + --private-repos users can only access their private repo --realm string realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) --stdio run an HTTP2 server on stdin/stdout --user string User name for authentication. +SEE ALSO + +- rclone serve - Serve a remote over a protocol. + +Auto generated by spf13/cobra on 15-Jun-2019 + + +rclone serve sftp + +Serve the remote over SFTP. + +Synopsis + +rclone serve sftp implements an SFTP server to serve the remote over +SFTP. This can be used with an SFTP client or you can make a remote of +type sftp to use with it. + +You can use the filter flags (eg –include, –exclude) to control what is +served. + +The server will log errors. Use -v to see access logs. + +–bwlimit will be respected for file transfers. Use –stats to control the +stats printing. + +You must provide some means of authentication, either with –user/–pass, +an authorized keys file (specify location with –authorized-keys - the +default is the same as ssh) or set the –no-auth flag for no +authentication when logging in. + +Note that this also implements a small number of shell commands so that +it can provide md5sum/sha1sum/df information for the rclone sftp +backend. This means that is can support SHA1SUMs, MD5SUMs and the about +command when paired with the rclone sftp backend. + +If you don’t supply a –key then rclone will generate one and cache it +for later use. + +By default the server binds to localhost:2022 - if you want it to be +reachable externally then supply “–addr :2022” for example. + +Note that the default of “–vfs-cache-mode off” is fine for the rclone +sftp backend, but it may not be with other SFTP clients. + +Directory Cache + +Using the --dir-cache-time flag, you can set how long a directory should +be considered up to date and not refreshed from the backend. Changes +made locally in the mount may appear immediately or invalidate the +cache. However, changes done on the remote will only be picked up once +the cache expires. + +Alternatively, you can send a SIGHUP signal to rclone for it to flush +all directory caches, regardless of how old they are. Assuming only one +rclone instance is running, you can reset the cache like this: + + kill -SIGHUP $(pidof rclone) + +If you configure rclone with a remote control then you can use rclone rc +to flush the whole directory cache: + + rclone rc vfs/forget + +Or individual files or directories: + + rclone rc vfs/forget file=path/to/file dir=path/to/dir + +File Buffering + +The --buffer-size flag determines the amount of memory, that will be +used to buffer data in advance. + +Each open file descriptor will try to keep the specified amount of data +in memory at all times. The buffered data is bound to one file +descriptor and won’t be shared between multiple open file descriptors of +the same file. + +This flag is a upper limit for the used memory per file descriptor. The +buffer will only use memory for data that is downloaded but not not yet +read. If the buffer is empty, only a small amount of memory will be +used. The maximum memory used by rclone for buffering can be up to +--buffer-size * open files. + +File Caching + +These flags control the VFS file caching options. The VFS layer is used +by rclone mount to make a cloud storage system work more like a normal +file system. + +You’ll need to enable VFS caching if you want, for example, to read and +write simultaneously to a file. See below for more details. + +Note that the VFS cache works in addition to the cache backend and you +may find that you need one or the other or both. + + --cache-dir string Directory rclone will use for caching. + --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) + --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off") + --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-cache-max-size int Max total size of objects in the cache. (default off) + +If run with -vv rclone will print the location of the file cache. The +files are stored in the user cache file area which is OS dependent but +can be controlled with --cache-dir or setting the appropriate +environment variable. + +The cache has 4 different modes selected by --vfs-cache-mode. The higher +the cache mode the more compatible rclone becomes at the cost of using +disk space. + +Note that files are written back to the remote only when they are closed +so if rclone is quit or dies with open files then these won’t get +written back to the remote. However they will still be in the on disk +cache. + +If using –vfs-cache-max-size note that the cache may exceed this size +for two reasons. Firstly because it is only checked every +–vfs-cache-poll-interval. Secondly because open files cannot be evicted +from the cache. + +–vfs-cache-mode off + +In this mode the cache will read directly from the remote and write +directly to the remote without caching anything on disk. + +This will mean some operations are not possible + +- Files can’t be opened for both read AND write +- Files opened for write can’t be seeked +- Existing files opened for write must have O_TRUNC set +- Files open for read with O_TRUNC will be opened write only +- Files open for write only will behave as if O_TRUNC was supplied +- Open modes O_APPEND, O_TRUNC are ignored +- If an upload fails it can’t be retried + +–vfs-cache-mode minimal + +This is very similar to “off” except that files opened for read AND +write will be buffered to disks. This means that files opened for write +will be a lot more compatible, but uses the minimal disk space. + +These operations are not possible + +- Files opened for write only can’t be seeked +- Existing files opened for write must have O_TRUNC set +- Files opened for write only will ignore O_APPEND, O_TRUNC +- If an upload fails it can’t be retried + +–vfs-cache-mode writes + +In this mode files opened for read only are still read directly from the +remote, write only and read/write files are buffered to disk first. + +This mode should support all normal file system operations. + +If an upload fails it will be retried up to –low-level-retries times. + +–vfs-cache-mode full + +In this mode all reads and writes are buffered to and from disk. When a +file is opened for read it will be downloaded in its entirety first. + +This may be appropriate for your needs, or you may prefer to look at the +cache backend which does a much more sophisticated job of caching, +including caching directory hierarchies and chunks of files. + +In this mode, unlike the others, when a file is written to the disk, it +will be kept on the disk after it is written to the remote. It will be +purged on a schedule according to --vfs-cache-max-age. + +This mode should support all normal file system operations. + +If an upload or download fails it will be retried up to +–low-level-retries times. + + rclone serve sftp remote:path [flags] + +Options + + --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2022") + --authorized-keys string Authorized keys file (default "~/.ssh/authorized_keys") + --dir-cache-time duration Time to cache directory entries for. (default 5m0s) + --dir-perms FileMode Directory permissions (default 0777) + --file-perms FileMode File permissions (default 0666) + --gid uint32 Override the gid field set by the filesystem. (default 1000) + -h, --help help for sftp + --key string SSH private key file (leave blank to auto generate) + --no-auth Allow connections with no authentication if set. + --no-checksum Don't compare checksums on up/download. + --no-modtime Don't read/write the modification time (can speed things up). + --no-seek Don't allow seeking in files. + --pass string Password for authentication. + --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) + --read-only Mount read-only. + --uid uint32 Override the uid field set by the filesystem. (default 1000) + --umask int Override the permission bits set by the filesystem. (default 2) + --user string User name for authentication. + --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) + --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) + --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) + --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) + --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) + +SEE ALSO + +- rclone serve - Serve a remote over a protocol. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone serve webdav @@ -3022,7 +3641,8 @@ Synopsis rclone serve webdav implements a basic webdav server to serve the remote over HTTP via the webdav protocol. This can be viewed with a webdav -client or you can make a remote of type webdav to read and write it. +client, through a web browser, or you can make a remote of type webdav +to read and write it. Webdav options @@ -3227,9 +3847,10 @@ Options --client-ca string Client certificate authority to verify clients with --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) + --disable-dir-list Disable HTML directory list on GET request for a directory --etag-hash string Which hash to use for the ETag, or auto or blank for off --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for webdav --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -3243,7 +3864,7 @@ Options --realm string realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) @@ -3253,6 +3874,12 @@ Options --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) +SEE ALSO + +- rclone serve - Serve a remote over a protocol. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone settier @@ -3265,7 +3892,7 @@ cloud storage services provides different storage classes on objects, for example AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive, Google Cloud Storage, Regional Storage, Nearline, Coldline etc. -Note that, certain tier chages make objects not available to access +Note that, certain tier changes make objects not available to access immediately. For example tiering to archive in azure blob storage makes objects in frozen state, user can restore by setting tier to Hot/Cool, similarly S3 to Glacier makes object inaccessible.true @@ -3289,6 +3916,12 @@ Options -h, --help help for settier +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone touch @@ -3306,6 +3939,12 @@ Options -C, --no-create Do not create the file if it does not exist. -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 ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + rclone tree @@ -3362,6 +4001,12 @@ Options -U, --unsorted Leave files unsorted. --version Sort files alphanumerically by version. +SEE ALSO + +- rclone - Show help for rclone commands, flags and backends. + +Auto generated by spf13/cobra on 15-Jun-2019 + Copying single files @@ -3704,7 +4349,11 @@ Specify the location of the rclone config file. Normally the config file is in your home directory as a file called .config/rclone/rclone.conf (or .rclone.conf if created with an older version). If $XDG_CONFIG_HOME is set it will be at -$XDG_CONFIG_HOME/rclone/rclone.conf +$XDG_CONFIG_HOME/rclone/rclone.conf. + +If there is a file rclone.conf in the same directory as the rclone +executable it will be preferred. This file must be created manually for +Rclone to use it, it will never be created automatically. If you run rclone config file you will see where the default location is for you. @@ -3753,6 +4402,12 @@ Do a trial run with no permanent changes. Use this to see what rclone would do without actually doing it. Useful when setting up the sync command which deletes files in the destination. +–ignore-case-sync + +Using this option will cause rclone to ignore the case of the files when +synchronizing so files will not be copied/synced when the existing +filenames are the same, even if the casing is different. + –ignore-checksum Normally rclone will check that the checksums of transferred files @@ -3925,6 +4580,48 @@ reading and writing to an OS X filing system this will be 1s by default. This command line flag allows you to override that computed default. +–multi-thread-cutoff=SIZE + +When downloading files to the local backend above this size, rclone will +use multiple threads to download the file. (default 250M) + +Rclone preallocates the file (using fallocate(FALLOC_FL_KEEP_SIZE) on +unix or NTSetInformationFile on Windows both of which takes no time) +then each thread writes directly into the file at the correct place. +This means that rclone won’t create fragmented or sparse files and there +won’t be any assembly time at the end of the transfer. + +The number of threads used to dowload is controlled by +--multi-thread-streams. + +Use -vv if you wish to see info about the threads. + +This will work with the sync/copy/move commands and friends +copyto/moveto. Multi thread downloads will be used with rclone mount and +rclone serve if --vfs-cache-mode is set to writes or above. + +NB that this ONLY works for a local destination but will work with any +source. + +–multi-thread-streams=N + +When using multi thread downloads (see above --multi-thread-cutoff) this +sets the maximum number of streams to use. Set to 0 to disable multi +thread downloads. (Default 4) + +Exactly how many streams rclone uses for the download depends on the +size of the file. To calculate the number of download streams Rclone +divides the size of the file by the --multi-thread-cutoff and rounds up, +up to the maximum set with --multi-thread-streams. + +So if --multi-thread-cutoff 250MB and --multi-thread-streams 4 are in +effect (the defaults): + +- 0MB.250MB files will be downloaded with 1 stream +- 250MB..500MB files will be downloaded with 2 streams +- 500MB..750MB files will be downloaded with 3 streams +- 750MB+ files will be downloaded with 4 streams + –no-gzip-encoding Don’t set Accept-Encoding: gzip. This means that rclone won’t ask the @@ -4046,6 +4743,19 @@ levels. When this is specified, rclone condenses the stats into a single line showing the most important stats only. +–stats-one-line-date + +When this is specified, rclone enables the single-line stats and +prepends the display with a date string. The default is +2006/01/02 15:04:05 - + +–stats-one-line-date-format + +When this is specified, rclone enables the single-line stats and +prepends the display with a user-supplied date string. The date string +MUST be enclosed in quotes. Follow golang specs for date formatting +syntax. + –stats-unit=bits|bytes By default, data transfer rates will be printed in bytes/second. @@ -5278,6 +5988,14 @@ the authorization in the URL in the http://user:pass@localhost/ style. Default Off. +–rc-job-expire-duration=DURATION + +Expire finished async jobs older than DURATION (default 60s). + +–rc-job-expire-interval=DURATION + +Interval duration to check for expired async jobs (default 10s). + –rc-no-auth By default rclone will require authorisation to have been set up on the @@ -5436,7 +6154,6 @@ config/create: create the config for a remote. This takes the following parameters - name - name of remote -- type - type of new remote - type - type of the new remote See the config create command command for more information on the above. @@ -5482,7 +6199,6 @@ config/password: password the config for a remote. This takes the following parameters - name - name of remote -- type - type of new remote See the config password command command for more information on the above. @@ -5503,7 +6219,6 @@ config/update: update the config for a remote. This takes the following parameters - name - name of remote -- type - type of new remote See the config update command command for more information on the above. @@ -5625,10 +6340,11 @@ operations/about: Return the space used on the remote This takes the following parameters - fs - a remote name string eg “drive:” -- remote - a path within that remote eg “dir” The result is as returned from rclone about –json +See the about command command for more information on the above. + Authentication is required for this call. operations/cleanup: Remove trashed files in the remote or path @@ -5686,6 +6402,62 @@ See the deletefile command command for more information on the above. Authentication is required for this call. +operations/fsinfo: Return information about the remote + +This takes the following parameters + +- fs - a remote name string eg “drive:” + +This returns info about the remote passed in; + + { + // optional features and whether they are available or not + "Features": { + "About": true, + "BucketBased": false, + "CanHaveEmptyDirectories": true, + "CaseInsensitive": false, + "ChangeNotify": false, + "CleanUp": false, + "Copy": false, + "DirCacheFlush": false, + "DirMove": true, + "DuplicateFiles": false, + "GetTier": false, + "ListR": false, + "MergeDirs": false, + "Move": true, + "OpenWriterAt": true, + "PublicLink": false, + "Purge": true, + "PutStream": true, + "PutUnchecked": false, + "ReadMimeType": false, + "ServerSideAcrossConfigs": false, + "SetTier": false, + "SetWrapper": false, + "UnWrap": false, + "WrapFs": false, + "WriteMimeType": false + }, + // Names of hashes available + "Hashes": [ + "MD5", + "SHA-1", + "DropboxHash", + "QuickXorHash" + ], + "Name": "local", // Name as created + "Precision": 1, // Precision of timestamps in ns + "Root": "/", // Path as created + "String": "Local file system at /" // how the remote will appear in logs + } + +This command does not have a command line equivalent so use this +instead: + + rclone rc --loopback operations/fsinfo fs=remote: + operations/list: List the given remote and path in JSON format This takes the following parameters @@ -6263,7 +7035,7 @@ more efficient. ------------------------------ ------- ------ ------ --------- --------- ------- -------------- ------------- ------- Amazon Drive Yes No Yes Yes No #575 No No No #2178 No Amazon S3 No Yes No No No Yes Yes No #2178 No - Backblaze B2 No No No No Yes Yes Yes No #2178 No + Backblaze B2 No Yes No No Yes Yes Yes No #2178 No Box Yes Yes Yes Yes No #575 No Yes Yes No Dropbox Yes Yes Yes Yes No #575 No Yes Yes Yes FTP No No Yes Yes No No Yes No #2178 No @@ -6272,14 +7044,14 @@ more efficient. HTTP No No No No No No No No #2178 No Hubic Yes † Yes No No No Yes Yes No #2178 Yes Jottacloud Yes Yes Yes Yes No Yes No Yes Yes - Mega Yes No Yes Yes No No No No #2178 Yes + Mega Yes No Yes Yes Yes No No No #2178 Yes Microsoft Azure Blob Storage Yes Yes No No No Yes No No #2178 No Microsoft OneDrive Yes Yes Yes Yes No #575 No No Yes Yes OpenDrive Yes Yes Yes Yes No No No No No Openstack Swift Yes † Yes No No No Yes Yes No #2178 Yes pCloud Yes Yes Yes Yes Yes No No No #2178 Yes QingStor No Yes No No No Yes No No #2178 No - SFTP No No Yes Yes No No Yes No #2178 No + SFTP No No Yes Yes No No Yes No #2178 Yes WebDAV Yes Yes Yes Yes No No Yes ‡ No #2178 Yes Yandex Disk Yes Yes Yes Yes Yes No Yes Yes Yes The local filesystem Yes No Yes Yes No No Yes No Yes @@ -6390,7 +7162,7 @@ This will guide you through an interactive setup process: name> remote Type of storage to configure. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" 2 / Amazon Drive \ "amazon cloud drive" @@ -6478,7 +7250,7 @@ Copy another local directory to the alias directory called source Standard Options -Here are the standard options specific to alias (Alias for a existing +Here are the standard options specific to alias (Alias for an existing remote). –alias-remote @@ -6835,7 +7607,7 @@ This will guide you through an interactive setup process. name> remote Type of storage to configure. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" 2 / Amazon Drive \ "amazon cloud drive" @@ -7045,6 +7817,12 @@ Modified time The modified time is stored as metadata on the object as X-Amz-Meta-Mtime as floating point since the epoch accurate to 1 ns. +If the modification time needs to be updated rclone will attempt to +perform a server side copy to update the modification if the object can +be copied in a single part. +In the case the object is larger than 5Gb or is in Glacier or Glacier +Deep Archive storage the object will be uploaded rather than copied. + Multipart uploads rclone supports multipart uploads with S3 which means that it can upload @@ -7179,6 +7957,9 @@ glacier storage class you will see an error like below. In this case you need to restore the object(s) in question before using rclone. +Note that rclone only speaks the S3 API it does not speak the Glacier +Vault API, so rclone cannot directly access Glacier Vaults. + Standard Options Here are the standard options specific to s3 (Amazon S3 Compliant @@ -7481,6 +8262,8 @@ Endpoint for S3 API. Required when using an S3 clone. - Wasabi US East endpoint - “s3.us-west-1.wasabisys.com” - Wasabi US West endpoint + - “s3.eu-central-1.wasabisys.com” + - Wasabi EU Central endpoint –s3-location-constraint @@ -7867,6 +8650,17 @@ Use this only if v4 signatures don’t work, eg pre Jewel/v10 CEPH. - Type: bool - Default: false +–s3-use-accelerate-endpoint + +If true use the AWS S3 accelerated endpoint. + +See: AWS S3 Transfer acceleration + +- Config: use_accelerate_endpoint +- Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT +- Type: bool +- Default: false + Anonymous access to public buckets If you want to use rclone to access a public bucket, configure with a @@ -8040,7 +8834,7 @@ To configure access to IBM COS S3, follow the steps below: 3. Select “s3” storage. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" 2 / Amazon Drive \ "amazon cloud drive" @@ -8609,10 +9403,9 @@ X-Bz-Info-src_last_modified_millis as milliseconds since 1970-01-01 in the Backblaze standard. Other tools should be able to use this as a modified time. -Modified times are used in syncing and are fully supported except in the -case of updating a modification time on an existing object. In this case -the object will be uploaded again as B2 doesn’t have an API method to -set the modification time independent of doing an upload. +Modified times are used in syncing and are fully supported. Note that if +a modification time needs to be updated on an object then it will create +a new version of the object. SHA1 checksums @@ -8660,6 +9453,10 @@ remove the file instead of hiding it. Old versions of files, where available, are visible using the --b2-versions flag. +NB Note that --b2-versions does not work with crypt at the moment #1627. +Using –backup-dir with rclone is the recommended way of working around +this. + If you wish to remove all the old versions then you can use the rclone cleanup remote:bucket command which will delete all the old versions of files, leaving the current ones intact. You can also supply @@ -9589,7 +10386,7 @@ as the DB file name. - Config: db_path - Env Var: RCLONE_CACHE_DB_PATH - Type: string -- Default: “/home/ncw/.cache/rclone/cache-backend” +- Default: “$HOME/.cache/rclone/cache-backend” –cache-chunk-path @@ -9606,7 +10403,7 @@ location for “–cache-db-path” and don’t specify one for - Config: chunk_path - Env Var: RCLONE_CACHE_CHUNK_PATH - Type: string -- Default: “/home/ncw/.cache/rclone/cache-backend” +- Default: “$HOME/.cache/rclone/cache-backend” –cache-db-purge @@ -10467,45 +11264,27 @@ your email address as the password. n/r/c/s/q> n name> remote Type of storage to configure. + Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value - 1 / Amazon Drive - \ "amazon cloud drive" - 2 / Amazon S3 (also Dreamhost, Ceph, Minio) - \ "s3" - 3 / Backblaze B2 - \ "b2" - 4 / Dropbox - \ "dropbox" - 5 / Encrypt/Decrypt a remote - \ "crypt" - 6 / FTP Connection + [snip] + 10 / FTP Connection \ "ftp" - 7 / Google Cloud Storage (this is not Google Drive) - \ "google cloud storage" - 8 / Google Drive - \ "drive" - 9 / Hubic - \ "hubic" - 10 / Local Disk - \ "local" - 11 / Microsoft OneDrive - \ "onedrive" - 12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) - \ "swift" - 13 / SSH/SFTP Connection - \ "sftp" - 14 / Yandex Disk - \ "yandex" + [snip] Storage> ftp + ** See help for ftp backend at: https://rclone.org/ftp/ ** + FTP host to connect to + Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Connect to ftp.example.com \ "ftp.example.com" host> ftp.example.com FTP username, leave blank for current username, ncw - user> + Enter a string value. Press Enter for the default (""). + user> FTP port, leave blank to use default (21) - port> + Enter a string value. Press Enter for the default (""). + port> FTP password y) Yes type in my own password g) Generate random password @@ -10514,12 +11293,14 @@ your email address as the password. password: Confirm the password: password: + Use FTP over TLS (Implicit) + Enter a boolean value (true or false). Press Enter for the default ("false"). + tls> Remote config -------------------- [remote] + type = ftp host = ftp.example.com - user = - port = pass = *** ENCRYPTED *** -------------------- y) Yes this is OK @@ -10555,6 +11336,13 @@ Checksums FTP does not support any checksums. +Implicit TLS + +FTP supports implicit FTP over TLS servers (FTPS). This has to be +enabled in the config for the remote. The default FTPS port is 990 so +the port will likely have to be explictly set in the config for the +remote. + Standard Options Here are the standard options specific to ftp (FTP Connection). @@ -10573,7 +11361,7 @@ FTP host to connect to –ftp-user -FTP username, leave blank for current username, ncw +FTP username, leave blank for current username, $USER - Config: user - Env Var: RCLONE_FTP_USER @@ -10598,6 +11386,15 @@ FTP password - Type: string - Default: "" +–ftp-tls + +Use FTP over TLS (Implicit) + +- Config: tls +- Env Var: RCLONE_FTP_TLS +- Type: bool +- Default: false + Advanced Options Here are the advanced options specific to ftp (FTP Connection). @@ -10611,6 +11408,15 @@ Maximum number of FTP simultaneous connections, 0 for unlimited - Type: int - Default: 0 +–ftp-no-check-certificate + +Do not verify the TLS certificate of the server + +- Config: no_check_certificate +- Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE +- Type: bool +- Default: false + Limitations Note that since FTP isn’t HTTP based the following flags don’t work with @@ -10625,6 +11431,9 @@ FTP could support server side move but doesn’t yet. Note that the ftp backend does not support the ftp_proxy environment variable yet. +Note that while implicit FTP over TLS is supported, explicit FTP over +TLS is not. + Google Cloud Storage @@ -11419,6 +12228,10 @@ If you wish to empty your trash you can use the rclone cleanup remote: command which will permanently delete all your trashed files. This command does not take any path arguments. +Note that Google Drive takes some time (minutes to days) to empty the +trash even though the command returns within a few seconds. No output is +echoed, so there will be no confirmation even using -v or -vv. + Quota information To view your current quota you can use the rclone about remote: command @@ -11448,7 +12261,7 @@ Note that rclone adds the extension to the google doc, so if it is called My Spreadsheet on google docs, it will be exported as My Spreadsheet.xlsx or My Spreadsheet.pdf etc. -When importing files into Google Drive, rclone will conververt all files +When importing files into Google Drive, rclone will convert all files with an extension in --drive-import-formats to their associated document type. rclone will not convert any files by default, since the conversion is lossy process. @@ -11862,6 +12675,18 @@ Keep new head revision of each file forever. - Type: bool - Default: false +–drive-size-as-quota + +Show storage quota usage for file size. + +The storage used by a file is the size of the current version plus any +older versions that have been set to keep forever. + +- Config: size_as_quota +- Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA +- Type: bool +- Default: false + –drive-v2-download-min-size If Object’s are greater, use drive v2 API to download. @@ -11889,6 +12714,20 @@ Number of API calls to allow without sleeping. - Type: int - Default: 100 +–drive-server-side-across-configs + +Allow server side operations (eg copy) to work across different drive +configs. + +This can be useful if you wish to do a server side copy between two +different Google drives. Note that this isn’t enabled by default because +it isn’t easy to tell if it will work beween any two configurations. + +- Config: server_side_across_configs +- Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS +- Type: bool +- Default: false + Limitations Drive has quite a lot of rate limiting. This causes rclone to be limited @@ -12355,26 +13194,20 @@ This will guide you through an interactive setup process: s) Set configuration password q) Quit config n/s/q> n - name> remote + name> jotta Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] - 13 / JottaCloud + 14 / JottaCloud \ "jottacloud" [snip] Storage> jottacloud - User Name + ** See help for jottacloud backend at: https://rclone.org/jottacloud/ ** + + User Name: Enter a string value. Press Enter for the default (""). - user> user - The mountpoint to use. - Enter a string value. Press Enter for the default (""). - Choose a number from below, or type in your own value - 1 / Will be synced by the official client. - \ "Sync" - 2 / Archive - \ "Archive" - mountpoint> Archive + user> user@email.tld Edit advanced config? (y/n) y) Yes n) No @@ -12388,16 +13221,35 @@ This will guide you through an interactive setup process: y) Yes n) No y/n> y - Your Jottacloud password is only required during config and will not be stored. + Your Jottacloud password is only required during setup and will not be stored. password: + + Do you want to use a non standard device/mountpoint e.g. for accessing files uploaded using the official Jottacloud client? + + y) Yes + n) No + y/n> y + Please select the device to use. Normally this will be Jotta + Choose a number from below, or type in an existing value + 1 > DESKTOP-3H31129 + 2 > test1 + 3 > Jotta + Devices> 3 + Please select the mountpoint to user. Normally this will be Archive + Choose a number from below, or type in an existing value + 1 > Archive + 2 > Shared + 3 > Sync + Mountpoints> 1 -------------------- - [remote] + [jotta] type = jottacloud - user = olihey - mountpoint = Archive + user = 0xC4KE@gmail.com client_id = ..... client_secret = ........ token = {........} + device = Jotta + mountpoint = Archive -------------------- y) Yes this is OK e) Edit this remote @@ -12418,6 +13270,16 @@ To copy a local directory to an Jottacloud directory called backup rclone copy /home/source remote:backup +Devices and Mountpoints + +The official Jottacloud client registers a device for each computer you +install it on and then creates a mountpoint for each folder you select +for Backup. The web interface uses a special device called Jotta for the +Archive, Sync and Shared mountpoints. In most cases you’ll want to use +the Jotta/Archive device/mounpoint however if you want to access files +uploaded by the official rclone provides the option to select other +devices and mountpoints during config. + –fast-list This remote supports --fast-list which allows you to use fewer @@ -12486,20 +13348,6 @@ User Name: - Type: string - Default: "" -–jottacloud-mountpoint - -The mountpoint to use. - -- Config: mountpoint -- Env Var: RCLONE_JOTTACLOUD_MOUNTPOINT -- Type: string -- Default: "" -- Examples: - - “Sync” - - Will be synced by the official client. - - “Archive” - - Archive - Advanced Options Here are the advanced options specific to jottacloud (JottaCloud). @@ -12590,7 +13438,7 @@ This will guide you through an interactive setup process: Choose a number from below, or type in your own value 1 / A stackable unification remote, which can appear to merge the contents of several remotes \ "union" - 2 / Alias for a existing remote + 2 / Alias for an existing remote \ "alias" 3 / Amazon Drive \ "amazon cloud drive" @@ -12770,7 +13618,7 @@ This will guide you through an interactive setup process: name> remote Type of storage to configure. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" [snip] 14 / Mega @@ -12834,6 +13682,52 @@ messages in the log about duplicates. Use rclone dedupe to fix duplicated files. +Failure to log-in + +Mega remotes seem to get blocked (reject logins) under “heavy use”. We +haven’t worked out the exact blocking rules but it seems to be related +to fast paced, sucessive rclone commands. + +For example, executing this command 90 times in a row +rclone link remote:file will cause the remote to become “blocked”. This +is not an abnormal situation, for example if you wish to get the public +links of a directory with hundred of files… After more or less a week, +the remote will remote accept rclone logins normally again. + +You can mitigate this issue by mounting the remote it with rclone mount. +This will log-in when mounting and a log-out when unmounting only. You +can also run rclone rcd and then use rclone rc to run the commands over +the API to avoid logging in each time. + +Rclone does not currently close mega sessions (you can see them in the +web interface), however closing the sessions does not solve the issue. + +If you space rclone commands by 3 seconds it will avoid blocking the +remote. We haven’t identified the exact blocking rules, so perhaps one +could execute the command 80 times without waiting and avoid blocking by +waiting 3 seconds, then continuing… + +Note that this has been observed by trial and error and might not be set +in stone. + +Other tools seem not to produce this blocking effect, as they use a +different working approach (state-based, using sessionIDs instead of +log-in) which isn’t compatible with the current stateless rclone +approach. + +Note that once blocked, the use of other tools (such as megacmd) is not +a sure workaround: following megacmd login times have been observed in +sucession for blocked remote: 7 minutes, 20 min, 30min, 30 min, 30min. +Web access looks unaffected though. + +Investigation is continuing in relation to workarounds based on +timeouts, pacers, retrials and tpslimits - if you discover something +relevant, please post on the forum. + +So, if rclone was working nicely and suddenly you are unable to log-in +and you are sure the user and the password are correct, likely you have +got the remote blocked for a while. + Standard Options Here are the standard options specific to mega (Mega). @@ -13199,10 +14093,10 @@ This will guide you through an interactive setup process: Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value ... - 17 / Microsoft OneDrive + 18 / Microsoft OneDrive \ "onedrive" ... - Storage> 17 + Storage> 18 Microsoft App Client Id Leave blank normally. Enter a string value. Press Enter for the default (""). @@ -14582,8 +15476,9 @@ Paths are specified as remote:path. If the path does not begin with a / it is relative to the home directory of the user. An empty path remote: refers to the user’s home directory. -Note that some SFTP servers will need the leading / - Synology is a good -example of this. +"Note that some SFTP servers will need the leading / - Synology is a +good example of this. rsync.net, on the other hand, requires users to +OMIT the leading /. Here is an example of making an SFTP configuration. First run @@ -14887,6 +15782,13 @@ servers which are not under your control, and to which the execution of remote commands is prohibited. Set the configuration option disable_hashcheck to true to disable checksumming. +SFTP also supports about if the same login has shell access and df are +in the remote’s PATH. about will return the total space, free space, and +used space on the remote for the disk of the specified path on the +remote or, if not set, the disk of the root on the remote. about will +fail if it does not have shell access or if df is not in the remote’s +PATH. + Note that some SFTP servers (eg Synology) the paths are different for SSH and SFTP so the hashes can’t be calculated properly. For them using disable_hashcheck is a good idea. @@ -14951,7 +15853,7 @@ This will guide you through an interactive setup process: name> remote Type of storage to configure. Choose a number from below, or type in your own value - 1 / Alias for a existing remote + 1 / Alias for an existing remote \ "alias" 2 / Amazon Drive \ "amazon cloud drive" @@ -15784,6 +16686,124 @@ Don’t cross filesystem boundaries (unix/macOS only). CHANGELOG +v1.48.0 - 2019-06-15 + +- New commands + - serve sftp: Serve an rclone remote over SFTP (Nick Craig-Wood) +- New Features + - Multi threaded downloads to local storage (Nick Craig-Wood) + - controlled with --multi-thread-cutoff and + --multi-thread-streams + - Use rclone.conf from rclone executable directory to enable + portable use (albertony) + - Allow sync of a file and a directory with the same name + (forgems) + - this is common on bucket based remotes, eg s3, gcs + - Add --ignore-case-sync for forced case insensitivity (garry415) + - Implement --stats-one-line-date and --stats-one-line-date-format + (Peter Berbec) + - Log an ERROR for all commands which exit with non-zero status + (Nick Craig-Wood) + - Use go-homedir to read the home directory more reliably (Nick + Craig-Wood) + - Enable creating encrypted config through external script + invocation (Wojciech Smigielski) + - build: Drop support for go1.8 (Nick Craig-Wood) + - config: Make config create/update encrypt passwords where + necessary (Nick Craig-Wood) + - copyurl: Honor --no-check-certificate (Stefan Breunig) + - install: Linux skip man pages if no mandb (didil) + - lsf: Support showing the Tier of the object (Nick Craig-Wood) + - lsjson + - Added EncryptedPath to output (calisro) + - Support showing the Tier of the object (Nick Craig-Wood) + - Add IsBucket field for bucket based remote listing of the + root (Nick Craig-Wood) + - rc + - Add --loopback flag to run commands directly without a + server (Nick Craig-Wood) + - Add operations/fsinfo: Return information about the remote + (Nick Craig-Wood) + - Skip auth for OPTIONS request (Nick Craig-Wood) + - cmd/providers: Add DefaultStr, ValueStr and Type fields + (Nick Craig-Wood) + - jobs: Make job expiry timeouts configurable (Aleksandar + Jankovic) + - serve dlna reworked and improved (Dan Walters) + - serve ftp: add --ftp-public-ip flag to specify public IP + (calistri) + - serve restic: Add support for --private-repos in serve restic + (Florian Apolloner) + - serve webdav: Combine serve webdav and serve http (Gary Kim) + - size: Ignore negative sizes when calculating total (Garry + McNulty) +- Bug Fixes + - Make move and copy individual files obey --backup-dir (Nick + Craig-Wood) + - If --ignore-checksum is in effect, don’t calculate checksum + (Nick Craig-Wood) + - moveto: Fix case-insensitive same remote move (Gary Kim) + - rc: Fix serving bucket based objects with --rc-serve (Nick + Craig-Wood) + - serve webdav: Fix serveDir not being updated with changes from + webdav (Gary Kim) +- Mount + - Fix poll interval documentation (Animosity022) +- VFS + - Make WriteAt for non cached files work with non-sequential + writes (Nick Craig-Wood) +- Local + - Only calculate the required hashes for big speedup (Nick + Craig-Wood) + - Log errors when listing instead of returning an error (Nick + Craig-Wood) + - Fix preallocate warning on Linux with ZFS (Nick Craig-Wood) +- Crypt + - Make rclone dedupe work through crypt (Nick Craig-Wood) + - Fix wrapping of ChangeNotify to decrypt directories properly + (Nick Craig-Wood) + - Support PublicLink (rclone link) of underlying backend (Nick + Craig-Wood) + - Implement Optional methods SetTier, GetTier (Nick Craig-Wood) +- B2 + - Implement server side copy (Nick Craig-Wood) + - Implement SetModTime (Nick Craig-Wood) +- Drive + - Fix move and copy from TeamDrive to GDrive (Fionera) + - Add notes that cleanup works in the background on drive (Nick + Craig-Wood) + - Add --drive-server-side-across-configs to default back to old + server side copy semantics by default (Nick Craig-Wood) + - Add --drive-size-as-quota to show storage quota usage for file + size (Garry McNulty) +- FTP + - Add FTP List timeout (Jeff Quinn) + - Add FTP over TLS support (Gary Kim) + - Add --ftp-no-check-certificate option for FTPS (Gary Kim) +- Google Cloud Storage + - Fix upload errors when uploading pre 1970 files (Nick + Craig-Wood) +- Jottacloud + - Add support for selecting device and mountpoint. (buengese) +- Mega + - Add cleanup support (Gary Kim) +- Onedrive + - More accurately check if root is found (Cnly) +- S3 + - Suppport S3 Accelerated endpoints with + --s3-use-accelerate-endpoint (Nick Craig-Wood) + - Add config info for Wasabi’s EU Central endpoint (Robert Marko) + - Make SetModTime work for GLACIER while syncing (Philip Harvey) +- SFTP + - Add About support (Gary Kim) + - Fix about parsing of df results so it can cope with -ve results + (Nick Craig-Wood) + - Send custom client version and debug server version (Nick + Craig-Wood) +- WebDAV + - Retry on 423 Locked errors (Nick Craig-Wood) + + v1.47.0 - 2019-04-13 - New backends @@ -18180,6 +19200,22 @@ default rclone only gets 10,000 files ahead in a sync so as not to use up too much memory. You can change this default with the –max-backlog flag. +Rclone is using too much memory or appears to have a memory leak + +Rclone is written in Go which uses a garbage collector. The default +settings for the garbage collector mean that it runs when the heap size +has doubled. + +However it is possible to tune the garbage collector to use less memory +by setting GOGC to a lower value, say export GOGC=20. This will make the +garbage collector work harder, reducing memory size at the expense of +CPU usage. + +The most common cause of rclone using lots of memory is a single +directory with thousands or millions of files in. Rclone has to load +this entirely into memory as rclone objects. Each Rclone object takes +0.5k-1k of memory. + License @@ -18456,6 +19492,20 @@ Contributors - xopez 28950736+xopez@users.noreply.github.com - Ben Boeckel mathstuf@gmail.com - Manu manu@snapdragon.cc +- Kyle E. Mitchell kyle@kemitchell.com +- Gary Kim gary@garykim.dev +- Jon jonathn@github.com +- Jeff Quinn jeffrey.quinn@bluevoyant.com +- Peter Berbec peter@berbec.com +- didil 1284255+didil@users.noreply.github.com +- id01 gaviniboom@gmail.com +- Robert Marko robimarko@gmail.com +- Philip Harvey 32467456+pharveybattelle@users.noreply.github.com +- JorisE JorisE@users.noreply.github.com +- garry415 garry.415@gmail.com +- forgems forgems@gmail.com +- Florian Apolloner florian@apolloner.eu +- Aleksandar Jankovic office@ajankovic.com diff --git a/docs/content/cache.md b/docs/content/cache.md index ed04ab720..5c0900669 100644 --- a/docs/content/cache.md +++ b/docs/content/cache.md @@ -420,7 +420,7 @@ The remote name is used as the DB file name. - Config: db_path - Env Var: RCLONE_CACHE_DB_PATH - Type: string -- Default: "/home/ncw/.cache/rclone/cache-backend" +- Default: "$HOME/.cache/rclone/cache-backend" #### --cache-chunk-path @@ -436,7 +436,7 @@ then "--cache-chunk-path" will use the same path as "--cache-db-path". - Config: chunk_path - Env Var: RCLONE_CACHE_CHUNK_PATH - Type: string -- Default: "/home/ncw/.cache/rclone/cache-backend" +- Default: "$HOME/.cache/rclone/cache-backend" #### --cache-db-purge diff --git a/docs/content/changelog.md b/docs/content/changelog.md index b022b2dd6..38ecd68f6 100644 --- a/docs/content/changelog.md +++ b/docs/content/changelog.md @@ -1,11 +1,96 @@ --- title: "Documentation" description: "Rclone Changelog" -date: "2019-04-13" +date: "2019-06-15" --- # Changelog +## v1.48.0 - 2019-06-15 + +* New commands + * serve sftp: Serve an rclone remote over SFTP (Nick Craig-Wood) +* New Features + * Multi threaded downloads to local storage (Nick Craig-Wood) + * controlled with `--multi-thread-cutoff` and `--multi-thread-streams` + * Use rclone.conf from rclone executable directory to enable portable use (albertony) + * Allow sync of a file and a directory with the same name (forgems) + * this is common on bucket based remotes, eg s3, gcs + * Add `--ignore-case-sync` for forced case insensitivity (garry415) + * Implement `--stats-one-line-date` and `--stats-one-line-date-format` (Peter Berbec) + * Log an ERROR for all commands which exit with non-zero status (Nick Craig-Wood) + * Use go-homedir to read the home directory more reliably (Nick Craig-Wood) + * Enable creating encrypted config through external script invocation (Wojciech Smigielski) + * build: Drop support for go1.8 (Nick Craig-Wood) + * config: Make config create/update encrypt passwords where necessary (Nick Craig-Wood) + * copyurl: Honor `--no-check-certificate` (Stefan Breunig) + * install: Linux skip man pages if no mandb (didil) + * lsf: Support showing the Tier of the object (Nick Craig-Wood) + * lsjson + * Added EncryptedPath to output (calisro) + * Support showing the Tier of the object (Nick Craig-Wood) + * Add IsBucket field for bucket based remote listing of the root (Nick Craig-Wood) + * rc + * Add `--loopback` flag to run commands directly without a server (Nick Craig-Wood) + * Add operations/fsinfo: Return information about the remote (Nick Craig-Wood) + * Skip auth for OPTIONS request (Nick Craig-Wood) + * cmd/providers: Add DefaultStr, ValueStr and Type fields (Nick Craig-Wood) + * jobs: Make job expiry timeouts configurable (Aleksandar Jankovic) + * serve dlna reworked and improved (Dan Walters) + * serve ftp: add `--ftp-public-ip` flag to specify public IP (calistri) + * serve restic: Add support for `--private-repos` in `serve restic` (Florian Apolloner) + * serve webdav: Combine serve webdav and serve http (Gary Kim) + * size: Ignore negative sizes when calculating total (Garry McNulty) +* Bug Fixes + * Make move and copy individual files obey `--backup-dir` (Nick Craig-Wood) + * If `--ignore-checksum` is in effect, don't calculate checksum (Nick Craig-Wood) + * moveto: Fix case-insensitive same remote move (Gary Kim) + * rc: Fix serving bucket based objects with `--rc-serve` (Nick Craig-Wood) + * serve webdav: Fix serveDir not being updated with changes from webdav (Gary Kim) +* Mount + * Fix poll interval documentation (Animosity022) +* VFS + * Make WriteAt for non cached files work with non-sequential writes (Nick Craig-Wood) +* Local + * Only calculate the required hashes for big speedup (Nick Craig-Wood) + * Log errors when listing instead of returning an error (Nick Craig-Wood) + * Fix preallocate warning on Linux with ZFS (Nick Craig-Wood) +* Crypt + * Make rclone dedupe work through crypt (Nick Craig-Wood) + * Fix wrapping of ChangeNotify to decrypt directories properly (Nick Craig-Wood) + * Support PublicLink (rclone link) of underlying backend (Nick Craig-Wood) + * Implement Optional methods SetTier, GetTier (Nick Craig-Wood) +* B2 + * Implement server side copy (Nick Craig-Wood) + * Implement SetModTime (Nick Craig-Wood) +* Drive + * Fix move and copy from TeamDrive to GDrive (Fionera) + * Add notes that cleanup works in the background on drive (Nick Craig-Wood) + * Add `--drive-server-side-across-configs` to default back to old server side copy semantics by default (Nick Craig-Wood) + * Add `--drive-size-as-quota` to show storage quota usage for file size (Garry McNulty) +* FTP + * Add FTP List timeout (Jeff Quinn) + * Add FTP over TLS support (Gary Kim) + * Add `--ftp-no-check-certificate` option for FTPS (Gary Kim) +* Google Cloud Storage + * Fix upload errors when uploading pre 1970 files (Nick Craig-Wood) +* Jottacloud + * Add support for selecting device and mountpoint. (buengese) +* Mega + * Add cleanup support (Gary Kim) +* Onedrive + * More accurately check if root is found (Cnly) +* S3 + * Suppport S3 Accelerated endpoints with `--s3-use-accelerate-endpoint` (Nick Craig-Wood) + * Add config info for Wasabi's EU Central endpoint (Robert Marko) + * Make SetModTime work for GLACIER while syncing (Philip Harvey) +* SFTP + * Add About support (Gary Kim) + * Fix about parsing of `df` results so it can cope with -ve results (Nick Craig-Wood) + * Send custom client version and debug server version (Nick Craig-Wood) +* WebDAV + * Retry on 423 Locked errors (Nick Craig-Wood) + ## v1.47.0 - 2019-04-13 * New backends diff --git a/docs/content/commands/rclone.md b/docs/content/commands/rclone.md index cfa281ac7..a23a742ee 100644 --- a/docs/content/commands/rclone.md +++ b/docs/content/commands/rclone.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone" slug: rclone url: /commands/rclone/ @@ -79,4 +79,4 @@ 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 10-May-2019 +###### 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 94ced8c7c..9deadd9a0 100644 --- a/docs/content/commands/rclone_about.md +++ b/docs/content/commands/rclone_about.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone about" slug: rclone_about url: /commands/rclone_about/ @@ -70,4 +70,4 @@ rclone about remote: [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 a224715bc..9f567d5bb 100644 --- a/docs/content/commands/rclone_authorize.md +++ b/docs/content/commands/rclone_authorize.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone authorize" slug: rclone_authorize url: /commands/rclone_authorize/ @@ -29,4 +29,4 @@ rclone authorize [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 6a6270c07..164aed93c 100644 --- a/docs/content/commands/rclone_cachestats.md +++ b/docs/content/commands/rclone_cachestats.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone cachestats" slug: rclone_cachestats url: /commands/rclone_cachestats/ @@ -28,4 +28,4 @@ rclone cachestats source: [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 6be154f93..984f86525 100644 --- a/docs/content/commands/rclone_cat.md +++ b/docs/content/commands/rclone_cat.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone cat" slug: rclone_cat url: /commands/rclone_cat/ @@ -50,4 +50,4 @@ rclone cat remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 7ba221ad8..1549a90e9 100644 --- a/docs/content/commands/rclone_check.md +++ b/docs/content/commands/rclone_check.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone check" slug: rclone_check url: /commands/rclone_check/ @@ -44,4 +44,4 @@ rclone check source:path dest:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 cc8455461..bb896da09 100644 --- a/docs/content/commands/rclone_cleanup.md +++ b/docs/content/commands/rclone_cleanup.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone cleanup" slug: rclone_cleanup url: /commands/rclone_cleanup/ @@ -29,4 +29,4 @@ rclone cleanup remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 6a0327b90..2dc80388f 100644 --- a/docs/content/commands/rclone_config.md +++ b/docs/content/commands/rclone_config.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone config" slug: rclone_config url: /commands/rclone_config/ @@ -38,4 +38,4 @@ 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 10-May-2019 +###### 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 ce832c70c..155f1bcc8 100644 --- a/docs/content/commands/rclone_config_create.md +++ b/docs/content/commands/rclone_config_create.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone config create" slug: rclone_config_create url: /commands/rclone_config_create/ @@ -23,6 +23,9 @@ Note that if the config process would normally ask a question the default is taken. Each time that happens rclone will print a message saying how to affect the value taken. +If any of the parameters passed is a password field, then rclone will +automatically obscure them before putting them in the config file. + So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this: @@ -43,4 +46,4 @@ rclone config create [ ]* [flags] * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 7a33de7ec..e9f4b8a80 100644 --- a/docs/content/commands/rclone_config_delete.md +++ b/docs/content/commands/rclone_config_delete.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone config delete" slug: rclone_config_delete url: /commands/rclone_config_delete/ @@ -26,4 +26,4 @@ rclone config delete [flags] * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 d11ec385d..2ea26b167 100644 --- a/docs/content/commands/rclone_config_dump.md +++ b/docs/content/commands/rclone_config_dump.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone config dump" slug: rclone_config_dump url: /commands/rclone_config_dump/ @@ -26,4 +26,4 @@ rclone config dump [flags] * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 63c112452..55190f226 100644 --- a/docs/content/commands/rclone_config_edit.md +++ b/docs/content/commands/rclone_config_edit.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone config edit" slug: rclone_config_edit url: /commands/rclone_config_edit/ @@ -29,4 +29,4 @@ rclone config edit [flags] * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 20b79f630..6a60b863e 100644 --- a/docs/content/commands/rclone_config_file.md +++ b/docs/content/commands/rclone_config_file.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone config file" slug: rclone_config_file url: /commands/rclone_config_file/ @@ -26,4 +26,4 @@ rclone config file [flags] * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 13a90822f..b4605af89 100644 --- a/docs/content/commands/rclone_config_password.md +++ b/docs/content/commands/rclone_config_password.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone config password" slug: rclone_config_password url: /commands/rclone_config_password/ @@ -18,6 +18,9 @@ For example to set password of a remote of name myremote you would do: rclone config password myremote fieldname mypassword +This command is obsolete now that "config update" and "config create" +both support obscuring passwords directly. + ``` rclone config password [ ]+ [flags] @@ -33,4 +36,4 @@ rclone config password [ ]+ [flags] * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 3b825dac7..f0de6b01d 100644 --- a/docs/content/commands/rclone_config_providers.md +++ b/docs/content/commands/rclone_config_providers.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone config providers" slug: rclone_config_providers url: /commands/rclone_config_providers/ @@ -26,4 +26,4 @@ rclone config providers [flags] * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 c7644a4e5..fd40f9b85 100644 --- a/docs/content/commands/rclone_config_show.md +++ b/docs/content/commands/rclone_config_show.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone config show" slug: rclone_config_show url: /commands/rclone_config_show/ @@ -26,4 +26,4 @@ rclone config show [] [flags] * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 c288db976..83ef29474 100644 --- a/docs/content/commands/rclone_config_update.md +++ b/docs/content/commands/rclone_config_update.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone config update" slug: rclone_config_update url: /commands/rclone_config_update/ @@ -14,10 +14,14 @@ Update options in an existing remote. Update an existing remote's options. The options should be passed in in pairs of . -For example to update the env_auth field of a remote of name myremote you would do: +For example to update the env_auth field of a remote of name myremote +you would do: rclone config update myremote swift env_auth true +If any of the parameters passed is a password field, then rclone will +automatically obscure them before putting them in the config file. + If the remote uses oauth the token will be updated, if you don't require this add an extra parameter thus: @@ -38,4 +42,4 @@ rclone config update [ ]+ [flags] * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 117ac81b5..f7dde01d6 100644 --- a/docs/content/commands/rclone_copy.md +++ b/docs/content/commands/rclone_copy.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone copy" slug: rclone_copy url: /commands/rclone_copy/ @@ -76,4 +76,4 @@ rclone copy source:path dest:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 f159e436a..dcba537bf 100644 --- a/docs/content/commands/rclone_copyto.md +++ b/docs/content/commands/rclone_copyto.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone copyto" slug: rclone_copyto url: /commands/rclone_copyto/ @@ -54,4 +54,4 @@ rclone copyto source:path dest:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 0fe4d496f..200a7c3d9 100644 --- a/docs/content/commands/rclone_copyurl.md +++ b/docs/content/commands/rclone_copyurl.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone copyurl" slug: rclone_copyurl url: /commands/rclone_copyurl/ @@ -29,4 +29,4 @@ rclone copyurl https://example.com dest:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 cf11fd05e..fc22e71bd 100644 --- a/docs/content/commands/rclone_cryptcheck.md +++ b/docs/content/commands/rclone_cryptcheck.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone cryptcheck" slug: rclone_cryptcheck url: /commands/rclone_cryptcheck/ @@ -54,4 +54,4 @@ rclone cryptcheck remote:path cryptedremote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 987ef5973..227ad6538 100644 --- a/docs/content/commands/rclone_cryptdecode.md +++ b/docs/content/commands/rclone_cryptdecode.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone cryptdecode" slug: rclone_cryptdecode url: /commands/rclone_cryptdecode/ @@ -38,4 +38,4 @@ rclone cryptdecode encryptedremote: encryptedfilename [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 f15885b3f..9ffd652e6 100644 --- a/docs/content/commands/rclone_dbhashsum.md +++ b/docs/content/commands/rclone_dbhashsum.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone dbhashsum" slug: rclone_dbhashsum url: /commands/rclone_dbhashsum/ @@ -31,4 +31,4 @@ rclone dbhashsum remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 feeb89747..30ed31c37 100644 --- a/docs/content/commands/rclone_dedupe.md +++ b/docs/content/commands/rclone_dedupe.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone dedupe" slug: rclone_dedupe url: /commands/rclone_dedupe/ @@ -107,4 +107,4 @@ rclone dedupe [mode] remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 0f8e12fd7..3f2b1f6a1 100644 --- a/docs/content/commands/rclone_delete.md +++ b/docs/content/commands/rclone_delete.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone delete" slug: rclone_delete url: /commands/rclone_delete/ @@ -47,4 +47,4 @@ rclone delete remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 aa13f909d..1cf478093 100644 --- a/docs/content/commands/rclone_deletefile.md +++ b/docs/content/commands/rclone_deletefile.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone deletefile" slug: rclone_deletefile url: /commands/rclone_deletefile/ @@ -30,4 +30,4 @@ rclone deletefile remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 d91d5229c..6ee5ba670 100644 --- a/docs/content/commands/rclone_genautocomplete.md +++ b/docs/content/commands/rclone_genautocomplete.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone genautocomplete" slug: rclone_genautocomplete url: /commands/rclone_genautocomplete/ @@ -27,4 +27,4 @@ Run with --help to list the supported shells. * [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 10-May-2019 +###### 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 8c9366609..f3bc5f91c 100644 --- a/docs/content/commands/rclone_genautocomplete_bash.md +++ b/docs/content/commands/rclone_genautocomplete_bash.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone genautocomplete bash" slug: rclone_genautocomplete_bash url: /commands/rclone_genautocomplete_bash/ @@ -41,4 +41,4 @@ rclone genautocomplete bash [output_file] [flags] * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 4809ca768..09fa8ab00 100644 --- a/docs/content/commands/rclone_genautocomplete_zsh.md +++ b/docs/content/commands/rclone_genautocomplete_zsh.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone genautocomplete zsh" slug: rclone_genautocomplete_zsh url: /commands/rclone_genautocomplete_zsh/ @@ -41,4 +41,4 @@ rclone genautocomplete zsh [output_file] [flags] * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 f7587c016..29bd804d7 100644 --- a/docs/content/commands/rclone_gendocs.md +++ b/docs/content/commands/rclone_gendocs.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone gendocs" slug: rclone_gendocs url: /commands/rclone_gendocs/ @@ -29,4 +29,4 @@ rclone gendocs output_directory [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 82bfb7dbd..5f2b2dd7d 100644 --- a/docs/content/commands/rclone_hashsum.md +++ b/docs/content/commands/rclone_hashsum.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone hashsum" slug: rclone_hashsum url: /commands/rclone_hashsum/ @@ -43,4 +43,4 @@ rclone hashsum remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 ac91f6dda..ae1cd610e 100644 --- a/docs/content/commands/rclone_link.md +++ b/docs/content/commands/rclone_link.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone link" slug: rclone_link url: /commands/rclone_link/ @@ -36,4 +36,4 @@ rclone link remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 3a5a15877..bc7e2d99e 100644 --- a/docs/content/commands/rclone_listremotes.md +++ b/docs/content/commands/rclone_listremotes.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone listremotes" slug: rclone_listremotes url: /commands/rclone_listremotes/ @@ -31,4 +31,4 @@ rclone listremotes [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 af598af11..a04d51eb2 100644 --- a/docs/content/commands/rclone_ls.md +++ b/docs/content/commands/rclone_ls.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone ls" slug: rclone_ls url: /commands/rclone_ls/ @@ -60,4 +60,4 @@ rclone ls remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 c7ebf800c..cb42c676f 100644 --- a/docs/content/commands/rclone_lsd.md +++ b/docs/content/commands/rclone_lsd.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone lsd" slug: rclone_lsd url: /commands/rclone_lsd/ @@ -71,4 +71,4 @@ rclone lsd remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 87a28fa8d..96bda7416 100644 --- a/docs/content/commands/rclone_lsf.md +++ b/docs/content/commands/rclone_lsf.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone lsf" slug: rclone_lsf url: /commands/rclone_lsf/ @@ -152,4 +152,4 @@ rclone lsf remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 834e31b8b..8f515855e 100644 --- a/docs/content/commands/rclone_lsjson.md +++ b/docs/content/commands/rclone_lsjson.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone lsjson" slug: rclone_lsjson url: /commands/rclone_lsjson/ @@ -22,13 +22,16 @@ The output is an array of Items, where each Item looks like this }, "ID": "y2djkhiujf83u33", "OrigID": "UYOJVTUW00Q1RzTDA", + "IsBucket" : false, "IsDir" : false, "MimeType" : "application/octet-stream", "ModTime" : "2017-05-31T16:15:57.034468261+01:00", "Name" : "file.txt", "Encrypted" : "v0qpsdq8anpci8n929v3uu9338", + "EncryptedPath" : "kja9098349023498/v0qpsdq8anpci8n929v3uu9338", "Path" : "full/path/goes/here/file.txt", - "Size" : 6 + "Size" : 6, + "Tier" : "hot", } If --hash is not specified the Hashes property won't be emitted. @@ -46,6 +49,10 @@ If "remote:path" contains the file "subfolder/file.txt", the Path for "file.txt" will be "subfolder/file.txt", not "remote:path/subfolder/file.txt". When used without --recursive the Path will always be the same as Name. +If the directory is a bucket in a bucket based backend, then +"IsBucket" will be set to true. This key won't be present unless it is +"true". + The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the @@ -101,4 +108,4 @@ rclone lsjson remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 f6bf44ec6..c93a2b069 100644 --- a/docs/content/commands/rclone_lsl.md +++ b/docs/content/commands/rclone_lsl.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone lsl" slug: rclone_lsl url: /commands/rclone_lsl/ @@ -60,4 +60,4 @@ rclone lsl remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 1df12bc02..fa59aa929 100644 --- a/docs/content/commands/rclone_md5sum.md +++ b/docs/content/commands/rclone_md5sum.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone md5sum" slug: rclone_md5sum url: /commands/rclone_md5sum/ @@ -29,4 +29,4 @@ rclone md5sum remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 27ade24db..d4a73e56f 100644 --- a/docs/content/commands/rclone_mkdir.md +++ b/docs/content/commands/rclone_mkdir.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone mkdir" slug: rclone_mkdir url: /commands/rclone_mkdir/ @@ -26,4 +26,4 @@ rclone mkdir remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 b554f6ed6..c7d3e3d3a 100644 --- a/docs/content/commands/rclone_mount.md +++ b/docs/content/commands/rclone_mount.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone mount" slug: rclone_mount url: /commands/rclone_mount/ @@ -310,7 +310,7 @@ rclone mount remote:path /path/to/mountpoint [flags] --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required. - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for mount --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k) --no-checksum Don't compare checksums on up/download. @@ -319,7 +319,7 @@ rclone mount remote:path /path/to/mountpoint [flags] -o, --option stringArray Option for libfuse/WinFsp. Repeat if required. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -335,4 +335,4 @@ rclone mount remote:path /path/to/mountpoint [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 f4723a2a5..a765563bc 100644 --- a/docs/content/commands/rclone_move.md +++ b/docs/content/commands/rclone_move.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone move" slug: rclone_move url: /commands/rclone_move/ @@ -54,4 +54,4 @@ rclone move source:path dest:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 316738b26..534a8750e 100644 --- a/docs/content/commands/rclone_moveto.md +++ b/docs/content/commands/rclone_moveto.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone moveto" slug: rclone_moveto url: /commands/rclone_moveto/ @@ -57,4 +57,4 @@ rclone moveto source:path dest:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 9fcf2d1ef..d0e239f1f 100644 --- a/docs/content/commands/rclone_ncdu.md +++ b/docs/content/commands/rclone_ncdu.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone ncdu" slug: rclone_ncdu url: /commands/rclone_ncdu/ @@ -57,4 +57,4 @@ rclone ncdu remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 99a8445d6..62a620df1 100644 --- a/docs/content/commands/rclone_obscure.md +++ b/docs/content/commands/rclone_obscure.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone obscure" slug: rclone_obscure url: /commands/rclone_obscure/ @@ -26,4 +26,4 @@ rclone obscure password [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 91acbd127..c46e5c003 100644 --- a/docs/content/commands/rclone_purge.md +++ b/docs/content/commands/rclone_purge.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone purge" slug: rclone_purge url: /commands/rclone_purge/ @@ -30,4 +30,4 @@ rclone purge remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 482b2be0c..55388ba02 100644 --- a/docs/content/commands/rclone_rc.md +++ b/docs/content/commands/rclone_rc.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone rc" slug: rclone_rc url: /commands/rclone_rc/ @@ -30,6 +30,12 @@ The --json parameter can be used to pass in a JSON blob as an input instead of key=value arguments. This is the only way of passing in more complicated values. +Use --loopback to connect to the rclone instance running "rclone rc". +This is very useful for testing commands without having to run an +rclone rc server, eg: + + rclone rc --loopback operations/about fs=/ + Use "rclone rc" to see a list of all possible commands. ``` @@ -41,6 +47,7 @@ rclone rc commands parameter [flags] ``` -h, --help help for rc --json string Input JSON - use instead of key=value args. + --loopback If set connect to this rclone instance not via HTTP. --no-output If set don't output the JSON result. --pass string Password to use to connect to rclone remote control. --url string URL to connect to rclone remote control. (default "http://localhost:5572/") @@ -51,4 +58,4 @@ rclone rc commands parameter [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 df3c36cb4..e25061fe0 100644 --- a/docs/content/commands/rclone_rcat.md +++ b/docs/content/commands/rclone_rcat.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone rcat" slug: rclone_rcat url: /commands/rclone_rcat/ @@ -48,4 +48,4 @@ rclone rcat remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 45b9bd4f8..dc02753af 100644 --- a/docs/content/commands/rclone_rcd.md +++ b/docs/content/commands/rclone_rcd.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone rcd" slug: rclone_rcd url: /commands/rclone_rcd/ @@ -36,4 +36,4 @@ rclone rcd * [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 55d0522da..ae4c9a7e3 100644 --- a/docs/content/commands/rclone_rmdir.md +++ b/docs/content/commands/rclone_rmdir.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone rmdir" slug: rclone_rmdir url: /commands/rclone_rmdir/ @@ -28,4 +28,4 @@ rclone rmdir remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 67e8e5453..3125b3c1a 100644 --- a/docs/content/commands/rclone_rmdirs.md +++ b/docs/content/commands/rclone_rmdirs.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone rmdirs" slug: rclone_rmdirs url: /commands/rclone_rmdirs/ @@ -36,4 +36,4 @@ rclone rmdirs remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 6164825ce..a9e1706c5 100644 --- a/docs/content/commands/rclone_serve.md +++ b/docs/content/commands/rclone_serve.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone serve" slug: rclone_serve url: /commands/rclone_serve/ @@ -38,4 +38,4 @@ 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 10-May-2019 +###### 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 e86d6edd6..577173eac 100644 --- a/docs/content/commands/rclone_serve_dlna.md +++ b/docs/content/commands/rclone_serve_dlna.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone serve dlna" slug: rclone_serve_dlna url: /commands/rclone_serve_dlna/ @@ -26,6 +26,11 @@ Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. +Use --name to choose the friendly server name, which is by +default "rclone (hostname)". + +Use --log-trace in conjunction with -vv to enable additional debug +logging of all UPNP traffic. ### Directory Cache @@ -173,14 +178,16 @@ rclone serve dlna remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for dlna + --log-trace enable trace logging of SOAP traffic + --name string name of DLNA server --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -194,4 +201,4 @@ rclone serve dlna remote:path [flags] * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 dc7cd8244..3e1a500d0 100644 --- a/docs/content/commands/rclone_serve_ftp.md +++ b/docs/content/commands/rclone_serve_ftp.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone serve ftp" slug: rclone_serve_ftp url: /commands/rclone_serve_ftp/ @@ -177,7 +177,7 @@ rclone serve ftp remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for ftp --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). @@ -187,7 +187,7 @@ rclone serve ftp remote:path [flags] --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --public-ip string Public IP address to advertise for passive connections. --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --user string User name for authentication. (default "anonymous") --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) @@ -202,4 +202,4 @@ rclone serve ftp remote:path [flags] * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 3d033dc9a..5500f95f0 100644 --- a/docs/content/commands/rclone_serve_http.md +++ b/docs/content/commands/rclone_serve_http.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone serve http" slug: rclone_serve_http url: /commands/rclone_serve_http/ @@ -220,7 +220,7 @@ rclone serve http remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for http --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -234,7 +234,7 @@ rclone serve http remote:path [flags] --realm string realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) @@ -249,4 +249,4 @@ rclone serve http remote:path [flags] * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 aab1d940c..b6f2676fe 100644 --- a/docs/content/commands/rclone_serve_restic.md +++ b/docs/content/commands/rclone_serve_restic.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone serve restic" slug: rclone_serve_restic url: /commands/rclone_serve_restic/ @@ -61,14 +61,14 @@ For example: $ export RESTIC_PASSWORD=yourpassword $ restic init created restic backend 8b1a4b56ae at rest:http://localhost:8080/ - + Please note that knowledge of your password is required to access the repository. Losing your password means that your data is irrecoverably lost. $ restic backup /path/to/files/to/backup scan [/path/to/files/to/backup] scanned 189 directories, 312 files in 0:00 - [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 + [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 duration: 0:00 snapshot 45c8fdd8 saved @@ -83,6 +83,10 @@ these **must** end with /. Eg $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ # backup user2 stuff +#### Private repositories #### + +The "--private-repos" flag can be used to limit users to repositories starting +with a path of "//". ### Server options @@ -151,6 +155,7 @@ rclone serve restic remote:path [flags] --key string SSL PEM Private key --max-header-bytes int Maximum size of request header (default 4096) --pass string Password for authentication. + --private-repos users can only access their private repo --realm string realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) @@ -162,4 +167,4 @@ rclone serve restic remote:path [flags] * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 294295fb9..bc6b8870f 100644 --- a/docs/content/commands/rclone_serve_sftp.md +++ b/docs/content/commands/rclone_serve_sftp.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone serve sftp" slug: rclone_serve_sftp url: /commands/rclone_serve_sftp/ @@ -28,8 +28,9 @@ default is the same as ssh) or set the --no-auth flag for no authentication when logging in. Note that this also implements a small number of shell commands so -that it can provide md5sum/sha1sum/df information for the sftp -backend. +that it can provide md5sum/sha1sum/df information for the rclone sftp +backend. This means that is can support SHA1SUMs, MD5SUMs and the +about command when paired with the rclone sftp backend. If you don't supply a --key then rclone will generate one and cache it for later use. @@ -188,7 +189,7 @@ rclone serve sftp remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for sftp --key string SSH private key file (leave blank to auto generate) --no-auth Allow connections with no authentication if set. @@ -198,7 +199,7 @@ rclone serve sftp remote:path [flags] --pass string Password for authentication. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) @@ -213,4 +214,4 @@ rclone serve sftp remote:path [flags] * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 e2db45ae0..c68229bc4 100644 --- a/docs/content/commands/rclone_serve_webdav.md +++ b/docs/content/commands/rclone_serve_webdav.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone serve webdav" slug: rclone_serve_webdav url: /commands/rclone_serve_webdav/ @@ -13,8 +13,8 @@ Serve remote:path over webdav. rclone serve webdav implements a basic webdav server to serve the remote over HTTP via the webdav protocol. This can be viewed with a -webdav client or you can make a remote of type webdav to read and -write it. +webdav client, through a web browser, or you can make a remote of +type webdav to read and write it. ### Webdav options @@ -227,9 +227,10 @@ rclone serve webdav remote:path [flags] --client-ca string Client certificate authority to verify clients with --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) + --disable-dir-list Disable HTML directory list on GET request for a directory --etag-hash string Which hash to use for the ETag, or auto or blank for off --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 502) + --gid uint32 Override the gid field set by the filesystem. (default 1000) -h, --help help for webdav --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -243,7 +244,7 @@ rclone serve webdav remote:path [flags] --realm string realm for authentication (default "rclone") --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) - --uid uint32 Override the uid field set by the filesystem. (default 502) + --uid uint32 Override the uid field set by the filesystem. (default 1000) --umask int Override the permission bits set by the filesystem. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) @@ -258,4 +259,4 @@ rclone serve webdav remote:path [flags] * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 2a767bc6d..e68157d6c 100644 --- a/docs/content/commands/rclone_settier.md +++ b/docs/content/commands/rclone_settier.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone settier" slug: rclone_settier url: /commands/rclone_settier/ @@ -48,4 +48,4 @@ rclone settier tier remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 e3f9da609..9f6a2bfc4 100644 --- a/docs/content/commands/rclone_sha1sum.md +++ b/docs/content/commands/rclone_sha1sum.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone sha1sum" slug: rclone_sha1sum url: /commands/rclone_sha1sum/ @@ -29,4 +29,4 @@ rclone sha1sum remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 63045cb9d..e15c5081c 100644 --- a/docs/content/commands/rclone_size.md +++ b/docs/content/commands/rclone_size.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone size" slug: rclone_size url: /commands/rclone_size/ @@ -27,4 +27,4 @@ rclone size remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 e7151a3dd..cae8abeaf 100644 --- a/docs/content/commands/rclone_sync.md +++ b/docs/content/commands/rclone_sync.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone sync" slug: rclone_sync url: /commands/rclone_sync/ @@ -48,4 +48,4 @@ rclone sync source:path dest:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 b3c6b1db3..a4f1aafd5 100644 --- a/docs/content/commands/rclone_touch.md +++ b/docs/content/commands/rclone_touch.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone touch" slug: rclone_touch url: /commands/rclone_touch/ @@ -28,4 +28,4 @@ rclone touch remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 205ba8b62..09a6568fe 100644 --- a/docs/content/commands/rclone_tree.md +++ b/docs/content/commands/rclone_tree.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone tree" slug: rclone_tree url: /commands/rclone_tree/ @@ -69,4 +69,4 @@ rclone tree remote:path [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### 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 2f5d067a2..2492f35e0 100644 --- a/docs/content/commands/rclone_version.md +++ b/docs/content/commands/rclone_version.md @@ -1,5 +1,5 @@ --- -date: 2019-05-10T23:12:21+01:00 +date: 2019-06-15T12:00:42+01:00 title: "rclone version" slug: rclone_version url: /commands/rclone_version/ @@ -54,4 +54,4 @@ rclone version [flags] * [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends. -###### Auto generated by spf13/cobra on 10-May-2019 +###### Auto generated by spf13/cobra on 15-Jun-2019 diff --git a/docs/content/drive.md b/docs/content/drive.md index 4390f9fdb..ed02b2b38 100644 --- a/docs/content/drive.md +++ b/docs/content/drive.md @@ -804,6 +804,18 @@ Keep new head revision of each file forever. - Type: bool - Default: false +#### --drive-size-as-quota + +Show storage quota usage for file size. + +The storage used by a file is the size of the current version plus any +older versions that have been set to keep forever. + +- Config: size_as_quota +- Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA +- Type: bool +- Default: false + #### --drive-v2-download-min-size If Object's are greater, use drive v2 API to download. @@ -831,6 +843,20 @@ Number of API calls to allow without sleeping. - Type: int - Default: 100 +#### --drive-server-side-across-configs + +Allow server side operations (eg copy) to work across different drive configs. + +This can be useful if you wish to do a server side copy between two +different Google drives. Note that this isn't enabled by default +because it isn't easy to tell if it will work beween any two +configurations. + +- Config: server_side_across_configs +- Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS +- Type: bool +- Default: false + ### Limitations ### diff --git a/docs/content/ftp.md b/docs/content/ftp.md index 979acd4b0..ebb4afd15 100644 --- a/docs/content/ftp.md +++ b/docs/content/ftp.md @@ -128,7 +128,7 @@ FTP host to connect to #### --ftp-user -FTP username, leave blank for current username, ncw +FTP username, leave blank for current username, $USER - Config: user - Env Var: RCLONE_FTP_USER @@ -153,6 +153,15 @@ FTP password - Type: string - Default: "" +#### --ftp-tls + +Use FTP over TLS (Implicit) + +- Config: tls +- Env Var: RCLONE_FTP_TLS +- Type: bool +- Default: false + ### Advanced Options Here are the advanced options specific to ftp (FTP Connection). @@ -166,6 +175,15 @@ Maximum number of FTP simultaneous connections, 0 for unlimited - Type: int - Default: 0 +#### --ftp-no-check-certificate + +Do not verify the TLS certificate of the server + +- Config: no_check_certificate +- Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE +- Type: bool +- Default: false + ### Limitations ### diff --git a/docs/content/rc.md b/docs/content/rc.md index 40e7c0c46..b3c4b307d 100644 --- a/docs/content/rc.md +++ b/docs/content/rc.md @@ -260,7 +260,6 @@ Show statistics for the cache remote. This takes the following parameters - name - name of remote -- type - type of new remote - type - type of the new remote @@ -311,7 +310,6 @@ Authentication is required for this call. This takes the following parameters - name - name of remote -- type - type of new remote See the [config password command](/commands/rclone_config_password/) command for more information on the above. @@ -332,7 +330,6 @@ Authentication is required for this call. This takes the following parameters - name - name of remote -- type - type of new remote See the [config update command](/commands/rclone_config_update/) command for more information on the above. @@ -460,10 +457,11 @@ Results This takes the following parameters - fs - a remote name string eg "drive:" -- remote - a path within that remote eg "dir" The result is as returned from rclone about --json +See the [about command](/commands/rclone_size/) command for more information on the above. + Authentication is required for this call. ### operations/cleanup: Remove trashed files in the remote or path @@ -520,6 +518,63 @@ See the [deletefile command](/commands/rclone_deletefile/) command for more info Authentication is required for this call. +### operations/fsinfo: Return information about the remote + +This takes the following parameters + +- fs - a remote name string eg "drive:" + +This returns info about the remote passed in; + +``` +{ + // optional features and whether they are available or not + "Features": { + "About": true, + "BucketBased": false, + "CanHaveEmptyDirectories": true, + "CaseInsensitive": false, + "ChangeNotify": false, + "CleanUp": false, + "Copy": false, + "DirCacheFlush": false, + "DirMove": true, + "DuplicateFiles": false, + "GetTier": false, + "ListR": false, + "MergeDirs": false, + "Move": true, + "OpenWriterAt": true, + "PublicLink": false, + "Purge": true, + "PutStream": true, + "PutUnchecked": false, + "ReadMimeType": false, + "ServerSideAcrossConfigs": false, + "SetTier": false, + "SetWrapper": false, + "UnWrap": false, + "WrapFs": false, + "WriteMimeType": false + }, + // Names of hashes available + "Hashes": [ + "MD5", + "SHA-1", + "DropboxHash", + "QuickXorHash" + ], + "Name": "local", // Name as created + "Precision": 1, // Precision of timestamps in ns + "Root": "/", // Path as created + "String": "Local file system at /" // how the remote will appear in logs +} +``` + +This command does not have a command line equivalent so use this instead: + + rclone rc --loopback operations/fsinfo fs=remote: + ### operations/list: List the given remote and path in JSON format This takes the following parameters @@ -538,7 +593,7 @@ The result is - list - This is an array of objects as described in the lsjson command -See the lsjson command for more information on the above and examples. +See the [lsjson command](/commands/rclone_lsjson/) for more information on the above and examples. Authentication is required for this call. diff --git a/docs/content/s3.md b/docs/content/s3.md index 141fb2bb4..8237d053e 100644 --- a/docs/content/s3.md +++ b/docs/content/s3.md @@ -708,6 +708,8 @@ Required when using an S3 clone. - Wasabi US East endpoint - "s3.us-west-1.wasabisys.com" - Wasabi US West endpoint + - "s3.eu-central-1.wasabisys.com" + - Wasabi EU Central endpoint #### --s3-location-constraint @@ -1069,6 +1071,17 @@ Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. - Type: bool - Default: false +#### --s3-use-accelerate-endpoint + +If true use the AWS S3 accelerated endpoint. + +See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) + +- Config: use_accelerate_endpoint +- Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT +- Type: bool +- Default: false + ### Anonymous access to public buckets ### diff --git a/docs/layouts/partials/version.html b/docs/layouts/partials/version.html index ef9a30ee1..1aafeee12 100644 --- a/docs/layouts/partials/version.html +++ b/docs/layouts/partials/version.html @@ -1 +1 @@ -v1.47.0 \ No newline at end of file +v1.48.0 \ No newline at end of file diff --git a/fs/version.go b/fs/version.go index ebeed02dd..0c72acbf2 100644 --- a/fs/version.go +++ b/fs/version.go @@ -1,4 +1,4 @@ package fs // Version of rclone -var Version = "v1.47.0-DEV" +var Version = "v1.48.0" diff --git a/rclone.1 b/rclone.1 index cca69c2d9..84f22a81c 100644 --- a/rclone.1 +++ b/rclone.1 @@ -1,7 +1,7 @@ .\"t .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "rclone" "1" "Apr 13, 2019" "User Manual" "" +.TH "rclone" "1" "Jun 15, 2019" "User Manual" "" .hy .SH Rclone .PP @@ -74,6 +74,8 @@ QingStor .IP \[bu] 2 Rackspace Cloud Files .IP \[bu] 2 +rsync.net +.IP \[bu] 2 Scaleway .IP \[bu] 2 SFTP @@ -105,14 +107,20 @@ hash equality .IP \[bu] 2 Can sync to and from network, eg two different cloud accounts .IP \[bu] 2 -(Encryption (https://rclone.org/crypt/)) backend +Encryption (https://rclone.org/crypt/) backend .IP \[bu] 2 -(Cache (https://rclone.org/cache/)) backend +Cache (https://rclone.org/cache/) backend .IP \[bu] 2 -(Union (https://rclone.org/union/)) backend +Union (https://rclone.org/union/) backend .IP \[bu] 2 Optional FUSE mount (rclone mount (https://rclone.org/commands/rclone_mount/)) +.IP \[bu] 2 +Multi\-threaded downloads to local disk +.IP \[bu] 2 +Can serve (https://rclone.org/commands/rclone_serve/) local or remote +files over +HTTP (https://rclone.org/commands/rclone_serve_http/)/WebDav (https://rclone.org/commands/rclone_serve_webdav/)/FTP (https://rclone.org/commands/rclone_serve_ftp/)/SFTP (https://rclone.org/commands/rclone_serve_sftp/)/dlna (https://rclone.org/commands/rclone_serve_dlna/) .PP Links .IP \[bu] 2 @@ -422,6 +430,40 @@ rclone\ config\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ config \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.IP \[bu] 2 +rclone config create (https://rclone.org/commands/rclone_config_create/) +\- Create a new remote with name, type and options. +.IP \[bu] 2 +rclone config delete (https://rclone.org/commands/rclone_config_delete/) +\- Delete an existing remote . +.IP \[bu] 2 +rclone config dump (https://rclone.org/commands/rclone_config_dump/) \- +Dump the config file as JSON. +.IP \[bu] 2 +rclone config edit (https://rclone.org/commands/rclone_config_edit/) \- +Enter an interactive configuration session. +.IP \[bu] 2 +rclone config file (https://rclone.org/commands/rclone_config_file/) \- +Show path of configuration file in use. +.IP \[bu] 2 +rclone config +password (https://rclone.org/commands/rclone_config_password/) \- Update +password in an existing remote. +.IP \[bu] 2 +rclone config +providers (https://rclone.org/commands/rclone_config_providers/) \- List +in JSON format all the providers and options. +.IP \[bu] 2 +rclone config show (https://rclone.org/commands/rclone_config_show/) \- +Print (decrypted) config file, or the config for a single remote. +.IP \[bu] 2 +rclone config update (https://rclone.org/commands/rclone_config_update/) +\- Update options in an existing remote. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone copy .PP Copy files from source to dest, skipping already copied @@ -511,6 +553,11 @@ rclone\ copy\ source:path\ dest:path\ [flags] \ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ copy \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone sync .PP Make source and dest identical, modifying destination only. @@ -553,6 +600,11 @@ rclone\ sync\ source:path\ dest:path\ [flags] \ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ sync \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone move .PP Move files from source to dest. @@ -600,6 +652,11 @@ rclone\ move\ source:path\ dest:path\ [flags] \ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ move \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone delete .PP Remove the contents of path. @@ -648,6 +705,11 @@ rclone\ delete\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ delete \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone purge .PP Remove the path and all of its contents. @@ -670,6 +732,11 @@ rclone\ purge\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ purge \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone mkdir .PP Make the path if it doesn't already exist. @@ -689,6 +756,11 @@ rclone\ mkdir\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ mkdir \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone rmdir .PP Remove the path if empty. @@ -710,6 +782,11 @@ rclone\ rmdir\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ rmdir \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone check .PP Checks the files in the source and destination match. @@ -748,6 +825,11 @@ rclone\ check\ source:path\ dest:path\ [flags] \ \ \ \ \ \ \-\-one\-way\ \ \ \ Check\ one\ way\ only,\ source\ files\ must\ exist\ on\ remote \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone ls .PP List the objects in the path with size and path. @@ -769,7 +851,7 @@ $\ rclone\ ls\ swift:bucket \f[] .fi .PP -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 @@ -809,6 +891,11 @@ rclone\ ls\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ ls \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone lsd .PP List all directories/containers/buckets in the path. @@ -845,7 +932,7 @@ $\ rclone\ lsd\ drive:test If you just want the directory names use \[lq]rclone lsf \[en]dirs\-only\[rq]. .PP -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 @@ -886,6 +973,11 @@ rclone\ lsd\ remote:path\ [flags] \ \ \-R,\ \-\-recursive\ \ \ Recurse\ into\ the\ listing. \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone lsl .PP List the objects in path with modification time, size and path. @@ -907,7 +999,7 @@ $\ rclone\ lsl\ swift:bucket \f[] .fi .PP -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 @@ -947,6 +1039,11 @@ rclone\ lsl\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ lsl \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone md5sum .PP Produces an md5sum file for all the objects in the path. @@ -967,6 +1064,11 @@ rclone\ md5sum\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ md5sum \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone sha1sum .PP Produces an sha1sum file for all the objects in the path. @@ -987,6 +1089,11 @@ rclone\ sha1sum\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ sha1sum \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone size .PP Prints the total size and number of objects in remote:path. @@ -1007,6 +1114,11 @@ rclone\ size\ remote:path\ [flags] \ \ \ \ \ \ \-\-json\ \ \ format\ output\ as\ JSON \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone version .PP Show the version number. @@ -1063,6 +1175,11 @@ rclone\ version\ [flags] \ \ \-h,\ \-\-help\ \ \ \ help\ for\ version \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone cleanup .PP Clean up the remote if possible @@ -1084,6 +1201,11 @@ rclone\ cleanup\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ cleanup \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone dedupe .PP Interactively find duplicate files and delete/rename them. @@ -1218,6 +1340,11 @@ rclone\ dedupe\ [mode]\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ dedupe \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone about .PP Get quota information from the remote. @@ -1298,6 +1425,11 @@ rclone\ about\ remote:\ [flags] \ \ \ \ \ \ \-\-json\ \ \ Format\ output\ as\ JSON \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone authorize .PP Remote authorization. @@ -1319,6 +1451,11 @@ rclone\ authorize\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ authorize \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone cachestats .PP Print cache stats for a remote @@ -1338,6 +1475,11 @@ rclone\ cachestats\ source:\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ cachestats \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone cat .PP Concatenates any files and sends them to stdout. @@ -1392,6 +1534,11 @@ rclone\ cat\ remote:path\ [flags] \ \ \ \ \ \ \-\-tail\ int\ \ \ \ \ Only\ print\ the\ last\ N\ characters. \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone config create .PP Create a new remote with name, type and options. @@ -1414,6 +1561,9 @@ default is taken. Each time that happens rclone will print a message saying how to affect the value taken. .PP +If any of the parameters passed is a password field, then rclone will +automatically obscure them before putting them in the config file. +.PP So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this: .IP @@ -1435,6 +1585,11 @@ rclone\ config\ create\ \ \ [\ ]*\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ create \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone config (https://rclone.org/commands/rclone_config/) \- Enter an +interactive configuration session. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone config delete .PP Delete an existing remote . @@ -1454,6 +1609,11 @@ rclone\ config\ delete\ \ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ delete \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone config (https://rclone.org/commands/rclone_config/) \- Enter an +interactive configuration session. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone config dump .PP Dump the config file as JSON. @@ -1473,6 +1633,11 @@ rclone\ config\ dump\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ dump \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone config (https://rclone.org/commands/rclone_config/) \- Enter an +interactive configuration session. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone config edit .PP Enter an interactive configuration session. @@ -1494,6 +1659,11 @@ rclone\ config\ edit\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ edit \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone config (https://rclone.org/commands/rclone_config/) \- Enter an +interactive configuration session. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone config file .PP Show path of configuration file in use. @@ -1513,6 +1683,11 @@ rclone\ config\ file\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ file \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone config (https://rclone.org/commands/rclone_config/) \- Enter an +interactive configuration session. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone config password .PP Update password in an existing remote. @@ -1528,6 +1703,9 @@ For example to set password of a remote of name myremote you would do: rclone\ config\ password\ myremote\ fieldname\ mypassword \f[] .fi +.PP +This command is obsolete now that \[lq]config update\[rq] and +\[lq]config create\[rq] both support obscuring passwords directly. .IP .nf \f[C] @@ -1541,6 +1719,11 @@ rclone\ config\ password\ \ [\ ]+\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ password \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone config (https://rclone.org/commands/rclone_config/) \- Enter an +interactive configuration session. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone config providers .PP List in JSON format all the providers and options. @@ -1560,6 +1743,11 @@ rclone\ config\ providers\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ providers \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone config (https://rclone.org/commands/rclone_config/) \- Enter an +interactive configuration session. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone config show .PP Print (decrypted) config file, or the config for a single remote. @@ -1579,6 +1767,11 @@ rclone\ config\ show\ []\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ show \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone config (https://rclone.org/commands/rclone_config/) \- Enter an +interactive configuration session. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone config update .PP Update options in an existing remote. @@ -1596,6 +1789,9 @@ rclone\ config\ update\ myremote\ swift\ env_auth\ true \f[] .fi .PP +If any of the parameters passed is a password field, then rclone will +automatically obscure them before putting them in the config file. +.PP If the remote uses oauth the token will be updated, if you don't require this add an extra parameter thus: .IP @@ -1617,6 +1813,11 @@ rclone\ config\ update\ \ [\ ]+\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ update \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone config (https://rclone.org/commands/rclone_config/) \- Enter an +interactive configuration session. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone copyto .PP Copy files from source to dest, skipping already copied @@ -1671,6 +1872,11 @@ rclone\ copyto\ source:path\ dest:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ copyto \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone copyurl .PP Copy url content to dest. @@ -1691,6 +1897,11 @@ rclone\ copyurl\ https://example.com\ dest:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ copyurl \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone cryptcheck .PP Cryptcheck checks the integrity of a crypted remote. @@ -1745,6 +1956,11 @@ rclone\ cryptcheck\ remote:path\ cryptedremote:path\ [flags] \ \ \ \ \ \ \-\-one\-way\ \ \ Check\ one\ way\ only,\ source\ files\ must\ exist\ on\ destination \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone cryptdecode .PP Cryptdecode returns unencrypted file names. @@ -1780,6 +1996,11 @@ rclone\ cryptdecode\ encryptedremote:\ encryptedfilename\ [flags] \ \ \ \ \ \ \-\-reverse\ \ \ Reverse\ cryptdecode,\ encrypts\ filenames \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone dbhashsum .PP Produces a Dropbox hash file for all the objects in the path. @@ -1802,6 +2023,11 @@ rclone\ dbhashsum\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ dbhashsum \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone deletefile .PP Remove a single file from remote. @@ -1824,6 +2050,11 @@ rclone\ deletefile\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ deletefile \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone genautocomplete .PP Output completion script for a given shell. @@ -1838,6 +2069,19 @@ Run with \[en]help to list the supported shells. \ \ \-h,\ \-\-help\ \ \ help\ for\ genautocomplete \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.IP \[bu] 2 +rclone genautocomplete +bash (https://rclone.org/commands/rclone_genautocomplete_bash/) \- +Output bash completion script for rclone. +.IP \[bu] 2 +rclone genautocomplete +zsh (https://rclone.org/commands/rclone_genautocomplete_zsh/) \- Output +zsh completion script for rclone. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone genautocomplete bash .PP Output bash completion script for rclone. @@ -1877,6 +2121,12 @@ rclone\ genautocomplete\ bash\ [output_file]\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ bash \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone +genautocomplete (https://rclone.org/commands/rclone_genautocomplete/) \- +Output completion script for a given shell. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone genautocomplete zsh .PP Output zsh completion script for rclone. @@ -1916,6 +2166,12 @@ rclone\ genautocomplete\ zsh\ [output_file]\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ zsh \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone +genautocomplete (https://rclone.org/commands/rclone_genautocomplete/) \- +Output completion script for a given shell. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone gendocs .PP Output markdown docs for rclone to the directory supplied. @@ -1938,6 +2194,11 @@ rclone\ gendocs\ output_directory\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ gendocs \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone hashsum .PP Produces an hashsum file for all the objects in the path. @@ -1980,6 +2241,11 @@ rclone\ hashsum\ \ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ hashsum \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone link .PP Generate public link to file/folder. @@ -2012,6 +2278,11 @@ rclone\ link\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ link \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone listremotes .PP List all the remotes in the config file. @@ -2034,6 +2305,11 @@ rclone\ listremotes\ [flags] \ \ \ \ \ \ \-\-long\ \ \ Show\ the\ type\ as\ well\ as\ names. \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone lsf .PP List directories and objects in remote:path formatted for parsing @@ -2072,6 +2348,7 @@ i\ \-\ ID\ of\ object o\ \-\ Original\ ID\ of\ underlying\ object m\ \-\ MimeType\ of\ object\ if\ known e\ \-\ encrypted\ name +T\ \-\ tier\ of\ storage\ if\ known,\ eg\ "Hot"\ or\ "Cool" \f[] .fi .PP @@ -2167,7 +2444,7 @@ rclone\ copy\ \-\-files\-from\ new_files\ /path/to/local\ remote:path \f[] .fi .PP -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 @@ -2216,6 +2493,11 @@ rclone\ lsf\ remote:path\ [flags] \ \ \-s,\ \-\-separator\ string\ \ \ Separator\ for\ the\ items\ in\ the\ format.\ (default\ ";") \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone lsjson .PP List directories and objects in the path in JSON format. @@ -2230,12 +2512,14 @@ The output is an array of Items, where each Item looks like this \[lq]b1946ac92492d2347c6235b4d2611184\[rq], \[lq]DropboxHash\[rq] : \[lq]ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc\[rq] }, \[lq]ID\[rq]: \[lq]y2djkhiujf83u33\[rq], \[lq]OrigID\[rq]: -\[lq]UYOJVTUW00Q1RzTDA\[rq], \[lq]IsDir\[rq] : false, \[lq]MimeType\[rq] -: \[lq]application/octet\-stream\[rq], \[lq]ModTime\[rq] : -\[lq]2017\-05\-31T16:15:57.034468261+01:00\[rq], \[lq]Name\[rq] : -\[lq]file.txt\[rq], \[lq]Encrypted\[rq] : -\[lq]v0qpsdq8anpci8n929v3uu9338\[rq], \[lq]Path\[rq] : -\[lq]full/path/goes/here/file.txt\[rq], \[lq]Size\[rq] : 6 } +\[lq]UYOJVTUW00Q1RzTDA\[rq], \[lq]IsBucket\[rq] : false, \[lq]IsDir\[rq] +: false, \[lq]MimeType\[rq] : \[lq]application/octet\-stream\[rq], +\[lq]ModTime\[rq] : \[lq]2017\-05\-31T16:15:57.034468261+01:00\[rq], +\[lq]Name\[rq] : \[lq]file.txt\[rq], \[lq]Encrypted\[rq] : +\[lq]v0qpsdq8anpci8n929v3uu9338\[rq], \[lq]EncryptedPath\[rq] : +\[lq]kja9098349023498/v0qpsdq8anpci8n929v3uu9338\[rq], \[lq]Path\[rq] : +\[lq]full/path/goes/here/file.txt\[rq], \[lq]Size\[rq] : 6, +\[lq]Tier\[rq] : \[lq]hot\[rq], } .PP If \[en]hash is not specified the Hashes property won't be emitted. .PP @@ -2257,6 +2541,10 @@ not \[lq]remote:path/subfolder/file.txt\[rq]. When used without \[en]recursive the Path will always be the same as Name. .PP +If the directory is a bucket in a bucket based backend, then +\[lq]IsBucket\[rq] will be set to true. +This key won't be present unless it is \[lq]true\[rq]. +.PP The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the @@ -2268,7 +2556,7 @@ be shown (\[lq]2017\-05\-31T16:15:57+01:00\[rq]). The whole output can be processed as a JSON blob, or alternatively it can be processed line by line as each item is written one to a line. .PP -Any of the filtering options can be applied to this commmand. +Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 @@ -2315,6 +2603,11 @@ rclone\ lsjson\ remote:path\ [flags] \ \ \-R,\ \-\-recursive\ \ \ \ Recurse\ into\ the\ listing. \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone mount .PP Mount the remote as file system on a mountpoint. @@ -2668,7 +2961,7 @@ rclone\ mount\ remote:path\ /path/to/mountpoint\ [flags] \ \ \ \ \ \ \-\-dir\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ permissions\ (default\ 0777) \ \ \ \ \ \ \-\-file\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ File\ permissions\ (default\ 0666) \ \ \ \ \ \ \-\-fuse\-flag\ stringArray\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Flags\ or\ arguments\ to\ be\ passed\ direct\ to\ libfuse/WinFsp.\ Repeat\ if\ required. -\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 502) +\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) \ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ mount \ \ \ \ \ \ \-\-max\-read\-ahead\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ number\ of\ bytes\ that\ can\ be\ prefetched\ for\ sequential\ reads.\ (default\ 128k) \ \ \ \ \ \ \-\-no\-checksum\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ compare\ checksums\ on\ up/download. @@ -2677,7 +2970,7 @@ rclone\ mount\ remote:path\ /path/to/mountpoint\ [flags] \ \ \-o,\ \-\-option\ stringArray\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Option\ for\ libfuse/WinFsp.\ Repeat\ if\ required. \ \ \ \ \ \ \-\-poll\-interval\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Time\ to\ wait\ between\ polling\ for\ changes.\ Must\ be\ smaller\ than\ dir\-cache\-time.\ Only\ on\ supported\ remotes.\ Set\ to\ 0\ to\ disable.\ (default\ 1m0s) \ \ \ \ \ \ \-\-read\-only\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Mount\ read\-only. -\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 502) +\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) \ \ \ \ \ \ \-\-umask\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ permission\ bits\ set\ by\ the\ filesystem. \ \ \ \ \ \ \-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) \ \ \ \ \ \ \-\-vfs\-cache\-max\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) @@ -2689,6 +2982,11 @@ 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. \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone moveto .PP Move file or directory from source to dest. @@ -2699,7 +2997,7 @@ directory named dest:path. .PP This can be used to rename files or upload single files to other than their existing name. -If the source is a directory then it acts exacty like the move command. +If the source is a directory then it acts exactly like the move command. .PP So .IP @@ -2746,6 +3044,11 @@ rclone\ moveto\ source:path\ dest:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ moveto \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone ncdu .PP Explore a remote with a text based user interface. @@ -2798,6 +3101,11 @@ rclone\ ncdu\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ ncdu \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone obscure .PP Obscure password for use in the rclone.conf @@ -2817,6 +3125,11 @@ rclone\ obscure\ password\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ obscure \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone rc .PP Run a command against a running rclone. @@ -2841,6 +3154,17 @@ The \[en]json parameter can be used to pass in a JSON blob as an input instead of key=value arguments. This is the only way of passing in more complicated values. .PP +Use \[en]loopback to connect to the rclone instance running \[lq]rclone +rc\[rq]. +This is very useful for testing commands without having to run an rclone +rc server, eg: +.IP +.nf +\f[C] +rclone\ rc\ \-\-loopback\ operations/about\ fs=/ +\f[] +.fi +.PP Use \[lq]rclone rc\[rq] to see a list of all possible commands. .IP .nf @@ -2854,12 +3178,18 @@ rclone\ rc\ commands\ parameter\ [flags] \f[C] \ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ help\ for\ rc \ \ \ \ \ \ \-\-json\ string\ \ \ Input\ JSON\ \-\ use\ instead\ of\ key=value\ args. +\ \ \ \ \ \ \-\-loopback\ \ \ \ \ \ If\ set\ connect\ to\ this\ rclone\ instance\ not\ via\ HTTP. \ \ \ \ \ \ \-\-no\-output\ \ \ \ \ If\ set\ don\[aq]t\ output\ the\ JSON\ result. \ \ \ \ \ \ \-\-pass\ string\ \ \ Password\ to\ use\ to\ connect\ to\ rclone\ remote\ control. \ \ \ \ \ \ \-\-url\ string\ \ \ \ URL\ to\ connect\ to\ rclone\ remote\ control.\ (default\ "http://localhost:5572/") \ \ \ \ \ \ \-\-user\ string\ \ \ Username\ to\ use\ to\ rclone\ remote\ control. \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone rcat .PP Copies standard input to file on remote. @@ -2908,6 +3238,11 @@ rclone\ rcat\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ rcat \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone rcd .PP Run rclone listening to remote control commands only. @@ -2936,6 +3271,11 @@ rclone\ rcd\ *\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ rcd \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone rmdirs .PP Remove empty directories under the path. @@ -2964,6 +3304,11 @@ rclone\ rmdirs\ remote:path\ [flags] \ \ \ \ \ \ \-\-leave\-root\ \ \ Do\ not\ remove\ root\ directory\ if\ empty \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone serve .PP Serve a remote over a protocol. @@ -2993,6 +3338,29 @@ rclone\ serve\ \ [opts]\ \ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ serve \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.IP \[bu] 2 +rclone serve dlna (https://rclone.org/commands/rclone_serve_dlna/) \- +Serve remote:path over DLNA +.IP \[bu] 2 +rclone serve ftp (https://rclone.org/commands/rclone_serve_ftp/) \- +Serve remote:path over FTP. +.IP \[bu] 2 +rclone serve http (https://rclone.org/commands/rclone_serve_http/) \- +Serve the remote over HTTP. +.IP \[bu] 2 +rclone serve restic (https://rclone.org/commands/rclone_serve_restic/) +\- Serve the remote for restic's REST API. +.IP \[bu] 2 +rclone serve sftp (https://rclone.org/commands/rclone_serve_sftp/) \- +Serve the remote over SFTP. +.IP \[bu] 2 +rclone serve webdav (https://rclone.org/commands/rclone_serve_webdav/) +\- Serve remote:path over webdav. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone serve dlna .PP Serve remote:path over DLNA @@ -3016,6 +3384,12 @@ play back correctly. Use \[en]addr to specify which IP address and port the server should listen on, eg \[en]addr 1.2.3.4:8000 or \[en]addr :8080 to listen to all IPs. +.PP +Use \[en]name to choose the friendly server name, which is by default +\[lq]rclone (hostname)\[rq]. +.PP +Use \[en]log\-trace in conjunction with \-vv to enable additional debug +logging of all UPNP traffic. .SS Directory Cache .PP Using the \f[C]\-\-dir\-cache\-time\f[] flag, you can set how long a @@ -3191,14 +3565,16 @@ rclone\ serve\ dlna\ remote:path\ [flags] \ \ \ \ \ \ \-\-dir\-cache\-time\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Time\ to\ cache\ directory\ entries\ for.\ (default\ 5m0s) \ \ \ \ \ \ \-\-dir\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ permissions\ (default\ 0777) \ \ \ \ \ \ \-\-file\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ File\ permissions\ (default\ 0666) -\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 502) +\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) \ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ dlna +\ \ \ \ \ \ \-\-log\-trace\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ enable\ trace\ logging\ of\ SOAP\ traffic +\ \ \ \ \ \ \-\-name\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ name\ of\ DLNA\ server \ \ \ \ \ \ \-\-no\-checksum\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ compare\ checksums\ on\ up/download. \ \ \ \ \ \ \-\-no\-modtime\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ read/write\ the\ modification\ time\ (can\ speed\ things\ up). \ \ \ \ \ \ \-\-no\-seek\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ allow\ seeking\ in\ files. \ \ \ \ \ \ \-\-poll\-interval\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Time\ to\ wait\ between\ polling\ for\ changes.\ Must\ be\ smaller\ than\ dir\-cache\-time.\ Only\ on\ supported\ remotes.\ Set\ to\ 0\ to\ disable.\ (default\ 1m0s) \ \ \ \ \ \ \-\-read\-only\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Mount\ read\-only. -\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 502) +\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) \ \ \ \ \ \ \-\-umask\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ permission\ bits\ set\ by\ the\ filesystem.\ (default\ 2) \ \ \ \ \ \ \-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) \ \ \ \ \ \ \-\-vfs\-cache\-max\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) @@ -3208,6 +3584,11 @@ 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.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone serve (https://rclone.org/commands/rclone_serve/) \- Serve a +remote over a protocol. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone serve ftp .PP Serve remote:path over FTP. @@ -3408,7 +3789,7 @@ rclone\ serve\ ftp\ remote:path\ [flags] \ \ \ \ \ \ \-\-dir\-cache\-time\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Time\ to\ cache\ directory\ entries\ for.\ (default\ 5m0s) \ \ \ \ \ \ \-\-dir\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ permissions\ (default\ 0777) \ \ \ \ \ \ \-\-file\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ File\ permissions\ (default\ 0666) -\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 502) +\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) \ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ ftp \ \ \ \ \ \ \-\-no\-checksum\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ compare\ checksums\ on\ up/download. \ \ \ \ \ \ \-\-no\-modtime\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ read/write\ the\ modification\ time\ (can\ speed\ things\ up). @@ -3416,8 +3797,9 @@ rclone\ serve\ ftp\ remote:path\ [flags] \ \ \ \ \ \ \-\-pass\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Password\ for\ authentication.\ (empty\ value\ allow\ every\ password) \ \ \ \ \ \ \-\-passive\-port\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Passive\ port\ range\ to\ use.\ (default\ "30000\-32000") \ \ \ \ \ \ \-\-poll\-interval\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Time\ to\ wait\ between\ polling\ for\ changes.\ Must\ be\ smaller\ than\ dir\-cache\-time.\ Only\ on\ supported\ remotes.\ Set\ to\ 0\ to\ disable.\ (default\ 1m0s) +\ \ \ \ \ \ \-\-public\-ip\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Public\ IP\ address\ to\ advertise\ for\ passive\ connections. \ \ \ \ \ \ \-\-read\-only\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Mount\ read\-only. -\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 502) +\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) \ \ \ \ \ \ \-\-umask\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ permission\ bits\ set\ by\ the\ filesystem.\ (default\ 2) \ \ \ \ \ \ \-\-user\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ User\ name\ for\ authentication.\ (default\ "anonymous") \ \ \ \ \ \ \-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) @@ -3428,6 +3810,11 @@ 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.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone serve (https://rclone.org/commands/rclone_serve/) \- Serve a +remote over a protocol. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone serve http .PP Serve the remote over HTTP. @@ -3677,7 +4064,7 @@ rclone\ serve\ http\ remote:path\ [flags] \ \ \ \ \ \ \-\-dir\-cache\-time\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Time\ to\ cache\ directory\ entries\ for.\ (default\ 5m0s) \ \ \ \ \ \ \-\-dir\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ permissions\ (default\ 0777) \ \ \ \ \ \ \-\-file\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ File\ permissions\ (default\ 0666) -\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 502) +\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) \ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ http \ \ \ \ \ \ \-\-htpasswd\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ htpasswd\ file\ \-\ if\ not\ provided\ no\ authentication\ is\ done \ \ \ \ \ \ \-\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSL\ PEM\ Private\ key @@ -3691,7 +4078,7 @@ rclone\ serve\ http\ remote:path\ [flags] \ \ \ \ \ \ \-\-realm\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ realm\ for\ authentication\ (default\ "rclone") \ \ \ \ \ \ \-\-server\-read\-timeout\ duration\ \ \ \ \ \ \ \ \ \ \ Timeout\ for\ server\ reading\ data\ (default\ 1h0m0s) \ \ \ \ \ \ \-\-server\-write\-timeout\ duration\ \ \ \ \ \ \ \ \ \ Timeout\ for\ server\ writing\ data\ (default\ 1h0m0s) -\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 502) +\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) \ \ \ \ \ \ \-\-umask\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ permission\ bits\ set\ by\ the\ filesystem.\ (default\ 2) \ \ \ \ \ \ \-\-user\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ User\ name\ for\ authentication. \ \ \ \ \ \ \-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) @@ -3702,6 +4089,11 @@ 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.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone serve (https://rclone.org/commands/rclone_serve/) \- Serve a +remote over a protocol. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone serve restic .PP Serve the remote for restic's REST API. @@ -3770,7 +4162,7 @@ irrecoverably\ lost. $\ restic\ backup\ /path/to/files/to/backup scan\ [/path/to/files/to/backup] scanned\ 189\ directories,\ 312\ files\ in\ 0:00 -[0:00]\ 100.00%\ \ 38.128\ MiB\ /\ 38.128\ MiB\ \ 501\ /\ 501\ items\ \ 0\ errors\ \ ETA\ 0:00\ +[0:00]\ 100.00%\ \ 38.128\ MiB\ /\ 38.128\ MiB\ \ 501\ /\ 501\ items\ \ 0\ errors\ \ ETA\ 0:00 duration:\ 0:00 snapshot\ 45c8fdd8\ saved \f[] @@ -3790,6 +4182,10 @@ $\ export\ RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ #\ backup\ user2\ stuff \f[] .fi +.SS Private repositories +.PP +The \[lq]\[en]private\-repos\[rq] flag can be used to limit users to +repositories starting with a path of \[lq]//\[rq]. .SS Server options .PP Use \[en]addr to specify which IP address and port the server should @@ -3863,6 +4259,7 @@ rclone\ serve\ restic\ remote:path\ [flags] \ \ \ \ \ \ \-\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSL\ PEM\ Private\ key \ \ \ \ \ \ \-\-max\-header\-bytes\ int\ \ \ \ \ \ \ \ \ \ \ \ Maximum\ size\ of\ request\ header\ (default\ 4096) \ \ \ \ \ \ \-\-pass\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Password\ for\ authentication. +\ \ \ \ \ \ \-\-private\-repos\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ users\ can\ only\ access\ their\ private\ repo \ \ \ \ \ \ \-\-realm\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ realm\ for\ authentication\ (default\ "rclone") \ \ \ \ \ \ \-\-server\-read\-timeout\ duration\ \ \ \ Timeout\ for\ server\ reading\ data\ (default\ 1h0m0s) \ \ \ \ \ \ \-\-server\-write\-timeout\ duration\ \ \ Timeout\ for\ server\ writing\ data\ (default\ 1h0m0s) @@ -3870,6 +4267,251 @@ rclone\ serve\ restic\ remote:path\ [flags] \ \ \ \ \ \ \-\-user\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ User\ name\ for\ authentication. \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone serve (https://rclone.org/commands/rclone_serve/) \- Serve a +remote over a protocol. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 +.SS rclone serve sftp +.PP +Serve the remote over SFTP. +.SS Synopsis +.PP +rclone serve sftp implements an SFTP server to serve the remote over +SFTP. +This can be used with an SFTP client or you can make a remote of type +sftp to use with it. +.PP +You can use the filter flags (eg \[en]include, \[en]exclude) to control +what is served. +.PP +The server will log errors. +Use \-v to see access logs. +.PP +\[en]bwlimit will be respected for file transfers. +Use \[en]stats to control the stats printing. +.PP +You must provide some means of authentication, either with +\[en]user/\[en]pass, an authorized keys file (specify location with +\[en]authorized\-keys \- the default is the same as ssh) or set the +\[en]no\-auth flag for no authentication when logging in. +.PP +Note that this also implements a small number of shell commands so that +it can provide md5sum/sha1sum/df information for the rclone sftp +backend. +This means that is can support SHA1SUMs, MD5SUMs and the about command +when paired with the rclone sftp backend. +.PP +If you don't supply a \[en]key then rclone will generate one and cache +it for later use. +.PP +By default the server binds to localhost:2022 \- if you want it to be +reachable externally then supply \[lq]\[en]addr :2022\[rq] for example. +.PP +Note that the default of \[lq]\[en]vfs\-cache\-mode off\[rq] is fine for +the rclone sftp backend, but it may not be with other SFTP clients. +.SS Directory Cache +.PP +Using the \f[C]\-\-dir\-cache\-time\f[] flag, you can set how long a +directory should be considered up to date and not refreshed from the +backend. +Changes made locally in the mount may appear immediately or invalidate +the cache. +However, changes done on the remote will only be picked up once the +cache expires. +.PP +Alternatively, you can send a \f[C]SIGHUP\f[] signal to rclone for it to +flush all directory caches, regardless of how old they are. +Assuming only one rclone instance is running, you can reset the cache +like this: +.IP +.nf +\f[C] +kill\ \-SIGHUP\ $(pidof\ rclone) +\f[] +.fi +.PP +If you configure rclone with a remote control (/rc) then you can use +rclone rc to flush the whole directory cache: +.IP +.nf +\f[C] +rclone\ rc\ vfs/forget +\f[] +.fi +.PP +Or individual files or directories: +.IP +.nf +\f[C] +rclone\ rc\ vfs/forget\ file=path/to/file\ dir=path/to/dir +\f[] +.fi +.SS File Buffering +.PP +The \f[C]\-\-buffer\-size\f[] flag determines the amount of memory, that +will be used to buffer data in advance. +.PP +Each open file descriptor will try to keep the specified amount of data +in memory at all times. +The buffered data is bound to one file descriptor and won't be shared +between multiple open file descriptors of the same file. +.PP +This flag is a upper limit for the used memory per file descriptor. +The buffer will only use memory for data that is downloaded but not not +yet read. +If the buffer is empty, only a small amount of memory will be used. +The maximum memory used by rclone for buffering can be up to +\f[C]\-\-buffer\-size\ *\ open\ files\f[]. +.SS File Caching +.PP +These flags control the VFS file caching options. +The VFS layer is used by rclone mount to make a cloud storage system +work more like a normal file system. +.PP +You'll need to enable VFS caching if you want, for example, to read and +write simultaneously to a file. +See below for more details. +.PP +Note that the VFS cache works in addition to the cache backend and you +may find that you need one or the other or both. +.IP +.nf +\f[C] +\-\-cache\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ rclone\ will\ use\ for\ caching. +\-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) +\-\-vfs\-cache\-mode\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ "off") +\-\-vfs\-cache\-poll\-interval\ duration\ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) +\-\-vfs\-cache\-max\-size\ int\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) +\f[] +.fi +.PP +If run with \f[C]\-vv\f[] rclone will print the location of the file +cache. +The files are stored in the user cache file area which is OS dependent +but can be controlled with \f[C]\-\-cache\-dir\f[] or setting the +appropriate environment variable. +.PP +The cache has 4 different modes selected by +\f[C]\-\-vfs\-cache\-mode\f[]. +The higher the cache mode the more compatible rclone becomes at the cost +of using disk space. +.PP +Note that files are written back to the remote only when they are closed +so if rclone is quit or dies with open files then these won't get +written back to the remote. +However they will still be in the on disk cache. +.PP +If using \[en]vfs\-cache\-max\-size note that the cache may exceed this +size for two reasons. +Firstly because it is only checked every +\[en]vfs\-cache\-poll\-interval. +Secondly because open files cannot be evicted from the cache. +.SS \[en]vfs\-cache\-mode off +.PP +In this mode the cache will read directly from the remote and write +directly to the remote without caching anything on disk. +.PP +This will mean some operations are not possible +.IP \[bu] 2 +Files can't be opened for both read AND write +.IP \[bu] 2 +Files opened for write can't be seeked +.IP \[bu] 2 +Existing files opened for write must have O_TRUNC set +.IP \[bu] 2 +Files open for read with O_TRUNC will be opened write only +.IP \[bu] 2 +Files open for write only will behave as if O_TRUNC was supplied +.IP \[bu] 2 +Open modes O_APPEND, O_TRUNC are ignored +.IP \[bu] 2 +If an upload fails it can't be retried +.SS \[en]vfs\-cache\-mode minimal +.PP +This is very similar to \[lq]off\[rq] except that files opened for read +AND write will be buffered to disks. +This means that files opened for write will be a lot more compatible, +but uses the minimal disk space. +.PP +These operations are not possible +.IP \[bu] 2 +Files opened for write only can't be seeked +.IP \[bu] 2 +Existing files opened for write must have O_TRUNC set +.IP \[bu] 2 +Files opened for write only will ignore O_APPEND, O_TRUNC +.IP \[bu] 2 +If an upload fails it can't be retried +.SS \[en]vfs\-cache\-mode writes +.PP +In this mode files opened for read only are still read directly from the +remote, write only and read/write files are buffered to disk first. +.PP +This mode should support all normal file system operations. +.PP +If an upload fails it will be retried up to \[en]low\-level\-retries +times. +.SS \[en]vfs\-cache\-mode full +.PP +In this mode all reads and writes are buffered to and from disk. +When a file is opened for read it will be downloaded in its entirety +first. +.PP +This may be appropriate for your needs, or you may prefer to look at the +cache backend which does a much more sophisticated job of caching, +including caching directory hierarchies and chunks of files. +.PP +In this mode, unlike the others, when a file is written to the disk, it +will be kept on the disk after it is written to the remote. +It will be purged on a schedule according to +\f[C]\-\-vfs\-cache\-max\-age\f[]. +.PP +This mode should support all normal file system operations. +.PP +If an upload or download fails it will be retried up to +\[en]low\-level\-retries times. +.IP +.nf +\f[C] +rclone\ serve\ sftp\ remote:path\ [flags] +\f[] +.fi +.SS Options +.IP +.nf +\f[C] +\ \ \ \ \ \ \-\-addr\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ IPaddress:Port\ or\ :Port\ to\ bind\ server\ to.\ (default\ "localhost:2022") +\ \ \ \ \ \ \-\-authorized\-keys\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Authorized\ keys\ file\ (default\ "~/.ssh/authorized_keys") +\ \ \ \ \ \ \-\-dir\-cache\-time\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Time\ to\ cache\ directory\ entries\ for.\ (default\ 5m0s) +\ \ \ \ \ \ \-\-dir\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ permissions\ (default\ 0777) +\ \ \ \ \ \ \-\-file\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ File\ permissions\ (default\ 0666) +\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) +\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ sftp +\ \ \ \ \ \ \-\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSH\ private\ key\ file\ (leave\ blank\ to\ auto\ generate) +\ \ \ \ \ \ \-\-no\-auth\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Allow\ connections\ with\ no\ authentication\ if\ set. +\ \ \ \ \ \ \-\-no\-checksum\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ compare\ checksums\ on\ up/download. +\ \ \ \ \ \ \-\-no\-modtime\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ read/write\ the\ modification\ time\ (can\ speed\ things\ up). +\ \ \ \ \ \ \-\-no\-seek\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ allow\ seeking\ in\ files. +\ \ \ \ \ \ \-\-pass\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Password\ for\ authentication. +\ \ \ \ \ \ \-\-poll\-interval\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Time\ to\ wait\ between\ polling\ for\ changes.\ Must\ be\ smaller\ than\ dir\-cache\-time.\ Only\ on\ supported\ remotes.\ Set\ to\ 0\ to\ disable.\ (default\ 1m0s) +\ \ \ \ \ \ \-\-read\-only\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Mount\ read\-only. +\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) +\ \ \ \ \ \ \-\-umask\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ permission\ bits\ set\ by\ the\ filesystem.\ (default\ 2) +\ \ \ \ \ \ \-\-user\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ User\ name\ for\ authentication. +\ \ \ \ \ \ \-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) +\ \ \ \ \ \ \-\-vfs\-cache\-max\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) +\ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) +\ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) +\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) +\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) +\f[] +.fi +.SS SEE ALSO +.IP \[bu] 2 +rclone serve (https://rclone.org/commands/rclone_serve/) \- Serve a +remote over a protocol. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone serve webdav .PP Serve remote:path over webdav. @@ -3877,8 +4519,8 @@ Serve remote:path over webdav. .PP rclone serve webdav implements a basic webdav server to serve the remote over HTTP via the webdav protocol. -This can be viewed with a webdav client or you can make a remote of type -webdav to read and write it. +This can be viewed with a webdav client, through a web browser, or you +can make a remote of type webdav to read and write it. .SS Webdav options .SS \[en]etag\-hash .PP @@ -4121,9 +4763,10 @@ rclone\ serve\ webdav\ remote:path\ [flags] \ \ \ \ \ \ \-\-client\-ca\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Client\ certificate\ authority\ to\ verify\ clients\ with \ \ \ \ \ \ \-\-dir\-cache\-time\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Time\ to\ cache\ directory\ entries\ for.\ (default\ 5m0s) \ \ \ \ \ \ \-\-dir\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ permissions\ (default\ 0777) +\ \ \ \ \ \ \-\-disable\-dir\-list\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Disable\ HTML\ directory\ list\ on\ GET\ request\ for\ a\ directory \ \ \ \ \ \ \-\-etag\-hash\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Which\ hash\ to\ use\ for\ the\ ETag,\ or\ auto\ or\ blank\ for\ off \ \ \ \ \ \ \-\-file\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ File\ permissions\ (default\ 0666) -\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 502) +\ \ \ \ \ \ \-\-gid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ gid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) \ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ webdav \ \ \ \ \ \ \-\-htpasswd\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ htpasswd\ file\ \-\ if\ not\ provided\ no\ authentication\ is\ done \ \ \ \ \ \ \-\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSL\ PEM\ Private\ key @@ -4137,7 +4780,7 @@ rclone\ serve\ webdav\ remote:path\ [flags] \ \ \ \ \ \ \-\-realm\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ realm\ for\ authentication\ (default\ "rclone") \ \ \ \ \ \ \-\-server\-read\-timeout\ duration\ \ \ \ \ \ \ \ \ \ \ Timeout\ for\ server\ reading\ data\ (default\ 1h0m0s) \ \ \ \ \ \ \-\-server\-write\-timeout\ duration\ \ \ \ \ \ \ \ \ \ Timeout\ for\ server\ writing\ data\ (default\ 1h0m0s) -\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 502) +\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) \ \ \ \ \ \ \-\-umask\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ permission\ bits\ set\ by\ the\ filesystem.\ (default\ 2) \ \ \ \ \ \ \-\-user\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ User\ name\ for\ authentication. \ \ \ \ \ \ \-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) @@ -4148,6 +4791,11 @@ 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.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone serve (https://rclone.org/commands/rclone_serve/) \- Serve a +remote over a protocol. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone settier .PP Changes storage class/tier of objects in remote. @@ -4159,7 +4807,7 @@ objects, for example AWS S3 and Glacier, Azure Blob storage \- Hot, Cool and Archive, Google Cloud Storage, Regional Storage, Nearline, Coldline etc. .PP -Note that, certain tier chages make objects not available to access +Note that, certain tier changes make objects not available to access immediately. For example tiering to archive in azure blob storage makes objects in frozen state, user can restore by setting tier to Hot/Cool, similarly S3 @@ -4202,6 +4850,11 @@ rclone\ settier\ tier\ remote:path\ [flags] \ \ \-h,\ \-\-help\ \ \ help\ for\ settier \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone touch .PP Create new file or change file modification time. @@ -4223,6 +4876,11 @@ 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\ \[aq]YYMMDD\[aq]\ (ex.\ 17.10.30)\ or\ \[aq]YYYY\-MM\-DDTHH:MM:SS\[aq]\ (ex.\ 2006\-01\-02T15:04:05) \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS rclone tree .PP List the contents of the remote in a tree like fashion. @@ -4289,6 +4947,11 @@ rclone\ tree\ remote:path\ [flags] \ \ \ \ \ \ \-\-version\ \ \ \ \ \ \ \ \ Sort\ files\ alphanumerically\ by\ version. \f[] .fi +.SS SEE ALSO +.IP \[bu] 2 +rclone (https://rclone.org/commands/rclone/) \- Show help for rclone +commands, flags and backends. +.SS Auto generated by spf13/cobra on 15\-Jun\-2019 .SS Copying single files .PP rclone normally syncs or copies directories. @@ -4715,7 +5378,12 @@ Normally the config file is in your home directory as a file called \f[C]\&.config/rclone/rclone.conf\f[] (or \f[C]\&.rclone.conf\f[] if created with an older version). If \f[C]$XDG_CONFIG_HOME\f[] is set it will be at -\f[C]$XDG_CONFIG_HOME/rclone/rclone.conf\f[] +\f[C]$XDG_CONFIG_HOME/rclone/rclone.conf\f[]. +.PP +If there is a file \f[C]rclone.conf\f[] in the same directory as the +rclone executable it will be preferred. +This file must be created manually for Rclone to use it, it will never +be created automatically. .PP If you run \f[C]rclone\ config\ file\f[] you will see where the default location is for you. @@ -4773,6 +5441,11 @@ Do a trial run with no permanent changes. Use this to see what rclone would do without actually doing it. Useful when setting up the \f[C]sync\f[] command which deletes files in the destination. +.SS \[en]ignore\-case\-sync +.PP +Using this option will cause rclone to ignore the case of the files when +synchronizing so files will not be copied/synced when the existing +filenames are the same, even if the casing is different. .SS \[en]ignore\-checksum .PP Normally rclone will check that the checksums of transferred files @@ -4951,6 +5624,56 @@ if you are reading and writing to an OS X filing system this will be \f[C]1s\f[] by default. .PP This command line flag allows you to override that computed default. +.SS \[en]multi\-thread\-cutoff=SIZE +.PP +When downloading files to the local backend above this size, rclone will +use multiple threads to download the file. +(default 250M) +.PP +Rclone preallocates the file (using +\f[C]fallocate(FALLOC_FL_KEEP_SIZE)\f[] on unix or +\f[C]NTSetInformationFile\f[] on Windows both of which takes no time) +then each thread writes directly into the file at the correct place. +This means that rclone won't create fragmented or sparse files and there +won't be any assembly time at the end of the transfer. +.PP +The number of threads used to dowload is controlled by +\f[C]\-\-multi\-thread\-streams\f[]. +.PP +Use \f[C]\-vv\f[] if you wish to see info about the threads. +.PP +This will work with the \f[C]sync\f[]/\f[C]copy\f[]/\f[C]move\f[] +commands and friends \f[C]copyto\f[]/\f[C]moveto\f[]. +Multi thread downloads will be used with \f[C]rclone\ mount\f[] and +\f[C]rclone\ serve\f[] if \f[C]\-\-vfs\-cache\-mode\f[] is set to +\f[C]writes\f[] or above. +.PP +\f[B]NB\f[] that this \f[B]only\f[] works for a local destination but +will work with any source. +.SS \[en]multi\-thread\-streams=N +.PP +When using multi thread downloads (see above +\f[C]\-\-multi\-thread\-cutoff\f[]) this sets the maximum number of +streams to use. +Set to \f[C]0\f[] to disable multi thread downloads. +(Default 4) +.PP +Exactly how many streams rclone uses for the download depends on the +size of the file. +To calculate the number of download streams Rclone divides the size of +the file by the \f[C]\-\-multi\-thread\-cutoff\f[] and rounds up, up to +the maximum set with \f[C]\-\-multi\-thread\-streams\f[]. +.PP +So if \f[C]\-\-multi\-thread\-cutoff\ 250MB\f[] and +\f[C]\-\-multi\-thread\-streams\ 4\f[] are in effect (the defaults): +.IP \[bu] 2 +0MB.250MB files will be downloaded with 1 stream +.IP \[bu] 2 +250MB..500MB files will be downloaded with 2 streams +.IP \[bu] 2 +500MB..750MB files will be downloaded with 3 streams +.IP \[bu] 2 +750MB+ files will be downloaded with 4 streams .SS \[en]no\-gzip\-encoding .PP Don't set \f[C]Accept\-Encoding:\ gzip\f[]. @@ -5080,6 +5803,18 @@ See the Logging section for more info on log levels. .PP When this is specified, rclone condenses the stats into a single line showing the most important stats only. +.SS \[en]stats\-one\-line\-date +.PP +When this is specified, rclone enables the single\-line stats and +prepends the display with a date string. +The default is \f[C]2006/01/02\ 15:04:05\ \-\f[] +.SS \[en]stats\-one\-line\-date\-format +.PP +When this is specified, rclone enables the single\-line stats and +prepends the display with a user\-supplied date string. +The date string MUST be enclosed in quotes. +Follow golang specs (https://golang.org/pkg/time/#Time.Format) for date +formatting syntax. .SS \[en]stats\-unit=bits|bytes .PP By default, data transfer rates will be printed in bytes/second. @@ -6517,6 +7252,12 @@ that is opened will have the authorization in the URL in the \f[C]http://user:pass\@localhost/\f[] style. .PP Default Off. +.SS \[en]rc\-job\-expire\-duration=DURATION +.PP +Expire finished async jobs older than DURATION (default 60s). +.SS \[en]rc\-job\-expire\-interval=DURATION +.PP +Interval duration to check for expired async jobs (default 10s). .SS \[en]rc\-no\-auth .PP By default rclone will require authorisation to have been set up on the @@ -6702,8 +7443,6 @@ This takes the following parameters .IP \[bu] 2 name \- name of remote .IP \[bu] 2 -type \- type of new remote -.IP \[bu] 2 type \- type of the new remote .PP See the config create @@ -6754,8 +7493,6 @@ Authentication is required for this call. This takes the following parameters .IP \[bu] 2 name \- name of remote -.IP \[bu] 2 -type \- type of new remote .PP See the config password command (https://rclone.org/commands/rclone_config_password/) command @@ -6777,8 +7514,6 @@ Authentication is required for this call. This takes the following parameters .IP \[bu] 2 name \- name of remote -.IP \[bu] 2 -type \- type of new remote .PP See the config update command (https://rclone.org/commands/rclone_config_update/) command for @@ -6910,11 +7645,12 @@ output of the job as would have been returned if called synchronously This takes the following parameters .IP \[bu] 2 fs \- a remote name string eg \[lq]drive:\[rq] -.IP \[bu] 2 -remote \- a path within that remote eg \[lq]dir\[rq] .PP The result is as returned from rclone about \[en]json .PP +See the about command (https://rclone.org/commands/rclone_size/) command +for more information on the above. +.PP Authentication is required for this call. .SS operations/cleanup: Remove trashed files in the remote or path .PP @@ -6979,6 +7715,69 @@ command (https://rclone.org/commands/rclone_deletefile/) command for more information on the above. .PP Authentication is required for this call. +.SS operations/fsinfo: Return information about the remote +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.PP +This returns info about the remote passed in; +.IP +.nf +\f[C] +{ +\ \ \ \ //\ optional\ features\ and\ whether\ they\ are\ available\ or\ not +\ \ \ \ "Features":\ { +\ \ \ \ \ \ \ \ "About":\ true, +\ \ \ \ \ \ \ \ "BucketBased":\ false, +\ \ \ \ \ \ \ \ "CanHaveEmptyDirectories":\ true, +\ \ \ \ \ \ \ \ "CaseInsensitive":\ false, +\ \ \ \ \ \ \ \ "ChangeNotify":\ false, +\ \ \ \ \ \ \ \ "CleanUp":\ false, +\ \ \ \ \ \ \ \ "Copy":\ false, +\ \ \ \ \ \ \ \ "DirCacheFlush":\ false, +\ \ \ \ \ \ \ \ "DirMove":\ true, +\ \ \ \ \ \ \ \ "DuplicateFiles":\ false, +\ \ \ \ \ \ \ \ "GetTier":\ false, +\ \ \ \ \ \ \ \ "ListR":\ false, +\ \ \ \ \ \ \ \ "MergeDirs":\ false, +\ \ \ \ \ \ \ \ "Move":\ true, +\ \ \ \ \ \ \ \ "OpenWriterAt":\ true, +\ \ \ \ \ \ \ \ "PublicLink":\ false, +\ \ \ \ \ \ \ \ "Purge":\ true, +\ \ \ \ \ \ \ \ "PutStream":\ true, +\ \ \ \ \ \ \ \ "PutUnchecked":\ false, +\ \ \ \ \ \ \ \ "ReadMimeType":\ false, +\ \ \ \ \ \ \ \ "ServerSideAcrossConfigs":\ false, +\ \ \ \ \ \ \ \ "SetTier":\ false, +\ \ \ \ \ \ \ \ "SetWrapper":\ false, +\ \ \ \ \ \ \ \ "UnWrap":\ false, +\ \ \ \ \ \ \ \ "WrapFs":\ false, +\ \ \ \ \ \ \ \ "WriteMimeType":\ false +\ \ \ \ }, +\ \ \ \ //\ Names\ of\ hashes\ available +\ \ \ \ "Hashes":\ [ +\ \ \ \ \ \ \ \ "MD5", +\ \ \ \ \ \ \ \ "SHA\-1", +\ \ \ \ \ \ \ \ "DropboxHash", +\ \ \ \ \ \ \ \ "QuickXorHash" +\ \ \ \ ], +\ \ \ \ "Name":\ "local",\ \ \ \ //\ Name\ as\ created +\ \ \ \ "Precision":\ 1,\ \ \ \ \ //\ Precision\ of\ timestamps\ in\ ns +\ \ \ \ "Root":\ "/",\ \ \ \ \ \ \ \ //\ Path\ as\ created +\ \ \ \ "String":\ "Local\ file\ system\ at\ /"\ //\ how\ the\ remote\ will\ appear\ in\ logs +} +\f[] +.fi +.PP +This command does not have a command line equivalent so use this +instead: +.IP +.nf +\f[C] +rclone\ rc\ \-\-loopback\ operations/fsinfo\ fs=remote: +\f[] +.fi .SS operations/list: List the given remote and path in JSON format .PP This takes the following parameters @@ -7009,7 +7808,8 @@ list This is an array of objects as described in the lsjson command .RE .PP -See the lsjson command for more information on the above and examples. +See the lsjson command (https://rclone.org/commands/rclone_lsjson/) for +more information on the above and examples. .PP Authentication is required for this call. .SS operations/mkdir: Make a destination directory or container @@ -8034,7 +8834,7 @@ Backblaze B2 T}@T{ No T}@T{ -No +Yes T}@T{ No T}@T{ @@ -8229,7 +9029,7 @@ Yes T}@T{ Yes T}@T{ -No +Yes T}@T{ No T}@T{ @@ -8384,7 +9184,7 @@ Yes T}@T{ No #2178 (https://github.com/ncw/rclone/issues/2178) T}@T{ -No +Yes T} T{ WebDAV @@ -8570,7 +9370,7 @@ n/s/q>\ n name>\ remote Type\ of\ storage\ to\ configure. Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Alias\ for\ a\ existing\ remote +\ 1\ /\ Alias\ for\ an\ existing\ remote \ \ \ \\\ "alias" \ 2\ /\ Amazon\ Drive \ \ \ \\\ "amazon\ cloud\ drive" @@ -8671,7 +9471,7 @@ rclone\ copy\ /home/source\ remote:source .fi .SS Standard Options .PP -Here are the standard options specific to alias (Alias for a existing +Here are the standard options specific to alias (Alias for an existing remote). .SS \[en]alias\-remote .PP @@ -9098,7 +9898,7 @@ n/s/q>\ n name>\ remote Type\ of\ storage\ to\ configure. Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Alias\ for\ a\ existing\ remote +\ 1\ /\ Alias\ for\ an\ existing\ remote \ \ \ \\\ "alias" \ 2\ /\ Amazon\ Drive \ \ \ \\\ "amazon\ cloud\ drive" @@ -9309,6 +10109,15 @@ last uploaded. The modified time is stored as metadata on the object as \f[C]X\-Amz\-Meta\-Mtime\f[] as floating point since the epoch accurate to 1 ns. +.PP +If the modification time needs to be updated rclone will attempt to +perform a server side copy to update the modification if the object can +be copied in a single part. +.PD 0 +.P +.PD +In the case the object is larger than 5Gb or is in Glacier or Glacier +Deep Archive storage the object will be uploaded rather than copied. .SS Multipart uploads .PP rclone supports multipart uploads with S3 which means that it can upload @@ -9489,6 +10298,9 @@ error like below. In this case you need to restore (http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) the object(s) in question before using rclone. +.PP +Note that rclone only speaks the S3 API it does not speak the Glacier +Vault API, so rclone cannot directly access Glacier Vaults. .SS Standard Options .PP Here are the standard options specific to s3 (Amazon S3 Compliant @@ -10200,6 +11012,12 @@ Wasabi US East endpoint .IP \[bu] 2 Wasabi US West endpoint .RE +.IP \[bu] 2 +\[lq]s3.eu\-central\-1.wasabisys.com\[rq] +.RS 2 +.IP \[bu] 2 +Wasabi EU Central endpoint +.RE .RE .SS \[en]s3\-location\-constraint .PP @@ -10959,6 +11777,20 @@ Env Var: RCLONE_S3_V2_AUTH Type: bool .IP \[bu] 2 Default: false +.SS \[en]s3\-use\-accelerate\-endpoint +.PP +If true use the AWS S3 accelerated endpoint. +.PP +See: AWS S3 Transfer +acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) +.IP \[bu] 2 +Config: use_accelerate_endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS Anonymous access to public buckets .PP If you want to use rclone to access a public bucket, configure with a @@ -11178,7 +12010,7 @@ Select \[lq]s3\[rq] storage. .nf \f[C] Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ \ \ \ 1\ /\ Alias\ for\ a\ existing\ remote +\ \ \ \ 1\ /\ Alias\ for\ an\ existing\ remote \ \ \ \ \\\ "alias" \ \ \ \ 2\ /\ Amazon\ Drive \ \ \ \ \\\ "amazon\ cloud\ drive" @@ -11840,10 +12672,9 @@ The modified time is stored as metadata on the object as 1970\-01\-01 in the Backblaze standard. Other tools should be able to use this as a modified time. .PP -Modified times are used in syncing and are fully supported except in the -case of updating a modification time on an existing object. -In this case the object will be uploaded again as B2 doesn't have an API -method to set the modification time independent of doing an upload. +Modified times are used in syncing and are fully supported. +Note that if a modification time needs to be updated on an object then +it will create a new version of the object. .SS SHA1 checksums .PP The SHA1 checksums of the files are checked on upload and download and @@ -11896,6 +12727,11 @@ file instead of hiding it. Old versions of files, where available, are visible using the \f[C]\-\-b2\-versions\f[] flag. .PP +\f[B]NB\f[] Note that \f[C]\-\-b2\-versions\f[] does not work with crypt +at the moment #1627 (https://github.com/ncw/rclone/issues/1627). +Using \[en]backup\-dir (/docs/#backup-dir-dir) with rclone is the +recommended way of working around this. +.PP If you wish to remove all the old versions then you can use the \f[C]rclone\ cleanup\ remote:bucket\f[] command which will delete all the old versions of files, leaving the current ones intact. @@ -13021,7 +13857,7 @@ Env Var: RCLONE_CACHE_DB_PATH .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: \[lq]/home/ncw/.cache/rclone/cache\-backend\[rq] +Default: \[lq]$HOME/.cache/rclone/cache\-backend\[rq] .SS \[en]cache\-chunk\-path .PP Directory to cache chunk files. @@ -13041,7 +13877,7 @@ Env Var: RCLONE_CACHE_CHUNK_PATH .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: \[lq]/home/ncw/.cache/rclone/cache\-backend\[rq] +Default: \[lq]$HOME/.cache/rclone/cache\-backend\[rq] .SS \[en]cache\-db\-purge .PP Clear all the cached data for this remote on start. @@ -14055,45 +14891,27 @@ q)\ Quit\ config n/r/c/s/q>\ n name>\ remote Type\ of\ storage\ to\ configure. +Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Amazon\ Drive -\ \ \ \\\ "amazon\ cloud\ drive" -\ 2\ /\ Amazon\ S3\ (also\ Dreamhost,\ Ceph,\ Minio) -\ \ \ \\\ "s3" -\ 3\ /\ Backblaze\ B2 -\ \ \ \\\ "b2" -\ 4\ /\ Dropbox -\ \ \ \\\ "dropbox" -\ 5\ /\ Encrypt/Decrypt\ a\ remote -\ \ \ \\\ "crypt" -\ 6\ /\ FTP\ Connection\ +[snip] +10\ /\ FTP\ Connection \ \ \ \\\ "ftp" -\ 7\ /\ Google\ Cloud\ Storage\ (this\ is\ not\ Google\ Drive) -\ \ \ \\\ "google\ cloud\ storage" -\ 8\ /\ Google\ Drive -\ \ \ \\\ "drive" -\ 9\ /\ Hubic -\ \ \ \\\ "hubic" -10\ /\ Local\ Disk -\ \ \ \\\ "local" -11\ /\ Microsoft\ OneDrive -\ \ \ \\\ "onedrive" -12\ /\ Openstack\ Swift\ (Rackspace\ Cloud\ Files,\ Memset\ Memstore,\ OVH) -\ \ \ \\\ "swift" -13\ /\ SSH/SFTP\ Connection -\ \ \ \\\ "sftp" -14\ /\ Yandex\ Disk -\ \ \ \\\ "yandex" +[snip] Storage>\ ftp +**\ See\ help\ for\ ftp\ backend\ at:\ https://rclone.org/ftp/\ ** + FTP\ host\ to\ connect\ to +Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value \ 1\ /\ Connect\ to\ ftp.example.com \ \ \ \\\ "ftp.example.com" host>\ ftp.example.com FTP\ username,\ leave\ blank\ for\ current\ username,\ ncw -user> +Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). +user>\ FTP\ port,\ leave\ blank\ to\ use\ default\ (21) -port> +Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). +port>\ FTP\ password y)\ Yes\ type\ in\ my\ own\ password g)\ Generate\ random\ password @@ -14102,12 +14920,14 @@ Enter\ the\ password: password: Confirm\ the\ password: password: +Use\ FTP\ over\ TLS\ (Implicit) +Enter\ a\ boolean\ value\ (true\ or\ false).\ Press\ Enter\ for\ the\ default\ ("false"). +tls>\ Remote\ config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] +type\ =\ ftp host\ =\ ftp.example.com -user\ =\ -port\ = pass\ =\ ***\ ENCRYPTED\ *** \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y)\ Yes\ this\ is\ OK @@ -14158,6 +14978,12 @@ Any times you see on the server will be time of upload. .SS Checksums .PP FTP does not support any checksums. +.SS Implicit TLS +.PP +FTP supports implicit FTP over TLS servers (FTPS). +This has to be enabled in the config for the remote. +The default FTPS port is \f[C]990\f[] so the port will likely have to be +explictly set in the config for the remote. .SS Standard Options .PP Here are the standard options specific to ftp (FTP Connection). @@ -14184,7 +15010,7 @@ Connect to ftp.example.com .RE .SS \[en]ftp\-user .PP -FTP username, leave blank for current username, ncw +FTP username, leave blank for current username, $USER .IP \[bu] 2 Config: user .IP \[bu] 2 @@ -14215,6 +15041,17 @@ Env Var: RCLONE_FTP_PASS Type: string .IP \[bu] 2 Default: "" +.SS \[en]ftp\-tls +.PP +Use FTP over TLS (Implicit) +.IP \[bu] 2 +Config: tls +.IP \[bu] 2 +Env Var: RCLONE_FTP_TLS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS Advanced Options .PP Here are the advanced options specific to ftp (FTP Connection). @@ -14229,6 +15066,17 @@ Env Var: RCLONE_FTP_CONCURRENCY Type: int .IP \[bu] 2 Default: 0 +.SS \[en]ftp\-no\-check\-certificate +.PP +Do not verify the TLS certificate of the server +.IP \[bu] 2 +Config: no_check_certificate +.IP \[bu] 2 +Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS Limitations .PP Note that since FTP isn't HTTP based the following flags don't work with @@ -14244,6 +15092,9 @@ FTP could support server side move but doesn't yet. .PP Note that the ftp backend does not support the \f[C]ftp_proxy\f[] environment variable yet. +.PP +Note that while implicit FTP over TLS is supported, explicit FTP over +TLS is not. .SS Google Cloud Storage .PP Paths are specified as \f[C]remote:bucket\f[] (or \f[C]remote:\f[] for @@ -15305,6 +16156,11 @@ If you wish to empty your trash you can use the \f[C]rclone\ cleanup\ remote:\f[] command which will permanently delete all your trashed files. This command does not take any path arguments. +.PP +Note that Google Drive takes some time (minutes to days) to empty the +trash even though the command returns within a few seconds. +No output is echoed, so there will be no confirmation even using \-v or +\-vv. .SS Quota information .PP To view your current quota you can use the @@ -15335,7 +16191,7 @@ Note that rclone adds the extension to the google doc, so if it is called \f[C]My\ Spreadsheet\f[] on google docs, it will be exported as \f[C]My\ Spreadsheet.xlsx\f[] or \f[C]My\ Spreadsheet.pdf\f[] etc. .PP -When importing files into Google Drive, rclone will conververt all files +When importing files into Google Drive, rclone will convert all files with an extension in \f[C]\-\-drive\-import\-formats\f[] to their associated document type. rclone will not convert any files by default, since the conversion is @@ -16053,6 +16909,20 @@ Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER Type: bool .IP \[bu] 2 Default: false +.SS \[en]drive\-size\-as\-quota +.PP +Show storage quota usage for file size. +.PP +The storage used by a file is the size of the current version plus any +older versions that have been set to keep forever. +.IP \[bu] 2 +Config: size_as_quota +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS \[en]drive\-v2\-download\-min\-size .PP If Object's are greater, use drive v2 API to download. @@ -16086,6 +16956,23 @@ Env Var: RCLONE_DRIVE_PACER_BURST Type: int .IP \[bu] 2 Default: 100 +.SS \[en]drive\-server\-side\-across\-configs +.PP +Allow server side operations (eg copy) to work across different drive +configs. +.PP +This can be useful if you wish to do a server side copy between two +different Google drives. +Note that this isn't enabled by default because it isn't easy to tell if +it will work beween any two configurations. +.IP \[bu] 2 +Config: server_side_across_configs +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS Limitations .PP Drive has quite a lot of rate limiting. @@ -16628,26 +17515,20 @@ n)\ New\ remote s)\ Set\ configuration\ password q)\ Quit\ config n/s/q>\ n -name>\ remote +name>\ jotta Type\ of\ storage\ to\ configure. Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value [snip] -13\ /\ JottaCloud +14\ /\ JottaCloud \ \ \ \\\ "jottacloud" [snip] Storage>\ jottacloud -User\ Name +**\ See\ help\ for\ jottacloud\ backend\ at:\ https://rclone.org/jottacloud/\ ** + +User\ Name: Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). -user>\ user -The\ mountpoint\ to\ use. -Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Will\ be\ synced\ by\ the\ official\ client. -\ \ \ \\\ "Sync" -\ 2\ /\ Archive -\ \ \ \\\ "Archive" -mountpoint>\ Archive +user>\ user\@email.tld Edit\ advanced\ config?\ (y/n) y)\ Yes n)\ No @@ -16661,16 +17542,35 @@ Rclone\ has\ it\[aq]s\ own\ Jottacloud\ API\ KEY\ which\ works\ fine\ as\ long\ y)\ Yes n)\ No y/n>\ y -Your\ Jottacloud\ password\ is\ only\ required\ during\ config\ and\ will\ not\ be\ stored. +Your\ Jottacloud\ password\ is\ only\ required\ during\ setup\ and\ will\ not\ be\ stored. password: + +Do\ you\ want\ to\ use\ a\ non\ standard\ device/mountpoint\ e.g.\ for\ accessing\ files\ uploaded\ using\ the\ official\ Jottacloud\ client? + +y)\ Yes +n)\ No +y/n>\ y +Please\ select\ the\ device\ to\ use.\ Normally\ this\ will\ be\ Jotta +Choose\ a\ number\ from\ below,\ or\ type\ in\ an\ existing\ value +\ 1\ >\ DESKTOP\-3H31129 +\ 2\ >\ test1 +\ 3\ >\ Jotta +Devices>\ 3 +Please\ select\ the\ mountpoint\ to\ user.\ Normally\ this\ will\ be\ Archive +Choose\ a\ number\ from\ below,\ or\ type\ in\ an\ existing\ value +\ 1\ >\ Archive +\ 2\ >\ Shared +\ 3\ >\ Sync +Mountpoints>\ 1 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -[remote] +[jotta] type\ =\ jottacloud -user\ =\ olihey -mountpoint\ =\ Archive +user\ =\ 0xC4KE\@gmail.com client_id\ =\ ..... client_secret\ =\ ........ token\ =\ {........} +device\ =\ Jotta +mountpoint\ =\ Archive \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y)\ Yes\ this\ is\ OK e)\ Edit\ this\ remote @@ -16704,6 +17604,17 @@ To copy a local directory to an Jottacloud directory called backup rclone\ copy\ /home/source\ remote:backup \f[] .fi +.SS Devices and Mountpoints +.PP +The official Jottacloud client registers a device for each computer you +install it on and then creates a mountpoint for each folder you select +for Backup. +The web interface uses a special device called Jotta for the Archive, +Sync and Shared mountpoints. +In most cases you'll want to use the Jotta/Archive device/mounpoint +however if you want to access files uploaded by the official rclone +provides the option to select other devices and mountpoints during +config. .SS \[en]fast\-list .PP This remote supports \f[C]\-\-fast\-list\f[] which allows you to use @@ -16772,33 +17683,6 @@ Env Var: RCLONE_JOTTACLOUD_USER Type: string .IP \[bu] 2 Default: "" -.SS \[en]jottacloud\-mountpoint -.PP -The mountpoint to use. -.IP \[bu] 2 -Config: mountpoint -.IP \[bu] 2 -Env Var: RCLONE_JOTTACLOUD_MOUNTPOINT -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]Sync\[rq] -.RS 2 -.IP \[bu] 2 -Will be synced by the official client. -.RE -.IP \[bu] 2 -\[lq]Archive\[rq] -.RS 2 -.IP \[bu] 2 -Archive -.RE -.RE .SS Advanced Options .PP Here are the advanced options specific to jottacloud (JottaCloud). @@ -16906,7 +17790,7 @@ Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value \ 1\ /\ A\ stackable\ unification\ remote,\ which\ can\ appear\ to\ merge\ the\ contents\ of\ several\ remotes \ \ \ \\\ "union" -\ 2\ /\ Alias\ for\ a\ existing\ remote +\ 2\ /\ Alias\ for\ an\ existing\ remote \ \ \ \\\ "alias" \ 3\ /\ Amazon\ Drive \ \ \ \\\ "amazon\ cloud\ drive" @@ -17113,7 +17997,7 @@ n/s/q>\ n name>\ remote Type\ of\ storage\ to\ configure. Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Alias\ for\ a\ existing\ remote +\ 1\ /\ Alias\ for\ an\ existing\ remote \ \ \ \\\ "alias" [snip] 14\ /\ Mega @@ -17188,6 +18072,55 @@ Duplicated files cause problems with the syncing and you will see messages in the log about duplicates. .PP Use \f[C]rclone\ dedupe\f[] to fix duplicated files. +.SS Failure to log\-in +.PP +Mega remotes seem to get blocked (reject logins) under \[lq]heavy +use\[rq]. +We haven't worked out the exact blocking rules but it seems to be +related to fast paced, sucessive rclone commands. +.PP +For example, executing this command 90 times in a row +\f[C]rclone\ link\ remote:file\f[] will cause the remote to become +\[lq]blocked\[rq]. +This is not an abnormal situation, for example if you wish to get the +public links of a directory with hundred of files\&... After more or +less a week, the remote will remote accept rclone logins normally again. +.PP +You can mitigate this issue by mounting the remote it with +\f[C]rclone\ mount\f[]. +This will log\-in when mounting and a log\-out when unmounting only. +You can also run \f[C]rclone\ rcd\f[] and then use \f[C]rclone\ rc\f[] +to run the commands over the API to avoid logging in each time. +.PP +Rclone does not currently close mega sessions (you can see them in the +web interface), however closing the sessions does not solve the issue. +.PP +If you space rclone commands by 3 seconds it will avoid blocking the +remote. +We haven't identified the exact blocking rules, so perhaps one could +execute the command 80 times without waiting and avoid blocking by +waiting 3 seconds, then continuing\&... +.PP +Note that this has been observed by trial and error and might not be set +in stone. +.PP +Other tools seem not to produce this blocking effect, as they use a +different working approach (state\-based, using sessionIDs instead of +log\-in) which isn't compatible with the current stateless rclone +approach. +.PP +Note that once blocked, the use of other tools (such as megacmd) is not +a sure workaround: following megacmd login times have been observed in +sucession for blocked remote: 7 minutes, 20 min, 30min, 30 min, 30min. +Web access looks unaffected though. +.PP +Investigation is continuing in relation to workarounds based on +timeouts, pacers, retrials and tpslimits \- if you discover something +relevant, please post on the forum. +.PP +So, if rclone was working nicely and suddenly you are unable to log\-in +and you are sure the user and the password are correct, likely you have +got the remote blocked for a while. .SS Standard Options .PP Here are the standard options specific to mega (Mega). @@ -17620,10 +18553,10 @@ Type\ of\ storage\ to\ configure. Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value \&... -17\ /\ Microsoft\ OneDrive +18\ /\ Microsoft\ OneDrive \ \ \ \\\ "onedrive" \&... -Storage>\ 17 +Storage>\ 18 Microsoft\ App\ Client\ Id Leave\ blank\ normally. Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). @@ -19344,8 +20277,9 @@ If the path does not begin with a \f[C]/\f[] it is relative to the home directory of the user. An empty path \f[C]remote:\f[] refers to the user's home directory. .PP -Note that some SFTP servers will need the leading \f[C]/\f[] \- Synology -is a good example of this. +"Note that some SFTP servers will need the leading / \- Synology is a +good example of this. +rsync.net, on the other hand, requires users to OMIT the leading /. .PP Here is an example of making an SFTP configuration. First run @@ -19738,6 +20672,14 @@ remote commands is prohibited. Set the configuration option \f[C]disable_hashcheck\f[] to \f[C]true\f[] to disable checksumming. .PP +SFTP also supports \f[C]about\f[] if the same login has shell access and +\f[C]df\f[] are in the remote's PATH. +\f[C]about\f[] will return the total space, free space, and used space +on the remote for the disk of the specified path on the remote or, if +not set, the disk of the root on the remote. +\f[C]about\f[] will fail if it does not have shell access or if +\f[C]df\f[] is not in the remote's PATH. +.PP Note that some SFTP servers (eg Synology) the paths are different for SSH and SFTP so the hashes can't be calculated properly. For them using \f[C]disable_hashcheck\f[] is a good idea. @@ -19816,7 +20758,7 @@ n/s/q>\ n name>\ remote Type\ of\ storage\ to\ configure. Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Alias\ for\ a\ existing\ remote +\ 1\ /\ Alias\ for\ an\ existing\ remote \ \ \ \\\ "alias" \ 2\ /\ Amazon\ Drive \ \ \ \\\ "amazon\ cloud\ drive" @@ -20860,6 +21802,240 @@ Type: bool .IP \[bu] 2 Default: false .SH Changelog +.SS v1.48.0 \- 2019\-06\-15 +.IP \[bu] 2 +New commands +.RS 2 +.IP \[bu] 2 +serve sftp: Serve an rclone remote over SFTP (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +New Features +.RS 2 +.IP \[bu] 2 +Multi threaded downloads to local storage (Nick Craig\-Wood) +.RS 2 +.IP \[bu] 2 +controlled with \f[C]\-\-multi\-thread\-cutoff\f[] and +\f[C]\-\-multi\-thread\-streams\f[] +.RE +.IP \[bu] 2 +Use rclone.conf from rclone executable directory to enable portable use +(albertony) +.IP \[bu] 2 +Allow sync of a file and a directory with the same name (forgems) +.RS 2 +.IP \[bu] 2 +this is common on bucket based remotes, eg s3, gcs +.RE +.IP \[bu] 2 +Add \f[C]\-\-ignore\-case\-sync\f[] for forced case insensitivity +(garry415) +.IP \[bu] 2 +Implement \f[C]\-\-stats\-one\-line\-date\f[] and +\f[C]\-\-stats\-one\-line\-date\-format\f[] (Peter Berbec) +.IP \[bu] 2 +Log an ERROR for all commands which exit with non\-zero status (Nick +Craig\-Wood) +.IP \[bu] 2 +Use go\-homedir to read the home directory more reliably (Nick +Craig\-Wood) +.IP \[bu] 2 +Enable creating encrypted config through external script invocation +(Wojciech Smigielski) +.IP \[bu] 2 +build: Drop support for go1.8 (Nick Craig\-Wood) +.IP \[bu] 2 +config: Make config create/update encrypt passwords where necessary +(Nick Craig\-Wood) +.IP \[bu] 2 +copyurl: Honor \f[C]\-\-no\-check\-certificate\f[] (Stefan Breunig) +.IP \[bu] 2 +install: Linux skip man pages if no mandb (didil) +.IP \[bu] 2 +lsf: Support showing the Tier of the object (Nick Craig\-Wood) +.IP \[bu] 2 +lsjson +.RS 2 +.IP \[bu] 2 +Added EncryptedPath to output (calisro) +.IP \[bu] 2 +Support showing the Tier of the object (Nick Craig\-Wood) +.IP \[bu] 2 +Add IsBucket field for bucket based remote listing of the root (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +rc +.RS 2 +.IP \[bu] 2 +Add \f[C]\-\-loopback\f[] flag to run commands directly without a server +(Nick Craig\-Wood) +.IP \[bu] 2 +Add operations/fsinfo: Return information about the remote (Nick +Craig\-Wood) +.IP \[bu] 2 +Skip auth for OPTIONS request (Nick Craig\-Wood) +.IP \[bu] 2 +cmd/providers: Add DefaultStr, ValueStr and Type fields (Nick +Craig\-Wood) +.IP \[bu] 2 +jobs: Make job expiry timeouts configurable (Aleksandar Jankovic) +.RE +.IP \[bu] 2 +serve dlna reworked and improved (Dan Walters) +.IP \[bu] 2 +serve ftp: add \f[C]\-\-ftp\-public\-ip\f[] flag to specify public IP +(calistri) +.IP \[bu] 2 +serve restic: Add support for \f[C]\-\-private\-repos\f[] in +\f[C]serve\ restic\f[] (Florian Apolloner) +.IP \[bu] 2 +serve webdav: Combine serve webdav and serve http (Gary Kim) +.IP \[bu] 2 +size: Ignore negative sizes when calculating total (Garry McNulty) +.RE +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +Make move and copy individual files obey \f[C]\-\-backup\-dir\f[] (Nick +Craig\-Wood) +.IP \[bu] 2 +If \f[C]\-\-ignore\-checksum\f[] is in effect, don't calculate checksum +(Nick Craig\-Wood) +.IP \[bu] 2 +moveto: Fix case\-insensitive same remote move (Gary Kim) +.IP \[bu] 2 +rc: Fix serving bucket based objects with \f[C]\-\-rc\-serve\f[] (Nick +Craig\-Wood) +.IP \[bu] 2 +serve webdav: Fix serveDir not being updated with changes from webdav +(Gary Kim) +.RE +.IP \[bu] 2 +Mount +.RS 2 +.IP \[bu] 2 +Fix poll interval documentation (Animosity022) +.RE +.IP \[bu] 2 +VFS +.RS 2 +.IP \[bu] 2 +Make WriteAt for non cached files work with non\-sequential writes (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +Local +.RS 2 +.IP \[bu] 2 +Only calculate the required hashes for big speedup (Nick Craig\-Wood) +.IP \[bu] 2 +Log errors when listing instead of returning an error (Nick Craig\-Wood) +.IP \[bu] 2 +Fix preallocate warning on Linux with ZFS (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Crypt +.RS 2 +.IP \[bu] 2 +Make rclone dedupe work through crypt (Nick Craig\-Wood) +.IP \[bu] 2 +Fix wrapping of ChangeNotify to decrypt directories properly (Nick +Craig\-Wood) +.IP \[bu] 2 +Support PublicLink (rclone link) of underlying backend (Nick +Craig\-Wood) +.IP \[bu] 2 +Implement Optional methods SetTier, GetTier (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +B2 +.RS 2 +.IP \[bu] 2 +Implement server side copy (Nick Craig\-Wood) +.IP \[bu] 2 +Implement SetModTime (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Drive +.RS 2 +.IP \[bu] 2 +Fix move and copy from TeamDrive to GDrive (Fionera) +.IP \[bu] 2 +Add notes that cleanup works in the background on drive (Nick +Craig\-Wood) +.IP \[bu] 2 +Add \f[C]\-\-drive\-server\-side\-across\-configs\f[] to default back to +old server side copy semantics by default (Nick Craig\-Wood) +.IP \[bu] 2 +Add \f[C]\-\-drive\-size\-as\-quota\f[] to show storage quota usage for +file size (Garry McNulty) +.RE +.IP \[bu] 2 +FTP +.RS 2 +.IP \[bu] 2 +Add FTP List timeout (Jeff Quinn) +.IP \[bu] 2 +Add FTP over TLS support (Gary Kim) +.IP \[bu] 2 +Add \f[C]\-\-ftp\-no\-check\-certificate\f[] option for FTPS (Gary Kim) +.RE +.IP \[bu] 2 +Google Cloud Storage +.RS 2 +.IP \[bu] 2 +Fix upload errors when uploading pre 1970 files (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Jottacloud +.RS 2 +.IP \[bu] 2 +Add support for selecting device and mountpoint. +(buengese) +.RE +.IP \[bu] 2 +Mega +.RS 2 +.IP \[bu] 2 +Add cleanup support (Gary Kim) +.RE +.IP \[bu] 2 +Onedrive +.RS 2 +.IP \[bu] 2 +More accurately check if root is found (Cnly) +.RE +.IP \[bu] 2 +S3 +.RS 2 +.IP \[bu] 2 +Suppport S3 Accelerated endpoints with +\f[C]\-\-s3\-use\-accelerate\-endpoint\f[] (Nick Craig\-Wood) +.IP \[bu] 2 +Add config info for Wasabi's EU Central endpoint (Robert Marko) +.IP \[bu] 2 +Make SetModTime work for GLACIER while syncing (Philip Harvey) +.RE +.IP \[bu] 2 +SFTP +.RS 2 +.IP \[bu] 2 +Add About support (Gary Kim) +.IP \[bu] 2 +Fix about parsing of \f[C]df\f[] results so it can cope with \-ve +results (Nick Craig\-Wood) +.IP \[bu] 2 +Send custom client version and debug server version (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +WebDAV +.RS 2 +.IP \[bu] 2 +Retry on 423 Locked errors (Nick Craig\-Wood) +.RE .SS v1.47.0 \- 2019\-04\-13 .IP \[bu] 2 New backends @@ -25500,6 +26676,22 @@ By default rclone only gets 10,000 files ahead in a sync so as not to use up too much memory. You can change this default with the \[en]max\-backlog (/docs/#max-backlog-n) flag. +.SS Rclone is using too much memory or appears to have a memory leak +.PP +Rclone is written in Go which uses a garbage collector. +The default settings for the garbage collector mean that it runs when +the heap size has doubled. +.PP +However it is possible to tune the garbage collector to use less memory +by setting GOGC (https://dave.cheney.net/tag/gogc) to a lower value, say +\f[C]export\ GOGC=20\f[]. +This will make the garbage collector work harder, reducing memory size +at the expense of CPU usage. +.PP +The most common cause of rclone using lots of memory is a single +directory with thousands or millions of files in. +Rclone has to load this entirely into memory as rclone objects. +Each Rclone object takes 0.5k\-1k of memory. .SS License .PP This is free software under the terms of MIT the license (check the @@ -26020,6 +27212,35 @@ xopez <28950736+xopez@users.noreply.github.com> Ben Boeckel .IP \[bu] 2 Manu +.IP \[bu] 2 +Kyle E. +Mitchell +.IP \[bu] 2 +Gary Kim +.IP \[bu] 2 +Jon +.IP \[bu] 2 +Jeff Quinn +.IP \[bu] 2 +Peter Berbec +.IP \[bu] 2 +didil <1284255+didil@users.noreply.github.com> +.IP \[bu] 2 +id01 +.IP \[bu] 2 +Robert Marko +.IP \[bu] 2 +Philip Harvey <32467456+pharveybattelle@users.noreply.github.com> +.IP \[bu] 2 +JorisE +.IP \[bu] 2 +garry415 +.IP \[bu] 2 +forgems +.IP \[bu] 2 +Florian Apolloner +.IP \[bu] 2 +Aleksandar Jankovic .SH Contact the rclone project .SS Forum .PP