robojerk
3dec23f8f7
- Fix trailing spaces and blank lines in Forgejo workflows - Update system requirements from Ubuntu Jammy/Bookworm to Debian 13+ (Trixie) - Update test treefile to use Debian Trixie instead of Ubuntu Jammy - Update documentation to reflect modern system requirements - Fix yamllint errors for CI/CD functionality - Ensure compatibility with modern OSTree and libapt versions
150 lines
3.7 KiB
Groff
150 lines
3.7 KiB
Groff
.TH APT-OSTREE-DEV 1 "2025-08-13" "apt-ostree 0.1.0" "System Administration"
|
|
.SH NAME
|
|
apt-ostree-dev \- Development and debugging commands for apt-ostree
|
|
.SH SYNOPSIS
|
|
.B apt-ostree
|
|
\fICOMMAND\fR [\fIARGS\fR]
|
|
.SH DESCRIPTION
|
|
.B apt-ostree-dev
|
|
describes the development and debugging commands available in apt-ostree.
|
|
These commands are hidden from normal help output and are intended for
|
|
developers and system administrators debugging apt-ostree installations.
|
|
.PP
|
|
These commands provide low-level access to system internals, testing utilities,
|
|
and diagnostic tools that are not part of the standard user interface.
|
|
.SH DEVELOPMENT COMMANDS
|
|
.SS "testutils"
|
|
Development and testing utilities for apt-ostree.
|
|
.TP
|
|
.B testutils inject-pkglist \fICOMMIT\fR \fIPACKAGES\fR
|
|
Inject a package list into an OSTree commit's metadata.
|
|
.TP
|
|
.B testutils script-shell \fISCRIPT\fR [\fIARGS\fR] [\fIOPTIONS\fR]
|
|
Execute a script in a bubblewrap container with various options.
|
|
.TP
|
|
.B testutils generate-synthetic-upgrade
|
|
Generate a synthetic upgrade for testing purposes.
|
|
.TP
|
|
.B testutils integration-read-only
|
|
Run integration tests in read-only mode.
|
|
.TP
|
|
.B testutils c-units
|
|
Run C unit tests if available.
|
|
.TP
|
|
.B testutils moo
|
|
Perform basic functionality tests.
|
|
|
|
.SS "shlib-backend"
|
|
Shared library backend operations for IPC and system integration.
|
|
.TP
|
|
.B shlib-backend get-basearch
|
|
Get the system's base architecture.
|
|
.TP
|
|
.B shlib-backend varsubst-basearch \fISOURCE\fR
|
|
Perform variable substitution for architecture-specific strings.
|
|
.TP
|
|
.B shlib-backend packagelist-from-commit \fICOMMIT\fR
|
|
Extract package list from an OSTree commit.
|
|
|
|
.SS "internals"
|
|
Internal system diagnostics and validation.
|
|
.TP
|
|
.B internals diagnostics
|
|
Run comprehensive system diagnostics.
|
|
.TP
|
|
.B internals validate-state
|
|
Validate system state consistency.
|
|
.TP
|
|
.B internals debug-dump
|
|
Dump comprehensive system information for debugging.
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
.B \-\-rootpath \fIPATH\fR
|
|
Set the root path for script execution (default: /).
|
|
.TP
|
|
.B \-\-read-only
|
|
Execute in read-only mode.
|
|
.TP
|
|
.B \-\-user \fIUSER\fR
|
|
Execute as specified user.
|
|
.TP
|
|
.B \-\-group \fIGROUP\fR
|
|
Execute as specified group.
|
|
.TP
|
|
.B \-\-cwd \fIPATH\fR
|
|
Set working directory for execution.
|
|
.TP
|
|
.B \-\-env \fIKEY=VALUE\fR
|
|
Set environment variables.
|
|
|
|
.SH EXAMPLES
|
|
.TP
|
|
Inject package list into commit:
|
|
.B apt-ostree testutils inject-pkglist abc123 "apt,curl,nginx"
|
|
.TP
|
|
Execute script in container:
|
|
.B apt-ostree testutils script-shell /tmp/test.sh --read-only
|
|
.TP
|
|
Get system architecture:
|
|
.B apt-ostree shlib-backend get-basearch
|
|
.TP
|
|
Run system diagnostics:
|
|
.B apt-ostree internals diagnostics
|
|
|
|
.SH FILES
|
|
.TP
|
|
.B /usr/bin/bubblewrap
|
|
Bubblewrap binary for containerization.
|
|
.TP
|
|
.B /usr/bin/objcopy
|
|
Binutils objcopy for ELF manipulation.
|
|
.TP
|
|
.B /var/lib/apt-ostree/
|
|
Data directory for apt-ostree.
|
|
|
|
.SH ENVIRONMENT
|
|
.TP
|
|
.B APT_OSTREE_DEV_MODE
|
|
Enable development mode features.
|
|
.TP
|
|
.B APT_OSTREE_LOG_LEVEL
|
|
Set logging level for debugging.
|
|
|
|
.SH EXIT STATUS
|
|
.TP
|
|
.B 0
|
|
Success.
|
|
.TP
|
|
.B 1
|
|
General error.
|
|
.TP
|
|
.B 2
|
|
Invalid arguments.
|
|
.TP
|
|
.B 3
|
|
System operation failed.
|
|
|
|
.SH SECURITY
|
|
These commands provide low-level access to system internals and should only
|
|
be used by trusted administrators. The script-shell command executes code in
|
|
isolated containers, but care should be taken with the scripts being executed.
|
|
|
|
.SH BUGS
|
|
Report bugs to the project issue tracker at
|
|
.IR https://github.com/robojerk/apt-ostree/issues .
|
|
|
|
.SH AUTHOR
|
|
Written by Robojerk <robojerk@example.com>.
|
|
|
|
.SH COPYRIGHT
|
|
Copyright \(co 2025 Robojerk. License GPL-3.0-or-later: GNU GPL version 3 or later
|
|
<https://gnu.org/licenses/gpl.html>.
|
|
This is free software: you are free to change and redistribute it.
|
|
There is NO WARRANTY, to the extent permitted by law.
|
|
|
|
.SH SEE ALSO
|
|
.BR apt-ostree (1),
|
|
.BR bubblewrap (1),
|
|
.BR objcopy (1),
|
|
.BR ostree (1)
|