.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH MKOSI "1" "November 2016" "mkosi 1" "User Commands"
.SH NAME
mkosi \- Create legacy-free OS images
.SH DESCRIPTION
usage: mkosi [\-h] [\-d {fedora,debian,ubuntu,arch}] [\-r RELEASE] [\-m MIRROR]
.IP
[\-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}]
.PP
Build Legacy\-Free OS Images
.SS "Commands:"
.TP
{build,clean,help,summary}
Operation to execute
.TP
\fB\-h\fR, \fB\-\-help\fR
Show this help
.SS "Distribution:"
.TP
\fB\-d\fR {fedora,debian,ubuntu,arch}, \fB\-\-distribution\fR {fedora,debian,ubuntu,arch}
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
.SS "Output:"
.TP
\fB\-t\fR {raw_gpt,raw_btrfs,directory,subvolume,tar}, \fB\-\-format\fR {raw_gpt,raw_btrfs,directory,subvolume,tar}
Output Format
.TP
\fB\-o\fR PATH, \fB\-\-output\fR PATH
Output image path
.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)
.TP
\fB\-\-read\-only\fR
Make root volume read\-only (only raw_btrfs, subvolume)
.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, implied on tar)
.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)
.TP
\fB\-\-cache\fR PATH
Package cache path (only fedora, debian, ubuntu)
.TP
\fB\-\-extra\-tree\fR PATH
Copy an extra tree on top of image
.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\-package\fR PACKAGE
Additional packages needed for build script
.TP
\fB\-\-use\-git\-files\fR USE_GIT_FILES
Ignore any files that git itself ignores (default:
guess)
.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)
.TP
\fB\-\-swap\-size\fR BYTES
Set size of swap partition (only raw_gpt, raw_btrfs)
.TP
\fB\-\-home\-size\fR BYTES
Set size of \fI\,/home\/\fP partition (only raw_gpt)
.TP
\fB\-\-srv\-size\fR BYTES
Set size of \fI\,/srv\/\fP partition (only raw_gpt)
.SS "Validation (only raw_gpt, raw_btrfs, tar):"
.TP
\fB\-\-checksum\fR
Write SHA256SUM file
.TP
\fB\-\-sign\fR
Write and sign SHA256SUM file
.TP
\fB\-\-key\fR KEY
GPG key to use for signing
.TP
\fB\-\-password\fR PASSWORD
Set the root password
.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)