Updated documentation

master
Thomas Schmitt 12 years ago
parent de078d2749
commit 52988adee6
  1. 26
      xorriso/xorriso.1
  2. 126
      xorriso/xorriso.info
  3. 28
      xorriso/xorriso.texi

@ -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 "Feb 17, 2011"
.TH XORRISO 1 "Mar 02, 2011"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -2314,7 +2314,7 @@ any more (if possible at all with the given type of target media).
This is the contrary of cdrecord, wodim, cdrskin option -multi,
and is one aspect of growisofs option -dvd-compat.
.TP
\fB\-padding\fR number["k"|"m"]
\fB\-padding\fR number["k"|"m"]|"included"|"appended"
Append the given number of extra bytes to the image stream.
This is a traditional remedy for a traditional bug in block
device read drivers. Needed only for CD recordings in TAO mode.
@ -2322,6 +2322,13 @@ Since one can hardly predict on what media an image might end up,
xorriso adds the traditional 300k of padding by default to all images.
.br
For images which will never get to a CD it is safe to use -padding 0 .
.br
Normally padding is not written as part of the ISO image but appended
after the image end. This is -padding mode "appended".
.br
Emulation command -as "mkisofs" and command -jigdo cause padding to be
written as part of the image.
The same effect is achieved by -padding mode "included".
.TP
.B Bootable ISO images:
.PP
@ -2514,12 +2521,16 @@ absolute start as well as from the partition start.
The offset value of an ISO image gets preserved when a new session is added.
So the value defined here is only in effect if a new ISO image gets written.
.br
\fBpartition_sec_hd=\fRnumber gives the number of sectors per head for
\fBpartition_hd_cyl=\fRnumber gives the number of heads per cylinder for
partition offset. 0 chooses a default value.
.br
\fBpartition_hd_cyl=\fRnumber gives the number of heads per cylinder for
\fBpartition_sec_hd=\fRnumber gives the number of sectors per head for
partition offset. 0 chooses a default value.
.br
If the product of partition_sec_hd and partition_hd_cyl is too small to
describe the image size by at most 1024 cylinders, then appropriate values
of partition_hd_cyl are chosen with partition_sec_hd 32 or 63.
.br
\fBmips_path=\fRiso_rr_path declares a data file in the image to be a
MIPS Big Endian boot file and causes production of a MIPS Big Endian Volume
Header. This is mutually exclusive with production of other boot blocks
@ -2993,8 +3004,8 @@ Print the foreseeable consumption of 2048 byte blocks
by next -commit. This can last a while as a -commit gets
prepared and only in last moment is revoked by this option.
The result depends on several settings and also on the kind of output device.
If no -jidgo options are given, then -padding (300 kB by default) is not
counted as part of the image size.
If no -jidgo options are given and not command -as "mkisofs" was used,
then -padding (300 kB by default) is not counted as part of the image size.
.TP
\fB\-tell_media_space\fR
Print available space on output media and the free space after
@ -3564,6 +3575,9 @@ standard output.
-print-size inhibits automatic image production at program end. This ban is
lifted only if the pending image changes get discarded.
.br
Eventual padding is counted as part of the ISO image if not option --emul-toc
is given.
.br
If no -iso-level is given, then level 1 is chosen when the first file or
directory is added to the image. At the same occasion directory names get
allowed to violate the standard by -compliance option allow_dir_id_ext.

@ -2072,7 +2072,7 @@ will be written according to the setting of option -acl.
This is the contrary of cdrecord, wodim, cdrskin option -multi,
and is one aspect of growisofs option -dvd-compat.
-padding number["k"|"m"]
-padding number["k"|"m"]|"included"|"appended"
Append the given number of extra bytes to the image stream. This
is a traditional remedy for a traditional bug in block device read
drivers. Needed only for CD recordings in TAO mode. Since one can
@ -2080,6 +2080,11 @@ will be written according to the setting of option -acl.
the traditional 300k of padding by default to all images.
For images which will never get to a CD it is safe to use -padding
0 .
Normally padding is not written as part of the ISO image but
appended after the image end. This is -padding mode "appended".
Emulation command -as "mkisofs" and command -jigdo cause padding
to be written as part of the image. The same effect is achieved
by -padding mode "included".

File: xorriso.info, Node: Bootable, Next: Jigdo, Prev: SetWrite, Up: Options
@ -2239,10 +2244,14 @@ filesystem and announced by an MBR partition table entry.
The offset value of an ISO image gets preserved when a new session
is added. So the value defined here is only in effect if a new
ISO image gets written.
*partition_sec_hd=*number gives the number of sectors per head for
partition offset. 0 chooses a default value.
*partition_hd_cyl=*number gives the number of heads per cylinder
for partition offset. 0 chooses a default value.
*partition_sec_hd=*number gives the number of sectors per head for
partition offset. 0 chooses a default value.
If the product of partition_sec_hd and partition_hd_cyl is too
small to describe the image size by at most 1024 cylinders, then
appropriate values of partition_hd_cyl are chosen with
partition_sec_hd 32 or 63.
*mips_path=*iso_rr_path declares a data file in the image to be a
MIPS Big Endian boot file and causes production of a MIPS Big
Endian Volume Header. This is mutually exclusive with production
@ -2643,8 +2652,9 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Opti
-commit. This can last a while as a -commit gets prepared and only
in last moment is revoked by this option. The result depends on
several settings and also on the kind of output device. If no
-jidgo options are given, then -padding (300 kB by default) is not
counted as part of the image size.
-jidgo options are given and not command -as "mkisofs" was used,
then -padding (300 kB by default) is not counted as part of the
image size.
-tell_media_space
Print available space on output media and the free space after
@ -3177,6 +3187,8 @@ programs trigger comparable actions.
drive to standard output.
-print-size inhibits automatic image production at program end.
This ban is lifted only if the pending image changes get discarded.
Eventual padding is counted as part of the ISO image if not option
-emul-toc is given.
If no -iso-level is given, then level 1 is chosen when the first
file or directory is added to the image. At the same occasion
directory names get allowed to violate the standard by -compliance
@ -4041,7 +4053,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -alter_date sets timestamps in ISO image: Manip. (line 146)
* -alter_date_r sets timestamps in ISO image: Manip. (line 166)
* -append_partition adds arbitrary file after image end: Bootable.
(line 186)
(line 190)
* -application_id sets application id: SetWrite. (line 117)
* -as emulates mkisofs or cdrecord: Emulation. (line 13)
* -assert_volid rejects undesired images: Loading. (line 84)
@ -4161,8 +4173,8 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -out_charset sets output character set: SetWrite. (line 183)
* -outdev aquires a drive for output: AqDrive. (line 29)
* -overwrite enables overwriting in ISO: SetInsert. (line 127)
* -pacifier controls pacifier text form: Emulation. (line 149)
* -padding sets amount of image padding: SetWrite. (line 266)
* -pacifier controls pacifier text form: Emulation. (line 151)
* -padding sets amount or mode of image padding: SetWrite. (line 266)
* -page set terminal geometry: DialogCtl. (line 19)
* -paste_in copies file into disk file: Restore. (line 117)
* -path_list inserts paths from disk file: Insert. (line 75)
@ -4175,13 +4187,13 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -prog_help prints help text: Frontend. (line 33)
* -prompt prompts for enter key: Scripting. (line 80)
* -publisher sets publisher id: SetWrite. (line 111)
* -pvd_info shows image id strings: Inquiry. (line 81)
* -pvd_info shows image id strings: Inquiry. (line 82)
* -pwd tells working directory in ISO: Navigate. (line 20)
* -pwdx tells working directory on disk: Navigate. (line 23)
* -quoted_not_list sets exclusions: SetInsert. (line 72)
* -quoted_path_list inserts paths from disk file: Insert. (line 80)
* -read_mkisofsrc searches and reads .mkisofsrc file: Emulation.
(line 137)
(line 139)
* -reassure enables confirmation question: DialogCtl. (line 32)
* -report_about controls verbosity: Exception. (line 55)
* -return_with controls exit value: Exception. (line 39)
@ -4191,7 +4203,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -rollback discards pending changes: Writing. (line 9)
* -rollback_end ends program without writing: Scripting. (line 125)
* -rom_toc_scan searches for sessions: Loading. (line 203)
* -scdbackup_tag enables scdbackup checksum tag: Emulation. (line 159)
* -scdbackup_tag enables scdbackup checksum tag: Emulation. (line 161)
* -scsi_log reports SCSI commands: Scripting. (line 113)
* -session_log logs written sessions: Scripting. (line 104)
* -session_string composes session info line: Inquiry. (line 56)
@ -4212,7 +4224,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -stdio_sync controls stdio buffer: SetWrite. (line 243)
* -stream_recording controls defect management: SetWrite. (line 224)
* -system_id sets system id: SetWrite. (line 126)
* -tell_media_space reports free space: Inquiry. (line 77)
* -tell_media_space reports free space: Inquiry. (line 78)
* -temp_mem_limit curbs memory consumption: Scripting. (line 70)
* -toc shows list of sessions: Inquiry. (line 18)
* -uid sets global ownership: SetWrite. (line 189)
@ -4244,15 +4256,15 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* ACL, show in ISO image, -getfacl: Navigate. (line 69)
* ACL, show in ISO image, -getfacl_r: Navigate. (line 76)
* Appendable media, _definition: Media. (line 38)
* Appended Filesystem Image, -append_partition: Bootable. (line 186)
* Appended Filesystem Image, -append_partition: Bootable. (line 190)
* Backslash Interpretation, _definition: Processing. (line 49)
* Backup, enable fast incremental, -disk_dev_ino: Loading. (line 182)
* Backup, enable features, -for_backup: Loading. (line 177)
* Backup, scdbackup checksum tag, -scdbackup: Emulation. (line 159)
* Backup, scdbackup checksum tag, -scdbackup: Emulation. (line 161)
* Blank media, _definition: Media. (line 29)
* Blind growing, _definition: Methods. (line 40)
* Bootability, control, -boot_image: Bootable. (line 26)
* cdrecord, Emulation: Emulation. (line 104)
* cdrecord, Emulation: Emulation. (line 106)
* Character Set, _definition: Charset. (line 6)
* Character Set, for input, -in_charset: Loading. (line 92)
* Character Set, for input/output, -charset: Charset. (line 43)
@ -4289,10 +4301,10 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Drive, write and eject, -commit_eject: Writing. (line 40)
* El Torito, _definiton: Extras. (line 19)
* Emulation, -as: Emulation. (line 13)
* Emulation, .mkisofsrc, -read_mkisofsrc: Emulation. (line 137)
* Emulation, cdrecord, -as: Emulation. (line 104)
* Emulation, .mkisofsrc, -read_mkisofsrc: Emulation. (line 139)
* Emulation, cdrecord, -as: Emulation. (line 106)
* Emulation, mkisofs, -as: Emulation. (line 16)
* Emulation, pacifier form, -pacifier: Emulation. (line 149)
* Emulation, pacifier form, -pacifier: Emulation. (line 151)
* Examples: Examples. (line 6)
* Filter, _definition: Filter. (line 6)
* Filter, apply to file tree, -set_filter_r: Filter. (line 84)
@ -4322,7 +4334,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Image, set volume id, -volid: SetWrite. (line 87)
* Image, set volume set id, -volset_id: SetWrite. (line 106)
* Image, set volume timestamp, -volume_date: SetWrite. (line 133)
* Image, show id strings, -pvd_info: Inquiry. (line 81)
* Image, show id strings, -pvd_info: Inquiry. (line 82)
* Insert, enable overwriting, -overwrite: SetInsert. (line 127)
* Insert, file exclusion absolute, -not_paths: SetInsert. (line 55)
* Insert, file exclusion from file, -not_list: SetInsert. (line 67)
@ -4355,7 +4367,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Media, erase, -blank: Writing. (line 45)
* Media, format, -format: Writing. (line 69)
* Media, list formats, -list_formats: Writing. (line 107)
* MIPS boot file, activation: Bootable. (line 162)
* MIPS boot file, activation: Bootable. (line 166)
* mkisofs, Emulation: Emulation. (line 16)
* Modifying, _definition: Methods. (line 27)
* Multi-session media, _definition: Media. (line 7)
@ -4434,8 +4446,8 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Session, mount command line, -mount_cmd: Inquiry. (line 31)
* Session, mount parameters, -mount_opts: Inquiry. (line 47)
* Session, select as input, -load: Loading. (line 11)
* SUN Disk Label, production: Bootable. (line 173)
* SUN SPARC boot images, activation: Bootable. (line 207)
* SUN Disk Label, production: Bootable. (line 177)
* SUN SPARC boot images, activation: Bootable. (line 211)
* System area, _definiton: Bootable. (line 123)
* Table-of-content, search sessions, -rom_toc_scan: Loading. (line 203)
* Table-of-content, show, -toc: Inquiry. (line 18)
@ -4458,7 +4470,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Write, defect management, -stream_recording: SetWrite. (line 224)
* Write, enable Joliet, -joliet: SetWrite. (line 10)
* Write, fifo size, -fs: SetWrite. (line 253)
* Write, free space, -tell_media_space: Inquiry. (line 77)
* Write, free space, -tell_media_space: Inquiry. (line 78)
* Write, log problematic disk files, -errfile_log: Scripting. (line 84)
* Write, log written sessions, -session_log: Scripting. (line 104)
* Write, padding image, -padding: SetWrite. (line 266)
@ -4496,39 +4508,39 @@ Node: CmdFind67752
Node: Filter79052
Node: Writing83401
Node: SetWrite89690
Node: Bootable103300
Node: Jigdo115607
Node: Charset119865
Node: Exception122616
Node: DialogCtl127131
Node: Inquiry129718
Node: Navigate134051
Node: Verify141991
Node: Restore150580
Node: Emulation157236
Node: Scripting166510
Node: Frontend172072
Node: Examples173367
Node: ExDevices174536
Node: ExCreate175170
Node: ExDialog176444
Node: ExGrowing177706
Node: ExModifying178508
Node: ExBootable179009
Node: ExCharset179556
Node: ExPseudo180384
Node: ExCdrecord181278
Node: ExMkisofs181593
Node: ExGrowisofs182596
Node: ExException183720
Node: ExTime184174
Node: ExIncBackup184633
Node: ExRestore188554
Node: ExRecovery189523
Node: Files190089
Node: Seealso191317
Node: Legal191841
Node: CommandIdx192763
Node: ConceptIdx207070
Node: Bootable103631
Node: Jigdo116168
Node: Charset120426
Node: Exception123177
Node: DialogCtl127692
Node: Inquiry130279
Node: Navigate134656
Node: Verify142596
Node: Restore151185
Node: Emulation157841
Node: Scripting167212
Node: Frontend172774
Node: Examples174069
Node: ExDevices175238
Node: ExCreate175872
Node: ExDialog177146
Node: ExGrowing178408
Node: ExModifying179210
Node: ExBootable179711
Node: ExCharset180258
Node: ExPseudo181086
Node: ExCdrecord181980
Node: ExMkisofs182295
Node: ExGrowisofs183298
Node: ExException184422
Node: ExTime184876
Node: ExIncBackup185335
Node: ExRestore189256
Node: ExRecovery190225
Node: Files190791
Node: Seealso192019
Node: Legal192543
Node: CommandIdx193465
Node: ConceptIdx207772

End Tag Table

@ -44,7 +44,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 "Feb 17, 2011"
@c man .TH XORRISO 1 "Mar 02, 2011"
@c man .\" Please adjust this date whenever revising the manpage.
@c man .\"
@c man .\" Some roff macros, for reference:
@ -2768,8 +2768,8 @@ any more (if possible at all with the given type of target media).
This is the contrary of cdrecord, wodim, cdrskin option -multi,
and is one aspect of growisofs option -dvd-compat.
@c man .TP
@item -padding number["k"|"m"]
@kindex -padding sets amount of image padding
@item -padding number["k"|"m"]|"included"|"appended"
@kindex -padding sets amount or mode of image padding
@cindex Write, padding image, -padding
Append the given number of extra bytes to the image stream.
This is a traditional remedy for a traditional bug in block
@ -2778,6 +2778,13 @@ Since one can hardly predict on what media an image might end up,
xorriso adds the traditional 300k of padding by default to all images.
@*
For images which will never get to a CD it is safe to use -padding 0 .
@*
Normally padding is not written as part of the ISO image but appended
after the image end. This is -padding mode "appended".
@*
Emulation command -as "mkisofs" and command -jigdo cause padding to be
written as part of the image.
The same effect is achieved by -padding mode "included".
@end table
@c man .TP
@c man .B Bootable ISO images:
@ -2985,12 +2992,16 @@ absolute start as well as from the partition start.
The offset value of an ISO image gets preserved when a new session is added.
So the value defined here is only in effect if a new ISO image gets written.
@*
@strong{partition_sec_hd=}number gives the number of sectors per head for
@strong{partition_hd_cyl=}number gives the number of heads per cylinder for
partition offset. 0 chooses a default value.
@*
@strong{partition_hd_cyl=}number gives the number of heads per cylinder for
@strong{partition_sec_hd=}number gives the number of sectors per head for
partition offset. 0 chooses a default value.
@*
If the product of partition_sec_hd and partition_hd_cyl is too small to
describe the image size by at most 1024 cylinders, then appropriate values
of partition_hd_cyl are chosen with partition_sec_hd 32 or 63.
@*
@cindex MIPS boot file, activation
@strong{mips_path=}iso_rr_path declares a data file in the image to be a
MIPS Big Endian boot file and causes production of a MIPS Big Endian Volume
@ -3531,8 +3542,8 @@ Print the foreseeable consumption of 2048 byte blocks
by next -commit. This can last a while as a -commit gets
prepared and only in last moment is revoked by this option.
The result depends on several settings and also on the kind of output device.
If no -jidgo options are given, then -padding (300 kB by default) is not
counted as part of the image size.
If no -jidgo options are given and not command -as "mkisofs" was used,
then -padding (300 kB by default) is not counted as part of the image size.
@c man .TP
@item -tell_media_space
@kindex -tell_media_space reports free space
@ -4219,6 +4230,9 @@ standard output.
-print-size inhibits automatic image production at program end. This ban is
lifted only if the pending image changes get discarded.
@*
Eventual padding is counted as part of the ISO image if not option --emul-toc
is given.
@*
If no -iso-level is given, then level 1 is chosen when the first file or
directory is added to the image. At the same occasion directory names get
allowed to violate the standard by -compliance option allow_dir_id_ext.

Loading…
Cancel
Save