# SOME DESCRIPTIVE TITLE # Copyright (C) YEAR Free Software Foundation, Inc. # This file is distributed under the same license as the PACKAGE package. # FIRST AUTHOR , YEAR. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "POT-Creation-Date: 2024-05-30 21:46+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "Language: \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #. type: TH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "mkosi" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "NAME" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "mkosi \\[em] Build Bespoke OS Images" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "SYNOPSIS" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] summary\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] build [command line\\&...]\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] shell [command line\\&...]\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] boot [nspawn settings\\&...]\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] qemu [qemu parameters\\&...]\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] vmspawn [vmspawn settings\\&...]\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] ssh [command line\\&...]\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] journalctl [command line\\&...]\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] coredumpctl [command line\\&...]\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] clean\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] serve\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] burn EdeviceE\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] bump\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] genkey\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] documentation\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]mkosi [options\\&...] help\\fR" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "DESCRIPTION" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]mkosi\\f[R] is a tool for easily building customized OS images. " "It\\[cq]s a fancy wrapper around \\f[CR]dnf --installroot\\f[R], " "\\f[CR]apt\\f[R], \\f[CR]pacman\\f[R] and \\f[CR]zypper\\f[R] that may " "generate disk images with a number of bells and whistles.\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "Command Line Verbs" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "The following command line verbs are known:" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]summary\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Outputs a human-readable summary of all options used for building an image. " "This will parse the command line and \\f[CR]mkosi.conf\\f[R] file as it " "would do on \\f[CR]build\\f[R], but only output what it is configured for " "and not actually build anything.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]build\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "This builds the image based on the settings passed in on the command line or " "read from configuration files. This command is the default if no verb is " "explicitly specified. If any command line arguments are specified, these " "are passed directly to the build script if one is defined." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]shell\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "This builds the image if it is not built yet, and then invokes " "\\f[CR]systemd-nspawn\\f[R] to acquire an interactive shell prompt in it. " "An optional command line may be specified after the \\f[CR]shell\\f[R] verb, " "to be invoked in place of the shell in the container. Use \\f[CR]-f\\f[R] " "in order to rebuild the image unconditionally before acquiring the shell, " "see below. This command must be executed as \\f[CR]root\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]boot\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Similar to \\f[CR]shell\\f[R], but boots the image using \\f[CR]systemd-" "nspawn\\f[R]. An optional command line may be specified after the " "\\f[CR]boot\\f[R] verb, which can contain extra nspawn options as well as " "arguments which are passed as the \\f[I]kernel command line\\f[R] to the " "init system in the image.\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]qemu\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Similar to \\f[CR]boot\\f[R], but uses \\f[CR]qemu\\f[R] to boot up the " "image, i.e.\\ instead of container virtualization virtual machine " "virtualization is used. This verb is only supported for disk images that " "contain a boot loader and cpio images in which a kernel was installed. For " "cpio images a kernel can also be provided by passing the \\f[CR]-" "kernel\\f[R] qemu argument to the \\f[CR]qemu\\f[R] verb. Any arguments " "specified after the \\f[CR]qemu\\f[R] verb are appended to the " "\\f[CR]qemu\\f[R] invocation.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]vmspawn\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Similar to \\f[CR]boot\\f[R], but uses \\f[CR]systemd-vmspawn\\f[R] to boot " "up the image, i.e. instead of container virtualization virtual machine " "virtualization is used. This verb is only supported for disk and directory " "type images. Any arguments specified after the \\f[CR]vmspawn\\f[R] verb " "are appended to the \\f[CR]systemd-vmspawn\\f[R] invocation.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ssh\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When the image is built with the \\f[CR]Ssh=yes\\f[R] option, this command " "connects to a booted virtual machine (\\f[CR]qemu\\f[R]) via SSH. Make sure " "to run \\f[CR]mkosi ssh\\f[R] with the same config as \\f[CR]mkosi " "build\\f[R] so that it has the necessary information available to connect to " "the running virtual machine via SSH. Specifically, the SSH private key from " "the \\f[CR]SshKey=\\f[R] setting is used to connect to the virtual machine. " "Use \\f[CR]mkosi genkey\\f[R] to automatically generate a key and " "certificate that will be picked up by mkosi. Any arguments passed after the " "\\f[CR]ssh\\f[R] verb are passed as arguments to the \\f[CR]ssh\\f[R] " "invocation. To connect to a container, use \\f[CR]machinectl login\\f[R] or " "\\f[CR]machinectl shell\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]journalctl\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Uses \\f[CR]journalctl\\f[R] to inspect the journal inside the image. Any " "arguments specified after the \\f[CR]journalctl\\f[R] verb are appended to " "the \\f[CR]journalctl\\f[R] invocation.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]coredumpctl\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Uses \\f[CR]coredumpctl\\f[R] to look for coredumps inside the image. Any " "arguments specified after the \\f[CR]coredumpctl\\f[R] verb are appended to " "the \\f[CR]coredumpctl\\f[R] invocation.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]clean\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Remove build artifacts generated on a previous build. If combined with " "\\f[CR]-f\\f[R], also removes incremental build cache images. If \\f[CR]-" "f\\f[R] is specified twice, also removes any package cache.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]serve\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "This builds the image if it is not built yet, and then serves the output " "directory (i.e.\\ usually \\f[CR]mkosi.output/\\f[R], see below) via a small " "embedded HTTP server, listening on port 8081. Combine with \\f[CR]-f\\f[R] " "in order to rebuild the image unconditionally before serving it. This " "command is useful for testing network based acquisition of OS images, for " "example via \\f[CR]machinectl pull-raw \\&...\\f[R] and \\f[CR]machinectl " "pull-tar \\&...\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]burn EdeviceE\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "This builds the image if it is not built yet, and then writes it to the " "specified block device. The partition contents are written as-is, but the " "GPT partition table is corrected to match sector and disk size of the " "specified medium." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]bump\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Bumps the image version from \\f[CR]mkosi.version\\f[R] and writes the " "resulting version string to \\f[CR]mkosi.version\\f[R]. This is useful for " "implementing a simple versioning scheme: each time this verb is called the " "version is bumped in preparation for the subsequent build. Note that " "\\f[CR]--auto-bump\\f[R]/\\f[CR]-B\\f[R] may be used to automatically bump " "the version after each successful build.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]genkey\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Generate a pair of SecureBoot keys for usage with the " "\\f[CR]SecureBootKey=\\f[R]/\\f[CR]--secure-boot-key=\\f[R] and " "\\f[CR]SecureBootCertificate=\\f[R]/\\f[CR]--secure-boot-certificate=\\f[R] " "options.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]documentation\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Show mkosi\\[cq]s documentation. By default this verb will try several ways " "to output the documentation, but a specific option can be chosen with the " "\\f[CR]--doc-format\\f[R] option. Distro packagers are encouraged to add a " "file \\f[CR]mkosi.1\\f[R] into the \\f[CR]mkosi/resources\\f[R] directory of " "the Python package, if it is missing, as well as to install it in the " "appropriate search path for man pages. The man page can be generated from " "the markdown file \\f[CR]mkosi/resources/mkosi.md\\f[R] e.g via " "\\f[CR]pandoc -t man -s -o mkosi.1 mkosi.md\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]help\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "This verb is equivalent to the \\f[CR]--help\\f[R] switch documented below: " "it shows a brief usage explanation.\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "Commandline-only Options" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "Those settings cannot be configured in the configuration files." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--force\\f[R], \\f[CR]-f\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Replace the output file if it already exists, when building an image. By " "default when building an image and an output artifact already exists " "\\f[CR]mkosi\\f[R] will refuse operation. Specify this option once to " "delete all build artifacts from a previous run before re-building the " "image. If incremental builds are enabled, specifying this option twice will " "ensure the intermediary cache files are removed, too, before the re-build is " "initiated. If a package cache is used (also see the \\f[B]Files\\f[R] " "section below), specifying this option thrice will ensure the package cache " "is removed too, before the re-build is initiated. For the " "\\f[CR]clean\\f[R] operation this option has a slightly different effect: by " "default the verb will only remove build artifacts from a previous run, when " "specified once the incremental cache files are deleted too, and when " "specified twice the package cache is also removed.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--directory=\\f[R], \\f[CR]-C\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a path to a directory. \\f[CR]mkosi\\f[R] switches to this directory " "before doing anything. Note that the various configuration files are " "searched for in this directory, hence using this option is an effective way " "to build a project located in a specific directory.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--debug=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Enable additional debugging output." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--debug-shell\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "When executing a command in the image fails, mkosi will start an interactive " "shell in the image allowing further debugging." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--debug-workspace=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "When an error occurs, the workspace directory will not be deleted." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--version\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "Show package version." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--help\\f[R], \\f[CR]-h\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "Show brief usage information." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--genkey-common-name=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Common name to be used when generating keys via mkosi\\[cq]s " "\\f[CR]genkey\\f[R] command. Defaults to \\f[CR]mkosi of %u\\f[R], where " "\\f[CR]%u\\f[R] expands to the username of the user invoking mkosi.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--genkey-valid-days=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Number of days that the keys should remain valid when generating keys via " "mkosi\\[cq]s \\f[CR]genkey\\f[R] command. Defaults to two years (730 days)." "\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--auto-bump=\\f[R], \\f[CR]-B\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If specified, after each successful build the the version is bumped in a " "fashion equivalent to the \\f[CR]bump\\f[R] verb, in preparation for the " "next build. This is useful for simple, linear version management: each " "build in a series will have a version number one higher then the previous " "one.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--doc-format\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The format to show the documentation in. Supports the values " "\\f[CR]markdown\\f[R], \\f[CR]man\\f[R], \\f[CR]pandoc\\f[R], " "\\f[CR]system\\f[R] and \\f[CR]auto\\f[R]. In the case of " "\\f[CR]markdown\\f[R] the documentation is shown in the original Markdown " "format. \\f[CR]man\\f[R] shows the documentation in man page format, if it " "is available. \\f[CR]pandoc\\f[R] will generate the man page format on the " "fly, if \\f[CR]pandoc\\f[R] is available. \\f[CR]system\\f[R] will show the " "system-wide man page for mkosi, which may or may not correspond to the " "version you are using, depending on how you installed mkosi. " "\\f[CR]auto\\f[R], which is the default, will try all methods in the order " "\\f[CR]man\\f[R], \\f[CR]pandoc\\f[R], \\f[CR]markdown\\f[R], " "\\f[CR]system\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]--json\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Show the summary output as JSON-SEQ." msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "Supported output formats" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "The following output formats are supported:" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "\\[bu]" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Raw \\f[I]GPT\\f[R] disk image, created using systemd-repart " "(\\f[I]disk\\f[R])\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "\\f[R]\\[bu]\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "Plain directory, containing the OS tree (\\f[I]directory\\f[R])\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "Tar archive (\\f[I]tar\\f[R])\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "CPIO archive (\\f[I]cpio\\f[R])\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "The output format may also be set to \\f[I]none\\f[R] to have mkosi produce " "no image at all. This can be useful if you only want to use the image to " "produce another output in the build scripts (e.g.\\ build an rpm).\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When a \\f[I]GPT\\f[R] disk image is created, repart partition definition " "files may be placed in \\f[CR]mkosi.repart/\\f[R] to configure the generated " "disk image.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "It is highly recommended to run \\f[CR]mkosi\\f[R] on a file system that " "supports reflinks such as XFS and btrfs and to keep all related directories " "on the same file system. This allows mkosi to create images very quickly by " "using reflinks to perform copying via copy-on-write operations.\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "Configuration Settings" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The following settings can be set through configuration files (the syntax " "with \\f[CR]SomeSetting=value\\f[R]) and on the command line (the syntax " "with \\f[CR]--some-setting=value\\f[R]). For some command line parameters, " "a single-letter shortcut is also allowed. In the configuration files, the " "setting must be in the appropriate section, so the settings are grouped by " "section below.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Configuration is parsed in the following order:" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "The command line arguments are parsed" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]mkosi.local.conf\\f[R] is parsed if it exists. This file should be " "in the gitignore (or equivalent) and is intended for local configuration.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Any default paths (depending on the option) are configured if the " "corresponding path exists." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]mkosi.conf\\f[R] is parsed if it exists in the directory configured " "with \\f[CR]--directory=\\f[R] or the current working directory if \\f[CR]--" "directory=\\f[R] is not used.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]mkosi.conf.d/\\f[R] is parsed in the same directory if it exists. " "Each directory and each file with the \\f[CR].conf\\f[R] extension in " "\\f[CR]mkosi.conf.d/\\f[R] is parsed. Any directory in \\f[CR]mkosi.conf." "d\\f[R] is parsed as if it were a regular top level directory.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Note that if the same setting is configured twice, the later assignment " "overrides the earlier assignment unless the setting is a list based " "setting. Also note that before v16, we used to do the opposite, where the " "earlier assignment would be used instead of later assignments." msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Settings that take a list of values are merged by appending the new values " "to the previously configured values. Assigning the empty string to such a " "setting removes all previously assigned values, and overrides any configured " "default values as well." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If a setting\\[cq]s name in the configuration file is prefixed with " "\\f[CR]\\[at]\\f[R], it configures the default value used for that setting " "if no explicit default value is set. This can be used to set custom default " "values in configuration files that can still be overridden by specifying the " "setting explicitly via the CLI.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "To conditionally include configuration files, the \\f[CR][Match]\\f[R] " "section can be used. A \\f[CR][Match]\\f[R] section consists of invididual " "conditions. Conditions can use a pipe symbol (\\f[CR]|\\f[R]) after the " "equals sign (\\f[CR]\\&...=|\\&...\\f[R]), which causes the condition to " "become a triggering condition. The config file will be included if the " "logical AND of all non-triggering conditions and the logical OR of all " "triggering conditions is satisfied. To negate the result of a condition, " "prefix the argument with an exclamation mark. If an argument is prefixed " "with the pipe symbol and an exclamation mark, the pipe symbol must be passed " "first, and the exclamation second.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Note that \\f[CR][Match]\\f[R] conditions compare against the current values " "of specific settings, and do not take into account changes made to the " "setting in configuration files that have not been parsed yet. Also note " "that matching against a setting and then changing its value afterwards in a " "different config file may lead to unexpected results.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The \\f[CR][Match]\\f[R] section of a \\f[CR]mkosi.conf\\f[R] file in a " "directory applies to the entire directory. If the conditions are not " "satisfied, the entire directory is skipped. The \\f[CR][Match]\\f[R] " "sections of files in \\f[CR]mkosi.conf.d/\\f[R] and \\f[CR]mkosi.local." "conf\\f[R] only apply to the file itself.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If there are multiple \\f[CR][Match]\\f[R] sections in the same " "configuration file, each of them has to be satisfied in order for the " "configuration file to be included. Specifically, triggering conditions only " "apply to the current \\f[CR][Match]\\f[R] section and are reset between " "multiple \\f[CR][Match]\\f[R] sections. As an example, the following will " "only match if the output format is one of \\f[CR]disk\\f[R] or " "\\f[CR]directory\\f[R] and the architecture is one of \\f[CR]x86-64\\f[R] or " "\\f[CR]arm64\\f[R]:\\fR" msgstr "" #. type: Plain text #: archlinux #, no-wrap msgid "" "[Match]\n" "Format=|disk\n" "Format=|directory\n" msgstr "" #. type: Plain text #: archlinux #, no-wrap msgid "" "[Match]\n" "Architecture=|x86-64\n" "Architecture=|arm64\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The \\f[CR][TriggerMatch]\\f[R] section can be used to indicate triggering " "match sections. These are identical to triggering conditions except they " "apply to the entire match section instead of just a single condition. As an " "example, the following will match if the distribution is \\f[CR]debian\\f[R] " "and the release is \\f[CR]bookworm\\f[R] or if the distribution is " "\\f[CR]ubuntu\\f[R] and the release is \\f[CR]focal\\f[R].\\fR" msgstr "" #. type: Plain text #: archlinux #, no-wrap msgid "" "[TriggerMatch]\n" "Distribution=debian\n" "Release=bookworm\n" msgstr "" #. type: Plain text #: archlinux #, no-wrap msgid "" "[TriggerMatch]\n" "Distribution=ubuntu\n" "Release=focal\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The semantics of conditions in \\f[CR][TriggerMatch]\\f[R] sections is the " "same as in \\f[CR][Match]\\f[R], i.e.\\ all normal conditions are joined by " "a logical AND and all triggering conditions are joined by a logical OR. " "When mixing \\f[CR][Match]\\f[R] and \\f[CR][TriggerMatch]\\f[R] sections, a " "match is achieved when all \\f[CR][Match]\\f[R] sections match and at least " "one \\f[CR][TriggerMatch]\\f[R] section matches. No match sections are " "valued as true. Logically this means:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "(⋀ᵢ Matchᵢ) ∧ (⋁ᵢ TriggerMatchᵢ)\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Command line options that take no argument are shown without \\f[CR]=\\f[R] " "in their long version. In the config files, they should be specified with a " "boolean argument: either \\f[CR]1\\f[R], \\f[CR]yes\\f[R], or " "\\f[CR]true\\f[R] to enable, or \\f[CR]0\\f[R], \\f[CR]no\\f[R], " "\\f[CR]false\\f[R] to disable.\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "[Match] Section." msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Profile=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Matches against the configured profile." msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Distribution=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Matches against the configured distribution." msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Release=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Matches against the configured distribution release. If this condition is " "used and no distribution has been explicitly configured yet, the host " "distribution and release are used." msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Architecture=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Matches against the configured architecture. If this condition is used and " "no architecture has been explicitly configured yet, the host architecture is " "used." msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]PathExists=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "This condition is satisfied if the given path exists. Relative paths are " "interpreted relative to the parent directory of the config file that the " "condition is read from." msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ImageId=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Matches against the configured image ID, supporting globs. If this " "condition is used and no image ID has been explicitly configured yet, this " "condition fails." msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ImageVersion=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Matches against the configured image version. Image versions can be " "prepended by the operators \\f[CR]==\\f[R], \\f[CR]!=\\f[R], " "\\f[CR]E=\\f[R], \\f[CR]E=\\f[R], \\f[CR]E\\f[R], " "\\f[CR]E\\f[R] for rich version comparisons according to the UAPI group " "version format specification. If no operator is prepended, the equality " "operator is assumed by default. If this condition is used and no image " "version has been explicitly configured yet, this condition fails.\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Bootable=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Matches against the configured value for the \\f[CR]Bootable=\\f[R] " "feature. Takes a boolean value or \\f[CR]auto\\f[R].\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Format=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Matches against the configured value for the \\f[CR]Format=\\f[R] option. " "Takes an output format (see the \\f[CR]Format=\\f[R] option).\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SystemdVersion=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Matches against the systemd version on the host (as reported by " "\\f[CR]systemctl --version\\f[R]). Values can be prepended by the operators " "\\f[CR]==\\f[R], \\f[CR]!=\\f[R], \\f[CR]E=\\f[R], \\f[CR]E=\\f[R], " "\\f[CR]E\\f[R], \\f[CR]E\\f[R] for rich version comparisons " "according to the UAPI group version format specification. If no operator is " "prepended, the equality operator is assumed by default.\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]BuildSources=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a build source target path (see \\f[CR]BuildSources=\\f[R]). This " "match is satisfied if any of the configured build sources uses this target " "path. For example, if we have a \\f[CR]mkosi.conf\\f[R] file containing:\\fR" msgstr "" #. type: Plain text #: archlinux #, no-wrap msgid "" "[Content]\n" "BuildSources=../abc/qed:kernel\n" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "and a drop-in containing:" msgstr "" #. type: Plain text #: archlinux #, no-wrap msgid "" "[Match]\n" "BuildSources=kernel\n" msgstr "" #. type: TP #: archlinux #, no-wrap msgid "The drop-in will be included." msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Any absolute paths passed to this setting are interpreted relative to the " "current working directory." msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]HostArchitecture=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Matches against the host\\[cq]s native architecture. See the " "\\f[CR]Architecture=\\f[R] setting for a list of possible values.\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Matcher" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Globs" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Rich Comparisons" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Default" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "_" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]no\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]match fails\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]match host distribution\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]match host release\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]match host architecture\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]n/a\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]yes\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]match auto feature\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]match default format\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "[Config] Section" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Profile=\\f[R], \\f[CR]--profile=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Select the given profile. A profile is a configuration file or directory in " "the \\f[CR]mkosi.profiles/\\f[R] directory. When selected, this " "configuration file or directory is included after parsing the \\f[CR]mkosi." "conf\\f[R] file, but before any \\f[CR]mkosi.conf.d/*.conf\\f[R] drop in " "configuration.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Include=\\f[R], \\f[CR]--include=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Include extra configuration from the given file or directory. The extra " "configuration is included immediately after parsing the setting, except when " "a default is set using \\f[CR]\\[at]Include=\\f[R], in which case the " "configuration is included after parsing all the other configuration files. " "Note that each path containing extra configuration is only parsed once, even " "if included more than once with \\f[CR]Include=\\f[R]. The builtin configs " "for the mkosi default initrd and default tools tree can be included by " "including the literal value \\f[CR]mkosi-initrd\\f[R] and \\f[CR]mkosi-" "tools\\f[R] respectively. Note: Include names starting with either of the " "literals \\f[CR]mkosi-\\f[R] or \\f[CR]contrib-\\f[R] are reserved for use " "by mkosi itself.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]InitrdInclude=\\f[R], \\f[CR]--initrd-include=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Same as \\f[CR]Include=\\f[R], but the extra configuration files or " "directories are included when building the default initrd.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Images=\\f[R], \\f[CR]--image=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "If specified, only build the given image. Can be specified multiple times " "to build multiple images. All the given images and their dependencies are " "built. If not specified, all images are built. See the \\f[B]Building " "multiple images\\f[R] section for more information. Note that this section " "only takes effect when specified in the global configuration files. It has " "no effect if specified as an image specific setting.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Dependencies=\\f[R], \\f[CR]--dependency=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The images that this image depends on specified as a comma-separated list. " "All images configured in this option will be built before this image and " "will be pulled in as dependencies of this image when \\f[CR]Images=\\f[R] is " "used.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]MinimumVersion=\\f[R], \\f[CR]--minimum-version=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "The minimum mkosi version required to build this configuration. If " "specified multiple times, the highest specified version is used." msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "[Distribution] Section" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Distribution=\\f[R], \\f[CR]--distribution=\\f[R], \\f[CR]-d\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The distribution to install in the image. Takes one of the following " "arguments: \\f[CR]fedora\\f[R], \\f[CR]debian\\f[R], \\f[CR]ubuntu\\f[R], " "\\f[CR]arch\\f[R], \\f[CR]opensuse\\f[R], \\f[CR]mageia\\f[R], " "\\f[CR]centos\\f[R], \\f[CR]rhel\\f[R], \\f[CR]rhel-ubi\\f[R], " "\\f[CR]openmandriva\\f[R], \\f[CR]rocky\\f[R], \\f[CR]alma\\f[R], " "\\f[CR]custom\\f[R]. If not specified, defaults to the distribution of the " "host or \\f[CR]custom\\f[R] if the distribution of the host is not a " "supported distribution.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Release=\\f[R], \\f[CR]--release=\\f[R], \\f[CR]-r\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The release of the distribution to install in the image. The precise syntax " "of the argument this takes depends on the distribution used, and is either a " "numeric string (in case of Fedora Linux, CentOS, \\&..., e.g.\\ " "\\f[CR]29\\f[R]), or a distribution version name (in case of Debian, Ubuntu, " "\\&..., e.g.\\ \\f[CR]artful\\f[R]). Defaults to a recent version of the " "chosen distribution, or the version of the distribution running on the host " "if it matches the configured distribution.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Architecture=\\f[R], \\f[CR]--architecture=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The architecture to build the image for. The architectures that are " "actually supported depends on the distribution used and whether a bootable " "image is requested or not. When building for a foreign architecture, " "you\\[cq]ll also need to install and register a user mode emulator for that " "architecture. One of the following architectures can be specified per image " "built: \\f[CR]alpha\\f[R], \\f[CR]arc\\f[R], \\f[CR]arm\\f[R], " "\\f[CR]arm64\\f[R], \\f[CR]ia64\\f[R], \\f[CR]loongarch64\\f[R], " "\\f[CR]mips64-le\\f[R], \\f[CR]mips-le\\f[R], \\f[CR]parisc\\f[R], " "\\f[CR]ppc\\f[R], \\f[CR]ppc64\\f[R], \\f[CR]ppc64-le\\f[R], " "\\f[CR]riscv32\\f[R], \\f[CR]riscv64\\f[R], \\f[CR]s390\\f[R], " "\\f[CR]s390x\\f[R], \\f[CR]tilegx\\f[R], \\f[CR]x86\\f[R], " "\\f[CR]x86-64\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Mirror=\\f[R], \\f[CR]--mirror=\\f[R], \\f[CR]-m\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "The mirror to use for downloading the distribution packages. Expects a " "mirror URL as argument. If not provided, the default mirror for the " "distribution is used. The default mirrors for each distribution are as " "follows (unless specified, the same mirror is used for all architectures):" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "x86-64" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "aarch64" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]debian\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]http://deb.debian.org/debian\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]arch\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]https://geo.mirror.pkgbuild.com\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]http://mirror.archlinuxarm.org\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]opensuse\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]http://download.opensuse.org\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ubuntu\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]http://archive.ubuntu.com\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]http://ports.ubuntu.com\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]centos\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]https://mirrors.centos.org\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]rocky\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]https://mirrors.rockylinux.org\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]alma\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]https://mirrors.almalinux.org\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]fedora\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]https://mirrors.fedoraproject.org\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]rhel-ubi\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]https://cdn-ubi.redhat.com\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]mageia\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]https://www.mageia.org\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]openmandriva\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]http://mirrors.openmandriva.org\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]LocalMirror=\\f[R], \\f[CR]--local-mirror=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The mirror will be used as a local, plain and direct mirror instead of using " "it as a prefix for the full set of repositories normally supported by " "distributions. Useful for fully offline builds with a single repository. " "Supported on deb/rpm/arch based distributions. Overrides \\f[CR]--" "mirror=\\f[R] but only for the local mkosi build, it will not be configured " "inside the final image, \\f[CR]--mirror=\\f[R] (or the default repository) " "will be configured inside the final image instead.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RepositoryKeyCheck=\\f[R], \\f[CR]--repository-key-check=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Controls signature/key checks when using repositories, enabled by default. " "Useful to disable checks when combined with \\f[CR]--local-mirror=\\f[R] and " "using only a repository from a local filesystem. Not used for DNF-based " "distros yet.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Repositories=\\f[R], \\f[CR]--repositories=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Enable package repositories that are disabled by default. This can be used " "to enable the EPEL repos for CentOS or different components of the Debian/" "Ubuntu repositories." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CacheOnly=\\f[R], \\f[CR]--cache-only=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes one of \\f[CR]none\\f[R], \\f[CR]metadata\\f[R] or " "\\f[CR]always\\f[R]. If \\f[CR]always\\f[R], the package manager is " "instructed not to contact the network. This provides a minimal level of " "reproducibility, as long as the package cache is already fully populated. " "If set to \\f[CR]metadata\\f[R], the package manager can still download " "packages, but we won\\[cq]t sync the repository metadata. If set to " "\\f[CR]none\\f[R], the repository metadata is synced and packages can be " "downloaded during the build.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]PackageManagerTrees=\\f[R], \\f[CR]--package-manager-tree=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "This option mirrors the above \\f[CR]SkeletonTrees=\\f[R] option and " "defaults to the same value if not configured otherwise, but installs the " "files to a subdirectory of the workspace directory instead of the OS tree. " "This subdirectory of the workspace is used to configure the package " "manager. \\f[CR]mkosi\\f[R] will look for the package manager configuration " "and related files in the configured package manager trees. Unless specified " "otherwise, it will use the configuration files from their canonical " "locations in \\f[CR]/usr\\f[R] or \\f[CR]/etc\\f[R] in the package manager " "trees. For example, it will look for \\f[CR]etc/dnf/dnf.conf\\f[R] in the " "package manager trees if \\f[CR]dnf\\f[R] is used to install packages. " "\\f[CR]SkeletonTrees=\\f[R] and \\f[CR]PackageManagerTrees=\\f[R] fulfill " "similar roles. Use \\f[CR]SkeletonTrees=\\f[R] if you want the files to be " "present in the final image. Use \\f[CR]PackageManagerTrees=\\f[R] if you " "don\\[cq]t want the files to be present in the final image, e.g.\\ when " "building an initrd or if you want to refer to paths outside of the image in " "your repository configuration.\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "[Output] Section" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Format=\\f[R], \\f[CR]--format=\\f[R], \\f[CR]-t\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The image format type to generate. One of \\f[CR]directory\\f[R] (for " "generating an OS image directly in a local directory), \\f[CR]tar\\f[R] " "(similar, but a tarball of the OS image is generated), \\f[CR]cpio\\f[R] " "(similar, but a cpio archive is generated), \\f[CR]disk\\f[R] (a block " "device OS image with a GPT partition table), \\f[CR]uki\\f[R] (a unified " "kernel image with the OS image in the \\f[CR].initrd\\f[R] PE section), " "\\f[CR]esp\\f[R] (\\f[CR]uki\\f[R] but wrapped in a disk image with only an " "ESP partition), \\f[CR]sysext\\f[R], \\f[CR]confext\\f[R], " "\\f[CR]portable\\f[R] or \\f[CR]none\\f[R] (the OS image is solely intended " "as a build image to produce another artifact). If the \\f[CR]disk\\f[R] " "output format is used, the disk image is generated using \\f[CR]systemd-" "repart\\f[R]. The repart partition definition files to use can be " "configured using the \\f[CR]RepartDirectories=\\f[R] setting or via " "\\f[CR]mkosi.repart/\\f[R]. When verity partitions are configured using " "systemd-repart\\[cq]s \\f[CR]Verity=\\f[R] setting, mkosi will automatically " "parse the verity hash partition\\[cq]s roothash from systemd-repart\\[cq]s " "JSON output and include it in the kernel command line of every unified " "kernel image built by mkosi.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ManifestFormat=\\f[R], \\f[CR]--manifest-format=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The manifest format type or types to generate. A comma-delimited list " "consisting of \\f[CR]json\\f[R] (the standard JSON output format that " "describes the packages installed), \\f[CR]changelog\\f[R] (a human-readable " "text format designed for diffing). By default no manifest is generated.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Output=\\f[R], \\f[CR]--output=\\f[R], \\f[CR]-o\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Name to use for the generated output image file or directory. All outputs " "will be prefixed with the given name. Defaults to \\f[CR]image\\f[R] or, if " "\\f[CR]ImageId=\\f[R] is specified, it is used as the default output name, " "optionally suffixed with the version set with \\f[CR]ImageVersion=\\f[R]. " "Note that this option does not allow configuring the output directory, use " "\\f[CR]OutputDirectory=\\f[R] for that. Note that this only specifies the " "output prefix, depending on the specific output format, compression and " "image version used, the full output name might be \\f[CR]image_7.8.raw." "xz\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CompressOutput=\\f[R], \\f[CR]--compress-output=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Configure compression for the resulting image or archive. The argument can " "be either a boolean or a compression algorithm (\\f[CR]xz\\f[R], " "\\f[CR]zstd\\f[R]). \\f[CR]zstd\\f[R] compression is used by default, " "except CentOS and derivatives up to version 8, which default to " "\\f[CR]xz\\f[R]. Note that when applied to block device image types, " "compression means the image cannot be started directly but needs to be " "decompressed first. This also means that the \\f[CR]shell\\f[R], " "\\f[CR]boot\\f[R], \\f[CR]qemu\\f[R] verbs are not available when this " "option is used. Implied for \\f[CR]tar\\f[R], \\f[CR]cpio\\f[R], " "\\f[CR]uki\\f[R], and \\f[CR]esp\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CompressLevel=\\f[R], \\f[CR]--compress-level=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Configure the compression level to use. Takes an integer. The possible " "values depend on the compression being used." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]OutputDirectory=\\f[R], \\f[CR]--output-dir=\\f[R], \\f[CR]-O\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Path to a directory where to place all generated artifacts. If this is not " "specified and the directory \\f[CR]mkosi.output/\\f[R] exists in the local " "directory, it is automatically used for this purpose.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]WorkspaceDirectory=\\f[R], \\f[CR]--workspace-dir=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Path to a directory where to store data required temporarily while building " "the image. This directory should have enough space to store the full OS " "image, though in most modes the actually used disk space is smaller. If not " "specified, a subdirectory of \\f[CR]$XDG_CACHE_HOME\\f[R] (if set), " "\\f[CR]$HOME/.cache\\f[R] (if set) or \\f[CR]/var/tmp\\f[R] is used. The " "data in this directory is removed automatically after each build. It\\[cq]s " "safe to manually remove the contents of this directory should an " "\\f[CR]mkosi\\f[R] invocation be aborted abnormally (for example, due to " "reboot/power failure).\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CacheDirectory=\\f[R], \\f[CR]--cache-dir=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a path to a directory to use as the incremental cache directory for " "the incremental images produced when the \\f[CR]Incremental=\\f[R] option is " "enabled. If this option is not used, but a \\f[CR]mkosi.cache/\\f[R] " "directory is found in the local directory it is automatically used for this " "purpose.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]PackageCacheDirectory=\\f[R], \\f[CR]--package-cache-dir\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Takes a path to a directory to use as the package cache directory for the " "distribution package manager used. If unset, a suitable directory in the " "user\\[cq]s home directory or system is used." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]BuildDirectory=\\f[R], \\f[CR]--build-dir=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a path to a directory to use as the build directory for build systems " "that support out-of-tree builds (such as Meson). The directory used this " "way is shared between repeated builds, and allows the build system to reuse " "artifacts (such as object files, executable, \\&...) generated on previous " "invocations. The build scripts can find the path to this directory in the " "\\f[CR]$BUILDDIR\\f[R] environment variable. This directory is mounted into " "the image\\[cq]s root directory when \\f[CR]mkosi-chroot\\f[R] is invoked " "during execution of the build scripts. If this option is not specified, but " "a directory \\f[CR]mkosi.builddir/\\f[R] exists in the local directory it is " "automatically used for this purpose (also see the \\f[B]Files\\f[R] section " "below).\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ImageVersion=\\f[R], \\f[CR]--image-version=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Configure the image version. This accepts any string, but it is recommended " "to specify a series of dot separated components. The version may also be " "configured in a file \\f[CR]mkosi.version\\f[R] in which case it may be " "conveniently managed via the \\f[CR]bump\\f[R] verb or the \\f[CR]--auto-" "bump\\f[R] option. When specified the image version is included in the " "default output file name, i.e.\\ instead of \\f[CR]image.raw\\f[R] the " "default will be \\f[CR]image_0.1.raw\\f[R] for version \\f[CR]0.1\\f[R] of " "the image, and similar. The version is also passed via the " "\\f[CR]$IMAGE_VERSION\\f[R] to any build scripts invoked (which may be " "useful to patch it into \\f[CR]/etc/os-release\\f[R] or similar, in " "particular the \\f[CR]IMAGE_VERSION=\\f[R] field of it).\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ImageId=\\f[R], \\f[CR]--image-id=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Configure the image identifier. This accepts a freeform string that shall " "be used to identify the image with. If set the default output file will be " "named after it (possibly suffixed with the version). The identifier is also " "passed via the \\f[CR]$IMAGE_ID\\f[R] to any build scripts invoked. The " "image ID is automatically added to \\f[CR]/usr/lib/os-release\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SplitArtifacts=\\f[R], \\f[CR]--split-artifacts\\fR" msgstr "" #. type: Plain text #: archlinux msgid "" "If specified and building a disk image, pass \\f[CR]--split=yes\\f[R] to " "systemd-repart to have it write out split partition files for each " "configured partition. Read the man (https://www.freedesktop.org/software/" "systemd/man/systemd-repart.html#--split=BOOL) page for more information. " "This is useful in A/B update scenarios where an existing disk image shall be " "augmented with a new version of a root or \\f[CR]/usr\\f[R] partition along " "with its Verity partition and unified kernel.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RepartDirectories=\\f[R], \\f[CR]--repart-dir=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Paths to directories containing systemd-repart partition definition files " "that are used when mkosi invokes systemd-repart when building a disk image. " "If \\f[CR]mkosi.repart/\\f[R] exists in the local directory, it will be used " "for this purpose as well. Note that mkosi invokes repart with \\f[CR]--" "root=\\f[R] set to the root of the image root, so any " "\\f[CR]CopyFiles=\\f[R] source paths in partition definition files will be " "relative to the image root directory.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SectorSize=\\f[R], \\f[CR]--sector-size=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Override the default sector size that systemd-repart uses when building a " "disk image." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RepartOffline=\\f[R], \\f[CR]--repart-offline=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Specifies whether to build disk images using loopback devices. Enabled by " "default. When enabled, \\f[CR]systemd-repart\\f[R] will not use loopback " "devices to build disk images. When disabled, \\f[CR]systemd-repart\\f[R] " "will always use loopback devices to build disk images. Note that when using " "\\f[CR]RepartOffline=no\\f[R] mkosi cannot run unprivileged and the image " "build has to be done as the root user outside of any containers and with " "loopback devices available on the host system. There are currently two " "known scenarios where \\f[CR]RepartOffline=no\\f[R] has to be used. The " "first is when using \\f[CR]Subvolumes=\\f[R] in a repart partition " "definition file, as subvolumes cannot be created without using loopback " "devices. The second is when creating a system with SELinux and an XFS root " "partition. Because \\f[CR]mkfs.xfs\\f[R] does not support populating an XFS " "filesystem with extended attributes, loopback devices have to be used to " "ensure the SELinux extended attributes end up in the generated XFS " "filesystem.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Overlay=\\f[R], \\f[CR]--overlay\\fR" msgstr "" #. type: Plain text #: archlinux msgid "" "When used together with \\f[CR]BaseTrees=\\f[R], the output will consist " "only out of changes to the specified base trees. Each base tree is attached " "as a lower layer in an overlayfs structure, and the output becomes the upper " "layer, initially empty. Thus files that are not modified compared to the " "base trees will not be present in the final output. This option may be used " "to create systemd \\f[I]system extensions\\f[R] or \\f[I]portable " "services\\f[R] (https://uapi-group.org/specifications/specs/extension_image)." "\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]UseSubvolumes=\\f[R], \\f[CR]--use-subvolumes=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a boolean or \\f[CR]auto\\f[R]. Enables or disables use of btrfs " "subvolumes for directory tree outputs. If enabled, mkosi will create the " "root directory as a btrfs subvolume and use btrfs subvolume snapshots where " "possible to copy base or cached trees which is much faster than doing a " "recursive copy. If explicitly enabled and \\f[CR]btrfs\\f[R] is not " "installed or subvolumes cannot be created, an error is raised. If " "\\f[CR]auto\\f[R], missing \\f[CR]btrfs\\f[R] or failures to create " "subvolumes are ignored.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Seed=\\f[R], \\f[CR]--seed=\\fR" msgstr "" #. type: Plain text #: archlinux msgid "" "Takes a UUID as argument or the special value \\f[CR]random\\f[R]. " "Overrides the seed that \\f[CR]systemd-repart(8)\\f[R] (https://www." "freedesktop.org/software/systemd/man/systemd-repart.service.html) uses when " "building a disk image. This is useful to achieve reproducible builds, where " "deterministic UUIDs and other partition metadata should be derived on each " "build.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SourceDateEpoch=\\f[R], \\f[CR]--source-date-epoch=\\fR" msgstr "" #. type: Plain text #: archlinux msgid "" "Takes a timestamp as argument. Resets file modification times of all files " "to this timestamp. The variable is also propagated to systemd-repart and " "scripts executed by mkosi. If not set explicitly, " "\\f[CR]SOURCE_DATE_EPOCH\\f[R] from \\f[CR]--environment\\f[R] and from the " "host environment are tried in that order. This is useful to make builds " "reproducible. See SOURCE_DATE_EPOCH (https://reproducible-builds.org/specs/" "source-date-epoch/) for more information.\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "[Content] Section" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Packages=\\f[R], \\f[CR]--package=\\f[R], \\f[CR]-p\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Install the specified distribution packages (i.e.\\ RPM, DEB, \\&...) in " "the image. Takes a comma separated list of package specifications. This " "option may be used multiple times in which case the specified package lists " "are combined. Use \\f[CR]BuildPackages=\\f[R] to specify packages that " "shall only be installed in an overlay that is mounted when the prepare " "scripts are executed with the \\f[CR]build\\f[R] argument and when the build " "scripts are executed. The types and syntax of \\f[I]package " "specifications\\f[R] that are allowed depend on the package installer (e.g." "\\ \\f[CR]dnf\\f[R] for \\f[CR]rpm\\f[R]-based distros or \\f[CR]apt\\f[R] " "for \\f[CR]deb\\f[R]-based distros), but may include package names, package " "names with version and/or architecture, package name globs, paths to " "packages in the file system, package groups, and virtual provides, including " "file paths. Example: when using a distro that uses \\f[CR]dnf\\f[R], the " "following configuration would install the \\f[CR]meson\\f[R] package (in the " "latest version), the 32-bit version of the \\f[CR]libfdisk-devel\\f[R] " "package, all available packages that start with the \\f[CR]git-\\f[R] " "prefix, a \\f[CR]systemd\\f[R] rpm from the local file system, one of the " "packages that provides \\f[CR]/usr/bin/ld\\f[R], the packages in the " "\\f[I]Development Tools\\f[R] group, and the package that contains the " "\\f[CR]mypy\\f[R] python module.\\fR" msgstr "" #. type: Plain text #: archlinux #, no-wrap msgid "" "Packages=meson\n" " libfdisk-devel.i686\n" " git-*\n" " prebuilt/rpms/systemd-249-rc1.local.rpm\n" " /usr/bin/ld\n" " \\[at]development-tools\n" " python3dist(mypy)\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" ": Note that since mkosi runs in a sandbox with most of the host files " "unavailable, any local packages have to be mounted into the sandbox " "explicitly using \\f[CR]BuildSources=\\f[R]. For example, let\\[cq]s say we " "have a local package located at \\f[CR]../my-packages/abc.rpm\\f[R] relative " "to the mkosi working directory, then we\\[cq]d be able to install it as " "follows:\\fR" msgstr "" #. type: Plain text #: archlinux #, no-wrap msgid "" "BuildSources=../my-packages:my-packages-in-sandbox\n" "Packages=my-packages-in-sandbox/abc.rpm\n" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]BuildPackages=\\f[R], \\f[CR]--build-package=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Similar to \\f[CR]Packages=\\f[R], but configures packages to install only " "in an overlay that is made available on top of the image to the prepare " "scripts when executed with the \\f[CR]build\\f[R] argument and the build " "scripts. This option should be used to list packages containing header " "files, compilers, build systems, linkers and other build tools the " "\\f[CR]mkosi.build\\f[R] scripts require to operate. Note that packages " "listed here will be absent in the final image.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]PackageDirectories=\\f[R], \\f[CR]--package-directory=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Specify directories containing extra packages to be made available during " "the build. \\f[CR]mkosi\\f[R] will create a local repository containing all " "packages in these directories and make it available when installing packages " "or running scripts. Note that this local repository is also made available " "when running scripts. Build scripts can add more packages to the local " "repository by placing the built packages in \\f[CR]$PACKAGEDIR\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]WithRecommends=\\f[R], \\f[CR]--with-recommends=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Configures whether to install recommended or weak dependencies, depending on " "how they are named by the used package manager, or not. By default, " "recommended packages are not installed. This is only used for package " "managers that support the concept, which are currently apt, dnf and zypper." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]WithDocs=\\f[R], \\f[CR]--with-docs\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Include documentation in the image. Enabled by default. When disabled, if " "the underlying distribution package manager supports it documentation is not " "included in the image. The \\f[CR]$WITH_DOCS\\f[R] environment variable " "passed to the \\f[CR]mkosi.build\\f[R] scripts is set to \\f[CR]0\\f[R] or " "\\f[CR]1\\f[R] depending on whether this option is enabled or disabled.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]BaseTrees=\\f[R], \\f[CR]--base-tree=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a comma separated list of paths to use as base trees. When used, " "these base trees are each copied into the OS tree and form the base " "distribution instead of installing the distribution from scratch. Only " "extra packages are installed on top of the ones already installed in the " "base trees. Note that for this to work properly, the base image still needs " "to contain the package manager metadata by setting " "\\f[CR]CleanPackageMetadata=no\\f[R] (see " "\\f[CR]CleanPackageMetadata=\\f[R]). Instead of a directory, a tar file or " "a disk image may be provided. In this case it is unpacked into the OS " "tree. This mode of operation allows setting permissions and file ownership " "explicitly, in particular for projects stored in a version control system " "such as \\f[CR]git\\f[R] which retain full file ownership and access mode " "metadata for committed files.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SkeletonTrees=\\f[R], \\f[CR]--skeleton-tree=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a comma separated list of colon separated path pairs. The first path " "of each pair refers to a directory to copy into the OS tree before invoking " "the package manager. The second path of each pair refers to the target " "directory inside the image. If the second path is not provided, the " "directory is copied on top of the root directory of the image. The second " "path is always interpreted as an absolute path. Use this to insert files " "and directories into the OS tree before the package manager installs any " "packages. If the \\f[CR]mkosi.skeleton/\\f[R] directory is found in the " "local directory it is also used for this purpose with the root directory as " "target (also see the \\f[B]Files\\f[R] section below). Note that skeleton " "trees are cached and any changes to skeleton trees after a cached image has " "been built (when using \\f[CR]Incremental=\\f[R]) are only applied when the " "cached image is rebuilt (by using \\f[CR]-ff\\f[R] or running \\f[CR]mkosi -" "f clean\\f[R]). As with the base tree logic above, instead of a directory, " "a tar file may be provided too. \\f[CR]mkosi.skeleton.tar\\f[R] will be " "automatically used if found in the local directory.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ExtraTrees=\\f[R], \\f[CR]--extra-tree=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a comma separated list of colon separated path pairs. The first path " "of each pair refers to a directory to copy from the host into the image. " "The second path of each pair refers to the target directory inside the " "image. If the second path is not provided, the directory is copied on top " "of the root directory of the image. The second path is always interpreted " "as an absolute path. Use this to override any default configuration files " "shipped with the distribution. If the \\f[CR]mkosi.extra/\\f[R] directory " "is found in the local directory it is also used for this purpose with the " "root directory as target. (also see the \\f[B]Files\\f[R] section below). " "As with the base tree logic above, instead of a directory, a tar file may be " "provided too. \\f[CR]mkosi.extra.tar\\f[R] will be automatically used if " "found in the local directory.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RemovePackages=\\f[R], \\f[CR]--remove-package=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a comma-separated list of package specifications for removal, in the " "same format as \\f[CR]Packages=\\f[R]. The removal will be performed as one " "of the last steps. This step is skipped if " "\\f[CR]CleanPackageMetadata=no\\f[R] is used.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RemoveFiles=\\f[R], \\f[CR]--remove-files=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "" "Takes a comma-separated list of globs. Files in the image matching the " "globs will be purged at the end." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CleanPackageMetadata=\\f[R], \\f[CR]--clean-package-metadata=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Enable/disable removal of package manager databases and repository metadata " "at the end of installation. Can be specified as \\f[CR]true\\f[R], " "\\f[CR]false\\f[R], or \\f[CR]auto\\f[R] (the default). With " "\\f[CR]auto\\f[R], package manager databases and repository metadata will be " "removed if the respective package manager executable is \\f[I]not\\f[R] " "present at the end of the installation.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SyncScripts=\\f[R], \\f[CR]--sync-script=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Takes a comma-separated list of paths to executables that are used as the " "sync scripts for this image. See the \\f[B]Scripts\\f[R] section for more " "information.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]PrepareScripts=\\f[R], \\f[CR]--prepare-script=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Takes a comma-separated list of paths to executables that are used as the " "prepare scripts for this image. See the \\f[B]Scripts\\f[R] section for " "more information.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]BuildScripts=\\f[R], \\f[CR]--build-script=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Takes a comma-separated list of paths to executables that are used as the " "build scripts for this image. See the \\f[B]Scripts\\f[R] section for more " "information.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]PostInstallationScripts=\\f[R], \\f[CR]--postinst-script=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Takes a comma-separated list of paths to executables that are used as the " "post-installation scripts for this image. See the \\f[B]Scripts\\f[R] " "section for more information.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]FinalizeScripts=\\f[R], \\f[CR]--finalize-script=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Takes a comma-separated list of paths to executables that are used as the " "finalize scripts for this image. See the \\f[B]Scripts\\f[R] section for " "more information.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]BuildSources=\\f[R], \\f[CR]--build-sources=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a comma separated list of colon separated path pairs. The first path " "of each pair refers to a directory to mount from the host. The second path " "of each pair refers to the directory where the source directory should be " "mounted when running scripts. Every target path is prefixed with \\f[CR]/" "work/src\\f[R] and all build sources are sorted lexicographically by their " "target before mounting, so that top level paths are mounted first. If not " "configured explicitly, the current working directory is mounted to \\f[CR]/" "work/src\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]BuildSourcesEphemeral=\\f[R], \\f[CR]--build-sources-ephemeral=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a boolean. Disabled by default. Configures whether changes to source " "directories (The working directory and configured using " "\\f[CR]BuildSources=\\f[R]) are persisted. If enabled, all source " "directories will be reset to their original state after scripts (except sync " "scripts) finish executing.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Environment=\\f[R], \\f[CR]--environment=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Adds variables to the environment that package managers and the prepare/" "build/postinstall/finalize scripts are executed with. Takes a space-" "separated list of variable assignments or just variable names. In the " "latter case, the values of those variables will be passed through from the " "environment in which \\f[CR]mkosi\\f[R] was invoked. This option may be " "specified more than once, in which case all listed variables will be set. " "If the same variable is set twice, the later setting overrides the earlier " "one.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]EnvironmentFiles=\\f[R], \\f[CR]--env-file=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a comma-separated list of paths to files that contain environment " "variable definitions to be added to the scripting environment. Uses " "\\f[CR]mkosi.env\\f[R] if it is found in the local directory. The variables " "are first read from \\f[CR]mkosi.env\\f[R] if it exists, then from the given " "list of files and then from the \\f[CR]Environment=\\f[R] settings.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]WithTests=\\f[R], \\f[CR]--without-tests\\f[R], \\f[CR]-T\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If set to false (or when the command-line option is used), the " "\\f[CR]$WITH_TESTS\\f[R] environment variable is set to \\f[CR]0\\f[R] when " "the \\f[CR]mkosi.build\\f[R] scripts are invoked. This is supposed to be " "used by the build scripts to bypass any unit or integration tests that are " "normally run during the source build process. Note that this option has no " "effect unless the \\f[CR]mkosi.build\\f[R] build scripts honor it.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]WithNetwork=\\f[R], \\f[CR]--with-network=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When true, enables network connectivity while the build scripts \\f[CR]mkosi." "build\\f[R] are invoked. By default, the build scripts run with networking " "turned off. The \\f[CR]$WITH_NETWORK\\f[R] environment variable is passed " "to the \\f[CR]mkosi.build\\f[R] build scripts indicating whether the build " "is done with or without network.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Bootable=\\f[R], \\f[CR]--bootable=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a boolean or \\f[CR]auto\\f[R]. Enables or disables generation of a " "bootable image. If enabled, mkosi will install an EFI bootloader, and add " "an ESP partition when the disk image output is used. If the selected EFI " "bootloader (See \\f[CR]Bootloader=\\f[R]) is not installed or no kernel " "images can be found, the build will fail. \\f[CR]auto\\f[R] behaves as if " "the option was enabled, but the build won\\[cq]t fail if either no kernel " "images or the selected EFI bootloader can\\[cq]t be found. If disabled, no " "bootloader will be installed even if found inside the image, no unified " "kernel images will be generated and no ESP partition will be added to the " "image if the disk output format is used.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Bootloader=\\f[R], \\f[CR]--bootloader=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes one of \\f[CR]none\\f[R], \\f[CR]systemd-boot\\f[R], \\f[CR]uki\\f[R] " "or \\f[CR]grub\\f[R]. Defaults to \\f[CR]systemd-boot\\f[R]. If set to " "\\f[CR]none\\f[R], no EFI bootloader will be installed into the image. If " "set to \\f[CR]systemd-boot\\f[R], systemd-boot will be installed and for " "each installed kernel, a UKI will be generated and stored in \\f[CR]EFI/" "Linux\\f[R] in the ESP. If set to \\f[CR]uki\\f[R], a single UKI will be " "generated for the latest installed kernel (the one with the highest version) " "which is installed to \\f[CR]EFI/BOOT/BOOTX64.EFI\\f[R] in the ESP. If set " "to \\f[CR]grub\\f[R], for each installed kernel, a UKI will be generated and " "stored in \\f[CR]EFI/Linux\\f[R] in the ESP. For each generated UKI, a menu " "entry is appended to the grub configuration in \\f[CR]grub/grub.cfg\\f[R] in " "the ESP which chainloads into the UKI. A shim grub.cfg is also written to " "\\f[CR]EFI/EdistributionE/grub.cfg\\f[R] in the ESP which loads " "\\f[CR]grub/grub.cfg\\f[R] in the ESP for compatibility with signed versions " "of grub which load the grub configuration from this location. Note that we " "do not yet install grub to the ESP when \\f[CR]Bootloader=\\f[R] is set to " "\\f[CR]grub\\f[R]. This has to be done manually in a postinst or finalize " "script. The grub EFI binary should be installed to \\f[CR]/efi/EFI/BOOT/" "BOOTX64.EFI\\f[R] (or similar depending on the architecture) and should be " "configured to load its configuration from \\f[CR]EFI/EdistributionE/" "grub.cfg\\f[R] in the ESP. Signed versions of grub shipped by distributions " "will load their configuration from this location by default.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]BiosBootloader=\\f[R], \\f[CR]--bios-bootloader=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes one of \\f[CR]none\\f[R] or \\f[CR]grub\\f[R]. Defaults to " "\\f[CR]none\\f[R]. If set to \\f[CR]none\\f[R], no BIOS bootloader will be " "installed. If set to \\f[CR]grub\\f[R], grub is installed as the BIOS boot " "loader if a bootable image is requested with the \\f[CR]Bootable=\\f[R] " "option. If no repart partition definition files are configured, mkosi will " "add a grub BIOS boot partition and an EFI system partition to the default " "partition definition files. Note that this option is not mutually exclusive " "with \\f[CR]Bootloader=\\f[R]. It is possible to have an image that is both " "bootable on UEFI and BIOS by configuring both \\f[CR]Bootloader=\\f[R] and " "\\f[CR]BiosBootloader=\\f[R]. The grub BIOS boot partition should have UUID " "\\f[CR]21686148-6449-6e6f-744e-656564454649\\f[R] and should be at least " "1MB. Even if no EFI bootloader is installed, we still need an ESP for BIOS " "boot as that\\[cq]s where we store the kernel, initrd and grub modules.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ShimBootloader=\\f[R], \\f[CR]--shim-bootloader=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes one of \\f[CR]none\\f[R], \\f[CR]unsigned\\f[R], or " "\\f[CR]signed\\f[R]. Defaults to \\f[CR]none\\f[R]. If set to " "\\f[CR]none\\f[R], shim and MokManager will not be installed to the ESP. If " "set to \\f[CR]unsigned\\f[R], mkosi will search for unsigned shim and " "MokManager EFI binaries and install them. If \\f[CR]SecureBoot=\\f[R] is " "enabled, mkosi will sign the unsigned EFI binaries before installing thel. " "If set to \\f[CR]signed\\f[R], mkosi will search for signed EFI binaries and " "install those. Even if \\f[CR]SecureBoot=\\f[R] is enabled, mkosi " "won\\[cq]t sign these binaries again. Note that this option only takes " "effect when an image that is bootable on UEFI firmware is requested using " "other options (\\f[CR]Bootable=\\f[R], \\f[CR]Bootloader=\\f[R]). Note that " "when this option is enabled, mkosi will only install already signed " "bootloader binaries, kernel image files and unified kernel images as self-" "signed binaries would not be accepted by the signed version of shim.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]UnifiedKernelImages=\\f[R], \\f[CR]--unified-kernel-images=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Specifies whether to use unified kernel images or not when " "\\f[CR]Bootloader=\\f[R] is set to \\f[CR]systemd-boot\\f[R] or " "\\f[CR]grub\\f[R]. Takes a boolean value or \\f[CR]auto\\f[R]. Defaults to " "\\f[CR]auto\\f[R]. If enabled, unified kernel images are always used and " "the build will fail if any components required to build unified kernel " "images are missing. If set to \\f[CR]auto\\f[R], unified kernel images will " "be used if all necessary components are available. Otherwise Type 1 entries " "as defined by the Boot Loader Specification will be used instead. If " "disabled, Type 1 entries will always be used.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Initrds=\\f[R], \\f[CR]--initrd\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Use user-provided initrd(s). Takes a comma separated list of paths to " "initrd files. This option may be used multiple times in which case the " "initrd lists are combined. If no initrds are specified and a bootable image " "is requested, mkosi will automatically build a default initrd." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]InitrdPackages=\\f[R], \\f[CR]--initrd-package=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Extra packages to install into the default initrd. Takes a comma separated " "list of package specifications. This option may be used multiple times in " "which case the specified package lists are combined." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]MicrocodeHost=\\f[R], \\f[CR]--microcode-host=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "When set to true only include microcode for the host\\[cq]s CPU in the image." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]KernelCommandLine=\\f[R], \\f[CR]--kernel-command-line=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Use the specified kernel command line when building images. Defaults to " "\\f[CR]console=ttyS0\\f[R]. For \\f[CR]arm\\f[R], \\f[CR]s390\\f[R] and " "\\f[CR]ppc\\f[R], \\f[CR]ttyS0\\f[R] is replaced with \\f[CR]ttyAMA0\\f[R], " "\\f[CR]ttysclp0\\f[R] or \\f[CR]hvc0\\f[R], respectively.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]KernelModulesInclude=\\f[R], \\f[CR]--kernel-modules-include=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a list of regex patterns that specify kernel modules to include in the " "image. Patterns should be relative to the \\f[CR]/usr/lib/modules/" "EkverE/kernel\\f[R] directory. mkosi checks for a match anywhere in " "the module path (e.g.\\ \\f[CR]i915\\f[R] will match against \\f[CR]drivers/" "gpu/drm/i915.ko\\f[R]). All modules that match any of the specified " "patterns are included in the image. All module and firmware dependencies of " "the matched modules are included in the image as well. This setting takes " "priority over \\f[CR]KernelModulesExclude=\\f[R] and only makes sense when " "used in combination with it because all kernel modules are included in the " "image by default.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]KernelModulesExclude=\\f[R], \\f[CR]--kernel-modules-exclude=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a list of regex patterns that specify modules to exclude from the " "image. Behaves the same as \\f[CR]KernelModulesInclude=\\f[R] except that " "all modules that match any of the specified patterns are excluded from the " "image.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]KernelModulesIncludeHost=\\f[R], \\f[CR]--kernel-modules-include-host=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a boolean. Specifies whether to include the currently loaded modules " "on the host system in the image. This setting takes priority over " "\\f[CR]KernelModulesExclude=\\f[R] and only makes sense when used in " "combination with it because all kernel modules are included in the image by " "default.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]KernelModulesInitrd=\\f[R], \\f[CR]--kernel-modules-initrd=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Enable/Disable generation of the kernel modules initrd when building a " "bootable image. Enabled by default. If enabled, when building a bootable " "image, for each kernel that we assemble a unified kernel image for we " "generate an extra initrd containing only the kernel modules for that kernel " "version and append it to the prebuilt initrd. This allows generating kernel " "independent initrds which are augmented with the necessary kernel modules " "when the UKI is assembled." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]KernelModulesInitrdInclude=\\f[R], \\f[CR]--kernel-modules-initrd-include=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Like \\f[CR]KernelModulesInclude=\\f[R], but applies to the kernel modules " "included in the kernel modules initrd.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]KernelModulesInitrdExclude=\\f[R], \\f[CR]--kernel-modules-initrd-exclude=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Like \\f[CR]KernelModulesExclude=\\f[R], but applies to the kernel modules " "included in the kernel modules initrd.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]KernelModulesInitrdIncludeHost=\\f[R], \\f[CR]--kernel-modules-initrd-include-host=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Like \\f[CR]KernelModulesIncludeHost=\\f[R], but applies to the kernel " "modules included in the kernel modules initrd.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Locale=\\f[R], \\f[CR]--locale=\\f[R], \\f[CR]LocaleMessages=\\f[R], \\f[CR]--locale-messages=\\f[R], \\f[CR]Keymap=\\f[R], \\f[CR]--keymap=\\f[R], \\f[CR]Timezone=\\f[R], \\f[CR]--timezone=\\f[R], \\f[CR]Hostname=\\f[R], \\f[CR]--hostname=\\f[R], \\f[CR]RootShell=\\f[R], \\f[CR]--root-shell=\\fR" msgstr "" #. type: Plain text #: archlinux msgid "" "The settings \\f[CR]Locale=\\f[R], \\f[CR]--locale=\\f[R], " "\\f[CR]LocaleMessages=\\f[R], \\f[CR]--locale-messages=\\f[R], " "\\f[CR]Keymap=\\f[R], \\f[CR]--keymap=\\f[R], \\f[CR]Timezone=\\f[R], " "\\f[CR]--timezone=\\f[R], \\f[CR]Hostname=\\f[R], \\f[CR]--hostname=\\f[R], " "\\f[CR]RootShell=\\f[R], \\f[CR]--root-shell=\\f[R] correspond to the " "identically named systemd-firstboot options. See the systemd firstboot " "manpage (https://www.freedesktop.org/software/systemd/man/systemd-firstboot." "html) for more information. Additionally, where applicable, the " "corresponding systemd credentials for these settings are written to \\f[CR]/" "usr/lib/credstore\\f[R], so that they apply even if only \\f[CR]/usr\\f[R] " "is shipped in the image.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RootPassword=\\f[R], \\f[CR]--root-password=\\f[R],\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Set the system root password. If this option is not used, but a " "\\f[CR]mkosi.rootpw\\f[R] file is found in the local directory, the password " "is automatically read from it. If the password starts with \\f[CR]hashed:" "\\f[R], it is treated as an already hashed root password. The root password " "is also stored in \\f[CR]/usr/lib/credstore\\f[R] under the appropriate " "systemd credential so that it applies even if only \\f[CR]/usr\\f[R] is " "shipped in the image. To create an unlocked account without any password " "use \\f[CR]hashed:\\f[R] without a hash.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Autologin=\\f[R], \\f[CR]--autologin\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Enable autologin for the \\f[CR]root\\f[R] user on \\f[CR]/dev/pts/0\\f[R] " "(nspawn), \\f[CR]/dev/tty1\\f[R] and \\f[CR]/dev/ttyS0\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]MakeInitrd=\\f[R], \\f[CR]--make-initrd\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Add \\f[CR]/etc/initrd-release\\f[R] and \\f[CR]/init\\f[R] to the image so " "that it can be used as an initramfs.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Ssh=\\f[R], \\f[CR]--ssh\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If specified, an sshd socket unit and matching service are installed in the " "final image that expose SSH over VSock. When building with this option and " "running the image using \\f[CR]mkosi qemu\\f[R], the \\f[CR]mkosi ssh\\f[R] " "command can be used to connect to the container/VM via SSH. Note that you " "still have to make sure openssh is installed in the image to make this " "option behave correctly. Run \\f[CR]mkosi genkey\\f[R] to automatically " "generate an X509 certificate and private key to be used by mkosi to enable " "SSH access to any virtual machines via \\f[CR]mkosi ssh\\f[R]. To access " "images booted using \\f[CR]mkosi boot\\f[R], use \\f[CR]machinectl\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SELinuxRelabel=\\f[R], \\f[CR]--selinux-relabel=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Specifies whether to relabel files to match the image\\[cq]s SELinux " "policy. Takes a boolean value or \\f[CR]auto\\f[R]. Defaults to " "\\f[CR]auto\\f[R]. If disabled, files will not relabeled. If enabled, an " "SELinux policy has to be installed in the image and \\f[CR]setfiles\\f[R] " "has to be available to relabel files. If any errors occur during " "\\f[CR]setfiles\\f[R], the build will fail. If set to \\f[CR]auto\\f[R], " "files will be relabeled if an SELinux policy is installed in the image and " "if \\f[CR]setfiles\\f[R] is available. Any errors occurred during " "\\f[CR]setfiles\\f[R] will be ignored. Note that when running unprivileged, " "\\f[CR]setfiles\\f[R] will fail to set any labels that are not in the " "host\\[cq]s SELinux policy. To ensure \\f[CR]setfiles\\f[R] succeeds " "without errors, make sure to run mkosi as root or build from a host system " "with the same SELinux policy as the image you\\[cq]re building.\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "[Validation] Section" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SecureBoot=\\f[R], \\f[CR]--secure-boot\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Sign systemd-boot (if it is not signed yet) and any generated unified kernel " "images for UEFI SecureBoot." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SecureBootAutoEnroll=\\f[R], \\f[CR]--secure-boot-auto-enroll=\\fR" msgstr "" #. type: Plain text #: archlinux msgid "" "Set up automatic enrollment of the secure boot keys in virtual machines as " "documented in the systemd-boot man page (https://www.freedesktop.org/" "software/systemd/man/systemd-boot.html) if \\f[CR]SecureBoot=\\f[R] is " "used. Note that systemd-boot will only do automatic secure boot key " "enrollment in virtual machines starting from systemd v253. To do auto " "enrollment on systemd v252 or on bare metal machines, write a systemd-boot " "configuration file to \\f[CR]/efi/loader/loader.conf\\f[R] using an extra " "tree with \\f[CR]secure-boot-enroll force\\f[R] or \\f[CR]secure-boot-enroll " "manual\\f[R] in it. Auto enrollment is not supported on systemd versions " "older than v252. Defaults to \\f[CR]yes\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SecureBootKey=\\f[R], \\f[CR]--secure-boot-key=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Path to the PEM file containing the secret key for signing the UEFI kernel " "image if \\f[CR]SecureBoot=\\f[R] is used and PCR signatures when " "\\f[CR]SignExpectedPcr=\\f[R] is also used. When " "\\f[CR]SecureBootKeySource=\\f[R] is specified, the input type depends on " "the source.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SecureBootKeySource=\\f[R], \\f[CR]--secure-boot-key-source=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Source of \\f[CR]SecureBootKey=\\f[R], to support OpenSSL engines. E.g.: " "\\f[CR]--secure-boot-key-source=engine:pkcs11\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SecureBootCertificate=\\f[R], \\f[CR]--secure-boot-certificate=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Path to the X.509 file containing the certificate for the signed UEFI kernel " "image, if \\f[CR]SecureBoot=\\f[R] is used.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SecureBootSignTool=\\f[R], \\f[CR]--secure-boot-sign-tool\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Tool to use to sign secure boot PE binaries. Takes one of " "\\f[CR]sbsign\\f[R], \\f[CR]pesign\\f[R] or \\f[CR]auto\\f[R]. Defaults to " "\\f[CR]auto\\f[R]. If set to \\f[CR]auto\\f[R], either sbsign or pesign are " "used if available, with sbsign being preferred if both are installed.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]VerityKey=\\f[R], \\f[CR]--verity-key=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Path to the PEM file containing the secret key for signing the verity " "signature, if a verity signature partition is added with systemd-repart. " "When \\f[CR]VerityKeySource=\\f[R] is specified, the input type depends on " "the source.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]VerityKeySource=\\f[R], \\f[CR]--verity-key-source=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Source of \\f[CR]VerityKey=\\f[R], to support OpenSSL engines. E.g.: " "\\f[CR]--verity-key-source=engine:pkcs11\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]VerityCertificate=\\f[R], \\f[CR]--verity-certificate=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Path to the X.509 file containing the certificate for signing the verity " "signature, if a verity signature partition is added with systemd-repart." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SignExpectedPcr=\\f[R], \\f[CR]--sign-expected-pcr\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Measure the components of the unified kernel image (UKI) using " "\\f[CR]systemd-measure\\f[R] and embed the PCR signature into the unified " "kernel image. This option takes a boolean value or the special value " "\\f[CR]auto\\f[R], which is the default, which is equal to a true value if " "the \\f[CR]systemd-measure\\f[R] binary is in \\f[CR]PATH\\f[R]. Depends on " "\\f[CR]SecureBoot=\\f[R] being enabled and key from " "\\f[CR]SecureBootKey=\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Passphrase=\\f[R], \\f[CR]--passphrase\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Specify the path to a file containing the passphrase to use for LUKS " "encryption. It should contain the passphrase literally, and not end in a " "newline character (i.e.\\ in the same format as cryptsetup and \\f[CR]/etc/" "crypttab\\f[R] expect the passphrase files). The file must have an access " "mode of 0600 or less.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Checksum=\\f[R], \\f[CR]--checksum\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Generate a \\f[CR]SHA256SUMS\\f[R] file of all generated artifacts after the " "build is complete.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Sign=\\f[R], \\f[CR]--sign\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Sign the generated \\f[CR]SHA256SUMS\\f[R] using \\f[CR]gpg\\f[R] after " "completion.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Key=\\f[R], \\f[CR]--key=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Select the \\f[CR]gpg\\f[R] key to use for signing \\f[CR]SHA256SUMS\\f[R]. " "This key must be already present in the \\f[CR]gpg\\f[R] keyring.\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "[Host] Section" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Incremental=\\f[R], \\f[CR]--incremental=\\f[R], \\f[CR]-i\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Enable incremental build mode. In this mode, a copy of the OS image is " "created immediately after all OS packages are installed and the prepare " "scripts have executed but before the \\f[CR]mkosi.build\\f[R] scripts are " "invoked (or anything that happens after it). On subsequent invocations of " "\\f[CR]mkosi\\f[R] with the \\f[CR]-i\\f[R] switch this cached image may be " "used to skip the OS package installation, thus drastically speeding up " "repetitive build times. Note that while there is some rudimentary cache " "invalidation, it is definitely not perfect. In order to force rebuilding of " "the cached image, combine \\f[CR]-i\\f[R] with \\f[CR]-ff\\f[R] to ensure " "the cached image is first removed and then re-created.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]NSpawnSettings=\\f[R], \\f[CR]--settings=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Specifies a \\f[CR].nspawn\\f[R] settings file for \\f[CR]systemd-" "nspawn\\f[R] to use in the \\f[CR]boot\\f[R] and \\f[CR]shell\\f[R] verbs, " "and to place next to the generated image file. This is useful to configure " "the \\f[CR]systemd-nspawn\\f[R] environment when the image is run. If this " "setting is not used but an \\f[CR]mkosi.nspawn\\f[R] file found in the local " "directory it is automatically used for this purpose.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ExtraSearchPaths=\\f[R], \\f[CR]--extra-search-path=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "List of colon-separated paths to look for tools in, before using the regular " "\\f[CR]$PATH\\f[R] search path.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuGui=\\f[R], \\f[CR]--qemu-gui=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "If enabled, qemu is executed with its graphical interface instead of with a " "serial console." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuSmp=\\f[R], \\f[CR]--qemu-smp=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When used with the \\f[CR]qemu\\f[R] verb, this options sets " "\\f[CR]qemu\\f[R]\\[cq]s \\f[CR]-smp\\f[R] argument which controls the " "number of guest\\[cq]s CPUs. Defaults to \\f[CR]2\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuMem=\\f[R], \\f[CR]--qemu-mem=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When used with the \\f[CR]qemu\\f[R] verb, this options sets " "\\f[CR]qemu\\f[R]\\[cq]s \\f[CR]-m\\f[R] argument which controls the amount " "of guest\\[cq]s RAM. Defaults to \\f[CR]2G\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuKvm=\\f[R], \\f[CR]--qemu-kvm=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When used with the \\f[CR]qemu\\f[R] verb, this option specifies whether " "QEMU should use KVM acceleration. Takes a boolean value or " "\\f[CR]auto\\f[R]. Defaults to \\f[CR]auto\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuVsock=\\f[R], \\f[CR]--qemu-vsock=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When used with the \\f[CR]qemu\\f[R] verb, this option specifies whether " "QEMU should be configured with a vsock. Takes a boolean value or " "\\f[CR]auto\\f[R]. Defaults to \\f[CR]auto\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuVsockConnectionId=\\f[R], \\f[CR]--qemu-vsock-cid=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When used with the \\f[CR]qemu\\f[R] verb, this option specifies the vsock " "connection ID to use. Takes a number in the interval \\f[CR][3, " "0xFFFFFFFF)\\f[R] or \\f[CR]hash\\f[R] or \\f[CR]auto\\f[R]. Defaults to " "\\f[CR]hash\\f[R]. When set to \\f[CR]hash\\f[R], the connection ID will be " "derived from the full path to the image. When set to \\f[CR]auto\\f[R], " "\\f[CR]mkosi\\f[R] will try to find a free connection ID automatically. " "Otherwise, the provided number will be used as is. Note that when set to " "\\f[CR]auto\\f[R], \\f[CR]mkosi ssh\\f[R] cannot be used as we cannot figure " "out which free connection ID we found when booting the image earlier.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuSwtpm=\\f[R], \\f[CR]--qemu-swtpm=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When used with the \\f[CR]qemu\\f[R] verb, this option specifies whether to " "start an instance of swtpm to be used as a TPM with qemu. This requires " "swtpm to be installed on the host. Takes a boolean value or " "\\f[CR]auto\\f[R]. Defaults to \\f[CR]auto\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuCdrom=\\f[R], \\f[CR]--qemu-cdrom=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When used with the \\f[CR]qemu\\f[R] verb, this option specifies whether to " "attach the image to the virtual machine as a CD-ROM device. Takes a " "boolean. Defaults to \\f[CR]no\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuFirmware=\\f[R], \\f[CR]--qemu-firmware=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When used with the \\f[CR]qemu\\f[R] verb, this option specifies which " "firmware to use. Takes one of \\f[CR]uefi\\f[R], \\f[CR]uefi-secure-" "boot\\f[R], \\f[CR]bios\\f[R], \\f[CR]linux\\f[R], or \\f[CR]auto\\f[R]. " "Defaults to \\f[CR]auto\\f[R]. When set to \\f[CR]uefi\\f[R], the OVMF " "firmware without secure boot support is used. When set to \\f[CR]uefi-" "secure-boot\\f[R], the OVMF firmware with secure boot support is used. When " "set to \\f[CR]bios\\f[R], the default SeaBIOS firmware is used. When set to " "\\f[CR]linux\\f[R], direct kernel boot is used. See the " "\\f[CR]QemuKernel=\\f[R] option for more details on which kernel image is " "used with direct kernel boot. When set to \\f[CR]auto\\f[R], \\f[CR]uefi-" "secure-boot\\f[R] is used if possible and \\f[CR]linux\\f[R] otherwise.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuFirmwareVariables=\\f[R], \\f[CR]--qemu-firmware-variables=\\fR" msgstr "" #. type: Plain text #: archlinux msgid "" "When used with the \\f[CR]qemu\\f[R] verb, this option specifies the path to " "the the firmware variables file to use. Currently, this option is only " "taken into account when the \\f[CR]uefi\\f[R] or \\f[CR]uefi-secure-" "boot\\f[R] firmware is used. If not specified, mkosi will search for the " "default variables file and use that instead. When set to " "\\f[CR]microsoft\\f[R], a firmware variables file with the Microsoft secure " "boot certificates already enrolled will be used. When set to " "\\f[CR]custom\\f[R], the secure boot certificate from " "\\f[CR]SecureBootCertificate=\\f[R] will be enrolled into the default " "firmware variables file. \\f[CR]virt-fw-vars\\f[R] from the virt-firmware " "(https://gitlab.com/kraxel/virt-firmware) project can be used to customize " "OVMF variable files.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuKernel=\\f[R], \\f[CR]--qemu-kernel=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Set the kernel image to use for qemu direct kernel boot. If not specified, " "mkosi will use the kernel provided via the command line (\\f[CR]-" "kernel\\f[R] option) or latest the kernel that was installed into the image " "(or fail if no kernel was installed into the image). Note that when the " "\\f[CR]cpio\\f[R] output format is used, direct kernel boot is used " "regardless of the configured firmware. Depending on the configured " "firmware, qemu might boot the kernel itself or using the configured firmware." "\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuDrives=\\f[R], \\f[CR]--qemu-drive=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Add a qemu drive. Takes a colon-delimited string of format " "\\f[CR]EidE:EsizeE[:EdirectoryE[:" "EoptionsE]]\\f[R]. \\f[CR]id\\f[R] specifies the qemu id we assign " "to the drive. This can be used as the \\f[CR]drive=\\f[R] property in " "various qemu devices. \\f[CR]size\\f[R] specifies the size of the drive. " "This takes a size in bytes. Additionally, the suffixes \\f[CR]K\\f[R], " "\\f[CR]M\\f[R] and \\f[CR]G\\f[R] can be used to specify a size in " "kilobytes, megabytes and gigabytes respectively. \\f[CR]directory\\f[R] " "optionally specifies the directory in which to create the file backing the " "drive. \\f[CR]options\\f[R] optionally specifies extra comma-delimited " "properties which are passed verbatim to qemu\\[cq]s \\f[CR]-drive\\f[R] " "option. Example usage:\\fR" msgstr "" #. type: Plain text #: archlinux #, no-wrap msgid "" "[Host]\n" "QemuDrives=btrfs:10G\n" " ext4:20G\n" "QemuArgs=-device nvme,serial=btrfs,drive=btrfs\n" " -device nvme,serial=ext4,drive=ext4\n" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]QemuArgs=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Space-delimited list of additional arguments to pass when invoking qemu." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Ephemeral=\\f[R], \\f[CR]--ephemeral\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When used with the \\f[CR]shell\\f[R], \\f[CR]boot\\f[R], or " "\\f[CR]qemu\\f[R] verbs, this option runs the specified verb on a temporary " "snapshot of the output image that is removed immediately when the container " "terminates. Taking the temporary snapshot is more efficient on file systems " "that support reflinks natively (btrfs or xfs) than on more traditional file " "systems that do not (ext4).\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Credentials=\\f[R], \\f[CR]--credential=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Set credentials to be passed to systemd-nspawn or qemu respectively when " "\\f[CR]mkosi shell/boot\\f[R] or \\f[CR]mkosi qemu\\f[R] are used. This " "option takes a space separated list of key=value assignments.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]KernelCommandLineExtra=\\f[R], \\f[CR]--kernel-command-line-extra=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Set extra kernel command line entries that are appended to the kernel " "command line at runtime when booting the image. When booting in a " "container, these are passed as extra arguments to systemd. When booting in " "a VM, these are appended to the kernel command line via the SMBIOS io." "systemd.stub.kernel-cmdline-extra OEM string. This will only be picked up " "by systemd-boot/systemd-stub versions newer than or equal to v254." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Acl=\\f[R], \\f[CR]--acl=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "If specified, ACLs will be set on any generated root filesystem directories " "that allow the user running mkosi to remove them without needing privileges." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ToolsTree=\\f[R], \\f[CR]--tools-tree=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If specified, programs executed by mkosi to build and boot an image are " "looked up inside the given tree instead of in the host system. Use this " "option to make image builds more reproducible by always using the same " "versions of programs to build the final image instead of whatever version is " "installed on the host system. If this option is not used, but the " "\\f[CR]mkosi.tools/\\f[R] directory is found in the local directory it is " "automatically used for this purpose with the root directory as target. Note " "that when looking up binaries in \\f[CR]--tools-tree=\\f[R], only \\f[CR]/" "usr/bin\\f[R] and \\f[CR]/usr/sbin\\f[R] are considered. Specifically, " "paths specified by \\f[CR]--extra-search-path=\\f[R] are ignored when " "looking up binaries in the given tools tree. If set to " "\\f[CR]default\\f[R], mkosi will automatically add an extra tools tree image " "and use it as the tools tree. The following table shows for which " "distributions default tools tree packages are defined and which packages are " "included in those default tools trees:\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Fedora" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "CentOS" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Debian" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Ubuntu" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Arch" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "openSUSE" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]acl\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]X\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]apt\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]archlinux-keyring\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]attr\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]bash\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]btrfs-progs\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]bubblewrap\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ca-certificates\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]coreutils\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]cpio\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]curl\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]debian-keyring\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]diffutils\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]distribution-gpg-keys\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]dnf\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]dnf-plugins-core\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]dnf5\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]dnf5-plugins\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]dosfstools\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]e2fsprogs\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]edk2-ovmf\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]erofs-utils\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]findutils\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]git\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]grep\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]jq\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]kmod\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]less\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]mtools\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]nano\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]openssh\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]openssl\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]sed\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]pacman\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]pesign\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]policycoreutils\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]sbsigntools\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]socat\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]squashfs-tools\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]strace\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]swtpm\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]systemd\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ukify\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]tar\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ubuntu-keyring\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]util-linux\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]virtiofsd\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]virt-firmware\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]xfsprogs\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]xz\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]zstd\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]zypper\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ToolsTreeDistribution=\\f[R], \\f[CR]--tools-tree-distribution=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Set the distribution to use for the default tools tree. By default, the " "same distribution as the image that\\[cq]s being built is used, except for " "CentOS and Ubuntu images, in which case Fedora and Debian are used " "respectively." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ToolsTreeRelease=\\f[R], \\f[CR]--tools-tree-release=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Set the distribution release to use for the default tools tree. By default, " "the hardcoded default release in mkosi for the distribution is used." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ToolsTreeMirror=\\f[R], \\f[CR]--tools-tree-mirror=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Set the mirror to use for the default tools tree. By default, the default " "mirror for the tools tree distribution is used." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ToolsTreeRepositories=\\f[R], \\f[CR]--tools-tree-repository\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Same as \\f[CR]Repositories=\\f[R] but for the default tools tree.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ToolsTreePackageManagerTrees=\\f[R], \\f[CR]--tools-tree-package-manager-tree=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Same as \\f[CR]PackageManagerTrees=\\f[R] but for the default tools tree.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ToolsTreePackages=\\f[R], \\f[CR]--tools-tree-packages=\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Extra packages to install into the default tools tree. Takes a comma " "separated list of package specifications. This option may be used multiple " "times in which case the specified package lists are combined." msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RuntimeTrees=\\f[R], \\f[CR]--runtime-tree=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a colon separated pair of paths. The first path refers to a directory " "to mount into any machine (container or VM) started by mkosi. The second " "path refers to the target directory inside the machine. If the second path " "is not provided, the directory is mounted below \\f[CR]/root/src\\f[R] in " "the machine. If the second path is relative, it is interpreted relative to " "\\f[CR]/root/src\\f[R] in the machine. For each mounted directory, the uid " "and gid of the user running mkosi are mapped to the root user in the " "machine. This means that all the files and directories will appear as if " "they\\[cq]re owned by root in the machine, and all new files and directories " "created by root in the machine in these directories will be owned by the " "user running mkosi on the host. Note that when using \\f[CR]mkosi " "qemu\\f[R] with this feature systemd v254 or newer has to be installed in " "the image.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RuntimeSize=\\f[R], \\f[CR]--runtime-size=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If specified, disk images are grown to the specified size before " "they\\[cq]re booted with systemd-nspawn or qemu. Takes a size in bytes. " "Additionally, the suffixes \\f[CR]K\\f[R], \\f[CR]M\\f[R] and \\f[CR]G\\f[R] " "can be used to specify a size in kilobytes, megabytes and gigabytes " "respectively.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RuntimeScratch=\\f[R]: \\f[CR]--runtime-scratch=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes a boolean value or \\f[CR]auto\\f[R]. Specifies whether to mount " "extra scratch space to \\f[CR]/var/tmp\\f[R]. If enabled, practically " "unlimited scratch space is made available under \\f[CR]/var/tmp\\f[R] when " "booting the image with \\f[CR]mkosi qemu\\f[R], \\f[CR]mkosi boot\\f[R] or " "\\f[CR]mkosi shell\\f[R]. Note that using this feature with \\f[CR]mkosi " "qemu\\f[R] requires systemd v254 or newer in the guest.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RuntimeNetwork=\\f[R]: \\f[CR]--runtime-network=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Takes one of \\f[CR]user\\f[R], \\f[CR]interface\\f[R] or " "\\f[CR]none\\f[R]. Defaults to \\f[CR]user\\f[R]. Specifies the networking " "to set up when booting the image. \\f[CR]user\\f[R] sets up usermode " "networking. \\f[CR]interface\\f[R] sets up a virtual network connection " "between the host and the image. This translates to a veth interface for " "\\f[CR]mkosi shell\\f[R] and \\f[CR]mkosi boot\\f[R] and a tap interface for " "\\f[CR]mkosi qemu\\f[R] and \\f[CR]mkosi vmspawn\\f[R]. Note that when " "using \\f[CR]interface\\f[R], mkosi does not automatically configure the " "host interface. It is expected that a recent version of \\f[CR]systemd-" "networkd\\f[R] is running on the host which will automatically configure the " "host interface of the link.\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SshKey=\\f[R], \\f[CR]--ssh-key=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Path to the X509 private key in PEM format to use to connect to a virtual " "machine started with \\f[CR]mkosi qemu\\f[R] and built with the " "\\f[CR]Ssh=\\f[R] option enabled via the \\f[CR]mkosi ssh\\f[R] command. If " "not configured and \\f[CR]mkosi.key\\f[R] exists in the working directory, " "it will automatically be used for this purpose. Run \\f[CR]mkosi " "genkey\\f[R] to automatically generate a key in \\f[CR]mkosi.key\\f[R].\\fR" msgstr "" #. type: TP #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SshCertificate=\\f[R], \\f[CR]--ssh-certificate=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Path to the X509 certificate in PEM format to provision as the SSH public " "key in virtual machines started with \\f[CR]mkosi qemu\\f[R]. If not " "configured and \\f[CR]mkosi.crt\\f[R] exists in the working directory, it " "will automatically be used for this purpose. Run \\f[CR]mkosi genkey\\f[R] " "to automatically generate a certificate in \\f[CR]mkosi.crt\\f[R].\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Specifiers" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The current value of various settings can be accessed when parsing " "configuration files by using specifiers. To write a literal \\f[CR]%\\f[R] " "character in a configuration file without treating it as a specifier, use " "\\f[CR]%%\\f[R]. The following specifiers are understood:\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Setting" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Specifier" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]%d\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]%r\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]%a\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]%t\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]Output=\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]%o\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]OutputDirectory=\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]%O\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]%i\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]%v\\fR" msgstr "" #. type: SS #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "Supported distributions" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Images may be created containing installations of the following " "distributions:" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "\\f[I]Fedora Linux\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "\\f[I]Debian\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "\\f[I]Ubuntu\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "\\f[I]Arch Linux\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "\\f[I]openSUSE\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "\\f[I]Mageia\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "\\f[I]CentOS\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "\\f[I]RHEL\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "\\f[I]RHEL UBI\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "\\f[I]OpenMandriva\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "\\f[I]Rocky Linux\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "\\f[I]Alma Linux\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "\\f[I]None\\f[R] (\\f[B]Requires the user to provide a pre-built " "rootfs\\f[R])\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "In theory, any distribution may be used on the host for building images " "containing any other distribution, as long as the necessary tools are " "available. Specifically, any distribution that packages \\f[CR]apt\\f[R] " "may be used to build \\f[I]Debian\\f[R] or \\f[I]Ubuntu\\f[R] images. Any " "distribution that packages \\f[CR]dnf\\f[R] may be used to build images for " "any of the rpm-based distributions. Any distro that packages " "\\f[CR]pacman\\f[R] may be used to build \\f[I]Arch Linux\\f[R] images. Any " "distribution that packages \\f[CR]zypper\\f[R] may be used to build " "\\f[I]openSUSE\\f[R] images. Other distributions and build automation tools " "for embedded Linux systems such as Buildroot, OpenEmbedded and Yocto Project " "may be used by selecting the \\f[CR]custom\\f[R] distribution, and " "populating the rootfs via a combination of base trees, skeleton trees, and " "prepare scripts.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "" "Currently, \\f[I]Fedora Linux\\f[R] packages all relevant tools as of Fedora " "28.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Note that when not using a custom mirror, \\f[CR]RHEL\\f[R] images can only " "be built from a host system with a \\f[CR]RHEL\\f[R] subscription " "(established using e.g.\\ \\f[CR]subscription-manager\\f[R]).\\fR" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Execution Flow" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Execution flow for \\f[CR]mkosi build\\f[R]. Default values/calls are shown " "in parentheses. When building with \\f[CR]--incremental\\f[R] mkosi creates " "a cache of the distribution installation if not already existing and " "replaces the distribution installation in consecutive runs with data from " "the cached one.\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "\\f[R]1.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Parse CLI options" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "2." msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Parse configuration files" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "3." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If we\\[cq]re not running as root, unshare the user namespace and map the " "subuid range configured in \\f[CR]/etc/subuid\\f[R] and \\f[CR]/etc/" "subgid\\f[R] into it.\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]4.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Unshare the mount namespace" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "5." msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Remount the following directories read-only if they exist:" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]/usr\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]/etc\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]/opt\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]/srv\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]/boot\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]/efi\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]/media\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]/mnt\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Then, for each image, we execute the following steps:" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid " 1." msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Copy package manager trees into the workspace" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid " 2." msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Sync the package manager repository metadata" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid " 3." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Copy base trees (\\f[CR]--base-tree=\\f[R]) into the image\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R] 4.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Reuse a cached image if one is available" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid " 5." msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Copy a snapshot of the package manager repository metadata into the image" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid " 6." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Copy skeleton trees (\\f[CR]mkosi.skeleton\\f[R]) into image\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R] 7.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Install distribution and packages into image" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid " 8." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Run prepare scripts on image with the \\f[CR]final\\f[R] argument " "(\\f[CR]mkosi.prepare\\f[R])\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R] 9.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Install build packages in overlay if any build scripts are configured" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "10." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Run prepare scripts on overlay with the \\f[CR]build\\f[R] argument if any " "build scripts are configured (\\f[CR]mkosi.prepare\\f[R])\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]11.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Cache the image if configured (\\f[CR]--incremental\\f[R])\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]12.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Run build scripts on image + overlay if any build scripts are configured " "(\\f[CR]mkosi.build\\f[R])\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]13.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Finalize the build if the output format \\f[CR]none\\f[R] is configured\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]14.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Copy the build scripts outputs into the image" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "15." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Copy the extra trees into the image (\\f[CR]mkosi.extra\\f[R])\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]16.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Run post-install scripts (\\f[CR]mkosi.postinst\\f[R])\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]17.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Write config files required for \\f[CR]Ssh=\\f[R], \\f[CR]Autologin=\\f[R] " "and \\f[CR]MakeInitrd=\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]18.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Install systemd-boot and configure secure boot if configured (\\f[CR]--" "secure-boot\\f[R])\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]19.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Run \\f[CR]systemd-sysusers\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]20.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Run \\f[CR]systemd-tmpfiles\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]21.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Run \\f[CR]systemctl preset-all\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]22.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Run \\f[CR]depmod\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]23.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Run \\f[CR]systemd-firstboot\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]24.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Run \\f[CR]systemd-hwdb\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]25.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Remove packages and files (\\f[CR]RemovePackages=\\f[R], " "\\f[CR]RemoveFiles=\\f[R])\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]26.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Run SELinux relabel is a SELinux policy is installed" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "27." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "Run finalize scripts (\\f[CR]mkosi.finalize\\f[R])\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]28.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Generate unified kernel image if configured to do so" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "29." msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Generate final output format" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Scripts" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "To allow for image customization that cannot be implemented using " "mkosi\\[cq]s builtin features, mkosi supports running scripts at various " "points during the image build process that can customize the image as " "needed. Scripts are executed on the host system as root (either real root " "or root within the user namespace that mkosi created when running " "unprivileged) with a customized environment to simplify modifying the " "image. For each script, the configured build sources " "(\\f[CR]BuildSources=\\f[R]) are mounted into the current working directory " "before running the script in the current working directory. " "\\f[CR]$SRCDIR\\f[R] is set to point to the current working directory. The " "following scripts are supported:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If \\f[CB]mkosi.sync\\f[R] (\\f[CR]SyncScripts=\\f[R]) exists, it is " "executed before the image is built. This script may be used to update " "various sources that are used to build the image. One use case is to run " "\\f[CR]git pull\\f[R] on various source repositories before building the " "image. Specifically, the \\f[CR]BuildSourcesEphemeral=\\f[R] setting does " "not apply to sync scripts, which means sync scripts can be used to update " "build sources even if \\f[CR]BuildSourcesEphemeral=\\f[R] is enabled.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If \\f[CB]mkosi.prepare\\f[R] (\\f[CR]PrepareScripts=\\f[R]) exists, it is " "first called with the \\f[CR]final\\f[R] argument, right after the software " "packages are installed. It is called a second time with the " "\\f[CR]build\\f[R] command line parameter, right after the build packages " "are installed and the build overlay mounted on top of the image\\[cq]s root " "directory . This script has network access and may be used to install " "packages from other sources than the distro\\[cq]s package manager (e.g.\\ " "\\f[CR]pip\\f[R], \\f[CR]npm\\f[R], \\&...), after all software packages are " "installed but before the image is cached (if incremental mode is enabled). " "In contrast to a general purpose installation, it is safe to install " "packages to the system (\\f[CR]pip install\\f[R], \\f[CR]npm install -" "g\\f[R]) instead of in \\f[CR]$SRCDIR\\f[R] itself because the build image " "is only used for a single project and can easily be thrown away and rebuilt " "so there\\[cq]s no risk of conflicting dependencies and no risk of polluting " "the host system.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If \\f[CB]mkosi.build\\f[R] (\\f[CR]BuildScripts=\\f[R]) exists, it is " "executed with the build overlay mounted on top of the image\\[cq]s root " "directory. When running the build script, \\f[CR]$DESTDIR\\f[R] points to a " "directory where the script should place any files generated it would like to " "end up in the image. Note that \\f[CR]make\\f[R]/\\f[CR]automake\\f[R]/" "\\f[CR]meson\\f[R] based build systems generally honor " "\\f[CR]$DESTDIR\\f[R], thus making it very natural to build " "\\f[I]source\\f[R] trees from the build script. After running the build " "script, the contents of \\f[CR]$DESTDIR\\f[R] are copied into the image.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If \\f[CB]mkosi.postinst\\f[R] (\\f[CR]PostInstallationScripts=\\f[R]) " "exists, it is executed after the (optional) build tree and extra trees have " "been installed. This script may be used to alter the images without any " "restrictions, after all software packages and built sources have been " "installed.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If \\f[CB]mkosi.finalize\\f[R] (\\f[CR]FinalizeScripts=\\f[R]) exists, it " "is executed as the last step of preparing an image.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If a script uses the \\f[CR].chroot\\f[R] extension, mkosi will chroot into " "the image using \\f[CR]mkosi-chroot\\f[R] (see below) before executing the " "script. For example, if \\f[CR]mkosi.postinst.chroot\\f[R] exists, mkosi " "will chroot into the image and execute it as the post-installation script." "\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Scripts executed by mkosi receive the following environment variables:" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$ARCHITECTURE\\f[R] contains the architecture from the " "\\f[CR]Architecture=\\f[R] setting. If \\f[CR]Architecture=\\f[R] is not " "set, it will contain the native architecture of the host machine. See the " "documentation of \\f[CR]Architecture=\\f[R] for possible values for this " "variable.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$DISTRIBUTION\\f[R] contains the distribution from the " "\\f[CR]Distribution=\\f[R] setting.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$RELEASE\\f[R] contains the release from the \\f[CR]Release=\\f[R] " "setting.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$PROFILE\\f[R] contains the profile from the \\f[CR]Profile=\\f[R] " "setting.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$CACHED=\\f[R] is set to \\f[CR]1\\f[R] if a cached image is " "available, \\f[CR]0\\f[R] otherwise.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$CHROOT_SCRIPT\\f[R] contains the path to the running script relative " "to the image root directory. The primary usecase for this variable is in " "combination with the \\f[CR]mkosi-chroot\\f[R] script. See the description " "of \\f[CR]mkosi-chroot\\f[R] below for more information.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$SRCDIR\\f[R] contains the path to the directory mkosi was invoked " "from, with any configured build sources mounted on top. " "\\f[CR]$CHROOT_SRCDIR\\f[R] contains the value that \\f[CR]$SRCDIR\\f[R] " "will have after invoking \\f[CR]mkosi-chroot\\f[R].\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$BUILDDIR\\f[R] is only defined if \\f[CR]mkosi.builddir\\f[R] exists " "and points to the build directory to use. This is useful for all build " "systems that support out-of-tree builds to reuse already built artifacts " "from previous runs. \\f[CR]$CHROOT_BUILDDIR\\f[R] contains the value that " "\\f[CR]$BUILDDIR\\f[R] will have after invoking \\f[CR]mkosi-chroot\\f[R]." "\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$DESTDIR\\f[R] is a directory into which any installed software " "generated by a build script may be placed. This variable is only set when " "executing a build script. \\f[CR]$CHROOT_DESTDIR\\f[R] contains the value " "that \\f[CR]$DESTDIR\\f[R] will have after invoking \\f[CR]mkosi-" "chroot\\f[R].\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$OUTPUTDIR\\f[R] points to the staging directory used to store build " "artifacts generated during the build. \\f[CR]$CHROOT_OUTPUTDIR\\f[R] " "contains the value that \\f[CR]$OUTPUTDIR\\f[R] will have after invoking " "\\f[CR]mkosi-chroot\\f[R].\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$PACKAGEDIR\\f[R] points to the directory containing the local " "package repository. Build scripts can add more packages to the local " "repository by writing the packages to \\f[CR]$PACKAGEDIR\\f[R].\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$BUILDROOT\\f[R] is the root directory of the image being built, " "optionally with the build overlay mounted on top depending on the script " "that\\[cq]s being executed.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$WITH_DOCS\\f[R] is either \\f[CR]0\\f[R] or \\f[CR]1\\f[R] depending " "on whether a build without or with installed documentation was requested " "(\\f[CR]WithDocs=yes\\f[R]). A build script should suppress installation of " "any package documentation to \\f[CR]$DESTDIR\\f[R] in case " "\\f[CR]$WITH_DOCS\\f[R] is set to \\f[CR]0\\f[R].\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$WITH_TESTS\\f[R] is either \\f[CR]0\\f[R] or \\f[CR]1\\f[R] " "depending on whether a build without or with running the test suite was " "requested (\\f[CR]WithTests=no\\f[R]). A build script should avoid running " "any unit or integration tests in case \\f[CR]$WITH_TESTS\\f[R] is " "\\f[CR]0\\f[R].\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$WITH_NETWORK\\f[R] is either \\f[CR]0\\f[R] or \\f[CR]1\\f[R] " "depending on whether a build without or with networking is being executed " "(\\f[CR]WithNetwork=no\\f[R]). A build script should avoid any network " "communication in case \\f[CR]$WITH_NETWORK\\f[R] is \\f[CR]0\\f[R].\\fR" msgstr "" #. type: Plain text #: archlinux msgid "" "\\f[CR]$SOURCE_DATE_EPOCH\\f[R] is defined if requested " "(\\f[CR]SourceDateEpoch=TIMESTAMP\\f[R], " "\\f[CR]Environment=SOURCE_DATE_EPOCH=TIMESTAMP\\f[R] or the host environment " "variable \\f[CR]$SOURCE_DATE_EPOCH\\f[R]). This is useful to make builds " "reproducible. See SOURCE_DATE_EPOCH (https://reproducible-builds.org/specs/" "source-date-epoch/) for more information.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$MKOSI_UID\\f[R] and \\f[CR]$MKOSI_GID\\f[R] are the respectively the " "uid, gid of the user that invoked mkosi, potentially translated to a uid in " "the user namespace that mkosi is running in. These can be used in " "combination with \\f[CR]setpriv\\f[R] to run commands as the user that " "invoked mkosi (e.g. \\f[CR]setpriv --reuid=$MKOSI_UID --regid=$MKOSI_GID --" "clear-groups EcommandE\\f[R])\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$MKOSI_CONFIG\\f[R] is a file containing a json summary of the " "settings of the current image. This file can be parsed inside scripts to " "gain access to all settings for the current image.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Consult this table for which script receives which environment variables:" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Variable" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]mkosi.sync\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]mkosi.prepare\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]mkosi.build\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]mkosi.postinst\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]mkosi.finalize\\fR" msgstr "" #. type: tbl table #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]_\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]ARCHITECTURE\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]DISTRIBUTION\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]RELEASE\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]PROFILE\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CACHED\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CHROOT_SCRIPT\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SRCDIR\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CHROOT_SRCDIR\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]BUILDDIR\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CHROOT_BUILDDIR\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]DESTDIR\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CHROOT_DESTDIR\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]OUTPUTDIR\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]CHROOT_OUTPUTDIR\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]BUILDROOT\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]WITH_DOCS\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]WITH_TESTS\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]WITH_NETWORK\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]SOURCE_DATE_EPOCH\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]MKOSI_UID\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]MKOSI_GID\\fR" msgstr "" #. type: tbl table #: archlinux opensuse-tumbleweed #, no-wrap msgid "\\f[CR]MKOSI_CONFIG\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Additionally, when a script is executed, a few scripts are made available " "via \\f[CR]$PATH\\f[R] to simplify common usecases.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]mkosi-chroot\\f[R]: This script will chroot into the image and " "execute the given command. On top of chrooting into the image, it will also " "mount various files and directories (\\f[CR]$SRCDIR\\f[R], " "\\f[CR]$DESTDIR\\f[R], \\f[CR]$BUILDDIR\\f[R], \\f[CR]$OUTPUTDIR\\f[R], " "\\f[CR]$CHROOT_SCRIPT\\f[R]) into the image and modify the corresponding " "environment variables to point to the locations inside the image. It will " "also mount APIVFS filesystems (\\f[CR]/proc\\f[R], \\f[CR]/dev\\f[R], " "\\&...) to make sure scripts and tools executed inside the chroot work " "properly. It also propagates \\f[CR]/etc/resolv.conf\\f[R] from the host " "into the chroot if requested so that DNS resolution works inside the " "chroot. After the mkosi-chroot command exits, various mount points are " "cleaned up.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "For example, to invoke \\f[CR]ls\\f[R] inside of the image, use the " "following\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "mkosi-chroot ls ...\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "To execute the entire script inside the image, add a \\[lq].chroot\\[rq] " "suffix to the name (\\f[CR]mkosi.build.chroot\\f[R] instead of \\f[CR]mkosi." "build\\f[R], etc.).\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "For all of the supported package managers except portage (\\f[CR]dnf\\f[R], " "\\f[CR]rpm\\f[R], \\f[CR]apt\\f[R], \\f[CR]pacman\\f[R], " "\\f[CR]zypper\\f[R]), scripts of the same name are put into " "\\f[CR]$PATH\\f[R] that make sure these commands operate on the image\\[cq]s " "root directory with the configuration supplied by the user instead of on the " "host system. This means that from a script, you can do e.g.\\ \\f[CR]dnf " "install vim\\f[R] to install vim into the image.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Additionally, \\f[CR]mkosi-install\\f[R], \\f[CR]mkosi-reinstall\\f[R], " "\\f[CR]mkosi-upgrade\\f[R] and \\f[CR]mkosi-remove\\f[R] will invoke the " "corresponding operation of the package manager being used to built the image." "\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]mkosi-as-caller\\f[R]: This script uses \\f[CR]setpriv\\f[R] to " "switch from the user \\f[CR]root\\f[R] in the user namespace used for " "various build steps back to the original user that called mkosi. This is " "useful when we want to invoke build steps which will write to " "\\f[CR]$BUILDDIR\\f[R] and we want to have the files owned by the calling " "user.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "For example, a complete \\f[CR]mkosi.build\\f[R] script might be the " "following:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "set -ex\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "mkosi-as-caller meson setup \\[dq]$BUILDDIR/build\\[dq] \\[dq]$SRCDIR\\[dq]\n" "mkosi-as-caller meson compile -C \\[dq]$BUILDDIR/build\\[dq]\n" "meson install -C \\[dq]$BUILDDIR/build\\[dq] --no-rebuild\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]git\\f[R] is automatically invoked with \\f[CR]safe.directory=*\\f[R] " "to avoid permissions errors when running as the root user in a user " "namespace.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]useradd\\f[R] and \\f[CR]groupadd\\f[R] are automatically invoked " "with \\f[CR]--root=$BUILDROOT\\f[R] when executed outside of the image.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When scripts are executed, any directories that are still writable are also " "made read-only (\\f[CR]/home\\f[R], \\f[CR]/var\\f[R], \\f[CR]/root\\f[R], " "\\&...) and only the minimal set of directories that need to be writable " "remain writable. This is to ensure that scripts can\\[cq]t mess with the " "host system when mkosi is running as root.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Note that when executing scripts, all source directories are made ephemeral " "which means all changes made to source directories while running scripts are " "thrown away after the scripts finish executing. Use the output, build or " "cache directories if you need to persist data between builds." msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "Files" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "" "To make it easy to build images for development versions of your projects, " "mkosi can read configuration data from the local directory, under the " "assumption that it is invoked from a \\f[I]source\\f[R] tree. Specifically, " "the following files are used if they exist in the local directory:\\fR" msgstr "" #. type: Plain text #: archlinux fedora-40 mageia-cauldron opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.skeleton/\\f[R] directory or \\f[CB]mkosi.skeleton." "tar\\f[R] archive may be used to insert files into the image. The files are " "copied \\f[I]before\\f[R] the distribution packages are installed into the " "image. This allows creation of files that need to be provided early, for " "example to configure the package manager or set systemd presets.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "" "When using the directory, file ownership is not preserved: all files copied " "will be owned by root. To preserve ownership, use a tar archive." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.extra/\\f[R] directory or \\f[CB]mkosi.extra.tar\\f[R] " "archive may be used to insert additional files into the image, on top of " "what the distribution includes in its packages. They are similar to " "\\f[CR]mkosi.skeleton/\\f[R] and \\f[CR]mkosi.skeleton.tar\\f[R], but the " "files are copied into the directory tree of the image \\f[I]after\\f[R] the " "OS was installed.\\fR" msgstr "" #. type: Plain text #: archlinux fedora-40 mageia-cauldron opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.nspawn\\f[R] nspawn settings file will be copied into the " "same place as the output image file, if it exists. This is useful since " "nspawn looks for settings files next to image files it boots, for additional " "container runtime settings.\\fR" msgstr "" #. type: Plain text #: archlinux fedora-40 mageia-cauldron opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.cache/\\f[R] directory, if it exists, is automatically used " "as package download cache, in order to speed repeated runs of the tool.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.builddir/\\f[R] directory, if it exists, is automatically " "used as out-of-tree build directory, if the build commands in the " "\\f[CR]mkosi.build\\f[R] scripts support it. Specifically, this directory " "will be mounted into the build container, and the \\f[CR]$BUILDDIR\\f[R] " "environment variable will be set to it when the build scripts are invoked. " "A build script may then use this directory as build directory, for automake-" "style or ninja-style out-of-tree builds. This speeds up builds " "considerably, in particular when \\f[CR]mkosi\\f[R] is used in incremental " "mode (\\f[CR]-i\\f[R]): not only the image and build overlay, but also the " "build tree is reused between subsequent invocations. Note that if this " "directory does not exist the \\f[CR]$BUILDDIR\\f[R] environment variable is " "not set, and it is up to the build scripts to decide whether to do in in-" "tree or an out-of-tree build, and which build directory to use.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.rootpw\\f[R] file can be used to provide the password for " "the root user of the image. If the password is prefixed with \\f[CR]hashed:" "\\f[R] it is treated as an already hashed root password. The password may " "optionally be followed by a newline character which is implicitly removed. " "The file must have an access mode of 0600 or less. If this file does not " "exist, the distribution\\[cq]s default root password is set (which usually " "means access to the root user is blocked).\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.passphrase\\f[R] file provides the passphrase to use when " "LUKS encryption is selected. It should contain the passphrase literally, " "and not end in a newline character (i.e.\\ in the same format as cryptsetup " "and \\f[CR]/etc/crypttab\\f[R] expect the passphrase files). The file must " "have an access mode of 0600 or less.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.crt\\f[R] and \\f[CB]mkosi.key\\f[R] files contain an X.509 " "certificate and PEM private key to use when signing is required (UEFI " "SecureBoot, verity, \\&...).\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.output/\\f[R] directory is used to store all build " "artifacts.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.credentials/\\f[R] directory is used as a source of extra " "credentials similar to the \\f[CR]Credentials=\\f[R] option. For each file " "in the directory, the filename will be used as the credential name and the " "file contents become the credential value, or, if the file is executable, " "mkosi will execute the file and the command\\[cq]s output to stdout will be " "used as the credential value. Output to stderr will be ignored. " "Credentials configured with \\f[CR]Credentials=\\f[R] take precedence over " "files in \\f[CR]mkosi.credentials\\f[R].\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The \\f[CB]mkosi.repart/\\f[R] directory is used as the source for systemd-" "repart partition definition files which are passed to systemd-repart when " "building a disk image. If it does not exist and the " "\\f[CR]RepartDirectories=\\f[R] setting is not configured, mkosi will " "default to the following partition definition files:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]00-esp.conf\\f[R] (if we\\[cq]re building a bootable image):\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "[Partition]\n" "Type=esp\n" "Format=vfat\n" "CopyFiles=/boot:/\n" "CopyFiles=/efi:/\n" "SizeMinBytes=512M\n" "SizeMaxBytes=512M\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]05-bios.conf\\f[R] (if we\\[cq]re building a BIOS bootable image):\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "[Partition]\n" "# UUID of the grub BIOS boot partition which grubs needs on GPT to\n" "# embed itself into.\n" "Type=21686148-6449-6e6f-744e-656564454649\n" "SizeMinBytes=1M\n" "SizeMaxBytes=1M\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]10-root.conf\\f[R]:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "[Partition]\n" "Type=root\n" "Format=Edistribution-default-filesystemE\n" "CopyFiles=/\n" "Minimize=guess\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Note that if either \\f[CR]mkosi.repart/\\f[R] is found or " "\\f[CR]RepartDirectories=\\f[R] is used, we will not use any of the default " "partition definitions.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "All these files are optional." msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Note that the location of all these files may also be configured during " "invocation via command line switches, and as settings in \\f[CR]mkosi." "conf\\f[R], in case the default settings are not acceptable for a project." "\\fR" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "CACHING" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]mkosi\\f[R] supports three different caches for speeding up " "repetitive re-building of images. Specifically:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The package cache of the distribution package manager may be cached between " "builds. This is configured with the \\f[CR]--cache-dir=\\f[R] option or the " "\\f[CR]mkosi.cache/\\f[R] directory. This form of caching relies on the " "distribution\\[cq]s package manager, and caches distribution packages (RPM, " "DEB, \\&...) after they are downloaded, but before they are unpacked.\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "\\f[R]2.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If the incremental build mode is enabled with \\f[CR]--incremental\\f[R], " "cached copies of the final image and build overlay are made immediately " "before the build sources are copied in (for the build overlay) or the " "artifacts generated by \\f[CR]mkosi.build\\f[R] are copied in (in case of " "the final image). This form of caching allows bypassing the time-consuming " "package unpacking step of the distribution package managers, but is only " "effective if the list of packages to use remains stable, but the build " "sources and its scripts change regularly. Note that this cache requires " "manual flushing: whenever the package list is modified the cached images " "need to be explicitly removed before the next re-build, using the \\f[CR]-" "f\\f[R] switch.\\fR" msgstr "" #. type: IP #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "\\f[R]3.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Finally, between multiple builds the build artifact directory may be shared, " "using the \\f[CR]mkosi.builddir/\\f[R] directory. This directory allows " "build systems such as Meson to reuse already compiled sources from a " "previous built, thus speeding up the build process of a \\f[CR]mkosi." "build\\f[R] build script.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The package cache and incremental mode are unconditionally useful. The " "final cache only apply to uses of \\f[CR]mkosi\\f[R] with a source tree and " "build script. When all three are enabled together turn-around times for " "complete image builds are minimal, as only changed source files need to be " "recompiled.\\fR" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Building multiple images" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "If the \\f[CR]mkosi.images/\\f[R] directory exists, mkosi will load " "individual image configurations from it and build each of them. Image " "configurations can be either directories containing mkosi configuration " "files or regular files with the \\f[CR].conf\\f[R] extension.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When image configurations are found in \\f[CR]mkosi.images/\\f[R], mkosi " "will build the configured images and all of their dependencies (or all of " "them if no images were explicitly configured using \\f[CR]Images=\\f[R]). " "To add dependencies between images, the \\f[CR]Dependencies=\\f[R] setting " "can be used.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "When images are defined, mkosi will first read the global configuration " "(configuration outside of the \\f[CR]mkosi.images/\\f[R] directory), " "followed by the image specific configuration. This means that global " "configuration takes precedence over image specific configuration.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Images can refer to outputs of images they depend on. Specifically, for the " "following options, mkosi will only check whether the inputs exist just " "before building the image:" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]BaseTrees=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]PackageManagerTrees=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]SkeletonTrees=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]ExtraTrees=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]ToolsTree=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]Initrds=\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "To refer to outputs of a image\\[cq]s dependencies, simply configure any of " "these options with a relative path to the output to use in the output " "directory of the dependency. Or use the \\f[CR]%O\\f[R] specifier to refer " "to the output directory.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable msgid "" "A good example on how to build multiple images can be found in the systemd " "(https://github.com/systemd/systemd/tree/main/mkosi.images) repository." msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "ENVIRONMENT VARIABLES" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$MKOSI_LESS\\f[R] overrides options for \\f[CR]less\\f[R] when it is " "invoked by \\f[CR]mkosi\\f[R] to page output.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "\\f[CR]$MKOSI_DNF\\f[R] can be used to override the executable used as " "\\f[CR]dnf\\f[R]. This is particularly useful to select between " "\\f[CR]dnf\\f[R] and \\f[CR]dnf5\\f[R].\\fR" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "EXAMPLES" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Create and run a raw \\f[I]GPT\\f[R] image with \\f[I]ext4\\f[R], as " "\\f[CR]image.raw\\f[R]:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "# mkosi -p systemd --incremental boot\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Create and run a bootable \\f[I]GPT\\f[R] image, as \\f[CR]foobar.raw\\f[R]:" "\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "$ mkosi -d fedora -p kernel-core -p systemd -p systemd-boot -p udev -o foobar.raw\n" "# mkosi --output foobar.raw boot\n" "$ mkosi --output foobar.raw qemu\n" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "Create and run a \\f[I]Fedora Linux\\f[R] image in a plain directory:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "# mkosi --distribution fedora --format directory boot\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Create a compressed image \\f[CR]image.raw.xz\\f[R] with \\f[I]SSH\\f[R] " "installed and add a checksum file:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "$ mkosi --distribution fedora --format disk --checksum --compress-output --package=openssh-clients\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Inside the source directory of an \\f[CR]automake\\f[R]-based project, " "configure \\f[I]mkosi\\f[R] so that simply invoking \\f[CR]mkosi\\f[R] " "without any parameters builds an OS image containing a built version of the " "project in its current state:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "$ cat Emkosi.conf EEEOF\n" "[Distribution]\n" "Distribution=fedora\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "[Output]\n" "Format=disk\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "[Content]\n" "Packages=kernel,systemd,systemd-udev,openssh-clients,httpd\n" "BuildPackages=make,gcc,libcurl-devel\n" "EOF\n" "$ cat Emkosi.build EEEOF\n" "#!/bin/sh\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "if [ \\[dq]$container\\[dq] != \\[dq]mkosi\\[dq] ]; then\n" " exec mkosi-chroot \\[dq]$CHROOT_SCRIPT\\[dq] \\[dq]$\\[at]\\[dq]\n" "fi\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "cd $SRCDIR\n" "\\&./autogen.sh\n" "\\&./configure --prefix=/usr\n" "make -j \\[ga]nproc\\[ga]\n" "make install\n" "EOF\n" "$ chmod +x mkosi.build\n" "# mkosi --incremental boot\n" "# systemd-nspawn -bi image.raw\n" msgstr "" #. type: SS #: archlinux opensuse-tumbleweed #, no-wrap msgid "Different ways to boot with \\f[CR]qemu\\fB" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The easiest way to boot a virtual machine is to build an image with the " "required components and let \\f[CR]mkosi\\f[R] call \\f[CR]qemu\\f[R] with " "all the right options:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "" "$ mkosi -d fedora \\[rs]\n" " --autologin \\[rs]\n" " -p systemd-udev,systemd-boot,kernel-core \\[rs]\n" " build\n" "$ mkosi -d fedora qemu\n" "\\&...\n" "fedora login: root (automatic login)\n" "[root\\[at]fedora \\[ti]]#\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "The default is to boot with a text console only. In this mode, messages " "from the boot loader, the kernel, and systemd, and later the getty login " "prompt and shell all use the same terminal. It is possible to switch " "between the qemu console and monitor by pressing \\f[CR]Ctrl-a c\\f[R]. The " "qemu monitor may for example be used to inject special keys or shut down the " "machine quickly.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "To boot with a graphical window, add \\f[CR]--qemu-qui\\f[R]:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "$ mkosi -d fedora --qemu-gui qemu\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "A kernel may be booted directly with \\f[CR]mkosi qemu -kernel ... -" "initrd ... -append \\[aq]...\\[aq]\\f[R]. This is a bit faster because no " "boot loader is used, and it is also easier to experiment with different " "kernels and kernel commandlines. Note that despite the name, qemu\\[cq]s " "\\f[CR]-append\\f[R] option replaces the default kernel commandline embedded " "in the kernel and any previous \\f[CR]-append\\f[R] specifications.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "The UKI is also copied into the output directory and may be booted directly:" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "$ mkosi qemu -kernel mkosi.output/fedora\\[ti]38/image.efi\n" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "When booting using an external kernel, we don\\[cq]t need the kernel " "\\f[I]in\\f[R] the image, but we would still want the kernel modules to be " "installed.\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "It is also possible to do a \\f[I]direct kernel boot\\f[R] into a boot " "loader, taking advantage of the fact that \\f[CR]systemd-boot(7)\\f[R] is a " "valid UEFI binary:\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "$ mkosi qemu -kernel /usr/lib/systemd/boot/efi/systemd-bootx64.efi\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "In this scenario, the kernel is loaded from the ESP in the image by " "\\f[CR]systemd-boot\\f[R].\\fR" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "REQUIREMENTS" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "" "mkosi is packaged for various distributions: Debian, Ubuntu, Arch Linux, " "Fedora Linux, OpenMandriva, Gentoo. Note that it has been a while since the " "last release and the packages shipped by distributions are very out of " "date. We currently recommend running mkosi from git until a new release " "happens." msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "mkosi currently requires systemd 254 to build bootable disk images." msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed msgid "" "When not using distribution packages make sure to install the necessary " "dependencies. For example, on \\f[I]Fedora Linux\\f[R] you need:\\fR" msgstr "" #. type: Plain text #: archlinux #, no-wrap msgid "# dnf install bubblewrap btrfs-progs apt dosfstools mtools edk2-ovmf e2fsprogs squashfs-tools gnupg python3 tar xfsprogs xz zypper sbsigntools\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "On Debian/Ubuntu it might be necessary to install the \\f[CR]ubuntu-" "keyring\\f[R], \\f[CR]ubuntu-archive-keyring\\f[R] and/or \\f[CR]debian-" "archive-keyring\\f[R] packages explicitly, in addition to \\f[CR]apt\\f[R], " "depending on what kind of distribution images you want to build.\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "Note that the minimum required Python version is 3.9." msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "Frequently Asked Questions (FAQ)" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Why does \\f[CR]mkosi qemu\\f[R] with KVM not work on Debian/Ubuntu?\\fR" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "While other distributions are OK with allowing access to \\f[CR]/dev/" "kvm\\f[R], on Debian/Ubuntu this is only allowed for users in the " "\\f[CR]kvm\\f[R] group. Because mkosi unshares a user namespace when " "running unprivileged, even if the calling user was in the kvm group, when " "mkosi unshares the user namespace to run unprivileged, it loses access to " "the \\f[CR]kvm\\f[R] group and by the time we start \\f[CR]qemu\\f[R] we " "don\\[cq]t have access to \\f[CR]/dev/kvm\\f[R] anymore. As a workaround, " "you can change the permissions of the device nodes to \\f[CR]0666\\f[R] " "which is sufficient to make KVM work unprivileged. To persist these " "settings across reboots, copy \\f[CR]/usr/lib/tmpfiles.d/static-nodes-" "permissions.conf\\f[R] to \\f[CR]/etc/tmpfiles.d/static-nodes-permissions." "conf\\f[R] and change the mode of \\f[CR]/dev/kvm\\f[R] from " "\\f[CR]0660\\f[R] to \\f[CR]0666\\f[R].\\fR" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "How do I add a regular user to an image?" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable opensuse-tumbleweed msgid "You can use the following snippet in a post-installation script:" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed #, no-wrap msgid "useradd --create-home --user-group $USER --password \\[dq]$(openssl passwd -stdin -6 E$USER_PASSWORD_FILE)\\[dq]\n" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "" "Note that from systemd v256 onwards, if enabled, \\f[CR]systemd-homed-" "firstboot.service\\f[R] will prompt to create a regular user on first boot " "if there are no regular users.\\fR" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "REFERENCES" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron msgid "" "Primary mkosi git repository on GitHub (https://github.com/systemd/mkosi/)" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable msgid "" "mkosi \\[em] A Tool for Generating OS Images (https://0pointer.net/blog/" "mkosi-a-tool-for-generating-os-images.html) introductory blog post by " "Lennart Poettering" msgstr "" #. type: Plain text #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron msgid "" "The mkosi OS generation tool (https://lwn.net/Articles/726655/) story on LWN" msgstr "" #. type: SH #: archlinux debian-bookworm debian-unstable fedora-40 mageia-cauldron #: opensuse-tumbleweed #, no-wrap msgid "SEE ALSO" msgstr "" #. type: Plain text #: archlinux opensuse-tumbleweed msgid "\\f[CR]systemd-nspawn(1)\\f[R], \\f[CR]dnf(8)\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] summary\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] build [command line\\&...]\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] shell [command line\\&...]\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] boot [nspawn settings\\&...]\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] qemu [qemu parameters\\&...]\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] vmspawn [vmspawn settings\\&...]\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] ssh [command line\\&...]\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] journalctl [command line\\&...]\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] coredumpctl [command line\\&...]\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] clean\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] serve\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] burn EdeviceE\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] bump\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] genkey\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] documentation\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]mkosi [options\\&...] help\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]mkosi\\f[R] is a tool for easily building customized OS images. " "It\\[cq]s a fancy wrapper around \\f[V]dnf --installroot\\f[R], " "\\f[V]apt\\f[R], \\f[V]pacman\\f[R] and \\f[V]zypper\\f[R] that may generate " "disk images with a number of bells and whistles.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]summary\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Outputs a human-readable summary of all options used for building an image. " "This will parse the command line and \\f[V]mkosi.conf\\f[R] file as it would " "do on \\f[V]build\\f[R], but only output what it is configured for and not " "actually build anything.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]build\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]shell\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "This builds the image if it is not built yet, and then invokes \\f[V]systemd-" "nspawn\\f[R] to acquire an interactive shell prompt in it. An optional " "command line may be specified after the \\f[V]shell\\f[R] verb, to be " "invoked in place of the shell in the container. Use \\f[V]-f\\f[R] in order " "to rebuild the image unconditionally before acquiring the shell, see below. " "This command must be executed as \\f[V]root\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]boot\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Similar to \\f[V]shell\\f[R], but boots the image using \\f[V]systemd-" "nspawn\\f[R]. An optional command line may be specified after the " "\\f[V]boot\\f[R] verb, which can contain extra nspawn options as well as " "arguments which are passed as the \\f[I]kernel command line\\f[R] to the " "init system in the image.\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]qemu\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Similar to \\f[V]boot\\f[R], but uses \\f[V]qemu\\f[R] to boot up the image, " "i.e.\\ instead of container virtualization virtual machine virtualization is " "used. This verb is only supported for disk images that contain a boot " "loader and cpio images in which a kernel was installed. For cpio images a " "kernel can also be provided by passing the \\f[V]-kernel\\f[R] qemu argument " "to the \\f[V]qemu\\f[R] verb. Any arguments specified after the " "\\f[V]qemu\\f[R] verb are appended to the \\f[V]qemu\\f[R] invocation.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]vmspawn\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Similar to \\f[V]boot\\f[R], but uses \\f[V]systemd-vmspawn\\f[R] to boot up " "the image, i.e. instead of container virtualization virtual machine " "virtualization is used. This verb is only supported for disk and directory " "type images. Any arguments specified after the \\f[V]vmspawn\\f[R] verb are " "appended to the \\f[V]systemd-vmspawn\\f[R] invocation.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ssh\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When the image is built with the \\f[V]Ssh=yes\\f[R] option, this command " "connects to a booted virtual machine (\\f[V]qemu\\f[R]) via SSH. Make sure " "to run \\f[V]mkosi ssh\\f[R] with the same config as \\f[V]mkosi build\\f[R] " "so that it has the necessary information available to connect to the running " "virtual machine via SSH. Specifically, the SSH private key from the " "\\f[V]SshKey=\\f[R] setting is used to connect to the virtual machine. Use " "\\f[V]mkosi genkey\\f[R] to automatically generate a key and certificate " "that will be picked up by mkosi. Any arguments passed after the " "\\f[V]ssh\\f[R] verb are passed as arguments to the \\f[V]ssh\\f[R] " "invocation. To connect to a container, use \\f[V]machinectl login\\f[R] or " "\\f[V]machinectl shell\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]journalctl\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Uses \\f[V]journalctl\\f[R] to inspect the journal inside the image. Any " "arguments specified after the \\f[V]journalctl\\f[R] verb are appended to " "the \\f[V]journalctl\\f[R] invocation.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]coredumpctl\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Uses \\f[V]coredumpctl\\f[R] to look for coredumps inside the image. Any " "arguments specified after the \\f[V]coredumpctl\\f[R] verb are appended to " "the \\f[V]coredumpctl\\f[R] invocation.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]clean\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Remove build artifacts generated on a previous build. If combined with " "\\f[V]-f\\f[R], also removes incremental build cache images. If \\f[V]-" "f\\f[R] is specified twice, also removes any package cache.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]serve\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "This builds the image if it is not built yet, and then serves the output " "directory (i.e.\\ usually \\f[V]mkosi.output/\\f[R], see below) via a small " "embedded HTTP server, listening on port 8081. Combine with \\f[V]-f\\f[R] " "in order to rebuild the image unconditionally before serving it. This " "command is useful for testing network based acquisition of OS images, for " "example via \\f[V]machinectl pull-raw \\&...\\f[R] and \\f[V]machinectl pull-" "tar \\&...\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]burn EdeviceE\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]bump\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Bumps the image version from \\f[V]mkosi.version\\f[R] and writes the " "resulting version string to \\f[V]mkosi.version\\f[R]. This is useful for " "implementing a simple versioning scheme: each time this verb is called the " "version is bumped in preparation for the subsequent build. Note that " "\\f[V]--auto-bump\\f[R]/\\f[V]-B\\f[R] may be used to automatically bump the " "version after each successful build.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]genkey\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Generate a pair of SecureBoot keys for usage with the " "\\f[V]SecureBootKey=\\f[R]/\\f[V]--secure-boot-key=\\f[R] and " "\\f[V]SecureBootCertificate=\\f[R]/\\f[V]--secure-boot-certificate=\\f[R] " "options.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]documentation\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Show mkosi\\[cq]s documentation. By default this verb will try several ways " "to output the documentation, but a specific option can be chosen with the " "\\f[V]--doc-format\\f[R] option. Distro packagers are encouraged to add a " "file \\f[V]mkosi.1\\f[R] into the \\f[V]mkosi/resources\\f[R] directory of " "the Python package, if it is missing, as well as to install it in the " "appropriate search path for man pages. The man page can be generated from " "the markdown file \\f[V]mkosi/resources/mkosi.md\\f[R] e.g via \\f[V]pandoc -" "t man -s -o mkosi.1 mkosi.md\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]help\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "This verb is equivalent to the \\f[V]--help\\f[R] switch documented below: " "it shows a brief usage explanation.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--force\\f[R], \\f[V]-f\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Replace the output file if it already exists, when building an image. By " "default when building an image and an output artifact already exists " "\\f[V]mkosi\\f[R] will refuse operation. Specify this option once to delete " "all build artifacts from a previous run before re-building the image. If " "incremental builds are enabled, specifying this option twice will ensure the " "intermediary cache files are removed, too, before the re-build is " "initiated. If a package cache is used (also see the \\f[B]Files\\f[R] " "section below), specifying this option thrice will ensure the package cache " "is removed too, before the re-build is initiated. For the \\f[V]clean\\f[R] " "operation this option has a slightly different effect: by default the verb " "will only remove build artifacts from a previous run, when specified once " "the incremental cache files are deleted too, and when specified twice the " "package cache is also removed.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--directory=\\f[R], \\f[V]-C\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a path to a directory. \\f[V]mkosi\\f[R] switches to this directory " "before doing anything. Note that the various configuration files are " "searched for in this directory, hence using this option is an effective way " "to build a project located in a specific directory.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--debug=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--debug-shell\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--debug-workspace=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--version\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--help\\f[R], \\f[V]-h\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--genkey-common-name=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Common name to be used when generating keys via mkosi\\[cq]s " "\\f[V]genkey\\f[R] command. Defaults to \\f[V]mkosi of %u\\f[R], where " "\\f[V]%u\\f[R] expands to the username of the user invoking mkosi.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--genkey-valid-days=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Number of days that the keys should remain valid when generating keys via " "mkosi\\[cq]s \\f[V]genkey\\f[R] command. Defaults to two years (730 days)." "\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--auto-bump=\\f[R], \\f[V]-B\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If specified, after each successful build the the version is bumped in a " "fashion equivalent to the \\f[V]bump\\f[R] verb, in preparation for the next " "build. This is useful for simple, linear version management: each build in " "a series will have a version number one higher then the previous one.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--doc-format\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The format to show the documentation in. Supports the values " "\\f[V]markdown\\f[R], \\f[V]man\\f[R], \\f[V]pandoc\\f[R], " "\\f[V]system\\f[R] and \\f[V]auto\\f[R]. In the case of " "\\f[V]markdown\\f[R] the documentation is shown in the original Markdown " "format. \\f[V]man\\f[R] shows the documentation in man page format, if it " "is available. \\f[V]pandoc\\f[R] will generate the man page format on the " "fly, if \\f[V]pandoc\\f[R] is available. \\f[V]system\\f[R] will show the " "system-wide man page for mkosi, which may or may not correspond to the " "version you are using, depending on how you installed mkosi. " "\\f[V]auto\\f[R], which is the default, will try all methods in the order " "\\f[V]man\\f[R], \\f[V]pandoc\\f[R], \\f[V]markdown\\f[R], " "\\f[V]system\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]--json\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When a \\f[I]GPT\\f[R] disk image is created, repart partition definition " "files may be placed in \\f[V]mkosi.repart/\\f[R] to configure the generated " "disk image.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "It is highly recommended to run \\f[V]mkosi\\f[R] on a file system that " "supports reflinks such as XFS and btrfs and to keep all related directories " "on the same file system. This allows mkosi to create images very quickly by " "using reflinks to perform copying via copy-on-write operations.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The following settings can be set through configuration files (the syntax " "with \\f[V]SomeSetting=value\\f[R]) and on the command line (the syntax with " "\\f[V]--some-setting=value\\f[R]). For some command line parameters, a " "single-letter shortcut is also allowed. In the configuration files, the " "setting must be in the appropriate section, so the settings are grouped by " "section below.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]mkosi.local.conf\\f[R] is parsed if it exists. This file should be in " "the gitignore (or equivalent) and is intended for local configuration.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]mkosi.conf\\f[R] is parsed if it exists in the directory configured " "with \\f[V]--directory=\\f[R] or the current working directory if \\f[V]--" "directory=\\f[R] is not used.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]mkosi.conf.d/\\f[R] is parsed in the same directory if it exists. " "Each directory and each file with the \\f[V].conf\\f[R] extension in " "\\f[V]mkosi.conf.d/\\f[R] is parsed. Any directory in \\f[V]mkosi.conf." "d\\f[R] is parsed as if it were a regular top level directory.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If a setting\\[cq]s name in the configuration file is prefixed with " "\\f[V]\\[at]\\f[R], it configures the default value used for that setting if " "no explicit default value is set. This can be used to set custom default " "values in configuration files that can still be overridden by specifying the " "setting explicitly via the CLI.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "To conditionally include configuration files, the \\f[V][Match]\\f[R] " "section can be used. A \\f[V][Match]\\f[R] section consists of invididual " "conditions. Conditions can use a pipe symbol (\\f[V]|\\f[R]) after the " "equals sign (\\f[V]\\&...=|\\&...\\f[R]), which causes the condition to " "become a triggering condition. The config file will be included if the " "logical AND of all non-triggering conditions and the logical OR of all " "triggering conditions is satisfied. To negate the result of a condition, " "prefix the argument with an exclamation mark. If an argument is prefixed " "with the pipe symbol and an exclamation mark, the pipe symbol must be passed " "first, and the exclamation second.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Note that \\f[V][Match]\\f[R] conditions compare against the current values " "of specific settings, and do not take into account changes made to the " "setting in configuration files that have not been parsed yet. Also note " "that matching against a setting and then changing its value afterwards in a " "different config file may lead to unexpected results.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[V][Match]\\f[R] section of a \\f[V]mkosi.conf\\f[R] file in a " "directory applies to the entire directory. If the conditions are not " "satisfied, the entire directory is skipped. The \\f[V][Match]\\f[R] " "sections of files in \\f[V]mkosi.conf.d/\\f[R] and \\f[V]mkosi.local." "conf\\f[R] only apply to the file itself.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If there are multiple \\f[V][Match]\\f[R] sections in the same configuration " "file, each of them has to be satisfied in order for the configuration file " "to be included. Specifically, triggering conditions only apply to the " "current \\f[V][Match]\\f[R] section and are reset between multiple \\f[V]" "[Match]\\f[R] sections. As an example, the following will only match if the " "output format is one of \\f[V]disk\\f[R] or \\f[V]directory\\f[R] and the " "architecture is one of \\f[V]x86-64\\f[R] or \\f[V]arm64\\f[R]:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "[Match]\n" "Format=|disk\n" "Format=|directory\\fR\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C][Match]\n" "Architecture=|x86-64\n" "Architecture=|arm64\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[V][TriggerMatch]\\f[R] section can be used to indicate triggering " "match sections. These are identical to triggering conditions except they " "apply to the entire match section instead of just a single condition. As an " "example, the following will match if the distribution is \\f[V]debian\\f[R] " "and the release is \\f[V]bookworm\\f[R] or if the distribution is " "\\f[V]ubuntu\\f[R] and the release is \\f[V]focal\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "[TriggerMatch]\n" "Distribution=debian\n" "Release=bookworm\\fR\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C][TriggerMatch]\n" "Distribution=ubuntu\n" "Release=focal\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The semantics of conditions in \\f[V][TriggerMatch]\\f[R] sections is the " "same as in \\f[V][Match]\\f[R], i.e.\\ all normal conditions are joined by a " "logical AND and all triggering conditions are joined by a logical OR. When " "mixing \\f[V][Match]\\f[R] and \\f[V][TriggerMatch]\\f[R] sections, a match " "is achieved when all \\f[V][Match]\\f[R] sections match and at least one " "\\f[V][TriggerMatch]\\f[R] section matches. No match sections are valued as " "true. Logically this means:\\fR" msgstr "" #. type: Plain text #: debian-bookworm #, no-wrap msgid "" "\\f[C]\n" "(\\[u22C0]\\[u1D62] Match\\[u1D62]) \\[AN] (\\[u22C1]\\[u1D62] TriggerMatch\\[u1D62])\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Command line options that take no argument are shown without \\f[V]=\\f[R] " "in their long version. In the config files, they should be specified with a " "boolean argument: either \\f[V]1\\f[R], \\f[V]yes\\f[R], or \\f[V]true\\f[R] " "to enable, or \\f[V]0\\f[R], \\f[V]no\\f[R], \\f[V]false\\f[R] to disable." "\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Profile=\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Distribution=\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Release=\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Architecture=\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]PathExists=\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ImageId=\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ImageVersion=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Matches against the configured image version. Image versions can be " "prepended by the operators \\f[V]==\\f[R], \\f[V]!=\\f[R], " "\\f[V]E=\\f[R], \\f[V]E=\\f[R], \\f[V]E\\f[R], \\f[V]E\\f[R] " "for rich version comparisons according to the UAPI group version format " "specification. If no operator is prepended, the equality operator is " "assumed by default. If this condition is used and no image version has been " "explicitly configured yet, this condition fails.\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Bootable=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Matches against the configured value for the \\f[V]Bootable=\\f[R] feature. " "Takes a boolean value or \\f[V]auto\\f[R].\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Format=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Matches against the configured value for the \\f[V]Format=\\f[R] option. " "Takes an output format (see the \\f[V]Format=\\f[R] option).\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SystemdVersion=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Matches against the systemd version on the host (as reported by " "\\f[V]systemctl --version\\f[R]). Values can be prepended by the operators " "\\f[V]==\\f[R], \\f[V]!=\\f[R], \\f[V]E=\\f[R], \\f[V]E=\\f[R], " "\\f[V]E\\f[R], \\f[V]E\\f[R] for rich version comparisons according " "to the UAPI group version format specification. If no operator is " "prepended, the equality operator is assumed by default.\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]BuildSources=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a build source target path (see \\f[V]BuildSources=\\f[R]). This " "match is satisfied if any of the configured build sources uses this target " "path. For example, if we have a \\f[V]mkosi.conf\\f[R] file containing:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "[Content]\n" "BuildSources=../abc/qed:kernel\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "[Match]\n" "BuildSources=kernel\\fR\n" "\n" msgstr "" #. type: TP #: debian-bookworm debian-unstable opensuse-tumbleweed #, no-wrap msgid "\\f[R]The drop-in will be included.\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]HostArchitecture=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Matches against the host\\[cq]s native architecture. See the " "\\f[V]Architecture=\\f[R] setting for a list of possible values.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Profile=\\f[R], \\f[V]--profile=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Select the given profile. A profile is a configuration file or directory in " "the \\f[V]mkosi.profiles/\\f[R] directory. When selected, this " "configuration file or directory is included after parsing the \\f[V]mkosi." "conf\\f[R] file, but before any \\f[V]mkosi.conf.d/*.conf\\f[R] drop in " "configuration.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Include=\\f[R], \\f[V]--include=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Include extra configuration from the given file or directory. The extra " "configuration is included immediately after parsing the setting, except when " "a default is set using \\f[V]\\[at]Include=\\f[R], in which case the " "configuration is included after parsing all the other configuration files. " "Note that each path containing extra configuration is only parsed once, even " "if included more than once with \\f[V]Include=\\f[R]. The builtin configs " "for the mkosi default initrd and default tools tree can be included by " "including the literal value \\f[V]mkosi-initrd\\f[R] and \\f[V]mkosi-" "tools\\f[R] respectively. Note: Include names starting with either of the " "literals \\f[V]mkosi-\\f[R] or \\f[V]contrib-\\f[R] are reserved for use by " "mkosi itself.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]InitrdInclude=\\f[R], \\f[V]--initrd-include=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Same as \\f[V]Include=\\f[R], but the extra configuration files or " "directories are included when building the default initrd.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Images=\\f[R], \\f[V]--image=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Dependencies=\\f[R], \\f[V]--dependency=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The images that this image depends on specified as a comma-separated list. " "All images configured in this option will be built before this image and " "will be pulled in as dependencies of this image when \\f[V]Images=\\f[R] is " "used.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]MinimumVersion=\\f[R], \\f[V]--minimum-version=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Distribution=\\f[R], \\f[V]--distribution=\\f[R], \\f[V]-d\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The distribution to install in the image. Takes one of the following " "arguments: \\f[V]fedora\\f[R], \\f[V]debian\\f[R], \\f[V]ubuntu\\f[R], " "\\f[V]arch\\f[R], \\f[V]opensuse\\f[R], \\f[V]mageia\\f[R], " "\\f[V]centos\\f[R], \\f[V]rhel\\f[R], \\f[V]rhel-ubi\\f[R], " "\\f[V]openmandriva\\f[R], \\f[V]rocky\\f[R], \\f[V]alma\\f[R], " "\\f[V]custom\\f[R]. If not specified, defaults to the distribution of the " "host or \\f[V]custom\\f[R] if the distribution of the host is not a " "supported distribution.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Release=\\f[R], \\f[V]--release=\\f[R], \\f[V]-r\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The release of the distribution to install in the image. The precise syntax " "of the argument this takes depends on the distribution used, and is either a " "numeric string (in case of Fedora Linux, CentOS, \\&..., e.g.\\ " "\\f[V]29\\f[R]), or a distribution version name (in case of Debian, Ubuntu, " "\\&..., e.g.\\ \\f[V]artful\\f[R]). Defaults to a recent version of the " "chosen distribution, or the version of the distribution running on the host " "if it matches the configured distribution.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Architecture=\\f[R], \\f[V]--architecture=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The architecture to build the image for. The architectures that are " "actually supported depends on the distribution used and whether a bootable " "image is requested or not. When building for a foreign architecture, " "you\\[cq]ll also need to install and register a user mode emulator for that " "architecture. One of the following architectures can be specified per image " "built: \\f[V]alpha\\f[R], \\f[V]arc\\f[R], \\f[V]arm\\f[R], " "\\f[V]arm64\\f[R], \\f[V]ia64\\f[R], \\f[V]loongarch64\\f[R], \\f[V]mips64-" "le\\f[R], \\f[V]mips-le\\f[R], \\f[V]parisc\\f[R], \\f[V]ppc\\f[R], " "\\f[V]ppc64\\f[R], \\f[V]ppc64-le\\f[R], \\f[V]riscv32\\f[R], " "\\f[V]riscv64\\f[R], \\f[V]s390\\f[R], \\f[V]s390x\\f[R], " "\\f[V]tilegx\\f[R], \\f[V]x86\\f[R], \\f[V]x86-64\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Mirror=\\f[R], \\f[V]--mirror=\\f[R], \\f[V]-m\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]debian\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]arch\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]opensuse\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ubuntu\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]centos\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]rocky\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]alma\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]fedora\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]rhel-ubi\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]mageia\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]openmandriva\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]LocalMirror=\\f[R], \\f[V]--local-mirror=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The mirror will be used as a local, plain and direct mirror instead of using " "it as a prefix for the full set of repositories normally supported by " "distributions. Useful for fully offline builds with a single repository. " "Supported on deb/rpm/arch based distributions. Overrides \\f[V]--" "mirror=\\f[R] but only for the local mkosi build, it will not be configured " "inside the final image, \\f[V]--mirror=\\f[R] (or the default repository) " "will be configured inside the final image instead.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RepositoryKeyCheck=\\f[R], \\f[V]--repository-key-check=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Controls signature/key checks when using repositories, enabled by default. " "Useful to disable checks when combined with \\f[V]--local-mirror=\\f[R] and " "using only a repository from a local filesystem. Not used for DNF-based " "distros yet.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Repositories=\\f[R], \\f[V]--repositories=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CacheOnly=\\f[R], \\f[V]--cache-only=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes one of \\f[V]none\\f[R], \\f[V]metadata\\f[R] or \\f[V]always\\f[R]. " "If \\f[V]always\\f[R], the package manager is instructed not to contact the " "network. This provides a minimal level of reproducibility, as long as the " "package cache is already fully populated. If set to \\f[V]metadata\\f[R], " "the package manager can still download packages, but we won\\[cq]t sync the " "repository metadata. If set to \\f[V]none\\f[R], the repository metadata is " "synced and packages can be downloaded during the build.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]PackageManagerTrees=\\f[R], \\f[V]--package-manager-tree=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "This option mirrors the above \\f[V]SkeletonTrees=\\f[R] option and defaults " "to the same value if not configured otherwise, but installs the files to a " "subdirectory of the workspace directory instead of the OS tree. This " "subdirectory of the workspace is used to configure the package manager. " "\\f[V]mkosi\\f[R] will look for the package manager configuration and " "related files in the configured package manager trees. Unless specified " "otherwise, it will use the configuration files from their canonical " "locations in \\f[V]/usr\\f[R] or \\f[V]/etc\\f[R] in the package manager " "trees. For example, it will look for \\f[V]etc/dnf/dnf.conf\\f[R] in the " "package manager trees if \\f[V]dnf\\f[R] is used to install packages. " "\\f[V]SkeletonTrees=\\f[R] and \\f[V]PackageManagerTrees=\\f[R] fulfill " "similar roles. Use \\f[V]SkeletonTrees=\\f[R] if you want the files to be " "present in the final image. Use \\f[V]PackageManagerTrees=\\f[R] if you " "don\\[cq]t want the files to be present in the final image, e.g.\\ when " "building an initrd or if you want to refer to paths outside of the image in " "your repository configuration.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Format=\\f[R], \\f[V]--format=\\f[R], \\f[V]-t\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The image format type to generate. One of \\f[V]directory\\f[R] (for " "generating an OS image directly in a local directory), \\f[V]tar\\f[R] " "(similar, but a tarball of the OS image is generated), \\f[V]cpio\\f[R] " "(similar, but a cpio archive is generated), \\f[V]disk\\f[R] (a block device " "OS image with a GPT partition table), \\f[V]uki\\f[R] (a unified kernel " "image with the OS image in the \\f[V].initrd\\f[R] PE section), " "\\f[V]esp\\f[R] (\\f[V]uki\\f[R] but wrapped in a disk image with only an " "ESP partition), \\f[V]sysext\\f[R], \\f[V]confext\\f[R], " "\\f[V]portable\\f[R] or \\f[V]none\\f[R] (the OS image is solely intended as " "a build image to produce another artifact). If the \\f[V]disk\\f[R] output " "format is used, the disk image is generated using \\f[V]systemd-" "repart\\f[R]. The repart partition definition files to use can be " "configured using the \\f[V]RepartDirectories=\\f[R] setting or via " "\\f[V]mkosi.repart/\\f[R]. When verity partitions are configured using " "systemd-repart\\[cq]s \\f[V]Verity=\\f[R] setting, mkosi will automatically " "parse the verity hash partition\\[cq]s roothash from systemd-repart\\[cq]s " "JSON output and include it in the kernel command line of every unified " "kernel image built by mkosi.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ManifestFormat=\\f[R], \\f[V]--manifest-format=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The manifest format type or types to generate. A comma-delimited list " "consisting of \\f[V]json\\f[R] (the standard JSON output format that " "describes the packages installed), \\f[V]changelog\\f[R] (a human-readable " "text format designed for diffing). By default no manifest is generated.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Output=\\f[R], \\f[V]--output=\\f[R], \\f[V]-o\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Name to use for the generated output image file or directory. All outputs " "will be prefixed with the given name. Defaults to \\f[V]image\\f[R] or, if " "\\f[V]ImageId=\\f[R] is specified, it is used as the default output name, " "optionally suffixed with the version set with \\f[V]ImageVersion=\\f[R]. " "Note that this option does not allow configuring the output directory, use " "\\f[V]OutputDirectory=\\f[R] for that. Note that this only specifies the " "output prefix, depending on the specific output format, compression and " "image version used, the full output name might be \\f[V]image_7.8.raw." "xz\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CompressOutput=\\f[R], \\f[V]--compress-output=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Configure compression for the resulting image or archive. The argument can " "be either a boolean or a compression algorithm (\\f[V]xz\\f[R], " "\\f[V]zstd\\f[R]). \\f[V]zstd\\f[R] compression is used by default, except " "CentOS and derivatives up to version 8, which default to \\f[V]xz\\f[R]. " "Note that when applied to block device image types, compression means the " "image cannot be started directly but needs to be decompressed first. This " "also means that the \\f[V]shell\\f[R], \\f[V]boot\\f[R], \\f[V]qemu\\f[R] " "verbs are not available when this option is used. Implied for " "\\f[V]tar\\f[R], \\f[V]cpio\\f[R], \\f[V]uki\\f[R], and \\f[V]esp\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CompressLevel=\\f[R], \\f[V]--compress-level=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]OutputDirectory=\\f[R], \\f[V]--output-dir=\\f[R], \\f[V]-O\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Path to a directory where to place all generated artifacts. If this is not " "specified and the directory \\f[V]mkosi.output/\\f[R] exists in the local " "directory, it is automatically used for this purpose.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]WorkspaceDirectory=\\f[R], \\f[V]--workspace-dir=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Path to a directory where to store data required temporarily while building " "the image. This directory should have enough space to store the full OS " "image, though in most modes the actually used disk space is smaller. If not " "specified, a subdirectory of \\f[V]$XDG_CACHE_HOME\\f[R] (if set), " "\\f[V]$HOME/.cache\\f[R] (if set) or \\f[V]/var/tmp\\f[R] is used. The data " "in this directory is removed automatically after each build. It\\[cq]s safe " "to manually remove the contents of this directory should an " "\\f[V]mkosi\\f[R] invocation be aborted abnormally (for example, due to " "reboot/power failure).\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CacheDirectory=\\f[R], \\f[V]--cache-dir=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a path to a directory to use as the incremental cache directory for " "the incremental images produced when the \\f[V]Incremental=\\f[R] option is " "enabled. If this option is not used, but a \\f[V]mkosi.cache/\\f[R] " "directory is found in the local directory it is automatically used for this " "purpose.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]PackageCacheDirectory=\\f[R], \\f[V]--package-cache-dir\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]BuildDirectory=\\f[R], \\f[V]--build-dir=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a path to a directory to use as the build directory for build systems " "that support out-of-tree builds (such as Meson). The directory used this " "way is shared between repeated builds, and allows the build system to reuse " "artifacts (such as object files, executable, \\&...) generated on previous " "invocations. The build scripts can find the path to this directory in the " "\\f[V]$BUILDDIR\\f[R] environment variable. This directory is mounted into " "the image\\[cq]s root directory when \\f[V]mkosi-chroot\\f[R] is invoked " "during execution of the build scripts. If this option is not specified, but " "a directory \\f[V]mkosi.builddir/\\f[R] exists in the local directory it is " "automatically used for this purpose (also see the \\f[B]Files\\f[R] section " "below).\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ImageVersion=\\f[R], \\f[V]--image-version=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Configure the image version. This accepts any string, but it is recommended " "to specify a series of dot separated components. The version may also be " "configured in a file \\f[V]mkosi.version\\f[R] in which case it may be " "conveniently managed via the \\f[V]bump\\f[R] verb or the \\f[V]--auto-" "bump\\f[R] option. When specified the image version is included in the " "default output file name, i.e.\\ instead of \\f[V]image.raw\\f[R] the " "default will be \\f[V]image_0.1.raw\\f[R] for version \\f[V]0.1\\f[R] of the " "image, and similar. The version is also passed via the " "\\f[V]$IMAGE_VERSION\\f[R] to any build scripts invoked (which may be useful " "to patch it into \\f[V]/etc/os-release\\f[R] or similar, in particular the " "\\f[V]IMAGE_VERSION=\\f[R] field of it).\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ImageId=\\f[R], \\f[V]--image-id=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Configure the image identifier. This accepts a freeform string that shall " "be used to identify the image with. If set the default output file will be " "named after it (possibly suffixed with the version). The identifier is also " "passed via the \\f[V]$IMAGE_ID\\f[R] to any build scripts invoked. The " "image ID is automatically added to \\f[V]/usr/lib/os-release\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SplitArtifacts=\\f[R], \\f[V]--split-artifacts\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If specified and building a disk image, pass \\f[V]--split=yes\\f[R] to " "systemd-repart to have it write out split partition files for each " "configured partition. Read the man (https://www.freedesktop.org/software/" "systemd/man/systemd-repart.html#--split=BOOL) page for more information. " "This is useful in A/B update scenarios where an existing disk image shall be " "augmented with a new version of a root or \\f[V]/usr\\f[R] partition along " "with its Verity partition and unified kernel.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RepartDirectories=\\f[R], \\f[V]--repart-dir=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Paths to directories containing systemd-repart partition definition files " "that are used when mkosi invokes systemd-repart when building a disk image. " "If \\f[V]mkosi.repart/\\f[R] exists in the local directory, it will be used " "for this purpose as well. Note that mkosi invokes repart with \\f[V]--" "root=\\f[R] set to the root of the image root, so any \\f[V]CopyFiles=\\f[R] " "source paths in partition definition files will be relative to the image " "root directory.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SectorSize=\\f[R], \\f[V]--sector-size=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RepartOffline=\\f[R], \\f[V]--repart-offline=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Specifies whether to build disk images using loopback devices. Enabled by " "default. When enabled, \\f[V]systemd-repart\\f[R] will not use loopback " "devices to build disk images. When disabled, \\f[V]systemd-repart\\f[R] " "will always use loopback devices to build disk images. Note that when using " "\\f[V]RepartOffline=no\\f[R] mkosi cannot run unprivileged and the image " "build has to be done as the root user outside of any containers and with " "loopback devices available on the host system. There are currently two " "known scenarios where \\f[V]RepartOffline=no\\f[R] has to be used. The " "first is when using \\f[V]Subvolumes=\\f[R] in a repart partition definition " "file, as subvolumes cannot be created without using loopback devices. The " "second is when creating a system with SELinux and an XFS root partition. " "Because \\f[V]mkfs.xfs\\f[R] does not support populating an XFS filesystem " "with extended attributes, loopback devices have to be used to ensure the " "SELinux extended attributes end up in the generated XFS filesystem.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Overlay=\\f[R], \\f[V]--overlay\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used together with \\f[V]BaseTrees=\\f[R], the output will consist only " "out of changes to the specified base trees. Each base tree is attached as a " "lower layer in an overlayfs structure, and the output becomes the upper " "layer, initially empty. Thus files that are not modified compared to the " "base trees will not be present in the final output. This option may be used " "to create systemd \\f[I]system extensions\\f[R] or \\f[I]portable " "services\\f[R] (https://uapi-group.org/specifications/specs/extension_image)." "\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]UseSubvolumes=\\f[R], \\f[V]--use-subvolumes=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a boolean or \\f[V]auto\\f[R]. Enables or disables use of btrfs " "subvolumes for directory tree outputs. If enabled, mkosi will create the " "root directory as a btrfs subvolume and use btrfs subvolume snapshots where " "possible to copy base or cached trees which is much faster than doing a " "recursive copy. If explicitly enabled and \\f[V]btrfs\\f[R] is not " "installed or subvolumes cannot be created, an error is raised. If " "\\f[V]auto\\f[R], missing \\f[V]btrfs\\f[R] or failures to create subvolumes " "are ignored.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Seed=\\f[R], \\f[V]--seed=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a UUID as argument or the special value \\f[V]random\\f[R]. Overrides " "the seed that \\f[V]systemd-repart(8)\\f[R] (https://www.freedesktop.org/" "software/systemd/man/systemd-repart.service.html) uses when building a disk " "image. This is useful to achieve reproducible builds, where deterministic " "UUIDs and other partition metadata should be derived on each build.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SourceDateEpoch=\\f[R], \\f[V]--source-date-epoch=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a timestamp as argument. Resets file modification times of all files " "to this timestamp. The variable is also propagated to systemd-repart and " "scripts executed by mkosi. If not set explicitly, " "\\f[V]SOURCE_DATE_EPOCH\\f[R] from \\f[V]--environment\\f[R] and from the " "host environment are tried in that order. This is useful to make builds " "reproducible. See SOURCE_DATE_EPOCH (https://reproducible-builds.org/specs/" "source-date-epoch/) for more information.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Packages=\\f[R], \\f[V]--package=\\f[R], \\f[V]-p\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Install the specified distribution packages (i.e.\\ RPM, DEB, \\&...) in " "the image. Takes a comma separated list of package specifications. This " "option may be used multiple times in which case the specified package lists " "are combined. Use \\f[V]BuildPackages=\\f[R] to specify packages that shall " "only be installed in an overlay that is mounted when the prepare scripts are " "executed with the \\f[V]build\\f[R] argument and when the build scripts are " "executed. The types and syntax of \\f[I]package specifications\\f[R] that " "are allowed depend on the package installer (e.g.\\ \\f[V]dnf\\f[R] for " "\\f[V]rpm\\f[R]-based distros or \\f[V]apt\\f[R] for \\f[V]deb\\f[R]-based " "distros), but may include package names, package names with version and/or " "architecture, package name globs, paths to packages in the file system, " "package groups, and virtual provides, including file paths. Example: when " "using a distro that uses \\f[V]dnf\\f[R], the following configuration would " "install the \\f[V]meson\\f[R] package (in the latest version), the 32-bit " "version of the \\f[V]libfdisk-devel\\f[R] package, all available packages " "that start with the \\f[V]git-\\f[R] prefix, a \\f[V]systemd\\f[R] rpm from " "the local file system, one of the packages that provides \\f[V]/usr/bin/" "ld\\f[R], the packages in the \\f[I]Development Tools\\f[R] group, and the " "package that contains the \\f[V]mypy\\f[R] python module.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "Packages=meson\n" " libfdisk-devel.i686\n" " git-*\n" " prebuilt/rpms/systemd-249-rc1.local.rpm\n" " /usr/bin/ld\n" " \\[at]development-tools\n" " python3dist(mypy)\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" ": Note that since mkosi runs in a sandbox with most of the host files " "unavailable, any local packages have to be mounted into the sandbox " "explicitly using \\f[V]BuildSources=\\f[R]. For example, let\\[cq]s say we " "have a local package located at \\f[V]../my-packages/abc.rpm\\f[R] relative " "to the mkosi working directory, then we\\[cq]d be able to install it as " "follows:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "BuildSources=../my-packages:my-packages-in-sandbox\n" "Packages=my-packages-in-sandbox/abc.rpm\\fR\n" "\n" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]BuildPackages=\\f[R], \\f[V]--build-package=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Similar to \\f[V]Packages=\\f[R], but configures packages to install only in " "an overlay that is made available on top of the image to the prepare scripts " "when executed with the \\f[V]build\\f[R] argument and the build scripts. " "This option should be used to list packages containing header files, " "compilers, build systems, linkers and other build tools the \\f[V]mkosi." "build\\f[R] scripts require to operate. Note that packages listed here will " "be absent in the final image.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]PackageDirectories=\\f[R], \\f[V]--package-directory=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Specify directories containing extra packages to be made available during " "the build. \\f[V]mkosi\\f[R] will create a local repository containing all " "packages in these directories and make it available when installing packages " "or running scripts. Note that this local repository is also made available " "when running scripts. Build scripts can add more packages to the local " "repository by placing the built packages in \\f[V]$PACKAGEDIR\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]WithRecommends=\\f[R], \\f[V]--with-recommends=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]WithDocs=\\f[R], \\f[V]--with-docs\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Include documentation in the image. Enabled by default. When disabled, if " "the underlying distribution package manager supports it documentation is not " "included in the image. The \\f[V]$WITH_DOCS\\f[R] environment variable " "passed to the \\f[V]mkosi.build\\f[R] scripts is set to \\f[V]0\\f[R] or " "\\f[V]1\\f[R] depending on whether this option is enabled or disabled.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]BaseTrees=\\f[R], \\f[V]--base-tree=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a comma separated list of paths to use as base trees. When used, " "these base trees are each copied into the OS tree and form the base " "distribution instead of installing the distribution from scratch. Only " "extra packages are installed on top of the ones already installed in the " "base trees. Note that for this to work properly, the base image still needs " "to contain the package manager metadata by setting " "\\f[V]CleanPackageMetadata=no\\f[R] (see " "\\f[V]CleanPackageMetadata=\\f[R]). Instead of a directory, a tar file or a " "disk image may be provided. In this case it is unpacked into the OS tree. " "This mode of operation allows setting permissions and file ownership " "explicitly, in particular for projects stored in a version control system " "such as \\f[V]git\\f[R] which retain full file ownership and access mode " "metadata for committed files.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SkeletonTrees=\\f[R], \\f[V]--skeleton-tree=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a comma separated list of colon separated path pairs. The first path " "of each pair refers to a directory to copy into the OS tree before invoking " "the package manager. The second path of each pair refers to the target " "directory inside the image. If the second path is not provided, the " "directory is copied on top of the root directory of the image. The second " "path is always interpreted as an absolute path. Use this to insert files " "and directories into the OS tree before the package manager installs any " "packages. If the \\f[V]mkosi.skeleton/\\f[R] directory is found in the " "local directory it is also used for this purpose with the root directory as " "target (also see the \\f[B]Files\\f[R] section below). Note that skeleton " "trees are cached and any changes to skeleton trees after a cached image has " "been built (when using \\f[V]Incremental=\\f[R]) are only applied when the " "cached image is rebuilt (by using \\f[V]-ff\\f[R] or running \\f[V]mkosi -f " "clean\\f[R]). As with the base tree logic above, instead of a directory, a " "tar file may be provided too. \\f[V]mkosi.skeleton.tar\\f[R] will be " "automatically used if found in the local directory.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ExtraTrees=\\f[R], \\f[V]--extra-tree=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a comma separated list of colon separated path pairs. The first path " "of each pair refers to a directory to copy from the host into the image. " "The second path of each pair refers to the target directory inside the " "image. If the second path is not provided, the directory is copied on top " "of the root directory of the image. The second path is always interpreted " "as an absolute path. Use this to override any default configuration files " "shipped with the distribution. If the \\f[V]mkosi.extra/\\f[R] directory is " "found in the local directory it is also used for this purpose with the root " "directory as target. (also see the \\f[B]Files\\f[R] section below). As " "with the base tree logic above, instead of a directory, a tar file may be " "provided too. \\f[V]mkosi.extra.tar\\f[R] will be automatically used if " "found in the local directory.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RemovePackages=\\f[R], \\f[V]--remove-package=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a comma-separated list of package specifications for removal, in the " "same format as \\f[V]Packages=\\f[R]. The removal will be performed as one " "of the last steps. This step is skipped if " "\\f[V]CleanPackageMetadata=no\\f[R] is used.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RemoveFiles=\\f[R], \\f[V]--remove-files=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CleanPackageMetadata=\\f[R], \\f[V]--clean-package-metadata=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Enable/disable removal of package manager databases and repository metadata " "at the end of installation. Can be specified as \\f[V]true\\f[R], " "\\f[V]false\\f[R], or \\f[V]auto\\f[R] (the default). With " "\\f[V]auto\\f[R], package manager databases and repository metadata will be " "removed if the respective package manager executable is \\f[I]not\\f[R] " "present at the end of the installation.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SyncScripts=\\f[R], \\f[V]--sync-script=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]PrepareScripts=\\f[R], \\f[V]--prepare-script=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]BuildScripts=\\f[R], \\f[V]--build-script=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]PostInstallationScripts=\\f[R], \\f[V]--postinst-script=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]FinalizeScripts=\\f[R], \\f[V]--finalize-script=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]BuildSources=\\f[R], \\f[V]--build-sources=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a comma separated list of colon separated path pairs. The first path " "of each pair refers to a directory to mount from the host. The second path " "of each pair refers to the directory where the source directory should be " "mounted when running scripts. Every target path is prefixed with \\f[V]/" "work/src\\f[R] and all build sources are sorted lexicographically by their " "target before mounting, so that top level paths are mounted first. If not " "configured explicitly, the current working directory is mounted to \\f[V]/" "work/src\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]BuildSourcesEphemeral=\\f[R], \\f[V]--build-sources-ephemeral=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a boolean. Disabled by default. Configures whether changes to source " "directories (The working directory and configured using " "\\f[V]BuildSources=\\f[R]) are persisted. If enabled, all source " "directories will be reset to their original state after scripts (except sync " "scripts) finish executing.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Environment=\\f[R], \\f[V]--environment=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Adds variables to the environment that package managers and the prepare/" "build/postinstall/finalize scripts are executed with. Takes a space-" "separated list of variable assignments or just variable names. In the " "latter case, the values of those variables will be passed through from the " "environment in which \\f[V]mkosi\\f[R] was invoked. This option may be " "specified more than once, in which case all listed variables will be set. " "If the same variable is set twice, the later setting overrides the earlier " "one.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]EnvironmentFiles=\\f[R], \\f[V]--env-file=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a comma-separated list of paths to files that contain environment " "variable definitions to be added to the scripting environment. Uses " "\\f[V]mkosi.env\\f[R] if it is found in the local directory. The variables " "are first read from \\f[V]mkosi.env\\f[R] if it exists, then from the given " "list of files and then from the \\f[V]Environment=\\f[R] settings.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]WithTests=\\f[R], \\f[V]--without-tests\\f[R], \\f[V]-T\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If set to false (or when the command-line option is used), the " "\\f[V]$WITH_TESTS\\f[R] environment variable is set to \\f[V]0\\f[R] when " "the \\f[V]mkosi.build\\f[R] scripts are invoked. This is supposed to be " "used by the build scripts to bypass any unit or integration tests that are " "normally run during the source build process. Note that this option has no " "effect unless the \\f[V]mkosi.build\\f[R] build scripts honor it.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]WithNetwork=\\f[R], \\f[V]--with-network=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When true, enables network connectivity while the build scripts \\f[V]mkosi." "build\\f[R] are invoked. By default, the build scripts run with networking " "turned off. The \\f[V]$WITH_NETWORK\\f[R] environment variable is passed to " "the \\f[V]mkosi.build\\f[R] build scripts indicating whether the build is " "done with or without network.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Bootable=\\f[R], \\f[V]--bootable=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a boolean or \\f[V]auto\\f[R]. Enables or disables generation of a " "bootable image. If enabled, mkosi will install an EFI bootloader, and add " "an ESP partition when the disk image output is used. If the selected EFI " "bootloader (See \\f[V]Bootloader=\\f[R]) is not installed or no kernel " "images can be found, the build will fail. \\f[V]auto\\f[R] behaves as if " "the option was enabled, but the build won\\[cq]t fail if either no kernel " "images or the selected EFI bootloader can\\[cq]t be found. If disabled, no " "bootloader will be installed even if found inside the image, no unified " "kernel images will be generated and no ESP partition will be added to the " "image if the disk output format is used.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Bootloader=\\f[R], \\f[V]--bootloader=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes one of \\f[V]none\\f[R], \\f[V]systemd-boot\\f[R], \\f[V]uki\\f[R] or " "\\f[V]grub\\f[R]. Defaults to \\f[V]systemd-boot\\f[R]. If set to " "\\f[V]none\\f[R], no EFI bootloader will be installed into the image. If " "set to \\f[V]systemd-boot\\f[R], systemd-boot will be installed and for each " "installed kernel, a UKI will be generated and stored in \\f[V]EFI/" "Linux\\f[R] in the ESP. If set to \\f[V]uki\\f[R], a single UKI will be " "generated for the latest installed kernel (the one with the highest version) " "which is installed to \\f[V]EFI/BOOT/BOOTX64.EFI\\f[R] in the ESP. If set " "to \\f[V]grub\\f[R], for each installed kernel, a UKI will be generated and " "stored in \\f[V]EFI/Linux\\f[R] in the ESP. For each generated UKI, a menu " "entry is appended to the grub configuration in \\f[V]grub/grub.cfg\\f[R] in " "the ESP which chainloads into the UKI. A shim grub.cfg is also written to " "\\f[V]EFI/EdistributionE/grub.cfg\\f[R] in the ESP which loads " "\\f[V]grub/grub.cfg\\f[R] in the ESP for compatibility with signed versions " "of grub which load the grub configuration from this location. Note that we " "do not yet install grub to the ESP when \\f[V]Bootloader=\\f[R] is set to " "\\f[V]grub\\f[R]. This has to be done manually in a postinst or finalize " "script. The grub EFI binary should be installed to \\f[V]/efi/EFI/BOOT/" "BOOTX64.EFI\\f[R] (or similar depending on the architecture) and should be " "configured to load its configuration from \\f[V]EFI/EdistributionE/" "grub.cfg\\f[R] in the ESP. Signed versions of grub shipped by distributions " "will load their configuration from this location by default.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]BiosBootloader=\\f[R], \\f[V]--bios-bootloader=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes one of \\f[V]none\\f[R] or \\f[V]grub\\f[R]. Defaults to " "\\f[V]none\\f[R]. If set to \\f[V]none\\f[R], no BIOS bootloader will be " "installed. If set to \\f[V]grub\\f[R], grub is installed as the BIOS boot " "loader if a bootable image is requested with the \\f[V]Bootable=\\f[R] " "option. If no repart partition definition files are configured, mkosi will " "add a grub BIOS boot partition and an EFI system partition to the default " "partition definition files. Note that this option is not mutually exclusive " "with \\f[V]Bootloader=\\f[R]. It is possible to have an image that is both " "bootable on UEFI and BIOS by configuring both \\f[V]Bootloader=\\f[R] and " "\\f[V]BiosBootloader=\\f[R]. The grub BIOS boot partition should have UUID " "\\f[V]21686148-6449-6e6f-744e-656564454649\\f[R] and should be at least " "1MB. Even if no EFI bootloader is installed, we still need an ESP for BIOS " "boot as that\\[cq]s where we store the kernel, initrd and grub modules.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ShimBootloader=\\f[R], \\f[V]--shim-bootloader=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes one of \\f[V]none\\f[R], \\f[V]unsigned\\f[R], or \\f[V]signed\\f[R]. " "Defaults to \\f[V]none\\f[R]. If set to \\f[V]none\\f[R], shim and " "MokManager will not be installed to the ESP. If set to " "\\f[V]unsigned\\f[R], mkosi will search for unsigned shim and MokManager EFI " "binaries and install them. If \\f[V]SecureBoot=\\f[R] is enabled, mkosi " "will sign the unsigned EFI binaries before installing thel. If set to " "\\f[V]signed\\f[R], mkosi will search for signed EFI binaries and install " "those. Even if \\f[V]SecureBoot=\\f[R] is enabled, mkosi won\\[cq]t sign " "these binaries again. Note that this option only takes effect when an image " "that is bootable on UEFI firmware is requested using other options " "(\\f[V]Bootable=\\f[R], \\f[V]Bootloader=\\f[R]). Note that when this " "option is enabled, mkosi will only install already signed bootloader " "binaries, kernel image files and unified kernel images as self-signed " "binaries would not be accepted by the signed version of shim.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]UnifiedKernelImages=\\f[R], \\f[V]--unified-kernel-images=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Specifies whether to use unified kernel images or not when " "\\f[V]Bootloader=\\f[R] is set to \\f[V]systemd-boot\\f[R] or " "\\f[V]grub\\f[R]. Takes a boolean value or \\f[V]auto\\f[R]. Defaults to " "\\f[V]auto\\f[R]. If enabled, unified kernel images are always used and the " "build will fail if any components required to build unified kernel images " "are missing. If set to \\f[V]auto\\f[R], unified kernel images will be used " "if all necessary components are available. Otherwise Type 1 entries as " "defined by the Boot Loader Specification will be used instead. If disabled, " "Type 1 entries will always be used.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Initrds=\\f[R], \\f[V]--initrd\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]InitrdPackages=\\f[R], \\f[V]--initrd-package=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]MicrocodeHost=\\f[R], \\f[V]--microcode-host=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]KernelCommandLine=\\f[R], \\f[V]--kernel-command-line=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Use the specified kernel command line when building images. Defaults to " "\\f[V]console=ttyS0\\f[R]. For \\f[V]arm\\f[R], \\f[V]s390\\f[R] and " "\\f[V]ppc\\f[R], \\f[V]ttyS0\\f[R] is replaced with \\f[V]ttyAMA0\\f[R], " "\\f[V]ttysclp0\\f[R] or \\f[V]hvc0\\f[R], respectively.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]KernelModulesInclude=\\f[R], \\f[V]--kernel-modules-include=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a list of regex patterns that specify kernel modules to include in the " "image. Patterns should be relative to the \\f[V]/usr/lib/modules/" "EkverE/kernel\\f[R] directory. mkosi checks for a match anywhere in " "the module path (e.g.\\ \\f[V]i915\\f[R] will match against \\f[V]drivers/" "gpu/drm/i915.ko\\f[R]). All modules that match any of the specified " "patterns are included in the image. All module and firmware dependencies of " "the matched modules are included in the image as well. This setting takes " "priority over \\f[V]KernelModulesExclude=\\f[R] and only makes sense when " "used in combination with it because all kernel modules are included in the " "image by default.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]KernelModulesExclude=\\f[R], \\f[V]--kernel-modules-exclude=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a list of regex patterns that specify modules to exclude from the " "image. Behaves the same as \\f[V]KernelModulesInclude=\\f[R] except that " "all modules that match any of the specified patterns are excluded from the " "image.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]KernelModulesIncludeHost=\\f[R], \\f[V]--kernel-modules-include-host=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a boolean. Specifies whether to include the currently loaded modules " "on the host system in the image. This setting takes priority over " "\\f[V]KernelModulesExclude=\\f[R] and only makes sense when used in " "combination with it because all kernel modules are included in the image by " "default.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]KernelModulesInitrd=\\f[R], \\f[V]--kernel-modules-initrd=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]KernelModulesInitrdInclude=\\f[R], \\f[V]--kernel-modules-initrd-include=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Like \\f[V]KernelModulesInclude=\\f[R], but applies to the kernel modules " "included in the kernel modules initrd.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]KernelModulesInitrdExclude=\\f[R], \\f[V]--kernel-modules-initrd-exclude=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Like \\f[V]KernelModulesExclude=\\f[R], but applies to the kernel modules " "included in the kernel modules initrd.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]KernelModulesInitrdIncludeHost=\\f[R], \\f[V]--kernel-modules-initrd-include-host=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Like \\f[V]KernelModulesIncludeHost=\\f[R], but applies to the kernel " "modules included in the kernel modules initrd.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Locale=\\f[R], \\f[V]--locale=\\f[R], \\f[V]LocaleMessages=\\f[R], \\f[V]--locale-messages=\\f[R], \\f[V]Keymap=\\f[R], \\f[V]--keymap=\\f[R], \\f[V]Timezone=\\f[R], \\f[V]--timezone=\\f[R], \\f[V]Hostname=\\f[R], \\f[V]--hostname=\\f[R], \\f[V]RootShell=\\f[R], \\f[V]--root-shell=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The settings \\f[V]Locale=\\f[R], \\f[V]--locale=\\f[R], " "\\f[V]LocaleMessages=\\f[R], \\f[V]--locale-messages=\\f[R], " "\\f[V]Keymap=\\f[R], \\f[V]--keymap=\\f[R], \\f[V]Timezone=\\f[R], \\f[V]--" "timezone=\\f[R], \\f[V]Hostname=\\f[R], \\f[V]--hostname=\\f[R], " "\\f[V]RootShell=\\f[R], \\f[V]--root-shell=\\f[R] correspond to the " "identically named systemd-firstboot options. See the systemd firstboot " "manpage (https://www.freedesktop.org/software/systemd/man/systemd-firstboot." "html) for more information. Additionally, where applicable, the " "corresponding systemd credentials for these settings are written to \\f[V]/" "usr/lib/credstore\\f[R], so that they apply even if only \\f[V]/usr\\f[R] is " "shipped in the image.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RootPassword=\\f[R], \\f[V]--root-password=\\f[R],\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Set the system root password. If this option is not used, but a \\f[V]mkosi." "rootpw\\f[R] file is found in the local directory, the password is " "automatically read from it. If the password starts with \\f[V]hashed:" "\\f[R], it is treated as an already hashed root password. The root password " "is also stored in \\f[V]/usr/lib/credstore\\f[R] under the appropriate " "systemd credential so that it applies even if only \\f[V]/usr\\f[R] is " "shipped in the image. To create an unlocked account without any password " "use \\f[V]hashed:\\f[R] without a hash.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Autologin=\\f[R], \\f[V]--autologin\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Enable autologin for the \\f[V]root\\f[R] user on \\f[V]/dev/pts/0\\f[R] " "(nspawn), \\f[V]/dev/tty1\\f[R] and \\f[V]/dev/ttyS0\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]MakeInitrd=\\f[R], \\f[V]--make-initrd\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Add \\f[V]/etc/initrd-release\\f[R] and \\f[V]/init\\f[R] to the image so " "that it can be used as an initramfs.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Ssh=\\f[R], \\f[V]--ssh\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If specified, an sshd socket unit and matching service are installed in the " "final image that expose SSH over VSock. When building with this option and " "running the image using \\f[V]mkosi qemu\\f[R], the \\f[V]mkosi ssh\\f[R] " "command can be used to connect to the container/VM via SSH. Note that you " "still have to make sure openssh is installed in the image to make this " "option behave correctly. Run \\f[V]mkosi genkey\\f[R] to automatically " "generate an X509 certificate and private key to be used by mkosi to enable " "SSH access to any virtual machines via \\f[V]mkosi ssh\\f[R]. To access " "images booted using \\f[V]mkosi boot\\f[R], use \\f[V]machinectl\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SELinuxRelabel=\\f[R], \\f[V]--selinux-relabel=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Specifies whether to relabel files to match the image\\[cq]s SELinux " "policy. Takes a boolean value or \\f[V]auto\\f[R]. Defaults to " "\\f[V]auto\\f[R]. If disabled, files will not relabeled. If enabled, an " "SELinux policy has to be installed in the image and \\f[V]setfiles\\f[R] has " "to be available to relabel files. If any errors occur during " "\\f[V]setfiles\\f[R], the build will fail. If set to \\f[V]auto\\f[R], " "files will be relabeled if an SELinux policy is installed in the image and " "if \\f[V]setfiles\\f[R] is available. Any errors occurred during " "\\f[V]setfiles\\f[R] will be ignored. Note that when running unprivileged, " "\\f[V]setfiles\\f[R] will fail to set any labels that are not in the " "host\\[cq]s SELinux policy. To ensure \\f[V]setfiles\\f[R] succeeds without " "errors, make sure to run mkosi as root or build from a host system with the " "same SELinux policy as the image you\\[cq]re building.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SecureBoot=\\f[R], \\f[V]--secure-boot\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SecureBootAutoEnroll=\\f[R], \\f[V]--secure-boot-auto-enroll=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Set up automatic enrollment of the secure boot keys in virtual machines as " "documented in the systemd-boot man page (https://www.freedesktop.org/" "software/systemd/man/systemd-boot.html) if \\f[V]SecureBoot=\\f[R] is " "used. Note that systemd-boot will only do automatic secure boot key " "enrollment in virtual machines starting from systemd v253. To do auto " "enrollment on systemd v252 or on bare metal machines, write a systemd-boot " "configuration file to \\f[V]/efi/loader/loader.conf\\f[R] using an extra " "tree with \\f[V]secure-boot-enroll force\\f[R] or \\f[V]secure-boot-enroll " "manual\\f[R] in it. Auto enrollment is not supported on systemd versions " "older than v252. Defaults to \\f[V]yes\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SecureBootKey=\\f[R], \\f[V]--secure-boot-key=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Path to the PEM file containing the secret key for signing the UEFI kernel " "image if \\f[V]SecureBoot=\\f[R] is used and PCR signatures when " "\\f[V]SignExpectedPcr=\\f[R] is also used. When " "\\f[V]SecureBootKeySource=\\f[R] is specified, the input type depends on the " "source.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SecureBootKeySource=\\f[R], \\f[V]--secure-boot-key-source=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Source of \\f[V]SecureBootKey=\\f[R], to support OpenSSL engines. E.g.: " "\\f[V]--secure-boot-key-source=engine:pkcs11\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SecureBootCertificate=\\f[R], \\f[V]--secure-boot-certificate=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Path to the X.509 file containing the certificate for the signed UEFI kernel " "image, if \\f[V]SecureBoot=\\f[R] is used.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SecureBootSignTool=\\f[R], \\f[V]--secure-boot-sign-tool\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Tool to use to sign secure boot PE binaries. Takes one of " "\\f[V]sbsign\\f[R], \\f[V]pesign\\f[R] or \\f[V]auto\\f[R]. Defaults to " "\\f[V]auto\\f[R]. If set to \\f[V]auto\\f[R], either sbsign or pesign are " "used if available, with sbsign being preferred if both are installed.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]VerityKey=\\f[R], \\f[V]--verity-key=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Path to the PEM file containing the secret key for signing the verity " "signature, if a verity signature partition is added with systemd-repart. " "When \\f[V]VerityKeySource=\\f[R] is specified, the input type depends on " "the source.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]VerityKeySource=\\f[R], \\f[V]--verity-key-source=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Source of \\f[V]VerityKey=\\f[R], to support OpenSSL engines. E.g.: \\f[V]--" "verity-key-source=engine:pkcs11\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]VerityCertificate=\\f[R], \\f[V]--verity-certificate=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SignExpectedPcr=\\f[R], \\f[V]--sign-expected-pcr\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Measure the components of the unified kernel image (UKI) using \\f[V]systemd-" "measure\\f[R] and embed the PCR signature into the unified kernel image. " "This option takes a boolean value or the special value \\f[V]auto\\f[R], " "which is the default, which is equal to a true value if the \\f[V]systemd-" "measure\\f[R] binary is in \\f[V]PATH\\f[R]. Depends on " "\\f[V]SecureBoot=\\f[R] being enabled and key from " "\\f[V]SecureBootKey=\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Passphrase=\\f[R], \\f[V]--passphrase\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Specify the path to a file containing the passphrase to use for LUKS " "encryption. It should contain the passphrase literally, and not end in a " "newline character (i.e.\\ in the same format as cryptsetup and \\f[V]/etc/" "crypttab\\f[R] expect the passphrase files). The file must have an access " "mode of 0600 or less.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Checksum=\\f[R], \\f[V]--checksum\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Generate a \\f[V]SHA256SUMS\\f[R] file of all generated artifacts after the " "build is complete.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Sign=\\f[R], \\f[V]--sign\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Sign the generated \\f[V]SHA256SUMS\\f[R] using \\f[V]gpg\\f[R] after " "completion.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Key=\\f[R], \\f[V]--key=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Select the \\f[V]gpg\\f[R] key to use for signing \\f[V]SHA256SUMS\\f[R]. " "This key must be already present in the \\f[V]gpg\\f[R] keyring.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Incremental=\\f[R], \\f[V]--incremental=\\f[R], \\f[V]-i\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Enable incremental build mode. In this mode, a copy of the OS image is " "created immediately after all OS packages are installed and the prepare " "scripts have executed but before the \\f[V]mkosi.build\\f[R] scripts are " "invoked (or anything that happens after it). On subsequent invocations of " "\\f[V]mkosi\\f[R] with the \\f[V]-i\\f[R] switch this cached image may be " "used to skip the OS package installation, thus drastically speeding up " "repetitive build times. Note that while there is some rudimentary cache " "invalidation, it is definitely not perfect. In order to force rebuilding of " "the cached image, combine \\f[V]-i\\f[R] with \\f[V]-ff\\f[R] to ensure the " "cached image is first removed and then re-created.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]NSpawnSettings=\\f[R], \\f[V]--settings=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Specifies a \\f[V].nspawn\\f[R] settings file for \\f[V]systemd-nspawn\\f[R] " "to use in the \\f[V]boot\\f[R] and \\f[V]shell\\f[R] verbs, and to place " "next to the generated image file. This is useful to configure the " "\\f[V]systemd-nspawn\\f[R] environment when the image is run. If this " "setting is not used but an \\f[V]mkosi.nspawn\\f[R] file found in the local " "directory it is automatically used for this purpose.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ExtraSearchPaths=\\f[R], \\f[V]--extra-search-path=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "List of colon-separated paths to look for tools in, before using the regular " "\\f[V]$PATH\\f[R] search path.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuGui=\\f[R], \\f[V]--qemu-gui=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuSmp=\\f[R], \\f[V]--qemu-smp=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used with the \\f[V]qemu\\f[R] verb, this options sets " "\\f[V]qemu\\f[R]\\[cq]s \\f[V]-smp\\f[R] argument which controls the number " "of guest\\[cq]s CPUs. Defaults to \\f[V]2\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuMem=\\f[R], \\f[V]--qemu-mem=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used with the \\f[V]qemu\\f[R] verb, this options sets " "\\f[V]qemu\\f[R]\\[cq]s \\f[V]-m\\f[R] argument which controls the amount of " "guest\\[cq]s RAM. Defaults to \\f[V]2G\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuKvm=\\f[R], \\f[V]--qemu-kvm=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used with the \\f[V]qemu\\f[R] verb, this option specifies whether QEMU " "should use KVM acceleration. Takes a boolean value or \\f[V]auto\\f[R]. " "Defaults to \\f[V]auto\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuVsock=\\f[R], \\f[V]--qemu-vsock=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used with the \\f[V]qemu\\f[R] verb, this option specifies whether QEMU " "should be configured with a vsock. Takes a boolean value or " "\\f[V]auto\\f[R]. Defaults to \\f[V]auto\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuVsockConnectionId=\\f[R], \\f[V]--qemu-vsock-cid=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used with the \\f[V]qemu\\f[R] verb, this option specifies the vsock " "connection ID to use. Takes a number in the interval \\f[V][3, " "0xFFFFFFFF)\\f[R] or \\f[V]hash\\f[R] or \\f[V]auto\\f[R]. Defaults to " "\\f[V]hash\\f[R]. When set to \\f[V]hash\\f[R], the connection ID will be " "derived from the full path to the image. When set to \\f[V]auto\\f[R], " "\\f[V]mkosi\\f[R] will try to find a free connection ID automatically. " "Otherwise, the provided number will be used as is. Note that when set to " "\\f[V]auto\\f[R], \\f[V]mkosi ssh\\f[R] cannot be used as we cannot figure " "out which free connection ID we found when booting the image earlier.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuSwtpm=\\f[R], \\f[V]--qemu-swtpm=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used with the \\f[V]qemu\\f[R] verb, this option specifies whether to " "start an instance of swtpm to be used as a TPM with qemu. This requires " "swtpm to be installed on the host. Takes a boolean value or " "\\f[V]auto\\f[R]. Defaults to \\f[V]auto\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuCdrom=\\f[R], \\f[V]--qemu-cdrom=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used with the \\f[V]qemu\\f[R] verb, this option specifies whether to " "attach the image to the virtual machine as a CD-ROM device. Takes a " "boolean. Defaults to \\f[V]no\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuFirmware=\\f[R], \\f[V]--qemu-firmware=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used with the \\f[V]qemu\\f[R] verb, this option specifies which " "firmware to use. Takes one of \\f[V]uefi\\f[R], \\f[V]uefi-secure-" "boot\\f[R], \\f[V]bios\\f[R], \\f[V]linux\\f[R], or \\f[V]auto\\f[R]. " "Defaults to \\f[V]auto\\f[R]. When set to \\f[V]uefi\\f[R], the OVMF " "firmware without secure boot support is used. When set to \\f[V]uefi-secure-" "boot\\f[R], the OVMF firmware with secure boot support is used. When set to " "\\f[V]bios\\f[R], the default SeaBIOS firmware is used. When set to " "\\f[V]linux\\f[R], direct kernel boot is used. See the " "\\f[V]QemuKernel=\\f[R] option for more details on which kernel image is " "used with direct kernel boot. When set to \\f[V]auto\\f[R], \\f[V]uefi-" "secure-boot\\f[R] is used if possible and \\f[V]linux\\f[R] otherwise.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuFirmwareVariables=\\f[R], \\f[V]--qemu-firmware-variables=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used with the \\f[V]qemu\\f[R] verb, this option specifies the path to " "the the firmware variables file to use. Currently, this option is only " "taken into account when the \\f[V]uefi\\f[R] or \\f[V]uefi-secure-boot\\f[R] " "firmware is used. If not specified, mkosi will search for the default " "variables file and use that instead. When set to \\f[V]microsoft\\f[R], a " "firmware variables file with the Microsoft secure boot certificates already " "enrolled will be used. When set to \\f[V]custom\\f[R], the secure boot " "certificate from \\f[V]SecureBootCertificate=\\f[R] will be enrolled into " "the default firmware variables file. \\f[V]virt-fw-vars\\f[R] from the virt-" "firmware (https://gitlab.com/kraxel/virt-firmware) project can be used to " "customize OVMF variable files.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuKernel=\\f[R], \\f[V]--qemu-kernel=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Set the kernel image to use for qemu direct kernel boot. If not specified, " "mkosi will use the kernel provided via the command line (\\f[V]-kernel\\f[R] " "option) or latest the kernel that was installed into the image (or fail if " "no kernel was installed into the image). Note that when the " "\\f[V]cpio\\f[R] output format is used, direct kernel boot is used " "regardless of the configured firmware. Depending on the configured " "firmware, qemu might boot the kernel itself or using the configured firmware." "\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuDrives=\\f[R], \\f[V]--qemu-drive=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Add a qemu drive. Takes a colon-delimited string of format " "\\f[V]EidE:EsizeE[:EdirectoryE[:" "EoptionsE]]\\f[R]. \\f[V]id\\f[R] specifies the qemu id we assign " "to the drive. This can be used as the \\f[V]drive=\\f[R] property in " "various qemu devices. \\f[V]size\\f[R] specifies the size of the drive. " "This takes a size in bytes. Additionally, the suffixes \\f[V]K\\f[R], " "\\f[V]M\\f[R] and \\f[V]G\\f[R] can be used to specify a size in kilobytes, " "megabytes and gigabytes respectively. \\f[V]directory\\f[R] optionally " "specifies the directory in which to create the file backing the drive. " "\\f[V]options\\f[R] optionally specifies extra comma-delimited properties " "which are passed verbatim to qemu\\[cq]s \\f[V]-drive\\f[R] option. Example " "usage:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "[Host]\n" "QemuDrives=btrfs:10G\n" " ext4:20G\n" "QemuArgs=-device nvme,serial=btrfs,drive=btrfs\n" " -device nvme,serial=ext4,drive=ext4\\fR\n" "\n" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]QemuArgs=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Ephemeral=\\f[R], \\f[V]--ephemeral\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When used with the \\f[V]shell\\f[R], \\f[V]boot\\f[R], or \\f[V]qemu\\f[R] " "verbs, this option runs the specified verb on a temporary snapshot of the " "output image that is removed immediately when the container terminates. " "Taking the temporary snapshot is more efficient on file systems that support " "reflinks natively (btrfs or xfs) than on more traditional file systems that " "do not (ext4).\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Credentials=\\f[R], \\f[V]--credential=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Set credentials to be passed to systemd-nspawn or qemu respectively when " "\\f[V]mkosi shell/boot\\f[R] or \\f[V]mkosi qemu\\f[R] are used. This " "option takes a space separated list of key=value assignments.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]KernelCommandLineExtra=\\f[R], \\f[V]--kernel-command-line-extra=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Acl=\\f[R], \\f[V]--acl=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ToolsTree=\\f[R], \\f[V]--tools-tree=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If specified, programs executed by mkosi to build and boot an image are " "looked up inside the given tree instead of in the host system. Use this " "option to make image builds more reproducible by always using the same " "versions of programs to build the final image instead of whatever version is " "installed on the host system. If this option is not used, but the " "\\f[V]mkosi.tools/\\f[R] directory is found in the local directory it is " "automatically used for this purpose with the root directory as target. Note " "that when looking up binaries in \\f[V]--tools-tree=\\f[R], only \\f[V]/usr/" "bin\\f[R] and \\f[V]/usr/sbin\\f[R] are considered. Specifically, paths " "specified by \\f[V]--extra-search-path=\\f[R] are ignored when looking up " "binaries in the given tools tree. If set to \\f[V]default\\f[R], mkosi will " "automatically add an extra tools tree image and use it as the tools tree. " "The following table shows for which distributions default tools tree " "packages are defined and which packages are included in those default tools " "trees:\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]acl\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]apt\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]archlinux-keyring\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]attr\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]bash\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]btrfs-progs\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]bubblewrap\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ca-certificates\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]coreutils\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]cpio\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]curl\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]debian-keyring\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]diffutils\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]distribution-gpg-keys\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]dnf\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]dnf-plugins-core\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]dnf5\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]dnf5-plugins\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]dosfstools\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]e2fsprogs\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]edk2-ovmf\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]erofs-utils\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]findutils\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]git\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]grep\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]jq\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]kmod\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]less\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]mtools\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]nano\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]openssh\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]openssl\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]sed\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]pacman\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]pesign\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]policycoreutils\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]sbsigntools\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]socat\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]squashfs-tools\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]strace\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]swtpm\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]systemd\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ukify\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]tar\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ubuntu-keyring\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]util-linux\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]virtiofsd\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]virt-firmware\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]xfsprogs\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]xz\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]zstd\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]zypper\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ToolsTreeDistribution=\\f[R], \\f[V]--tools-tree-distribution=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ToolsTreeRelease=\\f[R], \\f[V]--tools-tree-release=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ToolsTreeMirror=\\f[R], \\f[V]--tools-tree-mirror=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ToolsTreeRepositories=\\f[R], \\f[V]--tools-tree-repository\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Same as \\f[V]Repositories=\\f[R] but for the default tools tree.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ToolsTreePackageManagerTrees=\\f[R], \\f[V]--tools-tree-package-manager-tree=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Same as \\f[V]PackageManagerTrees=\\f[R] but for the default tools tree.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ToolsTreePackages=\\f[R], \\f[V]--tools-tree-packages=\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RuntimeTrees=\\f[R], \\f[V]--runtime-tree=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a colon separated pair of paths. The first path refers to a directory " "to mount into any machine (container or VM) started by mkosi. The second " "path refers to the target directory inside the machine. If the second path " "is not provided, the directory is mounted below \\f[V]/root/src\\f[R] in the " "machine. If the second path is relative, it is interpreted relative to " "\\f[V]/root/src\\f[R] in the machine. For each mounted directory, the uid " "and gid of the user running mkosi are mapped to the root user in the " "machine. This means that all the files and directories will appear as if " "they\\[cq]re owned by root in the machine, and all new files and directories " "created by root in the machine in these directories will be owned by the " "user running mkosi on the host. Note that when using \\f[V]mkosi qemu\\f[R] " "with this feature systemd v254 or newer has to be installed in the image.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RuntimeSize=\\f[R], \\f[V]--runtime-size=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If specified, disk images are grown to the specified size before " "they\\[cq]re booted with systemd-nspawn or qemu. Takes a size in bytes. " "Additionally, the suffixes \\f[V]K\\f[R], \\f[V]M\\f[R] and \\f[V]G\\f[R] " "can be used to specify a size in kilobytes, megabytes and gigabytes " "respectively.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RuntimeScratch=\\f[R]: \\f[V]--runtime-scratch=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes a boolean value or \\f[V]auto\\f[R]. Specifies whether to mount extra " "scratch space to \\f[V]/var/tmp\\f[R]. If enabled, practically unlimited " "scratch space is made available under \\f[V]/var/tmp\\f[R] when booting the " "image with \\f[V]mkosi qemu\\f[R], \\f[V]mkosi boot\\f[R] or \\f[V]mkosi " "shell\\f[R]. Note that using this feature with \\f[V]mkosi qemu\\f[R] " "requires systemd v254 or newer in the guest.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RuntimeNetwork=\\f[R]: \\f[V]--runtime-network=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Takes one of \\f[V]user\\f[R], \\f[V]interface\\f[R] or \\f[V]none\\f[R]. " "Defaults to \\f[V]user\\f[R]. Specifies the networking to set up when " "booting the image. \\f[V]user\\f[R] sets up usermode networking. " "\\f[V]interface\\f[R] sets up a virtual network connection between the host " "and the image. This translates to a veth interface for \\f[V]mkosi " "shell\\f[R] and \\f[V]mkosi boot\\f[R] and a tap interface for \\f[V]mkosi " "qemu\\f[R] and \\f[V]mkosi vmspawn\\f[R]. Note that when using " "\\f[V]interface\\f[R], mkosi does not automatically configure the host " "interface. It is expected that a recent version of \\f[V]systemd-" "networkd\\f[R] is running on the host which will automatically configure the " "host interface of the link.\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SshKey=\\f[R], \\f[V]--ssh-key=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Path to the X509 private key in PEM format to use to connect to a virtual " "machine started with \\f[V]mkosi qemu\\f[R] and built with the " "\\f[V]Ssh=\\f[R] option enabled via the \\f[V]mkosi ssh\\f[R] command. If " "not configured and \\f[V]mkosi.key\\f[R] exists in the working directory, it " "will automatically be used for this purpose. Run \\f[V]mkosi genkey\\f[R] " "to automatically generate a key in \\f[V]mkosi.key\\f[R].\\fR" msgstr "" #. type: TP #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SshCertificate=\\f[R], \\f[V]--ssh-certificate=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Path to the X509 certificate in PEM format to provision as the SSH public " "key in virtual machines started with \\f[V]mkosi qemu\\f[R]. If not " "configured and \\f[V]mkosi.crt\\f[R] exists in the working directory, it " "will automatically be used for this purpose. Run \\f[V]mkosi genkey\\f[R] " "to automatically generate a certificate in \\f[V]mkosi.crt\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The current value of various settings can be accessed when parsing " "configuration files by using specifiers. To write a literal \\f[V]%\\f[R] " "character in a configuration file without treating it as a specifier, use " "\\f[V]%%\\f[R]. The following specifiers are understood:\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]%d\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]%r\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]%a\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]%t\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]Output=\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]%o\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]OutputDirectory=\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]%O\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]%i\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]%v\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "In theory, any distribution may be used on the host for building images " "containing any other distribution, as long as the necessary tools are " "available. Specifically, any distribution that packages \\f[V]apt\\f[R] may " "be used to build \\f[I]Debian\\f[R] or \\f[I]Ubuntu\\f[R] images. Any " "distribution that packages \\f[V]dnf\\f[R] may be used to build images for " "any of the rpm-based distributions. Any distro that packages " "\\f[V]pacman\\f[R] may be used to build \\f[I]Arch Linux\\f[R] images. Any " "distribution that packages \\f[V]zypper\\f[R] may be used to build " "\\f[I]openSUSE\\f[R] images. Other distributions and build automation tools " "for embedded Linux systems such as Buildroot, OpenEmbedded and Yocto Project " "may be used by selecting the \\f[V]custom\\f[R] distribution, and populating " "the rootfs via a combination of base trees, skeleton trees, and prepare " "scripts.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Note that when not using a custom mirror, \\f[V]RHEL\\f[R] images can only " "be built from a host system with a \\f[V]RHEL\\f[R] subscription " "(established using e.g.\\ \\f[V]subscription-manager\\f[R]).\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Execution flow for \\f[V]mkosi build\\f[R]. Default values/calls are shown " "in parentheses. When building with \\f[V]--incremental\\f[R] mkosi creates " "a cache of the distribution installation if not already existing and " "replaces the distribution installation in consecutive runs with data from " "the cached one.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If we\\[cq]re not running as root, unshare the user namespace and map the " "subuid range configured in \\f[V]/etc/subuid\\f[R] and \\f[V]/etc/" "subgid\\f[R] into it.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]/usr\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]/etc\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]/opt\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]/srv\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]/boot\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]/efi\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]/media\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]/mnt\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Copy base trees (\\f[V]--base-tree=\\f[R]) into the image\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Copy skeleton trees (\\f[V]mkosi.skeleton\\f[R]) into image\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Run prepare scripts on image with the \\f[V]final\\f[R] argument " "(\\f[V]mkosi.prepare\\f[R])\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Run prepare scripts on overlay with the \\f[V]build\\f[R] argument if any " "build scripts are configured (\\f[V]mkosi.prepare\\f[R])\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Cache the image if configured (\\f[V]--incremental\\f[R])\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Run build scripts on image + overlay if any build scripts are configured " "(\\f[V]mkosi.build\\f[R])\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Finalize the build if the output format \\f[V]none\\f[R] is configured\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Copy the extra trees into the image (\\f[V]mkosi.extra\\f[R])\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Run post-install scripts (\\f[V]mkosi.postinst\\f[R])\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Write config files required for \\f[V]Ssh=\\f[R], \\f[V]Autologin=\\f[R] and " "\\f[V]MakeInitrd=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Install systemd-boot and configure secure boot if configured (\\f[V]--secure-" "boot\\f[R])\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Run \\f[V]systemd-sysusers\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Run \\f[V]systemd-tmpfiles\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Run \\f[V]systemctl preset-all\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Run \\f[V]depmod\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Run \\f[V]systemd-firstboot\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Run \\f[V]systemd-hwdb\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Remove packages and files (\\f[V]RemovePackages=\\f[R], " "\\f[V]RemoveFiles=\\f[R])\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Run finalize scripts (\\f[V]mkosi.finalize\\f[R])\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "To allow for image customization that cannot be implemented using " "mkosi\\[cq]s builtin features, mkosi supports running scripts at various " "points during the image build process that can customize the image as " "needed. Scripts are executed on the host system as root (either real root " "or root within the user namespace that mkosi created when running " "unprivileged) with a customized environment to simplify modifying the " "image. For each script, the configured build sources " "(\\f[V]BuildSources=\\f[R]) are mounted into the current working directory " "before running the script in the current working directory. " "\\f[V]$SRCDIR\\f[R] is set to point to the current working directory. The " "following scripts are supported:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If \\f[VB]mkosi.sync\\f[R] (\\f[V]SyncScripts=\\f[R]) exists, it is executed " "before the image is built. This script may be used to update various " "sources that are used to build the image. One use case is to run \\f[V]git " "pull\\f[R] on various source repositories before building the image. " "Specifically, the \\f[V]BuildSourcesEphemeral=\\f[R] setting does not apply " "to sync scripts, which means sync scripts can be used to update build " "sources even if \\f[V]BuildSourcesEphemeral=\\f[R] is enabled.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If \\f[VB]mkosi.prepare\\f[R] (\\f[V]PrepareScripts=\\f[R]) exists, it is " "first called with the \\f[V]final\\f[R] argument, right after the software " "packages are installed. It is called a second time with the " "\\f[V]build\\f[R] command line parameter, right after the build packages are " "installed and the build overlay mounted on top of the image\\[cq]s root " "directory . This script has network access and may be used to install " "packages from other sources than the distro\\[cq]s package manager (e.g.\\ " "\\f[V]pip\\f[R], \\f[V]npm\\f[R], \\&...), after all software packages are " "installed but before the image is cached (if incremental mode is enabled). " "In contrast to a general purpose installation, it is safe to install " "packages to the system (\\f[V]pip install\\f[R], \\f[V]npm install -" "g\\f[R]) instead of in \\f[V]$SRCDIR\\f[R] itself because the build image " "is only used for a single project and can easily be thrown away and rebuilt " "so there\\[cq]s no risk of conflicting dependencies and no risk of polluting " "the host system.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If \\f[VB]mkosi.build\\f[R] (\\f[V]BuildScripts=\\f[R]) exists, it is " "executed with the build overlay mounted on top of the image\\[cq]s root " "directory. When running the build script, \\f[V]$DESTDIR\\f[R] points to a " "directory where the script should place any files generated it would like to " "end up in the image. Note that \\f[V]make\\f[R]/\\f[V]automake\\f[R]/" "\\f[V]meson\\f[R] based build systems generally honor \\f[V]$DESTDIR\\f[R], " "thus making it very natural to build \\f[I]source\\f[R] trees from the build " "script. After running the build script, the contents of " "\\f[V]$DESTDIR\\f[R] are copied into the image.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If \\f[VB]mkosi.postinst\\f[R] (\\f[V]PostInstallationScripts=\\f[R]) " "exists, it is executed after the (optional) build tree and extra trees have " "been installed. This script may be used to alter the images without any " "restrictions, after all software packages and built sources have been " "installed.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If \\f[VB]mkosi.finalize\\f[R] (\\f[V]FinalizeScripts=\\f[R]) exists, it is " "executed as the last step of preparing an image.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If a script uses the \\f[V].chroot\\f[R] extension, mkosi will chroot into " "the image using \\f[V]mkosi-chroot\\f[R] (see below) before executing the " "script. For example, if \\f[V]mkosi.postinst.chroot\\f[R] exists, mkosi " "will chroot into the image and execute it as the post-installation script." "\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$ARCHITECTURE\\f[R] contains the architecture from the " "\\f[V]Architecture=\\f[R] setting. If \\f[V]Architecture=\\f[R] is not set, " "it will contain the native architecture of the host machine. See the " "documentation of \\f[V]Architecture=\\f[R] for possible values for this " "variable.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$DISTRIBUTION\\f[R] contains the distribution from the " "\\f[V]Distribution=\\f[R] setting.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$RELEASE\\f[R] contains the release from the \\f[V]Release=\\f[R] " "setting.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$PROFILE\\f[R] contains the profile from the \\f[V]Profile=\\f[R] " "setting.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$CACHED=\\f[R] is set to \\f[V]1\\f[R] if a cached image is available, " "\\f[V]0\\f[R] otherwise.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$CHROOT_SCRIPT\\f[R] contains the path to the running script relative " "to the image root directory. The primary usecase for this variable is in " "combination with the \\f[V]mkosi-chroot\\f[R] script. See the description " "of \\f[V]mkosi-chroot\\f[R] below for more information.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$SRCDIR\\f[R] contains the path to the directory mkosi was invoked " "from, with any configured build sources mounted on top. " "\\f[V]$CHROOT_SRCDIR\\f[R] contains the value that \\f[V]$SRCDIR\\f[R] will " "have after invoking \\f[V]mkosi-chroot\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$BUILDDIR\\f[R] is only defined if \\f[V]mkosi.builddir\\f[R] exists " "and points to the build directory to use. This is useful for all build " "systems that support out-of-tree builds to reuse already built artifacts " "from previous runs. \\f[V]$CHROOT_BUILDDIR\\f[R] contains the value that " "\\f[V]$BUILDDIR\\f[R] will have after invoking \\f[V]mkosi-chroot\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$DESTDIR\\f[R] is a directory into which any installed software " "generated by a build script may be placed. This variable is only set when " "executing a build script. \\f[V]$CHROOT_DESTDIR\\f[R] contains the value " "that \\f[V]$DESTDIR\\f[R] will have after invoking \\f[V]mkosi-chroot\\f[R]." "\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$OUTPUTDIR\\f[R] points to the staging directory used to store build " "artifacts generated during the build. \\f[V]$CHROOT_OUTPUTDIR\\f[R] " "contains the value that \\f[V]$OUTPUTDIR\\f[R] will have after invoking " "\\f[V]mkosi-chroot\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$PACKAGEDIR\\f[R] points to the directory containing the local package " "repository. Build scripts can add more packages to the local repository by " "writing the packages to \\f[V]$PACKAGEDIR\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$BUILDROOT\\f[R] is the root directory of the image being built, " "optionally with the build overlay mounted on top depending on the script " "that\\[cq]s being executed.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$WITH_DOCS\\f[R] is either \\f[V]0\\f[R] or \\f[V]1\\f[R] depending on " "whether a build without or with installed documentation was requested " "(\\f[V]WithDocs=yes\\f[R]). A build script should suppress installation of " "any package documentation to \\f[V]$DESTDIR\\f[R] in case " "\\f[V]$WITH_DOCS\\f[R] is set to \\f[V]0\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$WITH_TESTS\\f[R] is either \\f[V]0\\f[R] or \\f[V]1\\f[R] depending " "on whether a build without or with running the test suite was requested " "(\\f[V]WithTests=no\\f[R]). A build script should avoid running any unit or " "integration tests in case \\f[V]$WITH_TESTS\\f[R] is \\f[V]0\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$WITH_NETWORK\\f[R] is either \\f[V]0\\f[R] or \\f[V]1\\f[R] depending " "on whether a build without or with networking is being executed " "(\\f[V]WithNetwork=no\\f[R]). A build script should avoid any network " "communication in case \\f[V]$WITH_NETWORK\\f[R] is \\f[V]0\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$SOURCE_DATE_EPOCH\\f[R] is defined if requested " "(\\f[V]SourceDateEpoch=TIMESTAMP\\f[R], " "\\f[V]Environment=SOURCE_DATE_EPOCH=TIMESTAMP\\f[R] or the host environment " "variable \\f[V]$SOURCE_DATE_EPOCH\\f[R]). This is useful to make builds " "reproducible. See SOURCE_DATE_EPOCH (https://reproducible-builds.org/specs/" "source-date-epoch/) for more information.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$MKOSI_UID\\f[R] and \\f[V]$MKOSI_GID\\f[R] are the respectively the " "uid, gid of the user that invoked mkosi, potentially translated to a uid in " "the user namespace that mkosi is running in. These can be used in " "combination with \\f[V]setpriv\\f[R] to run commands as the user that " "invoked mkosi (e.g. \\f[V]setpriv --reuid=$MKOSI_UID --regid=$MKOSI_GID --" "clear-groups EcommandE\\f[R])\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$MKOSI_CONFIG\\f[R] is a file containing a json summary of the " "settings of the current image. This file can be parsed inside scripts to " "gain access to all settings for the current image.\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]mkosi.sync\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]mkosi.prepare\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]mkosi.build\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]mkosi.postinst\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]mkosi.finalize\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]ARCHITECTURE\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]DISTRIBUTION\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]RELEASE\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]PROFILE\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CACHED\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CHROOT_SCRIPT\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SRCDIR\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CHROOT_SRCDIR\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]BUILDDIR\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CHROOT_BUILDDIR\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]DESTDIR\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CHROOT_DESTDIR\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]OUTPUTDIR\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]CHROOT_OUTPUTDIR\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]BUILDROOT\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]WITH_DOCS\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]WITH_TESTS\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]WITH_NETWORK\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]SOURCE_DATE_EPOCH\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]MKOSI_UID\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]MKOSI_GID\\fR" msgstr "" #. type: tbl table #: debian-bookworm debian-unstable #, no-wrap msgid "\\f[V]MKOSI_CONFIG\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Additionally, when a script is executed, a few scripts are made available " "via \\f[V]$PATH\\f[R] to simplify common usecases.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]mkosi-chroot\\f[R]: This script will chroot into the image and execute " "the given command. On top of chrooting into the image, it will also mount " "various files and directories (\\f[V]$SRCDIR\\f[R], \\f[V]$DESTDIR\\f[R], " "\\f[V]$BUILDDIR\\f[R], \\f[V]$OUTPUTDIR\\f[R], \\f[V]$CHROOT_SCRIPT\\f[R]) " "into the image and modify the corresponding environment variables to point " "to the locations inside the image. It will also mount APIVFS filesystems " "(\\f[V]/proc\\f[R], \\f[V]/dev\\f[R], \\&...) to make sure scripts and " "tools executed inside the chroot work properly. It also propagates \\f[V]/" "etc/resolv.conf\\f[R] from the host into the chroot if requested so that DNS " "resolution works inside the chroot. After the mkosi-chroot command exits, " "various mount points are cleaned up.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "For example, to invoke \\f[V]ls\\f[R] inside of the image, use the " "following\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "mkosi-chroot ls ...\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "To execute the entire script inside the image, add a \\[lq].chroot\\[rq] " "suffix to the name (\\f[V]mkosi.build.chroot\\f[R] instead of \\f[V]mkosi." "build\\f[R], etc.).\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "For all of the supported package managers except portage (\\f[V]dnf\\f[R], " "\\f[V]rpm\\f[R], \\f[V]apt\\f[R], \\f[V]pacman\\f[R], \\f[V]zypper\\f[R]), " "scripts of the same name are put into \\f[V]$PATH\\f[R] that make sure these " "commands operate on the image\\[cq]s root directory with the configuration " "supplied by the user instead of on the host system. This means that from a " "script, you can do e.g.\\ \\f[V]dnf install vim\\f[R] to install vim into " "the image.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Additionally, \\f[V]mkosi-install\\f[R], \\f[V]mkosi-reinstall\\f[R], " "\\f[V]mkosi-upgrade\\f[R] and \\f[V]mkosi-remove\\f[R] will invoke the " "corresponding operation of the package manager being used to built the image." "\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]mkosi-as-caller\\f[R]: This script uses \\f[V]setpriv\\f[R] to switch " "from the user \\f[V]root\\f[R] in the user namespace used for various build " "steps back to the original user that called mkosi. This is useful when we " "want to invoke build steps which will write to \\f[V]$BUILDDIR\\f[R] and we " "want to have the files owned by the calling user.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "For example, a complete \\f[V]mkosi.build\\f[R] script might be the " "following:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "set -ex\\fR\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]mkosi-as-caller meson setup \\[dq]$BUILDDIR/build\\[dq] \\[dq]$SRCDIR\\[dq]\n" "mkosi-as-caller meson compile -C \\[dq]$BUILDDIR/build\\[dq]\n" "meson install -C \\[dq]$BUILDDIR/build\\[dq] --no-rebuild\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]git\\f[R] is automatically invoked with \\f[V]safe.directory=*\\f[R] " "to avoid permissions errors when running as the root user in a user " "namespace.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]useradd\\f[R] and \\f[V]groupadd\\f[R] are automatically invoked with " "\\f[V]--root=$BUILDROOT\\f[R] when executed outside of the image.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When scripts are executed, any directories that are still writable are also " "made read-only (\\f[V]/home\\f[R], \\f[V]/var\\f[R], \\f[V]/root\\f[R], " "\\&...) and only the minimal set of directories that need to be writable " "remain writable. This is to ensure that scripts can\\[cq]t mess with the " "host system when mkosi is running as root.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.skeleton/\\f[R] directory or \\f[VB]mkosi.skeleton." "tar\\f[R] archive may be used to insert files into the image. The files are " "copied \\f[I]before\\f[R] the distribution packages are installed into the " "image. This allows creation of files that need to be provided early, for " "example to configure the package manager or set systemd presets.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.extra/\\f[R] directory or \\f[VB]mkosi.extra.tar\\f[R] " "archive may be used to insert additional files into the image, on top of " "what the distribution includes in its packages. They are similar to " "\\f[V]mkosi.skeleton/\\f[R] and \\f[V]mkosi.skeleton.tar\\f[R], but the " "files are copied into the directory tree of the image \\f[I]after\\f[R] the " "OS was installed.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.nspawn\\f[R] nspawn settings file will be copied into the " "same place as the output image file, if it exists. This is useful since " "nspawn looks for settings files next to image files it boots, for additional " "container runtime settings.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.cache/\\f[R] directory, if it exists, is automatically used " "as package download cache, in order to speed repeated runs of the tool.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.builddir/\\f[R] directory, if it exists, is automatically " "used as out-of-tree build directory, if the build commands in the " "\\f[V]mkosi.build\\f[R] scripts support it. Specifically, this directory " "will be mounted into the build container, and the \\f[V]$BUILDDIR\\f[R] " "environment variable will be set to it when the build scripts are invoked. " "A build script may then use this directory as build directory, for automake-" "style or ninja-style out-of-tree builds. This speeds up builds " "considerably, in particular when \\f[V]mkosi\\f[R] is used in incremental " "mode (\\f[V]-i\\f[R]): not only the image and build overlay, but also the " "build tree is reused between subsequent invocations. Note that if this " "directory does not exist the \\f[V]$BUILDDIR\\f[R] environment variable is " "not set, and it is up to the build scripts to decide whether to do in in-" "tree or an out-of-tree build, and which build directory to use.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.rootpw\\f[R] file can be used to provide the password for " "the root user of the image. If the password is prefixed with \\f[V]hashed:" "\\f[R] it is treated as an already hashed root password. The password may " "optionally be followed by a newline character which is implicitly removed. " "The file must have an access mode of 0600 or less. If this file does not " "exist, the distribution\\[cq]s default root password is set (which usually " "means access to the root user is blocked).\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.passphrase\\f[R] file provides the passphrase to use when " "LUKS encryption is selected. It should contain the passphrase literally, " "and not end in a newline character (i.e.\\ in the same format as cryptsetup " "and \\f[V]/etc/crypttab\\f[R] expect the passphrase files). The file must " "have an access mode of 0600 or less.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.crt\\f[R] and \\f[VB]mkosi.key\\f[R] files contain an X.509 " "certificate and PEM private key to use when signing is required (UEFI " "SecureBoot, verity, \\&...).\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.output/\\f[R] directory is used to store all build " "artifacts.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.credentials/\\f[R] directory is used as a source of extra " "credentials similar to the \\f[V]Credentials=\\f[R] option. For each file " "in the directory, the filename will be used as the credential name and the " "file contents become the credential value, or, if the file is executable, " "mkosi will execute the file and the command\\[cq]s output to stdout will be " "used as the credential value. Output to stderr will be ignored. " "Credentials configured with \\f[V]Credentials=\\f[R] take precedence over " "files in \\f[V]mkosi.credentials\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The \\f[VB]mkosi.repart/\\f[R] directory is used as the source for systemd-" "repart partition definition files which are passed to systemd-repart when " "building a disk image. If it does not exist and the " "\\f[V]RepartDirectories=\\f[R] setting is not configured, mkosi will default " "to the following partition definition files:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]00-esp.conf\\f[R] (if we\\[cq]re building a bootable image):\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "[Partition]\n" "Type=esp\n" "Format=vfat\n" "CopyFiles=/boot:/\n" "CopyFiles=/efi:/\n" "SizeMinBytes=512M\n" "SizeMaxBytes=512M\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]05-bios.conf\\f[R] (if we\\[cq]re building a BIOS bootable image):\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "[Partition]\n" "# UUID of the grub BIOS boot partition which grubs needs on GPT to\n" "# embed itself into.\n" "Type=21686148-6449-6e6f-744e-656564454649\n" "SizeMinBytes=1M\n" "SizeMaxBytes=1M\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]10-root.conf\\f[R]:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "[Partition]\n" "Type=root\n" "Format=Edistribution-default-filesystemE\n" "CopyFiles=/\n" "Minimize=guess\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Note that if either \\f[V]mkosi.repart/\\f[R] is found or " "\\f[V]RepartDirectories=\\f[R] is used, we will not use any of the default " "partition definitions.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Note that the location of all these files may also be configured during " "invocation via command line switches, and as settings in \\f[V]mkosi." "conf\\f[R], in case the default settings are not acceptable for a project." "\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]mkosi\\f[R] supports three different caches for speeding up repetitive " "re-building of images. Specifically:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The package cache of the distribution package manager may be cached between " "builds. This is configured with the \\f[V]--cache-dir=\\f[R] option or the " "\\f[V]mkosi.cache/\\f[R] directory. This form of caching relies on the " "distribution\\[cq]s package manager, and caches distribution packages (RPM, " "DEB, \\&...) after they are downloaded, but before they are unpacked.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If the incremental build mode is enabled with \\f[V]--incremental\\f[R], " "cached copies of the final image and build overlay are made immediately " "before the build sources are copied in (for the build overlay) or the " "artifacts generated by \\f[V]mkosi.build\\f[R] are copied in (in case of the " "final image). This form of caching allows bypassing the time-consuming " "package unpacking step of the distribution package managers, but is only " "effective if the list of packages to use remains stable, but the build " "sources and its scripts change regularly. Note that this cache requires " "manual flushing: whenever the package list is modified the cached images " "need to be explicitly removed before the next re-build, using the \\f[V]-" "f\\f[R] switch.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Finally, between multiple builds the build artifact directory may be shared, " "using the \\f[V]mkosi.builddir/\\f[R] directory. This directory allows " "build systems such as Meson to reuse already compiled sources from a " "previous built, thus speeding up the build process of a \\f[V]mkosi." "build\\f[R] build script.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The package cache and incremental mode are unconditionally useful. The " "final cache only apply to uses of \\f[V]mkosi\\f[R] with a source tree and " "build script. When all three are enabled together turn-around times for " "complete image builds are minimal, as only changed source files need to be " "recompiled.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "If the \\f[V]mkosi.images/\\f[R] directory exists, mkosi will load " "individual image configurations from it and build each of them. Image " "configurations can be either directories containing mkosi configuration " "files or regular files with the \\f[V].conf\\f[R] extension.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When image configurations are found in \\f[V]mkosi.images/\\f[R], mkosi will " "build the configured images and all of their dependencies (or all of them if " "no images were explicitly configured using \\f[V]Images=\\f[R]). To add " "dependencies between images, the \\f[V]Dependencies=\\f[R] setting can be " "used.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "When images are defined, mkosi will first read the global configuration " "(configuration outside of the \\f[V]mkosi.images/\\f[R] directory), followed " "by the image specific configuration. This means that global configuration " "takes precedence over image specific configuration.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]BaseTrees=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]PackageManagerTrees=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]SkeletonTrees=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]ExtraTrees=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]ToolsTree=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]Initrds=\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "To refer to outputs of a image\\[cq]s dependencies, simply configure any of " "these options with a relative path to the output to use in the output " "directory of the dependency. Or use the \\f[V]%O\\f[R] specifier to refer " "to the output directory.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$MKOSI_LESS\\f[R] overrides options for \\f[V]less\\f[R] when it is " "invoked by \\f[V]mkosi\\f[R] to page output.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "\\f[V]$MKOSI_DNF\\f[R] can be used to override the executable used as " "\\f[V]dnf\\f[R]. This is particularly useful to select between " "\\f[V]dnf\\f[R] and \\f[V]dnf5\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Create and run a raw \\f[I]GPT\\f[R] image with \\f[I]ext4\\f[R], as " "\\f[V]image.raw\\f[R]:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "# mkosi -p systemd --incremental boot\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Create and run a bootable \\f[I]GPT\\f[R] image, as \\f[V]foobar.raw\\f[R]:" "\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "$ mkosi -d fedora -p kernel-core -p systemd -p systemd-boot -p udev -o foobar.raw\n" "# mkosi --output foobar.raw boot\n" "$ mkosi --output foobar.raw qemu\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "# mkosi --distribution fedora --format directory boot\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Create a compressed image \\f[V]image.raw.xz\\f[R] with \\f[I]SSH\\f[R] " "installed and add a checksum file:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "$ mkosi --distribution fedora --format disk --checksum --compress-output --package=openssh-clients\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Inside the source directory of an \\f[V]automake\\f[R]-based project, " "configure \\f[I]mkosi\\f[R] so that simply invoking \\f[V]mkosi\\f[R] " "without any parameters builds an OS image containing a built version of the " "project in its current state:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "$ cat Emkosi.conf EEEOF\n" "[Distribution]\n" "Distribution=fedora\\fR\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C][Output]\n" "Format=disk\\fR\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C][Content]\n" "Packages=kernel,systemd,systemd-udev,openssh-clients,httpd\n" "BuildPackages=make,gcc,libcurl-devel\n" "EOF\n" "$ cat Emkosi.build EEEOF\n" "#!/bin/sh\\fR\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]if [ \\[dq]$container\\[dq] != \\[dq]mkosi\\[dq] ]; then\n" " exec mkosi-chroot \\[dq]$CHROOT_SCRIPT\\[dq] \\[dq]$\\[at]\\[dq]\n" "fi\\fR\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]cd $SRCDIR\n" "\\&./autogen.sh\n" "\\&./configure --prefix=/usr\n" "make -j \\[ga]nproc\\[ga]\n" "make install\n" "EOF\n" "$ chmod +x mkosi.build\n" "# mkosi --incremental boot\n" "# systemd-nspawn -bi image.raw\\fR\n" "\n" msgstr "" #. type: SS #: debian-bookworm debian-unstable #, no-wrap msgid "Different ways to boot with \\f[V]qemu\\fB" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The easiest way to boot a virtual machine is to build an image with the " "required components and let \\f[V]mkosi\\f[R] call \\f[V]qemu\\f[R] with all " "the right options:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "$ mkosi -d fedora \\[rs]\n" " --autologin \\[rs]\n" " -p systemd-udev,systemd-boot,kernel-core \\[rs]\n" " build\n" "$ mkosi -d fedora qemu\n" "\\&...\n" "fedora login: root (automatic login)\n" "[root\\[at]fedora \\[ti]]#\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "The default is to boot with a text console only. In this mode, messages " "from the boot loader, the kernel, and systemd, and later the getty login " "prompt and shell all use the same terminal. It is possible to switch " "between the qemu console and monitor by pressing \\f[V]Ctrl-a c\\f[R]. The " "qemu monitor may for example be used to inject special keys or shut down the " "machine quickly.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "To boot with a graphical window, add \\f[V]--qemu-qui\\f[R]:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "$ mkosi -d fedora --qemu-gui qemu\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "A kernel may be booted directly with \\f[V]mkosi qemu -kernel ... -" "initrd ... -append \\[aq]...\\[aq]\\f[R]. This is a bit faster because no " "boot loader is used, and it is also easier to experiment with different " "kernels and kernel commandlines. Note that despite the name, qemu\\[cq]s " "\\f[V]-append\\f[R] option replaces the default kernel commandline embedded " "in the kernel and any previous \\f[V]-append\\f[R] specifications.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "$ mkosi qemu -kernel mkosi.output/fedora\\[ti]38/image.efi\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "It is also possible to do a \\f[I]direct kernel boot\\f[R] into a boot " "loader, taking advantage of the fact that \\f[V]systemd-boot(7)\\f[R] is a " "valid UEFI binary:\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "$ mkosi qemu -kernel /usr/lib/systemd/boot/efi/systemd-bootx64.efi\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "In this scenario, the kernel is loaded from the ESP in the image by " "\\f[V]systemd-boot\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "# dnf install bubblewrap btrfs-progs apt dosfstools mtools edk2-ovmf e2fsprogs squashfs-tools gnupg python3 tar xfsprogs xz zypper sbsigntools\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "On Debian/Ubuntu it might be necessary to install the \\f[V]ubuntu-" "keyring\\f[R], \\f[V]ubuntu-archive-keyring\\f[R] and/or \\f[V]debian-" "archive-keyring\\f[R] packages explicitly, in addition to \\f[V]apt\\f[R], " "depending on what kind of distribution images you want to build.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "Why does \\f[V]mkosi qemu\\f[R] with KVM not work on Debian/Ubuntu?\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "While other distributions are OK with allowing access to \\f[V]/dev/" "kvm\\f[R], on Debian/Ubuntu this is only allowed for users in the " "\\f[V]kvm\\f[R] group. Because mkosi unshares a user namespace when running " "unprivileged, even if the calling user was in the kvm group, when mkosi " "unshares the user namespace to run unprivileged, it loses access to the " "\\f[V]kvm\\f[R] group and by the time we start \\f[V]qemu\\f[R] we " "don\\[cq]t have access to \\f[V]/dev/kvm\\f[R] anymore. As a workaround, " "you can change the permissions of the device nodes to \\f[V]0666\\f[R] which " "is sufficient to make KVM work unprivileged. To persist these settings " "across reboots, copy \\f[V]/usr/lib/tmpfiles.d/static-nodes-permissions." "conf\\f[R] to \\f[V]/etc/tmpfiles.d/static-nodes-permissions.conf\\f[R] and " "change the mode of \\f[V]/dev/kvm\\f[R] from \\f[V]0660\\f[R] to " "\\f[V]0666\\f[R].\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable #, no-wrap msgid "" "\\f[C]\n" "useradd --create-home --user-group $USER --password \\[dq]$(openssl passwd -stdin -6 E$USER_PASSWORD_FILE)\\[dq]\\fR\n" "\n" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "" "Note that from systemd v256 onwards, if enabled, \\f[V]systemd-homed-" "firstboot.service\\f[R] will prompt to create a regular user on first boot " "if there are no regular users.\\fR" msgstr "" #. type: Plain text #: debian-bookworm debian-unstable msgid "\\f[V]systemd-nspawn(1)\\f[R], \\f[V]dnf(8)\\fR" msgstr "" #. type: Plain text #: debian-unstable #, no-wrap msgid "" "\\f[C]\n" "(⋀ᵢ Matchᵢ) ∧ (⋁ᵢ TriggerMatchᵢ)\\fR\n" "\n" msgstr "" #. type: TH #: fedora-40 mageia-cauldron #, no-wrap msgid "2016-" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] build\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] clean\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] summary\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] shell [command line\\&...]\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] boot [nspawn settings\\&...]\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] qemu\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] ssh\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] serve\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] bump\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] genkey\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]mkosi [options\\&...] help\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "\\f[C]mkosi\\f[R] is a tool for easily building customized OS images. " "It\\[cq]s a fancy wrapper around \\f[C]dnf --installroot\\f[R], " "\\f[C]debootstrap\\f[R], \\f[C]pacstrap\\f[R] and \\f[C]zypper\\f[R] that " "may generate disk images with a number of bells and whistles.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]build\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "This builds the image, based on the settings passed in on the command line " "or read from a \\f[C]mkosi.default\\f[R] file. This verb is the default if " "no verb is explicitly specified. This command must be executed as " "\\f[C]root\\f[R]. Any arguments passed after \\f[C]build\\f[R] are passed " "as arguments to the build script (if there is one).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]clean\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Remove build artifacts generated on a previous build. If combined with " "\\f[C]-f\\f[R], also removes incremental build cache images. If \\f[C]-" "f\\f[R] is specified twice, also removes any package cache.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]summary\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Outputs a human-readable summary of all options used for building an image. " "This will parse the command line and \\f[C]mkosi.default\\f[R] file as it " "would do on \\f[C]build\\f[R], but only output what it is configured for and " "not actually build anything.\\[ga]\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]shell\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "This builds the image if it is not built yet, and then invokes \\f[C]systemd-" "nspawn\\f[R] to acquire an interactive shell prompt in it. If this verb is " "used an optional command line may be specified which is then invoked in " "place of the shell in the container. Combine this with \\f[C]-f\\f[R] in " "order to rebuild the image unconditionally before acquiring the shell, see " "below. This command must be executed as \\f[C]root\\f[R].\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]boot\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Similar to \\f[C]shell\\f[R] but boots the image up using \\f[C]systemd-" "nspawn\\f[R]. If this verb is used an optional command line may be " "specified which is passed as \\[lq]kernel command line\\[rq] to the init " "system in the image.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]qemu\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Similar to \\f[C]boot\\f[R] but uses \\f[C]qemu\\f[R] to boot up the image, " "i.e.\\ instead of container virtualization VM virtualization is used. This " "verb is only supported on images that contain a boot loader, i.e.\\ those " "built with \\f[C]Bootable=yes\\f[R] (see below). This command must be " "executed as \\f[C]root\\f[R] unless the image already exists and \\f[C]-" "f\\f[R] is not specified.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]ssh\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When the image is built with the \\f[C]Ssh=yes\\f[R] option, this command " "connects to a booted (\\f[C]boot\\f[R], \\f[C]qemu\\f[R] verbs) container/VM " "via SSH. Make sure to run \\f[C]mkosi ssh\\f[R] with the same config as " "\\f[C]mkosi build\\f[R] was run with so that it has the necessary " "information available to connect to the running container/VM via SSH.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]serve\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "This builds the image if it is not built yet, and then serves the output " "directory (i.e.\\ usually \\f[C]mkosi.output/\\f[R], see below) via a small " "embedded HTTP server, listening on port 8081. Combine with \\f[C]-f\\f[R] " "in order to rebuild the image unconditionally before serving it. This " "command is useful for testing network based acquisition of OS images, for " "example via \\f[C]machinectl pull-raw \\&...\\f[R] and \\f[C]machinectl pull-" "tar \\&...\\f[R].\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]bump\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Determines the current image version string (as configured with " "\\f[C]ImageVersion=\\f[R]/\\f[C]--image-version=\\f[R]), increases its last " "dot-separated component by one and writes the resulting version string to " "\\f[C]mkosi.version\\f[R]. This is useful for implementing a simple " "versioning scheme: each time this verb is called the version is bumped in " "preparation for the subsequent build. Note that \\f[C]--auto-bump\\f[R]/" "\\f[C]-B\\f[R] may be used to automatically bump the version after each " "successful build.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]genkey\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Generate a pair of SecureBoot keys for usage with the " "\\f[C]SecureBootKey=\\f[R]/\\f[C]--secure-boot-key=\\f[R] and " "\\f[C]SecureBootCertificate=\\f[R]/\\f[C]--secure-boot-certificate=\\f[R] " "options.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]help\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "This verb is equivalent to the \\f[C]--help\\f[R] switch documented below: " "it shows a brief usage explanation.\\fR" msgstr "" #. type: SS #: fedora-40 mageia-cauldron #, no-wrap msgid "Execution flow" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Execution flow for \\f[C]mkosi build\\f[R]. Columns represent the execution " "context. Default values/calls are shown in parentheses. When building with " "\\f[C]--incremental\\f[R] mkosi creates a cache of the distribution " "installation for both images if not already existing and replaces the " "distribution installation in consecutive runs with data from the cached one." "\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" " HOST . BUILD . FINAL\n" " . IMAGE . IMAGE\n" " . .\n" " start . .\n" " | . .\n" " v . .\n" "build script? -------exists-----E copy .\n" " | . skeleton trees .\n" " | . (mkosi.skeleton/) .\n" " none . | .\n" " | . v .\n" " v . install .\n" " skip . distribution, .\n" " build image . packages and .\n" " | . build packages, .\n" " | . run .\n" " | . prepare script .\n" " | . (mkosi.prepare build) .\n" " | . or if incremental .\n" " | . use cached build image .\n" " | . | .\n" " | . v .\n" " | . copy .\n" " | . build sources .\n" " | . (./) .\n" " | . | .\n" " | . v .\n" " | . copy .\n" " | . extra trees .\n" " | . (mkosi.extra/) .\n" " | . | .\n" " | . v .\n" " | . run .\n" " | . postinstall script .\n" " | . (mkosi.postinst build) .\n" " | . | .\n" " | .-------------------------\\[aq] .\n" " | | . .\n" " | v . .\n" " | run . .\n" " | finalize script . .\n" " |(mkosi.finalize build). .\n" " | | . .\n" " | \\[aq]-------------------------. .\n" " | . | .\n" " | . v .\n" " | . run .\n" " | . build script .\n" " | . (mkosi.build) .\n" " | . | .\n" " \\[aq]-----------------------------------+------------------------.\n" " . . |\n" " . . v\n" " . . copy\n" " . . skeleton trees\n" " . . (mkosi.skeleton/)\n" " . . |\n" " . . v\n" " . . install\n" " . . distribution\n" " . . and packages,\n" " . . run\n" " . . prepare script\n" " . . (mkosi.prepare final)\n" " . . or if incremental\n" " . . use cached final image\n" " . . |\n" " . . v\n" " . . copy\n" " . . build results\n" " . . |\n" " . . v\n" " . . copy\n" " . . extra trees\n" " . . (mkosi.extra/)\n" " . . |\n" " . . v\n" " . . run\n" " . . postinstall script\n" " . . (mkosi.postinst final)\n" " . . |\n" " . . v\n" " . . |\n" " . . perform cleanup\n" " . . (remove files, packages,\n" " . . package metadata)\n" " . . |\n" " .--------------------------------------------------\\[aq]\n" " | . .\n" " v . .\n" " run . .\n" " finalize script . .\n" " (mkosi.finalize final) . .\n" " | . .\n" " .---------\\[aq] . .\n" " | . .\n" " v . .\n" " end . .\n" " . .\n" " HOST . BUILD . FINAL\n" " . IMAGE . IMAGE\n" " . .\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Raw \\f[I]GPT\\f[R] disk image, with ext4 as root (\\f[I]gpt_ext4\\f[R])\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Raw \\f[I]GPT\\f[R] disk image, with xfs as root (\\f[I]gpt_xfs\\f[R])\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Raw \\f[I]GPT\\f[R] disk image, with btrfs as root " "(\\f[I]gpt_btrfs\\f[R])\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Raw \\f[I]GPT\\f[R] disk image, with squashfs as read-only root " "(\\f[I]gpt_squashfs\\f[R])\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Plain squashfs image, without partition table, as read-only root " "(\\f[I]plain_squashfs\\f[R])\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "btrfs subvolume, with separate subvolumes for \\f[C]/var\\f[R], \\f[C]/" "home\\f[R], \\f[C]/srv\\f[R], \\f[C]/var/tmp\\f[R] " "(\\f[I]subvolume\\f[R])\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "CPIO archive (\\f[I]cpio\\f[R]) in the format appropriate for a kernel " "initrd\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When a \\f[I]GPT\\f[R] disk image is created, the following additional " "options are available:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "A swap partition may be added in" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The image may be made bootable on \\f[I]EFI\\f[R] and \\f[I]BIOS\\f[R] " "systems\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Separate partitions for \\f[C]/srv\\f[R] and \\f[C]/home\\f[R] may be added " "in\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The root, \\f[C]/srv\\f[R] and \\f[C]/home\\f[R] partitions may optionally " "be encrypted with LUKS.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "A dm-verity partition may be added in that adds runtime integrity data for " "the root partition" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The following settings can be set through configuration files (the syntax " "with \\f[C]SomeSetting=value\\f[R]) and on the command line (the syntax with " "\\f[C]--some-setting=value\\f[R]). For some command line parameters, a " "single-letter shortcut is also allowed. In the configuration files, the " "setting must be in the appropriate section, so the settings are grouped by " "section below.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Command line options that take no argument are shown without \\[lq]=\\[rq] " "in their long version. In the config files, they should be specified with a " "boolean argument: either \\[lq]1\\[rq], \\[lq]yes\\[rq], or \\[lq]true\\[rq] " "to enable, or \\[lq]0\\[rq], \\[lq]no\\[rq], \\[lq]false\\[rq] to disable." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Distribution=\\f[R], \\f[CB]--distribution=\\f[R], \\f[CB]-d\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The distribution to install in the image. Takes one of the following " "arguments: \\f[C]fedora\\f[R], \\f[C]debian\\f[R], \\f[C]ubuntu\\f[R], " "\\f[C]arch\\f[R], \\f[C]opensuse\\f[R], \\f[C]mageia\\f[R], " "\\f[C]centos\\f[R], \\f[C]centos_epel\\f[R], \\f[C]clear\\f[R], " "\\f[C]photon\\f[R], \\f[C]openmandriva\\f[R], \\f[C]rocky\\f[R], " "\\f[C]rocky_epel\\f[R], \\f[C]alma\\f[R], \\f[C]alma_epel\\f[R]. If not " "specified, defaults to the distribution of the host.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Release=\\f[R], \\f[CB]--release=\\f[R], \\f[CB]-r\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The release of the distribution to install in the image. The precise syntax " "of the argument this takes depends on the distribution used, and is either a " "numeric string (in case of Fedora Linux, CentOS, \\&..., e.g.\\ " "\\f[C]29\\f[R]), or a distribution version name (in case of Debian, Ubuntu, " "\\&..., e.g.\\ \\f[C]artful\\f[R]). If neither this option, nor " "\\f[C]Distribution=\\f[R] is specified, defaults to the distribution version " "of the host. If the distribution is specified, defaults to a recent version " "of it.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Mirror=\\f[R], \\f[CB]--mirror=\\f[R], \\f[CB]-m\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The mirror to use for downloading the distribution packages. Expects a " "mirror URL as argument." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Repositories=\\f[R], \\f[CB]--repositories=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Additional package repositories to use during installation. Expects one or " "more URLs as argument, separated by commas. This option may be used " "multiple times, in which case the list of repositories to use is combined. " "Use \\[lq]!*\\[rq] to remove all repositories from to the list or use e.g.\\ " "\\[lq]!repo-url\\[rq] to remove just one specific repository. For Arch " "Linux, additional repositories must be passed in the form " "\\f[C]EnameE::EurlE\\f[R] (e.g.\\ \\f[C]myrepo::https://" "myrepo.net\\f[R]).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]UseHostRepositories=\\f[R], \\f[CB]--use-host-repositories\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "This option is only applicable for RPM-based distributions: " "\\f[I]CentOS\\f[R], \\f[I]Fedora Linux\\f[R], \\f[I]Mageia\\f[R], " "\\f[I]Photon\\f[R], \\f[I]Rocky Linux\\f[R], \\f[I]Alma Linux\\f[R] and " "\\f[I]OpenMandriva\\f[R]. Allows use of the host\\[cq]s existing RPM " "repositories. By default, a hardcoded set of default RPM repositories is " "generated and used. Use \\f[C]--repositories=\\f[R] to identify a custom " "set of repositories to be enabled and used for the build.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]RepositoryDirectory\\f[R], \\f[CB]--repository-directory\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "This option can (for now) only be used with RPM-based istributions and Arch " "Linux. It identifies a directory containing extra repository definitions " "that will be used when installing packages. The files are passed directly " "to the corresponding package manager and should be written in the format " "expected by the package manager of the image\\[cq]s distro." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Architecture=\\f[R], \\f[CB]--architecture=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The architecture to build the image for. Note that this currently only " "works for architectures compatible with the host\\[cq]s architecture." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Format=\\f[R], \\f[CB]--format=\\f[R], \\f[CB]-t\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The image format type to generate. One of \\f[C]directory\\f[R] (for " "generating OS images inside a local directory), \\f[C]subvolume\\f[R] " "(similar, but as a btrfs subvolume), \\f[C]tar\\f[R] (similar, but a tarball " "of the image is generated), \\f[C]cpio\\f[R] (similar, but a cpio archive is " "generated), \\f[C]gpt_ext4\\f[R] (a block device image with an ext4 file " "system inside a GPT partition table), \\f[C]gpt_xfs\\f[R] (similar, but with " "an xfs file system), \\f[C]gpt_btrfs\\f[R] (similar, but with an btrfs file " "system), \\f[C]gpt_squashfs\\f[R] (similar, but with a squashfs file " "system), \\f[C]plain_squashfs\\f[R] (a plain squashfs file system without a " "partition table).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]ManifestFormat=\\f[R], \\f[CB]--manifest-format=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The manifest format type or types to generate. A comma-delimited list " "consisting of \\f[C]json\\f[R] (the standard JSON output format that " "describes the packages installed), \\f[C]changelog\\f[R] (a human-readable " "text format designed for diffing). Defaults to \\f[C]json\\f[R].\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Output=\\f[R], \\f[CB]--output=\\f[R], \\f[CB]-o\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Path for the output image file to generate. Takes a relative or absolute " "path where the generated image will be placed. If neither this option nor " "\\f[C]OutputDirectory=\\f[R] is used, the image is generated under the name " "\\f[C]image\\f[R], but its name suffixed with an appropriate file suffix (e." "g.\\ \\f[C]image.raw.xz\\f[R] in case \\f[C]gpt_ext4\\f[R] is used in " "combination with \\f[C]xz\\f[R] compression). If the \\f[C]ImageId=\\f[R] " "option is configured it is used instead of \\f[C]image\\f[R] in the default " "output name. If an image version is specified via " "\\f[C]ImageVersion=\\f[R], it is included in the default name, e.g.\\ a " "specified image version of \\f[C]7.8\\f[R] might result in an image file " "name of \\f[C]image_7.8.raw.xz\\f[R].\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]OutputSplitRoot=\\f[R], \\f[CB]--output-split-root=\\f[R], \\f[CB]OutputSplitVerify=\\f[R], \\f[CB]--output-split-verity=\\f[R], \\f[CB]OutputSplitKernel=\\f[R], \\f[CB]--output-split-kernel=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Paths for the split-out output image files, when " "\\f[C]SplitArtifacts=yes\\f[R] is used. If unspecified, the relevant split " "artifact files will be named like the main image, but with \\f[C]." "root\\f[R], \\f[C].verity\\f[R], and \\f[C].efi\\f[R] suffixes inserted (and " "in turn possibly suffixed by compression suffix, if compression is enabled)." "\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]OutputDirectory=\\f[R], \\f[CB]--output-dir=\\f[R], \\f[CB]-O\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Path to a directory where to place all generated artifacts (i.e.\\ the " "generated image when an output path is not given, \\f[C]SHA256SUMS\\f[R] " "file, etc.). If this is not specified and the directory \\f[C]mkosi.output/" "\\f[R] exists in the local directory, it is automatically used for this " "purpose. If the setting is not used and \\f[C]mkosi.output/\\f[R] does not " "exist, all output artifacts are placed adjacent to the output image file.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]WorkspaceDirectory=\\f[R], \\f[CB]--workspace-dir=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Path to a directory where to store data required temporarily while building " "the image. This directory should have enough space to store the full OS " "image, though in most modes the actually used disk space is smaller. If not " "specified, and \\f[C]mkosi.workspace/\\f[R] exists in the local directory, " "it is used for this purpose. Otherwise, a subdirectory in the temporary " "storage area is used (\\f[C]$TMPDIR\\f[R] if set, \\f[C]/var/tmp/\\f[R] " "otherwise). The data in this directory is removed automatically after each " "build. It\\[cq]s safe to manually remove the contents of this directory " "should an \\f[C]mkosi\\f[R] invocation be aborted abnormally (for example, " "due to reboot/power failure). If the \\f[C]btrfs\\f[R] output modes are " "selected this directory must be backed by \\f[C]btrfs\\f[R] too.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Force=\\f[R], \\f[CB]--force\\f[R], \\f[CB]-f\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Replace the output file if it already exists, when building an image. By " "default when building an image and an output artifact already exists " "\\f[C]mkosi\\f[R] will refuse operation. Specify this option once to delete " "all build artifacts from a previous run before re-building the image. If " "incremental builds are enabled, specifying this option twice will ensure the " "intermediary cache files are removed, too, before the re-build is " "initiated. If a package cache is used (also see the \\[lq]Files\\[rq] " "section below), specifying this option thrice will ensure the package cache " "is removed too, before the re-build is initiated. For the \\f[C]clean\\f[R] " "operation this option has a slightly different effect: by default the verb " "will only remove build artifacts from a previous run, when specified once " "the incremental cache files are deleted too, and when specified twice the " "package cache is also removed.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]GPTFirstLBA=\\f[R], \\f[CB]--gpt-first-lba=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Override the first usable LBA (Logical Block Address) within the GPT " "header. This defaults to \\f[C]2048\\f[R], which is actually the desired " "value. However, some tools, e.g.\\ the \\f[C]prl_disk_tool\\f[R] utility " "from the Parallels virtualization suite require this to be set to " "\\f[C]34\\f[R], otherwise they might fail to resize the disk image and/or " "partitions inside it.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Bootable=\\f[R], \\f[CB]--bootable\\f[R], \\f[CB]-b\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Generate a bootable image. By default this will generate an image bootable " "on UEFI systems. Use \\f[C]BootProtocols=\\f[R] to select support for a " "different boot protocol.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]BootProtocols=\\f[R], \\f[CB]--boot-protocols=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Pick one or more boot protocols to support when generating a bootable image, " "as enabled with \\f[C]Bootable=\\f[R]. Takes a comma-separated list of " "\\f[C]uefi\\f[R] or \\f[C]bios\\f[R]. May be specified more than once in " "which case the specified lists are merged. If \\f[C]uefi\\f[R] is specified " "the \\f[C]sd-boot\\f[R] UEFI boot loader is used, if \\f[C]bios\\f[R] is " "specified the GNU Grub boot loader is used. Use \\[lq]!*\\[rq] to remove " "all previously added protocols or \\[lq]!protocol\\[rq] to remove one " "protocol.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]KernelCommandLine=\\f[R], \\f[CB]--kernel-command-line=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Use the specified kernel command line when building bootable images. By " "default command line arguments get appended. To remove all arguments from " "the current list pass \\[lq]!*\\[rq]. To remove specific arguments add a " "space separated list of \\[lq]!\\[rq] prefixed arguments. For example " "adding \\[lq]!* console=ttyS0 rw\\[rq] to a \\f[C]mkosi.default\\f[R] file " "or the command line arguments passes \\[lq]console=ttyS0 rw\\[rq] to the " "kernel in any case. Just adding \\[lq]console=ttyS0 rw\\[rq] would append " "these two arguments to the kernel command line created by lower priority " "configuration files or previous \\f[C]KernelCommandLine=\\f[R] command line " "arguments.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SecureBoot=\\f[R], \\f[CB]--secure-boot\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "Sign the resulting kernel/initrd image for UEFI SecureBoot." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SecureBootKey=\\f[R], \\f[CB]--secure-boot-key=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Path to the PEM file containing the secret key for signing the UEFI kernel " "image, if \\f[C]SecureBoot=\\f[R] is used.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SecureBootCertificate=\\f[R], \\f[CB]--secure-boot-certificate=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Path to the X.509 file containing the certificate for the signed UEFI kernel " "image, if \\f[C]SecureBoot=\\f[R] is used.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SecureBootCommonName=\\f[R], \\f[CB]--secure-boot-common-name=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Common name to be used when generating SecureBoot keys via mkosi\\[cq]s " "\\f[C]genkey\\f[R] command. Defaults to \\f[C]mkosi of %u\\f[R], where " "\\f[C]%u\\f[R] expands to the username of the user invoking mkosi.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SecureBootValidDays=\\f[R], \\f[CB]--secure-boot-valid-days=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Number of days that the keys should remain valid when generating SecureBoot " "keys via mkosi\\[cq]s \\f[C]genkey\\f[R] command. Defaults to two years " "(730 days).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]ReadOnly=\\f[R], \\f[CB]--read-only\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Set the read-only flag on the root partition in the partition table. Only " "applies to \\f[C]gpt_ext4\\f[R], \\f[C]gpt_xfs\\f[R], \\f[C]gpt_btrfs\\f[R], " "\\f[C]subvolume\\f[R] output formats, and is implied on " "\\f[C]gpt_squashfs\\f[R] and \\f[C]plain_squashfs\\f[R]. The read-only flag " "is essentially a hint to tools using the image (see https://systemd.io/" "DISCOVERABLE_PARTITIONS/). In particular, all systemd tools like " "\\f[C]systemd-nspawn\\f[R] and \\f[C]systemd-gpt-auto-generator\\f[R] will " "mount such partitions read-only, but tools from other project may ignore the " "flag.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Minimize=\\f[R], \\f[CB]--minimize\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Attempt to make the resulting root file system as small as possible by " "removing free space from the file system. Only supported for " "\\f[C]gpt_ext4\\f[R] and \\f[C]gpt_btrfs\\f[R]. For ext4 this relies on " "\\f[C]resize2fs -M\\f[R], which reduces the free disk space but is not " "perfect and generally leaves some free space. For btrfs the results are " "optimal and no free space is left.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Encrypt=\\f[R], \\f[CB]--encrypt\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Encrypt all partitions in the file system or just the root file system. " "Takes either \\f[C]all\\f[R] or \\f[C]data\\f[R] as argument. If " "\\f[C]all\\f[R], the root, \\f[C]/home\\f[R] and \\f[C]/srv\\f[R] file " "systems will be encrypted using dm-crypt/LUKS (with its default settings). " "If \\f[C]data\\f[R], the root file system will be left unencrypted, but " "\\f[C]/home\\f[R] and \\f[C]/srv\\f[R] will be encrypted. The passphrase to " "use is read from the \\f[C]mkosi.passphrase\\f[R] file in the current " "working directory. Note that the UEFI System Partition (ESP) containing the " "boot loader and kernel to boot is never encrypted since it needs to be " "accessible by the firmware.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Verity=\\f[R], \\f[CB]--verity\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Add a \\[lq]Verity\\[rq] integrity partition to the image. Takes a boolean " "or the special value \\f[C]signed\\f[R], and defaults to disabled. If " "enabled, the root partition (or \\f[C]/usr/\\f[R] partition, in case " "\\f[C]UsrOnly=\\f[R] is enabled) is protected with \\f[C]dm-verity\\f[R] " "against offline modification, the verification data is placed in an " "additional GPT partition. Implies \\f[C]ReadOnly=yes\\f[R]. If this is " "enabled, the Verity root hash is written to an output file with \\f[C]." "roothash\\f[R] or \\f[C].usrhash\\f[R] suffix. If set to " "\\f[C]signed\\f[R], Verity is also enabled, but the resulting root hash is " "then also signed (in PKCS#7 format) with the signature key configured with " "\\f[C]SecureBootKey=\\f[R]. Or in other words: the SecureBoot key pair is " "then used to both sign the kernel, if that is enabled, and the root/\\f[C]/" "usr/\\f[R] file system. This signature is then stored in an additional " "output file with the \\f[C].roothash.p7s\\f[R] or \\f[C].usrhash.p7s\\f[R] " "suffix in DER format. It is also written to an additional partition in the " "image. The latter allows generating self-contained signed disk images, " "implementing the Verity provisions described in the Discoverable Partitions " "Specification (https://systemd.io/DISCOVERABLE_PARTITIONS).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]CompressFs=\\f[R], \\f[CB]--compress-fs=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Enable or disable internal compression in the file system. Only applies to " "output formats with squashfs or btrfs. Takes one of \\f[C]zlib\\f[R], " "\\f[C]lzo\\f[R], \\f[C]zstd\\f[R], \\f[C]lz4\\f[R], \\f[C]xz\\f[R] or a " "boolean value as argument. If the latter is used compression is enabled/" "disabled and the default algorithm is used. In case of the " "\\f[C]squashfs\\f[R] output formats compression is implied, but this option " "may be used to select the algorithm.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]CompressOutput=\\f[R], \\f[CB]--compress-output=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Configure compression for the resulting image or archive. The argument can " "be either a boolean or a compression algorithm (\\f[C]xz\\f[R], " "\\f[C]zstd\\f[R]). \\f[C]xz\\f[R] compression is used by default. Note " "that when applied to block device image types this means the image cannot be " "started directly but needs to be decompressed first. This also means that " "the \\f[C]shell\\f[R], \\f[C]boot\\f[R], \\f[C]qemu\\f[R] verbs are not " "available when this option is used. Implied for \\f[C]tar\\f[R] and " "\\f[C]cpio\\f[R].\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Compress=\\f[R], \\f[CB]--compress=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Enable compression. Using this option is equivalent to either " "\\f[C]CompressFs=\\f[R] or \\f[C]CompressOutput=\\f[R]; the appropriate type " "of compression is selected automatically.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Mksquashfs=\\f[R], \\f[CB]--mksquashfs=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Set the path to the \\f[C]mksquashfs\\f[R] executable to use. This is " "useful in case the parameters for the tool shall be augmented, as the tool " "may be replaced by a script invoking it with the right parameters, this way." "\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]QCow2=\\f[R], \\f[CB]--qcow2\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Encode the resulting image as QEMU QCOW2 image. This only applies to " "\\f[C]gpt_ext4\\f[R], \\f[C]gpt_xfs\\f[R], \\f[C]gpt_btrfs\\f[R], " "\\f[C]gpt_squashfs\\f[R]. QCOW2 images can be read natively by " "\\f[C]qemu\\f[R], but not by the Linux kernel. This means the " "\\f[C]shell\\f[R] and \\f[C]boot\\f[R] verbs are not available when this " "option is used, however \\f[C]qemu\\f[R] will work.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Hostname=\\f[R], \\f[CB]--hostname=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "Set the image\\[cq]s hostname to the specified name." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]ImageVersion=\\f[R], \\f[CB]--image-version=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Configure the image version. This accepts any string, but it is recommended " "to specify a series of dot separated components. The version may also be " "configured in a file \\f[C]mkosi.version\\f[R] in which case it may be " "conveniently managed via the \\f[C]bump\\f[R] verb or the \\f[C]--auto-" "bump\\f[R] switch. When specified the image version is included in the " "default output file name, i.e.\\ instead of \\f[C]image.raw\\f[R] the " "default will be \\f[C]image_0.1.raw\\f[R] for version \\f[C]0.1\\f[R] of the " "image, and similar. The version is also passed via the " "\\f[C]$IMAGE_VERSION\\f[R] to any build scripts invoked (which may be useful " "to patch it into \\f[C]/etc/os-release\\f[R] or similar, in particular the " "\\f[C]IMAGE_VERSION=\\f[R] field of it).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]ImageId=\\f[R], \\f[CB]--image-id=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Configure the image identifier. This accepts a freeform string that shall " "be used to identify the image with. If set the default output file will be " "named after it (possibly suffixed with the version). If this option is used " "the root, \\f[C]/usr/\\f[R] and Verity partitions in the image will have " "their labels set to this (possibly suffixed by the image version). The " "identifier is also passed via the \\f[C]$IMAGE_ID\\f[R] to any build scripts " "invoked (which may be useful to patch it into \\f[C]/etc/os-release\\f[R] or " "similar, in particular the \\f[C]IMAGE_ID=\\f[R] field of it).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]WithUnifiedKernelImages=\\f[R], \\f[CB]--without-unified-kernel-images\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If specified, mkosi does not build unified kernel images and instead " "installs kernels with a separate initrd and boot loader config to the efi or " "bootloader partition." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]HostonlyInitrd=\\f[R], \\f[CB]--hostonly-initrd\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If specified, mkosi will run the tool to create the initrd such that a non-" "generic initrd is created that will only be able to run on the system mkosi " "is run on. Currently mkosi uses dracut for all supported distributions " "except Clear Linux and this option translates to enabling dracut\\[cq]s " "hostonly option." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]UsrOnly=\\f[R], \\f[CB]--usr-only\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If specified, \\f[C]mkosi\\f[R] will only add the \\f[C]/usr/\\f[R] " "directory tree (instead of the whole root file system) to the image. This " "is useful for fully stateless systems that come up pristine on every single " "boot, where \\f[C]/etc/\\f[R] and \\f[C]/var/\\f[R] are populated by " "\\f[C]systemd-tmpfiles\\f[R]/\\f[C]systemd-sysusers\\f[R] and related calls, " "or systems that are originally shipped without a root file system, but where " "\\f[C]systemd-repart\\f[R] adds one on the first boot.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SplitArtifacts=\\f[R], \\f[CB]--split-artifacts\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If specified and building an image with a partition table, also write out " "the root file system partition, its Verity partition (if configured) and " "the generated unified kernel (if configured) into separate output files. " "This is useful in A/B update scenarios where an existing disk image shall be " "augmented with a new version of a root or \\f[C]/usr\\f[R] partition along " "with its Verity partition and unified kernel.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]NoChown=\\f[R], \\f[CB]--no-chown\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "By default, if \\f[C]mkosi\\f[R] is run inside a \\f[C]sudo\\f[R] " "environment all generated artifacts have their UNIX user/group ownership " "changed to the user which invoked \\f[C]sudo\\f[R]. With this option this " "may be turned off and all generated files are owned by \\f[C]root\\f[R].\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]TarStripSELinuxContext=\\f[R], \\f[CB]--tar-strip-selinux-context\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If running on a SELinux-enabled system (Fedora Linux, CentOS, Rocky Linux, " "Alma Linux), files inside the container are tagged with SELinux context " "extended attributes (\\f[C]xattrs\\f[R]), which may interfere with host " "SELinux rules in building or further container import stages. This option " "strips SELinux context attributes from the resulting tar archive.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]MachineID=\\f[R], \\f[CB]--machine-id\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Set the machine\\[cq]s ID to the specified value. If unused, a random ID " "will be used while building the image and the final image will be shipped " "without a machine ID." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]BasePackages=\\f[R], \\f[CB]--base-packages\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a boolean or the special value \\f[C]conditional\\f[R]. If true, " "automatically install packages to ensure basic functionality, as appropriate " "for the given image type. For example, \\f[C]systemd\\f[R] is always " "included, \\f[C]systemd-udev\\f[R] and \\f[C]dracut\\f[R] if the image is " "bootable, and so on. If false, only packages specified with " "\\f[C]Packages=\\f[R] will be installed. If \\f[C]conditional\\f[R], the " "list of packages to install will be extended with boolean dependencies (c." "f. https://rpm.org/user_doc/boolean_dependencies.html), to install specific " "packages when \\f[I]other\\f[R] packages are in the list. For example, " "\\f[C]systemd-udev\\f[R] may be automatically included if the image is " "bootable and \\f[C]systemd\\f[R] is installed. With this, various " "\\[lq]base\\[rq] packages still need to be specified if they should be " "included, but the corresponding \\[lq]extension\\[rq] packages will be added " "automatically when appropriate. This feature depends on support in the " "package manager, so it is not implemented for all distributions.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Packages=\\f[R], \\f[CB]--package=\\f[R], \\f[CB]-p\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Install the specified distribution packages (i.e.\\ RPM, DEB, \\&...) in the " "image. Takes a comma separated list of package specifications. This option " "may be used multiple times in which case the specified package lists are " "combined. Packages specified this way will be installed both in the " "development and the final image. Use \\f[C]BuildPackages=\\f[R] to specify " "packages that shall only be used for the image generated in the build image, " "but that shall not appear in the final image. The types and syntax of " "\\[lq]package specifications\\[rq] that are allowed depend on the package " "installer (e.g.\\ \\f[C]dnf\\f[R] or \\f[C]yum\\f[R] for \\f[C]rpm\\f[R]-" "based distros or \\f[C]apt\\f[R] for \\f[C]deb\\f[R]-based distros), but may " "include package names, package names with version and/or architecture, " "package name globs, paths to packages in the file system, package groups, " "and virtual provides, including file paths. To remove a package e.g.\\ " "added by a \\f[C]mkosi.default\\f[R] configuration file prepend the package " "name with \\f[C]!\\f[R]. For example -p \\[lq]!apache2\\[rq] would remove " "the apache2 package. To replace the apache2 package by the httpd package " "just add -p \\[lq]!apache2,httpd\\[rq] to the command line arguments. To " "remove all packages use \\[lq]!*\\[rq]. Example: when using an distro that " "uses \\f[C]dnf\\f[R], \\f[C]Packages=meson libfdisk-devel.i686 git-* " "prebuilt/rpms/systemd-249-rc1.local.rpm /usr/bin/ld \\[at]development-tools " "python3dist(mypy)\\f[R] would install the \\f[C]meson\\f[R] package (in the " "latest version), the 32-bit version of the \\f[C]libfdisk-devel\\f[R] " "package, all available packages that start with the \\f[C]git-\\f[R] prefix, " "a \\f[C]systemd\\f[R] rpm from the local file system, one of the packages " "that provides \\f[C]/usr/bin/ld\\f[R], the packages in the \\[lq]Development " "Tools\\[rq] group, and the package that contains the \\f[C]mypy\\f[R] python " "module.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]WithDocs=\\f[R], \\f[CB]--with-docs\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Include documentation in the image built. By default if the underlying " "distribution package manager supports it documentation is not included in " "the image built. The \\f[C]$WITH_DOCS\\f[R] environment variable passed to " "the \\f[C]mkosi.build\\f[R] script indicates whether this option was used or " "not.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]WithTests=\\f[R], \\f[CB]--without-tests\\f[R], \\f[CB]-T\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If set to false (or when the command-line option is used), the " "\\f[C]$WITH_TESTS\\f[R] environment variable is set to \\f[C]0\\f[R] when " "the \\f[C]mkosi.build\\f[R] script is invoked. This is supposed to be used " "by the build script to bypass any unit or integration tests that are " "normally run during the source build process. Note that this option has no " "effect unless the \\f[C]mkosi.build\\f[R] build script honors it.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Cache=\\f[R], \\f[CB]--cache=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path to a directory to use as package cache for the distribution " "package manager used. If this option is not used, but a \\f[C]mkosi.cache/" "\\f[R] directory is found in the local directory it is automatically used " "for this purpose. The directory configured this way is mounted into both " "the development and the final image while the package manager is running.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SkeletonTree=\\f[R], \\f[CB]--skeleton-tree=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path to a directory to copy into the OS tree before invoking the " "package manager. Use this to insert files and directories into the OS tree " "before the package manager installs any packages. If this option is not " "used, but the \\f[C]mkosi.skeleton/\\f[R] directory is found in the local " "directory it is automatically used for this purpose (also see the " "\\[lq]Files\\[rq] section below). Instead of a directory, a tar file may be " "provided. In this case it is unpacked into the OS tree before the package " "manager is invoked. This mode of operation allows setting permissions and " "file ownership explicitly, in particular for projects stored in a version " "control system such as \\f[C]git\\f[R] which retain full file ownership and " "access mode metadata for committed files. If the tar file \\f[C]mkosi." "skeleton.tar\\f[R] is found in the local directory it will be automatically " "used for this purpose.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]ExtraTree=\\f[R], \\f[CB]--extra-tree=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path to a directory to copy on top of the OS tree the package " "manager generated. Use this to override any default configuration files " "shipped with the distribution. If this option is not used, but the " "\\f[C]mkosi.extra/\\f[R] directory is found in the local directory it is " "automatically used for this purpose (also see the \\[lq]Files\\[rq] section " "below). As with the skeleton tree logic above, instead of a directory, a " "tar file may be provided too. \\f[C]mkosi.skeleton.tar\\f[R] will be " "automatically used if found in the local directory.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]CleanPackageMetadata=\\f[R], \\f[CB]--clean-package-metadata=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Enable/disable removal of package manager databases, caches, and logs at the " "end of installation. Can be specified as true, false, or " "\\[lq]\\f[C]auto\\f[R]\\[rq] (the default). With " "\\[lq]\\f[C]auto\\f[R]\\[rq], files will be removed if the respective " "package manager executable is \\f[I]not\\f[R] present at the end of the " "installation.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]RemoveFiles=\\f[R], \\f[CB]--remove-files=\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]RemovePackages=\\f[R], \\f[CB]--remove-package=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a comma-separated list of package specifications for removal, in the " "same format as \\f[C]Packages=\\f[R]. The removal will be performed as one " "of the last steps. This step is skipped if " "\\f[C]CleanPackageMetadata=no\\f[R] is used. This option is currently only " "implemented for distributions using \\f[C]dnf\\f[R].\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Environment=\\f[R], \\f[CB]--environment=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Adds variables to the environment that the build/prepare/postinstall/" "finalize scripts are executed with. Takes a space-separated list of " "variable assignments or just variable names. In the latter case, the values " "of those variables will be passed through from the environment in which " "\\f[C]mkosi\\f[R] was invoked. This option may be specified more than once, " "in which case all listed variables will be set. If the same variable is set " "twice, the later setting overrides the earlier one.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]BuildSources=\\f[R], \\f[CB]--build-sources=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path to a source tree to copy into the development image, if the " "build script is used. This only applies if a build script is used, and " "defaults to the local directory. Use \\f[C]SourceFileTransfer=\\f[R] to " "configure how the files are transferred from the host to the container image." "\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]BuildDirectory=\\f[R], \\f[CB]--build-dir=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path of a directory to use as build directory for build systems that " "support out-of-tree builds (such as Meson). The directory used this way is " "shared between repeated builds, and allows the build system to reuse " "artifacts (such as object files, executable, \\&...) generated on previous " "invocations. This directory is mounted into the development image when the " "build script is invoked. The build script can find the path to this " "directory in the \\f[C]$BUILDDIR\\f[R] environment variable. If this option " "is not specified, but a directory \\f[C]mkosi.builddir/\\f[R] exists in the " "local directory it is automatically used for this purpose (also see the " "\\[lq]Files\\[rq] section below).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]IncludeDirectory=\\f[R], \\f[CB]--include-directory=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path of a directory to use as the include directory. This directory " "is mounted at \\f[C]/usr/include\\f[R] when building the build image and " "running the build script. This means all include files installed to \\f[C]/" "usr/include\\f[R] will be stored in this directory. This is useful to make " "include files available on the host system for use by language servers to " "provide code completion. If this option is not specified, but a directory " "\\f[C]mkosi.includedir/\\f[R] exists in the local directory, it is " "automatically used for this purpose (also see the \\[lq]Files\\[rq] section " "below).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]InstallDirectory=\\f[R], \\f[CB]--install-directory=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path of a directory to use as the install directory. The directory " "used this way is shared between builds and allows the build system to not " "have to reinstall files that were already installed by a previous build and " "didn\\[cq]t change. The build script can find the path to this directory in " "the \\f[C]$DESTDIR\\f[R] environment variable. If this option is not " "specified, but a directory \\f[C]mkosi.installdir\\f[R] exists in the local " "directory, it is automatically used for this purpose (also see the " "\\[lq]Files\\[rq] section below).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]BuildPackages=\\f[R], \\f[CB]--build-package=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Similar to \\f[C]Packages=\\f[R], but configures packages to install only in " "the first phase of the build, into the development image. This option " "should be used to list packages containing header files, compilers, build " "systems, linkers and other build tools the \\f[C]mkosi.build\\f[R] script " "requires to operate. Note that packages listed here are only included in " "the image created during the first phase of the build, and are absent in the " "final image. Use \\f[C]Packages=\\f[R] to list packages that shall be " "included in both. Packages are appended to the list. Packages prefixed " "with \\[lq]!\\[rq] are removed from the list. \\[lq]!*\\[rq] removes all " "packages from the list.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Password=\\f[R], \\f[CB]--password=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Set the password of the \\f[C]root\\f[R] user. By default the " "\\f[C]root\\f[R] account is locked. If this option is not used, but a file " "\\f[C]mkosi.rootpw\\f[R] exists in the local directory, the root password is " "automatically read from it.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]PasswordIsHashed=\\f[R], \\f[CB]--password-is-hashed\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Indicate that the password supplied for the \\f[C]root\\f[R] user has " "already been hashed, so that the string supplied with \\f[C]Password=\\f[R] " "or \\f[C]mkosi.rootpw\\f[R] will be written to \\f[C]/etc/shadow\\f[R] " "literally.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Autologin=\\f[R], \\f[CB]--autologin\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Enable autologin for the \\f[C]root\\f[R] user on \\f[C]/dev/pts/0\\f[R] " "(nspawn), \\f[C]/dev/tty1\\f[R] (QEMU) and \\f[C]/dev/ttyS0\\f[R] (QEMU with " "\\f[C]QemuHeadless=yes\\f[R]) by patching \\f[C]/etc/pam.d/login\\f[R].\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SkipFinalPhase=\\f[R], \\f[CB]--skip-final-phase=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Causes the (second) final image build stage to be skipped. This is useful " "in combination with a build script, for when you care about the artifacts " "that were created locally in \\f[C]$BUILDDIR\\f[R], but ultimately plan to " "discard the final image.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]BuildScript=\\f[R], \\f[CB]--build-script=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path to an executable that is used as build script for this image. " "If this option is used the build process will be two-phased instead of " "single-phased. The specified script is copied onto the development image " "and executed inside an \\f[C]systemd-nspawn\\f[R] container environment. If " "this option is not used, but the \\f[C]mkosi.build\\f[R] file found in the " "local directory it is automatically used for this purpose (also see the " "\\[lq]Files\\[rq] section below). Specify an empty value to disable " "automatic detection.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]PrepareScript=\\f[R], \\f[CB]--prepare-script=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path to an executable that is invoked inside the image right after " "installing the software packages. It is the last step before the image is " "cached (if incremental mode is enabled). This script is invoked inside a " "\\f[C]systemd-nspawn\\f[R] container environment, and thus does not have " "access to host resources. If this option is not used, but an executable " "script \\f[C]mkosi.prepare\\f[R] is found in the local directory, it is " "automatically used for this purpose. Specify an empty value to disable " "automatic detection.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]PostInstallationScript=\\f[R], \\f[CB]--postinst-script=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path to an executable that is invoked inside the final image right " "after copying in the build artifacts generated in the first phase of the " "build. This script is invoked inside a \\f[C]systemd-nspawn\\f[R] container " "environment, and thus does not have access to host resources. If this " "option is not used, but an executable \\f[C]mkosi.postinst\\f[R] is found in " "the local directory, it is automatically used for this purpose. Specify an " "empty value to disable automatic detection.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]FinalizeScript=\\f[R], \\f[CB]--finalize-script=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path to an executable that is invoked outside the final image right " "after copying in the build artifacts generated in the first phase of the " "build, and after having executed the \\f[C]mkosi.postinst\\f[R] script (see " "\\f[C]PostInstallationScript=\\f[R]). This script is invoked directly in " "the host environment, and hence has full access to the host\\[cq]s " "resources. If this option is not used, but an executable \\f[C]mkosi." "finalize\\f[R] is found in the local directory, it is automatically used for " "this purpose. Specify an empty value to disable automatic detection.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SourceFileTransfer=\\f[R], \\f[CB]--source-file-transfer=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Configures how the source file tree (as configured with " "\\f[C]BuildSources=\\f[R]) is transferred into the container image during " "the first phase of the build. Takes one of \\f[C]copy-all\\f[R] (to copy " "all files from the source tree), \\f[C]copy-git-cached\\f[R] (to copy only " "those files \\f[C]git ls-files --cached\\f[R] lists), \\f[C]copy-git-" "others\\f[R] (to copy only those files \\f[C]git ls-files --others\\f[R] " "lists), \\f[C]mount\\f[R] to bind mount the source tree directly. Defaults " "to \\f[C]copy-git-cached\\f[R] if a \\f[C]git\\f[R] source tree is detected, " "otherwise \\f[C]copy-all\\f[R]. When you specify \\f[C]copy-git-more\\f[R], " "it is the same as \\f[C]copy-git-cached\\f[R], except it also includes the " "\\f[C].git/\\f[R] directory.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SourceFileTransferFinal=\\f[R], \\f[CB]--source-file-transfer-final=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Same as \\f[C]SourceFileTransfer=\\f[R], but for the final image instead of " "the build image. Takes the same values as \\f[C]SourceFileFransfer=\\f[R] " "except \\f[C]mount\\f[R]. By default, sources are not copied into the final " "image.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SourceResolveSymlinks=\\f[R], \\f[CB]--source-resolve-symlinks\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If given, any symbolic links in the source file tree are resolved and the " "file contents are copied to the build image. If not given, they are left as " "symbolic links. This only applies if \\f[C]SourceFileTransfer=\\f[R] is " "\\f[C]copy-all\\f[R]. Defaults to leaving them as symbolic links.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SourceResolveSymlinksFinal=\\f[R], \\f[CB]--source-resolve-symlinks-final\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Same as \\f[C]SourceResolveSymlinks=\\f[R], but for the final image instead " "of the build image.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]WithNetwork=\\f[R], \\f[CB]--with-network\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When true, enables network connectivity while the build script \\f[C]mkosi." "build\\f[R] is invoked. By default, the build script runs with networking " "turned off. The \\f[C]$WITH_NETWORK\\f[R] environment variable is passed to " "the \\f[C]mkosi.build\\f[R] build script indicating whether the build is " "done with or without network. If specified as \\f[C]never\\f[R], the " "package manager is instructed not to contact the network for updating " "package data. This provides a minimal level of reproducibility, as long as " "the package data cache is already fully populated.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Settings=\\f[R], \\f[CB]--settings=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Specifies a \\f[C].nspawn\\f[R] settings file for \\f[C]systemd-nspawn\\f[R] " "to use in the \\f[C]boot\\f[R] and \\f[C]shell\\f[R] verbs, and to place " "next to the generated image file. This is useful to configure the " "\\f[C]systemd-nspawn\\f[R] environment when the image is run. If this " "setting is not used but an \\f[C]mkosi.nspawn\\f[R] file found in the local " "directory it is automatically used for this purpose.\\fR" msgstr "" #. type: SS #: fedora-40 mageia-cauldron #, no-wrap msgid "[Partitions] Section" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]BaseImage=\\f[R], \\f[CB]--base-image=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Use the specified directory or file system image as the base image, and " "create the output image that consists only of changes from this base. The " "base image is attached as the lower file system in an overlayfs structure, " "and the output filesystem becomes the upper layer, initially empty. Thus " "files that are not modified compared to the base image are not present in " "the output image. This option may be used to create systemd \\[lq]system " "extensions\\[rq] or portable services. See https://systemd.io/" "PORTABLE_SERVICES/#extension-images for more information." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]RootSize=\\f[R], \\f[CB]--root-size=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a size in bytes for the root file system. The specified numeric value " "may be suffixed with \\f[C]K\\f[R], \\f[C]M\\f[R], \\f[C]G\\f[R] to indicate " "kilo-, mega- and gigabytes (all to the base of 1024). This applies to " "output formats \\f[C]gpt_ext4\\f[R], \\f[C]gpt_xfs\\f[R], " "\\f[C]gpt_btrfs\\f[R]. Defaults to 3G.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]ESPSize=\\f[R], \\f[CB]--esp-size=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Similar to \\f[C]RootSize=\\f[R], configures the size of the UEFI System " "Partition (ESP). This is only relevant if the \\f[C]Bootable=\\f[R] option " "is used to generate a bootable image. Defaults to 256 MB.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SwapSize=\\f[R], \\f[CB]--swap-size=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Similar to \\f[C]RootSize=\\f[R], configures the size of a swap partition on " "the image. If omitted, no swap partition is created.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]HomeSize=\\f[R], \\f[CB]--home-size=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Similar to \\f[C]RootSize=\\f[R], configures the size of the \\f[C]/" "home\\f[R] partition. If omitted, no separate \\f[C]/home\\f[R] partition " "is created.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SrvSize=\\f[R], \\f[CB]--srv-size=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Similar to \\f[C]RootSize=\\f[R], configures the size of the \\f[C]/" "srv\\f[R] partition. If omitted, no separate \\f[C]/srv\\f[R] partition is " "created.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Checksum=\\f[R], \\f[CB]--checksum\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Generate a \\f[C]SHA256SUMS\\f[R] file of all generated artifacts after the " "build is complete.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Sign=\\f[R], \\f[CB]--sign\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Sign the generated \\f[C]SHA256SUMS\\f[R] using \\f[C]gpg\\f[R] after " "completion.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Key=\\f[R], \\f[CB]--key=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Select the \\f[C]gpg\\f[R] key to use for signing \\f[C]SHA256SUMS\\f[R]. " "This key must be already present in the \\f[C]gpg\\f[R] keyring.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]BMap=\\f[R], \\f[CB]--bmap\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Generate a \\f[C]bmap\\f[R] file for usage with \\f[C]bmaptool\\f[R] from " "the generated image file.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]ExtraSearchPaths=\\f[R], \\f[CB]--extra-search-paths=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "List of colon-separated paths to look for tools in, before using the regular " "\\f[C]$PATH\\f[R] search path.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]QemuHeadless=\\f[R], \\f[CB]--qemu-headless=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When used with the \\f[C]build\\f[R] verb, this option adds " "\\f[C]console=ttyS0\\f[R] to the image\\[cq]s kernel command line and sets " "the terminal type of the serial console in the image to the terminal type of " "the host (more specifically, the value of the \\f[C]$TERM\\f[R] environment " "variable passed to mkosi). This makes sure that all terminal features such " "as colors and shortcuts still work as expected when connecting to the qemu " "VM over the serial console (for example via \\f[C]-nographic\\f[R]). When " "used with the \\f[C]qemu\\f[R] verb, this option adds the \\f[C]-" "nographic\\f[R] option to \\f[C]qemu\\f[R]\\[cq]s command line so qemu " "starts a headless vm and connects to its serial console from the current " "terminal instead of launching the VM in a separate window.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]QemuSmp=\\f[R], \\f[CB]--qemu-smp=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When used with the \\f[C]qemu\\f[R] verb, this options sets " "\\f[C]qemu\\f[R]\\[cq]s \\f[C]-smp\\f[R] argument which controls the number " "of guest\\[cq]s CPUs. Defaults to \\f[C]2\\f[R].\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]QemuMem=\\f[R], \\f[CB]--qemu-mem=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When used with the \\f[C]qemu\\f[R] verb, this options sets " "\\f[C]qemu\\f[R]\\[cq]s \\f[C]-m\\f[R] argument which controls the amount of " "guest\\[cq]s RAM. Defaults to \\f[C]1G\\f[R].\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]QemuKvm=\\f[R], \\f[CB]--qemu-kvm=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When used with the \\f[C]qemu\\f[R] verb, this option specifies whether QEMU " "should use KVM acceleration. Defaults to yes if the host machine supports " "KVM acceleration, no otherwise.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]NspawnKeepUnit=\\f[R], \\f[CB]--nspawn-keep-unit\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When used, this option instructs underlying calls of systemd-nspawn to use " "the current unit scope, instead of creating a dedicated transcient scope " "unit for the containers. This option should be used when mkosi is run by a " "service unit." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Netdev=\\f[R], \\f[CB]--netdev\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When used with the boot or qemu verbs, this option creates a virtual " "ethernet link between the host and the container/VM. The host interface is " "automatically picked up by systemd-networkd as documented in systemd-" "nspawn\\[cq]s man page: https://www.freedesktop.org/software/systemd/man/" "systemd-nspawn.html#-n" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Ephemeral=\\f[R], \\f[CB]--ephemeral\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When used with the \\f[C]shell\\f[R], \\f[C]boot\\f[R], or \\f[C]qemu\\f[R] " "verbs, this option runs the specified verb on a temporary snapshot of the " "output image that is removed immediately when the container terminates. " "Taking the temporary snapshot is more efficient on file systems that support " "subvolume snapshots or `reflinks' natively (\\[lq]btrfs\\[rq] or new " "\\[lq]xfs\\[rq]) than on more traditional file systems that do not " "(\\[lq]ext4\\[rq]).\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]Ssh=\\f[R], \\f[CB]--ssh\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If specified, installs and enables \\f[C]sshd\\f[R] in the final image and " "generates a SSH keypair and adds the public key to root\\[cq]s " "\\f[C]authorized_keys\\f[R] in the final image. The private key is stored " "in mkosi\\[cq]s output directory. When building with this option and " "running the image using \\f[C]mkosi boot\\f[R] or \\f[C]mkosi qemu\\f[R], " "the \\f[C]mkosi ssh\\f[R] command can be used to connect to the container/VM " "via SSH.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SshKey=\\f[R], \\f[CB]--ssh-key=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If specified, use the given private key when connecting to the guest machine " "via \\f[C]mkosi ssh\\f[R]. This requires the public key counterpart to be " "present in the same location, suffixed with \\f[C].pub\\f[R] (as done by " "\\f[C]ssh-keygen\\f[R]). If this option is not present, \\f[C]mkosi\\f[R] " "generates a new key pair automatically.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SshAgent=\\f[R], \\f[CB]--ssh-agent=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If specified as a path, use the given socket to connect to the ssh agent " "when building an image and when connecting via \\f[C]mkosi ssh\\f[R] instead " "of hard-coding a key. If specified as \\f[C]true\\f[R], " "\\f[C]$SSH_AUTH_SOCK\\f[R] will be parsed instead (hint: use " "\\f[C]sudo\\f[R] with \\f[C]-E\\f[R]). The keys listed by \\f[C]ssh-add -" "L\\f[R] will be installed as authorized keys in the built image. The " "\\f[C]ssh\\f[R] invocation done by \\f[C]mkosi ssh\\f[R] will inherit " "\\f[C]$SSH_AUTH_SOCK\\f[R] for authentication purposes.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SshPort=\\f[R], \\f[CB]--ssh-port=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "In the image, sshd will be configured to listen on this port. \\f[C]mkosi " "ssh\\f[R] will connect to this port.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]SshTimeout=\\f[R], \\f[CB]--ssh-timeout=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When used with the \\f[C]ssh\\f[R] verb, \\f[C]mkosi\\f[R] will attempt to " "retry the SSH connection up to given timeout (in seconds) in case it fails. " "This option is useful mainly in scripted environments where the " "\\f[C]qemu\\f[R] and \\f[C]ssh\\f[R] verbs are used in a quick succession " "and the virtual device might not get enough time to configure itself.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]--directory=\\f[R], \\f[CB]-C\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Takes a path to a directory. \\f[C]mkosi\\f[R] switches to this directory " "before doing anything. Note that the various \\f[C]mkosi.*\\f[R] files are " "searched for only after changing to this directory, hence using this option " "is an effective way to build a project located in a specific directory.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]--default=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Loads additional settings from the specified settings file. Most command " "line options may also be configured in a settings file. See the table below " "to see which command line options match which settings file option. If this " "option is not used, but a file \\f[C]mkosi.default\\f[R] is found in the " "local directory it is automatically used for this purpose. If a setting is " "configured both on the command line and in the settings file, the command " "line generally wins, except for options taking lists in which case both " "lists are combined.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]--all\\f[R], \\f[CB]-a\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Iterate through all files \\f[C]mkosi.*\\f[R] in the \\f[C]mkosi.files/" "\\f[R] subdirectory, and build each as if \\f[C]--default=mkosi.files/mkosi." "\\&...\\f[R] was invoked. This is a quick way to build a large number of " "images in one go. Any additional specified command line arguments override " "the relevant options in all files processed this way.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]--all-directory=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If specified, overrides the directory the \\f[C]--all\\f[R] logic described " "above looks for settings files in. If unspecified, defaults to \\f[C]mkosi." "files/\\f[R] in the current working directory.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]--incremental\\f[R], \\f[CB]-i\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Enable incremental build mode. This only applies if the two-phase " "\\f[C]mkosi.build\\f[R] build script logic is used. In this mode, a copy of " "the OS image is created immediately after all OS packages are unpacked but " "before the \\f[C]mkosi.build\\f[R] script is invoked in the development " "container. Similarly, a copy of the final image is created immediately " "before the build artifacts from the \\f[C]mkosi.build\\f[R] script are " "copied in. On subsequent invocations of \\f[C]mkosi\\f[R] with the \\f[C]-" "i\\f[R] switch these cached images may be used to skip the OS package " "unpacking, thus drastically speeding up repetitive build times. Note that " "when this is used and a pair of cached incremental images exists they are " "not automatically regenerated, even if options such as \\f[C]Packages=\\f[R] " "are modified. In order to force rebuilding of these cached images, combine " "\\f[C]-i\\f[R] with \\f[C]-ff\\f[R] to ensure cached images are first " "removed and then re-created.\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]--debug=\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Enable additional debugging output. Takes a comma-separated list of " "arguments specifying the area of interest. Pass any invalid value (e.g.\\ " "empty) to list currently accepted values." msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]--version\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]--help\\f[R], \\f[CB]-h\\fR" msgstr "" #. type: TP #: fedora-40 mageia-cauldron #, no-wrap msgid "\\f[CB]--auto-bump\\f[R], \\f[CB]-B\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If specified, after each successful build the the version is bumped in a " "fashion equivalent to the \\f[C]bump\\f[R] verb, in preparation for the next " "build. This is useful for simple, linear version management: each build in " "a series will have a version number one higher then the previous one.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Images may be created containing installations of the following operating " "systems:" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[I]Clear Linux\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[I]Photon\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[I]Gentoo\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "In theory, any distribution may be used on the host for building images " "containing any other distribution, as long as the necessary tools are " "available. Specifically, any distribution that packages " "\\f[C]debootstrap\\f[R] may be used to build \\f[I]Debian\\f[R] or " "\\f[I]Ubuntu\\f[R] images. Any distribution that packages \\f[C]dnf\\f[R] " "may be used to build \\f[I]Fedora Linux\\f[R], \\f[I]Mageia\\f[R] or " "\\f[I]OpenMandriva\\f[R] images. Any distro that packages " "\\f[C]pacstrap\\f[R] may be used to build \\f[I]Arch Linux\\f[R] images. " "Any distribution that packages \\f[C]zypper\\f[R] may be used to build " "\\f[I]openSUSE\\f[R] images. Any distribution that packages \\f[C]yum\\f[R] " "(or the newer replacement \\f[C]dnf\\f[R]) may be used to build " "\\f[I]CentOS\\f[R], \\f[I]Rocky Linux\\f[R], or \\f[I]Alma Linux\\f[R] " "images. Any distribution that packages \\f[C]emerge\\f[R] may be used to " "build \\f[I]Gentoo\\f[R] images.\\fR" msgstr "" #. type: SS #: fedora-40 mageia-cauldron #, no-wrap msgid "Compatibility" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Legacy concepts are avoided: generated images use \\f[I]GPT\\f[R] disk " "labels (and no \\f[I]MBR\\f[R] labels), and only systemd-based images may be " "generated.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "All generated \\f[I]GPT\\f[R] disk images may be booted in a local container " "directly with:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "systemd-nspawn -bi image.raw\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Additionally, bootable \\f[I]GPT\\f[R] disk images (as created with the " "\\f[C]--bootable\\f[R] flag) work when booted directly by \\f[I]EFI\\f[R] " "and \\f[I]BIOS\\f[R] systems, for example in \\f[I]KVM\\f[R] via:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "qemu-kvm -m 512 -smp 2 -bios /usr/share/edk2/ovmf/OVMF_CODE.fd -drive format=raw,file=image.raw\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "\\f[I]EFI\\f[R] bootable \\f[I]GPT\\f[R] images are larger than plain " "\\f[I]GPT\\f[R] images, as they additionally carry an \\f[I]EFI\\f[R] system " "partition containing a boot loader, as well as a kernel, kernel modules, " "udev and more.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "All directory or btrfs subvolume images may be booted directly with:" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "systemd-nspawn -bD image\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.default\\f[R] file provides the default configuration for " "the image building process. For example, it may specify the distribution to " "use (\\f[C]fedora\\f[R], \\f[C]ubuntu\\f[R], \\f[C]debian\\f[R], " "\\f[C]arch\\f[R], \\f[C]opensuse\\f[R], \\f[C]mageia\\f[R], " "\\f[C]openmandriva\\f[R], \\f[C]gentoo\\f[R]) for the image, or additional " "distribution packages to install. Note that all options encoded in this " "configuration file may also be set on the command line, and this file is " "hence little more than a way to make sure invoking \\f[C]mkosi\\f[R] without " "further parameters in your \\f[I]source\\f[R] tree is enough to get the " "right image of your choice set up.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Additionally, if a \\f[CI]mkosi.default.d/\\f[R] directory exists, each file " "in it is loaded in the same manner adding/overriding the values specified in " "\\f[C]mkosi.default\\f[R]. If \\f[C]mkosi.default.d/\\f[R] contains a " "directory named after the distribution being built, each file in that " "directory is also processed.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The file format is inspired by Windows \\f[C].ini\\f[R] files and supports " "multi-line assignments: any line with initial whitespace is considered a " "continuation line of the line before. Command-line arguments, as shown in " "the help description, have to be included in a configuration block (e.g.\\ " "\\[lq]\\f[C][Content]\\f[R]\\[rq]) corresponding to the argument group (e.g." "\\ \\[lq]\\f[C]Content\\f[R]\\[rq]), and the argument gets converted as " "follows: \\[lq]\\f[C]--with-network\\f[R]\\[rq] becomes " "\\[lq]\\f[C]WithNetwork=yes\\f[R]\\[rq]. For further details see the table " "above.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.extra/\\f[R] directory or \\f[CB]mkosi.extra.tar\\f[R] " "archive may be used to insert additional files into the image, on top of " "what the distribution includes in its packages. They are similar to " "\\f[C]mkosi.skeleton/\\f[R] and \\f[C]mkosi.skeleton.tar\\f[R], but the " "files are copied into the directory tree of the image \\f[I]after\\f[R] the " "OS was installed.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "\\f[CB]mkosi.build\\f[R] may be an executable script. If it exists, the " "image will be built twice: the first iteration will be the " "\\f[I]development\\f[R] image, the second iteration will be the " "\\f[I]final\\f[R] image. The \\f[I]development\\f[R] image is used to build " "the project in the current working directory (the \\f[I]source\\f[R] tree). " "For that the whole directory is copied into the image, along with the " "\\f[C]mkosi.build\\f[R] script. The script is then invoked inside the image " "(via \\f[C]systemd-nspawn\\f[R]), with \\f[C]$SRCDIR\\f[R] pointing to the " "\\f[I]source\\f[R] tree. \\f[C]$DESTDIR\\f[R] points to a directory where " "the script should place any files generated it would like to end up in the " "\\f[I]final\\f[R] image. Note that \\f[C]make\\f[R]/\\f[C]automake\\f[R]/" "\\f[C]meson\\f[R] based build systems generally honor \\f[C]$DESTDIR\\f[R], " "thus making it very natural to build \\f[I]source\\f[R] trees from the build " "script. After the \\f[I]development\\f[R] image was built and the build " "script ran inside of it, it is removed again. After that the " "\\f[I]final\\f[R] image is built, without any \\f[I]source\\f[R] tree or " "build script copied in. However, this time the contents of " "\\f[C]$DESTDIR\\f[R] are added into the image.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "When the source tree is copied into the \\f[I]build\\f[R] image, all files " "are copied, except for \\f[C]mkosi.builddir/\\f[R], \\f[C]mkosi.cache/\\f[R] " "and \\f[C]mkosi.output/\\f[R]. That said, \\f[C].gitignore\\f[R] is " "respected if the source tree is a \\f[C]git\\f[R] checkout. If multiple " "different images shall be built from the same source tree it is essential to " "exclude their output files from this copy operation, as otherwise a version " "of an image built earlier might be included in a later build, which is " "usually not intended. An alternative to excluding these built images via " "\\f[C].gitignore\\f[R] entries is to use the \\f[C]mkosi.output/\\f[R] " "directory, which is an easy way to exclude all build artifacts.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[C]$MKOSI_DEFAULT\\f[R] environment variable will be set inside of " "this script so that you know which \\f[C]mkosi.default\\f[R] (if any) was " "passed in.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.prepare\\f[R] script is invoked directly after the software " "packages are installed, from within the image context, if it exists. It is " "once called for the \\f[I]development\\f[R] image (if this is enabled, see " "above) with the \\[lq]build\\[rq] command line parameter, right before " "copying the extra tree. It is called a second time for the " "\\f[I]final\\f[R] image with the \\[lq]final\\[rq] command line parameter. " "This script has network access and may be used to install packages from " "other sources than the distro\\[cq]s package manager (e.g.\\ " "\\f[C]pip\\f[R], \\f[C]npm\\f[R], \\&...), after all software packages are " "installed but before the image is cached (if incremental mode is enabled). " "This script is executed within \\f[C]$SRCDIR\\f[R]. In contrast to a " "general purpose installation, it is safe to install packages to the system " "(\\f[C]pip install\\f[R], \\f[C]npm install -g\\f[R]) instead of in " "\\f[C]$SRCDIR\\f[R] itself because the build image is only used for a single " "project and can easily be thrown away and rebuilt so there\\[cq]s no risk of " "conflicting dependencies and no risk of polluting the host system.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.postinst\\f[R] script is invoked as the penultimate step of " "preparing an image, from within the image context, if it exists. It is " "called first for the \\f[I]development\\f[R] image (if this is enabled, see " "above) with the \\[lq]build\\[rq] command line parameter, right before " "invoking the build script. It is called a second time for the " "\\f[I]final\\f[R] image with the \\[lq]final\\[rq] command line parameter, " "right before the image is considered complete. This script may be used to " "alter the images without any restrictions, after all software packages and " "built sources have been installed. Note that this script is executed " "directly in the image context with the final root directory in place, " "without any \\f[C]$SRCDIR\\f[R]/\\f[C]$DESTDIR\\f[R] setup.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.finalize\\f[R] script, if it exists, is invoked as last " "step of preparing an image, from the host system. It is once called for the " "\\f[I]development\\f[R] image (if this is enabled, see above) with the " "\\[lq]build\\[rq] command line parameter, as the last step before invoking " "the build script, after the \\f[C]mkosi.postinst\\f[R] script is invoked. " "It is called the second time with the \\[lq]final\\[rq] command line " "parameter as the last step before the image is considered complete. The " "environment variable \\f[C]$BUILDROOT\\f[R] points to the root directory of " "the installation image. Additional verbs may be added in the future, the " "script should be prepared for that. This script may be used to alter the " "images without any restrictions, after all software packages and built " "sources have been installed. This script is more flexible than \\f[C]mkosi." "postinst\\f[R] in two regards: it has access to the host file system so " "it\\[cq]s easier to copy in additional files or to modify the image based on " "external configuration, and the script is run in the host, so it can be used " "even without emulation even if the image has a foreign architecture.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.mksquashfs-tool\\f[R] script, if it exists, will be called " "wherever \\f[C]mksquashfs\\f[R] would be called.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.builddir/\\f[R] directory, if it exists, is automatically " "used as out-of-tree build directory, if the build commands in the " "\\f[C]mkosi.build\\f[R] script support it. Specifically, this directory " "will be mounted into the build container, and the \\f[C]$BUILDDIR\\f[R] " "environment variable will be set to it when the build script is invoked. " "The build script may then use this directory as build directory, for " "automake-style or ninja-style out-of-tree builds. This speeds up builds " "considerably, in particular when \\f[C]mkosi\\f[R] is used in incremental " "mode (\\f[C]-i\\f[R]): not only the disk images, but also the build tree is " "reused between subsequent invocations. Note that if this directory does not " "exist the \\f[C]$BUILDDIR\\f[R] environment variable is not set, and it is " "up to build script to decide whether to do in in-tree or an out-of-tree " "build, and which build directory to use.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.includedir/\\f[R] directory, if it exists, is automatically " "used as an out-of-tree include directory for header files. Specifically, it " "will be mounted in the build container at \\f[C]/usr/include/\\f[R] when " "building the build image and when running the build script. After building " "the (cached) build image, this directory will contain all the files " "installed to \\f[C]/usr/include\\f[R]. Language servers or other tools can " "use these files to provide a better editing experience for developers " "working on a project.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.installdir/\\f[R] directory, if it exists, is automatically " "used as the install directory. Specifically, this directory will be mounted " "into the container at \\f[C]/root/dest\\f[R] when running the build script. " "After running the build script, the contents of this directory are installed " "into the final image. This is useful to cache the install step of the " "build. If used, subsequent builds will only have to reinstall files that " "have changed since the previous build.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.rootpw\\f[R] file can be used to provide the password or " "hashed password (if \\f[C]--password-is-hashed\\f[R] is set) for the root " "user of the image. The password may optionally be followed by a newline " "character which is implicitly removed. The file must have an access mode of " "0600 or less. If this file does not exist, the distribution\\[cq]s default " "root password is set (which usually means access to the root user is " "blocked).\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.passphrase\\f[R] file provides the passphrase to use when " "LUKS encryption is selected. It should contain the passphrase literally, " "and not end in a newline character (i.e.\\ in the same format as cryptsetup " "and \\f[C]/etc/crypttab\\f[R] expect the passphrase files). The file must " "have an access mode of 0600 or less. If this file does not exist and " "encryption is requested, the user is queried instead.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.secure-boot.crt\\f[R] and \\f[CB]mkosi.secure-boot." "key\\f[R] files contain an X.509 certificate and PEM private key to use when " "UEFI SecureBoot support is enabled. All EFI binaries included in the " "image\\[cq]s ESP are signed with this key, as a late step in the build " "process.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.output/\\f[R] directory will be used for all build " "artifacts, if the image output path is not configured (i.e.\\ no \\f[C]--" "output=\\f[R] setting specified), or configured to a filename (i.e.\\ a path " "containing no \\f[C]/\\f[R] character). This includes the image itself, the " "root hash file in case Verity is used, the checksum and its signature if " "that\\[cq]s enabled, and the nspawn settings file if there is any. Note " "that this directory is not used if the image output path contains at least " "one slash, and has no effect in that case. This setting is particularly " "useful if multiple different images shall be built from the same working " "directory, as otherwise the build result of a preceding run might be copied " "into a build image as part of the source tree (see above).\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The \\f[CB]mkosi.reposdir/\\f[R] directory, if it exists, is automatically " "used as the repository directory for extra repository files. See the " "\\f[C]RepositoryDirectory\\f[R] option for more information.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Note that the location of all these files may also be configured during " "invocation via command line switches, and as settings in \\f[C]mkosi." "default\\f[R], in case the default settings are not acceptable for a project." "\\fR" msgstr "" #. type: SH #: fedora-40 mageia-cauldron #, no-wrap msgid "BUILD PHASES" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If no build script \\f[C]mkosi.build\\f[R] (see above) is used the build " "consists of a single phase only: the final image is generated as the " "combination of \\f[C]mkosi.skeleton/\\f[R] (see above), the unpacked " "distribution packages and \\f[C]mkosi.extra/\\f[R].\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If a build script \\f[C]mkosi.build\\f[R] is used the build consists of two " "phases: in the the first \\f[C]development\\f[R] phase an image that " "includes necessary build tools (i.e.\\ the combination of " "\\f[C]Packages=\\f[R] and \\f[C]BuildPackages=\\f[R] is installed) is " "generated (i.e.\\ the combination of \\f[C]mkosi.skeleton/\\f[R] and " "unpacked distribution packages). Into this image the source tree is copied " "and \\f[C]mkosi.build\\f[R] executed. The artifacts the \\f[C]mkosi." "build\\f[R] generates are saved. Then, the second \\f[C]final\\f[R] phase " "starts: an image that excludes the build tools (i.e.\\ only " "\\f[C]Packages=\\f[R] is installed, \\f[C]BuildPackages=\\f[R] is not) is " "generated. This time the build artifacts saved from the first phase are " "copied in, and \\f[C]mkosi.extra\\f[R] copied on top, thus generating the " "final image.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The two-phased approach ensures that source tree is executed in a clean and " "comprehensive environment, while at the same the final image remains minimal " "and contains only those packages necessary at runtime, but avoiding those " "necessary at build-time." msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Note that only the package cache \\f[C]mkosi.cache/\\f[R] is shared between " "the two phases. The distribution package manager is executed exactly once " "in each phase, always starting from a directory tree that is populated with " "\\f[C]mkosi.skeleton\\f[R] but nothing else.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "\\f[C]mkosi\\f[R] supports three different caches for speeding up repetitive " "re-building of images. Specifically:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The package cache of the distribution package manager may be cached between " "builds. This is configured with the \\f[C]--cache=\\f[R] option or the " "\\f[C]mkosi.cache/\\f[R] directory. This form of caching relies on the " "distribution\\[cq]s package manager, and caches distribution packages (RPM, " "DEB, \\&...) after they are downloaded, but before they are unpacked.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "If an \\f[C]mkosi.build\\f[R] script is used, by enabling incremental build " "mode with \\f[C]--incremental\\f[R], a cached copy of the development and " "final images can be made immediately before the build sources are copied in " "(for the development image) or the artifacts generated by \\f[C]mkosi." "build\\f[R] are copied in (in case of the final image). This form of " "caching allows bypassing the time-consuming package unpacking step of the " "distribution package managers, but is only effective if the list of packages " "to use remains stable, but the build sources and its scripts change " "regularly. Note that this cache requires manual flushing: whenever the " "package list is modified the cached images need to be explicitly removed " "before the next re-build, using the \\f[C]-f\\f[R] switch.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Finally, between multiple builds the build artifact directory may be shared, " "using the \\f[C]mkosi.builddir/\\f[R] directory. This directory allows " "build systems such as Meson to reuse already compiled sources from a " "previous built, thus speeding up the build process of the \\f[C]mkosi." "build\\f[R] build script.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The package cache (i.e.\\ the first item above) is unconditionally useful. " "The latter two caches only apply to uses of \\f[C]mkosi\\f[R] with a source " "tree and build script. When all three are enabled together turn-around " "times for complete image builds are minimal, as only changed source files " "need to be recompiled: an OS image rebuilt will be almost as quick to build " "the source tree only.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The build script \\f[C]mkosi.build\\f[R] receives the following environment " "variables:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "\\f[C]$SRCDIR\\f[R] contains the path to the sources to build.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "\\f[C]$DESTDIR\\f[R] is a directory into which any artifacts generated by " "the build script shall be placed.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "\\f[C]$BUILDDIR\\f[R] is only defined if \\f[C]mkosi.builddir\\f[R] and " "points to the build directory to use. This is useful for all build systems " "that support out-of-tree builds to reuse already built artifacts from " "previous runs.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "\\f[C]$WITH_DOCS\\f[R] is either \\f[C]0\\f[R] or \\f[C]1\\f[R] depending on " "whether a build without or with installed documentation was requested " "(\\f[C]WithDocs=yes\\f[R]). The build script should suppress installation " "of any package documentation to \\f[C]$DESTDIR\\f[R] in case " "\\f[C]$WITH_DOCS\\f[R] is set to \\f[C]0\\f[R].\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "\\f[C]$WITH_TESTS\\f[R] is either \\f[C]0\\f[R]or \\f[C]1\\f[R] depending on " "whether a build without or with running the test suite was requested " "(\\f[C]WithTests=no\\f[R]). The build script should avoid running any unit " "or integration tests in case \\f[C]$WITH_TESTS\\f[R] is \\f[C]0\\f[R].\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "\\f[C]$WITH_NETWORK\\f[R] is either \\f[C]0\\f[R]or \\f[C]1\\f[R] depending " "on whether a build without or with networking is being executed " "(\\f[C]WithNetwork=no\\f[R]). The build script should avoid any network " "communication in case \\f[C]$WITH_NETWORK\\f[R] is \\f[C]0\\f[R].\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Create and run a raw \\f[I]GPT\\f[R] image with \\f[I]ext4\\f[R], as " "\\f[C]image.raw\\f[R]:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "# mkosi --bootable --incremental boot\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Create and run a bootable btrfs \\f[I]GPT\\f[R] image, as \\f[C]foobar." "raw\\f[R]:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "# mkosi --format gpt_btrfs --bootable -o foobar.raw\n" "# mkosi --output foobar.raw boot\n" "# mkosi --output foobar.raw qemu\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Create and run a \\f[I]Fedora Linux\\f[R] image into a plain directory:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Create a compressed image \\f[C]image.raw.xz\\f[R] and add a checksum file, " "and install \\f[I]SSH\\f[R] into it:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "# mkosi --distribution fedora --format gpt_squashfs --checksum --compress --package=openssh-clients\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "Inside the source directory of an \\f[C]automake\\f[R]-based project, " "configure \\f[I]mkosi\\f[R] so that simply invoking \\f[C]mkosi\\f[R] " "without any parameters builds an OS image containing a built version of the " "project in its current state:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "# cat Emkosi.default EEEOF\n" "[Distribution]\n" "Distribution=fedora\n" "Release=24\\fR\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C][Output]\n" "Format=gpt_btrfs\n" "Bootable=yes\\fR\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C][Content]\n" "Packages=openssh-clients,httpd\n" "BuildPackages=make,gcc,libcurl-devel\n" "EOF\n" "# cat Emkosi.build EEEOF\n" "#!/bin/sh\n" "cd $SRCDIR\n" "\\&./autogen.sh\n" "\\&./configure --prefix=/usr\n" "make -j \\[ga]nproc\\[ga]\n" "make install\n" "EOF\n" "# chmod +x mkosi.build\n" "# mkosi --bootable --incremental boot\n" "# systemd-nspawn -bi image.raw\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "To create a \\f[I]Fedora Linux\\f[R] image with hostname:\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "# mkosi --distribution fedora --hostname image\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "Also you could set hostname in configuration file:" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "# cat mkosi.default\n" "\\&...\n" "[Output]\n" "Hostname=image\n" "\\&...\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "mkosi is packaged for various distributions: Debian, Ubuntu, Arch Linux, " "Fedora Linux, OpenMandriva, Gentoo. It is usually easiest to use the " "distribution package." msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "The current version requires systemd 233 (or actually, systemd-nspawn of it)." msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron #, no-wrap msgid "" "\\f[C]\n" "dnf install arch-install-scripts btrfs-progs debootstrap dosfstools edk2-ovmf e2fsprogs squashfs-tools gnupg python3 tar veritysetup xfsprogs xz zypper sbsigntools\\fR\n" "\n" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "On Debian/Ubuntu it might be necessary to install the \\f[C]ubuntu-" "keyring\\f[R], \\f[C]ubuntu-archive-keyring\\f[R] and/or \\f[C]debian-" "archive-keyring\\f[R] packages explicitly, in addition to " "\\f[C]debootstrap\\f[R], depending on what kind of distribution images you " "want to build. \\f[C]debootstrap\\f[R] on Debian only pulls in the Debian " "keyring on its own, and the version on Ubuntu only the one from Ubuntu.\\fR" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "Note that the minimum required Python version is 3.7." msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "mkosi \\[em] A Tool for Generating OS Images (http://0pointer.net/blog/mkosi-" "a-tool-for-generating-os-images.html) introductory blog post by Lennart " "Poettering" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "" "\\f[C]systemd-nspawn(1)\\f[R], \\f[C]dnf(8)\\f[R], \\f[C]debootstrap(8)\\fR" msgstr "" #. type: SH #: fedora-40 mageia-cauldron #, no-wrap msgid "AUTHORS" msgstr "" #. type: Plain text #: fedora-40 mageia-cauldron msgid "The mkosi Authors." msgstr "" #. type: Plain text #: opensuse-tumbleweed #, no-wrap msgid "" "\\f[B][Match]\\f[R]\n" "Format=\\f[B]|\\f[R]disk\n" "Format=\\f[B]|\\f[R]directory\\fR\n" msgstr "" #. type: Plain text #: opensuse-tumbleweed #, no-wrap msgid "" "\\f[B][Match]\\f[R]\n" "Architecture=\\f[B]|\\f[R]x86-64\n" "Architecture=\\f[B]|\\f[R]arm64\\fR\n" msgstr "" #. type: Plain text #: opensuse-tumbleweed #, no-wrap msgid "" "\\f[B][TriggerMatch]\\f[R]\n" "Distribution=debian\n" "Release=bookworm\\fR\n" msgstr "" #. type: Plain text #: opensuse-tumbleweed #, no-wrap msgid "" "\\f[B][TriggerMatch]\\f[R]\n" "Distribution=ubuntu\n" "Release=focal\\fR\n" msgstr "" #. type: Plain text #: opensuse-tumbleweed #, no-wrap msgid "" "\\f[B][Content]\\f[R]\n" "BuildSources=..\\f[B]/\\f[R]abc\\f[B]/\\f[R]qed\\f[B]:\\f[R]kernel\\fR\n" msgstr "" #. type: Plain text #: opensuse-tumbleweed #, no-wrap msgid "" "\\f[B][Match]\\f[R]\n" "BuildSources=kernel\\fR\n" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "If specified and building a disk image, pass \\f[CR]--split=yes\\f[R] to " "systemd-repart to have it write out split partition files for each " "configured partition. Read the E<.UR https://www.freedesktop.org/software/" "systemd/man/systemd-repart.html#--split=BOOL> man E<.UE > \\ page for more " "information. This is useful in A/B update scenarios where an existing disk " "image shall be augmented with a new version of a root or \\f[CR]/usr\\f[R] " "partition along with its Verity partition and unified kernel.\\fR" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "When used together with \\f[CR]BaseTrees=\\f[R], the output will consist " "only out of changes to the specified base trees. Each base tree is attached " "as a lower layer in an overlayfs structure, and the output becomes the upper " "layer, initially empty. Thus files that are not modified compared to the " "base trees will not be present in the final output. This option may be used " "to create E<.UR https://uapi-group.org/specifications/specs/extension_image> " "systemd \\f[I]system extensions\\f[R] or \\f[I]portable services\\f[R] E<.UE " "> \\&.\\fR" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "Takes a UUID as argument or the special value \\f[CR]random\\f[R]. " "Overrides the seed that E<.UR https://www.freedesktop.org/software/systemd/" "man/systemd-repart.service.html> \\f[CR]systemd-repart(8)\\f[R] E<.UE > \\ " "uses when building a disk image. This is useful to achieve reproducible " "builds, where deterministic UUIDs and other partition metadata should be " "derived on each build.\\fR" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "Takes a timestamp as argument. Resets file modification times of all files " "to this timestamp. The variable is also propagated to systemd-repart and " "scripts executed by mkosi. If not set explicitly, " "\\f[CR]SOURCE_DATE_EPOCH\\f[R] from \\f[CR]--environment\\f[R] and from the " "host environment are tried in that order. This is useful to make builds " "reproducible. See E<.UR https://reproducible-builds.org/specs/source-date-" "epoch/> SOURCE_DATE_EPOCH E<.UE > \\ for more information.\\fR" msgstr "" #. type: Plain text #: opensuse-tumbleweed #, no-wrap msgid "" "Packages=meson\n" " libfdisk-devel.i686\n" " git-\\f[B]*\\f[R]\n" " prebuilt\\f[B]/\\f[R]rpms\\f[B]/\\f[R]systemd-249-rc1.local.rpm\n" " \\f[B]/\\f[R]usr\\f[B]/\\f[R]bin\\f[B]/\\f[R]ld\n" " \\f[B]\\[at]\\f[R]development-tools\n" " python3dist\\f[B](\\f[R]mypy\\f[B])\\fR\n" msgstr "" #. type: Plain text #: opensuse-tumbleweed #, no-wrap msgid "" "BuildSources=..\\f[B]/\\f[R]my-packages\\f[B]:\\f[R]my-packages-in-sandbox\n" "Packages=my-packages-in-sandbox\\f[B]/\\f[R]abc.rpm\\fR\n" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "The settings \\f[CR]Locale=\\f[R], \\f[CR]--locale=\\f[R], " "\\f[CR]LocaleMessages=\\f[R], \\f[CR]--locale-messages=\\f[R], " "\\f[CR]Keymap=\\f[R], \\f[CR]--keymap=\\f[R], \\f[CR]Timezone=\\f[R], " "\\f[CR]--timezone=\\f[R], \\f[CR]Hostname=\\f[R], \\f[CR]--hostname=\\f[R], " "\\f[CR]RootShell=\\f[R], \\f[CR]--root-shell=\\f[R] correspond to the " "identically named systemd-firstboot options. See the systemd firstboot E<." "UR https://www.freedesktop.org/software/systemd/man/systemd-firstboot.html> " "manpage E<.UE > \\ for more information. Additionally, where applicable, " "the corresponding systemd credentials for these settings are written to " "\\f[CR]/usr/lib/credstore\\f[R], so that they apply even if only \\f[CR]/" "usr\\f[R] is shipped in the image.\\fR" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "Set up automatic enrollment of the secure boot keys in virtual machines as " "documented in the systemd-boot E<.UR https://www.freedesktop.org/software/" "systemd/man/systemd-boot.html> man page E<.UE > \\ if " "\\f[CR]SecureBoot=\\f[R] is used. Note that systemd-boot will only do " "automatic secure boot key enrollment in virtual machines starting from " "systemd v253. To do auto enrollment on systemd v252 or on bare metal " "machines, write a systemd-boot configuration file to \\f[CR]/efi/loader/" "loader.conf\\f[R] using an extra tree with \\f[CR]secure-boot-enroll " "force\\f[R] or \\f[CR]secure-boot-enroll manual\\f[R] in it. Auto " "enrollment is not supported on systemd versions older than v252. Defaults " "to \\f[CR]yes\\f[R].\\fR" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "When used with the \\f[CR]qemu\\f[R] verb, this option specifies the path to " "the the firmware variables file to use. Currently, this option is only " "taken into account when the \\f[CR]uefi\\f[R] or \\f[CR]uefi-secure-" "boot\\f[R] firmware is used. If not specified, mkosi will search for the " "default variables file and use that instead. When set to " "\\f[CR]microsoft\\f[R], a firmware variables file with the Microsoft secure " "boot certificates already enrolled will be used. When set to " "\\f[CR]custom\\f[R], the secure boot certificate from " "\\f[CR]SecureBootCertificate=\\f[R] will be enrolled into the default " "firmware variables file. \\f[CR]virt-fw-vars\\f[R] from the E<.UR https://" "gitlab.com/kraxel/virt-firmware> virt-firmware E<.UE > \\ project can be " "used to customize OVMF variable files.\\fR" msgstr "" #. type: Plain text #: opensuse-tumbleweed #, no-wrap msgid "" "\\f[B][Host]\\f[R]\n" "QemuDrives=btrfs\\f[B]:\\f[R]10G\n" " ext4\\f[B]:\\f[R]20G\n" "QemuArgs=-device nvme\\f[B],\\f[R]serial=btrfs\\f[B],\\f[R]drive=btrfs\n" " -device nvme\\f[B],\\f[R]serial=ext4\\f[B],\\f[R]drive=ext4\\fR\n" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "\\f[CR]$SOURCE_DATE_EPOCH\\f[R] is defined if requested " "(\\f[CR]SourceDateEpoch=TIMESTAMP\\f[R], " "\\f[CR]Environment=SOURCE_DATE_EPOCH=TIMESTAMP\\f[R] or the host environment " "variable \\f[CR]$SOURCE_DATE_EPOCH\\f[R]). This is useful to make builds " "reproducible. See E<.UR https://reproducible-builds.org/specs/source-date-" "epoch/> SOURCE_DATE_EPOCH E<.UE > \\ for more information.\\fR" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "A good example on how to build multiple images can be found in the E<.UR " "https://github.com/systemd/systemd/tree/main/mkosi.images> systemd E<.UE > " "\\ repository." msgstr "" #. type: Plain text #: opensuse-tumbleweed #, no-wrap msgid "\\f[I]# dnf install bubblewrap btrfs-progs apt dosfstools mtools edk2-ovmf e2fsprogs squashfs-tools gnupg python3 tar xfsprogs xz zypper sbsigntools\\fR\n" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "E<.UR https://github.com/systemd/mkosi/> Primary mkosi git repository on " "GitHub E<.UE >" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "E<.UR https://0pointer.net/blog/mkosi-a-tool-for-generating-os-images.html> " "mkosi \\[em] A Tool for Generating OS Images E<.UE > \\ introductory blog " "post by Lennart Poettering" msgstr "" #. type: Plain text #: opensuse-tumbleweed msgid "" "E<.UR https://lwn.net/Articles/726655/> The mkosi OS generation tool E<.UE > " "\\ story on LWN" msgstr ""