HorizonScript Keys
Introduction A HorizonScript file is, at its core, a collection of values that determine the actions and configuration values used to transform a computer from an indeterminate state to a well-known state running Adélie Linux. These values are categorised into keys, which is a logical unit of a value. This chapter defines and specifies for every valid key for a HorizonScript file: its name, its purpose, its format, and one or more example values with explanations.
Required Keys Each key specified in this section is required to be present in a HorizonScript. If any key from this section is missing, the HorizonScript will be considered invalid and Horizon Runner will not execute it.
<literal>network</literal> Name network Purpose The network key determines if the target computer will support networking or not. If the value is true, the computer will support networking, and at least one netaddress key will then be required. Format The network key is a Boolean value — valid values are true and false. network must appear exactly once in a HorizonScript. Example The <literal>network</literal> Key network true This enables networking for the target computer.
<literal>hostname</literal> Name hostname Purpose The hostname key determines the hostname of the target computer. This key is always required, even when the target computer will not participate in a network. The computer's hostname is used on shell prompts, most window manager launchers, and in log files. Format The hostname key is a string value that must contain only alphanumeric characters and optionally one or more '.' characters. If hostname contains one or more '.' characters, all content before the first '.' is considered the hostname, and all content after the first '.' is considered the domain name. Examples The <literal>hostname</literal> Key — Setting a Host Name hostname gwyn This sets the hostname of the target computer to gwyn. The <literal>hostname</literal> Key — Setting a Host Name and Domain Name hostname gwyn.foxkit.internal This sets the hostname of the target computer to gwyn.foxkit.internal.
Optional Keys Each key specified in this section may be present in a HorizonScript. This section additionally defines the default value or action taken if the specified key is not present.
<literal>language</literal> Name language Purpose The language key determines the default natural language for the target computer. The value of this key will be used to configure the LANG and LC_ALL environment variables, in addition to installing language packs for certain software. Format The language key is a string value that specifies a valid locale code. A locale code must match one of the following formats: xx, or xx_YY, or xx_YY.UTF-8, where xx is a valid ISO 639-1 language code, and YY is a valid ISO 3166-1 country code. Default If the language key is not present, no setting will be defined for the LANG or LC_ALL environment variables. Most software treats this as either "C.UTF-8" or "en_US.UTF-8". No language packs will be installed for software that supports multiple language; due to English being the de facto language of software engineering, this implies all software will run in English. Examples The <literal>language</literal> Key — Simple Language language cy This sets the language of the target computer to Welsh. The <literal>language</literal> Key — Language with Country Localisation language fr_CA This sets the language of the target computer to Canadian French.
<literal>keymap</literal> Name keymap Purpose The keymap key determines the keyboard layout used for input on the target computer. Format The keymap key is a string value that specifies the name of a keyboard layout. Valid keyboard layouts are listed in /etc/console-setup/ckb/rules/xorg.lst under the ! layout heading. Default If the keymap key is not present, the target computer will use the default keyboard settings from Linux. These settings are architecture-dependent, but almost universally use a US QWERTY-style layout. Example The <literal>keymap</literal> Key keymap fr This sets the keyboard layout of the target computer to French AZERTY.