diff --git a/doc/mkvextract.1 b/doc/mkvextract.1 index 2298670db..1072363f9 100644 --- a/doc/mkvextract.1 +++ b/doc/mkvextract.1 @@ -1,16 +1,33 @@ .TH MKVEXTRACT "1" "July 2003" "mkvextract v0.6.0" "User Commands" + + .SH NAME mkvextract \- extract tracks from Matroska files into other files + + .SH SYNOPSIS .B mkvextract -[\fIoptions\fR] \fB-i\fR \fIinname\fR [\fITID1\fR:\fIoutname1\fR [\fITID2\fR:\fIoutname2\fR ...]] +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:\fIout1\fR [\fIAID2\fR:\fIout2\fR ...]] +.br +.B mkvextract +<\-h|\-V> + + .SH DESCRIPTION .LP -This program extracts selected tracks from a single Matroska file to other -suitable file formats. -.TP -\fB\-i\fR \fIinname\fR -Use '\fIinname\fR' as the source. +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 and \fBattachments\fR. +The second argument is the name of the source file. It must be a Matroska file. + +.LP +Command line syntax for the \fBtracks\fR extraction mode: .TP \fB\-c\fR \fIcharset\fR Sets the charset to convert the next text subtitle track to. Only valid if the @@ -24,6 +41,28 @@ given mutliple times. The track IDs are the same as the ones output by .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. This option can +be given mutliple 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 +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. @@ -31,6 +70,7 @@ Show usage information. \fB\-V\fR, \fB\-\-version\fR Show version information. + .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 @@ -61,6 +101,13 @@ 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. +.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. + .SH EXAMPLES Let's assume you've made a Matroska file with one video track, two audio tracks @@ -84,7 +131,8 @@ Track ID 5: subtitles (S_TEXT/UTF8) .LP Now you can call \fBmkvmextract\fR like this: .LP -$ \fBmkvextract -i movie.mkv 3:audio.ogg 4:subtitles.srt\fR +$ \fBmkvextract tracks movie.mkv 3:audio.ogg 4:subtitles.srt\fR + .SH AUTHOR .I mkvextract