Re-built the man pages with current DocBook.

This commit is contained in:
Moritz Bunkus 2009-12-26 22:16:03 +01:00
parent 673aee5ee5
commit fe9abbc060
5 changed files with 601 additions and 87 deletions

View File

@ -1,19 +1,27 @@
'\" t
.\" Title: mkvextract .\" Title: mkvextract
.\" Author: Moritz Bunkus <moritz@bunkus.org> .\" Author: Moritz Bunkus <moritz@bunkus.org>
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
.\" Date: December 2009 .\" Date: December 2009
.\" Manual: User Commands .\" Manual: User Commands
.\" Source: MkvToolNix 3.0.0 .\" Source: MkvToolNix 3.0.0
.\" Language: English
.\" .\"
.TH "MKVEXTRACT" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands" .TH "MKVEXTRACT" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation .\" disable hyphenation
.nh .nh
.\" disable justification (adjust text to left margin only) .\" disable justification (adjust text to left margin only)
.ad l .ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME" .SH "NAME"
mkvextract \- extract tracks from Matroska files into other files mkvextract \- extract tracks from Matroska(TM) files into other files
.SH "SYNOPSIS" .SH "SYNOPSIS"
.HP 11 .HP \w'\fBmkvextract\fR\ 'u
\fBmkvextract\fR {mode} {source\-filename} [options] [extraction\-spec] \fBmkvextract\fR {mode} {source\-filename} [options] [extraction\-spec]
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@ -95,7 +103,9 @@ Reads additional command line arguments from the file
.sp .sp
The command line \'\fBmkvextract tracks source\&.mkv \-\-raw 1:destination\&.raw\fR\' could be converted into the following option file: The command line \'\fBmkvextract tracks source\&.mkv \-\-raw 1:destination\&.raw\fR\' could be converted into the following option file:
.sp .sp
.if n \{\
.RS 4 .RS 4
.\}
.nf .nf
# Extract a track from source\&.mkv # Extract a track from source\&.mkv
tracks tracks
@ -105,7 +115,9 @@ source\&.mkv
1:destination\&.raw 1:destination\&.raw
.fi .fi
.if n \{\
.RE .RE
.\}
.RE .RE
.SS "Track extraction mode" .SS "Track extraction mode"
.PP .PP
@ -184,12 +196,16 @@ option\&.
.sp .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: 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 .sp
.if n \{\
.RS 4 .RS 4
.\}
.nf .nf
$ mkvextract tracks input\&.mkv 1:output\-two\-tracks\&.rm 2:output\-two\-tracks\&.rm $ mkvextract tracks input\&.mkv 1:output\-two\-tracks\&.rm 2:output\-two\-tracks\&.rm
.fi .fi
.if n \{\
.RE .RE
.\}
.RE .RE
.SS "Tags extraction mode" .SS "Tags extraction mode"
.PP .PP
@ -279,36 +295,52 @@ itself\&.
.PP .PP
The shell\'s builtin redirection mechanism is used by appending \'> output\-filename\&.ext\' to the command line\&. Example: The shell\'s builtin redirection mechanism is used by appending \'> output\-filename\&.ext\' to the command line\&. Example:
.sp .sp
.if n \{\
.RS 4 .RS 4
.\}
.nf .nf
$ mkvextract tags source\&.mkv > tags\&.xml $ mkvextract tags source\&.mkv > tags\&.xml
.fi .fi
.if n \{\
.RE .RE
.\}
.PP .PP
\fBmkvextract\fR(1)\'s own redirection is invoked with the \fBmkvextract\fR(1)\'s own redirection is invoked with the
\fB\-\-redirect\-output\fR \fB\-\-redirect\-output\fR
option\&. Example: option\&. Example:
.sp .sp
.if n \{\
.RS 4 .RS 4
.\}
.nf .nf
$ mkvextract tags source\&.mkv \-\-redirect\-output tags\&.xml $ mkvextract tags source\&.mkv \-\-redirect\-output tags\&.xml
.fi .fi
.if n \{\
.RE .RE
.\}
.if n \{\
.sp .sp
.\}
.RS 4
.it 1 an-trap .it 1 an-trap
.nr an-no-space-flag 1 .nr an-no-space-flag 1
.nr an-break-flag 1 .nr an-break-flag 1
.br .br
Note .ps +1
\fBNote\fR
.ps -1
.br
.PP .PP
On Windows you should probably use the On Windows you should probably use the
\fB\-\-redirect\-output\fR \fB\-\-redirect\-output\fR
option because option because
\fBcmd\&.exe\fR \fBcmd\&.exe\fR
sometimes interpretes special characters before they\'re written into the output file resulting in broken output\&. sometimes interpretes special characters before they\'re written into the output file resulting in broken output\&.
.sp .5v
.RE
.SH "OUTPUT FILE FORMATS" .SH "OUTPUT FILE FORMATS"
.PP .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: 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: exits with one of three exit codes:
.sp .sp
.RS 4 .RS 4
\h'-04'\(bu\h'+03' .ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB0\fR \fB0\fR
\-\- This exit codes means that extraction has completed successfully\&. \-\- This exit codes means that extraction has completed successfully\&.
.RE .RE
.sp .sp
.RS 4 .RS 4
\h'-04'\(bu\h'+03' .ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB1\fR \fB1\fR
\-\- In this case \-\- In this case
\fBmkvextract\fR(1) \fBmkvextract\fR(1)
@ -486,7 +532,14 @@ has output at least one warning, but extraction did continue\&. A warning is pre
.RE .RE
.sp .sp
.RS 4 .RS 4
\h'-04'\(bu\h'+03' .ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB2\fR \fB2\fR
\-\- This exit code is used after an error occured\&. \-\- This exit code is used after an error occured\&.
\fBmkvextract\fR(1) \fBmkvextract\fR(1)
@ -502,13 +555,13 @@ aborts right after outputting the error message\&. Error messages range from wro
.SH "WWW" .SH "WWW"
.PP .PP
The latest version can always be found at 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" .SH "AUTHOR"
.PP .PP
\fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&> \fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&>
.sp -1n .RS 4
.IP "" 4
Developer Developer
.RE
.SH "NOTES" .SH "NOTES"
.IP " 1." 4 .IP " 1." 4
the MKVToolNix homepage the MKVToolNix homepage

View File

@ -1,19 +1,27 @@
'\" t
.\" Title: mkvinfo .\" Title: mkvinfo
.\" Author: Moritz Bunkus <moritz@bunkus.org> .\" Author: Moritz Bunkus <moritz@bunkus.org>
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
.\" Date: December 2009 .\" Date: December 2009
.\" Manual: User Commands .\" Manual: User Commands
.\" Source: MkvToolNix 3.0.0 .\" Source: MkvToolNix 3.0.0
.\" Language: English
.\" .\"
.TH "MKVINFO" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands" .TH "MKVINFO" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation .\" disable hyphenation
.nh .nh
.\" disable justification (adjust text to left margin only) .\" disable justification (adjust text to left margin only)
.ad l .ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME" .SH "NAME"
mkvinfo \- Print information about elements in Matroska files mkvinfo \- Print information about elements in Matroska(TM) files
.SH "SYNOPSIS" .SH "SYNOPSIS"
.HP 8 .HP \w'\fBmkvinfo\fR\ 'u
\fBmkvinfo\fR [options] {source\-filename} \fBmkvinfo\fR [options] {source\-filename}
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@ -101,7 +109,9 @@ Reads additional command line arguments from the file
.sp .sp
The command line \'\fBmkvinfo \-v \-v input\&.mkv \-\-redirect\-output info\&.txt\fR\' could be converted into the following option file: The command line \'\fBmkvinfo \-v \-v input\&.mkv \-\-redirect\-output info\&.txt\fR\' could be converted into the following option file:
.sp .sp
.if n \{\
.RS 4 .RS 4
.\}
.nf .nf
# Be more verbose # Be more verbose
\-v \-v
@ -113,7 +123,9 @@ input\&.mkv
info\&.txt info\&.txt
.fi .fi
.if n \{\
.RE .RE
.\}
.RE .RE
.SH "VERBOSITY LEVELS" .SH "VERBOSITY LEVELS"
.PP .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: exits with one of three exit codes:
.sp .sp
.RS 4 .RS 4
\h'-04'\(bu\h'+03' .ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB0\fR \fB0\fR
\-\- This exit codes means that the run has completed successfully\&. \-\- This exit codes means that the run has completed successfully\&.
.RE .RE
.sp .sp
.RS 4 .RS 4
\h'-04'\(bu\h'+03' .ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB1\fR \fB1\fR
\-\- In this case \-\- In this case
\fBmkvinfo\fR(1) \fBmkvinfo\fR(1)
@ -168,7 +194,14 @@ has output at least one warning, but the run did continue\&. A warning is prefix
.RE .RE
.sp .sp
.RS 4 .RS 4
\h'-04'\(bu\h'+03' .ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB2\fR \fB2\fR
\-\- This exit code is used after an error occured\&. \-\- This exit code is used after an error occured\&.
\fBmkvinfo\fR(1) \fBmkvinfo\fR(1)
@ -184,13 +217,13 @@ aborts right after outputting the error message\&. Error messages range from wro
.SH "WWW" .SH "WWW"
.PP .PP
The latest version can always be found at 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" .SH "AUTHOR"
.PP .PP
\fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&> \fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&>
.sp -1n .RS 4
.IP "" 4
Developer Developer
.RE
.SH "NOTES" .SH "NOTES"
.IP " 1." 4 .IP " 1." 4
the MKVToolNix homepage the MKVToolNix homepage

File diff suppressed because it is too large Load Diff

View File

@ -1,19 +1,27 @@
'\" t
.\" Title: mkvpropedit .\" Title: mkvpropedit
.\" Author: Moritz Bunkus <moritz@bunkus.org> .\" Author: Moritz Bunkus <moritz@bunkus.org>
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
.\" Date: December 2009 .\" Date: December 2009
.\" Manual: User Commands .\" Manual: User Commands
.\" Source: MkvToolNix 3.0.0 .\" Source: MkvToolNix 3.0.0
.\" Language: English
.\" .\"
.TH "MKVPROPEDIT" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands" .TH "MKVPROPEDIT" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation .\" disable hyphenation
.nh .nh
.\" disable justification (adjust text to left margin only) .\" disable justification (adjust text to left margin only)
.ad l .ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME" .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" .SH "SYNOPSIS"
.HP 12 .HP \w'\fBmkvpropedit\fR\ 'u
\fBmkvpropedit\fR [options] {source\-filename} {actions} \fBmkvpropedit\fR [options] {source\-filename} {actions}
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@ -136,7 +144,9 @@ Reads additional command line arguments from the file
.sp .sp
The command line \'\fBmkvpropedit source\&.mkv \-\-edit track:a2 \-\-set title=Comments\fR\' could be converted into the following option file: The command line \'\fBmkvpropedit source\&.mkv \-\-edit track:a2 \-\-set title=Comments\fR\' could be converted into the following option file:
.sp .sp
.if n \{\
.RS 4 .RS 4
.\}
.nf .nf
# Modify source\&.mkv # Modify source\&.mkv
source\&.mkv source\&.mkv
@ -148,7 +158,9 @@ track:a2
title=Comments title=Comments
.fi .fi
.if n \{\
.RE .RE
.\}
.RE .RE
.SH "EDIT SELECTORS" .SH "EDIT SELECTORS"
.PP .PP
@ -230,12 +242,16 @@ option because editing the segment information element is the default for all op
\fB\-\-edit\fR \fB\-\-edit\fR
option anyway\&. option anyway\&.
.sp .sp
.if n \{\
.RS 4 .RS 4
.\}
.nf .nf
$ mkvpropedit movie\&.mkv \-\-edit info \-\-set "title=The movie" \-\-edit track:a1 \-\-set language=fre \-\-edit track:a2 \-\-set language=ita $ mkvpropedit movie\&.mkv \-\-edit info \-\-set "title=The movie" \-\-edit track:a1 \-\-set language=fre \-\-edit track:a2 \-\-set language=ita
.fi .fi
.if n \{\
.RE .RE
.\}
.SH "EXIT CODES" .SH "EXIT CODES"
.PP .PP
@ -243,13 +259,27 @@ $ mkvpropedit movie\&.mkv \-\-edit info \-\-set "title=The movie" \-\-edit track
exits with one of three exit codes: exits with one of three exit codes:
.sp .sp
.RS 4 .RS 4
\h'-04'\(bu\h'+03' .ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB0\fR \fB0\fR
\-\- This exit codes means that the modification has completed successfully\&. \-\- This exit codes means that the modification has completed successfully\&.
.RE .RE
.sp .sp
.RS 4 .RS 4
\h'-04'\(bu\h'+03' .ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB1\fR \fB1\fR
\-\- In this case \-\- In this case
\fBmkvpropedit\fR(1) \fBmkvpropedit\fR(1)
@ -257,7 +287,14 @@ has output at least one warning, but the modification did continue\&. A warning
.RE .RE
.sp .sp
.RS 4 .RS 4
\h'-04'\(bu\h'+03' .ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB2\fR \fB2\fR
\-\- This exit code is used after an error occured\&. \-\- This exit code is used after an error occured\&.
\fBmkvpropedit\fR(1) \fBmkvpropedit\fR(1)
@ -273,13 +310,13 @@ aborts right after outputting the error message\&. Error messages range from wro
.SH "WWW" .SH "WWW"
.PP .PP
The latest version can always be found at 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" .SH "AUTHOR"
.PP .PP
\fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&> \fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&>
.sp -1n .RS 4
.IP "" 4
Developer Developer
.RE
.SH "NOTES" .SH "NOTES"
.IP " 1." 4 .IP " 1." 4
the MKVToolNix homepage the MKVToolNix homepage

View File

@ -1,19 +1,27 @@
'\" t
.\" Title: mmg .\" Title: mmg
.\" Author: Moritz Bunkus <moritz@bunkus.org> .\" Author: Moritz Bunkus <moritz@bunkus.org>
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
.\" Date: December 2009 .\" Date: December 2009
.\" Manual: User Commands .\" Manual: User Commands
.\" Source: MkvToolNix 3.0.0 .\" Source: MkvToolNix 3.0.0
.\" Language: English
.\" .\"
.TH "MMG" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands" .TH "MMG" "1" "December 2009" "MkvToolNix 3\&.0\&.0" "User Commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation .\" disable hyphenation
.nh .nh
.\" disable justification (adjust text to left margin only) .\" disable justification (adjust text to left margin only)
.ad l .ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME" .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" .SH "SYNOPSIS"
.HP 4 .HP \w'\fBmmg\fR\ 'u
\fBmmg\fR [[{\-\-edit\-headers}\ {filename\&.mkv}] | [preferences\-file\&.mmg] | [source\-file\&.ext]] \fBmmg\fR [[{\-\-edit\-headers}\ {filename\&.mkv}] | [preferences\-file\&.mmg] | [source\-file\&.ext]]
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
@ -51,7 +59,7 @@ and a file name\&. This lets
\fBmmg\fR(1) \fBmmg\fR(1)
run its header editor and load the file\&. run its header editor and load the file\&.
.PP .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" .SH "SEE ALSO"
.PP .PP
@ -62,13 +70,13 @@ The full documentation is available in HTML form (\fIdoc/mkvmerge\-gui\&.html\fR
.SH "WWW" .SH "WWW"
.PP .PP
The latest version can always be found at 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" .SH "AUTHOR"
.PP .PP
\fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&> \fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&>
.sp -1n .RS 4
.IP "" 4
Developer Developer
.RE
.SH "NOTES" .SH "NOTES"
.IP " 1." 4 .IP " 1." 4
the MKVToolNix homepage the MKVToolNix homepage