grml-cheatcodes.txt: mention availability of bootoption netscript
[grml-live.git] / templates / GRML / grml-cheatcodes.txt
index 57fb758..8309378 100644 (file)
@@ -21,8 +21,10 @@ debug                               Get shells during process of booting for deb
 bootchart                           Create chart of booting sequence in /var/log/bootchart.tgz
 forensic                            Do not touch any harddisks during hardware recognition
 serial                              Activate ttyS0 and start mgetty
+grub                                Boot Grub bootloader (special all-in-one-image)
 dos                                 Boot FreeDOS
-grub                                Boot into the Grub bootloader
+bsd                                 Boot MirOS BSD
+hdt                                 Boot Hardware Detection Tool (from syslinux project)
 qemu                                Boot with special options for use in Qemu
 vmware                              Boot with special options for use in VMware
 
@@ -42,30 +44,42 @@ grml setkeycodes                    Set some special function keys for MS/HP key
 
 Configuration settings:
 -----------------------
-grml myconfig=/dev/fd0              Execute "grml.sh" and extract config.tbz from a partition:
+grml myconfig=/dev/fd0              Set the DCS dir (debs, config, scripts) to the root of this device
+                                    DCS dir defaults to the live image or a device labeled GRMLCFG
+                                    If a file /config.tbz exists, it is extracted from there.
                                     /dev/fd0  for floppy disk
                                     /dev/sda1 for USB-stick/first SCSI-device
 grml netconfig=server/config.tbz    Download file and extract configuration archive
+grml netscript=server/file          Download and execute file [Note: only available in releases >2009.05]
 grml partconf=/dev/hda2             Copy files specified in /etc/grml/partconf from /dev/hda2
                                     to booting grml system
 grml file=foobar.tbz                Use specified file as name for configuration archive
                                     instead of the default one (config.tbz)
 grml extract=/etc                   Extract only /etc from configuration archive,
                                     use it in combination with myconfig or netconfig
+grml persistent                     Enable persistency feature, more details available at
+                                    http://wiki.grml.org/doku.php?id=persistency
 grml home=/dev/hda2                 Mount specified partition as grml homedir
 grml home=/dev/sda1/grml.img        Mount loopback file as /home/grml
 grml home=scan                      Automatic search for grml homedir (using file grml.img)
 grml hostname=...                   Set hostname
 grml distri=...                     Set distribution name to given argument. If a jpg file named like the
                                     given distri name can be found in directory desktop on the ISO
-                                   (/cdrom/desktop/"$DISTRI") it will be taken as wallpaper for grml
+                                    (/cdrom/desktop/"$DISTRI") it will be taken as wallpaper for grml
 grml debnet                         Search through local partitions for file /etc/network/interfaces,
                                     copy /etc/network to local system and restart networking then
-grml mypath=...                     Add specified option into $PATH of Zsh.
+grml mypath=...                     Add specified option into $PATH of Zsh
                                     For example when using "grml mypath=/foobar" then /foobar
-                                    will be added to the end of $PATH inside Zsh.
-
-Notice: Take a look at http://grml.org/config/ and /usr/share/doc/grml-saveconfig/grml-config.html
+                                    will be added to the end of $PATH inside Zsh
+grml debs=path-name-wildcard        install Debian packages matching the path-name-wildcard in the
+                                    DCS dir
+grml scripts=path-name              execute script (defaulting to grml.sh) inside DCS dir. Path names
+                                    allowed. If path-name points to a directory, all scripts found in
+                                    the directory are executed.
+grml config=path-name               unpack archive that path-name points to
+grml noautoconfig                   Disable searching for device labeled GRMLCFG
+
+Notice: Take a look at http://grml.org/config/ and 'man 1 grml-autoconfig'
 for more information regarding the configuration framework of grml.
 
 Booting related options:
@@ -75,25 +89,29 @@ grml toram                          Copy the whole CD/medium to RAM and run from
 grml toram=filename.squashfs        Copy the specified file to RAM and run from there
                                     Usage example: grml toram=grml-medium.squashfs
                                     Notice: grml2ram is an alias for this option which
-                                    corresponds with the grml flavour settings by default.
+                                    corresponds with the grml flavour settings by default
 
 grml tohd=/dev/sda1                 Copy grml's squashfs file to harddisk partition for later
                                     use via "grml bootfrom=/dev/sda1"
-grml bootfrom=/dev/sda1             Use the squashfs file from directory 'live' of the specified device.
+grml bootfrom=/dev/sda1             Use the squashfs file from directory 'live' of the specified device
                                     Setup can be done booting 'grml tohd=/dev/sda1' or
-                                    running 'rsync -a --progress /live/image/live /mnt/sda1/'.
-grml isofrom=/dev/sda1/grml.iso     Use specified ISO image for booting.
+                                    running 'rsync -a --progress /live/image/live /mnt/sda1/'
+grml bootfrom=removable             Restrict search for the live media to removable type only.
+grml bootfrom=removable-usb         Restrict search for the live media to usb mass storage only.
+grml isofrom=/dev/sda1/grml.iso     Use specified ISO image for booting
                                     Useful when booting as a rescue system from harddisk - just boot
                                     the according grml kernel and initrd using the bootoptions
-                                    "boot=live isofrom=/dev/sda1/grml.iso".
+                                    "boot=live isofrom=/dev/sda1/grml.iso"
                                     Notice: "fromiso" does the same as "isofrom", it's just there
-                                    to prevent any typing errors.
-
-grml live-media-path=live           Sets the path to the live filesystem on the medium.
-                                    By default, it is set to /live.
+                                    to prevent any typing errors
+grml findiso=/grml_2009.05.iso      Look for the specified ISO file on all disks where it usually
+                                    looks for the .squashfs file (so you don't have to know the device name
+                                    as in isofrom=....). [Available since grml 2009.05]
+grml live-media-path=live           Sets the path to the live filesystem on the medium
+                                    By default, it is set to /live
 grml module=grml                    Instead of using the default "$name.module" another file can
                                     be specified without the extension ".module"; it should be placed
-                                    on "/live" directory of the live medium.
+                                    on "/live" directory of the live medium
                                     Useful for Multiboot USB pen, see
                                     http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
 
@@ -104,7 +122,7 @@ grml debug                          Get shells during process of booting, using
 grml debug=noscreen                 Get shells during process of booting, verbose, but without using GNU screen
 grml nocolor                        Disable colorized output while booting
 grml log                            Log error messages while booting to /tmp/grml.log.`date +%Y%m%d`"
-                                    and /var/log/boot.
+                                    and /var/log/boot
 grml testcd                         Check CD data integrity and md5sums
 
 Service related settings:
@@ -129,18 +147,24 @@ grml distcc=$NETWORK,$INTERFACE     Activate distcc-daemon to listen on specifie
 grml gcc=3.4 gpp=3.4                Link /usr/bin/gcc, /usr/bin/cpp and /usr/bin/c++ to specified version
 grml startx{=windowmanager}         Start X window system automatically
                                     Default window manager (if not provided): wm-ng (wrapper around fluxbox)
+grml nostartx                       If using startx as default bootoption the nostartx *disables* automatic
+                                    startup of X again. (This bootoption is relevant for grml based derivatives
+                                    which decide to enable startx by default only, plain grml does not use
+                                    automatic startup of X by default.)
 
 Accessibility related settings:
 -------------------------------
 grml blind                          Start Braille-Terminal (no X)
+grml hwspeak                        Probe all available speakup hardware modules
 grml swspeak                        Prepare system for use with software synthesizer through speakup
                                     Run 'swspeak' after booting up to activate sound output
-grml swspeak=espeak                 Use espeakup (if available) as connector to speakup.
+grml swspeak=espeak                 Use espeakup (if available) as connector to speakup
                                     Run 'swspeak' after booting up to activate sound output
-grml swspeak=speechd                Use speech-dispatcher / speechd-up (if available) as connector to speakup.
+grml swspeak=speechd                Use speech-dispatcher / speechd-up (if available) as connector to speakup
                                     Run 'swspeak' after booting up to activate sound output
 grml brltty=type,port,table         Parameters for Braille device (e.g.: brltty=al,/dev/ttyS0,text.de.tbl)
-grml speakup_synth=...              Use speakup kernel module with given hardware type
+grml speakup.synth=...              Use speakup kernel module with given hardware type
+                                    Usage example: speakup.synth=apollo
 
 Hardware related settings:
 --------------------------
@@ -149,6 +173,7 @@ grml noswraid                       Disable scanning for software raid arrays (c
 grml swraid                         Enable automatic assembling of software raid arrays
 grml nolvm                          Disable scanning for Logical Volumes (LVM)
 grml lvm                            Automatically activate Logival Volumes (LVM) during boot
+grml readonly                       Make sure all harddisk devices (/dev/hd* /dev/sd*) are forced to read-only mode
 grml xmodule=ati|fbdev|i810|mga     Use specified X.org-Module (1)
 grml xmodule=nv|radeon|savage|s3    Use specified X.org-Module (2)
 grml xmodule=radeon|svga|i810       Use specified X.org-Module (3)
@@ -172,8 +197,11 @@ grml pci=irqmask=0x0e98             Try this, if PS/2 mouse doesn't work *)
 grml pci=bios                       Workaround for bad PCI controllers
 grml ide2=0x180 nopcmcia            Boot from PCMCIA-CD-ROM (some notebooks)
 grml mem=128M                       Specify Memory size in MByte
-grml dma                            Enable DMA accelleration for ALL IDE-Drives
-grml nodma ide=nodma                Disable DMA accelleration for ALL IDE-Drives
+grml libata.force=[ID:]VAL          Force configurations for libata.
+                                    Usage example: grml libata.force=1:pio4
+                                    to force pio4 mode on device "ata1:00:"
+grml libata.dma=0                   Disable DMA on PATA and SATA devices
+grml libata.ignore_hpa=1            Disable host protected area (which should enable the whole disk)
 grml vga=normal [video=ofonly]      No-framebuffer mode (does not influence X)
 grml vga=ask [video=ofonly]         Display menu for framebuffer mode
 
@@ -227,25 +255,25 @@ driver during that procedure.
 
 *) If your grml-CD makes strange noises during boot, or you see frequent
 errors like "squashfs: read error", or programs are crashing randomly,
-then your CD image is probably defective or incomplete, or your CD-burner
-created a defective CD due to wrong writing speed or bad media. This is
-the most common error reported.  Please boot with "grml testcd" to check
-if the CD is OK, and/or even better, verify the MD5 checksums that are
-present on the mirrors before writing the CD.  Check your CD low-level
-via running 'readcd -c2scan dev=/dev/cdrom'. In some cases, defective
-IDE controllers cause this error if you have DMA enabled. Also, please
-read the grml-FAQ.
+then your CD image is probably defective or incomplete, your CD-burner
+created a defective CD due to wrong writing speed or bad media or your
+CD-ROM drive is broken. This is the most common error reported.  Please
+boot with "grml testcd" to check if the CD is OK, and/or even better,
+verify the MD5 checksums that are present on the mirrors before writing
+the CD.  Check your CD low-level via running 'readcd -c2scan
+dev=/dev/cdrom'. In some cases, defective IDE controllers cause this
+error if you have DMA enabled. Also, please read the grml-FAQ.
 
 *) In case of a failing hardware autodetection, try booting with any of
 the "no-" options as shown in the table above, like in
    grml noagp noapm noapic acpi=off nodma
 to skip some critical parts of the autodetection system.
 
-*) Some boards apparently don't pass the proper memory size to the
-linux-kernel. It may cause the message "Panic: cannot mount root file
-system" and the system hangs. Use "grml mem=128M" to solve that
-problem if your system has 128MByte memory for example (caution:
-you MUST use a capital "M" here).
+*) Some boards (especially those with E-ISA slots) apparently don't pass
+the proper memory size to the linux-kernel. It may cause the message
+"Panic: cannot mount root file system" and the system hangs. Use "grml
+mem=128M" to solve that problem if your system has 128MByte memory for
+example (caution: you MUST use a capital "M" here).
 
 *) The "myconfig=/dev/partition" option allows you to reconfigure the
 system after autoconfiguration by running a bourne shell script called