From 6109e960b4cf9bb6117e22f0808bd198d40b9d68 Mon Sep 17 00:00:00 2001
From: q3aql <q3aql@duck.com>
Date: Fri, 10 Mar 2023 20:12:29 +0100
Subject: [PATCH] Add doc for ks-av1(s)-wrapper

---
 doc/ks-av1-wrapper.md  | 52 ++++++++++++++++++++++++++++++++++++++++++
 doc/ks-av1s-wrapper.md | 52 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 104 insertions(+)
 create mode 100644 doc/ks-av1-wrapper.md
 create mode 100644 doc/ks-av1s-wrapper.md

diff --git a/doc/ks-av1-wrapper.md b/doc/ks-av1-wrapper.md
new file mode 100644
index 0000000..9c1377b
--- /dev/null
+++ b/doc/ks-av1-wrapper.md
@@ -0,0 +1,52 @@
+ks-av1-wrapper - Wrapper for ks-av1 to create graphical interfaces.
+===================================================================
+
+### TRACKS/CONFIG DETECT:
+
+```shell
+$ ks-av1-wrapper --show-info <video_file>
+$ ks-av1-wrapper --show-video-default <video_file>
+$ ks-av1-wrapper --show-audio-default <video_file>
+$ ks-av1-wrapper --show-subtitle-default <video_file>
+$ ks-av1-wrapper --show-resolution-default
+```
+
+### METADATA DETECT:
+  
+```shell
+$ ks-av1-wrapper --show-name-title-default <video_file>
+$ ks-av1-wrapper --show-year-default
+$ ks-av1-wrapper --show-genre-default
+```
+    
+### CONVERT:
+  
+```shell
+$ ks-av1-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> "<name-title>" <year> "<genre>" [patch]
+$ ks-av1-wrapper --conv-with-sub </path/video_file> </path/output_prefix> <video-track> <audio-track> <subs-track> <resolution> "<name-title>" <year> "<genre>" [patch]
+```
+    
+### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED):
+
+```shell
+$ ks-av1-wrapper --conv </path/video_file> </path/output_prefix>
+$ ks-av1-wrapper --conv-with-sub </path/video_file> </path/output_prefix>
+```
+    
+### EXAMPLES:
+
+```shell
+$ ks-av1-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 1280x534 "My video" 2018 "Comedy"
+$ ks-av1-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"
+$ ks-av1-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 1280x720 "My video" 2018 "Comedy" patch
+```
+    
+### Notes:
+
+  * The option `patch` apply the `-max_muxing_queue_size 9999` patch to ffmpeg.
+  * If you specify a path or file with spaces, you must use quotes.
+    
+### Back to README.md
+    
+* [Go back](../README.md)
+  
diff --git a/doc/ks-av1s-wrapper.md b/doc/ks-av1s-wrapper.md
new file mode 100644
index 0000000..98eed9e
--- /dev/null
+++ b/doc/ks-av1s-wrapper.md
@@ -0,0 +1,52 @@
+ks-av1s-wrapper - Wrapper for ks-av1s to create graphical interfaces.
+=====================================================================
+
+### TRACKS/CONFIG DETECT:
+
+```shell
+$ ks-av1s-wrapper --show-info <video_file>
+$ ks-av1s-wrapper --show-video-default <video_file>
+$ ks-av1s-wrapper --show-audio-default <video_file>
+$ ks-av1s-wrapper --show-subtitle-default <video_file>
+$ ks-av1s-wrapper --show-resolution-default
+```
+
+### METADATA DETECT:
+  
+```shell
+$ ks-av1s-wrapper --show-name-title-default <video_file>
+$ ks-av1s-wrapper --show-year-default
+$ ks-av1s-wrapper --show-genre-default
+```
+    
+### CONVERT:
+  
+```shell
+$ ks-av1s-wrapper --conv </path/video_file> </path/output_prefix> <video-track> <audio-track> <resolution> "<name-title>" <year> "<genre>" [patch]
+$ ks-av1s-wrapper --conv-with-sub </path/video_file> </path/output_prefix> <video-track> <audio-track> <subs-track> <resolution> "<name-title>" <year> "<genre>" [patch]
+```
+    
+### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED):
+
+```shell
+$ ks-av1s-wrapper --conv </path/video_file> </path/output_prefix>
+$ ks-av1s-wrapper --conv-with-sub </path/video_file> </path/output_prefix>
+```
+    
+### EXAMPLES:
+
+```shell
+$ ks-av1s-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x404 "My video" 2018 "Comedy"
+$ ks-av1s-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"
+$ ks-av1s-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x480 "My video" 2018 "Comedy" patch
+```
+    
+### Notes:
+
+  * The option `patch` apply the `-max_muxing_queue_size 9999` patch to ffmpeg.
+  * If you specify a path or file with spaces, you must use quotes.
+    
+### Back to README.md
+    
+* [Go back](../README.md)
+