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

Updated generated manuals

Browse Source
This commit is contained in:
Thomas Schmitt
2011-05-17 09:42:51 +00:00
parent 9a52fd6192
commit 5a5764fa74
4 changed files with 225 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
libisoburn/trunk/xorriso/xorrisofs.info
View File

@ -29,6 +29,7 @@ xorrisofs - Emulation of ISO 9660 program mkisofs by program xorriso
* Examples:: Examples
* Files:: Files
* Seealso:: See also
* Bugreport:: Reporting bugs
* Legal:: Author, Copyright, Credits
* CommandIdx:: Alphabetic Command List
* ConceptIdx:: Alphabetic List of Concepts and Objects
@ -39,13 +40,13 @@ File: xorrisofs.info, Node: Overview, Next: Standards, Prev: Top, Up: Top
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
directory trees too.
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.
`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: Standards, Next: Insert, Prev: Overview, Up: Top
@ -66,7 +67,7 @@ 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.
Rock Ridge information is produced unconditionally with any xorrisofs
Rock Ridge information is produced unconditionally with any `xorrisofs'
image.
*Joliet* is the name of an additional directory tree which provides
filenames up to 64 characters encoded as UTF-16. A Joliet tree is
@ -86,18 +87,18 @@ File: xorrisofs.info, Node: Insert, Next: Xorriso, Prev: Standards, Up: Top
3 Inserting files into the ISO image
************************************
xorrisofs deals with two kinds of file addresses:
`xorrisofs' deals with two kinds of file addresses:
*disk_path* is a path to an object in the local filesystem tree.
*iso_rr_path* 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.)
A program argument is handled as a *pathspec*, 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 the behavior depends on the file type of
disk_path. Directories get merged with the /-directory of the ISO
image. Files of other types get copied into the /-directory.
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 the behavior depends on the file
type of disk_path. Directories get merged with the /-directory of the
ISO image. Files of other types get copied into the /-directory.
If -graft-points is present then each pathspec gets split at the first
occurence of the =-character. The part before the = is taken as
*target*, i.e. the iso_rr_path for the file object in the ISO image.
@ -122,7 +123,7 @@ 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
`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".
@ -135,11 +136,11 @@ 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.
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
@ -490,7 +491,7 @@ File: xorrisofs.info, Node: SetExtras, Next: SetHide, Prev: SetCompl, Up: Op
-R
With mkisofs this option enables Rock Ridge extensions. xorrisofs
With mkisofs this option enables Rock Ridge extensions. `xorrisofs'
produces them unconditionally.
-rock
@ -686,9 +687,9 @@ File: xorrisofs.info, Node: Bootable, Next: SystemArea, Prev: ImageId, Up: O
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.
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.
An *El Torito* boot record points the bootstrapping facility to a boot
catalog with one or more boot images, which are binary program files
@ -700,7 +701,7 @@ given and structured by options -b, -e, -el-torito-alt-boot, and
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.
xorrisofs supports the example options out of the ISOLINUX wiki, the
`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.
@ -787,9 +788,9 @@ facilities of exotic hardware architectures or it may be a MBR for
booting via PC-BIOS from USB stick or hard disk.
A *MBR* (Master Boot Record) contains boot code and a partition table.
It does not hamper El Torito booting from CDROM.
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.
`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.
-G disk_path
Copy at most 32768 bytes from the given disk file to the very
@ -944,7 +945,7 @@ 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."
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
`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.
One may determine the ability for Jigdo by:
@ -954,11 +955,11 @@ $ xorrisofs -version 2>&1 | grep '^libjte' && echo YES
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.
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:
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:
MD5 as 32 hex digits, 2 blanks, size as 12 decimal digits or blanks, 2
blanks, symbolic file address
The file address in an .md5 line has to bear the same basename as the
@ -1329,7 +1330,7 @@ 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.
The prescribed mkisofs options can be used unchanged with xorrisofs:
The prescribed mkisofs options can be used unchanged with `xorrisofs':
$ xorrisofs -o output.iso \
-b isolinux/isolinux.bin -c isolinux/boot.cat \
@ -1382,8 +1383,8 @@ File: xorrisofs.info, Node: Files, Next: Seealso, Prev: Examples, Up: Top
7.1 Startup Files
=================
If not -no_rc is given as the first argument then xorrisofs attempts on
startup to read and execute lines from the following files:
If not -no_rc is given as the first argument then `xorrisofs' attempts
on startup to read and execute lines from the following files:
/etc/default/xorriso
/etc/opt/xorriso/rc
@ -1391,7 +1392,7 @@ startup to read and execute lines from the following files:
$HOME/.xorrisorc
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
required to exist. The lines are not interpreted as `xorrisofs' options
but as generic xorriso commands. See man xorriso. After the xorriso
startup files, the program tries one by one to open for reading:
@ -1413,7 +1414,7 @@ VOLS default for -volset
Any other lines will be silently ignored.

File: xorrisofs.info, Node: Seealso, Next: Legal, Prev: Files, Up: Top
File: xorrisofs.info, Node: Seealso, Next: Bugreport, Prev: Files, Up: Top
8 See also
**********
@ -1437,19 +1438,36 @@ MD5 checksums
md5sum(1)

File: xorrisofs.info, Node: Legal, Next: CommandIdx, Prev: Seealso, Up: Top
File: xorrisofs.info, Node: Bugreport, Next: Legal, Prev: Seealso, Up: Top
9 Author, Copyright, Credits
****************************
9 Reporting bugs
****************
9.1 Author
==========
To report bugs or to suggest enhancements for `xorriso', please send
electronic mail to the public lists <bug-xorriso@gnu.org> or
<libburn-hackers@pykix.org>. If more privacy is desired, mail to
<scdbackup@gmx.net>.
Please describe what you expect `xorriso' to do, the program arguments
resp. commands by which you tried to achieve it, the messages of
`xorriso', and the undesirable outcome of your program run.
Expect to get asked more questions before solutions can be proposed.

File: xorrisofs.info, Node: Legal, Next: CommandIdx, Prev: Bugreport, Up: Top
10 Author, Copyright, Credits
*****************************
10.1 Author
===========
Thomas Schmitt <scdbackup@gmx.net>
for libburnia-project.org
9.2 Copyright
=============
10.2 Copyright
==============
Copyright (c) 2011 Thomas Schmitt
Permission is granted to distribute this text freely. It shall only be
@ -1457,10 +1475,10 @@ 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.
9.3 Credits
===========
10.3 Credits
============
xorrisofs is in part based on work by Vreixo Formoso who provides
`xorrisofs' is in part based on work by Vreixo Formoso who provides
libisofs together with Mario Danic who also leads the libburnia team.
Compliments towards Joerg Schilling whose cdrtools served me for ten
years.
@ -1468,7 +1486,7 @@ years.

File: xorrisofs.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
10 Alphabetic Command List
11 Alphabetic Command List
**************************
[index]
@ -1633,7 +1651,7 @@ File: xorrisofs.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: T

File: xorrisofs.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
11 Alphabetic List of Concepts and Objects
12 Alphabetic List of Concepts and Objects
******************************************
[index]
@ -1671,6 +1689,7 @@ File: xorrisofs.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Bootability, patch System Area partition table, --protective-msdos-label: SystemArea.
(line 41)
* Bootability, SUN Disk Label text, -sparc-label: SystemArea. (line 132)
* Bugs, reporting: Bugreport. (line 6)
* Character Set, for disk file names, -input-charset: Charset.
(line 17)
* Character Set, for ISO file names, -output-charset: Charset.
@ -1754,6 +1773,7 @@ File: xorrisofs.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Permissions, for all data files, -file-mode: SetProduct. (line 66)
* Permissions, for all directories, -dir-mode: SetProduct. (line 60)
* Preparer Id, set, -p: ImageId. (line 54)
* Problems, reporting: Bugreport. (line 6)
* Program version, report, -version: Miscellaneous. (line 34)
* Publisher Id, set, -p, -publisher: ImageId. (line 30)
* Rock Ridge, (always enabled), -R, -rock: SetExtras. (line 8)
@ -1782,35 +1802,36 @@ File: xorrisofs.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top

Tag Table:
Node: Top397
Node: Overview1064
Node: Standards1500
Node: Insert3175
Node: Xorriso4943
Node: Options6079
Node: Loading6796
Node: SetInsert9090
Node: SetProduct13492
Node: SetCompl17199
Node: SetExtras19518
Node: SetHide22390
Node: ImageId23398
Node: Bootable26902
Node: SystemArea30982
Node: Charset37342
Node: Jigdo38367
Node: Miscellaneous42648
Node: Examples43821
Node: ExSimple44307
Node: ExGraft44786
Node: ExMkisofs46033
Node: ExGrowisofs47284
Node: ExIncBackup48456
Node: ExIncBckAcc51505
Node: ExBootable53180
Node: Files55279
Node: Seealso56349
Node: Legal56864
Node: CommandIdx57660
Node: ConceptIdx68993
Node: Overview1103
Node: Standards1541
Node: Insert3218
Node: Xorriso4990
Node: Options6129
Node: Loading6846
Node: SetInsert9140
Node: SetProduct13542
Node: SetCompl17249
Node: SetExtras19568
Node: SetHide22442
Node: ImageId23450
Node: Bootable26954
Node: SystemArea31038
Node: Charset37400
Node: Jigdo38425
Node: Miscellaneous42710
Node: Examples43883
Node: ExSimple44369
Node: ExGraft44848
Node: ExMkisofs46095
Node: ExGrowisofs47346
Node: ExIncBackup48518
Node: ExIncBckAcc51567
Node: ExBootable53242
Node: Files55343
Node: Seealso56417
Node: Bugreport56936
Node: Legal57537
Node: CommandIdx58345
Node: ConceptIdx69678

End Tag Table