NAME¶
mkosi - Create legacy-free OS images
DESCRIPTION¶
usage: mkosi [-h] [-d {fedora,debian,ubuntu,arch}] [-r RELEASE] [-m MIRROR]
- [-t {raw_gpt,raw_btrfs,directory,subvolume,tar}] [-o PATH] [-f] [-b
[BOOTABLE]] [--read-only] [--compress] [--xz] [-p PACKAGE] [--with-docs]
[--cache PATH] [--extra-tree PATH] [--build-script PATH] [--build-sources
PATH] [--build-package PACKAGE] [--use-git-files USE_GIT_FILES]
[--settings PATH] [--root-size BYTES] [--esp-size BYTES] [--swap-size
BYTES] [--home-size BYTES] [--srv-size BYTES] [--checksum] [--sign] [--key
KEY] [--password PASSWORD] [-C PATH] [--default PATH]
[--kernel-commandline KERNEL_COMMANDLINE]
[{build,clean,help,summary}]
Build Legacy-Free OS Images
Commands:¶
- {build,clean,help,summary}
- Operation to execute
- -h, --help
- Show this help
Distribution:¶
- -d {fedora,debian,ubuntu,arch}, --distribution
{fedora,debian,ubuntu,arch}
- Distribution to install
- -r RELEASE, --release RELEASE
- Distribution release to install
- -m MIRROR, --mirror MIRROR
- Distribution mirror to use
Output:¶
- -t {raw_gpt,raw_btrfs,directory,subvolume,tar}, --format
{raw_gpt,raw_btrfs,directory,subvolume,tar}
- Output Format
- -o PATH, --output PATH
- Output image path
- -f, --force
- Remove existing image file before operation
- -b [BOOTABLE], --bootable [BOOTABLE]
- Make image bootable on EFI (only raw_gpt, raw_btrfs)
- --read-only
- Make root volume read-only (only raw_btrfs, subvolume)
- --compress
- Enable compression in file system (only raw_btrfs, subvolume)
- --xz
- Compress resulting image with xz (only raw_gpt, raw_btrfs, implied on
tar)
Packages:¶
- -p PACKAGE, --package PACKAGE
- Add an additional package to the OS image
- --with-docs
- Install documentation (only fedora)
- --cache PATH
- Package cache path (only fedora, debian, ubuntu)
- --extra-tree PATH
- Copy an extra tree on top of image
- --build-script PATH
- Build script to run inside image
- --build-sources PATH
- Path for sources to build
- --build-package PACKAGE
- Additional packages needed for build script
- --use-git-files USE_GIT_FILES
- Ignore any files that git itself ignores (default: guess)
- --settings PATH
- Add in .spawn settings file
Partitions:¶
- --root-size BYTES
- Set size of root partition (only raw_gpt, raw_btrfs)
- --esp-size BYTES
- Set size of EFI system partition (only raw_gpt, raw_btrfs)
- --swap-size BYTES
- Set size of swap partition (only raw_gpt, raw_btrfs)
- --home-size BYTES
- Set size of /home partition (only raw_gpt)
- --srv-size BYTES
- Set size of /srv partition (only raw_gpt)
Validation (only raw_gpt, raw_btrfs, tar):¶
- --checksum
- Write SHA256SUM file
- --sign
- Write and sign SHA256SUM file
- --key KEY
- GPG key to use for signing
- --password PASSWORD
- Set the root password
Additional Configuration:¶
- -C PATH, --directory PATH
- Change to specified directory before doing anything
- --default PATH
- Read configuration data from file
- --kernel-commandline KERNEL_COMMANDLINE
- Set the kernel command line (only bootable images)
