Merge remote-tracking branch 'origin/github/pr/45'
[grml.org.git] / grml-live / index.html
index f01c64b..73a4ac0 100644 (file)
@@ -1,9 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
 <head>\r
 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.9" />\r
+<meta name="generator" content="AsciiDoc 9.0.5" />\r
 <title>grml-live(8)</title>\r
 <style type="text/css">\r
 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
@@ -435,7 +436,7 @@ thead, p.table.header {
 p.table {\r
   margin-top: 0;\r
 }\r
-/* Because the table frame attribute is overriden by CSS in most browsers. */\r
+/* Because the table frame attribute is overridden by CSS in most browsers. */\r
 div.tableblock > table[frame="void"] {\r
   border-style: none;\r
 }\r
@@ -734,9 +735,9 @@ asciidoc.install(2);
 <body class="article">\r
 <div id="header">\r
 <h1>grml-live(8)</h1>\r
-<div id="toc">
-  <div id="toctitle">Table of Contents</div>
-  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
+<div id="toc">\r
+  <div id="toctitle">Table of Contents</div>\r
+  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>\r
 </div>\r
 </div>\r
 <div id="content">\r
@@ -790,8 +791,7 @@ completely independent at the same time!</td>
 <td class="content">Please notice that you should have a fast network connection as all the Debian\r
 packages will be downloaded and installed via network. If you want to use a\r
 local mirror (strongly recommended if you plan to use grml-live more than once)\r
-checkout mkdebmirror (see /usr/share/doc/grml-live/examples/mkdebmirror),\r
-debmirror(1), reprepro(1) (see /usr/share/doc/grml-live/examples/reprepro/ for a\r
+checkout debmirror(1), reprepro(1) (see /usr/share/doc/grml-live/examples/reprepro/ for a\r
 sample configuration), apt-cacher(1) and approx(8). To avoid downloading the\r
 base system again and again check out <a href="#create-a-base-tgz">the base tar.gz feature</a>.</td>\r
 </tr></table>\r
@@ -853,12 +853,10 @@ really know that you do not want to update the chroot.
 <p>\r
 Specify the CLASSES to be used for building the ISO via FAI.  By default only\r
 the classes GRMLBASE, GRML_FULL and I386/AMD64 (depending on system\r
-architecture) are assumed, resulting in a base system of about 350MB\r
-total ISO size. If using a non-I386 system (like AMD64) you should specify the\r
-appropriate architecture as well. Additionally you can specify a class providing\r
-a grml-kernel (see <a href="#classes">the <em>CLASSES</em> section in this document</a> for\r
-details about available classes).  So instead of GRML_FULL you can also use\r
-GRML_SMALL and GRML_FULL.\r
+architecture) are assumed.  Additionally you can specify a class providing a\r
+(grml-)kernel (see <a href="#classes">the <em>CLASSES</em> section in this document</a> for\r
+details about available classes). So instead of GRML_FULL you can also use e.g.\r
+GRML_SMALL.\r
 </p>\r
 </dd>\r
 </dl></div>\r
@@ -1041,7 +1039,7 @@ Specify name of the release.
 <p>\r
 Specify the Debian suite you want to use for your live-system. If unset defaults\r
 to "testing". Supported values are: stable, testing, unstable (or their\r
-corresponding release names like "jessie"). Please be aware that recent Debian\r
+corresponding release names like "stretch"). Please be aware that recent Debian\r
 suites might require a recent base.tgz\r
 debootstrap.\r
 </p>\r
@@ -1122,7 +1120,7 @@ Use ZLIB instead of LZMA/XZ compression in mksquashfs part of the build process.
 <div class="sect1">\r
 <h2 id="usage-examples">5. Usage examples</h2>\r
 <div class="sectionbody">\r
-<div class="paragraph"><p>To get a Debian-stable and Grml-based Live-CD using /grml/grml-live\r
+<div class="paragraph"><p>To get a Debian-stable and Grml-based Live-CD using ./grml\r
 as build and output directory just run:</p></div>\r
 <div class="literalblock">\r
 <div class="content">\r
@@ -1226,6 +1224,16 @@ DEBORPHAN: get rid of all packages listed in output of deborphan
 </li>\r
 <li>\r
 <p>\r
+FILE_RC: instead of using systemd as init system use file-rc instead. file-rc\r
+was the init system used by Grml until and including stable release 2014.11,\r
+starting with beginning of 2016 Grml switched to systemd instead. If you want to\r
+build a live system in the old style using file-rc instead of systemd then enable\r
+this class. Please notice that the Grml team no longer provides support for it\r
+though.\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
 FRESHCLAM: execute freshclam (if it&#8217;s present) to update clamav definitions\r
 (increases resulting ISO size ~70MB). By default it&#8217;s skipped to avoid bigger\r
 ISO size.\r
@@ -1236,18 +1244,24 @@ ISO size.
 GRMLBASE: the main class responsible for getting a minimal subset of what&#8217;s\r
 defining a Grml system. Important parts of the buildprocess are specified in\r
 this class as well, so unless you have a really good reason you should always\r
-use this class.\r
+use this class. Please be aware that using <strong>just</strong> the GRMLBASE class won&#8217;t be\r
+enough, because the kernel packages (e.g. linux-image-*) are chosen in\r
+further GRML_* classes (to provide maximum flexibility with kernel\r
+selection). If you don&#8217;t want to use the existing GRML_FULL or GRML_SMALL\r
+classes, define your own CLASS file choosing the kernel package you want to use\r
+(and don&#8217;t forget to include your CLASS in the arguments of grml-live&#8217;s <code>-c...</code>\r
+command line option).\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
 GRML_FULL: full featured Grml, also known as the "normal", full grml as\r
-introduced in December 2011 (~460MB ISO size).\r
+introduced in December 2011 (~750 ISO size).\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-GRML_SMALL: minimum sized Grml version, known as grml-small (~230MB ISO\r
+GRML_SMALL: minimum sized Grml version, known as grml-small (~360MB ISO\r
 size).\r
 </p>\r
 </li>\r
@@ -1375,7 +1389,7 @@ installation process.</p></div>
 <div class="paragraph"><p>Directory with lists of software packages to be installed or removed.  The\r
 different classes describe what should find its way to your ISO.  When running\r
 "grml-live -c GRMLBASE,GRML_SMALL,AMD64 &#8230;" only the configuration of GRMLBASE,\r
-GRML_SMALL and and AMD64 will be taken. If you use <em>grml-live -c\r
+GRML_SMALL and AMD64 will be taken. If you use <em>grml-live -c\r
 GRMLBASE,GRML_SMALL,AMD64,FOOBAR &#8230;</em> then the files of GRMLBASE, GRML_SMALL,\r
 AMD64 <strong>plus</strong> the files from FOOBAR will be taken. So just create a new class to\r
 adjust the package selection according to your needs.  Please notice that the\r
@@ -1416,11 +1430,11 @@ on a plain, original Debian system.
 </li>\r
 <li>\r
 <p>\r
-enough free disk space; at least 800MB are required for a minimal grml-live\r
-run (~400MB for the chroot [$CHROOT_OUTPUT], ~150MB for the build target\r
-[$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some\r
-temporary files), if you plan to use GRML_FULL you should have at least 4GB of\r
-total free disk space\r
+enough free disk space; at least <sub>2GB are required for a minimal grml-live\r
+run (\</sub>1GB for the chroot [$CHROOT_OUTPUT], ~400MB for the build target\r
+[$BUILD_OUTPUT], ~35MB for the netboot files and \~350MB for the resulting ISO\r
+[$ISO_OUTPUT] plus some temporary files), if you plan to use GRML_FULL you\r
+should have at least 4GB of total free disk space\r
 </p>\r
 </li>\r
 <li>\r
@@ -1448,8 +1462,8 @@ chroot (check out "local mirror" to workaround this problem as far as possible)
 <div class="paragraph"><p>The easiest way to get a running grml-live setup is to just use Grml.\r
 Of course using grml-live on a plain, original Debian installation is supported\r
 as well. So there we go.</p></div>\r
-<div class="paragraph"><p>What we have: plain, original Debian jessie (8.x).</p></div>\r
-<div class="paragraph"><p>What we want: build a Grml ISO based on Debian/jessie for the amd64 architecture\r
+<div class="paragraph"><p>What we have: plain, original Debian stretch (9.x).</p></div>\r
+<div class="paragraph"><p>What we want: build a Grml ISO based on Debian/stretch for the amd64 architecture\r
 using grml-live.</p></div>\r
 <div class="sect3">\r
 <h4 id="_instructions">13.1.1. Instructions</h4>\r
@@ -1501,9 +1515,9 @@ cat &gt; /etc/grml/grml-live.local &lt;&lt; EOF
 # SQUASHFS_BINARY='/usr/bin/mksquashfs'\r
 ## install local files into the chroot\r
 # CHROOT_INSTALL="/etc/grml/fai/chroot_install"\r
-## adjust if necessary (defaults to /grml/grml-live):\r
+## adjust if necessary (defaults to ./grml/):\r
 ## OUTPUT="/srv/grml-live"\r
-FAI_DEBOOTSTRAP="jessie http://ftp.debian.org/debian/"\r
+FAI_DEBOOTSTRAP="stretch http://ftp.debian.org/debian/"\r
 # ARCH="amd64"\r
 CLASSES="GRMLBASE,GRML_FULL,AMD64"\r
 EOF</code></pre>\r
@@ -1585,7 +1599,7 @@ adjust MIRROR_DIRECTORY in /etc/grml/grml-live.conf[.local] as well.</p></div>
 <div class="literalblock">\r
 <div class="content">\r
 <pre><code># cat &gt; /etc/grml/fai/config/package_config/MIKA &lt;&lt; EOF\r
-PACKAGES aptitude</code></pre>\r
+PACKAGES install</code></pre>\r
 </div></div>\r
 <div class="literalblock">\r
 <div class="content">\r
@@ -1620,22 +1634,22 @@ FAI_DEBOOTSTRAP:</p></div>
 [...]\r
 APT_PROXY="http://localhost:3142/"\r
 [...]\r
-FAI_DEBOOTSTRAP="jessie http://localhost:3142/ftp.debian.org/debian jessie main contrib non-free"</code></pre>\r
+FAI_DEBOOTSTRAP="stretch http://localhost:3142/ftp.debian.org/debian stretch main contrib non-free"</code></pre>\r
 </div></div>\r
 <div class="paragraph"><p>Make sure apt-cacher-ng is running (<em>/etc/init.d/apt-cacher-ng restart</em>).\r
 That&#8217;s it.  All downloaded files will be cached in /var/cache/apt-cacher-ng then.</p></div>\r
 </div>\r
 <div class="sect2">\r
 <h3 id="revert_manifold">13.9. How do I revert the manifold feature from an ISO?</h3>\r
-<div class="paragraph"><p>The so called manifold feature Grml ISOs use by default allows one to use the same\r
-ISO for CD boot and USB boot. If you notice any problems when booting just\r
-revert the manifold feature running:</p></div>\r
+<div class="paragraph"><p>The so-called manifold feature Grml ISOs can, but by default do not, use allows\r
+one to use the same ISO for CD boot and USB boot. If you notice any problems\r
+when booting manifold-crafted media, just revert the manifold feature running:</p></div>\r
 <div class="literalblock">\r
 <div class="content">\r
 <pre><code>% dd if=/dev/zero of=grml.iso bs=512 count=1 conv=notrunc</code></pre>\r
 </div></div>\r
 <div class="paragraph"><p>To switch from manifold to isohybrid mode (an alternative approach provided by\r
-syslinux) then just execute:</p></div>\r
+syslinux, used by default for official Grml images) then just execute:</p></div>\r
 <div class="literalblock">\r
 <div class="content">\r
 <pre><code>% isohybrid grml.iso</code></pre>\r
@@ -1647,7 +1661,7 @@ syslinux) then just execute:</p></div>
 <div class="literalblock">\r
 <div class="content">\r
 <pre><code>BASECHROOT='/tmp/basefile'  # path where the chroot gets generated\r
-SUITE='jessie'              # using the current stable release should always work\r
+SUITE='stretch'              # using the current stable release should always work\r
 debootstrap --exclude=info,tasksel,tasksel-data "$SUITE" "$BASECHROOT" http://ftp.debian.org/debian\r
 tar -C "$BASECHROOT" --exclude='var/cache/apt/archives/*.deb' -zcf "${SUITE}".tar.gz ./</code></pre>\r
 </div></div>\r
@@ -1769,6 +1783,7 @@ Usage example:</p></div>
 <div class="content">\r
 <pre><code># export GRML_FAI_CONFIG=$(pwd)/etc/grml/fai\r
 # export SCRIPTS_DIRECTORY=$(pwd)/scripts\r
+# export TEMPLATE_DIRECTORY=$(pwd)/templates\r
 # ./grml-live -s sid -a amd64 -c GRMLBASE,GRML_FULL,AMD64</code></pre>\r
 </div></div>\r
 </div>\r
@@ -1818,7 +1833,7 @@ in different formats:</p></div>
 <div id="footer">\r
 <div id="footer-text">\r
 Last updated\r
- 2016-02-15 22:15:22 CET\r
+ 2021-03-08 18:51:37 CET\r
 </div>\r
 </div>\r
 </body>\r