github-mirror/rclone
2
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-11-30 12:34:04 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update filtering documentation - fixes #306

Browse Source 
Explains that filtering is done relative to the remote root.

Also removes a section that seems more about internal knowledge and
that may likely more confuse people. Adds instead a section giving an
overview of how to perform filtering before going into details.
This commit is contained in:
Werner Beroux 2016-02-08 09:22:54 +01:00 committed by Nick Craig-Wood
parent 85d99de26b
commit 6a47d966a4
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/content/filtering.md
View File

@ -1,7 +1,7 @@
--- ---
title: "Filtering" title: "Filtering"
description: "Filtering, includes and excludes" description: "Filtering, includes and excludes"
date: "2015-09-27" date: "2016-02-09"
--- ---
# Filtering, includes and excludes # # Filtering, includes and excludes #
@ -14,13 +14,10 @@ The filters are applied for the `copy`, `sync`, `move`, `ls`, `lsl`,
Note that `purge` does not obey the filters. Note that `purge` does not obey the filters.
Each path as it passes through rclone is matched against the include Each path as it passes through rclone is matched against the include
and exclude rules. The paths are matched without a leading `/`. and exclude rules like `--include`, `--exclude`, `--include-from`,
`--exclude-from`, `--filter`, or `--filter-from`. The simplest way to
For example the files might be passed to the matching engine like this try them out is using the `ls` command, or `--dry-run` together with
`-v`.
* `file1.jpg`
* `file2.jpg`
* `directory/file3.jpg`
## Patterns ## ## Patterns ##
@ -28,15 +25,15 @@ The patterns used to match files for inclusion or exclusion are based
on "file globs" as used by the unix shell. on "file globs" as used by the unix shell.
If the pattern starts with a `/` then it only matches at the top level If the pattern starts with a `/` then it only matches at the top level
of the directory tree. If it doesn't start with `/` then it is of the directory tree, relative to the root of the remote.
matched starting at the end of the path, but it will only match a If it doesn't start with `/` then it is matched starting at the
complete path element. **end of the path**, but it will only match a complete path element:
file.jpg - matches "file.jpg" file.jpg - matches "file.jpg"
- matches "directory/file.jpg" - matches "directory/file.jpg"
- doesn't match "afile.jpg" - doesn't match "afile.jpg"
- doesn't match "directory/afile.jpg" - doesn't match "directory/afile.jpg"
/file.jpg - matches "file.jpg" /file.jpg - matches "file.jpg" in the root directory of the remote
- doesn't match "afile.jpg" - doesn't match "afile.jpg"
- doesn't match "directory/file.jpg" - doesn't match "directory/file.jpg"