Adding live-initramfs 1.87.6-1.
[live-boot-grml.git] / manpages / live-initramfs.en.7
index 03a1e7e..c65bf09 100644 (file)
@@ -1,7 +1,7 @@
-.TH LIVE\-INITRAMFS 7 "2007\-05\-14" "1.81.3" "live\-initramfs"
+.TH LIVE\-INITRAMFS 7 "2007\-06\-04" "1.87.6" "live\-initramfs"
 
 .SH NAME
-live\-initramfs \- Debian Live initramfs generator
+live\-initramfs \- Debian Live initramfs hook
 
 .SH SYNOPSIS
 .B BOOT=live
@@ -12,6 +12,8 @@ live\-initramfs is a hook for the initramfs\-tools, used to generate a initramfs
 .PP
 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.
 .PP
+You probably do not want to install this package onto a non-live system, although it will do no harm.
+.PP
 live\-initramfs is a fork of casper <\fIhttp://packages.ubuntu.com/casper/\fR>. casper was originally written by Tollef Fog Heen <\fItfheen@canonical.com\fR> and Matt Zimmerman <\fImdz@canonical.com\fR>.
 
 .SH BOOT OPTIONS
@@ -40,22 +42,28 @@ live\-initramfs will mount the encrypted rootfs TYPE, asking the passphrase, use
 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.
 .IP "\fBlive\-media\-timeout=\fR\fISECONDS\fR" 4
 Set the timeout in seconds for the device specified by "live\-media=" to become ready before giving up.
-.IP "\fBlocale=\fR\fILOCALE\fR | \fBdebian\-installer/locale=\fR\fILOCALE\fR" 4
+.IP "\fB{locale|debian\-installer/locale}=\fR\fILOCALE\fR" 4
 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 ien: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.
 .IP "\fBmodule=\fR\fINAME\fR" 4
 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 "/live" directory of the live medium.
 .IP "\fBnetboot\fR[=nfs|cifs]" 4
 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.
+.IP "\fBnoautologin\fR" 4
+This parameter disables the automatic terminal login only, not touching gdk/kdm.
+.IP "\fBnoxautologin\fR" 4
+This parameter disables the automatic login of gdm/kdm only, not touching terminals.
+.IP "\fBnopersistent\fR" 4
+disables the "persistent" feature, useful if the bootloader (like syslinux) has been installed with persistent enabled.
+.IP "\fBnosudo\fR" 4
+This parameter disables the automatic configuration of sudo.
+.IP "\fBnoswap\fR" 4
+This parameter disables usage of local swap partitions.
 .IP "\fBpersistent\fR" 4
 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 \fIlive\-snapshot\fR(1) for more informations.
-.IP "\fBnopersistent\fR" 4
-disables the above mentioned "persistent" feature, useful if the bootloader (like syslinux) has been installed with persistent enabled.
 .IP "\fBquickreboot\fR" 4
 This option causes live\-initramfs to reboot without attempting to eject the media and without asking the user to remove the boot media.
 .IP "\fBshowmounts\fR" 4
 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.
-.IP "\fBswapoff\fR" 4
-This parameter disables usage of local swap partitions.
 .IP "\fBtodisk=\fR\fIDEVICE" 4
 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.
 .IP "\fBtoram\fR" 4
@@ -79,9 +87,13 @@ This optional file (inside the live media) contains a list of white\-space or ca
 .SH SEE ALSO
 \fIlive\-snapshot\fR(1)
 .PP
+\fIinitramfs\-tools\fR(8)
+.PP
 \fIlive\-helper\fR(7)
 .PP
-\fIinitramfs\-tools\fR(8)
+\fIlive\-sysvinit\fR(7)
+.PP
+\fIlive\-webhelper\fR(7)
 
 .SH BUGS
 Report bugs against live\-initramfs <\fIhttp://packages.qa.debian.org/live\-initramfs/\fR>.