diff options
Diffstat (limited to 'doc/manual.cli')
| -rw-r--r-- | doc/manual.cli | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/manual.cli b/doc/manual.cli index 6648eec..9e90297 100644 --- a/doc/manual.cli +++ b/doc/manual.cli @@ -3,7 +3,7 @@ // license : MIT; see accompanying LICENSE file "\name=build2-buildos-manual" -"\subject=buildos" +"\subject=Build OS" "\title=Operating System" // NOTES @@ -14,16 +14,16 @@ " \h0#preface|Preface| -This document describes \c{buildos}, the \c{build2} operating system. +This document describes Build OS, the \c{build2} operating system. \h1#intro|Introduction| -\c{buildos} is a Debian GNU/Linux-based in-memory network-booted operating -system specialized for autonomous building of software using the \c{build2} +Build OS is a Debian GNU/Linux-based in-memory network-booted operating system +specialized for autonomous building of software using the \c{build2} toolchain. It's primary purpose is to run the \c{build2} build bot (\c{bbot}), build slave (\c{bslave}), or both. -A machine that run an instance of \c{buildos} is called a \i{build host}. A +A machine that run an instance of Build OS is called a \i{build host}. A build host runs the \c{bbot} and/or \c{bslave} in the \i{agent mode}. The actual building is performed in the virtual machines and/or containers. For \c{bbot} it is normally one-shot virtual machines and for \c{bslave} it is @@ -80,8 +80,8 @@ the following subdirectories: \h1#boot|Booting| -\c{buildos} is normally booted from the network using PXE but can also be -booted locally from the kernel image and initrd directly. +Build OS is normally booted over the network using PXE but can also be booted +locally from the kernel image and initrd directly. \h#boot-reboot|Reboot| @@ -103,7 +103,7 @@ PXELINUX. That is, you have configured a TFTP server that hosts the \c{pxelinux} initial bootstrap program (NBP) and configured a DHCP server to direct PXE client to this server/NBP. -To setup PXE boot of \c{buildos}, perform the following steps: +To setup PXE boot of Build OS, perform the following steps: \ol| @@ -129,7 +129,7 @@ prompt 1 timeout 50 label buildos - menu label buildos + menu label Build OS kernel /buildos/buildos-image initrd /buildos/buildos-initrd append buildos.smtp_relay=example.org buildos.admin_email=admin@example.org buildos.buildid_url=tftp://<os-host>/buildos/buildos-buildid buildos.toolchain_url=https://<toolchain-host>/toolchain.sha256 buildos.toolchain_trust=<repo-fp> @@ -156,9 +156,9 @@ $ sudo kvm \ \h#boot-local|Local Boot| -During testing it is often useful to boot \c{buildos} directly from the -kernel image and initrd files. As an example, here is how this can be done -using QEMU/KVM: +During testing it is often useful to boot Build OS directly from the kernel +image and initrd files. As an example, here is how this can be done using +QEMU/KVM: \ sudo kvm \ @@ -262,14 +262,14 @@ with \c{dnsmasq} configured as a DHCP on this interface. Normally, \c{br0} is used for \c{bslave} virtual machines/container (since they may need to be accessed directly) and \c{br1} \- for \c{bbot} virtual -machines. You can view the bridge configuration on a booted \c{buildos} -instance by examining \c{/etc/network/interfaces}. +machines. You can view the bridge configuration on a booted Build OS instance +by examining \c{/etc/network/interfaces}. @@ TODO: private network parameters. \h#config-email|Email| -A \c{buildos} instance sends various notifications (including all messages to +A Build OS instance sends various notifications (including all messages to \c{root}) to the admin email address. The admin email is specified with the \c{buildos.admin_email} kernel command line parameter. |