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

Polished xorrisofs documentation

Browse Source
This commit is contained in:
Thomas Schmitt 2011-03-06 18:37:52 +00:00
parent ab8265b042
commit 1c1e86f168
3 changed files with 231 additions and 173 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
xorriso/xorrisofs.1
View File

@ -9,7 +9,7 @@
.\" First parameter, NAME, should be all caps .\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1) .\" other parameters are allowed: see man(7), man(1)
.TH XORRISOFS 1 "Mar 05, 2011" .TH XORRISOFS 1 "Mar 06, 2011"
.\" Please adjust this date whenever revising the manpage. .\" Please adjust this date whenever revising the manpage.
.\" .\"
.\" Some roff macros, for reference: .\" Some roff macros, for reference:
@ -24,7 +24,7 @@
.\" for manpage-specific macros, see man(7) .\" for manpage-specific macros, see man(7)
.nh .nh
.SH NAME .SH NAME
xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso, xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso
.SH SYNOPSIS .SH SYNOPSIS
.B xorrisofs .B xorrisofs
[ options ] [-o filename ] pathspec [pathspecs ...] [ options ] [-o filename ] pathspec [pathspecs ...]
@ -34,41 +34,22 @@ xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso,
\fBxorrisofs\fR \fBxorrisofs\fR
produces Rock Ridge enhanced ISO 9660 filesystems and add-on sessions to produces Rock Ridge enhanced ISO 9660 filesystems and add-on sessions to
such filesystems. Optionally it can produce Joliet directory trees too. such filesystems. Optionally it can produce Joliet directory trees too.
.br
.PP .PP
xorrisofs understands options of program mkisofs from cdrtools by xorrisofs understands options of program mkisofs from cdrtools by
Joerg Schilling. Joerg Schilling.
Its implementation is part of program xorriso which shares no source Its implementation is part of program xorriso which shares no source
code with cdrtools. code with cdrtools.
.SS .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 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
\fBISO 9660, Rock Ridge, Joliet:\fR \fBISO 9660, Rock Ridge, Joliet:\fR
.br .br
\fBISO 9660\fR \fBISO 9660\fR
(aka \fBECMA-119\fR) describes directories and data files with (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. very restricted filenames with no distinction of upper case and lower case.
Its metadata do not comply to fundamental POSIX specifications. Its metadata do not comply to fundamental POSIX specifications.
.br .br
@ -130,6 +111,31 @@ underneath this directory get inserted into the image, too.
It is possible to exclude particular files from being inserted It is possible to exclude particular files from being inserted
by help of option -m. by help of option -m.
.SS .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 .br
.SH OPTIONS .SH OPTIONS
.br .br
@ -139,12 +145,19 @@ by help of option -m.
.PP .PP
The following options control loading of an existing ISO image for the purpose The following options control loading of an existing ISO image for the purpose
of preparing a suitable add-on session. of preparing a suitable add-on session.
If they are missing then a new image is composed from scratch.
.TP .TP
\fB\-M\fR disk_path \fB\-M\fR disk_path
Set the path from which to load the existing ISO image directory tree 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. on which to base the upcomming directory tree as add-on session.
The path must lead to a random-access readable file object. The path must lead to a random-access readable file object.
On GNU/Linux: regular data files or block device files. 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 .TP
\fB\-prev-session\fR disk_path \fB\-prev-session\fR disk_path
Alias of -M. Alias of -M.
@ -287,7 +300,13 @@ when image production begins. It may not already exist as directory.
If it does not exist yet then its parent directory must exist and If it does not exist yet then its parent directory must exist and
a regular file will get created. a regular file will get created.
.br .br
Default is stdout which may also be set by disk_path "-". 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 .TP
\fB\-output\fR disk_path \fB\-output\fR disk_path
Alias of -o. Alias of -o.
@ -1078,7 +1097,7 @@ the image will be created automatically:
.br .br
/datafiles/file1=/home/me/datafile /datafiles/file1=/home/me/datafile
.br .br
yields in the ISO image yields in the ISO image:
.br .br
/datafiles/file1 /datafiles/file1
.br .br
@ -1090,7 +1109,7 @@ But if it must be, one may escape them:
.br .br
/with_\\=_and_\\\\/file=/tmp/directory/file /with_\\=_and_\\\\/file=/tmp/directory/file
.br .br
yields in the ISO image yields in the ISO image:
.br .br
/with_=_and_\\/file /with_=_and_\\/file
.SS .SS

223
xorriso/xorrisofs.info
View File

@ -17,14 +17,14 @@ File: xorrisofs.info, Node: Top, Next: Overview, Up: (dir)
xorrisofs xorrisofs
********* *********
xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso, xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso
* Menu: * Menu:
* Overview:: Overview * Overview:: Overview
* Xorriso:: Relation to program xorriso
* Standards:: ISO 9660, Rock Ridge, Joliet * Standards:: ISO 9660, Rock Ridge, Joliet
* Insert:: Inserting files into the ISO image * Insert:: Inserting files into the ISO image
* Xorriso:: Relation to program xorriso
* Options:: Options * Options:: Options
* Examples:: Examples * Examples:: Examples
* Files:: Files * Files:: Files
@ -34,51 +34,33 @@ xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso,
* ConceptIdx:: Alphabetic List of Concepts and Objects * ConceptIdx:: Alphabetic List of Concepts and Objects
 
File: xorrisofs.info, Node: Overview, Next: Xorriso, Prev: Top, Up: Top File: xorrisofs.info, Node: Overview, Next: Standards, Prev: Top, Up: Top
1 Overview 1 Overview
********** **********
*xorrisofs* produces Rock Ridge enhanced ISO 9660 filesystems and *xorrisofs* produces Rock Ridge enhanced ISO 9660 filesystems and
add-on sessions to such filesystems. Optionally it can produce Joliet add-on sessions to such filesystems. Optionally it can produce Joliet
directory trees too. xorrisofs understands options of program mkisofs directory trees too.
from cdrtools by Joerg Schilling. Its implementation is part of
program xorriso which shares no source code with cdrtools. 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.
 
File: xorrisofs.info, Node: Xorriso, Next: Standards, Prev: Overview, Up: Top File: xorrisofs.info, Node: Standards, Next: Insert, Prev: Overview, Up: Top
2 Relation to program xorriso 2 ISO 9660, Rock Ridge, Joliet
*****************************
xorrisofs is actually a command mode of program *xorriso*, which gets
entered either by xorriso command "-as mkisofs" or by starting the
program by one of the names "xorrisofs", "mkisofs", "genisoimage", or
"genisofs".
This command mode can be left by argument "--" which leads to generic
xorriso command mode. See *man xorriso* for its description.
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.
The program messages call any file a "drive". File types which are not
supported for reading are reported as "blank". The reported free media
space may be quite fictional.
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.

File: xorrisofs.info, Node: Standards, Next: Insert, Prev: Xorriso, Up: Top
3 ISO 9660, Rock Ridge, Joliet
****************************** ******************************
*ISO 9660* (aka *ECMA-119*) describes directories and data files with *ISO 9660* (aka *ECMA-119*) is a read-only filesystem that is mainly
very restricted filenames with no distinction of upper case and lower used for optical media CD, DVD, BD, but may also reside on other
case. Its metadata do not comply to fundamental POSIX specifications. 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.
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.
*Rock Ridge* is the name of a set of additional information which *Rock Ridge* is the name of a set of additional information which
enhance an ISO 9660 filesystem so that it can represent a POSIX enhance an ISO 9660 filesystem so that it can represent a POSIX
compliant filesystem with ownership, access permissions, symbolic compliant filesystem with ownership, access permissions, symbolic
@ -99,9 +81,9 @@ filenames nevertheless. Production of this directory tree may be
enabled by option -iso-level 4. enabled by option -iso-level 4.
 
File: xorrisofs.info, Node: Insert, Next: Options, Prev: Standards, Up: Top File: xorrisofs.info, Node: Insert, Next: Xorriso, Prev: Standards, Up: Top
4 Inserting files into the ISO image 3 Inserting files into the ISO image
************************************ ************************************
xorrisofs deals with two kinds of file addresses: xorrisofs deals with two kinds of file addresses:
@ -130,7 +112,32 @@ possible to exclude particular files from being inserted by help of
option -m. option -m.
 
File: xorrisofs.info, Node: Options, Next: Examples, Prev: Insert, Up: Top File: xorrisofs.info, Node: Xorriso, Next: Options, Prev: Insert, Up: Top
4 Relation to program xorriso
*****************************
xorrisofs is actually a command mode of program *xorriso*, which gets
entered either by xorriso command "-as mkisofs" or by starting the
program by one of the names "xorrisofs", "mkisofs", "genisoimage", or
"genisofs".
This command mode can be left by argument "--" which leads to generic
xorriso command mode. See *man xorriso* for its description.
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.
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.
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.

File: xorrisofs.info, Node: Options, Next: Examples, Prev: Xorriso, Up: Top
5 Options 5 Options
********* *********
@ -157,13 +164,19 @@ File: xorrisofs.info, Node: Loading, Next: SetInsert, Prev: Options, Up: Opt
============================================= =============================================
The following options control loading of an existing ISO image for the The following options control loading of an existing ISO image for the
purpose of preparing a suitable add-on session. purpose of preparing a suitable add-on session. If they are missing
then a new image is composed from scratch.
-M disk_path -M disk_path
Set the path from which to load the existing ISO image directory Set the path from which to load the existing ISO image directory
tree on which to base the upcomming directory tree as add-on tree on which to base the upcomming directory tree as add-on
session. The path must lead to a random-access readable file session. The path must lead to a random-access readable file
object. On GNU/Linux: regular data files or block device files. object. On GNU/Linux: regular data files or block device files.
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.
-prev-session disk_path -prev-session disk_path
Alias of -M. Alias of -M.
@ -312,7 +325,13 @@ File: xorrisofs.info, Node: SetProduct, Next: SetCompl, Prev: SetInsert, Up:
when image production begins. It may not already exist as when image production begins. It may not already exist as
directory. If it does not exist yet then its parent directory directory. If it does not exist yet then its parent directory
must exist and a regular file will get created. must exist and a regular file will get created.
Default is stdout which may also be set by disk_path "-". 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.
Default is standard output (/dev/fd/1) which may also be set by
disk_path "-".
-output disk_path -output disk_path
Alias of -o. Alias of -o.
@ -1093,7 +1112,7 @@ automatically:
/datafiles/file1=/home/me/datafile /datafiles/file1=/home/me/datafile
yields in the ISO image yields in the ISO image:
/datafiles/file1 /datafiles/file1
@ -1104,7 +1123,7 @@ pathspec. But if it must be, one may escape them:
/with_\=_and_\\/file=/tmp/directory/file /with_\=_and_\\/file=/tmp/directory/file
yields in the ISO image yields in the ISO image:
/with_=_and_\/file /with_=_and_\/file
@ -1425,15 +1444,15 @@ File: xorrisofs.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: T
(line 95) (line 95)
* --efi-boot El Torito EFI boot image: Bootable. (line 58) * --efi-boot El Torito EFI boot image: Bootable. (line 58)
* --embedded-boot Fill System Area e.g. by MBR: SystemArea. (line 27) * --embedded-boot Fill System Area e.g. by MBR: SystemArea. (line 27)
* --emul-toc enable table-of-content emulation: SetProduct. (line 29) * --emul-toc enable table-of-content emulation: SetProduct. (line 35)
* --for_backup Enable backup fidelity: SetExtras. (line 24) * --for_backup Enable backup fidelity: SetExtras. (line 24)
* --hardlinks Recording of hardlink relations: SetExtras. (line 47) * --hardlinks Recording of hardlink relations: SetExtras. (line 47)
* --md5 Recording of MD5 checksums: SetExtras. (line 39) * --md5 Recording of MD5 checksums: SetExtras. (line 39)
* --modification-date set ISO image timestamps: ImageId. (line 82) * --modification-date set ISO image timestamps: ImageId. (line 82)
* --no-emul-toc no table-of-content emulation: SetProduct. (line 38) * --no-emul-toc no table-of-content emulation: SetProduct. (line 44)
* --no_rc do not execute startup files: Miscellaneous. (line 16) * --no_rc do not execute startup files: Miscellaneous. (line 16)
* --old-empty old block addresses for empty files: SetProduct. * --old-empty old block addresses for empty files: SetProduct.
(line 75) (line 81)
* --old-root-devno enable disk idevno with -old-root: SetInsert. * --old-root-devno enable disk idevno with -old-root: SetInsert.
(line 97) (line 97)
* --old-root-no-ino disable disk ino with -old-root: SetInsert. * --old-root-no-ino disable disk ino with -old-root: SetInsert.
@ -1444,9 +1463,9 @@ File: xorrisofs.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: T
* --quoted_path_list read pathspecs from disk file: SetInsert. * --quoted_path_list read pathspecs from disk file: SetInsert.
(line 13) (line 13)
* --scdbackup_tag Recording of MD5 checksum: SetExtras. (line 56) * --scdbackup_tag Recording of MD5 checksum: SetExtras. (line 56)
* --sort-weight set output file address: SetProduct. (line 43) * --sort-weight set output file address: SetProduct. (line 49)
* --stdio_sync control forced output to disk files: SetProduct. * --stdio_sync control forced output to disk files: SetProduct.
(line 19) (line 25)
* --xattr Recording of xattr: SetExtras. (line 33) * --xattr Recording of xattr: SetExtras. (line 33)
* -A set Application Id: ImageId. (line 38) * -A set Application Id: ImageId. (line 38)
* -abstract set Abstract File path: ImageId. (line 66) * -abstract set Abstract File path: ImageId. (line 66)
@ -1460,16 +1479,16 @@ File: xorrisofs.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: T
* -boot-info-table Patch El Torito boot image: Bootable. (line 80) * -boot-info-table Patch El Torito boot image: Bootable. (line 80)
* -boot-load-size El Torito boot image load size: Bootable. (line 63) * -boot-load-size El Torito boot image load size: Bootable. (line 63)
* -c El Torito boot catalog name: Bootable. (line 86) * -c El Torito boot catalog name: Bootable. (line 86)
* -C set load address and write address offset: Loading. (line 22) * -C set load address and write address offset: Loading. (line 28)
* -cdrecord-params set load address and write address offset: Loading. * -cdrecord-params set load address and write address offset: Loading.
(line 37) (line 43)
* -checksum_algorithm_iso choose .jigdo checksums: Jigdo. (line 80) * -checksum_algorithm_iso choose .jigdo checksums: Jigdo. (line 80)
* -checksum_algorithm_template choose .template checksums: Jigdo. * -checksum_algorithm_template choose .template checksums: Jigdo.
(line 87) (line 87)
* -copyright set Copyright File path: ImageId. (line 77) * -copyright set Copyright File path: ImageId. (line 77)
* -d omit trailing dot in ISO file names: SetCompl. (line 50) * -d omit trailing dot in ISO file names: SetCompl. (line 50)
* -dev set path for loading existing ISO image: Loading. (line 19) * -dev set path for loading existing ISO image: Loading. (line 25)
* -dir-mode permissions for all directories: SetProduct. (line 54) * -dir-mode permissions for all directories: SetProduct. (line 60)
* -disallow_dir_id_ext enforce ISO level 1 directory names: SetCompl. * -disallow_dir_id_ext enforce ISO level 1 directory names: SetCompl.
(line 24) (line 24)
* -e El Torito EFI boot image: Bootable. (line 50) * -e El Torito EFI boot image: Bootable. (line 50)
@ -1481,7 +1500,7 @@ File: xorrisofs.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: T
* -exclude-list exclude disk files from inserting: SetInsert. * -exclude-list exclude disk files from inserting: SetInsert.
(line 51) (line 51)
* -f follow symbolic links on disk: SetInsert. (line 24) * -f follow symbolic links on disk: SetInsert. (line 24)
* -file-mode permissions for all data files: SetProduct. (line 60) * -file-mode permissions for all data files: SetProduct. (line 66)
* -follow-links follow symbolic links on disk: SetInsert. (line 28) * -follow-links follow symbolic links on disk: SetInsert. (line 28)
* -full-iso9660-filenames allow 37 characters in ISO file names: SetCompl. * -full-iso9660-filenames allow 37 characters in ISO file names: SetCompl.
(line 61) (line 61)
@ -1516,7 +1535,7 @@ File: xorrisofs.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: T
* -joliet-long allow longer Joliet names: SetExtras. (line 72) * -joliet-long allow longer Joliet names: SetExtras. (line 72)
* -l allow 37 characters in ISO file names: SetCompl. (line 57) * -l allow 37 characters in ISO file names: SetCompl. (line 57)
* -m exclude disk files from inserting: SetInsert. (line 35) * -m exclude disk files from inserting: SetInsert. (line 35)
* -M set path for loading existing ISO image: Loading. (line 10) * -M set path for loading existing ISO image: Loading. (line 11)
* -max-iso9660-filenames allow 37 characters in ISO file names: SetCompl. * -max-iso9660-filenames allow 37 characters in ISO file names: SetCompl.
(line 64) (line 64)
* -md5-list set path of readable .md5: Jigdo. (line 73) * -md5-list set path of readable .md5: Jigdo. (line 73)
@ -1524,7 +1543,7 @@ File: xorrisofs.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: T
* -mipsel-boot MIPS Little Endian boot image: SystemArea. (line 111) * -mipsel-boot MIPS Little Endian boot image: SystemArea. (line 111)
* -N omit version number in ISO file names: SetCompl. (line 67) * -N omit version number in ISO file names: SetCompl. (line 67)
* -no-emul-boot El Torito boot image emulation: Bootable. (line 72) * -no-emul-boot El Torito boot image emulation: Bootable. (line 72)
* -no-pad do not add zeros to ISO tree: SetProduct. (line 70) * -no-pad do not add zeros to ISO tree: SetProduct. (line 76)
* -o set output file address: SetProduct. (line 8) * -o set output file address: SetProduct. (line 8)
* -old-exclude exclude disk files from inserting: SetInsert. * -old-exclude exclude disk files from inserting: SetInsert.
(line 48) (line 48)
@ -1533,12 +1552,12 @@ File: xorrisofs.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: T
(line 54) (line 54)
* -omit-version-number omit version number in ISO file names: SetCompl. * -omit-version-number omit version number in ISO file names: SetCompl.
(line 71) (line 71)
* -output set output file address: SetProduct. (line 16) * -output set output file address: SetProduct. (line 22)
* -output-charset set character set of ISO file names: Charset. * -output-charset set character set of ISO file names: Charset.
(line 21) (line 21)
* -p set Preparer Id: ImageId. (line 54) * -p set Preparer Id: ImageId. (line 54)
* -p set Publisher Id: ImageId. (line 30) * -p set Publisher Id: ImageId. (line 30)
* -pad add 300 KiB of zeros to ISO tree: SetProduct. (line 63) * -pad add 300 KiB of zeros to ISO tree: SetProduct. (line 69)
* -partition_cyl_align Image size alignment: SystemArea. (line 75) * -partition_cyl_align Image size alignment: SystemArea. (line 75)
* -partition_hd_cyl MBR heads per cylinder: SystemArea. (line 58) * -partition_hd_cyl MBR heads per cylinder: SystemArea. (line 58)
* -partition_offset Make mountable by partition 1: SystemArea. * -partition_offset Make mountable by partition 1: SystemArea.
@ -1547,7 +1566,7 @@ File: xorrisofs.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: T
* -path-list read pathspecs from disk file: SetInsert. (line 8) * -path-list read pathspecs from disk file: SetInsert. (line 8)
* -preparer set Preparer Id: ImageId. (line 63) * -preparer set Preparer Id: ImageId. (line 63)
* -prev-session set path for loading existing ISO image: Loading. * -prev-session set path for loading existing ISO image: Loading.
(line 16) (line 22)
* -print-size predict ISO image size: Miscellaneous. (line 8) * -print-size predict ISO image size: Miscellaneous. (line 8)
* -publisher set Publisher Id: ImageId. (line 35) * -publisher set Publisher Id: ImageId. (line 35)
* -quiet suppress most messages: Miscellaneous. (line 24) * -quiet suppress most messages: Miscellaneous. (line 24)
@ -1590,7 +1609,7 @@ File: xorrisofs.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Application Id, set, -A, -appid: ImageId. (line 38) * Application Id, set, -A, -appid: ImageId. (line 38)
* Backup, enable fidelity, --for_backup: SetExtras. (line 24) * Backup, enable fidelity, --for_backup: SetExtras. (line 24)
* Biblio File, set path, -biblio: ImageId. (line 72) * Biblio File, set path, -biblio: ImageId. (line 72)
* Block address, set sort weight, --sort-weight: SetProduct. (line 43) * Block address, set sort weight, --sort-weight: SetProduct. (line 49)
* Bootability, boot catalog hidden, --boot-catalog-hide: Bootable. * Bootability, boot catalog hidden, --boot-catalog-hide: Bootable.
(line 95) (line 95)
* Bootability, boot catalog name, -c, -eltorito-catalog: Bootable. * Bootability, boot catalog name, -c, -eltorito-catalog: Bootable.
@ -1630,7 +1649,7 @@ File: xorrisofs.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* ECMA-119, _definiton: Standards. (line 6) * ECMA-119, _definiton: Standards. (line 6)
* El Torito, _definiton: Bootable. (line 13) * El Torito, _definiton: Bootable. (line 13)
* Examples: Examples. (line 6) * Examples: Examples. (line 6)
* Forced output, control, --stdio_sync: SetProduct. (line 19) * Forced output, control, --stdio_sync: SetProduct. (line 25)
* Hiding, from ISO and Rock Ridge, -hide: SetHide. (line 8) * Hiding, from ISO and Rock Ridge, -hide: SetHide. (line 8)
* Hiding, from ISO and Rock Ridge, -hide-list: SetHide. (line 16) * Hiding, from ISO and Rock Ridge, -hide-list: SetHide. (line 16)
* Hiding, from Joliet, -hide-joliet: SetHide. (line 20) * Hiding, from Joliet, -hide-joliet: SetHide. (line 20)
@ -1644,7 +1663,7 @@ File: xorrisofs.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
(line 97) (line 97)
* Incremental insertion, enable, -old-root: SetInsert. (line 70) * Incremental insertion, enable, -old-root: SetInsert. (line 70)
* ISO 9660, _definiton: Standards. (line 6) * ISO 9660, _definiton: Standards. (line 6)
* ISO 9660:1999, _definiton: Standards. (line 21) * ISO 9660:1999, _definiton: Standards. (line 26)
* ISO file names, allow 37 characters, -l, -full-iso9660-filenames, -max-iso9660-filenames: SetCompl. * ISO file names, allow 37 characters, -l, -full-iso9660-filenames, -max-iso9660-filenames: SetCompl.
(line 57) (line 57)
* ISO file names, allow lowercase, -allow-lowercase: SetCompl. * ISO file names, allow lowercase, -allow-lowercase: SetCompl.
@ -1676,7 +1695,7 @@ File: xorrisofs.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Jigdo Template Extraction, -jigdo-template-compress: Jigdo. (line 76) * Jigdo Template Extraction, -jigdo-template-compress: Jigdo. (line 76)
* Jigdo Template Extraction, -md5-list: Jigdo. (line 73) * Jigdo Template Extraction, -md5-list: Jigdo. (line 73)
* Jigdo Template Extraction, _definition: Jigdo. (line 6) * Jigdo Template Extraction, _definition: Jigdo. (line 6)
* Joliet, _definiton: Standards. (line 16) * Joliet, _definiton: Standards. (line 21)
* Joliet, allows longer names, -joliet-long: SetExtras. (line 72) * Joliet, allows longer names, -joliet-long: SetExtras. (line 72)
* Joliet, enable, -J, -joliet: SetExtras. (line 65) * Joliet, enable, -J, -joliet: SetExtras. (line 65)
* Links, follow on disk, -f, -follow-links: SetInsert. (line 24) * Links, follow on disk, -f, -follow-links: SetInsert. (line 24)
@ -1690,31 +1709,31 @@ File: xorrisofs.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
(line 46) (line 46)
* Options, list, -help: Miscellaneous. (line 20) * Options, list, -help: Miscellaneous. (line 20)
* Output file, set address, -o, -output: SetProduct. (line 8) * Output file, set address, -o, -output: SetProduct. (line 8)
* Padding, 300 KiB, -pad: SetProduct. (line 63) * Padding, 300 KiB, -pad: SetProduct. (line 69)
* Padding, disable, --old-empty: SetProduct. (line 75) * Padding, disable, --old-empty: SetProduct. (line 81)
* Padding, disable, -no-pad: SetProduct. (line 70) * Padding, disable, -no-pad: SetProduct. (line 76)
* pathspec, _definition: Insert. (line 11) * pathspec, _definition: Insert. (line 11)
* pathspec, enable target=source, -graft-points: SetInsert. (line 31) * pathspec, enable target=source, -graft-points: SetInsert. (line 31)
* pathspec, read list of, --quoted_path_list: SetInsert. (line 13) * pathspec, read list of, --quoted_path_list: SetInsert. (line 13)
* pathspec, read list of, -path-list: SetInsert. (line 8) * pathspec, read list of, -path-list: SetInsert. (line 8)
* Permissions, for all data files, -file-mode: SetProduct. (line 60) * Permissions, for all data files, -file-mode: SetProduct. (line 66)
* Permissions, for all directories, -dir-mode: SetProduct. (line 54) * Permissions, for all directories, -dir-mode: SetProduct. (line 60)
* Preparer Id, set, -p: ImageId. (line 54) * Preparer Id, set, -p: ImageId. (line 54)
* Program version, report, -version: Miscellaneous. (line 34) * Program version, report, -version: Miscellaneous. (line 34)
* Publisher Id, set, -p, -publisher: ImageId. (line 30) * Publisher Id, set, -p, -publisher: ImageId. (line 30)
* Rock Ridge, (always enabled), -R, -rock: SetExtras. (line 8) * Rock Ridge, (always enabled), -R, -rock: SetExtras. (line 8)
* Rock Ridge, _definiton: Standards. (line 9) * Rock Ridge, _definiton: Standards. (line 14)
* Rock Ridge, altered owner and permission, -r, -rational-rock: SetExtras. * Rock Ridge, altered owner and permission, -r, -rational-rock: SetExtras.
(line 15) (line 15)
* scdbackup, record checksum tag, --scdbackup_tag: SetExtras. (line 56) * scdbackup, record checksum tag, --scdbackup_tag: SetExtras. (line 56)
* Session, select path, -M, -prev-session, -dev: Loading. (line 10) * Session, select path, -M, -prev-session, -dev: Loading. (line 11)
* Session, set load and write address, -C, -cdrecord-params: Loading. * Session, set load and write address, -C, -cdrecord-params: Loading.
(line 22) (line 28)
* Startup files, suppress, --no_rc: Miscellaneous. (line 16) * Startup files, suppress, --no_rc: Miscellaneous. (line 16)
* System Area, _definiton: SystemArea. (line 6) * System Area, _definiton: SystemArea. (line 6)
* System Id, set, -sysid: ImageId. (line 49) * System Id, set, -sysid: ImageId. (line 49)
* Table-of-content, emulation off, --no-emul-toc: SetProduct. (line 38) * Table-of-content, emulation off, --no-emul-toc: SetProduct. (line 44)
* Table-of-content, emulation, --emul-toc: SetProduct. (line 29) * Table-of-content, emulation, --emul-toc: SetProduct. (line 35)
* Verbosity, high, -v, -verbose: Miscellaneous. (line 28) * Verbosity, high, -v, -verbose: Miscellaneous. (line 28)
* Volume Id, set, -V, -volid: ImageId. (line 13) * Volume Id, set, -V, -volid: ImageId. (line 13)
* Volume Set Id, set, -volset: ImageId. (line 26) * Volume Set Id, set, -volset: ImageId. (line 26)
@ -1728,35 +1747,35 @@ File: xorrisofs.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
 
Tag Table: Tag Table:
Node: Top397 Node: Top397
Node: Overview1053 Node: Overview1052
Node: Xorriso1487 Node: Standards1488
Node: Standards2621 Node: Insert3163
Node: Insert4024 Node: Xorriso4584
Node: Options5445 Node: Options5720
Node: Loading6161 Node: Loading6437
Node: SetInsert7792 Node: SetInsert8474
Node: SetProduct12194 Node: SetProduct12876
Node: SetCompl15533 Node: SetCompl16583
Node: SetExtras17852 Node: SetExtras18902
Node: SetHide20580 Node: SetHide21630
Node: ImageId21588 Node: ImageId22638
Node: Bootable25092 Node: Bootable26142
Node: SystemArea29172 Node: SystemArea30222
Node: Charset35532 Node: Charset36582
Node: Jigdo36557 Node: Jigdo37607
Node: Miscellaneous40838 Node: Miscellaneous41888
Node: Examples42011 Node: Examples43061
Node: ExSimple42497 Node: ExSimple43547
Node: ExGraft42976 Node: ExGraft44026
Node: ExMkisofs44221 Node: ExMkisofs45273
Node: ExGrowisofs45146 Node: ExGrowisofs46198
Node: ExIncBackup46127 Node: ExIncBackup47179
Node: ExIncBckAcc49017 Node: ExIncBckAcc50069
Node: ExBootable50533 Node: ExBootable51585
Node: Files52489 Node: Files53541
Node: Seealso53559 Node: Seealso54611
Node: Legal54074 Node: Legal55126
Node: CommandIdx54870 Node: CommandIdx55922
Node: ConceptIdx66203 Node: ConceptIdx67255
 
End Tag Table End Tag Table

100
xorriso/xorrisofs.texi
View File

@ -44,7 +44,7 @@
@c man .\" First parameter, NAME, should be all caps @c man .\" First parameter, NAME, should be all caps
@c man .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection @c man .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
@c man .\" other parameters are allowed: see man(7), man(1) @c man .\" other parameters are allowed: see man(7), man(1)
@c man .TH XORRISOFS 1 "Mar 05, 2011" @c man .TH XORRISOFS 1 "Mar 06, 2011"
@c man .\" Please adjust this date whenever revising the manpage. @c man .\" Please adjust this date whenever revising the manpage.
@c man .\" @c man .\"
@c man .\" Some roff macros, for reference: @c man .\" Some roff macros, for reference:
@ -83,13 +83,13 @@ Permission is granted to distrubute this text freely.
@c man-ignore-lines 1 @c man-ignore-lines 1
@c man .SH NAME @c man .SH NAME
xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso, xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso
@end ifnottex @end ifnottex
@menu @menu
* Overview:: Overview * Overview:: Overview
* Xorriso:: Relation to program xorriso
* Standards:: ISO 9660, Rock Ridge, Joliet * Standards:: ISO 9660, Rock Ridge, Joliet
* Insert:: Inserting files into the ISO image * Insert:: Inserting files into the ISO image
* Xorriso:: Relation to program xorriso
* Options:: Options * Options:: Options
* Examples:: Examples * Examples:: Examples
* Files:: Files * Files:: Files
@ -98,7 +98,7 @@ xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso,
* CommandIdx:: Alphabetic Command List * CommandIdx:: Alphabetic Command List
* ConceptIdx:: Alphabetic List of Concepts and Objects * ConceptIdx:: Alphabetic List of Concepts and Objects
@end menu @end menu
@node Overview, Xorriso, Top, Top @node Overview, Standards, Top, Top
@chapter Overview @chapter Overview
@c man .SH SYNOPSIS @c man .SH SYNOPSIS
@c man .B xorrisofs @c man .B xorrisofs
@ -109,49 +109,27 @@ xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso,
@strong{xorrisofs} @strong{xorrisofs}
produces Rock Ridge enhanced ISO 9660 filesystems and add-on sessions to produces Rock Ridge enhanced ISO 9660 filesystems and add-on sessions to
such filesystems. Optionally it can produce Joliet directory trees too. such filesystems. Optionally it can produce Joliet directory trees too.
@*
@sp 1
@c man .PP @c man .PP
xorrisofs understands options of program mkisofs from cdrtools by xorrisofs understands options of program mkisofs from cdrtools by
Joerg Schilling. Joerg Schilling.
Its implementation is part of program xorriso which shares no source Its implementation is part of program xorriso which shares no source
code with cdrtools. code with cdrtools.
@c man .SS @c man .SS
@node Xorriso, Standards, Overview, Top @node Standards, Insert, Overview, Top
@chapter Relation to program xorriso
@c man \fBRelation to program xorriso:\fR
@c man .br
@cindex xorriso, mkisofs emulation
xorrisofs is actually a command mode of program @strong{xorriso},
which gets entered either by xorriso command "-as mkisofs" or by
starting the program by one of the names "xorrisofs", "mkisofs",
"genisoimage", or "genisofs".
@*
This command mode can be left by argument "@minus{}@minus{}" which leads
to generic xorriso command mode. See @strong{man xorriso} for its description.
@*
@sp 1
@c man .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.
@*
The program messages call any file a "drive". File types which are not
supported for reading are reported as "blank". The reported free media
space may be quite fictional.
@*
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.
@c man .SS
@node Standards, Insert, Xorriso, Top
@chapter ISO 9660, Rock Ridge, Joliet @chapter ISO 9660, Rock Ridge, Joliet
@c man \fBISO 9660, Rock Ridge, Joliet:\fR @c man \fBISO 9660, Rock Ridge, Joliet:\fR
@c man .br @c man .br
@cindex ISO 9660, _definiton @cindex ISO 9660, _definiton
@cindex ECMA-119, _definiton @cindex ECMA-119, _definiton
@strong{ISO 9660} @strong{ISO 9660}
(aka @strong{ECMA-119}) describes directories and data files with (aka @strong{ECMA-119}) 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.
@*
ISO 9660 describes directories and data files by
very restricted filenames with no distinction of upper case and lower case. very restricted filenames with no distinction of upper case and lower case.
Its metadata do not comply to fundamental POSIX specifications. Its metadata do not comply to fundamental POSIX specifications.
@* @*
@ -184,7 +162,7 @@ Production of this directory tree may be enabled by option -iso-level 4.
@c man .SS @c man .SS
@sp 1 @sp 1
@c man .B Inserting files into the ISO image: @c man .B Inserting files into the ISO image:
@node Insert, Options, Standards, Top @node Insert, Xorriso, Standards, Top
@chapter Inserting files into the ISO image @chapter Inserting files into the ISO image
@c man .PP @c man .PP
xorrisofs deals with two kinds of file addresses: xorrisofs deals with two kinds of file addresses:
@ -224,7 +202,36 @@ underneath this directory get inserted into the image, too.
It is possible to exclude particular files from being inserted It is possible to exclude particular files from being inserted
by help of option -m. by help of option -m.
@c man .SS @c man .SS
@node Options, Examples, Insert, top @node Xorriso, Options, Insert, Top
@chapter Relation to program xorriso
@c man \fBRelation to program xorriso:\fR
@c man .br
@cindex xorriso, mkisofs emulation
xorrisofs is actually a command mode of program @strong{xorriso},
which gets entered either by xorriso command "-as mkisofs" or by
starting the program by one of the names "xorrisofs", "mkisofs",
"genisoimage", or "genisofs".
@*
This command mode can be left by argument "@minus{}@minus{}" which leads
to generic xorriso command mode. See @strong{man xorriso} for its description.
@*
@sp 1
@c man .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.
@*
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.
@*
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.
@c man .SS
@node Options, Examples, Xorriso, top
@chapter Options @chapter Options
@cindex xorriso, options @cindex xorriso, options
@c man .br @c man .br
@ -252,6 +259,7 @@ by help of option -m.
@c man .PP @c man .PP
The following options control loading of an existing ISO image for the purpose The following options control loading of an existing ISO image for the purpose
of preparing a suitable add-on session. of preparing a suitable add-on session.
If they are missing then a new image is composed from scratch.
@table @asis @table @asis
@sp 1 @sp 1
@c man .TP @c man .TP
@ -262,6 +270,12 @@ 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. on which to base the upcomming directory tree as add-on session.
The path must lead to a random-access readable file object. The path must lead to a random-access readable file object.
On GNU/Linux: regular data files or block device files. On GNU/Linux: regular data files or block device files.
@*
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.
@c man .TP @c man .TP
@item -prev-session disk_path @item -prev-session disk_path
@kindex -prev-session set path for loading existing ISO image @kindex -prev-session set path for loading existing ISO image
@ -450,7 +464,13 @@ when image production begins. It may not already exist as directory.
If it does not exist yet then its parent directory must exist and If it does not exist yet then its parent directory must exist and
a regular file will get created. a regular file will get created.
@* @*
Default is stdout which may also be set by disk_path "-". 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.
@*
Default is standard output (/dev/fd/1) which may also be set by disk_path "-".
@c man .TP @c man .TP
@item -output disk_path @item -output disk_path
@kindex -output set output file address @kindex -output set output file address
@ -1507,7 +1527,7 @@ the image will be created automatically:
/datafiles/file1=/home/me/datafile /datafiles/file1=/home/me/datafile
@* @*
@sp 1 @sp 1
yields in the ISO image yields in the ISO image:
@sp 1 @sp 1
@* @*
/datafiles/file1 /datafiles/file1
@ -1524,7 +1544,7 @@ But if it must be, one may escape them:
/with_\=_and_\\/file=/tmp/directory/file /with_\=_and_\\/file=/tmp/directory/file
@* @*
@sp 1 @sp 1
yields in the ISO image yields in the ISO image:
@* @*
@sp 1 @sp 1
/with_=_and_\/file /with_=_and_\/file