Download-Tools/mkvtoolnix
1
0
Fork 0
mirror of https://gitlab.com/mbunkus/mkvtoolnix.git synced 2024-12-23 19:31:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Removed the hand-written man pages from 'doc'. Added the converted man pages from 'doc/man'.

Browse Source
This commit is contained in:
Moritz Bunkus 2009-08-10 21:22:09 +02:00
parent 57c158cab7
commit 964216ccb1
10 changed files with 2670 additions and 1819 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -12,6 +12,3 @@ config.status
config.sub
configure
data
/doc/man/mkvmerge.1
/doc/man/mkvextract.1
/doc/man/mkvinfo.1

33
doc/base64tool.1
View File

@ -1,33 +0,0 @@
.TH BASE64TOOL "1" "July 2009" "base64tool v2.9.7" "User Commands"
.SH NAME
base64tool \- encode files into Base64 encoding and decode Base64 encoded files
.SH SYNOPSIS
.B base64tool
<\fIencode\fR|\fIdecode\fR> <\fIinput\fR> <\fIoutput\fR> [\fImaxlen\fR]
.SH DESCRIPTION
.LP
This program can either encode a file with Base64 encoding suited for
inclusion of binary data into text files such as XML files and decode
Base64 encoded data back into its original form. The first argument
controls whether \fBbase64tool\fR will encode or decode. The second
argument is name of the file that data is read from. The third
argument is the name of the file that output is written to. The file
will be overwritten if it exists.
.LP
When encoding an optional fourth parameter, \fImaxlen\fR, specifies
the maximum line length to output. It defaults to 72 if left out.
.SH AUTHOR
.I base64tool
was written by Moritz Bunkus <moritz@bunkus.org>.
.SH WWW
The newest version can always be found at
.UR http://www.bunkus.org/\:videotools/\:mkvtoolnix/
.UE

514
doc/man/mkvextract.1 Normal file
View File

@ -0,0 +1,514 @@
.\" Title: mkvextract
.\" Author: Moritz Bunkus <moritz@bunkus.org>
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" Date: July 2009
.\" Manual: User Commands
.\" Source: MkvToolNix 2.9.7
.\"
.TH "MKVEXTRACT" "1" "July 2009" "MkvToolNix 2\&.9\&.7" "User Commands"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
mkvextract \- extract tracks from Matroska files into other files
.SH "SYNOPSIS"
.HP 11
\fBmkvextract\fR {mode} {source\-filename} [options] [extraction\-spec]
.SH "DESCRIPTION"
.PP
This program extracts specific parts from a Matroska file to other useful formats\&. The first argument,
\fBmode\fR, tells
\fBmkvextract\fR(1)
what to extract\&. Currently supported is the extraction of
tracks,
tags,
attachments,
chapters,
CUE sheets
and
timecodes\&. The second argument is the name of the source file\&. It must be a
Matroska(TM)
file\&. All following arguments are options and extraction specifications; both of which depend on the selected mode\&.
.SS "Common options"
.PP
The following options are available in all modes and only described once in this section\&.
.PP
\fB\-\-command\-line\-charset\fR \fIcharacter\-set\fR
.RS 4
Sets the character set to convert strings given on the command line from\&. It defaults to the character set given by system\'s current locale\&.
.RE
.PP
\fB\-\-output\-charset\fR \fIcharacter\-set\fR
.RS 4
Sets the character set to which strings are converted that are to be output\&. It defaults to the character set given by system\'s current locale\&.
.RE
.PP
\fB\-r\fR, \fB\-\-redirect\-output\fR \fIfile\-name\fR
.RS 4
Writes all messages to the file
\fIfile\-name\fR
instead of to the console\&. While this can be done easily with output redirection there are cases in which this option is needed: when the terminal reinterprets the output before writing it to a file\&. The character set set with
\fB\-\-output\-charset\fR
is honored\&.
.RE
.PP
\fB\-\-ui\-language\fR \fIcode\fR
.RS 4
Forces the translations for the language
\fIcode\fR
to be used (e\&.g\&. \'de_DE\' for the German translations)\&. It is preferable to use the environment variables
\fILANG\fR,
\fILC_MESSAGES\fR
and
\fILC_ALL\fR
though\&. Entering \'list\' as the
\fIcode\fR
will cause
\fBmkvextract\fR(1)
to output a list of available translations\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Be verbose and show all the important
Matroska(TM)
elements as they\'re read\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show usage information and exit\&.
.RE
.PP
\fB\-V\fR, \fB\-\-version\fR
.RS 4
Show version information and exit\&.
.RE
.PP
\fB@\fRoptions\-file
.RS 4
Reads additional command line arguments from the file
\fIoptions\-file\fR\&. Lines whose first non\-whitespace character is a hash mark (\'#\') are treated as comments and ignored\&. White spaces at the start and end of a line will be stripped\&. Each line must contain exactly one option\&. There is no meta character escaping\&.
.sp
The command line \'\fBmkvextract tracks source\&.mkv \-\-raw 1:destination\&.raw\fR\' could be converted into the following option file:
.sp
.RS 4
.nf
# Extract a track from source\&.mkv
tracks
source\&.mkv
# Output the track as raw data\&.
\-\-raw
1;destination\&.raw
.fi
.RE
.RE
.SS "Track extraction mode"
.PP
Syntax:
\fBmkvextract\fR
\fBtracks\fR
\fIsource\-filename\fR
[\fIoptions\fR]
\fITID1:dest\-filename1\fR
[\fITID2:dest\-filename2\fR \&.\&.\&.]
.PP
The following command line options are available for each track in the \'tracks\' extraction mode\&. They have to appear in front of the track specification (see below) they should be applied to\&.
.PP
\fB\-c\fR \fIcharacter\-set\fR
.RS 4
Sets the character set to convert the next text subtitle track to\&. Only valid if the next track ID targets a text subtitle track\&. It defaults to UTF\-8\&.
.RE
.PP
\fB\-\-blockadd\fR \fIlevel\fR
.RS 4
Keep only the BlockAdditions up to this level\&. The default is to keep all levels\&. This option only affects certain kinds of codecs like WAVPACK4\&.
.RE
.PP
\fB\-\-cuesheet\fR
.RS 4
Causes
\fBmkvextract\fR(1)
to extract a
CUE
sheet from the chapter information and tag data for the following track into a file whose name is the track\'s output name with \'\&.cue\' appended to it\&.
.RE
.PP
\fB\-\-raw\fR
.RS 4
Extracts the raw data into a file without any container data around it\&. Unlike the
\fB\-\-fullraw\fR
flag this flag does not cause the contents of the
CodecPrivate
element to be written to the file\&. This mode works with all
CodecIDs, even the ones that
\fBmkvextract\fR(1)
doesn\'t support otherwise, but the resulting files might not be usable\&.
.RE
.PP
\fB\-\-fullraw\fR
.RS 4
Extracts the raw data into a file without any container data around it\&. The contents of the
CodecPrivate
element will be written to the file first if the track contains such a header element\&. This mode works with all
CodecIDs, even the ones that
\fBmkvextract\fR(1)
doesn\'t support otherwise, but the resulting files might not be usable\&.
.RE
.PP
\fB\-\-no\-ogg\fR
.RS 4
Only valid for
FLAC
tracks\&. Normally
FLAC
tracks are embedded in an Ogg transport stream\&. With this switch they are extracted to raw
FLAC
files instead\&.
.RE
.PP
\fITID:outname\fR
.RS 4
Causes extraction of the track with the ID
\fITID\fR
into the file
\fIoutname\fR
if such a track exists in the source file\&. This option can be given multiple times\&. The track IDs are the same as the ones output by
\fBmkvmerge\fR(1)\'s
\fB\-\-identify\fR
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
.RS 4
.nf
$ mkvextract tracks input\&.mkv 1:output\-two\-tracks\&.rm 2:output\-two\-tracks\&.rm
.fi
.RE
.RE
.SS "Tags extraction mode"
.PP
Syntax:
\fBmkvextract\fR
\fBtags\fR
\fIsource\-filename\fR
[\fIoptions\fR]
.PP
The extracted tags are written to the console unless the output is redirected (see the section about
output redirection
for details)\&.
.SS "Attachments extraction mode"
.PP
Syntax:
\fBmkvextract\fR
\fBattachments\fR
\fIsource\-filename\fR
[\fIoptions\fR]
\fIAID1:outname1\fR
[\fIAID2:outname2\fR \&.\&.\&.]
.PP
AID:outname
.RS 4
Causes extraction of the attachment with the ID
\fIAID\fR
into the file
\fIoutname\fR
if such an attachment exists in the source file\&. If the
\fIoutname\fR
is left empty then the name of the attachment inside the source
Matroska(TM)
file is used instead\&. This option can be given multiple times\&. The attachment IDs are the same as the ones output by
\fBmkvmerge\fR(1)\'s
\fB\-\-identify\fR
option\&.
.RE
.SS "Chapters extraction mode"
.PP
Syntax:
\fBmkvextract\fR
\fBchapters\fR
\fIsource\-filename\fR
[\fIoptions\fR]
.PP
\fB\-s\fR, \fB\-\-simple\fR
.RS 4
Exports the chapter information in the simple format used in the
OGM
tools (CHAPTER01=\&.\&.\&., CHAPTER01NAME=\&.\&.\&.)\&. In this mode some information has to be discarded\&. Default is to output the chapters in
XML
format\&.
.RE
.PP
The extracted chapters are written to the console unless the output is redirected (see the section about
output redirection
for details)\&.
.SS "Cue sheet extraction mode"
.PP
Syntax:
\fBmkvextract\fR
\fBcuesheet\fR
\fIsource\-filename\fR
[\fIoptions\fR]
.PP
The extracted cue sheet is written to the console unless the output is redirected (see the section about
output redirection
for details)\&.
.SS "Timecode extraction mode"
.PP
Syntax:
\fBmkvextract\fR
\fBtimecodes_v2\fR
\fIsource\-filename\fR
[\fIoptions\fR]
.PP
The extracted timecodes are written to the console unless the output is redirected (see the section about
output redirection
for details)\&.
.SH "OUTPUT REDIRECTION"
.PP
Several extraction modes cause
\fBmkvextract\fR(1)
to write the extracted data to the console\&. There are generally two ways of writing this data into a file: one provided by the shell and one provided by
\fBmkvextract\fR(1)
itself\&.
.PP
The shell\'s builtin redirection mechanism is used by appending \'> output\-filename\&.ext\' to the command line\&. Example:
.sp
.RS 4
.nf
$ mkvextract tags source\&.mkv > tags\&.xml
.fi
.RE
.PP
\fBmkvextract\fR(1)\'s own redirection is invoked with the
\fB\-\-redirect\-output\fR
option\&. Example:
.sp
.RS 4
.nf
$ mkvextract tags source\&.mkv \-\-redirect\-output tags\&.xml
.fi
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
.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\&.
.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:
.PP
V_MPEG4/ISO/AVC
.RS 4
H\&.264
/
AVC
video tracks are written to
H\&.264
elementary streams which can be processed further with e\&.g\&.
MP4Box(TM)
from the
GPAC(TM)
package\&.
.RE
.PP
V_MS/VFW/FOURCC
.RS 4
Fixed
FPS
video tracks with this
CodecID
are written to
AVI
files\&.
.RE
.PP
V_REAL/*
.RS 4
RealVideo(TM)
tracks are written to
RealMedia(TM)
files\&.
.RE
.PP
A_MPEG/L3, A_AC3
.RS 4
These will be extracted to raw
MP3
and
AC3
files\&.
.RE
.PP
A_PCM/INT/LIT
.RS 4
Raw
PCM
data will be written to a
WAV
file\&.
.RE
.PP
A_AAC/MPEG2/*, A_AAC/MPEG4/*, A_AAC
.RS 4
All
AAC
files will be written into an
AAC
file with
ADTS
headers before each packet\&. The
ADTS
headers will not contain the deprecated emphasis field\&.
.RE
.PP
A_VORBIS
.RS 4
Vorbis audio will be written into an
OggVorbis(TM)
file\&.
.RE
.PP
A_REAL/*
.RS 4
RealAudio(TM)
tracks are written to
RealMedia(TM)
files\&.
.RE
.PP
A_TTA1
.RS 4
TrueAudio(TM)
tracks are written to
TTA
files\&. Please note that due to
Matroska(TM)\'s limited timecode precision the extracted file\'s header will be different regarding two fields:
\fIdata_length\fR
(the total number of samples in the file) and the
CRC\&.
.RE
.PP
S_TEXT/UTF8
.RS 4
Simple text subtitles will be written as
SRT
files\&.
.RE
.PP
S_TEXT/SSA, S_TEXT/ASS
.RS 4
SSA
and
ASS
text subtitles will be written as
SSA/ASS
files respectively\&.
.RE
.PP
S_KATE
.RS 4
Kate(TM)
streams will be written within an
Ogg(TM)
container\&.
.RE
.PP
Tags
.RS 4
Tags are converted to a
XML
format\&. This format is the same that
\fBmkvmerge\fR(1)
supports for reading tags\&.
.RE
.PP
Attachments
.RS 4
Attachments are written to they output file as they are\&. No conversion whatsoever is done\&.
.RE
.PP
Chapters
.RS 4
Chapters are converted to a
XML
format\&. This format is the same that
\fBmkvmerge\fR(1)
supports for reading chapters\&. Alternatively a stripped\-down version can be output in the simple
OGM
style format\&.
.RE
.PP
Timecodes
.RS 4
Timecodes are first sorted and then output as a timecode v2 format compliant file ready to be fed to
\fBmkvmerge\fR(1)\&. The extraction to other formats (v1, v3 and v4) is not supported\&.
.RE
.SH "EXIT CODES"
.PP
\fBmkvextract\fR(1)
exits with one of three exit codes:
.sp
.RS 4
\h'-04'\(bu\h'+03'
\fB0\fR
\-\- This exit codes means that extraction has completed successfully\&.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'
\fB1\fR
\-\- In this case
\fBmkvextract\fR(1)
has output at least one warning, but extraction did continue\&. A warning is prefixed with the text \'Warning:\'\&. Depending on the issues involved the resulting files might be ok or not\&. The user is urged to check both the warning and the resulting files\&.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'
\fB2\fR
\-\- This exit code is used after an error occured\&.
\fBmkvextract\fR(1)
aborts right after outputting the error message\&. Error messages range from wrong command line arguments over read/write errors to broken files\&.
.RE
.SH "SEE ALSO"
.PP
\fBmkvmerge\fR(1),
\fBmkvinfo\fR(1),
\fBmmg\fR(1)
.SH "WWW"
.PP
The latest version can always be found at
\fIthe MKVToolNix homepage\fR\&[1]\&.
.SH "AUTHOR"
.PP
\fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&>
.sp -1n
.IP "" 4
Developer
.SH "NOTES"
.IP " 1." 4
the MKVToolNix homepage
.RS 4
\%http://www.bunkus.org/videotools/mkvtoolnix/
.RE

198
doc/man/mkvinfo.1 Normal file
View File

@ -0,0 +1,198 @@
.\" Title: mkvinfo
.\" Author: Moritz Bunkus <moritz@bunkus.org>
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" Date: July 2009
.\" Manual: User Commands
.\" Source: MkvToolNix 2.9.7
.\"
.TH "MKVINFO" "1" "July 2009" "MkvToolNix 2\&.9\&.7" "User Commands"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
mkvinfo \- Print information about elements in Matroska files
.SH "SYNOPSIS"
.HP 8
\fBmkvinfo\fR [options] {source\-filename}
.SH "DESCRIPTION"
.PP
This program lists all elements contained in a
Matroska(TM)\&. The output can be limited to a list of tracks in the file including information about the codecs used\&.
.PP
\fB\-g\fR, \fB\-\-gui\fR
.RS 4
Start the
GUI\&. This option is only available if mkvinfo was compiled with
GUI
support\&.
.RE
.PP
\fB\-c\fR, \fB\-\-checksums\fR
.RS 4
Calculates and display the
\fBAdler32\fR
checksum for each frame\&. Useful for debugging only\&.
.RE
.PP
\fB\-s\fR, \fB\-\-summary\fR
.RS 4
Only show a terse summary of what
\fBmkvinfo\fR(1)
finds and not each element\&.
.RE
.PP
\fB\-\-command\-line\-charset\fR \fIcharacter\-set\fR
.RS 4
Sets the character set to convert strings given on the command line from\&. It defaults to the character set given by system\'s current locale\&.
.RE
.PP
\fB\-\-output\-charset\fR \fIcharacter\-set\fR
.RS 4
Sets the character set to which strings are converted that are to be output\&. It defaults to the character set given by system\'s current locale\&.
.RE
.PP
\fB\-r\fR, \fB\-\-redirect\-output\fR \fIfile\-name\fR
.RS 4
Writes all messages to the file
\fIfile\-name\fR
instead of to the console\&. While this can be done easily with output redirection there are cases in which this option is needed: when the terminal reinterprets the output before writing it to a file\&. The character set set with
\fB\-\-output\-charset\fR
is honored\&.
.RE
.PP
\fB\-\-ui\-language\fR \fIcode\fR
.RS 4
Forces the translations for the language
\fIcode\fR
to be used (e\&.g\&. \'de_DE\' for the German translations)\&. It is preferable to use the environment variables
\fILANG\fR,
\fILC_MESSAGES\fR
and
\fILC_ALL\fR
though\&. Entering \'list\' as the
\fIcode\fR
will cause
\fBmkvinfo\fR(1)
to output a list of available translations\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Be more verbose\&. See the section about
verbosity levels
for a description which information will be output at which level\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show usage information and exit\&.
.RE
.PP
\fB\-V\fR, \fB\-\-version\fR
.RS 4
Show version information and exit\&.
.RE
.PP
\fB@\fRoptions\-file
.RS 4
Reads additional command line arguments from the file
\fIoptions\-file\fR\&. Lines whose first non\-whitespace character is a hash mark (\'#\') are treated as comments and ignored\&. White spaces at the start and end of a line will be stripped\&. Each line must contain exactly one option\&. There is no meta character escaping\&.
.sp
The command line \'\fBmkvinfo \-v \-v input\&.mkv \-\-redirect\-output info\&.txt\fR\' could be converted into the following option file:
.sp
.RS 4
.nf
# Be more verbose
\-v
\-v
# Parse input\&.mkv
input\&.mkv
# and write the output to info\&.txt
\-\-redirect\-output
info\&.txt
.fi
.RE
.RE
.SH "VERBOSITY LEVELS"
.PP
The
\fB\-v\fR
option can be used to increase
\fBmkvinfo\fR(1)\'s verbosity level and print more information about the current file\&.
.PP
At level 0
\fBmkvinfo\fR(1)
will print only the track headers it finds and their types\&.
\fBmkvinfo\fR(1)
will exit as soon as the headers are parsed completely (more technical: as soon as the first cluster is encountered)\&. In this level the seek head entries and the cues will not be displayed \-\- even if they\'re located in front of the track information\&.
.PP
At level 1
\fBmkvinfo\fR(1)
will also print all
Matroska(TM)
elements encountered for the complete file but the seek head entries and the cue entries\&. If the summary mode is enabled then
\fBmkvinfo\fR(1)
will output the frame position as well\&.
.PP
At level 2
\fBmkvinfo\fR(1)
will also print the seek head entries, the cue entries and the file position at which each
Matroska(TM)
element can be found at\&.
.PP
At level 3 and above
\fBmkvinfo\fR(1)
will print some information that is not directly connected to a
Matroska(TM)
element\&. All other elements only print stuff about the elements that were just found\&. Level 3 adds meta information to ease debugging (read: it\'s intended for developers only)\&. All lines written by level 3 are enclosed in square brackets to make filtering them out easy\&.
.SH "EXIT CODES"
.PP
\fBmkvinfo\fR(1)
exits with one of three exit codes:
.sp
.RS 4
\h'-04'\(bu\h'+03'
\fB0\fR
\-\- This exit codes means that the run has completed successfully\&.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'
\fB1\fR
\-\- In this case
\fBmkvinfo\fR(1)
has output at least one warning, but the run did continue\&. A warning is prefixed with the text \'Warning:\'\&.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'
\fB2\fR
\-\- This exit code is used after an error occured\&.
\fBmkvinfo\fR(1)
aborts right after outputting the error message\&. Error messages range from wrong command line arguments over read/write errors to broken files\&.
.RE
.SH "SEE ALSO"
.PP
\fBmkvmerge\fR(1),
\fBmkvextract\fR(1),
\fBmmg\fR(1)
.SH "WWW"
.PP
The latest version can always be found at
\fIthe MKVToolNix homepage\fR\&[1]\&.
.SH "AUTHOR"
.PP
\fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&>
.sp -1n
.IP "" 4
Developer
.SH "NOTES"
.IP " 1." 4
the MKVToolNix homepage
.RS 4
\%http://www.bunkus.org/videotools/mkvtoolnix/
.RE

1882
doc/man/mkvmerge.1 Normal file
View File

File diff suppressed because it is too large Load Diff

76
doc/man/mmg.1 Normal file
View File

@ -0,0 +1,76 @@
.\" Title: mmg
.\" Author: Moritz Bunkus <moritz@bunkus.org>
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" Date: July 2009
.\" Manual: User Commands
.\" Source: MkvToolNix 2.9.7
.\"
.TH "MMG" "1" "July 2009" "MkvToolNix 2\&.9\&.7" "User Commands"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
mmg \- a GUI for mkvmerge1 including a chapter and a header editor
.SH "SYNOPSIS"
.HP 4
\fBmmg\fR [[{\-\-edit\-headers}\ {filename\&.mkv}] | [preferences\-file\&.mmg] | [source\-file\&.ext]]
.SH "DESCRIPTION"
.PP
\fBmmg\fR(1)
is a
wxWindows(TM)
based
GUI
for
\fBmkvmerge\fR(1)\&. It offers easy access to all of
\fBmkvmerge\fR(1)\'s options\&. All settings (e\&.g\&. source files, track options etc) can be saved and restored\&. Included is a chapter editor that can read
OGM
style and
XML
style chapter files, write
XML
style chapter files and even read chapters from
Matroska(TM)
files and write chapters directly to
Matroska(TM)
files\&. Included is also a header editor that can be used to quickly change properties of existing
Matroska(TM)
files without needing a complete remux\&.
.PP
\fBmmg\fR(1)
knows few options\&. The first possibility is to start it with a single file name\&. If that file name\'s extenion is \'\&.mmg\' then it will be treated as a preferences file and
\fBmmg\fR(1)
will load its setting when it starts\&. Otherwise the name is interpreted as being the name of an input file which will be added\&.
.PP
The second operation mode is invoked with the option
\fB\-\-edit\-headers\fR
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)\&.
.SH "SEE ALSO"
.PP
\fBmkvmerge\fR(1),
\fBmkvextract\fR(1),
\fBmkvinfo\fR(1)
.SH "WWW"
.PP
The latest version can always be found at
\fIthe MKVToolNix homepage\fR\&[1]\&.
.SH "AUTHOR"
.PP
\fBMoritz Bunkus\fR <\&moritz@bunkus\&.org\&>
.sp -1n
.IP "" 4
Developer
.SH "NOTES"
.IP " 1." 4
the MKVToolNix homepage
.RS 4
\%http://www.bunkus.org/videotools/mkvtoolnix/
.RE

299
doc/mkvextract.1
View File

@ -1,299 +0,0 @@
.TH MKVEXTRACT "1" "July 2009" "mkvextract v2.9.7" "User Commands"
.SH NAME
mkvextract \- extract tracks from Matroska files into other files
.SH SYNOPSIS
.B mkvextract
tracks <\fIinname\fR> [\fIoptions\fR] [\fITID1\fR:\fIout1\fR [\fITID2\fR:\fIout2\fR ...]]
.br
.B mkvextract
tags <\fIinname\fR> [\fIoptions\fR]
.br
.B mkvextract
attachments <\fIinname\fR> [\fIoptions\fR] [\fIAID1\fR:\fI[out1]\fR [\fIAID2\fR:\fI[out2]\fR ...]]
.br
.B mkvextract
chapters <\fIinname\fR> [\fIoptions\fR]
.br
.B mkvextract
cuesheet <\fIinname\fR> [\fIoptions\fR]
.br
.B mkvextract
timecodes_v2 <\fIinname\fR> [\fITID1\fR:\fIout1\fR [\fITID2\fR:\fIout2\fR ...]]
.br
.B mkvextract
<\-h|\-V>
.SH DESCRIPTION
.LP
This program extracts specific parts from a Matroska file to other useful
formats. The first argument tells \fBmkvextract\fR what to extract. Currently
supported is the extraction of \fBtracks\fR, \fBtags\fR, \fBattachments\fR,
\fBchapters\fR, \fBCUE sheets\fR and \fBtimecodes\fR.
The second argument is the name of the source file. It must be a Matroska file.
.LP
The following command line options are available for each track in the
\fBtracks\fR extraction mode.
They have to appear in front of the track specification (see below) they should
be applied to.
.TP
\fB\-c\fR \fIcharset\fR
Sets the charset to convert the next text subtitle track to. Only valid if the
next track ID targets a text subtitle track. It defaults to UTF-8.
.TP
\fB\-\-blockadd\fR \fIlevel\fR
Keep only the BlockAdditions up to this level.
The default is to keep all levels.
This option only affects certain kinds of codecs like WAVPACK4.
.TP
\fB\-\-cuesheet\fR
Causes \fBmkvextract\fR to extract a CUE sheet from the chapter information
and tag data for the following track into a file whose name is the track's
output name with ".cue" appended to it.
.TP
\fB\-\-fullraw\fR
Extracts the raw data into a file without any container data around it.
The contents of the CodecPrivate element will be written to the file first
if the track contains such a header element.
This mode works with all CodecIDs, even the ones that \fBmkvextract\fR doesn't
support otherwise, but the resulting files might not be usable.
.TP
\fB\-\-no\-ogg\fR
Only valid for FLAC tracks. Normally FLAC tracks are embedded in an Ogg
transport stream. With this switch they are extracted to raw FLAC files
instead.
.TP
\fB\-\-raw\fR
Extracts the raw data into a file without any container data around it.
Unlike the \fB\-\-fullraw\fR flag this flag does not cause the contents of
the CodecPrivate element to be written to the file.
This mode works with all CodecIDs, even the ones that \fBmkvextract\fR doesn't
support otherwise, but the resulting files might not be usable.
.TP
\fITID\fR:\fIoutname\fR
Causes extraction of the track with the ID \fITID\fR into the file
\fIoutname\fR if such a track exists in the source file. This option can be
given multiple times. The track IDs are the same as the ones output by
\fBmkvmerge\fR's \fB--identify\fR option.
.br
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:
.br
\fBmkvextract tracks input.mkv 1:output-two-tracks.rm 2:output-two-tracks.rm\fR
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Be verbose and show all the important Matroska elements as they're read.
.LP
Command line syntax for the \fBtags\fR extraction mode:
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Be verbose and show all the important Matroska elements as they're read.
.LP
Command line syntax for the \fBattachments\fR extraction mode:
.TP
\fIAID\fR:\fIoutname\fR
Causes extraction of the attachment with the ID \fIAID\fR into the file
\fIoutname\fR if such an attachment exists in the source file.
If the \fIoutname\fR is left empty then the name of the attachment inside
the Matroska file is used instead.
This option can be given multiple times.
The attachment IDs are the same as the ones output by \fBmkvmerge\fR's
\fB--identify\fR option.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Be verbose and show all the important Matroska elements as they're read.
.LP
Command line syntax for the \fBchapters\fR extraction mode:
.TP
\fB\-s\fR, \fB\-\-simple\fR
Exports the chapter information in the simple format used in the OGM tools
(CHAPTER01=..., CHAPTER01NAME=...). In this mode some information has to be
discarded. Default is to output the chapters in XML format.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Be verbose and show all the important Matroska elements as they're read.
.LP
Command line syntax for the \fBcuesheet\fR extraction mode:
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Be verbose and show all the important Matroska elements as they're read.
.LP
Command line syntax for the \fBtimecodes_v2\fR extraction mode:
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Be verbose and show all the important Matroska elements as they're read.
.LP
If one of the following options is used as the only command line argument
additional information about \fBmkvextract\fR is output.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show usage information.
.TP
\fB\-V\fR, \fB\-\-version\fR
Show version information.
.LP
The following options can always be used no matter which mode has been
selected:
.TP
\fB\-\-output\-charset\fR <\fIcharset\fR>
Sets the charset to which strings are converted that are to be output.
It defaults to the charset given by system's current locale.
.TP
\fB-r\fR, \fB\-\-redirect\-output\fR <\fIfilename\fR>
Writes all messages to the file \fIfilename\fR instead of to the console.
While this can be done easily with output redirection there are cases in which
this option is needed: when the terminal reinterprets the output before
writing it to a file.
The charset set with \fB\-\-output-charset\fR is honored.
.TP
\fB\-\-ui\-language\fR <\fIcode\fR>
Forces the translations for the language \fIcode\fR to be used (e.g.
\fIde_DE\fR for the German translations). If is preferable to use the
environment variables LANG, LC_MESSAGES and LC_ALL though. Entering "list" as
the \fIcode\fR will cause mkextract to output a list of available translations.
.SH NOTES
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:
.TP
V_MPEG4/ISO/AVC
H.264 / AVC video tracks are written to H.264 elementary streams which
can be processed further with e.g. MP4Box from the GPAC package.
.TP
V_MS/VFW/FOURCC
Fixed FPS video tracks with this CodecID are written to AVI files.
.TP
V_REAL/*
RealVideo tracks are written to RealMedia files.
.TP
A_MPEG/L3, A_AC3
These will be extracted to raw MP3 and AC3 files.
.TP
A_PCM/INT/LIT
Raw PCM data will be written to a WAV file.
.TP
A_AAC/MPEG2/*
All MPEG2 AAC files will be written into an AAC file with ADTS headers before
each packet.
.TP
A_AAC/MPEG4/*
All MPEG4 AAC files will be written into an AAC file with ADTS headers before
each packet. The ADTS headers will not contain the deprecated emphasis field.
.TP
A_VORBIS
Vorbis audio will be written into an Ogg/Vorbis file.
.TP
A_REAL/*
RealAudio tracks are written to RealMedia files.
.TP
A_TTA1
TrueAudio tracks are written to TTA files. Please note that due to Matroska's
limited timecode precision the extracted file's header will be different
regarding two fields: data_length (the total number of samples in the file)
and the CRC.
.TP
S_TEXT/UTF8
Simple text subtitles will be written as SRT files.
.TP
S_TEXT/SSA, S_TEXT/ASS
SSA and ASS text subtitles will be written as SSA/ASS files respectively.
.TP
S_KATE
Kate streams will be written within an Ogg container.
.LP
\fBTags\fR are converted to a XML format. This format is the same that
\fBmkvmerge\fR supports for reading tags.
.LP
\fBAttachments\fR are written to they output file as they are. No conversion
whatsoever is done.
.LP
\fBChapters\fR are converted to a XML format. This format is the same that
\fBmkvmerge\fR supports for reading chapters. Alternatively a stripped-down
version can be output in the simple OGM style format.
.LP
\fBTimecodes\fR are first sorted and then output as a timecode v2 format
compliant file ready to be fed to mkvmerge.
The extraction to other formats (v1 and v3) is not supported.
.SH EXAMPLES
Let's assume you've made a Matroska file with one video track, two audio tracks
and two subtitle tracks, and you need the second audio track and the first
subtitle track. So first fire up \fBmkvmerge\fR with the \fB--identify\fR
option:
.LP
$ \fBmkvmerge -i movie.mkv\fR
.br
File 'movie.mkv': container: Matroska
.br
Track ID 1: video (V_MS/VFW/FOURCC, DIV3)
.br
Track ID 2: audio (A_MPEG/L3)
.br
Track ID 3: audio (A_VORBIS)
.br
Track ID 4: subtitles (S_TEXT/UTF8)
.br
Track ID 5: subtitles (S_TEXT/UTF8)
.LP
Now you can call \fBmkvextract\fR like this:
.LP
$ \fBmkvextract tracks movie.mkv 3:audio.ogg 4:subtitles.srt\fR
.LP
Another example. Let's assume you have a Matroska file with one RealVideo v10
track, one Vorbis audio track and one RealAudio (COOK) track. The
identification output might look like this:
.LP
$ \fB mkvmerge -i movie2.mkv\fR
.br
File 'movie2.mkv': container: Matroska
.br
Track ID 1: video (V_REAL/RV40)
.br
Track ID 2: audio (A_VORBIS)
.br
Track ID 3: audio (A_REAL/COOK)
.LP
Let's further assume you want only need the video and the RealAudio track but
both in the same output file. This is possible for RealMedia files by using
the same output name for those tracks that you want to end up in the same
file:
.LP
$ \fBmkvextract tracks movie2.mkv 1:extracted.rm 3:extracted.rm\fR
.LP
Sometimes you the raw data of a track might even be useful, e.g. for MPEG-1
tracks.
In this case you can use a track flag like this:
.LP
$ \fBmkvextract tracks movie3.mkv --fullraw 1:extracted.mpeg\fR
.LP
If you need the timecodes for all the blocks of track 2 from a file then
you can let mkvextract create a timecode v2 format file like this:
.LP
$ \fBmkvextract timecodes_v2 input.mkv 2:timecodes-track2.txt\fR
.SH AUTHOR
.I mkvextract
was written by Moritz Bunkus <moritz@bunkus.org>.
.SH SEE ALSO
.BR mkvmerge (1),
.BR mkvinfo (1)
.SH WWW
The newest version can always be found at
.UR http://www.bunkus.org/\:videotools/\:mkvtoolnix/
www.bunkus.org
.UE

91
doc/mkvinfo.1
View File

@ -1,91 +0,0 @@
.TH MKVINFO "1" "July 2009" "mkvinfo v2.9.7" "User Commands"
.SH NAME
mkvinfo \- Print information about tracks in Matroska files
.SH SYNOPSIS
.B mkvinfo
[\fIoptions\fR] \fIinname\fR
.SH DESCRIPTION
.LP
This program lists all tracks contained in a Matroska file including
information about the codecs used.
.TP
inname
Use '\fIinname\fR' as the source.
.TP
\fB\-g\fR, \fB\-\-gui\fR
Start the GUI. This option is only available if mkvinfo was compiled with
GUI support.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Be verbose and show all Matroska elements. See the section
\'\fBVERBOSITY LEVELS\fR' for details.
.TP
\fB\-c\fR, \fB\-\-checksums\fR
Calculates and display the Adler32 checksum for each frame. Useful for
debugging only.
.TP
\fB\-s\fR, \fB\-\-summary\fR
Only show a terse summary of what \fBmkvinfo\fR finds and not each element.
.TP
\fB\-\-output\-charset\fR <\fIcharset\fR>
Sets the charset to which strings are converted that are to be output.
It defaults to the charset given by system's current locale.
.TP
\fB-r\fR, \fB\-\-redirect\-output\fR <\fIfilename\fR>
Writes all messages to the file \fIfilename\fR instead of to the console.
While this can be done easily with output redirection there are cases in which
this option is needed: when the terminal reinterprets the output before
writing it to a file.
The charset set with \fB\-\-output-charset\fR is honored.
.TP
\fB\-\-ui\-language\fR <\fIcode\fR>
Forces the translations for the language \fIcode\fR to be used (e.g.
\fIde_DE\fR for the German translations). If is preferable to use the
environment variables LANG, LC_MESSAGES and LC_ALL though. Entering "list" as
the \fIcode\fR will cause mkvinfo to output a list of available translations.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show usage information.
.TP
\fB\-V\fR, \fB\-\-version\fR
Show version information.
.SH VERBOSITY LEVELS
.LP
The \fB-v\fR option can be used to increase \fBmkvinfo\fR's verbosity level
and print more information about the current file.
.TP
level 0
will print only the track headers it finds and their types. \fBmkvinfo\fR
will exit as soon as the headers are parsed completely (more technical:
as soon as the first cluster is encountered). In this level the seek head
entries and the cues will not be displayed - even if they're located in
front of the track information.
.TP
level 1
will also print all Matroska elements encountered for the complete file but
the seek head entries and the cue entries. If the summary mode is enabled
then \fBmkvinfo\fR will output the frame position as well.
.TP
level 2
will also print the seek head entries, the cue entries and the file position
at which each Matroska element can be found at.
.TP
level 3
will print some information that is not directly connected to a Matroska
element. All other elements only print stuff about the elements that were
just found. Level 3 adds meta information to ease debugging (read: it's
intended for developers only). All lines written by level 3 are enclosed
in square brackets to make filtering them out easy.
.LP
.SH AUTHOR
.I mkvinfo
was written by Moritz Bunkus <moritz@bunkus.org>.
.SH SEE ALSO
.BR mkvmerge (1),
.BR mkvextract (1),
.BR mmg (1)
.SH WWW
The newest version can always be found at
.UR http://www.bunkus.org/\:videotools/\:mkvtoolnix/
www.bunkus.org
.UE

1343
doc/mkvmerge.1
View File

File diff suppressed because it is too large Load Diff

50
doc/mmg.1
View File

@ -1,50 +0,0 @@
.TH MMG "1" "July 2009" "mmg v2.9.7" "User Commands"
.SH NAME
mmg \- a GUI for mkvmerge including a chapter editor
.SH SYNOPSIS
.B mmg
[\fIpreferences.mmg\fR|\fIinput_file.ext\fR]
.br
.B mmg
\-\-edit\-headers <\fIfile.mkv\fR>
.br
.SH DESCRIPTION
.LP
\fBmmg\fR is a wxWindows based GUI for \fBmkvmerge\fR. It offers easy
access to all of \fBmkvmerge\fR's options. All settings (e.g. source
files, track options etc) can be saved and restored. Included is a
chapter editor that can read OGM style and XML style chapter files,
write XML style chapter files and even read chapters from Matroska
files and write chapters directly to Matroska files.
.LP
\fBmmg\fR knows few options. The first possibility is to start it with
a single file name. If that file name's extenion is '\fI.mmg\fR' then
it will be treated as a preferences file and \fBmmg\fR will load its
setting when it starts. Otherwise the name is interpreted as being
the name of an input file which will be added.
.LP
The second operation mode is invoked with the
option '\-\-edit\-headers' and a file name. This lets \fBmmg\fR run
its header editor and load the file.
.LP
The full documentation is available in HTML form (doc/mkvmerge-gui.html).
.SH AUTHOR
.I mmg
was written by Moritz Bunkus <moritz@bunkus.org>.
.SH SEE ALSO
.BR mkvmerge (1),
.BR mkvinfo (1),
.BR mkvextract (1)
.SH WWW
The newest version can always be found at
.UR http://www.bunkus.org/\:videotools/\:mkvtoolnix/
.UE