.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "KIWI::SYSTEM::BUILD" "8" "Dec 22, 2022" "9.24.56" "KIWI NG"
.SH NAME
kiwi::system::build \- Build image in combined prepare and create step
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
kiwi\-ng [global options] service <command> [<args>]

kiwi\-ng system build \-h | \-\-help
kiwi\-ng system build \-\-description=<directory> \-\-target\-dir=<directory>
    [\-\-allow\-existing\-root]
    [\-\-clear\-cache]
    [\-\-ignore\-repos]
    [\-\-ignore\-repos\-used\-for\-build]
    [\-\-set\-repo=<source,type,alias,priority,imageinclude,package_gpgcheck,{signing_keys},components,distribution,repo_gpgcheck>]
    [\-\-set\-repo\-credentials=<user:pass_or_filename>]
    [\-\-add\-repo=<source,type,alias,priority,imageinclude,package_gpgcheck,{signing_keys},components,distribution,repo_gpgcheck>...]
    [\-\-add\-repo\-credentials=<user:pass_or_filename>...]
    [\-\-add\-package=<name>...]
    [\-\-add\-bootstrap\-package=<name>...]
    [\-\-delete\-package=<name>...]
    [\-\-set\-container\-derived\-from=<uri>]
    [\-\-set\-container\-tag=<name>]
    [\-\-add\-container\-label=<label>...]
    [\-\-signing\-key=<key\-file>...]
kiwi\-ng system build help
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
build an image in one step. The build command combines kiwi\(aqs prepare and
create steps in order to build an image with just one command call. The
build command creates the root directory of the image below
\fB<target\-dir>/build/image\-root\fP and if not specified differently writes
a log file \fB<target\-dir>/build/image\-root.log\fP\&. The result image files
are created in the specified target\-dir.
.SH OPTIONS
.INDENT 0.0
.TP
.BI \-\-add\-bootstrap\-package\fB= <name>
specify package to install as part of the early kiwi bootstrap phase.
The option can be specified multiple times
.TP
.BI \-\-add\-container\-label\fB= <name=value>
add a container label in the container configuration metadata. It
overwrites the label with the provided key\-value pair in case it was
already defined in the XML description
.TP
.BI \-\-add\-package\fB= <name>
specify package to add(install). The option can be specified
multiple times
.TP
.BI \-\-add\-repo\fB= <source,type,alias,priority,imageinclude,package_gpgcheck,{signing_keys},components,distribution,repo_gpgcheck>
Add a new repository to the existing repository setup in the XML
description. This option can be specified multiple times.
For details about the provided option values see the \fB\-\-set\-repo\fP
information below
.TP
.BI \-\-add\-repo\-credentials\fB= <user:pass_or_filename>
For \fBuri://user:pass@location\fP type repositories, set the user and
password connected with an add\-repo specification. The first
add\-repo\-credentials is connected with the first add\-repo
specification and so on. If the provided value describes a filename
in the filesystem, the first line of that file is read and used
as credentials information.
.TP
.B  \-\-allow\-existing\-root
Allow to use an existing root directory from an earlier
build attempt. Use with caution this could cause an inconsistent
root tree if the existing contents does not fit to the
former image type setup
.TP
.B  \-\-clear\-cache
delete repository cache for each of the used repositories
before installing any package. This is useful if an image build
should take and validate the signature of the package from the
original repository source for any build. Some package managers
unconditionally trust the contents of the cache, which is ok for
cache data dedicated to one build but in case of kiwi the cache
is shared between multiple image builds on that host for performance
reasons.
.TP
.BI \-\-delete\-package\fB= <name>
specify package to delete. The option can be specified
multiple times
.TP
.BI \-\-description\fB= <directory>
Path to the XML description. This is a directory containing at least
one _config.xml_ or _*.kiwi_ XML file.
.TP
.B  \-\-ignore\-repos
Ignore all repository configurations from the XML description.
Using that option is usually done with a sequence of \-\-add\-repo
options otherwise there are no repositories available for the
image build which would lead to an error.
.TP
.B  \-\-ignore\-repos\-used\-for\-build
Works the same way as \-\-ignore\-repos except that repository
configurations which has the imageonly attribute set to true
will not be ignored.
.TP
.BI \-\-set\-repo\fB= <source,type,alias,priority,imageinclude,package_gpgcheck,{signing_keys},components,distribution,repo_gpgcheck>
Overwrite the first repository entry in the XML description with the
provided information:
.INDENT 7.0
.IP \(bu 2
\fBsource\fP
.sp
source url, pointing to a package repository which must be in a format
supported by the selected package manager. See the URI_TYPES section for
details about the supported source locators.
.IP \(bu 2
\fBtype\fP
.sp
repository type, could be one of \fBrpm\-md\fP, \fBrpm\-dir\fP or \fByast2\fP\&.
.IP \(bu 2
\fBalias\fP
.sp
An alias name for the repository. If not specified kiwi calculates
an alias name as result from a sha sum. The sha sum is used to uniquely
identify the repository, but not very expressive. We recommend to
set an expressive and uniq alias name.
.IP \(bu 2
\fBpriority\fP
.sp
A number indicating the repository priority. How the value is evaluated
depends on the selected package manager. Please refer to the package
manager documentation for details about the supported priority ranges
and their meaning.
.IP \(bu 2
\fBimageinclude\fP
.sp
Set to either \fBtrue\fP or \fBfalse\fP to specify if this repository
should be part of the system image repository setup or not.
.IP \(bu 2
\fBpackage_gpgcheck\fP
.sp
Set to either \fBtrue\fP or \fBfalse\fP to specify if this repository
should validate the package signatures.
.IP \(bu 2
\fB{signing_keys}\fP
.sp
List of signing_keys enclosed in curly brackets and delimited by
semicolon. The reference to a signing key must be provided as URI
format
.IP \(bu 2
\fBcomponents\fP
.sp
Component list for debian based repos as string delimited by a space
.IP \(bu 2
\fBdistribution\fP
.sp
Main distribution name for debian based repos
.IP \(bu 2
\fBrepo_gpgcheck\fP
.sp
Set to either \fBtrue\fP or \fBfalse\fP to specify if this repository
should validate the repository signature.
.UNINDENT
.TP
.BI \-\-set\-repo\-credentials\fB= <user:pass_or_filename>
For \fBuri://user:pass@location\fP type repositories, set the user and
password connected to the set\-repo specification. If the provided
value describes a filename in the filesystem, the first line of that file
is read and used as credentials information.
.TP
.BI \-\-set\-container\-derived\-from\fB= <uri>
Overwrite the source location of the base container for the selected
image type. The setting is only effective if the configured image type
is setup with an initial derived_from reference
.TP
.BI \-\-set\-container\-tag\fB= <name>
Overwrite the container tag in the container configuration.
The setting is only effective if the container configuraiton
provides an initial tag value
.TP
.BI \-\-signing\-key\fB= <key\-file>
set the key file to be trusted and imported into the package
manager database before performing any operation. This is useful
if an image build should take and validate repository and package
signatures during build time. This option can be specified multiple
times
.TP
.BI \-\-target\-dir\fB= <directory>
Path to store the build results.
.UNINDENT
.SH URI_TYPES
.INDENT 0.0
.IP \(bu 2
\fBhttp://\fP | \fBhttps://\fP | \fBftp://\fP
.sp
remote repository delivered via http or ftp protocol.
.IP \(bu 2
\fBobs://\fP
.sp
Open Buildservice repository. The source data is translated into
an http url pointing to \fI\%http://download.opensuse.org\fP\&.
.IP \(bu 2
\fBibs://\fP
.sp
Internal Open Buildservice repository. The source data is translated into
an http url pointing to download.suse.de.
.IP \(bu 2
\fBiso://\fP
.sp
Local iso file. kiwi loop mounts the file and uses the mount point
as temporary directory source type
.IP \(bu 2
\fBdir://\fP
.sp
Local directory
.UNINDENT
.SH AUTHOR
Marcus Schäfer
.SH COPYRIGHT
2022, Marcus Schäfer
.\" Generated by docutils manpage writer.
.