From 70d5101d124becdd23a9cc205056f96baa7b15c0 Mon Sep 17 00:00:00 2001 From: Thomas Schmitt Date: Sat, 16 May 2015 10:36:06 +0000 Subject: [PATCH] Updated man xorriso about -report_system_area cmd --- libisoburn/trunk/xorriso/xorriso.1 | 36 +++++---- libisoburn/trunk/xorriso/xorriso.info | 109 +++++++++++++------------- libisoburn/trunk/xorriso/xorriso.texi | 36 +++++---- 3 files changed, 96 insertions(+), 85 deletions(-) diff --git a/libisoburn/trunk/xorriso/xorriso.1 b/libisoburn/trunk/xorriso/xorriso.1 index daf34255..bdd3ca09 100644 --- a/libisoburn/trunk/xorriso/xorriso.1 +++ b/libisoburn/trunk/xorriso/xorriso.1 @@ -9,7 +9,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH XORRISO 1 "Version 1.3.9, Apr 20, 2015" +.TH XORRISO 1 "Version 1.3.9, Mai 16, 2015" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -3876,42 +3876,46 @@ The timestamps get not automatically propagated from loaded image to newly written image. The ones for new images may be set by command \-volume_date. See there for the meaning of the particular timestamps. .TP -\fB\-report_el_torito\fR "plain"|"help" +\fB\-report_el_torito\fR mode .br -With parameter \fBplain\fR print a report about the information found +With mode \fBplain\fR print a report about the information found in the El Torito boot catalog of the loaded ISO image. .br -With parameter \fBhelp\fR print a text which explains the meaning of the +With mode \fBhelp\fR print a text which explains the meaning of the lines put out by "plain". .br -Parameter \fBcmd\fR tries to print the \fBxorriso\fR commands which are -necessary to produce the found El Torito equipment and System Area. +Mode \fBcmd\fR tries to print the \fBxorriso\fR commands which are +necessary to produce the found boot equipment: disk identifiers, +El Torito boot images, and System Area. Disk identifiers are strings +which the booting operating system might use to find the ISO filesystem +from where it comes. Currently known is the use of volume id and +modification date. +.br The intended use case is modification of the filesystem by having \-indev and \-outdev pointing to different images or drives. The result might be insufficient, if the found equipment cannot be -produced by xorriso. +produced by xorriso. Various SORRY events may arise in this case, but +it is not guaranteed that xorriso recognizes all its insufficiencies. .br -Parameter \fBas_mkisofs\fR tries to print the \fBxorriso \-as mkisofs\fR +Mode \fBas_mkisofs\fR tries to print the \fBxorriso \-as mkisofs\fR options, which are necessary to produce the found equipment. The intended use case is to use the mounted filesystem as input tree -together with the printed options. In some cases (e.g. \-isohybrid\-mbr) it -might be necessary to extract data from ISO to hard disk in order to -use the hard disk files as arguments of \-as mkisofs options. +together with the printed options. .TP -\fB\-report_system_area\fR "plain"|"help"|"gpt_crc_of:"disk_path -With parameter \fBplain\fR print a report about the information found in +\fB\-report_system_area\fR mode +With mode \fBplain\fR print a report about the information found in the System Area of the loaded ISO image. The report consists of zero to many lines with a header text, a colon, and information text. .br -With parameter \fBhelp\fR print a text which explains the meaning of the +With mode \fBhelp\fR print a text which explains the meaning of the lines put out by "plain". You probably will have to look for more documentation which explains the technical details of the mentioned boot facilities. .br -Parameters \fBcmd\fR and \fBas_mkisofs\fR work like with +Modes \fBcmd\fR and \fBas_mkisofs\fR work like with command \-report_el_torito. See above. .br -With parameter \fBgpt_crc_of:\fRdisk_path read up to 32 KiB from the disk +With mode \fBgpt_crc_of:\fRdisk_path read up to 32 KiB from the disk file with the path given after the colon. Compute the GPT compliant CRC number and print it to the result channel. The number is shown like "0x690fd979". The special disk_path "\-" causes reading from standard input. diff --git a/libisoburn/trunk/xorriso/xorriso.info b/libisoburn/trunk/xorriso/xorriso.info index a9e526e2..5317793e 100644 --- a/libisoburn/trunk/xorriso/xorriso.info +++ b/libisoburn/trunk/xorriso/xorriso.info @@ -3368,38 +3368,41 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Comm The ones for new images may be set by command -volume_date. See there for the meaning of the particular timestamps. --report_el_torito "plain"|"help" - With parameter *plain* print a report about the information found - in the El Torito boot catalog of the loaded ISO image. - With parameter *help* print a text which explains the meaning of - the lines put out by "plain". - Parameter *cmd* tries to print the *xorriso* commands which are - necessary to produce the found El Torito equipment and System Area. +-report_el_torito mode + With mode *plain* print a report about the information found in + the El Torito boot catalog of the loaded ISO image. + With mode *help* print a text which explains the meaning of the + lines put out by "plain". + Mode *cmd* tries to print the *xorriso* commands which are + necessary to produce the found boot equipment: disk identifiers, + El Torito boot images, and System Area. Disk identifiers are + strings which the booting operating system might use to find the + ISO filesystem from where it comes. Currently known is the use of + volume id and modification date. The intended use case is modification of the filesystem by having -indev and -outdev pointing to different images or drives. The result might be insufficient, if the found equipment cannot be - produced by xorriso. - Parameter *as_mkisofs* tries to print the *xorriso -as mkisofs* + produced by xorriso. Various SORRY events may arise in this case, + but it is not guaranteed that xorriso recognizes all its + insufficiencies. + Mode *as_mkisofs* tries to print the *xorriso -as mkisofs* options, which are necessary to produce the found equipment. The intended use case is to use the mounted filesystem as input tree - together with the printed options. In some cases (e.g. - -isohybrid-mbr) it might be necessary to extract data from ISO to - hard disk in order to use the hard disk files as arguments of -as - mkisofs options. + together with the printed options. --report_system_area "plain"|"help"|"gpt_crc_of:"disk_path - With parameter *plain* print a report about the information found - in the System Area of the loaded ISO image. The report consists of +-report_system_area mode + With mode *plain* print a report about the information found in + the System Area of the loaded ISO image. The report consists of zero to many lines with a header text, a colon, and information text. - With parameter *help* print a text which explains the meaning of - the lines put out by "plain". You probably will have to look for - more documentation which explains the technical details of the + With mode *help* print a text which explains the meaning of the + lines put out by "plain". You probably will have to look for more + documentation which explains the technical details of the mentioned boot facilities. - Parameters *cmd* and *as_mkisofs* work like with command + Modes *cmd* and *as_mkisofs* work like with command -report_el_torito. See above. - With parameter *gpt_crc_of:*disk_path read up to 32 KiB from the - disk file with the path given after the colon. Compute the GPT + With mode *gpt_crc_of:*disk_path read up to 32 KiB from the disk + file with the path given after the colon. Compute the GPT compliant CRC number and print it to the result channel. The number is shown like "0x690fd979". The special disk_path "-" causes reading from standard input. @@ -5268,7 +5271,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -reassure enables confirmation question: DialogCtl. (line 32) * -report_about controls verbosity: Exception. (line 55) * -report_el_torito shows Boot Catalog: Inquiry. (line 124) -* -report_system_area shows MBR, GPT, and alike: Inquiry. (line 143) +* -report_system_area shows MBR, GPT, and alike: Inquiry. (line 146) * -return_with controls exit value: Exception. (line 39) * -rm deletes files from ISO image: Manip. (line 21) * -rm_r deletes trees from ISO image: Manip. (line 28) @@ -5451,7 +5454,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Image, set volume timestamp, -volume_date: SetWrite. (line 212) * Image, show Boot Catalog: Inquiry. (line 124) * Image, show id strings, -pvd_info: Inquiry. (line 115) -* Image, show MBR, GPT, and alike, -pvd_info: Inquiry. (line 143) +* Image, show MBR, GPT, and alike, -pvd_info: Inquiry. (line 146) * Input Character Set, _definition: Charset. (line 25) * Insert, enable overwriting, -overwrite: SetInsert. (line 131) * Insert, file exclusion absolute, -not_paths: SetInsert. (line 55) @@ -5658,34 +5661,34 @@ Node: Charset156003 Node: Exception159318 Node: DialogCtl165438 Node: Inquiry168036 -Node: Navigate176374 -Node: Verify184672 -Node: Restore194499 -Node: Emulation203103 -Node: Scripting213491 -Node: Frontend221262 -Node: Examples230869 -Node: ExDevices232047 -Node: ExCreate232713 -Node: ExDialog233998 -Node: ExGrowing235263 -Node: ExModifying236068 -Node: ExBootable236572 -Node: ExCharset237124 -Node: ExPseudo238016 -Node: ExCdrecord238914 -Node: ExMkisofs239231 -Node: ExGrowisofs240571 -Node: ExException241706 -Node: ExTime242160 -Node: ExIncBackup242619 -Node: ExRestore246609 -Node: ExRecovery247542 -Node: Files248112 -Node: Seealso249411 -Node: Bugreport250134 -Node: Legal250715 -Node: CommandIdx251726 -Node: ConceptIdx268607 +Node: Navigate176478 +Node: Verify184776 +Node: Restore194603 +Node: Emulation203207 +Node: Scripting213595 +Node: Frontend221366 +Node: Examples230973 +Node: ExDevices232151 +Node: ExCreate232817 +Node: ExDialog234102 +Node: ExGrowing235367 +Node: ExModifying236172 +Node: ExBootable236676 +Node: ExCharset237228 +Node: ExPseudo238120 +Node: ExCdrecord239018 +Node: ExMkisofs239335 +Node: ExGrowisofs240675 +Node: ExException241810 +Node: ExTime242264 +Node: ExIncBackup242723 +Node: ExRestore246713 +Node: ExRecovery247646 +Node: Files248216 +Node: Seealso249515 +Node: Bugreport250238 +Node: Legal250819 +Node: CommandIdx251830 +Node: ConceptIdx268711  End Tag Table diff --git a/libisoburn/trunk/xorriso/xorriso.texi b/libisoburn/trunk/xorriso/xorriso.texi index 1503f6a5..7f87fd60 100644 --- a/libisoburn/trunk/xorriso/xorriso.texi +++ b/libisoburn/trunk/xorriso/xorriso.texi @@ -50,7 +50,7 @@ @c man .\" First parameter, NAME, should be all caps @c man .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection @c man .\" other parameters are allowed: see man(7), man(1) -@c man .TH XORRISO 1 "Version 1.3.9, Apr 20, 2015" +@c man .TH XORRISO 1 "Version 1.3.9, Mai 16, 2015" @c man .\" Please adjust this date whenever revising the manpage. @c man .\" @c man .\" Some roff macros, for reference: @@ -4495,46 +4495,50 @@ The timestamps get not automatically propagated from loaded image to newly written image. The ones for new images may be set by command -volume_date. See there for the meaning of the particular timestamps. @c man .TP -@item -report_el_torito "plain"|"help" +@item -report_el_torito mode @kindex -report_el_torito shows Boot Catalog @cindex Image, show Boot Catalog @* -With parameter @strong{plain} print a report about the information found +With mode @strong{plain} print a report about the information found in the El Torito boot catalog of the loaded ISO image. @* -With parameter @strong{help} print a text which explains the meaning of the +With mode @strong{help} print a text which explains the meaning of the lines put out by "plain". @* -Parameter @strong{cmd} tries to print the @strong{xorriso} commands which are -necessary to produce the found El Torito equipment and System Area. +Mode @strong{cmd} tries to print the @strong{xorriso} commands which are +necessary to produce the found boot equipment: disk identifiers, +El Torito boot images, and System Area. Disk identifiers are strings +which the booting operating system might use to find the ISO filesystem +from where it comes. Currently known is the use of volume id and +modification date. +@* The intended use case is modification of the filesystem by having -indev and -outdev pointing to different images or drives. The result might be insufficient, if the found equipment cannot be -produced by xorriso. +produced by xorriso. Various SORRY events may arise in this case, but +it is not guaranteed that xorriso recognizes all its insufficiencies. @* -Parameter @strong{as_mkisofs} tries to print the @strong{xorriso -as mkisofs} +Mode @strong{as_mkisofs} tries to print the @strong{xorriso -as mkisofs} options, which are necessary to produce the found equipment. The intended use case is to use the mounted filesystem as input tree -together with the printed options. In some cases (e.g. -isohybrid-mbr) it -might be necessary to extract data from ISO to hard disk in order to -use the hard disk files as arguments of -as mkisofs options. +together with the printed options. @c man .TP -@item -report_system_area "plain"|"help"|"gpt_crc_of:"disk_path +@item -report_system_area mode @kindex -report_system_area shows MBR, GPT, and alike @cindex Image, show MBR, GPT, and alike, -pvd_info -With parameter @strong{plain} print a report about the information found in +With mode @strong{plain} print a report about the information found in the System Area of the loaded ISO image. The report consists of zero to many lines with a header text, a colon, and information text. @* -With parameter @strong{help} print a text which explains the meaning of the +With mode @strong{help} print a text which explains the meaning of the lines put out by "plain". You probably will have to look for more documentation which explains the technical details of the mentioned boot facilities. @* -Parameters @strong{cmd} and @strong{as_mkisofs} work like with +Modes @strong{cmd} and @strong{as_mkisofs} work like with command -report_el_torito. See above. @* -With parameter @strong{gpt_crc_of:}disk_path read up to 32 KiB from the disk +With mode @strong{gpt_crc_of:}disk_path read up to 32 KiB from the disk file with the path given after the colon. Compute the GPT compliant CRC number and print it to the result channel. The number is shown like "0x690fd979". The special disk_path "-" causes reading from standard input.