From fe9abbc060315745388fd40f618a177a12beda60 Mon Sep 17 00:00:00 2001 From: Moritz Bunkus Date: Sat, 26 Dec 2009 22:16:03 +0100 Subject: [PATCH] Re-built the man pages with current DocBook. --- doc/man/mkvextract.1 | 73 ++++++- doc/man/mkvinfo.1 | 51 ++++- doc/man/mkvmerge.1 | 487 +++++++++++++++++++++++++++++++++++++----- doc/man/mkvpropedit.1 | 55 ++++- doc/man/mmg.1 | 22 +- 5 files changed, 601 insertions(+), 87 deletions(-) diff --git a/doc/man/mkvextract.1 b/doc/man/mkvextract.1 index 410dd841b..01460077f 100644 --- a/doc/man/mkvextract.1 +++ b/doc/man/mkvextract.1 @@ -1,19 +1,27 @@ +'\" t .\" Title: mkvextract .\" Author: Moritz Bunkus -.\" Generator: DocBook XSL Stylesheets v1.73.2 +.\" Generator: DocBook XSL Stylesheets v1.75.1 .\" Date: December 2009 .\" Manual: User Commands .\" Source: MkvToolNix 3.0.0 +.\" Language: English .\" .TH "MKVEXTRACT" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -mkvextract \- extract tracks from Matroska files into other files +mkvextract \- extract tracks from Matroska(TM) files into other files .SH "SYNOPSIS" -.HP 11 +.HP \w'\fBmkvextract\fR\ 'u \fBmkvextract\fR {mode} {source\-filename} [options] [extraction\-spec] .SH "DESCRIPTION" .PP @@ -95,7 +103,9 @@ Reads additional command line arguments from the file .sp The command line \'\fBmkvextract tracks source\&.mkv \-\-raw 1:destination\&.raw\fR\' could be converted into the following option file: .sp +.if n \{\ .RS 4 +.\} .nf # Extract a track from source\&.mkv tracks @@ -105,7 +115,9 @@ source\&.mkv 1:destination\&.raw .fi +.if n \{\ .RE +.\} .RE .SS "Track extraction mode" .PP @@ -184,12 +196,16 @@ option\&. .sp Each output name should be used only once\&. The exception are RealAudio and RealVideo tracks\&. If you use the same name for different tracks then those tracks will be saved in the same file\&. Example: .sp +.if n \{\ .RS 4 +.\} .nf $ mkvextract tracks input\&.mkv 1:output\-two\-tracks\&.rm 2:output\-two\-tracks\&.rm .fi +.if n \{\ .RE +.\} .RE .SS "Tags extraction mode" .PP @@ -279,36 +295,52 @@ itself\&. .PP The shell\'s builtin redirection mechanism is used by appending \'> output\-filename\&.ext\' to the command line\&. Example: .sp +.if n \{\ .RS 4 +.\} .nf $ mkvextract tags source\&.mkv > tags\&.xml .fi +.if n \{\ .RE +.\} .PP \fBmkvextract\fR(1)\'s own redirection is invoked with the \fB\-\-redirect\-output\fR option\&. Example: .sp +.if n \{\ .RS 4 +.\} .nf $ mkvextract tags source\&.mkv \-\-redirect\-output tags\&.xml .fi +.if n \{\ .RE +.\} +.if n \{\ .sp +.\} +.RS 4 .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br -Note +.ps +1 +\fBNote\fR +.ps -1 +.br .PP On Windows you should probably use the \fB\-\-redirect\-output\fR option because \fBcmd\&.exe\fR sometimes interpretes special characters before they\'re written into the output file resulting in broken output\&. +.sp .5v +.RE .SH "OUTPUT FILE FORMATS" .PP The decision about the output format is based on the track type, not on the extension used for the output file name\&. The following track types are supported at the moment: @@ -472,13 +504,27 @@ Timecodes are first sorted and then output as a timecode v2 format compliant fil exits with one of three exit codes: .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB0\fR \-\- This exit codes means that extraction has completed successfully\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB1\fR \-\- In this case \fBmkvextract\fR(1) @@ -486,7 +532,14 @@ has output at least one warning, but extraction did continue\&. A warning is pre .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB2\fR \-\- This exit code is used after an error occured\&. \fBmkvextract\fR(1) @@ -502,13 +555,13 @@ aborts right after outputting the error message\&. Error messages range from wro .SH "WWW" .PP The latest version can always be found at -\fIthe MKVToolNix homepage\fR\&[1]\&. +\m[blue]\fBthe MKVToolNix homepage\fR\m[]\&\s-2\u[1]\d\s+2\&. .SH "AUTHOR" .PP \fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&> -.sp -1n -.IP "" 4 +.RS 4 Developer +.RE .SH "NOTES" .IP " 1." 4 the MKVToolNix homepage diff --git a/doc/man/mkvinfo.1 b/doc/man/mkvinfo.1 index b2411df37..800f2a364 100644 --- a/doc/man/mkvinfo.1 +++ b/doc/man/mkvinfo.1 @@ -1,19 +1,27 @@ +'\" t .\" Title: mkvinfo .\" Author: Moritz Bunkus -.\" Generator: DocBook XSL Stylesheets v1.73.2 +.\" Generator: DocBook XSL Stylesheets v1.75.1 .\" Date: December 2009 .\" Manual: User Commands .\" Source: MkvToolNix 3.0.0 +.\" Language: English .\" .TH "MKVINFO" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -mkvinfo \- Print information about elements in Matroska files +mkvinfo \- Print information about elements in Matroska(TM) files .SH "SYNOPSIS" -.HP 8 +.HP \w'\fBmkvinfo\fR\ 'u \fBmkvinfo\fR [options] {source\-filename} .SH "DESCRIPTION" .PP @@ -101,7 +109,9 @@ Reads additional command line arguments from the file .sp The command line \'\fBmkvinfo \-v \-v input\&.mkv \-\-redirect\-output info\&.txt\fR\' could be converted into the following option file: .sp +.if n \{\ .RS 4 +.\} .nf # Be more verbose \-v @@ -113,7 +123,9 @@ input\&.mkv info\&.txt .fi +.if n \{\ .RE +.\} .RE .SH "VERBOSITY LEVELS" .PP @@ -154,13 +166,27 @@ element\&. All other elements only print stuff about the elements that were just exits with one of three exit codes: .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB0\fR \-\- This exit codes means that the run has completed successfully\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB1\fR \-\- In this case \fBmkvinfo\fR(1) @@ -168,7 +194,14 @@ has output at least one warning, but the run did continue\&. A warning is prefix .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB2\fR \-\- This exit code is used after an error occured\&. \fBmkvinfo\fR(1) @@ -184,13 +217,13 @@ aborts right after outputting the error message\&. Error messages range from wro .SH "WWW" .PP The latest version can always be found at -\fIthe MKVToolNix homepage\fR\&[1]\&. +\m[blue]\fBthe MKVToolNix homepage\fR\m[]\&\s-2\u[1]\d\s+2\&. .SH "AUTHOR" .PP \fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&> -.sp -1n -.IP "" 4 +.RS 4 Developer +.RE .SH "NOTES" .IP " 1." 4 the MKVToolNix homepage diff --git a/doc/man/mkvmerge.1 b/doc/man/mkvmerge.1 index cf28a8f26..7e5c8182c 100644 --- a/doc/man/mkvmerge.1 +++ b/doc/man/mkvmerge.1 @@ -1,26 +1,34 @@ +'\" t .\" Title: mkvmerge .\" Author: Moritz Bunkus -.\" Generator: DocBook XSL Stylesheets v1.73.2 +.\" Generator: DocBook XSL Stylesheets v1.75.1 .\" Date: December 2009 .\" Manual: User Commands .\" Source: MkvToolNix 3.0.0 +.\" Language: English .\" .TH "MKVMERGE" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -mkvmerge \- Merge multimedia streams into a Matroska file +mkvmerge \- Merge multimedia streams into a Matroska(TM) file .SH "SYNOPSIS" -.HP 9 +.HP \w'\fBmkvmerge\fR\ 'u \fBmkvmerge\fR [global\ options] {\-o\ out} [options1] {file1} [[options2]\ {file2}] [@optionsfile] .SH "DESCRIPTION" .PP This program takes the input from several media files and joins their streams (all of them or just a selection) into a Matroska(TM) file; see -\fIthe Matroska(TM) website\fR\&[1]\&. +\m[blue]\fBthe Matroska(TM) website\fR\m[]\&\s-2\u[1]\d\s+2\&. .PP Global options: .PP @@ -129,26 +137,54 @@ defaults to the format \'%p \- %t\' (the performer, followed by a space, a dash, If the format is given then everything except the following meta characters is copied as\-is, and the meta characters are replaced like this: .sp .RS 4 -\h'-04'\(bu\h'+03'\fI%p\fR +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fI%p\fR is replaced by the current entry\'s \fIPERFORMER\fR string, .RE .sp .RS 4 -\h'-04'\(bu\h'+03'\fI%t\fR +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fI%t\fR is replaced by the current entry\'s \fITITLE\fR string, .RE .sp .RS 4 -\h'-04'\(bu\h'+03'\fI%n\fR +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fI%n\fR is replaced by the current track number and .RE .sp .RS 4 -\h'-04'\(bu\h'+03'\fI%N\fR +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fI%N\fR is replaced by the current track number padded with a leading zero if it is < 10\&. .RE .RE @@ -274,7 +310,14 @@ At the moment supports three different modes\&. .sp .RS 4 -\h'-04' 1.\h'+02'Splitting by size\&. +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +Splitting by size\&. .sp Syntax: \fB\-\-split\fR @@ -293,7 +336,14 @@ The \'size:\' prefix may be omitted for compatibility reasons\&. .RE .sp .RS 4 -\h'-04' 2.\h'+02'Splitting after a duration\&. +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +Splitting after a duration\&. .sp Syntax: \fB\-\-split\fR @@ -322,7 +372,14 @@ The \'duration:\' prefix may be omitted for compatibility reasons\&. .RE .sp .RS 4 -\h'-04' 3.\h'+02'Splitting after specific timecodes\&. +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +Splitting after specific timecodes\&. .sp Syntax: \fB\-\-split\fR @@ -403,13 +460,17 @@ If this option has been omitted then a standard mapping is used\&. This standard .RS 4 A single \'+\' causes the next file to be appended instead of added\&. The \'+\' can also be put in front of the next file name\&. Therefore the following two commands are equivalent: .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o full\&.mkv file1\&.mkv + file2\&.mkv $ mkvmerge \-o full\&.mkv file1\&.mkv +file2\&.mkv .fi +.if n \{\ .RE +.\} .RE .PP Attachment support (more global options): @@ -434,7 +495,7 @@ or option\&. A list of officially recognized MIME types can be found e\&.g\&. at -\fIthe IANA homepage\fR\&[2]\&. The +\m[blue]\fBthe IANA homepage\fR\m[]\&\s-2\u[2]\d\s+2\&. The MIME type is mandatory for an attachment\&. .RE @@ -959,7 +1020,9 @@ Reads additional command line arguments from the file .sp The command line \'\fBmkvmerge \-o "my file\&.mkv" \-A "a movie\&.avi" sound\&.ogg\fR\' could be converted into the following option file: .sp +.if n \{\ .RS 4 +.\} .nf # Write to the file "my file\&.mkv"\&. \-o @@ -970,7 +1033,9 @@ a movie\&.avi sound\&.ogg .fi +.if n \{\ .RE +.\} .RE .PP \fB\-\-capabilities\fR @@ -978,7 +1043,14 @@ sound\&.ogg Lists information about optional features that have been compiled in and exit\&. The first line output will be the version information\&. All following lines contain exactly one word whose presence indicates that the feature has been compiled in\&. These features are: .sp .RS 4 -\h'-04'\(bu\h'+03'\'BZ2\' \-\- the +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\'BZ2\' \-\- the bzlib(TM) compression library\&. Affects the available compression methods for the \fB\-\-compression\fR @@ -986,7 +1058,14 @@ option\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03'\'LZO\' \-\- the +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\'LZO\' \-\- the lzo(TM) compression library\&. Affects the available compression methods for the \fB\-\-compression\fR @@ -994,7 +1073,14 @@ option\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03'\'FLAC\' \-\- reading raw +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\'FLAC\' \-\- reading raw FLAC files and handling FLAC @@ -1027,19 +1113,27 @@ option\&. Let\'s assume you have a file called MyMovie\&.avi and the audio track in a separate file, e\&.g\&. \'MyMovie\&.wav\'\&. First you want to encode the audio to OggVorbis(TM): .sp +.if n \{\ .RS 4 +.\} .nf $ oggenc \-q4 \-oMyMovie\&.ogg MyMovie\&.wav .fi +.if n \{\ .RE +.\} .PP After a couple of minutes you can join video and audio: .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o MyMovie\-with\-sound\&.mkv MyMovie\&.avi MyMovie\&.ogg .fi +.if n \{\ .RE +.\} .PP If your AVI @@ -1047,29 +1141,41 @@ already contains an audio track then it will be copied as well (if \fBmkvmerge\fR(1) supports the audio format)\&. To avoid that simply do .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o MyMovie\-with\-sound\&.mkv \-A MyMovie\&.avi MyMovie\&.ogg .fi +.if n \{\ .RE +.\} .PP After some minutes of consideration you rip another audio track, e\&.g\&. the director\'s comments or another language to \'MyMovie\-add\-audio\&.wav\'\&. Encode it again and join it up with the other file: .sp +.if n \{\ .RS 4 +.\} .nf $ oggenc \-q4 \-oMyMovie\-add\-audio\&.ogg MyMovie\-add\-audio\&.wav $ mkvmerge \-o MM\-complete\&.mkv MyMovie\-with\-sound\&.mkv MyMovie\-add\-audio\&.ogg .fi +.if n \{\ .RE +.\} .PP The same result can be achieved with .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o MM\-complete\&.mkv \-A MyMovie\&.avi MyMovie\&.ogg MyMovie\-add\-audio\&.ogg .fi +.if n \{\ .RE +.\} .PP Now fire up mplayer(TM) @@ -1079,19 +1185,27 @@ which track to play with the \'\fB\-vid\fR\' and \'\fB\-aid\fR\' options\&. Thes .PP If you need an audio track synchronized you can do that easily\&. First find out which track ID the Vorbis track has with .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-\-identify outofsync\&.ogg .fi +.if n \{\ .RE +.\} .PP Now you can use that ID in the following command line: .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o goodsync\&.mkv \-A source\&.avi \-y 12345:200 outofsync\&.ogg .fi +.if n \{\ .RE +.\} .PP This would add 200ms of silence at the beginning of the audio track with the ID \fB12345\fR @@ -1108,11 +1222,15 @@ seconds correspond to approx\&. \fB6\fR frames\&. So I did .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o goodsync\&.mkv \-y 23456:0,77346/77340 outofsync\&.mkv .fi +.if n \{\ .RE +.\} .PP The result was fine\&. .PP @@ -1125,73 +1243,129 @@ package found in \fBtranscode\fR(1)\'s sources in the \'contrib/subrip\' directory\&. The general process is: .sp .RS 4 -\h'-04' 1.\h'+02'extract a raw subtitle stream from the source: +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +extract a raw subtitle stream from the source: .sp +.if n \{\ .RS 4 +.\} .nf $ tccat \-i /path/to/copied/dvd/ \-T 1 \-L | tcextract \-x ps1 \-t vob \-a 0x20 | subtitle2pgm \-o mymovie .fi +.if n \{\ .RE +.\} .RE .sp .RS 4 -\h'-04' 2.\h'+02'convert the resulting PGM images to text with gocr: +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +convert the resulting PGM images to text with gocr: .sp +.if n \{\ .RS 4 +.\} .nf $ pgm2txt mymovie .fi +.if n \{\ .RE +.\} .RE .sp .RS 4 -\h'-04' 3.\h'+02'spell\-check the resulting text files: +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +spell\-check the resulting text files: .sp +.if n \{\ .RS 4 +.\} .nf $ ispell \-d american *txt .fi +.if n \{\ .RE +.\} .RE .sp .RS 4 -\h'-04' 4.\h'+02'convert the text files to a SRT file: +.ie n \{\ +\h'-04' 4.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 4." 4.2 +.\} +convert the text files to a SRT file: .sp +.if n \{\ .RS 4 +.\} .nf $ srttool \-s \-w \-i mymovie\&.srtx \-o mymovie\&.srt .fi +.if n \{\ .RE +.\} .RE .PP The resulting file can be used as another input file for \fBmkvmerge\fR(1): .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o mymovie\&.mkv mymovie\&.avi mymovie\&.srt .fi +.if n \{\ .RE +.\} .PP If you want to specify the language for a given track then this is easily done\&. First find out the ISO639\-2 code for your language\&. \fBmkvmerge\fR(1) can list all of those codes for you: .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-\-list\-languages .fi +.if n \{\ .RE +.\} .PP Search the list for the languages you need\&. Let\'s assume you have put two audio tracks into a Matroska(TM) file and want to set their language codes and that their track IDs are 2 and 3\&. This can be done with .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o with\-lang\-codes\&.mkv \-\-language 2:ger \-\-language 3:dut without\-lang\-codes\&.mkv .fi +.if n \{\ .RE +.\} .PP As you can see you can use the \fB\-\-language\fR @@ -1199,11 +1373,15 @@ switch multiple times\&. .PP Maybe you\'d also like to have the player use the Dutch language as the default language\&. You also have extra subtitles, e\&.g\&. in English and French, and want to have the player display the French ones by default\&. This can be done with .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o with\-lang\-codes\&.mkv \-\-language 2:ger \-\-language 3:dut \-\-default\-track 3 without\-lang\-codes\&.mkv \-\-language 0:eng english\&.srt \-\-default\-track 0 \-\-language 0:fre french\&.srt .fi +.if n \{\ .RE +.\} .PP If you do not see the language or default track flags that you\'ve specified in \fBmkvinfo\fR(1)\'s output then please read the section about @@ -1218,7 +1396,9 @@ is called with the \fB\-\-identify\fR option\&. An example for such output: .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-i v\&.mkv File \'v\&.mkv\': container: Matroska(TM) @@ -1226,18 +1406,34 @@ Track ID 1: video (V_MS/VFW/FOURCC, DIV3) Track ID 2: audio (A_MPEG/L3) .fi +.if n \{\ .RE +.\} .PP Track IDs are assigned like this: .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + AVI files: The video track has the ID 0\&. The audio tracks get IDs in ascending order starting at 1\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + AAC, AC3, MP3, @@ -1248,12 +1444,26 @@ files: The one \'track\' in that file gets the ID 0\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Ogg/OGM +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Ogg/OGM files: The track IDs are assigned in order the tracks are found in the file starting at 0\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + Matroska(TM) files: The track\'s ID is the track number as reported by \fBmkvinfo\fR(1)\&. It is @@ -1270,15 +1480,23 @@ The options that use the track IDs are the ones whose description contains \'TID and \fB\-\-btracks\fR\&. .SH "TEXT FILES AND CHARACTER SET CONVERSIONS" +.if n \{\ .sp +.\} +.RS 4 .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br -Note +.ps +1 +\fBNote\fR +.ps -1 +.br .PP This section applies to all programs in MkvToolNix even if it only mentions \fBmkvmerge\fR(1)\&. +.sp .5v +.RE .PP All text in a Matroska(TM) @@ -1332,25 +1550,53 @@ system call\&. This is the default character set for all strings read from the c The following options exist that allow specifying the character sets: .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB\-\-sub\-charset\fR for text subtitle files and for text subtitle tracks stored in container formats for which the character set cannot be determined unambiguously (e\&.g\&. Ogg files), .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB\-\-chapter\-charset\fR for chapter text files and for chapters and file titles stored in container formats for which the character set cannot be determined unambiguously (e\&.g\&. Ogg files for chapter information, track and file titles etc; MP4 files for chapter information), .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB\-\-command\-line\-charset\fR for all strings on the command line, .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB\-\-output\-charset\fR for all strings written to the console or to a file if the output has been redirected with the \fB\-\-redirect\-output\fR @@ -1370,19 +1616,47 @@ converts between character sets)\&. Kate subtitles are already encoded in UTF\-8 The following subtitle formats are supported at the moment: .sp .RS 4 -\h'-04'\(bu\h'+03'Subtitle Ripper (SRT) files +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Subtitle Ripper (SRT) files .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Substation Alpha (SSA) / Advanced Substation Alpha scripts (ASS) +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Substation Alpha (SSA) / Advanced Substation Alpha scripts (ASS) .RE .sp .RS 4 -\h'-04'\(bu\h'+03'OggKate streams +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +OggKate streams .RE .sp .RS 4 -\h'-04'\(bu\h'+03'VobSub bitmap subtitle files +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +VobSub bitmap subtitle files .RE .SH "FILE LINKING" .PP @@ -1472,12 +1746,16 @@ Here\'s an example how to attach a photo and a TrueType(TM) font to the output file: .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o output\&.mkv \-A video\&.avi sound\&.ogg \-\-attachment\-description "Me and the band behind the stage in a small get\-together" \-\-attachment\-mime\-type image/jpeg \-\-attach\-file me_and_the_band\&.jpg \-\-attachment\-description "The real rare and unbelievably good looking font" \-\-attachment\-type application/octet\-stream \-\-attach\-file really_cool_font\&.ttf .fi +.if n \{\ .RE +.\} .PP If a Matroska(TM) @@ -1494,7 +1772,7 @@ Matroska(TM) chapter system is more powerful than the old known system used by OGM files\&. The full specifications can be found at -\fIthe Matroska(TM) website\fR\&[1]\&. +\m[blue]\fBthe Matroska(TM) website\fR\m[]\&\s-2\u[1]\d\s+2\&. .PP \fBmkvmerge\fR(1) @@ -1508,7 +1786,9 @@ Matroska(TM)\'s chapter functionality\&. .PP This formmat consists of pairs of lines that start with \'CHAPTERxx=\' and \'CHAPTERxxNAME=\' respectively\&. The first one contains the start timecode while the second one contains the title\&. Here\'s an example: .sp +.if n \{\ .RS 4 +.\} .nf CHAPTER01=00:00:00\&.000 CHAPTER01NAME=Intro @@ -1518,7 +1798,9 @@ CHAPTER03=00:02:42\&.300 CHAPTER03NAME=Baby rocks the house .fi +.if n \{\ .RE +.\} .PP \fBmkvmerge\fR(1) @@ -1539,7 +1821,9 @@ The XML based chapter format looks like this example: .sp +.if n \{\ .RS 4 +.\} .nf @@ -1565,24 +1849,47 @@ based chapter format looks like this example: .fi +.if n \{\ .RE +.\} .PP With this format three things are possible that are not possible with the simple chapter format: .sp .RS 4 -\h'-04' 1.\h'+02'The timestamp for the end of the chapter can be set, +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +The timestamp for the end of the chapter can be set, .RE .sp .RS 4 -\h'-04' 2.\h'+02'chapters can be nested, +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +chapters can be nested, .RE .sp .RS 4 -\h'-04' 3.\h'+02'the language and country can be set\&. +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +the language and country can be set\&. .RE .PP The mkvtoolnix distribution contains some sample files in the -\fIdoc\fR +doc subdirectory which can be used as a basis\&. .SS "General notes" .PP @@ -1623,14 +1930,14 @@ these tags can also be nested, and both the and the \fIVALUE\fR are elements of their own\&. The example file -\fIexample\-tags\-2\&.xml\fR +example\-tags\-2\&.xml shows how to use this new system\&. .SS "Scope of the tags" .PP Matroska(TM) tags do not automatically apply to the complete file\&. They can, but they also may apply to different parts of the file: to one or more tracks, to one or more chapters, or even to a combination of both\&. The -\fIthe Matroska(TM) specification\fR\&[3] +\m[blue]\fBthe Matroska(TM) specification\fR\m[]\&\s-2\u[3]\d\s+2 gives more details about this fact\&. .PP One important fact is that tags are linked to tracks or chapters with the @@ -1677,12 +1984,16 @@ Targets elements and call \fBmkvmerge\fR(1): .sp +.if n \{\ .RS 4 +.\} .nf $ mkvmerge \-o file\&.mkv \-\-tags 0:tags\&.xml file\&.avi .fi +.if n \{\ .RE +.\} .SS "Tag file format" .PP @@ -1690,26 +2001,47 @@ $ mkvmerge \-o file\&.mkv \-\-tags 0:tags\&.xml file\&.avi supports a XML based tag file format\&. The format is very closely modeled after -\fIthe Matroska(TM) specification\fR\&[3]\&. Both the binary and the source distributions of MkvToolNix come with a sample file called -\fIexample\-tags\-2\&.xml\fR +\m[blue]\fBthe Matroska(TM) specification\fR\m[]\&\s-2\u[3]\d\s+2\&. Both the binary and the source distributions of MkvToolNix come with a sample file called +example\-tags\-2\&.xml which simply lists all known tags and which can be used as a basis for real life tag files\&. .PP The basics are: .sp .RS 4 -\h'-04'\(bu\h'+03'The outermost element must be +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The outermost element must be \&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03'One logical tag is contained inside one pair of +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +One logical tag is contained inside one pair of XML tags\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03'White spaces directly before and after tag contents are ignored\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +White spaces directly before and after tag contents are ignored\&. .RE .SS "Data types" .PP @@ -1759,13 +2091,27 @@ will render a file in a predefined way\&. The resulting file looks like this: The elements in curly braces are optional and depend on the contents and options used\&. A couple of notes: .sp .RS 4 -\h'-04'\(bu\h'+03'meta seek #1 includes only a small number of level 1 elements, and only if they actually exist: attachments, chapters, cues, tags, meta seek #2\&. Older versions of +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +meta seek #1 includes only a small number of level 1 elements, and only if they actually exist: attachments, chapters, cues, tags, meta seek #2\&. Older versions of \fBmkvmerge\fR(1) used to put the clusters into this meta seek element as well\&. Therefore some imprecise guessing was necessary to reserve enough space\&. It often failed\&. Now only the clusters are stored in meta seek #2, and meta seek #1 refers to the meta seek element #2\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Attachment, chapter and tag elements are only present if they were added\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Attachment, chapter and tag elements are only present if they were added\&. .RE .PP The shortest possible Matroska file would look like this: @@ -1789,12 +2135,16 @@ samples\&. .PP Timecode files that are used when tracks are appended to each other must only be specified for the first part in a chain of tracks\&. For example if you append two files, v1\&.avi and v2\&.avi, and want to use timecodes then your command line must look something like this: .sp +.if n \{\ .RS 4 +.\} .nf mkvmerge \&.\&.\&. \-\-timecodes 0:my_timecodes\&.txt v1\&.avi +v2\&.avi .fi +.if n \{\ .RE +.\} .PP There are four formats that are recognized by \fBmkvmerge\fR(1)\&. The first line always contains the version number\&. Empty lines, lines containing only whitespace and lines beginning with \'#\' are ignored\&. @@ -1807,7 +2157,9 @@ is a floating point number with the dot \'\&.\' as the decimal point\&. The rang FPS is used\&. An example: .sp +.if n \{\ .RS 4 +.\} .nf # timecode format v1 assume 27\&.930 @@ -1815,14 +2167,18 @@ assume 27\&.930 1500,1700,30 .fi +.if n \{\ .RE +.\} .SS "Timecode file format v2" .PP In this format each line contains a timecode for the corresponding frame\&. This timecode must be given in millisecond precision\&. It can be a floating point number, but it doesn\'t have to be\&. You \fIhave to\fR give at least as many timecode lines as there are frames in the track\&. The timecodes in this file must be sorted\&. Example for 25fps: .sp +.if n \{\ .RS 4 +.\} .nf # timecode format v2 0 @@ -1830,14 +2186,18 @@ give at least as many timecode lines as there are frames in the track\&. The tim 80 .fi +.if n \{\ .RE +.\} .SS "Timecode file format v3" .PP In this format each line contains a duration in seconds followed by an optional number of frames per second\&. Both can be floating point numbers\&. If the number of frames per second is not present the default one is used\&. For audio you should let the codec calculate the frame timecodes itself\&. For that you should be using \fB0\&.0\fR as the number of frames per second\&. You can also create gaps in the stream by using the \'gap\' keyword followed by the duration of the gap\&. Example for an audio file: .sp +.if n \{\ .RS 4 +.\} .nf # timecode format v3 assume 0\&.0 @@ -1847,7 +2207,9 @@ gap, 10\&.050 2\&.000,38\&.236 .fi +.if n \{\ .RE +.\} .SS "Timecode file format v4" .PP This format is identical to the v2 format\&. The only difference is that the timecodes do not have to be sorted\&. This format should almost never be used\&. @@ -1858,13 +2220,27 @@ This format is identical to the v2 format\&. The only difference is that the tim exits with one of three exit codes: .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB0\fR \-\- This exit codes means that muxing has completed successfully\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB1\fR \-\- In this case \fBmkvmerge\fR(1) @@ -1872,7 +2248,14 @@ has output at least one warning, but muxing did continue\&. A warning is prefixe .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB2\fR \-\- This exit code is used after an error occured\&. \fBmkvmerge\fR(1) @@ -1888,13 +2271,13 @@ aborts right after outputting the error message\&. Error messages range from wro .SH "WWW" .PP The latest version can always be found at -\fIthe MKVToolNix homepage\fR\&[4]\&. +\m[blue]\fBthe MKVToolNix homepage\fR\m[]\&\s-2\u[4]\d\s+2\&. .SH "AUTHOR" .PP \fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&> -.sp -1n -.IP "" 4 +.RS 4 Developer +.RE .SH "NOTES" .IP " 1." 4 the Matroska(TM) website diff --git a/doc/man/mkvpropedit.1 b/doc/man/mkvpropedit.1 index c4d99922d..2b767fb2a 100644 --- a/doc/man/mkvpropedit.1 +++ b/doc/man/mkvpropedit.1 @@ -1,19 +1,27 @@ +'\" t .\" Title: mkvpropedit .\" Author: Moritz Bunkus -.\" Generator: DocBook XSL Stylesheets v1.73.2 +.\" Generator: DocBook XSL Stylesheets v1.75.1 .\" Date: December 2009 .\" Manual: User Commands .\" Source: MkvToolNix 3.0.0 +.\" Language: English .\" .TH "MKVPROPEDIT" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -mkvpropedit \- Modify properties of existing Matroska files without a complete remux +mkvpropedit \- Modify properties of existing Matroska(TM) files without a complete remux .SH "SYNOPSIS" -.HP 12 +.HP \w'\fBmkvpropedit\fR\ 'u \fBmkvpropedit\fR [options] {source\-filename} {actions} .SH "DESCRIPTION" .PP @@ -136,7 +144,9 @@ Reads additional command line arguments from the file .sp The command line \'\fBmkvpropedit source\&.mkv \-\-edit track:a2 \-\-set title=Comments\fR\' could be converted into the following option file: .sp +.if n \{\ .RS 4 +.\} .nf # Modify source\&.mkv source\&.mkv @@ -148,7 +158,9 @@ track:a2 title=Comments .fi +.if n \{\ .RE +.\} .RE .SH "EDIT SELECTORS" .PP @@ -230,12 +242,16 @@ option because editing the segment information element is the default for all op \fB\-\-edit\fR option anyway\&. .sp +.if n \{\ .RS 4 +.\} .nf $ mkvpropedit movie\&.mkv \-\-edit info \-\-set "title=The movie" \-\-edit track:a1 \-\-set language=fre \-\-edit track:a2 \-\-set language=ita .fi +.if n \{\ .RE +.\} .SH "EXIT CODES" .PP @@ -243,13 +259,27 @@ $ mkvpropedit movie\&.mkv \-\-edit info \-\-set "title=The movie" \-\-edit track exits with one of three exit codes: .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB0\fR \-\- This exit codes means that the modification has completed successfully\&. .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB1\fR \-\- In this case \fBmkvpropedit\fR(1) @@ -257,7 +287,14 @@ has output at least one warning, but the modification did continue\&. A warning .RE .sp .RS 4 -\h'-04'\(bu\h'+03' +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + \fB2\fR \-\- This exit code is used after an error occured\&. \fBmkvpropedit\fR(1) @@ -273,13 +310,13 @@ aborts right after outputting the error message\&. Error messages range from wro .SH "WWW" .PP The latest version can always be found at -\fIthe MKVToolNix homepage\fR\&[1]\&. +\m[blue]\fBthe MKVToolNix homepage\fR\m[]\&\s-2\u[1]\d\s+2\&. .SH "AUTHOR" .PP \fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&> -.sp -1n -.IP "" 4 +.RS 4 Developer +.RE .SH "NOTES" .IP " 1." 4 the MKVToolNix homepage diff --git a/doc/man/mmg.1 b/doc/man/mmg.1 index 2fb956dc9..f3c3d0126 100644 --- a/doc/man/mmg.1 +++ b/doc/man/mmg.1 @@ -1,19 +1,27 @@ +'\" t .\" Title: mmg .\" Author: Moritz Bunkus -.\" Generator: DocBook XSL Stylesheets v1.73.2 +.\" Generator: DocBook XSL Stylesheets v1.75.1 .\" Date: December 2009 .\" Manual: User Commands .\" Source: MkvToolNix 3.0.0 +.\" Language: English .\" .TH "MMG" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -mmg \- a GUI for mkvmerge1 including a chapter and a header editor +mmg \- a GUI for \fBmkvmerge\fR(1) including a chapter and a header editor .SH "SYNOPSIS" -.HP 4 +.HP \w'\fBmmg\fR\ 'u \fBmmg\fR [[{\-\-edit\-headers}\ {filename\&.mkv}] | [preferences\-file\&.mmg] | [source\-file\&.ext]] .SH "DESCRIPTION" .PP @@ -51,7 +59,7 @@ and a file name\&. This lets \fBmmg\fR(1) run its header editor and load the file\&. .PP -The full documentation is available in HTML form (\fIdoc/mkvmerge\-gui\&.html\fR)\&. +The full documentation is available in HTML form (doc/mkvmerge\-gui\&.html)\&. .SH "SEE ALSO" .PP @@ -62,13 +70,13 @@ The full documentation is available in HTML form (\fIdoc/mkvmerge\-gui\&.html\fR .SH "WWW" .PP The latest version can always be found at -\fIthe MKVToolNix homepage\fR\&[1]\&. +\m[blue]\fBthe MKVToolNix homepage\fR\m[]\&\s-2\u[1]\d\s+2\&. .SH "AUTHOR" .PP \fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&> -.sp -1n -.IP "" 4 +.RS 4 Developer +.RE .SH "NOTES" .IP " 1." 4 the MKVToolNix homepage