templates/GRML/grml-cheatcodes.txt

   1       CHEATCODES AND HINTS FOR GRML
   2 ==============================================================================
   3
   4 Isolinux bootprompt options:
   5 ----------------------------
   6
   7 These options work from the isolinux bootprompt of Grml based (live) systems.
   8 (Do NOT use them as 'grml $OPTION', use them as '$OPTION'!):
   9
  10 grml                                Use default settings (same as just pressing return)
  11 grml2ram                            Copy Grml's squashfs file to RAM and
  12                                     run from there (compare with 'grml toram')
  13 memtest                             Run Memtest86+ instead of Linux
  14 fb1280x1024                         Use fixed framebuffer graphics (1)
  15 fb1024x768                          Use fixed framebuffer graphics (2) [notice: Grml's default]
  16 fb800x600                           Use fixed framebuffer graphics (3)
  17 nofb                                Disable framebuffer
  18 floppy                              Boot from floppydisk
  19 hd / hd1 / hd2 / hd3                Boot from (local) primary / secondary /... harddisk
  20 debug                               Get shells during process of booting for debugging
  21 bootchart                           Create chart of booting sequence in /var/log/bootchart.tgz
  22 forensic                            Do not touch any harddisks during hardware recognition
  23 serial                              Activate ttyS0 and start a getty
  24 grub                                Boot Grub bootloader (special all-in-one-image)
  25 dos                                 Boot FreeDOS
  26 hdt                                 Boot Hardware Detection Tool (from syslinux project)
  27
  28 Further documentation regarding the boot process can be found at:
  29 * http://git.grml.org/?p=live-initramfs-grml.git;a=blob_plain;f=manpages/live-initramfs.en.7.txt;hb=HEAD
  30 * https://manpages.debian.org/live-boot-doc/live-boot.7.en.html
  31 * https://manpages.debian.org/initramfs-tools-core/initramfs-tools.8.en.html
  32 * https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html
  33
  34 The following boot options can be combined.
  35 Notice: not all of them are available on all the Grml flavours.
  36 For example the X window system is not part of grml-small.
  37
  38 Regional settings:
  39 ------------------
  40 grml lang=at|de|cn|da|es|fr|it      Specify language ($LANG, $LC_ALL, $LANGUAGE - utf8) + keyboard
  41 grml lang=nl|pl|ru|sk|tr|tw|us      Specify language ($LANG, $LC_ALL, $LANGUAGE - utf8) + keyboard
  42 grml lang=$LANG-iso                 Activate $LANG (use like in lines above) with iso-mode instead of utf8
  43 grml utc                            Hardware Clock is set to Coordinated Universal Time (UTC)
  44 grml localtime                      Hardware Clock is set to local time (LOCAL), this is the default
  45 grml tz=Europe/Vienna               Use specified timezone for TZ, defaults to TZ=UTC
  46 grml keyboard=us xkeyboard=us       Use different keyboard layout (text-console/X)
  47
  48 Configuration settings:
  49 -----------------------
  50 grml myconfig=/dev/fd0              Set the DCS dir (debs, config, scripts) to the root of this device
  51                                     DCS dir defaults to the live image or a device labeled GRMLCFG
  52                                     If a file /config.tbz exists, it is extracted from there.
  53                                     /dev/fd0  for floppy disk
  54                                     /dev/sda1 for USB-stick/first SCSI-device
  55 grml autoconfig=SOMELABEL           Set the DCS dir to the root of the device labeled with SOMELABEL.
  56                                     If undefined search for a device labeled with GRMLCFG.
  57 grml netconfig=server/config.tbz    Download file and extract configuration archive
  58 grml netscript=server/file          Download and execute file
  59 grml partconf=/dev/sda2             Copy files specified in /etc/grml/partconf from /dev/sda2
  60                                     to booting grml system
  61 grml file=foobar.tbz                Use specified file as name for configuration archive
  62                                     instead of the default one (config.tbz)
  63 grml extract=/etc                   Extract only /etc from configuration archive,
  64                                     use it in combination with myconfig or netconfig
  65 grml persistence                    Enable persistency feature, more details available at
  66                                     http://wiki.grml.org/doku.php?id=persistency
  67 grml hostname=...                   Set hostname to given argument
  68 grml hostname                       Set a random hostname
  69                                     [Note: only available with releases newer than 2010.04]
  70 grml nonetworking                   Do not create/overwrite /etc/network/interface during startup
  71 grml distri=...                     Set distribution name to given argument. If a jpg file named like the
  72                                     given distri name can be found in directory desktop on the ISO
  73                                     (/cdrom/desktop/"$DISTRI") it will be taken as wallpaper for grml
  74 grml debnet                         Search through local partitions for file /etc/network/interfaces,
  75                                     copy /etc/network to local system and restart networking then
  76 grml dns=8.8.8.8,8.8.4.4            Set DNS resolvers during boot and for live system.
  77 grml ip=...                         Standard Linux kernel ip= boot option. Arguments:
  78                                     clientip:nfsserverip:gwip:netmask:hostname:device:autoconf
  79                                     Valid values for autoconf: off, on, dhcp, bootp, rarp, both.
  80                                     Almost everything is optional. Most common form: ip=dhcp
  81 grml mypath=...                     Add specified option into $PATH of Zsh
  82                                     For example when using "grml mypath=/foobar" then /foobar
  83                                     will be added to the end of $PATH inside Zsh
  84 grml debs                           Install all Debian packages from the "debs" directory of your DCS
  85                                     directory (see myconfig=, typically the root of your ISO image).
  86 grml debs=path-name-wildcard        Install Debian packages from DCS directory (see myconfig=,
  87                                     typically the root of your ISO image). If path does not contain a
  88                                     "/" the package(s) will be installed from directory "debs" of the
  89                                     DCS directory instead.  The "path-name-wildcard" can contain
  90                                     wildcards (e.g. debs=rat* will install a packages starting with "rat"
  91                                     from directory debs/).
  92 grml scripts=path-name              Execute script (defaulting to grml.sh) inside DCS dir. Path names
  93                                     allowed. If path-name points to a directory, all scripts found in
  94                                     the directory are executed.
  95 grml config=path-name               Unpack archive that path-name points to
  96 grml noautoconfig                   Disable searching for device labeled GRMLCFG
  97 grml nobeep                         Disable welcome chime, sounded before grml-quickconfig starts.
  98
  99 Notice: Take a look at http://grml.org/config/ and 'man 1 grml-autoconfig'
 100 for more information regarding the configuration framework of Grml.
 101
 102 Booting related options:
 103 ------------------------
 104 grml toram                          Copy the whole CD/medium to RAM and run from there
 105 grml toram=filename.squashfs        Copy the specified file to RAM and run from there
 106                                     Usage example: grml toram=grml-medium.squashfs
 107                                     Notice: grml2ram is an alias for this option which
 108                                     corresponds with the grml flavour settings by default
 109 grml tohd=/dev/sda1                 Copy Grml's squashfs file to harddisk partition for later
 110                                     use via "grml bootfrom=/dev/sda1"
 111 grml bootfrom=/dev/sda1             Use the squashfs file from directory 'live' of the specified device
 112                                     Setup can be done booting 'grml tohd=/dev/sda1' or
 113                                     running 'rsync -a --progress /lib/live/mount/medium/live /media/sda1/'
 114 grml bootfrom=removable             Restrict search for the live media to removable type only.
 115 grml bootfrom=removable-usb         Restrict search for the live media to usb mass storage only.
 116 grml isofrom=/dev/sda1/grml.iso     Use specified ISO image for booting
 117                                     Useful when booting as a rescue system from harddisk - just boot
 118                                     the according grml kernel and initrd using the bootoptions
 119                                     "boot=live isofrom=/dev/sda1/grml.iso"
 120                                     Notice: "fromiso" does the same as "isofrom", it's just there
 121                                     to prevent any typing errors
 122 grml findiso=/grml_2010.12.iso      Look for the specified ISO file on all disks where it usually
 123                                     looks for the .squashfs file (so you don't have to know the device name
 124                                     as in isofrom=....).
 125 grml fetch=$IP/filename.squashfs    Download a squashfs image from a given url, copying to ram and booting it.
 126                                     [Note: releases before 2011.05 didn't support DNS but IP only.]
 127 grml live-media-path=/live/grml...  Sets the path to the live filesystem on the medium
 128                                     By default, it is set to /live/$GRML_FLAVOUR/ (where $GRML_FLAVOUR
 129                                     is corresponding to grml64-full, grml32-full, grml64-small,...
 130                                     [Note: this option is mandatory since release 2011.12]
 131 grml module=grml                    Instead of using the default "$name.module" another file can
 132                                     be specified without the extension ".module"; it should be placed
 133                                     on "/live" directory of the live medium
 134                                     Useful for Multiboot USB pen, see
 135                                     http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
 136 grml bootid=mybootid                Use specified argument as identifier for the ISO.
 137                                     mybootid is specified in /conf/bootid.txt on the ISO.
 138                                     [Note: only available since release 2010.04]
 139 grml ignore_bootid                  Disable bootid verification.
 140                                     [Note: only available since release 2010.04]
 141
 142
 143 Debugging related settings:
 144 ---------------------------
 145 grml debug                          Get shells during process of booting, using GNU screen, be verbose
 146 grml debug=1                        Get shells during process of booting, using GNU screen, be verbose and
 147                                     display shell code being executed in initramfs.
 148 grml debug=noscreen                 Get shells during process of booting, verbose, but without using GNU screen
 149 grml nocolor                        Disable colorized output while booting
 150                                     Also set SYSTEMD_COLORS=0 to disable colors in systemd output
 151 grml log                            Log error messages while booting to /tmp/grml.log.`date +%Y%m%d`"
 152                                     and /var/log/boot
 153 grml testcd                         Check CD data integrity and md5sums
 154
 155 Security / login related settings:
 156 ----------------------------------
 157
 158 grml ssh=password                   Set password for root & grml user and start ssh-server
 159 grml passwd=...                     Set password for root & grml user
 160 grml encpasswd=....                 Set specified hash as password for root & grml user, use e.g.
 161                                     'mkpasswd -H md5' to generate such a hash (available in Grml >=2013.09)
 162
 163 Service related settings:
 164 -------------------------
 165 grml startup=script                 Start $script instead of grml-quickconfig on startup
 166 grml nosyslog                       Do not start syslog daemon
 167 grml nogpm                          Disable GPM daemon
 168 grml noconsolefont                  Disable setting of console font (using consolechars)
 169 grml noblank                        Disable console blanking
 170 grml noquick                        Disable grml-quickconfig startup script
 171 grml wondershaper=eth0,1000,500     Set up basic traffic shaping
 172 grml services={postfix,mysql,...}   Start service(s) which have an init-script (/etc/init.d/)
 173 grml welcome                        Welcome message via soundoutput
 174 grml noeject                        Do NOT eject CD after halt/reboot
 175 grml noprompt                       Do NOT prompt to remove the CD when halting/rebooting the system
 176 grml distcc=$NETWORK,$INTERFACE     Activate distcc-daemon to listen on specified network
 177                                     and interface, usage example:
 178                                     distcc=192.168.0.1/24,eth0
 179 grml gcc=3.4 gpp=3.4                Link /usr/bin/gcc, /usr/bin/cpp and /usr/bin/c++ to specified version
 180 grml startx{=windowmanager}         Start X window system automatically
 181                                     Default window manager (if not provided): wm-ng (wrapper around fluxbox)
 182 grml nostartx                       If using startx as default bootoption the nostartx *disables* automatic
 183                                     startup of X again. (This bootoption is relevant for grml based derivatives
 184                                     which decide to enable startx by default only, plain grml does not use
 185                                     automatic startup of X by default.)
 186 grml vnc=password                   Start VNC server with startup of X.org and sets the password to the specified
 187                                     one. To automatically start the VNC server use the startx bootoption.
 188                                     [Note: Grml 2011.12+ doesn't include a VNC server.]
 189 grml vnc_connect=host[:port]        Connect to a listening VNC client ("vncviewer -listen" reverse connection).
 190                                     Can be used to connect from devices behind firewalls as connection is
 191                                     initiated from the VNC server instead of the VNC client. Has to be
 192                                     combined with the vnc bootoption.
 193                                     [Note: Grml 2011.12+ doesn't include a VNC client.]
 194
 195 Accessibility related settings:
 196 -------------------------------
 197 grml brltty=type,port,table         Parameters for Braille device (e.g.: brltty=al,/dev/ttyS0,text.de.tbl)
 198                                     See http://mielke.cc/brltty/guidelines.html for documentation.
 199
 200 Hardware related settings:
 201 --------------------------
 202 grml swap                           Activate present/detected swap partitions
 203 grml noswraid                       Disable scanning for software raid arrays (creates /etc/mdadm/mdadm.conf)
 204 grml swraid                         Enable automatic assembling of software raid arrays
 205 grml nodmraid                       Do not enable present dmraid devices.
 206 grml dmraid=on                      Automatically enable any present dmraid devices.
 207 grml dmraid=off                     Actively try to stop any present dmraid devices.
 208 grml nolvm                          Disable scanning for Logical Volumes (LVM)
 209 grml lvm                            Automatically activate Logival Volumes (LVM) during boot
 210 grml read-only                      Make sure all harddisk devices (/dev/hd* /dev/sd*) are forced to read-only mode
 211 grml ethdevice=...                  Use specified network device for network boot instead of default (eth0)
 212 grml ethdevice-timeout=...          Use specified network configuration timeout instead of default (15sec)
 213 grml xmodule=ati|fbdev|i810|mga     Use specified X.org-Module (1)
 214 grml xmodule=nv|radeon|savage|s3    Use specified X.org-Module (2)
 215 grml xmodule=radeon|svga|i810       Use specified X.org-Module (3)
 216 grml no{acpi,agp,cpu,dhcp}          Skip parts of HW-detection (1)
 217 grml no{dma,fstab,modem}            Skip parts of HW-detection (2)
 218 grml no{pcmcia,scsi,swap,usb}       Skip parts of HW-detection (3)
 219 grml blacklist=modulename[,module2] Completely disable loading of specified module(s) via
 220                                     blacklisting through udev's /etc/modprobe.d/grml
 221 grml fwtimeout=50                   Set firmware timeout via /sys/class/firmware/timeout to specified value
 222 grml nosound                        Mute sound devices (notice: this does not deactivate loading of sound drivers!)
 223 grml vol=number                     Set mixer volumes to level $number
 224 grml micvol=number                  Set mixer volume of microphone to level $number (default: 0)
 225 grml pnpbios=off                    No PnP Bios initialization
 226 grml acpi=off                       Disable ACPI Bios completely
 227 grml nofirewire                     Disable initialization of firewire devices in booting sequence
 228 grml pci=irqmask=0x0e98             Try this, if PS/2 mouse doesn't work *)
 229 grml pci=bios                       Workaround for bad PCI controllers
 230 grml ide2=0x180 nopcmcia            Boot from PCMCIA-CD-ROM (some notebooks)
 231 grml mem=128M                       Specify Memory size in MByte
 232 grml libata.force=[ID:]VAL          Force configurations for libata.
 233                                     Usage example: grml libata.force=1:pio4
 234                                     to force pio4 mode on device "ata1:00:"
 235 grml libata.dma=0                   Disable DMA on PATA and SATA devices
 236 grml libata.ignore_hpa=1            Disable host protected area (which should enable the whole disk)
 237 grml vga=normal                     No-framebuffer mode (does not influence X)
 238 grml vga=ask                        Display menu for framebuffer mode
 239 grml radeon.modeset=0  nomodeset    Disable Kernel Mode Setting (KMS) for Radeon driver.
 240 grml i915.modeset=0    nomodeset    Disable Kernel Mode Setting (KMS) for Intel driver.
 241 grml nouveau.modeset=0 nomodeset    Disable Kernel Mode Setting (KMS) for Nouveau driver.
 242 grml cirrus.modeset=0  nomodeset    Disable Kernel Mode Setting (KMS) for Cirrus driver.
 243 grml mgag200.modeset=0 nomodeset    Disable Kernel Mode Setting (KMS) for MGAG200 driver.
 244
 245 Installation related settings:
 246 ------------------------------
 247
 248 Caution: do *NOT* use the debian2hd bootoption if you do not know what you are doing!
 249
 250 Install plain Debian via debian2hd bootoption (which runs grml-debootstrap in non-interactive mode):
 251
 252 debian2hd <options>                 ... whereas valid options for debian2hd are:
 253
 254   target=       target partition/directory of the new Debian system, e.g.: target=/dev/sda1
 255   grub=         where to install grub to, e.g.: grub=/dev/sda
 256   release=      specify release of new Debian system (default is stable), e.g.: release=sid
 257   mirror=       specify mirror for apt-get/aptitude, e,g.: mirror=http://ftp.debian.org/debian
 258   password=     set passwort of user root without prompting for it, e.g.: password=AiTh5ahn
 259
 260   Usage example for automatic installation:
 261
 262     debian2hd target=/dev/sda1 grub=/dev/sda mirror=http://ftp.debian.org/debian password=foobar
 263
 264   See http://grml.org/grml-debootstrap/ for more information.
 265
 266 Additional notes:
 267 -----------------
 268
 269 *) If your Grml-CD makes strange noises during boot, or you see frequent
 270 errors like "squashfs: read error", or programs are crashing randomly,
 271 then your CD image is probably defective or incomplete, your CD-burner
 272 created a defective CD due to wrong writing speed or bad media or your
 273 CD-ROM drive is broken. This is the most common error reported.  Please
 274 boot with "grml testcd" to check if the CD is OK, and/or even better,
 275 verify the MD5 checksums that are present on the mirrors before writing
 276 the CD.  Check your CD low-level via running 'readcd -c2scan
 277 dev=/dev/cdrom'. In some cases, defective IDE controllers cause this
 278 error if you have DMA enabled. Also, please read the grml-FAQ.
 279
 280 *) In case of a failing hardware autodetection, try booting with any of
 281 the "no-" options as shown in the table above, like in
 282    grml noagp noapic acpi=off nodma
 283 to skip some critical parts of the autodetection system.
 284
 285 *) Some boards (especially those with E-ISA slots) apparently don't pass
 286 the proper memory size to the linux-kernel. It may cause the message
 287 "Panic: cannot mount root file system" and the system hangs. Use "grml
 288 mem=128M" to solve that problem if your system has 128MByte memory for
 289 example (caution: you MUST use a capital "M" here).
 290
 291 *) The "myconfig=/dev/partition" option allows you to reconfigure the
 292 system after autoconfiguration by running a bourne shell script called
 293 "grml.sh" and/or extracting configuration files from a file named
 294 config.tbz from the root directory on the given device (or floppy).
 295 Take a look at http://grml.org/config/ for more information regarding
 296 the configuration framework of grml.
 297
 298 *) If you wish to remaster the CD, please don't forget to specify
 299
 300         -no-emul-boot -boot-load-size 4 -boot-info-table \
 301         -b boot/isolinux/isolinux.bin -c boot/isolinux/boot.cat
 302
 303 as option to mkisofs. Otherwise your CD won't be bootable. The
 304 directory live, containing the squashfs compressed filesystem file,
 305 must be located in the top level directory of the CD.
 306
 307 *) Caution: screensavers: Don't start physlock or any other screensaver
 308 that requires a password manually. There are no default passwords on
 309 the live system - all accounts are LOCKED by default for security reasons.
 310 Instead just invoke the script grml-lock which prompts for setting a
 311 password.
 312
 313 # EOF