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