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

Wrapped @command{} around the word xorrisofs in its manual

Browse Source
This commit is contained in:
Thomas Schmitt 2011-05-17 09:41:04 +00:00
parent 4952c1837c
commit 9a52fd6192
1 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
libisoburn/trunk/xorriso/xorrisofs.texi
View File

@ -111,13 +111,13 @@ xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso
@c man .br @c man .br
@c man .SH DESCRIPTION @c man .SH DESCRIPTION
@c man .PP @c man .PP
@strong{xorrisofs} @command{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 @sp 1
@c man .PP @c man .PP
xorrisofs understands options of program mkisofs from cdrtools by @command{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.
@ -146,7 +146,8 @@ with ownership, access permissions, symbolic links, and other attributes.
Rock Ridge allows filenames of up to 255 bytes and paths of up to Rock Ridge allows filenames of up to 255 bytes and paths of up to
1024 bytes. 1024 bytes.
@* @*
Rock Ridge information is produced unconditionally with any xorrisofs image. Rock Ridge information is produced unconditionally with any @command{xorrisofs}
image.
@* @*
@cindex Joliet, _definiton @cindex Joliet, _definiton
@strong{Joliet} @strong{Joliet}
@ -170,7 +171,7 @@ Production of this directory tree may be enabled by option -iso-level 4.
@node Insert, Xorriso, 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: @command{xorrisofs} deals with two kinds of file addresses:
@* @*
@cindex disk_path, _definition @cindex disk_path, _definition
@strong{disk_path} @strong{disk_path}
@ -185,7 +186,7 @@ confuse with the lowlevel ISO 9660 names visible if Rock Ridge gets ignored.)
@sp 1 @sp 1
@c man .PP @c man .PP
A program argument is handled as a @strong{pathspec}, if it is not A program argument is handled as a @strong{pathspec}, if it is not
recognized as original mkisofs option or additional xorrisofs option. recognized as original mkisofs option or additional @command{xorrisofs} option.
A pathspec depicts an input file object by a disk_path. A pathspec depicts an input file object by a disk_path.
If option -graft-points is not present, then the behavior depends on the If option -graft-points is not present, then the behavior depends on the
file type of disk_path. Directories get merged with the /-directory of the file type of disk_path. Directories get merged with the /-directory of the
@ -218,7 +219,7 @@ Non-directories may not overwrite existing directories.
@c man \fBRelation to program xorriso:\fR @c man \fBRelation to program xorriso:\fR
@c man .br @c man .br
@cindex xorriso, mkisofs emulation @cindex xorriso, mkisofs emulation
xorrisofs is actually a command mode of program @strong{xorriso}, @command{xorrisofs} is actually a command mode of program @strong{xorriso},
which gets entered either by xorriso command "-as mkisofs" or by which gets entered either by xorriso command "-as mkisofs" or by
starting the program by one of the names "xorrisofs", "mkisofs", starting the program by one of the names "xorrisofs", "mkisofs",
"genisoimage", or "genisofs". "genisoimage", or "genisofs".
@ -236,7 +237,7 @@ 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 supported for reading are reported as "blank". The reported free media
space may be quite fictional. space may be quite fictional.
@* @*
Nevertheless xorrisofs does not operate directly on optical drives, Nevertheless @command{xorrisofs} does not operate directly on optical drives,
but rather forces libburn to regard them as general device files. 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) 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. one will have to use a burn program. E.g the cdrecord emulation of xorriso.
@ -697,8 +698,8 @@ Alias of -N.
@kindex -R Rock Ridge (is always enabled) @kindex -R Rock Ridge (is always enabled)
@cindex Rock Ridge, (always enabled), -R, -rock @cindex Rock Ridge, (always enabled), -R, -rock
@* @*
With mkisofs this option enables Rock Ridge extensions. xorrisofs produces With mkisofs this option enables Rock Ridge extensions. @command{xorrisofs}
them unconditionally. produces them unconditionally.
@c man .TP @c man .TP
@item -rock @item -rock
@kindex -rock Rock Ridge (is always enabled) @kindex -rock Rock Ridge (is always enabled)
@ -967,7 +968,7 @@ 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 the files of a boot loader. The boot facilities of computers get
directed to such files, which usually execute further program files directed to such files, which usually execute further program files
from the ISO image. from the ISO image.
xorrisofs can produce several kinds of boot block or boot record, @command{xorrisofs} can produce several kinds of boot block or boot record,
which become part of the ISO image, and get interpreted by the according which become part of the ISO image, and get interpreted by the according
boot facility. boot facility.
@* @*
@ -988,7 +989,7 @@ El Torito gets interpreted by boot facilities PC-BIOS and EFI.
Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images
for PC-BIOS. for PC-BIOS.
@* @*
xorrisofs supports the example options out of the ISOLINUX wiki, @command{xorrisofs} supports the example options out of the ISOLINUX wiki,
the options used in GRUB script grub-mkrescue, and the example in the the options used in GRUB script grub-mkrescue, and the example in the
FreeBSD AvgLiveCD wiki. FreeBSD AvgLiveCD wiki.
@* @*
@ -1104,7 +1105,7 @@ a MBR for booting via PC-BIOS from USB stick or hard disk.
A @strong{MBR} (Master Boot Record) contains boot code and a partition table. A @strong{MBR} (Master Boot Record) contains boot code and a partition table.
It does not hamper El Torito booting from CDROM. It does not hamper El Torito booting from CDROM.
@* @*
xorrisofs supports boot facilities other than PC-BIOS: @command{xorrisofs} supports boot facilities other than PC-BIOS:
MIPS Big Endian (SGI), MIPS Little Endian (DEC), SUN SPARC. MIPS Big Endian (SGI), MIPS Little Endian (DEC), SUN SPARC.
Those are mutually not combinable and also not combinable with MBR. Those are mutually not combinable and also not combinable with MBR.
@* @*
@ -1309,7 +1310,7 @@ and DVD ISO images are published on the web in jigdo format to allow
end users to download them more efficiently." end users to download them more efficiently."
@* @*
If the use of libjte was enabled at compile time of xorriso, then 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 @command{xorrisofs} can produce a .jigdo and a .template file together with a
single-session ISO image. If not, then Jigdo options will cause a single-session ISO image. If not, then Jigdo options will cause a
FAILURE event, which normally leads to program abort. FAILURE event, which normally leads to program abort.
@* @*
@ -1324,7 +1325,8 @@ The .jigdo file contains checksums and symbolic file addresses.
The .template file contains the compressed ISO image with reference tags The .template file contains the compressed ISO image with reference tags
instead of the content bytes of the listed files. instead of the content bytes of the listed files.
@* @*
Input for this process are the normal arguments for a xorrisofs session Input for this process are the normal arguments for a @command{xorrisofs}
session
with no image loaded, and a .md5 file which lists those data files which may be 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. 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: Each designated file is represented in the .md5 file by a single text line:
@ -1842,7 +1844,7 @@ to copy all desired files underneath that directory. Especially file
isolinux.bin shall be copied to ./CD_root/isolinux/isolinux.bin . isolinux.bin shall be copied to ./CD_root/isolinux/isolinux.bin .
This is the boot image file. This is the boot image file.
@* @*
The prescribed mkisofs options can be used unchanged with xorrisofs: The prescribed mkisofs options can be used unchanged with @command{xorrisofs}:
@* @*
@sp 1 @sp 1
$ xorrisofs -o output.iso \ $ xorrisofs -o output.iso \
@ -1917,7 +1919,7 @@ Now copy the image onto it
@c man .B Startup files: @c man .B Startup files:
@section Startup Files @section Startup Files
@* @*
If not --no_rc is given as the first argument then xorrisofs If not --no_rc is given as the first argument then @command{xorrisofs}
attempts on startup to read and execute lines from the following files: attempts on startup to read and execute lines from the following files:
@* @*
@sp 1 @sp 1
@ -1931,8 +1933,8 @@ attempts on startup to read and execute lines from the following files:
@* @*
@sp 1 @sp 1
The files are read in the sequence given here, but none of them is required 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 to exist. The lines are not interpreted as @command{xorrisofs} options but
xorriso commands. See man xorriso. as generic xorriso commands. See man xorriso.
@c man .PP @c man .PP
After the xorriso startup files, the program tries one by one to open for After the xorriso startup files, the program tries one by one to open for
reading: reading:
@ -2054,8 +2056,8 @@ of the license to derive modified versions of xorriso then you are entitled
to modify this text under that same license. to modify this text under that same license.
@c man .SH CREDITS @c man .SH CREDITS
@section Credits @section Credits
xorrisofs is in part based on work by Vreixo Formoso who provides libisofs @command{xorrisofs} is in part based on work by Vreixo Formoso who provides
together with Mario Danic who also leads the libburnia team. libisofs together with Mario Danic who also leads the libburnia team.
@* @*
Compliments towards Joerg Schilling whose cdrtools served me for ten years. Compliments towards Joerg Schilling whose cdrtools served me for ten years.
@c man-ignore-lines begin @c man-ignore-lines begin