From 13760df938c7ddaf0c655489f22226aabf50d7d2 Mon Sep 17 00:00:00 2001 From: q3aql Date: Sun, 7 Mar 2021 19:10:24 +0100 Subject: [PATCH] Add more documentation --- doc/ks-avi-wrapper.md | 42 ++++++++++++++++++++++++++++++++++++++++++ doc/ks-mp4-wrapper.md | 42 ++++++++++++++++++++++++++++++++++++++++++ doc/ks-mp4k-wrapper.md | 42 ++++++++++++++++++++++++++++++++++++++++++ doc/ks-mp4s-wrapper.md | 42 ++++++++++++++++++++++++++++++++++++++++++ doc/ks-upa.md | 22 +++++++++++----------- doc/ks-upf.md | 22 +++++++++++----------- doc/ks-upr.md | 22 +++++++++++----------- doc/ks-upv.md | 22 +++++++++++----------- doc/ks-vob-wrapper.md | 37 +++++++++++++++++++++++++++++++++++++ 9 files changed, 249 insertions(+), 44 deletions(-) create mode 100644 doc/ks-avi-wrapper.md create mode 100644 doc/ks-mp4-wrapper.md create mode 100644 doc/ks-mp4k-wrapper.md create mode 100644 doc/ks-mp4s-wrapper.md create mode 100644 doc/ks-vob-wrapper.md diff --git a/doc/ks-avi-wrapper.md b/doc/ks-avi-wrapper.md new file mode 100644 index 0000000..06a7d87 --- /dev/null +++ b/doc/ks-avi-wrapper.md @@ -0,0 +1,42 @@ +ks-avi-wrapper - Wrapper for ks-avi to create graphical interfaces. +=================================================================== + +### TRACKS/CONFIG DETECT:: + + * `$ ks-avi-wrapper --show-info ` + * `$ ks-avi-wrapper --show-video-default ` + * `$ ks-avi-wrapper --show-audio-default ` + * `$ ks-avi-wrapper --show-subtitle-default ` + * `$ ks-avi-wrapper --show-resolution-default` + +### METADATA DETECT: + + * `$ ks-avi-wrapper --show-name-title-default ` + * `$ ks-avi-wrapper --show-year-default` + * `$ ks-avi-wrapper --show-genre-default` + +### CONVERT: + + * `$ ks-avi-wrapper --conv "" "" [patch]` + * `$ ks-avi-wrapper --conv-with-sub "" "" [patch]` + +### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED): + + * `$ ks-avi-wrapper --conv ` + * `$ ks-avi-wrapper --conv-with-sub ` + +### EXAMPLES: + + * `$ ks-avi-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x480 "My video" 2018 "Comedy"` + * `$ ks-avi-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"` + * `$ ks-avi-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x404 "My video" 2018 "Comedy" patch` + +### Notes: + + * The option `patch` apply the `-thread_queue_size 2048` patch to ffmpeg. + * If you specify a path or file with spaces, you must use quotes. + +### Back to README.md + +* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md) + \ No newline at end of file diff --git a/doc/ks-mp4-wrapper.md b/doc/ks-mp4-wrapper.md new file mode 100644 index 0000000..812297f --- /dev/null +++ b/doc/ks-mp4-wrapper.md @@ -0,0 +1,42 @@ +ks-mp4-wrapper - Wrapper for ks-mp4 to create graphical interfaces. +=================================================================== + +### TRACKS/CONFIG DETECT:: + + * `$ ks-mp4-wrapper --show-info ` + * `$ ks-mp4-wrapper --show-video-default ` + * `$ ks-mp4-wrapper --show-audio-default ` + * `$ ks-mp4-wrapper --show-subtitle-default ` + * `$ ks-mp4-wrapper --show-resolution-default` + +### METADATA DETECT: + + * `$ ks-mp4-wrapper --show-name-title-default ` + * `$ ks-mp4-wrapper --show-year-default` + * `$ ks-mp4-wrapper --show-genre-default` + +### CONVERT: + + * `$ ks-mp4-wrapper --conv "" "" [patch]` + * `$ ks-mp4-wrapper --conv-with-sub "" "" [patch]` + +### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED): + + * `$ ks-mp4-wrapper --conv ` + * `$ ks-mp4-wrapper --conv-with-sub ` + +### EXAMPLES: + + * `$ ks-mp4-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 1280x534 "My video" 2018 "Comedy"` + * `$ ks-mp4-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"` + * `$ ks-mp4-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 1280x720 "My video" 2018 "Comedy" patch` + +### Notes: + + * The option `patch` apply the `-thread_queue_size 2048` patch to ffmpeg. + * If you specify a path or file with spaces, you must use quotes. + +### Back to README.md + +* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md) + \ No newline at end of file diff --git a/doc/ks-mp4k-wrapper.md b/doc/ks-mp4k-wrapper.md new file mode 100644 index 0000000..672575b --- /dev/null +++ b/doc/ks-mp4k-wrapper.md @@ -0,0 +1,42 @@ +ks-mp4k-wrapper - Wrapper for ks-mp4k to create graphical interfaces. +===================================================================== + +### TRACKS/CONFIG DETECT:: + + * `$ ks-mp4k-wrapper --show-info ` + * `$ ks-mp4k-wrapper --show-video-default ` + * `$ ks-mp4k-wrapper --show-audio-default ` + * `$ ks-mp4k-wrapper --show-subtitle-default ` + * `$ ks-mp4k-wrapper --show-resolution-default` + +### METADATA DETECT: + + * `$ ks-mp4k-wrapper --show-name-title-default ` + * `$ ks-mp4k-wrapper --show-year-default` + * `$ ks-mp4k-wrapper --show-genre-default` + +### CONVERT: + + * `$ ks-mp4k-wrapper --conv "" "" [patch]` + * `$ ks-mp4k-wrapper --conv-with-sub "" "" [patch]` + +### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED): + + * `$ ks-mp4k-wrapper --conv ` + * `$ ks-mp4k-wrapper --conv-with-sub ` + +### EXAMPLES: + + * `$ ks-mp4k-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 3840x2160 "My video" 2018 "Comedy"` + * `$ ks-mp4k-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"` + * `$ ks-mp4k-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 3840x2160 "My video" 2018 "Comedy" patch` + +### Notes: + + * The option `patch` apply the `-thread_queue_size 2048` patch to ffmpeg. + * If you specify a path or file with spaces, you must use quotes. + +### Back to README.md + +* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md) + \ No newline at end of file diff --git a/doc/ks-mp4s-wrapper.md b/doc/ks-mp4s-wrapper.md new file mode 100644 index 0000000..2d95ad6 --- /dev/null +++ b/doc/ks-mp4s-wrapper.md @@ -0,0 +1,42 @@ +ks-mp4s-wrapper - Wrapper for ks-mp4s to create graphical interfaces. +=================================================================== + +### TRACKS/CONFIG DETECT:: + + * `$ ks-mp4s-wrapper --show-info ` + * `$ ks-mp4s-wrapper --show-video-default ` + * `$ ks-mp4s-wrapper --show-audio-default ` + * `$ ks-mp4s-wrapper --show-subtitle-default ` + * `$ ks-mp4s-wrapper --show-resolution-default` + +### METADATA DETECT: + + * `$ ks-mp4s-wrapper --show-name-title-default ` + * `$ ks-mp4s-wrapper --show-year-default` + * `$ ks-mp4s-wrapper --show-genre-default` + +### CONVERT: + + * `$ ks-mp4s-wrapper --conv "" "" [patch]` + * `$ ks-mp4s-wrapper --conv-with-sub "" "" [patch]` + +### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED): + + * `$ ks-mp4s-wrapper --conv ` + * `$ ks-mp4s-wrapper --conv-with-sub ` + +### EXAMPLES: + + * `$ ks-mp4s-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x404 "My video" 2018 "Comedy"` + * `$ ks-mp4s-wrapper --conv-with-sub /tmp/video.mkv /tmp/output 0:0 0:1 0:3 1280x720 "My video" 2018 "Comedy"` + * `$ ks-mp4s-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x480 "My video" 2018 "Comedy" patch` + +### Notes: + + * The option `patch` apply the `-thread_queue_size 2048` patch to ffmpeg. + * If you specify a path or file with spaces, you must use quotes. + +### Back to README.md + +* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md) + \ No newline at end of file diff --git a/doc/ks-upa.md b/doc/ks-upa.md index bea7f88..8dfcf30 100644 --- a/doc/ks-upa.md +++ b/doc/ks-upa.md @@ -3,18 +3,18 @@ ks-upa - Upload audio file(s) to server with rsync+ssh. ### Sintax: - * `ks-upa -i - Start upload` - * `ks-upa -r - Remove configuration` - * `ks-upa -c - Show configuration` - * `ks-upa -e - Edit configuration` - * `ks-upa -v - Show version` - * `ks-upa -h - Show help` + * `$ ks-upa -i - Start upload` + * `$ ks-upa -r - Remove configuration` + * `$ ks-upa -c - Show configuration` + * `$ ks-upa -e - Edit configuration` + * `$ ks-upa -v - Show version` + * `$ ks-upa -h - Show help` ### Initialize audio file(s) upload: * For initialize audio file(s) upload only run the following command: - * `ks-upa -i` + * `$ ks-upa -i` * The first time you run the command, you will be asked for the necessary connection information: @@ -30,13 +30,13 @@ ks-upa - Upload audio file(s) to server with rsync+ssh. * If you want to clear the connection settings, you just need to run the following command: - * `ks-upa -r` + * `$ ks-upa -r` ### Show configuration: * You can check the configuration with the following command: - * `ks-upa -c` + * `$ ks-upa -c` * When consulting the configuration, we will see something like this: @@ -50,7 +50,7 @@ ks-upa - Upload audio file(s) to server with rsync+ssh. * To edit any section of the configuration, the following command would be executed: - * `ks-upa -e` + * `$ ks-upa -e` * After its execution, we will see a menu like the following one to be able to edit the desired section: @@ -68,7 +68,7 @@ ks-upa - Upload audio file(s) to server with rsync+ssh. * You can check the version with the command: - * `ks-upa -v` + * `$ ks-upa -v` ### Back to README.md diff --git a/doc/ks-upf.md b/doc/ks-upf.md index ec4c81b..209f80c 100644 --- a/doc/ks-upf.md +++ b/doc/ks-upf.md @@ -3,18 +3,18 @@ ks-upf - Upload common file(s) to server with rsync+ssh. ### Sintax: - * `ks-upf -i - Start upload` - * `ks-upf -r - Remove configuration` - * `ks-upf -c - Show configuration` - * `ks-upf -e - Edit configuration` - * `ks-upf -v - Show version` - * `ks-upf -h - Show help` + * `$ ks-upf -i - Start upload` + * `$ ks-upf -r - Remove configuration` + * `$ ks-upf -c - Show configuration` + * `$ ks-upf -e - Edit configuration` + * `$ ks-upf -v - Show version` + * `$ ks-upf -h - Show help` ### Initialize common file(s) upload: * For initialize file(s) upload only un the following command: - * `ks-upf -i` + * `$ ks-upf -i` * The first time you run the command, you will be asked for the necessary connection information: @@ -30,13 +30,13 @@ ks-upf - Upload common file(s) to server with rsync+ssh. * If you want to clear the connection settings, you just need to run the following command: - * `ks-upf -r` + * `$ ks-upf -r` ### Show configuration: * You can check the configuration with the following command: - * `ks-upf -c` + * `$ ks-upf -c` * When consulting the configuration, we will see something like this: @@ -50,7 +50,7 @@ ks-upf - Upload common file(s) to server with rsync+ssh. * To edit any section of the configuration, the following command would be executed: - * `ks-upf -e` + * `$ ks-upf -e` * After its execution, we will see a menu like the following one to be able to edit the desired section: @@ -68,7 +68,7 @@ ks-upf - Upload common file(s) to server with rsync+ssh. * You can check the version with the command: - * `ks-upf -v` + * `$ ks-upf -v` ### Back to README.md diff --git a/doc/ks-upr.md b/doc/ks-upr.md index c7bea2e..02169ef 100644 --- a/doc/ks-upr.md +++ b/doc/ks-upr.md @@ -3,18 +3,18 @@ ks-upr - Upload recursively file(s) to server with rsync+ssh. ### Sintax: - * `ks-upr -i - Start upload` - * `ks-upr -r - Remove configuration` - * `ks-upr -c - Show configuration` - * `ks-upr -e - Edit configuration` - * `ks-upr -v - Show version` - * `ks-upr -h - Show help` + * `$ ks-upr -i - Start upload` + * `$ ks-upr -r - Remove configuration` + * `$ ks-upr -c - Show configuration` + * `$ ks-upr -e - Edit configuration` + * `$ ks-upr -v - Show version` + * `$ ks-upr -h - Show help` ### Initialize common file(s) upload: * For initialize recursively upload only un the following command: - * `ks-upr -i` + * `$ ks-upr -i` * The first time you run the command, you will be asked for the necessary connection information: @@ -30,13 +30,13 @@ ks-upr - Upload recursively file(s) to server with rsync+ssh. * If you want to clear the connection settings, you just need to run the following command: - * `ks-upr -r` + * `$ ks-upr -r` ### Show configuration: * You can check the configuration with the following command: - * `ks-upr -c` + * `$ ks-upr -c` * When consulting the configuration, we will see something like this: @@ -50,7 +50,7 @@ ks-upr - Upload recursively file(s) to server with rsync+ssh. * To edit any section of the configuration, the following command would be executed: - * `ks-upr -e` + * `$ ks-upr -e` * After its execution, we will see a menu like the following one to be able to edit the desired section: @@ -68,7 +68,7 @@ ks-upr - Upload recursively file(s) to server with rsync+ssh. * You can check the version with the command: - * `ks-upr -v` + * `$ ks-upr -v` ### Back to README.md diff --git a/doc/ks-upv.md b/doc/ks-upv.md index cca8853..95a9103 100644 --- a/doc/ks-upv.md +++ b/doc/ks-upv.md @@ -3,18 +3,18 @@ ks-upv - Upload videos file(s) to server with rynsc+ssh. ### Sintax: - * `ks-upv -i - Start upload` - * `ks-upv -r - Remove configuration` - * `ks-upv -c - Show configuration` - * `ks-upv -e - Edit configuration` - * `ks-upv -v - Show version` - * `ks-upv -h - Show help` + * `$ ks-upv -i - Start upload` + * `$ ks-upv -r - Remove configuration` + * `$ ks-upv -c - Show configuration` + * `$ ks-upv -e - Edit configuration` + * `$ ks-upv -v - Show version` + * `$ ks-upv -h - Show help` ### Initialize video file(s) upload: * For initialize video file(s) upload only un the following command: - * `ks-upv -i` + * `$ ks-upv -i` * The first time you run the command, you will be asked for the necessary connection information: @@ -30,13 +30,13 @@ ks-upv - Upload videos file(s) to server with rynsc+ssh. * If you want to clear the connection settings, you just need to run the following command: - * `ks-upv -r` + * `$ ks-upv -r` ### Show configuration: * You can check the configuration with the following command: - * `ks-upv -c` + * `$ ks-upv -c` * When consulting the configuration, we will see something like this: @@ -50,7 +50,7 @@ ks-upv - Upload videos file(s) to server with rynsc+ssh. * To edit any section of the configuration, the following command would be executed: - * `ks-upv -e` + * `$ ks-upv -e` * After its execution, we will see a menu like the following one to be able to edit the desired section: @@ -68,7 +68,7 @@ ks-upv - Upload videos file(s) to server with rynsc+ssh. * You can check the version with the command: - * `ks-upv -v` + * `$ ks-upv -v` ### Back to README.md diff --git a/doc/ks-vob-wrapper.md b/doc/ks-vob-wrapper.md new file mode 100644 index 0000000..c8fc63b --- /dev/null +++ b/doc/ks-vob-wrapper.md @@ -0,0 +1,37 @@ +ks-vob-wrapper - Wrapper for ks-vob to create graphical interfaces. +=================================================================== + +### TRACKS/CONFIG DETECT:: + + * `$ ks-vob-wrapper --show-info ` + * `$ ks-vob-wrapper --show-video-default ` + * `$ ks-vob-wrapper --show-audio-default ` + * `$ ks-vob-wrapper --show-resolution-default` + +### CONVERT: + + * `$ ks-vob-wrapper --conv [patch]` + +### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED): + + * `$ ks-vob-wrapper --conv ` + +### CONVERT WITH DEFAULT DETECTION (NOT RECOMMENDED): + + * `$ ks-vob-wrapper --conv ` + * `$ ks-vob-wrapper --conv-with-sub ` + +### EXAMPLES: + + * `$ ks-vob-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x480` + * `$ ks-vob-wrapper --conv /tmp/video.mkv /tmp/output 0:0 0:1 720x576 patch` + +### Notes: + + * The option `patch` apply the `-thread_queue_size 2048` patch to ffmpeg. + * If you specify a path or file with spaces, you must use quotes. + +### Back to README.md + +* [Go back](https://github.com/q3aql/ks-tools/blob/main/README.md) + \ No newline at end of file