path: root/tools/XBMCLive/live-initramfs/manpages/live-initramfs.en.7.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry lang="en">
<refmeta>
<refentrytitle>live-initramfs</refentrytitle>
<manvolnum>7</manvolnum>
</refmeta>
<refnamediv>
    <refname>live-initramfs</refname>
    <refpurpose>Debian Live initramfs hook</refpurpose>
</refnamediv>
<refsynopsisdiv>
<simpara>BOOT=live</simpara>

<simpara>as kernel parameter at boot prompt.</simpara>

</refsynopsisdiv>
<refsect1 id="_description">
<title>Description</title>
<simpara>live-initramfs is a hook for the initramfs-tools, used to generate a initramfs
capable to boot live systems, such as those created by <emphasis role="strong">live-helper</emphasis>(7).
This includes the Debian Live isos, netboot tarballs, and usb stick images.</simpara>

<simpara>At boot time it will look for a (read-only) media containing a "/live"
directory where a root filesystems (often a compressed filesystem image like
squashfs) is stored. If found, it will create a writable environment, using
aufs, for Debian like systems to boot from.</simpara>

<simpara>You probably do not want to install this package onto a non-live system,
although it will do no harm.</simpara>

<simpara>live-initramfs is a fork of <ulink url="http://packages.ubuntu.com/casper/">casper</ulink>.
casper was originally written by Tollef Fog Heen &lt;tfheen@canonical.com&gt;
and Matt Zimmerman &lt;mdz@canonical.com&gt;.</simpara>

</refsect1>
<refsect1 id="_boot_options">
<title>Boot options</title>
<simpara>Here is the complete list of recognized boot parameters by live-initramfs.</simpara>

<variablelist>
<varlistentry>
<term>
access=<emphasis role="strong">ACCESS</emphasis>
</term>
<listitem>
<simpara>
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.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
console=<emphasis role="strong">TTY,SPEED</emphasis>
</term>
<listitem>
<simpara>
Set the default console to be used with the "live-getty" option. Example:
"console=ttyS0,115200"
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
debug
</term>
<listitem>
<simpara>
Makes initramfs boot process more verbose.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
fetch=<emphasis role="strong">URL</emphasis>
</term>
<listitem>
<simpara>
Another form of netboot by downloading a squashfs image from a given url,
copying to ram and booting it. Due to current limitations in busyboxs wget
and DNS resolution, an URL can not contain a hostname but an IP only.
</simpara>
</listitem>
</varlistentry>
</variablelist>
<simpara>Not working: http://example.com/path/to/your_filesystem.squashfs
Working: http://1.2.3.4/path/to/your_filesystem.squashfs</simpara>

<simpara>Also note that therefore it's currently not possible to fetch an image from a
namebased virtualhost of an httpd if it is sharing the ip with the main httpd
instance.</simpara>

<variablelist>
<varlistentry>
<term>
hostname=<emphasis role="strong">HOSTNAME</emphasis>, username=<emphasis role="strong">USER</emphasis>, userfullname=<emphasis role="strong">USERFULLNAME</emphasis>
</term>
<listitem>
<simpara>
Those parameters lets you override values read from the config file.
</simpara>
<literallayout class="monospaced">ignore_uuid</literallayout>
</listitem>
</varlistentry>
</variablelist>
<simpara>Do not check that any UUID embedded in the initramfs matches the discovered
medium. live-initramfs may be told to generate a UUID by setting
LIVE_GENERATE_UUID=1 when building the initramfs.</simpara>

<variablelist>
<varlistentry>
<term>
integrity-check
</term>
<listitem>
<simpara>
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 the
live media.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
ip=<emphasis role="strong">[CLIENT_IP]:[SERVER_IP]:[GATEWAY_IP]:[NETMASK]:[HOSTNAME]:[DEVICE]:[AUTOCONF] [,[CLIENT_IP]:[SERVER_IP]:[GATEWAY_IP]:[NETMASK]:[HOSTNAME]:[DEVICE]:[AUTOCONF]]</emphasis>*
</term>
<listitem>
<simpara>
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).
It will be changed in a future release to mimick official kernel boot param
specification (e.g. ip=10.0.0.1::10.0.0.254:255.255.255.0::eth0,:::::eth1:dhcp).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
ip=[<emphasis role="strong">frommedia</emphasis>]
</term>
<listitem>
<simpara>
If this variable is set, dhcp and static configuration are just skipped and the
system will use the (must be) media-preconfigured /etc/network/interfaces
instead.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
{keyb|kbd-chooser/method}=<emphasis role="strong">KEYBOARD</emphasis>, {klayout|console-setup/layoutcode}=<emphasis role="strong">LAYOUT</emphasis>, {kvariant|console-setup/variantcode}=<emphasis role="strong">VARIANT</emphasis>, {kmodel|console-setup/modelcode}=<emphasis role="strong">CODE</emphasis>, koptions=<emphasis role="strong">OPTIONS</emphasis>
</term>
<listitem>
<simpara>
Configure the running keyboard as specified, if this one misses live-initramfs
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).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
live-getty
</term>
<listitem>
<simpara>
This changes the auto-login on virtual terminals to use the (experimental)
live-getty code. With this option set the standard kernel argument "console=" is
parsed and if a serial console is specified then live-getty is used to autologin
on the serial console.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
{live-media|bootfrom}=<emphasis role="strong">DEVICE</emphasis>
</term>
<listitem>
<simpara>
If you specify one of this two equivalent forms, live-initramfs will first try
to find this device for the "/live" directory where the read-only root
filesystem should reside. If it did not find something usable, the normal scan
for block devices is performed.
</simpara>
</listitem>
</varlistentry>
</variablelist>
<simpara>Instead of specifing an actual device name, the keyword <emphasis>removable</emphasis> can be used
to limit the search of acceptable live media to removable type only. Note that
if you want to further restrict the media to usb mass storage only, you can use
the <emphasis>removable-usb</emphasis> keyword.</simpara>

<variablelist>
<varlistentry>
<term>
{live-media-encryption|encryption}=<emphasis role="strong">TYPE</emphasis>
</term>
<listitem>
<simpara>
live-initramfs will mount the encrypted rootfs TYPE, asking the passphrase,
useful to build paranoid live systems :-). TYPE supported so far are "aes" for
loop-aes encryption type.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
live-media-offset=<emphasis role="strong">BYTES</emphasis>
</term>
<listitem>
<simpara>
This way you could tell live-initramfs 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.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
live-media-path=<emphasis role="strong">PATH</emphasis>
</term>
<listitem>
<simpara>
Sets the path to the live filesystem on the medium. By default, it is set to
<emphasis>/live</emphasis> and you should not change that unless you have customized your media
accordingly.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
live-media-timeout=<emphasis role="strong">SECONDS</emphasis>
</term>
<listitem>
<simpara>
Set the timeout in seconds for the device specified by "live-media=" to become
ready before giving up.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
{locale|debian-installer/locale}=<emphasis role="strong">LOCALE</emphasis>
</term>
<listitem>
<simpara>
Configure the running locale as specified, if not present the live-media rootfs
configured locale will be used and if also this one misses live-initramfs 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 en:EN.UTF-8), in this
case if also "keyb=" is unspecified is set with those 2 lowercase letters
(keyb=us). Beside that facility, only UTF8 locales are supported by
live-initramfs.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
module=<emphasis role="strong">NAME</emphasis>
</term>
<listitem>
<simpara>
Instead of using the default optional file "filesystem.module" (see below)
another file could be specified without the extension ".module"; it should be
placed on "/live" directory of the live medium.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
netboot[=<emphasis role="strong">nfs</emphasis>|<emphasis role="strong">cifs</emphasis>]
</term>
<listitem>
<simpara>
This tells live-initramfs 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.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
nfsopts=
</term>
<listitem>
<simpara>
This lets you specify custom nfs options.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
noautologin
</term>
<listitem>
<simpara>
This parameter disables the automatic terminal login only, not touching gdk/kdm.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
noxautologin
</term>
<listitem>
<simpara>
This parameter disables the automatic login of gdm/kdm only, not touching
terminals.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
nofastboot
</term>
<listitem>
<simpara>
This parameter disables the default disabling of filesystem checks in
/etc/fstab. If you have static filesystems on your harddisk and you want them to
be checked at boot time, use this parameter, otherwise they are skipped.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
nopersistent
</term>
<listitem>
<simpara>
disables the "persistent" feature, useful if the bootloader (like syslinux) has
been installed with persistent enabled.
</simpara>
<literallayout class="monospaced">noprompt</literallayout>
</listitem>
</varlistentry>
</variablelist>
<simpara>Do not prompt to eject the CD on reboot.</simpara>

<variablelist>
<varlistentry>
<term>
nosudo
</term>
<listitem>
<simpara>
This parameter disables the automatic configuration of sudo.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
swapon
</term>
<listitem>
<simpara>
This parameter enables usage of local swap partitions.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
nouser
</term>
<listitem>
<simpara>
This parameter disables the creation of the default user completely.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
noxautoconfig
</term>
<listitem>
<simpara>
This parameter disables Xorg auto-reconfiguration at boot time. This is valuable
if you either do the detection on your own, or, if you want to ship a custom,
premade xorg.conf in your live system.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
persistent[=nofiles]
</term>
<listitem>
<simpara>
live-initramfs will look for persistent and snapshot partitions or files labeled
"live-rw", "home-rw", and files called "live-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 latter in appropriate locations (snapshots). Snapshots will be
tried to be updated on reboot/shutdown. Look at live-snapshot(1) for more
informations. If "nofiles" is specified, only filesystems with matching labels
will be searched; no filesystems will be traversed looking for archives or image
files. This results in shorter boot times.
</simpara>
<literallayout class="monospaced">persistent-path=PATH</literallayout>
</listitem>
</varlistentry>
</variablelist>
<simpara>live-initramfs will look for persistency files in the root directory of a partition,
with this parameter, the path can be configured so that you can have multiple
directories on the same partition to store persistency files.</simpara>

<variablelist>
<varlistentry>
<term>
{preseed/file|file}=<emphasis role="strong">FILE</emphasis>
</term>
<listitem>
<simpara>
A path to a file present on the rootfs could be used to preseed debconf
database.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
package/question=<emphasis role="strong">VALUE</emphasis>
</term>
<listitem>
<simpara>
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.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
quickreboot
</term>
<listitem>
<simpara>
This option causes live-initramfs to reboot without attempting to eject the
media and without asking the user to remove the boot media.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
showmounts
</term>
<listitem>
<simpara>
This parameter will make live-initramfs to show on "/" the ro filesystems
(mostly compressed) on "/live". This is not enabled by default because could
lead to problems by applications like "mono" which store binary paths on
installation.
</simpara>
<literallayout class="monospaced">silent</literallayout>
</listitem>
</varlistentry>
</variablelist>
<simpara>If you boot with the normal quiet parameter, live-initramfs hides most messages
of its own. When adding silent, it hides all.</simpara>

<literallayout class="monospaced">textonly</literallayout>
<simpara>Start up to text-mode shell prompts, disabling the graphical user interface.</simpara>

<variablelist>
<varlistentry>
<term>
timezone=<emphasis role="strong">TIMEZONE</emphasis>
</term>
<listitem>
<simpara>
By default, timezone is set to UTC. Using the timezone parameter, you can set it
to your local zone, e.g. Europe/Zurich.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
todisk=<emphasis role="strong">DEVICE</emphasis>
</term>
<listitem>
<simpara>
Adding this parameter, live-initramfs will try to copy the entire read-only
media to the specified device before mounting the root filesystem. It probably
needs a lot of free space. Subsequent boots should then skip this step and just
specify the "live-media=DEVICE" boot parameter with the same DEVICE used this
time.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
toram
</term>
<listitem>
<simpara>
Adding this parameter, live-initramfs will try to copy the whole read-only media
to the computer's RAM before mounting the root filesystem. This could need a lot
of ram, according to the space used by the read-only media.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
union=<emphasis role="strong">aufs</emphasis>|<emphasis role="strong">unionfs</emphasis>
</term>
<listitem>
<simpara>
By default, live-initramfs uses aufs. With this parameter, you can switch to
unionfs.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
utc=<emphasis role="strong">yes</emphasis>|<emphasis role="strong">no</emphasis>
</term>
<listitem>
<simpara>
By default, Debian systems do assume that the hardware clock is set to UTC. You
can change or explicitly set it with this parameter.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
xdebconf
</term>
<listitem>
<simpara>
Uses xdebconfigurator, if present on the rootfs, to configure X instead of the
standard procedure (experimental).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
xvideomode=<emphasis role="strong">RESOLUTION</emphasis>
</term>
<listitem>
<simpara>
Doesn't do xorg autodetection, but enforces a given resolution.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="_files">
<title>Files</title>
<literallayout class="monospaced">/etc/live.conf</literallayout>
<simpara>Some variables can be configured via this config file (inside the live system).</simpara>

<literallayout class="monospaced">/live/filesystem.module</literallayout>
<simpara>This optional file (inside the live media) contains a list of white-space or
carriage-return-separated file names corresponding to disk images in the "/live"
directory. If this file exists, only images listed here will be merged into the
root aufs, and they will be loaded in the order listed here. The first entry
in this file will be the "lowest" point in the aufs, and the last file in
this list will be on the "top" of the aufs, directly below /cow.  Without
this file, any images in the "/live" directory are loaded in alphanumeric order.</simpara>

<literallayout class="monospaced">/etc/live-persistence.binds</literallayout>
<simpara>This optional file (which resides in the rootfs system, not in the live media)
is used as a list of directories which not need be persistent: ie. their
content does not need to survive reboots when using the persistence features.</simpara>

<simpara>This saves expensive writes and speeds up operations on volatile data such as
web caches and temporary files (like e.g. /tmp and .mozilla) which are
regenerated each time. This is achieved by bind mounting each listed directory
with a tmpfs on the original path.</simpara>

</refsect1>
<refsect1 id="_see_also">
<title>See also</title>
<simpara>live-snapshot(1), initramfs-tools(8), live-helper(7), live-initscripts(7),
live-webhelper(7)</simpara>

</refsect1>
<refsect1 id="_bugs">
<title>Bugs</title>
<simpara>Report bugs against live-initramfs
<ulink url="http://packages.qa.debian.org/live-initramfs">http://packages.qa.debian.org/live-initramfs</ulink>.</simpara>

</refsect1>
<refsect1 id="_homepage">
<title>Homepage</title>
<simpara>More information about the Debian Live project can be found at
<ulink url="http://debian-live.alioth.debian.org/">http://debian-live.alioth.debian.org/</ulink> and
<ulink url="http://wiki.debian.org/DebianLive/">http://wiki.debian.org/DebianLive/</ulink>.</simpara>

</refsect1>
<refsect1 id="_authors">
<title>Authors</title>
<simpara>live-initramfs is maintained by Daniel Baumann &lt;daniel@debian.org&gt;
for the Debian project.</simpara>

<simpara>live-initramfs is a fork of <ulink url="http://packages.ubuntu.com/casper/">casper</ulink>.
casper was originally written by Tollef Fog Heen &lt;tfheen@canonical.com&gt;
and Matt Zimmerman &lt;mdz@canonical.com&gt;.</simpara>

</refsect1>
</refentry>