MKHYBRID(8) System Manager’s Manual MKHYBRID(8) #
MKHYBRID(8) System Manager’s Manual MKHYBRID(8)
NNAAMMEE #
mkhybrid - create an hybrid ISO9660/JOLIET/HFS filesystem with optional
Rock Ridge attributes.
SSYYNNOOPPSSIISS #
mmkkhhyybbrriidd [ --aa ] [ --aabbssttrraacctt _F_I_L_E ] [ --bbiibblliioo _F_I_L_E ] [ --bb _b_o_o_t___i_m_a_g_e ] [
--cc _b_o_o_t___c_a_t_a_l_o_g ] [ --ccooppyyrriigghhtt _F_I_L_E ] [ --AA _a_p_p_l_i_c_a_t_i_o_n___i_d ] [ --ff ] [ --dd ]
[ --DD ] [ --ee _e_f_i___b_o_o_t___i_m_a_g_e ] [ --hhiiddee _g_l_o_b ] [ --hhiiddee--lliisstt _f_i_l_e ] [
--hhiiddee--jjoolliieett _g_l_o_b ] [ --hhiiddee--jjoolliieett--lliisstt _f_i_l_e ] [ --JJ ] [ --ll ] [ --LL ] [
--lloogg--ffiillee _l_o_g___f_i_l_e ] [ --nnoo--sspplliitt--ssyymmlliinnkk--ccoommppoonneennttss ] [
--nnoo--sspplliitt--ssyymmlliinnkk--ffiieellddss ] [ --ppaatthh--lliisstt _f_i_l_e ] [ --pp _p_r_e_p_a_r_e_r ] [
--pprriinntt--ssiizzee ] [ --PP _p_u_b_l_i_s_h_e_r ] [ --qquuiieett ] [ --rr ] [ --RR ] [ --ssyyssiidd _I_D ] [
--TT | --ttaabbllee--nnaammee _T_A_B_L_E___N_A_M_E ] [ --vv ] [ --VV _v_o_l_i_d ] [ --vvoollsseett _I_D ] [
--vvoollsseett--ssiizzee _# ] [ --vvoollsseett--sseeqqnnoo _# ] [ --xx _p_a_t_h ] [ --zz ] [ --mm _g_l_o_b ] [
--hhffss | --aappppllee ] [ --mmaapp _m_a_p_p_i_n_g___f_i_l_e ] [ --mmaaggiicc _m_a_g_i_c___f_i_l_e ] [
--nnoo--mmaacc--ffiilleess ] [ --pprroobbee ] [ --nnoo--ddeesskkttoopp ] [ --mmaacc--nnaammee ] [ --bboooott--hhffss--ffiillee
_d_r_i_v_e_r___f_i_l_e [ --ppaarrtt ] [ --aauuttoo _A_u_t_o_S_t_a_r_t___f_i_l_e ] [ --cclluusstteerr--ssiizzee _s_i_z_e ] [
--hhiiddee--hhffss _g_l_o_b ] [ --hhiiddee--hhffss--lliisstt _f_i_l_e ] [ --hhffss--vvoolliidd _h_f_s___v_o_l_i_d ] [
--hhffss--bblleessss _f_o_l_d_e_r___n_a_m_e ] [ ----ccaapp ] [ ----nneettaattaallkk ] [ ----ddoouubbllee ] [
----eetthheerrsshhaarree ] [ ----uusshhaarree ] [ ----eexxcchhaannggee ] [ ----ssggii ] [ ----xxiinneett ] [
----mmaaccbbiinn ] [ ----ssiinnggllee ] --oo _f_i_l_e_n_a_m_e _p_a_t_h_s_p_e_c _[_p_a_t_h_s_p_e_c_]
DDEESSCCRRIIPPTTIIOONN #
mmkkhhyybbrriidd is effectively a pre-mastering program to generate an
HFS/ISO9660/JOLIET hybrid filesystem. It is based on mmkkiissooffss(1) and will
generate a pure ISO9660 filesystem unless the HFS hybrid command line
options are given.
mmkkhhyybbrriidd can generate a _t_r_u_e (or _s_h_a_r_e_d_) HFS hybrid filesystem. The same
files are seen as HFS files when accessed from a Macintosh and as ISO9660
files when accessed from other machines. HFS stands for _H_i_e_r_a_r_c_h_i_c_a_l _F_i_l_e
_S_y_s_t_e_m and is the native file system used on Macintosh computers.
As an alternative, mmkkhhyybbrriidd can generate the _A_p_p_l_e _E_x_t_e_n_s_i_o_n_s _t_o _I_S_O_9_6_6_0
for each file. These extensions provide each file with CREATOR, TYPE and
certain Finder Flags when accessed from a Macintosh. See the MMAACCIINNTTOOSSHH
FFIILLEE FFOORRMMAATTSS section below.
mmkkhhyybbrriidd takes a snapshot of a given directory tree, and generates a
binary image which will correspond to an ISO9660 or HFS filesystem when
written to a block device.
mmkkhhyybbrriidd is also capable of generating the System Use Sharing Protocol
records specified by the Rock Ridge Interchange Protocol. This is used
to further describe the files in the iso9660 filesystem to a unix host,
and provides information such as longer filenames, uid/gid, posix
permissions, and block and character devices.
Each file written to the iso9660 filesystem must have a filename in the
8.3 format (8 characters, period, 3 characters, all upper case), even if
Rock Ridge is in use. This filename is used on systems that are not able
to make use of the Rock Ridge extensions (such as MS-DOS), and each
filename in each directory must be different from the other filenames in
the same directory. mmkkhhyybbrriidd generally tries to form correct names by
forcing the unix filename to upper case and truncating as required, but
often times this yields unsatisfactory results when there are cases where
the truncated names are not all unique. mmkkhhyybbrriidd assigns weightings to
each filename, and if two names that are otherwise the same are found the
name with the lower priority is renamed to have a 3 digit number as an
extension (where the number is guaranteed to be unique). An example of
this would be the files foo.bar and foo.bar.~1~ - the file foo.bar.~1~
would be written as FOO.000;1 and the file foo.bar would be written as
FOO.BAR;1 #
When used with the HFS options, mmkkhhyybbrriidd will attempt to recognise files
stored in a number of Apple/Unix file formats and will copy the data and
resource forks as well as any relevant finder information. See the
MMAACCIINNTTOOSSHH FFIILLEE FFOORRMMAATTSS section below for more about formats mmkkhhyybbrriidd
supports.
Note that mmkkhhyybbrriidd is not designed to communicate with the writer
directly. Most writers have proprietary command sets which vary from one
manufacturer to another, and you need a specialized tool to actually burn
the disk. The ccddwwrriittee utility is one such tool that runs under Linux and
performs this task. The latest version of ccddwwrriittee is capable of
communicating with Phillips/IMS/Kodak, HP and Yamaha drives. Most
writers come with some version of DOS software that allows a direct image
copy of an iso9660 image to the writer. Note that cdwrite has not been
actively maintained in recent times.
The ccddrreeccoorrdd utility is another utility capable of burning an actual
disc. The latest version of Cdrecord is under constant development.
Also you should know that most cd writers are very particular about
timing. Once you start to burn a disc, you cannot let their buffer empty
before you are done, or you will end up with a corrupt disc. Thus it is
critical that you be able to maintain an uninterrupted data stream to the
writer for the entire time that the disc is being written.
_p_a_t_h_s_p_e_c is the path of the directory tree to be copied into the iso9660
filesystem. Multiple paths can be specified, and mmkkhhyybbrriidd will merge the
files found in all of the specified path components to form the cdrom
image.
It is possible to graft the paths at points other than the root
directory, and it is possible to graft files or directories onto the
cdrom image with names different than what they have in the source
filesystem. This is easiest to illustrate with a couple of examples.
Let's start by assuming that a local file ../old.lis exists, and you wish
to include it in the cdrom image.
foo/bar/=../old.lis
will include the file old.lis in the cdrom image at /foo/bar/old.lis,
while
foo/bar/xxx=../old.lis
will include the file old.lis in the cdrom image at /foo/bar/xxx. The
same sort of syntax can be used with directories as well. mmkkhhyybbrriidd will
create any directories required such that the graft points exist on the
cdrom image - the directories do not need to appear in one of the paths.
Any directories that are created on the fly like this will have
permissions 0555 and appear to be owned by the person running mkhybrid.
If you wish other permissions or owners of the intermediate directories,
the easiest solution is to create real directories in the path such that
mkhybrid doesn't have to invent them.
_m_k_h_y_b_r_i_d will also run on Win9X/NT4 machines when compiled with Cygnus'
cygwin. Therefore most references in this man page to _U_n_i_x can be
replaced with _W_i_n_3_2.
OOPPTTIIOONNSS #
--aa Include all files on the iso9660 filesystem. Normally files that
contain the characters '~' or '#' will not be included (these are
typically backup files for editors under unix).
--aabbssttrraacctt _F_I_L_E
Specifies the abstract file name. This parameter can also be set
in the file ..mmkkiissooffssrrcc with ABST=filename. If specified in both
places, the command line version is used.
--AA _a_p_p_l_i_c_a_t_i_o_n___i_d
Specifies a text string that will be written into the volume
header. This should describe the application that will be on the
disc. There is space on the disc for 128 characters of
information. This parameter can also be set in the file
_._m_k_i_s_o_f_s_r_c with APPI=id. If specified in both places, the command
line version is used.
--bbiibblliioo _F_I_L_E
Specifies the bibliographic file name. This parameter can also be
set in the file ..mmkkiissooffssrrcc with BIBLO=filename. If specified in
both places, the command line version is used.
--bb _b_o_o_t___i_m_a_g_e
Specifies the path and filename of the boot image to be used when
making an "El Torito" bootable CD. The pathname must be relative
to the source path specified to mmkkhhyybbrriidd.. This option is required
to make a bootable CD. The boot image must be exactly the size of
one of a 1.2, 1.44, or 2.88 MB floppy, or of a 2 KB CD sector, and
mmkkhhyybbrriidd will use this size when creating the output iso9660
filesystem. If the boot file is 2 KB long, a no-emulation boot CD
will be created, and the whole 2 KB will be read on boot. If the
boot file is a floppy image, then only the first 512-byte sector
will be read from the boot image (it is emulating a normal floppy
drive). This will work, for example, if the boot image is a LILO-
based boot floppy.
--CC _l_a_s_t___s_e_s_s___s_t_a_r_t_,_n_e_x_t___s_e_s_s___s_t_a_r_t
This option is needed when mmkkiissooffss is used to create the image of
a second session or a higher level session for a multi session
disk. The option --CC takes a pair of two numbers separated by a
comma. The first number is the sector number of the first sector
in the last session of the disk that should be appended to. The
second number is the starting sector number of the new session.
The expected pair of numbers may be retrieved by calling ccddrreeccoorrdd
--mmssiinnffoo ...... the --CC option may only be uses in conjunction with
the --MM option.
--cc _b_o_o_t___c_a_t_a_l_o_g
Specifies the path and filename of the boot catalog to be used
when making an "El Torito" bootable CD. The pathname must be
relative to the source path specified to mmkkhhyybbrriidd.. This option is
required to make a bootable CD. This file will be created by
mmkkhhyybbrriidd in the source filesystem, so be sure the specified
filename does not conflict with an existing file, as it will be
quietly overwritten! Usually a name like "boot.catalog" is chosen.
--ccooppyyrriigghhtt _F_I_L_E
Specifies the Copyright file name. This parameter can also be set
in the file ..mmkkiissooffssrrcc with COPY=filename. If specified in both
places, the command line version is used.
--dd Omit trailing period from files that do not have a period. This
violates the ISO9660 standard, but it happens to work on many
systems. Use with caution.
--DD Do not use deep directory relocation, and instead just pack them
in the way we see them. This violates the ISO9660 standard, but
it works on many systems. Use with caution.
--ee _e_f_i___b_o_o_t___i_m_a_g_e
Specifies the path and filename of the EFI boot image to be used
when making an "El Torito" bootable CD. The pathname must be
relative to the source path specified to mmkkhhyybbrriidd.. The file
should contain an EFI system partition image. The --ee option can
be used with or without the --bb option.
--ff Follow symbolic links when generating the filesystem. When this
option is not in use, symbolic links will be entered using Rock
Ridge if enabled, otherwise the file will be ignored.
--hhiiddee _g_l_o_b
Hide _g_l_o_b from being seen on the ISO9660 or Rock Ridge directory.
_g_l_o_b is a shell wild-card-style pattern that must match any part
of the filename or path. Multiple globs may be hidden (up to
1000). If _g_l_o_b matches a directory, then the contents of that
directory will be hidden. All the hidden files will still be
written to the output CD image file. Should be used with the
_-_h_i_d_e_-_j_o_l_i_e_t option.
--hhiiddee--lliisstt _f_i_l_e
A file containing a list of _g_l_o_b_s to be hidden as above.
--hhiiddee--jjoolliieett _g_l_o_b
Hide _g_l_o_b from being seen on the Joliet directory. _g_l_o_b is a
shell wild-card-style pattern that must match any part of the
filename or path. Multiple globs may be hidden (up to 1000). If
_g_l_o_b matches a directory, then the contents of that directory will
be hidden. All the hidden files will still be written to the
output CD image file. Should be used with the _-_h_i_d_e option.
--hhiiddee--jjoolliieett--lliisstt _f_i_l_e
A file containing a list of _g_l_o_b_s to be hidden as above.
--ll Allow full 32 character filenames. Normally the ISO9660 filename
will be in an 8.3 format which is compatible with MS-DOS, even
though the ISO9660 standard allows filenames of up to 32
characters. If you use this option, the disc may be difficult to
use on a MS-DOS system, but this comes in handy on some other
systems (such as the Amiga). Use with caution.
--JJ Generate Joliet directory records in addition to regular iso9660
file names. This is primarily useful when the discs are to be
used on Windows-NT or Windows-95 machines. The Joliet filenames
are specified in Unicode and each path component can be up to 64
Unicode characters long.
--LL Allow filenames to begin with a period. Usually, a leading dot is
replaced with an underscore in order to maintain MS-DOS
compatibility.
--lloogg--ffiillee _l_o_g___f_i_l_e
Redirect all error, warning and informational messages to _l_o_g___f_i_l_e
instead of the standard error.
--mm _g_l_o_b
Exclude _g_l_o_b from being written to CDROM. _g_l_o_b is a shell wild-
card-style pattern that must match part of the filename (not the
path as with option --xx). Technically _g_l_o_b is matched against the
_d_-_>_d___n_a_m_e part of the directory entry. Multiple globs may be
excluded (up to 1000). Example:
mkhybrid -o rom -m '*.o' -m core -m foobar
would exclude all files ending in ".o", called "core" or "foobar"
to be copied to CDROM. Note that if you had a directory called
"foobar" it too (and of course all its descendants) would be
excluded.
NOTE: The -m and -x option description should both be updated,
they are wrong. Both now work identical and use filename
globbing. A file is excluded if either the last component matches
or the whole path matches.
--eexxcclluuddee--lliisstt _f_i_l_e
A file containing a list of _g_l_o_b_s to be exclude as above.
--MM _p_a_t_h
or
--MM _d_e_v_i_c_e
Specifies path to existing iso9660 image to be merged. The
alternate form takes a SCSI device specifier that uses the same
syntax as the ddeevv== parameter of ccddrreeccoorrdd.. The output of mmkkhhyybbrriidd
will be a new session which should get written to the end of the
image specified in -M. Typically this requires multi-session
capability for the recorder and cdrom drive that you are
attempting to write this image to. This option may only be used
in conjunction with the --CC option.
--NN Omit version numbers from ISO9660 file names. This may violate
the ISO9660 standard, but no one really uses the version numbers
anyway. Use with caution.
--nnoo--sspplliitt--ssyymmlliinnkk--ccoommppoonneennttss
Don't split the SL components, but begin a new Continuation Area
(CE) instead. This may waste some space, but the SunOS 4.1.4 cdrom
driver has a bug in reading split SL components (link_size =
component_size instead of link_size += component_size).
--nnoo--sspplliitt--ssyymmlliinnkk--ffiieellddss
Don't split the SL fields, but begin a new Continuation Area (CE)
instead. This may waste some space, but the SunOS 4.1.4 and
Solaris 2.5.1 cdrom driver have a bug in reading split SL fields
(a `/' can be dropped).
--oo _f_i_l_e_n_a_m_e
is the name of the file to which the iso9660 filesystem image
should be written. This can be a disk file, a tape drive, or it
can correspond directly to the device name of the optical disc
writer. If not specified, stdout is used. Note that the output
can also be a block special device for a regular disk drive, in
which case the disk partition can be mounted and examined to
ensure that the premastering was done correctly.
--ppaatthh--lliisstt _f_i_l_e
A file containing a list of _f_i_l_e_s_p_e_c directories and filenames to
be added to the ISO9660 filesystem. This list of filespecs are
processed after any that appear on the command line. If the
argument is _-, then the list is read from the standard input.
--PP _p_u_b_l_i_s_h_e_r___i_d
Specifies a text string that will be written into the volume
header. This should describe the publisher of the CDROM, usually
with a mailing address and phone number. There is space on the
disc for 128 characters of information. This parameter can also
be set in the file _._m_k_i_s_o_f_s_r_c with PUBL=. If specified in both
places, the command line version is used.
--pp _p_r_e_p_a_r_e_r___i_d
Specifies a text string that will be written into the volume
header. This should describe the preparer of the CDROM, usually
with a mailing address and phone number. There is space on the
disc for 128 characters of information. This parameter can also
be set in the file _._m_k_i_s_o_f_s_r_c with PREP=. If specified in both
places, the command line version is used.
--pprriinntt--ssiizzee
Print estimated filesystem size and exit. This option is needed
for Disk At Once mode and with some CD-R drives when piping
directly into ccddrreeccoorrdd.. In this case it is needed to know the
size of the filesystem before the actual CD-creation is done. The
option -print-size allows to get this size from a "dry-run" before
the CD is actually written.
--qquuiieett This makes mmkkhhyybbrriidd even less verbose. No progress output will be
provided.
--RR Generate SUSP and RR records using the Rock Ridge protocol to
further describe the files on the iso9660 filesystem.
--rr This is like the -R option, but file ownership and modes are set
to more useful values. The uid and gid are set to zero, because
they are usually only useful on the author's system, and not
useful to the client. All the file read bits are set true, so
that files and directories are globally readable on the client.
If any execute bit is set for a file, set all of the execute bits,
so that executables are globally executable on the client. If any
search bit is set for a directory, set all of the search bits, so
that directories are globally searchable on the client. All write
bits are cleared, because the CD-Rom will be mounted read-only in
any case. If any of the special mode bits are set, clear them,
because file locks are not useful on a read-only file system, and
set-id bits are not desirable for uid 0 or gid 0. When used on
Win32, the execute bit is set on _a_l_l files.
--ssyyssiidd _I_D
Specifies the system ID. This parameter can also be set in the
file ..mmkkiissooffssrrcc with SYSI=system_id. If specified in both places,
the command line version is used.
--TT Generate a file TRANS.TBL in each directory on the CDROM, which
can be used on non-Rock Ridge capable systems to help establish
the correct file names. There is also information present in the
file that indicates the major and minor numbers for block and
character devices, and each symlink has the name of the link file
given.
--ttaabbllee--nnaammee _T_A_B_L_E___N_A_M_E
Alternative translation table file name (see above). Implies the
_-_T option.
--VV _v_o_l_i_d
Specifies the volume ID (volume name or label) to be written into
the master block. This parameter can also be set in the file
_._m_k_i_s_o_f_s_r_c with VOLI=id. If specified in both places, the command
line version is used. Note that if you assign a volume ID, this
is the name that will be used as the mount point used by the
Solaris volume management system and the name that is assigned to
the disc on a Windows or Mac platform.
--vvoollsseett _I_D
Specifies the volset ID. This parameter can also be set in the
file ..mmkkiissooffssrrcc with VOLS=volset_id. If specified in both places,
the command line version is used.
--vvoollsseett--ssiizzee _#
Sets the volume set size to #. The volume set size is the number
of CD's that are in a CD set. The --vvoollsseett--ssiizzee option may be used
to create CD's that are part of e.g. a Operation System
installation set of CD's. The option --vvoollsseett--ssiizzee must be
specified before --vvoollsseett--sseeqqnnoo on each command line.
--vvoollsseett--sseeqqnnoo _#
Sets the volume set sequence number to #. The volume set sequence
number is the index number of the current CD in a CD set. The
option --vvoollsseett--ssiizzee must be specified before --vvoollsseett--sseeqqnnoo on each
command line.
--vv Verbose execution. If given twice on the command line, extra debug
information will be printed.
--xx _p_a_t_h
Exclude _p_a_t_h from being written to CDROM. _p_a_t_h must be the
complete pathname that results from concatenating the pathname
given as command line argument and the path relative to this
directory. Multiple paths may be excluded (up to 1000). Example:
mkhybrid -o cd -x /local/dir1 -x /local/dir2 /local
NOTE: The -m and -x option description should both be updated,
they are wrong. Both now work identical and use filename
globbing. A file is excluded if either the last component matches
or the whole path matches.
--zz Generate special SUSP records for transparently compressed files.
This is only of use and interest for hosts that support
transparent decompression. This is an experimental feature, and
no hosts yet support this, but there are ALPHA patches for Linux
that can make use of this feature.
HHFFSS OOPPTTIIOONNSS #
--hhffss Create an ISO9660/HFS hybrid CD. By default, all source files are
checked to attempt to recognise files stored in one of the known
Apple/Unix file formats. See the MMAACCIINNTTOOSSHH FFIILLEE FFOORRMMAATTSS section
below for more about these formats
--aappppllee Create an ISO9660 CD with Apple's extensions. Similar to the _-_h_f_s
option, except that the Apple Extensions to ISO9660 are added
instead of creating an HFS hybrid volume.
--mmaapp _m_a_p_p_i_n_g___f_i_l_e
Use the _m_a_p_p_i_n_g___f_i_l_e to set the CREATOR and TYPE information for a
file based on the filename's extension. A filename is mapped only
if it is not one of the know Apple/Unix file formats. See the
CCRREEAATTOORR//TTYYPPEE section below.
--mmaaggiicc _m_a_g_i_c___f_i_l_e
The CREATOR and TYPE information is set by using a file's _m_a_g_i_c
_n_u_m_b_e_r (usually the first few bytes of a file). The _m_a_g_i_c___f_i_l_e is
only used if a file is not one of the known Apple/Unix file
formats, or the filename extension has not been mapped using the
_-_m_a_p option. See the CCRREEAATTOORR//TTYYPPEE section below for more details.
--nnoo--mmaacc--ffiilleess
Disables searching for Apple/Unix files. This will speed up
processing if there are none of the known Apple/Unix format files
in the source directory trees (the source directories just contain
ordinary files). The _-_m_a_p and/or _-_m_a_g_i_c option can be used to set
the CREATOR and TYPE for each file.
--pprroobbee Search the contents of files for Apple/Unix file formats. When
_-_h_f_s or _-_a_p_p_l_e is used, mkhybrid will attempt to work out
automatically what type of Apple/Unix format each file is.
However, the only way to check for _M_a_c_B_i_n_a_r_y and _A_p_p_l_e_S_i_n_g_l_e files
is to open and read them. Therefore, if _M_a_c_B_i_n_a_r_y or _A_p_p_l_e_S_i_n_g_l_e
format files are being used, then you need to give this option.
This saves opening and searching every file if no _M_a_c_B_i_n_a_r_y and/or
_A_p_p_l_e_S_i_n_g_l_e files exist. Or you could use the relevant _d_o_u_b_l_e _d_a_s_h
options given below.
--nnoo--ddeesskkttoopp
Do not create (empty) Desktop files. New HFS Desktop files will be
created when the CD is used on a Macintosh (and stored in the
System Folder). By default, empty Desktop files are added to the
HFS volume.
--mmaacc--nnaammee
Use the HFS filename as the starting point for the ISO9660, Joliet
and Rock Ridge file names. See the MMAACCIINNTTOOSSHH FFIILLEE NNAAMMEESS section
below for more information.
--bboooott--hhffss--ffiillee _d_r_i_v_e_r___f_i_l_e
Installs the _d_r_i_v_e_r___f_i_l_e that _m_a_y make the CD bootable on a
Macintosh. See the HHFFSS BBOOOOTT DDRRIIVVEERR section below. (Alpha).
--ppaarrtt Generate an HFS partition table. By default, no partition table is
generated, but some older Macintosh CDROM drivers need an HFS
partition table on the CDROM to be able to recognize a hybrid
CDROM. #
--aauuttoo _A_u_t_o_S_t_a_r_t___f_i_l_e
Make the HFS CD use the QuickTime 2.0 Autostart feature to launch
an application or document. The given filename must be the name of
a document or application located at the top level of the CD. The
filename must be less than 12 characters. (Alpha).
--cclluusstteerr--ssiizzee _s_i_z_e
Set the size in bytes of the cluster or allocation units of PC
Exchange files. See the MMAACCIINNTTOOSSHH FFIILLEE FFOORRMMAATTSS section below.
--hhiiddee--hhffss _g_l_o_b
Hide _g_l_o_b from the HFS volume. The file or directory will still
exist in the ISO9660 and/or Joliet directory. _g_l_o_b is a shell
wild-card-style pattern that must match any part of the filename
Multiple globs may be excluded (up to 1000). Example:
mkhybrid -o rom -hfs -hide-hfs '*.o' -hide-hfs foobar
would exclude all files ending in ".o" or called "foobar" from the
HFS volume. Note that if you had a directory called "foobar" it
too (and of course all its descendants) would be excluded. The
_g_l_o_b can also be a path name relative to the source directories
given on the command line. Example:
mkhybrid -o rom -hfs -hide-hfs src/html src
would exclude just the file or directory called "html" from the
"src" directory. Any other file or directory called "html" in the
tree will not be excluded. Should be used with the _-_h_i_d_e and/or
_-_h_i_d_e_-_j_o_l_i_e_t options.
--hhiiddee--hhffss--lliisstt _f_i_l_e
A file containing a list of _g_l_o_b_s to be hidden as above.
--hhffss--vvoolliidd _h_f_s___v_o_l_i_d
Volume name for the HFS partition. This is the name that is
assigned to the disc on a Macintosh and replaces the _v_o_l_i_d used
with the _-_V option
--hhffss--bblleessss _f_o_l_d_e_r___n_a_m_e
"Bless" the given directory (folder). This is usually the SSyysstteemm
FFoollddeerr and is used in creating HFS bootable CDs. The name of the
directory must be the whole path name as mmkkiissooffss sees it. e.g. if
the given pathspec is ./cddata and the required folder is called
System Folder, then the whole path name is "./cddata/System
Folder" (remember to use quotes if the name contains spaces).
----ccaapp Look for AUFS CAP Macintosh files. Search for CAP Apple/Unix file
formats only. Searching for the other possible Apple/Unix file
formats is disabled, unless other _d_o_u_b_l_e _d_a_s_h options are given.
----nneettaattaallkk
Look for NETATALK Macintosh files
----ddoouubbllee
Look for AppleDouble Macintosh files
----eetthheerrsshhaarree
Look for Helios EtherShare Macintosh files
----uusshhaarree
Look for IPT UShare Macintosh files
----eexxcchhaannggee
Look for PC Exchange Macintosh files
----ssggii Look for SGI Macintosh files
----xxiinneett
Look for XINET Macintosh files
----mmaaccbbiinn
Look for MacBinary Macintosh files
----ssiinnggllee
Look for AppleSingle Macintosh files
CCRREEAATTOORR//TTYYPPEE #
A Macintosh file has two properties associated with it which define which
application created the file, the _C_R_E_A_T_O_R and what data the file
contains, the _T_Y_P_E. Both are (exactly) 4 letter strings. Usually this
allows a Macintosh user to double-click on a file and launch the correct
application etc. The CREATOR and TYPE of a particular file can be found
by using something like ResEdit (or similar) on a Macintosh.
The CREATOR and TYPE information is stored in all the various Apple/Unix
encoded files. For other files it is possible to base the CREATOR and
TYPE on the filename's extension using a _m_a_p_p_i_n_g file (the _-_m_a_p option)
and/or using the _m_a_g_i_c _n_u_m_b_e_r (usually a _s_i_g_n_a_t_u_r_e in the first few
bytes) of a file (the _-_m_a_g_i_c option). If both these options are given,
then their order on the command line is important. If the _-_m_a_p option is
given first, then a filename extension match is attempted before a magic
number match. However, if the _-_m_a_g_i_c option is given first, then a magic
number match is attempted before a filename extension match.
If a mapping or magic file is not used, or no match is found then the
default CREATOR and TYPE for all regular files can be set by using
entries in the _._m_k_i_s_o_f_s_r_c file, otherwise the default CREATOR and TYPE
are 'unix' and 'TEXT'.
The format of the _m_a_p_p_i_n_g file is the same _a_f_p_f_i_l_e format as used by
_a_u_f_s. This file has five columns for the _e_x_t_e_n_s_i_o_n, _f_i_l_e _t_r_a_n_s_l_a_t_i_o_n,
_C_R_E_A_T_O_R, _T_Y_P_E and _C_o_m_m_e_n_t. Lines starting with the '#' character are
comment lines and are ignored. An example file would be like:
# Example filename mapping file
#
# EXTN XLate CREATOR TYPE Comment
.tif Raw '8BIM' 'TIFF' "Photoshop TIFF image"
.hqx Ascii 'BnHq' 'TEXT' "BinHex file"
.doc Raw 'MSWD' 'WDBN' "Word file"
.mov Raw 'TVOD' 'MooV' "QuickTime Movie"
* Ascii 'ttxt' 'TEXT' "Text file"
Where:
The first column _E_X_T_N defines the Unix filename extension to be
mapped. The default mapping for any filename extension that
doesn't match is defined with the "*" character.
The _X_l_a_t_e column defines the type of text translation between the
Unix and Macintosh file it is ignored by _m_k_h_y_b_r_i_d_, but is kept to
be compatible with _a_u_f_s(1). Although _m_k_h_y_b_r_i_d does not alter the
contents of a file, if a binary file has it's TYPE set as 'TEXT',
it _m_a_y be read incorrectly on a Macintosh. Therefore a better
choice for the default TYPE may be '????'
The _C_R_E_A_T_O_R and _T_Y_P_E keywords must be 4 characters long and
enclosed in single quotes.
The comment field is enclosed in double quotes - it is ignored by
_m_k_h_y_b_r_i_d, but is kept to be compatible with _a_u_f_s.
The format of the _m_a_g_i_c file is almost identical to the _m_a_g_i_c(4) file
used by the Linux _f_i_l_e(1) command - the routines for reading and decoding
the _m_a_g_i_c file are based on the Linux _f_i_l_e(1) command.
This file has four tab separated columns for the _b_y_t_e _o_f_f_s_e_t, _t_y_p_e, _t_e_s_t
and _m_e_s_s_a_g_e. Lines starting with the '#' character are comment lines and
are ignored. An example file would be like:
# Example magic file
#
# off type test message
0 string GIF8 8BIM GIFf GIF image
0 beshort 0xffd8 8BIM JPEG image data
0 string SIT! SIT! SIT! StuffIt Archive
0 string \037\235 LZIV ZIVU standard unix compress
0 string \037\213 GNUz ZIVU gzip compressed data
0 string %! ASPS TEXT Postscript
0 string \004%! ASPS TEXT PC Postscript with a ^D to start
4 string moov txtt MooV QuickTime movie file (moov)
4 string mdat txtt MooV QuickTime movie file (mdat)
The format of the file is described in the _m_a_g_i_c(4) man page. The only
difference here is that for each entry in the magic file, the _m_e_s_s_a_g_e for
the initial offset mmuusstt be 4 characters for the CREATOR followed by 4
characters for the TYPE - white space is optional between them. Any other
characters on this line are ignored. Continuation lines (starting with a
'>') are also ignored i.e. only the initial offset lines are used.
Using the _-_m_a_g_i_c option may significantly increase processing time as
each file has to opened and read to find it's magic number.
In summary, for all files, the default CREATOR is 'unix' and the default
TYPE is 'TEXT'. These can be changed by using entries in the _._m_k_i_s_o_f_s_r_c
file.
If the a file is in one of the known Apple/Unix formats (and the format
has been selected), then the CREATOR and TYPE are taken from the values
stored in the Apple/Unix file.
Other files can have their CREATOR and TYPE set from their file name
extension (the _-_m_a_p option), or their magic number (the _-_m_a_g_i_c option).
If the default match is used in the _m_a_p_p_i_n_g file, then these values
override the default CREATOR and TYPE.
MMAACCIINNTTOOSSHH FFIILLEE FFOORRMMAATTSS #
Macintosh files have two parts called the _D_a_t_a and _R_e_s_o_u_r_c_e fork. Either
may be empty. Unix (and many other OSs) can only cope with files having
one part (or fork). To add to this, Macintosh files have a number of
attributes associated with them - probably the most important are the
TYPE and CREATOR. Again Unix has no concept of these types of attributes.
e.g. a Macintosh file may be a JPEG image where the image is stored in
the Data fork and a desktop thumbnail stored in the Resource fork. It is
usually the information in the data fork that is useful across platforms.
Therefore to store a Macintosh file on a Unix filesystem, a way has to be
found to cope with the two forks and the extra attributes (which are
referred to as the _f_i_n_d_e_r _i_n_f_o_)_. Unfortunately, it seems that every
software package that stores Macintosh files on Unix has chosen a
completely different storage method.
The Apple/Unix formats that _m_k_h_y_b_r_i_d (partially) supports are:
CAP AUFS format
Data fork stored in a file. Resource fork in subdirectory
.resource with same filename as data fork. Finder info in
.finderinfo subdirectory with same filename.
AppleDouble/Netatalk
Data fork stored in a file. Resource fork stored in a file with
same name prefixed with "%". Finder info also stored in same "%"
file. Netatalk uses the same format, but the resource
fork/finderinfo stored in subdirectory .AppleDouble with same name
as data fork.
AppleSingle
Data structures similar to above, except both forks and finder
info are stored in one file.
Helios EtherShare
Data fork stored in a file. Resource fork and finder info together
in subdirectory .rsrc with same filename as data fork.
IPT UShare
Very similar to the EtherShare format, but the finder info is
stored slightly differently.
MacBinary
Both forks and finder info stored in one file.
Apple PC Exchange
Used by Macintoshes to store Apple files on DOS (FAT) disks. Data
fork stored in a file. Resource fork in subdirectory resource.frk
(or RESOURCE.FRK). Finder info as one record in file finder.dat
(or FINDER.DAT). Separate finder.dat for each data fork directory.
Note: normally files should be accessed directly from the DOS
media as _m_k_h_y_b_r_i_d needs to find out the native FAT cluster size.
If the native FAT cluster size is known, then the _-_c_l_u_s_t_e_r_-_s_i_z_e
option can be used to set the cluster size - useful if PC Exchange
files have be copied from DOS disks before running _m_k_h_y_b_r_i_d. The
cluster or allocation size can be found by using the DOS utility
_C_H_K_D_S_K. #
May not work with PC Exchange v2.2 or higher files (available with
MacOS 8.1). DOS media containing PC Exchange files should be
mounted as type mmssddooss (not vvffaatt) when using Linux.
SGI/XINET #
Used by SGI machines when they mount HFS disks. Data fork stored
in a file. Resource fork in subdirectory .HSResource with same
name. Finder info as one record in file .HSancillary. Separate
.HSancillary for each data fork directory.
_m_k_h_y_b_r_i_d will attempt to set the CREATOR, TYPE, date and possibly other
flags from the finder info. Additionally, if it exists, the Macintosh
filename is set from the finder info, otherwise the Macintosh name is
based on the Unix filename - see the MACINTOSH FILE NAMES section below.
When using the _-_a_p_p_l_e option, the TYPE and CREATOR are stored in the
optional System Use or SUSP field in the ISO9660 Directory Record - in
much the same way as the Rock Ridge attributes are. In fact to make life
easy, the Apple extensions are added at the beginning of the existing
Rock Ridge attributes (i.e. to get the Apple extensions you get the Rock
Ridge extensions as well).
The Apple extensions require the resource fork to be stored as an ISO9660
_a_s_s_o_c_i_a_t_e_d file. This is just like any normal file stored in the ISO9660
filesystem except that the associated file flag is set in the Directory
Record (bit 2). This file has the same name as the data fork (the file
seen by non-Apple machines). Associated files are normally ignored by
other OSs
When using the _-_h_f_s option, the TYPE and CREATOR plus other finder info,
are stored in a separate HFS directory, not visible on the ISO9660
volume. The HFS directory references the same data and resource fork
files described above.
In most cases, it is better to use the _-_h_f_s option instead of the _-_a_p_p_l_e
option, as the latter imposes the limited ISO9660 characters allowed in
filenames. However, the Apple extensions do give the advantage that the
files are packed on the disk more efficiently and it may be possible to
fit more files on a CD - important when the total size of the source
files is approaching 650MB.
MMAACCIINNTTOOSSHH FFIILLEE NNAAMMEESS #
Where possible, the HFS filename that is stored with an Apple/Unix file
is used for the HFS part of the CD. However, not all the Apple/Unix
encodings store the HFS filename with the finderinfo. In these cases, the
Unix filename is used - with escaped special characters. Special
characters include '/' and characters with codes over 127.
Aufs escapes these characters by using ":" followed by the character code
as two hex digits. Netatalk and EtherShare have a similar scheme, but
uses "%" instead of a ":".
If mkhybrid can't find an HFS filename, then it uses the Unix name, with
any %xx or :xx characters (xx == two hex digits) converted to a single
character code. If "xx" are not hex digits ([0-9a-fA-F]), then they are
left alone - although any remaining ":" is converted to "%" as colon is
the HFS directory separator. Care must be taken, as an ordinary Unix file
with %xx or :xx will also be converted. e.g.
This:2fFile converted to This/File
This:File converted to This%File
This:t7File converted to This%t7File
Although HFS filenames appear to support upper and lower case letters,
the filesystem is case insensitive. i.e. the filenames "aBc" and "AbC"
are the same. If a file is found in a directory with the same HFS name,
then _m_k_h_y_b_r_i_d will attempt, where possible, to make a unique name by
adding '_' characters to one of the filenames.
If an HFS filename exists for a file, then mkhybrid can use this name as
the starting point for the ISO9660, Joliet and Rock Ridge filenames using
the _-_m_a_c_-_n_a_m_e option. Normal Unix files without an HFS name will still
use their Unix name. e.g.
If a _M_a_c_B_i_n_a_r_y (or _P_C _E_x_c_h_a_n_g_e) file is stored as _s_o_m_e_i_m_a_g_e_._g_i_f_._b_i_n on
the Unix filesystem, but contains a HFS file called _s_o_m_e_i_m_a_g_e_._g_i_f, then
this is the name that would appear on the HFS part of the CD. However, as
mkhybrid uses the Unix name as the starting point for the other names,
then the ISO9660 name generated will probably be _S_O_M_E_I_M_A_G_._B_I_N and the
Joliet/Rock Ridge would be _s_o_m_e_i_m_a_g_e_._g_i_f_._b_i_n. Although the actual data
(in this case) is a GIF image. This option will use the HFS filename as
the starting point and the ISO9660 name will probably be _S_O_M_E_I_M_A_G_._G_I_F and
the Joliet/Rock Ridge would be _s_o_m_e_i_m_a_g_e_._g_i_f.
Using the _-_m_a_c_-_n_a_m_e option will not currently work with the _-_T option -
the Unix name will be used in the TRANS.TBL file, not the Macintosh name.
The existing mkisofs code will filter out any illegal characters for the
ISO9660 and Joliet filenames, but as mkisofs expects to be dealing
directly with Unix names, it leaves the Rock Ridge names as is. But as
'/' is a legal HFS filename character, the _-_m_a_c_-_n_a_m_e option coverts '/'
to a '_' in a Rock Ridge filenames.
If the Apple extensions are used, then only the ISO9660 filenames will
appear on the Macintosh. However, as the Macintosh ISO9660 drivers can
use _L_e_v_e_l _2 filenames, then you can use the _-_l option without problems on
a Macintosh - still take care over the names, for example _t_h_i_s_._f_i_l_e_._n_a_m_e
will be converted to _T_H_I_S_._F_I_L_E i.e. only have one '.', also filename
_a_b_c_d_e_f_g_h will be seen as _A_B_C_D_E_F_G_H but _a_b_c_d_e_f_g_h_i will be seen as
_A_B_C_D_E_F_G_H_I_. i.e. with a '.' at the end - don't know if this is a
Macintosh problem or mkisofs/mkhybrid problem. All filenames will be in
uppercase when viewed on a Macintosh. Of course, DOS/Win3.X machines will
not be able to see Level 2 filenames...
As Macintosh filenames do use the '~' and '#' characters (especially when
using PC Exchange Macintosh files), then the _-_a option should be given.
HHFFSS BBOOOOTT DDRRIIVVEERR #
It _m_a_y be possible to make the hybrid CD bootable on a Macintosh.
A bootable HFS CD requires an Apple CD-ROM (or compatible) driver, a
bootable HFS partition and the necessary System, Finder, etc. files.
A driver can be obtained from any other Macintosh bootable CD-ROM using
the _a_p_p_l_e___d_r_i_v_e_r utility. This file can then be used with the
_-_b_o_o_t_-_h_f_s_-_f_i_l_e option.
The HFS partition (i.e. the hybrid disk in our case) must contain a
suitable System Folder, again from another CD-ROM or disk.
For a partition to be bootable, it must have it's _b_o_o_t _b_l_o_c_k set. The
boot block is in the first two blocks of a partition. For a non-bootable
partition the boot block is full of zeros. Normally, when a System file
is copied to partition on a Macintosh disk, the boot block is filled with
a number of required settings - unfortunately I don't know the full spec
for the boot block, so I'm guessing that the following will work OK.
Therefore, the utility _a_p_p_l_e___d_r_i_v_e_r also extracts the boot block from the
first HFS partition it finds on the given CD-ROM and this is used for the
HFS partition created by _m_k_h_y_b_r_i_d.
PLEASE NOTE #
By using a driver from an Apple CD and copying Apple software to
your CD, you become liable to obey Apple Computer, Inc. Software
License Agreements.
CCOONNFFIIGGUURRAATTIIOONN #
mmkkhhyybbrriidd looks for the _._m_k_i_s_o_f_s_r_c file, first in the current working
directory, then in the user's home directory, and then in the directory
in which the mmkkhhyybbrriidd binary is stored. This file is assumed to contain
a series of lines of the form "TAG=value", and in this way you can
specify certain options. The case of the tag is not significant. Some
fields in the volume header are not settable on the command line, but can
be altered through this facility. Comments may be placed in this file,
using lines which start with a hash (#) character.
APPI The application identifier should describe the application that
will be on the disc. There is space on the disc for 128
characters of information. May be overridden using the -A command
line option.
COPY The copyright information, often the name of a file on the disc
containing the copyright notice. There is space in the disc for
37 characters of information. May be overridden using the
--ccooppyyrriigghhtt command line option.
ABST The abstract information, often the name of a file on the disc
containing an abstract. There is space in the disc for 37
characters of information. May be overridden using the --aabbssttrraacctt
command line option.
BIBL The bibliographic information, often the name of a file on the
disc containing a bibliography. There is space in the disc for 37
characters of information. May be overridden using the --bbiilliioo
command line option.
PREP This should describe the preparer of the CDROM, usually with a
mailing address and phone number. There is space on the disc for
128 characters of information. May be overridden using the --pp
command line option.
PUBL This should describe the publisher of the CDROM, usually with a
mailing address and phone number. There is space on the disc for
128 characters of information. May be overridden using the --PP
command line option.
SYSI The System Identifier. There is space on the disc for 32
characters of information. May be overridden using the --ssyyssiidd
command line option.
VOLI The Volume Identifier. There is space on the disc for 32
characters of information. May be overridden using the --VV command
line option.
VOLS The Volume Set Name. There is space on the disc for 278
characters of information. May be overridden using the --vvoollsseett
command line option.
TYPE The default TYPE for Macintosh files. Must be exactly 4
characters.
CREATOR #
The default CREATOR for Macintosh files. Must be exactly 4
characters.
mmkkhhyybbrriidd can also be configured at compile time with defaults for many of
these fields. See the file defaults.h.
AAUUTTHHOORR #
mmkkiissooffss is not based on the standard mk*fs tools for unix, because we
must generate a complete copy of an existing filesystem on a disk in the
iso9660 filesystem. The name mkisofs is probably a bit of a misnomer,
since it not only creates the filesystem, but it also populates it as
well.
Eric Youngdale <ericy@gnu.ai.mit.edu> or <eric@andante.jic.com> wrote
both the Linux isofs9660 filesystem and the mkisofs utility, and is
currently maintaining them. The copyright for the mkisofs utility is
held by Yggdrasil Computing, Incorporated.
mmkkhhyybbrriidd is based on mmkkiissooffss and works in exactly the same way as mmkkiissooffss
without the HFS options. The change in name is to signify that it does
something extra. If you do not need the HFS options, then you should
really be using _m_k_i_s_o_f_s.
HFS hybrid code Copyright (C) James Pearson 1997, 1998, 1999
libhfs code Copyright (C) 1996, 1997 Robert Leslie
libfile code Copyright (C) Ian F. Darwin 1986, 1987, 1989, 1990, 1991,
1992, 1994, 1995.
BBUUGGSS #
Any files that have hard links to files not in the tree being copied to
the iso9660 filesystem will have an incorrect file reference count.
There may be some other ones. Please, report them to the author.
HHFFSS PPRROOBBLLEEMMSS//LLIIMMIITTAATTIIOONNSS #
I have had to make several assumptions on how I expect the modified
libhfs routines to work, however there may be situations that either I
haven't thought of, or come across when these assumptions fail.
Therefore I can't guarantee that mkhybrid will work as expected (although
I haven't had a major problem yet). Most of the HFS features work fine,
however, some are not fully tested. These are marked as _A_l_p_h_a above.
Output volume size must be at least 800Kb (libhfs limit - shouldn't
really be a problem).
Although HFS filenames appear to support upper and lower case letters,
the filesystem is case insensitive. i.e. the filenames "aBc" and "AbC"
are the same. If a file is found in a directory with the same HFS name,
then _m_k_h_y_b_r_i_d will attempt, where possible, to make a unique name by
adding '_' characters to one of the filenames.
HFS file/directory names that share the first 31 characters have _N' (N
== decimal number) substituted for the last few characters to generate
unique names.
Care must be taken when "grafting" Apple/Unix files or directories (see
above for the method and syntax involved). It is not possible to use a
new name for an Apple/Unix encoded file/directory. e.g. If a Apple/Unix
encoded file called "oldname" is to added to the CD, then you can not use
the command line:
mkhybrid -o output.raw -hfs newname=oldname cd_dir
mkhybrid will be unable to decode "oldname". However, you can graft
Apple/Unix encoded files or directories as long as you do not attempt to
give them new names as above.
The _-_M option has no real meaning with an HFS volume - and will probably
not work.
Symbolic links (as with all other non-regular files) are not added to the
HFS directory.
Hybrid volumes may be larger than pure ISO9660 volumes containing the
same data.
The resulting hybrid volume can be accessed on a Unix machine by using
the hfsutils routines. However, no changes should be made to the contents
of the volume as it's not a "real" HFS volume.
Using the _-_m_a_c_-_n_a_m_e option will not currently work with the _-_T option -
the Unix name will be used in the TRANS.TBL file, not the Macintosh name.
Although _m_k_h_y_b_r_i_d does not alter the contents of a file, if a binary file
has it's TYPE set as 'TEXT', it _m_a_y be read incorrectly on a Macintosh.
Therefore a better choice for the default TYPE may be '????'
The _-_m_a_c_-_b_o_o_t_-_f_i_l_e option may not work at all...
The _-_a option should be used at all times. It may well become the default
in future releases.
May not work with PC Exchange v2.2 or higher files (available with MacOS
8.1). DOS media containing PC Exchange files should be mounted as type
mmssddooss (not vvffaatt) when using Linux.
SSEEEE AALLSSOO #
_m_k_i_s_o_f_s(8), _m_a_g_i_c(5), _a_p_p_l_e___d_r_i_v_e_r(8)
FFUUTTUURREE IIMMPPRROOVVEEMMEENNTTSS #
Some sort of gui interface.
Version 1.12b5.1 7 April 1999 MKHYBRID(8)