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