]> git.lizzy.rs Git - plan9front.git/blob - sys/man/8/mk9660
mk9660: add -E option to create EFI boot entry
[plan9front.git] / sys / man / 8 / mk9660
1 .TH MK9660 8
2 .SH NAME
3 dump9660, mk9660 \- create an ISO-9660 CD image
4 .SH SYNOPSIS
5 .B disk/mk9660
6 [
7 .B -:D
8 ]
9 [
10 .B -9cjr
11 ]
12 [
13 .B -b
14 .I bootfile
15 ]
16 [
17 .B -B
18 .I bootfile
19 ]
20 [
21 .B -E
22 .I bootfile
23 ]
24 [
25 .B -p
26 .I proto
27 ]
28 [
29 .B -s
30 src
31 ]
32 [
33 .B -v
34 volume
35 ]
36 .I image
37 .PP
38 .B disk/dump9660
39 [
40 .B -:D
41 ]
42 [
43 .B -9cjr
44 ]
45 [
46 .B -p
47 .I proto
48 ]
49 [
50 .B -s
51 src
52 ]
53 [
54 .B -v
55 volume
56 ]
57 [
58 .B -m
59 .I maxsize
60 ]
61 [
62 .B -n
63 .I now
64 ]
65 .I image
66 .SH DESCRIPTION
67 .I Mk9660
68 writes to the random access file
69 .I image
70 an ISO-9660 CD image containing the
71 files named in
72 .I proto
73 (by default,
74 .BR /sys/lib/sysconfig/proto/portproto )
75 from the file tree
76 .I src
77 (by default,
78 the current directory).
79 The
80 .I proto
81 file is formatted as described in
82 .IR mkfs (8).
83 .PP
84 The created CD image will be in ISO-9660
85 format, but by default the file names will
86 be stored in UTF-8 with no imposed length 
87 or character restrictions.
88 The
89 .B -c
90 flag causes
91 .I mk9660
92 to use only file names in ``8.3'' form
93 that use digits, letters, and underscore.
94 File names that do not conform are changed
95 to 
96 .BI D nnnnnn
97 (for directories)
98 or
99 .BI F nnnnnn
100 (for files);
101 a key file
102 .B _CONFORM.MAP
103 is created in the root
104 directory to ease the reverse process.
105 .PP
106 If the
107 .B -9
108 flag is given, the system use fields at the end of
109 each directory entry will be populated with
110 Plan directory information (owner, group, mode,
111 full name); this is interpreted by
112 .IR 9660srv .
113 .PP
114 If the
115 .B -j
116 flag is given, the usual directory tree is written,
117 but an additional tree in Microsoft Joliet format is
118 also added.
119 This second tree can contain long Unicode file names,
120 and can be read by
121 .I 9660srv
122 as well as most versions of Windows
123 and many Unix clones.
124 The characters
125 .BR * ,
126 .BR : ,
127 .BR ; ,
128 .BR ? ,
129 and
130 .B \e
131 are allowed in Plan 9 file names but not in Joliet file names;
132 non-conforming file names are translated
133 and a 
134 .B _CONFORM.MAP
135 file written
136 as in the case of the
137 .B -c
138 option.
139 .PP
140 If the
141 .B -r
142 flag is given, Rock Ridge extensions are written in the
143 format of the system use sharing protocol;
144 this format provides Posix-style file metadata and is 
145 common on Unix platforms.
146 .PP
147 The options
148 .BR -c ,
149 .BR -9 ,
150 .BR -j ,
151 and
152 .B -r
153 may be mixed freely with the exception that
154 .B -9
155 and
156 .B -r
157 are mutually exclusive.
158 .PP
159 The
160 .B -v
161 flag sets the volume title;
162 if unspecified, the base name of
163 .I proto
164 is used.
165 .PP
166 The 
167 .B -:
168 flag causes 
169 .B mk9660
170 to replace colons in scanned file names with spaces;
171 this is the inverse of the map applied by
172 .IR dossrv (4)
173 and is useful for writing Joliet CDs containing data
174 from FAT file systems.
175 .PP
176 The
177 .B -b
178 option creates a bootable CD.
179 Bootable CDs contain pointers to floppy images which are
180 loaded and booted by the BIOS.
181 .I Bootfile
182 should be the name of the floppy image to use;
183 it is a path relative to the root of the created CD.
184 That is, the boot floppy image must be listed in the
185 .I proto
186 file already:
187 the
188 .B -b
189 option just creates a pointer to it.
190 .PP
191 The
192 .B -B
193 option is similar to
194 .B -b
195 but the created CD image is marked as having a non-floppy-emulation
196 boot block.
197 This gives the program in the boot block full (ATA) LBA access
198 to the CD filesystem, not just the initial blocks that would fit on a floppy.
199 .PP
200 In addition to
201 .B -b
202 and
203 .B -B
204 a boot entry for UEFI systems can be created with the
205 .B -E
206 option and with
207 .I bootfile
208 pointing to a FAT image containing the contents of
209 the efi system partition.
210 .PP
211 The
212 .B -D
213 flag creates immense amounts of debugging output
214 on standard error.
215 .PP
216 .I Dump9660
217 is similar in specification to
218 .I mk9660
219 but creates and updates backup CD images in the style of
220 the 
221 .I dump
222 file system
223 (see
224 .IR fs (4)).
225 The dump is file-based rather than block-based:
226 if a file's contents have not changed since the last
227 backup, only its directory entry will be rewritten.
228 .PP
229 The
230 .B -n
231 option specifies a time (in seconds since January 1, 1970)
232 to be used for naming the dump directory.
233 .PP
234 The 
235 .B -m
236 option specifies a maximum size for the image;
237 if a backup would cause the image to grow larger than
238 .IR maxsize ,
239 it will not be written, and
240 .I dump9660
241 will exit with a non-empty status.
242 .SH EXAMPLE
243 .PP
244 Create an image of the Plan 9 source tree, 
245 including a conformant ISO-9660 directory tree,
246 Plan 9 extensions in the system use fields, and
247 a Joliet directory tree.
248 .IP
249 .EX
250 disk/mk9660 -9cj -s /sys/src \e
251         -p /sys/lib/sysconfig/proto/allproto cdimage
252 .EE
253 .SH SOURCE
254 .B /sys/src/cmd/disk/9660
255 .SH "SEE ALSO"
256 .I 9660srv
257 (in
258 .IR dossrv (4)),
259 .IR cdfs (4),
260 .IR mkfs (8)