Update cheatcodes documentation to clarify isolinux vs GRUB situation
[grml-live.git] / templates / GRML / grml-cheatcodes.txt
index babfbb6..066fee2 100644 (file)
@@ -1,10 +1,11 @@
       CHEATCODES AND HINTS FOR GRML
 ==============================================================================
 
-These options work from the (isolinux/grub) bootprompt of Grml based (live) systems.
+Isolinux bootprompt options:
+----------------------------
 
-The following kernel options are available (do NOT use them as 'grml $OPTION',
-use them as '$OPTION'!):
+These options work from the isolinux bootprompt of Grml based (live) systems.
+(Do NOT use them as 'grml $OPTION', use them as '$OPTION'!):
 
 grml                                Use default settings (same as just pressing return)
 grml2ram                            Copy Grml's squashfs file to RAM and
@@ -16,14 +17,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 +63,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
@@ -115,7 +111,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
@@ -129,12 +125,10 @@ 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 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 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 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
@@ -154,20 +148,27 @@ grml debug=1                        Get shells during process of booting, using
                                     display shell code being executed in initramfs.
 grml debug=noscreen                 Get shells during process of booting, verbose, but without using GNU screen
 grml nocolor                        Disable colorized output while booting
+                                    Also set SYSTEMD_COLORS=0 to disable colors in systemd output
 grml log                            Log error messages while booting to /tmp/grml.log.`date +%Y%m%d`"
                                     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 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
@@ -185,12 +186,17 @@ grml nostartx                       If using startx as default bootoption the no
                                     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: only available since release 2011.12]
+                                    [Note: Grml 2011.12+ doesn't include a VNC client.]
 
+Accessibility related settings:
+-------------------------------
+grml brltty=type,port,table         Parameters for Braille device (e.g.: brltty=al,/dev/ttyS0,text.de.tbl)
+                                    See http://mielke.cc/brltty/guidelines.html for documentation.
 
 Hardware related settings:
 --------------------------
@@ -202,8 +208,9 @@ 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)
@@ -233,6 +240,8 @@ 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.
+grml mgag200.modeset=0 nomodeset    Disable Kernel Mode Setting (KMS) for MGAG200 driver.
 
 Installation related settings:
 ------------------------------
@@ -246,12 +255,12 @@ 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.
 
@@ -296,7 +305,7 @@ as option to mkisofs. Otherwise your CD won't be bootable. The
 directory live, containing the squashfs compressed filesystem file,
 must be located in the top level directory of the CD.
 
-*) Caution: screensavers: Don't start vlock or any other screensaver
+*) Caution: screensavers: Don't start physlock or any other screensaver
 that requires a password manually. There are no default passwords on
 the live system - all accounts are LOCKED by default for security reasons.
 Instead just invoke the script grml-lock which prompts for setting a