summaryrefslogtreecommitdiff
path: root/docs/README.build
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.build')
-rw-r--r--docs/README.build46
1 files changed, 22 insertions, 24 deletions
diff --git a/docs/README.build b/docs/README.build
index eae43fe..4b4a542 100644
--- a/docs/README.build
+++ b/docs/README.build
@@ -125,20 +125,11 @@ Note that the ISOs can built by an unprivileged user with sudo but all files und
* master - Profile branch a.k.a "releng". Branch rebrand/releng with Parabola customizations. The files outside configs/ which are common to all variants are packaged from this branch.
-NOTE: This distinction is in the process of being deprecated or reverted. In the future, there will be only one 'releng' profile which is capable of building any of the variant editions via command-line options a single ./build.sh script on the master branch. See the "Package Lists" section the '-E' ./build.sh option below.
+NOTE: This distinction is in the process of being deprecated or reverted. In the future, there will be only one 'releng' profile; which is capable of building any of the variant editions via command-line options to a single ./build.sh script on the master branch. See README.package_lists and the '-E' ./build.sh option below for more information.
** Package Lists
-For each valid edition, a file named 'packages/packages-<WM>.both' must exist, even if empty
-where: <WM> is 'cli' by default, or:
- <WM> corresponds to the part of the '-E' CLI option after the '/'
-This file lists the packages that are to be installed
-in one specific edition of live system for all architectures;
-but are not shared by other editions and are not coupled to a particular init system
-Files named 'packages-<WM>.<ARCH>' cat exist optionally to specify the packages
-that are to be installed for that same edition but only for specific architectures
- e.g. 'packages-lxde.x86_64'
-All packages/packages-* files must be named in lowercase.
+See README.package_lists for information regarding the package lists files schema.
*** Building Parabola GNU/Linux-libre Live ISOs.
@@ -158,22 +149,29 @@ All packages/packages-* files must be named in lowercase.
# cd parabolaiso/configs/releng
* Build one or more ISOs.
- # ./build.sh # dual-architecture SystemD/CLI
- # ./build.sh -T i686 # 32-bit x86 target SystemD/CLI
- # ./build.sh -T x86_64 # 64-bit x86 target SystemD/CLI
- # ./build.sh -E OpenRC/CLI -O # OpenRC/CLI for offline install
- # ./build.sh -E OpenRC/LXDE -O # OpenRC/LXDE for offline install
- # ./build.sh -E SystemD/Talking # SystemD/TalkingParabola
- # ./build.sh -T x86_64 -V "`date +%Y.%m.%d.%H.%M`-alpha" # development filename
-
-Note: See build.sh -h for more options.
-Note: This script needs to be run on an x86_64 ArchLinux derrivative
-Note: Specifying a single architecture with the -T option builds in half of the time
+ # ./build.sh # dual-architecture SystemD/CLI
+ # ./build.sh -T i686 # 32-bit x86 target SystemD/CLI
+ # ./build.sh -T x86_64 # 64-bit x86 target SystemD/CLI
+ # ./build.sh -E OpenRC/CLI -O # OpenRC/CLI for offline install
+ # ./build.sh -E OpenRC/LXDE -O # OpenRC/LXDE for offline install
+ # ./build.sh -E SystemD/LXDE # SystemD/LXDE for net-install
+ # ./build.sh -E SystemD/MATE -S # SystemD/MATE with speech and braille
+ # ./build.sh -V "`date +%Y.%m.%d.%H.%M`-alpha" # development filename
+
+NOTE: The commands above are only some examples. Run `build.sh -h` for the complete options.
+NOTE: This script needs to be run on an x86_64 ArchLinux derrivative
+NOTE: Specifying a single architecture with the -T option builds in half of the time
and results in the ISO being about half of the size as the dual-architecture ISO.
-Note: The argument to the -E option must consist of an init/wm pair separated by a '/' slash.
+ If the -T option is omitted, the default value of 'dual' will be assumed.
+NOTE: Omitting the -O option results in the ISO being about half of the size yet again;
+ but will require an internet connection to install the target system.
+NOTE: The argument to the -E option must consist of an init/wm pair separated by a '/' slash,
+ and must correspond to one each of the 'VALID_INITS' and 'VALID_GUIS'
+ as defined in the 'build.sh' script. If the -E option is omitted,
+ the default value of 'SystemD/CLI' will be assumed.
This will determine which package lists will be used. Although the package lists
files are named in lowercase, this argument may contain captial letters.
It will be printed verbatim in the titles of the boot menu and the MOTD.
-Note: The rebuild.sh script can be handly during development. Among other things,
+NOTE: The rebuild.sh script can be handly during development. Among other things,
it can delete the work directory while retaining the chroot package caches
(the 'wipe' option); which will speed up repeated clean re-builds.