summaryrefslogtreecommitdiff
path: root/debian/manpage
diff options
context:
space:
mode:
Diffstat (limited to 'debian/manpage')
-rw-r--r--debian/manpage/casper-snapshot.128
-rw-r--r--debian/manpage/casper.710
2 files changed, 26 insertions, 12 deletions
diff --git a/debian/manpage/casper-snapshot.1 b/debian/manpage/casper-snapshot.1
index 1e17251..3cd5309 100644
--- a/debian/manpage/casper-snapshot.1
+++ b/debian/manpage/casper-snapshot.1
@@ -7,24 +7,30 @@ casper-snapshot \- a simple script to ease persistence usage.
.B casper-snapshot
.RB [\| \-c \||\| \-\-cow
.IR DIRECTORY \|]
-.RB [\| \-d \||\| \-\-destination
-.IR DIRECTORY \||\| FILE \|]
+.RB [\| \-d \||\| \-\-device
+.IR DEVICE \|]
+.RB [\| \-e \||\| \-\-exclude\-list
+.IR FILE \|]
.RB [\| \-o \||\| \-\-output
.IR FILE \|]
.RB [\| \-t \||\| \-\-type
.IR TYPE \|]
.PP
-.B make-live
+.B casper-snapshot
+.RB \-r \||\| \-\-resync\-string
+.IR STRING
+.br
+.B casper-snapshot
.RB \-h \||\| \-\-help
.br
-.B make-live
+.B casper-snapshot
.RB \-u \||\| \-\-usage
.br
-.B make-live
+.B casper-snapshot
.RB \-v \||\| \-\-version
.SH DESCRIPTION
-Casper-snapshot is a script useful to build the right types of persistent image files supported by casper.
+Casper-snapshot is a script useful to build the right types of persistent image files supported by casper, it is also used on exit by the casper init script to resync the boot-found snapshots devices.
.SH OPTIONS
.TP
@@ -32,9 +38,17 @@ Casper-snapshot is a script useful to build the right types of persistent image
specifies the input directory to be cloned in the image file.
This parameters often does not need to be specified as the default of "/cow" for it should be right for most uses, however it could be handy to specify "/home" and type ext2 for the type to prepare an image file suited to be directly mounted by casper as home.
.TP
-.BI "\-d, \-\-destination" DIRECTORY
+.BI "\-d, \-\-device" DEVICE
+the device on where the media which the snapshot/persistence file/partition will be put. If not specified a tmpfs will be used and linked on user's desktop to move it where he/her wants. If the device has not a filesystem on it, an ext2 fs will be created in it and labeled like --output options or with a sane default.
+.TP
+.BI "\-e, \-\-exclude\-list" FILE
+you could pass a list of filenames/path that should not be saved. This exclude list will be remebered on the target snapshotting media for reuse.
.TP
.BI "\-o, \-\-output" FILE
+the filename/label to be used for the output file/partition, if left blank it could search for a proper file on the device or use the whole partition.
+.TP
+.BI "\-r, \-\-resync\-string" STRING
+internally used on resyncs.
.TP
.BI "\-t, \-\-type" TYPE
diff --git a/debian/manpage/casper.7 b/debian/manpage/casper.7
index 89f1cf2..794ee0d 100644
--- a/debian/manpage/casper.7
+++ b/debian/manpage/casper.7
@@ -1,7 +1,7 @@
.TH CASPER 7 "Thu, 28 Sep 2006" "1.69" "Initramfs-tools hook"
.SH NAME
-casper \- an hook for initramfs-tools to boot live systems.
+casper \- a hook for initramfs-tools to boot live systems.
.SH SYNOPSIS
.B BOOT=casper
@@ -15,11 +15,11 @@ Casper is an hook for initramfs-tools used to generate initramfs able to boot li
.B casper-getty
This enable a special serial login shell (experimental).
.TP
-.BI "host=" HOSTNAME " , userfullname=" USERFULLNAME " , username=" USERNAME
+.BI "hostname=" HOSTNAME " , userfullname=" USERFULLNAME " , username=" USERNAME
Those parameters lets you override values read from the config file.
.TP
-.BI "keyb=" KEYBOARD " | kbd-chooser/method=" KEYBOARD "; console-setup/layoutcode=" LAYOUT ", console-setup/variantcode=" VARIANT
-Configure the running keyboard as specified, if this one misses casper behave as "keyb=us" was specified. (It will be interfered from "locale=" somewhere in the future). You could also specify layout and variant (no defaults).
+.BI "keyb=" KEYBOARD " | kbd-chooser/method=" KEYBOARD " ; console-setup/layoutcode=" LAYOUT " , console-setup/variantcode=" VARIANT " , console-setup/modelcode" CODE
+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).
.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 it if you want to use dhcp (default).
@@ -28,7 +28,7 @@ Let you specify the name(s) and the options of the interface(s) that should be c
This way dhcp and static configuration is just skipped and the system will use the (must be) media-preconfigured /etc/network/interfaces instead.
.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.
+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).
.TP
.BI live-media= DEVICE " | bootfrom=" DEVICE
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.