Releasing debian version 1.236.2-1.
[live-boot-grml.git] / manpages / live-initramfs.en.7.txt
index 5bc0adf..f68e87c 100644 (file)
@@ -1,5 +1,7 @@
 live-initramfs(7)
 =================
+:man source: 1.157.3
+:man manual: Debian Live
 
 Name
 ----
@@ -21,7 +23,7 @@ This includes the Debian Live isos, netboot tarballs, and usb stick images.
 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
-unionfs, for Debian like systems to boot from.
+aufs, for Debian like systems to boot from.
 
 You probably do not want to install this package onto a non-live system,
 although it will do no harm.
@@ -54,7 +56,15 @@ Makes initramfs boot process more verbose.
   fetch=*URL*::
 
 Another form of netboot by downloading a squashfs image from a given url,
-copying to ram and booting it.
+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.
+
+Not working: http://example.com/path/to/your_filesystem.squashfs
+Working: http://1.2.3.4/path/to/your_filesystem.squashfs
+
+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.
 
   hostname=*HOSTNAME*, username=*USER*, userfullname=*USERFULLNAME*::
 
@@ -79,7 +89,7 @@ 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).
 
-  ip[=**frommedia**]::
+  ip=[**frommedia**]::
 
 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
@@ -106,6 +116,11 @@ 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.
 
+Instead of specifing an actual device name, the keyword 'removable' 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 'removable-usb' keyword.
+
   {live-media-encryption|encryption}=**TYPE**::
 
 live-initramfs will mount the encrypted rootfs TYPE, asking the passphrase,
@@ -175,13 +190,17 @@ be checked at boot time, use this parameter, otherwise they are skipped.
 disables the "persistent" feature, useful if the bootloader (like syslinux) has
 been installed with persistent enabled.
 
+  noprompt
+
+Do not prompt to eject the CD or remove the USB flash drive on reboot.
+
   nosudo::
 
 This parameter disables the automatic configuration of sudo.
 
-  noswap::
+  swapon::
 
-This parameter disables usage of local swap partitions.
+This parameter enables usage of local swap partitions.
 
   nouser::
 
@@ -193,14 +212,22 @@ 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.
 
-  persistent::
+  persistent[=nofiles]::
 
 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.
+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.
+
+  persistent-path=PATH
+
+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.
 
   {preseed/file|file}=**FILE**::
 
@@ -225,6 +252,11 @@ This parameter will make live-initramfs to show on "/" the ro filesystems
 lead to problems by applications like "mono" which store binary paths on
 installation.
 
+  silent
+
+If you boot with the normal quiet parameter, live-initramfs hides most messages
+of its own. When adding silent, it hides all.
+
   textonly
 
 Start up to text-mode shell prompts, disabling the graphical user interface.
@@ -248,10 +280,10 @@ 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.
 
-  union=**unionfs**|**aufs**::
+  union=**aufs**|**unionfs**::
 
-By default, live-initramfs uses unionfs. With this parameter, you can switch to
-aufs.
+By default, live-initramfs uses aufs. With this parameter, you can switch to
+unionfs.
 
   utc=**yes**|**no**::
 
@@ -279,11 +311,23 @@ Some variables can be configured via this config file (inside the live system).
 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 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
+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.
 
+ /etc/live-persistence.binds
+
+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.
+
+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.
+
+
 See also
 --------