Debian Codegraph @

upstream/opensuse-tumbleweed/man8/mkisofs.8

raw
1 '\" t
2 .\" To print, first run through tbl
3 .\" -*- nroff -*-
4 .\" @(#)mkisofs.8 1.172 20/09/04 Copyright 1997-2020 J. Schilling
5 .\"
6 .\" This program is free software; you can redistribute it and/or modify
7 .\" it under the terms of the GNU General Public License version 2
8 .\" as published by the Free Software Foundation.
9 .\"
10 .\" This program is distributed in the hope that it will be useful,
11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 .\" GNU General Public License for more details.
14 .\"
15 .\" You should have received a copy of the GNU General Public License along with
16 .\" this program; see the file COPYING. If not, write to the Free Software
17 .\" Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 .\"
19 .\"
20 .if t .ds a \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'a
21 .if t .ds o \v'-0.55m'\h'0.00n'\z.\h'0.45n'\z.\v'0.55m'\h'-0.45n'o
22 .if t .ds u \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'u
23 .if t .ds A \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'A
24 .if t .ds O \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'O
25 .if t .ds U \v'-0.77m'\h'0.30n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.75n'U
26 .if t .ds s \\(*b
27 .if t .ds S SS
28 .if n .ds a ae
29 .if n .ds o oe
30 .if n .ds u ue
31 .if n .ds s sz
32 .TH MKISOFS 8 "2022/09/09" "Version 3.02"
33 .SH NAME
34 mkisofs \- create an hybrid ISO-9660/JOLIET/HFS/UDF filesystem-image with optional Rock Ridge attributes.
35 .SH SYNOPSIS
36 .B mkisofs
37 [
38 .I options
39 ]
40 [
41 .B \-o
42 .I filename
43 ]
44 .I pathspec [pathspec ...]
45 .br
46 .B mkisofs
47 [
48 .I options
49 ]
50 [
51 .B \-o
52 .I filename
53 ]
54 .B \-find
55 .I [find expression]
56 .br
57 .SH DESCRIPTION
58 .B mkisofs
59 is effectively a pre-mastering program to generate an ISO-9660/JOLIET/HFS/UDF hybrid
60 filesystem.
61 .PP
62 ISO-9660/JOLIET/UDF filesystems are limited to a maximum size of 8\ TB.
63 The maximum size of a single file is 8\ TB (single files in UDF are currently
64 limited to aprox. 200\ GB).
65 If you like to have files
66 larger than 2 \GB, you need to specify
67 .B \-iso\-level 3
68 or above.
69 If a HFS hybrid is created, the maximum
70 file size for files in the HFS hybrid is 2\ GB in any case.
71 .SS "Hybrid filesystem support"
72 .PP
73 .B mkisofs
74 is capable of generating the
75 .B "System Use Sharing Protocol records (SUSP)"
76 specified
77 by the
78 .B "Rock Ridge Interchange Protocol."
79 This is used to further describe the
80 files in the ISO-9660 filesystem to a UNIX host, and provides information such
81 as longer filenames, uid/gid, posix permissions, symbolic links, hard links,
82 block and character devices.
83 .PP
84 If Joliet, HFS or UDF hybrid command line options are specified,
85 .B mkisofs
86 will create additional separate filesystem meta data for Joliet, HFS or UDF.
87 The file content in this case refers to the same data blocks on the media.
88 It
89 will generate a pure ISO-9660 filesystem unless the Joliet, HFS or UDF hybrid command
90 line options are given.
91 .PP
92 .B mkisofs
93 can generate a
94 .I true
95 (or
96 .IR shared )
97 HFS hybrid filesystem. The same files are seen as HFS files when
98 accessed from a Macintosh and as ISO-9660 files when accessed from other
99 machines. HFS stands for
100 .I Hierarchical File System
101 and is the native file system used on Macintosh computers up to Mac\ OS\ 9.
102 .PP
103 As an alternative,
104 .B mkisofs
105 can generate the
106 .I "Apple Extensions to ISO-9660"
107 or
108 .I UDF
109 for each file. These extensions provide each file with CREATOR, TYPE and
110 certain Finder Flags when accessed from a Macintosh. See the
111 .B HFS MACINTOSH FILE FORMATS
112 section below.
113 .SS "Functional description"
114 .PP
115 .B mkisofs
116 takes a snapshot of a given directory tree, and generates a
117 binary image which will correspond to an ISO-9660 or Joliet/HFS/UDF filesystem when
118 written to a block device.
119 .PP
120 Each file written to the ISO-9660 filesystem must have a filename in the 8.3
121 format (8 characters, period, 3 characters, all upper case), even if Rock Ridge
122 attributes are in use. This filename is used on systems that are not able to make use of
123 the Rock Ridge extensions (such as MS-DOS), and each filename in each directory
124 must be different from the other filenames in the same directory.
125 .B mkisofs
126 generally tries to form correct names by forcing the UNIX filename to upper
127 case and truncating as required, but often times this yields unsatisfactory
128 results when there are cases where the
129 truncated names are not all unique.
130 .B mkisofs
131 assigns weightings to each filename, and if two names that are otherwise the
132 same are found the name with the lower priority is renamed to have a 3 digit
133 number as an extension (where the number is guaranteed to be unique). An
134 example of this would be the files foo.bar and
135 foo.bar.~1~ - the file foo.bar.~1~ would be written as FOO000.BAR;1 and the file
136 foo.bar would be written as FOO.BAR;1
137 .PP
138 When used with various HFS or UDF options,
139 .B mkisofs
140 will attempt to recognise files stored in a number of Apple/Unix file formats
141 and will copy the data and resource forks as well as any
142 relevant finder information. See the
143 .B HFS MACINTOSH FILE FORMATS
144 section below for more about formats
145 .B mkisofs
146 supports.
147 .PP
148 Note that
149 .B mkisofs
150 is not designed to communicate with writers for optical media directly.
151 Most writers
152 have proprietary command sets which vary from one manufacturer to
153 another, and you need a specialized tool like
154 .B cdrecord
155 to actually burn the disk.
156 .PP
157 The
158 .B cdrecord
159 utility is a utility capable of burning an actual disc. The latest version
160 of
161 .B cdrecord
162 is available from
163 .B https://codeberg.org/schilytools/schilytools/releases
164 \(.
165 .PP
166 Also you should know that most CD writers are very particular about timing.
167 Once you start to burn a disc, you cannot let their buffer empty before you
168 are done, or you will end up with a corrupt disc. Thus it is critical
169 that you be able to maintain an uninterrupted data stream to the writer
170 for the entire time that the disc is being written.
171 .SS "Dealing with path names"
172 .PP
173 .B pathspec
174 is the path of the directory tree to be copied into the ISO-9660 filesystem.
175 Multiple paths can be specified, and
176 .B
177 mkisofs
178 will merge the files found in all of the specified path components to form the cdrom
179 image.
180 .PP
181 If the option
182 .B \-graft\-points
183 has been specified,
184 it is possible to graft the paths at points other than the root
185 directory, and it is possible to graft files or directories onto the
186 cdrom image with names different than what they have in the source filesystem. This is
187 easiest to illustrate with a couple of examples. Let's start by assuming that a local
188 file ../old.lis exists, and you wish to include it in the cdrom image.
189
190
191 foo/bar/=../old.lis
192
193 will include the file old.lis in the cdrom image at /foo/bar/old.lis, while
194
195 foo/bar/xxx=../old.lis
196
197 will include the file old.lis in the cdrom image at /foo/bar/xxx. The
198 same sort of syntax can be used with directories as well.
199 .B mkisofs
200 will create any directories required such that the graft
201 points exist on the cdrom image - the directories do not need to
202 appear in one of the paths. By default, any directories that are created on
203 the fly like this will have permissions 0555 and appear to be owned by the
204 person running mkisofs. If you wish other permissions or owners of
205 the intermediate directories, see
206 .BR \-uid ,
207 .BR \-gid ,
208 .BR \-dir\-mode ,
209 .BR \-file\-mode " and"
210 .BR \-new\-dir\-mode .
211 .PP
212 .B mkisofs
213 will also run on Win9\fIx\fP/NT\fIx\fP machines when compiled with Cygnus' cygwin
214 (available from http://sourceware.cygnus.com/cygwin/). Therefore most
215 references in this man page to
216 .I Unix
217 also apply to
218 .I Win32
219 or
220 .IR Win64 .
221
222 .SH OPTIONS
223 .TP
224 .BI \-abstract " FILE"
225 Specifies the abstract file name in the primary volume descriptor.
226 There is space on the disc for 37 characters of information.
227 The related Joliet entry is limited to 18 characters.
228 This parameter can also be set in the file
229 .B \&.m\&kisofsrc
230 with ABST=filename.
231 If specified in both places, the command line version is used.
232 .sp
233 It is up to the user of
234 .B mkisofs
235 to include a file with the appropriate name in the created filesystem tree.
236 .TP
237 .BI \-A " application_id"
238 .TP
239 .BI \-appid " application_id"
240 Specifies a text string that will be written into the volume header.
241 This should describe the application that will be on the disc. There
242 is space on the disc for 128 characters of information.
243 The related Joliet entry is limited to 64 characters.
244 This parameter can
245 also be set in the file
246 .B \&.m\&kisofsrc
247 with APPI=id.
248 If specified in both places, the command line version is used.
249 .TP
250 .B \-allow\-leading\-dots
251 .TP
252 .B \-ldots
253 Allow ISO-9660 filenames to begin with a period. Usually, a leading dot is
254 replaced with an underscore in order to maintain MS-DOS compatibility.
255 .br
256 This violates the ISO-9660 standard, but it happens to work on many systems.
257 Use with caution.
258 .TP
259 .B \-allow\-lowercase
260 This options allows lower case characters to appear in ISO-9660 filenames.
261 .br
262 This violates the ISO-9660 standard, but it happens to work on some systems.
263 Use with caution.
264 .TP
265 .B \-no\-allow\-lowercase
266 This resets the effect of
267 .B \-allow\-lowercase
268 and even works when
269 .BR \-U ,
270 .B \-untranslated\-filenames
271 or
272 .B \-iso\-level 4
273 have been used to allow lowercase filenames.
274 .TP
275 .B \-allow\-multidot
276 This options allows more than one dot to appear in ISO-9660 filenames.
277 A leading dot is not affected by this option, it
278 may be allowed separately using the
279 .B \-allow\-leading\-dots
280 option.
281 .br
282 This violates the ISO-9660 standard, but it happens to work on many systems.
283 Use with caution.
284 .TP
285 .BI \-biblio " FILE"
286 Specifies the bibliographic file name in the primary volume descriptor.
287 There is space on the disc for 37 characters of information.
288 The related Joliet entry is limited to 18 characters.
289 This parameter can also be set in the file
290 .B \&.m\&kisofsrc
291 with BIBLO=filename.
292 If specified in both places, the command line version is used.
293 .sp
294 It is up to the user of
295 .B mkisofs
296 to include a file with the appropriate name in the created filesystem tree.
297 .TP
298 .B \-cache\-inodes
299 Cache inode and device numbers to find hard links to files.
300 If
301 .B mkisofs
302 finds a hard link (a file with multiple names), then the file will only
303 appear once on the CD. This helps to save space on the CD.
304 The option
305 .B \-cache\-inodes
306 is default on UNIX like operating systems.
307 Be careful when using this option on a filesystem without unique
308 inode numbers as it may result in files containing the wrong content on CD.
309 .sp
310 See the option
311 .B \-duplicates\-once
312 for a method that works on filesystems without unique inode numbers.
313 .sp
314 If inodes are not cached,
315 .B mkisofs
316 will revert to the old Rrip Version-1.10 (see
317 .BR \-rrip110 )
318 and
319 .B mkisofs
320 will not be able to create
321 .B "correct inode numbers"
322 for zero sized files.
323 .TP
324 .B \-no\-cache\-inodes
325 Do not cache inode and device numbers.
326 This option is needed whenever a filesystem does not have unique
327 inode numbers. It is the default on old
328 .B Cygwin
329 versions.
330 As the Microsoft operating system that runs below
331 .B Cygwin
332 uses 64 bit inode numbers for NTFS, it does not have unique inode numbers
333 in the 32 bit range.
334 Old Cygwin versions create fake 32-bit inode numbers from a hash algorithm
335 and thus create non-unique numbers.
336 If
337 .B mkisofs
338 would cache inodes on old Cygwin versions, it would believe that some files are
339 identical although they are not. The result in this case are files
340 that contain the wrong content if a significant amount of different
341 files (> ~5000) is in inside the tree that is to be archived.
342 This does not happen when the
343 .B \-no\-cache\-inodes
344 is used, but the disadvantage is that
345 .B mkisofs
346 cannot detect hardlinks anymore and the resulting CD image may be larger
347 than expected.
348 .sp
349 If inodes are not cached,
350 .B mkisofs
351 will revert to the old Rrip Version-1.10 (see
352 .BR \-rrip110 )
353 and
354 .B mkisofs
355 will not be able to create
356 .B "correct inode numbers"
357 for zero sized files.
358 .TP
359 .BI \-creation\-date " date-spec"
360 Set the
361 .B creation date
362 in the primary volume descriptor (PVD) to a value different from the current
363 time.
364 This allows e.g. to set up an intentional date in order to be able to create
365 reproducible ISO-9660 filesystem images.
366 .sp
367 See
368 .B \-modification\-date
369 for a description of the
370 .I date-spec
371 format and
372 .B \-reproducible\-date
373 for a simple way to create reproducible filesystem images.
374 .TP
375 .B \-duplicates\-once
376 Tells
377 .B mkisofs
378 to use a message digest checksum to identify identical files as
379 apparently hard linked files.
380 This allows
381 .B mkisofs
382 to archive inode numbers and hard links even when it is run on
383 non-POSIX platforms like
384 .BR DOS .
385 .TP
386 .BI \-effective\-date " date-spec"
387 Set the
388 .B effective date
389 in the primary volume descriptor (PVD) to a value different from the current
390 time.
391 This allows e.g. to set up an intentional date in order to be able to create
392 reproducible ISO-9660 filesystem images.
393 .sp
394 See
395 .B \-modification\-date
396 for a description of the
397 .I date-spec
398 format and
399 .B \-reproducible\-date
400 for a simple way to create reproducible filesystem images.
401 .TP
402 .BI \-b " eltorito_boot_image"
403 .TP
404 .BI \-eltorito\-boot " eltorito_boot_image"
405 Specifies the path and filename of the boot image to be used when making
406 an "El Torito" bootable CD. The pathname must be relative to the source
407 path and inside the source tree specified to
408 .B mkisofs.
409 This option is required to make an "El Torito" bootable CD.
410 The boot image must be exactly the size of either a 1200, 1440, or a 2880
411 kB floppy, and
412 .B mkisofs
413 will use this size when creating the output ISO-9660
414 filesystem. It is assumed that the first 512 byte sector should be read
415 from the boot image (it is essentially emulating a normal floppy drive).
416 This will work, for example, if the boot image is a boot floppy.
417 .sp
418 If the boot image is not an image of a floppy, you need to add one of the
419 options:
420 .BR \-hard\-disk\-boot " or " \-no\-emul\-boot .
421 If the system should not boot off the emulated disk, use
422 .BR \-no\-boot .
423 .sp
424 More than one boot entry may be specified, see
425 .B \-eltorito\-platform
426 and
427 .B \-eltorito\-alt\-boot
428 on how to specify more boot entries.
429 The first boot entry is the
430 .BR "default boot entry" .
431 Additional boot entries are members for a multi boot configuration.
432 .sp
433 If the
434 .B \-sort
435 option has not been specified, the boot images are sorted
436 with low priority (+2) to the beginning of the medium.
437 If you don't like this, you need to specify a sort weight of 0 for the boot images.
438 .TP
439 .B \-eltorito\-alt\-boot
440 Start with a new set of "El Torito" boot parameters.
441 This allows one to have more than one El Torito boot entry on a CD.
442 A maximum of 63 El Torito boot entries may be put on a single CD.
443 .sp
444 The
445 .B \-eltorito\-alt\-boot
446 option starts a new boot entry with the same
447 .I platform id
448 but no new boot section except when it appears
449 past the first boot entry which is the default boot entry.
450 .TP
451 .BI \-eltorito\-platform " id"
452 Set the "El Torito" platform id for a boot record or a section of boot records.
453 The.
454 .I id
455 parameter may be either:
456 .RS
457 .TP
458 .B x86
459 This is the default
460 .I platform id
461 value and specifies entries for the PC platform.
462 If no
463 .B \-eltorito\-platform
464 option appears before the first
465 .B \-eltorito\-boot
466 option, the default boot entry becomes an entry for the x86 PC platform.
467 .TP
468 .B PPC
469 Boot entries for the Power PC platform.
470 .TP
471 .B Mac
472 Boot entries for the Apple Mac platform.
473 .TP
474 .B efi
475 Boot entries for EFI based PCs.
476 .TP
477 .B #
478 A numeric value specifying any platform id.
479 .LP
480 If the option
481 .B \-eltorito\-platform
482 appears before the first
483 .B \-eltorito\-boot
484 option, it sets the
485 .I platform id
486 for the default boot entry.
487 .LP
488 If the option
489 .B \-eltorito\-platform
490 appears after an
491 .B \-eltorito\-boot
492 option and sets the
493 .I platform id
494 to a value different from the previous value,
495 it starts a new set of boot entries.
496 .LP
497 The second boot entry and any new
498 .I platform id
499 creates a new section header and reduces the number of boot
500 entries per CD by one.
501
502 .RE
503 .TP
504 .BI errctl= " name"
505 .TP
506 .BI errctl= " error control spec"
507 Add the content from file
508 .I name
509 to the error control definitions or add
510 .I error control spec
511 to the error control definitions.
512 More than one error control file and more than one
513 .I error control spec
514 as well as a mixture of both forms is possible.
515 .sp
516 The reason for using error control is to make
517 .B mkisofs
518 quiet about error conditions that are known to be irrelevant on the quality
519 of the created filesystem or to tell
520 .B mkisofs
521 to abort on certain error conditions instead of trying to continue
522 with the filesystem.
523 .sp
524 .ne 6
525 A typical reason to use error control is to
526 suppress warnings about growing log files while doing a backup on a
527 live file system.
528 Another typical reason to use error control is to tell
529 .B mkisofs
530 to abort if e.g. a file could not be archived instead of continuing
531 to archive other files from a list.
532 .sp
533 The error control file contains a set of lines, each starting with a list
534 of error conditions to be ignored followed by white space followed by a
535 file name pattern (see
536 .BR match (1)
537 or
538 .BR patmatch (3)
539 for more information).
540 The
541 .I error control spec
542 uses the same syntax as a single line from the error control file.
543 If the file name pattern needs to start with white space, use a backslash
544 to escape the start of the file name. It is not possible to have new line
545 characters in the file name pattern.
546 Whenever an error situation is encountered,
547 .B mkisofs
548 checks the lines in the error control file starting from the top.
549 If the current error condition is listed on a line in the error control file,
550 then
551 .B mkisofs
552 checks whether the pattern on the rest of the line matches the current file name.
553 If this is the case,
554 .B mkisofs
555 uses the current error control specification to
556 control the current error condition.
557 .sp
558 The list of error conditions to be handled may use one or more (in this case
559 separated by a '|' character) identifiers from the list below:
560 .RS
561 .TP 12
562 .B ABORT
563 If this meta condition is included in an error condition,
564 .B mkisofs
565 aborts (exits) as soon as possible after this error condition has been
566 seen instead of making
567 .B mkisofs
568 quiet about the condition.
569 This error condition flag may only be used together with at another
570 error condition or a list of error conditions
571 (separated by a '|' character).
572 .TP 12
573 .B WARN
574 If this meta condition is included in an error condition,
575 .B mkisofs
576 prints the warning about the error condition but the error condition
577 does not affect the exit code of
578 .B mkisofs
579 and the error statistics (which is printed to the end) does not
580 include the related errors.
581 This error condition flag may only be used together with at another
582 error condition or a list of error conditions
583 (separated by a '|' character).
584 The
585 .B WARN
586 meta condition has a lower precedence than
587 .BR ABORT .
588 .TP 12
589 .B ALL
590 This is a shortcut for all error conditions below.
591 .TP 12
592 .B STAT
593 Suppress warnings that
594 .B mkisofs
595 could not
596 .BR stat (2)
597 a file.
598 .TP
599 .B GETACL
600 Suppress warnings about files on which
601 .B mkisofs
602 had problems to retrieve the ACL information.
603 .TP
604 .B OPEN
605 Suppress warnings about files that could not be opened.
606 .TP
607 .B READ
608 Suppress warnings read errors on files.
609 .TP
610 .B WRITE
611 Suppress warnings write errors on files.
612 .TP
613 .B READLINK
614 Suppress warnings
615 .BR readlink (2)
616 errors on symbolic links.
617 .TP
618 .B GROW
619 Suppress warnings about files that did grow while they have been
620 archived.
621 .TP
622 .B SHRINK
623 Suppress warnings about files that did shrink while they have been
624 archived.
625 .TP
626 .B MISSLINK
627 Suppress warnings about files for which
628 .B mkisofs
629 was unable to archive all hard links.
630 .TP
631 .B NAMETOOLONG
632 Suppress warnings about files that could not be archived because the name of
633 the file is too long for the archive format.
634 .TP
635 .B FILETOOBIG
636 Suppress warnings about files that could not be archived because the size of
637 the file is too big for the archive format.
638 .TP
639 .B SPECIALFILE
640 Suppress warnings about files that could not be archived because the file type
641 is not supported by the archive format.
642 .TP
643 .B GETXATTR
644 Suppress warnings about files on that
645 .B mkisofs
646 could not retrieve the extended file attribute information.
647 .TP
648 .B SETTIME
649 Suppress warnings about files on that
650 .B mkisofs
651 could not set the time information during extraction.
652 .TP
653 .B SETMODE
654 Suppress warnings about files on that
655 .B mkisofs
656 could not set the access modes during extraction.
657 .TP
658 .B SECURITY
659 Suppress warnings about files that
660 have been skipped on extraction because they have been considered to be a
661 security risk.
662 This currently applies to all files that have a '/../' sequence inside
663 when
664 .B \-..
665 has not been specified.
666 .TP
667 .B LSECURITY
668 Suppress warnings about links that
669 have been skipped on extraction because they have been considered to be a
670 security risk.
671 This currently applies to all link names that start with '/' or
672 have a '/../' sequence inside when
673 .B \-secure\-links
674 has been specified.
675 In this case,
676 .B mkisofs
677 tries to match the link name against the pattern in the error control file.
678 .TP
679 .B SAMEFILE
680 Suppress warnings about links that
681 have been skipped on extraction because source and target of the link
682 are pointing to the same file.
683 If
684 .B mkisofs
685 would not skip these files, it would end up with removing the file completely.
686 In this case,
687 .B mkisofs
688 tries to match the link name against the pattern in the error control file.
689 .TP
690 .B BADACL
691 Suppress warnings access control list conversion problems.
692 .TP
693 .B SETACL
694 Suppress warnings about files on that
695 .B mkisofs
696 could not set the ACL information during extraction.
697 .TP
698 .B SETXATTR
699 Suppress warnings about files on that
700 .B mkisofs
701 could not set the extended file attribute information during extraction.
702 .RE
703 .sp
704 If a specific error condition is ignored, then the error condition is not
705 only handled in a silent way but also excluded from the error statistics
706 that are printed at the end of the
707 .B mkisofs
708 run.
709 .sp
710 Be very careful when using error control as you may ignore any error condition.
711 If you ignore the wrong error conditions, you may not be able to see real
712 problems anymore.
713 .sp
714 Note that currently only the tags
715 .BR OPEN ,
716 .BR READ ,
717 .BR GROW ,
718 .BR SHRINK ,
719 are checked from
720 .BR mkisofs .
721 .TP
722 .BI \-expiration\-date " date-spec"
723 Set the
724 .B expiration date
725 in the primary volume descriptor (PVD) to a value different from a zeroed out
726 time.
727 This allows e.g. to set up an intentional date in order to be able to create
728 reproducible ISO-9660 filesystem images.
729 .sp
730 See
731 .B \-modification\-date
732 for a description of the
733 .I date-spec
734 format and
735 .B \-reproducible\-date
736 for a simple way to create reproducible filesystem images.
737 .TP
738 .BI \-B " img_sun4,img_sun4c,img_sun4m,img_sun4d,img_sun4e"
739 .TP
740 .BI \-sparc\-boot " img_sun4,img_sun4c,img_sun4m,img_sun4d,img_sun4e"
741 Specifies a comma separated list of boot images that are needed to make
742 a bootable CD for sparc systems.
743 Partition 0 is used for the ISO-9660 image, the first image file is mapped
744 to partition 1.
745 There may be empty fields in the comma separated list.
746 The maximum number of possible partitions is 8 so it is impossible to specify
747 more than 7 partition images.
748 This option is required to make a bootable CD for Sun sparc systems.
749 If the
750 .B \-B
751 or
752 .B \-sparc\-boot
753 option has been specified, the first sector of the resulting image will
754 contain a Sun disk label. This disk label specifies slice 0 for the
755 ISO-9660 image and slice 1 .\|.\|. slice 7 for the boot images that
756 have been specified with this option. Byte offset 512 .\|.\|. 8191
757 within each of the additional boot images must contain a primary boot
758 that works for the appropriate sparc architecture. The rest of each
759 of the images usually contains an ufs filesystem that is used primary
760 kernel boot stage.
761 .sp
762 The implemented boot method is the boot method found with SunOS 4.x and SunOS 5.x.
763 However, it does not depend on SunOS internals but only on properties of
764 the Open Boot prom. For this reason, it should be usable for any OS
765 that boots off a sparc system.
766 .sp
767 For more information also see the
768 .B NOTES
769 section below.
770 .sp
771 If the special filename
772 .B "..."
773 is used, the actual and all following boot partitions are mapped to the
774 previous partition. If
775 .B mkisofs
776 is called with
777 .BI "\-G " image " \-B " ...
778 all boot partitions are mapped to the partition that contains the ISO-9660
779 filesystem image and the generic boot image that is located in the first
780 16 sectors of the disk is used for all architectures.
781 .TP
782 .BI \-G " generic_boot_image"
783 Specifies the path and filename of the generic boot image to be used when making
784 a generic bootable CD.
785 The
786 .B generic_boot_image
787 will be placed on the first 16 sectors of the CD. The first 16 sectors
788 are the sectors that are located before the ISO-9660 primary volume descriptor.
789 If this option is used together with the
790 .B \-sparc\-boot
791 option, the Sun disk label will overlay the first 512 bytes of the generic
792 boot image.
793 .TP
794 .BI \-hard\-disk\-boot
795 Specifies that the boot image used to create "El Torito" bootable CDs is
796 a hard disk image. The hard disk image must begin with a master boot
797 record that contains a single partition.
798 .TP
799 .BI \-ignore\-error
800 Ignore errors.
801 .B mkisofs
802 by default aborts on several errors, such as read errors. With this option in effect,
803 .B mkisofs
804 tries to continue.
805 Use with care.
806 .TP
807 .BI \-no\-emul\-boot
808 Specifies that the boot image used to create "El Torito" bootable CDs is
809 a 'no emulation' image. The system will load and execute this image without
810 performing any disk emulation.
811 .TP
812 .BI \-no\-boot
813 Specifies that the created "El Torito" CD should be marked as not bootable. The
814 system will provide an emulated drive for the image, but will boot off
815 a standard boot device.
816 .TP
817 .BI \-boot\-load\-seg " segment_address"
818 Specifies the load segment address of the boot image for no-emulation
819 "El Torito" CDs.
820 .TP
821 .BI \-boot\-load\-size " load_sectors"
822 Specifies the number of "virtual" (512-byte) sectors to load in
823 no-emulation mode. The default is to load the entire boot file. Some
824 BIOSes may have problems if this is not a multiple of 4.
825 .TP
826 .BI \-boot\-info\-table
827 Specifies that a 56-byte table with information of the CD-ROM layout
828 will be patched in at offset 8 in the boot file. If this option is
829 given, the boot file is modified in the source filesystem, so make
830 sure to make a copy if this file cannot be easily regenerated! See
831 the
832 .B "EL TORITO BOOT INFO TABLE"
833 section for a description of this table.
834 .TP
835 .BI \-C " last_sess_start,next_sess_start"
836 .TP
837 .BI \-cdrecord\-params " last_sess_start,next_sess_start"
838 This option is needed when
839 .B mkisofs
840 is used to create a CDextra or the image of a second session or a
841 higher level session for a multi session disk.
842 The option
843 .B \-C
844 takes a pair of two numbers separated by a comma. The first number is the
845 sector number of the first sector in the last session of the disk
846 that should be appended to.
847 The second number is the starting sector number of the new session.
848 The expected pair of numbers may be retrieved by calling
849 .B "cdrecord \-msinfo ..."
850 If the
851 .B \-C
852 option is used in conjunction with the
853 .B \-M
854 option,
855 .B mkisofs
856 will create a filesystem image that is intended to be a continuation
857 of the previous session.
858 If the
859 .B \-C
860 option is used without the
861 .B \-M
862 option,
863 .B mkisofs
864 will create a filesystem image that is intended to be used for a second
865 session on a CDextra. This is a multi session CD that holds audio data
866 in the first session and a ISO-9660 filesystem in the second session.
867 .TP
868 .BI \-c " boot_catalog"
869 .TP
870 .BI \-eltorito\-catalog " boot_catalog"
871 Specifies the path and filename of the boot catalog to be used when making
872 an "El Torito" bootable CD. The pathname must be relative to the source
873 path specified to
874 .B mkisofs.
875 This option is required to make a bootable CD.
876 This file will be inserted into the output tree and not created
877 in the source filesystem, so be
878 sure the specified filename does not conflict with an existing file, as
879 it will be excluded. Usually a name like "boot.catalog" is
880 chosen.
881 .sp
882 If the
883 .B \-sort
884 option has not been specified, the boot catalog sorted
885 with low priority (+1) to the beginning of the medium.
886 If you don't like this, you need to specify a sort weight of 0 for the boot catalog.
887 .TP
888 .B \-check\-oldnames
889 Check all filenames imported from old session for compliance with
890 actual
891 .B mkisofs
892 ISO-9660 file naming rules.
893 It his option is not present, only names with a length > 31 are checked
894 as these files are a hard violation of the ISO-9660 standard.
895 .TP
896 .BI \-check\-session " FILE"
897 Check all old sessions for compliance with
898 actual
899 .B mkisofs
900 ISO-9660 file naming rules.
901 This is a high level option that is a combination of the options:
902 .BI \-M " FILE " "\-C 0,0 \-check\-oldnames"
903 For the parameter
904 .I FILE
905 see description of
906 .B \-M
907 option.
908 .TP
909 .BI \-copyright " FILE"
910 Specifies the Copyright file name in the primary volume descriptor.
911 There is space on the disc for 37 characters of information.
912 The related Joliet entry is limited to 18 characters.
913 This parameter can also be set in the file
914 .B \&.m\&kisofsrc
915 with COPY=filename.
916 If specified in both places, the command line version is used.
917 .sp
918 It is up to the user of
919 .B mkisofs
920 to include a file with the appropriate name in the created filesystem tree.
921 .TP
922 .B \-d
923 .TP
924 .B \-omit\-period
925 Omit trailing period from files that do not have a period.
926 .br
927 This violates the ISO-9660 standard, but it happens to work on many systems.
928 Use with caution.
929 .TP
930 .B \-D
931 .TP
932 .B \-disable\-deep\-relocation
933 Do not use
934 .B Rock Ridge
935 deep directory relocation, and instead just pack directories in the
936 way they are in the master directory tree.
937 .sp
938 This option was needed with old
939 .B mkisofs
940 versions to avoid a visible directory
941 .BR rr_moved .
942 Since August 2006,
943 .B mkisofs
944 correctly hides the
945 .B rr_moved
946 directory from the
947 .B Rock Ridge
948 filesystem.
949 .sp
950 If ISO-9660/Amd 1:2013 has not been selected,
951 this violates the ISO-9660 standard, but it happens to work on many systems.
952 Use with caution.
953 .TP
954 .B \-data\-change\-warn
955 If the size of a file changes while the file is being archived, treat this
956 condition as a warning only that does not cause
957 .B mkisofs
958 to abort.
959 A warning message is still written if the condition is not otherwise
960 ignored by another rule from an
961 .B errctl=
962 option.
963 The
964 .B \-data\-change\-warn
965 option works as if the last error control option was
966 .sp
967 \fBerrctl=\fP\fI"WARN|GROW|SHRINK *"\fP
968 .sp
969 .TP
970 .B \-debug
971 Increment debug value by one.
972 .TP
973 .BI \-dir\-mode " mode"
974 Overrides the mode of directories used to create the image to
975 .IR mode .
976 See
977 .B \-new\-dir\-mode
978 on how to specify a different
979 .I mode
980 that is used for directories that do not exist
981 in the tree specified by the source-path.
982 Specifying the
983 .B \-dir\-mode
984 option automatically enables Rock Ridge extensions.
985 .br
986 .ne 4
987 .TP
988 .B \-dvd\-audio
989 Generate DVD-Audio compliant UDF file system. This is done by sorting the
990 order of the content of the appropriate files.
991 .\" Audio is currently not sorted
992 .\" and by adding padding between the files if needed.
993 Sorting only works if the DVD-Audio filenames include upper case
994 characters only.
995 .sp
996 Note that in order to get a DVD-Audio compliant filesystem image, you need
997 to prepare a DVD-Audio compliant directory tree. This means you need to
998 have a directory AUDIO_TS (all caps) in the root directory of the resulting DVD
999 and you should have a directory VIDEO_TS. The directory AUDIO_TS needs to
1000 include all needed files (file names must be all caps) for a compliant DVD-Audio
1001 filesystem.
1002 .TP
1003 .B \-dvd\-hybrid
1004 Equivalent to selecting both -dvd-audio and -dvd-video
1005 .TP
1006 .B \-dvd\-video
1007 Generate DVD-Video compliant UDF file system. This is done by sorting the
1008 order of the content of the appropriate files and by adding padding
1009 between the files if needed.
1010 Sorting only works if the DVD-Video filenames include upper case
1011 characters only.
1012 .sp
1013 Note that in order to get a DVD-Video compliant filesystem image, you need
1014 to prepare a DVD-Video compliant directory tree. This means you need to
1015 have a directory VIDEO_TS (all caps) in the root directory of the resulting DVD
1016 and you should have a directory AUDIO_TS. The directory VIDEO_TS needs to
1017 include all needed files (file names must be all caps) for a compliant DVD-Video
1018 filesystem.
1019 .TP
1020 .B \-f
1021 .TP
1022 .B \-follow\-links
1023 Follow all symbolic links when generating the filesystem. When this option is not
1024 in use, symbolic links will be entered using Rock Ridge if enabled, otherwise
1025 the file will be ignored.
1026 .sp
1027 See also
1028 .B \-posix\-L
1029 option.
1030 .TP
1031 .BI \-file\-mode " mode"
1032 Overrides the mode of regular files used to create the image to
1033 .IR mode .
1034 Specifying this option automatically enables Rock Ridge extensions.
1035 .TP
1036 .B \-find
1037 This option acts a separator.
1038 If it is used, all
1039 .B mkisofs
1040 options must be to the left of the
1041 .B \-find
1042 option. To the right of the
1043 .B \-find
1044 option,
1045 .B mkisofs
1046 accepts the
1047 .B find
1048 command line syntax only.
1049 .sp
1050 The
1051 .B find
1052 expression acts as a filter between the source of file names and the
1053 consumer, which is archiving engine.
1054 If the
1055 .B find
1056 expression evaluated as TRUE, then the related file is selected for
1057 processing, otherwise it is omited.
1058 .sp
1059 In order to make the evaluation of the
1060 .B find
1061 expression more convenient,
1062 .B mkisofs
1063 implements additional
1064 .B "find primaries"
1065 that have side effects on the file meta data.
1066 .B Mkisofs
1067 implements the following additional
1068 .B find
1069 primaries:
1070 .RS
1071 .TP
1072 .B \-help
1073 Lists the available
1074 .BR find (1)
1075 syntax.
1076 .br
1077 .ne 5
1078 .TP
1079 .BI \-chatime " timespec"
1080 The primary always evaluates as true;
1081 it modifies the
1082 .B time of last access
1083 of a file in
1084 .BR "struct stat" .
1085 See
1086 .BR sfind (1)
1087 for a description of
1088 .IR timespec .
1089 .br
1090 .ne 5
1091 .TP
1092 .BI \-chctime " timespec"
1093 The primary always evaluates as true;
1094 it modifies the
1095 .B time of last status change
1096 of a file in
1097 .BR "struct stat" .
1098 See
1099 .BR sfind (1)
1100 for a description of
1101 .IR timespec .
1102 .br
1103 .ne 5
1104 .TP
1105 .BI \-chmtime " timespec"
1106 The primary always evaluates as true;
1107 it modifies the
1108 .B time of last modification
1109 of a file in
1110 .BR "struct stat" .
1111 See
1112 .BR sfind (1)
1113 for a description of
1114 .IR timespec .
1115 .TP
1116 .BI \-chgrp " gname"
1117 The primary always evaluates as true;
1118 it sets the group of the file to
1119 .IR gname .
1120 .TP
1121 .BI \-chmod " mode"
1122 The primary always evaluates as true;
1123 it sets the permissions of the file to
1124 .IR mode .
1125 Octal and symbolic permissions are accepted for
1126 .I mode
1127 as with
1128 .BR chmod (1).
1129 .TP
1130 .BI \-chown " uname"
1131 The primary always evaluates as true;
1132 it sets the owner of the file to
1133 .IR uname .
1134 .TP
1135 .B \-false
1136 The primary always evaluates as false;
1137 it allows one to make the result of the full expression different from
1138 the result of a part of the expression.
1139 .TP
1140 .B \-true
1141 The primary always evaluates as true;
1142 it allows one to make the result of the full expression different from
1143 the result of a part of the expression.
1144 .PP
1145 The command line:
1146 .PP
1147 .B "mkisofs -o o.iso -find . ( -type d -ls -o false ) -o ! -type d"
1148 .PP
1149 lists all directories and puts all non-directories to the image
1150 .BR o.iso .
1151 .PP
1152 The command line:
1153 .PP
1154 .B "mkisofs -o o.iso -find . ( -type d -chown root -o true )"
1155 .PP
1156 archives all directories so they appear to be owned by root in the archive,
1157 all non-directories are archived as they are in the file system.
1158 .PP
1159 Note that the
1160 .BR \-ls ,
1161 .B \-exec
1162 and the
1163 .B \-ok
1164 primary cannot be used if
1165 .B stdin
1166 or
1167 stdout
1168 has not been redirected.
1169 .RE
1170 .TP
1171 .BI \-gid " gid"
1172 Overrides the gid read from the source files to the value of
1173 .IR gid .
1174 Specifying this option automatically enables Rock Ridge extensions.
1175 .TP
1176 .B \-gui
1177 Switch the behaviour for a GUI. This currently makes the output more verbose
1178 but may have other effects in future.
1179 .TP
1180 .B \-graft\-points
1181 Allow one to use graft points for filenames. If this option is used, all filenames
1182 are checked for graft points. The filename is divided at the first unescaped
1183 equal sign. All occurrences of '\e\e' and '=' characters must be escaped with '\e\e'
1184 if
1185 .I \-graft\-points
1186 has been specified.
1187 .TP
1188 .BI \-hide " glob"
1189 Hide
1190 .I glob
1191 from being seen on the ISO-9660 or Rock Ridge directory.
1192 .I glob
1193 is a shell wild-card-style pattern that must match any part of the filename
1194 or path.
1195 Multiple globs may be hidden.
1196 If
1197 .I glob
1198 matches a directory, then the contents of that directory will be hidden.
1199 In order to match a directory name, make sure the pathname does not include
1200 a trailing '/' character.
1201 All the hidden files will still be written to the output CD image file.
1202 Should be used with the
1203 .B \-hide\-joliet
1204 option. See README.hide for more details.
1205 .TP
1206 .BI \-hide\-list " file"
1207 A file containing a list of
1208 .I globs
1209 to be hidden as above.
1210 .TP
1211 .BI \-hidden " glob"
1212 Add the hidden (existence) ISO-9660 directory attribute for
1213 .IR glob .
1214 This attribute will prevent
1215 .I glob
1216 from being listed on DOS based systems if the /A flag is not used for the listing.
1217 .I glob
1218 is a shell wild-card-style pattern that must match any part of the filename
1219 or path.
1220 In order to match a directory name, make sure the pathname does not include
1221 a trailing '/' character.
1222 Multiple globs may be hidden.
1223 .TP
1224 .BI \-hidden\-list " file"
1225 A file containing a list of
1226 .I globs
1227 to get the hidden attribute as above.
1228 .TP
1229 .BI \-hide\-joliet " glob"
1230 Hide
1231 .I glob
1232 from being seen on the Joliet directory.
1233 .I glob
1234 is a shell wild-card-style pattern that must match any part of the filename
1235 or path.
1236 Multiple globs may be hidden.
1237 If
1238 .I glob
1239 matches a directory, then the contents of that directory will be hidden.
1240 In order to match a directory name, make sure the pathname does not include
1241 a trailing '/' character.
1242 All the hidden files will still be written to the output CD image file.
1243 Should be used with the
1244 .B \-hide
1245 option. See README.hide for more details.
1246 .TP
1247 .BI \-hide\-joliet\-list " file"
1248 A file containing a list of
1249 .I globs
1250 to be hidden as above.
1251 .TP
1252 .B \-hide\-joliet\-trans\-tbl
1253 Hide the
1254 .B TRANS.TBL
1255 files from the Joliet tree.
1256 These files usually don't make sense in the Joliet World as they list
1257 the real name and the ISO-9660 name which may both be different from the
1258 Joliet name.
1259 .TP
1260 .B \-hide\-rr\-moved
1261 Rename the directory
1262 .B RR_MOVED
1263 to
1264 .B .rr_moved
1265 in the Rock Ridge tree.
1266 This option has been introduced when
1267 .B mkisofs
1268 was not able to hide the directory in the Rock Ridge tree.
1269 This version of
1270 .B mkisofs
1271 always automatically hides the
1272 .B RR_MOVED
1273 directory in the Rock Ridge tree.
1274 If you need to have no
1275 .B RR_MOVED
1276 directory at all (even in the ISO-9660 tree), you should use the
1277 .B \-D
1278 option. Note that in case that the
1279 .B \-D
1280 option has been specified, the resulting filesystem is not ISO-9660
1281 level-1 compliant and will not be readable on MS-DOS.
1282 See also
1283 .B NOTES
1284 section for more information on the
1285 .B RR_MOVED
1286 directory.
1287
1288 .TP
1289 .BI \-hide\-udf " glob"
1290 Hide
1291 .I glob
1292 from being seen on the UDF directory.
1293 .I glob
1294 is a shell wild-card-style pattern that must match any part of the filename
1295 or path.
1296 Multiple globs may be hidden.
1297 If
1298 .I glob
1299 matches a directory, then the contents of that directory will be hidden.
1300 In order to match a directory name, make sure the pathname does not include
1301 a trailing '/' character.
1302 All the hidden files will still be written to the output CD image file.
1303 Should be used with the
1304 .B \-hide
1305 option. See README.hide for more details.
1306 .TP
1307 .BI \-hide\-udf\-list " file"
1308 A file containing a list of
1309 .I globs
1310 to be hidden as above.
1311
1312 .PD 0
1313 .TP
1314 .B \-hide\-ignorecase
1315 .TP
1316 .B \-exclude\-ignorecase
1317 .PD
1318 Ignore the case of the filenames with the
1319 .B \-hide*
1320 options
1321 and with the
1322 .B \-exclude\-list
1323 option.
1324
1325 .TP
1326 .BI \-input\-charset " charset"
1327 Set up the input charset that defines the characters used in local file names.
1328 To get a list of valid charset names, call
1329 .B "mkisofs \-input\-charset help."
1330 To get a 1:1 mapping, you may use
1331 .B default
1332 as charset name. If the input charset has not been set up from the
1333 locale in the environment, the default initial values are
1334 .I cp437
1335 on DOS based systems and
1336 .I iso8859-1
1337 on all other systems.
1338 See
1339 .B "CHARACTER SETS"
1340 section below for more details.
1341 .sp
1342 If
1343 .B \-input\-charset
1344 has not been specified, it will be set up from the locale in the
1345 environment. If you like to disable this automatic setup, use
1346 the empty string as locale name.
1347 .TP
1348 .BI \-output\-charset " charset"
1349 Set up the output charset that defines the characters that will be used in Rock Ridge
1350 file names. Defaults to the input charset. See
1351 .B "CHARACTER SETS"
1352 section below for more details.
1353 .TP
1354 .BI \-iso\-level " level"
1355 Set the ISO-9660 conformance level. Valid numbers are 1..3 and 4.
1356 .sp
1357 With level 1, files may only consist of one section and filenames are
1358 restricted to 8.3 characters.
1359 .sp
1360 With level 2, files may only consist of one section.
1361 .sp
1362 With level 3, no restrictions (other than ISO-9660:1988) do apply.
1363 Starting with this level, mkisofs also allows files to be larger than 4 GB
1364 by implementing ISO-9660 multi-extent files.
1365 .sp
1366 With all ISO-9660 levels from 1..3, all filenames are restricted to upper
1367 case letters, numbers and the underscore (_). The maximum filename
1368 length is restricted to 31 characters, the directory nesting level
1369 is restricted to 8 and the maximum path length is limited to 255 characters.
1370 .sp
1371 Level 4 officially does not exists but
1372 .B mkisofs
1373 maps it to ISO-9660/Amd 1:2013 (formerly ISO-9660:1999 / JIS X 0606:1998),
1374 also known as ISO-9660 version 2.
1375 .sp
1376 With level 4, an enhanced volume descriptor with version number
1377 and file structure version number set to 2 is emitted.
1378 There may be more than 8 levels of directory nesting,
1379 there is no need for a file to contain a dot and the dot has no
1380 more special meaning,
1381 file names do not have version numbers,
1382 .\" (f XXX ??? The character used for filling byte positions which are
1383 .\" specified to be characters is subject to agreement between the
1384 .\" originator and the recipient of the volume),
1385 the maximum length for files and directory is raised to 207.
1386 If Rock Ridge is used, the maximum ISO-9660 name length is reduced to 197.
1387 .sp
1388 When creating Version 2 images,
1389 .B mkisofs
1390 emits an enhanced volume descriptor which looks similar to a primary volume
1391 descriptor but is slightly different. Be careful not to use broken software
1392 to make ISO-9660 images bootable by assuming a second PVD copy and patching
1393 this putative PVD copy into an El Torito VD.
1394 .TP
1395 .B \-J
1396 Generate Joliet directory records in addition to regular ISO-9660 file
1397 names. This is primarily useful when the discs are to be used on Windows-NT
1398 or Windows-95 machines. The Joliet filenames are specified in Unicode and
1399 each path component can be up to 64 Unicode characters long.
1400 Note that Joliet is no standard - CD's that use only Joliet extensions but no
1401 standard Rock Ridge extensions may usually only be used on Microsoft Win32
1402 systems. Furthermore, the fact that the filenames are limited to 64 characters
1403 and the fact that Joliet uses the UTF-16 coding for Unicode characters causes
1404 interoperability problems.
1405 .TP
1406 .B \-joliet\-long
1407 Allow Joliet filenames to be up to 103 Unicode characters. This breaks the
1408 Joliet specification - but appears to work. Use with caution. The number
1409 103 is derived from: the maximum Directory Record Length (254), minus the
1410 length of Directory Record (33), minus CD-ROM XA System Use Extension
1411 Information (14), divided by the UTF-16 character size (2).
1412 .TP
1413 .BI \-jcharset " charset"
1414 Same as using
1415 .B \-input\-charset
1416 .I charset
1417 and
1418 .B \-J
1419 options. See
1420 .B "CHARACTER SETS"
1421 section below for more details.
1422 .TP
1423 .B \-l
1424 .TP
1425 .B \-full\-iso9660\-filenames
1426 Allow full 31 character filenames. Normally the ISO-9660 filename will be in an
1427 8.3 format which is compatible with MS-DOS, even though the ISO-9660 standard
1428 allows filenames of up to 31 characters. If you use this option, the disc may
1429 be difficult to use on a MS-DOS system, but this comes in handy on some other
1430 systems (such as the Amiga).
1431 Use with caution.
1432 .TP
1433 .B \-L
1434 Outdated option reserved by POSIX.1-2001, use
1435 .B \-allow\-leading\-dots
1436 instead.
1437 This option will get POSIX.1-2001 semantics with mkisofs-3.02.
1438 .TP
1439 .BI \-log\-file " log_file"
1440 Redirect all error, warning and informational messages to
1441 .I log_file
1442 instead of the standard error.
1443 .TP
1444 .B \-long\-rr\-time
1445 Use the long ISO-9660 time format for the file time stamps used in Rock Ridge.
1446 This time format allows one to represent year 0 .. year 9999 with a granularity of 10ms.
1447 .sp
1448 The short ISO-9660 time format only allows one to represent year 1900 .. year 2155
1449 with a granularity of 1s.
1450 .TP
1451 .BI \-m " glob"
1452 Exclude
1453 .I glob
1454 from being written to CDROM.
1455 .I glob
1456 is a shell wild-card-style pattern that must match part of the filename (not
1457 the path as with option
1458 .BR \-x ).
1459 Technically
1460 .I glob
1461 is matched against the
1462 .I d->d_name
1463 part of the directory entry.
1464 Multiple globs may be excluded.
1465 Example:
1466
1467 mkisofs \-o rom \-m '*.o' \-m core \-m foobar
1468
1469 would exclude all files ending in ".o", called "core" or "foobar" to be
1470 copied to CDROM. Note that if you had a directory called "foobar" it too (and
1471 of course all its descendants) would be excluded.
1472 .sp
1473 NOTE: The
1474 .B \-m
1475 and
1476 .B \-x
1477 option description should both be updated, they are wrong.
1478 Both now work identical and use filename globbing. A file is excluded if either
1479 the last component matches or the whole path matches.
1480 .TP
1481 .BI \-exclude\-list " file"
1482 A file containing a list of
1483 .I globs
1484 to be excluded as above.
1485 .TP
1486 .B \-max\-iso9660\-filenames
1487 Allow 37 chars in ISO-9660 filenames.
1488 This option forces the
1489 .B \-N
1490 option as the extra name space is taken from the space reserved for
1491 ISO-9660 version numbers.
1492 .br
1493 This violates the ISO-9660 standard, but it happens to work on many systems.
1494 Although a conforming application needs to provide a buffer space of at
1495 least 37 characters, disks created with this option may cause a buffer
1496 overflow in the reading operating system. Use with extreme care.
1497 .TP
1498 .BI \-M " path"
1499 or
1500 .TP
1501 .BI \-M " device"
1502 or
1503 .TP
1504 .BI \-dev " device"
1505 Specifies path to existing ISO-9660 image to be merged. The alternate form
1506 takes a SCSI device specifier that uses the same syntax as the
1507 .B "dev="
1508 parameter of
1509 .B cdrecord.
1510 The output of
1511 .B mkisofs
1512 will be a new session which should get written to the end of the
1513 image specified in \-M. Typically this requires multi-session capability
1514 for the recorder and cdrom drive that you are attempting to write this
1515 image to.
1516 This option may only be used in conjunction with the
1517 .B \-C
1518 option.
1519 .TP
1520 .BI \-modification\-date " date-spec"
1521 Set the
1522 .B modification date
1523 in the primary volume descriptor (PVD) to a value different from the current
1524 time.
1525 This allows e.g. to set up an intentional UUID for
1526 .BR grub .
1527 .sp
1528 .ne 3
1529 The format of
1530 .I date-spec
1531 is:
1532 .sp
1533 .nf
1534 \fIyyyy\fR[\fImm\fR[\fIdd\fR[\fIhh\fR[\fImm\fR[\fIss\fR]\|]\|]\|]\|][.\fIhh\fR][+-\fIghgm\fR]
1535 .fi
1536 .sp
1537 The fields are
1538 .BR year ,
1539 .BR month ,
1540 .BR "day of month" ,
1541 .BR hour ,
1542 .BR minute ,
1543 .BR second ,
1544 .BR "hundreds of a second" ,
1545 .BR "GMT offset in hours and minutes" .
1546 The time is interpreted as local time.
1547 .sp
1548 Year and the GMT offset are four digit fields, all other fields take two digits.
1549 The GMT offset may be between -12 and +13 hours in 15 minute steps. Locations
1550 east to Greenwich have positive values. The value is the sum of the time zone offset
1551 and the effects from daylight saving time.
1552 Omited values are replaced by the minimal possible values.
1553 If the GMT offset is omited, it is computed from the local time value that has been
1554 supplied.
1555 .sp
1556 Between year and month as well as between month and day of month, a separator chosen
1557 from '/' and '-' may appear. In this case, the year may be a two digit number with
1558 values 69..99 representing 1969..1999 and values 00..68 representing 2000..2068.
1559 Between date and time spec, an optional space is permitted. Between hours and minutes
1560 as well as between minutes and seconds, an optional ':' separator is permitted.
1561 This allows
1562 .B mkisofs
1563 to parse the popular POSIX date format created by:
1564 .sp
1565 .nf
1566 \fBdate "+%Y-%m-%d %H:%M:%S %z"\fR
1567 .fi
1568 .sp
1569 Note that the possible range for
1570 .I date-spec
1571 for 32 bit programs is limited to values up to 2038 Jan 19 04:14:07 GMT.
1572 .sp
1573 The PVD contains the following four date values:
1574 .BR creation-date ,
1575 .BR expiration-date ,
1576 .B effective-date
1577 and
1578 .BR modification-date .
1579 See the related option for a description.
1580 .TP
1581 .B \-N
1582 .TP
1583 .B \-omit\-version\-number
1584 Omit version numbers from ISO-9660 file names.
1585 .br
1586 This violates the ISO-9660 standard, but no one really uses the
1587 version numbers anyway.
1588 Use with caution.
1589 .TP
1590 .BI \-new\-dir\-mode " mode"
1591 Mode to use when creating new directories in the iso fs image. The default
1592 mode in the absence of a
1593 .B \-dir\-mode
1594 option is 0555.
1595 .TP
1596 .B \-noatime
1597 Do not include the file last access time but rather use the modification time.
1598 This allows e.g. to create reproducible ISO-9660 filesystem images.
1599 .sp
1600 See also the options:
1601 .BR \-creation\-date ,
1602 .BR \-expiration\-date ,
1603 .BR \-effective\-date ,
1604 .B \-modification\-date
1605 and
1606 .B \-reproducible\-date
1607 for other options to create reproducible ISO-9660 filesystem images.
1608 .sp
1609 To create reproducible ISO-9660 filesystem images, the options:
1610 .BR \-creation\-date ,
1611 .BR \-effective\-date ,
1612 .B \-modification\-date
1613 and
1614 .B \-noatime
1615 need to be specified and the
1616 .B \-o
1617 option must not be used.
1618 .TP
1619 .B \-nobak
1620 .TP
1621 .B \-no\-bak
1622 Do not include backup files files on the ISO-9660 filesystem.
1623 If the
1624 .B \-no\-bak
1625 option is specified, files that contain the characters '~' or '#'
1626 or end in '.bak' will not be included (these are typically backup files
1627 for editors under UNIX).
1628 .TP
1629 .B \-no\-limit\-pathtables
1630 A ISO-9660 filesystem contains path tables that contain a list of directories.
1631 This list may contain many directories but only 65535 of them may be parent
1632 directories.
1633 When
1634 .B \-no\-limit\-pathtables
1635 is in use, further parent directories will be folded to the root directory
1636 and the resulting filesystem will no longer be usable on
1637 .BR DOS .
1638 .TP
1639 .B \-no\-long\-rr\-time
1640 Use the short ISO-9660 time format for the file time stamps used in Rock Ridge.
1641 This time format allows one to represent year 1990 .. year 2155 with a granularity of one second.
1642 .TP
1643 .B \-force\-rr
1644 Do not use the automatic Rock Ridge attributes recognition for previous sessions.
1645 This helps to show rotten ISO-9660 extension records as e.g. created by NERO burning ROM.
1646 .TP
1647 .B \-no\-rr
1648 Do not use the Rock Ridge attributes from previous sessions.
1649 This may help to avoid getting into trouble when
1650 .B mkisofs
1651 finds illegal Rock Ridge signatures on an old session.
1652 .TP
1653 .B \-no\-split\-symlink\-components
1654 Don't split the SL components, but begin a new Continuation Area (CE)
1655 instead. This may waste some space, but the SunOS 4.1.4 cdrom driver
1656 has a bug in reading split SL components (link_size = component_size
1657 instead of link_size += component_size).
1658 .sp
1659 Note that this option has been introduced by Eric Youngdale in 1997.
1660 It is questionable whether it makes sense at all.
1661 When it has been introduced,
1662 .B mkisofs
1663 did have a serious bug that did create defective CE signatures if
1664 a symlink contained `/../'.
1665 This CE signature bug in
1666 .B mkisofs
1667 has been fixed in May 2003.
1668 .TP
1669 .B \-no\-split\-symlink\-fields
1670 Don't split the SL fields, but begin a new Continuation Area (CE)
1671 instead. This may waste some space, but the SunOS 4.1.4 and
1672 Solaris 2.5.1 cdrom driver have a bug in reading split SL fields
1673 (a `/' can be dropped).
1674 .sp
1675 Note that this option has been introduced by Eric Youngdale in 1997.
1676 It is questionable whether it makes sense at all.
1677 When it has been introduced,
1678 .B mkisofs
1679 did have a serious bug that did create defective CE signatures if
1680 a symlink contained `/../'.
1681 This CE signature bug in
1682 .B mkisofs
1683 has been fixed in May 2003.
1684 .TP
1685 .BI \-o " filename"
1686 is the name of the file to which the ISO-9660 filesystem image should be
1687 written. This can be a disk file, a tape drive, or it can correspond directly
1688 to the device name of the optical disc writer. If not specified, stdout is
1689 used. Note that the output can also be a block special device for a regular
1690 disk drive, in which case the disk partition can be mounted and examined to
1691 ensure that the premastering was done correctly.
1692 .TP
1693 .B \-pad
1694 Pad the end of the whole image by 150 sectors (300 kB).
1695 If the option
1696 .B \-B
1697 is used, then there is a padding at the end of the ISO-9660 partition
1698 and before the beginning of the boot partitions.
1699 The size of this padding is chosen to make the first boot partition start
1700 on a sector number that is a multiple of 16.
1701 .sp
1702 The padding is needed as many operating systems (e.g. Linux)
1703 implement read ahead bugs in their filesystem I/O. These bugs result in read
1704 errors on one or more files that are located at the end of a track. They are
1705 usually present when the CD is written in Track at Once mode or when
1706 the disk is written as mixed mode CD where an audio track follows the
1707 data track.
1708 .sp
1709 To avoid problems with I/O error on the last file on the filesystem,
1710 the
1711 .B \-pad
1712 option has been made the default.
1713 .TP
1714 .B \-no\-pad
1715 Do not Pad the end by 150 sectors (300 kB) and do not make the the boot partitions
1716 start on a multiple of 16 sectors.
1717 .TP
1718 .BI \-path\-list " file"
1719 A file containing a list of
1720 .I pathspec
1721 directories and filenames to be added to the ISO-9660 filesystem. This list
1722 of pathspecs are processed after any that appear on the command line. If the
1723 argument is
1724 .IR \- ,
1725 then the list is read from the standard input.
1726 .TP
1727 .B \-P
1728 Outdated option reserved by POSIX.1-2001, use
1729 .B \-publisher
1730 instead.
1731 This option will get POSIX.1-2001 semantics with mkisofs-3.02.
1732 .TP
1733 .BI \-publisher " publisher_id"
1734 Specifies a text string that will be written into the volume header.
1735 This should describe the publisher of the CDROM, usually with a
1736 mailing address and phone number. There is space on the disc for 128
1737 characters of information.
1738 The related Joliet entry is limited to 64 characters.
1739 This parameter can also be set in the file
1740 .B \&.m\&kisofsrc
1741 with PUBL=.
1742 If specified in both places, the command line version is used.
1743 .TP
1744 .BI \-p " preparer_id"
1745 .TP
1746 .BI \-preparer " preparer_id"
1747 Specifies a text string that will be written into the volume header.
1748 This should describe the preparer of the CDROM, usually with a mailing
1749 address and phone number. There is space on the disc for 128
1750 characters of information.
1751 The related Joliet entry is limited to 64 characters.
1752 This parameter can also be set in the file
1753 .B \&.m\&kisofsrc
1754 with PREP=.
1755 If specified in both places, the command line version is used.
1756 .TP
1757 .B \-posix\-H
1758 Follow all symbolic links encountered on command line when generating the filesystem.
1759 .TP
1760 .B \-posix\-L
1761 Follow all symbolic links when generating the filesystem.
1762 When this option is not in use, symbolic links will be entered using
1763 Rock Ridge if enabled, otherwise the file will be ignored.
1764 .TP
1765 .B \-posix\-P
1766 Do not follow symbolic links when generating the filesystem (this is the default).
1767 If
1768 .B \-posix\-P
1769 is specified after
1770 .B \-posix\-H
1771 or
1772 .BR \-posix\-L ,
1773 the effect of these options will be reset.
1774 .TP
1775 .B \-print\-size
1776 Print estimated filesystem size in multiples of the sector size (2048 bytes)
1777 and exit. This option is needed for
1778 Disk At Once mode and with some CD-R drives when piping directly into
1779 .B cdrecord.
1780 In this case it is needed to know the size of the filesystem before the
1781 actual CD-creation is done.
1782 The option \-print\-size allows one to get this size from a "dry-run" before
1783 the CD is actually written.
1784 Old versions of
1785 .B mkisofs
1786 did write this information (among other information) to
1787 .IR stderr .
1788 As this turns out to be hard to parse, the number without any other information
1789 is now printed on
1790 .B stdout
1791 too.
1792 If you like to write a simple shell script, redirect
1793 .B stderr
1794 and catch the number from
1795 .BR stdout .
1796 This may be done with:
1797 .sp
1798 .B "cdblocks=` mkisofs \-print\-size \-quiet .\|.\|. `"
1799 .sp
1800 .B "mkisofs .\|.\|. | cdrecord .\|.\|. tsize=${cdblocks}s -"
1801 .TP
1802 .B \-quiet
1803 This makes
1804 .B mkisofs
1805 even less verbose. No progress output will be provided.
1806 .TP
1807 .B \-R
1808 .TP
1809 .B \-rock
1810 Generate SUSP and RR records using the Rock Ridge protocol to further describe
1811 the files on the ISO-9660 filesystem.
1812 The Rock Ridge protocol is needed in order to add POSIX like file meta data
1813 like permissions, extended time stamps, user/group is'd, link counts, inode numbers
1814 and symbolic links. The Rock Ridge protocol allows one to archive hierarchy trees
1815 with unlimited depth.
1816 .sp
1817 Warning: When you specify
1818 .BR \-udf ,
1819 this causes
1820 .B Rock\ Ridge
1821 to be in
1822 .BR \-r / \-rational\-rock
1823 form as well.
1824 .TP
1825 .B \-r
1826 .TP
1827 .B \-rational\-rock
1828 This is like the \-R option, but file ownership and modes are set to
1829 more useful values. The uid and gid are set to zero, because they are
1830 usually only useful on the author's system, and not useful to the
1831 client. All the file read bits are set true, so that files and
1832 directories are globally readable on the client. If any execute bit is
1833 set for a file, set all of the execute bits, so that executables are
1834 globally executable on the client. If any search bit is set for a
1835 directory, set all of the search bits, so that directories are globally
1836 searchable on the client. All write bits are cleared, because the
1837 CD-Rom will be mounted read-only in any case. If any of the special
1838 mode bits are set, clear them, because file locks are not useful on a
1839 read-only file system, and set-id bits are not desirable for uid 0 or
1840 gid 0.
1841 When used on Win32, the execute bit is set on
1842 .I all
1843 files. This is a result of the lack of file permissions on Win32 and the
1844 Cygwin POSIX emulation layer. See also \-uid \-gid, \-dir\-mode, \-file\-mode
1845 and \-new\-dir\-mode.
1846 .TP
1847 .B \-relaxed\-filenames
1848 The option
1849 .B \-relaxed\-filenames
1850 allows ISO-9660 filenames to include digits, upper case characters
1851 and all other 7 bit ASCII characters (resp. anything except lowercase
1852 characters).
1853 .br
1854 This violates the ISO-9660 standard, but it happens to work on many systems.
1855 Use with caution.
1856 .TP
1857 .BI \-reproducible\-date " date-spec"
1858 Is a macro for setting
1859 .BR \-creation\-date ,
1860 .BR \-effective\-date ,
1861 .B \-modification\-date
1862 and
1863 .B \-noatime
1864 in order to create reproducible ISO 9660 filesystem images.
1865 .TP
1866 .BI \-root " dir"
1867 Moves all files and directories into
1868 .I dir
1869 in the image. This is essentially the
1870 same as using
1871 .B -graft-points
1872 and adding
1873 .I dir
1874 in front of every pathspec, but is easier to use.
1875
1876 .I dir
1877 may actually be several levels deep. It is
1878 created with the same permissions as other graft points.
1879 .TP
1880 .B \-rrip110
1881 Create ISO-9660 file system images that follow the old Rrip Version-1.10 standard
1882 from 1993. This option may be needed if you know of systems that do not implement
1883 the Rrip protocol correctly and like the file system to be read by such a system.
1884 Currently no such system is known.
1885 .sp
1886 If a file system has been created with
1887 .BR \-rrip110 ,
1888 the Rock Ridge attributes do not include inode number information.
1889 .TP
1890 .B \-rrip112
1891 Create ISO-9660 file system images that follow the new Rrip Version-1.12 standard
1892 from 1994, this is the default.
1893 .TP
1894 .BI \-old-root " dir"
1895 This option is necessary when writing a multisession
1896 image and the previous (or even older) session was written with
1897 .BI -root " dir" .
1898 Using a directory name not found in the previous session
1899 causes
1900 .B mkisofs
1901 to abort with an error.
1902
1903 Without this option,
1904 .B mkisofs
1905 would not be able to find unmodified files and would
1906 be forced to write their data into the image once more.
1907
1908 .B \-root
1909 and
1910 .B \-old-root
1911 are meant to be used together to do incremental backups.
1912 The initial session would e.g. use:
1913 .BI "mkisofs \-root backup_1 " dirs\f0.
1914 The next incremental backup with
1915 .BI "mkisofs \-root backup_2 \-old-root backup_1 " dirs\f0.
1916 would take another snapshot of these directories. The first
1917 snapshot would be found in
1918 .BR backup_1 ,
1919 the second one in
1920 .BR backup_2 ,
1921 but only modified or new files need to be written
1922 into the second session.
1923
1924 Without these options, new files would be added and old ones would be
1925 preserved. But old ones would be overwritten if the file was
1926 modified. Recovering the files by copying the whole directory back
1927 from CD would also restore files that were deleted
1928 intentionally. Accessing several older versions of a file requires
1929 support by the operating system to choose which sessions are to be
1930 mounted.
1931 .br
1932 .ne 8
1933 .TP
1934 .B \-short\-rr\-time
1935 Use the short ISO-9660 time format for the file time stamps used in Rock Ridge.
1936 This time format allows one to represent year 1990 .. year 2155 with a granularity of one second.
1937 .TP
1938 .BI \-s " sector type"
1939 .TP
1940 .BI \-sectype " sector type"
1941 Set the
1942 .I sector type
1943 to be used for the output file with the ISO-9660 filesystem.
1944 The
1945 .I sector type
1946 may be one of:
1947 .RS
1948 .TP
1949 .B data
1950 This is the default. It results in standard CD-ROM data sectors with
1951 2048 bytes per sector.
1952 .TP
1953 .B xa1
1954 This sets the sector type to CD-ROM XA mode 1 with 2056 bytes per sector.
1955 This sector type is the official sector type for multi-session CDs, it
1956 should be used together with the
1957 .B \-XA
1958 option of mkisofs.
1959 It is required to write Kodak Photo CDs and Kodak Picture CDs.
1960 Use the
1961 .B \-xa1
1962 option from
1963 .B cdrecord
1964 to tell
1965 .B cdrecord
1966 to write CD-ROM XA mode 1 sectors.
1967 Do not use for DVD or BluRay media.
1968 .br
1969 .ne 6
1970 .TP
1971 .B raw
1972 This sets the sector type to raw audio sectors with 2352 bytes per sector.
1973 This is reserved for future enhancements.
1974 Do not use for DVD or BluRay media.
1975 .RE
1976 .TP
1977 .BI \-sort " sort file"
1978 Sort file locations on the media. Sorting is controlled by a file that
1979 contains pairs of filenames and sorting offset weighting.
1980 If the weighting is higher, the file will be located closer to the
1981 beginning of the media, if the weighting is lower, the file will be located
1982 closer to the end of the media. There must be only one space or tabs
1983 character between the filename and the
1984 weight and the weight must be the last characters on a line. The filename
1985 is taken to include all the characters up to, but not including the last
1986 space or tab character on a line. This is to allow for space characters to
1987 be in, or at the end of a filename.
1988 This option does
1989 .B not
1990 sort the order of the file names that appear
1991 in the ISO-9660 directory. It sorts the order in which the file data is
1992 written to the CD image - which may be useful in order to optimize the
1993 data layout on a CD. See README.sort for more details.
1994 .TP
1995 .BI \-isort " sort file"
1996 Similar to
1997 .B \-sort
1998 but the case if the filenames in the
1999 .B sort file
2000 is ignored.
2001 .TP
2002 .BI \-sparc\-boot " img_sun4,img_sun4c,img_sun4m,img_sun4d,img_sun4e"
2003 See
2004 .B \-B
2005 option above.
2006 .TP
2007 .BI \-sparc\-label " label"
2008 Set the Sun disk label name for the Sun disk label that is created with the
2009 .B \-sparc-boot
2010 option.
2011 .TP
2012 .B \-split\-output
2013 Split the output image into several files of approximately 1 GB.
2014 This helps to create DVD sized ISO-9660 images on operating systems without
2015 large file support.
2016 Cdrecord will concatenate more than one file into a single track if writing
2017 to a DVD.
2018 To make
2019 .B \-split\-output
2020 work, the
2021 .BI \-o " filename"
2022 option must be specified. The resulting output images will be named:
2023 .IR filename_00 , filename_01, filename_02 ...
2024 .TP
2025 .BI \-stream\-media\-size " #"
2026 Select streaming operation and set the media size to # sectors.
2027 This allows you to pipe the output of the tar program into mkisofs
2028 and to create a ISO-9660 filesystem without the need of an intermediate
2029 tar archive file.
2030 If this option has been specified,
2031 .B mkisofs
2032 reads from
2033 .B stdin
2034 and creates a file with the name
2035 .BR STREAM.IMG .
2036 The maximum size of the file (with padding) is 200 sectors less than the
2037 specified media size. If
2038 .B \-no\-pad
2039 has been specified, the file size is 50 sectors less than the specified media size.
2040 If the file is smaller, then mkisofs will write padding. This may take a while.
2041 .sp
2042 The option
2043 .B \-stream\-media\-size
2044 creates simple ISO-9660 filesystems only and may not used together with multi-session
2045 or hybrid filesystem options.
2046 .TP
2047 .BI \-stream\-file\-name " name"
2048 Set the file name used with
2049 .BI \-stream\-media\-size " #"
2050 to a value different from
2051 .BR STREAM.IMG .
2052 If this option is used, the filesystem is created as if
2053 .BR \-iso\-level " 4"
2054 has been specified.
2055 .TP
2056 .BI \-sunx86\-boot " UFS-img,,,AUX1-img"
2057 Specifies a comma separated list of filesystem images that are needed to make
2058 a bootable CD for Solaris x86 systems.
2059 .sp
2060 Note that partition 1 is used for the ISO-9660 image and that partition 2 is
2061 the whole disk, so partition 1 and 2 may not be used by external partition data.
2062 The first image file is mapped to partition 0.
2063 There may be empty fields in the comma separated list,
2064 and list entries for partition 1 and 2 must be empty.
2065 The maximum number of supported partitions is 8 (although the Solaris x86
2066 partition table could support up to 16 partitions), so it is impossible
2067 to specify more than 6 partition images.
2068 This option is required to make a bootable CD for Solaris x86 systems.
2069 .sp
2070 If the
2071 .B \-sunx86\-boot
2072 option has been specified, the first sector of the resulting image will
2073 contain a PC fdisk label with a Solaris type 0x82 fdisk partition that
2074 starts at offset 512 and spans the whole CD.
2075 In addition, for the Solaris type 0x82 fdisk partition, there is a
2076 SVr4 disk label at offset 1024 in the first sector of the CD.
2077 This disk label specifies slice 0 for the first (usually UFS type)
2078 filesystem image that is used to boot the PC and slice 1 for
2079 the ISO-9660 image.
2080 Slice 2 spans the whole CD slice 3 .\|.\|. slice 7 may be used for additional
2081 filesystem images that have been specified with this option.
2082 .sp
2083 A Solaris x86 boot CD uses a 1024 byte sized primary boot that uses the
2084 .B "El-Torito no-emulation"
2085 boot mode and a secondary generic boot that is in CD sectors 1\|.\|.15.
2086 For this reason, both
2087 .BI "-b " bootimage " -no\-emul\-boot"
2088 and
2089 .BI \-G " genboot"
2090 must be specified.
2091 .TP
2092 .BI \-sunx86\-label " label"
2093 Set the SVr4 disk label name for the SVr4 disk label that is created with the
2094 .B \-sunx86-boot
2095 option.
2096 .TP
2097 .BI \-sysid " ID"
2098 Specifies the system ID.
2099 There is space on the disc for 32 characters of information.
2100 This parameter can also be set in the file
2101 .B \&.m\&kisofsrc
2102 with SYSI=system_id.
2103 If specified in both places, the command line version is used.
2104 .TP
2105 .B \-T
2106 .TP
2107 .B \-translation\-table
2108 Generate a file TRANS.TBL in each directory on the CDROM, which can be used
2109 on non-Rock Ridge capable systems to help establish the correct file names.
2110 There is also information present in the file that indicates the major and
2111 minor numbers for block and character devices, and each symlink has the name of
2112 the link file given.
2113 .TP
2114 .BI \-table\-name " TABLE_NAME"
2115 Alternative translation table file name (see above). Implies the
2116 .B \-T
2117 option.
2118 If you are creating a multi-session image you must use the same name
2119 as in the previous session.
2120 .TP
2121 .BI \-ucs\-level " level"
2122 Set Unicode conformance level in the Joliet SVD. The default level is 3.
2123 It may be set to 1..3 using this option.
2124 .TP
2125 .B \-UDF
2126 Include a
2127 .B UDF
2128 hybrid in the generated filesystem image.
2129 As
2130 .B mkisofs
2131 always creates a ISO-9660 filesystem,
2132 it is not possible to create UDF only images.
2133 Note that
2134 .B UDF
2135 wastes the space from sector ~20 to sector 256 at the beginning of the disk
2136 in addition to the space needed for real
2137 .B UDF
2138 data structures.
2139 .sp
2140 Warning: When you specify
2141 .B \-r
2142 or
2143 .B \-rational\-rock
2144 this causes
2145 .B UDF
2146 to be in
2147 .B \-udf
2148 form as well.
2149 .TP
2150 .B \-udf
2151 Rationalized UDF with user and group set to 0 and with simplified permissions.
2152 See
2153 .B \-r
2154 option for more information.
2155 .TP
2156 .B \-udf\-symlinks
2157 Support symlinks in
2158 .B UDF
2159 filesystems. This is the default.
2160 .TP
2161 .B \-no\-udf\-symlinks
2162 Do not support symlinks in
2163 .B UDF
2164 filesystems.
2165 .TP
2166 .BI \-uid " uid"
2167 Overrides the uid read from the source files to the value of
2168 .IR uid .
2169 Specifying this option automatically enables Rock Ridge extensions.
2170 .TP
2171 .B \-use\-fileversion
2172 The option
2173 .B \-use\-fileversion
2174 allows mkisofs to use file version numbers from the filesystem.
2175 If the option is not specified,
2176 .B mkisofs
2177 creates a version number of 1 for all files.
2178 File versions are strings in the range
2179 .I ";1"
2180 to
2181 .I ";32767"
2182 This option is the default on VMS.
2183 .TP
2184 .B \-U
2185 .TP
2186 .B \-untranslated\-filenames
2187 Allows "Untranslated" filenames, completely violating the ISO-9660 standards
2188 described above. Forces on the \-d, \-l, \-N, \-allow\-leading\-dots,
2189 \-relaxed\-filenames,
2190 \-allow\-lowercase, \-allow\-multidot and \-no\-iso\-translate
2191 flags. It allows more
2192 than one '.' character in the filename, as well as mixed case filenames.
2193 This is useful on HP-UX system, where the built-in CDFS filesystem does
2194 not recognize ANY extensions. Use with extreme caution.
2195 .TP
2196 .B \-no\-iso\-translate
2197 Do not translate the characters '#' and '~' which are invalid for ISO-9660 filenames.
2198 These characters are though invalid often used by Microsoft systems.
2199 .br
2200 This violates the ISO-9660 standard, but it happens to work on many systems.
2201 Use with caution.
2202 .TP
2203 .BI \-V " volid"
2204 Specifies the volume ID (volume name or label) to be written into the
2205 master block.
2206 There is space on the disc for 32 characters of information.
2207 This parameter can also be set in the file
2208 .B \&.m\&kisofsrc
2209 with VOLI=id.
2210 If specified in both places, the command line version is used. Note that
2211 if you assign a volume ID, this is the name that will be used as the mount
2212 point used by the Solaris volume management system and the name that is
2213 assigned to the disc on a Microsoft Win32 or Apple Mac platform.
2214 .TP
2215 .BI \-volset " ID"
2216 Specifies the volset ID.
2217 There is space on the disc for 128 characters of information.
2218 The related Joliet entry is limited to 64 characters.
2219 This parameter can also be set in the file
2220 .B \&.m\&kisofsrc
2221 with VOLS=volset_id.
2222 If specified in both places, the command line version is used.
2223 .TP
2224 .BI \-volset\-size " #"
2225 Sets the volume set size to #.
2226 The volume set size is the number of CD's that are in a CD volume set.
2227 A volume set is a collection of one or more volumes, on which a set of
2228 files is recorded.
2229 .sp
2230 Volume Sets are not intended to be used to create a set numbered CD's
2231 that are part of e.g. a Operation System installation set of CD's.
2232 Volume Sets are rather used to record a big directory tree that would not
2233 fit on a single volume.
2234 Each volume of a Volume Set contains a description of all the directories
2235 and files that are recorded on the volumes where the sequence numbers
2236 are less than, or equal to, the assigned Volume Set Size of the current
2237 volume.
2238 .sp
2239 .B Mkisofs
2240 currently does not support a
2241 .B \-volset\-size
2242 that is larger than 1.
2243 .sp
2244 The option
2245 .B \-volset\-size
2246 must be specified before
2247 .B \-volset\-seqno
2248 on each command line.
2249 .TP
2250 .BI \-volset\-seqno " #"
2251 Sets the volume set sequence number to #.
2252 The volume set sequence number is the index number of the current
2253 CD in a CD set.
2254 The option
2255 .B \-volset\-size
2256 must be specified before
2257 .B \-volset\-seqno
2258 on each command line.
2259 .TP
2260 .B \-v
2261 .TP
2262 .B \-verbose
2263 Verbose execution. If given twice on the command line, extra debug information
2264 will be printed.
2265 .TP
2266 .BI \-x " path"
2267 Exclude
2268 .I path
2269 from being written to CDROM.
2270 .I path
2271 must be the complete pathname that results from concatenating the pathname
2272 given as command line argument and the path relative to this directory.
2273 Multiple paths may be excluded.
2274 Example:
2275
2276 mkisofs \-o cd \-x /local/dir1 \-x /local/dir2 /local
2277 .sp
2278 NOTE: The
2279 .B \-m
2280 and
2281 .B \-x
2282 option description should both be updated, they are wrong.
2283 Both now work identical and use filename globbing. A file is excluded if either
2284 the last component matches or the whole path matches.
2285 .TP
2286 .B \-XA
2287 Generate XA iso-directory attributes with original owner and mode information.
2288 This option is required to create conforming multi session CDs as used by the
2289 Kodak Photo CD and the Kodak Picture CD.
2290 A conforming XA CD uses CD-ROM XA mode 1 sectors, see the
2291 .BI \-sectype " xa1"
2292 option for more information.
2293 .TP
2294 .B \-xa
2295 Generate XA iso-directory attributes with rationalized owner and mode information.
2296 User ID and group ID are set to 0.
2297 See
2298 .B \-XA
2299 for more information.
2300 .TP
2301 .B \-z
2302 Generate special RRIP records for transparently compressed files.
2303 This is only of use and interest for hosts that support transparent
2304 decompression, such as Linux 2.4.14 or later. You must specify the
2305 .B \-R
2306 or
2307 .B \-r
2308 options to enable RockRidge, and generate compressed files using the
2309 .B mkzftree
2310 utility before running
2311 .BR mkisofs .
2312 Note that transparent compression is a nonstandard Rock Ridge extension.
2313 The resulting disks are only transparently readable if used on Linux.
2314 On other operating systems you will need to call
2315 .B mkzftree
2316 by hand to decompress the files.
2317
2318 .SH "HFS OPTIONS"
2319 .TP
2320 .B \-hfs
2321 Create an ISO-9660/HFS hybrid CD. This option should be used in conjunction
2322 with the
2323 .BR \-map ,
2324 .B \-magic
2325 and/or the various
2326 .I double dash
2327 options given below.
2328 .TP
2329 .B \-no\-hfs
2330 Do not create an ISO-9660/HFS hybrid CD even though other options may imply to do so.
2331 .TP
2332 .B \-apple
2333 Create an ISO-9660 CD with Apple's extensions. Similar to the
2334 .B \-hfs
2335 option, except that the Apple Extensions to ISO-9660 are added instead of
2336 creating an HFS hybrid volume.
2337 Former
2338 .B mkisofs
2339 versions did include Rock Ridge attributes by default if
2340 .B \-apple
2341 was specified. This versions of
2342 .B mkisofs
2343 does not do this anymore. If you like to have Rock Ridge attributes,
2344 you need to specify this separately.
2345 .TP
2346 .BI \-map " mapping_file"
2347 Use the
2348 .I mapping_file
2349 to set the CREATOR and TYPE information for a file based on the
2350 filename's extension. A filename is
2351 mapped only if it is not one of the know Apple/Unix file formats. See the
2352 .B "HFS CREATOR/TYPE"
2353 section below.
2354 .TP
2355 .BI \-magic " magic_file"
2356 The CREATOR and TYPE information is set by using a file's
2357 .I magic number
2358 (usually the first few bytes of a file). The
2359 .I magic_file
2360 is only used if a file is not one of the known Apple/Unix file formats, or
2361 the filename extension has not been mapped using the
2362 .B \-map
2363 option. See the
2364 .B "HFS CREATOR/TYPE"
2365 section below for more details.
2366 .TP
2367 .BI \-hfs\-creator " CREATOR"
2368 Set the default CREATOR for all files. Must be exactly 4 characters. See the
2369 .B "HFS CREATOR/TYPE"
2370 section below for more details.
2371 .TP
2372 .BI \-hfs\-type " TYPE"
2373 Set the default TYPE for all files. Must be exactly 4 characters. See the
2374 .B "HFS CREATOR/TYPE"
2375 section below for more details.
2376 .TP
2377 .B \-probe
2378 Search the contents of files for all the known Apple/Unix file formats.
2379 See the
2380 .B HFS MACINTOSH FILE FORMATS
2381 section below for more about these formats.
2382 However, the only way to check for
2383 .I MacBinary
2384 and
2385 .I AppleSingle
2386 files is to open and read them. Therefore this option
2387 .I may
2388 increase processing time. It is better to use one or more
2389 .I double dash
2390 options given below if the Apple/Unix formats in use are known.
2391 .TP
2392 .B \-no\-desktop
2393 Do not create (empty) Desktop files. New HFS Desktop files will be created
2394 when the CD is used on a Macintosh (and stored in the System Folder).
2395 By default, empty Desktop files are added to the HFS volume.
2396 .TP
2397 .B \-mac\-name
2398 Use the HFS filename as the starting point for the ISO-9660, Joliet and
2399 Rock Ridge file names. See the
2400 .B HFS MACINTOSH FILE NAMES
2401 section below for more information.
2402 .TP
2403 .BI \-boot\-hfs\-file " driver_file"
2404 Installs the
2405 .I driver_file
2406 that
2407 .I may
2408 make the CD bootable on a Macintosh. See the
2409 .B HFS BOOT DRIVER
2410 section below. (Alpha).
2411 .TP
2412 .B \-part
2413 Generate an HFS partition table. By default, no partition table is generated,
2414 but some older Macintosh CDROM drivers need an HFS partition table on the
2415 CDROM to be able to recognize a hybrid CDROM.
2416 .TP
2417 .BI \-auto " AutoStart_file"
2418 Make the HFS CD use the QuickTime 2.0 Autostart feature to launch an
2419 application or document. The given filename must be the name of a document or
2420 application located at the top level of the CD. The filename must be less
2421 than 12 characters. (Alpha).
2422 .TP
2423 .BI \-cluster\-size " size"
2424 Set the size in bytes of the cluster or allocation units of PC Exchange
2425 files. Implies the
2426 .B \-\-exchange
2427 option. See the
2428 .B HFS MACINTOSH FILE FORMATS
2429 section below.
2430 .TP
2431 .BI \-hide\-hfs " glob"
2432 Hide
2433 .I glob
2434 from the HFS volume. The file or directory will still exist in the
2435 ISO-9660 and/or Joliet directory.
2436 .I glob
2437 is a shell wild-card-style pattern that must match any part of the filename
2438 Multiple globs may be excluded.
2439 Example:
2440
2441 mkisofs \-o rom \-hfs \-hide\-hfs '*.o' \-hide\-hfs foobar
2442
2443 would exclude all files ending in ".o" or called "foobar"
2444 from the HFS volume. Note that if you had a directory called
2445 "foobar" it too (and of course all its descendants) would be excluded.
2446 The
2447 .I glob
2448 can also be a path name relative to the source directories given on the
2449 command line. Example:
2450
2451 mkisofs \-o rom \-hfs \-hide\-hfs src/html src
2452
2453 would exclude just the file or directory called "html" from the "src"
2454 directory. Any other file or directory called "html" in the tree will
2455 not be excluded.
2456 Should be used with the
2457 .B \-hide
2458 and/or
2459 .B \-hide\-joliet
2460 options.
2461 In order to match a directory name, make sure the pathname does not include
2462 a trailing '/' character. See README.hide for more details.
2463 .TP
2464 .BI \-hide\-hfs\-list " file"
2465 A file containing a list of
2466 .I globs
2467 to be hidden as above.
2468 .TP
2469 .BI \-hfs\-volid " hfs_volid"
2470 Volume name for the HFS partition. This is the name that is
2471 assigned to the disc on a Macintosh and replaces the
2472 .I volid
2473 used with the
2474 .B \-V
2475 option
2476 .TP
2477 .B \-icon\-position
2478 Use the icon position information, if it exists, from the Apple/Unix file.
2479 The icons will appear in the same position as they would on a Macintosh
2480 desktop. Folder location and size on screen, its scroll positions, folder
2481 View (view as Icons, Small Icons, etc.) are also preserved.
2482 This option may become set by default in the future.
2483 (Alpha).
2484 .TP
2485 .BI \-root\-info " file"
2486 Set the location, size on screen, scroll positions, folder View etc. for the
2487 root folder of an HFS volume. See README.rootinfo for more information.
2488 (Alpha)
2489 .TP
2490 .BI \-prep\-boot " FILE"
2491 PReP boot image file. Up to 4 are allowed. See README.prep_boot (Alpha)
2492 .TP
2493 .B \-chrp\-boot
2494 Create a CHRP boot in boot partition 1.
2495 See
2496 .B \-prep\-boot
2497 for further information.
2498 .TP
2499 .BI \-input\-hfs\-charset " charset"
2500 Input charset that defines the characters used in HFS file names when
2501 used with the
2502 .I \-mac\-name
2503 option.
2504 The default charset is
2505 .I macintosh
2506 (Mac Roman)
2507 See
2508 .B "CHARACTER SETS"
2509 and
2510 .B "HFS MACINTOSH FILE NAMES"
2511 sections below for more details.
2512 .TP
2513 .BI \-output\-hfs\-charset " charset"
2514 Output charset that defines the characters that will be used in the HFS
2515 file names. Defaults to the input charset. See
2516 .B "CHARACTER SETS"
2517 section below for more details.
2518 .TP
2519 .B \-hfs\-unlock
2520 By default,
2521 .B mkisofs
2522 will create an HFS volume that is
2523 .IR locked .
2524 This option leaves the volume unlocked so that other applications (e.g.
2525 hfsutils) can modify the volume. See the
2526 .B "HFS PROBLEMS/LIMITATIONS"
2527 section below for warnings about using this option.
2528 .TP
2529 .BI \-hfs\-bless " folder_name"
2530 "Bless" the given directory (folder). This is usually the
2531 .B System Folder
2532 and is used in creating HFS bootable CDs. The name of the directory must
2533 be the whole path name as
2534 .B mkisofs
2535 sees it. e.g. if the given pathspec is ./cddata and the required folder is
2536 called System Folder, then the whole path name is "./cddata/System Folder"
2537 (remember to use quotes if the name contains spaces).
2538 .TP
2539 .BI \-hfs\-parms " PARAMETERS"
2540 Override certain parameters used to create the HFS file system. Unlikely to
2541 be used in normal circumstances. See the libhfs_iso/hybrid.h source file for
2542 details.
2543 .TP
2544 .B \-\-cap
2545 Look for AUFS CAP Macintosh files. Search for CAP Apple/Unix file formats
2546 only. Searching for the other possible Apple/Unix file formats is disabled,
2547 unless other
2548 .I double dash
2549 options are given.
2550 .TP
2551 .B \-\-netatalk
2552 Look for NETATALK Macintosh files
2553 .TP
2554 .B \-\-double
2555 Look for AppleDouble Macintosh files
2556 .TP
2557 .B \-\-ethershare
2558 Look for Helios EtherShare Macintosh files
2559 .TP
2560 .B \-\-ushare
2561 Look for IPT UShare Macintosh files
2562 .TP
2563 .B \-\-exchange
2564 Look for PC Exchange Macintosh files
2565 .TP
2566 .B \-\-sgi
2567 Look for SGI Macintosh files
2568 .TP
2569 .B \-\-xinet
2570 Look for XINET Macintosh files
2571 .TP
2572 .B \-\-macbin
2573 Look for MacBinary Macintosh files
2574 .TP
2575 .B \-\-single
2576 Look for AppleSingle Macintosh files
2577 .TP
2578 .B \-\-dave
2579 Look for Thursby Software Systems DAVE Macintosh files
2580 .TP
2581 .B \-\-sfm
2582 Look for Microsoft's Services for Macintosh files (NT only) (Alpha)
2583 .TP
2584 .B \-\-osx\-double
2585 Look for MacOS X AppleDouble Macintosh files
2586 .TP
2587 .B \-\-osx\-hfs
2588 Look for MacOS X HFS Macintosh files
2589
2590 .SH "CHARACTER SETS"
2591 .B mkisofs
2592 processes file names in a POSIX compliant way as strings of 8-bit characters.
2593 To represent all codings for all languages, 8-bit characters are not
2594 sufficient. Unicode or
2595 .B ISO-10646
2596 define character codings that need at least 21 bits to represent all
2597 known languages. They may be represented with
2598 .BR UTF-32 ", " UTF-16 " or " UTF-8
2599 coding.
2600 .B UTF-32
2601 uses a plain 32-bit coding but seems to be uncommon.
2602 .B UCS-2
2603 is used by Microsoft with Win32.
2604 This coding is similar to
2605 .B UTF-16
2606 with the disadvantage that it only supports
2607 a 16 bit subset (except when surrogates are used) of all codes
2608 and that 16-bit characters are not compliant with
2609 the POSIX filesystem interface.
2610 .PP
2611 Modern UNIX operating systems may use
2612 .B UTF-8
2613 coding for filenames. This coding allows one to use the complete Unicode code set.
2614 Each 32-bit character is represented by one or more 8-bit characters.
2615 If a character is coded in
2616 .B ISO-8859-1
2617 (used in Central Europe and North America) it maps 1:1 to a
2618 .BR UTF-32 " or " UTF-16 \c
2619 coded Unicode character.
2620 If a character is coded in
2621 .B "7-Bit ASCII"
2622 (used in USA and other countries with limited character set)
2623 it maps 1:1 to a
2624 .BR UTF-32 ", " UTF-16 " or " UTF-8
2625 coded Unicode character.
2626 Character codes that cannot be represented as a single byte in UTF-8
2627 (typically if the value is > 0x7F) use escape sequences that map to more than
2628 one 8-bit character.
2629 .PP
2630 If all operating systems would use
2631 .B UTF-8
2632 coding,
2633 .B mkisofs
2634 would not need to recode characters in file names.
2635 Unfortunately, Apple uses completely nonstandard codings and Microsoft
2636 uses a Unicode coding that is not compatible with the POSIX filename
2637 interface.
2638 .PP
2639 For all non
2640 .B UTF-8
2641 coded operating systems, the actual character
2642 that each byte represents, depends on the
2643 .I character set
2644 or
2645 .I codepage
2646 (which is the name used by Microsoft)
2647 used by the local operating system in use - the characters in a character
2648 set will reflect the region or natural language used by the user.
2649 .PP
2650 Usually character codes 0x00-0x1f are control characters, codes 0x20-0x7f
2651 are the 7 bit ASCII characters and (on PC's and Mac's) 0x80-0xff are used
2652 for other characters.
2653 Unfortunately even this does not follow ISO standards that reserve the
2654 range 0x80-0x9f for control characters and only allow 0xa0-0xff for other
2655 characters.
2656 .PP
2657 As there is a lot more than 256 characters/symbols in use, only a small
2658 subset are represented in a character set. Therefore the same character code
2659 may represent a different character in different character sets. So a file name
2660 generated, say in central Europe, may not display the same character
2661 when viewed on a machine in, say eastern Europe.
2662 .PP
2663 To make matters more complicated, different operating systems use
2664 different character sets for the region or language. For example the character
2665 code for "small e with acute accent" may be character code 0x82 on a PC,
2666 code 0x8e on a Macintosh and code 0xe9 on a UNIX system.
2667 Note while the codings used on a PC or Mac are nonstandard,
2668 Unicode codes this character as 0x00000000e9 which is basically the
2669 same value as the value used by most UNIX systems.
2670 .PP
2671 As long as not all operating systems and applications will use the Unicode
2672 character set as the basis for file names in a unique way, it may be
2673 necessary to specify which character set your file names use in and which
2674 character set the file names should appear on the CD.
2675 .PP
2676 There are four options to specify the character sets you want to use:
2677 .TP
2678 .B \-input\-charset
2679 Defines the local character set you are using on your host machine.
2680 Any character set conversions that take place will use this character
2681 set as the staring point. The default input character sets are
2682 .I cp437
2683 on DOS based systems and
2684 .I iso8859-1
2685 on all other systems.
2686
2687 If the
2688 .I \-J
2689 option is given, then the Unicode equivalents of the input character set
2690 will be used in the Joliet directory. Using the
2691 .I \-jcharset
2692 option is the same as using the
2693 .I \-input\-charset
2694 and
2695 .I \-J
2696 options.
2697 .TP
2698 .B \-output\-charset
2699 Defines the character set that will be used with for the Rock Ridge names
2700 on the CD. Defaults to the input character set. Only likely to be useful
2701 if used on a non-Unix platform. e.g. using
2702 .B mkisofs
2703 on a Microsoft Win32 machine to create Rock Ridge CDs. If you are using
2704 .B mkisofs
2705 on a Unix machine, it is likely that the output character set
2706 will be the same as the input character set.
2707 .TP
2708 .B \-input\-hfs\-charset
2709 Defines the HFS character set used for HFS file names decoded from
2710 any of the various Apple/Unix file formats. Only useful when used with
2711 .I \-mac\-name
2712 option. See the
2713 .B HFS MACINTOSH FILE NAMES
2714 for more information. Defaults to
2715 .I macintosh
2716 (Mac Roman).
2717 .TP
2718 .B \-output\-hfs\-charset
2719 Defines the HFS character set used to create HFS file names from the input
2720 character set in use. In most cases this will be from the character set
2721 given with the
2722 .I \-input\-charset
2723 option. Defaults to the input HFS character set.
2724 .PP
2725 The
2726 .B default
2727 character set is built into
2728 .BR mkisofs .
2729 A number of further character sets are read in from the filesystem by
2730 .I mkisofs
2731 from a directory relatively to the install path.
2732 To get a listing, use
2733 .B "mkisofs \-input\-charset help."
2734 .PP
2735 Additional character sets from
2736 .BR iconv (1)
2737 may be used on systems, that support
2738 .BR iconv (1).
2739 In this case, call
2740 .B "iconv \-l"
2741 to get a list of valid character sets from this coding method.
2742 To force an
2743 .BR iconv (1)
2744 based coding, use
2745 .BI iconv: name
2746 instead of
2747 .I name
2748 for the character set.
2749 .PP
2750 If using non
2751 .BR iconv (1)
2752 based character sets,
2753 additional character sets can be read from file for any of the character
2754 set options by giving a filename as the argument to the options. A given
2755 character set will be read from a file whenever the supplied name contains
2756 a '/'.
2757 .PP
2758 The format of the character set files is the same as the mapping files
2759 available from http://www.unicode.org/Public/MAPPINGS The format of these
2760 files is:
2761
2762 Column #1 is the input byte code (in hex as 0xXX)
2763 .br
2764 Column #2 is the Unicode (in hex as 0xXXXX)
2765 .br
2766 Rest of the line is ignored.
2767
2768 Any blank line, line without two (or more) columns in the above format
2769 or comments lines (starting with the # character) are ignored without any
2770 warnings. Any missing input code is mapped to Unicode character 0x0000.
2771 .PP
2772 Note that there is no support for 16 bit UNICODE (UTF-16) or 32 bit UNICODE
2773 (UTF-32) coding because this coding is not POSIX compliant. There should
2774 be support for UTF-8 UNICODE coding which is compatible to POSIX filenames
2775 and supported by modern UNIX implementations such as Solaris.
2776 .PP
2777 A 1:1 character set mapping can be defined by using the keyword
2778 .I default
2779 as the argument to any of the character set options. This is the behaviour
2780 of older (v1.12) versions of
2781 .BR mkisofs .
2782 .PP
2783 The ISO-9660 file names generated from the input filenames are not converted
2784 from the input character set. The ISO-9660 character set is a very limited
2785 subset of the ASCII characters, so any conversion would be pointless.
2786 .PP
2787 Any character that
2788 .B mkisofs
2789 can not convert will be replaced with a '_' character.
2790 .PP
2791 .SH "HFS CREATOR/TYPE"
2792 A Macintosh file has two properties associated with it which define
2793 which application created the file, the
2794 .I CREATOR
2795 and what data the file contains, the
2796 .IR TYPE .
2797 Both are (exactly) 4 letter strings. Usually this
2798 allows a Macintosh user to double-click on a file and launch the correct
2799 application etc. The CREATOR and TYPE of a particular file can be found by
2800 using something like ResEdit (or similar) on a Macintosh.
2801 .LP
2802 The CREATOR and TYPE information is stored in all the various Apple/Unix
2803 encoded files.
2804 For other files it is possible to base the CREATOR and TYPE on the
2805 filename's extension using a
2806 .I mapping
2807 file (the
2808 .B \-map
2809 option) and/or using the
2810 .I magic number
2811 (usually a
2812 .I signature
2813 in the first few bytes)
2814 of a file (the
2815 .B \-magic
2816 option). If both these options are given, then their order on the command
2817 line is important. If the
2818 .B \-map
2819 option is given first, then a filename extension match is attempted
2820 before a magic number match. However, if the
2821 .B \-magic
2822 option is given first, then a magic number match is attempted before a
2823 filename extension match.
2824 .PP
2825 If a mapping or magic file is not used, or no match is found then the default
2826 CREATOR and TYPE for all regular files can be set by using entries in the
2827 .B \&.m\&kisofsrc
2828 file or using the
2829 .B \-hfs\-creator
2830 and/or
2831 .B \-hfs\-type
2832 options, otherwise the default CREATOR and TYPE are 'unix' and 'TEXT'.
2833 .PP
2834 The format of the
2835 .I mapping
2836 file is the same
2837 .I afpfile
2838 format as used by
2839 .IR aufs .
2840 This file has five columns for the
2841 .IR extension ,
2842 .I file
2843 .IR translation ,
2844 .IR CREATOR ,
2845 .I TYPE
2846 and
2847 .IR Comment .
2848 Lines starting with the '#' character are
2849 comment lines and are ignored. An example file would be like:
2850 .LP
2851 .TS
2852 tab (/);
2853 l s s s s
2854 l s s s s
2855 l l l l l .
2856 # Example filename mapping file
2857 #
2858 # EXTN/XLate/CREATOR/TYPE/Comment
2859 \&.tif/Raw/'8BIM'/'TIFF'/"Photoshop TIFF image"
2860 \&.hqx/Ascii/'BnHq'/'TEXT'/"BinHex file"
2861 \&.doc/Raw/'MSWD'/'WDBN'/"Word file"
2862 \&.mov/Raw/'TVOD'/'MooV'/"QuickTime Movie"
2863 */Ascii/'ttxt'/'TEXT'/"Text file"
2864 .TE
2865 .LP
2866 Where:
2867 .IP
2868 The first column
2869 .I EXTN
2870 defines the Unix filename extension to be
2871 mapped. The default mapping for any filename extension that doesn't
2872 match is defined with the "*" character.
2873 .IP
2874 The
2875 .I Xlate
2876 column defines the type of text translation between the Unix and
2877 Macintosh file it is ignored by
2878 .BR mkisofs ,
2879 but is kept to be compatible with
2880 .BR aufs (1).
2881 Although
2882 .B mkisofs
2883 does not alter the contents of a file, if a binary file has its TYPE
2884 set as 'TEXT', it
2885 .I may
2886 be read incorrectly on a Macintosh. Therefore a better choice for the
2887 default TYPE may be '????'
2888 .IP
2889 The
2890 .I CREATOR
2891 and
2892 .I TYPE
2893 keywords must be 4 characters long and enclosed in single quotes.
2894 .IP
2895 The comment field is enclosed in double quotes - it is ignored by
2896 .BR mkisofs ,
2897 but is kept to be compatible with
2898 .BR aufs .
2899 .PP
2900 The format of the
2901 .I magic
2902 file is almost identical to the
2903 .BR magic (5)
2904 file used by the Linux
2905 .BR file (1)
2906 command - the routines for reading and decoding the
2907 .I magic
2908 file are based on the Linux
2909 .BR file (1)
2910 command.
2911 .PP
2912 This file has four tab separated columns for the
2913 .I byte
2914 .IR offset ,
2915 .IR type ,
2916 .I test
2917 and
2918 .IR message .
2919 Lines starting with the '#' character are
2920 comment lines and are ignored. An example file would be like:
2921 .LP
2922 .TS
2923 tab (/);
2924 l s s s
2925 l s s s
2926 l l l l .
2927 # Example magic file
2928 #
2929 # off/type/test/message
2930 0/string/GIF8/8BIM GIFf GIF image
2931 0/beshort/0xffd8/8BIM JPEG image data
2932 0/string/SIT!/SIT! SIT! StuffIt Archive
2933 0/string/\e037\e235/LZIV ZIVU standard unix compress
2934 0/string/\e037\e213/GNUz ZIVU gzip compressed data
2935 0/string/%!/ASPS TEXT Postscript
2936 0/string/\e004%!/ASPS TEXT PC Postscript with a ^D to start
2937 4/string/moov/txtt MooV QuickTime movie file (moov)
2938 4/string/mdat/txtt MooV QuickTime movie file (mdat)
2939 .TE
2940 .PP
2941 The format of the file is described in the
2942 .BR magic (5)
2943 man page. The only difference here is that for each entry in the magic file, the
2944 .I message
2945 for the initial offset
2946 .B must
2947 be 4 characters for the CREATOR followed by 4 characters for the TYPE -
2948 white space is
2949 optional between them. Any other characters on this line are ignored.
2950 Continuation lines (starting with a '>') are also ignored i.e. only the initial
2951 offset lines are used.
2952 .PP
2953 Using the
2954 .B \-magic
2955 option may significantly increase processing time as each file has to opened
2956 and read to find its magic number.
2957 .PP
2958 In summary, for all files, the default CREATOR is 'unix' and the default
2959 TYPE is 'TEXT'. These can be changed by using entries in the
2960 .I \&.m\&kisofsrc
2961 file or by using the
2962 .B \-hfs\-creator
2963 and/or
2964 .B \-hfs\-type
2965 options.
2966 .PP
2967 If the a file is in one of the known Apple/Unix formats (and the format
2968 has been selected), then the CREATOR and TYPE are taken from the values
2969 stored in the Apple/Unix file.
2970 .PP
2971 Other files can have their CREATOR and TYPE set from their file name
2972 extension (the
2973 .B \-map
2974 option), or their magic number (the
2975 .B \-magic
2976 option). If the default match is used in the
2977 .I mapping
2978 file, then these values override the default CREATOR and TYPE.
2979 .PP
2980 A full CREATOR/TYPE database can be found at
2981 http://www.angelfire.com/il/szekely/index.html
2982
2983 .SH "HFS MACINTOSH FILE FORMATS"
2984 Macintosh files have two parts called the
2985 .I Data
2986 and
2987 .I Resource
2988 fork. Either may be empty. Unix (and many other OSs) can only
2989 cope with files having one part (or fork). To add to this, Macintosh files
2990 have a number of attributes associated with them - probably the most
2991 important are the TYPE and CREATOR. Again Unix has no concept of these
2992 types of attributes.
2993 .PP
2994 e.g. a Macintosh file may be a JPEG image where the image is stored in the
2995 Data fork and a desktop thumbnail stored in the Resource fork. It is usually
2996 the information in the data fork that is useful across platforms.
2997 .PP
2998 Therefore to store a Macintosh file on a Unix filesystem, a way has to be
2999 found to cope with the two forks and the extra attributes (which are
3000 referred to as the
3001 .I finder
3002 .IR info ).
3003 Unfortunately, it seems that every software package that stores Macintosh
3004 files on Unix has chosen a completely different storage method.
3005 .PP
3006 The Apple/Unix formats that
3007 .I mkisofs
3008 (partially) supports are:
3009 .TP
3010 .B "CAP AUFS format"
3011 Data fork stored in a file. Resource fork in subdirectory .resource
3012 with same filename as data fork. Finder info
3013 in .finderinfo subdirectory with same filename.
3014 .TP
3015 .B "AppleDouble/Netatalk"
3016 Data fork stored in a file. Resource fork stored in a file with
3017 same name prefixed with "%". Finder info also stored in same
3018 "%" file. Netatalk uses the same format, but the resource
3019 fork/finderinfo stored in subdirectory .AppleDouble with same
3020 name as data fork.
3021 .TP
3022 .B AppleSingle
3023 Data structures similar to above, except both forks and finder
3024 info are stored in one file.
3025 .TP
3026 .B "Helios EtherShare"
3027 Data fork stored in a file. Resource fork and finder info together in
3028 subdirectory .rsrc with same filename as data fork.
3029 .TP
3030 .B "IPT UShare"
3031 Very similar to the EtherShare format, but the finder info
3032 is stored slightly differently.
3033 .TP
3034 .B MacBinary
3035 Both forks and finder info stored in one file.
3036 .TP
3037 .B "Apple PC Exchange"
3038 Used by Macintoshes to store Apple files on DOS (FAT) disks.
3039 Data fork stored in a file. Resource fork in subdirectory
3040 resource.frk (or RESOURCE.FRK). Finder info as one record
3041 in file finder.dat (or FINDER.DAT). Separate finder.dat for
3042 each data fork directory.
3043 .IP
3044 Note:
3045 .I mkisofs
3046 needs to know the native FAT cluster size of the disk that the PC Exchange
3047 files are on (or have been copied from). This size is given by the
3048 .B \-cluster\-size
3049 option.
3050 The cluster or allocation size can be found by using the DOS utility
3051 .BR CHKDSK .
3052 .IP
3053 May not work with PC Exchange v2.2 or higher files (available with MacOS 8.1).
3054 DOS media containing PC Exchange files should be mounted as type
3055 .B msdos
3056 (not
3057 .BR vfat )
3058 when using Linux.
3059 .TP
3060 .B "SGI/XINET"
3061 Used by SGI machines when they mount HFS disks. Data fork stored
3062 in a file. Resource fork in subdirectory .HSResource with same
3063 name. Finder info as one record in file .HSancillary. Separate .HSancillary
3064 for each data fork directory.
3065 .TP
3066 .B "Thursby Software Systems DAVE"
3067 Allows Macintoshes to store Apple files on SMB servers.
3068 Data fork stored in a file. Resource fork in subdirectory
3069 resource.frk. Uses the AppleDouble format to store resource fork.
3070 .TP
3071 .B "Services for Macintosh"
3072 Format of files stored by NT Servers on NTFS filesystems. Data fork is
3073 stored as "filename". Resource fork stored as a NTFS
3074 .I stream
3075 called "filename:AFP_Resource". The finder info is stored as a NTFS
3076 .I stream
3077 called "filename:Afp_AfpInfo". These streams are normally invisible to the
3078 user.
3079 .IP
3080 Warning: mkisofs only partially supports the SFM format. If an HFS file
3081 or folder stored on the NT server contains an
3082 .I illegal
3083 NT character in its name, then NT converts these characters to
3084 .I Private Use Unicode
3085 characters. The characters are: " * / < > ? \ | also a space or
3086 .\" " <-- hack for emacs. please keep.
3087 period if it is the last character of the file name, character codes 0x01
3088 to 0x1f (control characters) and Apple' apple logo.
3089 .IP
3090 Unfortunately, these private Unicode characters are not
3091 readable by the mkisofs NT executable. Therefore any file or directory
3092 name containing these characters will be ignored - including the contents of
3093 any such directory.
3094 .TP
3095 .B "MacOS X AppleDouble"
3096 When HFS/HFS+ files are copied or saved by MacOS X on to a non-HFS file
3097 system (e.g. UFS, NFS etc.), the files are stored in AppleDouble format.
3098 Data fork stored in a file. Resource fork stored in a file with
3099 same name prefixed with "._". Finder info also stored in same "._" file.
3100 .TP
3101 .B "MacOS X HFS (Alpha)"
3102 Not really an Apple/Unix encoding, but actual HFS/HFS+ files on a MacOS X
3103 system. Data fork stored in a file. Resource fork stored in a pseudo file
3104 with the same name with the suffix '/rsrc'. The finderinfo is only
3105 available via a MacOS X library call.
3106 .IP
3107 Notes: (also see README.macosx)
3108 .IP
3109 Only works when used on MacOS X.
3110 .IP
3111 If a file is found with a zero
3112 length resource fork and empty finderinfo, it is assumed not to have
3113 any Apple/Unix encoding - therefore a TYPE and CREATOR can be set using
3114 other methods.
3115 .LP
3116 .I mkisofs
3117 will attempt to set the CREATOR, TYPE, date and possibly other flags from
3118 the finder info. Additionally, if it exists, the Macintosh filename is set
3119 from the finder info, otherwise the Macintosh name is based on the Unix
3120 filename - see the
3121 .B "HFS MACINTOSH FILE NAMES"
3122 section below.
3123 .PP
3124 When using the
3125 .B \-apple
3126 option, the TYPE and CREATOR are stored in the optional System Use or SUSP field
3127 in the ISO-9660 Directory Record - in much the same way as the Rock Ridge
3128 attributes are. In fact to make life easy, the Apple extensions are added
3129 at the beginning of the existing Rock Ridge attributes (i.e. to get the Apple
3130 extensions you get the Rock Ridge extensions as well).
3131 .PP
3132 The Apple extensions require the resource fork to be stored as an ISO-9660
3133 .I associated
3134 file. This is just like any normal file stored in the ISO-9660 filesystem
3135 except that the associated file flag is set in the Directory Record (bit
3136 2). This file has the same name as the data fork (the file seen by
3137 non-Apple machines). Associated files are normally ignored by other OSs
3138 .PP
3139 When using the
3140 .B \-hfs
3141 option, the TYPE and CREATOR plus other finder info, are stored in a separate
3142 HFS directory, not visible on the ISO-9660 volume. The HFS directory references
3143 the same data and resource fork files described above.
3144 .PP
3145 In most cases, it is better to use the
3146 .B \-hfs
3147 option instead of the
3148 .B \-apple
3149 option, as the latter imposes the limited ISO-9660 characters allowed in
3150 filenames. However, the Apple extensions do give the advantage that the
3151 files are packed on the disk more efficiently and it may be possible to fit
3152 more files on a CD - important when the total size of the source files is
3153 approaching 650MB.
3154
3155 .SH "HFS MACINTOSH FILE NAMES"
3156 Where possible, the HFS filename that is stored with an Apple/Unix file
3157 is used for the HFS part of the CD. However, not all the Apple/Unix
3158 encodings store the HFS filename with the finderinfo. In these cases,
3159 the Unix filename is used - with escaped special characters. Special
3160 characters include '/' and characters with codes over 127.
3161 .PP
3162 Aufs escapes these characters by using ":" followed by the character code
3163 as two hex digits. Netatalk and EtherShare have a similar scheme, but uses
3164 "%" instead of a ":".
3165 .PP
3166 If mkisofs can't find an HFS filename, then it uses the Unix name, with
3167 any %xx or :xx characters (xx == two hex digits) converted to a single
3168 character code. If "xx" are not hex digits ([0-9a-fA-F]), then they are
3169 left alone - although any remaining ":" is converted to "%" as colon
3170 is the HFS directory separator. Care must be taken, as an ordinary Unix
3171 file with %xx or :xx will also be converted. e.g.
3172 .PP
3173 .TS
3174 l l
3175 l s
3176 l l
3177 l s
3178 l l .
3179 This:2fFile converted to This/File
3180
3181 This:File converted to This%File
3182
3183 This:t7File converted to This%t7File
3184 .TE
3185 .PP
3186 Although HFS filenames appear to support upper and lower case letters,
3187 the filesystem is case insensitive. i.e. the filenames "aBc" and "AbC"
3188 are the same. If a file is found in a directory with the same HFS name,
3189 then
3190 .I mkisofs
3191 will attempt, where possible, to make a unique name by adding '_' characters
3192 to one of the filenames.
3193 .PP
3194 If an HFS filename exists for a file, then mkisofs can use this name as
3195 the starting point for the ISO-9660, Joliet and Rock Ridge filenames using
3196 the
3197 .B \-mac\-name
3198 option. Normal Unix files without an HFS name will still use their Unix name.
3199 e.g.
3200 .PP
3201 If a
3202 .I MacBinary
3203 (or
3204 .I PC
3205 .IR Exchange )
3206 file is stored as
3207 .I someimage.gif.bin
3208 on the Unix filesystem, but contains a HFS file called
3209 .IR someimage.gif ,
3210 then this is the name that would appear on the HFS part of the CD. However, as
3211 mkisofs uses the Unix name as the starting point for the other names, then
3212 the ISO-9660 name generated will probably be
3213 .I SOMEIMAG.BIN
3214 and the Joliet/Rock Ridge would be
3215 .IR someimage.gif.bin .
3216 Although the actual data (in this case) is a GIF image. This option will use
3217 the HFS filename as the starting point and the ISO-9660 name will probably be
3218 .I SOMEIMAG.GIF
3219 and the Joliet/Rock Ridge would be
3220 .IR someimage.gif .
3221 .PP
3222 Using the
3223 .B \-mac\-name
3224 option will not currently work with the
3225 .B \-T
3226 option - the Unix
3227 name will be used in the TRANS.TBL file, not the Macintosh name.
3228 .PP
3229 The character set used to convert any HFS file name to a Joliet/Rock Ridge
3230 file name defaults to
3231 .I macintosh
3232 (Mac Roman).
3233 The character set used can be specified using the
3234 .I \-input\-hfs\-charset
3235 option. Other built in HFS character sets are:
3236 MAC-CYRILLIC (MacCyrillic), MAC-CENTRALEUROPE (MacLatin2), MAC-IS (MacIcelandic).
3237 .PP
3238 Note: the character codes used by HFS file names taken from the various
3239 Apple/Unix formats will not be converted as they are assumed to be in the
3240 correct Apple character set. Only the Joliet/Rock Ridge names derived from
3241 the HFS file names will be converted.
3242 .PP
3243 The existing mkisofs code will filter out any illegal characters for the
3244 ISO-9660 and Joliet filenames, but as mkisofs expects to be dealing
3245 directly with Unix names, it leaves the Rock Ridge names as is.
3246 But as '/' is a legal HFS filename character, the
3247 .B \-mac\-name
3248 option converts '/' to a '_' in Rock Ridge filenames.
3249 .PP
3250 If the Apple extensions are used, then only the ISO-9660 filenames will
3251 appear on the Macintosh. However, as the Macintosh ISO-9660 drivers can use
3252 .I Level 2
3253 filenames, then you can use options like
3254 .B \-allow\-multidot
3255 without problems on
3256 a Macintosh - still take care over the names, for example
3257 .I this.file.name
3258 will be converted to
3259 .I THIS.FILE
3260 i.e. only have one '.', also filename
3261 .I abcdefgh
3262 will be seen as
3263 .I ABCDEFGH
3264 but
3265 .I abcdefghi
3266 will be seen as
3267 .I ABCDEFGHI.
3268 i.e. with a '.' at the end - don't know if this is a Macintosh
3269 problem or m\&kisofs/mkhybrid problem. All filenames will be in upper case
3270 when viewed on a Macintosh. Of course, DOS/Win3.X machines will not be able
3271 to see Level 2 filenames...
3272
3273 .SH "HFS CUSTOM VOLUME/FOLDER ICONS"
3274 To give a HFS CD a custom icon, make sure the root (top level) folder includes
3275 a standard Macintosh volume icon file. To give a volume a custom icon on
3276 a Macintosh, an icon has to be pasted over the volume's icon in the "Get Info"
3277 box of the volume. This creates an invisible file called 'Icon\er' ('\er' is
3278 the 'carriage return' character) in the root folder.
3279 .P
3280 A custom folder icon is very similar - an invisible file called 'Icon\er'
3281 exits in the folder itself.
3282 .P
3283 Probably the easiest way to create a custom icon that mkisofs can use, is to
3284 format a blank HFS floppy disk on a Mac, paste an icon to its "Get Info"
3285 box. If using Linux with the HFS module installed, mount the floppy using
3286 something like:
3287
3288 mount \-t hfs /dev/fd0 /mnt/floppy
3289
3290 The floppy will be mounted as a CAP file system by default. Then run mkisofs
3291 using something like:
3292
3293 mkisofs \-\-cap \-o output source_dir /mnt/floppy
3294
3295 If you are not using Linux, then you can use the hfsutils to copy the icon
3296 file from the floppy. However, care has to be taken, as the icon file
3297 contains a control character. e.g.
3298
3299 hmount /dev/fd0
3300 .br
3301 hdir \-a
3302 .br
3303 hcopy \-m Icon^V^M icon_dir/icon
3304
3305 Where '^V^M' is control\-V followed by control\-M. Then run
3306 .B mkisofs
3307 by using something like:
3308
3309 mkisofs \-\-macbin \-o output source_dir icon_dir
3310 .PP
3311 The procedure for creating/using custom folder icons is very similar - paste
3312 an icon to folder's "Get Info" box and transfer the resulting 'Icon\er'
3313 file to the relevant directory in the mkisofs source tree.
3314 .PP
3315 You may want to hide the icon files from the ISO-9660 and Joliet trees.
3316 .PP
3317 To give a custom icon to a Joliet CD, follow the instructions found at:
3318 http://www.fadden.com/cdrfaq/faq03.html#[3-21]
3319
3320 .SH "HFS BOOT DRIVER"
3321 It
3322 .I may
3323 be possible to make the hybrid CD bootable on a Macintosh.
3324 .PP
3325 A bootable HFS CD requires an Apple CD-ROM (or compatible) driver, a bootable
3326 HFS partition and the necessary System, Finder, etc. files.
3327 .PP
3328 A driver can be obtained from any other Macintosh bootable CD-ROM using the
3329 .I apple_driver
3330 utility. This file can then be used with the
3331 .B \-boot\-hfs\-file
3332 option.
3333 .PP
3334 The HFS partition (i.e. the hybrid disk in our case) must contain a
3335 suitable System Folder, again from another CD-ROM or disk.
3336 .PP
3337 For a partition to be bootable, it must have its
3338 .I boot block
3339 set. The boot
3340 block is in the first two blocks of a partition. For a non-bootable partition
3341 the boot block is full of zeros. Normally, when a System file is copied to
3342 partition on a Macintosh disk, the boot block is filled with a number of
3343 required settings - unfortunately I don't know the full spec for the boot
3344 block, so I'm guessing that the following will work OK.
3345 .PP
3346 Therefore, the utility
3347 .I apple_driver
3348 also extracts the boot block from the
3349 first HFS partition it finds on the given CD-ROM and this is used for the
3350 HFS partition created by
3351 .BR mkisofs .
3352 .TP
3353 .B "PLEASE NOTE"
3354 By using a driver from an Apple CD and copying Apple software to your CD,
3355 you become liable to obey Apple Computer, Inc. Software License Agreements.
3356 .SH "EL TORITO BOOT INFORMATION TABLE"
3357 When the
3358 .B \-boot\-info\-table
3359 option is given,
3360 .B mkisofs
3361 will modify the boot file specified by the
3362 .B \-b
3363 option by inserting a 56-byte "boot information table" at offset 8 in
3364 the file. This modification is done in the source filesystem, so make
3365 sure you use a copy if this file is not easily recreated! This file
3366 contains pointers which may not be easily or reliably obtained at boot
3367 time.
3368 .PP
3369 The format of this table is as follows; all integers are in
3370 section 7.3.1 ("little endian") format.
3371 .sp
3372 .RS +.2i
3373 .ta 1.0i 2.5i 3.5i
3374 .nf
3375 Offset Name Size Meaning
3376 8 bi_pvd 4 bytes LBA of primary volume descriptor
3377 12 bi_file 4 bytes LBA of boot file
3378 16 bi_length 4 bytes Boot file length in bytes
3379 20 bi_csum 4 bytes 32-bit checksum
3380 24 bi_reserved 40 bytes Reserved
3381 .fi
3382 .RE
3383 .sp
3384 The 32-bit checksum is the sum of all the 32-bit words in the boot
3385 file starting at byte offset 64. All linear block addresses (LBAs)
3386 are given in CD sectors (normally 2048 bytes).
3387 .SH CONFIGURATION
3388 .B mkisofs
3389 looks for the
3390 .B \&.m\&kisofsrc
3391 file,
3392 first in the current working directory,
3393 then in the user's home directory,
3394 and then in the directory in which the
3395 .B mkisofs
3396 binary is stored. This file is assumed to contain a series of lines
3397 of the form
3398 .BI TAG= value
3399 , and in this way you can specify certain options.
3400 The case of the tag is not significant.
3401 Some fields in the volume header
3402 are not settable on the command line, but can be altered through this
3403 facility.
3404 Comments may be placed in this file,
3405 using lines which start with a hash (#) character.
3406 .TP
3407 .B APPI
3408 The application identifier
3409 should describe the application that will be on the disc.
3410 There is space on the disc for 128 characters of information.
3411 The related Joliet entry is limited to 64 characters.
3412 May be overridden using the
3413 .B \-A
3414 command line option.
3415 .TP
3416 .B COPY
3417 The copyright information,
3418 often the name of a file on the disc containing the copyright notice.
3419 There is space in the disc for 37 characters of information.
3420 The related Joliet entry is limited to 18 characters.
3421 May be overridden using the
3422 .B \-copyright
3423 command line option.
3424 .TP
3425 .B ABST
3426 The abstract information,
3427 often the name of a file on the disc containing an abstract.
3428 There is space in the disc for 37 characters of information.
3429 The related Joliet entry is limited to 18 characters.
3430 May be overridden using the
3431 .B \-abstract
3432 command line option.
3433 .TP
3434 .B BIBL
3435 The bibliographic information,
3436 often the name of a file on the disc containing a bibliography.
3437 There is space in the disc for 37 characters of information.
3438 The related Joliet entry is limited to 18 characters.
3439 May be overridden using the
3440 .B \-bilio
3441 command line option.
3442 .TP
3443 .B PREP
3444 This should describe the preparer of the CDROM,
3445 usually with a mailing address and phone number.
3446 There is space on the disc for 128 characters of information.
3447 The related Joliet entry is limited to 64 characters.
3448 May be overridden using the
3449 .B \-p
3450 command line option.
3451 .TP
3452 .B PUBL
3453 This should describe the publisher of the CDROM,
3454 usually with a mailing address and phone number.
3455 There is space on the disc for 128 characters of information.
3456 The related Joliet entry is limited to 64 characters.
3457 May be overridden using the
3458 .B \-publisher
3459 command line option.
3460 .TP
3461 .B SYSI
3462 The System Identifier.
3463 There is space on the disc for 32 characters of information.
3464 May be overridden using the
3465 .B \-sysid
3466 command line option.
3467 .TP
3468 .B VOLI
3469 The Volume Identifier.
3470 There is space on the disc for 32 characters of information.
3471 May be overridden using the
3472 .B \-V
3473 command line option.
3474 .TP
3475 .B VOLS
3476 The Volume Set Name.
3477 There is space on the disc for 128 characters of information.
3478 The related Joliet entry is limited to 64 characters.
3479 May be overridden using the
3480 .B \-volset
3481 command line option.
3482 .TP
3483 .B HFS_TYPE
3484 The default TYPE for Macintosh files. Must be exactly 4 characters.
3485 May be overridden using the
3486 .B \-hfs\-type
3487 command line option.
3488 .TP
3489 .B HFS_CREATOR
3490 The default CREATOR for Macintosh files. Must be exactly 4 characters.
3491 May be overridden using the
3492 .B \-hfs\-creator
3493 command line option.
3494 .PP
3495 .B mkisofs
3496 can also be configured at compile time with defaults for many of these fields.
3497 See the file defaults.h.
3498
3499 .SH EXAMPLES
3500 .PP
3501 To create a vanilla ISO-9660 filesystem image in the file
3502 .IR cd.iso ,
3503 where the directory
3504 .I cd_dir
3505 will become the root directory of the CD ISO image, call:
3506 .PP
3507 % mkisofs \-o cd.iso cd_dir
3508 .PP
3509 To create a CD with Rock Ridge extensions of
3510 the source directory
3511 .IR cd_dir :
3512 .PP
3513 % mkisofs \-o cd.iso \-R cd_dir
3514 .PP
3515 To create a CD with Rock Ridge extensions of
3516 the source directory
3517 .I cd_dir
3518 where all files have at least read permission and all files
3519 are owned by
3520 .IR root ,
3521 call:
3522 .PP
3523 % mkisofs \-o cd.iso \-r cd_dir
3524 .PP
3525 To write a tar archive directly to a CD that will later contain a simple
3526 ISO-9660 filesystem with the tar archive call:
3527 .PP
3528 % star \-c . | mkisofs \-stream\-media\-size 333000 | \e
3529 .br
3530 cdrecord dev=b,t,l \-dao tsize=333000s \-
3531 .PP
3532 To create a HFS hybrid CD with the Joliet and Rock Ridge extensions of
3533 the source directory
3534 .IR cd_dir :
3535 .PP
3536 % mkisofs \-o cd.iso \-R \-J \-hfs cd_dir
3537 .PP
3538 To create a HFS hybrid CD from the source directory
3539 .I cd_dir
3540 that contains
3541 Netatalk Apple/Unix files:
3542 .PP
3543 % mkisofs \-o cd.iso \-\-netatalk cd_dir
3544 .PP
3545 To create a HFS hybrid CD from the source directory
3546 .IR cd_dir ,
3547 giving all files
3548 CREATOR and TYPES based on just their filename extensions listed in the file
3549 "mapping".:
3550 .PP
3551 % mkisofs \-o cd.iso \-map mapping cd_dir
3552 .PP
3553 To create a CD with the 'Apple Extensions to ISO-9660', from the source
3554 directories
3555 .I cd_dir
3556 and
3557 .IR another_dir.
3558 Files in all the known Apple/Unix format
3559 are decoded and any other files are given CREATOR and TYPE based on their
3560 magic number given in the file "magic":
3561 .PP
3562 % mkisofs \-o cd.iso \-apple \-magic magic \-probe \e
3563 .br
3564 cd_dir another_dir
3565 .PP
3566 The following example puts different files on the CD that all have
3567 the name README, but have different contents when seen as a
3568 ISO-9660/RockRidge, Joliet or HFS CD.
3569 .PP
3570 Current directory contains:
3571 .PP
3572 % ls \-F
3573 .br
3574 README.hfs README.joliet README.unix cd_dir/
3575 .PP
3576 The following command puts the contents of the directory
3577 .I cd_dir
3578 on the
3579 CD along with the three README files - but only one will be seen from
3580 each of the three filesystems:
3581 .PP
3582 % mkisofs \-o cd.iso \-hfs \-J \-r \-graft\-points \e
3583 .br
3584 \-hide README.hfs \-hide README.joliet \e
3585 .br
3586 \-hide\-joliet README.hfs \-hide\-joliet README.unix \e
3587 .br
3588 \-hide\-hfs README.joliet \-hide\-hfs README.unix \e
3589 .br
3590 README=README.hfs README=README.joliet \e
3591 .br
3592 README=README.unix cd_dir
3593 .PP
3594 i.e. the file README.hfs will be seen as README on the HFS CD and the
3595 other two README files will be hidden. Similarly for the Joliet and
3596 ISO-9660/RockRidge CD.
3597 .PP
3598 There are probably all sorts of strange results possible with
3599 combinations of the hide options ...
3600 .PP
3601 To create a DVD-Audio of the DVD-Audio compliant source directory
3602 .IR DVD :
3603 .PP
3604 % mkisofs \-o dvda.iso \-dvd\-audio DVD
3605
3606 .SH NOTES
3607 .PP
3608 .B Mkisofs
3609 may safely be installed suid root. This may be needed to allow
3610 .B mkisofs
3611 to read the previous session when creating a multi session image.
3612 .PP
3613 .B m\&kisofs
3614 is not based on the standard mk*fs tools for unix, because we must generate
3615 a complete copy of an existing filesystem on a disk in the ISO-9660
3616 filesystem. The name m\&kisofs is probably a bit of a misnomer, since it
3617 not only creates the filesystem, but it also populates it as well.
3618 However, the appropriate tool name for a UNIX tool that creates populated
3619 filesystems -
3620 .B mkproto
3621 - is not well known.
3622 .PP
3623 If
3624 .B mkisofs
3625 is creating a filesystem image with Rock Ridge attributes and the
3626 directory nesting level of the source directory tree is too much
3627 for ISO-9660,
3628 .B mkisofs
3629 will do deep directory relocation.
3630 This results in a directory called
3631 .B RR_MOVED
3632 in the root directory of the CD. You cannot avoid this directory in the
3633 directory tree that is visible with ISO-9660 but it it automatically hidden
3634 in the
3635 .B Rock Ridge
3636 tree.
3637 .PP
3638 The sparc boot support that is implemented with the
3639 .B \-sparc\-boot
3640 options completely follows the official Sparc CD boot requirements from
3641 the Boot prom in Sun Sparc systems. Some Linux distributions for Sparc
3642 systems use a boot loader called
3643 .B SILO
3644 that unfortunately is not Sparc CD boot compliant.
3645 It is annoyingly to see that the Authors of SILO don't fix SILO but instead
3646 provide a completely unneeded "patch" to mkisofs that incorporates far
3647 more source than the fix for SILO would need.
3648 .SH BUGS
3649 .TP
3650 \(bu
3651 Does not properly read relocated directories in multi-session
3652 mode when adding data.
3653 .sp
3654 Any relocated deep directory is lost if the new session does not
3655 include the deep directory.
3656 .sp
3657 Repeat by: create first session with deep directory relocation
3658 then add new session with a single dir that differs from the
3659 old deep path.
3660 .TP
3661 \(bu
3662 Does not re-use RR_MOVED when doing multi-session from TRANS.TBL
3663 .PP
3664
3665 Mail bugs and suggestions to
3666 .B [email protected]
3667 or open a ticket at
3668 .BR https://codeberg.org/schilytools/schilytools/issues .
3669 .PP
3670 The mailing list archive may be found at
3671 .PP
3672 .nf
3673 .BR https://mlists.in-berlin.de/mailman/listinfo/schilytools-mlists.in-berlin.de .
3674 .fi
3675
3676 .SH "HFS PROBLEMS/LIMITATIONS"
3677 I have had to make several assumptions on how I expect the modified
3678 libhfs routines to work, however there may be situations that either
3679 I haven't thought of, or come across when these assumptions fail.
3680 Therefore I can't guarantee that mkisofs will work as expected
3681 (although I haven't had a major problem yet). Most of the HFS features work
3682 fine, however, some are not fully tested. These are marked as
3683 .I Alpha
3684 above.
3685 .PP
3686 Although HFS filenames appear to support upper and lower case letters,
3687 the filesystem is case insensitive. i.e. the filenames "aBc" and "AbC"
3688 are the same. If a file is found in a directory with the same HFS name, then
3689 .I mkisofs
3690 will attempt, where possible, to make a unique name by adding '_' characters
3691 to one of the filenames.
3692 .PP
3693 HFS file/directory names that share the first 31 characters have
3694 _N' (N == decimal number) substituted for the last few characters
3695 to generate unique names.
3696 .PP
3697 Care must be taken when "grafting" Apple/Unix files or directories (see
3698 above for the method and syntax involved). It is not possible to use a
3699 new name for an Apple/Unix encoded file/directory. e.g. If a Apple/Unix
3700 encoded file called "oldname" is to added to the CD, then you can not use
3701 the command line:
3702 .IP
3703 mkisofs \-o output.raw \-hfs \-graft\-points newname=oldname cd_dir
3704 .LP
3705 mkisofs will be unable to decode "oldname". However, you can graft
3706 Apple/Unix encoded files or directories as long as you do not attempt to
3707 give them new names as above.
3708 .PP
3709 When creating an HFS volume with the multisession options,
3710 .B \-M
3711 and
3712 .BR \-C ,
3713 only files in the last session will be in the HFS volume. i.e. mkisofs can
3714 not
3715 .I add
3716 existing files from previous sessions to the HFS volume.
3717 .PP
3718 However, if each session is created with the
3719 .B \-part
3720 option, then each session will appear as
3721 separate volumes when mounted on a Mac. In this case, it is worth using the
3722 .B \-V
3723 or
3724 .B \-hfs\-volid
3725 option to give each session a unique volume name,
3726 otherwise each "volume" will appear on the Desktop with the same name.
3727 .PP
3728 Symbolic links (as with all other non-regular files) are not added to
3729 the HFS directory.
3730 .PP
3731 Hybrid volumes may be larger than pure ISO-9660 volumes
3732 containing the same data. In some cases (e.g. DVD sized volumes) the hybrid
3733 volume may be significantly larger. As an HFS volume gets bigger, so does the
3734 allocation block size (the smallest amount of space a file can occupy).
3735 For a 650Mb CD, the allocation block is 10Kb, for a 4.7Gb DVD it will be
3736 about 70Kb.
3737 .PP
3738 The maximum number of files in an HFS volume is about 65500 - although
3739 the real limit will be somewhat less than this.
3740 .PP
3741 The resulting hybrid volume can be accessed on a Unix machine by using
3742 the hfsutils routines. However, no changes can be made to the volume as it
3743 is set as
3744 .B locked.
3745 The option
3746 .B \-hfs\-unlock
3747 will create an output image that is unlocked - however no changes should be
3748 made to the contents of the volume (unless you really know what you are
3749 doing) as it's not a "real" HFS volume.
3750 .PP
3751 Using the
3752 .B \-mac\-name
3753 option will not currently work with the
3754 .B \-T
3755 option - the Unix
3756 name will be used in the TRANS.TBL file, not the Macintosh name.
3757 .PP
3758 Although
3759 .B mkisofs
3760 does not alter the contents of a file, if a binary file has its TYPE
3761 set as 'TEXT', it
3762 .I may
3763 be read incorrectly on a Macintosh. Therefore a better choice for the
3764 default TYPE may be '????'
3765 .PP
3766 The
3767 .B \-mac\-boot\-file
3768 option may not work at all...
3769 .PP
3770 May not work with PC Exchange v2.2 or higher files (available with MacOS 8.1).
3771 DOS media containing PC Exchange files should be mounted as type
3772 .B msdos
3773 (not
3774 .BR vfat )
3775 when using Linux.
3776 .PP
3777 The SFM format is only partially supported - see
3778 .B HFS MACINTOSH FILE FORMATS
3779 section above.
3780 .PP
3781 It is not possible to use the the
3782 .B \-sparc\-boot
3783 or
3784 .B \-generic\-boot
3785 options with the
3786 .B \-boot\-hfs\-file
3787 the
3788 .B \-prep\-boot
3789 or
3790 .B \-chrp\-boot
3791 options.
3792 .PP
3793 .B mkisofs
3794 should be able to create HFS hybrid images over 4Gb, although this has not
3795 been fully tested.
3796
3797 .SH "SEE ALSO"
3798 .BR cdrecord (1),
3799 .BR mkzftree (1),
3800 .BR sfind (1),
3801 .BR magic (5),
3802 .BR apple_driver (8).
3803
3804 .SH "FUTURE IMPROVEMENTS"
3805 Some sort of gui interface.
3806
3807 =======
3808 .SH AUTHORS
3809 .LP
3810 Eric Youngdale <[email protected]> or <[email protected]> wrote the
3811 first versions (1993 .\|.\|. 1998) of the m\&kisofs utility.
3812 The copyright for old versions of the m\&kisofs utility is held by
3813 Yggdrasil Computing, Incorporated.
3814 .LP
3815 J\*org Schilling wrote the SCSI transport library and its adaptation layer to
3816 .B mkisofs
3817 and newer parts (starting from 1997) of the utility.
3818 .LP
3819 J\*org Schilling was the primary author and maintainer since 1999, this makes
3820 .B mkisofs
3821 Copyright (C) 1997-2018 J\*org Schilling.
3822 .PP
3823 HFS hybrid code Copyright (C) James Pearson <[email protected]>
3824 1997 .\|.\|. 2001.
3825 .sp
3826 libhfs code Copyright (C) 1996, 1997 Robert Leslie.
3827 .sp
3828 libfile code Copyright (C) Ian F. Darwin 1986, 1987, 1989, 1990, 1991,
3829 1992, 1994, 1995.
3830
3831 .SH "SOURCE DOWNLOAD"
3832 The source code for
3833 .B mkisofs
3834 is included in the
3835 .B schilytools
3836 project and may be retrieved from the
3837 .B schilytools
3838 project at Codeberg at
3839 .LP
3840 .BR https://codeberg.org/schilytools/schilytools/ .
3841 .LP
3842 The download directory is
3843 .LP
3844 .BR https://codeberg.org/schilytools/schilytools/releases .
3845
3846 .SH "INTERFACE STABILITY"
3847 The interfaces provided by
3848 .B mkisofs
3849 are designed for long term stability.
3850 As
3851 .B mkisofs
3852 depends on interfaces provided by the underlying operating system,
3853 the stability of the interfaces offered by
3854 .B mkisofs
3855 depends on the interface stability of the OS interfaces.
3856 Modified interfaces in the OS may enforce modified interfaces
3857 in
3858 .BR mkisofs .