Documentation changes of rev 3480

This commit is contained in:
Thomas Schmitt 2010-11-05 15:19:25 +00:00
parent 4dde2a206b
commit 64e43541db
3 changed files with 143 additions and 72 deletions

View File

@ -9,7 +9,7 @@
.\" First parameter, NAME, should be all caps .\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1) .\" other parameters are allowed: see man(7), man(1)
.TH XORRISO 1 "Oct 18, 2010" .TH XORRISO 1 "Nov 05, 2010"
.\" Please adjust this date whenever revising the manpage. .\" Please adjust this date whenever revising the manpage.
.\" .\"
.\" Some roff macros, for reference: .\" Some roff macros, for reference:
@ -2241,7 +2241,8 @@ can assume overwriteable media.
.br .br
There are booting mechanisms which do not use an El Torito record but rather There are booting mechanisms which do not use an El Torito record but rather
start at the first bytes of the image: PC-BIOS MBR for hard-disk-like devices, start at the first bytes of the image: PC-BIOS MBR for hard-disk-like devices,
MIPS Volume Header for old SGI computers, DEC Boot Block for old DECstation. MIPS Volume Header for old SGI computers, DEC Boot Block for old DECstation,
SUN Disk Label for SPARC machines.
.br .br
The boot firmware EFI may use programs which are located in a FAT filesystem The boot firmware EFI may use programs which are located in a FAT filesystem
and announced by an MBR partition table entry. and announced by an MBR partition table entry.
@ -2418,32 +2419,47 @@ partition offset. 0 chooses a default value.
partition offset. 0 chooses a default value. partition offset. 0 chooses a default value.
.br .br
\fBmips_path=\fRiso_rr_path declares a data file in the image to be a \fBmips_path=\fRiso_rr_path declares a data file in the image to be a
MIPS Big Endian boot file. Enable production of a MIPS Big Endian Volume MIPS Big Endian boot file and causes production of a MIPS Big Endian Volume
Header. This is mutually exclusive with MBR production and mipsel_path=. Header. This is mutually exclusive with production of other boot blocks
like MBR.
It will overwrite the first 512 bytes of any data eventually provided by It will overwrite the first 512 bytes of any data eventually provided by
system_area=. system_area=.
Up to 15 boot files can be declared by mips_path=. Up to 15 boot files can be declared by mips_path=.
.br .br
\fBmipsel_path=\fRiso_rr_path declares a data file in the image to be the \fBmipsel_path=\fRiso_rr_path declares a data file in the image to be the
MIPS Little Endian boot file. This is mutually exclusive with MBR production MIPS Little Endian boot file. This is mutually exclusive with other boot
and mips_path=. It will overwrite the first 512 bytes of any data eventually blocks.
It will overwrite the first 512 bytes of any data eventually
provided by system_area=. provided by system_area=.
Only a single boot file can be declared by mipsel_path=. Only a single boot file can be declared by mipsel_path=.
.br .br
\fBmips_discard\fR revokes any boot file declarations made by mips_path=. \fBsparc_label=\fRtext causes the production of a SUN Disk Label with the
This removes the ban on MBR production. given text as ASCII label. This boot block format allows to append images
for partitions 2 to 8. Partition 1 will always be the ISO image.
See option -append_partition.
The first 512 bytes of any data eventually provided
by system_area= will be overwritten.
.br
\fBmips_discard\fR and \fBsparc_discard\fR revoke any boot file
declarations made by mips_path= or mipsel_path=. They also disable production
of SUN Disk Label.
This removes the ban on production of other boot blocks.
.br .br
.br .br
.TP .TP
\fB\-append_partition\fR partition_number type_code disk_path \fB\-append_partition\fR partition_number type_code disk_path
Cause a prepared filesystem image to be appended to the ISO image and to be Cause a prepared filesystem image to be appended to the ISO image and to be
described by a partition table entry in an MBR at the start of the emerging described by a partition table entry in a boot block at the start of the
ISO image. The partition entry will bear the size of the submitted file emerging ISO image. The partition entry will bear the size of the submitted
rounded up to the next multiple of 2048 bytes. file rounded up to the next multiple of 2048 bytes.
.br .br
Beware of subsequent multi-session runs. The appended partition will get Beware of subsequent multi-session runs. The appended partition will get
overwritten. overwritten.
.br .br
Partitions may be appended with boot block type MBR and with SUN Disk Label.
.br
With MBR:
.br
partition_number may be 1 to 4. Number 1 will put the whole ISO image into partition_number may be 1 to 4. Number 1 will put the whole ISO image into
the unclaimed space before partition 1. So together with most xorriso MBR the unclaimed space before partition 1. So together with most xorriso MBR
features, number 2 would be the most natural choice. features, number 2 would be the most natural choice.
@ -2455,6 +2471,15 @@ yield usable results. For a list of codes search the Internet for
.br .br
The disk_path must provide the necessary data bytes at commit time. The disk_path must provide the necessary data bytes at commit time.
An empty disk_path disables this feature for the given partition number. An empty disk_path disables this feature for the given partition number.
.br
With SUN Disk Label (selected by -boot_image any sparc_label=):
.br
partition_number may be 2 to 8. Number 1 will always be the ISO image.
Partition start addresses are aligned to 320 KiB. The type_code does not
matter. Submit 0x0.
.br
Partition image name "." causes the partition to become a copy of the next
lower valid one.
.TP .TP
.B Jigdo Template Extraction: .B Jigdo Template Extraction:
.PP .PP

View File

@ -2009,7 +2009,7 @@ of the existing sessions, unless one can assume overwriteable media.
There are booting mechanisms which do not use an El Torito record but There are booting mechanisms which do not use an El Torito record but
rather start at the first bytes of the image: PC-BIOS MBR for rather start at the first bytes of the image: PC-BIOS MBR for
hard-disk-like devices, MIPS Volume Header for old SGI computers, DEC hard-disk-like devices, MIPS Volume Header for old SGI computers, DEC
Boot Block for old DECstation. Boot Block for old DECstation, SUN Disk Label for SPARC machines.
The boot firmware EFI may use programs which are located in a FAT The boot firmware EFI may use programs which are located in a FAT
filesystem and announced by an MBR partition table entry. filesystem and announced by an MBR partition table entry.
@ -2151,28 +2151,39 @@ filesystem and announced by an MBR partition table entry.
*partition_hd_cyl=*number gives the number of heads per cylinder *partition_hd_cyl=*number gives the number of heads per cylinder
for partition offset. 0 chooses a default value. for partition offset. 0 chooses a default value.
*mips_path=*iso_rr_path declares a data file in the image to be a *mips_path=*iso_rr_path declares a data file in the image to be a
MIPS Big Endian boot file. Enable production of a MIPS Big Endian MIPS Big Endian boot file and causes production of a MIPS Big
Volume Header. This is mutually exclusive with MBR production and Endian Volume Header. This is mutually exclusive with production
mipsel_path=. It will overwrite the first 512 bytes of any data of other boot blocks like MBR. It will overwrite the first 512
eventually provided by system_area=. Up to 15 boot files can be bytes of any data eventually provided by system_area=. Up to 15
declared by mips_path=. boot files can be declared by mips_path=.
*mipsel_path=*iso_rr_path declares a data file in the image to be *mipsel_path=*iso_rr_path declares a data file in the image to be
the MIPS Little Endian boot file. This is mutually exclusive with the MIPS Little Endian boot file. This is mutually exclusive with
MBR production and mips_path=. It will overwrite the first 512 other boot blocks. It will overwrite the first 512 bytes of any
bytes of any data eventually provided by system_area=. Only a data eventually provided by system_area=. Only a single boot file
single boot file can be declared by mipsel_path=. can be declared by mipsel_path=.
*mips_discard* revokes any boot file declarations made by *sparc_label=*text causes the production of a SUN Disk Label with
mips_path=. This removes the ban on MBR production. the given text as ASCII label. This boot block format allows to
append images for partitions 2 to 8. Partition 1 will always be
the ISO image. See option -append_partition. The first 512 bytes
of any data eventually provided by system_area= will be
overwritten.
*mips_discard* and *sparc_discard* revoke any boot file
declarations made by mips_path= or mipsel_path=. They also disable
production of SUN Disk Label. This removes the ban on production
of other boot blocks.
-append_partition partition_number type_code disk_path -append_partition partition_number type_code disk_path
Cause a prepared filesystem image to be appended to the ISO image Cause a prepared filesystem image to be appended to the ISO image
and to be described by a partition table entry in an MBR at the and to be described by a partition table entry in a boot block at
start of the emerging ISO image. The partition entry will bear the the start of the emerging ISO image. The partition entry will bear
size of the submitted file rounded up to the next multiple of 2048 the size of the submitted file rounded up to the next multiple of
bytes. 2048 bytes.
Beware of subsequent multi-session runs. The appended partition Beware of subsequent multi-session runs. The appended partition
will get overwritten. will get overwritten.
Partitions may be appended with boot block type MBR and with SUN
Disk Label.
With MBR:
partition_number may be 1 to 4. Number 1 will put the whole ISO partition_number may be 1 to 4. Number 1 will put the whole ISO
image into the unclaimed space before partition 1. So together image into the unclaimed space before partition 1. So together
with most xorriso MBR features, number 2 would be the most natural with most xorriso MBR features, number 2 would be the most natural
@ -2184,6 +2195,12 @@ filesystem and announced by an MBR partition table entry.
The disk_path must provide the necessary data bytes at commit time. The disk_path must provide the necessary data bytes at commit time.
An empty disk_path disables this feature for the given partition An empty disk_path disables this feature for the given partition
number. number.
With SUN Disk Label (selected by -boot_image any sparc_label=):
partition_number may be 2 to 8. Number 1 will always be the ISO
image. Partition start addresses are aligned to 320 KiB. The
type_code does not matter. Submit 0x0.
Partition image name "." causes the partition to become a copy of
the next lower valid one.
 
File: xorriso.info, Node: Jigdo, Next: Charset, Prev: Bootable, Up: Options File: xorriso.info, Node: Jigdo, Next: Charset, Prev: Bootable, Up: Options
@ -3887,7 +3904,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -alter_date sets timestamps in ISO image: Manip. (line 146) * -alter_date sets timestamps in ISO image: Manip. (line 146)
* -alter_date_r sets timestamps in ISO image: Manip. (line 166) * -alter_date_r sets timestamps in ISO image: Manip. (line 166)
* -append_partition adds arbitrary file after image end: Bootable. * -append_partition adds arbitrary file after image end: Bootable.
(line 178) (line 186)
* -application_id sets application id: SetWrite. (line 90) * -application_id sets application id: SetWrite. (line 90)
* -as emulates mkisofs or cdrecord: Emulation. (line 13) * -as emulates mkisofs or cdrecord: Emulation. (line 13)
* -assert_volid rejects undesired images: Loading. (line 65) * -assert_volid rejects undesired images: Loading. (line 65)
@ -4087,7 +4104,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* ACL, show in ISO image, -getfacl: Navigate. (line 69) * ACL, show in ISO image, -getfacl: Navigate. (line 69)
* ACL, show in ISO image, -getfacl_r: Navigate. (line 76) * ACL, show in ISO image, -getfacl_r: Navigate. (line 76)
* Appendable media, _definition: Media. (line 38) * Appendable media, _definition: Media. (line 38)
* Appended Filesystem Image, -append_partition: Bootable. (line 178) * Appended Filesystem Image, -append_partition: Bootable. (line 186)
* Backslash Interpretation, _definition: Processing. (line 49) * Backslash Interpretation, _definition: Processing. (line 49)
* Backup, enable fast incremental, -disk_dev_ino: Loading. (line 163) * Backup, enable fast incremental, -disk_dev_ino: Loading. (line 163)
* Backup, enable features, -for_backup: Loading. (line 158) * Backup, enable features, -for_backup: Loading. (line 158)
@ -4274,6 +4291,8 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Session, mount command line, -mount_cmd: Inquiry. (line 31) * Session, mount command line, -mount_cmd: Inquiry. (line 31)
* Session, mount parameters, -mount_opts: Inquiry. (line 47) * Session, mount parameters, -mount_opts: Inquiry. (line 47)
* Session, select as input, -load: Loading. (line 11) * Session, select as input, -load: Loading. (line 11)
* SUN Disk Label, production: Bootable. (line 173)
* SUN SPARC boot images, activation: Bootable. (line 207)
* System area, _definiton: Bootable. (line 123) * System area, _definiton: Bootable. (line 123)
* Table-of-content, search sessions, -rom_toc_scan: Loading. (line 184) * Table-of-content, search sessions, -rom_toc_scan: Loading. (line 184)
* Table-of-content, show, -toc: Inquiry. (line 18) * Table-of-content, show, -toc: Inquiry. (line 18)
@ -4335,38 +4354,38 @@ Node: Filter75430
Node: Writing79779 Node: Writing79779
Node: SetWrite86068 Node: SetWrite86068
Node: Bootable98019 Node: Bootable98019
Node: Jigdo109361 Node: Jigdo110326
Node: Charset113619 Node: Charset114584
Node: Exception116370 Node: Exception117335
Node: DialogCtl120885 Node: DialogCtl121850
Node: Inquiry123230 Node: Inquiry124195
Node: Navigate127360 Node: Navigate128325
Node: Verify134958 Node: Verify135923
Node: Restore143378 Node: Restore144343
Node: Emulation150034 Node: Emulation150999
Node: Scripting158181 Node: Scripting159146
Node: Frontend163743 Node: Frontend164708
Node: Examples164944 Node: Examples165909
Node: ExDevices166113 Node: ExDevices167078
Node: ExCreate166747 Node: ExCreate167712
Node: ExDialog168021 Node: ExDialog168986
Node: ExGrowing169283 Node: ExGrowing170248
Node: ExModifying170085 Node: ExModifying171050
Node: ExBootable170586 Node: ExBootable171551
Node: ExCharset171133 Node: ExCharset172098
Node: ExPseudo171961 Node: ExPseudo172926
Node: ExCdrecord172855 Node: ExCdrecord173820
Node: ExMkisofs173170 Node: ExMkisofs174135
Node: ExGrowisofs174173 Node: ExGrowisofs175138
Node: ExException175297 Node: ExException176262
Node: ExTime175751 Node: ExTime176716
Node: ExIncBackup176210 Node: ExIncBackup177175
Node: ExRestore179682 Node: ExRestore180647
Node: ExRecovery180651 Node: ExRecovery181616
Node: Files181217 Node: Files182182
Node: Seealso182445 Node: Seealso183410
Node: Legal182969 Node: Legal183934
Node: CommandIdx183891 Node: CommandIdx184856
Node: ConceptIdx197977 Node: ConceptIdx198942
 
End Tag Table End Tag Table

View File

@ -44,7 +44,7 @@
@c man .\" First parameter, NAME, should be all caps @c man .\" First parameter, NAME, should be all caps
@c man .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection @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 .\" other parameters are allowed: see man(7), man(1)
@c man .TH XORRISO 1 "Oct 19, 2010" @c man .TH XORRISO 1 "Nov 05, 2010"
@c man .\" Please adjust this date whenever revising the manpage. @c man .\" Please adjust this date whenever revising the manpage.
@c man .\" @c man .\"
@c man .\" Some roff macros, for reference: @c man .\" Some roff macros, for reference:
@ -2699,7 +2699,8 @@ can assume overwriteable media.
@* @*
There are booting mechanisms which do not use an El Torito record but rather There are booting mechanisms which do not use an El Torito record but rather
start at the first bytes of the image: PC-BIOS MBR for hard-disk-like devices, start at the first bytes of the image: PC-BIOS MBR for hard-disk-like devices,
MIPS Volume Header for old SGI computers, DEC Boot Block for old DECstation. MIPS Volume Header for old SGI computers, DEC Boot Block for old DECstation,
SUN Disk Label for SPARC machines.
@* @*
The boot firmware EFI may use programs which are located in a FAT filesystem The boot firmware EFI may use programs which are located in a FAT filesystem
and announced by an MBR partition table entry. and announced by an MBR partition table entry.
@ -2889,20 +2890,32 @@ partition offset. 0 chooses a default value.
@* @*
@cindex MIPS boot file, activation @cindex MIPS boot file, activation
@strong{mips_path=}iso_rr_path declares a data file in the image to be a @strong{mips_path=}iso_rr_path declares a data file in the image to be a
MIPS Big Endian boot file. Enable production of a MIPS Big Endian Volume MIPS Big Endian boot file and causes production of a MIPS Big Endian Volume
Header. This is mutually exclusive with MBR production and mipsel_path=. Header. This is mutually exclusive with production of other boot blocks
like MBR.
It will overwrite the first 512 bytes of any data eventually provided by It will overwrite the first 512 bytes of any data eventually provided by
system_area=. system_area=.
Up to 15 boot files can be declared by mips_path=. Up to 15 boot files can be declared by mips_path=.
@* @*
@strong{mipsel_path=}iso_rr_path declares a data file in the image to be the @strong{mipsel_path=}iso_rr_path declares a data file in the image to be the
MIPS Little Endian boot file. This is mutually exclusive with MBR production MIPS Little Endian boot file. This is mutually exclusive with other boot
and mips_path=. It will overwrite the first 512 bytes of any data eventually blocks.
It will overwrite the first 512 bytes of any data eventually
provided by system_area=. provided by system_area=.
Only a single boot file can be declared by mipsel_path=. Only a single boot file can be declared by mipsel_path=.
@* @*
@strong{mips_discard} revokes any boot file declarations made by mips_path=. @cindex SUN Disk Label, production
This removes the ban on MBR production. @strong{sparc_label=}text causes the production of a SUN Disk Label with the
given text as ASCII label. This boot block format allows to append images
for partitions 2 to 8. Partition 1 will always be the ISO image.
See option -append_partition.
The first 512 bytes of any data eventually provided
by system_area= will be overwritten.
@*
@strong{mips_discard} and @strong{sparc_discard} revoke any boot file
declarations made by mips_path= or mipsel_path=. They also disable production
of SUN Disk Label.
This removes the ban on production of other boot blocks.
@* @*
@end table @end table
@* @*
@ -2913,13 +2926,17 @@ This removes the ban on MBR production.
@kindex -append_partition adds arbitrary file after image end @kindex -append_partition adds arbitrary file after image end
@cindex Appended Filesystem Image, -append_partition @cindex Appended Filesystem Image, -append_partition
Cause a prepared filesystem image to be appended to the ISO image and to be Cause a prepared filesystem image to be appended to the ISO image and to be
described by a partition table entry in an MBR at the start of the emerging described by a partition table entry in a boot block at the start of the
ISO image. The partition entry will bear the size of the submitted file emerging ISO image. The partition entry will bear the size of the submitted
rounded up to the next multiple of 2048 bytes. file rounded up to the next multiple of 2048 bytes.
@* @*
Beware of subsequent multi-session runs. The appended partition will get Beware of subsequent multi-session runs. The appended partition will get
overwritten. overwritten.
@* @*
Partitions may be appended with boot block type MBR and with SUN Disk Label.
@*
With MBR:
@*
partition_number may be 1 to 4. Number 1 will put the whole ISO image into partition_number may be 1 to 4. Number 1 will put the whole ISO image into
the unclaimed space before partition 1. So together with most xorriso MBR the unclaimed space before partition 1. So together with most xorriso MBR
features, number 2 would be the most natural choice. features, number 2 would be the most natural choice.
@ -2931,6 +2948,16 @@ yield usable results. For a list of codes search the Internet for
@* @*
The disk_path must provide the necessary data bytes at commit time. The disk_path must provide the necessary data bytes at commit time.
An empty disk_path disables this feature for the given partition number. An empty disk_path disables this feature for the given partition number.
@*
@cindex SUN SPARC boot images, activation
With SUN Disk Label (selected by -boot_image any sparc_label=):
@*
partition_number may be 2 to 8. Number 1 will always be the ISO image.
Partition start addresses are aligned to 320 KiB. The type_code does not
matter. Submit 0x0.
@*
Partition image name "." causes the partition to become a copy of the next
lower valid one.
@end table @end table
@c man .TP @c man .TP
@c man .B Jigdo Template Extraction: @c man .B Jigdo Template Extraction: