Patch by Mats Erik Anderson: wrap @command{} around the word xorriso

master
Thomas Schmitt 12 years ago
parent 87321c252d
commit 8a6f217c42
  1. 19
      xorriso/make_xorriso_1.c
  2. 234
      xorriso/xorriso.1
  3. 455
      xorriso/xorriso.info
  4. 245
      xorriso/xorriso.texi

@ -111,6 +111,23 @@ int Mx1_substitute(struct Mx1 *m, char line_in[256], char line_out[256],
strcpy(wpt, "\\fR");
wpt+= 3;
rpt+= ept - rpt;
} else if(strncmp(rpt, "@command{}", 9) == 0) {
/* @command{... } gets mapped to \fB...\fR . */
ept= strchr(rpt, '}');
if(ept == NULL) {
Mx1_report_error(m, "No closing bracket found for '@command{'", 0);
return(-1);
}
l= ept - rpt - 9;
if((wpt - line_out) + l + 6 + (rpt[9] == '-') > 255)
goto overflow;
strcpy(wpt, "\\fB");
wpt+= 3;
strncpy(wpt, rpt + 9, l);
wpt+= l;
strcpy(wpt, "\\fR");
wpt+= 3;
rpt+= ept - rpt;
} else if(strncmp(rpt, "@minus{}", 8) == 0) {
/* @minus{} will become "-". */
if((wpt - line_out) + 1 > 255)
@ -252,11 +269,13 @@ int Mx1_convert(struct Mx1 *m, char line_in[256], char line_out[256], int flag)
/* @strong{-...} gets mapped to \fB\-...\fR . */
/* @strong{... } gets mapped to \fB...\fR . */
/* @command{... } gets mapped to \fB...\fR . */
/* @minus{} will become "-". */
/* @@ , @{, @} will get stripped of their first @. */
/* "\" becomes "\\" */
if(line_in[0] != '@' ||
strncmp(line_in, "@strong{", 8) == 0 ||
strncmp(line_in, "@command{", 9) == 0 ||
strncmp(line_in, "@minus{}", 8) == 0 ||
strncmp(line_in, "@@", 2) == 0 ||
strncmp(line_in, "@{", 2) == 0 ||

@ -39,9 +39,9 @@ session\-wise manipulation of such filesystems. It can load the management
information of existing ISO images and it writes the session results to
optical media or to filesystem objects.
.br
Vice versa xorriso is able to copy file objects out of ISO 9660 filesystems.
Vice versa \fBxorriso\fR is able to copy file objects out of ISO 9660 filesystems.
.PP
A special property of xorriso is that it needs neither an external ISO 9660
A special property of \fBxorriso\fR is that it needs neither an external ISO 9660
formatter program nor an external burn program for CD, DVD or BD but rather
incorporates the libraries of libburnia\-project.org .
.SS
@ -137,16 +137,16 @@ types. But program growisofs by Andy Polyakov showed how to extend this
functionality to overwriteable media or disk files which carry valid ISO 9660
filesystems.
.PP
xorriso provides growing as well as an own method named
\fBxorriso\fR provides growing as well as an own method named
\fBmodifying\fR which produces a completely new ISO image from the old
one and the modifications.
See paragraph Creating, Growing, Modifying, Blind Growing below.
.PP
xorriso adopts the concept of multi\-session by loading an eventual image
\fBxorriso\fR adopts the concept of multi\-session by loading an eventual image
directory tree, allowing to manipulate it by several actions, and to write
the new image to the target media.
.br
The first session of a xorriso run begins by the definition of the input
The first session of a \fBxorriso\fR run begins by the definition of the input
drive with the eventual ISO image or by the definition of an output drive.
The session ends by command \-commit which triggers writing. A \-commit is
done automatically when the program ends regularly.
@ -170,12 +170,12 @@ describes their existing sessions. See option \fB\-toc\fR.
.br
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.
xorriso will write onto them only if option \-close is set to "on".
\fBxorriso\fR will write onto them only if option \-close is set to "on".
.br
\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
session history. If they contain one or more ISO 9660 sessions and if the
first session was written by xorriso, then a table of content can
first session was written by \fBxorriso\fR, then a table of content can
be emulated. Else only a single overall session will be visible.
.br
DVD\-RW media can be formatted by \-format "full".
@ -188,23 +188,23 @@ These media can assume several states in which they offer different
capabilities.
.br
\fBBlank\fR media can be written from scratch. They contain no ISO image
suitable for xorriso.
suitable for \fBxorriso\fR.
.br
Blank is the state of newly purchased optical media.
With used CD\-RW and DVD\-RW it can be achieved by action \-blank "as_needed".
Overwriteable media are considered blank if they are new or if they have
been marked as blank by xorriso.
been marked as blank by \fBxorriso\fR.
Action \-blank "as_needed" can be used to do this marking on overwriteable
media, or to apply eventual mandatory formatting to new media.
.br
\fBAppendable\fR media accept further sessions. Either they are MMC
multi\-session media in appendable state, or they are overwriteable media
which contain an ISO image suitable for xorriso.
which contain an ISO image suitable for \fBxorriso\fR.
.br
Appendable is the state after writing a session with option \-close off.
.br
\fBClosed\fR media cannot be written. They may contain an ISO image suitable
for xorriso.
for \fBxorriso\fR.
.br
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
@ -264,7 +264,7 @@ to the given block address. This is the usage model of
mkisofs \-M $indev \-C $msc1,$msc2 \-o $outdev
.br
which gives much room for wrong parameter combinations and should thus only be
employed if a strict distinction between ISO formatter xorriso and the burn
employed if a strict distinction between ISO formatter \fBxorriso\fR and the burn
program is desired. \-C $msc1,$msc2 is equivalent to:
.br
\-load sbsector $msc1 \-grow_blindly $msc2
@ -279,7 +279,7 @@ Output drive, i.e. target for writing, can be any libburn drive.
Some drive types do not support the method of growing but only the methods
of modifying and blind growing. They all are suitable for newly created images.
.br
All drive file objects have to offer rw\-permission to the user of xorriso.
All drive file objects have to offer rw\-permission to the user of \fBxorriso\fR.
Even those which will not be useable for reading an ISO image.
.PP
MMC compliant (i.e. optical) drives on GNU/Linux usually get addressed by
@ -366,11 +366,11 @@ is the name of a set of additional information which enhance
an ISO 9660 filesystem so that it can represent a POSIX compliant filesystem
with ownership, access permissions, symbolic links, and other attributes.
.br
This is what xorriso uses for a decent representation of the disk files
within the ISO image. Rock Ridge information is produced with any xorriso
This is what \fBxorriso\fR uses for a decent representation of the disk files
within the ISO image. Rock Ridge information is produced with any \fBxorriso\fR
image.
.PP
xorriso is not named "porriso" because POSIX only guarantees 14 characters
\fBxorriso\fR is not named "porriso" because POSIX only guarantees 14 characters
of filename length. It is the X/Open System Interface standard XSI which
demands a file name length of up to 255 characters and paths of up to 1024
characters. Rock Ridge fulfills this demand.
@ -381,7 +381,7 @@ images, which are binary program files stored in the ISO image.
The content of the boot image files is not in the scope of El Torito.
.br
Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images.
xorriso is able to create or maintain an El Torito object which makes such
\fBxorriso\fR is able to create or maintain an El Torito object which makes such
an image bootable. For details see option \-boot_image.
.br
It is possible to make ISO images bootable from USB stick or other
@ -409,25 +409,25 @@ It uses this extension if enabled by option
.br
AAIP enhanced images are supposed to be mountable normally, but one cannot
expect that the mounted filesystem will show and respect the eventual ACLs.
For now, only xorriso is able to retrieve those ACLs. It can bring them into
For now, only \fBxorriso\fR is able to retrieve those ACLs. It can bring them into
effect when files get restored to an ACL enabled file system or it can
print them in a format suitable for tool setfacl.
.br
Files with ACL show as group permissions the setting of entry "mask::" if
that entry exists. Nevertheless the non\-listed group members get handled
according to entry "group::". xorriso brings "group::" into effect before
according to entry "group::". \fBxorriso\fR brings "group::" into effect before
eventually removing the ACL from a file.
.PP
\fBxattr\fR (aka EA)
are pairs of name and value which can be attached to file objects. AAIP is
able to represent them and xorriso allows to record and restore pairs which
able to represent them and \fBxorriso\fR allows to record and restore pairs which
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.
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
\fB\-xattr\fR.
.br
As with ACL, currently only xorriso is able to retrieve xattr from AAIP
As with ACL, currently only \fBxorriso\fR is able to retrieve xattr from AAIP
enhanced images, to restore them to xattr capable file systems, or to print
them.
.SS
@ -473,9 +473,9 @@ Command and parameter words are either read from program arguments, where one
argument is one word, or from quoted input lines where words are recognized
similar to the quotation rules of a shell parser.
.br
xorriso is not a shell, although it might appear so on first glimpse.
\fBxorriso\fR is not a shell, although it might appear so on first glimpse.
Be aware that the interaction of quotation marks and pattern symbols like "*"
differs from the usual shell parsers. In xorriso, a quotation mark does not
differs from the usual shell parsers. In \fBxorriso\fR, a quotation mark does not
make a pattern symbol literal.
.PP
\fBQuoted input\fR
@ -511,8 +511,8 @@ them as commands with their parameters. It provides assisting services
to make dialog more comfortable.
.PP
Readline is an enhancement for the input line. You may know it already from
the bash shell. Whether it is available in xorriso depends on the availability
of package readline\-dev at the time when xorriso was built from its sourcecode.
the bash shell. Whether it is available in \fBxorriso\fR depends on the availability
of package readline\-dev at the time when \fBxorriso\fR was built from its sourcecode.
.br
It allows to move the cursor over the text in the line by help of the
Leftward and the Rightward arrow key.
@ -527,7 +527,7 @@ Option \-page activates a built\-in result text pager which may be convenient in
dialog. After an action has put out the given number of terminal lines,
the pager prompts the user for a line of input.
.br
An empty line lets xorriso resume work until the next page is put out.
An empty line lets \fBxorriso\fR resume work until the next page is put out.
.br
The single character "@" disables paging for the current action.
.br
@ -602,7 +602,7 @@ predicted_nwa is the block address where the add\-on session of blind
growing will finally end up. It is the responsibility of the user to ensure
this final position and the presence of the older sessions. Else the
overall ISO image will not be mountable or will produce read errors when
accessing file content. xorriso will write the session to the address
accessing file content. \fBxorriso\fR will write the session to the address
as obtained from examining \-outdev and not necessarily to predicted_nwa.
.br
During a run of blind growing, the input drive is given up before output
@ -670,7 +670,7 @@ accepted. If it is not a MMC device then the prefix "stdio:" will be prepended
automatically. This list is empty by default.
.br
Else if the path matches the "banned" list then the drive will not be
accepted by xorriso but rather lead to a FAILURE event. This list is empty by
accepted by \fBxorriso\fR but rather lead to a FAILURE event. This list is empty by
default.
.br
Else if the path matches the "caution" list and if it is not a MMC device,
@ -689,7 +689,7 @@ By pseudo\-class "clear_list" and pseudo\-patterns "banned", "caution",
.br
E.g.: \-drive_class clear_list banned
.br
One will normally define the \-drive_class lists in one of the xorriso
One will normally define the \-drive_class lists in one of the \fBxorriso\fR
Startup Files.
.br
Note: This is not a security feature but rather a bumper for the superuser to
@ -719,7 +719,7 @@ an eventual recorded character set name gets used as input character set
when reading an image.
.br
Note that the default output charset is the local character set of the
terminal where xorriso runs. Before attributing this local character set
terminal where \fBxorriso\fR runs. Before attributing this local character set
to the produced ISO image, check whether the terminal properly displays
all intended filenames, especially exotic national characters.
.TP
@ -746,7 +746,7 @@ e.g. if you need to apply filters to all updated files.
Mode "without_update" avoids hardlink processing during update commands.
Use this if your filesystem situation does not allow \-disk_dev_ino "on".
.br
xorriso commands which extract files from an ISO image try to hardlink files
\fBxorriso\fR commands which extract files from an ISO image try to hardlink files
with identical inode number. The normal scope of this operation is from
image load to image load. One may give up the accumulated hard link addresses
by \-hardlinks "discard_extract".
@ -760,7 +760,7 @@ wide and expensive hardlink accumulation.
.TP
\fB\-acl\fR "on"|"off"
Enable or disable processing of ACLs.
If enabled, then xorriso will obtain ACLs from disk file objects,
If enabled, then \fBxorriso\fR will obtain ACLs from disk file objects,
store ACLs in the ISO image using the libisofs specific AAIP format,
load AAIP data from ISO images, test ACL during file comparison,
and restore ACLs to disk files when extracting them from ISO images.
@ -768,7 +768,7 @@ See also options \-getfacl, \-setfacl.
.TP
\fB\-xattr\fR "on"|"off"
Enable or disable processing of xattr attributes in user namespace.
If enabled, then xorriso 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.
.TP
\fB\-md5\fR "on"|"all"|"off"|"load_check_off"
@ -796,7 +796,7 @@ Mode "load_check_off" together with "on" or "all" will load recorded MD5 sums
but not test the recorded checksum tags of superblock and directory tree.
This is necessary if growisofs was used as burn program, because it does
not overwrite the superblock checksum tag of the first session.
Therefore load_check_off is in effect when xorriso \-as mkisofs option \-M
Therefore load_check_off is in effect when \fBxorriso\fR \-as mkisofs option \-M
is performed.
.br
The test can be re\-enabled by mode "load_check_on".
@ -846,7 +846,7 @@ to invalid addresses and thus ugly drive behavior.
Setting "on" enables that scan for alleged read\-only media.
.br
Some operating systems are not able to mount the most recent session of
multi\-session DVD or BD. If on such a system xorriso has no own MMC
multi\-session DVD or BD. If on such a system \fBxorriso\fR has no own MMC
capabilities then it may still find that session from a scanned table of
content. Setting "force" handles any media like a ROM media with setting "on".
.br
@ -1103,7 +1103,7 @@ arguments.
\fB\-file_size_limit\fR value [value [...]] --
Set the maximum permissible size for a single data file. The values get
summed up for the actual limit. If the only value is "off" then the file
size is not limited by xorriso. Default is a limit of 100 extents, 4g \-2k each:
size is not limited by \fBxorriso\fR. Default is a limit of 100 extents, 4g \-2k each:
.br
\-file_size_limit 400g \-200k \-\-
.br
@ -1112,7 +1112,7 @@ up to 2g \-1 \-\-. Newer ones are good up to 4g \-1 \-\-.
You need quite a new Linux kernel to read correctly the final bytes
of a file >= 4g if its size is not aligned to 2048 byte blocks.
.br
xorriso's own data read capabilities are not affected by eventual
\fBxorriso\fR's own data read capabilities are not affected by eventual
operating system size limits. They apply to mounting only. Nevertheless,
the target filesystem of an \-extract must be able to take the file size.
.TP
@ -1234,7 +1234,7 @@ The number given with "limit=" can curb this workload at the risk of truncating
an intentional sequence of link hops.
.TP
\fB\-pathspecs\fR "on"|"off"
Control parameter interpretation with xorriso actions \-add and \-path_list.
Control parameter interpretation with \fBxorriso\fR actions \-add and \-path_list.
.br
"on" enables pathspecs of the form
\fBtarget=source\fR
@ -1426,7 +1426,7 @@ be an empty text.
Only names from the user namespace are allowed. I.e. a name has to begin with
"user.", like "user.x" or "user.whatever".
.br
Values and names undergo the normal input processing of xorriso.
Values and names undergo the normal input processing of \fBxorriso\fR.
See also option \-backslash_codes. Other than with option \-setfattr_list,
the byte value 0 cannot be expressed via \-setfattr.
.TP
@ -1481,7 +1481,7 @@ Absolute seconds counted from Jan 1 1970:
.br
=Number
.br
xorriso's own timestamps:
\fBxorriso\fR's own timestamps:
.br
YYYY.MM.DD[.hh[mm[ss]]]
.br
@ -1636,7 +1636,7 @@ If \-else is missing and would be hit, then the result is a non\-match.
Default action is \fBecho\fR,
i.e. to print the address of the found file. Other actions are certain
xorriso commands which get performed on the found files. These commands
\fBxorriso\fR commands which get performed on the found files. These commands
may have specific parameters. See also their particular descriptions.
.br
\fBchown\fR and \fBchown_r\fR
@ -1862,8 +1862,8 @@ is not applied to any file in the ISO image.
Irrevocably ban commands \-external_filter and \-unregister_filter,
but not \-set_filter. Use this to prevent external filtering in general or
when all intended filters are registered.
External filters may also be banned totally at compile time of xorriso.
By default they are banned if xorriso runs under setuid permission.
External filters may also be banned totally at compile time of \fBxorriso\fR.
By default they are banned if \fBxorriso\fR runs under setuid permission.
.TP
\fB\-set_filter\fR name iso_rr_path [***]
Apply an \-external_filter or a built\-in filter to the given data files in the
@ -1923,7 +1923,7 @@ Writing can last quite a while. It is not unnormal with several
types of media that there is no progress visible for the first
few minutes or that the drive gnaws on the media for a few
minutes after all data have been transmitted.
xorriso and the drives are in a client\-server relationship.
\fBxorriso\fR and the drives are in a client\-server relationship.
The drives have much freedom about what to do with the media.
Some combinations of drives and media simply do not work,
despite the promises by their vendors.
@ -1963,7 +1963,7 @@ overwriteable ISO images. "all" might work more thoroughly and need more time.
.br
"deformat_quickest" is a faster way to deformat or blank DVD\-RW
but produces media which are only suitable for a single session.
xorriso will write onto them only if option \-close is set to "on".
\fBxorriso\fR will write onto them only if option \-close is set to "on".
.br
The progress reports issued by some drives while blanking are
quite unrealistic. Do not conclude success or failure from the
@ -2139,7 +2139,7 @@ Note: The term "ISO file" means the plain ISO 9660 names and attributes
which get visible if the reader ignores Rock Ridge.
.TP
\fB\-volid\fR text
Specify the volume ID. xorriso accepts any text up to 32 characters,
Specify the volume ID. \fBxorriso\fR accepts any text up to 32 characters,
but according to rarely obeyed specs stricter rules apply:
.br
ECMA 119 demands ASCII characters out of [A\-Z0\-9_]. Like: "IMAGE_23"
@ -2175,7 +2175,7 @@ identify the specification of how the data are recorded.
Permissible are up to 128 characters. This setting gets overridden by
image loading.
.br
The special text "@xorriso@" gets converted to the id string of xorriso
The special text "@xorriso@" gets converted to the id string of \fBxorriso\fR
which is normally written as \-preparer_id. It is a wrong tradition to write
the program id as \-application_id.
.TP
@ -2237,11 +2237,11 @@ image loading.
\fB\-preparer_id\fR
Set the preparer id string to be written with the next \-commit. This may
identify the person or other entity which controls the preparation of the data
which shall be recorded. Normally this should be the id of xorriso and not
of the person or program which operates xorriso. Please avoid to change it.
which shall be recorded. Normally this should be the id of \fBxorriso\fR and not
of the person or program which operates \fBxorriso\fR. Please avoid to change it.
Permissible are up to 128 characters.
.br
The special text "@xorriso@" gets converted to the id string of xorriso
The special text "@xorriso@" gets converted to the id string of \fBxorriso\fR
which is default at program startup.
.br
Unlike other id strings, this setting is not influenced by image loading.
@ -2344,7 +2344,7 @@ Append the given number of extra bytes to the image stream.
This is a traditional remedy for a traditional bug in block
device read drivers. Needed only for CD recordings in TAO mode.
Since one can hardly predict on what media an image might end up,
xorriso adds the traditional 300k of padding by default to all images.
\fBxorriso\fR adds the traditional 300k of padding by default to all images.
.br
For images which will never get to a CD it is safe to use \-padding 0 .
.br
@ -2613,7 +2613,7 @@ Partitions may be appended with boot block type MBR and with SUN Disk Label.
With MBR:
.br
partition_number may be 1 to 4. Number 1 will put the whole ISO image into
the unclaimed space before partition 1. So together with most xorriso MBR
the unclaimed space before partition 1. So together with most \fBxorriso\fR MBR
features, number 2 would be the most natural choice.
.br
The type_code may be "FAT12", "FAT16", "Linux",
@ -2641,13 +2641,13 @@ DVD images; see http://atterer.net/jigdo/ for more details. Debian CDs
and DVD ISO images are published on the web in jigdo format to allow
end users to download them more efficiently."
.br
xorriso can produce a .jigdo and a .template file together with a
\fBxorriso\fR can produce a .jigdo and a .template file together with a
single\-session ISO image.
The .jigdo file contains checksums and symbolic file addresses.
The .template file contains the compressed ISO image with reference tags
instead of the content bytes of the listed files.
.br
Input for this process are the normal arguments for a xorriso session
Input for this process are the normal arguments for a \fBxorriso\fR session
on a blank \-outdev, and a .md5 file which lists those data files which may be
listed in the .jigdo file and externally referenced in the .template file.
Each designated file is represented in the .md5 file by a single text line:
@ -2662,7 +2662,7 @@ After eventual To=From mapping, the file address gets written into the .jigdo
file. Jigdo restore tools will convert these addresses into really
reachable data source addresses from which they can read.
.br
If the list of jigdo parameters is not empty, then xorriso will refuse to
If the list of jigdo parameters is not empty, then \fBxorriso\fR will refuse to
write to non\-blank targets, it will disable multi\-session emulation, and
eventual padding will be counted as part of the ISO image.
.br
@ -2743,7 +2743,7 @@ names. Shell command iconv \-l lists them.
Character sets should not matter as long as only english alphanumeric
characters are used for file names or as long as all writers and readers
of the media use the same character set.
Outside these constraints it may be necessary to let xorriso convert byte
Outside these constraints it may be necessary to let \fBxorriso\fR convert byte
codes.
.br
There is an input conversion from input character set to the local character
@ -2752,14 +2752,14 @@ character set to the output character set is performed when an
image tree gets written. The sets can be defined independently by options
\-in_charset and \-out_charset. Normally one will have both identical, if ever.
.br
If conversions are desired then xorriso needs to know the name of the
local character set. xorriso can inquire the same info as shell command
If conversions are desired then \fBxorriso\fR needs to know the name of the
local character set. \fBxorriso\fR can inquire the same info as shell command
"locale" with argument "charmap". This may be influenced by environment
variables LC_ALL, LC_CTYPE, or LANG and should match the expectations of
the terminal.
.br
The default output charset is the local character set of the terminal where
xorriso runs. So by default no conversion happens between local filesystem
\fBxorriso\fR runs. So by default no conversion happens between local filesystem
names and emerging names in the image. The situation stays ambigous and the
reader has to riddle what character set was used.
.br
@ -2786,8 +2786,8 @@ If this appears necessary, one should consider to set \-backslash_codes to
.TP
.B Exception processing:
.PP
Since the tasks of xorriso are manifold and prone to external influence, there
may arise the need for xorriso to report and handle problem events.
Since the tasks of \fBxorriso\fR are manifold and prone to external influence, there
may arise the need for \fBxorriso\fR to report and handle problem events.
.br
Those events get classified when they are detected by one of the software
modules and forwarded to reporting and evaluation modules which decide about
@ -2829,24 +2829,24 @@ be ignorable.
.br
A special property of this option is that it works preemptive if given as
program start argument. I.e. the first \-abort_on setting among the
start arguments is in effect already when the first operations of xorriso
start arguments is in effect already when the first operations of \fBxorriso\fR
begin. Only "\-abort_on" with dash "\-" is recognized that way.
.TP
\fB\-return_with\fR severity exit_value
Set the threshold and exit_value to be returned at program end if no abort
has happened. This is to allow xorriso to go on after problems but to get
has happened. This is to allow \fBxorriso\fR to go on after problems but to get
a failure indicating exit value from the program, nevertheless.
Useful is a value lower than the \-abort_on threshold, down to "WARNING".
.br
exit_value may be either 0 (indicating success to the starter of the program)
or a number between 32 and 63. Some other exit_values are used by xorriso if
or a number between 32 and 63. Some other exit_values are used by \fBxorriso\fR if
it decides to abort the program run:
.br
1=abort due to external signal
.br
2=no program arguments given
.br
3=creation of xorriso main object failed
3=creation of \fBxorriso\fR main object failed
.br
4=failure to start libburnia\-project.org libraries
.br
@ -2868,7 +2868,7 @@ Info messages which belong to no event get attributed severity "NOTE".
.br
A special property of this option is that the first \-report_about setting
among the start arguments is in effect already when the first operations
of xorriso begin. Only "\-report_about" with dash "\-" is recognized that way.
of \fBxorriso\fR begin. Only "\-report_about" with dash "\-" is recognized that way.
.TP
\fB\-signal_handling\fR mode
Control the installation of a signal handler which shall react on external
@ -2877,10 +2877,10 @@ caused by severe program errors.
.br
Mode "on" is the default. It uses the signal handler of libburn which produces
ugly messages but puts much effort in releasing eventually used optical drives
before xorriso ends.
before \fBxorriso\fR ends.
.br
Mode "off" as first \-signal_handling among the start arguments prevents all
own signal precautions of xorriso. Eventually inherited signal handler settings
own signal precautions of \fBxorriso\fR. Eventually inherited signal handler settings
stay as they are.
.br
It works like "sig_dfl" if given after other signal handling was already
@ -2891,14 +2891,14 @@ normally a sudden abort of the program. To prevent stuck drives, the
libburn handler is used during burning, blanking, and formatting on MMC drives.
.br
Mode "sig_ign" tries to ignore as many signal types as possible. This imposes
the risk that xorriso refuses to end until externally kill \-9 if performed.
the risk that \fBxorriso\fR refuses to end until externally kill \-9 if performed.
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
wait for at least their normal run time before killing externally.
.br
A special property of this option is that the first \-signal_handling setting
among the start arguments is in effect already when the first operations
of xorriso begin. Only "\-signal_handling" with dash "\-" is recognized that way.
of \fBxorriso\fR begin. Only "\-signal_handling" with dash "\-" is recognized that way.
.TP
\fB\-error_behavior\fR occasion behavior
Control the program behavior at problem event occasions.
@ -3012,7 +3012,7 @@ not the ISO image directory tree.
.br
In case of overwriteable media holding a valid ISO image, it may happen that
only a single session gets shown. But if the first session on the
overwriteable media was written by xorriso then a complete
overwriteable media was written by \fBxorriso\fR then a complete
session history can be emulated.
.br
A drive which is incapable of writing may show any media as CD\-ROM or DVD\-ROM
@ -3044,7 +3044,7 @@ for direct execution of this command.
\fB\-mount_opts\fR option[:option...]
Set options which influence \-mount and \-mount_cmd. Currently there is only
option "exclusive" which is default and its counterpart "shared". The latter
causes xorriso not to give up the affected drive with command \-mount.
causes \fBxorriso\fR not to give up the affected drive with command \-mount.
On GNU/Linux it adds mount option "loop" which may allow to mount several
sessions of the same block device at the same time. One should not write
to a mounted optical media, of course. Take care to umount all sessions
@ -3057,7 +3057,7 @@ format and the parameters of the addressed session.
Formats "linux:"path or "freebsd:"path produce the output of \-mount_cmd
for the given operating systems.
.br
In other texts xorriso will substitute the following parameter names.
In other texts \fBxorriso\fR will substitute the following parameter names.
An optional prefix "string:" will be removed.
.br
"%device%" will be substituted by the mountable device path of the drive
@ -3289,7 +3289,7 @@ and based on extra data on the media. If a drive returns data then one can
quite trust that they are valid. But at some degree of read problems the
correction will fail and the drive is supposed to indicate error.
.br
xorriso can scan the media for readable data blocks, classify them according
\fBxorriso\fR can scan the media for readable data blocks, classify them according
to their read speed, save them to a file, and keep track of successfuly saved
blocks for further tries on the same media.
.br
@ -3379,7 +3379,7 @@ gives the path of the file which may abort a scan run. Abort
happens if the file exists and its mtime is not older than the start time
of the run. Use shell command "touch" to trigger this.
Other than an aborted program run, this will report the tested and untested
blocks and go on with running xorriso.
blocks and go on with running \fBxorriso\fR.
.br
\fBtime_limit=seconds\fR
gives the number of seconds after which the scan shall be
@ -3422,7 +3422,7 @@ when it gets mounted or loaded as stdio: drive. But it usually makes
the original session 1 inaccessible.
.br
\fBpatch_lba0="force"\fR
performs patch_lba0="on" even if xorriso believes
performs patch_lba0="on" even if \fBxorriso\fR believes
that the copied data are not valid.
.br
patch_lba0= may also bear a number. If it is 32 or higher it is taken as
@ -3463,7 +3463,7 @@ Only mismatching data files will be reported.
.TP
.B osirrox ISO-to-disk restore options:
.PP
Normally xorriso 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.
But its alter ego osirrox is able to extract file objects
from ISO images and to create, overwrite, or delete file objects on disk.
@ -3500,7 +3500,7 @@ handled like any other ISO image directory.
.br
Option "auto_chmod_off" is default. If "auto_chmod_on" is set then access
restrictions for disk directories get circumvented if those directories
are owned by the effective user who runs xorriso. This happens by temporarily
are owned by the effective user who runs \fBxorriso\fR. This happens by temporarily
granting rwx permission to the owner.
.br
Option "sort_lba_on" may improve read performance with optical drives. It
@ -3596,7 +3596,7 @@ reachable as /bin/mount or /sbin/mount.
.PP
Writing of ISO 9660 on CD is traditionally done by program mkisofs
as ISO 9660 image producer and cdrecord as burn program.
xorriso does not strive for their comprehensive emulation.
\fBxorriso\fR does not strive for their comprehensive emulation.
Nevertheless it is ready to perform some of its core tasks under control
of commands which in said programs trigger comparable actions.
.TP
@ -3621,16 +3621,16 @@ emulation. Some are ignored, but better do not rely on this tolerance.
.br
The supported options are documented in detail in xorrisofs.info
and in man xorrisofs. The description here is focused on the effect
of mkisofs emulation in the context of a xorriso run.
of mkisofs emulation in the context of a \fBxorriso\fR run.
.br
Other than with the "cdrecord" personality there is no automatic \-commit at
the end of a "mkisofs" option list. Verbosity settings \-v (= "UPDATE") and
\-quiet (= "SORRY") persist. The output file, eventually chosen with \-o,
persists until things happen like \-commit, \-rollback, \-dev, or end of xorriso.
persists until things happen like \-commit, \-rollback, \-dev, or end of \fBxorriso\fR.
\-pacifier gets set to "mkisofs" if files are added to the image.
.br
\-graft\-points is equivalent to \-pathspecs on. Note that pathspecs without "="
are interpreted differently than with xorriso option \-add. Directories get
are interpreted differently than with \fBxorriso\fR option \-add. Directories get
merged with the root directory of the ISO image, other filetypes get mapped
into that root directory.
.br
@ -3638,7 +3638,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.
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
is chosen by xorriso options before \-as mkisofs or after its list delimiter.
is chosen by \fBxorriso\fR options before \-as mkisofs or after its list delimiter.
Directories and symbolic links are no valid \-o targets.
.br
Writing to stdout is possible only if \-as "mkisofs" was among the start
@ -3656,7 +3656,7 @@ directory is added to the image. At the same occasion directory names get
allowed to violate the standard by \-compliance option allow_dir_id_ext.
This may be avoided by option \-disallow_dir_id_ext.
.br
Option \-root is supported. Option \-old\-root is implemented by xorriso
Option \-root is supported. Option \-old\-root is implemented by \fBxorriso\fR
commands \-mkdir, \-cp_clone, \-find update_merge, and \-find rm_merge.
\-root and \-old\-root set command \-disk_dev_ino to "ino_only" and \-md5 to "on",
by default.
@ -3667,7 +3667,7 @@ resp. to "on" by \-\-old\-root\-devno .
Not original mkisofs options are \-\-quoted_path_list ,
\-\-hardlinks , \-\-acl ,
\-\-xattr , \-\-md5 , \-\-stdio_sync .
They work like the xorriso options with the
They work like the \fBxorriso\fR options with the
same name and hardcoded argument "on", e.g. \-acl "on".
Explicit arguments are expected by \-\-stdio_sync
and \-\-scdbackup_tag.
@ -3712,19 +3712,19 @@ Option \-append_partition is supported.
\-\-old\-empty is \-compliance old_empty.
.br
The options of genisoimage Jigdo Template Extraction are recognized and
performed via xorriso option \-jigdo. See the "Alias:" names there for the
performed via \fBxorriso\fR option \-jigdo. See the "Alias:" names there for the
meaning of the genisoimage options.
.br
Personalities "\fBxorrisofs\fR", "\fBgenisoimage\fR",
and "\fBgenisofs\fR" are aliases for "mkisofs".
.br
If xorriso is started with one of the leafnames "xorrisofs", "genisofs",
If \fBxorriso\fR is started with one of the leafnames "xorrisofs", "genisofs",
"mkisofs", or "genisoimage", then it performs \-read_mkisofsrc and prepends
\-as "genisofs" to the command line arguments.
I.e. all arguments will be interpreted mkisofs style until "\-\-"
is encountered.
From then on, options are interpreted as xorriso options.
From then on, options are interpreted as \fBxorriso\fR options.
.br
\-\-no_rc as first argument of such a program start
prevents interpretation of startup files. See section FILES below.
@ -3740,7 +3740,7 @@ write_start_address=,
track source file path or "\-" for standard input as track source.
.br
It ignores most other options of cdrecord and cdrskin but refuses on
\-audio, \-scanbus, and on blanking modes unknown to xorriso.
\-audio, \-scanbus, and on blanking modes unknown to \fBxorriso\fR.
.br
The scope is only a single data track per session to be written
to blank, overwriteable, or appendable media. The media gets closed if
@ -3749,7 +3749,7 @@ closing is applicable and not option \-multi is present.
An eventually acquired input drive is given up.
This is only allowed if no image changes are pending.
.br
dev= must be given as xorriso device address. Addresses like 0,0,0 or ATA:1,1,0
dev= must be given as \fBxorriso\fR device address. Addresses like 0,0,0 or ATA:1,1,0
are not supported.
.br
If a track source is given, then an automatic \-commit happens at the end of
@ -3766,14 +3766,14 @@ A much more elaborate libburn based cdrecord emulator is the program cdrskin.
Personalites "\fBxorrecord\fR", "\fBwodim\fR", and "\fBcdrskin\fR"
are aliases for "cdrecord".
.br
If xorriso is started with one of the leafnames "xorrecord", "cdrskin",
If \fBxorriso\fR is started with one of the leafnames "xorrecord", "cdrskin",
"cdrecord", or "wodim", then it automatically prepends \-as "cdrskin"
to the command line arguments. I.e. all arguments will be interpreted cdrecord
style until "\-\-" is encountered and an eventual commit happens.
From then on, options are interpreted as xorriso options.
From then on, options are interpreted as \fBxorriso\fR options.
.br
\-\-no_rc as first argument of such a program start
prevents interpretation of xorriso startup files. See section FILES below.
prevents interpretation of \fBxorriso\fR startup files. See section FILES below.
.TP
\fB\-read_mkisofsrc\fR
Try one by one to open for reading:
@ -3828,7 +3828,7 @@ files. See section FILES below.
\fB\-options_from_file\fR fileaddress
Read quoted input from fileaddress and execute it like dialog lines.
Empty lines and lines which begin by # are ignored. Normally one line
should hold one xorriso command and all its arguments. Nevertheless lines
should hold one \fBxorriso\fR command and all its arguments. Nevertheless lines
may be concatenated by a trailing backslash.
.br
See also section "Command processing", paragraph "Quoted input".
@ -3844,7 +3844,7 @@ Print program name and version, component versions, license.
Copy textline into libreadline history.
.TP
\fB\-status\fR mode|filter
Print the current settings of xorriso.
Print the current settings of \fBxorriso\fR.
Modes:
.br
short... print only important or altered settings
@ -3960,12 +3960,12 @@ The first three items are single words, the rest of the line is the volume id.
.TP
\fB\-scsi_log\fR "on"|"off"
Mode "on" enables very verbous logging of SCSI commands and drive replies.
Logging messages get printed to stderr, not to any of the xorriso output
Logging messages get printed to stderr, not to any of the \fBxorriso\fR output
channels.
.br
A special property of this option is that the first \-scsi_log setting
among the start arguments is in effect already when the first operations
of xorriso begin. Only "\-scsi_log" with dash "\-" is recognized that way.
of \fBxorriso\fR begin. Only "\-scsi_log" with dash "\-" is recognized that way.
.TP
\fB\-end\fR
.br
@ -4005,8 +4005,8 @@ Copy output of a channel to the given file. Channel may be one of: "." for all
channels, "I" for info messages, "R" for result lines, "M" for \-mark texts.
.TP
\fB\-mark\fR text
If text is not empty it will get put out on "M" channel each time xorriso
is ready for the next dialog line or before xorriso performs a command that
If text is not empty it will get put out on "M" channel each time \fBxorriso\fR
is ready for the next dialog line or before \fBxorriso\fR performs a command that
was entered to the pager prompt.
.TP
\fB\-prog\fR text
@ -4052,8 +4052,8 @@ Try to retrieve blocks from a damaged media
.SS
.B As superuser learn about available drives
On Linux or FreeBSD consider to give rw\-permissions to those users or groups
which shall be able to use the drives with xorriso.
On Solaris use pfexec. Consider to restrict privileges of xorriso to
which shall be able to use the drives with \fBxorriso\fR.
On Solaris use pfexec. Consider to restrict privileges of \fBxorriso\fR to
"base,sys_devices" and to give r\-permission to user or group.
.br
$ xorriso \-devices
@ -4216,7 +4216,7 @@ $ xorriso \-indev /dev/sr2 \\
.B Bring a prepared ISOLINUX tree onto media and make it bootable
The user has already created a suitable file tree on disk and copied the
ISOLINUX files into subdirectory ./boot/isolinux of that tree.
Now xorriso can burn an El Torito bootable media:
Now \fBxorriso\fR can burn an El Torito bootable media:
.br
$ xorriso \-outdev /dev/sr0 \-blank as_needed \\
.br
@ -4249,9 +4249,9 @@ Paths underneath /dev normally need prefix "stdio:"
$ xorriso \-dev stdio:/dev/sdb ...
.br
If /dev/sdb is to be used frequently and /dev/sda is the system disk,
then consider to place the following lines in a xorriso Startup File.
then consider to place the following lines in a \fBxorriso\fR Startup File.
They allow to use /dev/sdb without prefix and protect disk /dev/sda
from xorriso:
from \fBxorriso\fR:
.br
\-drive_class banned /dev/sda*
.br
@ -4300,7 +4300,7 @@ of the changed content before it loads the media again.
In this case the previous session would not be loaded and the
new session would contain only the newly added files.
.br
For the same reason do not let xorriso \-as cdrecord load the media,
For the same reason do not let \fBxorriso\fR \-as cdrecord load the media,
but rather do this manually or by a program that reads from /dev/sr0.
.br
This example works for multi\-session media only.
@ -4310,7 +4310,7 @@ in order to enable multi\-session emulation on overwriteable media.
.SS
.B Let xorriso work underneath growisofs
growisofs expects an ISO formatter program which understands options \-C and
\-M. If xorriso gets started by name "xorrisofs" then it is suitable for that.
\-M. If \fBxorriso\fR gets started by name "xorrisofs" then it is suitable for that.
.br
$ export MKISOFS="xorrisofs"
.br
@ -4319,14 +4319,14 @@ $ growisofs \-Z /dev/dvd /some/files
$ growisofs \-M /dev/dvd /more/files
.br
If no "xorrisofs" is available on your system, then you will have to create
a link pointing to the xorriso binary and tell growisofs to use it. E.g. by:
a link pointing to the \fBxorriso\fR binary and tell growisofs to use it. E.g. by:
.br
$ ln \-s $(which xorriso) "$HOME/xorrisofs"
.br
$ export MKISOFS="$HOME/xorrisofs"
.br
One may quit mkisofs emulation by argument "\-\-" and make
use of all xorriso commands. growisofs dislikes options which
use of all \fBxorriso\fR commands. growisofs dislikes options which
start with "\-o" but \-outdev must be set to "\-".
So use "outdev" instead:
.br
@ -4439,8 +4439,8 @@ it is possible to access the session trees which represent the older backup
versions. With CD media, GNU/Linux mount accepts session numbers directly by
its option "session=".
.br
Multi\-session media and most overwriteable media written by xorriso can tell
the sbsectors of their sessions by xorriso option \-toc.
Multi\-session media and most overwriteable media written by \fBxorriso\fR can tell
the sbsectors of their sessions by \fBxorriso\fR option \-toc.
Used after \-commit the following option prints the matching mount command for
the newly written session (here for mount point /mnt):
.br
@ -4527,12 +4527,12 @@ resp. \-s.
.SS
.B Program alias names:
.br
Normal installation of xorriso creates three links or copies which by their
Normal installation of \fBxorriso\fR creates three links or copies which by their
program name pre\-select certain settings:
.br
\fBxorrisofs\fR starts xorriso with \-as mkisofs emulation.
\fBxorrisofs\fR starts \fBxorriso\fR with \-as mkisofs emulation.
.br
\fBxorrecord\fR starts xorriso with \-as cdrecord emulation.
\fBxorrecord\fR starts \fBxorriso\fR with \-as cdrecord emulation.
.br
\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
@ -4540,7 +4540,7 @@ one or more of the existing ISO sessions.
.SS
.B Startup files:
.br
If not \-no_rc is given as the first argument then xorriso attempts on startup
If not \-no_rc is given as the first argument then \fBxorriso\fR attempts on startup
to read and execute lines from the following files:
.br
/etc/default/xorriso
@ -4601,11 +4601,11 @@ for libburnia\-project.org
Copyright (c) 2007 \- 2011 Thomas Schmitt
.br
Permission is granted to distribute this text freely. It shall only be
modified in sync with the technical properties of xorriso. If you make use
of the license to derive modified versions of xorriso then you are entitled
modified in sync with the technical properties of \fBxorriso\fR. If you make use
of the license to derive modified versions of \fBxorriso\fR then you are entitled
to modify this text under that same license.
.SH CREDITS
xorriso is in part based on work by Vreixo Formoso who provides libisofs
\fBxorriso\fR is in part based on work by Vreixo Formoso who provides libisofs
together with Mario Danic who also leads the libburnia team.
Thanks to Andy Polyakov who invented emulated growing,
to Derek Foreman and Ben Jansens who once founded libburn.

File diff suppressed because it is too large Load Diff

@ -27,6 +27,7 @@
@c "@item word words" becomes "\fBword\fR words".
@c @strong{-...} gets mapped to \fB\-...\fR .
@c @strong{...} gets mapped to \fB...\fR .
@c @command{...} gets mapped to \fB...\fR .
@c @minus{} will become "-".
@c @@ , @{, @} will get stripped of their first @.
@c Other lines which begin by "@" will be discarded.
@ -114,17 +115,17 @@ with Rock Ridge extensions.
@c man .br
@c man .SH DESCRIPTION
@c man .PP
@strong{xorriso}
@command{xorriso}
is a program which copies file objects from POSIX compliant
filesystems into Rock Ridge enhanced ISO 9660 filesystems and allows
session-wise manipulation of such filesystems. It can load the management
information of existing ISO images and it writes the session results to
optical media or to filesystem objects.
@*
Vice versa xorriso is able to copy file objects out of ISO 9660 filesystems.
Vice versa @command{xorriso} is able to copy file objects out of ISO 9660 filesystems.
@c man .PP
@sp 1
A special property of xorriso is that it needs neither an external ISO 9660
A special property of @command{xorriso} is that it needs neither an external ISO 9660
formatter program nor an external burn program for CD, DVD or BD but rather
incorporates the libraries of libburnia-project.org .
@c man .SS
@ -229,17 +230,17 @@ functionality to overwriteable media or disk files which carry valid ISO 9660
filesystems.
@c man .PP
@sp 1
xorriso provides growing as well as an own method named
@command{xorriso} provides growing as well as an own method named
@strong{modifying} which produces a completely new ISO image from the old
one and the modifications.
See paragraph Creating, Growing, Modifying, Blind Growing below.
@c man .PP
@sp 1
xorriso adopts the concept of multi-session by loading an eventual image
@command{xorriso} adopts the concept of multi-session by loading an eventual image
directory tree, allowing to manipulate it by several actions, and to write
the new image to the target media.
@c man .br
The first session of a xorriso run begins by the definition of the input
The first session of a @command{xorriso} run begins by the definition of the input
drive with the eventual ISO image or by the definition of an output drive.
The session ends by command -commit which triggers writing. A -commit is
done automatically when the program ends regularly.
@ -268,13 +269,13 @@ describes their existing sessions. See option @strong{-toc}.
@*
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.
xorriso will write onto them only if option -close is set to "on".
@command{xorriso} will write onto them only if option -close is set to "on".
@*
@cindex Overwriteable media, _definition
@strong{Overwriteable media} are DVD-RAM, DVD+RW, BD-RE, and formatted DVD-RW.
They allow random write access but do not provide information about their
session history. If they contain one or more ISO 9660 sessions and if the
first session was written by xorriso, then a table of content can
first session was written by @command{xorriso}, then a table of content can
be emulated. Else only a single overall session will be visible.
@*
DVD-RW media can be formatted by -format "full".
@ -290,12 +291,12 @@ capabilities.
@sp 1
@cindex Blank media, _definition
@strong{Blank} media can be written from scratch. They contain no ISO image
suitable for xorriso.
suitable for @command{xorriso}.
@*
Blank is the state of newly purchased optical media.
With used CD-RW and DVD-RW it can be achieved by action -blank "as_needed".
Overwriteable media are considered blank if they are new or if they have
been marked as blank by xorriso.
been marked as blank by @command{xorriso}.
Action -blank "as_needed" can be used to do this marking on overwriteable
media, or to apply eventual mandatory formatting to new media.
@*
@ -303,14 +304,14 @@ media, or to apply eventual mandatory formatting to new media.
@cindex Appendable media, _definition
@strong{Appendable} media accept further sessions. Either they are MMC
multi-session media in appendable state, or they are overwriteable media
which contain an ISO image suitable for xorriso.
which contain an ISO image suitable for @command{xorriso}.
@*
Appendable is the state after writing a session with option -close off.
@*
@sp 1
@cindex Closed media, _definition
@strong{Closed} media cannot be written. They may contain an ISO image suitable
for xorriso.
for @command{xorriso}.
@*
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
@ -380,7 +381,7 @@ to the given block address. This is the usage model of
mkisofs -M $indev -C $msc1,$msc2 -o $outdev
@*
which gives much room for wrong parameter combinations and should thus only be
employed if a strict distinction between ISO formatter xorriso and the burn
employed if a strict distinction between ISO formatter @command{xorriso} and the burn
program is desired. -C $msc1,$msc2 is equivalent to:
@*
-load sbsector $msc1 -grow_blindly $msc2
@ -399,7 +400,7 @@ Output drive, i.e. target for writing, can be any libburn drive.
Some drive types do not support the method of growing but only the methods
of modifying and blind growing. They all are suitable for newly created images.
@*
All drive file objects have to offer rw-permission to the user of xorriso.
All drive file objects have to offer rw-permission to the user of @command{xorriso}.
Even those which will not be useable for reading an ISO image.
@c man .PP
@sp 1
@ -493,12 +494,12 @@ is the name of a set of additional information which enhance
an ISO 9660 filesystem so that it can represent a POSIX compliant filesystem
with ownership, access permissions, symbolic links, and other attributes.
@*
This is what xorriso uses for a decent representation of the disk files
within the ISO image. Rock Ridge information is produced with any xorriso
This is what @command{xorriso} uses for a decent representation of the disk files
within the ISO image. Rock Ridge information is produced with any @command{xorriso}
image.
@c man .PP
@sp 1
xorriso is not named "porriso" because POSIX only guarantees 14 characters
@command{xorriso} is not named "porriso" because POSIX only guarantees 14 characters
of filename length. It is the X/Open System Interface standard XSI which
demands a file name length of up to 255 characters and paths of up to 1024
characters. Rock Ridge fulfills this demand.
@ -511,7 +512,7 @@ images, which are binary program files stored in the ISO image.
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.
xorriso is able to create or maintain an El Torito object which makes such
@command{xorriso} is able to create or maintain an El Torito object which makes such
an image bootable. For details see option -boot_image.
@*
@cindex MBR, _definiton
@ -542,27 +543,27 @@ It uses this extension if enabled by option
@*
AAIP enhanced images are supposed to be mountable normally, but one cannot
expect that the mounted filesystem will show and respect the eventual ACLs.
For now, only xorriso is able to retrieve those ACLs. It can bring them into
For now, only @command{xorriso} is able to retrieve those ACLs. It can bring them into
effect when files get restored to an ACL enabled file system or it can
print them in a format suitable for tool setfacl.
@*
Files with ACL show as group permissions the setting of entry "mask::" if
that entry exists. Nevertheless the non-listed group members get handled
according to entry "group::". xorriso brings "group::" into effect before
according to entry "group::". @command{xorriso} brings "group::" into effect before
eventually removing the ACL from a file.
@c man .PP
@sp 1
@cindex xattr, _definiton
@strong{xattr} (aka EA)
are pairs of name and value which can be attached to file objects. AAIP is
able to represent them and xorriso allows to record and restore pairs which
able to represent them and @command{xorriso} allows to record and restore pairs which
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.
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
@strong{-xattr}.
@*
As with ACL, currently only xorriso is able to retrieve xattr from AAIP
As with ACL, currently only @command{xorriso} is able to retrieve xattr from AAIP
enhanced images, to restore them to xattr capable file systems, or to print
them.
@c man .SS
@ -615,9 +616,9 @@ Command and parameter words are either read from program arguments, where one
argument is one word, or from quoted input lines where words are recognized
similar to the quotation rules of a shell parser.
@*
xorriso is not a shell, although it might appear so on first glimpse.
@command{xorriso} is not a shell, although it might appear so on first glimpse.
Be aware that the interaction of quotation marks and pattern symbols like "*"
differs from the usual shell parsers. In xorriso, a quotation mark does not
differs from the usual shell parsers. In @command{xorriso}, a quotation mark does not
make a pattern symbol literal.
@c man .PP
@sp 1
@ -661,8 +662,8 @@ to make dialog more comfortable.
@c man .PP
@sp 1
Readline is an enhancement for the input line. You may know it already from
the bash shell. Whether it is available in xorriso depends on the availability
of package readline-dev at the time when xorriso was built from its sourcecode.
the bash shell. Whether it is available in @command{xorriso} depends on the availability
of package readline-dev at the time when @command{xorriso} was built from its sourcecode.
@*
It allows to move the cursor over the text in the line by help of the
Leftward and the Rightward arrow key.
@ -680,7 +681,7 @@ Option -page activates a built-in result text pager which may be convenient in
dialog. After an action has put out the given number of terminal lines,
the pager prompts the user for a line of input.
@*
An empty line lets xorriso resume work until the next page is put out.
An empty line lets @command{xorriso} resume work until the next page is put out.
@*
The single character "@@" disables paging for the current action.
@*
@ -793,7 +794,7 @@ predicted_nwa is the block address where the add-on session of blind
growing will finally end up. It is the responsibility of the user to ensure
this final position and the presence of the older sessions. Else the
overall ISO image will not be mountable or will produce read errors when
accessing file content. xorriso will write the session to the address
accessing file content. @command{xorriso} will write the session to the address
as obtained from examining -outdev and not necessarily to predicted_nwa.
@*
During a run of blind growing, the input drive is given up before output
@ -872,7 +873,7 @@ accepted. If it is not a MMC device then the prefix "stdio:" will be prepended
automatically. This list is empty by default.
@*
Else if the path matches the "banned" list then the drive will not be
accepted by xorriso but rather lead to a FAILURE event. This list is empty by
accepted by @command{xorriso} but rather lead to a FAILURE event. This list is empty by
default.
@*
Else if the path matches the "caution" list and if it is not a MMC device,
@ -891,7 +892,7 @@ By pseudo-class "clear_list" and pseudo-patterns "banned", "caution",
@*
E.g.: -drive_class clear_list banned
@*
One will normally define the -drive_class lists in one of the xorriso
One will normally define the -drive_class lists in one of the @command{xorriso}
Startup Files.
@*
Note: This is not a security feature but rather a bumper for the superuser to
@ -927,7 +928,7 @@ an eventual recorded character set name gets used as input character set
when reading an image.
@*
Note that the default output charset is the local character set of the
terminal where xorriso runs. Before attributing this local character set
terminal where @command{xorriso} runs. Before attributing this local character set
to the produced ISO image, check whether the terminal properly displays
all intended filenames, especially exotic national characters.
@c man .TP
@ -956,7 +957,7 @@ e.g. if you need to apply filters to all updated files.
Mode "without_update" avoids hardlink processing during update commands.
Use this if your filesystem situation does not allow -disk_dev_ino "on".
@*
xorriso commands which extract files from an ISO image try to hardlink files
@command{xorriso} commands which extract files from an ISO image try to hardlink files
with identical inode number. The normal scope of this operation is from
image load to image load. One may give up the accumulated hard link addresses
by -hardlinks "discard_extract".
@ -972,7 +973,7 @@ wide and expensive hardlink accumulation.
@kindex -acl controls handling of ACLs
@cindex ACL, control handling, -acl
Enable or disable processing of ACLs.
If enabled, then xorriso will obtain ACLs from disk file objects,
If enabled, then @command{xorriso} will obtain ACLs from disk file objects,
store ACLs in the ISO image using the libisofs specific AAIP format,
load AAIP data from ISO images, test ACL during file comparison,
and restore ACLs to disk files when extracting them from ISO images.
@ -982,7 +983,7 @@ See also options -getfacl, -setfacl.
@kindex -xattr controls handling of xattr (EA)
@cindex xattr, control handling, -xattr
Enable or disable processing of xattr attributes in user namespace.
If enabled, then 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.
@c man .TP
@item -md5 "on"|"all"|"off"|"load_check_off"
@ -1012,7 +1013,7 @@ Mode "load_check_off" together with "on" or "all" will load recorded MD5 sums
but not test the recorded checksum tags of superblock and directory tree.
This is necessary if growisofs was used as burn program, because it does
not overwrite the superblock checksum tag of the first session.
Therefore load_check_off is in effect when xorriso -as mkisofs option -M
Therefore load_check_off is in effect when @command{xorriso} -as mkisofs option -M
is performed.
@*
The test can be re-enabled by mode "load_check_on".
@ -1068,7 +1069,7 @@ to invalid addresses and thus ugly drive behavior.
Setting "on" enables that scan for alleged read-only media.
@*
Some operating systems are not able to mount the most recent session of
multi-session DVD or BD. If on such a system xorriso has no own MMC
multi-session DVD or BD. If on such a system @command{xorriso} has no own MMC
capabilities then it may still find that session from a scanned table of
content. Setting "force" handles any media like a ROM media with setting "on".
@*
@ -1379,7 +1380,7 @@ arguments.
@cindex Insert, limit data file size, -file_size_limit
Set the maximum permissible size for a single data file. The values get
summed up for the actual limit. If the only value is "off" then the file
size is not limited by xorriso. Default is a limit of 100 extents, 4g -2k each:
size is not limited by @command{xorriso}. Default is a limit of 100 extents, 4g -2k each:
@*
-file_size_limit 400g -200k @minus{}@minus{}
@*
@ -1388,7 +1389,7 @@ up to 2g -1 @minus{}@minus{}. Newer ones are good up to 4g -1 @minus{}@minus{}.
You need quite a new Linux kernel to read correctly the final bytes
of a file >= 4g if its size is not aligned to 2048 byte blocks.
@*
xorriso's own data read capabilities are not affected by eventual
@command{xorriso}'s own data read capabilities are not affected by eventual
operating system size limits. They apply to mounting only. Nevertheless,
the target filesystem of an -extract must be able to take the file size.
@c man .TP
@ -1525,7 +1526,7 @@ an intentional sequence of link hops.
@item -pathspecs "on"|"off"
@kindex -pathspecs sets meaning of = with -add
@cindex Insert, meaning of = with -add, -pathspecs
Control parameter interpretation with xorriso actions -add and -path_list.
Control parameter interpretation with @command{xorriso} actions -add and -path_list.
@*
@cindex Pathspec, _definition
"on" enables pathspecs of the form
@ -1758,7 +1759,7 @@ be an empty text.
Only names from the user namespace are allowed. I.e. a name has to begin with
"user.", like "user.x" or "user.whatever".
@*
Values and names undergo the normal input processing of xorriso.
Values and names undergo the normal input processing of @command{xorriso}.
See also option -backslash_codes. Other than with option -setfattr_list,
the byte value 0 cannot be expressed via -setfattr.
@c man .TP
@ -1819,7 +1820,7 @@ Absolute seconds counted from Jan 1 1970:
@*
=Number
@*
xorriso's own timestamps:
@command{xorriso}'s own timestamps:
@*
YYYY.MM.DD[.hh[mm[ss]]]
@*
@ -1994,7 +1995,7 @@ If -else is missing and would be hit, then the result is a non-match.
Default action is @strong{echo},
i.e. to print the address of the found file. Other actions are certain
xorriso commands which get performed on the found files. These commands
@command{xorriso} commands which get performed on the found files. These commands
may have specific parameters. See also their particular descriptions.
@c man .br
@table @asis
@ -2244,8 +2245,8 @@ is not applied to any file in the ISO image.
Irrevocably ban commands -external_filter and -unregister_filter,
but not -set_filter. Use this to prevent external filtering in general or
when all intended filters are registered.
External filters may also be banned totally at compile time of xorriso.
By default they are banned if xorriso runs under setuid permission.
External filters may also be banned totally at compile time of @command{xorriso}.
By default they are banned if @command{xorriso} runs under setuid permission.
@c man .TP
@item -set_filter name iso_r