grml-cheatcodes.txt: update and extend documentation regarding live-media-path
[grml-live.git] / templates / GRML / grml-cheatcodes.txt
index 360db5c..d652778 100644 (file)
@@ -63,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 persistent                     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
@@ -114,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 /live/image/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 +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 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).
@@ -159,14 +158,13 @@ grml testcd                         Check CD data integrity and md5sums
 
 Service related settings:
 -------------------------
-grml ssh=password                   Set password for user grml and start ssh-server
+grml ssh=password                   Set password for root & grml user 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
@@ -184,12 +182,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:
 --------------------------
@@ -203,6 +206,7 @@ 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 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)