From 6fe40d93890e8943146c478a04a0ca7d426baa41 Mon Sep 17 00:00:00 2001 From: RatzzFatzz Date: Thu, 13 Apr 2023 21:58:29 +0200 Subject: [PATCH] Add parameters --- Attribute-Config.md | 11 ++++++--- Home.md | 4 ++- Parameters.md | 60 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 71 insertions(+), 4 deletions(-) create mode 100644 Parameters.md diff --git a/Attribute-Config.md b/Attribute-Config.md index 06b15bb..b9211ec 100644 --- a/Attribute-Config.md +++ b/Attribute-Config.md @@ -1,12 +1,17 @@ ### Language validation -The entered 3-letter country codes are validated with a packaged list. It also allows `OFF` for subtitles, to disable full subtitles and just set forced tracks. + +The entered 3-letter country codes are validated with a packaged list. It also allows `OFF` for subtitles, to disable full subtitles and +only set forced tracks. List of country codes can be found [here](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/blob/master/language-codes). ### Multiple configurations -You can enter as many configurations as you want. Keep in mind that the order of the entered configurations matters. -For this example `java -jar mkvaudiosubtitlechanger.jar -l "\\remote-server\files" -a eng:ger eng:OFF ger:OFF`, the files would be checked in following order: +You can enter as many configurations as you want. Keep in mind that the order of the entered configurations matters. + +For this example `java -jar mkvaudiosubtitlechanger.jar -l "\\remote-server\files" -a eng:ger eng:OFF ger:OFF`, the files would be checked +in following order: + 1. Audio: English, Subs: German 2. Audio: English, Subs: ignored 3. Audio: German, Subs: ignored diff --git a/Home.md b/Home.md index b9d2cad..f67ba13 100644 --- a/Home.md +++ b/Home.md @@ -1 +1,3 @@ -Welcome to the MKVAudioSubtitleChanger wiki! +1. [Parameters](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/Parameters) +2. [Attribute Config](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/Attribute-Config) +3. [How to config file](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/How-to-config-file) \ No newline at end of file diff --git a/Parameters.md b/Parameters.md new file mode 100644 index 0000000..ebb6879 --- /dev/null +++ b/Parameters.md @@ -0,0 +1,60 @@ +## -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 \ + +## -cf,--force-coherent + +## -n,--only-new-files + +## -d,--filter-date \ + +## -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. + +## -fk,--forced-keywords \ + +Keywords to recognize forced subtitle tracks. + +## -ck,--commentary-keywords \ + +Keywords to recognize commentary audio tracks. + +## -ps,--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