diff --git a/MANUAL.html b/MANUAL.html index 4c0d99e61..1e3c162e2 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -19,7 +19,7 @@

rclone(1) User Manual

Nick Craig-Wood

-

Jul 09, 2022

+

Aug 08, 2022

Rclone syncs your files to cloud storage

rclone logo

@@ -300,7 +300,7 @@ go build

Run the config paths command to see the locations that rclone will use.

To override them set the corresponding options (as command-line arguments, or as environment variables): - --config - --cache-dir - --temp-dir

Autostart

-

After installing and configuring rclone, as described above, you are ready to use rclone as an interactive command line utility. If your goal is to perform periodic operations, such as a regular sync, you will probably want to configure your rclone command in your operating system's scheduler. If you need to expose service-like features, such as remote control, GUI, serve or mount, you will often want an rclone command always running in the background, and configuring it to run in a service infrastructure may be a better option. Below are some alternatives on how to achieve this on different operating systems.

+

After installing and configuring rclone, as described above, you are ready to use rclone as an interactive command line utility. If your goal is to perform periodic operations, such as a regular sync, you will probably want to configure your rclone command in your operating system's scheduler. If you need to expose service-like features, such as remote control, GUI, serve or mount, you will often want an rclone command always running in the background, and configuring it to run in a service infrastructure may be a better option. Below are some alternatives on how to achieve this on different operating systems.

NOTE: Before setting up autorun it is highly recommended that you have tested your command manually from a Command Prompt first.

Autostart on Windows

The most relevant alternatives for autostart on Windows are: - Run at user log on using the Startup folder - Run at user log on, at system startup or at schedule using Task Scheduler - Run at system startup using Windows service

@@ -309,7 +309,7 @@ go build

Example command to run a sync in background:

c:\rclone\rclone.exe sync c:\files remote:/files --no-console --log-file c:\rclone\logs\sync_files.txt

User account

-

As mentioned in the mount documentation, mounted drives created as Administrator are not visible to other accounts, not even the account that was elevated as Administrator. By running the mount command as the built-in SYSTEM user account, it will create drives accessible for everyone on the system. Both scheduled task and Windows service can be used to achieve this.

+

As mentioned in the mount documentation, mounted drives created as Administrator are not visible to other accounts, not even the account that was elevated as Administrator. By running the mount command as the built-in SYSTEM user account, it will create drives accessible for everyone on the system. Both scheduled task and Windows service can be used to achieve this.

NOTE: Remember that when rclone runs as the SYSTEM user, the user profile that it sees will not be yours. This means that if you normally run rclone with configuration file in the default location, to be able to use the same configuration when running as the system user you must explicitely tell rclone where to find it with the --config option, or else it will look in the system users profile path (C:\Windows\System32\config\systemprofile). To test your command manually from a Command Prompt, you can run it with the PsExec utility from Microsoft's Sysinternals suite, which takes option -s to execute commands as the SYSTEM user.

Start from Startup folder

To quickly execute an rclone command you can simply create a standard Windows Explorer shortcut for the complete rclone command you want to run. If you store this shortcut in the special "Startup" start-menu folder, Windows will automatically run it at login. To open this folder in Windows Explorer, enter path %APPDATA%\Microsoft\Windows\Start Menu\Programs\Startup, or C:\ProgramData\Microsoft\Windows\Start Menu\Programs\StartUp if you want the command to start for every user that logs in.

@@ -469,6 +469,7 @@ destpath/sourcepath/two.txt

Note that files in the destination won't be deleted if there were any errors at any point. Duplicate objects (files with the same name, on those providers that support it) are also not yet handled.

It is always the contents of the directory that is synced, not the directory itself. So when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents. See extended explanation in the copy command if unsure.

If dest:path doesn't exist, it is created and the source:path contents go there.

+

It is not possible to sync overlapping remotes. However, you may exclude the destination from the sync with a filter rule or by putting an exclude-if-present file inside the destination directory and sync to a destination that is inside the source directory.

Note: Use the -P/--progress flag to view real-time transfer statistics

Note: Use the rclone dedupe command to deal with "Duplicate object/directory found in source/destination - ignoring" errors. See this forum post for more info.

rclone sync source:path dest:path [flags]
@@ -4236,7 +4237,7 @@ rclone sync -i /path/to/files remote:current-backup

--backup-dir=DIR

When using sync, copy or move any files which would have been overwritten or deleted are moved in their original hierarchy into this directory.

If --suffix is set, then the moved files will have the suffix added to them. If there is a file with the same path (after the suffix has been added) in DIR, then it will be overwritten.

-

The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync. The backup directory must not overlap the destination directory.

+

The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync. The backup directory must not overlap the destination directory without it being excluded by a filter rule.

For example

rclone sync -i /path/to/local remote:current --backup-dir remote:old

will sync /path/to/local to remote:current, but for any files which would have been updated or deleted will be stored in remote:old.

@@ -8378,7 +8379,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 (default "rclone/v1.59.0") + --user-agent string Set the user-agent to a specified string (default "rclone/v1.59.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.

@@ -17156,7 +17157,7 @@ remote = drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=: [AllDrives] type = combine -remote = "My Drive=My Drive:" "Test Drive=Test Drive:" +upstreams = "My Drive=My Drive:" "Test Drive=Test Drive:"

If you then add that config to your config file (find it with rclone config file) then you can access all the shared drives in one place with the AllDrives: remote.

See the Google Drive docs for full info.

Standard options

@@ -19657,7 +19658,7 @@ remote = drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=: [AllDrives] type = combine -remote = "My Drive=My Drive:" "Test Drive=Test Drive:" +upstreams = "My Drive=My Drive:" "Test Drive=Test Drive:"

Adding this to the rclone config file will cause those team drives to be accessible with the aliases shown. Any illegal charactes will be substituted with "_" and duplicate names will have numbers suffixed. It will also add a remote called AllDrives which shows all the shared drives combined into one directory tree.

untrash

Untrash files and directories

@@ -20952,8 +20953,8 @@ y/e/d> y

The Internet Archive backend utilizes Items on archive.org

Refer to IAS3 API documentation for the API this backend uses.

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

-

Once you have made a remote (see the provider specific section above) you can use it like this:

Unlike S3, listing up all items uploaded by you isn't supported.

+

Once you have made a remote, you can use it like this:

Make a new item

rclone mkdir remote:item

List the contents of a item

@@ -20965,7 +20966,7 @@ y/e/d> y

You can optionally wait for the server's processing to finish, by setting non-zero value to wait_archive key. By making it wait, rclone can do normal file comparison. Make sure to set a large enough value (e.g. 30m0s for smaller files) as it can take a long time depending on server's queue.

About metadata

This backend supports setting, updating and reading metadata of each file. The metadata will appear as file metadata on Internet Archive. However, some fields are reserved by both Internet Archive and rclone.

-

The following are reserved by Internet Archive: - name - source - size - md5 - crc32 - sha1 - format - old_version - viruscheck

+

The following are reserved by Internet Archive: - name - source - size - md5 - crc32 - sha1 - format - old_version - viruscheck - summation

Trying to set values to these keys is ignored with a warning. Only setting mtime is an exception. Doing so make it the identical behavior as setting ModTime.

rclone reserves all the keys starting with rclone-. Setting value for these keys will give you warnings, but values are set according to request.

If there are multiple values for a key, only the first one is returned. This is a limitation of rclone, that supports one value per one key. It can be triggered when you did a server-side copy.

@@ -21138,42 +21139,42 @@ y/e/d> y CRC32 calculated by Internet Archive string 01234567 -N +Y format Name of format identified by Internet Archive string Comma-Separated Values -N +Y md5 MD5 hash calculated by Internet Archive string 01234567012345670123456701234567 -N +Y mtime Time of last modification, managed by Rclone RFC 3339 2006-01-02T15:04:05.999999999Z -N +Y name Full file path, without the bucket part filename backend/internetarchive/internetarchive.go -N +Y old_version Whether the file was replaced and moved by keep-old-version flag boolean true -N +Y rclone-ia-mtime @@ -21201,28 +21202,35 @@ y/e/d> y SHA1 hash calculated by Internet Archive string 0123456701234567012345670123456701234567 -N +Y size File size in bytes decimal number 123456 -N +Y source The source of the file string original -N +Y +summation +Check https://forum.rclone.org/t/31922 for how it is used +string +md5 +Y + + viruscheck The last time viruscheck process was run for the file (?) unixtime 1654191352 -N +Y @@ -27757,6 +27765,60 @@ $ tree /tmp/b
  • "error": return an error based on option value

    • Changelog

    +

    v1.59.1 - 2022-08-08

    +

    See commits

    +

    v1.59.0 - 2022-07-09

    See commits