Update parameter docs

RatzzFatzz
2025-02-04 14:02:26 +01:00
parent cd2c122bad
commit 4dbf6f8e35
2 changed files with 77 additions and 0 deletions

@@ -1,3 +1,5 @@
This parameter apply all versions older than v4.0
## -l,--library-path \<arg> (Required)
Path to file library which should be updated.

75
Parameters-v4.md Normal file

@@ -0,0 +1,75 @@
This parameter apply for version 4.0 and newer
## -l,--library-path \<arg> (Required)
Path to file library which should be updated.
## -a,--attribute-config \<arg> (Required)
See [this page](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/Attribute-Config) for more information.
## -p,--config-path \<arg>
Path to config file. More about this [here](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/How-to-config-file)
## -m,--mkvtoolnix \<arg>
Path to mkv tool nix installation, if it's not installed in default directory.
## -s,--safe-mode
Process will run as usual, but changes won't be applied. This should be used to test new configurations.
## -c,--coherent \<arg>
Tries to match files on entered depth to the same config. If no configuration is found for all files, they will be treated individually.
Examples:
Directory structure: `X:/Collection/Show/Season/Episodes.mkv`
- `-l "X:/Collection -c 0`: Try to match the same config for all files in `Collection`.
- `-l "X:/Coolection -c 1`: Try to match the same config for all files in `Show`.
- `-l "X:/Coolection -c 2`: Try to match the same config for all files in `Season`.
## -cf,--force-coherent
Only update files, when a configuration matched for all files at entered depth.
## -n,--only-new-files
Remembers last successful execution and only considers files newer than that.
## -d,--filter-date \<arg>
Only consider files newer than entered date. Format: dd.MM.yyyy-HH:mm:ss, eg. 20.03.2022-21:30:42
## -t,--threads \<arg>
How many threads the task executor should use. By default, two threads are used. If files are stored on a SSD thread count should be
raised to increase performance.
## -i,--include-pattern \<arg>
Regex pattern to only include (or when inverted, to exclude) files and directories.
## -e,--excluded-directories \<arg>
One or more paths to directories which should not be considered.
## --forced-keywords \<arg>
Keywords to recognize forced subtitle tracks.
## --commentary-keywords \<arg>
Keywords to recognize commentary audio tracks.
## --preferred-subtitles \<arg>
Keywords to prefer subtitle tracks.
## -v,--version
Display version.
## -h,--help
Display all available parameters and a short description.