2015-09-27 15:13:20 +00:00
|
|
|
---
|
|
|
|
title: "Filtering"
|
|
|
|
description: "Filtering, includes and excludes"
|
2016-02-08 08:22:54 +00:00
|
|
|
date: "2016-02-09"
|
2015-09-27 15:13:20 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# Filtering, includes and excludes #
|
|
|
|
|
|
|
|
Rclone has a sophisticated set of include and exclude rules. Some of
|
|
|
|
these are based on patterns and some on other things like file size.
|
|
|
|
|
2015-11-24 16:54:12 +00:00
|
|
|
The filters are applied for the `copy`, `sync`, `move`, `ls`, `lsl`,
|
2015-12-02 22:25:32 +00:00
|
|
|
`md5sum`, `sha1sum`, `size`, `delete` and `check` operations.
|
2016-01-11 12:39:33 +00:00
|
|
|
Note that `purge` does not obey the filters.
|
2015-11-24 16:54:12 +00:00
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
Each path as it passes through rclone is matched against the include
|
2016-02-08 08:22:54 +00:00
|
|
|
and exclude rules like `--include`, `--exclude`, `--include-from`,
|
|
|
|
`--exclude-from`, `--filter`, or `--filter-from`. The simplest way to
|
|
|
|
try them out is using the `ls` command, or `--dry-run` together with
|
2020-03-15 13:58:46 +00:00
|
|
|
`-v`. `--filter-from`, `--exclude-from`, `--include-from`, `--files-from`
|
|
|
|
understand `-` as a file name to mean read from standard input.
|
2015-09-27 15:13:20 +00:00
|
|
|
|
|
|
|
## Patterns ##
|
|
|
|
|
|
|
|
The patterns used to match files for inclusion or exclusion are based
|
|
|
|
on "file globs" as used by the unix shell.
|
|
|
|
|
|
|
|
If the pattern starts with a `/` then it only matches at the top level
|
2016-11-27 18:20:45 +00:00
|
|
|
of the directory tree, **relative to the root of the remote** (not
|
|
|
|
necessarily the root of the local drive). If it doesn't start with `/`
|
|
|
|
then it is matched starting at the **end of the path**, but it will
|
|
|
|
only match a complete path element:
|
2015-09-27 15:13:20 +00:00
|
|
|
|
|
|
|
file.jpg - matches "file.jpg"
|
|
|
|
- matches "directory/file.jpg"
|
|
|
|
- doesn't match "afile.jpg"
|
|
|
|
- doesn't match "directory/afile.jpg"
|
2016-02-08 08:22:54 +00:00
|
|
|
/file.jpg - matches "file.jpg" in the root directory of the remote
|
2015-09-27 15:13:20 +00:00
|
|
|
- doesn't match "afile.jpg"
|
|
|
|
- doesn't match "directory/file.jpg"
|
|
|
|
|
2016-03-19 17:40:54 +00:00
|
|
|
**Important** Note that you must use `/` in patterns and not `\` even
|
|
|
|
if running on Windows.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
A `*` matches anything but not a `/`.
|
|
|
|
|
|
|
|
*.jpg - matches "file.jpg"
|
|
|
|
- matches "directory/file.jpg"
|
2016-01-20 15:16:24 +00:00
|
|
|
- doesn't match "file.jpg/something"
|
2015-09-27 15:13:20 +00:00
|
|
|
|
2016-01-20 15:16:24 +00:00
|
|
|
Use `**` to match anything, including slashes (`/`).
|
2015-09-27 15:13:20 +00:00
|
|
|
|
|
|
|
dir/** - matches "dir/file.jpg"
|
|
|
|
- matches "dir/dir1/dir2/file.jpg"
|
|
|
|
- doesn't match "directory/file.jpg"
|
|
|
|
- doesn't match "adir/file.jpg"
|
|
|
|
|
|
|
|
A `?` matches any character except a slash `/`.
|
|
|
|
|
|
|
|
l?ss - matches "less"
|
|
|
|
- matches "lass"
|
|
|
|
- doesn't match "floss"
|
|
|
|
|
2019-03-27 19:12:24 +00:00
|
|
|
A `[` and `]` together make a character class, such as `[a-z]` or
|
2015-09-27 15:13:20 +00:00
|
|
|
`[aeiou]` or `[[:alpha:]]`. See the [go regexp
|
|
|
|
docs](https://golang.org/pkg/regexp/syntax/) for more info on these.
|
|
|
|
|
|
|
|
h[ae]llo - matches "hello"
|
|
|
|
- matches "hallo"
|
|
|
|
- doesn't match "hullo"
|
|
|
|
|
|
|
|
A `{` and `}` define a choice between elements. It should contain a
|
2017-10-28 06:03:51 +00:00
|
|
|
comma separated list of patterns, any of which might match. These
|
2015-09-27 15:13:20 +00:00
|
|
|
patterns can contain wildcards.
|
|
|
|
|
|
|
|
{one,two}_potato - matches "one_potato"
|
|
|
|
- matches "two_potato"
|
|
|
|
- doesn't match "three_potato"
|
|
|
|
- doesn't match "_potato"
|
|
|
|
|
|
|
|
Special characters can be escaped with a `\` before them.
|
|
|
|
|
|
|
|
\*.jpg - matches "*.jpg"
|
|
|
|
\\.jpg - matches "\.jpg"
|
2015-10-20 08:16:47 +00:00
|
|
|
\[one\].jpg - matches "[one].jpg"
|
2016-05-16 16:14:04 +00:00
|
|
|
|
2018-11-12 14:29:37 +00:00
|
|
|
Patterns are case sensitive unless the `--ignore-case` flag is used.
|
|
|
|
|
|
|
|
Without `--ignore-case` (default)
|
|
|
|
|
|
|
|
potato - matches "potato"
|
|
|
|
- doesn't match "POTATO"
|
|
|
|
|
|
|
|
With `--ignore-case`
|
|
|
|
|
|
|
|
potato - matches "potato"
|
|
|
|
- matches "POTATO"
|
|
|
|
|
2016-05-19 11:39:16 +00:00
|
|
|
Note also that rclone filter globs can only be used in one of the
|
|
|
|
filter command line flags, not in the specification of the remote, so
|
|
|
|
`rclone copy "remote:dir*.jpg" /path/to/dir` won't work - what is
|
|
|
|
required is `rclone --include "*.jpg" copy remote:dir /path/to/dir`
|
|
|
|
|
2016-05-16 16:14:04 +00:00
|
|
|
### Directories ###
|
|
|
|
|
|
|
|
Rclone keeps track of directories that could match any file patterns.
|
|
|
|
|
|
|
|
Eg if you add the include rule
|
|
|
|
|
2016-10-04 12:39:29 +00:00
|
|
|
/a/*.jpg
|
2016-05-16 16:14:04 +00:00
|
|
|
|
|
|
|
Rclone will synthesize the directory include rule
|
|
|
|
|
2016-10-04 12:39:29 +00:00
|
|
|
/a/
|
2016-05-16 16:14:04 +00:00
|
|
|
|
2016-10-04 12:39:29 +00:00
|
|
|
If you put any rules which end in `/` then it will only match
|
2016-05-16 16:14:04 +00:00
|
|
|
directories.
|
|
|
|
|
|
|
|
Directory matches are **only** used to optimise directory access
|
|
|
|
patterns - you must still match the files that you want to match.
|
|
|
|
Directory matches won't optimise anything on bucket based remotes (eg
|
|
|
|
s3, swift, google compute storage, b2) which don't have a concept of
|
|
|
|
directory.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
### Differences between rsync and rclone patterns ###
|
|
|
|
|
2015-09-28 21:51:33 +00:00
|
|
|
Rclone implements bash style `{a,b,c}` glob matching which rsync doesn't.
|
2015-09-27 15:13:20 +00:00
|
|
|
|
|
|
|
Rclone always does a wildcard match so `\` must always escape a `\`.
|
|
|
|
|
|
|
|
## How the rules are used ##
|
|
|
|
|
2016-11-27 12:10:52 +00:00
|
|
|
Rclone maintains a combined list of include rules and exclude rules.
|
2015-09-27 15:13:20 +00:00
|
|
|
|
2016-11-27 12:10:52 +00:00
|
|
|
Each file is matched in order, starting from the top, against the rule
|
|
|
|
in the list until it finds a match. The file is then included or
|
|
|
|
excluded according to the rule type.
|
2015-09-27 15:13:20 +00:00
|
|
|
|
2016-11-27 12:10:52 +00:00
|
|
|
If the matcher fails to find a match after testing against all the
|
|
|
|
entries in the list then the path is included.
|
2015-09-27 15:13:20 +00:00
|
|
|
|
|
|
|
For example given the following rules, `+` being include, `-` being
|
|
|
|
exclude,
|
|
|
|
|
|
|
|
- secret*.jpg
|
|
|
|
+ *.jpg
|
|
|
|
+ *.png
|
|
|
|
+ file2.avi
|
|
|
|
- *
|
|
|
|
|
|
|
|
This would include
|
|
|
|
|
|
|
|
* `file1.jpg`
|
|
|
|
* `file3.png`
|
|
|
|
* `file2.avi`
|
|
|
|
|
|
|
|
This would exclude
|
|
|
|
|
|
|
|
* `secret17.jpg`
|
|
|
|
* non `*.jpg` and `*.png`
|
|
|
|
|
2016-05-16 16:14:04 +00:00
|
|
|
A similar process is done on directory entries before recursing into
|
|
|
|
them. This only works on remotes which have a concept of directory
|
2016-07-11 11:42:44 +00:00
|
|
|
(Eg local, google drive, onedrive, amazon drive) and not on bucket
|
2016-05-16 16:14:04 +00:00
|
|
|
based remotes (eg s3, swift, google compute storage, b2).
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
## Adding filtering rules ##
|
|
|
|
|
|
|
|
Filtering rules are added with the following command line flags.
|
|
|
|
|
2016-12-07 13:37:40 +00:00
|
|
|
### Repeating options ##
|
|
|
|
|
|
|
|
You can repeat the following options to add more than one rule of that
|
|
|
|
type.
|
|
|
|
|
|
|
|
* `--include`
|
|
|
|
* `--include-from`
|
|
|
|
* `--exclude`
|
|
|
|
* `--exclude-from`
|
|
|
|
* `--filter`
|
|
|
|
* `--filter-from`
|
|
|
|
|
2017-11-20 22:33:54 +00:00
|
|
|
**Important** You should not use `--include*` together with `--exclude*`.
|
|
|
|
It may produce different results than you expected. In that case try to use: `--filter*`.
|
|
|
|
|
2016-12-07 13:37:40 +00:00
|
|
|
Note that all the options of the same type are processed together in
|
|
|
|
the order above, regardless of what order they were placed on the
|
|
|
|
command line.
|
|
|
|
|
|
|
|
So all `--include` options are processed first in the order they
|
|
|
|
appeared on the command line, then all `--include-from` options etc.
|
|
|
|
|
|
|
|
To mix up the order includes and excludes, the `--filter` flag can be
|
|
|
|
used.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
### `--exclude` - Exclude files matching pattern ###
|
|
|
|
|
|
|
|
Add a single exclude rule with `--exclude`.
|
|
|
|
|
2016-12-07 13:37:40 +00:00
|
|
|
This flag can be repeated. See above for the order the flags are
|
|
|
|
processed in.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
Eg `--exclude *.bak` to exclude all bak files from the sync.
|
|
|
|
|
|
|
|
### `--exclude-from` - Read exclude patterns from file ###
|
|
|
|
|
|
|
|
Add exclude rules from a file.
|
|
|
|
|
2016-12-07 13:37:40 +00:00
|
|
|
This flag can be repeated. See above for the order the flags are
|
|
|
|
processed in.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
Prepare a file like this `exclude-file.txt`
|
|
|
|
|
|
|
|
# a sample exclude rule file
|
|
|
|
*.bak
|
|
|
|
file2.jpg
|
|
|
|
|
|
|
|
Then use as `--exclude-from exclude-file.txt`. This will sync all
|
|
|
|
files except those ending in `bak` and `file2.jpg`.
|
|
|
|
|
|
|
|
This is useful if you have a lot of rules.
|
|
|
|
|
|
|
|
### `--include` - Include files matching pattern ###
|
|
|
|
|
|
|
|
Add a single include rule with `--include`.
|
|
|
|
|
2016-12-07 13:37:40 +00:00
|
|
|
This flag can be repeated. See above for the order the flags are
|
|
|
|
processed in.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
Eg `--include *.{png,jpg}` to include all `png` and `jpg` files in the
|
|
|
|
backup and no others.
|
|
|
|
|
2016-01-10 11:42:53 +00:00
|
|
|
This adds an implicit `--exclude *` at the very end of the filter
|
|
|
|
list. This means you can mix `--include` and `--include-from` with the
|
|
|
|
other filters (eg `--exclude`) but you must include all the files you
|
|
|
|
want in the include statement. If this doesn't provide enough
|
|
|
|
flexibility then you must use `--filter-from`.
|
2015-09-27 15:13:20 +00:00
|
|
|
|
|
|
|
### `--include-from` - Read include patterns from file ###
|
|
|
|
|
|
|
|
Add include rules from a file.
|
|
|
|
|
2016-12-07 13:37:40 +00:00
|
|
|
This flag can be repeated. See above for the order the flags are
|
|
|
|
processed in.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
Prepare a file like this `include-file.txt`
|
|
|
|
|
|
|
|
# a sample include rule file
|
|
|
|
*.jpg
|
|
|
|
*.png
|
|
|
|
file2.avi
|
|
|
|
|
|
|
|
Then use as `--include-from include-file.txt`. This will sync all
|
|
|
|
`jpg`, `png` files and `file2.avi`.
|
|
|
|
|
|
|
|
This is useful if you have a lot of rules.
|
|
|
|
|
2016-01-10 11:42:53 +00:00
|
|
|
This adds an implicit `--exclude *` at the very end of the filter
|
|
|
|
list. This means you can mix `--include` and `--include-from` with the
|
|
|
|
other filters (eg `--exclude`) but you must include all the files you
|
|
|
|
want in the include statement. If this doesn't provide enough
|
|
|
|
flexibility then you must use `--filter-from`.
|
2015-09-27 15:13:20 +00:00
|
|
|
|
|
|
|
### `--filter` - Add a file-filtering rule ###
|
|
|
|
|
|
|
|
This can be used to add a single include or exclude rule. Include
|
|
|
|
rules start with `+ ` and exclude rules start with `- `. A special
|
|
|
|
rule called `!` can be used to clear the existing rules.
|
|
|
|
|
2016-12-07 13:37:40 +00:00
|
|
|
This flag can be repeated. See above for the order the flags are
|
|
|
|
processed in.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
Eg `--filter "- *.bak"` to exclude all bak files from the sync.
|
|
|
|
|
|
|
|
### `--filter-from` - Read filtering patterns from a file ###
|
|
|
|
|
|
|
|
Add include/exclude rules from a file.
|
|
|
|
|
2016-12-07 13:37:40 +00:00
|
|
|
This flag can be repeated. See above for the order the flags are
|
|
|
|
processed in.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
Prepare a file like this `filter-file.txt`
|
|
|
|
|
2017-09-01 10:35:26 +00:00
|
|
|
# a sample filter rule file
|
2015-09-27 15:13:20 +00:00
|
|
|
- secret*.jpg
|
|
|
|
+ *.jpg
|
|
|
|
+ *.png
|
|
|
|
+ file2.avi
|
2017-09-01 10:35:26 +00:00
|
|
|
- /dir/Trash/**
|
|
|
|
+ /dir/**
|
2015-09-27 15:13:20 +00:00
|
|
|
# exclude everything else
|
|
|
|
- *
|
|
|
|
|
|
|
|
Then use as `--filter-from filter-file.txt`. The rules are processed
|
|
|
|
in the order that they are defined.
|
|
|
|
|
|
|
|
This example will include all `jpg` and `png` files, exclude any files
|
2017-09-01 10:35:26 +00:00
|
|
|
matching `secret*.jpg` and include `file2.avi`. It will also include
|
|
|
|
everything in the directory `dir` at the root of the sync, except
|
|
|
|
`dir/Trash` which it will exclude. Everything else will be excluded
|
|
|
|
from the sync.
|
2015-09-27 15:13:20 +00:00
|
|
|
|
|
|
|
### `--files-from` - Read list of source-file names ###
|
|
|
|
|
|
|
|
This reads a list of file names from the file passed in and **only**
|
2018-03-01 09:59:50 +00:00
|
|
|
these files are transferred. The **filtering rules are ignored**
|
2015-09-27 15:13:20 +00:00
|
|
|
completely if you use this option.
|
|
|
|
|
2019-10-28 22:42:49 +00:00
|
|
|
`--files-from` expects a list of files as it's input. [rclone lsf](/commands/rclone_lsf/)
|
|
|
|
has a compatible format that can be used to export file lists from
|
|
|
|
remotes.
|
|
|
|
|
2019-02-13 17:14:51 +00:00
|
|
|
Rclone will traverse the file system if you use `--files-from`,
|
|
|
|
effectively using the files in `--files-from` as a set of filters.
|
|
|
|
Rclone will not error if any of the files are missing.
|
|
|
|
|
|
|
|
If you use `--no-traverse` as well as `--files-from` then rclone will
|
|
|
|
not traverse the destination file system, it will find each file
|
|
|
|
individually using approximately 1 API call. This can be more
|
|
|
|
efficient for small lists of files.
|
2018-10-19 16:41:14 +00:00
|
|
|
|
2016-12-07 13:37:40 +00:00
|
|
|
This option can be repeated to read from more than one file. These
|
|
|
|
are read in the order that they are placed on the command line.
|
|
|
|
|
2018-03-01 09:59:50 +00:00
|
|
|
Paths within the `--files-from` file will be interpreted as starting
|
|
|
|
with the root specified in the command. Leading `/` characters are
|
|
|
|
ignored.
|
|
|
|
|
|
|
|
For example, suppose you had `files-from.txt` with this content:
|
2015-09-27 15:13:20 +00:00
|
|
|
|
|
|
|
# comment
|
|
|
|
file1.jpg
|
2018-03-01 09:59:50 +00:00
|
|
|
subdir/file2.jpg
|
|
|
|
|
|
|
|
You could then use it like this:
|
|
|
|
|
|
|
|
rclone copy --files-from files-from.txt /home/me/pics remote:pics
|
2015-09-27 15:13:20 +00:00
|
|
|
|
2018-03-01 09:59:50 +00:00
|
|
|
This will transfer these files only (if they exist)
|
2015-09-27 15:13:20 +00:00
|
|
|
|
2018-03-01 09:59:50 +00:00
|
|
|
/home/me/pics/file1.jpg → remote:pics/file1.jpg
|
2019-07-27 11:35:54 +00:00
|
|
|
/home/me/pics/subdir/file2.jpg → remote:pics/subdir/file2.jpg
|
2018-03-01 09:59:50 +00:00
|
|
|
|
|
|
|
To take a more complicated example, let's say you had a few files you
|
|
|
|
want to back up regularly with these absolute paths:
|
2016-07-05 11:33:59 +00:00
|
|
|
|
|
|
|
/home/user1/important
|
|
|
|
/home/user1/dir/file
|
|
|
|
/home/user2/stuff
|
|
|
|
|
|
|
|
To copy these you'd find a common subdirectory - in this case `/home`
|
|
|
|
and put the remaining files in `files-from.txt` with or without
|
|
|
|
leading `/`, eg
|
|
|
|
|
|
|
|
user1/important
|
|
|
|
user1/dir/file
|
|
|
|
user2/stuff
|
|
|
|
|
|
|
|
You could then copy these to a remote like this
|
|
|
|
|
|
|
|
rclone copy --files-from files-from.txt /home remote:backup
|
|
|
|
|
|
|
|
The 3 files will arrive in `remote:backup` with the paths as in the
|
2018-03-01 09:59:50 +00:00
|
|
|
`files-from.txt` like this:
|
|
|
|
|
|
|
|
/home/user1/important → remote:backup/user1/important
|
|
|
|
/home/user1/dir/file → remote:backup/user1/dir/file
|
2019-07-27 11:35:54 +00:00
|
|
|
/home/user2/stuff → remote:backup/user2/stuff
|
2016-07-05 11:33:59 +00:00
|
|
|
|
|
|
|
You could of course choose `/` as the root too in which case your
|
|
|
|
`files-from.txt` might look like this.
|
|
|
|
|
|
|
|
/home/user1/important
|
|
|
|
/home/user1/dir/file
|
|
|
|
/home/user2/stuff
|
|
|
|
|
|
|
|
And you would transfer it like this
|
|
|
|
|
|
|
|
rclone copy --files-from files-from.txt / remote:backup
|
|
|
|
|
2018-03-01 09:59:50 +00:00
|
|
|
In this case there will be an extra `home` directory on the remote:
|
|
|
|
|
2019-07-27 11:35:54 +00:00
|
|
|
/home/user1/important → remote:backup/home/user1/important
|
|
|
|
/home/user1/dir/file → remote:backup/home/user1/dir/file
|
|
|
|
/home/user2/stuff → remote:backup/home/user2/stuff
|
2016-07-05 11:33:59 +00:00
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
### `--min-size` - Don't transfer any file smaller than this ###
|
|
|
|
|
|
|
|
This option controls the minimum size file which will be transferred.
|
|
|
|
This defaults to `kBytes` but a suffix of `k`, `M`, or `G` can be
|
|
|
|
used.
|
|
|
|
|
|
|
|
For example `--min-size 50k` means no files smaller than 50kByte will be
|
|
|
|
transferred.
|
|
|
|
|
|
|
|
### `--max-size` - Don't transfer any file larger than this ###
|
|
|
|
|
|
|
|
This option controls the maximum size file which will be transferred.
|
|
|
|
This defaults to `kBytes` but a suffix of `k`, `M`, or `G` can be
|
|
|
|
used.
|
|
|
|
|
|
|
|
For example `--max-size 1G` means no files larger than 1GByte will be
|
|
|
|
transferred.
|
|
|
|
|
2015-12-29 19:34:10 +00:00
|
|
|
### `--max-age` - Don't transfer any file older than this ###
|
|
|
|
|
|
|
|
This option controls the maximum age of files to transfer. Give in
|
|
|
|
seconds or with a suffix of:
|
|
|
|
|
|
|
|
* `ms` - Milliseconds
|
|
|
|
* `s` - Seconds
|
|
|
|
* `m` - Minutes
|
|
|
|
* `h` - Hours
|
|
|
|
* `d` - Days
|
|
|
|
* `w` - Weeks
|
|
|
|
* `M` - Months
|
|
|
|
* `y` - Years
|
|
|
|
|
|
|
|
For example `--max-age 2d` means no files older than 2 days will be
|
|
|
|
transferred.
|
|
|
|
|
|
|
|
### `--min-age` - Don't transfer any file younger than this ###
|
|
|
|
|
|
|
|
This option controls the minimum age of files to transfer. Give in
|
|
|
|
seconds or with a suffix (see `--max-age` for list of suffixes)
|
|
|
|
|
|
|
|
For example `--min-age 2d` means no files younger than 2 days will be
|
|
|
|
transferred.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
### `--delete-excluded` - Delete files on dest excluded from sync ###
|
|
|
|
|
|
|
|
**Important** this flag is dangerous - use with `--dry-run` and `-v` first.
|
|
|
|
|
|
|
|
When doing `rclone sync` this will delete any files which are excluded
|
|
|
|
from the sync on the destination.
|
|
|
|
|
|
|
|
If for example you did a sync from `A` to `B` without the `--min-size 50k` flag
|
|
|
|
|
|
|
|
rclone sync A: B:
|
|
|
|
|
|
|
|
Then you repeated it like this with the `--delete-excluded`
|
|
|
|
|
|
|
|
rclone --min-size 50k --delete-excluded sync A: B:
|
|
|
|
|
|
|
|
This would delete all files on `B` which are less than 50 kBytes as
|
|
|
|
these are now excluded from the sync.
|
|
|
|
|
|
|
|
Always test first with `--dry-run` and `-v` before using this flag.
|
|
|
|
|
2017-11-20 20:21:44 +00:00
|
|
|
### `--dump filters` - dump the filters to the output ###
|
2015-09-27 15:13:20 +00:00
|
|
|
|
|
|
|
This dumps the defined filters to the output as regular expressions.
|
|
|
|
|
|
|
|
Useful for debugging.
|
|
|
|
|
2018-11-12 14:29:37 +00:00
|
|
|
### `--ignore-case` - make searches case insensitive ###
|
|
|
|
|
|
|
|
Normally filter patterns are case sensitive. If this flag is supplied
|
|
|
|
then filter patterns become case insensitive.
|
|
|
|
|
|
|
|
Normally a `--include "file.txt"` will not match a file called
|
|
|
|
`FILE.txt`. However if you use the `--ignore-case` flag then
|
|
|
|
`--include "file.txt"` this will match a file called `FILE.txt`.
|
|
|
|
|
2015-09-27 15:13:20 +00:00
|
|
|
## Quoting shell metacharacters ##
|
|
|
|
|
|
|
|
The examples above may not work verbatim in your shell as they have
|
|
|
|
shell metacharacters in them (eg `*`), and may require quoting.
|
|
|
|
|
|
|
|
Eg linux, OSX
|
|
|
|
|
|
|
|
* `--include \*.jpg`
|
|
|
|
* `--include '*.jpg'`
|
|
|
|
* `--include='*.jpg'`
|
|
|
|
|
|
|
|
In Windows the expansion is done by the command not the shell so this
|
|
|
|
should work fine
|
|
|
|
|
|
|
|
* `--include *.jpg`
|
2017-11-09 09:40:47 +00:00
|
|
|
|
|
|
|
## Exclude directory based on a file ##
|
|
|
|
|
|
|
|
It is possible to exclude a directory based on a file, which is
|
|
|
|
present in this directory. Filename should be specified using the
|
|
|
|
`--exclude-if-present` flag. This flag has a priority over the other
|
|
|
|
filtering flags.
|
|
|
|
|
|
|
|
Imagine, you have the following directory structure:
|
|
|
|
|
|
|
|
dir1/file1
|
|
|
|
dir1/dir2/file2
|
|
|
|
dir1/dir2/dir3/file3
|
|
|
|
dir1/dir2/dir3/.ignore
|
|
|
|
|
|
|
|
You can exclude `dir3` from sync by running the following command:
|
|
|
|
|
|
|
|
rclone sync --exclude-if-present .ignore dir1 remote:backup
|
|
|
|
|
|
|
|
Currently only one filename is supported, i.e. `--exclude-if-present`
|
|
|
|
should not be used multiple times.
|