Update grml-live docs to current grml-live.git
[grml.org.git] / grml-live / index.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 8.6.6" />\r
7 <title>grml-live(8)</title>\r
8 <style type="text/css">\r
9 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
10 \r
11 /* Default font. */\r
12 body {\r
13   font-family: Georgia,serif;\r
14 }\r
15 \r
16 /* Title font. */\r
17 h1, h2, h3, h4, h5, h6,\r
18 div.title, caption.title,\r
19 thead, p.table.header,\r
20 #toctitle,\r
21 #author, #revnumber, #revdate, #revremark,\r
22 #footer {\r
23   font-family: Arial,Helvetica,sans-serif;\r
24 }\r
25 \r
26 body {\r
27   margin: 1em 5% 1em 5%;\r
28 }\r
29 \r
30 a {\r
31   color: blue;\r
32   text-decoration: underline;\r
33 }\r
34 a:visited {\r
35   color: fuchsia;\r
36 }\r
37 \r
38 em {\r
39   font-style: italic;\r
40   color: navy;\r
41 }\r
42 \r
43 strong {\r
44   font-weight: bold;\r
45   color: #083194;\r
46 }\r
47 \r
48 h1, h2, h3, h4, h5, h6 {\r
49   color: #527bbd;\r
50   margin-top: 1.2em;\r
51   margin-bottom: 0.5em;\r
52   line-height: 1.3;\r
53 }\r
54 \r
55 h1, h2, h3 {\r
56   border-bottom: 2px solid silver;\r
57 }\r
58 h2 {\r
59   padding-top: 0.5em;\r
60 }\r
61 h3 {\r
62   float: left;\r
63 }\r
64 h3 + * {\r
65   clear: left;\r
66 }\r
67 h5 {\r
68   font-size: 1.0em;\r
69 }\r
70 \r
71 div.sectionbody {\r
72   margin-left: 0;\r
73 }\r
74 \r
75 hr {\r
76   border: 1px solid silver;\r
77 }\r
78 \r
79 p {\r
80   margin-top: 0.5em;\r
81   margin-bottom: 0.5em;\r
82 }\r
83 \r
84 ul, ol, li > p {\r
85   margin-top: 0;\r
86 }\r
87 ul > li     { color: #aaa; }\r
88 ul > li > * { color: black; }\r
89 \r
90 pre {\r
91   padding: 0;\r
92   margin: 0;\r
93 }\r
94 \r
95 #author {\r
96   color: #527bbd;\r
97   font-weight: bold;\r
98   font-size: 1.1em;\r
99 }\r
100 #email {\r
101 }\r
102 #revnumber, #revdate, #revremark {\r
103 }\r
104 \r
105 #footer {\r
106   font-size: small;\r
107   border-top: 2px solid silver;\r
108   padding-top: 0.5em;\r
109   margin-top: 4.0em;\r
110 }\r
111 #footer-text {\r
112   float: left;\r
113   padding-bottom: 0.5em;\r
114 }\r
115 #footer-badges {\r
116   float: right;\r
117   padding-bottom: 0.5em;\r
118 }\r
119 \r
120 #preamble {\r
121   margin-top: 1.5em;\r
122   margin-bottom: 1.5em;\r
123 }\r
124 div.imageblock, div.exampleblock, div.verseblock,\r
125 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
126 div.admonitionblock {\r
127   margin-top: 1.0em;\r
128   margin-bottom: 1.5em;\r
129 }\r
130 div.admonitionblock {\r
131   margin-top: 2.0em;\r
132   margin-bottom: 2.0em;\r
133   margin-right: 10%;\r
134   color: #606060;\r
135 }\r
136 \r
137 div.content { /* Block element content. */\r
138   padding: 0;\r
139 }\r
140 \r
141 /* Block element titles. */\r
142 div.title, caption.title {\r
143   color: #527bbd;\r
144   font-weight: bold;\r
145   text-align: left;\r
146   margin-top: 1.0em;\r
147   margin-bottom: 0.5em;\r
148 }\r
149 div.title + * {\r
150   margin-top: 0;\r
151 }\r
152 \r
153 td div.title:first-child {\r
154   margin-top: 0.0em;\r
155 }\r
156 div.content div.title:first-child {\r
157   margin-top: 0.0em;\r
158 }\r
159 div.content + div.title {\r
160   margin-top: 0.0em;\r
161 }\r
162 \r
163 div.sidebarblock > div.content {\r
164   background: #ffffee;\r
165   border: 1px solid #dddddd;\r
166   border-left: 4px solid #f0f0f0;\r
167   padding: 0.5em;\r
168 }\r
169 \r
170 div.listingblock > div.content {\r
171   border: 1px solid #dddddd;\r
172   border-left: 5px solid #f0f0f0;\r
173   background: #f8f8f8;\r
174   padding: 0.5em;\r
175 }\r
176 \r
177 div.quoteblock, div.verseblock {\r
178   padding-left: 1.0em;\r
179   margin-left: 1.0em;\r
180   margin-right: 10%;\r
181   border-left: 5px solid #f0f0f0;\r
182   color: #888;\r
183 }\r
184 \r
185 div.quoteblock > div.attribution {\r
186   padding-top: 0.5em;\r
187   text-align: right;\r
188 }\r
189 \r
190 div.verseblock > pre.content {\r
191   font-family: inherit;\r
192   font-size: inherit;\r
193 }\r
194 div.verseblock > div.attribution {\r
195   padding-top: 0.75em;\r
196   text-align: left;\r
197 }\r
198 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */\r
199 div.verseblock + div.attribution {\r
200   text-align: left;\r
201 }\r
202 \r
203 div.admonitionblock .icon {\r
204   vertical-align: top;\r
205   font-size: 1.1em;\r
206   font-weight: bold;\r
207   text-decoration: underline;\r
208   color: #527bbd;\r
209   padding-right: 0.5em;\r
210 }\r
211 div.admonitionblock td.content {\r
212   padding-left: 0.5em;\r
213   border-left: 3px solid #dddddd;\r
214 }\r
215 \r
216 div.exampleblock > div.content {\r
217   border-left: 3px solid #dddddd;\r
218   padding-left: 0.5em;\r
219 }\r
220 \r
221 div.imageblock div.content { padding-left: 0; }\r
222 span.image img { border-style: none; }\r
223 a.image:visited { color: white; }\r
224 \r
225 dl {\r
226   margin-top: 0.8em;\r
227   margin-bottom: 0.8em;\r
228 }\r
229 dt {\r
230   margin-top: 0.5em;\r
231   margin-bottom: 0;\r
232   font-style: normal;\r
233   color: navy;\r
234 }\r
235 dd > *:first-child {\r
236   margin-top: 0.1em;\r
237 }\r
238 \r
239 ul, ol {\r
240     list-style-position: outside;\r
241 }\r
242 ol.arabic {\r
243   list-style-type: decimal;\r
244 }\r
245 ol.loweralpha {\r
246   list-style-type: lower-alpha;\r
247 }\r
248 ol.upperalpha {\r
249   list-style-type: upper-alpha;\r
250 }\r
251 ol.lowerroman {\r
252   list-style-type: lower-roman;\r
253 }\r
254 ol.upperroman {\r
255   list-style-type: upper-roman;\r
256 }\r
257 \r
258 div.compact ul, div.compact ol,\r
259 div.compact p, div.compact p,\r
260 div.compact div, div.compact div {\r
261   margin-top: 0.1em;\r
262   margin-bottom: 0.1em;\r
263 }\r
264 \r
265 tfoot {\r
266   font-weight: bold;\r
267 }\r
268 td > div.verse {\r
269   white-space: pre;\r
270 }\r
271 \r
272 div.hdlist {\r
273   margin-top: 0.8em;\r
274   margin-bottom: 0.8em;\r
275 }\r
276 div.hdlist tr {\r
277   padding-bottom: 15px;\r
278 }\r
279 dt.hdlist1.strong, td.hdlist1.strong {\r
280   font-weight: bold;\r
281 }\r
282 td.hdlist1 {\r
283   vertical-align: top;\r
284   font-style: normal;\r
285   padding-right: 0.8em;\r
286   color: navy;\r
287 }\r
288 td.hdlist2 {\r
289   vertical-align: top;\r
290 }\r
291 div.hdlist.compact tr {\r
292   margin: 0;\r
293   padding-bottom: 0;\r
294 }\r
295 \r
296 .comment {\r
297   background: yellow;\r
298 }\r
299 \r
300 .footnote, .footnoteref {\r
301   font-size: 0.8em;\r
302 }\r
303 \r
304 span.footnote, span.footnoteref {\r
305   vertical-align: super;\r
306 }\r
307 \r
308 #footnotes {\r
309   margin: 20px 0 20px 0;\r
310   padding: 7px 0 0 0;\r
311 }\r
312 \r
313 #footnotes div.footnote {\r
314   margin: 0 0 5px 0;\r
315 }\r
316 \r
317 #footnotes hr {\r
318   border: none;\r
319   border-top: 1px solid silver;\r
320   height: 1px;\r
321   text-align: left;\r
322   margin-left: 0;\r
323   width: 20%;\r
324   min-width: 100px;\r
325 }\r
326 \r
327 div.colist td {\r
328   padding-right: 0.5em;\r
329   padding-bottom: 0.3em;\r
330   vertical-align: top;\r
331 }\r
332 div.colist td img {\r
333   margin-top: 0.3em;\r
334 }\r
335 \r
336 @media print {\r
337   #footer-badges { display: none; }\r
338 }\r
339 \r
340 #toc {\r
341   margin-bottom: 2.5em;\r
342 }\r
343 \r
344 #toctitle {\r
345   color: #527bbd;\r
346   font-size: 1.1em;\r
347   font-weight: bold;\r
348   margin-top: 1.0em;\r
349   margin-bottom: 0.1em;\r
350 }\r
351 \r
352 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {\r
353   margin-top: 0;\r
354   margin-bottom: 0;\r
355 }\r
356 div.toclevel2 {\r
357   margin-left: 2em;\r
358   font-size: 0.9em;\r
359 }\r
360 div.toclevel3 {\r
361   margin-left: 4em;\r
362   font-size: 0.9em;\r
363 }\r
364 div.toclevel4 {\r
365   margin-left: 6em;\r
366   font-size: 0.9em;\r
367 }\r
368 \r
369 span.aqua { color: aqua; }\r
370 span.black { color: black; }\r
371 span.blue { color: blue; }\r
372 span.fuchsia { color: fuchsia; }\r
373 span.gray { color: gray; }\r
374 span.green { color: green; }\r
375 span.lime { color: lime; }\r
376 span.maroon { color: maroon; }\r
377 span.navy { color: navy; }\r
378 span.olive { color: olive; }\r
379 span.purple { color: purple; }\r
380 span.red { color: red; }\r
381 span.silver { color: silver; }\r
382 span.teal { color: teal; }\r
383 span.white { color: white; }\r
384 span.yellow { color: yellow; }\r
385 \r
386 span.aqua-background { background: aqua; }\r
387 span.black-background { background: black; }\r
388 span.blue-background { background: blue; }\r
389 span.fuchsia-background { background: fuchsia; }\r
390 span.gray-background { background: gray; }\r
391 span.green-background { background: green; }\r
392 span.lime-background { background: lime; }\r
393 span.maroon-background { background: maroon; }\r
394 span.navy-background { background: navy; }\r
395 span.olive-background { background: olive; }\r
396 span.purple-background { background: purple; }\r
397 span.red-background { background: red; }\r
398 span.silver-background { background: silver; }\r
399 span.teal-background { background: teal; }\r
400 span.white-background { background: white; }\r
401 span.yellow-background { background: yellow; }\r
402 \r
403 span.big { font-size: 2em; }\r
404 span.small { font-size: 0.6em; }\r
405 \r
406 span.underline { text-decoration: underline; }\r
407 span.overline { text-decoration: overline; }\r
408 span.line-through { text-decoration: line-through; }\r
409 \r
410 \r
411 /*\r
412  * xhtml11 specific\r
413  *\r
414  * */\r
415 \r
416 tt {\r
417   font-family: monospace;\r
418   font-size: inherit;\r
419   color: navy;\r
420 }\r
421 \r
422 div.tableblock {\r
423   margin-top: 1.0em;\r
424   margin-bottom: 1.5em;\r
425 }\r
426 div.tableblock > table {\r
427   border: 3px solid #527bbd;\r
428 }\r
429 thead, p.table.header {\r
430   font-weight: bold;\r
431   color: #527bbd;\r
432 }\r
433 p.table {\r
434   margin-top: 0;\r
435 }\r
436 /* Because the table frame attribute is overriden by CSS in most browsers. */\r
437 div.tableblock > table[frame="void"] {\r
438   border-style: none;\r
439 }\r
440 div.tableblock > table[frame="hsides"] {\r
441   border-left-style: none;\r
442   border-right-style: none;\r
443 }\r
444 div.tableblock > table[frame="vsides"] {\r
445   border-top-style: none;\r
446   border-bottom-style: none;\r
447 }\r
448 \r
449 \r
450 /*\r
451  * html5 specific\r
452  *\r
453  * */\r
454 \r
455 .monospaced {\r
456   font-family: monospace;\r
457   font-size: inherit;\r
458   color: navy;\r
459 }\r
460 \r
461 table.tableblock {\r
462   margin-top: 1.0em;\r
463   margin-bottom: 1.5em;\r
464 }\r
465 thead, p.tableblock.header {\r
466   font-weight: bold;\r
467   color: #527bbd;\r
468 }\r
469 p.tableblock {\r
470   margin-top: 0;\r
471 }\r
472 table.tableblock {\r
473   border-width: 3px;\r
474   border-spacing: 0px;\r
475   border-style: solid;\r
476   border-color: #527bbd;\r
477   border-collapse: collapse;\r
478 }\r
479 th.tableblock, td.tableblock {\r
480   border-width: 1px;\r
481   padding: 4px;\r
482   border-style: solid;\r
483   border-color: #527bbd;\r
484 }\r
485 \r
486 table.tableblock.frame-topbot {\r
487   border-left-style: hidden;\r
488   border-right-style: hidden;\r
489 }\r
490 table.tableblock.frame-sides {\r
491   border-top-style: hidden;\r
492   border-bottom-style: hidden;\r
493 }\r
494 table.tableblock.frame-none {\r
495   border-style: hidden;\r
496 }\r
497 \r
498 th.tableblock.halign-left, td.tableblock.halign-left {\r
499   text-align: left;\r
500 }\r
501 th.tableblock.halign-center, td.tableblock.halign-center {\r
502   text-align: center;\r
503 }\r
504 th.tableblock.halign-right, td.tableblock.halign-right {\r
505   text-align: right;\r
506 }\r
507 \r
508 th.tableblock.valign-top, td.tableblock.valign-top {\r
509   vertical-align: top;\r
510 }\r
511 th.tableblock.valign-middle, td.tableblock.valign-middle {\r
512   vertical-align: middle;\r
513 }\r
514 th.tableblock.valign-bottom, td.tableblock.valign-bottom {\r
515   vertical-align: bottom;\r
516 }\r
517 \r
518 \r
519 /*\r
520  * manpage specific\r
521  *\r
522  * */\r
523 \r
524 body.manpage h1 {\r
525   padding-top: 0.5em;\r
526   padding-bottom: 0.5em;\r
527   border-top: 2px solid silver;\r
528   border-bottom: 2px solid silver;\r
529 }\r
530 body.manpage h2 {\r
531   border-style: none;\r
532 }\r
533 body.manpage div.sectionbody {\r
534   margin-left: 3em;\r
535 }\r
536 \r
537 @media print {\r
538   body.manpage div#toc { display: none; }\r
539 }\r
540 </style>\r
541 <script type="text/javascript">\r
542 /*<![CDATA[*/\r
543 var asciidoc = {  // Namespace.\r
544 \r
545 /////////////////////////////////////////////////////////////////////\r
546 // Table Of Contents generator\r
547 /////////////////////////////////////////////////////////////////////\r
548 \r
549 /* Author: Mihai Bazon, September 2002\r
550  * http://students.infoiasi.ro/~mishoo\r
551  *\r
552  * Table Of Content generator\r
553  * Version: 0.4\r
554  *\r
555  * Feel free to use this script under the terms of the GNU General Public\r
556  * License, as long as you do not remove or alter this notice.\r
557  */\r
558 \r
559  /* modified by Troy D. Hanson, September 2006. License: GPL */\r
560  /* modified by Stuart Rackham, 2006, 2009. License: GPL */\r
561 \r
562 // toclevels = 1..4.\r
563 toc: function (toclevels) {\r
564 \r
565   function getText(el) {\r
566     var text = "";\r
567     for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
568       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.\r
569         text += i.data;\r
570       else if (i.firstChild != null)\r
571         text += getText(i);\r
572     }\r
573     return text;\r
574   }\r
575 \r
576   function TocEntry(el, text, toclevel) {\r
577     this.element = el;\r
578     this.text = text;\r
579     this.toclevel = toclevel;\r
580   }\r
581 \r
582   function tocEntries(el, toclevels) {\r
583     var result = new Array;\r
584     var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');\r
585     // Function that scans the DOM tree for header elements (the DOM2\r
586     // nodeIterator API would be a better technique but not supported by all\r
587     // browsers).\r
588     var iterate = function (el) {\r
589       for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
590         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {\r
591           var mo = re.exec(i.tagName);\r
592           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {\r
593             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);\r
594           }\r
595           iterate(i);\r
596         }\r
597       }\r
598     }\r
599     iterate(el);\r
600     return result;\r
601   }\r
602 \r
603   var toc = document.getElementById("toc");\r
604   if (!toc) {\r
605     return;\r
606   }\r
607 \r
608   // Delete existing TOC entries in case we're reloading the TOC.\r
609   var tocEntriesToRemove = [];\r
610   var i;\r
611   for (i = 0; i < toc.childNodes.length; i++) {\r
612     var entry = toc.childNodes[i];\r
613     if (entry.nodeName == 'div'\r
614      && entry.getAttribute("class")\r
615      && entry.getAttribute("class").match(/^toclevel/))\r
616       tocEntriesToRemove.push(entry);\r
617   }\r
618   for (i = 0; i < tocEntriesToRemove.length; i++) {\r
619     toc.removeChild(tocEntriesToRemove[i]);\r
620   }\r
621 \r
622   // Rebuild TOC entries.\r
623   var entries = tocEntries(document.getElementById("content"), toclevels);\r
624   for (var i = 0; i < entries.length; ++i) {\r
625     var entry = entries[i];\r
626     if (entry.element.id == "")\r
627       entry.element.id = "_toc_" + i;\r
628     var a = document.createElement("a");\r
629     a.href = "#" + entry.element.id;\r
630     a.appendChild(document.createTextNode(entry.text));\r
631     var div = document.createElement("div");\r
632     div.appendChild(a);\r
633     div.className = "toclevel" + entry.toclevel;\r
634     toc.appendChild(div);\r
635   }\r
636   if (entries.length == 0)\r
637     toc.parentNode.removeChild(toc);\r
638 },\r
639 \r
640 \r
641 /////////////////////////////////////////////////////////////////////\r
642 // Footnotes generator\r
643 /////////////////////////////////////////////////////////////////////\r
644 \r
645 /* Based on footnote generation code from:\r
646  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html\r
647  */\r
648 \r
649 footnotes: function () {\r
650   // Delete existing footnote entries in case we're reloading the footnodes.\r
651   var i;\r
652   var noteholder = document.getElementById("footnotes");\r
653   if (!noteholder) {\r
654     return;\r
655   }\r
656   var entriesToRemove = [];\r
657   for (i = 0; i < noteholder.childNodes.length; i++) {\r
658     var entry = noteholder.childNodes[i];\r
659     if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote")\r
660       entriesToRemove.push(entry);\r
661   }\r
662   for (i = 0; i < entriesToRemove.length; i++) {\r
663     noteholder.removeChild(entriesToRemove[i]);\r
664   }\r
665 \r
666   // Rebuild footnote entries.\r
667   var cont = document.getElementById("content");\r
668   var spans = cont.getElementsByTagName("span");\r
669   var refs = {};\r
670   var n = 0;\r
671   for (i=0; i<spans.length; i++) {\r
672     if (spans[i].className == "footnote") {\r
673       n++;\r
674       var note = spans[i].getAttribute("data-note");\r
675       if (!note) {\r
676         // Use [\s\S] in place of . so multi-line matches work.\r
677         // Because JavaScript has no s (dotall) regex flag.\r
678         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];\r
679         spans[i].innerHTML =\r
680           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +\r
681           "' title='View footnote' class='footnote'>" + n + "</a>]";\r
682         spans[i].setAttribute("data-note", note);\r
683       }\r
684       noteholder.innerHTML +=\r
685         "<div class='footnote' id='_footnote_" + n + "'>" +\r
686         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +\r
687         n + "</a>. " + note + "</div>";\r
688       var id =spans[i].getAttribute("id");\r
689       if (id != null) refs["#"+id] = n;\r
690     }\r
691   }\r
692   if (n == 0)\r
693     noteholder.parentNode.removeChild(noteholder);\r
694   else {\r
695     // Process footnoterefs.\r
696     for (i=0; i<spans.length; i++) {\r
697       if (spans[i].className == "footnoteref") {\r
698         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");\r
699         href = href.match(/#.*/)[0];  // Because IE return full URL.\r
700         n = refs[href];\r
701         spans[i].innerHTML =\r
702           "[<a href='#_footnote_" + n +\r
703           "' title='View footnote' class='footnote'>" + n + "</a>]";\r
704       }\r
705     }\r
706   }\r
707 },\r
708 \r
709 install: function(toclevels) {\r
710   var timerId;\r
711 \r
712   function reinstall() {\r
713     asciidoc.footnotes();\r
714     if (toclevels) {\r
715       asciidoc.toc(toclevels);\r
716     }\r
717   }\r
718 \r
719   function reinstallAndRemoveTimer() {\r
720     clearInterval(timerId);\r
721     reinstall();\r
722   }\r
723 \r
724   timerId = setInterval(reinstall, 500);\r
725   if (document.addEventListener)\r
726     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);\r
727   else\r
728     window.onload = reinstallAndRemoveTimer;\r
729 }\r
730 \r
731 }\r
732 asciidoc.install(2);\r
733 /*]]>*/\r
734 </script>\r
735 </head>\r
736 <body class="article">\r
737 <div id="header">\r
738 <h1>grml-live(8)</h1>\r
739 <div id="toc">
740   <div id="toctitle">Table of Contents</div>
741   <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
742 </div>\r
743 </div>\r
744 <div id="content">\r
745 <div class="sect1">\r
746 <h2 id="_name">1. Name</h2>\r
747 <div class="sectionbody">\r
748 <div class="paragraph"><p>grml-live - build framework based on FAI for generating a grml and Debian based\r
749 Linux Live system (CD/ISO)</p></div>\r
750 </div>\r
751 </div>\r
752 <div class="sect1">\r
753 <h2 id="_synopsis">2. Synopsis</h2>\r
754 <div class="sectionbody">\r
755 <div class="paragraph"><p>grml-live [-a &lt;architecture&gt;] [-c &lt;classe[s]&gt;] [-C &lt;configfile&gt;] [-g\r
756 &lt;grml_name&gt;] [-i &lt;iso_name&gt; ] [-o &lt;output_directory&gt;] [-r &lt;release_name&gt;] [-s\r
757 &lt;suite&gt;] [-t &lt;template_directory&gt;] [-v &lt;version_number&gt;] [-U &lt;username&gt;] [\r
758 -AbBFnNquVz]</p></div>\r
759 <div class="admonitionblock">\r
760 <table><tr>\r
761 <td class="icon">\r
762 <img src="./images/icons/caution.png" alt="Caution" />\r
763 </td>\r
764 <td class="content">Please check out <a href="#current_state">the <em>Current state of grml-live with squashfs-tools and kernel</em> section</a> for details about current state of involved\r
765 tools before starting with grml-live or if you encounter any problems.</td>\r
766 </tr></table>\r
767 </div>\r
768 </div>\r
769 </div>\r
770 <div class="sect1">\r
771 <h2 id="_description">3. Description</h2>\r
772 <div class="sectionbody">\r
773 <div class="paragraph"><p>grml-live provides the build system for creating a grml and Debian based Linux\r
774 Live-CD. The build system is based on\r
775 <a href="http://fai-project.org/">FAI</a> (Fully Automatic\r
776 Installation). grml-live uses the "fai dirinstall" feature to generate a chroot\r
777 system based on the class concept of FAI (see later sections for further\r
778 details) and provides the framework to be able to generate a full-featured ISO.\r
779 It does not use all the FAI features by default though and you don&#8217;t have to\r
780 know FAI to be able to use it.</p></div>\r
781 <div class="paragraph"><p>The use of FAI gives you the flexibility to choose the packages you would like\r
782 to include on your very own Linux Live-CD without having to deal with all the\r
783 details of a build process.</p></div>\r
784 <div class="admonitionblock">\r
785 <table><tr>\r
786 <td class="icon">\r
787 <img src="./images/icons/caution.png" alt="Caution" />\r
788 </td>\r
789 <td class="content">grml-live does <strong>not</strong> use /etc/fai for configuration but instead\r
790 (unless overriden using the <em>'-D</em>' option). This ensures that it does not clash\r
791 with default FAI configuration and packages, so you can use grml-live and FAI\r
792 completely independent at the same time!</td>\r
793 </tr></table>\r
794 </div>\r
795 <div class="admonitionblock">\r
796 <table><tr>\r
797 <td class="icon">\r
798 <img src="./images/icons/note.png" alt="Note" />\r
799 </td>\r
800 <td class="content">Please notice that you should have a fast network connection as all the Debian\r
801 packages will be downloaded and installed via network. If you want to use a\r
802 local mirror (strongly recommended if you plan to use grml-live more than once)\r
803 checkout mkdebmirror (see /usr/share/doc/grml-live/examples/mkdebmirror),\r
804 debmirror(1), reprepro(1) (see /usr/share/doc/grml-live/examples/reprepro/ for a\r
805 sample configuration), apt-cacher(1) and approx(8). To avoid downloading the\r
806 base system again and again check out FAI&#8217;s NFSROOT (see FAQ of this document\r
807 for details).</td>\r
808 </tr></table>\r
809 </div>\r
810 </div>\r
811 </div>\r
812 <div class="sect1">\r
813 <h2 id="_options">4. Options</h2>\r
814 <div class="sectionbody">\r
815 <div class="dlist"><dl>\r
816 <dt class="hdlist1">\r
817 -A\r
818 </dt>\r
819 <dd>\r
820 <p>\r
821 Clean up output directories before attempting the build. Packs the chroot\r
822 into a tar archive, and removes chroot and iso build directories before exiting.\r
823 </p>\r
824 </dd>\r
825 <dt class="hdlist1">\r
826 -a <strong>ARCHITECTURE</strong>\r
827 </dt>\r
828 <dd>\r
829 <p>\r
830 Use the specified architecture instead of the currently running one.  This\r
831 allows building a 32bit system on a 64bit host (though you can&#8217;t build a 64bit\r
832 system on a 32bit system/kernel of course). Please notice that real\r
833 crosscompiling (like building a ppc system on x86) isn&#8217;t possible due to the\r
834 nature and the need of working in a chroot. Currently supported values: i386\r
835 and amd64.\r
836 </p>\r
837 </dd>\r
838 <dt class="hdlist1">\r
839 -b\r
840 </dt>\r
841 <dd>\r
842 <p>\r
843 Build the ISO without updating the chroot via FAI. This option is useful for\r
844 example when working on stable releases: if you have a working base\r
845 system/chroot and do not want to execute any further updates (via "-u" option)\r
846 but intend to only build the ISO.\r
847 </p>\r
848 </dd>\r
849 <dt class="hdlist1">\r
850 -B\r
851 </dt>\r
852 <dd>\r
853 <p>\r
854 Build the ISO without touching the chroot at all. This option is useful if\r
855 you modified anything that FAI or grml-live might adjust via grml&#8217;s FAI\r
856 scripts.  It&#8217;s like the <em>-b</em> option but even more advanced. Use only if you\r
857 really know that you do not want to update the chroot.\r
858 </p>\r
859 </dd>\r
860 <dt class="hdlist1">\r
861 -c <strong>CLASSES</strong>\r
862 </dt>\r
863 <dd>\r
864 <p>\r
865 Specify the CLASSES to be used for building the ISO via FAI.  By default only\r
866 the classes GRMLBASE, GRML_FULL and I386/AMD64 (depending on system\r
867 architecture) are assumed, resulting in a small base system (being about ~180MB\r
868 total ISO size). If using a non-I386 system (like AMD64) you should specify the\r
869 appropriate architecture as well. Additionally you can specify a class providing\r
870 a grml-kernel (see <a href="#classes">the <em>CLASSES</em> section in this document</a> for\r
871 details about available classes).  So instead of GRML_FULL you can also use\r
872 GRML_SMALL and GRML_FULL.\r
873 </p>\r
874 </dd>\r
875 </dl></div>\r
876 <div class="admonitionblock">\r
877 <table><tr>\r
878 <td class="icon">\r
879 <img src="./images/icons/important.png" alt="Important" />\r
880 </td>\r
881 <td class="content">All class names should be written in uppercase letters. Do not use a dash, use\r
882 an underscore. So do not use "amd64" but "AMD64", do not use "FOO BAR" but\r
883 "FOO_BAR".</td>\r
884 </tr></table>\r
885 </div>\r
886 <div class="dlist"><dl>\r
887 <dt class="hdlist1">\r
888 -C <strong>CONFIGURATION_FILE</strong>\r
889 </dt>\r
890 <dd>\r
891 <p>\r
892 The specified file is used as configuration file for grml-live. By default\r
893 /etc/grml/grml-live.conf is used as default configuration. If a file named\r
894 /etc/grml/grml-live.local exists it is used as well (sourced after reading\r
895 /etc/grml/grml-live.conf meant as main file for local configuration). As a last\r
896 option the specified configuration file is sourced so it is possible to override\r
897 settings of /etc/grml/grml-live.conf as well as of /etc/grml/grml-live.local.\r
898 Please notice that all configuration files have to be adjusted during execution\r
899 of grml-live, so please make sure you use /etc/grml/grml-live.conf as a base for\r
900 your own configuration file (usually /etc/grml/grml-live.local). Please also\r
901 notice that the configuration file specified via this option is <strong>not</strong> (yet)\r
902 /etc/grml/grml-live.local for configuration stuff used inside\r
903 </p>\r
904 </dd>\r
905 <dt class="hdlist1">\r
906 -d <strong>DATE</strong>\r
907 </dt>\r
908 <dd>\r
909 <p>\r
910 Use specified date as build date information on the ISO instead of the default.\r
911 The default is the date when grml-live is being executed (retrieved via\r
912 executing <em>date +%Y-%m-%d</em>). The information is stored inside the file\r
913 /GRML/grml-version on the ISO, /etc/grml_version in the squashfs file and in all\r
914 the bootsplash related files. This option is useful if you want to provide an\r
915 ISO with release information for a specific date but have to build it in\r
916 advance. Usage example: <em>-d 2009-10-30</em>\r
917 </p>\r
918 </dd>\r
919 <dt class="hdlist1">\r
920 -D <strong>CONFIGURATION_DIRECTORY</strong>\r
921 </dt>\r
922 <dd>\r
923 <p>\r
924 The specified directory is used as configuration directory for grml-live and its\r
925 FAI. By default /etc/grml/fai is used as default configuration directory.  If\r
926 you want to have different configuration scripts, package definitions, etc. with\r
927 without messing with the global configuration under /etc/grml/fai provided by\r
928 grml-live this option provides you the option to use your own configuration\r
929 throughout this documentation.\r
930 </p>\r
931 </dd>\r
932 <dt class="hdlist1">\r
933 -F\r
934 </dt>\r
935 <dd>\r
936 <p>\r
937 Force execution and do not prompt for acknowledgment of configuration.\r
938 </p>\r
939 </dd>\r
940 <dt class="hdlist1">\r
941 -g <strong>GRML_NAME</strong>\r
942 </dt>\r
943 <dd>\r
944 <p>\r
945 Set the grml flavour name. Common usage examples: grml, grml-small, grml64.\r
946 Please do NOT use blanks and any special characters like <em>/</em>, <em>;</em> inside\r
947 GRML_NAME, otherwise you might notice problems while booting.\r
948 </p>\r
949 </dd>\r
950 <dt class="hdlist1">\r
951 -h\r
952 </dt>\r
953 <dd>\r
954 <p>\r
955 Display short usage information and exit.\r
956 </p>\r
957 </dd>\r
958 <dt class="hdlist1">\r
959 -i <strong>ISO_NAME</strong>\r
960 </dt>\r
961 <dd>\r
962 <p>\r
963 Specify name of ISO which will be available inside $OUTPUT_DIRECTORY/grml_isos\r
964 by default.\r
965 </p>\r
966 </dd>\r
967 <dt class="hdlist1">\r
968 -I <strong>CHROOT_INSTALL</strong>\r
969 </dt>\r
970 <dd>\r
971 <p>\r
972 Specify name of source directory which provides files that should become part of\r
973 the chroot/ISO. Not enabled by default. Note: the files are installed under <em>/</em>\r
974 in the chroot so you have to create the rootfs structure on your own.\r
975 </p>\r
976 </dd>\r
977 <dt class="hdlist1">\r
978 -n\r
979 </dt>\r
980 <dd>\r
981 <p>\r
982 Skip creation of the ISO file. This option is useful if you want to build/update\r
983 the chroot and/or recreate the squashfs file without building an ISO file.\r
984 </p>\r
985 </dd>\r
986 <dt class="hdlist1">\r
987 -N\r
988 </dt>\r
989 <dd>\r
990 <p>\r
991 Bootstrap the chroot without building bootloader, squashfs, or finalizing the\r
992 ISO. Use this option if installation of some packages fails, you want to run\r
993 custom commands or similar.\r
994 The main use of this option is to save time by skipping stages which aren&#8217;t\r
995 necessary for bootstrapping the chroot and which would get executed more than\r
996 once when iterating through the initial bootstrapping.\r
997 Alternatively, use this option as a test run of grml-live. Once you are\r
998 satisfied with the state of your grml_chroot, use grml-live <strong>-u</strong> to build the\r
999 remaining stages and finalize the ISO.\r
1000 </p>\r
1001 </dd>\r
1002 <dt class="hdlist1">\r
1003 -o <strong>OUTPUT_DIRECTORY</strong>\r
1004 </dt>\r
1005 <dd>\r
1006 <p>\r
1007 Main output directory of the build process of FAI.  Some directories are created\r
1008 inside this target directory, being: grml_cd (where the files for creating the\r
1009 ISO are located, including the compressed squashfs file), grml_chroot (the\r
1010 chroot system) and grml_isos (where the resulting ISO is stored).\r
1011 </p>\r
1012 </dd>\r
1013 <dt class="hdlist1">\r
1014 -q\r
1015 </dt>\r
1016 <dd>\r
1017 <p>\r
1018 Build the ISO without (re-)creating the squashfs compressed file using mksquashfs.\r
1019 This option is useful if you just want to update parts outside the chroot in the ISO.\r
1020 Consider combining this option with the build-only option <em>-b</em>.\r
1021 </p>\r
1022 </dd>\r
1023 <dt class="hdlist1">\r
1024 -Q\r
1025 </dt>\r
1026 <dd>\r
1027 <p>\r
1028 Build the ISO without generating a netboot package.\r
1029 </p>\r
1030 </dd>\r
1031 <dt class="hdlist1">\r
1032 -r <strong>RELEASENAME</strong>\r
1033 </dt>\r
1034 <dd>\r
1035 <p>\r
1036 Specify name of the release.\r
1037 </p>\r
1038 </dd>\r
1039 <dt class="hdlist1">\r
1040 -s <strong>SUITE</strong>\r
1041 </dt>\r
1042 <dd>\r
1043 <p>\r
1044 Specify the Debian suite you want to use for your live-system.  Defaults to\r
1045 "squeeze" (being current Debian/stable). Supported values are: etch, lenny,\r
1046 squeeze, sid. Debian "squeeze" requires a recent base.tgz\r
1047 debootstrap.\r
1048 </p>\r
1049 </dd>\r
1050 <dt class="hdlist1">\r
1051 -t <strong>TEMPLATE_DIRECTORY</strong>\r
1052 </dt>\r
1053 <dd>\r
1054 <p>\r
1055 Specify place of the templates used for building the ISO. By default\r
1056 (and if not manually specified) this is /usr/share/grml-live/templates/.\r
1057 </p>\r
1058 </dd>\r
1059 <dt class="hdlist1">\r
1060 -T <strong>CHROOT_ARCHIVE</strong>\r
1061 </dt>\r
1062 <dd>\r
1063 <p>\r
1064 Unpack chroot tar archive before starting. Most useful in combination with\r
1065 -A and -b or -u.\r
1066 </p>\r
1067 </dd>\r
1068 <dt class="hdlist1">\r
1069 -u\r
1070 </dt>\r
1071 <dd>\r
1072 <p>\r
1073 Update existing chroot instead of rebuilding it from scratch. This option is\r
1074 based on the softupdate feature of FAI.\r
1075 </p>\r
1076 </dd>\r
1077 <dt class="hdlist1">\r
1078 -U <strong>USERNAME</strong>\r
1079 </dt>\r
1080 <dd>\r
1081 <p>\r
1082 Sets ownership of all build output files to specified username before exiting.\r
1083 </p>\r
1084 </dd>\r
1085 <dt class="hdlist1">\r
1086 -v <strong>VERSION_NUMBER</strong>\r
1087 </dt>\r
1088 <dd>\r
1089 <p>\r
1090 Specify version number of the release.\r
1091 </p>\r
1092 </dd>\r
1093 <dt class="hdlist1">\r
1094 -V\r
1095 </dt>\r
1096 <dd>\r
1097 <p>\r
1098 Increase verbosity in the build process.\r
1099 </p>\r
1100 </dd>\r
1101 <dt class="hdlist1">\r
1102 -z\r
1103 </dt>\r
1104 <dd>\r
1105 <p>\r
1106 Use ZLIB instead of LZMA/XZ compression in mksquashfs part of the build process.\r
1107 </p>\r
1108 </dd>\r
1109 </dl></div>\r
1110 </div>\r
1111 </div>\r
1112 <div class="sect1">\r
1113 <h2 id="usage-examples">5. Usage examples</h2>\r
1114 <div class="sectionbody">\r
1115 <div class="paragraph"><p>To get a small, Debian-stable and grml-based Live-CD using /grml/grml-live\r
1116 as build and output directory just run:</p></div>\r
1117 <div class="literalblock">\r
1118 <div class="content">\r
1119 <pre><tt># grml-live</tt></pre>\r
1120 </div></div>\r
1121 <div class="paragraph"><p>To get a small Debian-unstable and grml-small based Live-CD using\r
1122 /home/mika/grml-live as build and output directory just use:</p></div>\r
1123 <div class="literalblock">\r
1124 <div class="content">\r
1125 <pre><tt># grml-live -s sid -c GRMLBASE,GRML_SMALL,AMD64 -o /home/mika/grml-live</tt></pre>\r
1126 </div></div>\r
1127 <div class="paragraph"><p>To get a medium sized, Debian-unstable and grml-based Live-CD for amd64\r
1128 architecture using /grml/grml-live as build and output directory just run:</p></div>\r
1129 <div class="literalblock">\r
1130 <div class="content">\r
1131 <pre><tt># grml-live -s sid -a amd64 -c GRMLBASE,GRML_FULL,AMD64</tt></pre>\r
1132 </div></div>\r
1133 <div class="paragraph"><p>To get a small, Debian-unstable and grml-based Live-CD using /tmp as build and\r
1134 output directory and use grml_0.0-3.iso as ISO name (placed inside\r
1135 /tmp/grml_isos) just invoke:</p></div>\r
1136 <div class="literalblock">\r
1137 <div class="content">\r
1138 <pre><tt># grml-live -o /tmp -c GRMLBASE,GRML_SMALL,AMD64 -s sid -i grml_0.0-3.iso</tt></pre>\r
1139 </div></div>\r
1140 <div class="admonitionblock">\r
1141 <table><tr>\r
1142 <td class="icon">\r
1143 <img src="./images/icons/note.png" alt="Note" />\r
1144 </td>\r
1145 <td class="content">If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually\r
1146 you should have &gt;=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm"\r
1147 and use /dev/shm as build and output directory - resulting in very fast build\r
1148 process.  But please be aware of the fact that rebooting your system will result\r
1149 in an empty /dev/shm, so please use another directory for $CHROOT_OUTPUT,\r
1150 $BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :)</td>\r
1151 </tr></table>\r
1152 </div>\r
1153 </div>\r
1154 </div>\r
1155 <div class="sect1">\r
1156 <h2 id="main-features">6. Main features of grml-live</h2>\r
1157 <div class="sectionbody">\r
1158 <div class="ulist"><ul>\r
1159 <li>\r
1160 <p>\r
1161 create a grml-/Debian-based Linux Live-CD with one single command\r
1162 </p>\r
1163 </li>\r
1164 <li>\r
1165 <p>\r
1166 class based concept, providing a maximum of flexibility\r
1167 </p>\r
1168 </li>\r
1169 <li>\r
1170 <p>\r
1171 supports integration of own hooks, scripts and configuration\r
1172 </p>\r
1173 </li>\r
1174 <li>\r
1175 <p>\r
1176 supports use and integration of own Software and/or Kernels via simple use of\r
1177 Debian repositories\r
1178 </p>\r
1179 </li>\r
1180 <li>\r
1181 <p>\r
1182 native support of FAI features\r
1183 </p>\r
1184 </li>\r
1185 <li>\r
1186 <p>\r
1187 multi-arch support (work in progress)\r
1188 </p>\r
1189 </li>\r
1190 </ul></div>\r
1191 </div>\r
1192 </div>\r
1193 <div class="sect1">\r
1194 <h2 id="class-concept">7. The class concept</h2>\r
1195 <div class="sectionbody">\r
1196 <div class="paragraph"><p>grml-live uses FAI and its class based concept for adjusting configuration and\r
1197 setup according to your needs. This gives you flexibility and strength without\r
1198 losing the simplicity in the build process.</p></div>\r
1199 <div class="paragraph"><p>The main and base class provided by grml-live is named GRMLBASE. It&#8217;s strongly\r
1200 recommended to <strong>always</strong> use the class GRMLBASE when building an ISO using\r
1201 grml-live, as well as the architecture dependent class which provides the kernel\r
1202 (being <em>I386</em> for x86_32 and <em>AMD64</em> for x86_64) and a GRML_* class (like\r
1203 GRML_SMALL, GRML_MEDIUM or GRML_FULL). The following files and directories are\r
1204 relevant for class GRMLBASE by default:</p></div>\r
1205 <div class="literalblock">\r
1206 <div class="content">\r
1207 <pre><tt>${GRML_FAI_CONFIG}/config/scripts/GRMLBASE/\r
1208 ${GRML_FAI_CONFIG}/config/debconf/GRMLBASE\r
1209 ${GRML_FAI_CONFIG}/config/class/GRMLBASE.var\r
1210 ${GRML_FAI_CONFIG}/config/hooks/instsoft.GRMLBASE\r
1211 ${GRML_FAI_CONFIG}/config/package_config/GRMLBASE</tt></pre>\r
1212 </div></div>\r
1213 <div class="paragraph"><p>Take a look at the next section for information about the concept of those\r
1214 files/directories.</p></div>\r
1215 <div class="paragraph"><p>If you want to use your own configuration, extend an existing configuration\r
1216 and/or add additional packages to your ISO just invent a new class (or extend an\r
1217 existing one). For example if you want to use your own class named "FOOBAR" just\r
1218 set CLASSES="GRMLBASE,GRML_SMALL,AMD64,FOOBAR" inside /etc/grml/grml-live.local\r
1219 or invoke grml-live using the classes option: "grml-live -c\r
1220 GRMLBASE,GRML_SMALL,AMD64,FOOBAR &#8230;".</p></div>\r
1221 <div class="paragraph"><p>More details regarding the class concept can be found in the documentation of\r
1222 FAI itself (being available at /usr/share/doc/fai-doc/).</p></div>\r
1223 </div>\r
1224 </div>\r
1225 <div class="sect1">\r
1226 <h2 id="classes">8. Available classes</h2>\r
1227 <div class="sectionbody">\r
1228 <div class="paragraph"><p>The package selection part of the classes can be found in\r
1229 selected. The following classes are predefined:</p></div>\r
1230 <div class="ulist"><ul>\r
1231 <li>\r
1232 <p>\r
1233 DEBORPHAN: get rid of all packages listed in output of Deborphan\r
1234 </p>\r
1235 </li>\r
1236 <li>\r
1237 <p>\r
1238 GRMLBASE: the main class responsible for getting a minimal subset of what&#8217;s\r
1239 defining a Grml system. Important parts of the buildprocess are specified in\r
1240 this class as well, so unless you have a really good reason you should always\r
1241 use this class.\r
1242 </p>\r
1243 </li>\r
1244 <li>\r
1245 <p>\r
1246 GRML_FULL: full featured grml, also known as the "normal", full grml as\r
1247 introduced in november 2011 (~350MB ISO size).\r
1248 </p>\r
1249 </li>\r
1250 <li>\r
1251 <p>\r
1252 GRML_MEDIUM: medium sized grml version, used to be known as grml-medium\r
1253 until november 2011 (~220MB ISO size).\r
1254 </p>\r
1255 </li>\r
1256 <li>\r
1257 <p>\r
1258 GRML_SMALL: minimum sized grml version, known as grml-small (~110MB ISO\r
1259 size).\r
1260 </p>\r
1261 </li>\r
1262 <li>\r
1263 <p>\r
1264 GRML_XL: large size Grml version, used to be known as "full grml" until\r
1265 november 2011 (~700MB ISO size).\r
1266 </p>\r
1267 </li>\r
1268 <li>\r
1269 <p>\r
1270 LATEX: LaTeX(-related) packages like auctex, texlive,&#8230;\r
1271 (which used to be shipped by grml before the LaTeX removal)\r
1272 </p>\r
1273 </li>\r
1274 <li>\r
1275 <p>\r
1276 LATEX_CLEANUP: get rid of several very large LaTeX directories\r
1277 (like some /usr/share/doc/texlive-*, /usr/share/doc/texmf,&#8230;)\r
1278 </p>\r
1279 </li>\r
1280 <li>\r
1281 <p>\r
1282 LOCALES: use full featured locales setup (see /etc/locale.gen.grml). This\r
1283 avoids to get rid of /usr/share/locale - which happens by default otherwise - as\r
1284 well.\r
1285 </p>\r
1286 </li>\r
1287 <li>\r
1288 <p>\r
1289 NO_ONLINE: do not run scripts during the chroot build process which require a\r
1290 network connection\r
1291 </p>\r
1292 </li>\r
1293 <li>\r
1294 <p>\r
1295 RELEASE: run some specific scripts and commands to provide the workflow for an\r
1296 official grml release\r
1297 </p>\r
1298 </li>\r
1299 <li>\r
1300 <p>\r
1301 REMOVE_DOCS: get rid of documentation directories (like /usr/share/doc,\r
1302 /usr/share/man/, /usr/share/info,&#8230;)\r
1303 </p>\r
1304 </li>\r
1305 <li>\r
1306 <p>\r
1307 SOURCES: retrieve Debian source packages after installation. Files will be\r
1308 placed in the output directory under grml_sources.\r
1309 </p>\r
1310 </li>\r
1311 <li>\r
1312 <p>\r
1313 XORG: providing important packages for use with a base grml-featured X.org\r
1314 setup\r
1315 </p>\r
1316 </li>\r
1317 </ul></div>\r
1318 </div>\r
1319 </div>\r
1320 <div class="sect1">\r
1321 <h2 id="files">9. Files</h2>\r
1322 <div class="sectionbody">\r
1323 <div class="paragraph"><p>Notice that grml-live ships FAI configuration files that do not use the same\r
1324 namespace as the FAI packages itself. This ensures that grml-live does not clash\r
1325 with your usual FAI configuration, so instead of /etc/fai/fai.conf (package\r
1326 below. To get an idea how another configuration or example files could look like\r
1327 check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package\r
1328 fai-doc). Furthermore /usr/share/doc/fai-doc/fai-guide.html/ch-config.html\r
1329 provides documentation regarding configuration possibilities.</p></div>\r
1330 <div class="literalblock">\r
1331 <div class="content">\r
1332 <pre><tt>/usr/sbin/grml-live</tt></pre>\r
1333 </div></div>\r
1334 <div class="paragraph"><p>Script for the main build process. Requires root permissions for execution.</p></div>\r
1335 <div class="literalblock">\r
1336 <div class="content">\r
1337 <pre><tt>/etc/grml/grml-live.conf</tt></pre>\r
1338 </div></div>\r
1339 <div class="paragraph"><p>Main configuration file for grml-live which should be considered as a reference\r
1340 configuration file only. Please use /etc/grml/grml-live.local for local\r
1341 configuration instead.</p></div>\r
1342 <div class="literalblock">\r
1343 <div class="content">\r
1344 <pre><tt>/etc/grml/grml-live.local</tt></pre>\r
1345 </div></div>\r
1346 <div class="paragraph"><p>All the local configuration should go to this file. This file overrides any\r
1347 defaults of grml-live. Configurations via /etc/grml/grml-live.local are preferred\r
1348 over the ones from /etc/grml/grml-live.conf. If you want to override settings\r
1349 from /etc/grml/grml-live.local as well you have to specify them on the grml-live\r
1350 commandline.</p></div>\r
1351 <div class="literalblock">\r
1352 <div class="content">\r
1353 <pre><tt>${GRML_FAI_CONFIG}/fai.conf</tt></pre>\r
1354 </div></div>\r
1355 <div class="paragraph"><p>Main configuration file for FAI which specifies where all the configuration\r
1356 files and scripts for FAI/grml-live can be found. By default the configuration\r
1357 variables are FAI_CONFIG_SRC=file:///etc/grml/fai/config and\r
1358 GRML_FAI_CONFIG=/etc/grml/fai/config - both pointing to a directory shipped by\r
1359 grml-live out-of-the-box so you shouldn&#8217;t have to configure anything in this\r
1360 file.</p></div>\r
1361 <div class="literalblock">\r
1362 <div class="content">\r
1363 <pre><tt>${GRML_FAI_CONFIG}/make-fai-nfsroot.conf</tt></pre>\r
1364 </div></div>\r
1365 <div class="paragraph"><p>This file is used by make-fai-nfsroot(8) only. Usually you don&#8217;t have to change\r
1366 anything inside this file. If you want to modify NFSROOT though you can adjust\r
1367 it there.</p></div>\r
1368 <div class="literalblock">\r
1369 <div class="content">\r
1370 <pre><tt>${GRML_FAI_CONFIG}/NFSROOT</tt></pre>\r
1371 </div></div>\r
1372 <div class="paragraph"><p>This file specifies the package list for creating the NFSROOT.</p></div>\r
1373 <div class="literalblock">\r
1374 <div class="content">\r
1375 <pre><tt>${GRML_FAI_CONFIG}/apt/sources.list</tt></pre>\r
1376 </div></div>\r
1377 <div class="paragraph"><p>This file specifies which mirrors should be considered for retrieving the Debian\r
1378 packages when creating the main chroot (including all the software you would\r
1379 like to see included). Important: this file should <strong>not</strong> be adjusted manually!\r
1380 Instead use the GRML_LIVE_SOURCES variable inside /etc/grml/grml-live.conf or\r
1381 on-the-fly via grml-live then. If you want to generally adjust apt configuration</p></div>\r
1382 <div class="literalblock">\r
1383 <div class="content">\r
1384 <pre><tt>${GRML_FAI_CONFIG}/config/</tt></pre>\r
1385 </div></div>\r
1386 <div class="paragraph"><p>The main directory for configuration of FAI/grml-live. More details below.</p></div>\r
1387 <div class="literalblock">\r
1388 <div class="content">\r
1389 <pre><tt>${GRML_FAI_CONFIG}/config/class/</tt></pre>\r
1390 </div></div>\r
1391 <div class="paragraph"><p>This directory contains files which specify main configuration variables for the\r
1392 FAI classes.</p></div>\r
1393 <div class="literalblock">\r
1394 <div class="content">\r
1395 <pre><tt>${GRML_FAI_CONFIG}/config/debconf/</tt></pre>\r
1396 </div></div>\r
1397 <div class="paragraph"><p>This directory provides the files for preseeding/configuration of debconf\r
1398 through files.</p></div>\r
1399 <div class="literalblock">\r
1400 <div class="content">\r
1401 <pre><tt>${GRML_FAI_CONFIG}/config/hooks/</tt></pre>\r
1402 </div></div>\r
1403 <div class="paragraph"><p>This directory provides files for customising the build process through hooks.\r
1404 Hooks are user defined programs or scripts, which are called during the\r
1405 installation process.</p></div>\r
1406 <div class="literalblock">\r
1407 <div class="content">\r
1408 <pre><tt>${GRML_FAI_CONFIG}/config/package_config/</tt></pre>\r
1409 </div></div>\r
1410 <div class="paragraph"><p>Directory with lists of software packages to be installed or removed.  The\r
1411 different classes describe what should find its way to your ISO.  When running\r
1412 "grml-live -c GRMLBASE,GRML_SMALL,AMD64 &#8230;" only the configuration of GRMLBASE,\r
1413 GRML_SMALL and and AMD64 will be taken. If you use <em>grml-live -c\r
1414 GRMLBASE,GRML_SMALL,AMD64,FOOBAR &#8230;</em> then the files of GRMLBASE, GRML_SMALL,\r
1415 AMD64 <strong>plus</strong> the files from FOOBAR will be taken. So just create a new class to\r
1416 adjust the package selection according to your needs.  Please notice that the\r
1417 directory GRMLBASE contains a package list defining a minimum but still\r
1418 reasonable package configuration.</p></div>\r
1419 <div class="literalblock">\r
1420 <div class="content">\r
1421 <pre><tt>${GRML_FAI_CONFIG}/config/scripts/</tt></pre>\r
1422 </div></div>\r
1423 <div class="paragraph"><p>Scripts for customising the ISO within the build process.</p></div>\r
1424 <div class="literalblock">\r
1425 <div class="content">\r
1426 <pre><tt>${GRML_FAI_CONFIG}/live-initramfs/</tt></pre>\r
1427 </div></div>\r
1428 <div class="paragraph"><p>This directory provides the files used for building the initramfs/initrd via\r
1429 live-initramfs(8).</p></div>\r
1430 </div>\r
1431 </div>\r
1432 <div class="sect1">\r
1433 <h2 id="log-files">10. Available log files</h2>\r
1434 <div class="sectionbody">\r
1435 <div class="paragraph"><p>grml-live itself logs to /var/log/grml-live.log. Unless you set PRESERVE_LOGFILE\r
1436 in your grml-live configuration the file is cleared on each new invocation of\r
1437 grml-live.</p></div>\r
1438 <div class="paragraph"><p>The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the\r
1439 default being /var/log/fai/grml/.</p></div>\r
1440 <div class="paragraph"><p>If you are using the grml-live buildd you will find the logs of the grml-live\r
1441 run at /var/log/grml-buildd.log.</p></div>\r
1442 <div class="paragraph"><p>If you want to store build information in a database just install the\r
1443 grml-live-db Debian package. Further details available in the grml-live-db\r
1444 manpage.</p></div>\r
1445 </div>\r
1446 </div>\r
1447 <div class="sect1">\r
1448 <h2 id="requirements">11. Requirements for the build system</h2>\r
1449 <div class="sectionbody">\r
1450 <div class="ulist"><ul>\r
1451 <li>\r
1452 <p>\r
1453 any Debian based system should be sufficient (if it doesn&#8217;t work it&#8217;s a bug,\r
1454 please send us a bug report then) [a usual\r
1455 <a href="http://grml.org/grml2hd/">grml2hd</a> harddisk installation (using grml or\r
1456 grml-medium) ships all you need]. Check out <a href="#deploy-on-debian">How do I deploy grml-live on a plain Debian installation</a> for details how to set up grml-live\r
1457 on a plain, original Debian system.\r
1458 </p>\r
1459 </li>\r
1460 <li>\r
1461 <p>\r
1462 enough free disk space; at least 800MB are required for a minimal grml-live\r
1463 run (~400MB for the chroot [$CHROOT_OUTPUT], ~150MB for the build target\r
1464 [$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some\r
1465 temporary files), if you plan to use GRML_FULL you should have at least 4GB of\r
1466 total free disk space\r
1467 </p>\r
1468 </li>\r
1469 <li>\r
1470 <p>\r
1471 fast network access for retrieving the Debian packages used for creating the\r
1472 chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far\r
1473 as possible)\r
1474 </p>\r
1475 </li>\r
1476 </ul></div>\r
1477 <div class="paragraph"><p>For further information see next section.</p></div>\r
1478 </div>\r
1479 </div>\r
1480 <div class="sect1">\r
1481 <h2 id="current_state">12. Current state of grml-live with squashfs-tools and kernel</h2>\r
1482 <div class="sectionbody">\r
1483 <div class="paragraph"><p>Use squashfs-tools &gt;=4.2-1 (available from Grml repositories as well as from\r
1484 Debian/unstable) to build Grml (based) ISOs featuring kernel version\r
1485 2.6.38-grml[64].</p></div>\r
1486 </div>\r
1487 </div>\r
1488 <div class="sect1">\r
1489 <h2 id="faq">13. FAQ</h2>\r
1490 <div class="sectionbody">\r
1491 <div class="sect2">\r
1492 <h3 id="deploy-on-debian">13.1. How do I deploy grml-live on a plain Debian installation?</h3>\r
1493 <div class="paragraph"><p>The easiest way to get a running grml-live setup is to install Grml or\r
1494 grml-medium using grml2hd (for example inside KVM, Virtualbox, VMware,&#8230; if you\r
1495 don&#8217;t want to run it on a physical system). Of course using grml-live on a\r
1496 plain, original Debian installation is supported as well. So there we go.</p></div>\r
1497 <div class="paragraph"><p>What we have: plain, original Debian Lenny (5.0).</p></div>\r
1498 <div class="paragraph"><p>What we want: build a grml-medium ISO based on Debian/squeeze for the amd64\r
1499 architecture using grml-live.</p></div>\r
1500 <div class="admonitionblock">\r
1501 <table><tr>\r
1502 <td class="icon">\r
1503 <img src="./images/icons/important.png" alt="Important" />\r
1504 </td>\r
1505 <td class="content">If you encounter any problems while booting the resulting ISO please be aware of\r
1506 <a href="#current_state">the <em>current state of grml-live with squashfs-tools and kernel</em> section</a>.</td>\r
1507 </tr></table>\r
1508 </div>\r
1509 <div class="sect3">\r
1510 <h4 id="_instructions">13.1.1. Instructions</h4>\r
1511 <div class="literalblock">\r
1512 <div class="content">\r
1513 <pre><tt># adjust sources.list:\r
1514 cat &gt;&gt; /etc/apt/sources.list &lt;&lt; EOF</tt></pre>\r
1515 </div></div>\r
1516 <div class="literalblock">\r
1517 <div class="content">\r
1518 <pre><tt># grml stable repository:\r
1519   deb     http://deb.grml.org/ grml-stable  main\r
1520 # deb-src http://deb.grml.org/ grml-stable  main</tt></pre>\r
1521 </div></div>\r
1522 <div class="literalblock">\r
1523 <div class="content">\r
1524 <pre><tt># grml testing/development repository:\r
1525   deb     http://deb.grml.org/ grml-testing main\r
1526 # deb-src http://deb.grml.org/ grml-testing main\r
1527 EOF</tt></pre>\r
1528 </div></div>\r
1529 <div class="literalblock">\r
1530 <div class="content">\r
1531 <pre><tt># adjust apt-pinning (only prefer squashfs stuff from grml):\r
1532 cat &gt;&gt; /etc/apt/preferences &lt;&lt; EOF\r
1533 Package: *\r
1534 Pin: origin deb.grml.org\r
1535 Pin-Priority: 1</tt></pre>\r
1536 </div></div>\r
1537 <div class="literalblock">\r
1538 <div class="content">\r
1539 <pre><tt>Package: squashfs-tools\r
1540 Pin: origin deb.grml.org\r
1541 Pin-Priority: 996\r
1542 EOF</tt></pre>\r
1543 </div></div>\r
1544 <div class="literalblock">\r
1545 <div class="content">\r
1546 <pre><tt># get keyring for apt:\r
1547 apt-get update\r
1548 apt-get --allow-unauthenticated install grml-debian-keyring</tt></pre>\r
1549 </div></div>\r
1550 <div class="literalblock">\r
1551 <div class="content">\r
1552 <pre><tt># optionally(!) install basefile so we don't have to build basic\r
1553 # chroot from scratch, grab from http://daily.grml.org/\r
1554 # mkdir -p /etc/grml/fai/config/basefiles/\r
1555 # mv base.tgz /etc/grml/fai/config/basefiles/I386.tar.gz\r
1556 # mv base64.tgz /etc/grml/fai/config/basefiles/AMD64.tar.gz</tt></pre>\r
1557 </div></div>\r
1558 <div class="literalblock">\r
1559 <div class="content">\r
1560 <pre><tt># install relevant tools\r
1561 # please check out http://grml.org/grml-live/#current_state when encountering problems!\r
1562 apt-get -o APT::Install-Recommends=false install grml-live squashfs-tools</tt></pre>\r
1563 </div></div>\r
1564 <div class="literalblock">\r
1565 <div class="content">\r
1566 <pre><tt># adjust grml-live configuration for our needs:\r
1567 cat &gt; /etc/grml/grml-live.local &lt;&lt; EOF\r
1568 ## want a faster build process and don't need smaller ISOs?\r
1569 ## if so use zlib compression\r
1570 # SQUASHFS_OPTIONS="-comp gzip -b 256k"\r
1571 ## want to use a specific squashfs binary?\r
1572 # SQUASHFS_BINARY='/usr/bin/mksquashfs'\r
1573 # install local files into the chroot\r
1574 CHROOT_INSTALL="/etc/grml/fai/chroot_install"\r
1575 ## adjust if necessary (defaults to /grml/grml-live):\r
1576 ## OUTPUT="/srv/grml-live"\r
1577 FAI_DEBOOTSTRAP="squeeze http://cdn.debian.net/debian/"\r
1578 ARCH="i386"\r
1579 CLASSES="GRMLBASE,GRML_FULL,AMD64"\r
1580 # PRESERVE_LOGFILE='1'\r
1581 # ZERO_FAI_LOGFILE='1'\r
1582 GRML_LIVE_SOURCES="\r
1583 deb http://deb.grml.org/            grml-stable  main\r
1584 deb http://deb.grml.org/            grml-testing main\r
1585 deb http://cdn.debian.net/debian squeeze main contrib non-free\r
1586 "\r
1587 EOF</tt></pre>\r
1588 </div></div>\r
1589 <div class="literalblock">\r
1590 <div class="content">\r
1591 <pre><tt># just optional(!) - upgrade FAI to latest available version:\r
1592 cat &gt;&gt; /etc/apt/sources.list &lt;&lt; EOF\r
1593 # fai:\r
1594   deb http://fai-project.org/download lenny koeln\r
1595 EOF</tt></pre>\r
1596 </div></div>\r
1597 <div class="literalblock">\r
1598 <div class="content">\r
1599 <pre><tt># get gpg key of FAI repos and install current FAI version:\r
1600 gpg -a --recv-keys AB9B66FD; gpg -a --export AB9B66FD | apt-key add -\r
1601 apt-get update\r
1602 apt-get install fai-client fai-server fai-doc</tt></pre>\r
1603 </div></div>\r
1604 <div class="paragraph"><p>That&#8217;s it. Now invoking <em>grml-live -V</em> should build the ISO.  If everything\r
1605 worked as expected the last line of the shell output should look like:</p></div>\r
1606 <div class="literalblock">\r
1607 <div class="content">\r
1608 <pre><tt>[*] Successfully finished execution of grml-live [running 687 seconds]</tt></pre>\r
1609 </div></div>\r
1610 <div class="paragraph"><p>and the ISO can be found inside /grml-live/grml-live/grml_isos/ then.</p></div>\r
1611 </div>\r
1612 </div>\r
1613 <div class="sect2">\r
1614 <h3 id="grml_fai_config_variable">13.2. What is $GRML_FAI_CONFIG?</h3>\r
1615 <div class="paragraph"><p>The variable <em>$GRML_FAI_CONFIG</em> is pointing to the directory /etc/grml/fai by\r
1616 default.  To provide you a maximum of flexibility you can set up your own\r
1617 configuration directory (e.g. based on /etc/grml/fai) and use this directory\r
1618 running grml-live with the <em>-D &lt;config_dir&gt;</em> option. Now <em>$GRML_FAI_CONFIG</em>\r
1619 points to the specified directory instead of using /etc/grml/fai and all the\r
1620 configuration files, scripts and hooks will be taken from your\r
1621 <em>$GRML_FAI_CONFIG</em> directory.</p></div>\r
1622 </div>\r
1623 <div class="sect2">\r
1624 <h3 id="how-to-debug">13.3. I&#8217;ve problems with the build process. How to start debugging?</h3>\r
1625 <div class="paragraph"><p>Check out the logs inside /var/log/fai/&#8230; If you think it&#8217;s a bug in grml-live\r
1626 send a copy of your config, logs and the commandline with a short problem\r
1627 description to &lt;<a href="mailto:mika@grml.org">mika@grml.org</a>&gt;:</p></div>\r
1628 <div class="literalblock">\r
1629 <div class="content">\r
1630 <pre><tt># history | grep grml-live &gt; /etc/grml/grml_live.cmdline\r
1631 # tar zcf grml_live_problem.tar.gz /etc/grml/grml-live.conf \\r
1632           /etc/grml/grml_live.cmdline /etc/grml/grml-buildd.conf \\r
1633           /var/log/fai /etc/grml/fai\r
1634 -&gt; finally mail grml_live_problem.tar.gz to &lt;mika@grml.org&gt;</tt></pre>\r
1635 </div></div>\r
1636 <div class="paragraph"><p>If you need help with grml-live or would like to see new features as part of\r
1637 grml-live you can get commercial support via\r
1638 <a href="http://grml-solutions.com/">Grml Solutions</a>.</p></div>\r
1639 </div>\r
1640 <div class="sect2">\r
1641 <h3 id="lzma-vs-zlib">13.4. How much is the difference between LZMA and ZLIB compression?</h3>\r
1642 <div class="paragraph"><p>ISO size (bs = blocksize):</p></div>\r
1643 <div class="tableblock">\r
1644 <table rules="all"\r
1645 width="45%"\r
1646 frame="border"\r
1647 cellspacing="0" cellpadding="4">\r
1648 <col width="42%" />\r
1649 <col width="28%" />\r
1650 <col width="28%" />\r
1651 <tbody>\r
1652 <tr>\r
1653 <td align="left" valign="top"><p class="table">ISO</p></td>\r
1654 <td align="center" valign="top"><p class="table">LZMA (256kB bs)</p></td>\r
1655 <td align="center" valign="top"><p class="table">ZLIB</p></td>\r
1656 </tr>\r
1657 <tr>\r
1658 <td align="left" valign="top"><p class="table">grml_sid</p></td>\r
1659 <td align="center" valign="top"><p class="table">666M</p></td>\r
1660 <td align="center" valign="top"><p class="table">771M</p></td>\r
1661 </tr>\r
1662 <tr>\r
1663 <td align="left" valign="top"><p class="table">grml_squeeze</p></td>\r
1664 <td align="center" valign="top"><p class="table">659M</p></td>\r
1665 <td align="center" valign="top"><p class="table">761M</p></td>\r
1666 </tr>\r
1667 <tr>\r
1668 <td align="left" valign="top"><p class="table">grml_lenny</p></td>\r
1669 <td align="center" valign="top"><p class="table">624M</p></td>\r
1670 <td align="center" valign="top"><p class="table">723M</p></td>\r
1671 </tr>\r
1672 <tr>\r
1673 <td align="left" valign="top"><p class="table">grml64_sid</p></td>\r
1674 <td align="center" valign="top"><p class="table">677M</p></td>\r
1675 <td align="center" valign="top"><p class="table">791M</p></td>\r
1676 </tr>\r
1677 <tr>\r
1678 <td align="left" valign="top"><p class="table">grml64_squeeze</p></td>\r
1679 <td align="center" valign="top"><p class="table">671M</p></td>\r
1680 <td align="center" valign="top"><p class="table">785M</p></td>\r
1681 </tr>\r
1682 <tr>\r
1683 <td align="left" valign="top"><p class="table">grml64_lenny</p></td>\r
1684 <td align="center" valign="top"><p class="table">639M</p></td>\r
1685 <td align="center" valign="top"><p class="table">745M</p></td>\r
1686 </tr>\r
1687 <tr>\r
1688 <td align="left" valign="top"><p class="table">grml-medium_sid</p></td>\r
1689 <td align="center" valign="top"><p class="table">208M</p></td>\r
1690 <td align="center" valign="top"><p class="table">236M</p></td>\r
1691 </tr>\r
1692 <tr>\r
1693 <td align="left" valign="top"><p class="table">grml-medium_squeeze</p></td>\r
1694 <td align="center" valign="top"><p class="table">206M</p></td>\r
1695 <td align="center" valign="top"><p class="table">234M</p></td>\r
1696 </tr>\r
1697 <tr>\r
1698 <td align="left" valign="top"><p class="table">grml-medium_lenny</p></td>\r
1699 <td align="center" valign="top"><p class="table">193M</p></td>\r
1700 <td align="center" valign="top"><p class="table">220M</p></td>\r
1701 </tr>\r
1702 <tr>\r
1703 <td align="left" valign="top"><p class="table">grml64-medium_sid</p></td>\r
1704 <td align="center" valign="top"><p class="table">213M</p></td>\r
1705 <td align="center" valign="top"><p class="table">245M</p></td>\r
1706 </tr>\r
1707 <tr>\r
1708 <td align="left" valign="top"><p class="table">grml64-medium_squeeze</p></td>\r
1709 <td align="center" valign="top"><p class="table">213M</p></td>\r
1710 <td align="center" valign="top"><p class="table">244M</p></td>\r
1711 </tr>\r
1712 <tr>\r
1713 <td align="left" valign="top"><p class="table">grml64-medium_lenny</p></td>\r
1714 <td align="center" valign="top"><p class="table">201M</p></td>\r
1715 <td align="center" valign="top"><p class="table">231M</p></td>\r
1716 </tr>\r
1717 <tr>\r
1718 <td align="left" valign="top"><p class="table">grml-small_sid</p></td>\r
1719 <td align="center" valign="top"><p class="table">102M</p></td>\r
1720 <td align="center" valign="top"><p class="table">118M</p></td>\r
1721 </tr>\r
1722 <tr>\r
1723 <td align="left" valign="top"><p class="table">grml-small_squeeze</p></td>\r
1724 <td align="center" valign="top"><p class="table">101M</p></td>\r
1725 <td align="center" valign="top"><p class="table">117M</p></td>\r
1726 </tr>\r
1727 <tr>\r
1728 <td align="left" valign="top"><p class="table">grml-small_lenny</p></td>\r
1729 <td align="center" valign="top"><p class="table">97M</p></td>\r
1730 <td align="center" valign="top"><p class="table">112M</p></td>\r
1731 </tr>\r
1732 <tr>\r
1733 <td align="left" valign="top"><p class="table">grml64-small_sid</p></td>\r
1734 <td align="center" valign="top"><p class="table">103M</p></td>\r
1735 <td align="center" valign="top"><p class="table">120M</p></td>\r
1736 </tr>\r
1737 <tr>\r
1738 <td align="left" valign="top"><p class="table">grml64-small_squeeze</p></td>\r
1739 <td align="center" valign="top"><p class="table">103M</p></td>\r
1740 <td align="center" valign="top"><p class="table">120M</p></td>\r
1741 </tr>\r
1742 <tr>\r
1743 <td align="left" valign="top"><p class="table">grml64-small_lenny</p></td>\r
1744 <td align="center" valign="top"><p class="table">99M</p></td>\r
1745 <td align="center" valign="top"><p class="table">116M</p></td>\r
1746 </tr>\r
1747 </tbody>\r
1748 </table>\r
1749 </div>\r
1750 <div class="paragraph"><p>Build time of grml-medium&#8217;s squashfs file (depends on your system, though just\r
1751 to get the ratio between the different options):</p></div>\r
1752 <div class="ulist"><ul>\r
1753 <li>\r
1754 <p>\r
1755 10 minutes and 4 seconds with LZMA default blocksize (128k)\r
1756 </p>\r
1757 </li>\r
1758 <li>\r
1759 <p>\r
1760 7 minutes 27 seconds with LZMA and blocksize 256k\r
1761 </p>\r
1762 </li>\r
1763 <li>\r
1764 <p>\r
1765 6 minutes and 8 seconds with LZMA blocksize 512k\r
1766 </p>\r
1767 </li>\r
1768 <li>\r
1769 <p>\r
1770 1 minute and 40 seconds with ZLIB\r
1771 </p>\r
1772 </li>\r
1773 </ul></div>\r
1774 </div>\r
1775 <div class="sect2">\r
1776 <h3 id="install-local-files">13.5. How do I install further files into the chroot/ISO?</h3>\r
1777 <div class="paragraph"><p>Just point the configuration variable CHROOT_INSTALL to the directory which\r
1778 provides the files you would like to install. Note that the files are installed\r
1779 under <em>/</em> in the chroot - so you have to create the rootfs structure on your\r
1780 own. Usage example:</p></div>\r
1781 <div class="literalblock">\r
1782 <div class="content">\r
1783 <pre><tt>echo "CHROOT_INSTALL=\$GRML_FAI_CONFIG/chroot_install" &gt;&gt; /etc/grml/grml-live.local\r
1784 mkdir -p /etc/grml/fai/chroot_install/usr/src/\r
1785 wget example.org/foo.tar.gz\r
1786 mv foo.tar.gz /etc/grml/fai/chroot_install/usr/src/\r
1787 grml-live ...</tt></pre>\r
1788 </div></div>\r
1789 </div>\r
1790 <div class="sect2">\r
1791 <h3 id="local-debian-mirror">13.6. Can I use my own (local) Debian mirror?</h3>\r
1792 <div class="paragraph"><p>Yes. Set up an according sources.list configuration as class file in\r
1793 FAI_DEBOOTSTRAP (if not already using NFSROOT&#8217;s base.tgz) inside\r
1794 /etc/grml/grml-live.conf[.local]. If you&#8217;re setting up your own class file don&#8217;t\r
1795 forget to include the class name in the class list (grml-live -c &#8230;).</p></div>\r
1796 <div class="paragraph"><p>If you want to use a local (for example NFS mount) mirror additionally then\r
1797 adjust MIRROR_DIRECTORY in /etc/grml/grml-live.conf[.local] as well.</p></div>\r
1798 <div class="paragraph"><p>If you want to use a HTTP Proxy (like apt-cacher-ng), set APT_PROXY. Example:</p></div>\r
1799 <div class="literalblock">\r
1800 <div class="content">\r
1801 <pre><tt>APT_PROXY="http://localhost:3142/"</tt></pre>\r
1802 </div></div>\r
1803 </div>\r
1804 <div class="sect2">\r
1805 <h3 id="add-additional-debian-packages">13.7. How do I add additional Debian package(s) to my CD/ISO?</h3>\r
1806 <div class="paragraph"><p>Just create a new class (using the package_config directory):</p></div>\r
1807 <div class="literalblock">\r
1808 <div class="content">\r
1809 <pre><tt># cat &gt; /etc/grml/fai/config/package_config/MIKA &lt;&lt; EOF\r
1810 PACKAGES aptitude</tt></pre>\r
1811 </div></div>\r
1812 <div class="literalblock">\r
1813 <div class="content">\r
1814 <pre><tt>vim\r
1815 another_name_of_a_debian_package\r
1816 and_another_one\r
1817 EOF</tt></pre>\r
1818 </div></div>\r
1819 <div class="paragraph"><p>and specify it when invoking grml-live then:</p></div>\r
1820 <div class="literalblock">\r
1821 <div class="content">\r
1822 <pre><tt># grml-live -c GRMLBASE,GRML_SMALL,AMD64,MIKA</tt></pre>\r
1823 </div></div>\r
1824 </div>\r
1825 <div class="sect2">\r
1826 <h3 id="reset-grml-live-configuration">13.8. I fscked up my grml-live configuration. How do I reset it to the defaults?</h3>\r
1827 <div class="paragraph"><p>Notice: this deletes all your grml-live configuration files. If that&#8217;s really\r
1828 what you are searching for just run:</p></div>\r
1829 <div class="literalblock">\r
1830 <div class="content">\r
1831 <pre><tt>rm -rf /etc/grml/fai /etc/grml/grml-live.conf\r
1832 dpkg -i --force-confnew --force-confmiss /path/to/grml-live_..._all.deb</tt></pre>\r
1833 </div></div>\r
1834 <div class="admonitionblock">\r
1835 <table><tr>\r
1836 <td class="icon">\r
1837 <img src="./images/icons/note.png" alt="Note" />\r
1838 </td>\r
1839 <td class="content">If you don&#8217;t control your /etc using a version control system (VCS) yet it&#8217;s a\r
1840 good chance to start using it now. Check out\r
1841 <a href="http://michael-prokop.at/blog/2007/03/14/maintain-etc-with-mercurial-on-debian/">http://michael-prokop.at/blog/2007/03/14/maintain-etc-with-mercurial-on-debian/</a>\r
1842 for more details how to maintain /etc using the mercurial VCS.</td>\r
1843 </tr></table>\r
1844 </div>\r
1845 </div>\r
1846 <div class="sect2">\r
1847 <h3 id="create-a-base-tgz">13.9. How do I create a base.tgz for use as NFSROOT?</h3>\r
1848 <div class="paragraph"><p>First of all build the chroot system:</p></div>\r
1849 <div class="literalblock">\r
1850 <div class="content">\r
1851 <pre><tt>mkdir /tmp/nfsroot &amp;&amp; cd /tmp/nfsroot\r
1852 debootstrap squeeze /tmp/nfsroot/ http://cdn.debian.net/debian\r
1853 tar zcf base.tgz ./</tt></pre>\r
1854 </div></div>\r
1855 <div class="paragraph"><p>Then check out where your NFSROOT is located:</p></div>\r
1856 <div class="literalblock">\r
1857 <div class="content">\r
1858 <pre><tt># grep '^NFSROOT' /etc/grml/fai/make-fai-nfsroot.conf\r
1859 NFSROOT=/grml/fai/nfsroot</tt></pre>\r
1860 </div></div>\r
1861 <div class="paragraph"><p>So as /grml/fai/nfsroot is your NFSROOT place the file under\r
1862 /grml/fai/nfsroot/live/filesystem.dir/var/tmp/:</p></div>\r
1863 <div class="literalblock">\r
1864 <div class="content">\r
1865 <pre><tt>mv base.tgz /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz</tt></pre>\r
1866 </div></div>\r
1867 <div class="paragraph"><p>or even better use /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz instead.\r
1868 Use I386 as $CLASSNAME for i386 builds and AMD64 for amd64 builds.</p></div>\r
1869 <div class="paragraph"><p>Now running "grml-live &#8230;" will use this file as main system instead of\r
1870 executing debootstrap. Check out the output for the following lines if using\r
1871 NFSROOT:</p></div>\r
1872 <div class="literalblock">\r
1873 <div class="content">\r
1874 <pre><tt>[...]\r
1875 Calling task_extrbase\r
1876 Unpacking Debian base archive\r
1877 Extracting /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz\r
1878 Calling task_mirror\r
1879 [...]</tt></pre>\r
1880 </div></div>\r
1881 <div class="paragraph"><p>or if using /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz for:</p></div>\r
1882 <div class="literalblock">\r
1883 <div class="content">\r
1884 <pre><tt>[...]\r
1885 ftar: extracting /etc/grml/fai/config/basefiles///AMD64.tar.gz to\r
1886 /grml-live/grml-live_20071029.22138/grml_chroot//\r
1887 [...]</tt></pre>\r
1888 </div></div>\r
1889 <div class="admonitionblock">\r
1890 <table><tr>\r
1891 <td class="icon">\r
1892 <img src="./images/icons/tip.png" alt="Tip" />\r
1893 </td>\r
1894 <td class="content">Existing base.tgz can be found at <a href="http://daily.grml.org/">http://daily.grml.org/</a></td>\r
1895 </tr></table>\r
1896 </div>\r
1897 <div class="paragraph" id="apt-cacher"><p>Set up apt-cacher-ng for use with grml-live</p></div>\r
1898 <div class="listingblock">\r
1899 <div class="content">\r
1900 <pre><tt>Make sure /etc/grml/grml-live.local provides according APT_PROXY and\r
1901 FAI_DEBOOTSTRAP:\r
1902 \r
1903   # cat /etc/grml/grml-live.local\r
1904   [...]\r
1905   APT_PROXY="http://localhost:3142/"\r
1906   [...]\r
1907   FAI_DEBOOTSTRAP="squeeze http://localhost:3142/cdn.debian.net/debian squeeze main contrib non-free"\r
1908 \r
1909 Make sure apt-cacher-ng is running ('/etc/init.d/apt-cacher-ng restart').\r
1910 That's it.  All downloaded files will be cached in /var/cache/apt-cacher-ng then.\r
1911 \r
1912 [[approx]]\r
1913 Set up approx for use with grml-live</tt></pre>\r
1914 </div></div>\r
1915 <div class="paragraph"><p>Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and\r
1916 FAI_DEBOOTSTRAP:</p></div>\r
1917 <div class="literalblock">\r
1918 <div class="content">\r
1919 <pre><tt># cat /etc/grml/grml-live.conf\r
1920 [...]\r
1921 GRML_LIVE_SOURCES="\r
1922 deb http://localhost:9999/grml            grml-stable  main\r
1923 deb http://localhost:9999/grml            grml-testing main\r
1924 deb http://localhost:9999/debian squeeze  main contrib non-free\r
1925 "\r
1926 FAI_DEBOOTSTRAP="squeeze http://localhost:9999/debian"</tt></pre>\r
1927 </div></div>\r
1928 <div class="paragraph"><p>Configure approx:</p></div>\r
1929 <div class="literalblock">\r
1930 <div class="content">\r
1931 <pre><tt># cat /etc/approx/approx.conf\r
1932 [...]\r
1933 debian http://ftp.at.debian.org/debian\r
1934 grml   http://deb.grml.org/</tt></pre>\r
1935 </div></div>\r
1936 <div class="paragraph"><p>Don&#8217;t forget to restart approx (/etc/init.d/approx restart). That&#8217;s it.\r
1937 All downloaded files will be cached in /var/cache/approx now.</p></div>\r
1938 </div>\r
1939 <div class="sect2">\r
1940 <h3 id="revert_manifold">13.10. How do I revert the manifold feature from an ISO?</h3>\r
1941 <div class="paragraph"><p>The so called manifold feature Grml ISOs use by default allows one to use the same\r
1942 ISO for CD boot and USB boot. If you notice any problems when booting just\r
1943 revert the manifold feature running:</p></div>\r
1944 <div class="literalblock">\r
1945 <div class="content">\r
1946 <pre><tt>% dd if=/dev/zero of=grml.iso bs=512 count=1 conv=notrunc</tt></pre>\r
1947 </div></div>\r
1948 <div class="paragraph"><p>To switch from manifold to isohybrid mode (an alternative approach provided by\r
1949 syslinux) then just execute:</p></div>\r
1950 <div class="literalblock">\r
1951 <div class="content">\r
1952 <pre><tt>% isohybrid grml.iso</tt></pre>\r
1953 </div></div>\r
1954 </div>\r
1955 <div class="sect2">\r
1956 <h3 id="basetgz">13.11. How do I create a base tar.gz (I386.tar.gz or AMD64.tar.gz)</h3>\r
1957 <div class="paragraph"><p>Execute the following commands (requires root):</p></div>\r
1958 <div class="literalblock">\r
1959 <div class="content">\r
1960 <pre><tt>ARCH='amd64' # replace with i386 if necessary\r
1961 SUITE='squeeze' # using the current stable release should always work\r
1962 debootstrap --arch "$ARCH" --exclude=info,tasksel,tasksel-data "$SUITE" "$ARCH" http://debian.netcologne.de/debian\r
1963 cd "$ARCH"\r
1964 rm var/cache/apt/archives/*.deb\r
1965 tar zcf ../"${ARCH}".tar.gz *</tt></pre>\r
1966 </div></div>\r
1967 <div class="paragraph"><p>And finally place the generated tarball in /etc/grml/fai/config/basefiles/ (note\r
1968 that it needs to be uppercase letters matching the class names, so: AMD64.tar.gz\r
1969 for amd64 and I386.tar.gz for i386).</p></div>\r
1970 </div>\r
1971 <div class="sect2">\r
1972 <h3 id="autobuild">13.12. How do I set up an autobuild environment?</h3>\r
1973 <div class="paragraph"><p>If you want to set up a system like <a href="http://daily.grml.org/">daily.grml.org</a>\r
1974 the Debian package grml-live-buildd provides all you need to start. Start with\r
1975 figuring out the cron job script /usr/share/grml-live/buildd/cronjob.sh.</p></div>\r
1976 <div class="paragraph"><p>If you want to automatically update the grml-live Debian package on your build\r
1977 system based on the git tree of grml-live (so you get bleeding edge of\r
1978 development which might is interesting for services like daily.grml.org) the\r
1979 provided release_helper.sh script provides everything you need. Execute as root:</p></div>\r
1980 <div class="literalblock">\r
1981 <div class="content">\r
1982 <pre><tt>echo "deb file:/home/grml-live-git/grml-live.build-area/ ./" &gt;&gt; /etc/apt/sources.list.d/grml-live.list\r
1983 adduser --disabled-login --disabled-password grml-live-git</tt></pre>\r
1984 </div></div>\r
1985 <div class="paragraph"><p>Execute <em>visudo</em> to update sudo configuration and add the following line:</p></div>\r
1986 <div class="literalblock">\r
1987 <div class="content">\r
1988 <pre><tt>grml-live-git ALL=NOPASSWD: /usr/bin/apt-get</tt></pre>\r
1989 </div></div>\r
1990 <div class="paragraph"><p>Switch to user grml-live-git and configure the rest:</p></div>\r
1991 <div class="literalblock">\r
1992 <div class="content">\r
1993 <pre><tt>su - grml-live-git\r
1994 mkdir grml-live.build-area\r
1995 git clone git://git.grml.org/grml-live.git\r
1996 git config --global user.name "Grml-Live Git Autobuild"\r
1997 git config --global user.email "grml-live-git@$(hostname)"</tt></pre>\r
1998 </div></div>\r
1999 <div class="paragraph"><p>Finally install a cron job (as user grml-live-git) like:</p></div>\r
2000 <div class="literalblock">\r
2001 <div class="content">\r
2002 <pre><tt>30 00 * * * cd /home/grml-live-git/grml-live.git/ &amp;&amp; env AUTOBUILD=1 scripts/release_helper.sh &gt;/home/grml-live-git/grml-live-build.log</tt></pre>\r
2003 </div></div>\r
2004 <div class="paragraph"><p>Tip: To find out the build date of the installed grml-live package just execute:</p></div>\r
2005 <div class="literalblock">\r
2006 <div class="content">\r
2007 <pre><tt>% apt-cache policy grml-live | grep 'Installed.*autobuild'\r
2008  Installed: 0.13.1~autobuild1300450381</tt></pre>\r
2009 </div></div>\r
2010 <div class="paragraph"><p>and run "date -ud @$STRING" where $STRING is the number behind the "autobuild",\r
2011 like:</p></div>\r
2012 <div class="literalblock">\r
2013 <div class="content">\r
2014 <pre><tt>% date -ud @1300450081\r
2015 Fri Mar 18 12:08:01 UTC 2011</tt></pre>\r
2016 </div></div>\r
2017 </div>\r
2018 <div class="sect2">\r
2019 <h3 id="question">13.13. I&#8217;ve a question which isn&#8217;t answered by this document</h3>\r
2020 <div class="paragraph"><p>Don&#8217;t hesitate to contact the author: &lt;<a href="mailto:mika@grml.org">mika@grml.org</a>&gt;</p></div>\r
2021 </div>\r
2022 </div>\r
2023 </div>\r
2024 <div class="sect1">\r
2025 <h2 id="download">14. Download / install grml-live as a Debian package</h2>\r
2026 <div class="sectionbody">\r
2027 <div class="paragraph"><p>Debian packages are available through the grml-repository at\r
2028 <a href="http://deb.grml.org/pool/main/g/grml-live/">deb.grml.org</a>.  If you want to\r
2029 build a Debian package on your own (using for example a specific version or the\r
2030 current development tree), just execute:</p></div>\r
2031 <div class="literalblock">\r
2032 <div class="content">\r
2033 <pre><tt>git clone git://git.grml.org/grml-live\r
2034 cd grml-live\r
2035 debuild -us -uc</tt></pre>\r
2036 </div></div>\r
2037 </div>\r
2038 </div>\r
2039 <div class="sect1">\r
2040 <h2 id="source">15. Source</h2>\r
2041 <div class="sectionbody">\r
2042 <div class="paragraph"><p>The source of grml-live is available at\r
2043 <a href="http://git.grml.org/?p=grml-live.git">http://git.grml.org/?p=grml-live.git</a></p></div>\r
2044 </div>\r
2045 </div>\r
2046 <div class="sect1">\r
2047 <h2 id="todo-list">16. TODO list</h2>\r
2048 <div class="sectionbody">\r
2049 <div class="paragraph"><p>Check out the <a href="http://git.grml.org/?p=grml-live.git;a=blob;f=TODO;hb=HEAD">TODO file</a>.</p></div>\r
2050 </div>\r
2051 </div>\r
2052 <div class="sect1">\r
2053 <h2 id="bugs">17. Bugs</h2>\r
2054 <div class="sectionbody">\r
2055 <div class="paragraph"><p>Please report feedback, <a href="http://grml.org/bugs/">bugreports</a> and wishes\r
2056 <a href="http://grml.org/contact/">to the grml-team</a>!</p></div>\r
2057 </div>\r
2058 </div>\r
2059 <div class="sect1">\r
2060 <h2 id="documentation">18. Documentation</h2>\r
2061 <div class="sectionbody">\r
2062 <div class="paragraph"><p>The most recent grml-live documentation is available online at\r
2063 <a href="http://grml.org/grml-live/">http://grml.org/grml-live/</a> and for offline reading also available\r
2064 in different formats:</p></div>\r
2065 <div class="ulist"><ul>\r
2066 <li>\r
2067 <p>\r
2068 <a href="http://grml.org/grml-live/grml-live.epub">http://grml.org/grml-live/grml-live.epub</a>\r
2069 </p>\r
2070 </li>\r
2071 <li>\r
2072 <p>\r
2073 <a href="http://grml.org/grml-live/grml-live.pdf">http://grml.org/grml-live/grml-live.pdf</a>\r
2074 </p>\r
2075 </li>\r
2076 </ul></div>\r
2077 </div>\r
2078 </div>\r
2079 <div class="sect1">\r
2080 <h2 id="authors">19. Authors</h2>\r
2081 <div class="sectionbody">\r
2082 <div class="paragraph"><p>Michael Prokop &lt;<a href="mailto:mika@grml.org">mika@grml.org</a>&gt;</p></div>\r
2083 </div>\r
2084 </div>\r
2085 </div>\r
2086 <div id="footnotes"><hr /></div>\r
2087 <div id="footer">\r
2088 <div id="footer-text">\r
2089 Last updated 2011-12-10 01:16:51 CET\r
2090 </div>\r
2091 </div>\r
2092 </body>\r
2093 </html>\r