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