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