falso
/
rmv
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Document the `--wildcard` argument.

This commit is contained in:
Pedro de Oliveira 2023-05-07 23:32:14 +01:00
parent 0770290a35
commit 8870c915d1
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -24,7 +24,7 @@ The `--path` argument specifies the path to the directory where the files to be
The `--pattern` argument specifies the regular expression pattern to match against the filenames. This argument is required.
You can use matching groups in the pattern to capture parts of the filename that you want to use in the replacement pattern. For example, the pattern `"S(\d+)E(\d+)"` will match on `"S01E23"` and capture `"01"` in group `1` and `"23"` in group `2`.
You can use matching groups in the pattern to capture parts of the filename that you want to use in the replacement pattern. For example, the pattern `"S(\d+)E(\d+)"` will match on `"S01E23"` and capture `"01"` in group 1 and `"23"` in group 2.
### `--replacement`
@ -38,6 +38,12 @@ You can also use the following special tags in the replacement pattern:
* `{name}` - filename without extension
* `{ext}` - extension
### `--wildcard` (optional)
Specifies a wildcard pattern to filter which files in the directory are considered. Only files whose names match the wildcard will be renamed. The default value is `"*"`.
For example, if you want to only rename files with the `.mkv` extension, you can use the wildcard pattern `"*.mkv"`.
Here is an example usage:
```shell