To use the following features of WinSCP you need to specify a mask (wildcard) to select files (or other things):
- Text file mask for text mode transfers.
- File mask for transfers and synchronization.
- Selecting/unselecting files by file mask.
- Filtering files in file panel.
- Defining autoselection rule for transfer settings preset.
- Defining autoselection mask for editors.
- Various script commands.
TransferOptions.FileMaskin .NET assembly.
You can use File Mask dialog to help you with assembling the mask.
- Basic Syntax
- Size and Time Constraints
- Combining Masks
- Include and Exclude Masks
- Directory Mask
- Path Mask
- Subfolders with All Files Excluded
When specifying the mask you can use following patterns:
||Matches any number (including zero) of arbitrary characters.||
||Matches exactly one arbitrary character.||
||Matches one character from the set.||
||Matches one character from the range.||
All other characters are treated literally (except for special characters used in the constructs described below).
To escape character with special meaning in patterns (
*?[) surround it by set pattern, e.g.
The file masks are case insensitive.
Size and Time Constraints
File mask can be followed by these size and time constraints:
||Matches files larger than
Note that directories are considered to have a zero size.
Following units can be used:
||Matches files smaller than
||Matches files modified the last time after the date or time (i.e. “newer than”).||
||Matches files modified the last time within specified interval (i.e. “newer than”).
Cannot be used for directories.
One of the following units must be used:
||Matches files modified the last time before the date or time (i.e. “older than”).||
||Matches files modified the last time before specified interval (i.e. “older than”).||
It is also possible to use operators
To escape an operator character (
<>), double it, e.g.
To combine constraints, append one after another, without any separators (or use spaces). E.g. to select all
.doc files created in 2013:
Note that if your constraint contains spaces (particularly constraint with date and time), to use it in scripting, you need to enclose whole mask to double-quotes.
In most contexts, you can combine several masks using semicolon (
;) or comma (
,). You cannot use this in source parameters of script commands and .NET assembly methods.1
For example following mask includes all JPG and GIF images:
To escape separator character double it, e.g.
Include and Exclude Masks
Mask can combine include and exclude mask separated by pipe (
|). You cannot use this in source parameters of script commands and .NET assembly methods.1
For example following mask includes all JPG and GIF images, but excludes those starting with
*.jpg; *.gif | 2010*; 2011*.
Both include and exclude part can be empty, denoting that everything is included or nothing is excluded, respectively. When include part is empty, masks starts with pipe straight away. When exclude part is empty, you can omit the trailing pipe.
Exclude mask takes precedence over include mask. I.e. when the same file is matched by both the exclude and include mask, it is excluded. On the other hand, using an include mask effectively excludes all non included files and folders.
To escape pipe character double it, e.g.
To use the mask for directories, append a slash to the end, e.g.
images/. The mask
*/ matches any directory.
Note that when using File Mask dialog, the trailing slash for directory masks is appended automatically.
To make operation non-recursive use exclude mask
Directory masks are recursive. E.g. mask
images/ matches directories
/home/martin/images/ as well as
During transfer and synchronization, files and directories are processed recursively. When a directory is excluded, subdirectories and files contained in the excluded directory are not even evaluated against file masks. They are excluded along with its container directory.
When a mask selects files and it makes sense to select them based on directory, you can extend the mask with a path mask. You should separate the path mask from the filename mask by a slash. For example mask
/home/martinp/*.txt matches all text files within the directory. To match all text files within subtree, use mask
The path mask is matched against full path, i.e. not against path relative path to a root of file transfer or synchronization. E.g. mask
public_html/wiki/ does not match
/home/martinp/public_html/wiki directory, even if the root of file transfer or synchronization is
/home/martinp. Partial path mask that matches an absolute path may look like
For a partial path mask it makes no difference whether you use back (
\) or forward slashes (
/); the mask will always work for both local and remote paths. For example, a mask
*/public_html/*.bak will match backup files both in
Paths starting with a dot followed by a slash (
.\) are matched from the root of the operation (such as file transfer or synchronization). For example, when uploading files and folders from local path
D:\Documents\public_html\ to remote path
*.txt files in
You can also specify full path to a specific file or directory, both local and remote. For example if you want to match only a specific
.csv directory, not all, use
/home/martinp/data/.csv/ instead of
The full path mask matches a local or a remote paths only, depending on the syntax used.4 This matters for synchronization particularly. For exclude masks, you may need to use a separate full path mask for both local and remote path. For include masks, using a full path mask does not make sense with synchronization, as it effectively excludes all files on the other side of the synchronization, breaking it. In general, use partial path masks with the synchronization.
For convenience, mask
*.* is an exception matching any file or directory, even if its name does not include any dot. On the contrary, mask
*. matches any file or directory without an extension.
Subfolders with All Files Excluded
Excluding all files within a subfolder from transfer or synchronization does not exclude the subfolder itself. As a result an empty subfolder is created in the target. To prevent that, use the Exclude empty directories transfer setting. In scripting or .NET assembly, use the
ExcludeEmptyDirectories raw transfer setting.
- Note that this restriction does not apply to
-filemaskswitch in scripting and
TransferOptions.FileMaskin .NET assembly.Back
- Full inline file mask syntax, in case there’s no other mask involved, is
|*/, where the
|denotes a start of an exclude mask.Back
- Simpler, but less precise, form would be
- Paths starting with drive letter and colon match local paths only. Paths starting with slash match remote path only. Type of slashes does not matter.Back