summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMineralwater Xu <[email protected]>2021-10-20 17:15:31 +0800
committerMineralwater Xu <[email protected]>2021-10-20 17:15:31 +0800
commit940e4a034100584cb686df4d79a77c0a61232fe0 (patch)
tree6da39ac8a6e0c2f82907b1ca527fc82ba7154ba3
parent528cebefcd45b18a8ebaedf2afeea613db95aa6a (diff)
add man page
-rw-r--r--mkvtool/mkvtool.174
1 files changed, 74 insertions, 0 deletions
diff --git a/mkvtool/mkvtool.1 b/mkvtool/mkvtool.1
new file mode 100644
index 0000000..ef8bc3d
--- /dev/null
+++ b/mkvtool/mkvtool.1
@@ -0,0 +1,74 @@
+.TH MKVTOOL 1
+.SH NAME
+mkvtool \- Automatic fonts subset tool.
+.SH SYNOPSIS
+.B mkvtool
+.RB [ input_options ]
+.RB [ input_url ]
+.RB [ output_options ]
+.RB [ output_url ]
+.SH DESCRIPTION
+mkvtool is an automatic fonts subset tool. It can help you extract certain character(letter) fonts in special effect subtitles(.ass or .ssa format) from videos, and re-package mkv files in order to decrease file size.
+.SH OPTIONS
+.TP
+.B \-a [value]
+ASS files. (multiple & join ass mode)
+.TP
+.B \-af [string]
+ASS fonts folder. (ass mode only)
+.TP
+.B \-ans
+ASS output not to the new "subsetted" folder. (ass mode only)
+.TP
+.B \-ao [string]
+ASS output folder. (ass mode only)
+.TP
+.B \-c
+Create mode.
+.TP
+.B \-clean
+Clean original file subtitles and fonts. (create mode only)
+.TP
+.B \-d
+Dump mode.
+.TP
+.B \-data [string]
+Subtitles & Fonts folder (dump & make mode only) (default "data")
+.TP
+.B \-dist [string]
+Results output folder (make mode only) (default "dist")
+.TP
+.B \-f [string]
+MKV file. (join single mode)
+.TP
+.B \-log [string]
+Log file path
+.TP
+.B \-m
+Make mode.
+.TP
+.B \-n
+Not do ass font subset. (dump mode only)
+.TP
+.B \-q
+Query mode.
+.TP
+.B \-s [string]
+Source folder.
+.TP
+.B \-sl [string]
+Subtitle language. (create & make mode only) (default "chi")
+.TP
+.B \-st [string]
+Subtitle title. (create & make mode only)
+.TP
+.B \-v
+Show app info.
+.SH EXAMPLES
+You can find examples in README.md.
+.SH BUGS
+UNKNOWN
+.SH AUTHOR
+Written by anonym.
+.SH COPYRIGHT
+Under GNU GENERAL PUBLIC LICENSE Version 3. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.