[DRWTSN32][SHIMDBG] Add missing va_end.
[reactos.git] / modules / rosapps / applications / devutils / cdmake / readme.txt
1 CD-ROM Maker
2 Philip J. Erdelsky
3
4 The CDMAKE utility converts files from DOS/Windows format to ISO9660
5 (CD-ROM) format.
6
7 First, gather all the files to be converted and put them into a single
8 base directory and its subdirectories, arranged just the way you want
9 them on the CD-ROM. Remember that ISO9660 allows subdirectories to be
10 nested only eight levels deep. Therefore, if the base directory is
11 C:\CDROM,
12
13 C:\CDROM\D2\D3\D4\D5\D6\D7\D8\FOO.TXT is permitted, but
14
15 C:\CDROM\D2\D3\D4\D5\D6\D7\D8\D9\FOO.TXT is forbidden.
16
17 Also, ISO9660 does not allow directories to have extensions, although
18 DOS does.
19
20 Finally, the characters in file and directory names and file extensions
21 must be letters, digits or underscores. Other punctuation marks
22 permitted by DOS/Windows are forbidden by ISO9660. You can use the -c
23 option to override this restriction, but the resulting CD-ROM may not be
24 readable on systems other than DOS/Windows.
25
26 Files in the base directory will be written to the root directory of the
27 CD-ROM image. All subdirectories of the base directory will appear as
28 subdirectories of the root directory of the CD-ROM image. Their
29 contents, and the contents of their subdirectories, down to the eighth
30 level, will be faithfully copied to the CD-ROM image.
31
32 System files will not be written to the CD-ROM image. Hidden files will
33 be written to the CD-ROM image, and will retain their hidden attributes.
34 Read-only files will be written, and will remain read-only on the
35 CD-ROM, but this does not distinguish them in any way, because on a
36 CD-ROM all files are read-only. The archive attribute will be lost.
37
38 File and directory date and time stamps will be preserved in the CD-ROM
39 image.
40
41 The utility is called up by a command line of the following form:
42
43 CDMAKE [-q] [-v] [-p] [-s N] [-m] [-j] [-b bootimage] source volume image
44
45 source specifications of base directory containing all files to
46 be written to CD-ROM image
47
48 volume volume label
49
50 image image file or device
51
52 -q quiet mode - display nothing but error messages
53
54 -v verbose mode - display file information as files are
55 scanned and written - overrides -p option
56
57 -p show progress while writing
58
59 -s N abort operation before beginning write if image will be
60 larger than N megabytes (i.e. 1024*1024*N bytes)
61
62 -m accept punctuation marks other than underscores in
63 names and extensions
64
65 -j generates Joliet filename records
66
67 -b bootimage create bootable ElTorito CD-ROM using 'no emulation' mode
68
69
70 The utility makes three passes over the source files:
71
72 (1) The scanning pass, in which the names and extensions are
73 checked for validity, and the names, extensions, sizes, dates,
74 times and attributes are recorded internally. The files are not
75 actually read during this pass.
76
77 (2) The layout pass, in which the sizes and positions of
78 directories, files and other items in the CD-ROM image are
79 determined.
80
81 (3) The writing pass, in which the files are actually read and the
82 CD-ROM image is actually written to the specified file or
83 device. The image is always written sequentially.
84
85 If neither the -q nor the -v option is used, CDMAKE will display the
86 volume label, size, number of files and directories and the total bytes
87 in each at the end of the layout pass.
88
89 If the -p option is used, and is not overridden by the -v option, then
90 during the writing pass, CDMAKE will display the number of bytes still
91 to be written to the CD-ROM image, updating it frequently. The number
92 will decrease as the operation progresses, and will reach zero when the
93 operation is complete.
94
95 The operation of CDMAKE can be aborted by typing Ctrl-C when the utility
96 is displaying text of any kind.