1505 lines
52 KiB
Groff
1505 lines
52 KiB
Groff
.\" Hey, EMACS: -*- nroff -*-
|
|
.\"
|
|
.\" IMPORTANT NOTE:
|
|
.\"
|
|
.\" The original of this file is kept in xorriso/xorrisofs.texi
|
|
.\" This here was generated by program xorriso/make_xorriso_1
|
|
.\"
|
|
.\"
|
|
.\" First parameter, NAME, should be all caps
|
|
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
|
|
.\" other parameters are allowed: see man(7), man(1)
|
|
.TH XORRISOFS 1 "Mar 26, 2011"
|
|
.\" Please adjust this date whenever revising the manpage.
|
|
.\"
|
|
.\" Some roff macros, for reference:
|
|
.\" .nh disable hyphenation
|
|
.\" .hy enable hyphenation
|
|
.\" .ad l left justify
|
|
.\" .ad b justify to both left and right margins
|
|
.\" .nf disable filling
|
|
.\" .fi enable filling
|
|
.\" .br insert line break
|
|
.\" .sp <n> insert n+1 empty lines
|
|
.\" for manpage-specific macros, see man(7)
|
|
.nh
|
|
.SH NAME
|
|
xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso
|
|
.SH SYNOPSIS
|
|
.B xorrisofs
|
|
[ options ] [-o filename ] pathspec [pathspecs ...]
|
|
.br
|
|
.SH DESCRIPTION
|
|
.PP
|
|
\fBxorrisofs\fR
|
|
produces Rock Ridge enhanced ISO 9660 filesystems and add-on sessions to
|
|
such filesystems. Optionally it can produce Joliet directory trees too.
|
|
.br
|
|
.PP
|
|
xorrisofs understands options of program mkisofs from cdrtools by
|
|
Joerg Schilling.
|
|
Its implementation is part of program xorriso which shares no source
|
|
code with cdrtools.
|
|
.SS
|
|
\fBISO 9660, Rock Ridge, Joliet:\fR
|
|
.br
|
|
\fBISO 9660\fR
|
|
(aka \fBECMA-119\fR) is a read-only filesystem that is mainly used for
|
|
optical media CD, DVD, BD, but may also reside on other storage devices like
|
|
disk files, USB sticks or disk partitions. It is widely readable by many
|
|
operating systems and by boot facilities of personal computers.
|
|
.br
|
|
ISO 9660 describes directories and data files by
|
|
very restricted filenames with no distinction of upper case and lower case.
|
|
Its metadata do not comply to fundamental POSIX specifications.
|
|
.br
|
|
\fBRock Ridge\fR
|
|
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.
|
|
Rock Ridge allows filenames of up to 255 bytes and paths of up to
|
|
1024 bytes.
|
|
.br
|
|
Rock Ridge information is produced unconditionally with any xorrisofs image.
|
|
.br
|
|
\fBJoliet\fR
|
|
is the name of an additional directory tree which provides
|
|
filenames up to 64 characters encoded as UTF-16.
|
|
A Joliet tree is mainly interesting for reading the ISO image by
|
|
operating systems of Microsoft Corporation.
|
|
Production of this directory tree may be enabled by option -J.
|
|
.br
|
|
\fBISO 9660:1999\fR
|
|
is the name of an additional directory tree which provides longer
|
|
filenames. It allows single file names to have up to 207 characters.
|
|
It might be of use with some older computer system boot
|
|
facilities which read neither Rock Ridge nor Joliet but
|
|
need longer filenames nevertheless.
|
|
Production of this directory tree may be enabled by option -iso-level 4.
|
|
.SS
|
|
.B Inserting files into the ISO image:
|
|
.PP
|
|
xorrisofs deals with two kinds of file addresses:
|
|
.br
|
|
\fBdisk_path\fR
|
|
is a path to an object in the local filesystem tree.
|
|
.br
|
|
\fBiso_rr_path\fR
|
|
is the Rock Ridge address of a file object in the ISO image. (Do not
|
|
confuse with the lowlevel ISO 9660 names visible if Rock Ridge gets ignored.)
|
|
.br
|
|
.PP
|
|
A program argument is handled as a \fBpathspec\fR, if it is not
|
|
recognized as original mkisofs option or additional xorrisofs option.
|
|
A pathspec depicts an input file object by a disk_path.
|
|
If option -graft-points is not present, then this file object gets
|
|
copied into the /-directory of the ISO image.
|
|
.br
|
|
If -graft-points is present then each pathspec gets split at the first
|
|
occurence of the =-character.
|
|
The part before the = is taken as \fBtarget\fR, the iso_rr_path for
|
|
the file object in the ISO image. The part after the first = is taken
|
|
as \fBsource\fR, the disk_path of the input object.
|
|
.br
|
|
It is possible to make =-characters part of the iso_rr_path by preceeding
|
|
them with a \\-character. The same must be done for \\-characters which
|
|
shall be part of the iso_rr_path.
|
|
.br
|
|
.PP
|
|
If the source part of the pathspec leads to a directory, then all files
|
|
underneath this directory get inserted into the image, too.
|
|
It is possible to exclude particular files from being inserted
|
|
by help of option -m.
|
|
.SS
|
|
\fBRelation to program xorriso:\fR
|
|
.br
|
|
xorrisofs is actually a command mode of program \fBxorriso\fR,
|
|
which gets entered either by xorriso command "-as mkisofs" or by
|
|
starting the program by one of the names "xorrisofs", "mkisofs",
|
|
"genisoimage", or "genisofs".
|
|
.br
|
|
This command mode can be left by argument "--" which leads
|
|
to generic xorriso command mode. See \fBman xorriso\fR for its description.
|
|
.br
|
|
.PP
|
|
xorriso performs image reading and writing by help of libburn, which is
|
|
mainly intended for optical drives, but also operates on all POSIX
|
|
file types except directories.
|
|
.br
|
|
The program messages call any image file a "drive". File types which are not
|
|
supported for reading are reported as "blank". The reported free media
|
|
space may be quite fictional.
|
|
.br
|
|
Nevertheless xorrisofs does not operate directly on optical drives,
|
|
but rather forces libburn to regard them as general device files.
|
|
So for writing of sequential optical media (CD, DVD-R, DVD+R, BD-R)
|
|
one will have to use a burn program. E.g the cdrecord emulation of xorriso.
|
|
See EXAMPLES.
|
|
.SS
|
|
.br
|
|
.SH OPTIONS
|
|
.br
|
|
.PP
|
|
.TP
|
|
.B Image loading:
|
|
.PP
|
|
The following options control loading of an existing ISO image for the purpose
|
|
of preparing a suitable add-on session.
|
|
If they are missing then a new image is composed from scratch.
|
|
.TP
|
|
\fB\-M\fR disk_path
|
|
Set the path from which to load the existing ISO image directory tree
|
|
on which to base the upcomming directory tree as add-on session.
|
|
The path must lead to a random-access readable file object.
|
|
On GNU/Linux: regular data files or block device files.
|
|
.br
|
|
A special kind of pseudo disk_path has the form "/dev/fd/"number.
|
|
It depicts the open file descriptor with the given number, regardless whether
|
|
the operating system supports this feature by file nodes in /dev/fd or not.
|
|
E.g. /dev/fd/3 is file descriptor 3 which was opened by the program that
|
|
later started xorriso.
|
|
.TP
|
|
\fB\-prev-session\fR disk_path
|
|
Alias of -M.
|
|
.TP
|
|
\fB\-dev\fR disk_path
|
|
Alias of -M.
|
|
.TP
|
|
\fB\-C\fR last_session_start,next_writeable_address
|
|
Set the 2 KiB block address last_session_start from where to read the
|
|
ISO image out of the file given by option -M.
|
|
.br
|
|
Separated by a comma, set the next_writeable_address to which the
|
|
add-on session will finally be written. Decisive is actually the block
|
|
address which the intended readers will have to use as superblock address
|
|
on the intended media.
|
|
.br
|
|
Both values can be inquired from optical media by help of burn programs
|
|
and cdrecord option -msinfo. xorriso itself can obtain it in its
|
|
cdrecord emulation. Do not let it load the drive, but rather do this manually
|
|
or by a program like dd which reads a few bytes. Only then it is sure that
|
|
the device driver knows the true readable size of the media.
|
|
.br
|
|
dd if=/dev/... count=1 >/dev/null 2>&1
|
|
.br
|
|
values=$(xorriso -as cdrecord dev=/dev/... -msinfo)
|
|
.br
|
|
echo $values
|
|
.br
|
|
Option -C may be used without option -M to create an ISO image from
|
|
scratch and prepare it for being finally written to a block address
|
|
other than 0. Parameter last_session_start must then be set to 0.
|
|
.TP
|
|
\fB\-cdrecord-params\fR last_session_start,next_writeable_address
|
|
Alias of -C.
|
|
.TP
|
|
.B Settings for file insertion:
|
|
.TP
|
|
\fB\-path-list\fR disk_path
|
|
Read pathspecs line-by-line from disk_file and insert the depicted file
|
|
objects into the ISO image. If disk_path is "-" then read the pathspecs
|
|
from standard input.
|
|
.TP
|
|
\fB--quoted_path_list\fR disk_path
|
|
Like option -path-list but reading quoted words rather than plain lines.
|
|
Whitespace outside of quotes will be discarded. On the other hand it is
|
|
possible to represent pathspecs which contain newline characters.
|
|
.br
|
|
The double quotation mark " and the single quotation mark ' can be used to
|
|
enclose whitespace and make it part of pathspecs. Each mark
|
|
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.
|
|
.TP
|
|
\fB\-f\fR
|
|
.br
|
|
Resolve symbolic links on disk rather than storing them as symbolic
|
|
links in the ISO image.
|
|
.TP
|
|
\fB\-follow-links\fR
|
|
Alias of -f.
|
|
.TP
|
|
\fB\-graft-points\fR
|
|
Enable interpretation of input file pathspecs as combination of iso_rr_path
|
|
and disk_path, separated by a =-character.
|
|
.TP
|
|
\fB\-m\fR disk_pattern
|
|
Exclude files from being inserted into the image. Silently ignored are
|
|
those files of which the disk_path matches the given shell parser pattern.
|
|
If no /-character is part of the pattern, then it gets matched against
|
|
the leaf name of the disk file.
|
|
.br
|
|
It is possible to give more than one -m option.
|
|
.TP
|
|
\fB\-exclude\fR
|
|
Alias of -m.
|
|
.TP
|
|
\fB\-x\fR
|
|
.br
|
|
Alias of -m.
|
|
.TP
|
|
\fB\-old-exclude\fR
|
|
Alias of -m.
|
|
.TP
|
|
\fB\-exclude-list\fR disk_path
|
|
Perform -m using each line out of file disk_path as argument disk_pattern.
|
|
.TP
|
|
\fB\-z\fR
|
|
.br
|
|
Enable recognition and proper processing of zisofs compressed files
|
|
as produced by program mkzftree. These files will get equipped with the
|
|
necessary meta data so that a Linux kernel will recognize them and
|
|
deliver their content in uncompressed form.
|
|
.TP
|
|
\fB\-transparent-compression\fR
|
|
Alias of -z.
|
|
.TP
|
|
\fB\-root\fR iso_rr_path
|
|
Insert all files under the given iso_rr_path. If option -graft-points is given,
|
|
then iso_rr_path is prepended to each target part of a pathspec.
|
|
.br
|
|
The default for -root is "/".
|
|
.TP
|
|
\fB\-old-root\fR iso_rr_path
|
|
Enable incremental insertion of files into the loaded image.
|
|
The effective target and source addresses of given pathspecs get compared
|
|
whether the target already exists in the ISO image and is still identical
|
|
to the source on disk. Metadata in the ISO image will eventually get adjusted.
|
|
New files and files with changed content will get newly added.
|
|
Target files which do not exist in any of the according pathspec sources
|
|
will get removed from the ISO directory tree.
|
|
.br
|
|
If the effective setting of -root differs from the iso_rr_path given
|
|
with -old-root, then the files underneath the -old-root directory get cloned
|
|
underneath the -root directory. Cloning happens before file comparison.
|
|
.TP
|
|
\fB--old-root-no-ino\fR
|
|
Disable recording and use of disk inode numbers.
|
|
If no disk inode numbers are recorded, then option -old-root will have
|
|
to read disk file content and compare it with the MD5 checksum that is
|
|
recorded in the ISO image.
|
|
.br
|
|
With recorded disk inode numbers and with credible ctime and mtime,
|
|
it is possible to detect potential changes in the content without actually
|
|
reading it.
|
|
A loophole remains if multiple different filesystems may get mounted
|
|
at the same directory, like it is habit with /mnt.
|
|
In this case one has to use option --old-root-devno
|
|
or disable the inode number shortcut by --old-root-no-ino.
|
|
.TP
|
|
\fB--old-root-devno\fR
|
|
Enable comparison of recorded device numbers together with recorded
|
|
inode numbers. This works only with good old stable device numbers which
|
|
get out of fashion, regrettably. If the hard disk has a different
|
|
device number after each reboot, then this comparison will see all
|
|
files as changed and thus prevent any incremental size saving.
|
|
.TP
|
|
\fB--old-root-no-md5\fR
|
|
Disable recording and eventual use of MD5 checksums for data file content.
|
|
If neither checksums and nor disk inode numbers are recorded, then
|
|
option -old-root will have to read ISO image file content when comparing
|
|
it with disk file content.
|
|
.TP
|
|
.B Settings for image production:
|
|
.TP
|
|
\fB\-o\fR disk_path
|
|
Set the output file address for the emerging ISO image.
|
|
If the address exists as regular file, it will be truncated to length 0
|
|
when image production begins. It may not already exist as directory.
|
|
If it does not exist yet then its parent directory must exist and
|
|
a regular file will get created.
|
|
.br
|
|
A special kind of pseudo disk_path has the form "/dev/fd/"number.
|
|
It depicts the open file descriptor with the given number, regardless whether
|
|
the operating system supports this feature by file nodes in /dev/fd or not.
|
|
E.g. /dev/fd/4 is file descriptor 4 which was opened by the program that
|
|
later started xorriso.
|
|
.br
|
|
Default is standard output (/dev/fd/1) which may also be set by disk_path "-".
|
|
.TP
|
|
\fB\-output\fR disk_path
|
|
Alias of -o.
|
|
.TP
|
|
\fB--stdio_sync\fR "on"|"off"|number
|
|
Set the number of bytes after which to force output to disk
|
|
in order to keep the memory from being clogged with lots of
|
|
pending data for slow devices. Default "on" is the same as "16m".
|
|
Forced output can be disabled by "off".
|
|
.br
|
|
xorriso uses an inner fifo buffer with default size 4 MiB. So forcing
|
|
the operating system i/o cache to disk does not necessarily block the
|
|
simultaneous production of more image content.
|
|
.TP
|
|
\fB--emul-toc\fR
|
|
Write a second superblock with the first session into random-access
|
|
files. If further sessions get appended and the first superblock gets updated,
|
|
then the second superblock will not be overwritten. This allows to still
|
|
mount the first session and to find the start blocks of the further sessions.
|
|
.br
|
|
The price is 64 KiB extra space consumption. If -partition_offset is non-zero,
|
|
then it is 128 KiB plus twice the partition setup.
|
|
.TP
|
|
\fB--no-emul-toc\fR
|
|
Do not write a second superblock with the first session into random-access
|
|
files.
|
|
.br
|
|
This is the default.
|
|
.TP
|
|
\fB--sort-weight\fR weight_number iso_rr_path
|
|
Attribute a LBA weight number to regular files. If iso_rr_path leads
|
|
to a directory then all regular files underneath will get the weight_number.
|
|
.br
|
|
The weight_number may range from -2147483648 to 2147483647.
|
|
The higher it is, the lower will be the block address of the file data
|
|
in the emerging ISO image.
|
|
Currently the El Torito boot catalog has a hardcoded weight of 1 billion.
|
|
Normally it should occupy the block with the lowest possible address.
|
|
Data files get added or loaded with initial weight 0.
|
|
.TP
|
|
\fB\-dir-mode\fR mode
|
|
Set the access permissions for all directories in the image to the given
|
|
mode which is either an octal number beginning with "0" or a comma separated
|
|
list of statements of the form [ugoa]*[+-=][rwxst]* . E.g. ug=rx,a-rwx
|
|
.TP
|
|
\fB\-file-mode\fR mode
|
|
Like -dir-mode but for all regular data files in the image.
|
|
.TP
|
|
\fB\-pad\fR
|
|
.br
|
|
Add 300 KiB to the end of the produced ISO image. This circumvents possible
|
|
read errors from ISO images which have been written to CD media in TAO mode.
|
|
The additional bytes are claimed as part of the ISO image if not --emul-toc
|
|
is given.
|
|
.br
|
|
Option -pad is the default.
|
|
.TP
|
|
\fB\-no-pad\fR
|
|
Disable padding of 300 KiB to the end of the produced ISO image.
|
|
This is safe if the image is not meant to be written on CD or if it
|
|
gets written to CD as only track in write mode SAO.
|
|
.TP
|
|
\fB--old-empty\fR
|
|
Use the old way of of giving block addresses in the range
|
|
of [0,31] to files with no own data content. The new way is to have
|
|
a dedicated block to which all such files will point.
|
|
.TP
|
|
.B Settings for standards compliance:
|
|
.TP
|
|
\fB\-iso-level\fR number
|
|
Specify the ISO 9660 version which defines the limitations of file naming
|
|
and data file size. The naming restrictions do not apply to the
|
|
Rock Ridge names but only to the low-level ISO 9660 names.
|
|
There are three conformance levels:
|
|
.br
|
|
Level 1 allows ISO names of the form 8.3 and file size up to 4 GiB - 1.
|
|
.br
|
|
Level 2 allows ISO names with up to 32 characters
|
|
and file size up to 4 GiB - 1.
|
|
.br
|
|
Level 3 allows ISO names with up to 32 characters
|
|
and file size of up to 400 GiB - 200 KiB. (This size limitation is
|
|
set by the xorriso implementation and not by ISO 9660 which would
|
|
allow nearly 8 TiB.)
|
|
.br
|
|
Pseudo-level 4 enables production of an additional ISO 9660:1999
|
|
directory tree.
|
|
.TP
|
|
\fB\-disallow_dir_id_ext\fR
|
|
Do not follow a bad habit of mkisofs which allows dots in the ISO names
|
|
of directories. On the other hand, some bootable GNU/Linux images depend on
|
|
this bad habit.
|
|
.TP
|
|
\fB\-U\fR
|
|
.br
|
|
This option allows ISO file names without dot and up to 37 characters,
|
|
ISO file paths longer than 255 characters, and all ASCII characters in file
|
|
names. Further it omits the semicolon and the version numbers at the end
|
|
of ISO names.
|
|
.br
|
|
This all violates ISO 9660 specs.
|
|
.TP
|
|
\fB\-untranslated-filenames\fR
|
|
Alias of -U.
|
|
\fB\-untranslated_name_len\fR number
|
|
Allow ISO file names up to the given number of characters
|
|
without any character conversion. The maximum number is 96.
|
|
If a file name has more characters, then image production will
|
|
fail deliberately.
|
|
.br
|
|
This violates ISO 9660 specs.
|
|
.TP
|
|
\fB\-allow-lowercase\fR
|
|
Allow lowercase character in ISO file names.
|
|
.br
|
|
This violates ISO 9660 specs.
|
|
.TP
|
|
\fB\-d\fR
|
|
.br
|
|
Do not add trailing dot to ISO file names without dot.
|
|
.br
|
|
This violates ISO 9660 specs.
|
|
.TP
|
|
\fB\-omit-period\fR
|
|
Alias of -d.
|
|
.TP
|
|
\fB\-l\fR
|
|
.br
|
|
Allow up to 37 characters in ISO file names.
|
|
.br
|
|
This violates ISO 9660 specs.
|
|
.TP
|
|
\fB\-full-iso9660-filenames\fR
|
|
Alias of -l.
|
|
.TP
|
|
\fB\-max-iso9660-filenames\fR
|
|
Alias of -l.
|
|
.TP
|
|
\fB\-N\fR
|
|
.br
|
|
Omit the semicolon and the version numbers at the end of ISO names.
|
|
.br
|
|
This violates ISO 9660 specs.
|
|
.TP
|
|
\fB\-omit-version-number\fR
|
|
Alias of -N.
|
|
.TP
|
|
.B Settings for standards extensions:
|
|
.TP
|
|
\fB\-R\fR
|
|
.br
|
|
With mkisofs this option enables Rock Ridge extensions. xorrisofs produces
|
|
them unconditionally.
|
|
.TP
|
|
\fB\-rock\fR
|
|
.br
|
|
Alias of -R.
|
|
.TP
|
|
\fB\-r\fR
|
|
.br
|
|
Set Rock Ridge user and group id of all files in the ISO image to 0.
|
|
Grant r-permissions to all. Deny all w-permissions.
|
|
If any x-permission is set, grant x-permission to all.
|
|
Remove s-bit and t-bit.
|
|
.TP
|
|
\fB\-rational-rock\fR
|
|
Alias of -r.
|
|
.TP
|
|
\fB--for_backup\fR
|
|
Enable options which improve backup fidelity:
|
|
--acl, --xattr, --md5,
|
|
--hardlinks.
|
|
.TP
|
|
\fB--acl\fR
|
|
.br
|
|
Enable recording and loading of GNU/Linux ACLs (see man getfacl, man acl).
|
|
They will not be in effect with mounted ISO images. But xorriso can
|
|
restore them when extracting files from the ISO image.
|
|
.TP
|
|
\fB--xattr\fR
|
|
.br
|
|
Enable recording and loading of GNU/Linux extended attributes in
|
|
user namespace (see man getfattr, man attr).
|
|
They will not be in effect with mounted ISO images. But xorriso can
|
|
restore them when extracting files from the ISO image.
|
|
.TP
|
|
\fB--md5\fR
|
|
.br
|
|
Enable recording of MD5 checksums for the overall ISO image and for each
|
|
single data file in the image. xorriso can check the content of an ISO
|
|
image with these sums and eventually raise alert on mismatch.
|
|
See man xorriso, options -check_media, check_md5_r.
|
|
xorriso can print recorded MD5 checksums. E.g. by:
|
|
.br
|
|
-find / -exec get_md5
|
|
.TP
|
|
\fB--hardlinks\fR
|
|
Enable loading and recording of hardlink relations.
|
|
Search for families of iso_rr files which stem from the same disk file,
|
|
have identical content filtering and have identical properties.
|
|
The members of each family get the same inode number in the ISO image.
|
|
.br
|
|
Whether these numbers are respected at mount time depends on the operating
|
|
system. xorriso can create hardlink families when extracting files from
|
|
the ISO image.
|
|
.TP
|
|
\fB--scdbackup_tag\fR disk_path record_name
|
|
Append a scdbackup checksum record to the image. This works only if the
|
|
parameter next_writeable_address of option -C is 0.
|
|
If disk_path is not an empty string, then append a scdbackup checksum record
|
|
to the end of this file. record_name is a word that gets part of tag
|
|
and record.
|
|
.br
|
|
Program scdbackup_verify will recognize and verify tag resp. record.
|
|
.TP
|
|
\fB\-J\fR
|
|
.br
|
|
Enable the production of an additional Joliet directory tree along
|
|
with the ISO 9660 Rock Ridge tree.
|
|
.TP
|
|
\fB\-joliet\fR
|
|
Alias of -J.
|
|
.TP
|
|
\fB\-joliet-long\fR
|
|
Allow 103 characters in Joliet file names rather than 64 as is prescribed
|
|
by the specification. Allow Joliet paths longer than the prescribed limit of
|
|
240 characters.
|
|
.br
|
|
Oversized names get truncated. Without this option, oversized paths get
|
|
excluded from the Joliet tree.
|
|
.TP
|
|
.B Settings for file hiding:
|
|
.TP
|
|
\fB\-hide\fR disk_path_pattern
|
|
Make files invisible in the directory tree of ISO 9660 and Rock Ridge,
|
|
if their disk_path matches the given shell parser pattern.
|
|
The eventual data content of such hidden files will be included in the
|
|
resulting image, even if they do not show up in any directory.
|
|
But you will need own means to find nameless data in the image.
|
|
.br
|
|
This command does not apply to the boot catalog.
|
|
.TP
|
|
\fB\-hide-list\fR disk_path
|
|
Perform -hide using each line out of file disk_path as argument
|
|
disk_path_pattern.
|
|
.TP
|
|
\fB\-hide-joliet\fR disk_path_pattern
|
|
Like option -hide but making files invisible in the directory tree of Joliet,
|
|
if their disk_path matches the given shell parser pattern.
|
|
.TP
|
|
\fB\-hide-joliet-list\fR disk_path
|
|
Perform -hide-joliet using each line out of file disk_path as argument
|
|
disk_path_pattern.
|
|
.TP
|
|
.B ISO image ID strings:
|
|
.PP
|
|
The following strings and file addresses get stored in the Primary Volume
|
|
Descriptor of the ISO9660 image. The file addresses are ISO 9660
|
|
paths. These files should have iso_rr_paths which consist only of
|
|
the characters [A-Z0-9_] and exactly one dot which separates
|
|
at most 8 characters from at most 3 characters.
|
|
.TP
|
|
\fB\-V\fR text
|
|
Set the Volume Id of the ISO image.
|
|
xorriso accepts any text up to 32 characters,
|
|
but according to rarely obeyed specs stricter rules apply:
|
|
.br
|
|
Conformant are ASCII characters out of [A-Z0-9_]. Like: "IMAGE_23"
|
|
.br
|
|
Joliet allows 16 UCS-2 characters. Like: "Windows name"
|
|
.br
|
|
Be aware that the volume id might get used automatically as name of the
|
|
mount point when the media is inserted into a playful computer system.
|
|
.TP
|
|
\fB\-volid\fR text
|
|
Alias of -V.
|
|
.TP
|
|
\fB\-volset\fR text
|
|
Set the Volume Set Id of the ISO image.
|
|
Permissible are up to 128 characters.
|
|
.TP
|
|
\fB\-p\fR text
|
|
Set the Publisher Id of the ISO image. This may identify the person or
|
|
organisation who specified what shall be recorded.
|
|
Permissible are up to 128 characters.
|
|
.TP
|
|
\fB\-publisher\fR text
|
|
Alias of -p.
|
|
.TP
|
|
\fB\-A\fR text
|
|
Set the Application Id of the ISO image.
|
|
This may identify the specification of how the data are recorded.
|
|
Permissible are up to 128 characters.
|
|
.br
|
|
The special text "@xorriso@" gets converted to the id string of xorriso
|
|
which is normally written as Preparer Id. It is a wrong tradition to write
|
|
the program id as Application Id.
|
|
.TP
|
|
\fB\-appid\fR text
|
|
Alias of -A.
|
|
.TP
|
|
\fB\-sysid\fR text
|
|
Set the System Id of the ISO image. This may
|
|
identify the system which can recognize and act upon the content of the
|
|
System Area in image blocks 0 to 15.
|
|
Permissible are up to 32 characters.
|
|
.TP
|
|
\fB\-p\fR text
|
|
Set the Preparer Id of the ISO image. 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.
|
|
Permissible are up to 128 characters.
|
|
.br
|
|
The special text "@xorriso@" gets converted to the id string of xorriso
|
|
which is default at program startup.
|
|
.TP
|
|
\fB\-preparer\fR text
|
|
Alias of -p.
|
|
.TP
|
|
\fB\-abstract\fR iso_path
|
|
Set the address of the Abstract File of the ISO image. This should
|
|
be the ISO 9660 path of a file in the image which contains an abstract
|
|
statement about the image content.
|
|
Permissible are up to 37 characters.
|
|
.TP
|
|
\fB\-biblio\fR iso_path
|
|
Set the address of the Biblio File of the ISO image. This should
|
|
be the ISO 9660 path of a file in the image which contains bibliographic
|
|
records.
|
|
Permissible are up to 37 characters.
|
|
.TP
|
|
\fB\-copyright\fR iso_path
|
|
Set the address of the Copyright File of the ISO image. This should
|
|
be the ISO 9660 path of a file in the image which contains a copyright
|
|
statement.
|
|
Permissible are up to 37 characters.
|
|
.TP
|
|
\fB--modification-date=YYYYMMDDhhmmsscc\fR
|
|
Set a timestring that overrides ISO image creation and modification timestamps
|
|
literally.
|
|
It must consist of 16 decimal digits which form YYYYMMDDhhmmsscc, with
|
|
YYYY between 1970 and 2999. Time zone is GMT.
|
|
It is supposed to match this GRUB line:
|
|
.br
|
|
search --fs-uuid --set YYYY-MM-DD-hh-mm-ss-cc
|
|
.br
|
|
E.g. 2010040711405800 is 7 Apr 2010 11:40:58 (+0 centiseconds).
|
|
.TP
|
|
.B El Torito Bootable ISO images:
|
|
.PP
|
|
The precondition for a bootable ISO image is to have in the ISO image
|
|
the files of a boot loader. The boot facilities of computers get
|
|
directed to such files, which usually execute further program files
|
|
from the ISO image.
|
|
xorrisofs can produce several kinds of boot block or boot record,
|
|
which become part of the ISO image, and get interpreted by the according
|
|
boot facility.
|
|
.br
|
|
.PP
|
|
An \fBEl Torito\fR
|
|
boot record points the bootstrapping facility to a boot catalog
|
|
with one or more boot 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
|
|
xorriso composes the boot catalog according to the boot image
|
|
files given and structured by options -b, -e, -el-torito-alt-boot,
|
|
and --efi-boot. Often it contains only one entry.
|
|
.br
|
|
El Torito gets interpreted by boot facilities PC-BIOS and EFI.
|
|
Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images
|
|
for PC-BIOS.
|
|
.br
|
|
xorrisofs supports the example options out of the ISOLINUX wiki,
|
|
the options used in GRUB script grub-mkrescue, and the example in the
|
|
FreeBSD AvgLiveCD wiki.
|
|
.br
|
|
.PP
|
|
For CD booting via boot facilities other than PC-BIOS and EFI, and
|
|
for booting from USB sticks or hard disks, see the next section
|
|
about the Sytem Area.
|
|
.br
|
|
.TP
|
|
\fB\-b\fR iso_rr_path
|
|
Specify the boot image file which shall be mentioned in the current
|
|
entry of the El Torito boot catalog. It will be marked as suitable for
|
|
PC-BIOS.
|
|
.br
|
|
With boot images from ISOLINUX and GRUB this option should be accompanied by
|
|
options -c , -no-emul-boot , -boot-load-size 4 , -boot-info-table.
|
|
.TP
|
|
\fB\-eltorito-boot\fR iso_rr_path
|
|
Alias of -b.
|
|
.TP
|
|
\fB\-eltorito-alt-boot\fR
|
|
Finalize the current El Torito boot catalog entry and begin a new one.
|
|
A boot image file and all its necessary options shall be specified before
|
|
option -eltorito-alt-boot.
|
|
All further El Torito boot options apply to the new catalog
|
|
entry. Up to 32 catalog entries are possible.
|
|
.TP
|
|
\fB\-e\fR iso_rr_path
|
|
Specify the boot image file which shall be mentioned in the current
|
|
entry of the El Torito boot catalog. It will be marked as suitable for EFI.
|
|
.br
|
|
Normally no other El Torito options should be used with the catalog entry
|
|
that points to an EFI image.
|
|
Consider to use --efi-boot rather than -e.
|
|
.TP
|
|
\fB--efi-boot\fR iso_rr_path
|
|
Perform eventual necessary -eltorito-alt-boot, option -e with the given
|
|
iso_rr_path, and again -eltorito-alt-boot. This gesture is
|
|
used for achieving EFI-bootability of the GRUB2 rescue CD.
|
|
.TP
|
|
\fB\-boot-load-size\fR number
|
|
Set the number of 512-byte blocks for boot images which emulate
|
|
a floppy or a hard disk. A safe default for non-emulating boot images is 4.
|
|
.TP
|
|
\fB\-hard-disk-boot\fR
|
|
Mark the boot image in the current catalog entry as emulated hard disk.
|
|
(Not suitable for any known boot loader.)
|
|
.TP
|
|
\fB\-no-emul-boot\fR
|
|
Mark the boot image in the current catalog entry as not emulating
|
|
floppy or hard disk. (This is to be used with all known boot loaders.)
|
|
.br
|
|
If neither -hard-disk-boot nor -no-emul-boot is given, then the
|
|
boot image will be marked as emulating a floppy.
|
|
(Not suitable for any known boot loader.)
|
|
.TP
|
|
\fB\-boot-info-table\fR
|
|
Overwrite certain bytes in the current boot image. The information will be
|
|
supplied by xorriso in the course of image production: Block address of
|
|
the Primary Volume Descriptor, block address of the boot image file,
|
|
size of the boot image file.
|
|
.TP
|
|
\fB\-c\fR iso_rr_path
|
|
Set the address of the El Torito boot catalog file within the image.
|
|
This file address is not significant for the booting PC-BIOS or EFI,
|
|
but it may later be read by other programs in order to learn about
|
|
the available boot images.
|
|
.TP
|
|
\fB\-eltorito-catalog\fR iso_rr_path
|
|
Alias of -c.
|
|
.TP
|
|
\fB--boot-catalog-hide\fR
|
|
Prevent the El Torito boot catalog from appearing as file
|
|
in the directory trees of the image.
|
|
.TP
|
|
.B System Area, MBR, other boot blocks:
|
|
.PP
|
|
The first 16 blocks of an ISO image are the System Area.
|
|
It is reserved for system dependent boot software. This may be the
|
|
CD boot facilities of exotic hardware architectures or it may be
|
|
a MBR for booting via PC-BIOS from USB stick or hard disk.
|
|
.br
|
|
A \fBMBR\fR (Master Boot Record) contains boot code and a partition table.
|
|
It does not hamper El Torito booting from CDROM.
|
|
.br
|
|
xorrisofs supports boot facilities other than PC-BIOS:
|
|
MIPS Big Endian (SGI), MIPS Little Endian (DEC), SUN SPARC.
|
|
Those are mutually not combinable and also not combinable with MBR.
|
|
.br
|
|
.TP
|
|
\fB\-G\fR disk_path
|
|
Copy at most 32768 bytes from the given disk file to the very start of
|
|
the ISO image.
|
|
.br
|
|
Other than a El Torito boot image, the file disk_path needs not to be added
|
|
to the ISO image. It will not show up as file in the directory trees.
|
|
.TP
|
|
\fB\-generic-boot\fR disk_path
|
|
Alias of -G.
|
|
.TP
|
|
\fB--embedded-boot\fR disk_path
|
|
Alias of -G.
|
|
.TP
|
|
\fB\-isohybrid-mbr\fR disk_path
|
|
Install disk_path as ISOLINUX isohybrid MBR which makes the boot image
|
|
given by option -b bootable from USB sticks and hard disks via PC-BIOS.
|
|
This preparation is normally done by ISOLINUX program isohybrid
|
|
on the already produced ISO image.
|
|
.br
|
|
The disk path should lead to one of the Syslinux files isohdp[fp]x*.bin .
|
|
The MBR gets patched according to isohybrid needs. The first partition
|
|
describes the range of the ISO image. Its start is at block 0 by default,
|
|
but may be set to 64 disk blocks by option -partition_offset 16.
|
|
.TP
|
|
\fB--protective-msdos-label\fR
|
|
Patch the System Area by a simple PC-DOS partition table where partition 1
|
|
claims the range of the ISO image but leaves the first block unclaimed.
|
|
.TP
|
|
\fB\-partition_offset\fR 2kb_block_adr
|
|
Cause a partition table with a single partition that begins at the
|
|
given block address. This is counted in 2048 byte
|
|
blocks, not in 512 byte blocks. If the block address is non-zero then it must
|
|
be at least 16. Values larger than 16 are hardly of use.
|
|
A non-zero partition offset causes two superblocks to be
|
|
generated and two sets of directory trees. The image is then mountable from its
|
|
absolute start as well as from the partition start.
|
|
.br
|
|
The offset value of an ISO image gets preserved when a new session is added
|
|
to a loaded image.
|
|
So the value defined here is only in effect if a new ISO image gets written.
|
|
.TP
|
|
\fB\-partition_hd_cyl\fR number
|
|
Set the number of heads per cylinder for the partition table.
|
|
0 chooses a default value. Maximum is 255.
|
|
.TP
|
|
\fB\-partition_sec_hd\fR number
|
|
Set the number of sectors per head for the partition table.
|
|
0 chooses a default value. Maximum is 63.
|
|
.br
|
|
The product partition_sec_hd * partition_hd_cyl * 512 is the cylinder size.
|
|
It should be divisible by 2048 in order to allow exact alignment.
|
|
If it is too small to describe the image size by at most 1024 cylinders,
|
|
then appropriate values of partition_hd_cyl are chosen with
|
|
partition_sec_hd 32 or 63. If the image is larger than 8,422,686,720 bytes,
|
|
then the cylinder size constraints cannot be fulfilled. They seem not overly
|
|
important anyway. Flat block addresses in partition tables are good for 1 TiB.
|
|
.TP
|
|
\fB\-partition_cyl_align\fR mode
|
|
Control image size alignment to an integer number of cylinders.
|
|
It is prescribed by isohybrid specs and it seems to please program fdisk.
|
|
Cylinder size must be divisible by 2048.
|
|
Images larger than 8,323,596,288 bytes cannot be aligned.
|
|
.br
|
|
Mode "auto" is default. Alignment by padding happens only if
|
|
option -isohybrid-mbr is given.
|
|
.br
|
|
Mode "on" causes alignment by padding with option
|
|
--protective-msdos-label too.
|
|
Mode "off" disables alignment unconditionally.
|
|
.TP
|
|
\fB\-append_partition\fR partition_number type_code disk_path
|
|
Cause a prepared filesystem image to be appended to the ISO image and to be
|
|
described by a partition table entry in a boot block at the start of the
|
|
emerging ISO image. The partition entry will bear the size of the submitted
|
|
file rounded up to the next multiple of 2048 bytes.
|
|
.br
|
|
Beware of subsequent multi-session runs. The appended partition will get
|
|
overwritten.
|
|
.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
|
|
features, number 2 would be the most natural choice.
|
|
.br
|
|
The type_code may be "FAT12", "FAT16", "Linux",
|
|
or a hexadecimal number between 0x00 and 0xff. Not all those numbers will
|
|
yield usable results. For a list of codes search the Internet for
|
|
"Partition Types" or run fdisk command "L".
|
|
.TP
|
|
\fB\-mips-boot\fR iso_rr_path
|
|
Declare a data file in the image to be a
|
|
MIPS Big Endian boot file and cause production of a MIPS Big Endian Volume
|
|
Header. This is mutually exclusive with production of other boot blocks
|
|
like MBR.
|
|
It will overwrite the first 512 bytes of any data eventually provided by -G.
|
|
Up to 15 boot files can be declared by multiple -mips-boot options.
|
|
.TP
|
|
\fB\-mipsel-boot\fR iso_rr_path
|
|
Declare a data file in the image to be the
|
|
MIPS Little Endian boot file. This is mutually exclusive with other boot
|
|
blocks.
|
|
It will overwrite the first 512 bytes of any data eventually
|
|
provided by -G.
|
|
Only a single boot file can be declared by -mipsel-boot.
|
|
.TP
|
|
\fB\-B\fR disk_path[,disk_path ...]
|
|
Cause one or more data files on disk to be written after the end of the
|
|
ISO image. A SUN Disk Label will be written into the first 512 bytes of the
|
|
ISO image which lists this image as partition 1 and the given disk_paths as
|
|
partition 2 up to 8.
|
|
.br
|
|
The disk files should contain suitable boot images for SUN SPARC systems.
|
|
.br
|
|
The pseudo disk_path "..." causes that all empty partition entries become
|
|
copies of the last non-empty entry. If no other disk_path is given before
|
|
"..." then all partitions describe the ISO image. In this case, the boot
|
|
loader code has to be imported by option -G.
|
|
.TP
|
|
\fB\-sparc-boot\fR disk_path[,disk_path ...]
|
|
Alias of -B.
|
|
.TP
|
|
\fB\-sparc-label\fR text
|
|
Set the ASCII label text of a SUN Disk Label.
|
|
.TP
|
|
.B Character sets:
|
|
.PP
|
|
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
|
|
codes.
|
|
.br
|
|
A conversion from input character set to the output character set is
|
|
performed when an ISO image gets written.
|
|
Vice versa there is a conversion from output character set to the
|
|
input character set when an ISO image gets loaded.
|
|
The sets can be defined by options -input-charset and -output-charset,
|
|
if needed.
|
|
.br
|
|
.TP
|
|
\fB\-input-charset\fR character_set_name
|
|
Set the character set from which to convert disk file names when
|
|
inserting them into the ISO image.
|
|
.TP
|
|
\fB\-output-charset\fR character_set_name
|
|
Set the character set from which to convert names of loaded ISO images
|
|
and to which to convert names when writing ISO images.
|
|
.TP
|
|
.B Jigdo Template Extraction:
|
|
.PP
|
|
From man genisoimage:
|
|
"Jigdo is a tool to help in the distribution of large files like CD and
|
|
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
|
|
If the use of libjte was enabled at compile time of xorriso, then
|
|
xorrisofs can produce a .jigdo and a .template file together with a
|
|
single-session ISO image. If not, then Jigdo options will cause a
|
|
FAILURE event, which normally leads to program abort.
|
|
.br
|
|
One may determine the ability for Jigdo by:
|
|
.br
|
|
$ xorrisofs -version 2>&1 | grep '^libjte' && echo YES
|
|
.br
|
|
.PP
|
|
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 xorrisofs session
|
|
with no image loaded, 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:
|
|
.br
|
|
MD5 as 32 hex digits, 2 blanks, size as 12 decimal digits or blanks, 2 blanks,
|
|
symbolic file address
|
|
.br
|
|
The file address in an .md5 line has to bear the same basename as the
|
|
disk_path of the file which it shall match. The directory path of
|
|
the file address is decisive for To=From mapping, not for file recognition.
|
|
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 eventual padding will be
|
|
counted as part of the ISO image.
|
|
.br
|
|
.TP
|
|
\fB\-jigdo-jigdo\fR disk_path
|
|
Set the disk_path for the .jigdo file with the checksums
|
|
and download addresses for filling the holes in .template.
|
|
.TP
|
|
\fB\-jigdo-template\fR disk_path
|
|
Set the disk_path for the .template file with the
|
|
holed and compressed ISO image copy.
|
|
.TP
|
|
\fB\-jigdo-min-file-size\fR size
|
|
Set the minimum size for a data file to be listed
|
|
in the .jigdo file and being a hole in the .template file.
|
|
size may be a plain number counting bytes, or a number with appended
|
|
letter "k", "m", "g" to count KiB (1024 bytes), MiB (1024 KiB), or
|
|
GiB (1024 MiB).
|
|
.TP
|
|
\fB\-jigdo-force-md5\fR disk_path_pattern
|
|
adds a regular expression pattern which will get compared
|
|
with the absolute disk_path of any data file that was not found in the .md5
|
|
list. A match causes a MISHAP event, which normally does not abort the
|
|
program run but finally causes a non-zero exit value of the program.
|
|
.TP
|
|
\fB\-jigdo-exclude\fR disk_path_pattern
|
|
Add a regular expression pattern which will get compared
|
|
with the absolute disk_path of any data file. A match causes the file to
|
|
stay in .template in any case.
|
|
.TP
|
|
\fB\-jigdo-map\fR To=From
|
|
Add a string pair of the form To=From to the parameter list.
|
|
If a data file gets listed in the .jigdo file, then it is referred by the
|
|
file address from its line in the .md5 file. This file address gets checked
|
|
whether it begins with the From string. If so, then this string will be
|
|
replaced by the To string and a ':' character, before it goes into the .jigdo
|
|
file. The From string should end by a '/' character.
|
|
.TP
|
|
\fB\-md5-list\fR disk_path
|
|
Set the disk_path where to find the .md5 input file.
|
|
.TP
|
|
\fB\-jigdo-template-compress\fR "gzip"|"bzip2"
|
|
Choose one of "bzip2" or "gzip" for the compression of
|
|
the template file. The jigdo file is put out uncompressed.
|
|
.TP
|
|
\fB\-checksum_algorithm_iso\fR list_of_names
|
|
Choose one or more of "md5", "sha1", "sha256", "sha512"
|
|
for the auxiliary "# Image Hex" checksums in the .jigdo file. The list_of_names
|
|
may e.g. look like "md5,sha1,sha512". Value "all" chooses all available
|
|
algorithms.
|
|
Note that MD5 stays always enabled.
|
|
.TP
|
|
\fB\-checksum_algorithm_template\fR list_of_names
|
|
Choose the algorithms for the "# Template Hex" checksums in the .jigdo file.
|
|
The rules for list_of_names are the same as with -checksum_algorithm_iso.
|
|
.TP
|
|
.B Miscellaneous options:
|
|
.TP
|
|
\fB\-print-size\fR
|
|
Print to stdandard output the foreseeable number of 2048 byte blocks in
|
|
the emerging ISO image. Do not produce this image.
|
|
.br
|
|
The result depends on several settings.
|
|
.br
|
|
If option --emul-toc is given, then padding (see -pad) is not
|
|
counted as part of the image size. In this case either use -no-pad or
|
|
add 150 (= 300 KiB) to the resulting number.
|
|
.TP
|
|
\fB--no_rc\fR
|
|
Only if used as first argument this option
|
|
prevents reading and interpretation of eventual startup
|
|
files. See section FILES below.
|
|
.TP
|
|
\fB\-help\fR
|
|
.br
|
|
List supported options to stderr. Original mkisofs options bear their
|
|
original mkisofs description texts.
|
|
.TP
|
|
\fB\-quiet\fR
|
|
.br
|
|
Suppress most messages of the program run, except those which indicate
|
|
problems or errors.
|
|
.TP
|
|
\fB\-v\fR
|
|
.br
|
|
Enable the output of informational program messages.
|
|
.TP
|
|
\fB\-verbose\fR
|
|
Alias of -v.
|
|
.TP
|
|
\fB\-version\fR
|
|
Print to standard output a text that begins with
|
|
.br
|
|
"mkisofs 2.01-Emulation Copyright (C)"
|
|
.br
|
|
and to standard error the version information of xorriso.
|
|
.br
|
|
.SH EXAMPLES
|
|
.SS
|
|
.B Overview of examples:
|
|
A simple image production run
|
|
.br
|
|
Set ISO image paths by -graft-points
|
|
.br
|
|
Perform multi-session runs
|
|
.br
|
|
Let xorrisofs work underneath growisofs
|
|
.br
|
|
Incremental backup of a few directory trees
|
|
.br
|
|
Incremental backup with accumulated trees
|
|
.br
|
|
Create bootable images for PC-BIOS
|
|
.br
|
|
.SS
|
|
.B A simple image production run
|
|
A prepared file tree in directory ./for_iso gets copied into the root
|
|
directory of the ISO image. File permissions get set to read-only for
|
|
everybody.
|
|
Joliet attributes for Microsoft systems get added.
|
|
The resulting image gets written as data file ./image.iso on disk.
|
|
.br
|
|
$ xorrisofs -r -J -o ./image.iso ./for_iso
|
|
.SS
|
|
.B Set ISO image paths by -graft-points
|
|
Without option -graft-points each given disk file is copied into the root
|
|
directory of the ISO image, maintaining its name. If a directory is given,
|
|
then its files and sub-directories are copied into the root directory,
|
|
maintaining their names.
|
|
.br
|
|
$ xorrisofs ... /home/me/datafile /tmp/directory
|
|
.br
|
|
yields in the ISO image root directory:
|
|
.br
|
|
/datafile
|
|
.br
|
|
/file_1_from_directory
|
|
.br
|
|
...
|
|
.br
|
|
/file_N_from_directory
|
|
.br
|
|
.sp 1
|
|
With option -graft-points it is possible to put files and directories to
|
|
arbitrary paths in the ISO image.
|
|
.br
|
|
$ xorrisofs ... -graft-points /home/me/datafile /dir=/tmp/directory
|
|
.br
|
|
yields in the ISO image root directory:
|
|
.br
|
|
/datafile
|
|
.br
|
|
/dir
|
|
.br
|
|
Eventually needed parent directories in
|
|
the image will be created automatically:
|
|
.br
|
|
/datafiles/file1=/home/me/datafile
|
|
.br
|
|
yields in the ISO image:
|
|
.br
|
|
/datafiles/file1
|
|
.br
|
|
The attributes of directory /datafiles get copied from /home/me on disk.
|
|
.br
|
|
.sp 1
|
|
Normally one should avoid = and \\ characters in the ISO part of a pathspec.
|
|
But if it must be, one may escape them:
|
|
.br
|
|
/with_\\=_and_\\\\/file=/tmp/directory/file
|
|
.br
|
|
yields in the ISO image:
|
|
.br
|
|
/with_=_and_\\/file
|
|
.SS
|
|
.B Perform multi-session runs
|
|
This example works for multi-session media only:
|
|
CD-R[W], DVD-R[W], DVD+R, BD-R.
|
|
Add cdrskin option --grow_overwriteable_iso
|
|
to all -as cdrecord runs
|
|
in order to enable multi-session emulation on overwriteable media.
|
|
.br
|
|
The first session is written like this:
|
|
.br
|
|
$ xorrisofs -graft-points \\
|
|
.br
|
|
/tree1=prepared_for_iso/tree1 \\
|
|
.br
|
|
| xorriso -as cdrecord -v dev=/dev/sr0 blank=fast -multi -eject -
|
|
.br
|
|
Follow-up sessions are written like this:
|
|
.br
|
|
$ dd if=/dev/sr0 count=1 >/dev/null 2>&1
|
|
.br
|
|
$ m=$(xorriso -as cdrecord dev=/dev/sr0 -msinfo)
|
|
.br
|
|
$ xorrisofs -M /dev/sr0 -C $m -graft-points \\
|
|
.br
|
|
/tree2=prepared_for_iso/tree2 \\
|
|
.br
|
|
| xorriso -as cdrecord -v dev=/dev/sr0 -waiti -multi -eject -
|
|
.br
|
|
Always eject the drive tray between sessions. The old sessions
|
|
get read via /dev/sr0. Its device driver might not be aware
|
|
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,
|
|
but rather do this manually or by a program that reads from /dev/sr0.
|
|
.SS
|
|
.B Let xorrisofs work underneath growisofs
|
|
growisofs expects an ISO formatter program which understands options -C and
|
|
-M. A variable is defined to override the hardcoded default name.
|
|
.br
|
|
$ export MKISOFS="xorrisofs"
|
|
.br
|
|
$ growisofs -Z /dev/dvd /some/files
|
|
.br
|
|
$ 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:
|
|
.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
|
|
start with "-o" but -outdev must be set to "-".
|
|
So use "outdev" instead:
|
|
.br
|
|
$ growisofs -Z /dev/dvd --for_backup -- \\
|
|
.br
|
|
outdev - -update_r /my/files /files
|
|
.br
|
|
$ growisofs -M /dev/dvd --for_backup -- \\
|
|
.br
|
|
outdev - -update_r /my/files /files
|
|
.br
|
|
Note that --for_backup is given in the mkisofs emulation.
|
|
To preserve the recorded extra data it must already be in effect, when
|
|
the emulation loads the image.
|
|
.SS
|
|
.B Incremental backup of a few directory trees
|
|
This changes the directory trees /open_source_project and /personal_mail
|
|
in the ISO image so that they become exact copies of their disk counterparts.
|
|
ISO file objects get created, deleted or get their attributes adjusted
|
|
accordingly.
|
|
.br
|
|
ACL, xattr, hard links and MD5 checksums will be recorded.
|
|
It is expected that inode numbers in the disk filesystem are persistent
|
|
over cycles of mounting and booting.
|
|
Files with names matching *.o or *.swp get excluded explicitly.
|
|
.br
|
|
.sp 1
|
|
To be used several times on the same media, whenever an update of
|
|
the two disk trees to the media is desired. Begin with blank media and start
|
|
a new blank media when the run fails due to lack of remaining space on
|
|
the old one.
|
|
.br
|
|
Do not let xorriso -as cdrecord load the media,
|
|
but rather do this manually or by a program that reads from /dev/sr0.
|
|
.br
|
|
$ dd if=/dev/sr0 count=1 >/dev/null 2>&1
|
|
.br
|
|
$ msinfo=$(xorriso -as cdrecord dev=/dev/sr0 -msinfo)
|
|
.br
|
|
$ load_opts=
|
|
.br
|
|
$ test -n "$msinfo" && load_opts="-M /dev/sr0 -C $msinfo"
|
|
.br
|
|
$ xorrisofs $load_opts -o - --for_backup -m '*.o' -m '*.swp' \\
|
|
.br
|
|
-V PROJ_MAIL_"$(date '+%Y_%m_%d_%H%M%S')" -graft-points \\
|
|
.br
|
|
-old-root / \\
|
|
.br
|
|
/projects=/home/thomas/projects \\
|
|
.br
|
|
/personal_mail=/home/thomas/personal_mail \\
|
|
.br
|
|
| xorriso -as cdrecord dev=/dev/sr0 -v -multi -waiti -eject -
|
|
.br
|
|
.sp 1
|
|
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.
|
|
.br
|
|
.sp 1
|
|
\fBBetter do not use your youngest backup for -old-root\fR.
|
|
Have at least two media which you use alternatingly. So only older backups
|
|
get endangered by the new write operation, while the newest backup is
|
|
stored safely on a different media.
|
|
Always have a blank media ready to perform a full backup in case the update
|
|
attempt fails due to insufficient remaining capacity.
|
|
.br
|
|
.sp 1
|
|
If inode numbers on disk are not persistent, then use
|
|
option --old-root-no-ino .
|
|
In this case an update run will compare recorded MD5
|
|
sums against the current file content on hard disk.
|
|
.br
|
|
.sp 1
|
|
With \fBmount\fR option \fB\-o "sbsector="\fR on GNU/Linux
|
|
resp. \fB\-s\fR on FreeBSD
|
|
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:
|
|
.br
|
|
$ xorriso -dev /dev/sr0 -toc
|
|
.br
|
|
xorriso can print the matching mount command for a session number:
|
|
.br
|
|
$ xorriso -mount_cmd /dev/sr0 session 12 /mnt
|
|
.br
|
|
or for a volume id that matches a search expression:
|
|
.br
|
|
$ xorriso -mount_cmd /dev/sr0 volid '*2008_12_05*' /mnt
|
|
.br
|
|
Both yield on standard output something like:
|
|
.br
|
|
mount -t iso9660 -o nodev,noexec,nosuid,ro,sbsector=1460256 '/dev/sr0' '/mnt'
|
|
.br
|
|
The superuser may let xorriso execute the mount command directly:
|
|
.br
|
|
# osirrox -mount /dev/sr0 "volid" '*2008_12_05*' /mnt
|
|
.SS
|
|
.B Incremental backup with accumulated trees
|
|
Solaris does not offer the option to mount older sessions.
|
|
In order to keep them accessible, one may map all files to a file tree under
|
|
a session directory and accumulate those directories from session to session.
|
|
The -root tree is cloned from the -old-root tree before it gets
|
|
compared with the appropriate trees on disk.
|
|
.br
|
|
This demands to know the previously used session directory name.
|
|
.br
|
|
With the first session:
|
|
.br
|
|
$ xorrisofs -root /session1 \\
|
|
.br
|
|
-o - --for_backup -m '*.o' -m '*.swp' \\
|
|
.br
|
|
-V PROJ_MAIL_"$(date '+%Y_%m_%d_%H%M%S')" -graft-points \\
|
|
.br
|
|
/projects=/home/thomas/projects \\
|
|
.br
|
|
/personal_mail=/home/thomas/personal_mail \\
|
|
.br
|
|
| xorriso -as cdrecord dev=/dev/sr0 -v blank=as_needed \\
|
|
.br
|
|
-multi -waiti -eject -
|
|
.br
|
|
.sp 1
|
|
With the second session, option -old-root refers to /session1 and the
|
|
new -root is /session2.
|
|
.br
|
|
Do not let xorriso -as cdrecord load the media,
|
|
but rather do this manually or by a program that reads from /dev/sr0.
|
|
.br
|
|
$ dd if=/dev/sr0 count=1 >/dev/null 2>&1
|
|
.br
|
|
$ msinfo=$(xorriso -as cdrecord dev=/dev/sr0 -msinfo)
|
|
.br
|
|
$ load_opts=
|
|
.br
|
|
$ test -n "$msinfo" && load_opts="-M /dev/sr0 -C $msinfo"
|
|
.br
|
|
$ xorrisofs $load_opts -root /session2 -old-root /session1 \\
|
|
.br
|
|
-o - --for_backup -m '*.o' -m '*.swp' \\
|
|
.br
|
|
-V PROJ_MAIL_"$(date '+%Y_%m_%d_%H%M%S')" -graft-points \\
|
|
.br
|
|
/projects=/home/thomas/projects \\
|
|
.br
|
|
/personal_mail=/home/thomas/personal_mail \\
|
|
.br
|
|
| xorriso -as cdrecord dev=/dev/sr0 -v -multi -waiti -eject -
|
|
.br
|
|
With the third session, option -old-root refers to /session2.
|
|
The new -root is /session3. And so on.
|
|
.SS
|
|
.B Create bootable images for PC-BIOS
|
|
The ISOLINUX wiki prescribes to create on disk a directory ./CD_root and
|
|
to copy all desired files underneath that directory. Especially file
|
|
isolinux.bin shall be copied to ./CD_root/isolinux/isolinux.bin .
|
|
This is the boot image file.
|
|
.br
|
|
The prescribed mkisofs options can be used unchanged with xorrisofs:
|
|
.br
|
|
$ xorrisofs -o output.iso \\
|
|
.br
|
|
-b isolinux/isolinux.bin -c isolinux/boot.cat \\
|
|
.br
|
|
-no-emul-boot -boot-load-size 4 -boot-info-table \\
|
|
.br
|
|
./CD_root
|
|
.br
|
|
Put it on CD by a burn program. E.g.:
|
|
.br
|
|
$ xorriso -as cdrecord -v dev=/dev/sr0 blank=as_needed output.iso
|
|
.br
|
|
.sp 1
|
|
The image from above example will boot from CD, DVD or BD, but not from
|
|
USB stick or other hard-disk-like devices. This can be done by help of an
|
|
isohybrid MBR. Syslinux provides matching template files
|
|
as isohdp[fp]x*.bin . E.g. /usr/lib/syslinux/isohdpfx.bin .
|
|
.br
|
|
If a few hundred KB of size do not matter, then option -partition_offset
|
|
can be used to create a partition table where partition 1 starts not
|
|
at block 0. This facilitates later manipulations of the USB stick by
|
|
tools for partitioning and formatting.
|
|
.br
|
|
The image from the following example will be prepared for booting via MBR
|
|
and its first parttion will start at hard disk block 64.
|
|
.br
|
|
It will also boot from optical media.
|
|
.br
|
|
$ xorrisofs -o output.iso \\
|
|
-b isolinux/isolinux.bin -c isolinux/boot.cat \\
|
|
-no-emul-boot -boot-load-size 4 -boot-info-table \\
|
|
.br
|
|
-isohybrid-mbr /usr/lib/syslinux/isohdpfx.bin \\
|
|
.br
|
|
-partition_offset 16 \\
|
|
.br
|
|
./CD_root
|
|
.br
|
|
Become superuser and copy the image to the unpartitioned base device file
|
|
of the USB stick. On GNU/Linux this is e.g. /dev/sdb, not /dev/sdb1.
|
|
.br
|
|
CAUTION:
|
|
This will overwrite any eventual partitioning on the USB stick and make
|
|
remaining data unaccessible.
|
|
.br
|
|
So first make sure you got the correct address of the intended device.
|
|
E.g. by reading 100 MiB data from it and watching it blinking:
|
|
.br
|
|
# dd bs=2K if=/dev/sdb count=50K >/dev/null
|
|
.br
|
|
Now copy the image onto it
|
|
.br
|
|
# dd bs=2K if=output.iso of=/dev/sdb
|
|
.br
|
|
.SH FILES
|
|
.SS
|
|
.B Startup files:
|
|
.br
|
|
If not --no_rc is given as the first argument then xorrisofs
|
|
attempts on startup to read and execute lines from the following files:
|
|
.br
|
|
/etc/default/xorriso
|
|
.br
|
|
/etc/opt/xorriso/rc
|
|
.br
|
|
/etc/xorriso/xorriso.conf
|
|
.br
|
|
$HOME/.xorrisorc
|
|
.br
|
|
The files are read in the sequence given here, but none of them is required
|
|
to exist. The lines are not interpreted as xorrisofs options but as generic
|
|
xorriso commands. See man xorriso.
|
|
.PP
|
|
After the xorriso startup files, the program tries one by one to open for
|
|
reading:
|
|
.br
|
|
./.mkisofsrc
|
|
.br
|
|
$MKISOFSRC
|
|
.br
|
|
$HOME/.mkisofsrc
|
|
.br
|
|
$(dirname $0)/.mkisofsrc
|
|
.br
|
|
On success it interprets the file content and does not try further files.
|
|
The last address is used only if start argument 0 has a non-trivial dirname.
|
|
.br
|
|
The reader currently interprets the following NAME=VALUE pairs:
|
|
.br
|
|
APPI default for -A
|
|
.br
|
|
PUBL default for -publisher
|
|
.br
|
|
SYSI default for -sysid
|
|
.br
|
|
VOLI default for -V
|
|
.br
|
|
VOLS default for -volset
|
|
.br
|
|
Any other lines will be silently ignored.
|
|
.br
|
|
.SH SEE ALSO
|
|
.TP
|
|
For generic xorriso command mode
|
|
.BR xorriso(1)
|
|
.TP
|
|
For mounting xorriso generated ISO 9660 images (-t iso9660)
|
|
.BR mount(8)
|
|
.TP
|
|
Other programs which produce ISO 9660 images
|
|
.BR mkisofs(8),
|
|
.BR genisoimage(8)
|
|
.TP
|
|
Programs which burn sessions to optical media
|
|
.BR growisofs(1),
|
|
.BR cdrecord(1),
|
|
.BR wodim(1),
|
|
.BR cdrskin(1),
|
|
.BR xorriso(1)
|
|
.TP
|
|
ACL and xattr
|
|
.BR getfacl(1),
|
|
.BR setfacl(1),
|
|
.BR getfattr(1),
|
|
.BR setfattr(1)
|
|
.TP
|
|
MD5 checksums
|
|
.BR md5sum(1)
|
|
.SH AUTHOR
|
|
Thomas Schmitt <scdbackup@gmx.net>
|
|
.br
|
|
for libburnia-project.org
|
|
.SH COPYRIGHT
|
|
Copyright (c) 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
|
|
to modify this text under that same license.
|
|
.SH CREDITS
|
|
xorrisofs is in part based on work by Vreixo Formoso who provides libisofs
|
|
together with Mario Danic who also leads the libburnia team.
|
|
.br
|
|
Compliments towards Joerg Schilling whose cdrtools served me for ten years.
|