<commit_before>.TH RAUC 1

.SH NAME
rauc \- safe and secure updating

.SH SYNOPSIS
.B rauc
[\fIOPTIONS\fR...] \fBbundle\fR \fIINPUTDIR\fR \fIBUNDLE\fR

.B rauc
[\fIOPTIONS\fR...] \fBresign\fR \fIBUNDLE\fR

.B rauc
[\fIOPTIONS\fR...] \fBextract\fR \fIBUNDLE\fR \fIOUTPUTDIR\fR

.B rauc
[\fIOPTIONS\fR...] \fBconvert\fR \fIINBUNDLE\fR \fIOUTBUNDLE\fR

.B rauc
[\fIOPTIONS\fR...] \fBinstall\fR \fIBUNDLE\fR

.B rauc
[\fIOPTIONS\fR...] \fBinfo\fR \fIBUNDLE\fR

.B rauc
[\fIOPTIONS\fR...] \fBstatus\fR [\fISLOTNAME\fR | \fBmark-{good,bad,active}\fR [\fBbooted\fR|\fBother\fR|\fISLOTNAME\fR]]

.B rauc
[\fIOPTIONS\fR...] \fBwrite-slot\fR \fISLOTNAME\fR \fIIMAGEFILE\fR

.SH DESCRIPTION

RAUC is a lightweight update client that runs on an Embedded Linux device and
reliably controls the procedure of updating the device with a new firmware.

RAUC is also the tool on the host system that is used to create, inspect and
modify update artifacts for the device.

This manual page documents briefly the
.BR rauc
command line utility.

It was written for the Debian GNU/Linux distribution to satisfy the
packaging requirements. Thus it should only serve as a summary,
reading the comprehensive online manual (\fBhttps://rauc.readthedocs.io/\fR)
is recommended.

.SH OPTIONS

The following general options can be used with most commands, however
not all combinations make sense.

.TP
\fB\-c\fR \fIFILENAME\fR, \fB\-\-conf=\fR\fIFILENAME\fR
use the given config file instead of the one at the compiled-in default path

.TP
\fB\-\-cert=\fR\fIPEMFILE\fR|\fIPKCS11-URL\fR
use given certificate file or the certificate referenced by the given PKCS#11 URL

.TP
\fB\-\-key=\fR\fIPEMFILE\fR|\fIPKCS11-URL\fR
use given private key file or the key referenced by the given PKCS#11 URL

.TP
\fB\-\-keyring=\fR\fIPEMFILE\fR
use specific keyring file

.TP
\fB\-\-intermediate=\fR\fIPEMFILE\fR
intermediate CA file name

.TP
\fB\-\-mount=\fR\fIPATH\fR
mount prefix

.TP
\fB\-\-override\-boot\-slot=\fR\fIBOOTNAME\fR
overrides auto-detection of booted slot

.TP
\fB\-\-handler\-args=\fR\fIARGS\fR
pass extra handler arguments

.TP
\fB\-d\fR, \fB\-\-debug\fR
enable debug output

.TP
\fB\-\-version\fR
display version

.TP
\fB\-h\fR, \fB\-\-help\fR
print usage

.SH COMMANDS

.PP
\fBbundle\fR \fIINPUTDIR\fR \fIBUNDLE\fR

.RS 4
Create a bundle from a content directory.

\fBOptions:\fR

.RS 4

.TP
\fB\-\-signing\-keyring=\fR\fIPEMFILE\fR
verification keyring file

.TP
\fB\-\-mksquashfs\-args=\fR\fIARGS\fR
mksquashfs extra args

.RE
.RE
.PP
\fBresign\fR \fIBUNDLE\fR

.RS 4
Resign an already signed bundle.

\fBOptions:\fR

.RS 4

.TP
\fB\-\-no\-verify\fR
disable bundle verification

.TP
\fB\-\-signing\-keyring=\fR\fIPEMFILE\fR
verification keyring file

.RE
.RE
.PP
\fBextract\fR \fIBUNDLE\fR \fIOUTPUTDIR\fR

.RS 4
Extract the bundle content to a directory.

.RE
.PP
\fBconvert\fR \fIINBUNDLE\fR \fIOUTBUNDLE\fR

.RS 4
Convert an existing bundle to casync index bundle and store.

\fBOptions:\fR

.RS 4

.TP
\fB\-\-signing\-keyring=\fR\fIPEMFILE\fR
verification keyring file

.TP
\fB\-\-mksquashfs\-args=\fR\fIARGS\fR
mksquashfs extra args

.TP
\fB\-\-casync\-args=\fR\fIARGS\fR
casync extra args

.RE
.RE
.PP
\fBinstall\fR \fIBUNDLE\fR

.RS 4
Install a bundle.

\fBOptions:\fR

.RS 4

.TP
\fB\-\-ignore\-compatible\fR
disable compatible check

.TP
\fB\-\-progress\fR
show progress bar

.RE
.RE
.PP
\fBinfo\fR \fIBUNDLE\fR

.RS 4
Print bundle info.

\fBOptions:\fR

.RS 4

.TP
\fB\-\-no\-verify\fR
disable bundle verification

.TP
\fB\-\-output\-format=\fR[\fBreadable\fR|\fBshell\fR|\fBjson\fR|\fBjson-pretty\fR]
select output format

.TP
\fB\-\-dump\-cert\fR
dump certificate

.RE
.RE
.PP
\fBstatus\fR [\fISLOTNAME\fR | \fBmark-{good,bad,active}\fR [\fBbooted\fR|\fBother\fR|\fISLOTNAME\fR]]

.RS 4<commit_msg>manpage: fix minor styling issue<commit_after>.TH RAUC 1

.SH NAME
rauc \- safe and secure updating

.SH SYNOPSIS
.B rauc
[\fIOPTIONS\fR...] \fBbundle\fR \fIINPUTDIR\fR \fIBUNDLE\fR

.B rauc
[\fIOPTIONS\fR...] \fBresign\fR \fIBUNDLE\fR

.B rauc
[\fIOPTIONS\fR...] \fBextract\fR \fIBUNDLE\fR \fIOUTPUTDIR\fR

.B rauc
[\fIOPTIONS\fR...] \fBconvert\fR \fIINBUNDLE\fR \fIOUTBUNDLE\fR

.B rauc
[\fIOPTIONS\fR...] \fBinstall\fR \fIBUNDLE\fR

.B rauc
[\fIOPTIONS\fR...] \fBinfo\fR \fIBUNDLE\fR

.B rauc
[\fIOPTIONS\fR...] \fBstatus\fR [\fISLOTNAME\fR | \fBmark-\fR{\fBgood\fR,\fBbad\fR,\fBactive\fR} [\fBbooted\fR|\fBother\fR|\fISLOTNAME\fR]]

.B rauc
[\fIOPTIONS\fR...] \fBwrite-slot\fR \fISLOTNAME\fR \fIIMAGEFILE\fR

.SH DESCRIPTION

RAUC is a lightweight update client that runs on an Embedded Linux device and
reliably controls the procedure of updating the device with a new firmware.

RAUC is also the tool on the host system that is used to create, inspect and
modify update artifacts for the device.

This manual page documents briefly the
.BR rauc
command line utility.

It was written for the Debian GNU/Linux distribution to satisfy the
packaging requirements. Thus it should only serve as a summary,
reading the comprehensive online manual (\fBhttps://rauc.readthedocs.io/\fR)
is recommended.

.SH OPTIONS

The following general options can be used with most commands, however
not all combinations make sense.

.TP
\fB\-c\fR \fIFILENAME\fR, \fB\-\-conf=\fR\fIFILENAME\fR
use the given config file instead of the one at the compiled-in default path

.TP
\fB\-\-cert=\fR\fIPEMFILE\fR|\fIPKCS11-URL\fR
use given certificate file or the certificate referenced by the given PKCS#11 URL

.TP
\fB\-\-key=\fR\fIPEMFILE\fR|\fIPKCS11-URL\fR
use given private key file or the key referenced by the given PKCS#11 URL

.TP
\fB\-\-keyring=\fR\fIPEMFILE\fR
use specific keyring file

.TP
\fB\-\-intermediate=\fR\fIPEMFILE\fR
intermediate CA file name

.TP
\fB\-\-mount=\fR\fIPATH\fR
mount prefix

.TP
\fB\-\-override\-boot\-slot=\fR\fIBOOTNAME\fR
overrides auto-detection of booted slot

.TP
\fB\-\-handler\-args=\fR\fIARGS\fR
pass extra handler arguments

.TP
\fB\-d\fR, \fB\-\-debug\fR
enable debug output

.TP
\fB\-\-version\fR
display version

.TP
\fB\-h\fR, \fB\-\-help\fR
print usage

.SH COMMANDS

.PP
\fBbundle\fR \fIINPUTDIR\fR \fIBUNDLE\fR

.RS 4
Create a bundle from a content directory.

\fBOptions:\fR

.RS 4

.TP
\fB\-\-signing\-keyring=\fR\fIPEMFILE\fR
verification keyring file

.TP
\fB\-\-mksquashfs\-args=\fR\fIARGS\fR
mksquashfs extra args

.RE
.RE
.PP
\fBresign\fR \fIBUNDLE\fR

.RS 4
Resign an already signed bundle.

\fBOptions:\fR

.RS 4

.TP
\fB\-\-no\-verify\fR
disable bundle verification

.TP
\fB\-\-signing\-keyring=\fR\fIPEMFILE\fR
verification keyring file

.RE
.RE
.PP
\fBextract\fR \fIBUNDLE\fR \fIOUTPUTDIR\fR

.RS 4
Extract the bundle content to a directory.

.RE
.PP
\fBconvert\fR \fIINBUNDLE\fR \fIOUTBUNDLE\fR

.RS 4
Convert an existing bundle to casync index bundle and store.

\fBOptions:\fR

.RS 4

.TP
\fB\-\-signing\-keyring=\fR\fIPEMFILE\fR
verification keyring file

.TP
\fB\-\-mksquashfs\-args=\fR\fIARGS\fR
mksquashfs extra args

.TP
\fB\-\-casync\-args=\fR\fIARGS\fR
casync extra args

.RE
.RE
.PP
\fBinstall\fR \fIBUNDLE\fR

.RS 4
Install a bundle.

\fBOptions:\fR

.RS 4

.TP
\fB\-\-ignore\-compatible\fR
disable compatible check

.TP
\fB\-\-progress\fR
show progress bar

.RE
.RE
.PP
\fBinfo\fR \fIBUNDLE\fR

.RS 4
Print bundle info.

\fBOptions:\fR

.RS 4

.TP
\fB\-\-no\-verify\fR
disable bundle verification

.TP
\fB\-\-output\-format=\fR[\fBreadable\fR|\fBshell\fR|\fBjson\fR|\fBjson-pretty\fR]
select output format

.TP
\fB\-\-dump\-cert\fR
dump certificate

.RE
.RE
.PP
\fBstatus\fR [\fISLOTNAME\fR | \fBmark-\fR{\fBgood\fR,\fBbad\fR,\fBactive\fR} [\fBbooted\fR|\fBother\fR|\fISLOTNAME\fR]]

.RS 4
{'fraction_non_alphanumeric': 0.14240796541333683, 'fraction_numerical': 0.00550242368662387, 'mean_word_length': 3.0031463030938648, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '426876', 'n_tokens_mistral': 3492, 'n_tokens_neox': 3200, 'n_words': 845}