56 lines
2.2 KiB
Groff
56 lines
2.2 KiB
Groff
.TH ARKDEP 8 "21 April 2024"
|
|
.SH NAME
|
|
arkdep - Manage arkdep deployments
|
|
.SH SYNOPSIS
|
|
\fBarkdep\fR {option} <version>...
|
|
.br
|
|
\fBarkdep\fR {option} [variant] [version]
|
|
.br
|
|
\fBarkdep\fR {option} [variant] [variant]
|
|
.SH DESCRIPTION
|
|
Arkdep is a utility which downloads, deploys and manages Btrfs subvolume exports.
|
|
|
|
It is able to perform atomic and immutable system updates, migrate local data to new deployments, update the systemd-boot bootloader configuration and switch the by default booted root subvolume through EFI variables.
|
|
.SH OPTIONS
|
|
.SS deploy
|
|
Deploy a new or update an existing deployment.
|
|
.SS init
|
|
Initialize arkdep on a new system.
|
|
.SS teardown
|
|
Remove all arkdep-deploy related files and folders.
|
|
.SS cleanup
|
|
Remove any hanging images, unfinished downloads and untracked deployments.
|
|
.SS healthcheck
|
|
Check for and report any config issues or untracked deployments.
|
|
.SS get-available
|
|
Get and print available variants in repo.
|
|
.SS diff
|
|
Generate and print diff between two deployments.
|
|
.SS remove
|
|
Remove specified deployments.
|
|
.SH ENVIRONMENT
|
|
.SS ARKDEP_ROOT
|
|
Prepend path to arkdep target directory.
|
|
.SS ARKDEP_BOOT
|
|
Set custom /boot location, overwrites ARKDEP_ROOT on relevant tasks if set, implies ARKDEP_NO_BOOTCTL.
|
|
.SS ARKDEP_NO_BOOTCTL
|
|
Do not run bootctl commands, this includes installing systemd-boot and setting the new deployment as the default boot entry.
|
|
.SH EXAMPLES
|
|
.SS arkdep deploy
|
|
Check for updates, if available download and deploy.
|
|
.SS arkdep deploy test-arkanelinux-kde
|
|
Download and deploy the latest version of the defined image variant.
|
|
.SS arkdep deploy - stable_v1
|
|
Download the defined image version from the default variant.
|
|
.SS arkdep deploy test-arkanelinux-kde stable_v1
|
|
Download the defined image version from the specified variant.
|
|
.SS arkdep deploy cache stable_v1
|
|
Deploy an image from the local cache skipping database download and checksum check.
|
|
.SS arkdep remove stable_v1
|
|
Remove the defined deployment.
|
|
.SS arkdep diff
|
|
Generate diff between currently active deployment and latest default variant.
|
|
.SS arkdep diff test-arkanelinux-kde
|
|
Generate diff between current deployment and specified variant.
|
|
.SS arkdep diff test-arkanelinux-kde arkanelinux
|
|
Generate diff between two specified variants.
|