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