man/update-grml-rescueboot.xml

   1 <?xml version="1.0" standalone='no'?>
   2 <!DOCTYPE manpage SYSTEM "http://masqmail.cx/xmltoman/xmltoman.dtd">
   3 <?xml-stylesheet type="text/xsl" href="http://masqmail.cx/xmltoman/xmltoman.xsl" ?>
   4
   5 <manpage name="update-grml-rescueboot" section="8" desc="Script to integrate Grml ISO for booting via GRUB">
   6
   7 <synopsis>
   8   <cmd>update-grml-rescueboot [-f] [-a <arg>32|64|96</arg>] [-t <arg>small|full</arg>]</cmd>
   9 </synopsis>
  10
  11 <description>
  12   <p>
  13     grml-rescueboot integrates Grml ISO booting into GRUB.
  14     It provides a script for update-grub which looks for Grml ISO images in <file>/boot/grml</file>,
  15     and automatically adds an entry for each image.
  16     The purpose is to use one of those images to boot a Grml rescue system without using a CD, USB stick or network boot (PXE).
  17
  18     <file>update-grml-rescueboot</file> is a script which checks for the latest stable version of Grml (via download.grml.org),
  19     ensures there's enough free disk space in <file>/boot/grml</file> and downloads the ISO to <file>/boot/grml</file>.
  20     It verifies the ISO signature and upon success executes update-grub then.
  21     Everything should be ready for booting a Grml ISO via GRUB then.
  22
  23     This script makes integration of a Grml ISO into GRUB via grml-rescueboot even easier.
  24     All that needs to be done is install grml-rescueboot and invoke update-grml-rescueboot afterwards.
  25     Using the <arg>-a</arg> and <arg>-t</arg> options it's possible to use specific Grml ISOs.
  26     If none of those options is specific it defaults to the grml-full flavour,
  27     matching the currently running hardware architecture (i?86 or x86_64).
  28   </p>
  29 </description>
  30
  31 <options>
  32
  33 <option>
  34   <p><opt>-a <arg>arg</arg></opt></p>
  35   <optdesc>
  36     <p>
  37       Choose Grml architecture, specified via <arg>arg</arg>.
  38       Supported flavours are '32', '64' and '96'.
  39       If unset defaults to the currently running architecture.
  40     </p>
  41   </optdesc>
  42 </option>
  43
  44 <option>
  45   <p><opt>-f</opt></p>
  46   <optdesc>
  47     <p>
  48       Force execution, ignoring, e.g. existing ISO files and disk space checks for <file>/boot/grml</file>.
  49     </p>
  50   </optdesc>
  51 </option>
  52
  53 <option>
  54   <p><opt>-h</opt></p>
  55   <optdesc>
  56     <p>
  57       Display usage information and exit script.
  58     </p>
  59   </optdesc>
  60 </option>
  61
  62 <option>
  63   <p><opt>-t <arg>arg</arg></opt></p>
  64   <optdesc>
  65     <p>
  66       Choose Grml flavour, specified via <arg>arg</arg>.
  67       Supported flavours are 'small' and 'full'.
  68       If unset defaults to 'full'.
  69     </p>
  70   </optdesc>
  71 </option>
  72
  73 </options>
  74
  75 <section name = "Author">
  76   <p>
  77     update-grml-rescueboot was written by Michael Prokop, based on a script by Felipe Sateler.
  78   </p>
  79 </section>
  80
  81 <section name = "Bugs">
  82   <p>
  83     Please report them towards Debian's BTS, see https://bugs.debian.org/grml-rescueboot.
  84   </p>
  85 </section>
  86
  87 </manpage>