Debian Codegraph @

upstream/debian-unstable/man1/genisoimage.1

raw
1 '\" t
2 .\" genisoimage.1 -*- nroff -*- To render, first run through tbl
3 .\" Copyright 1993-1998 by Yggdrasil Computing
4 .\" Copyright 1996-1997 by Robert Leslie
5 .\" Copyright 1997-2001 by James Pearson
6 .\" Copyright 1999-2006 by Joerg Schilling
7 .\" Copyright 2002-2003 by Jungshik Shin
8 .\" Copyright 2003 by Jaakko Heinonen
9 .\" Copyright 2006 by the Cdrkit maintainers
10 .\"
11 .TH GENISOIMAGE 1 "13 Dec 2006"
12 .\" ----------------------------------------
13 .SH NAME
14 genisoimage \- create ISO9660/Joliet/HFS filesystem with optional Rock Ridge attributes
15 .\" ----------------------------------------
16 .SH SYNOPSIS
17 .B genisoimage
18 .RI [ options ]
19 .RB [ \-o
20 .IR filename ]
21 .IR pathspec " [" "pathspec ..." ]
22 .\" ----------------------------------------
23 .SH DESCRIPTION
24 .B genisoimage
25 is a pre-mastering program to generate ISO9660/Joliet/HFS hybrid
26 filesystems.
27 .PP
28 .B genisoimage
29 is capable of generating the
30 .B System Use Sharing Protocol records (SUSP)
31 specified by the
32 .BR "Rock Ridge Interchange Protocol" .
33 This is used to further describe the
34 files in the ISO9660 filesystem to a Unix host, and provides information such
35 as long filenames, UID/GID, POSIX permissions, symbolic links, and
36 block and character device files.
37 .PP
38 If Joliet or HFS hybrid command line options are specified,
39 .B genisoimage
40 will create the additional filesystem metadata needed for Joliet or HFS.
41 Otherwise
42 .B genisoimage
43 will generate a pure ISO9660 filesystem.
44 .PP
45 .B genisoimage
46 can generate a
47 .I true
48 (or
49 .IR shared )
50 HFS hybrid filesystem. The same files are seen as HFS files when
51 accessed from a Macintosh and as ISO9660 files when accessed from other
52 machines. HFS stands for
53 .I Hierarchical File System
54 and is the native filesystem used on Macintosh computers.
55 .PP
56 As an alternative,
57 .B genisoimage
58 can generate the
59 .I Apple Extensions to ISO9660
60 for each file. These extensions provide each file with CREATOR, TYPE and
61 certain Finder flags when accessed from a Macintosh. See the
62 .B HFS MACINTOSH FILE FORMATS
63 section below.
64 .PP
65 .B genisoimage
66 takes a snapshot of a given directory tree, and generates a
67 binary image which will correspond to an ISO9660 and/or HFS filesystem when
68 written to a block device.
69 .PP
70 Each file written to the ISO9660 filesystem must have a filename in the 8.3
71 format (up to 8 characters, period, up to 3 characters, all uppercase), even
72 if Rock Ridge is in use. This filename is used on systems that are not able
73 to make use of the Rock Ridge extensions (such as MS-DOS), and each filename
74 in each directory must be different from the other filenames in the same
75 directory.
76 .B genisoimage
77 generally tries to form correct names by forcing the Unix filename to
78 uppercase and truncating as required, but often this yields unsatisfactory
79 results when the truncated names are not all unique.
80 .B genisoimage
81 assigns weightings to each filename, and if two names that are otherwise the
82 same are found, the name with the lower priority is renamed to include a
83 3-digit number (guaranteed to be unique). For example, the two files
84 .I foo.bar
85 and
86 .I foo.bar.~1~
87 could be rendered as
88 .I FOO.BAR;1
89 and
90 .IR FOO000.BAR;1 .
91 .PP
92 When used with various HFS options,
93 .B genisoimage
94 will attempt to recognise files stored in a number of Apple/Unix file formats
95 and will copy the data and resource forks as well as any
96 relevant Finder information. See the
97 .B HFS MACINTOSH FILE FORMATS
98 section below for more about formats
99 .B genisoimage
100 supports.
101 .PP
102 Note that
103 .B genisoimage
104 is not designed to communicate with the writer directly. Most writers
105 have proprietary command sets which vary from one manufacturer to
106 another, and you need a specialized tool to actually burn the disc.
107 .B wodim
108 is one such tool. The latest version of
109 .B wodim
110 is available from
111 .IR http://www.cdrkit.org/ .
112 .PP
113 .B pathspec
114 is the path of the directory tree to be copied into the ISO9660 filesystem.
115 Multiple paths can be specified, and
116 .B genisoimage
117 will merge the files found in all of the specified path components to
118 form the filesystem image.
119 .PP
120 If the option
121 .B \-graft\-points
122 has been specified, it is possible to graft the paths at points other
123 than the root directory, and it is possible to graft files or
124 directories onto the cdrom image with names different than what they
125 have in the source filesystem. This is easiest to illustrate with a
126 couple of examples. Let's start by assuming that a local file
127 .I ../old.lis
128 exists, and you wish to include it in the cdrom image.
129 .IP
130 foo/bar/=../old.lis
131 .PP
132 will include
133 .I old.lis
134 in the cdrom image at
135 .IR /foo/bar/old.lis ,
136 while
137 .IP
138 foo/bar/xxx=../old.lis
139 .PP
140 will include
141 .I old.lis
142 in the cdrom image at
143 .IR /foo/bar/xxx .
144 The same sort of syntax can be used with directories as well.
145 .B genisoimage
146 will create any directories required such that the graft
147 points exist on the cdrom image \(em the directories do not need to
148 appear in one of the paths. By default, any directories that are created on
149 the fly like this will have permissions 0555 and appear to be owned by the
150 person running
151 .BR genisoimage .
152 If you wish other permissions or owners of
153 the intermediate directories, see
154 .BR \-uid ", " \-gid ", " \-dir\-mode ", " \-file\-mode " and " \-new\-dir\-mode .
155 .PP
156 .B genisoimage
157 will also run on Windows machines when compiled with Cygnus' cygwin
158 (available from
159 .IR http://www.cygwin.com/ ).
160 Therefore most references in this man page to
161 .I Unix
162 can be replaced with
163 .IR Win32 .
164 .\" ----------------------------------------
165 .SH OPTIONS
166 .PP
167 Several options can be specified as defaults in a
168 .I .genisoimagerc
169 configuration file, as well as on the command line. If a parameter is
170 specified in both places, the setting from the command line is used.
171 For details on the format and possible locations of this file, see
172 .BR genisoimagerc (5).
173 .TP
174 .BI \-abstract " file"
175 Specifies the abstract filename. There is space for 37 characters.
176 Equivalent to
177 .B ABST
178 in the
179 .I .genisoimagerc
180 file.
181 .TP
182 .BI \-A " application_id"
183 Specifies a text string that will be written into the volume header.
184 This should describe the application that will be on the disc. There
185 is space for 128 characters. Equivalent to
186 .B APPI
187 in the
188 .I .genisoimagerc
189 file.
190 .TP
191 .B \-allow\-limited\-size
192 When processing files larger than 2GiB which cannot be easily represented in
193 ISO9660, add them with a shrunk visible file size to ISO9660 and with the
194 correct visible file size to the UDF system. The result is an inconsistent
195 filesystem and users need to make sure that they really use UDF rather than
196 ISO9660 driver to read a such disk. Implies enabling
197 .BR \-udf.
198 .TP
199 .B \-allow\-leading\-dots
200 .TP
201 .B \-ldots
202 Allow ISO9660 filenames to begin with a period. Usually, a leading dot is
203 replaced with an underscore in order to maintain MS-DOS compatibility.
204 .br
205 This violates the ISO9660 standard, but it happens to work on many systems.
206 Use with caution.
207 .TP
208 .B \-allow\-lowercase
209 This options allows lowercase characters to appear in ISO9660 filenames.
210 .br
211 This violates the ISO9660 standard, but it happens to work on some systems.
212 Use with caution.
213 .TP
214 .B \-allow\-multidot
215 This options allows more than one dot to appear in ISO9660 filenames.
216 A leading dot is not affected by this option, it
217 may be allowed separately using
218 .BR \-allow\-leading\-dots .
219 .br
220 This violates the ISO9660 standard, but it happens to work on many systems.
221 Use with caution.
222 .TP
223 .BI \-biblio " file"
224 Specifies the bibliographic filename. There is space for 37 characters.
225 Equivalent to
226 .B BIBL
227 in the
228 .I .genisoimagerc
229 file.
230 .TP
231 .B \-cache\-inodes
232 .TP
233 .B \-no\-cache\-inodes
234 Enable or disable caching inode and device numbers to find hard links
235 to files. If
236 .B genisoimage
237 finds a hard link (a file with multiple names), the file will also be
238 hard-linked on the CD, so the file contents only appear once. This
239 helps to save space.
240 .B \-cache\-inodes
241 is default on Unix-like operating systems, but
242 .B \-no\-cache\-inodes
243 is default on some other systems such as Cygwin, because it is not safe
244 to assume that inode numbers are unique on those systems. (Some
245 versions of Cygwin create fake inode numbers using a weak hashing
246 algorithm, which may produce duplicates.) If two files have the same
247 inode number but are not hard links to the same file,
248 .B genisoimage \-cache\-inodes
249 will not behave correctly.
250 .B \-no\-cache\-inodes
251 is safe in all situations, but in that case
252 .B genisoimage
253 cannot detect hard links, so the resulting CD image may be larger
254 than necessary.
255 .TP
256 .BI \-alpha\-boot " alpha_boot_image"
257 Specifies the path and filename of the boot image to be used when
258 making an Alpha/SRM bootable CD. The pathname must be relative to the
259 source path specified to
260 .BR genisoimage .
261 .TP
262 .BI \-hppa\-bootloader " hppa_bootloader_image"
263 Specifies the path and filename of the boot image to be used when
264 making an HPPA bootable CD. The pathname must be relative to the
265 source path specified to
266 .BR genisoimage .
267 Other options are required, at the very least a kernel filename and
268 a boot command line. See the
269 .B HPPA NOTES
270 section below for more information.
271 .TP
272 .BI \-hppa\-cmdline " hppa_boot_command_line"
273 Specifies the command line to be passed to the HPPA boot loader when
274 making a bootable CD. Separate the parameters with spaces or
275 commas. More options must be passed to
276 .B genisoimage,
277 at the very least a kernel filename and the boot loader filename.
278 See the
279 .B HPPA NOTES
280 section below for more information.
281 .TP
282 .BI \-hppa\-kernel\-32 " hppa_kernel_32"
283 .TP
284 .BI \-hppa\-kernel\-64 " hppa_kernel_64"
285 Specifies the path and filename of the 32-bit and/or 64-bit kernel images
286 to be used when making an HPPA bootable CD. The pathnames must be
287 relative to the source path specified to
288 .BR genisoimage .
289 Other options are required, at the very least the boot loader filename
290 and the boot command line. See the
291 .B HPPA NOTES
292 section below for more information.
293 .TP
294 .BI \-hppa\-ramdisk " hppa_ramdisk_image"
295 Specifies the path and filename of the ramdisk image to be used when
296 making an HPPA bootable CD. The pathname must be relative to the
297 source path specified to
298 .BR genisoimage .
299 This parameter is optional. Other options are required, at the very
300 least a kernel filename and the boot command line. See the
301 .B HPPA NOTES
302 section below for more information.
303 .TP
304 .BI \-mips\-boot " mips_boot_image"
305 Specifies the path and filename of the boot image to be used when
306 making an SGI/big-endian MIPS bootable CD. The pathname must be
307 relative to the source path specified to
308 .BR genisoimage .
309 This option may be specified several times, to store up to 15 boot
310 images.
311 .TP
312 .BI \-mipsel\-boot " mipsel_boot_image"
313 Specifies the path and filename of the boot image to be used when
314 making an DEC/little-endian MIPS bootable CD. The pathname must be
315 relative to the source path specified to
316 .BR genisoimage .
317 .TP
318 .BI \-B " img_sun4,img_sun4c,img_sun4m,img_sun4d,img_sun4e"
319 .TP
320 .BI \-sparc\-boot " img_sun4,img_sun4c,img_sun4m,img_sun4d,img_sun4e"
321 Specifies a comma-separated list of boot images that are needed to make
322 a bootable CD for SPARC systems.
323 Partition 0 is used for the ISO9660 image, the first image file is mapped
324 to partition 1.
325 The comma-separated list may have up to 7 fields, including empty fields.
326 This option is required to make a bootable CD for Sun SPARC systems.
327 If
328 .B \-B
329 or
330 .B \-sparc\-boot
331 has been specified, the first sector of the resulting image will
332 contain a Sun disk label. This disk label specifies slice 0 for the
333 ISO9660 image and slices 1 to 7 for the boot images that
334 have been specified with this option. Byte offsets 512 to 8191
335 within each of the additional boot images must contain a primary boot
336 that works for the appropriate SPARC architecture. The rest of each
337 of the images usually contains a UFS filesystem used for the primary
338 kernel boot stage.
339 .IP
340 The implemented boot method is the one found with SunOS 4.x and SunOS 5.x.
341 However, it does not depend on SunOS internals but only on properties of
342 the Open Boot prom, so it should be usable for any OS for SPARC systems.
343 For more information also see the
344 .B NOTES
345 section below.
346 .IP
347 If the special filename
348 .B ...
349 is used, the actual and all following boot partitions are mapped to the
350 previous partition. If
351 .B genisoimage
352 is called with
353 .BI \-G " image " \-B " ..."
354 all boot partitions are mapped to the partition that contains the ISO9660
355 filesystem image and the generic boot image that is located in the first
356 16 sectors of the disc is used for all architectures.
357 .TP
358 .BI \-G " generic_boot_image"
359 Specifies the path and filename of the generic boot image to be used when making
360 a generic bootable CD. The boot image will be placed on the first 16
361 sectors of the CD, before the ISO9660 primary volume descriptor.
362 If this option is used together with
363 .BR \-sparc\-boot ,
364 the Sun disk label will overlay the first 512 bytes of the generic
365 boot image.
366 .TP
367 .BI \-b " eltorito_boot_image"
368 Specifies the path and filename of the boot image to be used when making
369 an El Torito bootable CD for x86 PCs. The pathname must be relative to
370 the source path specified to
371 .BR genisoimage .
372 This option is required to make an El Torito bootable CD.
373 The boot image must be exactly 1200 kB, 1440 kB or 2880 kB, and
374 .B genisoimage
375 will use this size when creating the output ISO9660 filesystem. The PC
376 BIOS will use the image to emulate a floppy disk, so the first 512-byte
377 sector should contain PC boot code. This will work, for example, if
378 the boot image is a LILO-based boot floppy.
379 .IP
380 If the boot image is not an image of a floppy, you need to add either
381 .BR \-hard\-disk\-boot " or " \-no\-emul\-boot .
382 If the system should not boot off the emulated disk, use
383 .BR \-no\-boot .
384 .IP
385 If
386 .B \-sort
387 has not been specified, the boot images are sorted
388 with low priority (+2) to the beginning of the medium.
389 If you don't like this, you need to specify a sort weight of 0 for the boot images.
390 .TP
391 .B \-eltorito\-alt\-boot
392 Start with a new set of El Torito boot parameters. Up to 63 El Torito
393 boot entries may be stored on a single CD.
394 .TP
395 .BI \-hard\-disk\-boot
396 Specifies that the boot image used to create El Torito bootable CDs is
397 a hard disk image. The image must begin with a master boot
398 record that contains a single partition.
399 .TP
400 .BI \-no\-emul\-boot
401 Specifies that the boot image used to create El Torito bootable CDs is
402 a "no emulation" image. The system will load and execute this image without
403 performing any disk emulation.
404 .TP
405 .BI \-no\-boot
406 Specifies that the created El Torito CD should be marked as not bootable. The
407 system will provide an emulated drive for the image, but will boot off
408 a standard boot device.
409 .TP
410 .BI \-boot\-load\-seg " segment_address"
411 Specifies the load segment address of the boot image for no-emulation
412 El Torito CDs.
413 .TP
414 .BI \-boot\-load\-size " load_sectors"
415 Specifies the number of "virtual" (512-byte) sectors to load in
416 no-emulation mode. The default is to load the entire boot file. Some
417 BIOSes may have problems if this is not a multiple of 4.
418 .TP
419 .B \-boot\-info\-table
420 Specifies that a 56-byte table with information of the CD-ROM layout
421 will be patched in at offset 8 in the boot file. If this option is
422 given, the boot file is
423 .IR "modified in the source filesystem" ,
424 so make a copy of this file if it cannot be easily regenerated!
425 See the
426 .B EL TORITO BOOT INFO TABLE
427 section for a description of this table.
428 .TP
429 .BI \-C " last_sess_start,next_sess_start"
430 This option is needed to create a CD Extra or the image of a second
431 session or a higher-level session for a multisession disc.
432 .B \-C
433 takes two numbers separated by a comma. The first is the first sector
434 in the last session of the disc that should be appended to.
435 The second number is the starting sector number of the new session.
436 The correct numbers may be retrieved by calling
437 .B wodim \-msinfo ...
438 If
439 .B \-C
440 is used in conjunction with
441 .BR \-M ,
442 .B genisoimage
443 will create a filesystem image that is intended to be a continuation
444 of the previous session.
445 If
446 .B \-C
447 is used without
448 .BR \-M ,
449 .B genisoimage
450 will create a filesystem image that is intended to be used for a second
451 session on a CD Extra. This is a multisession CD that holds audio data
452 in the first session and an ISO9660 filesystem in the second session.
453 .TP
454 .BI \-c " boot_catalog"
455 Specifies the path and filename of the boot catalog, which is required
456 for an El Torito bootable CD. The pathname must be relative to the source
457 path specified to
458 .BR genisoimage .
459 This file will be inserted into the output tree and not created
460 in the source filesystem, so be
461 sure the specified filename does not conflict with an existing file, or
462 it will be excluded. Usually a name like
463 .I boot.catalog
464 is chosen.
465 .IP
466 If
467 .B \-sort
468 has not been specified, the boot catalog sorted
469 with low priority (+1) to the beginning of the medium.
470 If you don't like this, you need to specify a sort weight of 0 for the boot catalog.
471 .TP
472 .B \-check\-oldnames
473 Check all filenames imported from the old session for compliance with
474 the ISO9660 file naming rules.
475 Without this option, only names longer than 31 characters are checked,
476 as these files are a serious violation of the ISO9660 standard.
477 .TP
478 .BI \-check\-session " file"
479 Check all old sessions for compliance with actual
480 .B genisoimage
481 ISO9660 file naming rules.
482 This is a high-level option that combines
483 .B \-M
484 .I file
485 .BR "\-C 0,0 \-check\-oldnames" .
486 For the parameter
487 .IR file ,
488 see the description of
489 .BR \-M .
490 .TP
491 .BI \-copyright " file"
492 Specifies copyright information, typically a filename on the disc.
493 There is space for 37 characters. Equivalent to
494 .B COPY
495 in the
496 .I .genisoimagerc
497 file.
498 .TP
499 .B \-d
500 Do not append a period to files that do not have one.
501 .br
502 This violates the ISO9660 standard, but it happens to work on many systems.
503 Use with caution.
504 .TP
505 .B \-D
506 Do not use deep directory relocation, and instead just pack them in the
507 way we see them.
508 .br
509 If ISO9660:1999 has not been selected,
510 this violates the ISO9660 standard, but it happens to work on many systems.
511 Use with caution.
512 .TP
513 .BI \-dir\-mode " mode"
514 Overrides the mode of directories used to create the image to
515 .IR mode ,
516 specified as 4 digits of permission bits as in
517 .BR chmod (1).
518 This option automatically enables Rock Ridge extensions.
519 .TP
520 .B \-dvd\-video
521 Generate a DVD-Video compliant UDF filesystem. This is done by sorting the
522 order of the content of the appropriate files and by adding padding
523 between the files if needed.
524 Note that the sorting only works if the DVD-Video filenames include uppercase
525 characters only.
526 .IP
527 Note that in order to get a DVD-Video compliant filesystem image, you
528 need to prepare a DVD-Video compliant directory tree. This requires a
529 directory
530 .B VIDEO_TS
531 (all caps) in the root directory of the resulting DVD, and usually
532 another directory
533 .BR AUDIO_TS .
534 .B VIDEO_TS
535 needs to include all needed files (filenames must be all caps) for a
536 compliant DVD-Video filesystem.
537 .TP
538 .B \-f
539 Follow symbolic links when generating the filesystem. When this option is not
540 in use, symbolic links will be entered using Rock Ridge if enabled, otherwise
541 they will be ignored.
542 .TP
543 .BI \-file\-mode " mode"
544 Overrides the mode of regular files used to create the image to
545 .IR mode ,
546 specified as 4 digits of permission bits as in
547 .BR chmod (1).
548 This option automatically enables Rock Ridge extensions.
549 .TP
550 .BI \-gid " gid"
551 Overrides the group ID read from the source files to the value of
552 .IR gid .
553 Specifying this option automatically enables Rock Ridge extensions.
554 .TP
555 .B \-gui
556 Switch the behaviour for a GUI. This currently makes the output more verbose
557 but may have other effects in the future.
558 .TP
559 .B \-graft\-points
560 Allow use of graft points for filenames. If this option is used, all
561 filenames are checked for graft points. The filename is divided at the
562 first unescaped equal sign. All occurrences of `\(rs' and `=' characters
563 must be escaped with `\(rs' if
564 .B \-graft\-points
565 has been specified.
566 .TP
567 .BI \-hide " glob"
568 Hide any files matching
569 .IR glob ,
570 a shell wildcard pattern, from being seen in the ISO9660 or Rock Ridge
571 directory.
572 .I glob
573 may match any part of the filename or path. If
574 .I glob
575 matches a directory, the contents of that directory will be hidden.
576 In order to match a directory name, make sure the pathname does not include
577 a trailing `/' character.
578 All the hidden files will still be written to the output CD image file.
579 See also
580 .BR \-hide\-joliet ,
581 and
582 .IR README.hide .
583 This option may be used multiple times.
584 .TP
585 .BI \-hide\-list " file"
586 A file containing a list of shell wildcards to be hidden. See
587 .BR \-hide .
588 .TP
589 .BI \-hidden " glob"
590 Add the hidden (existence) ISO9660 directory attribute for files and
591 directories matching
592 .IR glob ,
593 a shell wildcard pattern. This attribute will prevent the files from
594 being shown by some MS-DOS and Windows commands.
595 .I glob
596 may match any part of the filename or path.
597 In order to match a directory name, make sure the pathname does not include
598 a trailing `/' character.
599 This option may be used multiple times.
600 .TP
601 .BI \-hidden\-list " file"
602 A file containing a list of shell wildcards to get the hidden
603 attribute. See
604 .BR \-hidden .
605 .TP
606 .BI \-hide\-joliet " glob"
607 Hide files and directories matching
608 .IR glob ,
609 a shell wildcard pattern, from being seen in the Joliet directory.
610 .I glob
611 may match any part of the filename or path. If
612 .I glob
613 matches a directory, the contents of that directory will be hidden.
614 In order to match a directory name, make sure the pathname does not include
615 a trailing `/' character.
616 All the hidden files will still be written to the output CD image file.
617 This option is usually used with
618 .BR \-hide .
619 See also
620 .IR README.hide .
621 This option may be used multiple times.
622 .TP
623 .BI \-hide\-joliet\-list " file"
624 A file containing a list of shell wildcards to be hidden from the
625 Joliet tree. See
626 .BR \-hide\-joliet .
627 .TP
628 .B \-hide\-joliet\-trans\-tbl
629 Hide the
630 .I TRANS.TBL
631 files from the Joliet tree.
632 These files usually don't make sense in the Joliet world as they list
633 the real name and the ISO9660 name which may both be different from the
634 Joliet name.
635 .TP
636 .B \-hide\-rr\-moved
637 Rename the directory
638 .I RR_MOVED
639 to
640 .I .rr_moved
641 in the Rock Ridge tree.
642 It seems to be impossible to completely hide the
643 .I RR_MOVED
644 directory from the Rock Ridge tree.
645 This option only makes the visible tree less confusing for
646 people who don't know what this directory is for.
647 If you need to have no
648 .I RR_MOVED
649 directory at all, you should use
650 .BR \-D .
651 Note that if
652 .B \-D
653 has been specified, the resulting filesystem is not ISO9660
654 level-1 compliant and will not be readable on MS-DOS.
655 See also the
656 .B NOTES
657 section.
658 .TP
659 .BI \-input\-charset " charset"
660 Input charset that defines the characters used in local filenames.
661 To get a list of valid charset names, call
662 .BR "genisoimage \-input\-charset help" .
663 To get a 1:1 mapping, you may use
664 .B default
665 as charset name. The default initial values are
666 .I cp437
667 on DOS-based systems and
668 .I iso8859-1
669 on all other systems. See the
670 .B CHARACTER SETS
671 section below for more details.
672 .TP
673 .BI \-output\-charset " charset"
674 Output charset that defines the characters that will be used in Rock Ridge
675 filenames. Defaults to the input charset. See
676 .B CHARACTER SETS
677 section below for more details.
678 .TP
679 .BI \-iso\-level " level"
680 Set the ISO9660 conformance level. Valid numbers are 1 to 4.
681 .IP
682 With level 1, files may only consist of one section and filenames are
683 restricted to 8.3 characters.
684 .IP
685 With level 2, files may only consist of one section.
686 .IP
687 With level 3, no restrictions (other than ISO-9660:1988) do apply.
688 .IP
689 With all ISO9660 levels from 1 to 3, all filenames are restricted to
690 uppercase letters, numbers and underscores (_). Filenames are
691 limited to 31 characters, directory nesting is limited to 8
692 levels, and pathnames are limited to 255 characters.
693 .IP
694 Level 4 officially does not exist but
695 .B genisoimage
696 maps it to ISO-9660:1999, which is ISO9660 version 2.
697 .IP
698 With level 4, an enhanced volume descriptor with version number
699 and file structure version number set to 2 is emitted.
700 Directory nesting is not limited to 8 levels,
701 there is no need for a file to contain a dot and the dot has no
702 special meaning, filenames do not have version numbers,
703 .\" (f XXX ??? The character used for filling byte positions which are
704 .\" specified to be characters is subject to agreement between the
705 .\" originator and the recipient of the volume),
706 and filenames can be up to 207 characters long, or 197 characters if
707 Rock Ridge is used.
708 .IP
709 When creating Version 2 images,
710 .B genisoimage
711 emits an enhanced volume descriptor, similar but not identical to a
712 primary volume descriptor. Be careful not to use broken software
713 to make ISO9660 images bootable by assuming a second PVD copy and patching
714 this putative PVD copy into an El Torito VD.
715 .TP
716 .B \-J
717 Generate Joliet directory records in addition to regular ISO9660
718 filenames. This is primarily useful when the discs are to be used on
719 Windows machines. Joliet filenames are specified in Unicode and each
720 path component can be up to 64 Unicode characters long.
721 Note that Joliet is not a standard \(em only Microsoft Windows and Linux
722 systems can read Joliet extensions. For greater portability, consider
723 using both Joliet and Rock Ridge extensions.
724 .TP
725 .B \-joliet\-long
726 Allow Joliet filenames to be up to 103 Unicode characters, instead of
727 64. This breaks the Joliet specification, but appears to work. Use
728 with caution.
729 .\" The number 103 is derived from: the maximum Directory Record Length
730 .\" (254), minus the length of Directory Record (33), minus CD-ROM XA
731 .\" System Use Extension Information (14), divided by the UTF-16
732 .\" character size (2).
733 .TP
734 .BI \-jcharset " charset"
735 A combination of
736 .B \-J \-input\-charset
737 .IR charset .
738 See the
739 .B CHARACTER SETS
740 section below for more details.
741 .TP
742 .B \-l
743 Allow full 31-character filenames. Normally the ISO9660 filename will be in an
744 8.3 format which is compatible with MS-DOS, even though the ISO9660 standard
745 allows filenames of up to 31 characters. If you use this option, the disc may
746 be difficult to use on a MS-DOS system, but will work on most other systems.
747 Use with caution.
748 .TP
749 .B \-L
750 Outdated option; use
751 .B \-allow\-leading\-dots
752 instead.
753 .TP
754 .BI \-jigdo\-jigdo " jigdo_file"
755 Produce a
756 .B jigdo
757 .I .jigdo
758 metadata file as well as the filesystem image. See the
759 .B JIGDO NOTES
760 section below for more information.
761 .TP
762 .BI \-jigdo\-template " template_file"
763 Produce a
764 .B jigdo
765 .I .template
766 file as well as the filesystem image. See the
767 .B JIGDO NOTES
768 section below for more information.
769 .TP
770 .BI \-jigdo\-min\-file\-size " size"
771 Specify the minimum size for a file to be listed in the
772 .I .jigdo
773 file. Default (and minimum allowed) is 1KB. See the
774 .B JIGDO NOTES
775 section below for more information.
776 .TP
777 .BI \-jigdo\-force\-md5 " path"
778 Specify a file pattern where files
779 .I must
780 be contained in the externally-supplied MD5 list as supplied by
781 .BR \-md5\-list .
782 See the
783 .B JIGDO NOTES
784 section below for more information.
785 .TP
786 .BI \-jigdo\-exclude " path"
787 Specify a file pattern where files will not be listed in the
788 .I .jigdo
789 file. See the
790 .B JIGDO NOTES
791 section below for more information.
792 .TP
793 .BI \-jigdo\-map " path"
794 Specify a pattern mapping for the jigdo file
795 (e.g.
796 .IR Debian=/mirror/debian ).
797 See the
798 .B JIGDO NOTES
799 section below for more information.
800 .TP
801 .BI \-md5\-list " md5_file"
802 Specify a file containing the MD5sums, sizes and pathnames of the
803 files to be included in the
804 .I .jigdo
805 file. See the
806 .B JIGDO NOTES
807 section below for more information.
808 .TP
809 .BI \-jigdo\-template\-compress " algorithm
810 Specify a compression algorithm to use for template date. gzip and
811 bzip2 are currently supported, and gzip is the default. See the
812 .B JIGDO NOTES
813 section below for more information.
814 .TP
815 .BI \-log\-file " log_file"
816 Redirect all error, warning and informational messages to
817 .I log_file
818 instead of the standard error.
819 .TP
820 .BI \-m " glob"
821 Exclude files matching
822 .IR glob ,
823 a shell wildcard pattern, from being written to CD-ROM.
824 .I glob
825 may match either the filename component or the full pathname.
826 This option may be used multiple times. For example:
827 .sp
828 genisoimage \-o rom \-m \(aq*.o\(aq \-m core \-m foobar
829 .sp
830 would exclude all files ending in `.o', or called
831 .IR core " or " foobar
832 from the image. Note that if you had a directory called
833 .IR foobar ,
834 it too (and of course all its descendants) would be excluded.
835 .TP
836 .BI \-exclude\-list " file"
837 A file containing a list of shell wildcards to be excluded. See
838 .BR \-m .
839 .TP
840 .B \-max\-iso9660\-filenames
841 Allow ISO9660 filenames to be up to 37 characters long.
842 This option enables
843 .B \-N
844 as the extra name space is taken from the space reserved for
845 file version numbers.
846 .br
847 This violates the ISO9660 standard, but it happens to work on many systems.
848 Although a conforming application needs to provide a buffer space of at
849 least 37 characters, discs created with this option may cause a buffer
850 overflow in the reading operating system. Use with extreme care.
851 .TP
852 .BI \-M " path"
853 .TP
854 .BI \-M " device"
855 .TP
856 .BI \-dev " device"
857 Specifies path to existing ISO9660 image to be merged. The alternate form
858 takes a SCSI device specifier that uses the same syntax as the
859 .B dev=
860 parameter of
861 .BR wodim .
862 The output of
863 .B genisoimage
864 will be a new session which should get written to the end of the
865 image specified in
866 .BR \-M .
867 Typically this requires multisession capability for the CD recorder
868 used to write the image. This option may only be used in conjunction
869 with
870 .BR \-C .
871 .TP
872 .B \-N
873 Omit version numbers from ISO9660 filenames.
874 .br
875 This violates the ISO9660 standard, but no one really uses the
876 version numbers anyway. Use with caution.
877 .TP
878 .BI \-new\-dir\-mode " mode"
879 Specify the mode, a 4-digit number as used in
880 .BR chmod (1),
881 to use when creating new directories in the filesystem image. The
882 default is 0555.
883 .TP
884 .B \-nobak
885 .TP
886 .B \-no\-bak
887 Exclude backup files files on the ISO9660 filesystem; that is,
888 filenames that contain the characters `~' or `#' or end in
889 .IR .bak .
890 These are typically backup files for Unix text editors.
891 .TP
892 .B \-force\-rr
893 Do not use the automatic Rock Ridge attributes recognition for previous sessions.
894 This can work around problems with images created by, e.g., NERO Burning ROM.
895 .TP
896 .B \-no\-rr
897 Do not use the Rock Ridge attributes from previous sessions.
898 This may help to avoid problems when
899 .B genisoimage
900 finds illegal Rock Ridge signatures on an old session.
901 .TP
902 .B \-no\-split\-symlink\-components
903 Don't split the symlink components, but begin a new Continuation Area (CE)
904 instead. This may waste some space, but the SunOS 4.1.4 cdrom driver
905 has a bug in reading split symlink components.
906 .IP
907 It is questionable whether this option is useful nowadays.
908 .TP
909 .B \-no\-split\-symlink\-fields
910 Don't split the symlink fields, but begin a new Continuation Area (CE)
911 instead. This may waste some space, but the SunOS 4.1.4 and
912 Solaris 2.5.1 cdrom driver have a bug in reading split symlink fields
913 (a `/' can be dropped).
914 .IP
915 It is questionable whether this option is useful nowadays.
916 .TP
917 .BI \-o " filename"
918 Specify the output file for the the ISO9660 filesystem image.
919 This can be a disk file, a tape drive, or it can correspond directly
920 to the device name of the optical disc writer. If not specified, stdout is
921 used. Note that the output can also be a block device for a regular
922 disk partition, in which case the ISO9660 filesystem can be mounted
923 normally to verify that it was generated correctly.
924 .TP
925 .B \-pad
926 Pad the end of the whole image by 150 sectors (300 kB). This option is
927 enabled by default. If used in combination with
928 .BR \-B ,
929 padding is inserted between the ISO9660 partition and the boot
930 partitions, such that the first boot partition starts
931 on a sector number that is a multiple of 16.
932 .IP
933 The padding is needed as many operating systems (e.g. Linux)
934 implement read-ahead bugs in their filesystem I/O. These bugs result in read
935 errors on files that are located near the end of a track, particularly
936 if the disc is written in Track At Once mode, or where a CD audio track
937 follows the data track.
938 .\" XXX: Someone should check to see if the Linux readahead bug is
939 .\" XXX: still present, and update this comment accordingly.
940 .TP
941 .B \-no\-pad
942 Do not pad the end by 150 sectors (300 kB) and do not make the the boot partitions
943 start on a multiple of 16 sectors.
944 .TP
945 .BI \-path\-list " file"
946 A file containing a list of
947 .I pathspec
948 directories and filenames to be added to the ISO9660 filesystem. This list
949 of pathspecs are processed after any that appear on the command line. If the
950 argument is
951 .IR \- ,
952 the list is read from the standard input.
953 .TP
954 .B \-P
955 Outdated option; use
956 .B \-publisher
957 instead.
958 .TP
959 .BI \-publisher " publisher_id"
960 Specifies a text string that will be written into the volume header.
961 This should describe the publisher of the CD-ROM, usually with a
962 mailing address and phone number. There is space for 128 characters.
963 Equivalent to
964 .B PUBL
965 in the
966 .I .genisoimagerc
967 file.
968 .TP
969 .BI \-p " preparer_id"
970 Specifies a text string that will be written into the volume header.
971 This should describe the preparer of the CD-ROM, usually with a mailing
972 address and phone number. There is space for 128 characters.
973 Equivalent to
974 .B PREP
975 in the
976 .I .genisoimagerc
977 file.
978 .TP
979 .BI \-creation-date " epoch"
980 Specifies the date to be used as creation, modification and effective
981 date in the volume descriptor and for files and relocations created
982 on the fly. Specified as a number of second since
983 1970-01-01 00:00:00 +0000 (UTC); if 0, the current time is used.
984 .TP
985 .B \-print\-size
986 Print estimated filesystem size in multiples of the sector size (2048 bytes)
987 and exit. This option is needed for
988 Disk At Once mode and with some CD-R drives when piping directly into
989 .BR wodim ,
990 cases where
991 .B wodim
992 needs to know the size of the filesystem image in advance.
993 Old versions of
994 .B mkisofs
995 wrote this information (among other information) to
996 .IR stderr .
997 As this turns out to be hard to parse, the number without any other information
998 is now printed on
999 .I stdout
1000 too.
1001 If you like to write a simple shell script, redirect
1002 .I stderr
1003 and catch the number from
1004 .IR stdout .
1005 This may be done with:
1006 .sp
1007 cdblocks=\` genisoimage \-print\-size \-quiet .\|.\|. \`
1008 .br
1009 genisoimage .\|.\|. | wodim .\|.\|. tsize=${cdblocks}s \-
1010 .TP
1011 .B \-quiet
1012 This makes
1013 .B genisoimage
1014 even less verbose. No progress output will be provided.
1015 .TP
1016 .B \-R
1017 Generate SUSP and RR records using the Rock Ridge protocol to further describe
1018 the files on the ISO9660 filesystem.
1019 .TP
1020 .B \-r
1021 This is like the \-R option, but file ownership and modes are set to
1022 more useful values. The uid and gid are set to zero, because they are
1023 usually only useful on the author's system, and not useful to the
1024 client. All the file read bits are set true, so that files and
1025 directories are globally readable on the client. If any execute bit is
1026 set for a file, set all of the execute bits, so that executables are
1027 globally executable on the client. If any search bit is set for a
1028 directory, set all of the search bits, so that directories are globally
1029 searchable on the client. All write bits are cleared, because the
1030 filesystem will be mounted read-only in any case. If any of the special
1031 mode bits are set, clear them, because file locks are not useful on a
1032 read-only filesystem, and set-id bits are not desirable for uid 0 or
1033 gid 0.
1034 When used on Win32, the execute bit is set on
1035 .I all
1036 files. This is a result of the lack of file permissions on Win32 and the
1037 Cygwin POSIX emulation layer. See also
1038 .BR \-uid ", " \-gid ,
1039 .BR \-dir\-mode ", " \-file\-mode
1040 and
1041 .BR \-new\-dir\-mode .
1042 .TP
1043 .B \-relaxed\-filenames
1044 Allows ISO9660 filenames to include all 7-bit ASCII characters except
1045 lowercase letters.
1046 .br
1047 This violates the ISO9660 standard, but it happens to work on many systems.
1048 Use with caution.
1049 .TP
1050 .BI \-root " dir"
1051 Moves all files and directories into
1052 .I dir
1053 in the image. This is essentially the
1054 same as using
1055 .B \-graft\-points
1056 and adding
1057 .I dir
1058 in front of every pathspec, but is easier to use.
1059 .I dir
1060 may actually be several levels deep. It is
1061 created with the same permissions as other graft points.
1062 .TP
1063 .BI \-old-root " dir"
1064 This option is necessary when writing a multisession
1065 image and the previous (or even older) session was written with
1066 .B -root
1067 .IR dir .
1068 Using a directory name not found in the previous session
1069 causes
1070 .B genisoimage
1071 to abort with an error.
1072 Without this option,
1073 .B genisoimage
1074 would not be able to find unmodified files and would
1075 be forced to write their data into the image once more.
1076 .B \-root
1077 and
1078 .B \-old-root
1079 are meant to be used together to do incremental backups.
1080 The initial session would e.g. use:
1081 .B genisoimage \-root backup_1
1082 .IR dirs .
1083 The next incremental backup with
1084 .B genisoimage \-root backup_2 \-old-root backup_1
1085 .I dirs
1086 would take another snapshot of these directories. The first
1087 snapshot would be found in
1088 .BR backup_1 ,
1089 the second one in
1090 .BR backup_2 ,
1091 but only modified or new files need to be written
1092 into the second session.
1093 Without these options, new files would be added and old ones would be
1094 preserved. But old ones would be overwritten if the file was
1095 modified. Recovering the files by copying the whole directory back
1096 from CD would also restore files that were deleted
1097 intentionally. Accessing several older versions of a file requires
1098 support by the operating system to choose which sessions are to be
1099 mounted.
1100 .TP
1101 .BI \-sort " sort_file"
1102 Sort file locations on the media. Sorting is controlled by a file that
1103 contains pairs of filenames and sorting offset weighting.
1104 If the weighting is higher, the file will be located closer to the
1105 beginning of the media, if the weighting is lower, the file will be located
1106 closer to the end of the media. There must be only one space or tabs
1107 character between the filename and the
1108 weight and the weight must be the last characters on a line. The filename
1109 is taken to include all the characters up to, but not including the last
1110 space or tab character on a line. This is to allow for space characters to
1111 be in, or at the end of a filename.
1112 This option does
1113 .B not
1114 sort the order of the filenames that appear
1115 in the ISO9660 directory. It sorts the order in which the file data is
1116 written to the CD image, which is useful in order to optimize the
1117 data layout on a CD. See
1118 .B README.sort
1119 for more details.
1120 .TP
1121 .BI \-sparc\-boot " img_sun4,img_sun4c,img_sun4m,img_sun4d,img_sun4e"
1122 See
1123 .B \-B
1124 above.
1125 .TP
1126 .BI \-sparc\-label " label"
1127 Set the Sun disk label name for the Sun disk label that is created with
1128 .BR \-sparc-boot .
1129 .TP
1130 .B \-split\-output
1131 Split the output image into several files of approximately 1 GB each.
1132 This helps to create DVD-sized ISO9660 images on operating systems without
1133 large file support.
1134 .B wodim
1135 will concatenate more than one file into a single track if writing to a DVD.
1136 To make
1137 .B \-split\-output
1138 work,
1139 .BI \-o " filename"
1140 must be specified. The resulting output images will be named:
1141 .IR filename_00 ", " filename_01 ", " filename_02 ....
1142 .TP
1143 .BI \-stream\-media\-size " #"
1144 Select streaming operation and set the media size to # sectors.
1145 This allows you to pipe the output of the
1146 .BR tar (1)
1147 program into
1148 .B genisoimage
1149 and to create an ISO9660 filesystem without the need of an intermediate
1150 tar archive file.
1151 If this option has been specified,
1152 .B genisoimage
1153 reads from
1154 .I stdin
1155 and creates a file with the name
1156 .IR STREAM.IMG .
1157 The maximum size of the file (with padding) is 200 sectors less than the
1158 specified media size. If
1159 .B \-no\-pad
1160 has been specified, the file size is 50 sectors less than the specified media size.
1161 If the file is smaller,
1162 .B genisoimage
1163 will write padding. This may take awhile.
1164 .IP
1165 The option
1166 .B \-stream\-media\-size
1167 creates simple ISO9660 filesystems only and may not used together with multisession
1168 or hybrid filesystem options.
1169 .TP
1170 .BI \-stream\-file\-name " name"
1171 Reserved for future use.
1172 .TP
1173 .BI \-sunx86\-boot " UFS_img,,,AUX1_img"
1174 Specifies a comma-separated list of filesystem images that are needed to make
1175 a bootable CD for Solaris x86 systems.
1176 .IP
1177 Note that partition 1 is used for the ISO9660 image and that partition 2 is
1178 the whole disk, so partition 1 and 2 may not be used by external partition data.
1179 The first image file is mapped to partition 0.
1180 There may be empty fields in the comma-separated list,
1181 and list entries for partition 1 and 2 must be empty.
1182 The maximum number of supported partitions is 8 (although the Solaris x86
1183 partition table could support up to 16 partitions), so it is impossible
1184 to specify more than 6 partition images.
1185 This option is required to make a bootable CD for Solaris x86 systems.
1186 .IP
1187 If
1188 .B \-sunx86\-boot
1189 has been specified, the first sector of the resulting image will
1190 contain a PC fdisk label with a Solaris type 0x82 fdisk partition that
1191 starts at offset 512 and spans the whole CD.
1192 In addition, for the Solaris type 0x82 fdisk partition, there is a
1193 SVr4 disk label at offset 1024 in the first sector of the CD.
1194 This disk label specifies slice 0 for the first (usually UFS type)
1195 filesystem image that is used to boot the PC and slice 1 for
1196 the ISO9660 image.
1197 Slice 2 spans the whole CD slice 3 .\|.\|. slice 7 may be used for additional
1198 filesystem images that have been specified with this option.
1199 .IP
1200 A Solaris x86 boot CD uses a 1024 byte sized primary boot that uses the
1201 .B El-Torito no-emulation
1202 boot mode and a secondary generic boot that is in CD sectors 1\|.\|.15.
1203 For this reason, both
1204 .BI "-b " bootimage " \-no\-emul\-boot"
1205 and
1206 .BI \-G " genboot"
1207 must be specified.
1208 .TP
1209 .BI \-sunx86\-label " label"
1210 Set the SVr4 disk label name for the SVr4 disk label that is created with
1211 .BR \-sunx86-boot .
1212 .TP
1213 .BI \-sysid " ID"
1214 Specifies the system ID. There is space for 32 characters.
1215 Equivalent to
1216 .B SYSI
1217 in the
1218 .I .genisoimagerc
1219 file.
1220 .TP
1221 .B \-T
1222 Generate a file
1223 .I TRANS.TBL
1224 in each directory on the CD-ROM, which can be used
1225 on non-Rock\ Ridge-capable systems to help establish the correct filenames.
1226 There is also information present in the file that indicates the major and
1227 minor numbers for block and character devices, and each symlink has the name of
1228 the link file given.
1229 .TP
1230 .BI \-table\-name " table_name"
1231 Alternative translation table filename (see above). Implies
1232 .BR \-T .
1233 If you are creating a multisession image you must use the same name
1234 as in the previous session.
1235 .TP
1236 .BI \-ucs\-level " level"
1237 Set Unicode conformance level in the Joliet SVD. The default level is 3.
1238 It may be set to 1..3 using this option.
1239 .TP
1240 .B \-udf
1241 Include UDF filesystem support in the generated filesystem image. UDF
1242 support is currently in alpha status and for this reason, it is not
1243 possible to create UDF-only images. UDF data structures are currently
1244 coupled to the Joliet structures, so there are many pitfalls with the
1245 current implementation. There is no UID/GID support, there is no POSIX
1246 permission support, there is no support for symlinks. Note that UDF
1247 wastes the space from sector ~20 to sector 256 at the beginning of the
1248 disc in addition to the space needed for real UDF data structures.
1249 .TP
1250 .BI \-uid " uid"
1251 Overrides the uid read from the source files to the value of
1252 .IR uid .
1253 Specifying this option automatically enables Rock Ridge extensions.
1254 .TP
1255 .B \-use\-fileversion
1256 The option
1257 .B \-use\-fileversion
1258 allows
1259 .B genisoimage
1260 to use file version numbers from the filesystem.
1261 If the option is not specified,
1262 .B genisoimage
1263 creates a version number of 1 for all files.
1264 File versions are strings in the range
1265 .I ;1
1266 to
1267 .I ;32767
1268 This option is the default on VMS.
1269 .TP
1270 .B \-U
1271 Allows "untranslated" filenames, completely violating the ISO9660 standards
1272 described above. Enables the following flags:
1273 .B \-d \-l \-N \-allow\-leading\-dots \-relaxed\-filenames
1274 .BR "\-allow\-lowercase \-allow\-multidot \-no\-iso\-translate" .
1275 Allows more than one `.' character in the filename, as well as
1276 mixed-case filenames. This is useful on HP-UX, where the built-in
1277 .I cdfs
1278 filesystem does not recognize any extensions. Use with extreme caution.
1279 .TP
1280 .B \-no\-iso\-translate
1281 Do not translate the characters `#' and `~' which are invalid for ISO9660 filenames.
1282 Although invalid, these characters are often used by Microsoft systems.
1283 .br
1284 This violates the ISO9660 standard, but it happens to work on many systems.
1285 Use with caution.
1286 .TP
1287 .BI \-V " volid"
1288 Specifies the volume ID (volume name or label) to be written into the
1289 master block. There is space for 32 characters. Equivalent to
1290 .B VOLI
1291 in the
1292 .I .genisoimagerc
1293 file. The volume ID is used as the mount point by the Solaris volume
1294 manager and as a label assigned to a disc on various other platforms
1295 such as Windows and Apple Mac OS.
1296 .TP
1297 .BI \-volset " ID"
1298 Specifies the volume set ID. There is space for 128 characters.
1299 Equivalent to
1300 .B VOLS
1301 in the
1302 .I .genisoimagerc
1303 file.
1304 .TP
1305 .BI \-volset\-size " #"
1306 Sets the volume set size to #.
1307 The volume set size is the number of CDs that are in a CD volume set.
1308 A volume set is a collection of one or more volumes, on which a set of
1309 files is recorded.
1310 .IP
1311 Volume Sets are not intended to be used to create a set numbered CDs
1312 that are part of e.g. a Operation System installation set of CDs.
1313 Volume Sets are rather used to record a big directory tree that would not
1314 fit on a single volume.
1315 Each volume of a Volume Set contains a description of all the directories
1316 and files that are recorded on the volumes where the sequence numbers
1317 are less than, or equal to, the assigned Volume Set Size of the current
1318 volume.
1319 .IP
1320 .B genisoimage
1321 currently does not support a
1322 .B \-volset\-size
1323 that is larger than 1.
1324 .IP
1325 The option
1326 .B \-volset\-size
1327 must be specified before
1328 .B \-volset\-seqno
1329 on each command line.
1330 .TP
1331 .BI \-volset\-seqno " #"
1332 Sets the volume set sequence number to #.
1333 The volume set sequence number is the index number of the current
1334 CD in a CD set.
1335 The option
1336 .B \-volset\-size
1337 must be specified before
1338 .B \-volset\-seqno
1339 on each command line.
1340 .TP
1341 .B \-v
1342 Verbose execution. If given twice on the command line, extra debug information
1343 will be printed.
1344 .TP
1345 .BI \-x " glob"
1346 Identical to
1347 .B \-m
1348 .IR glob .
1349 .TP
1350 .B \-z
1351 Generate special
1352 .I RRIP
1353 records for transparently compressed files.
1354 This is only of use and interest for hosts that support transparent
1355 decompression, such as Linux 2.4.14 or later. You must specify
1356 .BR \-R " or " \-r
1357 to enable Rock Ridge, and generate compressed files using the
1358 .B mkzftree
1359 utility before running
1360 .BR genisoimage .
1361 Note that transparent compression is a nonstandard Rock Ridge extension.
1362 The resulting disks are only transparently readable if used on Linux.
1363 On other operating systems you will need to call
1364 .B mkzftree
1365 by hand to decompress the files.
1366 .\" ----------------------------------------
1367 .SH "HFS OPTIONS"
1368 .TP
1369 .B \-hfs
1370 Create an ISO9660/HFS hybrid CD. This option should be used in conjunction
1371 with the
1372 .BR \-map ,
1373 .B \-magic
1374 and/or the various
1375 .I double dash
1376 options given below.
1377 .TP
1378 .B \-apple
1379 Create an ISO9660 CD with Apple's extensions. Similar to
1380 .BR \-hfs ,
1381 except that the Apple Extensions to ISO9660 are added instead of
1382 creating an HFS hybrid volume.
1383 Former
1384 .B genisoimage
1385 versions did include Rock Ridge attributes by default if
1386 .B \-apple
1387 was specified. This versions of
1388 .B genisoimage
1389 does not do this anymore. If you like to have Rock Ridge attributes,
1390 you need to specify this separately.
1391 .TP
1392 .BI \-map " mapping_file"
1393 Use the
1394 .I mapping_file
1395 to set the CREATOR and TYPE information for a file based on the
1396 filename's extension. A filename is
1397 mapped only if it is not one of the know Apple/Unix file formats. See the
1398 .B HFS CREATOR/TYPE
1399 section below.
1400 .TP
1401 .BI \-magic " magic_file"
1402 The CREATOR and TYPE information is set by using a file's
1403 .I magic number
1404 (usually the first few bytes of a file). The
1405 .I magic_file
1406 is only used if a file is not one of the known Apple/Unix file formats, or
1407 the filename extension has not been mapped using
1408 .BR \-map .
1409 See the
1410 .B HFS CREATOR/TYPE
1411 section below for more details.
1412 .TP
1413 .BI \-hfs\-creator " creator"
1414 Set the default CREATOR for all files. Must be exactly 4 characters. See the
1415 .B HFS CREATOR/TYPE
1416 section below for more details.
1417 .TP
1418 .BI \-hfs\-type " type"
1419 Set the default TYPE for all files. Must be exactly 4 characters. See the
1420 .B HFS CREATOR/TYPE
1421 section below for more details.
1422 .TP
1423 .B \-probe
1424 Search the contents of files for all the known Apple/Unix file formats.
1425 See the
1426 .B HFS MACINTOSH FILE FORMATS
1427 section below for more about these formats.
1428 However, the only way to check for
1429 .I MacBinary
1430 and
1431 .I AppleSingle
1432 files is to open and read them, so this option may
1433 increase processing time. It is better to use one or more
1434 .I double dash
1435 options given below if the Apple/Unix formats in use are known.
1436 .TP
1437 .B \-no\-desktop
1438 Do not create (empty) Desktop files. New HFS Desktop files will be created
1439 when the CD is used on a Macintosh (and stored in the System Folder).
1440 By default, empty Desktop files are added to the HFS volume.
1441 .TP
1442 .B \-mac\-name
1443 Use the HFS filename as the starting point for the ISO9660, Joliet and
1444 Rock Ridge filenames. See the
1445 .B HFS MACINTOSH FILENAMES
1446 section below for more information.
1447 .TP
1448 .BI \-boot\-hfs\-file " driver_file"
1449 Installs the
1450 .I driver_file
1451 that
1452 .I may
1453 make the CD bootable on a Macintosh. See the
1454 .B HFS BOOT DRIVER
1455 section below. (Alpha).
1456 .TP
1457 .B \-part
1458 Generate an HFS partition table. By default, no partition table is generated,
1459 but some older Macintosh CD-ROM drivers need an HFS partition table on the
1460 CD-ROM to be able to recognize a hybrid CD-ROM.
1461 .TP
1462 .BI \-auto " AutoStart_file"
1463 Make the HFS CD use the QuickTime 2.0 Autostart feature to launch an
1464 application or document. The given filename must be the name of a document or
1465 application located at the top level of the CD. The filename must be less
1466 than 12 characters. (Alpha).
1467 .TP
1468 .BI \-cluster\-size " size"
1469 Set the size in bytes of the cluster or allocation units of PC Exchange
1470 files. Implies
1471 .BR \-\-exchange .
1472 See the
1473 .B HFS MACINTOSH FILE FORMATS
1474 section below.
1475 .TP
1476 .BI \-hide\-hfs " glob"
1477 Hide
1478 .IR glob ,
1479 a shell wildcard pattern, from the HFS volume. The file or directory
1480 will still exist in the ISO9660 and/or Joliet directory.
1481 .I glob
1482 may match any part of the filename. Multiple globs may be excluded.
1483 Example:
1484 .sp
1485 genisoimage \-o rom \-hfs \-hide\-hfs \(aq*.o\(aq \-hide\-hfs foobar
1486 .sp
1487 would exclude all files ending in `.o' or called
1488 .I foobar
1489 from the HFS volume. Note that if you had a directory called
1490 .IR foobar ,
1491 it too (and of course all its descendants) would be excluded. The
1492 .I glob
1493 can also be a path name relative to the source directories given on the
1494 command line. Example:
1495 .sp
1496 genisoimage \-o rom \-hfs \-hide\-hfs src/html src
1497 .sp
1498 would exclude just the file or directory called
1499 .I html
1500 from the
1501 .I src
1502 directory. Any other file or directory called
1503 .I html
1504 in the tree will not be excluded. Should be used with
1505 .B \-hide
1506 and/or
1507 .BR \-hide\-joliet .
1508 In order to match a directory name, make sure the pattern does not
1509 include a trailing `/' character. See
1510 .I README.hide
1511 for more details.
1512 .TP
1513 .BI \-hide\-hfs\-list " file"
1514 Specify a file containing a list of wildcard patterns to be hidden as in
1515 .BR \-hide\-hfs .
1516 .TP
1517 .BI \-hfs\-volid " hfs_volid"
1518 Volume name for the HFS partition. This is the name that is
1519 assigned to the disc on a Macintosh and replaces the
1520 .I volid
1521 used with
1522 .BR \-V .
1523 .TP
1524 .B \-icon\-position
1525 Use the icon position information, if it exists, from the Apple/Unix file.
1526 The icons will appear in the same position as they would on a Macintosh
1527 desktop. Folder location and size on screen, its scroll positions, folder
1528 View (view as Icons, Small Icons, etc.) are also preserved.
1529 .\" This option may become set by default in the future.
1530 (Alpha).
1531 .TP
1532 .BI \-root\-info " file"
1533 Set the location, size on screen, scroll positions, folder View etc. for the
1534 root folder of an HFS volume. See
1535 .I README.rootinfo
1536 for more information. (Alpha)
1537 .TP
1538 .BI \-prep\-boot " file"
1539 PReP boot image file. Up to 4 are allowed. See
1540 .I README.prep_boot
1541 for more information. (Alpha)
1542 .TP
1543 .BI \-chrp\-boot
1544 Add CHRP boot header.
1545 .TP
1546 .BI \-input\-hfs\-charset " charset"
1547 Input charset that defines the characters used in HFS filenames when
1548 used with
1549 .BR \-mac\-name .
1550 The default charset is
1551 .I cp10000
1552 (Mac Roman). See the
1553 .B CHARACTER SETS
1554 and
1555 .B HFS MACINTOSH FILENAMES
1556 sections below for more details.
1557 .TP
1558 .BI \-output\-hfs\-charset " charset"
1559 Output charset that defines the characters that will be used in the HFS
1560 filenames. Defaults to the input charset. See the
1561 .B CHARACTER SETS
1562 section below for more details.
1563 .TP
1564 .B \-hfs\-unlock
1565 By default,
1566 .B genisoimage
1567 will create an HFS volume that is locked.
1568 This option leaves the volume unlocked so that other applications (e.g.
1569 .BR hfsutils )
1570 can modify the volume. See the
1571 .B HFS PROBLEMS/LIMITATIONS
1572 section below for warnings about using this option.
1573 .TP
1574 .BI \-hfs\-bless " folder_name"
1575 "Bless" the given directory (folder). This is usually the
1576 .I System Folder
1577 and is used in creating HFS bootable CDs. The name of the directory must
1578 be the whole path name as
1579 .B genisoimage
1580 sees it. E.g., if the given pathspec is
1581 .I ./cddata
1582 and the required folder is called
1583 .IR "System Folder" ,
1584 the whole path name is
1585 .I \(dq/cddata/System Folder\(dq
1586 (remember to use quotes if the name contains spaces).
1587 .TP
1588 .BI \-hfs\-parms " parameters"
1589 Override certain parameters used to create the HFS filesystem. Unlikely to
1590 be used in normal circumstances. See the
1591 .I libhfs_iso/hybrid.h
1592 source file for details.
1593 .TP
1594 .B \-\-cap
1595 Look for AUFS CAP Macintosh files. Search for CAP Apple/Unix file formats
1596 only. Searching for the other possible Apple/Unix file formats is disabled,
1597 unless other
1598 .I double dash
1599 options are given.
1600 .TP
1601 .B \-\-netatalk
1602 Look for NETATALK Macintosh files
1603 .TP
1604 .B \-\-double
1605 Look for AppleDouble Macintosh files
1606 .TP
1607 .B \-\-ethershare
1608 Look for Helios EtherShare Macintosh files
1609 .TP
1610 .B \-\-ushare
1611 Look for IPT UShare Macintosh files
1612 .TP
1613 .B \-\-exchange
1614 Look for PC Exchange Macintosh files
1615 .TP
1616 .B \-\-sgi
1617 Look for SGI Macintosh files
1618 .TP
1619 .B \-\-xinet
1620 Look for XINET Macintosh files
1621 .TP
1622 .B \-\-macbin
1623 Look for MacBinary Macintosh files
1624 .TP
1625 .B \-\-single
1626 Look for AppleSingle Macintosh files
1627 .TP
1628 .B \-\-dave
1629 Look for Thursby Software Systems DAVE Macintosh files
1630 .TP
1631 .B \-\-sfm
1632 Look for Microsoft's Services for Macintosh files (NT only) (Alpha)
1633 .TP
1634 .B \-\-osx\-double
1635 Look for Mac OS X AppleDouble Macintosh files
1636 .TP
1637 .B \-\-osx\-hfs
1638 Look for Mac OS X HFS Macintosh files
1639 .\" ----------------------------------------
1640 .SH "CHARACTER SETS"
1641 .B genisoimage
1642 processes filenames in a POSIX-compliant way as strings of 8-bit characters.
1643 To represent all codings for all languages, 8-bit characters are not
1644 sufficient. Unicode or ISO-10646
1645 define character codings that need at least 21 bits to represent all
1646 known languages. They may be represented with
1647 .IR UTF-32 ", " UTF-16 " or " UTF-8
1648 coding. UTF-32 uses a plain 32-bit coding but seems to be uncommon.
1649 UTF-16 is used by Microsoft with Win32 with the disadvantage that
1650 16-bit characters are not compliant with the POSIX filesystem
1651 interface.
1652 .PP
1653 Modern Unix operating systems may use UTF-8 coding for filenames.
1654 Each 32-bit character is represented by one or more 8-bit characters.
1655 If a character is coded in
1656 .I ISO-8859-1
1657 (used in Central Europe and North America) is maps 1:1 to a
1658 UTF-32 or UTF-16 coded Unicode character.
1659 If a character is coded in
1660 .I 7-Bit ASCII
1661 (used in USA and other countries with limited character set)
1662 is maps 1:1 to a UTF-32, UTF-16 or UTF-8 coded Unicode character.
1663 Character codes that cannot be represented as a single byte in UTF-8
1664 (if the value is > 0x7F) use escape sequences that map to more than
1665 one 8-bit character.
1666 .PP
1667 If all operating systems used UTF-8,
1668 .B genisoimage
1669 would not need to recode characters in filenames.
1670 Unfortunately, Apple uses completely nonstandard codings and Microsoft
1671 uses a Unicode coding that is not compatible with the POSIX filename
1672 interface.
1673 .PP
1674 For all non-UTF-8-coded operating systems, the actual character
1675 that each byte represents depends on the
1676 .I character set
1677 or
1678 .I codepage
1679 (the name used by Microsoft)
1680 used by the local operating system \(em the characters in a character
1681 set will reflect the region or natural language set by the user.
1682 .PP
1683 Usually character codes 0x00-0x1f are control characters, codes 0x20-0x7f
1684 are the 7-bit ASCII characters and (on PCs and Macs) 0x80-0xff are used
1685 for other characters.
1686 .PP
1687 As there are a lot more than 256 characters/symbols in use, only a small
1688 subset are represented in a character set. Therefore the same character code
1689 may represent a different character in different character sets. So a filename
1690 generated, say in central Europe, may not display the same character
1691 when viewed on a machine in, say eastern Europe.
1692 .PP
1693 To make matters more complicated, different operating systems use
1694 different character sets for the region or language. For example, the
1695 character code for `\('e' (small e with acute accent)
1696 may be character code 0x82 on a PC,
1697 code 0x8e on a Macintosh, code 0xe9 on a Unix system in western Europe,
1698 and code 0x000e9 in Unicode.
1699 .PP
1700 As long as not all operating systems and applications use the same
1701 character set as the basis for filenames, it may be
1702 necessary to specify which character set your filenames use in and which
1703 character set the filenames should appear on the CD.
1704 .PP
1705 There are four options to specify the character sets you want to use:
1706 .TP
1707 .B \-input\-charset
1708 Defines the local character set you are using on your host machine.
1709 Any character set conversions that take place will use this character
1710 set as the starting point. The default input character sets are
1711 .I cp437
1712 on MS-DOS-based systems and
1713 .I iso8859-1
1714 on all other systems. If
1715 .B \-J
1716 is given, the Unicode equivalents of the input character set
1717 will be used in the Joliet directory.
1718 .B \-jcharset
1719 is the same as
1720 .BR "\-input\-charset \-J" .
1721 .TP
1722 .B \-output\-charset
1723 Defines the character set that will be used with for the Rock Ridge names
1724 on the CD. Defaults to the input character set.
1725 .TP
1726 .B \-input\-hfs\-charset
1727 Defines the HFS character set used for HFS filenames decoded from
1728 any of the various Apple/Unix file formats. Only useful when used with
1729 .BR \-mac\-name .
1730 See the
1731 .B HFS MACINTOSH FILENAMES
1732 for more information. Defaults to
1733 .I cp10000
1734 (Mac Roman).
1735 .TP
1736 .B \-output\-hfs\-charset
1737 Defines the HFS character set used to create HFS filenames from the input
1738 character set in use. In most cases this will be from the character set
1739 given with
1740 .BR \-input\-charset .
1741 Defaults to the input HFS character set.
1742 .PP
1743 There are a number of character sets built in to
1744 .BR genisoimage .
1745 To get a listing, use
1746 .BR "\-input\-charset help" .
1747 This list doesn't include the charset derived from the current locale,
1748 if
1749 .B genisoimage
1750 is built with
1751 .I iconv
1752 support.
1753 .PP
1754 Additional character sets can be read from file for any of the character
1755 set options by giving a filename as the argument to the options. The given
1756 file will only be read if its name does not match one of the built-in
1757 character sets.
1758 .PP
1759 The format of the character set files is the same as the mapping files
1760 available from
1761 .IR http://www.unicode.org/Public/MAPPINGS .
1762 This format is:
1763 .IP
1764 Column #1 is the input byte code (in hex as 0xXX)
1765 .br
1766 Column #2 is the Unicode (in hex as 0xXXXX)
1767 .br
1768 The rest of the line is ignored.
1769 .PP
1770 Any blank line, line without two (or more) columns in the above format
1771 or comments lines (starting with the # character) are ignored without any
1772 warnings. Any missing input code is mapped to Unicode character 0x0000.
1773 .PP
1774 Note that, while UTF-8 is supported, other Unicode encodings such as
1775 UCS-2/UTF-16 and UCS-4/UTF-32 are not, as POSIX operating systems
1776 cannot handle them natively.
1777 .PP
1778 A 1:1 character set mapping can be defined by using the keyword
1779 .I default
1780 as the argument to any of the character set options. This is the behaviour
1781 of old versions of
1782 .BR mkisofs .
1783 .PP
1784 The ISO9660 filenames generated from the input filenames are not converted
1785 from the input character set. The ISO9660 character set is a very limited
1786 subset of the ASCII characters, so any conversion would be pointless.
1787 .PP
1788 Any character that
1789 .B genisoimage
1790 cannot convert will be replaced with a `_' character.
1791 .\" ----------------------------------------
1792 .SH "HFS CREATOR/TYPE"
1793 A Macintosh file has two properties associated with it which define
1794 which application created the file, the
1795 .I CREATOR
1796 and what data the file contains, the
1797 .IR TYPE .
1798 Both are (exactly) 4 letter strings. Usually this
1799 allows a Macintosh user to double-click on a file and launch the correct
1800 application etc. The CREATOR and TYPE of a particular file can be found by
1801 using something like ResEdit (or similar) on a Macintosh.
1802 .PP
1803 The CREATOR and TYPE information is stored in all the various Apple/Unix
1804 encoded files.
1805 For other files it is possible to base the CREATOR and TYPE on the
1806 filename's extension using a
1807 .I mapping
1808 file (with
1809 .BR \-map )
1810 and/or using the
1811 .I magic number
1812 (usually a
1813 .I signature
1814 in the first few bytes) of a file (with
1815 .BR \-magic ).
1816 If both these options are given, their order on the command
1817 line is significant. If
1818 .B \-map
1819 is given first, a filename extension match is attempted
1820 before a magic number match. However, if
1821 .B \-magic
1822 is given first, a magic number match is attempted before a
1823 filename extension match.
1824 .PP
1825 If a mapping or magic file is not used, or no match is found, the default
1826 CREATOR and TYPE for all regular files can be set by using entries in the
1827 .I .genisoimagerc
1828 file or using
1829 .B \-hfs\-creator
1830 and/or
1831 .BR \-hfs\-type ,
1832 otherwise the default CREATOR and TYPE are
1833 .IR Unix " and " TEXT .
1834 .PP
1835 The format of the
1836 .I mapping
1837 file is the same
1838 .I afpfile
1839 format as used by
1840 .BR aufs .
1841 This file has five columns for the
1842 .IR extension ,
1843 .IR "file translation" ,
1844 .IR CREATOR ,
1845 .IR TYPE " and"
1846 .IR Comment .
1847 Lines starting with the `#' character are
1848 comment lines and are ignored. An example file would be like:
1849 .PP
1850 .TS
1851 tab (/);
1852 l s s s s
1853 l s s s s
1854 l l l l l .
1855 # Example filename mapping file
1856 #
1857 # EXTN/XLate/CREATOR/TYPE/Comment
1858 \&.tif/Raw/\(aq8BIM\(aq/\(aqTIFF\(aq/\(dqPhotoshop TIFF image\(dq
1859 \&.hqx/Ascii/\(aqBnHq\(aq/\(aqTEXT\(aq/\(dqBinHex file\(dq
1860 \&.doc/Raw/\(aqMSWD\(aq/\(aqWDBN\(aq/\(dqWord file\(dq
1861 \&.mov/Raw/\(aqTVOD\(aq/\(aqMooV\(aq/\(dqQuickTime Movie\(dq
1862 */Ascii/\(aqttxt\(aq/\(aqTEXT\(aq/\(dqText file\(dq
1863 .TE
1864 .PP
1865 Where:
1866 .IP
1867 The first column
1868 .I EXTN
1869 defines the Unix filename extension to be
1870 mapped. The default mapping for any filename extension that doesn't
1871 match is defined with the `*' character.
1872 .IP
1873 The
1874 .I Xlate
1875 column defines the type of text translation between the Unix and
1876 Macintosh file it is ignored by
1877 .BR genisoimage ,
1878 but is kept to be compatible with
1879 .BR aufs (1).
1880 Although
1881 .B genisoimage
1882 does not alter the contents of a file, if a binary file has its TYPE
1883 set as
1884 .IR TEXT ", it " may
1885 be read incorrectly on a Macintosh. Therefore a better choice for the
1886 default TYPE may be
1887 .IR ???? .
1888 .IP
1889 The
1890 .I CREATOR
1891 and
1892 .I TYPE
1893 keywords must be 4 characters long and enclosed in single quotes.
1894 .IP
1895 The comment field is enclosed in double quotes \(em it is ignored by
1896 .BR genisoimage ,
1897 but is kept to be compatible with
1898 .BR aufs .
1899 .PP
1900 The format of the
1901 .I magic
1902 file is almost identical to the
1903 .BR magic (5)
1904 file used by the
1905 .BR file (1)
1906 command.
1907 .PP
1908 This file has four tab-separated columns for the
1909 .IR "byte offset" ,
1910 .IR type ,
1911 .I test
1912 and
1913 .IR message .
1914 Lines starting with the `#' character are
1915 comment lines and are ignored. An example file would be like:
1916 .PP
1917 .TS
1918 tab (/);
1919 l s s s
1920 l s s s
1921 l l l l .
1922 # Example magic file
1923 #
1924 # off/type/test/message
1925 0/string/GIF8/8BIM GIFf GIF image
1926 0/beshort/0xffd8/8BIM JPEG image data
1927 0/string/SIT!/SIT! SIT! StuffIt Archive
1928 0/string/\(rs037\(rs235/LZIV ZIVU standard Unix compress
1929 0/string/\(rs037\(rs213/GNUz ZIVU gzip compressed data
1930 0/string/%!/ASPS TEXT Postscript
1931 0/string/\(rs004%!/ASPS TEXT PC Postscript with a ^D to start
1932 4/string/moov/txtt MooV QuickTime movie file (moov)
1933 4/string/mdat/txtt MooV QuickTime movie file (mdat)
1934 .TE
1935 .PP
1936 The format of the file is described in
1937 .BR magic (5).
1938 The only difference here is that for each entry in the magic file, the
1939 .I message
1940 for the initial offset must be be 4 characters for the CREATOR followed
1941 by 4 characters for the TYPE \(em white space is
1942 optional between them. Any other characters on this line are ignored.
1943 Continuation lines (starting with a `>') are also ignored, i.e., only
1944 the initial offset lines are used.
1945 .PP
1946 Using
1947 .B \-magic
1948 may significantly increase processing time as each file has to opened
1949 and read to find its magic number.
1950 .PP
1951 In summary, for all files, the default CREATOR is
1952 .I Unix
1953 and the default TYPE is
1954 .IR TEXT .
1955 These can be changed by using entries in the
1956 .I .genisoimagerc
1957 file or by using
1958 .B \-hfs\-creator
1959 and/or
1960 .BR \-hfs\-type .
1961 .PP
1962 If the a file is in one of the known Apple/Unix formats (and the format
1963 has been selected), the CREATOR and TYPE are taken from the values
1964 stored in the Apple/Unix file.
1965 .PP
1966 Other files can have their CREATOR and TYPE set from their filename
1967 extension (with
1968 .BR \-map ),
1969 or their magic number (with
1970 .BR \-magic ).
1971 If the default match is used in the
1972 .I mapping
1973 file, these values override the default CREATOR and TYPE.
1974 .PP
1975 A full CREATOR/TYPE database can be found at
1976 .IR http://www.angelfire.com/il/szekely/ .
1977 .\" ----------------------------------------
1978 .SH "HFS MACINTOSH FILE FORMATS"
1979 Macintosh files have two parts called the
1980 .I Data
1981 and
1982 .IR "Resource fork" .
1983 Either may be empty. Unix (and many other OSs) can only
1984 cope with files having one part (or fork). To add to this, Macintosh files
1985 have a number of attributes associated with them \(em probably the most
1986 important are the TYPE and CREATOR. Again, Unix has no concept of these
1987 types of attributes.
1988 .PP
1989 E.g., a Macintosh file may be a JPEG image where the image is stored in the
1990 Data fork and a desktop thumbnail stored in the Resource fork. It is usually
1991 the information in the data fork that is useful across platforms.
1992 .PP
1993 Therefore to store a Macintosh file on a Unix filesystem, a way has to be
1994 found to cope with the two forks and the extra attributes (which are
1995 referred to as the
1996 .IR "Finder info" ).
1997 Unfortunately, it seems that every software package that stores Macintosh
1998 files on Unix has chosen a completely different storage method.
1999 .PP
2000 The Apple/Unix formats that
2001 .B genisoimage
2002 (partially) supports are:
2003 .IP "CAP AUFS format"
2004 Data fork stored in a file. Resource fork in subdirectory
2005 .I .resource
2006 with same filename as data fork. Finder info in subdirectory
2007 .I .finderinfo
2008 with same filename.
2009 .IP "AppleDouble/Netatalk"
2010 Data fork stored in a file. Resource fork stored in a file with
2011 same name prefixed with `%'. Finder info also stored in same
2012 `%' file. Netatalk uses the same format, but the resource
2013 fork/Finder info stored in subdirectory
2014 .I .AppleDouble
2015 with same filename as data fork.
2016 .IP AppleSingle
2017 Data structures similar to above, except both forks and Finder
2018 info are stored in one file.
2019 .IP "Helios EtherShare"
2020 Data fork stored in a file. Resource fork and Finder info together in
2021 subdirectory
2022 .I .rsrc
2023 with same filename as data fork.
2024 .IP "IPT UShare"
2025 Like the EtherShare format, but the Finder info
2026 is stored slightly differently.
2027 .IP MacBinary
2028 Both forks and Finder info stored in one file.
2029 .IP "Apple PC Exchange"
2030 Used by Macintoshes to store Apple files on DOS (FAT) disks.
2031 Data fork stored in a file. Resource fork in subdirectory
2032 .IR resource.frk " (or " RESOURCE.FRK ).
2033 Finder info as one record in file
2034 .IR finder.dat " (or " FINDER.DAT ).
2035 Separate
2036 .I finder.dat
2037 for each data fork directory.
2038 .IP
2039 Note:
2040 .B genisoimage
2041 needs to know the native FAT cluster size of the disk that the PC Exchange
2042 files are on (or have been copied from). This size is given by
2043 .BR \-cluster\-size .
2044 The cluster or allocation size can be found by using the DOS utility
2045 .BR chkdsk .
2046 .IP
2047 May not work with PC Exchange v2.2 or higher files (available with MacOS 8.1).
2048 DOS media containing PC Exchange files should be mounted as type
2049 .I msdos
2050 (not
2051 .IR vfat )
2052 when using Linux.
2053 .IP SGI/XINET
2054 Used by SGI machines when they mount HFS disks. Data fork stored
2055 in a file. Resource fork in subdirectory
2056 .I .HSResource
2057 with same filename. Finder info as one record in file
2058 .IR .HSancillary ". Separate " .HSancillary
2059 for each data fork directory.
2060 .IP "Thursby Software Systems DAVE"
2061 Allows Macintoshes to store Apple files on SMB servers.
2062 Data fork stored in a file. Resource fork in subdirectory
2063 .IR resource.frk .
2064 Uses the AppleDouble format to store resource fork.
2065 .IP "Services for Macintosh"
2066 Format of files stored by NT Servers on NTFS filesystems. Data fork is
2067 stored as
2068 .IR filename .
2069 Resource fork stored as a NTFS stream called
2070 .IR filename:AFP_Resource .
2071 The Finder info is stored as a NTFS stream called
2072 .IR filename:Afp_AfpInfo .
2073 NTFS streams are normally invisible to the user.
2074 .IP
2075 Warning:
2076 .B genisoimage
2077 only partially supports the SFM format. If an HFS file
2078 or folder stored on the NT server contains an illegal
2079 NT character in its name, NT converts these characters to
2080 .I Private Use Unicode
2081 characters. The characters are: \(dq * / < > ? \(rs | and a space or
2082 period if it is the last character of the filename, character codes 0x01
2083 to 0x1f (control characters) and Apple's apple logo.
2084 .IP
2085 Unfortunately, these private Unicode characters are not readable by the
2086 .B genisoimage
2087 NT executable. Therefore any file or directory
2088 name containing these characters will be ignored \(em including the contents of
2089 any such directory.
2090 .IP "Mac OS X AppleDouble"
2091 When HFS/HFS+ files are copied or saved by Mac OS X on to a non-HFS
2092 filesystem (e.g. UFS, NFS etc.), the files are stored in AppleDouble format.
2093 Data fork stored in a file. Resource fork stored in a file with
2094 same name prefixed with `._'. Finder info also stored in same `._' file.
2095 .IP "Mac OS X HFS (Alpha)"
2096 Not really an Apple/Unix encoding, but actual HFS/HFS+ files on a Mac\ OS\ X
2097 system. Data fork stored in a file. Resource fork stored in a pseudo file
2098 with the same name with the suffix
2099 .IR /rsrc .
2100 The Finder info is only available via a Mac OS X library call.
2101 .IP
2102 See also
2103 .IR README.macosx .
2104 .IP
2105 Only works when used on Mac OS X.
2106 .IP
2107 If a file is found with a zero
2108 length resource fork and empty finderinfo, it is assumed not to have
2109 any Apple/Unix encoding \(em therefore a TYPE and CREATOR can be set using
2110 other methods.
2111 .PP
2112 .B genisoimage
2113 will attempt to set the CREATOR, TYPE, date and possibly other flags from
2114 the finder info. Additionally, if it exists, the Macintosh filename is set
2115 from the finder info, otherwise the Macintosh name is based on the Unix
2116 filename \(em see the
2117 .B HFS MACINTOSH FILENAMES
2118 section below.
2119 .PP
2120 When using
2121 .BR \-apple ,
2122 the TYPE and CREATOR are stored in the optional System Use or
2123 .I SUSP
2124 field
2125 in the ISO9660 Directory Record \(em in much the same way as the Rock Ridge
2126 attributes are. In fact to make life easy, the Apple extensions are added
2127 at the beginning of the existing Rock Ridge attributes (i.e., to get the Apple
2128 extensions you get the Rock Ridge extensions as well).
2129 .PP
2130 The Apple extensions require the resource fork to be stored as an ISO9660
2131 .I associated
2132 file. This is just like any normal file stored in the ISO9660 filesystem
2133 except that the associated file flag is set in the Directory Record (bit
2134 2). This file has the same name as the data fork (the file seen by
2135 non-Apple machines). Associated files are normally ignored by other OSs
2136 .PP
2137 When using
2138 .BR \-hfs ,
2139 the TYPE and CREATOR plus other finder info, are stored in a separate
2140 HFS directory, not visible on the ISO9660 volume. The HFS directory references
2141 the same data and resource fork files described above.
2142 .PP
2143 In most cases, it is better to use
2144 .B \-hfs
2145 instead of
2146 .BR \-apple ,
2147 as the latter imposes the limited ISO9660 characters allowed in
2148 filenames. However, the Apple extensions do give the advantage that the
2149 files are packed on the disk more efficiently and it may be possible to fit
2150 more files on a CD.
2151 .\" ----------------------------------------
2152 .SH "HFS MACINTOSH FILENAMES"
2153 Where possible, the HFS filename that is stored with an Apple/Unix file
2154 is used for the HFS part of the CD. However, not all the Apple/Unix
2155 encodings store the HFS filename with the finderinfo. In these cases,
2156 the Unix filename is used \(em with escaped special characters. Special
2157 characters include `/' and characters with codes over 127.
2158 .PP
2159 AUFS escapes these characters by using `:' followed by the character code
2160 as two hex digits. Netatalk and EtherShare have a similar scheme, but uses
2161 `%' instead of a `:'.
2162 .PP
2163 If
2164 .B genisoimage
2165 cannot find an HFS filename, it uses the Unix name, with any
2166 .IR %xx " or " :xx
2167 characters
2168 .RI ( xx
2169 are two hex digits) converted to a single character code. If
2170 .I xx
2171 are not hex digits ([0-9a-fA-F]), they are
2172 left alone \(em although any remaining `:' is converted to `%', as `:'
2173 is the HFS directory separator. Care must be taken, as an ordinary Unix
2174 file with
2175 .I %xx
2176 or
2177 .I :xx
2178 will also be converted. e.g.
2179 .PP
2180 .TS
2181 l l
2182 l s
2183 l l
2184 l s
2185 l l .
2186 This:2fFile converted to This/File
2187
2188 This:File converted to This%File
2189
2190 This:t7File converted to This%t7File
2191 .TE
2192 .PP
2193 Although HFS filenames appear to support uppercase and lowercase letters,
2194 the filesystem is case-insensitive, i.e., the filenames
2195 .IR aBc " and " AbC
2196 are the same. If a file is found in a directory with the same HFS name,
2197 .B genisoimage
2198 will attempt to make a unique name by adding `_' characters
2199 to one of the filenames.
2200 .PP
2201 If an HFS filename exists for a file,
2202 .B genisoimage
2203 can use this name as the starting point for the ISO9660, Joliet and
2204 Rock Ridge filenames using
2205 .BR \-mac\-name .
2206 Normal Unix files without an HFS name will still use their Unix name.
2207 e.g.
2208 .PP
2209 If a MacBinary (or PC Exchange) file is stored as
2210 .I someimage.gif.bin
2211 on the Unix filesystem, but contains a HFS file called
2212 .IR someimage.gif ,
2213 this is the name that would appear on the HFS part of the CD. However, as
2214 .B genisoimage
2215 uses the Unix name as the starting point for the other names,
2216 the ISO9660 name generated will probably be
2217 .I SOMEIMAG.BIN
2218 and the Joliet/Rock Ridge would be
2219 .IR someimage.gif.bin .
2220 This option will use
2221 the HFS filename as the starting point and the ISO9660 name will probably be
2222 .I SOMEIMAG.GIF
2223 and the Joliet/Rock Ridge would be
2224 .IR someimage.gif .
2225 .PP
2226 .B \-mac\-name
2227 will not currently work with
2228 .B \-T
2229 \(em the Unix name will be used in the
2230 .I TRANS.TBL
2231 file, not the Macintosh name.
2232 .PP
2233 The character set used to convert any HFS filename to a Joliet/Rock Ridge
2234 filename defaults to
2235 .I cp10000
2236 (Mac Roman).
2237 The character set used can be specified using
2238 .BR \-input\-hfs\-charset .
2239 Other built-in HFS character sets are:
2240 .I cp10006
2241 (MacGreek),
2242 .I cp10007
2243 (MacCyrillic),
2244 .I cp10029
2245 (MacLatin2),
2246 .I cp10079
2247 (MacIcelandandic) and
2248 .I cp10081
2249 (MacTurkish).
2250 .PP
2251 Note: the character codes used by HFS filenames taken from the various
2252 Apple/Unix formats will not be converted as they are assumed to be in the
2253 correct Apple character set. Only the Joliet/Rock Ridge names derived from
2254 the HFS filenames will be converted.
2255 .PP
2256 The existing
2257 .B genisoimage
2258 code will filter out any illegal characters for the ISO9660 and Joliet
2259 filenames, but as
2260 .B genisoimage
2261 expects to be dealing directly with Unix names, it leaves the Rock
2262 Ridge names as is. But as `/' is a legal HFS filename character,
2263 .B \-mac\-name
2264 converts `/' to a `_' in Rock Ridge filenames.
2265 .PP
2266 If the Apple extensions are used, only the ISO9660 filenames will
2267 appear on the Macintosh. However, as the Macintosh ISO9660 drivers can use
2268 .I Level 2
2269 filenames, you can use options like
2270 .B \-allow\-multidot
2271 without problems on
2272 a Macintosh \(em still take care over the names, for example
2273 .I this.file.name
2274 will be converted to
2275 .I THIS.FILE
2276 i.e. only have one `.', also filename
2277 .I abcdefgh
2278 will be seen as
2279 .I ABCDEFGH
2280 but
2281 .I abcdefghi
2282 will be seen as
2283 .I ABCDEFGHI.
2284 i.e. with a `.' at the end \(em don't know if this is a Macintosh
2285 problem or a
2286 .BR genisoimage / mkhybrid
2287 problem. All filenames will be in uppercase
2288 when viewed on a Macintosh. Of course, DOS/Win3.X machines will not be able
2289 to see Level 2 filenames...
2290 .\" ----------------------------------------
2291 .SH "HFS CUSTOM VOLUME/FOLDER ICONS"
2292 To give a HFS CD a custom icon, make sure the root (top level) folder includes
2293 a standard Macintosh volume icon file. To give a volume a custom icon on
2294 a Macintosh, an icon has to be pasted over the volume's icon in the "Get Info"
2295 box of the volume. This creates an invisible file called
2296 .I Icon\(rsr
2297 (`\(rsr' is the carriage return character) in the root folder.
2298 .P
2299 A custom folder icon is very similar \(em an invisible file called
2300 .I Icon\(rsr
2301 exists in the folder itself.
2302 .P
2303 Probably the easiest way to create a custom icon that
2304 .B genisoimage
2305 can use is to format a blank HFS floppy disk on a Mac and paste an icon
2306 to its "Get Info" box. If using Linux with the HFS module installed,
2307 mount the floppy:
2308 .IP
2309 mount \-t hfs /dev/fd0 /mnt/floppy
2310 .PP
2311 The floppy will be mounted as a CAP filesystem by default. Then run
2312 .B genisoimage
2313 using something like:
2314 .IP
2315 genisoimage \-\-cap \-o output source_dir /mnt/floppy
2316 .PP
2317 If you are not using Linux, you can use
2318 .B hfsutils
2319 to copy the icon file from the floppy. However, care has to be taken,
2320 as the icon file contains a control character. For example:
2321 .IP
2322 hmount /dev/fd0
2323 .br
2324 hdir \-a
2325 .br
2326 hcopy \-m Icon^V^M icon_dir/icon
2327 .PP
2328 Where `^V^M' is control-V followed by control-M. Then run
2329 .B genisoimage
2330 by using something like:
2331 .IP
2332 genisoimage \-\-macbin \-o output source_dir icon_dir
2333 .PP
2334 The procedure for creating/using custom folder icons is very similar \(em paste
2335 an icon to folder's "Get Info" box and transfer the resulting
2336 .I Icon\(rsr
2337 file to the relevant directory in the
2338 .B genisoimage
2339 source tree.
2340 .PP
2341 You may want to hide the icon files from the ISO9660 and Joliet trees.
2342 .PP
2343 To give a custom icon to a Joliet CD, follow the instructions found at
2344 .IR http://www.cdrfaq.org/faq03.html#S3-21-1 .
2345 .\" ----------------------------------------
2346 .SH "HFS BOOT DRIVER"
2347 It
2348 .I may
2349 be possible to make the hybrid CD bootable on a Macintosh.
2350 .PP
2351 A bootable HFS CD requires an Apple CD-ROM (or compatible) driver, a bootable
2352 HFS partition and the necessary System, Finder, etc. files.
2353 .PP
2354 A driver can be obtained from any other Macintosh bootable CD-ROM using the
2355 .B apple_driver
2356 utility. This file can then be used with
2357 .BR \-boot\-hfs\-file .
2358 .PP
2359 The HFS partition (i.e. the hybrid disk in our case) must contain a
2360 suitable System Folder, again from another CD-ROM or disk.
2361 .PP
2362 For a partition to be bootable, it must have its
2363 .I boot block
2364 set. The boot
2365 block is in the first two blocks of a partition. For a non-bootable partition
2366 the boot block is full of zeros. Normally, when a System file is copied to
2367 partition on a Macintosh disk, the boot block is filled with a number of
2368 required settings \(em unfortunately I don't know the full spec for the boot
2369 block, so I'm guessing that the following will work.
2370 .PP
2371 Therefore, the utility
2372 .B apple_driver
2373 also extracts the boot block from the
2374 first HFS partition it finds on the given CD-ROM and this is used for the
2375 HFS partition created by
2376 .BR genisoimage .
2377 .PP
2378 .I Please note:
2379 By using a driver from an Apple CD and copying Apple software to your CD,
2380 you become liable to obey Apple Computer, Inc. Software License Agreements.
2381 .\" ----------------------------------------
2382 .SH "EL TORITO BOOT INFORMATION TABLE"
2383 When
2384 .B \-boot\-info\-table
2385 is given,
2386 .B genisoimage
2387 will modify the boot file specified by
2388 .B \-b
2389 by inserting a 56-byte
2390 .I boot information table
2391 at offset 8 in
2392 the file. This modification is done in the source filesystem, so make
2393 sure you use a copy if this file is not easily recreated! This file
2394 contains pointers which may not be easily or reliably obtained at boot
2395 time.
2396 .PP
2397 The format of this table is as follows; all integers are in
2398 section 7.3.1 ("little endian") format.
2399 .sp
2400 .RS +.2i
2401 .ta 1.0i 2.5i 3.5i
2402 .nf
2403 Offset Name Size Meaning
2404 8 bi_pvd 4 bytes LBA of primary volume descriptor
2405 12 bi_file 4 bytes LBA of boot file
2406 16 bi_length 4 bytes Boot file length in bytes
2407 20 bi_csum 4 bytes 32-bit checksum
2408 24 bi_reserved 40 bytes Reserved
2409 .fi
2410 .RE
2411 .IP
2412 The 32-bit checksum is the sum of all the 32-bit words in the boot
2413 file starting at byte offset 64. All linear block addresses (LBAs)
2414 are given in CD sectors (normally 2048 bytes).
2415 .\" ----------------------------------------
2416 .SH "HPPA NOTES"
2417 To make a bootable CD for HPPA, at the very least a boot loader file
2418 .RB ( \-hppa\-bootloader ),
2419 a kernel image file (32-bit, 64-bit, or both, depending on hardware)
2420 and a boot command line
2421 .RB ( \-hppa\-cmdline )
2422 must be specified. Some systems can boot either a 32- or a 64-bit
2423 kernel, and the firmware will choose one if both are present.
2424 Optionally, a ramdisk can be used for the root filesystem using
2425 .BR \-hppa\-cmdline .
2426 .\" ----------------------------------------
2427 .SH "JIGDO NOTES"
2428 Jigdo is a tool to help in the distribution of large files like CD and
2429 DVD images; see
2430 .I http://atterer.org/jigdo/
2431 for more details. Debian CDs and DVD ISO
2432 images are published on the web in jigdo format to allow end users to download
2433 them more efficiently.
2434 .PP
2435 To create jigdo and template files alongside the ISO image from
2436 .BR genisoimage ,
2437 you must first generate a list of the files that will be
2438 used, in the following format:
2439 .sp
2440 .RS +.2i
2441 .ta 2.0i 2.0i 5.0i
2442 .nf
2443 MD5sum File size Path
2444 32 chars 12 chars to end of line
2445 .fi
2446 .RE
2447 .IP
2448 .PP
2449 The MD5sum must be written in standard hexadecimal notation, the
2450 file size must list the size of the file in bytes, and the path
2451 must list the absolute path to the file. For example:
2452 .sp
2453 .nf
2454 00006dcd58ff0756c36d2efae21be376 14736 /mirror/debian/file1
2455 000635c69b254a1be8badcec3a8d05c1 211822 /mirror/debian/file2
2456 00083436a3899a09633fc1026ef1e66e 22762 /mirror/debian/file3
2457 .fi
2458 .PP
2459 Once you have this file, call
2460 .B genisoimage
2461 with all of your normal command-line parameters. Specify the output
2462 filenames for the jigdo and template files using
2463 .BR \-jigdo\-jigdo " and " \-jigdo\-template ,
2464 and pass in the location of your MD5 list with
2465 .BR \-md5\-list .
2466 .PP
2467 If there are files that you do NOT want to be added into the jigdo
2468 file (e.g. if they are likely to change often), specify them using
2469 \-jigdo\-exclude. If you want to verify some of the files as they are
2470 written into the image, specify them using \-jigdo\-force\-md5. If any
2471 files don't match,
2472 .B genisoimage
2473 will then abort. Both of these options take
2474 regular expressions as input. It is possible to restrict the set of
2475 files that will be used further based on size \(em use the
2476 \-jigdo\-min\-file\-size option.
2477 .PP
2478 Finally, the jigdo code needs to know how to map the files it is given
2479 onto a mirror-style configuration. Specify how to map paths using
2480 .BR \-jigdo\-map .
2481 Using
2482 .I Debian=/mirror/debian
2483 will cause all
2484 paths starting with
2485 .I /mirror/debian
2486 to be mapped to
2487 .I Debian:<file>
2488 in the output jigdo file.
2489 .\" ----------------------------------------
2490 .SH EXAMPLES
2491 .PP
2492 To create a vanilla ISO9660 filesystem image in the file
2493 .IR cd.iso ,
2494 where the directory
2495 .I cd_dir
2496 will become the root directory of the CD, call:
2497 .IP
2498 % genisoimage \-o cd.iso cd_dir
2499 .PP
2500 To create a CD with Rock Ridge extensions of
2501 the source directory
2502 .IR cd_dir :
2503 .IP
2504 % genisoimage \-o cd.iso \-R cd_dir
2505 .PP
2506 To create a CD with Rock Ridge extensions of
2507 the source directory
2508 .I cd_dir
2509 where all files have at least read permission and all files
2510 are owned by
2511 .IR root ,
2512 call:
2513 .IP
2514 % genisoimage \-o cd.iso \-r cd_dir
2515 .PP
2516 To write a tar archive directly to a CD that will later contain a simple
2517 ISO9660 filesystem with the tar archive call:
2518 .IP
2519 % tar cf \- . | genisoimage \-stream\-media\-size 333000 | \(rs
2520 .br
2521 wodim dev=b,t,l \-dao tsize=333000s \-
2522 .PP
2523 To create a HFS hybrid CD with the Joliet and Rock Ridge extensions of
2524 the source directory
2525 .IR cd_dir :
2526 .IP
2527 % genisoimage \-o cd.iso \-R \-J \-hfs cd_dir
2528 .PP
2529 To create a HFS hybrid CD from the source directory
2530 .I cd_dir
2531 that contains
2532 Netatalk Apple/Unix files:
2533 .IP
2534 % genisoimage \-o cd.iso \-\-netatalk cd_dir
2535 .PP
2536 To create a HFS hybrid CD from the source directory
2537 .IR cd_dir ,
2538 giving all files
2539 CREATOR and TYPES based on just their filename extensions listed in the file
2540 "mapping".:
2541 .IP
2542 % genisoimage \-o cd.iso \-map mapping cd_dir
2543 .PP
2544 To create a CD with the Apple Extensions to ISO9660, from the source
2545 directories
2546 .I cd_dir
2547 and
2548 .IR another_dir .
2549 Files in all the known Apple/Unix format
2550 are decoded and any other files are given CREATOR and TYPE based on their
2551 magic number given in the file
2552 .IR magic :
2553 .IP
2554 % genisoimage \-o cd.iso \-apple \-magic magic \-probe \(rs
2555 .br
2556 cd_dir another_dir
2557 .PP
2558 The following example puts different files on the CD that all have
2559 the name README, but have different contents when seen as a
2560 ISO9660/Rock Ridge, Joliet or HFS CD.
2561 .PP
2562 Current directory contains:
2563 .IP
2564 % ls \-F
2565 .br
2566 README.hfs README.joliet README.Unix cd_dir/
2567 .PP
2568 The following command puts the contents of the directory
2569 .I cd_dir
2570 on the
2571 CD along with the three README files \(em but only one will be seen from
2572 each of the three filesystems:
2573 .IP
2574 % genisoimage \-o cd.iso \-hfs \-J \-r \-graft\-points \(rs
2575 .br
2576 \-hide README.hfs \-hide README.joliet \(rs
2577 .br
2578 \-hide\-joliet README.hfs \-hide\-joliet README.Unix \(rs
2579 .br
2580 \-hide\-hfs README.joliet \-hide\-hfs README.Unix \(rs
2581 .br
2582 README=README.hfs README=README.joliet \(rs
2583 .br
2584 README=README.Unix cd_dir
2585 .PP
2586 i.e. the file README.hfs will be seen as README on the HFS CD and the
2587 other two README files will be hidden. Similarly for the Joliet and
2588 ISO9660/Rock Ridge CD.
2589 .PP
2590 There are probably all sorts of strange results possible with
2591 combinations of the hide options ...
2592 .\" ----------------------------------------
2593 .SH NOTES
2594 .PP
2595 .B genisoimage
2596 may safely be installed suid root. This may be needed to allow
2597 .B genisoimage
2598 to read the previous session when creating a multisession image.
2599 .PP
2600 If
2601 .B genisoimage
2602 is creating a filesystem image with Rock Ridge attributes and the
2603 directory nesting level of the source directory tree is too much
2604 for ISO9660,
2605 .B genisoimage
2606 will do deep directory relocation.
2607 This results in a directory called
2608 .B RR_MOVED
2609 in the root directory of the CD. You cannot avoid this directory.
2610 .PP
2611 Many boot code options for different platforms are mutualy exclusive because
2612 the boot blocks cannot coexist, ie. different platforms share the same data
2613 locations in the image. See
2614 http://lists.debian.org/debian-cd/2006/12/msg00109.html for details.
2615 .\" ----------------------------------------
2616 .SH BUGS
2617 .PP
2618 Any files that have hard links to files not in the tree being copied to the
2619 ISO9660 filesystem will have an incorrect file reference count.
2620 .PP
2621 Does not check for SUSP record(s) in `.' entry of the
2622 root directory to verify the existence of Rock Ridge
2623 enhancements.
2624 This problem is present when reading old sessions while
2625 adding data in multisession mode.
2626 .PP
2627 Does not properly read relocated directories in multisession
2628 mode when adding data.
2629 Any relocated deep directory is lost if the new session does not
2630 include the deep directory.
2631 .\" Repeat by: create first session with deep directory relocation
2632 .\" then add new session with a single dir that differs from the
2633 .\" old deep path.
2634 .PP
2635 Does not re-use
2636 .I RR_MOVED
2637 when doing multisession from
2638 .IR TRANS.TBL .
2639 .PP
2640 Does not create whole_name entry for
2641 .I RR_MOVED
2642 in multisession mode.
2643 .PP
2644 There may be other bugs. Please, report them to the maintainers.
2645 .\" ----------------------------------------
2646 .SH "HFS PROBLEMS/LIMITATIONS"
2647 I have had to make several assumptions on how I expect the modified
2648 libhfs routines to work, however there may be situations that either
2649 I haven't thought of, or come across when these assumptions fail.
2650 Therefore I can't guarantee that
2651 .B genisoimage
2652 will work as expected
2653 (although I haven't had a major problem yet). Most of the HFS features work
2654 fine, but some are not fully tested. These are marked as
2655 .I Alpha
2656 above.
2657 .PP
2658 Although HFS filenames appear to support uppercase and lowercase letters,
2659 the filesystem is case-insensitive, i.e., the filenames
2660 .IR aBc " and "AbC
2661 are the same. If a file is found in a directory with the same HFS name,
2662 .B genisoimage
2663 will attempt to make a unique name by adding `_' characters
2664 to one of the filenames.
2665 .PP
2666 HFS file/directory names that share the first 31 characters have
2667 `_N' (a decimal number) substituted for the last few characters
2668 to generate unique names.
2669 .PP
2670 Care must be taken when "grafting" Apple/Unix files or directories (see
2671 above for the method and syntax involved). It is not possible to use a
2672 new name for an Apple/Unix encoded file/directory. e.g. If a Apple/Unix
2673 encoded file called
2674 .I oldname
2675 is to added to the CD, you cannot use the command line:
2676 .IP
2677 genisoimage \-o output.raw \-hfs \-graft\-points newname=oldname cd_dir
2678 .PP
2679 .B genisoimage
2680 will be unable to decode
2681 .IR oldname .
2682 However, you can graft
2683 Apple/Unix encoded files or directories as long as you do not attempt to
2684 give them new names as above.
2685 .PP
2686 When creating an HFS volume with the multisession options,
2687 .B \-M
2688 and
2689 .BR \-C ,
2690 only files in the last session will be in the HFS volume. i.e.
2691 .B genisoimage
2692 cannot
2693 .I add
2694 existing files from previous sessions to the HFS volume.
2695 .PP
2696 However, if each session is created with
2697 .BR \-part ,
2698 each session will appear as
2699 separate volumes when mounted on a Mac. In this case, it is worth using
2700 .BR \-V " or " \-hfs\-volid
2701 to give each session a unique volume name,
2702 otherwise each "volume" will appear on the Desktop with the same name.
2703 .PP
2704 Symbolic links (as with all other non-regular files) are not added to
2705 the HFS directory.
2706 .PP
2707 Hybrid volumes may be larger than pure ISO9660 volumes
2708 containing the same data. In some cases (e.g. DVD sized volumes) the
2709 difference can be significant. As an HFS volume gets bigger, so does the
2710 allocation block size (the smallest amount of space a file can occupy).
2711 For a 650MB CD, the allocation block is 10kB, for a 4.7GB DVD it will be
2712 about 70kB.
2713 .PP
2714 The maximum number of files in an HFS volume is about 65500 \(em although
2715 the real limit will be somewhat less than this.
2716 .PP
2717 The resulting hybrid volume can be accessed on a Unix machine by using
2718 the hfsutils routines. However, no changes can be made to the volume as it
2719 is set as
2720 .B locked.
2721 The option
2722 .B \-hfs\-unlock
2723 will create an output image that is unlocked \(em however no changes should be
2724 made to the contents of the volume (unless you really know what you are
2725 doing) as it's not a "real" HFS volume.
2726 .PP
2727 .B \-mac\-name
2728 will not currently work with
2729 .B \-T
2730 \(em the Unix name will be used in the
2731 .I TRANS.TBL
2732 file, not the Macintosh name.
2733 .PP
2734 Although
2735 .B genisoimage
2736 does not alter the contents of a file, if a binary file has its TYPE
2737 set as
2738 .IR TEXT ", it " may
2739 be read incorrectly on a Macintosh. Therefore a better choice for the
2740 default TYPE may be
2741 .IR ???? .
2742 .PP
2743 .B \-mac\-boot\-file
2744 may not work at all...
2745 .PP
2746 May not work with PC Exchange v2.2 or higher files (available with MacOS 8.1).
2747 DOS media containing PC Exchange files should be mounted as type
2748 .B msdos
2749 (not
2750 .BR vfat )
2751 when using Linux.
2752 .PP
2753 The SFM format is only partially supported \(em see
2754 .B HFS MACINTOSH FILE FORMATS
2755 section above.
2756 .PP
2757 It is not possible to use
2758 .BR \-sparc\-boot " or " \-generic\-boot " with"
2759 .BR \-boot\-hfs\-file " or " \-prep\-boot .
2760 .PP
2761 .B genisoimage
2762 should be able to create HFS hybrid images over 4Gb, although this has not
2763 been fully tested.
2764 .\" ----------------------------------------
2765 .SH "SEE ALSO"
2766 .BR genisoimagerc (5),
2767 .BR wodim (1),
2768 .BR mkzftree (8),
2769 .BR magic (5).
2770 .\" ----------------------------------------
2771 .SH AUTHORS
2772 .B genisoimage
2773 is derived from
2774 .B mkisofs
2775 from the
2776 .B cdrtools 2.01.01a08
2777 package from May 2006 (with few updates extracted from cdrtools 2.01.01a24 from
2778 March 2007) from .IR http://cdrecord.berlios.de/ ,
2779 but is now part of the
2780 .B cdrkit
2781 suite, maintained by Joerg Jaspert, Eduard Bloch, Steve McIntyre, Peter
2782 Samuelson, Christian Fromme, Ben Hutchings, and other contributors.
2783 The maintainers can be contacted at
2784 .IR [email protected] ,
2785 or see the
2786 .B cdrkit
2787 project web site at
2788 .IR http://www.cdrkit.org/ .
2789 .PP
2790 Eric Youngdale wrote the first versions (1993\(en1998) of
2791 .BR mkisofs .
2792 J\(:org Schilling wrote the SCSI transport library and its
2793 interface, and has maintained
2794 .B mkisofs
2795 since 1999. James Pearson wrote the HFS hybrid code, using
2796 .I libhfs
2797 by Robert Leslie. Pearson, Schilling, Jungshik Shin and Jaakko
2798 Heinonen contributed to the character set conversion code. The
2799 .B cdrkit
2800 maintainers have maintained
2801 .B genisoimage
2802 since 2006.
2803 .PP
2804 .nf
2805 Copyright 1993-1998 by Yggdrasil Computing, Inc.
2806 Copyright 1996-1997 by Robert Leslie
2807 Copyright 1997-2001 by James Pearson
2808 Copyright 1999-2006 by J\(:org Schilling
2809 Copyright 2007 by J\(:org Schilling (originating few updates)
2810 Copyright 2002-2003 by Jungshik Shin
2811 Copyright 2003 by Jaakko Heinonen
2812 Copyright 2006 by the Cdrkit maintainers
2813 .fi
2814 .PP
2815 If you want to take part in the development of
2816 .BR genisoimage ,
2817 you may join the
2818 .B cdrkit
2819 developer mailing list by following the instructions on
2820 .IR http://alioth.debian.org/mail/?group_id=31006 .
2821 The email address of the list is
2822 .IR [email protected] .
2823 This is also the address for user support questions. Note that
2824 .BR cdrkit " and " cdrtools
2825 are not affiliated.
2826 .PP
2827 .\" ----------------------------------------
2828 .SH ACKNOWLEDGEMENTS
2829 UNIX is a registered trademark of The Open Group in the US and other countries.