libburnia/libisoburn
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Small corrections and enhancements in man xorriso

Browse Source
This commit is contained in:
Thomas Schmitt 2018-03-23 18:43:03 +01:00
parent 447b427688
commit e72ab34569
3 changed files with 103 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
xorriso/xorriso.1
View File

@ -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.4.9, Nov 12, 2017"
.TH XORRISO 1 "Version 1.4.9, Mar 23, 2018"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -804,10 +804,14 @@ Examples:
.br
If a track of a CD starts at block 123456 and gets copied to a disk file
where it begins at block 0, then this copy can be loaded with
\-displacement \-123456.
\-displacement \-123456
.br
If an ISO image was written onto a partition with offset of 640000 blocks of
512 bytes, then it can be loaded from the base device by \-displacement 160000.
512 bytes, then it can be loaded from the base device by
\-load sbsector 160000 \-displacement 160000
.br
(If the partition start address is not divisible by 4, then you will have
to employ a loop device instead.)
.br
In both cases, the ISO sessions should be self contained, i.e. not add\-on
sessions to an ISO image outside their track or partition.
@ -3183,11 +3187,11 @@ can assume overwriteable media.
Normally the boot images are data files inside the ISO filesystem. By
special path "\-\-interval:appended_partition_NNN:all::" it is possible to
refer to an appended partition. The number NNN gives the partition number
as used with the corresponding option \-append_partition.
as used with the corresponding command \-append_partition.
E.g.:
.br
\-append_partition 2 0xef /tmp/efi.img
\-e \-\-interval:appended_partition_2:all::
\-boot_image any efi_path=\-\-interval:appended_partition_2:all::
.br
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 or EFI GPT for

168
xorriso/xorriso.info
View File

@ -736,10 +736,12 @@ activate them only after image loading.
Examples:
If a track of a CD starts at block 123456 and gets copied to a disk
file where it begins at block 0, then this copy can be loaded with
-displacement -123456.
-displacement -123456
If an ISO image was written onto a partition with offset of 640000
blocks of 512 bytes, then it can be loaded from the base device by
-displacement 160000.
-load sbsector 160000 -displacement 160000
(If the partition start address is not divisible by 4, then you
will have to employ a loop device instead.)
In both cases, the ISO sessions should be self contained, i.e. not
add-on sessions to an ISO image outside their track or partition.
-drive_class "harmless"|"banned"|"caution"|"clear_list" disk_pattern
@ -2702,9 +2704,9 @@ of the existing sessions, unless one can assume overwriteable media.
Normally the boot images are data files inside the ISO filesystem. By
special path "-interval:appended_partition_NNN:all::" it is possible to
refer to an appended partition. The number NNN gives the partition
number as used with the corresponding option -append_partition. E.g.:
number as used with the corresponding command -append_partition. E.g.:
-append_partition 2 0xef /tmp/efi.img
-e -interval:appended_partition_2:all::
-boot_image any efi_path=-interval:appended_partition_2:all::
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 or EFI GPT for
hard-disk-like devices, APM partition entries for Macs which expect HFS+
@ -5242,7 +5244,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* # starts a comment line: Scripting. (line 156)
* -abort_on controls abort on error: Exception. (line 27)
* -abstract_file sets abstract file name: SetWrite. (line 244)
* -acl controls handling of ACLs: Loading. (line 171)
* -acl controls handling of ACLs: Loading. (line 173)
* -add inserts one or more paths: Insert. (line 44)
* -add_plainly inserts one or more paths: Insert. (line 68)
* -alter_date sets timestamps in ISO image: Manip. (line 139)
@ -5252,14 +5254,14 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -application_id sets application id: SetWrite. (line 191)
* -application_use sets application use field: SetWrite. (line 266)
* -as emulates mkisofs or cdrecord: Emulation. (line 13)
* -assert_volid rejects undesired images: Loading. (line 111)
* -auto_charset learns character set from image: Loading. (line 123)
* -assert_volid rejects undesired images: Loading. (line 113)
* -auto_charset learns character set from image: Loading. (line 125)
* -backslash_codes enables backslash conversion: Scripting. (line 71)
* -ban_stdio_write demands real drive: Loading. (line 334)
* -ban_stdio_write demands real drive: Loading. (line 336)
* -biblio_file sets biblio file name: SetWrite. (line 250)
* -blank erases media: Writing. (line 57)
* -boot_image controls bootability: Bootable. (line 75)
* -calm_drive reduces drive activity: Loading. (line 324)
* -calm_drive reduces drive activity: Loading. (line 326)
* -cd sets working directory in ISO: Navigate. (line 7)
* -cdx sets working directory on disk: Navigate. (line 15)
* -changes_pending overrides change status: Writing. (line 12)
@ -5293,24 +5295,24 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -cp_rx copies file trees to disk: Restore. (line 103)
* -cp_rx copies file trees to disk <1>: Restore. (line 111)
* -cut_out inserts piece of data file: Insert. (line 139)
* -data_cache_size adjusts read cache size: Loading. (line 350)
* -data_cache_size adjusts read cache size: Loading. (line 352)
* -dev acquires one drive for input and output: AqDrive. (line 12)
* -devices gets list of drives: Inquiry. (line 7)
* -device_links gets list of drives: Inquiry. (line 17)
* -dialog enables dialog mode: DialogCtl. (line 7)
* -disk_dev_ino fast incremental backup: Loading. (line 244)
* -disk_dev_ino fast incremental backup: Loading. (line 246)
* -disk_pattern controls pattern expansion: Insert. (line 34)
* -displacement compensate altered image start address: Loading.
(line 57)
* -drive_class controls drive accessability: Loading. (line 73)
* -drive_class controls drive accessability: Loading. (line 75)
* -du show directory size in ISO image: Navigate. (line 78)
* -dummy controls write simulation: SetWrite. (line 393)
* -dus show directory size in ISO image: Navigate. (line 81)
* -dusx show directory size on disk: Navigate. (line 88)
* -dux show directory size on disk: Navigate. (line 84)
* -dvd_obs set write block size: SetWrite. (line 330)
* -early_stdio_test classifies stdio drives: Loading. (line 338)
* -ecma119_map names w/o Rock Ridge, Joliet: Loading. (line 232)
* -early_stdio_test classifies stdio drives: Loading. (line 340)
* -ecma119_map names w/o Rock Ridge, Joliet: Loading. (line 234)
* -eject ejects drive tray: Writing. (line 50)
* -end writes pending session and ends program: Scripting. (line 151)
* -errfile_log logs problematic disk files: Scripting. (line 116)
@ -5321,13 +5323,13 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -extract_cut copies file piece to disk: Restore. (line 80)
* -extract_l copies files to disk: Restore. (line 76)
* -extract_single copies file to disk: Restore. (line 73)
* -file_name_limit curbs length of file names: Loading. (line 264)
* -file_name_limit curbs length of file names: Loading. (line 266)
* -file_size_limit limits data file size: SetInsert. (line 7)
* -find traverses and alters ISO tree: CmdFind. (line 7)
* -findx traverses disk tree: Navigate. (line 91)
* -follow softlinks and mount points: SetInsert. (line 69)
* -format formats media: Writing. (line 87)
* -for_backup -acl,-xattr,-hardlinks,-md5: Loading. (line 218)
* -for_backup -acl,-xattr,-hardlinks,-md5: Loading. (line 220)
* -fs sets size of fifo: SetWrite. (line 396)
* -getfacl shows ACL in ISO image: Navigate. (line 60)
* -getfacl_r shows ACL in ISO image: Navigate. (line 66)
@ -5335,13 +5337,13 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -getfattr_r shows xattr in ISO image: Navigate. (line 75)
* -gid sets global ownership: SetWrite. (line 287)
* -grow_blindly overides next writeable address: AqDrive. (line 60)
* -hardlinks controls handling of hard links: Loading. (line 134)
* -hardlinks controls handling of hard links: Loading. (line 136)
* -help prints help text: Scripting. (line 19)
* -hfsplus enables production of HFS+ partition: SetWrite. (line 14)
* -hide excludes file names from directory trees: Manip. (line 177)
* -history brings text into readline history: Scripting. (line 42)
* -indev acquires a drive for input: AqDrive. (line 23)
* -in_charset sets input character set: Loading. (line 118)
* -in_charset sets input character set: Loading. (line 120)
* -iso_rr_pattern controls pattern expansion: Manip. (line 10)
* -jigdo clears JTE or or adds parameter to JTE: Jigdo. (line 33)
* -joliet enables production of Joliet tree: SetWrite. (line 10)
@ -5369,7 +5371,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -map_l inserts paths from disk file: Insert. (line 96)
* -map_single inserts path: Insert. (line 93)
* -mark sets synchronizing message: Frontend. (line 23)
* -md5 controls handling of MD5 sums: Loading. (line 190)
* -md5 controls handling of MD5 sums: Loading. (line 192)
* -mkdir creates ISO directory: Insert. (line 177)
* -modesty_on_drive keep drive buffer hungry: SetWrite. (line 336)
* -mount issues mount command for ISO session: Restore. (line 146)
@ -5410,7 +5412,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -pwdx tells working directory on disk: Navigate. (line 21)
* -quoted_not_list sets exclusions: SetInsert. (line 66)
* -quoted_path_list inserts paths from disk file: Insert. (line 85)
* -read_fs filesystem type for image loading: Loading. (line 102)
* -read_fs filesystem type for image loading: Loading. (line 104)
* -read_mkisofsrc searches and reads .mkisofsrc file: Emulation.
(line 155)
* -read_speed set read speed: Loading. (line 11)
@ -5426,7 +5428,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
(line 51)
* -rollback discards pending changes: Writing. (line 9)
* -rollback_end ends program without writing: Scripting. (line 154)
* -rom_toc_scan searches for sessions: Loading. (line 296)
* -rom_toc_scan searches for sessions: Loading. (line 298)
* -rr_reloc_dir sets name of relocation directory: SetWrite. (line 144)
* -scdbackup_tag enables scdbackup checksum tag: Emulation. (line 179)
* -scsi_dev_family choose Linux device file type: AqDrive. (line 43)
@ -5473,7 +5475,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -volume_date sets volume timestamp: SetWrite. (line 205)
* -write_type chooses TAO or SAO/DAO: SetWrite. (line 417)
* -x enables automatic execution order of arguments: ArgSort. (line 16)
* -xattr controls handling of xattr (EA): Loading. (line 178)
* -xattr controls handling of xattr (EA): Loading. (line 180)
* -zisofs controls zisofs production: SetWrite. (line 290)

@ -5485,7 +5487,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
[index]
* Menu:
* ACL, control handling, -acl: Loading. (line 171)
* ACL, control handling, -acl: Loading. (line 173)
* ACL, set in ISO image, -setfacl: Manip. (line 68)
* ACL, set in ISO image, -setfacl_list: Manip. (line 94)
* ACL, set in ISO image, -setfacl_r: Manip. (line 92)
@ -5500,8 +5502,8 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Appended partition, in MBR or GPT: Bootable. (line 276)
* Automatic execution order, of arguments, -x: ArgSort. (line 16)
* Backslash Interpretation, _definition: Processing. (line 53)
* Backup, enable fast incremental, -disk_dev_ino: Loading. (line 244)
* Backup, enable features, -for_backup: Loading. (line 218)
* Backup, enable fast incremental, -disk_dev_ino: Loading. (line 246)
* Backup, enable features, -for_backup: Loading. (line 220)
* Backup, scdbackup checksum tag, -scdbackup: Emulation. (line 179)
* Blank media, _definition: Media. (line 29)
* Blank, format, Immed bit, -use_immed_bit: SetWrite. (line 374)
@ -5509,10 +5511,10 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Bootability, control, -boot_image: Bootable. (line 75)
* Bugs, reporting: Bugreport. (line 6)
* cdrecord, Emulation: Emulation. (line 120)
* Character Set, for input, -in_charset: Loading. (line 118)
* Character Set, for input, -in_charset: Loading. (line 120)
* Character Set, for input/output, -charset: Charset. (line 54)
* Character Set, for output, -out_charset: SetWrite. (line 279)
* Character set, learn from image, -auto_charset: Loading. (line 123)
* Character set, learn from image, -auto_charset: Loading. (line 125)
* Character Set, of terminal, -local_charset: Charset. (line 57)
* Character Set, _definition: Charset. (line 6)
* CHRP partition, _definition: Bootable. (line 288)
@ -5538,9 +5540,9 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Directory, create, -mkdir: Insert. (line 177)
* Directory, delete, -rmdir: Manip. (line 29)
* disk_path, _definition: Insert. (line 6)
* Drive, accessability, -drive_class: Loading. (line 73)
* Drive, classify stdio, -early_stdio_test: Loading. (line 338)
* Drive, demand real MMC, -ban_stdio_write: Loading. (line 334)
* Drive, accessability, -drive_class: Loading. (line 75)
* Drive, classify stdio, -early_stdio_test: Loading. (line 340)
* Drive, demand real MMC, -ban_stdio_write: Loading. (line 336)
* Drive, eject tray, -eject: Writing. (line 50)
* Drive, for input and output, -dev: AqDrive. (line 12)
* Drive, for input, -indev: AqDrive. (line 23)
@ -5548,7 +5550,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Drive, get drive list, -devices: Inquiry. (line 7)
* Drive, get drive list, -device_links: Inquiry. (line 17)
* Drive, list supported media, -list_profiles: Writing. (line 177)
* Drive, reduce activity, -calm_drive: Loading. (line 324)
* Drive, reduce activity, -calm_drive: Loading. (line 326)
* Drive, report SCSI commands, -scsi_log: Scripting. (line 143)
* Drive, write and eject, -commit_eject: Writing. (line 53)
* Drive, _definition: Drives. (line 6)
@ -5564,8 +5566,8 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Examples: Examples. (line 6)
* extattr, _definition: Extras. (line 66)
* File content, copy, -concat: Restore. (line 118)
* File names, curb length, -file_name_limit: Loading. (line 264)
* File names, if neither Rock Ridge nor Joliet: Loading. (line 232)
* File names, curb length, -file_name_limit: Loading. (line 266)
* File names, if neither Rock Ridge nor Joliet: Loading. (line 234)
* Filter, apply to file tree, -set_filter_r: Filter. (line 84)
* Filter, apply to file, -set_filter: Filter. (line 58)
* Filter, ban registration, -close_filter_list: Filter. (line 50)
@ -5583,15 +5585,15 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Group, in ISO image, -chgrp: Manip. (line 49)
* Group, in ISO image, -chgrp_r: Manip. (line 53)
* Growing, _definition: Methods. (line 20)
* Hard links, control handling, -hardlinks: Loading. (line 134)
* Hard links, control handling, -hardlinks: Loading. (line 136)
* HFS+ allocation block size: Bootable. (line 403)
* HFS+ serial number: Bootable. (line 400)
* hidden, set in ISO image, -hide: Manip. (line 177)
* HP-PA boot sector, production: Bootable. (line 375)
* Image reading, cache size, -data_cache_size: Loading. (line 350)
* Image, demand volume ID, -assert_volid: Loading. (line 111)
* Image reading, cache size, -data_cache_size: Loading. (line 352)
* Image, demand volume ID, -assert_volid: Loading. (line 113)
* Image, discard pending changes, -rollback: Writing. (line 9)
* Image, filesystem to load, -read_fs: Loading. (line 102)
* Image, filesystem to load, -read_fs: Loading. (line 104)
* Image, override change status, -changes_pending: Writing. (line 12)
* Image, set abstract file name, -abstract_file: SetWrite. (line 244)
* Image, set application id, -application_id: SetWrite. (line 191)
@ -5646,7 +5648,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* MBR bootable/active flag, enforce: Bootable. (line 343)
* MBR, set, -boot_image system_area=: Bootable. (line 200)
* MBR, _definition: Extras. (line 27)
* MD5, control handling, -md5: Loading. (line 190)
* MD5, control handling, -md5: Loading. (line 192)
* Media, erase, -blank: Writing. (line 57)
* Media, format, -format: Writing. (line 87)
* Media, list formats, -list_formats: Writing. (line 129)
@ -5750,7 +5752,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* SUN SPARC boot images, activation: Bootable. (line 438)
* Symbolic link, create, -lns: Insert. (line 181)
* System area, _definition: Bootable. (line 200)
* Table-of-content, search sessions, -rom_toc_scan: Loading. (line 296)
* Table-of-content, search sessions, -rom_toc_scan: Loading. (line 298)
* Table-of-content, show, -toc: Inquiry. (line 27)
* Timestamps, set in ISO image, -alter_date: Manip. (line 139)
* Timestamps, set in ISO image, -alter_date_r: Manip. (line 174)
@ -5784,7 +5786,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Write, set speed, -speed: SetWrite. (line 301)
* Write, simulation, -dummy: SetWrite. (line 393)
* Write, TAO or SAO/DAO, -write_type: SetWrite. (line 417)
* xattr, control handling, -xattr: Loading. (line 178)
* xattr, control handling, -xattr: Loading. (line 180)
* xattr, set in ISO image, -setfattr: Manip. (line 103)
* xattr, set in ISO image, -setfattr_list: Manip. (line 120)
* xattr, set in ISO image, -setfattr_r: Manip. (line 118)
@ -5808,48 +5810,48 @@ Node: Commands25598
Node: ArgSort27275
Node: AqDrive28769
Node: Loading32883
Node: Insert54011
Node: SetInsert65514
Node: Manip74946
Node: CmdFind85046
Node: Filter103975
Node: Writing108597
Node: SetWrite118753
Node: Bootable143512
Node: Jigdo169684
Node: Charset173943
Node: Exception177272
Node: DialogCtl183401
Node: Inquiry186003
Node: Navigate194887
Node: Verify203344
Node: Restore213222
Node: Emulation221835
Node: Scripting232294
Node: Frontend240077
Node: Examples249703
Node: ExDevices250881
Node: ExCreate251542
Node: ExDialog252842
Node: ExGrowing254113
Node: ExModifying254922
Node: ExBootable255432
Node: ExCharset255987
Node: ExPseudo256883
Node: ExCdrecord257810
Node: ExMkisofs258130
Node: ExGrowisofs259487
Node: ExException260641
Node: ExTime261099
Node: ExIncBackup261557
Node: ExRestore265583
Node: ExRecovery266529
Node: Files267101
Node: Environ268435
Node: Seealso269144
Node: Bugreport269861
Node: Legal270452
Node: CommandIdx271464
Node: ConceptIdx288798
Node: Insert54149
Node: SetInsert65652
Node: Manip75084
Node: CmdFind85184
Node: Filter104113
Node: Writing108735
Node: SetWrite118891
Node: Bootable143650
Node: Jigdo169845
Node: Charset174104
Node: Exception177433
Node: DialogCtl183562
Node: Inquiry186164
Node: Navigate195048
Node: Verify203505
Node: Restore213383
Node: Emulation221996
Node: Scripting232455
Node: Frontend240238
Node: Examples249864
Node: ExDevices251042
Node: ExCreate251703
Node: ExDialog253003
Node: ExGrowing254274
Node: ExModifying255083
Node: ExBootable255593
Node: ExCharset256148
Node: ExPseudo257044
Node: ExCdrecord257971
Node: ExMkisofs258291
Node: ExGrowisofs259648
Node: ExException260802
Node: ExTime261260
Node: ExIncBackup261718
Node: ExRestore265744
Node: ExRecovery266690
Node: Files267262
Node: Environ268596
Node: Seealso269305
Node: Bugreport270022
Node: Legal270613
Node: CommandIdx271625
Node: ConceptIdx288959

End Tag Table

14
xorriso/xorriso.texi
View File

@ -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.4.9, Nov 12, 2017"
@c man .TH XORRISO 1 "Version 1.4.9, Mar 23, 2018"
@c man .\" Please adjust this date whenever revising the manpage.
@c man .\"
@c man .\" Some roff macros, for reference:
@ -1032,10 +1032,14 @@ Examples:
@*
If a track of a CD starts at block 123456 and gets copied to a disk file
where it begins at block 0, then this copy can be loaded with
-displacement -123456.
-displacement -123456
@*
If an ISO image was written onto a partition with offset of 640000 blocks of
512 bytes, then it can be loaded from the base device by -displacement 160000.
512 bytes, then it can be loaded from the base device by
-load sbsector 160000 -displacement 160000
@*
(If the partition start address is not divisible by 4, then you will have
to employ a loop device instead.)
@*
In both cases, the ISO sessions should be self contained, i.e. not add-on
sessions to an ISO image outside their track or partition.
@ -3715,12 +3719,12 @@ can assume overwriteable media.
Normally the boot images are data files inside the ISO filesystem. By
special path "--interval:appended_partition_NNN:all::" it is possible to
refer to an appended partition. The number NNN gives the partition number
as used with the corresponding option -append_partition.
as used with the corresponding command -append_partition.
E.g.:
@*
-append_partition 2 0xef /tmp/efi.img
@*
-e --interval:appended_partition_2:all::
-boot_image any efi_path=--interval:appended_partition_2:all::
@*
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 or EFI GPT for