Debian Codegraph @

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