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