diff --git a/doc/docbook/mkvmerge.xml b/doc/docbook/mkvmerge.xml index 955ac538f..9d1a37d52 100644 --- a/doc/docbook/mkvmerge.xml +++ b/doc/docbook/mkvmerge.xml @@ -4,6 +4,12 @@ [ + +mkvmerge1"> +mkvinfo1"> +mkvextract1"> +mmg1"> + ]> @@ -74,34 +80,34 @@ - , out + , file-name - Write to the file out. If splitting is used then this parameter is treated a bit - differently. See the explanation for the option for details. + Write to the file file-name. If splitting is used then this parameter is treated a bit differently. See + the explanation for the option for details. - title + title Sets the general title for the output file, e.g. the movie name. - file + file-name - Read global tags from the XML file file. See the section about tags - below for details. + Read global tags from the XML file file-name. See the section about tags below for + details. - code + language-code - Sets the default language code that will be used for all tracks unless overwritten with the - option. The default language code is 'und' for 'undefined'. + Sets the default language code that will be used for all tracks unless overwritten with the option. The default language code is + 'und' for 'undefined'. @@ -112,28 +118,27 @@ - language + language-code - Sets the ISO639-2 language code that is written for each chapter entry. - Defaults to 'eng'. - See the section about chapters below for details. + Sets the ISO639-2 language code that is written for each chapter entry. Defaults to 'eng'. See the section about + chapters below for details. - This option can be used both for simple chapter files and for source files - that contain chapters but no information about the chapters' language, - e.g. MP4 and OGM files. + This option can be used both for simple chapter files and for source files that contain chapters but no information about the + chapters' language, e.g. MP4 and OGM files. - charset + character-set - Sets the charset that is used for the conversion to UTF-8 for simple chapter files. Defaults to the current system - locale. + Sets the character set that is used for the conversion to UTF-8 for simple chapter files. See the section about text files and character sets for an explanation how + &mkvmerge; converts between character sets. @@ -144,18 +149,17 @@ - format + format - mkvmerge supports reading CUE sheets for audio files as the input for - chapters. CUE sheets usually contain the entries PERFORMER and - TITLE for each index entry. mkvmerge uses these two strings in order - to construct the chapter name. With this option the format used for this name can be set. + &mkvmerge; supports reading CUE sheets for audio files as the input for chapters. CUE sheets usually + contain the entries PERFORMER and TITLE for each index entry. &mkvmerge; uses these two strings + in order to construct the chapter name. With this option the format used for this name can be set. - If this option is not given then mkvmerge defaults to the format '%p - %t' - (the performer, followed by a space, a dash, another space and the title). + If this option is not given then &mkvmerge; defaults to the format '%p - %t' (the performer, followed by a space, a dash, + another space and the title). @@ -182,11 +186,11 @@ - file + file-name - Read chapter information from the file file. See the section about chapters below for - details. + Read chapter information from the file file-name. See the section about chapters below for details. @@ -198,25 +202,43 @@ - FID1:TID1,FID2:TID2,... + FID1:TID1,FID2:TID2,... - This option changes the order in which the tracks for an input file are created. The argument is a comma separated - list of pairs IDs. Each pair contains first the file ID which is simply the number of the file on the command line - starting at 0. The second is a track ID from that file. If some track IDs are omitted then those tracks are - created after the ones given with this option have been created. + This option changes the order in which the tracks for an input file are created. The argument is a comma separated list of pairs + IDs. Each pair contains first the file ID (FID1) which is simply the number of the file on the command line + starting at 0. The second is a track ID (TID1) from that file. If some track IDs are omitted then those tracks + are created after the ones given with this option have been created. - nms + spec - Put at most n data blocks into each cluster. If the number is postfixed with 'ms' then put - at most n milliseconds of data into each cluster. The maximum length for a cluster that - mkvmerge accepts is 60000 blocks and 32000ms; the minimum length is 100ms. Programs - will only be able to seek to clusters, so creating larger clusters may lead to imprecise or slow seeking. + Limit the number of data blocks or the duration of data in each cluster. The spec parameter can either be a + number n without a unit or a number d postfixed with 'ms'. + + + + If no unit is used then &mkvmerge; will put at most n data blocks into each cluster. The maximum number of + blocks is 65535. + + + + If the number n is postfixed with 'ms' then &mkvmerge; puts at most d + milliseconds of data into each cluster. The minimum for d is '100ms', and the maximum is + '32000ms'. + + + + &mkvmerge; defaults to putting at most 65535 data blocks and 2000ms of data into a cluster. + + + + Programs trying to find a certain frame can only seek directly to a cluster and have to read the whole cluster afterwards. Therefore + creating larger clusters may lead to imprecise or slow seeking. @@ -225,10 +247,10 @@ - Tells mkvmerge not to create and write the cue data which can be compared to an index - in an AVI. Matroska files can be played back without the cue data, but seeking will probably be imprecise and - slower. Use this only if you're really desperate for space or for testing purposes. See also option - which can be specified for each input file. + Tells &mkvmerge; not to create and write the cue data which can be compared to an index in an AVI. Matroska files can be played back + without the cue data, but seeking will probably be imprecise and slower. Use this only if you're really desperate for space or for + testing purposes. See also option which can be specified for + each input file. @@ -237,8 +259,8 @@ - Tells mkvmerge not to create a meta seek element at the end of the file containing all - clusters. See also the section about the Matroska file layout. + Tells &mkvmerge; not to create a meta seek element at the end of the file containing all clusters. See also the section about the + Matroska file layout. @@ -247,8 +269,8 @@ - Disables lacing for all tracks. This will increase the file's size, especially if there are many audio - tracks. This option is not intended for everyday use. + Disables lacing for all tracks. This will increase the file's size, especially if there are many audio tracks. This option is not + intended for everyday use. @@ -257,31 +279,28 @@ - Write durations for all blocks. This will increase file size and does not offer any additional value for players - at the moment. + Write durations for all blocks. This will increase file size and does not offer any additional value for players at the moment. - n + factor - Forces the timecode scale factor to n. Valid values are in the range - 1000..10000000 or the special value -1. + Forces the timecode scale factor to factor. Valid values are in the range + 1000..10000000 or the special value -1. - Normally mkvmerge will use a value of 1000000 which means that - timecodes and durations will have a precision of 1ms. For files that will not contain a video track but at least - one audio track mkvmerge will automatically chose a timecode scale factor so that all - timecodes and durations have a precision of one audio sample. This causes bigger overhead but allows precise seeking - and extraction. + Normally &mkvmerge; will use a value of 1000000 which means that timecodes and durations will have a precision of + 1ms. For files that will not contain a video track but at least one audio track &mkvmerge; will automatically chose a timecode scale + factor so that all timecodes and durations have a precision of one audio sample. This causes bigger overhead but allows precise + seeking and extraction. - If the special value -1 is used then mkvmerge will use sample - precision even if a video track is present. + If the special value -1 is used then &mkvmerge; will use sample precision even if a video track is present. @@ -293,17 +312,17 @@ - specification + specification Splits the output file after a given size or a given time. Please note that tracks can only be split right before a key frame. Due - to buffering mkvmerge will split right before the next key frame after the split point has been reached. - Therefore the split point may be a bit off from what the user has specified. + to buffering &mkvmerge; will split right before the next key frame after the split point has been reached. Therefore the split point + may be a bit off from what the user has specified. - At the moment mkvmerge supports three different modes. + At the moment &mkvmerge; supports three different modes. @@ -313,7 +332,7 @@ - Syntax: size:dk|m|g + Syntax: size:dk|m|g @@ -337,7 +356,7 @@ - Syntax: duration:HH:MM:SS.nnnnnnnnn|ns + Syntax: duration:HH:MM:SS.nnnnnnnnn|ds @@ -346,7 +365,7 @@ The paramter must either have the form HH:MM:SS.nnnnnnnnn for specifying the duration in up to nano-second - precision or be a number n followed by the letter 's' for the duration in + precision or be a number d followed by the letter 's' for the duration in seconds. HH is the number of hours, MM the number of minutes, SS the number of seconds and nnnnnnnnn the number of nanoseconds. Both the number of hours and the number of nanoseconds can be omitted. There can be up to nine digits after the decimal point. After the duration of @@ -364,7 +383,7 @@ - Syntax: timecodes:A,B,C... + Syntax: timecodes:A,B,C... @@ -372,9 +391,9 @@ - The parameters A, B etc must all have the same format as the ones used for the - duration (see above). The list of timecodes is separated by commas. After the input stream has reached the current split point's - timecode a new file is created. Then the next split point given in this list is used. + The parameters A, B, c etc must all have the same format as the + ones used for the duration (see above). The list of timecodes is separated by commas. After the input stream has reached the + current split point's timecode a new file is created. Then the next split point given in this list is used. @@ -394,7 +413,7 @@ - + @@ -405,21 +424,82 @@ - SID + segment-UID - Links the first output file to the segment with the segment UID given by the SID parameter. See the section on - file linking below for details. + Links the first output file to the segment with the segment UID given by the segment-UID parameter. See the + section on file linking below for details. - SID + segment-UID - Links the last output file to the segment with the segment UID given by the SID parameter. See the section on - file linking below for details. + Links the last output file to the segment with the segment UID given by the segment-UID parameter. See the + section on file linking below for details. + + + + + + + Attachment support (more global options): + + + + + description + + + Plain text description of the following attachment. Applies to the next or option. + + + + + + + MIME type + + + MIME type of the following attachment. Applies to the next or option. A list of officially recognized + MIME types can be found e.g. at the IANA + homepage. The MIME type is mandatory for an attachment. + + + + + + name + + + Sets the name that will be stored in the output file for this attachment. If this option is not given then the name will be derived + from the file name of the attachment as given with the or the option. + + + + + + + file-name, + file-name + + + + Creates a file attachment inside the Matroska file. The MIME type must have been set before this option can used. The + difference between the two forms is that during splitting the files attached with are attached to all + output files while the ones attached with are only attached to the first file created. If + splitting is not used then both do the same. + + + + &mkvextract; can be used to extract attached files from a Matroska file. @@ -442,36 +522,26 @@ - Each segment is identified by a unique 128 bit wide segment UID. This UID is automatically generated by - mkvmerge. The linking is done primarily via putting the segment UIDs (short: SID) of the - previous/next file into the segment header information. - - mkvinfo - 1 - - prints these SIDs if it finds them. + Each segment is identified by a unique 128 bit wide segment UID. This UID is automatically generated by &mkvmerge;. The linking is done + primarily via putting the segment UIDs (short: SID) of the previous/next file into the segment header + information. &mkvinfo; prints these SIDs if it finds them. If a file is split into several smaller ones and linking is used then the timecodes will not start at 0 again but will continue where the last file has left off. This way the absolute time is kept even if the previous files are not available (e.g. when streaming). If no - linking is used then the timecodes should start at 0 for each file. By default mkvmerge does not use file - linking. If you want that you can turn it on with the option. This option is only useful if splitting is - activated as well. + linking is used then the timecodes should start at 0 for each file. By default &mkvmerge; does not use file linking. If you want that you + can turn it on with the option. This option is only useful if splitting is activated as well. - Regardless of whether splitting is active or not the user can tell mkvmerge to link the produced files to - specific SIDs. This is achieved with the options and - . These options accept a segment SID in the format that - - mkvinfo - 1 - - outputs: 16 hexadecimal numbers between 0x00 and 0xff prefixed with '0x' - each, e.g. '0x41 0xda 0x73 0x66 0xd9 0xcf 0xb2 0x1e 0xae 0x78 0xeb 0xb4 0x5e 0xca 0xb3 0x93'. Alternatively a shorter - form can be used: 16 hexadecimal numbers between 0x00 and 0xff without the - '0x' prefixes and without the spaces, e.g. '41da7366d9cfb21eae78ebb45ecab393'. + Regardless of whether splitting is active or not the user can tell &mkvmerge; to link the produced files to specific + SIDs. This is achieved with the options and . These + options accept a segment SID in the format that &mkvinfo; outputs: 16 hexadecimal numbers between + 0x00 and 0xff prefixed with '0x' each, e.g. '0x41 0xda 0x73 0x66 + 0xd9 0xcf 0xb2 0x1e 0xae 0x78 0xeb 0xb4 0x5e 0xca 0xb3 0x93'. Alternatively a shorter form can be used: 16 hexadecimal numbers + between 0x00 and 0xff without the '0x' prefixes and without the spaces, e.g. + '41da7366d9cfb21eae78ebb45ecab393'. @@ -484,9 +554,14 @@ See also - mkvinfo1, - mkvextract1, - mmg1 + &mkvinfo;, &mkvextract;, &mmg; + + + + + WWW + + The latest version can always be found at the MKVToolNix homepage.