Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs/README.bootparams
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.bootparams')
-rw-r--r--docs/README.bootparams127
1 files changed, 127 insertions, 0 deletions
diff --git a/docs/README.bootparams b/docs/README.bootparams
new file mode 100644
index 0000000..13e1ead
--- /dev/null
+++ b/docs/README.bootparams
@@ -0,0 +1,127 @@
+INDEX
+-----
+
+* Boot parameters (initramfs stage)
+ * hooks/archiso
+ * hooks/archiso_pxe_common
+ * hooks/archiso_pxe_nbd
+ * hooks/archiso_pxe_http
+ * hooks/archiso_pxe_nfs
+ * hooks/archiso_loop_mnt
+
+
+
+*** Boot parameters (initramfs stage)
+
+** hooks/archiso
+
+* archisolabel= Set the filesystem label where archiso files reside.
+ Default: (unset)
+* archisodevice= Set the device node where archiso medium is located.
+ Default: "/dev/disk/by-label/${archisolabel}"
+* archisobasedir= Set the base directory where all files reside.
+ Default: "arch"
+* aitab= Set the path for "aitab" file.
+ Default: ${archisobasedir}/aitab
+* copytoram= If set to "y" or just "copytoram" without arguments,
+ all SquashFS are copied to "RAM".
+ Default: (unset)
+* checksum= If set to "y" or just "checksum" without arguments,
+ performs a self-test of all files inside ${install_dir},
+ and continue booting if ok.
+ Default: (unset)
+* cow_label= Set the filesystem label where COW (dm-snapshot)
+ files must be stored.
+ Default: (unset)
+* cow_device= Set the device node where COW (dm-snapshot) files
+ must be stored.
+ Default: (unset) or "/dev/disk/by-label/${cow_label}"
+* cow_directory= Set a directory inside ${cow_device}.
+ Default: "/persistent_${archisolabel}/${arch}"
+* cow_persistent= Set if snapshots are persistent "P" or non-persistent "N".
+ Default: "N" (if no ${cow_device} is used) otherwise "P".
+* cowspace_size= Set the size of tmpfs /cowspace. This space is used for
+ Copy-On-Write files of dm-snapshot.
+ Size is in bytes (suffix with "k", "m" and "g") or
+ in percentage of available RAM.
+ Default: "75%"
+* cowfile_size= Set the size for all files to be used as COW (dm-snapshot),
+ in percentage of the ro-device.fs file. This is mostly useful
+ when cow_device= is used and filesystem does not support
+ sparse files (ie VFAT).
+ Default: "100%"
+* copytoram_size= Set the size of tmpfs. This space is used for
+ copy of all SquashFS images used, if copytoram=y.
+ Size is in bytes (suffix with "k", "m" and "g") or
+ in percentage of available RAM.
+ Default: "75%"
+* dm_snap_prefix= Set a prefix for device-mapper snapshot node names.
+ Default: "arch"
+* arch= Force an architecture type (i686 | x86_64).
+ Do not set it for normal operations.
+ Useful for running a 64 bit kernel / 32 bit userspace.
+ Default: (architecture of running kernel)
+
+
+** hooks/archiso_pxe_common
+
+* ip= This parameter is setup automatically by PXELINUX
+ when option "IPAPPEND" is set to 1 or 2 in config.
+ ip=<client-ip>:<boot-server-ip>:<gw-ip>:<netmask>
+ Default: (set via PXE server)
+* BOOTIF= This parameter is setup automatically by PXELINUX
+ when option "IPAPPEND" is set to 2 or 3 in config.
+ BOOTIF=<hardware-address-of-boot-interface>
+ Default: (set via PXELINUX)
+* copy_resolvconf= Copy /etc/resolv.conf from initramfs to live-enviroment.
+ Set to "n" to skip them.
+ Default: "y"
+
+
+** hooks/archiso_pxe_nbd
+
+* archiso_nbd_name= Set NBD export name used by the server.
+ Default: archiso
+* archiso_nbd_srv= Set an IP address where NBD reside.
+ If ${pxeserver} is used, PXE IP will be used.
+ Default: (unset)
+
+
+** hooks/archiso_pxe_http
+
+* archiso_http_srv= Set an HTTP URL (must end with /) where ${archisobasedir}
+ is found with all *.sfs files.
+ In the IP/domain part if ${pxeserver} is used, use PXE IP.
+ Default: (unset)
+* archiso_http_spc= Set the size of tmpfs where *.sfs files are downloaded.
+ Default: "75%"
+
+
+** hooks/archiso_pxe_nfs
+
+* archiso_nfs_srv= Set the NFS-IP:/path of the server
+ In the IP part if ${pxeserver} is used, PXE IP will be used.
+ Default: (unset)
+* archiso_nfs_opt= Set NFS mount options separated by comma.
+ Default: (unset, see below)
+ These are the implicit options:
+ port = as given by server portmap daemon
+ rsize = 1024
+ wsize = 1024
+ timeo = 7
+ retrans = 3
+ acregmin = 3
+ acregmax = 60
+ acdirmin = 30
+ acdirmax = 60
+ flags = hard, nointr, noposix, cto, ac
+
+
+** hooks/archiso_loop_mnt
+
+* img_label= Set the filesystem label where archiso-image.iso.
+ Default: (unset)
+* img_dev= Device where archiso-image.iso reside.
+ Default: (unset) or "/dev/disk/by-label/${img_label}"
+* img_loop= Full path where archiso-image.iso is located on ${img_dev}
+ Default: (unset)