Merge remote-tracking branch 'origin/github/pr/60'
[grml-live.git] / templates / GRML / grml-cheatcodes.txt
1       CHEATCODES AND HINTS FOR GRML
2 ==============================================================================
3
4 Isolinux bootprompt options:
5 ----------------------------
6
7 These options work from the isolinux bootprompt of Grml based (live) systems.
8 (Do NOT use them as 'grml $OPTION', use them as '$OPTION'!):
9
10 grml                                Use default settings (same as just pressing return)
11 grml2ram                            Copy Grml's squashfs file to RAM and
12                                     run from there (compare with 'grml toram')
13 memtest                             Run Memtest86+ instead of Linux
14 fb1280x1024                         Use fixed framebuffer graphics (1)
15 fb1024x768                          Use fixed framebuffer graphics (2) [notice: Grml's default]
16 fb800x600                           Use fixed framebuffer graphics (3)
17 nofb                                Disable framebuffer
18 floppy                              Boot from floppydisk
19 hd / hd1 / hd2 / hd3                Boot from (local) primary / secondary /... harddisk
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 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 persistence                    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 nonetworking                   Do not create/overwrite /etc/network/interface during startup
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 dns=8.8.8.8,8.8.4.4            Set DNS resolvers during boot and for live system.
78 grml ip=...                         Standard Linux kernel ip= boot option. Arguments:
79                                     clientip:nfsserverip:gwip:netmask:hostname:device:autoconf
80                                     Valid values for autoconf: off, on, dhcp, bootp, rarp, both.
81                                     Almost everything is optional. Most common form: ip=dhcp
82 grml mypath=...                     Add specified option into $PATH of Zsh
83                                     For example when using "grml mypath=/foobar" then /foobar
84                                     will be added to the end of $PATH inside Zsh
85 grml debs                           Install all Debian packages from the "debs" directory of your DCS
86                                     directory (see myconfig=, typically the root of your ISO image).
87 grml debs=path-name-wildcard        Install Debian packages from DCS directory (see myconfig=,
88                                     typically the root of your ISO image). If path does not contain a
89                                     "/" the package(s) will be installed from directory "debs" of the
90                                     DCS directory instead.  The "path-name-wildcard" can contain
91                                     wildcards (e.g. debs=rat* will install a packages starting with "rat"
92                                     from directory debs/).
93 grml scripts=path-name              Execute script (defaulting to grml.sh) inside DCS dir. Path names
94                                     allowed. If path-name points to a directory, all scripts found in
95                                     the directory are executed.
96 grml config=path-name               Unpack archive that path-name points to
97 grml noautoconfig                   Disable searching for device labeled GRMLCFG
98 grml nobeep                         Disable welcome chime, sounded before grml-quickconfig starts.
99
100 Notice: Take a look at http://grml.org/config/ and 'man 1 grml-autoconfig'
101 for more information regarding the configuration framework of Grml.
102
103 Booting related options:
104 ------------------------
105 grml toram                          Copy the whole CD/medium to RAM and run from there
106 grml toram=filename.squashfs        Copy the specified file to RAM and run from there
107                                     Usage example: grml toram=grml-medium.squashfs
108                                     Notice: grml2ram is an alias for this option which
109                                     corresponds with the grml flavour settings by default
110 grml tohd=/dev/sda1                 Copy Grml's squashfs file to harddisk partition for later
111                                     use via "grml bootfrom=/dev/sda1"
112 grml bootfrom=/dev/sda1             Use the squashfs file from directory 'live' of the specified device
113                                     Setup can be done booting 'grml tohd=/dev/sda1' or
114                                     running 'rsync -a --progress /lib/live/mount/medium/live /media/sda1/'
115 grml bootfrom=removable             Restrict search for the live media to removable type only.
116 grml bootfrom=removable-usb         Restrict search for the live media to usb mass storage only.
117 grml isofrom=/dev/sda1/grml.iso     Use specified ISO image for booting
118                                     Useful when booting as a rescue system from harddisk - just boot
119                                     the according grml kernel and initrd using the bootoptions
120                                     "boot=live isofrom=/dev/sda1/grml.iso"
121                                     Notice: "fromiso" does the same as "isofrom", it's just there
122                                     to prevent any typing errors
123 grml findiso=/grml_2010.12.iso      Look for the specified ISO file on all disks where it usually
124                                     looks for the .squashfs file (so you don't have to know the device name
125                                     as in isofrom=....).
126 grml fetch=$IP/filename.squashfs    Download a squashfs image from a given url, copying to ram and booting it.
127                                     [Note: releases before 2011.05 didn't support DNS but IP only.]
128 grml live-media-path=/live/grml...  Sets the path to the live filesystem on the medium
129                                     By default, it is set to /live/$GRML_FLAVOUR/ (where $GRML_FLAVOUR
130                                     is corresponding to grml64-full, grml32-full, grml64-small,...
131                                     [Note: this option is mandatory since release 2011.12]
132 grml module=grml                    Instead of using the default "$name.module" another file can
133                                     be specified without the extension ".module"; it should be placed
134                                     on "/live" directory of the live medium
135                                     Useful for Multiboot USB pen, see
136                                     http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
137 grml bootid=mybootid                Use specified argument as identifier for the ISO.
138                                     mybootid is specified in /conf/bootid.txt on the ISO.
139                                     [Note: only available since release 2010.04]
140 grml ignore_bootid                  Disable bootid verification.
141                                     [Note: only available since release 2010.04]
142
143
144 Debugging related settings:
145 ---------------------------
146 grml debug                          Get shells during process of booting, using GNU screen, be verbose
147 grml debug=1                        Get shells during process of booting, using GNU screen, be verbose and
148                                     display shell code being executed in initramfs.
149 grml debug=noscreen                 Get shells during process of booting, verbose, but without using GNU screen
150 grml nocolor                        Disable colorized output while booting
151                                     Also set SYSTEMD_COLORS=0 to disable colors in systemd output
152 grml log                            Log error messages while booting to /tmp/grml.log.`date +%Y%m%d`"
153                                     and /var/log/boot
154 grml testcd                         Check CD data integrity and md5sums
155
156 Security / login related settings:
157 ----------------------------------
158
159 grml ssh=password                   Set password for root & grml user and start ssh-server
160 grml passwd=...                     Set password for root & grml user
161 grml encpasswd=....                 Set specified hash as password for root & grml user, use e.g.
162                                     'mkpasswd -H md5' to generate such a hash (available in Grml >=2013.09)
163
164 Service related settings:
165 -------------------------
166 grml startup=script                 Start $script instead of grml-quickconfig on startup
167 grml nosyslog                       Do not start syslog daemon
168 grml nogpm                          Disable GPM daemon
169 grml noconsolefont                  Disable setting of console font (using consolechars)
170 grml noblank                        Disable console blanking
171 grml noquick                        Disable grml-quickconfig startup script
172 grml wondershaper=eth0,1000,500     Set up basic traffic shaping
173 grml services={postfix,mysql,...}   Start service(s) which have an init-script (/etc/init.d/)
174 grml welcome                        Welcome message via soundoutput
175 grml noeject                        Do NOT eject CD after halt/reboot
176 grml noprompt                       Do NOT prompt to remove the CD when halting/rebooting the system
177 grml distcc=$NETWORK,$INTERFACE     Activate distcc-daemon to listen on specified network
178                                     and interface, usage example:
179                                     distcc=192.168.0.1/24,eth0
180 grml gcc=3.4 gpp=3.4                Link /usr/bin/gcc, /usr/bin/cpp and /usr/bin/c++ to specified version
181 grml startx{=windowmanager}         Start X window system automatically
182                                     Default window manager (if not provided): wm-ng (wrapper around fluxbox)
183 grml nostartx                       If using startx as default bootoption the nostartx *disables* automatic
184                                     startup of X again. (This bootoption is relevant for grml based derivatives
185                                     which decide to enable startx by default only, plain grml does not use
186                                     automatic startup of X by default.)
187 grml vnc=password                   Start VNC server with startup of X.org and sets the password to the specified
188                                     one. To automatically start the VNC server use the startx bootoption.
189                                     [Note: Grml 2011.12+ doesn't include a VNC server.]
190 grml vnc_connect=host[:port]        Connect to a listening VNC client ("vncviewer -listen" reverse connection).
191                                     Can be used to connect from devices behind firewalls as connection is
192                                     initiated from the VNC server instead of the VNC client. Has to be
193                                     combined with the vnc bootoption.
194                                     [Note: Grml 2011.12+ doesn't include a VNC client.]
195
196 Accessibility related settings:
197 -------------------------------
198 grml brltty=type,port,table         Parameters for Braille device (e.g.: brltty=al,/dev/ttyS0,text.de.tbl)
199                                     See http://mielke.cc/brltty/guidelines.html for documentation.
200
201 Hardware related settings:
202 --------------------------
203 grml swap                           Activate present/detected swap partitions
204 grml noswraid                       Disable scanning for software raid arrays (creates /etc/mdadm/mdadm.conf)
205 grml swraid                         Enable automatic assembling of software raid arrays
206 grml nodmraid                       Do not enable present dmraid devices.
207 grml dmraid=on                      Automatically enable any present dmraid devices.
208 grml dmraid=off                     Actively try to stop any present dmraid devices.
209 grml nolvm                          Disable scanning for Logical Volumes (LVM)
210 grml lvm                            Automatically activate Logival Volumes (LVM) during boot
211 grml read-only                      Make sure all harddisk devices (/dev/hd* /dev/sd*) are forced to read-only mode
212 grml ethdevice=...                  Use specified network device for network boot instead of default (eth0)
213 grml ethdevice-timeout=...          Use specified network configuration timeout instead of default (15sec)
214 grml xmodule=ati|fbdev|i810|mga     Use specified X.org-Module (1)
215 grml xmodule=nv|radeon|savage|s3    Use specified X.org-Module (2)
216 grml xmodule=radeon|svga|i810       Use specified X.org-Module (3)
217 grml no{acpi,agp,cpu,dhcp}          Skip parts of HW-detection (1)
218 grml no{dma,fstab,modem}            Skip parts of HW-detection (2)
219 grml no{pcmcia,scsi,swap,usb}       Skip parts of HW-detection (3)
220 grml blacklist=modulename[,module2] Completely disable loading of specified module(s) via
221                                     blacklisting through udev's /etc/modprobe.d/grml
222 grml fwtimeout=50                   Set firmware timeout via /sys/class/firmware/timeout to specified value
223 grml nosound                        Mute sound devices (notice: this does not deactivate loading of sound drivers!)
224 grml vol=number                     Set mixer volumes to level $number
225 grml micvol=number                  Set mixer volume of microphone to level $number (default: 0)
226 grml pnpbios=off                    No PnP Bios initialization
227 grml acpi=off                       Disable ACPI Bios completely
228 grml nofirewire                     Disable initialization of firewire devices in booting sequence
229 grml pci=irqmask=0x0e98             Try this, if PS/2 mouse doesn't work *)
230 grml pci=bios                       Workaround for bad PCI controllers
231 grml ide2=0x180 nopcmcia            Boot from PCMCIA-CD-ROM (some notebooks)
232 grml mem=128M                       Specify Memory size in MByte
233 grml libata.force=[ID:]VAL          Force configurations for libata.
234                                     Usage example: grml libata.force=1:pio4
235                                     to force pio4 mode on device "ata1:00:"
236 grml libata.dma=0                   Disable DMA on PATA and SATA devices
237 grml libata.ignore_hpa=1            Disable host protected area (which should enable the whole disk)
238 grml vga=normal                     No-framebuffer mode (does not influence X)
239 grml vga=ask                        Display menu for framebuffer mode
240 grml radeon.modeset=0  nomodeset    Disable Kernel Mode Setting (KMS) for Radeon driver.
241 grml i915.modeset=0    nomodeset    Disable Kernel Mode Setting (KMS) for Intel driver.
242 grml nouveau.modeset=0 nomodeset    Disable Kernel Mode Setting (KMS) for Nouveau driver.
243 grml cirrus.modeset=0  nomodeset    Disable Kernel Mode Setting (KMS) for Cirrus driver.
244 grml mgag200.modeset=0 nomodeset    Disable Kernel Mode Setting (KMS) for MGAG200 driver.
245
246 Installation related settings:
247 ------------------------------
248
249 Caution: do *NOT* use the debian2hd bootoption if you do not know what you are doing!
250
251 Install plain Debian via debian2hd bootoption (which runs grml-debootstrap in non-interactive mode):
252
253 debian2hd <options>                 ... whereas valid options for debian2hd are:
254
255   target=       target partition/directory of the new Debian system, e.g.: target=/dev/sda1
256   grub=         where to install grub to, e.g.: grub=/dev/sda
257   release=      specify release of new Debian system (default is stable), e.g.: release=sid
258   mirror=       specify mirror for apt-get/aptitude, e,g.: mirror=http://ftp.debian.org/debian
259   password=     set passwort of user root without prompting for it, e.g.: password=AiTh5ahn
260
261   Usage example for automatic installation:
262
263     debian2hd target=/dev/sda1 grub=/dev/sda mirror=http://ftp.debian.org/debian password=foobar
264
265   See http://grml.org/grml-debootstrap/ 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 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 physlock 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