Adding casper 1.81+debian-1.
[live-boot-grml.git] / debian / manpage / casper.7
index c195d9f..8c6420a 100644 (file)
@@ -12,11 +12,17 @@ Casper is a hook for initramfs-tools used to generate an initramfs capable to bo
 
 .SH RECOGNIZED BOOT OPTIONS
 .TP
+.BI "access=" ACCESS
+Set the accessibility level for physically or visually impared users. 
+ACCESS must be one of v1, v2, v3, m1, or m2. v1=lesser visual impairment, v2=moderate visual impairment, v3=blindness, m1=minor motor difficulties, m2=moderate motor difficulties.
+.TP
 .B casper-getty
-This enables a special "serial" login shell (experimental).
+This changes the auto-login on virtual terminals to use the (experimental) casper-getty code.
+With this option set the standard kernel argument "console=" is parsed and if a serial console is specified then casper-getty is used to autologin on the serial console.
 .TP
-.B xdebconf
-uses xdebconfigurator, if present on the rootfs, to configure X instead of the standard procedure (experimental).
+.BI "console=" TTY "," SPEED
+Set the default console to be used with the "casper-getty" option.
+Example: "console=ttyS0,115200"
 .TP
 .BI "hostname=" HOSTNAME " , userfullname=" USERFULLNAME " , username=" USERNAME
 Those parameters lets you override values read from the config file.
@@ -24,6 +30,9 @@ Those parameters lets you override values read from the config file.
 .BI "{keyb|kbd-chooser/method}=" KEYBOARD " , {klayout|console-setup/layoutcode}=" LAYOUT " , {kvariant|console-setup/variantcode}=" VARIANT " , {kmodel|console-setup/modelcode}=" CODE " ,  koptions=" OPTIONS
 Configure the running keyboard as specified, if this one misses casper behaves as if "keyb=us" was specified. It will be interfered from "locale=" if locale is only 2 lowecase letters as a special case. You could also specify console layout, variant, code, and options (no defaults).
 .TP
+.B integrity-check
+If specified, an MD5 sum is calculated on the live media during boot and compared to the value found in md5sum.txt found in the root directory of that partition.
+.TP
 .BI ip= IFACE,ADDRESS,NETMASK,GATEWAY [ :IFACE,ADDRESS,NETMASK,GATEWAY "]*"
 Let you specify the name(s) and the options of the interface(s) that should be configured at boot time. Do not specify this if you want to use dhcp (default).
 .TP
@@ -36,8 +45,14 @@ If you specify one of this two equivalent forms, casper will first try to find t
 .BI "live-media-offset=" BYTES
 This way you could tell casper that your image starts at offset BYTES in the above specified or autodiscovered device, this could be useful to hide the debian-live iso or image inside another iso or image, to create "clean" images.
 .TP
+.BI "live-media-timeout=" SECONDS
+Set the timeout in seconds for the device specified by "live-media=" to become ready before giving up.
+.TP
 .BI "locale=" LOCALE " | debian-installer/locale=" LOCALE
-Configure the running locale as specified, if not present the live-media rootfs configured locale will be used and if also this one misses casper behave as "locale=en_US.UTF-8" was specified. If only 2 lowercase letter are specified (like "it"), the "maybe wanted" locale is generated (like it:IT.UTF-8), in this case if also "keyb=" is unspecified is set with those 2 lowercase letters (keyb=it).
+Configure the running locale as specified, if not present the live-media rootfs configured locale will be used and if also this one misses casper behave as "locale=en_US.UTF-8" was specified. If only 2 lowercase letter are specified (like "it"), the "maybe wanted" locale is generated (like it:IT.UTF-8), in this case if also "keyb=" is unspecified is set with those 2 lowercase letters (keyb=it). Beside that facility, only UTF8 locales are supported by casper.
+.TP
+.BI "module=" NAME
+Instead of using the default optional file "order.lst" (see below) another file could be specified without the extension ".lst"; it should be placed on /casper/ directory of the live medium.
 .TP
 .BR "netboot[=" nfs "|" cifs ]
 This tells casper to perform a network mount. The parameter "nfsroot=" (with optional "nfsopts="), should specify where is the location of the root filesystem.  With no args, will try cifs first, and if it fails nfs.
@@ -62,11 +77,17 @@ A path to a file present on the rootfs could be used to preseed debconf database
 .TP
 .BI "package/question=" VALUE
 All debian installed packages could be preseeded from command-line that way, beware of blanks spaces, they will interfere with parsing, use a preseed file in this case.
+.TP
+.B xdebconf
+uses xdebconfigurator, if present on the rootfs, to configure X instead of the standard procedure (experimental).
+.TP
 
 .SH FILES
 .B /etc/casper.conf
 some variables can be configured via this config file.
-
+.TP
+.B /casper/order.lst
+This optional file contains a list of white-space or carriage-return-separated file names corresponding to disk images in the /casper directory. If this file exists, only images listed here will be merged into the root unionfs, and they will be loaded in the order listed here. The first entry in this file will be the "lowest" point in the unionfs, and the last file in this list will be on the "top" of the unionfs, directly below /cow.  Without this file, any images in the /casper directory are loaded in alphanumeric order.
 .SH BUGS
 .B casper
 works fully on amd64, i386 and ppc, it should also run on other archs.