No longer include MirOS BSD in isolinux/syslinux boot menu
[grml-live.git] / templates / GRML / grml-cheatcodes.txt
index 102ee32..12fafdd 100644 (file)
@@ -16,14 +16,12 @@ fb800x600                           Use fixed framebuffer graphics (3)
 nofb                                Disable framebuffer
 floppy                              Boot from floppydisk
 hd / hd1 / hd2 / hd3                Boot from (local) primary / secondary /... harddisk
-failsafe                            Boot with (almost) no HW-detection
 debug                               Get shells during process of booting for debugging
 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 a getty
 grub                                Boot Grub bootloader (special all-in-one-image)
 dos                                 Boot FreeDOS
-bsd                                 Boot MirOS BSD
 hdt                                 Boot Hardware Detection Tool (from syslinux project)
 
 Further documentation regarding the boot process can be found at:
@@ -64,14 +62,11 @@ grml file=foobar.tbz                Use specified file as name for configuration
                                     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=nofiles             Enable persistency feature, more details available at
+grml persistence                    Enable persistency feature, more details available at
                                     http://wiki.grml.org/doku.php?id=persistency
-                                    Notice that the "=nofiles" argument is optional, though recommended
-                                    as default setting.
 grml hostname=...                   Set hostname to given argument
 grml hostname                       Set a random hostname
                                     [Note: only available with releases newer than 2010.04]
-grml nodhcphostname                 Do not to set the hostname according to the dns information
 grml nonetworking                   Do not create/overwrite /etc/network/interface during startup
 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
@@ -91,14 +86,15 @@ grml debs                           Install all Debian packages from the "debs"
 grml debs=path-name-wildcard        Install Debian packages from DCS directory (see myconfig=,
                                     typically the root of your ISO image). If path does not contain a
                                     "/" the package(s) will be installed from directory "debs" of the
-                                   DCS directory instead.  The "path-name-wildcard" can contain
-                                   wildcards (e.g. debs=rat* will install a packages starting with "rat"
-                                   from directory debs/).
+                                    DCS directory instead.  The "path-name-wildcard" can contain
+                                    wildcards (e.g. debs=rat* will install a packages starting with "rat"
+                                    from directory debs/).
 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
+grml nobeep                         Disable welcome chime, sounded before grml-quickconfig starts.
 
 Notice: Take a look at http://grml.org/config/ and 'man 1 grml-autoconfig'
 for more information regarding the configuration framework of Grml.
@@ -114,7 +110,7 @@ grml tohd=/dev/sda1                 Copy Grml's squashfs file to harddisk partit
                                     use via "grml bootfrom=/dev/sda1"
 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/'
+                                    running 'rsync -a --progress /lib/live/mount/medium/live /media/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
@@ -128,8 +124,14 @@ grml findiso=/grml_2010.12.iso      Look for the specified ISO file on all disks
                                     as in isofrom=....).
 grml fetch=$IP/filename.squashfs    Download a squashfs image from a given url, copying to ram and booting it.
                                     [Note: releases before 2011.05 didn't support DNS but IP only.]
-grml live-media-path=live           Sets the path to the live filesystem on the medium
-                                    By default, it is set to /live
+grml live-media-path=/live/grml...  Sets the path to the live filesystem on the medium
+                                    By default, it is set to /live/$GRML_FLAVOUR/ (where $GRML_FLAVOUR
+                                    is corresponding to grml64-full, grml32-full, grml64-small,...
+                                    [Note: this option is mandatory since release 2011.12]
+grml nostats                        Don't send any information to the Grml project at startup.
+                                    Parameters sent are Grml version, if the cpu supports 64bit,
+                                    anonymized boot parameters and boot source (remote or local).
+                                    [Note: only available since release 2011.12]
 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
@@ -153,17 +155,22 @@ grml log                            Log error messages while booting to /tmp/grm
                                     and /var/log/boot
 grml testcd                         Check CD data integrity and md5sums
 
+Security / login related settings:
+----------------------------------
+
+grml ssh=password                   Set password for root & grml user and start ssh-server
+grml passwd=...                     Set password for root & grml user
+grml encpasswd=....                 Set specified hash as password for root & grml user, use e.g.
+                                    'mkpasswd -H md5' to generate such a hash (available in Grml >=2013.09)
+
 Service related settings:
 -------------------------
-grml ssh=password                   Set password for user grml and start ssh-server
 grml startup=script                 Start $script instead of grml-quickconfig on startup
 grml nosyslog                       Do not start syslog daemon
 grml nogpm                          Disable GPM daemon
 grml noconsolefont                  Disable setting of console font (using consolechars)
 grml noblank                        Disable console blanking
-grml tsplash                        Text based bootsplash
 grml noquick                        Disable grml-quickconfig startup script
-grml small                          Do not start that many consoles
 grml wondershaper=eth0,1000,500     Set up basic traffic shaping
 grml services={postfix,mysql,...}   Start service(s) which have an init-script (/etc/init.d/)
 grml welcome                        Welcome message via soundoutput
@@ -179,20 +186,19 @@ grml nostartx                       If using startx as default bootoption the no
                                     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.)
+grml vnc=password                   Start VNC server with startup of X.org and sets the password to the specified
+                                    one. To automatically start the VNC server use the startx bootoption.
+                                    [Note: Grml 2011.12+ doesn't include a VNC server.]
+grml vnc_connect=host[:port]        Connect to a listening VNC client ("vncviewer -listen" reverse connection).
+                                    Can be used to connect from devices behind firewalls as connection is
+                                    initiated from the VNC server instead of the VNC client. Has to be
+                                    combined with the vnc bootoption.
+                                    [Note: Grml 2011.12+ doesn't include a VNC client.]
 
 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
-                                    Run 'swspeak' after booting up to activate sound output
-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
-                                    Usage example: speakup.synth=apollo
+                                    See http://mielke.cc/brltty/guidelines.html for documentation.
 
 Hardware related settings:
 --------------------------
@@ -204,16 +210,15 @@ grml dmraid=on                      Automatically enable any present dmraid devi
 grml dmraid=off                     Actively try to stop any present dmraid devices.
 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 read-only                      Make sure all harddisk devices (/dev/hd* /dev/sd*) are forced to read-only mode
 grml ethdevice=...                  Use specified network device for network boot instead of default (eth0)
+grml ethdevice-timeout=...          Use specified network configuration timeout instead of default (15sec)
 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)
-grml no{acpi,agp,apm,cpu,dhcp}      Skip parts of HW-detection (1)
+grml no{acpi,agp,cpu,dhcp}          Skip parts of HW-detection (1)
 grml no{dma,fstab,modem}            Skip parts of HW-detection (2)
 grml no{pcmcia,scsi,swap,usb}       Skip parts of HW-detection (3)
-grml 915resolution=...              Start resolution modify tool for Intel graphic chipset
-                                    usage: $MODE,$XRESO,$YRESO
 grml blacklist=modulename[,module2] Completely disable loading of specified module(s) via
                                     blacklisting through udev's /etc/modprobe.d/grml
 grml fwtimeout=50                   Set firmware timeout via /sys/class/firmware/timeout to specified value
@@ -222,8 +227,6 @@ grml vol=number                     Set mixer volumes to level $number
 grml micvol=number                  Set mixer volume of microphone to level $number (default: 0)
 grml pnpbios=off                    No PnP Bios initialization
 grml acpi=off                       Disable ACPI Bios completely
-grml nousb2                         Disable initialization of USB 2.x controller(s)
-grml nousb                          Disable initialization of USB in booting sequence
 grml nofirewire                     Disable initialization of firewire devices in booting sequence
 grml pci=irqmask=0x0e98             Try this, if PS/2 mouse doesn't work *)
 grml pci=bios                       Workaround for bad PCI controllers
@@ -239,11 +242,12 @@ grml vga=ask                        Display menu for framebuffer mode
 grml radeon.modeset=0  nomodeset    Disable Kernel Mode Setting (KMS) for Radeon driver.
 grml i915.modeset=0    nomodeset    Disable Kernel Mode Setting (KMS) for Intel driver.
 grml nouveau.modeset=0 nomodeset    Disable Kernel Mode Setting (KMS) for Nouveau driver.
+grml cirrus.modeset=0  nomodeset    Disable Kernel Mode Setting (KMS) for Cirrus driver.
 
 Installation related settings:
 ------------------------------
 
-Caution: do *NOT* use the grml2hd and/or debian2hd bootoption if you do not know what you are doing!
+Caution: do *NOT* use the debian2hd bootoption if you do not know what you are doing!
 
 Install plain Debian via debian2hd bootoption (which runs grml-debootstrap in non-interactive mode):
 
@@ -252,31 +256,15 @@ debian2hd <options>                 ... whereas valid options for debian2hd are:
   target=       target partition/directory of the new Debian system, e.g.: target=/dev/sda1
   grub=         where to install grub to, e.g.: grub=/dev/sda
   release=      specify release of new Debian system (default is stable), e.g.: release=sid
-  mirror=       specify mirror for apt-get/aptitude, e,g.: mirror=http://cdn.debian.net/debian
+  mirror=       specify mirror for apt-get/aptitude, e,g.: mirror=http://ftp.debian.org/debian
   password=     set passwort of user root without prompting for it, e.g.: password=AiTh5ahn
 
   Usage example for automatic installation:
 
-    debian2hd target=/dev/sda1 grub=/dev/sda mirror=http://cdn.debian.net/debian password=foobar
+    debian2hd target=/dev/sda1 grub=/dev/sda mirror=http://ftp.debian.org/debian password=foobar
 
   See http://grml.org/grml-debootstrap/ for more information.
 
-Install grml via grml2hd bootoption (which runs grml2hd in non-interactive mode):
-
-grml2hd <options>                   ... whereas valid options for grml2hd are:
-
-   user=                user name for user which should be used at hd-install
-   filesystem={ext2|ext3|reiserfs|reiser4|jfs|xfs}      filesystem to be used
-   mbr=/dev/...  partition where MBR should be installed (default:=partition)
-   partition=/dev/...                partition where grml should be installed
-
-  Usage example for booting:
-   grml2hd partition=/dev/sda4 mbr=/dev/sda filesystem=ext3 user=mika
-
-  Passwords of user root and user are "grml" - please adjust after hd-install!
-
-  See http://grml.org/grml2hd/ for more information.
-
 Additional notes:
 -----------------
 
@@ -293,7 +281,7 @@ 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
+   grml noagp noapic acpi=off nodma
 to skip some critical parts of the autodetection system.
 
 *) Some boards (especially those with E-ISA slots) apparently don't pass