debian/manpage/casper.7

   1 .TH CASPER 7 "Thu,  28 Sep 2006" "1.69" "Initramfs-tools hook"
   2
   3 .SH NAME
   4 casper \- a hook for initramfs-tools to boot live systems.
   5
   6 .SH SYNOPSIS
   7 .B BOOT=casper
   8 As kernel parameter boot prompt.
   9
  10 .SH DESCRIPTION
  11 Casper is an hook for initramfs-tools used to generate initramfs able to boot live systems like those created by make-live, this includes the Debian-Live isos, netboot tarballs, and usb stick image and Ubuntu live cds. At boot time it will look for a (often read-only) media containing a "/casper" directory where root filesystems (often squashfs compressed) lies and create, using unionfs, a writable environment for debian like systems to boot from.
  12
  13 .SH RECOGNIZED BOOT OPTIONS
  14 .TP
  15 .B casper-getty
  16 This enable a special serial login shell (experimental).
  17 .TP
  18 .BI "hostname=" HOSTNAME " , userfullname=" USERFULLNAME " , username=" USERNAME
  19 Those parameters lets you override values read from the config file.
  20 .TP
  21 .BI "keyb=" KEYBOARD " | kbd-chooser/method=" KEYBOARD " ;  console-setup/layoutcode=" LAYOUT " , console-setup/variantcode=" VARIANT " , console-setup/modelcode" CODE
  22 Configure the running keyboard as specified, if this one misses casper behave as "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 layout, variant, and code (no defaults).
  23 .TP
  24 .BI ip= IFACE,ADDRESS,NETMASK,GATEWAY [ :IFACE,ADDRESS,NETMASK,GATEWAY "]*"
  25 Let you specify the name(s) and the options of the interface(s) that should be configured at boot time. Do not specify it if you want to use dhcp (default).
  26 .TP
  27 .BR ip[= frommedia ]
  28 This way dhcp and static configuration is just skipped and the system will use the (must be) media-preconfigured /etc/network/interfaces instead.
  29 .TP
  30 .BI "locale=" LOCALE " | debian-installer/locale=" LOCALE
  31 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).
  32 .TP
  33 .BI live-media= DEVICE " | bootfrom=" DEVICE
  34 If you specify one of this two equivalent forms, casper will try first to look on this device for the "/casper" directory where it should lie the read-only root filesystem, if it did not find it, the normal scan for block devices will be performed.
  35 .TP
  36 .BR "netboot[=" nfs "|" cifs ]
  37 This tells casper to look for a network mount, to be specified by parameter "nfsroot=" (with optional "nfsopts="), for the "/casper" dirs where root filesystem lies. With no args, will try cifs first, and if it fails nfs.
  38 .TP
  39 .B persistent
  40 Casper will look for persistent and snapshot partitions or files labeled "casper-rw", "home-rw", and files called "casper-sn*", "home-sn*" and will try to, in order: mount as /cow the first, mount the second in /home, and just copy the contents of the latters in appropriate locations (snapshots). Snapshots will be tried to be updated on reboot/shutdown. Look at casper-snapshot(1) for more informations.
  41 .TP
  42 .B "showmounts"
  43 Specifying this will make casper to show on "/" the ro filesystems (mostly compressed) on /casper. This is not enabled by default because could lead to problems by application like "mono" which store binary paths on installation.
  44 .TP
  45 .BI "todisk=" DEVICE
  46 Adding this parameter, casper will try to copy to the specified device the whole read-only media before mounting the root filesystem, it could need a lot of free space, according to one used by the read-only media. Subsequent boots should then skip this step and just specify the "live-media=DEVICE" boot parameter with the same DEVICE used this time.
  47 .TP
  48 .B toram
  49 Adding this parameter, casper will try to copy to ram the whole read-only media before mounting the root filesystem, it could need a lot of ram, according to the space used by the read-only media.
  50
  51 .SH FILES
  52 .B /etc/casper.conf
  53 some variables could be configured via this config file.
  54
  55 .SH BUGS
  56 .B casper
  57 works fully on amd64, i386 and ppc, it should too on other archs.
  58
  59 .SH HOMEPAGE
  60 Debian Live project <http://live.debian.net/>
  61
  62 .SH SEE ALSO
  63 .BR casper-snapshot(1), initramfs-tools(8), make-live(1), make-live.conf(5)
  64
  65 .SH AUTHOR
  66 casper was written by Tollen Fog Heen <tfheen@canonical.com>, Matt Zimmerman <mdz@canonical.com>, and Marco Amadori <marco.amadori@gmail.com>.
  67 .TP
  68 This manual page was written by Marco Amadori <marco.amadori@gmail.com>,
  69 for the Debian project (but may be used by others).