diff --git a/MANUAL.html b/MANUAL.html index b30001a19..738792fb7 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -17,7 +17,7 @@

rclone(1) User Manual

Nick Craig-Wood

-

Mar 31, 2021

+

Apr 26, 2021

Rclone syncs your files to cloud storage

rclone logo

@@ -774,8 +774,8 @@ two-3.txt: renamed from: two.txt

rclone about

Get quota information from the remote.

Synopsis

-

rclone aboutprints quota information about a remote to standard output. The output is typically used, free, quota and trash contents.

-

E.g. Typical output fromrclone about remote:is:

+

rclone about prints quota information about a remote to standard output. The output is typically used, free, quota and trash contents.

+

E.g. Typical output from rclone about remote: is:

Total:   17G
 Used:    7.444G
 Free:    1.315G
@@ -797,7 +797,7 @@ Used:    7993453766
 Free:    1411001220
 Trashed: 104857602
 Other:   8849156022
-

A --jsonflag generates conveniently computer readable output, e.g.

+

A --json flag generates conveniently computer readable output, e.g.

{
     "total": 18253611008,
     "used": 7993453766,
@@ -1066,7 +1066,7 @@ if src is directory
 
Copy url content to dest.

 
Synopsis

 
Download a URL's content and copy it to the destination without saving it in temporary storage.

-
Setting --auto-filenamewill cause the file name to be retrieved from the from URL (after any redirections) and used in the destination path. With --print-filename in addition, the resuling file name will be printed.

+
Setting --auto-filename will cause the file name to be retrieved from the from URL (after any redirections) and used in the destination path. With --print-filename in addition, the resuling file name will be printed.

 
Setting --no-clobber will prevent overwriting file on the destination if there is one with the same name.

 
Setting --stdout or making the output file name - will cause the output to be written to standard output.

 
rclone copyurl https://example.com dest:path [flags]

@@ -1475,7 +1475,7 @@ rclone mount remote:path/to/files * --volname \\cloud\remote

The permissions on each entry will be set according to options --dir-perms and --file-perms, which takes a value in traditional numeric notation, where the default corresponds to --file-perms 0666 --dir-perms 0777.

Note that the mapping of permissions is not always trivial, and the result you see in Windows Explorer may not be exactly like you expected. For example, when setting a value that includes write access, this will be mapped to individual permissions "write attributes", "write data" and "append data", but not "write extended attributes". Windows will then show this as basic permission "Special" instead of "Write", because "Write" includes the "write extended attributes" permission.

If you set POSIX permissions for only allowing access to the owner, using --file-perms 0600 --dir-perms 0700, the user group and the built-in "Everyone" group will still be given some special permissions, such as "read attributes" and "read permissions", in Windows. This is done for compatibility reasons, e.g. to allow users without additional permissions to be able to read basic metadata about files like in UNIX. One case that may arise is that other programs (incorrectly) interprets this as the file being accessible by everyone. For example an SSH client may warn about "unprotected private key file".

-

WinFsp 2021 (version 1.9, still in beta) introduces a new FUSE option "FileSecurity", that allows the complete specification of file security descriptors using SDDL. With this you can work around issues such as the mentioned "unprotected private key file" by specifying -o FileSecurity="D:P(A;;FA;;;OW)", for file all access (FA) to the owner (OW).

+

WinFsp 2021 (version 1.9) introduces a new FUSE option "FileSecurity", that allows the complete specification of file security descriptors using SDDL. With this you can work around issues such as the mentioned "unprotected private key file" by specifying -o FileSecurity="D:P(A;;FA;;;OW)", for file all access (FA) to the owner (OW).

Windows caveats

Note that drives created as Administrator are not visible by other accounts (including the account that was elevated as Administrator). So if you start a Windows drive from an Administrative Command Prompt and then try to access the same drive from Explorer (which does not run as Administrator), you will not be able to see the new drive.

The easiest way around this is to start the drive from a normal command prompt. It is also possible to start a drive from the SYSTEM account (using the WinFsp.Launcher infrastructure) which creates drives accessible for everyone on the system or alternatively using the nssm service manager.

@@ -1805,7 +1805,7 @@ ffmpeg - | rclone rcat remote:path/to/file

This command downloads the latest release of rclone and replaces the currently running binary. The download is verified with a hashsum and cryptographically signed signature.

If used without flags (or with implied --stable flag), this command will install the latest stable release. However, some issues may be fixed (or features added) only in the latest beta release. In such cases you should run the command with the --beta flag, i.e. rclone selfupdate --beta. You can check in advance what version would be installed by adding the --check flag, then repeat the command without it when you are satisfied.

Sometimes the rclone team may recommend you a concrete beta or stable rclone release to troubleshoot your issue or add a bleeding edge feature. The --version VER flag, if given, will update to the concrete version instead of the latest one. If you omit micro version from VER (for example 1.53), the latest matching micro version will be used.

-

Upon successful update rclone will print a message that contains a previous version number. You will need it if you later decide to revert your update for some reason. Then you'll have to note the previous version and run the following command: rclone selfupdate [--beta] OLDVER. If the old version contains only dots and digits (for example v1.54.0) then it's a stable release so you won't need the --beta flag. Beta releases have an additional information similar to v1.54.0-beta.5111.06f1c0c61. (if you are a developer and use a locally built rclone, the version number will end with -DEV, you will have to rebuild it as it obvisously can't be distributed).

+

Upon successful update rclone will print a message that contains a previous version number. You will need it if you later decide to revert your update for some reason. Then you'll have to note the previous version and run the following command: rclone selfupdate [--beta] OLDVER. If the old version contains only dots and digits (for example v1.54.0) then it's a stable release so you won't need the --beta flag. Beta releases have an additional information similar to v1.54.0-beta.5111.06f1c0c61. (if you are a developer and use a locally built rclone, the version number will end with -DEV, you will have to rebuild it as it obviously can't be distributed).

If you previously installed rclone via a package manager, the package may include local documentation or configure services. You may wish to update with the flag --package deb or --package rpm (whichever is correct for your OS) to update these too. This command with the default --package zip will update only the rclone executable so the local manual may become inaccurate after it.

The rclone mount command (https://rclone.org/commands/rclone_mount/) may or may not support extended FUSE options depending on the build and OS. selfupdate will refuse to update if the capability would be discarded.

Note: Windows forbids deletion of a currently running executable so this command will rename the old executable to 'rclone.old.exe' upon success.

@@ -3378,7 +3378,7 @@ rclone sync -i /path/to/files remote:current-backup

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.

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.

-

Use this flag to override the config location, e.g. rclone --config=".myconfig" .config.

+

Use this flag to override the config location, e.g. rclone --config=".myconfig" config.

If the location is set to empty string "" or the special value /notfound, or the os null device represented by value NUL on Windows and /dev/null on Unix systems, then rclone will keep the config file in memory only.

The file format is basic INI: Sections of text, led by a [section] header and followed by key=value entries on separate lines. In rclone each remote is represented by its own section, where the section name defines the name of the remote. Options are specified as the key=value entries, where the key is the option name without the --backend- prefix, in lowercase and with _ instead of -. E.g. option --mega-hard-delete corresponds to key hard_delete. Only backend options can be specified. A special, and required, key type identifies the storage system, where the value is the internal lowercase name as returned by command rclone help backends. Comments are indicated by ; or # at the beginning of a line.

Example:

@@ -3929,7 +3929,7 @@ $ rclone lsd MYS3: $ rclone listremotes | grep mys3 mys3:

Note that if you want to create a remote using environment variables you must create the ..._TYPE variable as above.

-

Note also that now rclone has connectionstrings, it is probably easier to use those instead which makes the above example

+

Note also that now rclone has connection strings, it is probably easier to use those instead which makes the above example

rclone lsd :s3,access_key_id=XXX,secret_access_key=XXX:

Precedence

The various different methods of backend configuration are read in this order and the first one with a value is used.

@@ -6806,7 +6806,7 @@ Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total --use-json-log Use json log format. --use-mmap Use mmap allocator (see docs). --use-server-modtime Use server modified time instead of object metadata - --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.55.0") + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.55.1") -v, --verbose count Print lots more stuff (repeat for more)

Backend Flags

These flags are available for every command. They control the backends and may be set in the config file.

@@ -20355,6 +20355,65 @@ $ tree /tmp/b
  • "error": return an error based on option value

    • Changelog

    +

    v1.55.1 - 2021-04-26

    +

    See commits

    +

    v1.55.0 - 2021-03-31

    See commits