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

Revised the use of "option" and "ASCII" in xorriso.texi

Browse Source
This commit is contained in:
Thomas Schmitt 2012-03-05 12:13:37 +00:00
parent 5b3d809270
commit 22cc189200
4 changed files with 480 additions and 471 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
libisoburn/trunk/xorriso/man_xorriso_to_html.sh
View File

@ -86,7 +86,7 @@ then
-e 's/<b>Navigation in ISO image/\&nbsp;<BR><A NAME="Navigate"><\/A><b>Navigation in ISO image/' \ -e 's/<b>Navigation in ISO image/\&nbsp;<BR><A NAME="Navigate"><\/A><b>Navigation in ISO image/' \
-e 's/^filesystem:<\/b>/filesystem:<\/b><BR>\&nbsp;<BR>/' \ -e 's/^filesystem:<\/b>/filesystem:<\/b><BR>\&nbsp;<BR>/' \
-e 's/<b>Evaluation of readability and recovery:<\/b>/\&nbsp;<BR><A NAME="Verify"><\/A><b>Evaluation of readability and recovery:<\/b><BR>\&nbsp;<BR>/' \ -e 's/<b>Evaluation of readability and recovery:<\/b>/\&nbsp;<BR><A NAME="Verify"><\/A><b>Evaluation of readability and recovery:<\/b><BR>\&nbsp;<BR>/' \
-e 's/<b>osirrox ISO-to-disk restore options:<\/b>/\&nbsp;<BR><A NAME="Restore"><\/A><b>osirrox ISO-to-disk restore options:<\/b><BR>\&nbsp;<BR>/' \ -e 's/<b>osirrox ISO-to-disk restore commands:<\/b>/\&nbsp;<BR><A NAME="Restore"><\/A><b>osirrox ISO-to-disk restore commands:<\/b><BR>\&nbsp;<BR>/' \
-e 's/<b>Command compatibility emulations:<\/b>/\&nbsp;<BR><A NAME="Emulation"><\/A><b>Command compatibility emulations:<\/b><BR>\&nbsp;<BR>/' \ -e 's/<b>Command compatibility emulations:<\/b>/\&nbsp;<BR><A NAME="Emulation"><\/A><b>Command compatibility emulations:<\/b><BR>\&nbsp;<BR>/' \
-e 's/^<p><b>&minus;as</<p>\&nbsp;<BR><b>\&minus;as</' \ -e 's/^<p><b>&minus;as</<p>\&nbsp;<BR><b>\&minus;as</' \
-e 's/<b>Scripting, dialog and/\&nbsp;<BR><A NAME="Scripting"><\/A><b>Scripting, dialog and/' \ -e 's/<b>Scripting, dialog and/\&nbsp;<BR><A NAME="Scripting"><\/A><b>Scripting, dialog and/' \

214
libisoburn/trunk/xorriso/xorriso.1
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 "Version 1.2.1, Feb 03, 2012" .TH XORRISO 1 "Version 1.2.1, Feb 05, 2012"
.\" 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:
@ -169,11 +169,11 @@ There are two families of media in the MMC standard:
.br .br
\fBMulti\-session media\fR are CD\-R, CD\-RW, DVD\-R, DVD+R, DVD+R/DL, BD\-R, and \fBMulti\-session media\fR are CD\-R, CD\-RW, DVD\-R, DVD+R, DVD+R/DL, BD\-R, and
unformatted DVD\-RW. These media provide a table of content which unformatted DVD\-RW. These media provide a table of content which
describes their existing sessions. See option \fB\-toc\fR. describes their existing sessions. See command \fB\-toc\fR.
.br .br
Similar to multi\-session media are DVD\-R DL and minimally blanked DVD\-RW. Similar to multi\-session media are DVD\-R DL and minimally blanked DVD\-RW.
They allow only a single session of which the size must be known in advance. They allow only a single session of which the size must be known in advance.
\fBxorriso\fR will write onto them only if option \-close is set to "on". \fBxorriso\fR will write onto them only if command \-close is set to "on".
.br .br
\fBOverwriteable media\fR are DVD\-RAM, DVD+RW, BD\-RE, and formatted DVD\-RW. \fBOverwriteable media\fR are DVD\-RAM, DVD+RW, BD\-RE, and formatted DVD\-RW.
They allow random write access but do not provide information about their They allow random write access but do not provide information about their
@ -204,13 +204,13 @@ media, or to apply mandatory formatting to new media if necessary.
multi\-session media in appendable state, or they are overwriteable media multi\-session media in appendable state, or they are overwriteable media
which contain an ISO image suitable for \fBxorriso\fR. which contain an ISO image suitable for \fBxorriso\fR.
.br .br
Appendable is the state after writing a session with option \-close off. Appendable is the state after writing a session with command \-close off.
.br .br
\fBClosed\fR media cannot be written. They may contain an ISO image suitable \fBClosed\fR media cannot be written. They may contain an ISO image suitable
for \fBxorriso\fR. for \fBxorriso\fR.
.br .br
Closed is the state of DVD\-ROM media and of multi\-session media which were Closed is the state of DVD\-ROM media and of multi\-session media which were
written with option \-close on. If the drive is read\-only hardware then it will written with command \-close on. If the drive is read\-only hardware then it will
probably show any media as closed CD\-ROM resp. DVD\-ROM. probably show any media as closed CD\-ROM resp. DVD\-ROM.
.br .br
Overwriteable media assume this state in such read\-only drives or if they Overwriteable media assume this state in such read\-only drives or if they
@ -218,14 +218,14 @@ contain unrecognizable data in the first 32 data blocks.
.br .br
Read\-only drives may or may not show session histories of multi\-session Read\-only drives may or may not show session histories of multi\-session
media. Often only the first and the last session are visible. Sometimes media. Often only the first and the last session are visible. Sometimes
not even that. Option \-rom_toc_scan might or might not help in such cases. not even that. Command \-rom_toc_scan might or might not help in such cases.
.SS .SS
.B Creating, Growing, Modifying, Blind Growing: .B Creating, Growing, Modifying, Blind Growing:
.br .br
A new empty ISO image gets \fBcreated\fR A new empty ISO image gets \fBcreated\fR
if there is no input drive with a valid ISO 9660 image when the first time if there is no input drive with a valid ISO 9660 image when the first time
an output drive is defined. This is achieved by option \-dev on blank media an output drive is defined. This is achieved by command \-dev on blank media
or by option \-outdev on media in any state. or by command \-outdev on media in any state.
.br .br
The new empty image can be populated with directories and files. The new empty image can be populated with directories and files.
Before it can be written, the medium in the output drive must get into Before it can be written, the medium in the output drive must get into
@ -242,7 +242,7 @@ ISO 9660 + Rock Ridge directory tree. It is possible to hide files from
previous sessions but they still exist on the medium and with many types of previous sessions but they still exist on the medium and with many types of
optical media it is quite easy to recover them by mounting older sessions. optical media it is quite easy to recover them by mounting older sessions.
.br .br
Growing is achieved by option \-dev. Growing is achieved by command \-dev.
.PP .PP
The write method of \fBmodifying\fR produces compact filesystem The write method of \fBmodifying\fR produces compact filesystem
images with no outdated files or directory trees. Modifying can write its images with no outdated files or directory trees. Modifying can write its
@ -256,10 +256,10 @@ So for this method one needs either two optical drives or has to work with
filesystem objects as source and/or target medium. filesystem objects as source and/or target medium.
.br .br
Modifying takes place if input drive and output drive are not the same and Modifying takes place if input drive and output drive are not the same and
if option \-grow_blindly is set to its default "off". if command \-grow_blindly is set to its default "off".
This is achieved by options \-indev and \-outdev. This is achieved by commands \-indev and \-outdev.
.PP .PP
If option \-grow_blindly is set to a non\-negative number and if \-indev and If command \-grow_blindly is set to a non\-negative number and if \-indev and
\-outdev are both set to different drives, then \fBblind growing\fR is \-outdev are both set to different drives, then \fBblind growing\fR is
performed. It produces an add\-on session which is ready for being written performed. It produces an add\-on session which is ready for being written
to the given block address. This is the usage model of to the given block address. This is the usage model of
@ -354,13 +354,13 @@ device by using its path with the "stdio:" prefix. By default any address
in the /dev tree without prefix "stdio:" will work only if it leads to a MMC in the /dev tree without prefix "stdio:" will work only if it leads to a MMC
drive. drive.
.br .br
One may use option One may use command
\fB\-ban_stdio_write\fR \fB\-ban_stdio_write\fR
to surely prevent this risk and to allow only MMC drives. to surely prevent this risk and to allow only MMC drives.
.br .br
One may prepend "mmc:" to a path to surely disallow any automatic "stdio:". One may prepend "mmc:" to a path to surely disallow any automatic "stdio:".
.br .br
By option \-drive_class one may ban certain paths or allow access without By command \-drive_class one may ban certain paths or allow access without
prefix "stdio:" to other paths. prefix "stdio:" to other paths.
.SS .SS
.B Rock Ridge, POSIX, X/Open, El Torito, ACL, xattr: .B Rock Ridge, POSIX, X/Open, El Torito, ACL, xattr:
@ -387,7 +387,7 @@ The content of the boot image files is not in the scope of El Torito.
.br .br
Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images. Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images.
\fBxorriso\fR is able to create or maintain an El Torito object which \fBxorriso\fR is able to create or maintain an El Torito object which
makes such an image bootable. For details see option \-boot_image. makes such an image bootable. For details see command \-boot_image.
.br .br
It is possible to make ISO images bootable from USB stick or other It is possible to make ISO images bootable from USB stick or other
hard\-disk\-like media by \-boot_image parameter system_area= . This installs hard\-disk\-like media by \-boot_image parameter system_area= . This installs
@ -409,7 +409,7 @@ EFI, MIPS Big Endian (SGI), MIPS Little Endian (DEC), SUN SPARC.
are an advanced way of controlling access permissions to file objects. Neither are an advanced way of controlling access permissions to file objects. Neither
ISO 9660 nor Rock Ridge specify a way to record ACLs. So libisofs has ISO 9660 nor Rock Ridge specify a way to record ACLs. So libisofs has
introduced a standard conformant extension named AAIP for that purpose. introduced a standard conformant extension named AAIP for that purpose.
It uses this extension if enabled by option It uses this extension if enabled by command
\fB\-acl\fR. \fB\-acl\fR.
.br .br
AAIP enhanced images are supposed to be mountable normally, but one cannot AAIP enhanced images are supposed to be mountable normally, but one cannot
@ -434,7 +434,7 @@ pairs which
have names out of the user namespace. I.e. those which begin with "user.", have names out of the user namespace. I.e. those which begin with "user.",
like "user.x" or "user.whatever". Name has to be a 0 terminated string. like "user.x" or "user.whatever". Name has to be a 0 terminated string.
Value may be any array of bytes which does not exceed the size of 4095 bytes. Value may be any array of bytes which does not exceed the size of 4095 bytes.
xattr processing happens only if it is enabled by option xattr processing happens only if it is enabled by command
\fB\-xattr\fR. \fB\-xattr\fR.
.br .br
As with ACL, currently only \fBxorriso\fR is able to retrieve xattr As with ACL, currently only \fBxorriso\fR is able to retrieve xattr
@ -448,7 +448,7 @@ only on GNU/Linux and FreeBSD, where they are known as extattr.
.br .br
Commands are either actions which happen immediately or settings which Commands are either actions which happen immediately or settings which
influence following actions. So their sequence does matter, unless they are influence following actions. So their sequence does matter, unless they are
given as program arguments and option given as program arguments and command
\fB\-x\fR \fB\-x\fR
is among them. is among them.
.br .br
@ -459,7 +459,7 @@ terminated by either the \fBlist delimiter\fR, occur at the end of
the argument list, or occur at the end of an input line. the argument list, or occur at the end of an input line.
.PP .PP
At program start the list delimiter is the string "\-\-". At program start the list delimiter is the string "\-\-".
This may be changed with the \-list_delimiter option in order to allow This may be changed with the \-list_delimiter command in order to allow
"\-\-" as parameter in a variable length list. "\-\-" as parameter in a variable length list.
However, it is advised to reset the delimiter to "\-\-" However, it is advised to reset the delimiter to "\-\-"
immediately afterwards. immediately afterwards.
@ -501,15 +501,15 @@ enclose whitespace and make it part of words (e.g. of file names). Each mark
type can enclose the marks of the other type. A trailing backslash \\ outside type can enclose the marks of the other type. A trailing backslash \\ outside
quotations or an open quotation cause the next input line to be appended. quotations or an open quotation cause the next input line to be appended.
.br .br
Quoted input accepts any ASCII character except NUL (0) as the content of Quoted input accepts any 8\-bit character except NUL (0) as the content of
the quotes. the quotes.
Nevertheless it can be cumbersome for the user to produce those characters Nevertheless it can be cumbersome for the user to produce those characters
directly. Therefore quoted input and program arguments allow optional directly. Therefore quoted input and program arguments allow optional
\fBBackslash Interpretation\fR \fBBackslash Interpretation\fR
which can represent all ASCII characters except NUL (0) via backslash codes which can represent all 8\-bit characters except NUL (0) via backslash codes
as in $'...' of bash. as in $'...' of bash.
.br .br
This is not enabled by default. See option \-backslash_codes. This is not enabled by default. See command \-backslash_codes.
.PP .PP
When the program starts then it first looks for argument \-no_rc. If this is When the program starts then it first looks for argument \-no_rc. If this is
not present then it looks for its startup files and not present then it looks for its startup files and
@ -542,7 +542,7 @@ the history of previous input lines.
See man readline See man readline
for more info about libreadline. for more info about libreadline.
.PP .PP
Option \-page activates a built\-in result text pager which may be convenient in Command \-page activates a built\-in result text pager which may be convenient in
dialog mode. After an action has output the given number of terminal lines, dialog mode. After an action has output the given number of terminal lines,
the pager prompts the user for a line of input. the pager prompts the user for a line of input.
.br .br
@ -564,8 +564,8 @@ All actions try to abort as soon as possible.
.SH OPTIONS .SH OPTIONS
.br .br
All command words are shown with a leading dash although this dash is not All command words are shown with a leading dash although this dash is not
mandatory for the option to be recognized. Nevertheless within option \-as mandatory for the command to be recognized. Nevertheless within command \-as
the dashes of the emulated options are mandatory. the dashes of the emulated commands are mandatory.
.br .br
Normally any number of leading dashes is ignored with command words and Normally any number of leading dashes is ignored with command words and
inner dashes are interpreted as underscores. inner dashes are interpreted as underscores.
@ -595,7 +595,8 @@ with a single dash (i.e. "\-x"). It will not work in startup files, nor with
It affects only the commands given as program arguments. It affects only the commands given as program arguments.
.TP .TP
\fB\-list_arg_sorting\fR \fB\-list_arg_sorting\fR
List all xorriso commands in the order which applies if option \-x is in effect. List all xorriso commands in the order which applies if command \-x is in
effect.
.br .br
This list may also be helpful without \-x for a user who ponders over the This list may also be helpful without \-x for a user who ponders over the
sequence in which to put commands. Deviations from the listed sorting order may sequence in which to put commands. Deviations from the listed sorting order may
@ -604,7 +605,7 @@ well make sense, though.
.TP .TP
.B Acquiring source and target drive: .B Acquiring source and target drive:
.PP .PP
The effect of acquiring a drive may depend on several options in the The effect of acquiring a drive may depend on several commands in the
next paragraph "Influencing the behavior of image loading". next paragraph "Influencing the behavior of image loading".
If desired, their enabling commands have to be performed before the If desired, their enabling commands have to be performed before the
commands which acquire the drive. commands which acquire the drive.
@ -666,13 +667,13 @@ begins. The output drive is given up when writing is done.
.TP .TP
.B Influencing the behavior of image loading: .B Influencing the behavior of image loading:
.PP .PP
The following options should normally be performed before loading an image The following commands should normally be performed before loading an image
by acquiring an input drive. In rare cases it is desirable to activate by acquiring an input drive. In rare cases it is desirable to activate
them only after image loading. them only after image loading.
.TP .TP
\fB\-load\fR entity id \fB\-load\fR entity id
Load a particular (possibly outdated) ISO session from \-dev or \-indev. Load a particular (possibly outdated) ISO session from \-dev or \-indev.
Usually all available sessions are shown with option \-toc. Usually all available sessions are shown with command \-toc.
.br .br
entity depicts the kind of addressing. id depicts the particular entity depicts the kind of addressing. id depicts the particular
address. The following entities are defined: address. The following entities are defined:
@ -758,7 +759,7 @@ search pattern. When refusing an image, give up the input drive and issue
an event of the given severity (like FAILURE, see \-abort_on). An empty search an event of the given severity (like FAILURE, see \-abort_on). An empty search
pattern accepts any image. pattern accepts any image.
.br .br
This option does not hamper the creation of an empty image from blank This command does not hamper the creation of an empty image from blank
input media and does not discard an already loaded image. input media and does not discard an already loaded image.
.TP .TP
\fB\-in_charset\fR character_set_name \fB\-in_charset\fR character_set_name
@ -822,12 +823,12 @@ If enabled, then \fBxorriso\fR will obtain ACLs from disk file objects,
store ACLs in the ISO image using the libisofs specific AAIP format, store ACLs in the ISO image using the libisofs specific AAIP format,
load AAIP data from ISO images, test ACL during file comparison, load AAIP data from ISO images, test ACL during file comparison,
and restore ACLs to disk files when extracting them from ISO images. and restore ACLs to disk files when extracting them from ISO images.
See also options \-getfacl, \-setfacl. See also commands \-getfacl, \-setfacl.
.TP .TP
\fB\-xattr\fR "on"|"off" \fB\-xattr\fR "on"|"off"
Enable or disable processing of xattr attributes in user namespace. Enable or disable processing of xattr attributes in user namespace.
If enabled, then \fBxorriso\fR will handle xattr similar to ACL. If enabled, then \fBxorriso\fR will handle xattr similar to ACL.
See also options \-getfattr, \-setfattr and above paragraph about xattr. See also commands \-getfattr, \-setfattr and above paragraph about xattr.
.TP .TP
\fB\-md5\fR "on"|"all"|"off"|"load_check_off" \fB\-md5\fR "on"|"all"|"off"|"load_check_off"
Enable or disable processing of MD5 checksums for the overall session and for Enable or disable processing of MD5 checksums for the overall session and for
@ -836,7 +837,7 @@ only if the tags of superblock and directory tree match properly. The MD5
checksums of data files and whole session get loaded from the image if there checksums of data files and whole session get loaded from the image if there
are any. are any.
.br .br
With options \-compare and \-update the recorded MD5 of a file With commands \-compare and \-update the recorded MD5 of a file
will be used to avoid content reading from the image. Only the disk file will be used to avoid content reading from the image. Only the disk file
content will be read and compared with that MD5. This can save much time content will be read and compared with that MD5. This can save much time
if \-disk_dev_ino "on" is not suitable. if \-disk_dev_ino "on" is not suitable.
@ -859,7 +860,7 @@ option \-M is performed.
.br .br
The test can be re\-enabled by mode "load_check_on". The test can be re\-enabled by mode "load_check_on".
.br .br
Checksums can be exploited via options \-check_md5, \-check_md5_r, via find Checksums can be exploited via commands \-check_md5, \-check_md5_r, via find
actions get_md5, check_md5, and via \-check_media. actions get_md5, check_md5, and via \-check_media.
.TP .TP
\fB\-for_backup\fR \fB\-for_backup\fR
@ -1052,7 +1053,7 @@ composed from disk_path by replacing disk_prefix by iso_rr_prefix.
Compare file object disk_path with file object iso_rr_path. If they do not Compare file object disk_path with file object iso_rr_path. If they do not
match, then perform the necessary image manipulations to make iso_rr_path match, then perform the necessary image manipulations to make iso_rr_path
a matching copy of disk_path. By default this comparison will imply lengthy a matching copy of disk_path. By default this comparison will imply lengthy
content reading before a decision is made. Options \-disk_dev_ino or \-md5 may content reading before a decision is made. Commands \-disk_dev_ino or \-md5 may
accelerate comparison if they were already in effect when the loaded session accelerate comparison if they were already in effect when the loaded session
was recorded. was recorded.
.br .br
@ -1066,7 +1067,7 @@ addresses get compared whether they have counterparts below the other address
and whether both counterparts match. If there is a mismatch then the necessary and whether both counterparts match. If there is a mismatch then the necessary
update manipulation is done. update manipulation is done.
.br .br
Note that the comparison result may depend on option \-follow. Its setting Note that the comparison result may depend on command \-follow. Its setting
should always be the same as with the first adding of disk_path as iso_rr_path. should always be the same as with the first adding of disk_path as iso_rr_path.
.br .br
If iso_rr_path does not exist yet, then it gets added. If disk_path does not If iso_rr_path does not exist yet, then it gets added. If disk_path does not
@ -1104,12 +1105,12 @@ E.g:
.br .br
/file/part_3_of_3_at_4094m_with_2047m_of_5753194821 /file/part_3_of_3_at_4094m_with_2047m_of_5753194821
.br .br
While option \-split_size is set larger than 0, and if all pieces of a file While command \-split_size is set larger than 0, and if all pieces of a file
reside in the same ISO directory with no other files, and if the names look reside in the same ISO directory with no other files, and if the names look
like above, then their ISO directory will be recognized and handled like a like above, then their ISO directory will be recognized and handled like a
regular file. This affects options \-compare*, \-update*, and overwrite regular file. This affects commands \-compare*, \-update*, and overwrite
situations. situations.
See option \-split_size for details. See command \-split_size for details.
.TP .TP
\fB\-cpr\fR disk_path [***] iso_rr_path \fB\-cpr\fR disk_path [***] iso_rr_path
Insert the given files or directory trees from filesystem Insert the given files or directory trees from filesystem
@ -1331,10 +1332,10 @@ FAILURE event.
A well tested \-split_size is 2047m. Sizes above \-file_size_limit are not A well tested \-split_size is 2047m. Sizes above \-file_size_limit are not
permissible. permissible.
.br .br
While option \-split_size is set larger than 0 such a directory with split While command \-split_size is set larger than 0 such a directory with split
file pieces will be recognized and handled like a regular file by options file pieces will be recognized and handled like a regular file by commands
\-compare* , \-update*, and in overwrite situations. There are \-ossirox \-compare* , \-update*, and in overwrite situations. There are \-ossirox
options "concat_split_on" and "concat_split_off" which control the handling parameters "concat_split_on" and "concat_split_off" which control the handling
when files get restored to disk. when files get restored to disk.
.br .br
In order to be recognizable, the names of the part files have to In order to be recognizable, the names of the part files have to
@ -1386,7 +1387,7 @@ medium in modification mode.
.TP .TP
\fB\-rm_r\fR iso_rr_path [***] \fB\-rm_r\fR iso_rr_path [***]
Delete the given files or directory trees from the ISO image. Delete the given files or directory trees from the ISO image.
See also the note with option \-rm. See also the note with command \-rm.
.TP .TP
\fB\-rmdir\fR iso_rr_path [***] \fB\-rmdir\fR iso_rr_path [***]
Delete empty directories. Delete empty directories.
@ -1489,7 +1490,7 @@ Only names from the user namespace are allowed. I.e. a name has to begin with
"user.", like "user.x" or "user.whatever". "user.", like "user.x" or "user.whatever".
.br .br
Values and names undergo the normal input processing of \fBxorriso\fR. Values and names undergo the normal input processing of \fBxorriso\fR.
See also option \-backslash_codes. Other than with option \-setfattr_list, See also command \-backslash_codes. Other than with command \-setfattr_list,
the byte value 0 cannot be expressed via \-setfattr. the byte value 0 cannot be expressed via \-setfattr.
.TP .TP
\fB\-setfattr_r\fR [-]name value iso_rr_path [***] \fB\-setfattr_r\fR [-]name value iso_rr_path [***]
@ -1514,7 +1515,7 @@ Name must be from user namespace. I.e. user.xyz where xyz should consist of
printable characters only. The separator "=" is not allowed in names. printable characters only. The separator "=" is not allowed in names.
Value may contain any kind of bytes. It must be in quotes. Trailing Value may contain any kind of bytes. It must be in quotes. Trailing
whitespace after the end quote will be ignored. Non\-printables bytes and quotes whitespace after the end quote will be ignored. Non\-printables bytes and quotes
must be represented as \\XYZ by their octal ASCII code XYZ. must be represented as \\XYZ by their octal 8\-bit code XYZ.
Use code \\000 for 0\-bytes. Use code \\000 for 0\-bytes.
.TP .TP
\fB\-alter_date\fR type timestring iso_rr_path [***] \fB\-alter_date\fR type timestring iso_rr_path [***]
@ -1780,7 +1781,7 @@ prints access permissions in ACL text form to the result channel.
.br .br
\fBsetfacl\fR \fBsetfacl\fR
attaches ACLs after removing existing ones. The new attaches ACLs after removing existing ones. The new
ACL is given in text form as defined with option \-setfacl. ACL is given in text form as defined with command \-setfacl.
.br .br
E.g.: \-exec setfacl u:lisa:rw,u::rw,g::r,o::\-,m::rw \-\- E.g.: \-exec setfacl u:lisa:rw,u::rw,g::r,o::\-,m::rw \-\-
.br .br
@ -1807,7 +1808,7 @@ Mode "b" prints backslash encoding. Not suitable for shell parsing.
.br .br
E.g. \-exec list_extattr e \-\- E.g. \-exec list_extattr e \-\-
.br .br
Option \-backslash_codes does not affect the output. Command \-backslash_codes does not affect the output.
.br .br
\fBget_md5\fR \fBget_md5\fR
prints the MD5 sum, if recorded, together with file path. prints the MD5 sum, if recorded, together with file path.
@ -2014,7 +2015,7 @@ Switch to growing mode.
are uncommitted manipulations pending. are uncommitted manipulations pending.
.br .br
So, to perform a final write operation with no new \-dev So, to perform a final write operation with no new \-dev
and no new loading of image, rather execute option \-end. and no new loading of image, rather execute command \-end.
If you want to go on without image loading, execute \-commit_eject "none". If you want to go on without image loading, execute \-commit_eject "none".
To eject after write without image loading, use \-commit_eject "all". To eject after write without image loading, use \-commit_eject "all".
.br .br
@ -2068,7 +2069,7 @@ but produces media which are only suitable for a single session.
Some drives announce this state by not offering feature 21h, Some drives announce this state by not offering feature 21h,
but some drives offer it anyway. but some drives offer it anyway.
If feature 21h is missing, then \fBxorriso\fR If feature 21h is missing, then \fBxorriso\fR
will refuse to write on DVD\-RW if not option \-close is set to "on". will refuse to write on DVD\-RW if not command \-close is set to "on".
.br .br
The progress reports issued by some drives while blanking are The progress reports issued by some drives while blanking are
quite unrealistic. Do not conclude success or failure from the quite unrealistic. Do not conclude success or failure from the
@ -2090,7 +2091,7 @@ unformatted BD\-R. Other media are left untouched.
.br .br
"fast" does the same as "full" but tries to be quicker. "fast" does the same as "full" but tries to be quicker.
.br .br
"by_index_" selects a format out of the descriptor list issued by option "by_index_" selects a format out of the descriptor list issued by command
\-list_formats. The index number from that list is to be appended to the \-list_formats. The index number from that list is to be appended to the
mode word. E.g: "by_index_3". mode word. E.g: "by_index_3".
.br .br
@ -2159,7 +2160,7 @@ or BD\-R media. It is indicated by warning messages when the drive gets
acquired, and by a remark "but next track is damaged" with the line acquired, and by a remark "but next track is damaged" with the line
"Media status :" of command \-toc. "Media status :" of command \-toc.
.br .br
The setting of option \-close determines whether the medium stays appendable. The setting of command \-close determines whether the medium stays appendable.
.br .br
Mode "as_needed" gracefully refuses on media which are not reported as Mode "as_needed" gracefully refuses on media which are not reported as
damaged. Mode "force" attempts the close operation even with media which damaged. Mode "force" attempts the close operation even with media which
@ -2175,7 +2176,7 @@ The currently recognized type is marked by text "(current)".
.B Settings for result writing: .B Settings for result writing:
.PP .PP
Rock Ridge info will be generated by the program unconditionally. Rock Ridge info will be generated by the program unconditionally.
ACLs will be written according to the setting of option \-acl. ACLs will be written according to the setting of command \-acl.
.TP .TP
\fB\-joliet\fR "on"|"off" \fB\-joliet\fR "on"|"off"
If enabled by "on", generate Joliet tree additional to ISO 9660 + Rock Ridge If enabled by "on", generate Joliet tree additional to ISO 9660 + Rock Ridge
@ -2188,7 +2189,7 @@ cases it is worth to deviate a bit in order to circumvent bugs of the intended
reader system or to get unofficial extra features. reader system or to get unofficial extra features.
.br .br
There are several adjustable rules which have a keyword each. If they There are several adjustable rules which have a keyword each. If they
are mentioned with this option then their rule gets added to the relaxation are mentioned with this command then their rule gets added to the relaxation
list. This list can be erased by rules "strict" or "clear". It can be reset list. This list can be erased by rules "strict" or "clear". It can be reset
to its start setting by "default". All of the following relaxation rules to its start setting by "default". All of the following relaxation rules
can be revoked individually by appending "_off". Like "deep_paths_off". can be revoked individually by appending "_off". Like "deep_paths_off".
@ -2223,11 +2224,12 @@ not 8.3.
.br .br
"lowercase" allows lowercase characters in ISO file names. "lowercase" allows lowercase characters in ISO file names.
.br .br
"full_ascii" allows all ASCII characters in ISO file names. "full_ascii" allows all 8\-bit characters except 0x0 and '/'
in ISO file names.
.br .br
"untranslated_names" might be dangerous for inadverted reader programs "untranslated_names" might be dangerous for inadverted reader programs
which rely on the restriction to at most 37 characters in ISO file names. which rely on the restriction to at most 37 characters in ISO file names.
This option allows ISO file names up to 96 characters with no character This rule allows ISO file names up to 96 characters with no character
conversion. If a file name has more characters, then image production will conversion. If a file name has more characters, then image production will
fail deliberately. fail deliberately.
.br .br
@ -2348,7 +2350,7 @@ It is supposed to match this GRUB line:
.br .br
E.g. 2010040711405800 is 7 Apr 2010 11:40:58 (+0 centiseconds). E.g. 2010040711405800 is 7 Apr 2010 11:40:58 (+0 centiseconds).
.br .br
Timestrings for the other types may be given as with option \-alter_date. Timestrings for the other types may be given as with command \-alter_date.
They are prone to timezone computations. The timestrings "default" or They are prone to timezone computations. The timestrings "default" or
"overridden" cause default settings: "c" and "m" will show the current time "overridden" cause default settings: "c" and "m" will show the current time
of image creation. "x" and "f" will be marked as insignificant. of image creation. "x" and "f" will be marked as insignificant.
@ -2402,7 +2404,7 @@ Group id to be used for all files when the new ISO tree gets written to media.
\fB\-zisofs\fR option[:options] \fB\-zisofs\fR option[:options]
Set global parameters for zisofs compression. This data format is recognized Set global parameters for zisofs compression. This data format is recognized
and transparently uncompressed by some Linux kernels. It is to be applied and transparently uncompressed by some Linux kernels. It is to be applied
via option \-set_filter with built\-in filter "\-\-zisofs". via command \-set_filter with built\-in filter "\-\-zisofs".
Parameters are: Parameters are:
.br .br
"level="[0\-9] zlib compression: 0=none, 1=fast,..., 9=slow "level="[0\-9] zlib compression: 0=none, 1=fast,..., 9=slow
@ -2453,7 +2455,7 @@ written and writing of file content blocks begins.
GNU/Linux specific: GNU/Linux specific:
Set the number of bytes to be transmitted with each write operation to DVD Set the number of bytes to be transmitted with each write operation to DVD
or BD media. A number of 64 KB may improve throughput with bus systems which or BD media. A number of 64 KB may improve throughput with bus systems which
show latency problems. The default depends on media type, on option show latency problems. The default depends on media type, on command
\-stream_recording , and on compile time options. \-stream_recording , and on compile time options.
.TP .TP
\fB\-stdio_sync\fR "on"|"off"|number \fB\-stdio_sync\fR "on"|"off"|number
@ -2477,7 +2479,7 @@ which means unit is kiB (= 1024) or MiB (= 1024 kiB).
If "on" then mark the written medium as not appendable If "on" then mark the written medium as not appendable
any more (if possible at all with the given type of target media). any more (if possible at all with the given type of target media).
.br .br
This is the contrary of cdrecord, wodim, cdrskin option \-multi, This is the contrary of cdrecord, wodim, cdrskin command \-multi,
and is one aspect of growisofs option \-dvd\-compat. and is one aspect of growisofs option \-dvd\-compat.
.TP .TP
\fB\-padding\fR number["k"|"m"]|"included"|"appended" \fB\-padding\fR number["k"|"m"]|"included"|"appended"
@ -2727,7 +2729,7 @@ Only a single boot file can be declared by mipsel_path=.
\fBsparc_label=\fRtext causes the production of a SUN Disk Label with the \fBsparc_label=\fRtext causes the production of a SUN Disk Label with the
given text as ASCII label. This boot block format allows to append images 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. for partitions 2 to 8. Partition 1 will always be the ISO image.
See option \-append_partition. See command \-append_partition.
The first 512 bytes of any data provided by system_area= will be overwritten. The first 512 bytes of any data provided by system_area= will be overwritten.
.br .br
\fBmips_discard\fR and \fBsparc_discard\fR revoke any boot file \fBmips_discard\fR and \fBsparc_discard\fR revoke any boot file
@ -2888,7 +2890,7 @@ convert byte codes.
There is an input conversion from input character set to the local character There is an input conversion from input character set to the local character
set which applies when an ISO image gets loaded. A conversion from local set which applies when an ISO image gets loaded. A conversion from local
character set to the output character set is performed when an character set to the output character set is performed when an
image tree gets written. The sets can be defined independently by options image tree gets written. The sets can be defined independently by commands
\-in_charset and \-out_charset. Normally one will have both identical, if ever. \-in_charset and \-out_charset. Normally one will have both identical, if ever.
.br .br
If conversions are desired then \fBxorriso\fR needs to know the name of the If conversions are desired then \fBxorriso\fR needs to know the name of the
@ -2904,7 +2906,7 @@ filesystem
names and emerging names in the image. The situation stays ambigous and the names and emerging names in the image. The situation stays ambigous and the
reader has to riddle what character set was used. reader has to riddle what character set was used.
.br .br
By option \-auto_charset it is possible to attribute the output charset name By command \-auto_charset it is possible to attribute the output charset name
to the image. This makes the situation unambigous. But if your terminal to the image. This makes the situation unambigous. But if your terminal
character set does not match the character set of the local file names, character set does not match the character set of the local file names,
then this attribute can become plainly wrong and cause problems at read time. then this attribute can become plainly wrong and cause problems at read time.
@ -2966,10 +2968,10 @@ Set the severity threshold for events to abort the program.
Useful: "NEVER", "ABORT", "FATAL", "FAILURE" , "MISHAP", "SORRY" Useful: "NEVER", "ABORT", "FATAL", "FAILURE" , "MISHAP", "SORRY"
.br .br
It may become necessary to abort the program anyway, despite It may become necessary to abort the program anyway, despite
the setting by this option. Expect not many "ABORT" events to the setting by this command. Expect not many "ABORT" events to
be ignorable. be ignorable.
.br .br
A special property of this option is that it works preemptive if given as A special property of this command is that it works preemptive if given as
program start argument. I.e. the first \-abort_on setting among the program start argument. I.e. the first \-abort_on setting among the
start arguments is in effect already when the first operations of start arguments is in effect already when the first operations of
\fBxorriso\fR begin. Only "\-abort_on" with dash "\-" is recognized that way. \fBxorriso\fR begin. Only "\-abort_on" with dash "\-" is recognized that way.
@ -3008,7 +3010,7 @@ Event messages are sent to the info channel "I" which is usually stderr
but may be influenced by command \-pkt_output. but may be influenced by command \-pkt_output.
Info messages which belong to no event get attributed severity "NOTE". Info messages which belong to no event get attributed severity "NOTE".
.br .br
A special property of this option is that the first \-report_about setting A special property of this command is that the first \-report_about setting
among the start arguments is in effect already when the first operations among the start arguments is in effect already when the first operations
of \fBxorriso\fR begin. Only "\-report_about" with dash "\-" is of \fBxorriso\fR begin. Only "\-report_about" with dash "\-" is
recognized that way. recognized that way.
@ -3040,7 +3042,7 @@ kill \-9 then imposes the risk that the drive is left in unusable state and
needs poweroff to be reset. So during burning, blanking, and formatting needs poweroff to be reset. So during burning, blanking, and formatting
wait for at least their normal run time before killing externally. wait for at least their normal run time before killing externally.
.br .br
A special property of this option is that the first \-signal_handling setting A special property of this command is that the first \-signal_handling setting
among the start arguments is in effect already when the first operations among the start arguments is in effect already when the first operations
of \fBxorriso\fR begin. Only "\-signal_handling" with dash "\-" is of \fBxorriso\fR begin. Only "\-signal_handling" with dash "\-" is
recognized that way. recognized that way.
@ -3049,12 +3051,12 @@ recognized that way.
Control the program behavior at problem event occasions. Control the program behavior at problem event occasions.
For now this applies to occasions "image_loading" which is given while For now this applies to occasions "image_loading" which is given while
an image tree is read from the input device, and to "file_extraction" which an image tree is read from the input device, and to "file_extraction" which
is given with osirrox options like \-extract. is given with osirrox commands like \-extract.
.br .br
With "image_loading" there are three behaviors available: With "image_loading" there are three behaviors available:
.br .br
"best_effort" goes on with reading after events with severity below FAILURE "best_effort" goes on with reading after events with severity below FAILURE
if the threshold of option \-abort_on allows this. if the threshold of command \-abort_on allows this.
.br .br
"failure" aborts image tree reading on first event of at least SORRY. "failure" aborts image tree reading on first event of at least SORRY.
It issues an own FAILURE event. It issues an own FAILURE event.
@ -3124,9 +3126,9 @@ directory only once and not for each file in its whole subtree.
Setting "off" silently kills any kind of image file object resp. performs Setting "off" silently kills any kind of image file object resp. performs
above irrevocable actions. above irrevocable actions.
.br .br
To really produce user prompts, option \-dialog needs to be set to "on". To really produce user prompts, command \-dialog needs to be set to "on".
Note that the prompt does not appear in situations where file removal Note that the prompt does not appear in situations where file removal
is forbidden by option \-overwrite. \-reassure only imposes an additional is forbidden by command \-overwrite. \-reassure only imposes an additional
curb for removing existing file objects. curb for removing existing file objects.
.br .br
Be aware that file objects get deleted from the ISO image immediately Be aware that file objects get deleted from the ISO image immediately
@ -3141,7 +3143,7 @@ Show list of available MMC drives with the addresses of
their libburn standard device files. their libburn standard device files.
.br .br
This is only possible when no ISO image changes are pending. This is only possible when no ISO image changes are pending.
After this option was executed, there is no drive current After this command was executed, there is no drive current
and no image loaded. and no image loaded.
.br .br
In order to be visible, a device has to offer rw\-permissions In order to be visible, a device has to offer rw\-permissions
@ -3177,7 +3179,7 @@ with only one or two sessions on it. The last of these sessions is supposed
to be the most recent real session then. to be the most recent real session then.
.br .br
Some read\-only drives and media show no usable session history at all. Some read\-only drives and media show no usable session history at all.
Option \-rom_toc_scan might help. Command \-rom_toc_scan might help.
.TP .TP
\fB\-mount_cmd\fR drive entity id path \fB\-mount_cmd\fR drive entity id path
Emit an appropriate command line for mounting the ISO session Emit an appropriate command line for mounting the ISO session
@ -3195,7 +3197,7 @@ as id.
.br .br
path will be used as mount point and must already exist as a directory on disk. path will be used as mount point and must already exist as a directory on disk.
.br .br
The command gets printed to the result channel. See option \-mount The command gets printed to the result channel. See command \-mount
for direct execution of this command. for direct execution of this command.
.TP .TP
\fB\-mount_opts\fR option[:option...] \fB\-mount_opts\fR option[:option...]
@ -3228,9 +3230,9 @@ session number, resp. volume id of the depicted session.
\fB\-print_size\fR \fB\-print_size\fR
Print the foreseeable consumption of 2048 byte blocks Print the foreseeable consumption of 2048 byte blocks
by next \-commit. This can last a while as a \-commit gets by next \-commit. This can last a while as a \-commit gets
prepared and only in last moment is revoked by this option. prepared and only in last moment is revoked by this command.
The result depends on several settings and also on the kind of output device. The result depends on several settings and also on the kind of output device.
If no \-jidgo options are given and not command \-as "mkisofs" was used, If no \-jidgo options are set and not command \-as "mkisofs" was used,
then \-padding (300 kB by default) is not counted as part of the image size. then \-padding (300 kB by default) is not counted as part of the image size.
.TP .TP
\fB\-tell_media_space\fR \fB\-tell_media_space\fR
@ -3239,7 +3241,7 @@ subtracting already foreseeable consumption by next \-commit.
.TP .TP
\fB\-pvd_info\fR \fB\-pvd_info\fR
Print various id strings which can be found in loaded ISO images. Some of Print various id strings which can be found in loaded ISO images. Some of
them may be changed by options like \-volid or \-publisher. For these them may be changed by commands like \-volid or \-publisher. For these
ids \-pvd_info reports what would be written with the next \-commit. ids \-pvd_info reports what would be written with the next \-commit.
.TP .TP
.B Navigation in ISO image and disk filesystem: .B Navigation in ISO image and disk filesystem:
@ -3318,7 +3320,7 @@ Output format resembles shell command ls \-dln.
Print the access permissions of the given files in the ISO image using the Print the access permissions of the given files in the ISO image using the
format of shell command getfacl. If a file has no ACL then it gets fabricated format of shell command getfacl. If a file has no ACL then it gets fabricated
from the \-chmod settings. A file may have a real ACL if it was introduced into from the \-chmod settings. A file may have a real ACL if it was introduced into
the ISO image while option \-acl was set to "on". the ISO image while command \-acl was set to "on".
.TP .TP
\fB\-getfacl_r\fR iso_rr_pattern [***] \fB\-getfacl_r\fR iso_rr_pattern [***]
Like \-gefacl but listing recursively the whole file trees underneath eventual Like \-gefacl but listing recursively the whole file trees underneath eventual
@ -3461,7 +3463,7 @@ according
to their read speed, save them to a file, and keep track of successfuly saved to their read speed, save them to a file, and keep track of successfuly saved
blocks for further tries on the same medium. blocks for further tries on the same medium.
.br .br
By option \-md5 checksums may get recorded with data files and whole By command \-md5 checksums may get recorded with data files and whole
sessions. These checksums are reachable only via indev and a loaded image. sessions. These checksums are reachable only via indev and a loaded image.
They work independently of the media type and can detect transmission errors. They work independently of the media type and can detect transmission errors.
.TP .TP
@ -3470,9 +3472,9 @@ Try to read data blocks from the indev drive, optionally copy them to a
disk file, and finally report about the encountered quality. Several options disk file, and finally report about the encountered quality. Several options
may be used to modify the default behavior. may be used to modify the default behavior.
.br .br
The options given with this command override the default settings which The parameters given with this command override the default settings which
may have been changed by option \-check_media_defaults. See there for a may have been changed by command \-check_media_defaults. See there for a
description of options. description of available options.
.br .br
The result list tells intervals of 2 KiB blocks with start address, number The result list tells intervals of 2 KiB blocks with start address, number
of blocks and quality. Qualities which begin with "+" are of blocks and quality. Qualities which begin with "+" are
@ -3618,10 +3620,10 @@ This gets rounded down to full blocks of 2048 bytes. 0 means automatic size.
Compare the data content of the given files in the loaded image with their Compare the data content of the given files in the loaded image with their
recorded MD5 checksums, if there are any. In case of any mismatch an event of recorded MD5 checksums, if there are any. In case of any mismatch an event of
the given severity is issued. It may then be handled by appropriate settings of the given severity is issued. It may then be handled by appropriate settings of
options \-abort_on or \-return_with which both can cause non\-zero exit values commands \-abort_on or \-return_with which both can cause non\-zero exit values
of the program run. Severity ALL suppresses that event. of the program run. Severity ALL suppresses that event.
.br .br
This option reports match and mismatch of data files to the result channel. This command reports match and mismatch of data files to the result channel.
Non\-data files cause NOTE events. There will also be UPDATE events from Non\-data files cause NOTE events. There will also be UPDATE events from
data reading. data reading.
.br .br
@ -3633,7 +3635,7 @@ if there are older sessions.
Like \-check_md5 but checking all data files underneath the given paths. Like \-check_md5 but checking all data files underneath the given paths.
Only mismatching data files will be reported. Only mismatching data files will be reported.
.TP .TP
.B osirrox ISO-to-disk restore options: .B osirrox ISO-to-disk restore commands:
.PP .PP
Normally \fBxorriso\fR only writes to disk files which were given as stdio: Normally \fBxorriso\fR only writes to disk files which were given as stdio:
pseudo\-drives or as log files. pseudo\-drives or as log files.
@ -3759,7 +3761,7 @@ ownership and group as in ISO image.
\fB\-paste_in\fR iso_rr_path disk_path byte_offset byte_count \fB\-paste_in\fR iso_rr_path disk_path byte_offset byte_count
Read the content of a ISO data file and write it into a data file on disk Read the content of a ISO data file and write it into a data file on disk
beginning at the byte_offset. Write at most byte_count bytes. beginning at the byte_offset. Write at most byte_count bytes.
This is the inverse of option \-cut_out. This is the inverse of command \-cut_out.
.TP .TP
\fB\-mount\fR drive entity id path \fB\-mount\fR drive entity id path
Produce the same line as \-mount_cmd and then execute it as external program run Produce the same line as \-mount_cmd and then execute it as external program run
@ -3807,7 +3809,7 @@ persists until things happen like \-commit, \-rollback, \-dev, or end of
\-pacifier gets set to "mkisofs" if files are added to the image. \-pacifier gets set to "mkisofs" if files are added to the image.
.br .br
\-graft\-points is equivalent to \-pathspecs on. Note that pathspecs without "=" \-graft\-points is equivalent to \-pathspecs on. Note that pathspecs without "="
are interpreted differently than with \fBxorriso\fR option \-add. are interpreted differently than with \fBxorriso\fR command \-add.
Directories get Directories get
merged with the root directory of the ISO image, other filetypes get mapped merged with the root directory of the ISO image, other filetypes get mapped
into that root directory. into that root directory.
@ -3816,7 +3818,7 @@ If pathspecs are given and if no output file was chosen before or during the
"mkisofs" option list, then standard output (\-outdev "\-") will get into effect. "mkisofs" option list, then standard output (\-outdev "\-") will get into effect.
If \-o points to a regular file, then it will be truncated to 0 bytes If \-o points to a regular file, then it will be truncated to 0 bytes
when finally writing begins. This truncation does not happen if the drive when finally writing begins. This truncation does not happen if the drive
is chosen by \fBxorriso\fR options before \-as mkisofs or after its is chosen by \fBxorriso\fR commands before \-as mkisofs or after its
list delimiter. Directories and symbolic links are no valid \-o targets. list delimiter. Directories and symbolic links are no valid \-o targets.
.br .br
Writing to stdout is possible only if \-as "mkisofs" was among the start Writing to stdout is possible only if \-as "mkisofs" was among the start
@ -3845,7 +3847,7 @@ resp. to "on" by \-\-old\-root\-devno .
Not original mkisofs options are \-\-quoted_path_list , Not original mkisofs options are \-\-quoted_path_list ,
\-\-hardlinks , \-\-acl , \-\-hardlinks , \-\-acl ,
\-\-xattr , \-\-md5 , \-\-stdio_sync . \-\-xattr , \-\-md5 , \-\-stdio_sync .
They work like the \fBxorriso\fR options with the They work like the \fBxorriso\fR commands with the
same name and hardcoded parameter "on", e.g. \-acl "on". same name and hardcoded parameter "on", e.g. \-acl "on".
Explicit parameters are expected by \-\-stdio_sync Explicit parameters are expected by \-\-stdio_sync
and \-\-scdbackup_tag. and \-\-scdbackup_tag.
@ -3882,7 +3884,7 @@ instead of \-G to apply the effect of \-boot_image isolinux partition_table=on.
\-partition_offset number is \-partition_offset number is
\-boot_image any partition_offset=number. \-boot_image any partition_offset=number.
.br .br
Option \-append_partition is supported. Command \-append_partition is supported.
.br .br
\-untranslated_name_len number is \-untranslated_name_len number is
\-compliance untranslated_name_len=number. \-compliance untranslated_name_len=number.
@ -3890,7 +3892,7 @@ Option \-append_partition is supported.
\-\-old\-empty is \-compliance old_empty. \-\-old\-empty is \-compliance old_empty.
.br .br
The options of genisoimage Jigdo Template Extraction are recognized and The options of genisoimage Jigdo Template Extraction are recognized and
performed via \fBxorriso\fR option \-jigdo. See the "Alias:" names there performed via \fBxorriso\fR command \-jigdo. See the "Alias:" names there
for the meaning of the genisoimage options. for the meaning of the genisoimage options.
.br .br
@ -3903,7 +3905,7 @@ If \fBxorriso\fR is started with one of the leafnames "xorrisofs",
\-as "genisofs" to the program arguments. \-as "genisofs" to the program arguments.
I.e. all arguments will be interpreted mkisofs style until "\-\-" I.e. all arguments will be interpreted mkisofs style until "\-\-"
is encountered. is encountered.
From then on, options are interpreted as \fBxorriso\fR options. From then on, arguments are interpreted as \fBxorriso\fR commands.
.br .br
\-\-no_rc as first argument of such a program start \-\-no_rc as first argument of such a program start
prevents interpretation of startup files. See section FILES below. prevents interpretation of startup files. See section FILES below.
@ -3949,7 +3951,7 @@ If \fBxorriso\fR is started with one of the leafnames "xorrecord",
"cdrskin", "cdrecord", or "wodim", then it automatically prepends \-as "cdrskin" "cdrskin", "cdrecord", or "wodim", then it automatically prepends \-as "cdrskin"
to the program arguments. I.e. all arguments will be interpreted cdrecord to the program arguments. I.e. all arguments will be interpreted cdrecord
style until "\-\-" is encountered. style until "\-\-" is encountered.
From then on, options are interpreted as \fBxorriso\fR options. From then on, arguments are interpreted as \fBxorriso\fR commands.
.br .br
\-\-no_rc as first argument of such a program start \-\-no_rc as first argument of such a program start
prevents interpretation of \fBxorriso\fR startup files. prevents interpretation of \fBxorriso\fR startup files.
@ -4001,7 +4003,7 @@ Program scdbackup_verify will recognize and verify tag resp. record.
.TP .TP
\fB\-no_rc\fR \fB\-no_rc\fR
.br .br
Only if used as first program argument this option Only if used as first program argument this command
prevents reading and interpretation of startup files. See section FILES below. prevents reading and interpretation of startup files. See section FILES below.
.TP .TP
\fB\-options_from_file\fR fileaddress \fB\-options_from_file\fR fileaddress
@ -4099,8 +4101,8 @@ With the start program arguments there is mode:
.br .br
Mode "encode_output" encodes output characters. It combines "encode_results" Mode "encode_output" encodes output characters. It combines "encode_results"
with "encode_infos". Inside single or double quotation marks encoding applies with "encode_infos". Inside single or double quotation marks encoding applies
to ASCII characters octal 001 to 037 , 177 to 377 and to backslash(134). to 8\-bit characters octal 001 to 037 , 177 to 377 and to backslash(134).
Outside quotation marks some harmless control characters stay unencoded: Outside quotation marks some harmless ASCII control characters stay unencoded:
bell(007), backspace(010), tab(011), linefeed(012), formfeed(014), bell(007), backspace(010), tab(011), linefeed(012), formfeed(014),
carriage_return(015). carriage_return(015).
.br .br
@ -4169,7 +4171,7 @@ Mode "on" enables very verbous logging of SCSI commands and drive replies.
Logging messages get printed to stderr, not to any of the \fBxorriso\fR Logging messages get printed to stderr, not to any of the \fBxorriso\fR
output channels. output channels.
.br .br
A special property of this option is that the first \-scsi_log setting A special property of this command is that the first \-scsi_log setting
among the start arguments is in effect already when the first operations among the start arguments is in effect already when the first operations
of \fBxorriso\fR begin. of \fBxorriso\fR begin.
Only "\-scsi_log" with dash "\-" is recognized that way. Only "\-scsi_log" with dash "\-" is recognized that way.
@ -4319,7 +4321,7 @@ $ xorriso \-outdev /dev/sr2 \\
.br .br
Note that '/pictures/*private*' is a pattern for iso_rr_paths Note that '/pictures/*private*' is a pattern for iso_rr_paths
while pictures/confidential/work* gets expanded by the shell while pictures/confidential/work* gets expanded by the shell
with addresses from the hard disk. Options \-add and \-map have different with addresses from the hard disk. Commands \-add and \-map have different
parameter rules but finally the same effect: they put files into the image. parameter rules but finally the same effect: they put files into the image.
.SS .SS
.B A dialog session doing about the same .B A dialog session doing about the same
@ -4327,8 +4329,8 @@ parameter rules but finally the same effect: they put files into the image.
Some settings are already given as start argument. The other activities Some settings are already given as start argument. The other activities
are done as dialog input. The pager gets set to 20 lines of 80 characters. are done as dialog input. The pager gets set to 20 lines of 80 characters.
.br .br
The drive is acquired by option \-dev rather than \-outdev in order to see The drive is acquired by command \-dev rather than \-outdev in order to see
the message about its current content. By option \-blank this content is the message about its current content. By command \-blank this content is
made ready for being overwritten and the loaded ISO image is made empty. made ready for being overwritten and the loaded ISO image is made empty.
.br .br
In order to be able to eject the medium, the session needs to be committed In order to be able to eject the medium, the session needs to be committed
@ -4438,7 +4440,7 @@ the same files gets added with converted file names.
In order to avoid any weaknesses of the local character set, this command In order to avoid any weaknesses of the local character set, this command
pretends that it uses already the final target set UTF\-8. pretends that it uses already the final target set UTF\-8.
Therefore strange file names may appear in messages, which Therefore strange file names may appear in messages, which
will be made terminal\-safe by option \-backslash_codes. will be made terminal\-safe by command \-backslash_codes.
.br .br
$ xorriso \-in_charset ISO\-8859\-1 \-local_charset UTF\-8 \\ $ xorriso \-in_charset ISO\-8859\-1 \-local_charset UTF\-8 \\
.br .br
@ -4631,13 +4633,13 @@ the old one.
This makes sense if the full backup leaves substantial remaining capacity This makes sense if the full backup leaves substantial remaining capacity
on media and if the expected changes are much smaller than the full backup. on media and if the expected changes are much smaller than the full backup.
To apply zisofs compression to those data files which get newly copied from To apply zisofs compression to those data files which get newly copied from
the local filesystem, insert these options immediately before \-commit : the local filesystem, insert these commands immediately before \-commit :
.br .br
\-hardlinks perform_update \\ \-hardlinks perform_update \\
.br .br
\-find / \-type f \-pending_data \-exec set_filter \-\-zisofs \-\- \\ \-find / \-type f \-pending_data \-exec set_filter \-\-zisofs \-\- \\
.br .br
Options \-disk_dev_ino and \-for_backup depend on stable device and inode numbers Commands \-disk_dev_ino and \-for_backup depend on stable device and inode numbers
on disk. Without them, an update run may use \-md5 "on" to match recorded MD5 on disk. Without them, an update run may use \-md5 "on" to match recorded MD5
sums against the current file content on hard disk. This is usually much faster sums against the current file content on hard disk. This is usually much faster
than the default which compares both contents directly. than the default which compares both contents directly.
@ -4649,13 +4651,13 @@ versions. With CD media, GNU/Linux mount accepts session numbers directly by
its option "session=". its option "session=".
.br .br
Multi\-session media and most overwriteable media written by \fBxorriso\fR Multi\-session media and most overwriteable media written by \fBxorriso\fR
can tell the sbsectors of their sessions by \fBxorriso\fR option \-toc. can tell the sbsectors of their sessions by \fBxorriso\fR command \-toc.
Used after \-commit the following option prints the matching mount command for Used after \-commit the following command prints the matching mount command for
the newly written session (here for mount point /mnt): the newly written session (here for mount point /mnt):
.br .br
\-mount_cmd "indev" "auto" "auto" /mnt \-mount_cmd "indev" "auto" "auto" /mnt
.br .br
Options \-mount_cmd and \-mount are also able to produce the mount commands for Commands \-mount_cmd and \-mount are also able to produce the mount commands for
older sessions in the table\-of\-content. E.g. as superuser: older sessions in the table\-of\-content. E.g. as superuser:
.br .br
# osirrox \-mount /dev/sr0 "volid" '*2008_12_05*' /mnt # osirrox \-mount /dev/sr0 "volid" '*2008_12_05*' /mnt
@ -4746,7 +4748,7 @@ program name pre\-select certain settings:
\fBxorrecord\fR starts \fBxorriso\fR with \-as cdrecord emulation. \fBxorrecord\fR starts \fBxorriso\fR with \-as cdrecord emulation.
.br .br
\fBosirrox\fR starts with \-osirrox "on:o_excl_off" which allows \fBosirrox\fR starts with \-osirrox "on:o_excl_off" which allows
to copy files from ISO image to disk and to apply option \-mount to to copy files from ISO image to disk and to apply command \-mount to
one or more of the existing ISO sessions. one or more of the existing ISO sessions.
.SS .SS
.B Startup files: .B Startup files:

515
libisoburn/trunk/xorriso/xorriso.info
View File

File diff suppressed because it is too large Load Diff

220
libisoburn/trunk/xorriso/xorriso.texi
View File

@ -272,11 +272,11 @@ There are two families of media in the MMC standard:
@cindex Multi-session media, _definition @cindex Multi-session media, _definition
@strong{Multi-session media} are CD-R, CD-RW, DVD-R, DVD+R, DVD+R/DL, BD-R, and @strong{Multi-session media} are CD-R, CD-RW, DVD-R, DVD+R, DVD+R/DL, BD-R, and
unformatted DVD-RW. These media provide a table of content which unformatted DVD-RW. These media provide a table of content which
describes their existing sessions. See option @strong{-toc}. describes their existing sessions. See command @strong{-toc}.
@* @*
Similar to multi-session media are DVD-R DL and minimally blanked DVD-RW. Similar to multi-session media are DVD-R DL and minimally blanked DVD-RW.
They allow only a single session of which the size must be known in advance. They allow only a single session of which the size must be known in advance.
@command{xorriso} will write onto them only if option -close is set to "on". @command{xorriso} will write onto them only if command -close is set to "on".
@* @*
@cindex Overwriteable media, _definition @cindex Overwriteable media, _definition
@strong{Overwriteable media} are DVD-RAM, DVD+RW, BD-RE, and formatted DVD-RW. @strong{Overwriteable media} are DVD-RAM, DVD+RW, BD-RE, and formatted DVD-RW.
@ -313,7 +313,7 @@ media, or to apply mandatory formatting to new media if necessary.
multi-session media in appendable state, or they are overwriteable media multi-session media in appendable state, or they are overwriteable media
which contain an ISO image suitable for @command{xorriso}. which contain an ISO image suitable for @command{xorriso}.
@* @*
Appendable is the state after writing a session with option -close off. Appendable is the state after writing a session with command -close off.
@* @*
@sp 1 @sp 1
@cindex Closed media, _definition @cindex Closed media, _definition
@ -321,7 +321,7 @@ Appendable is the state after writing a session with option -close off.
for @command{xorriso}. for @command{xorriso}.
@* @*
Closed is the state of DVD-ROM media and of multi-session media which were Closed is the state of DVD-ROM media and of multi-session media which were
written with option -close on. If the drive is read-only hardware then it will written with command -close on. If the drive is read-only hardware then it will
probably show any media as closed CD-ROM resp. DVD-ROM. probably show any media as closed CD-ROM resp. DVD-ROM.
@* @*
Overwriteable media assume this state in such read-only drives or if they Overwriteable media assume this state in such read-only drives or if they
@ -329,7 +329,7 @@ contain unrecognizable data in the first 32 data blocks.
@* @*
Read-only drives may or may not show session histories of multi-session Read-only drives may or may not show session histories of multi-session
media. Often only the first and the last session are visible. Sometimes media. Often only the first and the last session are visible. Sometimes
not even that. Option -rom_toc_scan might or might not help in such cases. not even that. Command -rom_toc_scan might or might not help in such cases.
@c man .SS @c man .SS
@node Methods, Drives, Media, top @node Methods, Drives, Media, top
@chapter Creating, Growing, Modifying, Blind Growing: @chapter Creating, Growing, Modifying, Blind Growing:
@ -338,8 +338,8 @@ not even that. Option -rom_toc_scan might or might not help in such cases.
@cindex Create, new ISO image, _definiton @cindex Create, new ISO image, _definiton
A new empty ISO image gets @strong{created} A new empty ISO image gets @strong{created}
if there is no input drive with a valid ISO 9660 image when the first time if there is no input drive with a valid ISO 9660 image when the first time
an output drive is defined. This is achieved by option -dev on blank media an output drive is defined. This is achieved by command -dev on blank media
or by option -outdev on media in any state. or by command -outdev on media in any state.
@* @*
The new empty image can be populated with directories and files. The new empty image can be populated with directories and files.
Before it can be written, the medium in the output drive must get into Before it can be written, the medium in the output drive must get into
@ -359,7 +359,7 @@ ISO 9660 + Rock Ridge directory tree. It is possible to hide files from
previous sessions but they still exist on the medium and with many types of previous sessions but they still exist on the medium and with many types of
optical media it is quite easy to recover them by mounting older sessions. optical media it is quite easy to recover them by mounting older sessions.
@* @*
Growing is achieved by option -dev. Growing is achieved by command -dev.
@c man .PP @c man .PP
@sp 1 @sp 1
@cindex Modifying, _definition @cindex Modifying, _definition
@ -375,12 +375,12 @@ So for this method one needs either two optical drives or has to work with
filesystem objects as source and/or target medium. filesystem objects as source and/or target medium.
@* @*
Modifying takes place if input drive and output drive are not the same and Modifying takes place if input drive and output drive are not the same and
if option -grow_blindly is set to its default "off". if command -grow_blindly is set to its default "off".
This is achieved by options -indev and -outdev. This is achieved by commands -indev and -outdev.
@c man .PP @c man .PP
@sp 1 @sp 1
@cindex Blind growing, _definition @cindex Blind growing, _definition
If option -grow_blindly is set to a non-negative number and if -indev and If command -grow_blindly is set to a non-negative number and if -indev and
-outdev are both set to different drives, then @strong{blind growing} is -outdev are both set to different drives, then @strong{blind growing} is
performed. It produces an add-on session which is ready for being written performed. It produces an add-on session which is ready for being written
to the given block address. This is the usage model of to the given block address. This is the usage model of
@ -483,13 +483,13 @@ device by using its path with the "stdio:" prefix. By default any address
in the /dev tree without prefix "stdio:" will work only if it leads to a MMC in the /dev tree without prefix "stdio:" will work only if it leads to a MMC
drive. drive.
@* @*
One may use option One may use command
@strong{-ban_stdio_write} @strong{-ban_stdio_write}
to surely prevent this risk and to allow only MMC drives. to surely prevent this risk and to allow only MMC drives.
@* @*
One may prepend "mmc:" to a path to surely disallow any automatic "stdio:". One may prepend "mmc:" to a path to surely disallow any automatic "stdio:".
@c man .br @c man .br
By option -drive_class one may ban certain paths or allow access without By command -drive_class one may ban certain paths or allow access without
prefix "stdio:" to other paths. prefix "stdio:" to other paths.
@c man .SS @c man .SS
@node Extras, Processing, Drives, top @node Extras, Processing, Drives, top
@ -522,7 +522,7 @@ The content of the boot image files is not in the scope of El Torito.
@* @*
Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images. Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images.
@command{xorriso} is able to create or maintain an El Torito object which @command{xorriso} is able to create or maintain an El Torito object which
makes such an image bootable. For details see option -boot_image. makes such an image bootable. For details see command -boot_image.
@* @*
@cindex MBR, _definiton @cindex MBR, _definiton
It is possible to make ISO images bootable from USB stick or other It is possible to make ISO images bootable from USB stick or other
@ -547,7 +547,7 @@ EFI, MIPS Big Endian (SGI), MIPS Little Endian (DEC), SUN SPARC.
are an advanced way of controlling access permissions to file objects. Neither are an advanced way of controlling access permissions to file objects. Neither
ISO 9660 nor Rock Ridge specify a way to record ACLs. So libisofs has ISO 9660 nor Rock Ridge specify a way to record ACLs. So libisofs has
introduced a standard conformant extension named AAIP for that purpose. introduced a standard conformant extension named AAIP for that purpose.
It uses this extension if enabled by option It uses this extension if enabled by command
@strong{-acl}. @strong{-acl}.
@* @*
AAIP enhanced images are supposed to be mountable normally, but one cannot AAIP enhanced images are supposed to be mountable normally, but one cannot
@ -576,7 +576,7 @@ pairs which
have names out of the user namespace. I.e. those which begin with "user.", have names out of the user namespace. I.e. those which begin with "user.",
like "user.x" or "user.whatever". Name has to be a 0 terminated string. like "user.x" or "user.whatever". Name has to be a 0 terminated string.
Value may be any array of bytes which does not exceed the size of 4095 bytes. Value may be any array of bytes which does not exceed the size of 4095 bytes.
xattr processing happens only if it is enabled by option xattr processing happens only if it is enabled by command
@strong{-xattr}. @strong{-xattr}.
@* @*
As with ACL, currently only @command{xorriso} is able to retrieve xattr As with ACL, currently only @command{xorriso} is able to retrieve xattr
@ -592,7 +592,7 @@ only on GNU/Linux and FreeBSD, where they are known as extattr.
@c man .br @c man .br
Commands are either actions which happen immediately or settings which Commands are either actions which happen immediately or settings which
influence following actions. So their sequence does matter, unless they are influence following actions. So their sequence does matter, unless they are
given as program arguments and option given as program arguments and command
@strong{-x} @strong{-x}
is among them. is among them.
@* @*
@ -605,7 +605,7 @@ the argument list, or occur at the end of an input line.
@c man .PP @c man .PP
@sp 1 @sp 1
At program start the list delimiter is the string "@minus{}@minus{}". At program start the list delimiter is the string "@minus{}@minus{}".
This may be changed with the -list_delimiter option in order to allow This may be changed with the -list_delimiter command in order to allow
"@minus{}@minus{}" as parameter in a variable length list. "@minus{}@minus{}" as parameter in a variable length list.
However, it is advised to reset the delimiter to "@minus{}@minus{}" However, it is advised to reset the delimiter to "@minus{}@minus{}"
immediately afterwards. immediately afterwards.
@ -653,15 +653,15 @@ type can enclose the marks of the other type. A trailing backslash \ outside
quotations or an open quotation cause the next input line to be appended. quotations or an open quotation cause the next input line to be appended.
@* @*
@cindex Backslash Interpretation, _definition @cindex Backslash Interpretation, _definition
Quoted input accepts any ASCII character except NUL (0) as the content of Quoted input accepts any 8-bit character except NUL (0) as the content of
the quotes. the quotes.
Nevertheless it can be cumbersome for the user to produce those characters Nevertheless it can be cumbersome for the user to produce those characters
directly. Therefore quoted input and program arguments allow optional directly. Therefore quoted input and program arguments allow optional
@strong{Backslash Interpretation} @strong{Backslash Interpretation}
which can represent all ASCII characters except NUL (0) via backslash codes which can represent all 8-bit characters except NUL (0) via backslash codes
as in $'...' of bash. as in $'...' of bash.
@* @*
This is not enabled by default. See option -backslash_codes. This is not enabled by default. See command -backslash_codes.
@c man .PP @c man .PP
@sp 1 @sp 1
When the program starts then it first looks for argument -no_rc. If this is When the program starts then it first looks for argument -no_rc. If this is
@ -702,7 +702,7 @@ See info readline
for more info about libreadline. for more info about libreadline.
@c man .PP @c man .PP
@sp 1 @sp 1
Option -page activates a built-in result text pager which may be convenient in Command -page activates a built-in result text pager which may be convenient in
dialog mode. After an action has output the given number of terminal lines, dialog mode. After an action has output the given number of terminal lines,
the pager prompts the user for a line of input. the pager prompts the user for a line of input.
@* @*
@ -727,8 +727,8 @@ All actions try to abort as soon as possible.
@c man .SH OPTIONS @c man .SH OPTIONS
@c man .br @c man .br
All command words are shown with a leading dash although this dash is not All command words are shown with a leading dash although this dash is not
mandatory for the option to be recognized. Nevertheless within option -as mandatory for the command to be recognized. Nevertheless within command -as
the dashes of the emulated options are mandatory. the dashes of the emulated commands are mandatory.
@* @*
Normally any number of leading dashes is ignored with command words and Normally any number of leading dashes is ignored with command words and
inner dashes are interpreted as underscores. inner dashes are interpreted as underscores.
@ -751,7 +751,7 @@ inner dashes are interpreted as underscores.
* Inquiry:: Drive and media related inquiry actions * Inquiry:: Drive and media related inquiry actions
* Navigate:: Navigation in ISO image and disk filesystem * Navigate:: Navigation in ISO image and disk filesystem
* Verify:: Evaluation of readability and recovery * Verify:: Evaluation of readability and recovery
* Restore:: osirrox ISO-to-disk restore options * Restore:: osirrox ISO-to-disk restore commands
* Emulation:: Command compatibility emulations (cdrtools) * Emulation:: Command compatibility emulations (cdrtools)
* Scripting:: Scripting, dialog and program control features * Scripting:: Scripting, dialog and program control features
* Frontend:: Support for frontend programs via stdin and stdout * Frontend:: Support for frontend programs via stdin and stdout
@ -774,8 +774,8 @@ at the cost of loss of expressivity.
@sp 1 @sp 1
@c man .TP @c man .TP
@item -x @item -x
@kindex -x enables automatic execution order of options @kindex -x enables automatic execution order of arguments
@cindex Automatic execution order, of options, -x @cindex Automatic execution order, of arguments, -x
Enable automatic sorting of program arguments into a sequence that Enable automatic sorting of program arguments into a sequence that
(most likely) is sensible. (most likely) is sensible.
This command may be given at any position among the commands This command may be given at any position among the commands
@ -790,7 +790,8 @@ It affects only the commands given as program arguments.
@item -list_arg_sorting @item -list_arg_sorting
@kindex -list_arg_sorting prints sorting order of -x @kindex -list_arg_sorting prints sorting order of -x
@cindex Sorting order, for -x, -list_arg_sorting @cindex Sorting order, for -x, -list_arg_sorting
List all xorriso commands in the order which applies if option -x is in effect. List all xorriso commands in the order which applies if command -x is in
effect.
@* @*
This list may also be helpful without -x for a user who ponders over the This list may also be helpful without -x for a user who ponders over the
sequence in which to put commands. Deviations from the listed sorting order may sequence in which to put commands. Deviations from the listed sorting order may
@ -802,7 +803,7 @@ well make sense, though.
@section Acquiring source and target drive @section Acquiring source and target drive
@c man .B Acquiring source and target drive: @c man .B Acquiring source and target drive:
@c man .PP @c man .PP
The effect of acquiring a drive may depend on several options in the The effect of acquiring a drive may depend on several commands in the
next paragraph "Influencing the behavior of image loading". next paragraph "Influencing the behavior of image loading".
If desired, their enabling commands have to be performed before the If desired, their enabling commands have to be performed before the
commands which acquire the drive. commands which acquire the drive.
@ -877,7 +878,7 @@ begins. The output drive is given up when writing is done.
@node Loading, Insert, AqDrive, Options @node Loading, Insert, AqDrive, Options
@section Influencing the behavior of image loading @section Influencing the behavior of image loading
@c man .PP @c man .PP
The following options should normally be performed before loading an image The following commands should normally be performed before loading an image
by acquiring an input drive. In rare cases it is desirable to activate by acquiring an input drive. In rare cases it is desirable to activate
them only after image loading. them only after image loading.
@table @asis @table @asis
@ -887,7 +888,7 @@ them only after image loading.
@kindex -load addresses a particular session as input @kindex -load addresses a particular session as input
@cindex Session, select as input, -load @cindex Session, select as input, -load
Load a particular (possibly outdated) ISO session from -dev or -indev. Load a particular (possibly outdated) ISO session from -dev or -indev.
Usually all available sessions are shown with option -toc. Usually all available sessions are shown with command -toc.
@* @*
entity depicts the kind of addressing. id depicts the particular entity depicts the kind of addressing. id depicts the particular
address. The following entities are defined: address. The following entities are defined:
@ -979,7 +980,7 @@ search pattern. When refusing an image, give up the input drive and issue
an event of the given severity (like FAILURE, see -abort_on). An empty search an event of the given severity (like FAILURE, see -abort_on). An empty search
pattern accepts any image. pattern accepts any image.
@* @*
This option does not hamper the creation of an empty image from blank This command does not hamper the creation of an empty image from blank
input media and does not discard an already loaded image. input media and does not discard an already loaded image.
@c man .TP @c man .TP
@item -in_charset character_set_name @item -in_charset character_set_name
@ -1051,14 +1052,14 @@ If enabled, then @command{xorriso} will obtain ACLs from disk file objects,
store ACLs in the ISO image using the libisofs specific AAIP format, store ACLs in the ISO image using the libisofs specific AAIP format,
load AAIP data from ISO images, test ACL during file comparison, load AAIP data from ISO images, test ACL during file comparison,
and restore ACLs to disk files when extracting them from ISO images. and restore ACLs to disk files when extracting them from ISO images.
See also options -getfacl, -setfacl. See also commands -getfacl, -setfacl.
@c man .TP @c man .TP
@item -xattr "on"|"off" @item -xattr "on"|"off"
@kindex -xattr controls handling of xattr (EA) @kindex -xattr controls handling of xattr (EA)
@cindex xattr, control handling, -xattr @cindex xattr, control handling, -xattr
Enable or disable processing of xattr attributes in user namespace. Enable or disable processing of xattr attributes in user namespace.
If enabled, then @command{xorriso} will handle xattr similar to ACL. If enabled, then @command{xorriso} will handle xattr similar to ACL.
See also options -getfattr, -setfattr and above paragraph about xattr. See also commands -getfattr, -setfattr and above paragraph about xattr.
@c man .TP @c man .TP
@item -md5 "on"|"all"|"off"|"load_check_off" @item -md5 "on"|"all"|"off"|"load_check_off"
@kindex -md5 controls handling of MD5 sums @kindex -md5 controls handling of MD5 sums
@ -1069,7 +1070,7 @@ only if the tags of superblock and directory tree match properly. The MD5
checksums of data files and whole session get loaded from the image if there checksums of data files and whole session get loaded from the image if there
are any. are any.
@* @*
With options -compare and -update the recorded MD5 of a file With commands -compare and -update the recorded MD5 of a file
will be used to avoid content reading from the image. Only the disk file will be used to avoid content reading from the image. Only the disk file
content will be read and compared with that MD5. This can save much time content will be read and compared with that MD5. This can save much time
if -disk_dev_ino "on" is not suitable. if -disk_dev_ino "on" is not suitable.
@ -1092,7 +1093,7 @@ option -M is performed.
@* @*
The test can be re-enabled by mode "load_check_on". The test can be re-enabled by mode "load_check_on".
@* @*
Checksums can be exploited via options -check_md5, -check_md5_r, via find Checksums can be exploited via commands -check_md5, -check_md5_r, via find
actions get_md5, check_md5, and via -check_media. actions get_md5, check_md5, and via -check_media.
@c man .TP @c man .TP
@item -for_backup @item -for_backup
@ -1325,7 +1326,7 @@ composed from disk_path by replacing disk_prefix by iso_rr_prefix.
Compare file object disk_path with file object iso_rr_path. If they do not Compare file object disk_path with file object iso_rr_path. If they do not
match, then perform the necessary image manipulations to make iso_rr_path match, then perform the necessary image manipulations to make iso_rr_path
a matching copy of disk_path. By default this comparison will imply lengthy a matching copy of disk_path. By default this comparison will imply lengthy
content reading before a decision is made. Options -disk_dev_ino or -md5 may content reading before a decision is made. Commands -disk_dev_ino or -md5 may
accelerate comparison if they were already in effect when the loaded session accelerate comparison if they were already in effect when the loaded session
was recorded. was recorded.
@* @*
@ -1341,7 +1342,7 @@ addresses get compared whether they have counterparts below the other address
and whether both counterparts match. If there is a mismatch then the necessary and whether both counterparts match. If there is a mismatch then the necessary
update manipulation is done. update manipulation is done.
@* @*
Note that the comparison result may depend on option -follow. Its setting Note that the comparison result may depend on command -follow. Its setting
should always be the same as with the first adding of disk_path as iso_rr_path. should always be the same as with the first adding of disk_path as iso_rr_path.
@* @*
If iso_rr_path does not exist yet, then it gets added. If disk_path does not If iso_rr_path does not exist yet, then it gets added. If disk_path does not
@ -1383,12 +1384,12 @@ E.g:
@* @*
/file/part_3_of_3_at_4094m_with_2047m_of_5753194821 /file/part_3_of_3_at_4094m_with_2047m_of_5753194821
@* @*
While option -split_size is set larger than 0, and if all pieces of a file While command -split_size is set larger than 0, and if all pieces of a file
reside in the same ISO directory with no other files, and if the names look reside in the same ISO directory with no other files, and if the names look
like above, then their ISO directory will be recognized and handled like a like above, then their ISO directory will be recognized and handled like a
regular file. This affects options -compare*, -update*, and overwrite regular file. This affects commands -compare*, -update*, and overwrite
situations. situations.
See option -split_size for details. See command -split_size for details.
@c man .TP @c man .TP
@item -cpr disk_path [***] iso_rr_path @item -cpr disk_path [***] iso_rr_path
@kindex -cpr inserts like with cp -r @kindex -cpr inserts like with cp -r
@ -1644,10 +1645,10 @@ FAILURE event.
A well tested -split_size is 2047m. Sizes above -file_size_limit are not A well tested -split_size is 2047m. Sizes above -file_size_limit are not
permissible. permissible.
@* @*
While option -split_size is set larger than 0 such a directory with split While command -split_size is set larger than 0 such a directory with split
file pieces will be recognized and handled like a regular file by options file pieces will be recognized and handled like a regular file by commands
-compare* , -update*, and in overwrite situations. There are -ossirox -compare* , -update*, and in overwrite situations. There are -ossirox
options "concat_split_on" and "concat_split_off" which control the handling parameters "concat_split_on" and "concat_split_off" which control the handling
when files get restored to disk. when files get restored to disk.
@* @*
In order to be recognizable, the names of the part files have to In order to be recognizable, the names of the part files have to
@ -1710,7 +1711,7 @@ medium in modification mode.
@kindex -rm_r deletes trees from ISO image @kindex -rm_r deletes trees from ISO image
@cindex Delete, from ISO image, -rm_r @cindex Delete, from ISO image, -rm_r
Delete the given files or directory trees from the ISO image. Delete the given files or directory trees from the ISO image.
See also the note with option -rm. See also the note with command -rm.
@c man .TP @c man .TP
@item -rmdir iso_rr_path [***] @item -rmdir iso_rr_path [***]
@kindex -rmdir deletes ISO directory @kindex -rmdir deletes ISO directory
@ -1838,7 +1839,7 @@ Only names from the user namespace are allowed. I.e. a name has to begin with
"user.", like "user.x" or "user.whatever". "user.", like "user.x" or "user.whatever".
@* @*
Values and names undergo the normal input processing of @command{xorriso}. Values and names undergo the normal input processing of @command{xorriso}.
See also option -backslash_codes. Other than with option -setfattr_list, See also command -backslash_codes. Other than with command -setfattr_list,
the byte value 0 cannot be expressed via -setfattr. the byte value 0 cannot be expressed via -setfattr.
@c man .TP @c man .TP
@item -setfattr_r [-]name value iso_rr_path [***] @item -setfattr_r [-]name value iso_rr_path [***]
@ -1867,7 +1868,7 @@ Name must be from user namespace. I.e. user.xyz where xyz should consist of
printable characters only. The separator "=" is not allowed in names. printable characters only. The separator "=" is not allowed in names.
Value may contain any kind of bytes. It must be in quotes. Trailing Value may contain any kind of bytes. It must be in quotes. Trailing
whitespace after the end quote will be ignored. Non-printables bytes and quotes whitespace after the end quote will be ignored. Non-printables bytes and quotes
must be represented as \XYZ by their octal ASCII code XYZ. must be represented as \XYZ by their octal 8-bit code XYZ.
Use code \000 for 0-bytes. Use code \000 for 0-bytes.
@c man .TP @c man .TP
@item -alter_date type timestring iso_rr_path [***] @item -alter_date type timestring iso_rr_path [***]
@ -2165,7 +2166,7 @@ prints access permissions in ACL text form to the result channel.
@* @*
@item setfacl @item setfacl
attaches ACLs after removing existing ones. The new attaches ACLs after removing existing ones. The new
ACL is given in text form as defined with option -setfacl. ACL is given in text form as defined with command -setfacl.
@* @*
E.g.: -exec setfacl u:lisa:rw,u::rw,g::r,o::@minus{},m::rw @minus{}@minus{} E.g.: -exec setfacl u:lisa:rw,u::rw,g::r,o::@minus{},m::rw @minus{}@minus{}
@* @*
@ -2192,7 +2193,7 @@ Mode "b" prints backslash encoding. Not suitable for shell parsing.
@* @*
E.g. -exec list_extattr e -- E.g. -exec list_extattr e --
@* @*
Option -backslash_codes does not affect the output. Command -backslash_codes does not affect the output.
@* @*
@item get_md5 @item get_md5
prints the MD5 sum, if recorded, together with file path. prints the MD5 sum, if recorded, together with file path.
@ -2428,7 +2429,7 @@ Switch to growing mode.
are uncommitted manipulations pending. are uncommitted manipulations pending.
@* @*
So, to perform a final write operation with no new -dev So, to perform a final write operation with no new -dev
and no new loading of image, rather execute option -end. and no new loading of image, rather execute command -end.
If you want to go on without image loading, execute -commit_eject "none". If you want to go on without image loading, execute -commit_eject "none".
To eject after write without image loading, use -commit_eject "all". To eject after write without image loading, use -commit_eject "all".
@* @*
@ -2488,7 +2489,7 @@ but produces media which are only suitable for a single session.
Some drives announce this state by not offering feature 21h, Some drives announce this state by not offering feature 21h,
but some drives offer it anyway. but some drives offer it anyway.
If feature 21h is missing, then @command{xorriso} If feature 21h is missing, then @command{xorriso}
will refuse to write on DVD-RW if not option -close is set to "on". will refuse to write on DVD-RW if not command -close is set to "on".
@* @*
The progress reports issued by some drives while blanking are The progress reports issued by some drives while blanking are
quite unrealistic. Do not conclude success or failure from the quite unrealistic. Do not conclude success or failure from the
@ -2512,7 +2513,7 @@ unformatted BD-R. Other media are left untouched.
@* @*
"fast" does the same as "full" but tries to be quicker. "fast" does the same as "full" but tries to be quicker.
@* @*
"by_index_" selects a format out of the descriptor list issued by option "by_index_" selects a format out of the descriptor list issued by command
-list_formats. The index number from that list is to be appended to the -list_formats. The index number from that list is to be appended to the
mode word. E.g: "by_index_3". mode word. E.g: "by_index_3".
@* @*
@ -2587,7 +2588,7 @@ or BD-R media. It is indicated by warning messages when the drive gets
acquired, and by a remark "but next track is damaged" with the line acquired, and by a remark "but next track is damaged" with the line
"Media status :" of command -toc. "Media status :" of command -toc.
@* @*
The setting of option -close determines whether the medium stays appendable. The setting of command -close determines whether the medium stays appendable.
@* @*
Mode "as_needed" gracefully refuses on media which are not reported as Mode "as_needed" gracefully refuses on media which are not reported as
damaged. Mode "force" attempts the close operation even with media which damaged. Mode "force" attempts the close operation even with media which
@ -2608,7 +2609,7 @@ The currently recognized type is marked by text "(current)".
@section Settings for result writing @section Settings for result writing
@c man .PP @c man .PP
Rock Ridge info will be generated by the program unconditionally. Rock Ridge info will be generated by the program unconditionally.
ACLs will be written according to the setting of option -acl. ACLs will be written according to the setting of command -acl.
@table @asis @table @asis
@sp 1 @sp 1
@c man .TP @c man .TP
@ -2627,7 +2628,7 @@ cases it is worth to deviate a bit in order to circumvent bugs of the intended
reader system or to get unofficial extra features. reader system or to get unofficial extra features.
@* @*
There are several adjustable rules which have a keyword each. If they There are several adjustable rules which have a keyword each. If they
are mentioned with this option then their rule gets added to the relaxation are mentioned with this command then their rule gets added to the relaxation
list. This list can be erased by rules "strict" or "clear". It can be reset list. This list can be erased by rules "strict" or "clear". It can be reset
to its start setting by "default". All of the following relaxation rules to its start setting by "default". All of the following relaxation rules
can be revoked individually by appending "_off". Like "deep_paths_off". can be revoked individually by appending "_off". Like "deep_paths_off".
@ -2662,11 +2663,12 @@ not 8.3.
@* @*
"lowercase" allows lowercase characters in ISO file names. "lowercase" allows lowercase characters in ISO file names.
@* @*
"full_ascii" allows all ASCII characters in ISO file names. "full_ascii" allows all 8-bit characters except 0x0 and '/'
in ISO file names.
@* @*
"untranslated_names" might be dangerous for inadverted reader programs "untranslated_names" might be dangerous for inadverted reader programs
which rely on the restriction to at most 37 characters in ISO file names. which rely on the restriction to at most 37 characters in ISO file names.
This option allows ISO file names up to 96 characters with no character This rule allows ISO file names up to 96 characters with no character
conversion. If a file name has more characters, then image production will conversion. If a file name has more characters, then image production will
fail deliberately. fail deliberately.
@* @*
@ -2799,7 +2801,7 @@ It is supposed to match this GRUB line:
@* @*
E.g. 2010040711405800 is 7 Apr 2010 11:40:58 (+0 centiseconds). E.g. 2010040711405800 is 7 Apr 2010 11:40:58 (+0 centiseconds).
@* @*
Timestrings for the other types may be given as with option -alter_date. Timestrings for the other types may be given as with command -alter_date.
They are prone to timezone computations. The timestrings "default" or They are prone to timezone computations. The timestrings "default" or
"overridden" cause default settings: "c" and "m" will show the current time "overridden" cause default settings: "c" and "m" will show the current time
of image creation. "x" and "f" will be marked as insignificant. of image creation. "x" and "f" will be marked as insignificant.
@ -2869,7 +2871,7 @@ Group id to be used for all files when the new ISO tree gets written to media.
@cindex Filter, zisofs parameters, -zisofs @cindex Filter, zisofs parameters, -zisofs
Set global parameters for zisofs compression. This data format is recognized Set global parameters for zisofs compression. This data format is recognized
and transparently uncompressed by some Linux kernels. It is to be applied and transparently uncompressed by some Linux kernels. It is to be applied
via option -set_filter with built-in filter "@minus{}@minus{}zisofs". via command -set_filter with built-in filter "@minus{}@minus{}zisofs".
Parameters are: Parameters are:
@* @*
"level="[0-9] zlib compression: 0=none, 1=fast,..., 9=slow "level="[0-9] zlib compression: 0=none, 1=fast,..., 9=slow
@ -2926,7 +2928,7 @@ written and writing of file content blocks begins.
GNU/Linux specific: GNU/Linux specific:
Set the number of bytes to be transmitted with each write operation to DVD Set the number of bytes to be transmitted with each write operation to DVD
or BD media. A number of 64 KB may improve throughput with bus systems which or BD media. A number of 64 KB may improve throughput with bus systems which
show latency problems. The default depends on media type, on option show latency problems. The default depends on media type, on command
-stream_recording , and on compile time options. -stream_recording , and on compile time options.
@c man .TP @c man .TP
@item -stdio_sync "on"|"off"|number @item -stdio_sync "on"|"off"|number
@ -2958,7 +2960,7 @@ which means unit is kiB (= 1024) or MiB (= 1024 kiB).
If "on" then mark the written medium as not appendable If "on" then mark the written medium as not appendable
any more (if possible at all with the given type of target media). any more (if possible at all with the given type of target media).
@* @*
This is the contrary of cdrecord, wodim, cdrskin option -multi, This is the contrary of cdrecord, wodim, cdrskin command -multi,
and is one aspect of growisofs option -dvd-compat. and is one aspect of growisofs option -dvd-compat.
@c man .TP @c man .TP
@item -padding number["k"|"m"]|"included"|"appended" @item -padding number["k"|"m"]|"included"|"appended"
@ -3229,7 +3231,7 @@ Only a single boot file can be declared by mipsel_path=.
@strong{sparc_label=}text causes the production of a SUN Disk Label with the @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 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. for partitions 2 to 8. Partition 1 will always be the ISO image.
See option -append_partition. See command -append_partition.
The first 512 bytes of any data provided by system_area= will be overwritten. The first 512 bytes of any data provided by system_area= will be overwritten.
@* @*
@strong{mips_discard} and @strong{sparc_discard} revoke any boot file @strong{mips_discard} and @strong{sparc_discard} revoke any boot file
@ -3408,7 +3410,7 @@ convert byte codes.
There is an input conversion from input character set to the local character There is an input conversion from input character set to the local character
set which applies when an ISO image gets loaded. A conversion from local set which applies when an ISO image gets loaded. A conversion from local
character set to the output character set is performed when an character set to the output character set is performed when an
image tree gets written. The sets can be defined independently by options image tree gets written. The sets can be defined independently by commands
-in_charset and -out_charset. Normally one will have both identical, if ever. -in_charset and -out_charset. Normally one will have both identical, if ever.
@* @*
If conversions are desired then @command{xorriso} needs to know the name of the If conversions are desired then @command{xorriso} needs to know the name of the
@ -3424,7 +3426,7 @@ filesystem
names and emerging names in the image. The situation stays ambigous and the names and emerging names in the image. The situation stays ambigous and the
reader has to riddle what character set was used. reader has to riddle what character set was used.
@* @*
By option -auto_charset it is possible to attribute the output charset name By command -auto_charset it is possible to attribute the output charset name
to the image. This makes the situation unambigous. But if your terminal to the image. This makes the situation unambigous. But if your terminal
character set does not match the character set of the local file names, character set does not match the character set of the local file names,
then this attribute can become plainly wrong and cause problems at read time. then this attribute can become plainly wrong and cause problems at read time.
@ -3499,10 +3501,10 @@ Set the severity threshold for events to abort the program.
Useful: "NEVER", "ABORT", "FATAL", "FAILURE" , "MISHAP", "SORRY" Useful: "NEVER", "ABORT", "FATAL", "FAILURE" , "MISHAP", "SORRY"
@* @*
It may become necessary to abort the program anyway, despite It may become necessary to abort the program anyway, despite
the setting by this option. Expect not many "ABORT" events to the setting by this command. Expect not many "ABORT" events to
be ignorable. be ignorable.
@* @*
A special property of this option is that it works preemptive if given as A special property of this command is that it works preemptive if given as
program start argument. I.e. the first -abort_on setting among the program start argument. I.e. the first -abort_on setting among the
start arguments is in effect already when the first operations of start arguments is in effect already when the first operations of
@command{xorriso} begin. Only "-abort_on" with dash "-" is recognized that way. @command{xorriso} begin. Only "-abort_on" with dash "-" is recognized that way.
@ -3545,7 +3547,7 @@ Event messages are sent to the info channel "I" which is usually stderr
but may be influenced by command -pkt_output. but may be influenced by command -pkt_output.
Info messages which belong to no event get attributed severity "NOTE". Info messages which belong to no event get attributed severity "NOTE".
@* @*
A special property of this option is that the first -report_about setting A special property of this command is that the first -report_about setting
among the start arguments is in effect already when the first operations among the start arguments is in effect already when the first operations
of @command{xorriso} begin. Only "-report_about" with dash "-" is of @command{xorriso} begin. Only "-report_about" with dash "-" is
recognized that way. recognized that way.
@ -3579,7 +3581,7 @@ kill -9 then imposes the risk that the drive is left in unusable state and
needs poweroff to be reset. So during burning, blanking, and formatting needs poweroff to be reset. So during burning, blanking, and formatting
wait for at least their normal run time before killing externally. wait for at least their normal run time before killing externally.
@* @*
A special property of this option is that the first -signal_handling setting A special property of this command is that the first -signal_handling setting
among the start arguments is in effect already when the first operations among the start arguments is in effect already when the first operations
of @command{xorriso} begin. Only "-signal_handling" with dash "-" is of @command{xorriso} begin. Only "-signal_handling" with dash "-" is
recognized that way. recognized that way.
@ -3590,12 +3592,12 @@ recognized that way.
Control the program behavior at problem event occasions. Control the program behavior at problem event occasions.
For now this applies to occasions "image_loading" which is given while For now this applies to occasions "image_loading" which is given while
an image tree is read from the input device, and to "file_extraction" which an image tree is read from the input device, and to "file_extraction" which
is given with osirrox options like -extract. is given with osirrox commands like -extract.
@* @*
With "image_loading" there are three behaviors available: With "image_loading" there are three behaviors available:
@* @*
"best_effort" goes on with reading after events with severity below FAILURE "best_effort" goes on with reading after events with severity below FAILURE
if the threshold of option -abort_on allows this. if the threshold of command -abort_on allows this.
@* @*
"failure" aborts image tree reading on first event of at least SORRY. "failure" aborts image tree reading on first event of at least SORRY.
It issues an own FAILURE event. It issues an own FAILURE event.
@ -3677,9 +3679,9 @@ directory only once and not for each file in its whole subtree.
Setting "off" silently kills any kind of image file object resp. performs Setting "off" silently kills any kind of image file object resp. performs
above irrevocable actions. above irrevocable actions.
@* @*
To really produce user prompts, option -dialog needs to be set to "on". To really produce user prompts, command -dialog needs to be set to "on".
Note that the prompt does not appear in situations where file removal Note that the prompt does not appear in situations where file removal
is forbidden by option -overwrite. -reassure only imposes an additional is forbidden by command -overwrite. -reassure only imposes an additional
curb for removing existing file objects. curb for removing existing file objects.
@* @*
Be aware that file objects get deleted from the ISO image immediately Be aware that file objects get deleted from the ISO image immediately
@ -3700,7 +3702,7 @@ Show list of available MMC drives with the addresses of
their libburn standard device files. their libburn standard device files.
@* @*
This is only possible when no ISO image changes are pending. This is only possible when no ISO image changes are pending.
After this option was executed, there is no drive current After this command was executed, there is no drive current
and no image loaded. and no image loaded.
@* @*
In order to be visible, a device has to offer rw-permissions In order to be visible, a device has to offer rw-permissions
@ -3740,7 +3742,7 @@ with only one or two sessions on it. The last of these sessions is supposed
to be the most recent real session then. to be the most recent real session then.
@* @*
Some read-only drives and media show no usable session history at all. Some read-only drives and media show no usable session history at all.
Option -rom_toc_scan might help. Command -rom_toc_scan might help.
@c man .TP @c man .TP
@item -mount_cmd drive entity id path @item -mount_cmd drive entity id path
@kindex -mount_cmd composes mount command line @kindex -mount_cmd composes mount command line
@ -3760,7 +3762,7 @@ as id.
@* @*
path will be used as mount point and must already exist as a directory on disk. path will be used as mount point and must already exist as a directory on disk.
@* @*
The command gets printed to the result channel. See option -mount The command gets printed to the result channel. See command -mount
for direct execution of this command. for direct execution of this command.
@c man .TP @c man .TP
@item -mount_opts option[:option...] @item -mount_opts option[:option...]
@ -3799,9 +3801,9 @@ session number, resp. volume id of the depicted session.
@cindex Write, predict image size, -print_size @cindex Write, predict image size, -print_size
Print the foreseeable consumption of 2048 byte blocks Print the foreseeable consumption of 2048 byte blocks
by next -commit. This can last a while as a -commit gets by next -commit. This can last a while as a -commit gets
prepared and only in last moment is revoked by this option. prepared and only in last moment is revoked by this command.
The result depends on several settings and also on the kind of output device. The result depends on several settings and also on the kind of output device.
If no -jidgo options are given and not command -as "mkisofs" was used, If no -jidgo options are set and not command -as "mkisofs" was used,
then -padding (300 kB by default) is not counted as part of the image size. then -padding (300 kB by default) is not counted as part of the image size.
@c man .TP @c man .TP
@item -tell_media_space @item -tell_media_space
@ -3814,7 +3816,7 @@ subtracting already foreseeable consumption by next -commit.
@kindex -pvd_info shows image id strings @kindex -pvd_info shows image id strings
@cindex Image, show id strings, -pvd_info @cindex Image, show id strings, -pvd_info
Print various id strings which can be found in loaded ISO images. Some of Print various id strings which can be found in loaded ISO images. Some of
them may be changed by options like -volid or -publisher. For these them may be changed by commands like -volid or -publisher. For these
ids -pvd_info reports what would be written with the next -commit. ids -pvd_info reports what would be written with the next -commit.
@end table @end table
@c man .TP @c man .TP
@ -3923,7 +3925,7 @@ Output format resembles shell command ls -dln.
Print the access permissions of the given files in the ISO image using the Print the access permissions of the given files in the ISO image using the
format of shell command getfacl. If a file has no ACL then it gets fabricated format of shell command getfacl. If a file has no ACL then it gets fabricated
from the -chmod settings. A file may have a real ACL if it was introduced into from the -chmod settings. A file may have a real ACL if it was introduced into
the ISO image while option -acl was set to "on". the ISO image while command -acl was set to "on".
@c man .TP @c man .TP
@item -getfacl_r iso_rr_pattern [***] @item -getfacl_r iso_rr_pattern [***]
@kindex -getfacl_r shows ACL in ISO image @kindex -getfacl_r shows ACL in ISO image
@ -4098,7 +4100,7 @@ according
to their read speed, save them to a file, and keep track of successfuly saved to their read speed, save them to a file, and keep track of successfuly saved
blocks for further tries on the same medium. blocks for further tries on the same medium.
@* @*
By option -md5 checksums may get recorded with data files and whole By command -md5 checksums may get recorded with data files and whole
sessions. These checksums are reachable only via indev and a loaded image. sessions. These checksums are reachable only via indev and a loaded image.
They work independently of the media type and can detect transmission errors. They work independently of the media type and can detect transmission errors.
@table @asis @table @asis
@ -4112,9 +4114,9 @@ Try to read data blocks from the indev drive, optionally copy them to a
disk file, and finally report about the encountered quality. Several options disk file, and finally report about the encountered quality. Several options
may be used to modify the default behavior. may be used to modify the default behavior.
@* @*
The options given with this command override the default settings which The parameters given with this command override the default settings which
may have been changed by option -check_media_defaults. See there for a may have been changed by command -check_media_defaults. See there for a
description of options. description of available options.
@* @*
The result list tells intervals of 2 KiB blocks with start address, number The result list tells intervals of 2 KiB blocks with start address, number
of blocks and quality. Qualities which begin with "+" are of blocks and quality. Qualities which begin with "+" are
@ -4267,10 +4269,10 @@ This gets rounded down to full blocks of 2048 bytes. 0 means automatic size.
Compare the data content of the given files in the loaded image with their Compare the data content of the given files in the loaded image with their
recorded MD5 checksums, if there are any. In case of any mismatch an event of recorded MD5 checksums, if there are any. In case of any mismatch an event of
the given severity is issued. It may then be handled by appropriate settings of the given severity is issued. It may then be handled by appropriate settings of
options -abort_on or -return_with which both can cause non-zero exit values commands -abort_on or -return_with which both can cause non-zero exit values
of the program run. Severity ALL suppresses that event. of the program run. Severity ALL suppresses that event.
@* @*
This option reports match and mismatch of data files to the result channel. This command reports match and mismatch of data files to the result channel.
Non-data files cause NOTE events. There will also be UPDATE events from Non-data files cause NOTE events. There will also be UPDATE events from
data reading. data reading.
@* @*
@ -4285,9 +4287,9 @@ Like -check_md5 but checking all data files underneath the given paths.
Only mismatching data files will be reported. Only mismatching data files will be reported.
@end table @end table
@c man .TP @c man .TP
@c man .B osirrox ISO-to-disk restore options: @c man .B osirrox ISO-to-disk restore commands:
@node Restore, Emulation, Verify, Options @node Restore, Emulation, Verify, Options
@section osirrox ISO-to-disk restore options @section osirrox ISO-to-disk restore commands
@c man .PP @c man .PP
Normally @command{xorriso} only writes to disk files which were given as stdio: Normally @command{xorriso} only writes to disk files which were given as stdio:
pseudo-drives or as log files. pseudo-drives or as log files.
@ -4435,7 +4437,7 @@ ownership and group as in ISO image.
@cindex Restore, copy file into disk file, -paste_in @cindex Restore, copy file into disk file, -paste_in
Read the content of a ISO data file and write it into a data file on disk Read the content of a ISO data file and write it into a data file on disk
beginning at the byte_offset. Write at most byte_count bytes. beginning at the byte_offset. Write at most byte_count bytes.
This is the inverse of option -cut_out. This is the inverse of command -cut_out.
@c man .TP @c man .TP
@item -mount drive entity id path @item -mount drive entity id path
@kindex -mount issues mount command for ISO session @kindex -mount issues mount command for ISO session
@ -4495,7 +4497,7 @@ persists until things happen like -commit, -rollback, -dev, or end of
-pacifier gets set to "mkisofs" if files are added to the image. -pacifier gets set to "mkisofs" if files are added to the image.
@* @*
-graft-points is equivalent to -pathspecs on. Note that pathspecs without "=" -graft-points is equivalent to -pathspecs on. Note that pathspecs without "="
are interpreted differently than with @command{xorriso} option -add. are interpreted differently than with @command{xorriso} command -add.
Directories get Directories get
merged with the root directory of the ISO image, other filetypes get mapped merged with the root directory of the ISO image, other filetypes get mapped
into that root directory. into that root directory.
@ -4504,7 +4506,7 @@ If pathspecs are given and if no output file was chosen before or during the
"mkisofs" option list, then standard output (-outdev "-") will get into effect. "mkisofs" option list, then standard output (-outdev "-") will get into effect.
If -o points to a regular file, then it will be truncated to 0 bytes If -o points to a regular file, then it will be truncated to 0 bytes
when finally writing begins. This truncation does not happen if the drive when finally writing begins. This truncation does not happen if the drive
is chosen by @command{xorriso} options before -as mkisofs or after its is chosen by @command{xorriso} commands before -as mkisofs or after its
list delimiter. Directories and symbolic links are no valid -o targets. list delimiter. Directories and symbolic links are no valid -o targets.
@* @*
Writing to stdout is possible only if -as "mkisofs" was among the start Writing to stdout is possible only if -as "mkisofs" was among the start
@ -4533,7 +4535,7 @@ resp. to "on" by @minus{}@minus{}old-root-devno .
Not original mkisofs options are @minus{}@minus{}quoted_path_list , Not original mkisofs options are @minus{}@minus{}quoted_path_list ,
@minus{}@minus{}hardlinks , @minus{}@minus{}acl , @minus{}@minus{}hardlinks , @minus{}@minus{}acl ,
@minus{}@minus{}xattr , @minus{}@minus{}md5 , @minus{}@minus{}stdio_sync . @minus{}@minus{}xattr , @minus{}@minus{}md5 , @minus{}@minus{}stdio_sync .
They work like the @command{xorriso} options with the They work like the @command{xorriso} commands with the
same name and hardcoded parameter "on", e.g. -acl "on". same name and hardcoded parameter "on", e.g. -acl "on".
Explicit parameters are expected by @minus{}@minus{}stdio_sync Explicit parameters are expected by @minus{}@minus{}stdio_sync
and @minus{}@minus{}scdbackup_tag. and @minus{}@minus{}scdbackup_tag.
@ -4570,7 +4572,7 @@ instead of -G to apply the effect of -boot_image isolinux partition_table=on.
@minus{}partition_offset number is @minus{}partition_offset number is
@minus{}boot_image any partition_offset=number. @minus{}boot_image any partition_offset=number.
@* @*
Option @minus{}append_partition is supported. Command @minus{}append_partition is supported.
@* @*
@minus{}untranslated_name_len number is @minus{}untranslated_name_len number is
@minus{}compliance untranslated_name_len=number. @minus{}compliance untranslated_name_len=number.
@ -4578,7 +4580,7 @@ Option @minus{}append_partition is supported.
@minus{}@minus{}old-empty is -compliance old_empty. @minus{}@minus{}old-empty is -compliance old_empty.
@* @*
The options of genisoimage Jigdo Template Extraction are recognized and The options of genisoimage Jigdo Template Extraction are recognized and
performed via @command{xorriso} option -jigdo. See the "Alias:" names there performed via @command{xorriso} command -jigdo. See the "Alias:" names there
for the meaning of the genisoimage options. for the meaning of the genisoimage options.
@* @*
@sp 1 @sp 1
@ -4592,7 +4594,7 @@ If @command{xorriso} is started with one of the leafnames "xorrisofs",
-as "genisofs" to the program arguments. -as "genisofs" to the program arguments.
I.e. all arguments will be interpreted mkisofs style until "@minus{}@minus{}" I.e. all arguments will be interpreted mkisofs style until "@minus{}@minus{}"
is encountered. is encountered.
From then on, options are interpreted as @command{xorriso} options. From then on, arguments are interpreted as @command{xorriso} commands.
@* @*
@minus{}@minus{}no_rc as first argument of such a program start @minus{}@minus{}no_rc as first argument of such a program start
prevents interpretation of startup files. See section FILES below. prevents interpretation of startup files. See section FILES below.
@ -4641,7 +4643,7 @@ If @command{xorriso} is started with one of the leafnames "xorrecord",
"cdrskin", "cdrecord", or "wodim", then it automatically prepends -as "cdrskin" "cdrskin", "cdrecord", or "wodim", then it automatically prepends -as "cdrskin"
to the program arguments. I.e. all arguments will be interpreted cdrecord to the program arguments. I.e. all arguments will be interpreted cdrecord
style until "@minus{}@minus{}" is encountered. style until "@minus{}@minus{}" is encountered.
From then on, options are interpreted as @command{xorriso} options. From then on, arguments are interpreted as @command{xorriso} commands.
@* @*
@minus{}@minus{}no_rc as first argument of such a program start @minus{}@minus{}no_rc as first argument of such a program start
prevents interpretation of @command{xorriso} startup files. prevents interpretation of @command{xorriso} startup files.
@ -4705,7 +4707,7 @@ Program scdbackup_verify will recognize and verify tag resp. record.
@kindex -no_rc disables startup files @kindex -no_rc disables startup files
@cindex Process, disable startup files, -no_rc @cindex Process, disable startup files, -no_rc
@* @*
Only if used as first program argument this option Only if used as first program argument this command
prevents reading and interpretation of startup files. See section FILES below. prevents reading and interpretation of startup files. See section FILES below.
@c man .TP @c man .TP
@item -options_from_file fileaddress @item -options_from_file fileaddress
@ -4821,8 +4823,8 @@ With the start program arguments there is mode:
@* @*
Mode "encode_output" encodes output characters. It combines "encode_results" Mode "encode_output" encodes output characters. It combines "encode_results"
with "encode_infos". Inside single or double quotation marks encoding applies with "encode_infos". Inside single or double quotation marks encoding applies
to ASCII characters octal 001 to 037 , 177 to 377 and to backslash(134). to 8-bit characters octal 001 to 037 , 177 to 377 and to backslash(134).
Outside quotation marks some harmless control characters stay unencoded: Outside quotation marks some harmless ASCII control characters stay unencoded:
bell(007), backspace(010), tab(011), linefeed(012), formfeed(014), bell(007), backspace(010), tab(011), linefeed(012), formfeed(014),
carriage_return(015). carriage_return(015).
@* @*
@ -4910,7 +4912,7 @@ Mode "on" enables very verbous logging of SCSI commands and drive replies.
Logging messages get printed to stderr, not to any of the @command{xorriso} Logging messages get printed to stderr, not to any of the @command{xorriso}
output channels. output channels.
@* @*
A special property of this option is that the first -scsi_log setting A special property of this command is that the first -scsi_log setting
among the start arguments is in effect already when the first operations among the start arguments is in effect already when the first operations
of @command{xorriso} begin. of @command{xorriso} begin.
Only "-scsi_log" with dash "-" is recognized that way. Only "-scsi_log" with dash "-" is recognized that way.
@ -5113,7 +5115,7 @@ $ xorriso -outdev /dev/sr2 \
@sp 1 @sp 1
Note that '/pictures/*private*' is a pattern for iso_rr_paths Note that '/pictures/*private*' is a pattern for iso_rr_paths
while pictures/confidential/work* gets expanded by the shell while pictures/confidential/work* gets expanded by the shell
with addresses from the hard disk. Options -add and -map have different with addresses from the hard disk. Commands -add and -map have different
parameter rules but finally the same effect: they put files into the image. parameter rules but finally the same effect: they put files into the image.
@c man .SS @c man .SS
@c man .B A dialog session doing about the same @c man .B A dialog session doing about the same
@ -5123,8 +5125,8 @@ parameter rules but finally the same effect: they put files into the image.
Some settings are already given as start argument. The other activities Some settings are already given as start argument. The other activities
are done as dialog input. The pager gets set to 20 lines of 80 characters. are done as dialog input. The pager gets set to 20 lines of 80 characters.
@* @*
The drive is acquired by option -dev rather than -outdev in order to see The drive is acquired by command -dev rather than -outdev in order to see
the message about its current content. By option -blank this content is the message about its current content. By command -blank this content is
made ready for being overwritten and the loaded ISO image is made empty. made ready for being overwritten and the loaded ISO image is made empty.
@* @*
In order to be able to eject the medium, the session needs to be committed In order to be able to eject the medium, the session needs to be committed
@ -5273,7 +5275,7 @@ the same files gets added with converted file names.
In order to avoid any weaknesses of the local character set, this command In order to avoid any weaknesses of the local character set, this command
pretends that it uses already the final target set UTF-8. pretends that it uses already the final target set UTF-8.
Therefore strange file names may appear in messages, which Therefore strange file names may appear in messages, which
will be made terminal-safe by option -backslash_codes. will be made terminal-safe by command -backslash_codes.
@* @*
@sp 1 @sp 1
$ xorriso -in_charset ISO-8859-1 -local_charset UTF-8 \ $ xorriso -in_charset ISO-8859-1 -local_charset UTF-8 \
@ -5527,7 +5529,7 @@ the old one.
This makes sense if the full backup leaves substantial remaining capacity This makes sense if the full backup leaves substantial remaining capacity
on media and if the expected changes are much smaller than the full backup. on media and if the expected changes are much smaller than the full backup.
To apply zisofs compression to those data files which get newly copied from To apply zisofs compression to those data files which get newly copied from
the local filesystem, insert these options immediately before -commit : the local filesystem, insert these commands immediately before -commit :
@* @*
@sp 1 @sp 1
-hardlinks perform_update \ -hardlinks perform_update \
@ -5535,7 +5537,7 @@ the local filesystem, insert these options immediately before -commit :
-find / -type f -pending_data -exec set_filter @minus{}@minus{}zisofs @minus{}@minus{} \ -find / -type f -pending_data -exec set_filter @minus{}@minus{}zisofs @minus{}@minus{} \
@* @*
@sp 1 @sp 1
Options -disk_dev_ino and -for_backup depend on stable device and inode numbers Commands -disk_dev_ino and -for_backup depend on stable device and inode numbers
on disk. Without them, an update run may use -md5 "on" to match recorded MD5 on disk. Without them, an update run may use -md5 "on" to match recorded MD5
sums against the current file content on hard disk. This is usually much faster sums against the current file content on hard disk. This is usually much faster
than the default which compares both contents directly. than the default which compares both contents directly.
@ -5547,15 +5549,15 @@ versions. With CD media, GNU/Linux mount accepts session numbers directly by
its option "session=". its option "session=".
@* @*
Multi-session media and most overwriteable media written by @command{xorriso} Multi-session media and most overwriteable media written by @command{xorriso}
can tell the sbsectors of their sessions by @command{xorriso} option -toc. can tell the sbsectors of their sessions by @command{xorriso} command -toc.
Used after -commit the following option prints the matching mount command for Used after -commit the following command prints the matching mount command for
the newly written session (here for mount point /mnt): the newly written session (here for mount point /mnt):
@* @*
@sp 1 @sp 1
-mount_cmd "indev" "auto" "auto" /mnt -mount_cmd "indev" "auto" "auto" /mnt
@* @*
@sp 1 @sp 1
Options -mount_cmd and -mount are also able to produce the mount commands for Commands -mount_cmd and -mount are also able to produce the mount commands for
older sessions in the table-of-content. E.g. as superuser: older sessions in the table-of-content. E.g. as superuser:
@* @*
@sp 1 @sp 1
@ -5664,7 +5666,7 @@ program name pre-select certain settings:
@strong{xorrecord} starts @command{xorriso} with -as cdrecord emulation. @strong{xorrecord} starts @command{xorriso} with -as cdrecord emulation.
@* @*
@strong{osirrox} starts with -osirrox "on:o_excl_off" which allows @strong{osirrox} starts with -osirrox "on:o_excl_off" which allows
to copy files from ISO image to disk and to apply option -mount to to copy files from ISO image to disk and to apply command -mount to
one or more of the existing ISO sessions. one or more of the existing ISO sessions.
@c man .SS @c man .SS
@c man .B Startup files: @c man .B Startup files: