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