README.bootparams 6.35 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
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

12
13
* Boot parameters (configs/releng)
  * scripts/choose-mirror
14
15
16
17
18
19
20
21
22
23
24
25
26


*** 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"
* copytoram=        If set to "y" or just "copytoram" without arguments,
Simon Wilper's avatar
Simon Wilper committed
27
28
29
                    all SquashFS are copied to "RAM". If you add the package
                    "pv" to the packages.x86_64 it is used to display the copy
                    progress.
30
31
32
33
34
                    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)
35
36
* cow_label=        Set the filesystem label where COW file (for dm-snapshot)
                    or upperdir/workdir files (for overlayfs) must be stored.
37
                    Default: (unset)
38
* cow_device=       Like cow_label= but using device node.
39
                    Default: (unset) or "/dev/disk/by-label/${cow_label}"
40
41
* cow_flags=        Set extra mount options, e.g. for btrfs subvolumes.
                    Default: defaults
42
43
* cow_directory=    Set a directory inside ${cow_device}.
                    Default: "/persistent_${archisolabel}/${arch}"
44
* cow_persistent=   Set if snapshot is persistent "P" or non-persistent "N".
45
                    Only used for dm-snapshot mode, ignored for overlayfs.
46
                    Default: "N" (if no ${cow_device} is used) otherwise "P".
47
48
* cow_spacesize=    Set the size for COW space (tmpfs). Valid for both
                    dm-snapshot and overlayfs mode.
49
                    The argument is an integer and optional unit.
50
                    Units are M,G (powers of 1024).
51
                    Default: "256M"
52
53
* cow_chunksize=    Set chunksize used for dm-snapshot. This is number
                    of 512 byte blocks to write at once.
Gerardo Exequiel Pozzi's avatar
Gerardo Exequiel Pozzi committed
54
                    Default: "8"
55
* copytoram_size=   Set the size of tmpfs. This space is used for
56
                    airootfs.sfs image if copytoram=y.
57
58
59
                    Size is in bytes (suffix with "k", "m" and "g") or
                    in percentage of available RAM.
                    Default: "75%"
60
61
* dm_snap_prefix=   Set a prefix for dm-snapshot node names.
                    Only used for dm-snapshot mode, ignored for overlayfs.
62
                    Default: "arch"
63
64
65
* arch=             Force an architecture type (i686 | x86_64).
                    Do not set it for normal operations.
                    Default: (architecture of running kernel)
66
67
68
69
70


** hooks/archiso_pxe_common

* ip=               This parameter is setup automatically by PXELINUX
71
                    when option "SYSAPPEND" is set to 1 or 2 in config.
72
73
74
                    ip=<client-ip>:<boot-server-ip>:<gw-ip>:<netmask>
                    Default: (set via PXE server)
* BOOTIF=           This parameter is setup automatically by PXELINUX
75
                    when option "SYSAPPEND" is set to 2 or 3 in config.
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
                    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}"
128
129
* img_flags=        Set extra mount options, e.g. for btrfs subvolumes.
                    Default: defaults
130
131
* img_loop=         Full path where archiso-image.iso is located on ${img_dev}
                    Default: (unset)
132
133
134
135
136
137
138
139
140
141
142
143



*** Boot parameters (configs/releng)

** scripts/choose-mirror

* mirror=           Takes a mirror URL and creates a new mirrorlist.
                    When setting mirror=auto, the mirror is taken from
                    archiso_http_srv= in order to keep using the mirror
                    selected in the netboot menu.
                    Default: (unset)
144
145
146
147
148
149

* script=           Takes a local file path or a URL to a script file which is
                    executed from a temporary location after boot. If the
                    parameter points at a remote file (supported protocols are
                    http, https and ftp), it will be downloaded before execution.
                    Default: (unset)