.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
.TH MKOSI "1" "April 2018" "mkosi 4" "User Commands"
.SH NAME
mkosi \- Create legacy-free OS images
.SH DESCRIPTION
usage: mkosi [\-h] [\-\-version]
.IP
[\-d {fedora,debian,ubuntu,arch,opensuse,mageia,centos,clear}]
[\-r RELEASE] [\-m MIRROR] [\-\-repositories REPOS]
[\-t {raw_gpt,raw_btrfs,raw_squashfs,directory,subvolume,tar}]
[\-o PATH] [\-O DIR] [\-f] [\-b [BOOTABLE]] [\-\-secure\-boot]
[\-\-secure\-boot\-key PATH] [\-\-secure\-boot\-certificate PATH]
[\-\-read\-only] [\-\-encrypt {all,data}] [\-\-verity] [\-\-compress]
[\-\-xz] [\-i] [\-p PACKAGE] [\-\-with\-docs] [\-T] [\-\-cache PATH]
[\-\-extra\-tree PATH] [\-\-skeleton\-tree PATH] [\-\-build\-script PATH]
[\-\-build\-sources PATH] [\-\-build\-dir PATH]
[\-\-build\-package PACKAGE] [\-\-postinst\-script PATH]
[\-\-use\-git\-files USE_GIT_FILES] [\-\-git\-files {cached,others}]
[\-\-with\-network] [\-\-settings PATH] [\-\-root\-size BYTES]
[\-\-esp\-size BYTES] [\-\-swap\-size BYTES] [\-\-home\-size BYTES]
[\-\-srv\-size BYTES] [\-\-checksum] [\-\-sign] [\-\-key KEY] [\-\-bmap]
[\-\-password PASSWORD] [\-\-extra\-search\-paths EXTRA_SEARCH_PATHS]
[\-C PATH] [\-\-default PATH]
[\-\-kernel\-commandline KERNEL_COMMANDLINE] [\-\-hostname HOSTNAME]
[{build,clean,help,summary,shell,boot,qemu}] ...
.PP
Build Legacy\-Free OS Images
.SS "Commands:"
.TP
{build,clean,help,summary,shell,boot,qemu}
Operation to execute
.TP
cmdline
The command line to use for 'shell', 'boot', 'qemu'
.TP
\fB\-h\fR, \fB\-\-help\fR
Show this help
.TP
\fB\-\-version\fR
show program's version number and exit
.SS "Distribution:"
.TP
\fB\-d\fR {fedora,debian,ubuntu,arch,opensuse,mageia,centos,clear}, \fB\-\-distribution\fR {fedora,debian,ubuntu,arch,opensuse,mageia,centos,clear}
Distribution to install
.TP
\fB\-r\fR RELEASE, \fB\-\-release\fR RELEASE
Distribution release to install
.TP
\fB\-m\fR MIRROR, \fB\-\-mirror\fR MIRROR
Distribution mirror to use
.TP
\fB\-\-repositories\fR REPOS
Repositories to use
.SS "Output:"
.TP
\fB\-t\fR {raw_gpt,raw_btrfs,raw_squashfs,directory,subvolume,tar}, \fB\-\-format\fR {raw_gpt,raw_btrfs,raw_squashfs,directory,subvolume,tar}
Output Format
.TP
\fB\-o\fR PATH, \fB\-\-output\fR PATH
Output image path
.TP
\fB\-O\fR DIR, \fB\-\-output\-dir\fR DIR
Output root directory
.TP
\fB\-f\fR, \fB\-\-force\fR
Remove existing image file before operation
.TP
\fB\-b\fR [BOOTABLE], \fB\-\-bootable\fR [BOOTABLE]
Make image bootable on EFI (only raw_gpt, raw_btrfs,
raw_squashfs)
.TP
\fB\-\-secure\-boot\fR
Sign the resulting kernel/initrd image for UEFI
SecureBoot
.TP
\fB\-\-secure\-boot\-key\fR PATH
UEFI SecureBoot private key in PEM format
.TP
\fB\-\-secure\-boot\-certificate\fR PATH
UEFI SecureBoot certificate in X509 format
.TP
\fB\-\-read\-only\fR
Make root volume read\-only (only raw_gpt, raw_btrfs,
subvolume, implied on raw_squashs)
.TP
\fB\-\-encrypt\fR {all,data}
Encrypt everything except: ESP ("all") or ESP and root
("data")
.TP
\fB\-\-verity\fR
Add integrity partition (implies \fB\-\-read\-only\fR)
.TP
\fB\-\-compress\fR
Enable compression in file system (only raw_btrfs,
subvolume)
.TP
\fB\-\-xz\fR
Compress resulting image with xz (only raw_gpt,
raw_btrfs, raw_squashfs, implied on tar)
.TP
\fB\-i\fR, \fB\-\-incremental\fR
Make use of and generate intermediary cache images
.SS "Packages:"
.TP
\fB\-p\fR PACKAGE, \fB\-\-package\fR PACKAGE
Add an additional package to the OS image
.TP
\fB\-\-with\-docs\fR
Install documentation (only Fedora, CentOS and Mageia)
.TP
\fB\-T\fR, \fB\-\-without\-tests\fR
Do not run tests as part of build script, if supported
.TP
\fB\-\-cache\fR PATH
Package cache path
.TP
\fB\-\-extra\-tree\fR PATH
Copy an extra tree on top of image
.TP
\fB\-\-skeleton\-tree\fR PATH
Use a skeleton tree to bootstrap the image before
installing anything
.TP
\fB\-\-build\-script\fR PATH
Build script to run inside image
.TP
\fB\-\-build\-sources\fR PATH
Path for sources to build
.TP
\fB\-\-build\-dir\fR PATH
Path to use as persistent build directory
.TP
\fB\-\-build\-package\fR PACKAGE
Additional packages needed for build script
.TP
\fB\-\-postinst\-script\fR PATH
Post installation script to run inside image
.TP
\fB\-\-use\-git\-files\fR USE_GIT_FILES
Ignore any files that git itself ignores (default:
guess)
.TP
\fB\-\-git\-files\fR {cached,others}
Whether to include untracked files (default: others)
.TP
\fB\-\-with\-network\fR
Run build and postinst scripts with network access
(instead of private network)
.TP
\fB\-\-settings\fR PATH
Add in .spawn settings file
.SS "Partitions:"
.TP
\fB\-\-root\-size\fR BYTES
Set size of root partition (only raw_gpt, raw_btrfs)
.TP
\fB\-\-esp\-size\fR BYTES
Set size of EFI system partition (only raw_gpt,
raw_btrfs, raw_squashfs)
.TP
\fB\-\-swap\-size\fR BYTES
Set size of swap partition (only raw_gpt, raw_btrfs,
raw_squashfs)
.TP
\fB\-\-home\-size\fR BYTES
Set size of \fI\,/home\/\fP partition (only raw_gpt,
raw_squashfs)
.TP
\fB\-\-srv\-size\fR BYTES
Set size of \fI\,/srv\/\fP partition (only raw_gpt,
raw_squashfs)
.SS "Validation (only raw_gpt, raw_btrfs, raw_squashfs, tar):"
.TP
\fB\-\-checksum\fR
Write SHA256SUMS file
.TP
\fB\-\-sign\fR
Write and sign SHA256SUMS file
.TP
\fB\-\-key\fR KEY
GPG key to use for signing
.TP
\fB\-\-bmap\fR
Write block map file (.bmap) for bmaptool usage (only
raw_gpt, raw_btrfs)
.TP
\fB\-\-password\fR PASSWORD
Set the root password
.SS "Host configuration:"
.TP
\fB\-\-extra\-search\-paths\fR EXTRA_SEARCH_PATHS
List of colon\-separated paths to look for programs
before looking in PATH
.SS "Additional Configuration:"
.TP
\fB\-C\fR PATH, \fB\-\-directory\fR PATH
Change to specified directory before doing anything
.TP
\fB\-\-default\fR PATH
Read configuration data from file
.TP
\fB\-\-kernel\-commandline\fR KERNEL_COMMANDLINE
Set the kernel command line (only bootable images)
.TP
\fB\-\-hostname\fR HOSTNAME
Set hostname