about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
authorJuan RP <xtraeme@gmail.com>2012-06-12 16:27:17 +0200
committerJuan RP <xtraeme@gmail.com>2012-06-12 16:27:17 +0200
commitf23d55be2bd378f82d53f1cc6eba9c0b07c17c32 (patch)
treecb2c61c05a6421052d7dae668482c4d5579f5e6a /README
downloadhrmpf-f23d55be2bd378f82d53f1cc6eba9c0b07c17c32.tar.gz
hrmpf-f23d55be2bd378f82d53f1cc6eba9c0b07c17c32.tar.xz
hrmpf-f23d55be2bd378f82d53f1cc6eba9c0b07c17c32.zip
Initial import of void-mklive 0.9.5 (from srcpkgs/vmklive).
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1e43928
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+void-mklive - The Void Linux live image maker
+
+This is a simple shell script to build a live image for the
+Void linux distribution. The images contain the void-installer package
+to be able to install Void linux to storage disks.
+
+Usage: vmklive [options]
+
+Options:
+ -C file		Path to configuration file (defaults to ~/.mklive.conf)
+ -c (gzip|bzip2|xz) 	Compression type for the squashfs/initramfs image.
+ -k version		Kernel version to use.
+ -o outfile		Output file name for the ISO image.
+ -r rootdir		Rootfs directory.
+ -s splash		Splash image file for isolinux.
+ -v volname		ISO Volume name.
+
+NOTE: If -k not specified it will use $(uname -r) by default.
+NOTE: the first time it is executed a configuration file will be created at ~/mklive.conf.
+NOTE: It's assumed that void-mklive is run in a Void Linux system.
+
+Take a look at the configuration file (~/mklive.conf) to tweak some
+default parameters in the generated image.
+
+	-- Juan RP <xtraeme@gmail.com>