2010-02-09 08:13:22 +00:00
'\" t
. \" Title: mkvinfo
. \" Author: Moritz Bunkus <moritz@bunkus.org>
2013-06-27 18:16:17 +00:00
. \" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
2014-10-22 16:36:19 +00:00
. \" Date: 2014-10-22
2014-05-24 18:49:37 +00:00
. \" Manual: User Commands
2014-10-22 16:36:19 +00:00
. \" Source: MKVToolNix 7.3.0
2014-05-24 18:49:37 +00:00
. \" Language: English
2010-02-09 08:13:22 +00:00
. \"
2014-10-22 16:36:19 +00:00
.TH "MKVINFO" "1" "2014\-10\-22" "MKVToolNix 7\&.3\&.0" "User Commands"
2010-02-09 08:13:22 +00:00
. \" -----------------------------------------------------------------
2010-05-26 10:49:55 +00:00
. \" * Define some portability stuff
. \" -----------------------------------------------------------------
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
. \" http://bugs.debian.org/507673
. \" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n (.g .ds Aq \(aq
.el .ds Aq '
. \" -----------------------------------------------------------------
2010-02-09 08:13:22 +00:00
. \" * set default formatting
. \" -----------------------------------------------------------------
. \" disable hyphenation
.nh
. \" disable justification (adjust text to left margin only)
.ad l
. \" -----------------------------------------------------------------
. \" * MAIN CONTENT STARTS HERE *
. \" -----------------------------------------------------------------
2014-05-24 18:49:37 +00:00
.SH "NAME"
mkvinfo \- Print information about elements in Matroska(TM) files
.SH "SYNOPSIS"
2010-02-09 08:13:22 +00:00
.HP \w '\fBmkvinfo\fR\ 'u
2014-05-24 18:49:37 +00:00
\fB mkvinfo\fR [options] {source\- filename}
.SH "DESCRIPTION"
2010-02-09 08:13:22 +00:00
.PP
2014-05-24 18:49:37 +00:00
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\& .
2010-02-09 08:13:22 +00:00
.PP
\fB \- g\fR , \fB \- \- gui\fR
.RS 4
2014-05-24 18:49:37 +00:00
Start the
GUI\& . This option is only available if mkvinfo was compiled with
2010-02-09 08:13:22 +00:00
GUI
2014-05-24 18:49:37 +00:00
support\& .
2010-02-09 08:13:22 +00:00
.RE
.PP
\fB \- c\fR , \fB \- \- checksums\fR
.RS 4
2014-05-24 18:49:37 +00:00
Calculates and display the
2010-02-09 08:13:22 +00:00
\fB Adler32\fR
2014-05-24 18:49:37 +00:00
checksum for each frame\& . Useful for debugging only\& .
2010-02-09 08:13:22 +00:00
.RE
.PP
\fB \- s\fR , \fB \- \- summary\fR
.RS 4
2014-05-24 18:49:37 +00:00
Only show a terse summary of what
2010-02-09 08:13:22 +00:00
\fB mkvinfo\fR (1)
2014-05-24 18:49:37 +00:00
finds and not each element\& .
2010-02-09 08:13:22 +00:00
.RE
.PP
2011-01-21 11:14:12 +00:00
\fB \- t\fR , \fB \- \- track\- info\fR
.RS 4
2014-05-24 18:49:37 +00:00
Show statistics for each track in verbose mode\& . Also sets verbosity to 1 if it was at level 0 before\& .
2011-01-21 11:14:12 +00:00
.RE
.PP
2010-05-22 13:27:12 +00:00
\fB \- x\fR , \fB \- \- hexdump\fR
.RS 4
2014-05-24 18:49:37 +00:00
Show the first 16 bytes of each frame as a hex dump\& .
2010-05-22 13:27:12 +00:00
.RE
.PP
\fB \- X\fR , \fB \- \- full\- hexdump\fR
.RS 4
2014-05-24 18:49:37 +00:00
Show all bytes of each frame as a hex dump\& .
2010-05-22 13:27:12 +00:00
.RE
.PP
\fB \- z\fR , \fB \- \- size\fR
.RS 4
2014-05-24 18:49:37 +00:00
Show the size of each element including its header\& .
2010-05-22 13:27:12 +00:00
.RE
.PP
2014-05-24 18:49:37 +00:00
\fB \- \- command\- line\- charset\fR \fI character\- set\fR
2010-02-09 08:13:22 +00:00
.RS 4
2014-05-24 18:49:37 +00:00
Sets the character set to convert strings given on the command line from\& . It defaults to the character set given by system\* (Aqs current locale\& .
2010-02-09 08:13:22 +00:00
.RE
.PP
2014-05-24 18:49:37 +00:00
\fB \- \- output\- charset\fR \fI character\- set\fR
2010-02-09 08:13:22 +00:00
.RS 4
2014-05-24 18:49:37 +00:00
Sets the character set to which strings are converted that are to be output\& . It defaults to the character set given by system\* (Aqs current locale\& .
2010-02-09 08:13:22 +00:00
.RE
.PP
2014-05-24 18:49:37 +00:00
\fB \- r\fR , \fB \- \- redirect\- output\fR \fI file\- name\fR
2010-02-09 08:13:22 +00:00
.RS 4
2014-05-24 18:49:37 +00:00
Writes all messages to the file
\fI file\- 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
2010-02-09 08:13:22 +00:00
\fB \- \- output\- charset\fR
2014-05-24 18:49:37 +00:00
is honored\& .
2010-02-09 08:13:22 +00:00
.RE
.PP
2014-05-24 18:49:37 +00:00
\fB \- \- ui\- language\fR \fI code\fR
2010-02-09 08:13:22 +00:00
.RS 4
2014-05-24 18:49:37 +00:00
Forces the translations for the language
\fI code\fR
to be used (e\& .g\& . \* (Aqde_DE\* (Aq for the German translations)\& . It is preferable to use the environment variables
\fI LANG\fR ,
\fI LC_MESSAGES\fR
and
2010-02-09 08:13:22 +00:00
\fI LC_ALL\fR
2014-05-24 18:49:37 +00:00
though\& . Entering \* (Aqlist\* (Aq as the
2010-02-09 08:13:22 +00:00
\fI code\fR
2014-05-24 18:49:37 +00:00
will cause
\fB mkvinfo\fR (1)
to output a list of available translations\& .
2010-02-09 08:13:22 +00:00
.RE
.PP
2014-05-24 18:49:37 +00:00
\fB \- \- debug\fR \fI topic\fR
2012-02-25 11:44:18 +00:00
.RS 4
2014-05-24 18:49:37 +00:00
Turn on debugging for a specific feature\& . This option is only useful for developers\& .
2012-02-25 11:44:18 +00:00
.RE
.PP
2014-05-24 18:49:37 +00:00
\fB \- \- engage\fR \fI feature\fR
2012-02-25 11:44:18 +00:00
.RS 4
2014-05-24 18:49:37 +00:00
Turn on experimental features\& . A list of available features can be requested with
\fB mkvinfo \- \- engage list\fR \& . These features are not meant to be used in normal situations\& .
2012-02-25 11:44:18 +00:00
.RE
.PP
2013-12-31 21:00:32 +00:00
\fB \- \- gui\- mode\fR
.RS 4
Turns on GUI mode\& . In this mode specially\- formatted lines may be output that can tell a controlling GUI what\* (Aqs happening\& . These messages follow the format \* (Aq#GUI#message\* (Aq\& . The message may be followed by key/value pairs as in \* (Aq#GUI#message#key1=value1#key2=value2\& ...\* (Aq\& . Neither the messages nor the keys are ever translated and always output in English\& .
.sp
This switch has nothing to do with the
\fB \- \- gui\fR
parameter which causes mkvinfo to display its own GUI\& .
.RE
.PP
2010-02-09 08:13:22 +00:00
\fB \- v\fR , \fB \- \- verbose\fR
.RS 4
2014-05-24 18:49:37 +00:00
Be more verbose\& . See the section about
verbosity levels
for a description which information will be output at which level\& .
2010-02-09 08:13:22 +00:00
.RE
.PP
\fB \- h\fR , \fB \- \- help\fR
.RS 4
2014-05-24 18:49:37 +00:00
Show usage information and exit\& .
2010-02-09 08:13:22 +00:00
.RE
.PP
\fB \- V\fR , \fB \- \- version\fR
.RS 4
2014-05-24 18:49:37 +00:00
Show version information and exit\& .
2010-02-09 08:13:22 +00:00
.RE
.PP
2010-12-23 15:07:34 +00:00
\fB \- \- check\- for\- updates\fR
.RS 4
2014-05-24 18:49:37 +00:00
Checks online for new releases by downloading the URL
\m[blue]\fBhttp://mkvtoolnix\-releases\&.bunkus\&.org/latest\-release\&.xml\fR\m[] \& . Four lines will be output in
key=value
style: the URL from where the information was retrieved (key
version_check_url), the currently running version (key
running_version), the latest release\* (Aqs version (key
available_version) and the download URL (key
download_url)\& .
2010-12-23 15:07:34 +00:00
.sp
2014-05-24 18:49:37 +00:00
Afterwards the program exists with an exit code of 0 if no newer release is available, with 1 if a newer release is available and with 2 if an error occured (e\& .g\& . if the update information could not be retrieved)\& .
2010-12-23 15:07:34 +00:00
.sp
2014-05-24 18:49:37 +00:00
This option is only available if the program was built with support for libcurl\& .
2010-12-23 15:07:34 +00:00
.RE
.PP
2014-05-24 18:49:37 +00:00
\fB @\fR \fI options\- file\fR
2010-02-09 08:13:22 +00:00
.RS 4
2014-05-24 18:49:37 +00:00
Reads additional command line arguments from the file
\fI options\- file\fR \& . Lines whose first non\- whitespace character is a hash mark (\* (Aq#\* (Aq) 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\& .
2010-12-20 19:12:59 +00:00
.sp
2014-05-24 18:49:37 +00:00
Several chars can be escaped, e\& .g\& . if you need to start a non\- comment line with \* (Aq#\* (Aq\& . The rules are described in
the section about escaping text\& .
2010-02-09 08:13:22 +00:00
.sp
2014-05-24 18:49:37 +00:00
The command line \* (Aq\fB mkvinfo \- v \- v input\& .mkv \- \- redirect\- output info\& .txt\fR \* (Aq could be converted into the following option file:
2010-02-09 08:13:22 +00:00
.sp
.if n \{ \
.RS 4
. \}
.nf
2014-05-24 18:49:37 +00:00
# Be more verbose
2010-02-09 08:13:22 +00:00
\- v
\- v
2014-05-24 18:49:37 +00:00
# Parse input\& .mkv
input\& .mkv
# and write the output to info\& .txt
2010-02-09 08:13:22 +00:00
\- \- redirect\- output
2014-05-24 18:49:37 +00:00
info\& .txt
2010-02-09 08:13:22 +00:00
.fi
.if n \{ \
.RE
. \}
.RE
2014-05-24 18:49:37 +00:00
.SH "VERBOSITY LEVELS"
2010-02-09 08:13:22 +00:00
.PP
2014-05-24 18:49:37 +00:00
The
2010-02-09 08:13:22 +00:00
\fB \- v\fR
2014-05-24 18:49:37 +00:00
option can be used to increase
\fB mkvinfo\fR (1)\* (Aqs verbosity level and print more information about the current file\& .
2010-02-09 08:13:22 +00:00
.PP
2014-05-24 18:49:37 +00:00
At level 0
2010-02-09 08:13:22 +00:00
\fB mkvinfo\fR (1)
2014-05-24 18:49:37 +00:00
will print only the track headers it finds and their types\& .
\fB mkvinfo\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\* (Aqre located in front of the track information\& .
2010-02-09 08:13:22 +00:00
.PP
2014-05-24 18:49:37 +00:00
At level 1
2010-02-09 08:13:22 +00:00
\fB mkvinfo\fR (1)
2014-05-24 18:49:37 +00:00
will also print all
2010-02-09 08:13:22 +00:00
Matroska(TM)
2014-05-24 18:49:37 +00:00
elements encountered for the complete file but the seek head entries and the cue entries\& . If the summary mode is enabled then
\fB mkvinfo\fR (1)
will output the frame position as well\& .
2010-02-09 08:13:22 +00:00
.PP
2014-05-24 18:49:37 +00:00
At level 2
2010-02-09 08:13:22 +00:00
\fB mkvinfo\fR (1)
2014-05-24 18:49:37 +00:00
will also print the seek head entries, the cue entries and the file position at which each
2010-02-09 08:13:22 +00:00
Matroska(TM)
2014-05-24 18:49:37 +00:00
element can be found at\& .
2010-02-09 08:13:22 +00:00
.PP
2014-05-24 18:49:37 +00:00
At level 3 and above
2010-02-09 08:13:22 +00:00
\fB mkvinfo\fR (1)
2014-05-24 18:49:37 +00:00
will print some information that is not directly connected to a
2010-02-09 08:13:22 +00:00
Matroska(TM)
2014-05-24 18:49:37 +00:00
element\& . All other elements only print stuff about the elements that were just found\& . Level 3 adds meta information to ease debugging (read: it\* (Aqs intended for developers only)\& . All lines written by level 3 are enclosed in square brackets to make filtering them out easy\& .
.SH "TEXT FILES AND CHARACTER SET CONVERSIONS"
2014-01-21 20:34:18 +00:00
.PP
For an in\- depth discussion about how all tools in the MKVToolNix suite handle character set conversions, input/output encoding, command line encoding and console encoding please see the identically\- named section in the
\fB mkvmerge\fR (1)
man page\& .
2014-05-24 18:49:37 +00:00
.SH "EXIT CODES"
2010-02-09 08:13:22 +00:00
.PP
\fB mkvinfo\fR (1)
2014-05-24 18:49:37 +00:00
exits with one of three exit codes:
2010-02-09 08:13:22 +00:00
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
\fB 0\fR
2014-05-24 18:49:37 +00:00
\- \- This exit codes means that the run has completed successfully\& .
2010-02-09 08:13:22 +00:00
.RE
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
\fB 1\fR
2014-05-24 18:49:37 +00:00
\- \- In this case
2010-02-09 08:13:22 +00:00
\fB mkvinfo\fR (1)
2014-05-24 18:49:37 +00:00
has output at least one warning, but the run did continue\& . A warning is prefixed with the text \* (AqWarning:\* (Aq\& .
2010-02-09 08:13:22 +00:00
.RE
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
\fB 2\fR
2014-05-24 18:49:37 +00:00
\- \- This exit code is used after an error occurred\& .
2010-02-09 08:13:22 +00:00
\fB mkvinfo\fR (1)
2014-05-24 18:49:37 +00:00
aborts right after outputting the error message\& . Error messages range from wrong command line arguments over read/write errors to broken files\& .
2010-02-09 08:13:22 +00:00
.RE
2014-05-24 18:49:37 +00:00
.SH "ESCAPING SPECIAL CHARS IN TEXT"
2010-12-20 19:12:59 +00:00
.PP
2014-05-24 18:49:37 +00:00
There are a few places in which special characters in text must or should be escaped\& . The rules for escaping are simple: each character that needs escaping is replaced with a backslash followed by another character\& .
2010-12-20 19:12:59 +00:00
.PP
2014-05-24 18:49:37 +00:00
The rules are: \* (Aq \* (Aq (a space) becomes \* (Aq\e s\* (Aq, \* (Aq"\* (Aq (double quotes) becomes \* (Aq\e 2\* (Aq, \* (Aq:\* (Aq becomes \* (Aq\e c\* (Aq, \* (Aq#\* (Aq becomes \* (Aq\e h\* (Aq and \* (Aq\e \* (Aq (a single backslash) itself becomes \* (Aq\e \e \* (Aq\& .
.SH "ENVIRONMENT VARIABLES"
2012-02-25 11:44:18 +00:00
.PP
\fB mkvinfo\fR (1)
2014-05-24 18:49:37 +00:00
uses the default variables that determine the system\* (Aqs locale (e\& .g\& .
2012-02-25 11:44:18 +00:00
\fI LANG\fR
2014-05-24 18:49:37 +00:00
and the
2012-02-25 11:44:18 +00:00
\fI LC_*\fR
2014-05-24 18:49:37 +00:00
family)\& . Additional variables:
2012-02-25 11:44:18 +00:00
.PP
2014-05-24 18:49:37 +00:00
\fI MKVTOOLNIX_DEBUG\fR and its short form \fI MTX_DEBUG\fR
2012-02-25 11:44:18 +00:00
.RS 4
2014-05-24 18:49:37 +00:00
The content is treated as if it had been passed via the
2012-02-25 11:44:18 +00:00
\fB \- \- debug\fR
2014-05-24 18:49:37 +00:00
option\& .
2012-02-25 11:44:18 +00:00
.RE
.PP
2014-05-24 18:49:37 +00:00
\fI MKVTOOLNIX_ENGAGE\fR and its short form \fI MTX_ENGAGE\fR
2012-02-25 11:44:18 +00:00
.RS 4
2014-05-24 18:49:37 +00:00
The content is treated as if it had been passed via the
2012-02-25 11:44:18 +00:00
\fB \- \- engage\fR
2014-05-24 18:49:37 +00:00
option\& .
2012-02-25 11:44:18 +00:00
.RE
2012-02-25 14:09:02 +00:00
.PP
2014-05-24 18:49:37 +00:00
\fI MKVTOOLNIX_OPTIONS\fR and its short form \fI MTX_OPTIONS\fR
2012-02-25 14:09:02 +00:00
.RS 4
2014-05-24 18:49:37 +00:00
The content is split on white space\& . The resulting partial strings are treated as if it had been passed as command line options\& . If you need to pass special characters (e\& .g\& . spaces) then you have to escape them (see
the section about escaping special characters in text)\& .
2012-02-25 14:09:02 +00:00
.RE
2014-05-24 18:49:37 +00:00
.SH "SEE ALSO"
2010-02-09 08:13:22 +00:00
.PP
\fB mkvmerge\fR (1),
\fB mkvextract\fR (1),
\fB mkvpropedit\fR (1),
\fB mmg\fR (1)
2014-05-24 18:49:37 +00:00
.SH "WWW"
2010-02-09 08:13:22 +00:00
.PP
2014-05-24 18:49:37 +00:00
The latest version can always be found at
\m[blue]\fBthe MKVToolNix homepage\fR\m[]\&\s-2\u[1] \d \s +2\& .
.SH "AUTHOR"
2010-02-09 08:13:22 +00:00
.PP
\fB Moritz Bunkus\fR <\& moritz@bunkus\& .org\& >
.RS 4
2014-05-24 18:49:37 +00:00
Developer
2010-02-09 08:13:22 +00:00
.RE
2014-05-24 18:49:37 +00:00
.SH "NOTES"
2010-02-09 08:13:22 +00:00
.IP " 1." 4
2014-05-24 18:49:37 +00:00
the MKVToolNix homepage
2010-02-09 08:13:22 +00:00
.RS 4
\% http://www.bunkus.org/videotools/mkvtoolnix/
.RE