From 4dbf6f8e35239b5633d989bf62c47767c2c20f3f Mon Sep 17 00:00:00 2001 From: RatzzFatzz Date: Tue, 4 Feb 2025 14:02:26 +0100 Subject: [PATCH] Update parameter docs --- Parameters.md => Parameters-v3.md | 2 + Parameters-v4.md | 75 +++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+) rename Parameters.md => Parameters-v3.md (97%) create mode 100644 Parameters-v4.md diff --git a/Parameters.md b/Parameters-v3.md similarity index 97% rename from Parameters.md rename to Parameters-v3.md index 8143596..012784d 100644 --- a/Parameters.md +++ b/Parameters-v3.md @@ -1,3 +1,5 @@ +This parameter apply all versions older than v4.0 + ## -l,--library-path \ (Required) Path to file library which should be updated. diff --git a/Parameters-v4.md b/Parameters-v4.md new file mode 100644 index 0000000..0ddd96c --- /dev/null +++ b/Parameters-v4.md @@ -0,0 +1,75 @@ +This parameter apply for version 4.0 and newer + +## -l,--library-path \ (Required) + +Path to file library which should be updated. + +## -a,--attribute-config \ (Required) + +See [this page](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/Attribute-Config) for more information. + +## -p,--config-path \ + +Path to config file. More about this [here](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/How-to-config-file) + +## -m,--mkvtoolnix \ + +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 \ + +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 \ + +Only consider files newer than entered date. Format: dd.MM.yyyy-HH:mm:ss, eg. 20.03.2022-21:30:42 + +## -t,--threads \ + +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 \ + +Regex pattern to only include (or when inverted, to exclude) files and directories. + +## -e,--excluded-directories \ + +One or more paths to directories which should not be considered. + +## --forced-keywords \ + +Keywords to recognize forced subtitle tracks. + +## --commentary-keywords \ + +Keywords to recognize commentary audio tracks. + +## --preferred-subtitles \ + +Keywords to prefer subtitle tracks. + +## -v,--version + +Display version. + +## -h,--help + +Display all available parameters and a short description. \ No newline at end of file