.\" 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 "SWUGENERATOR"  "" ""
.SH NAME
swugenerator \- 
.sp
A host tool to generate SWU update package for SWUpdate.
.SH SYNOPSIS
.INDENT 0.0
.TP
.B usage: SWUGenerator [\-h] [\-K ENCRYPTION_KEY_FILE] [\-k SIGN] \-s SW_DESCRIPTION
[\-a ARTIFACTORY] \-o SWU_FILE [\-c CONFIG]
command
.UNINDENT
.sp
Generator SWU Packages for SWUpdate
.INDENT 0.0
.TP
.B positional arguments:
command               command to be executed, one of : create
.TP
.B optional arguments:
.INDENT 7.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.BI \-K \ ENCRYPTION_KEY_FILE\fR,\fB \ \-\-encryption\-key\-file \ ENCRYPTION_KEY_FILE
AES Key to encrypt artifacts
.TP
.B  \-n\fP,\fB  \-\-no\-compress
Do not compress files
.TP
.BI \-k \ SIGN\fR,\fB \ \-\-sign \ SIGN
RSA key or certificate to sign the SWU
.TP
.BI \-s \ SW_DESCRIPTION\fR,\fB \ \-\-sw\-description \ SW_DESCRIPTION
sw\-description template
.TP
.B  \-t\fP,\fB  \-\-encrypt\-swdesc
Encrypt sw\-description
.TP
.BI \-a \ ARTIFACTORY\fR,\fB \ \-\-artifactory \ ARTIFACTORY
list of directories where artifacts are searched
.TP
.BI \-o \ SWU_FILE\fR,\fB \ \-\-swu\-file \ SWU_FILE
SWU output file
.TP
.BI \-c \ CONFIG\fR,\fB \ \-\-config \ CONFIG
configuration file
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
\fBswugenerator\fP is a tool running on host to create and modify SWUpdate\(aqs Update
files (SWU). SWU file contains a meta description of the release (\fBsw\-description\fP),
and swugenerator adds components to a template passed from command line.
This tool requires \fIopenssl\fP to run and to sign the SWU. It is goal of the tool to fill
the gap with Yocto/OE, where SWU generation is done by classes in the meta\-swupdate layer,
but other buildsystems like Debian or Buildroot have no tools to create a SWU.
.sp
The tool signs the SWU and can encrypt the artifacts. The tool parses the libconf based sw\-description (tool does not work for JSON based sw\-description) and provides the following features:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
replace occurrencies of variables found in the CONFIG file
.IP \(bu 2
add sha256 to each artifact
.IP \(bu 2
check if an artifact should be encrypted and encrypts it
.IP \(bu 2
sign sw\-description with one of the methods accepted by SWUpdate
.IP \(bu 2
pack all artifacts into a SWU file
.UNINDENT
.UNINDENT
.UNINDENT