templates/GRML/grml-cheatcodes.txt

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