apt-ostree/debian/apt-ostree.1
joe 76467ece47 feat: Implement comprehensive Debian packaging improvements and enhanced CI workflow
- Enhanced Package Information: Expanded PackageInfo struct with 23 fields including section, priority, maintainer, homepage, size, dependencies, and more
- Real Package Data Extraction: Integrated dpkg and apt-cache for actual package information instead of mock data
- Professional Debian Packaging: Added man pages, shell completions, postinst/prerm scripts, triggers, and lintian overrides
- Enhanced Build System: Improved debian/rules with cross-compilation support, enhanced build.sh with options and validation
- CI Workflow Updates: Added missing build dependencies, enhanced package validation, lintian quality checks, and comprehensive reporting
- Quality Assurance: Added lintian validation, enhanced file checking, and professional packaging standards
- Documentation: Comprehensive README.Debian with build instructions and troubleshooting guide

Resolves mock package issues and provides production-ready Debian packaging infrastructure.
2025-08-15 14:05:37 -07:00

130 lines
3.1 KiB
Groff

.TH APT-OSTREE 1 "2025-08-13" "apt-ostree 0.1.0" "System Administration"
.SH NAME
apt-ostree \- Debian/Ubuntu equivalent of rpm-ostree
.SH SYNOPSIS
.B apt-ostree
[\fIOPTIONS\fR] \fICOMMAND\fR [\fIARGS\fR]
.SH DESCRIPTION
.B apt-ostree
is a tool for managing atomic, immutable deployments on Debian and Ubuntu systems
using OSTree as the backend. It provides functionality similar to rpm-ostree but
adapted for APT package management, enabling atomic updates and rollbacks on
Debian-based systems.
.PP
The tool integrates APT package management with OSTree's atomic deployment model,
allowing system administrators to maintain immutable system images while still
benefiting from Debian's package ecosystem.
.SH COMMANDS
.TP
.B info \fIPACKAGE\fR
Display detailed information about a package, including dependencies, conflicts,
and metadata.
.TP
.B search \fIQUERY\fR
Search for packages in the APT repositories.
.TP
.B install \fIPACKAGES\fR
Install packages and create a new OSTree deployment.
.TP
.B remove \fIPACKAGES\fR
Remove packages and create a new OSTree deployment.
.TP
.B upgrade
Upgrade all packages and create a new OSTree deployment.
.TP
.B rollback
Rollback to the previous OSTree deployment.
.TP
.B status
Show the current OSTree deployment status.
.SH OPTIONS
.TP
.B \-h, \-\-help
Show help message and exit.
.TP
.B \-V, \-\-version
Show version information and exit.
.TP
.B \-\-verbose
Enable verbose output.
.TP
.B \-\-quiet
Suppress non-error messages.
.SH EXAMPLES
.TP
Show package information:
.B apt-ostree info apt
.TP
Search for packages:
.B apt-ostree search curl
.TP
Install a package:
.B apt-ostree install nginx
.TP
Remove a package:
.B apt-ostree remove apache2
.TP
Upgrade all packages:
.B apt-ostree upgrade
.TP
Rollback to previous deployment:
.B apt-ostree rollback
.SH FILES
.TP
.B /etc/apt-ostree/
Configuration directory for apt-ostree.
.TP
.B /var/lib/apt-ostree/
Data directory for apt-ostree.
.TP
.B /ostree/
OSTree repository and deployments.
.SH ENVIRONMENT
.TP
.B APT_OSTREE_CONFIG
Path to configuration file (default: /etc/apt-ostree/config.toml).
.TP
.B APT_OSTREE_DATA_DIR
Path to data directory (default: /var/lib/apt-ostree).
.TP
.B APT_OSTREE_LOG_LEVEL
Log level for debugging (default: info).
.SH EXIT STATUS
.TP
.B 0
Success.
.TP
.B 1
General error.
.TP
.B 2
Configuration error.
.TP
.B 3
Package operation failed.
.TP
.B 4
OSTree operation failed.
.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 ostree (1),
.BR apt (8),
.BR dpkg (1),
.BR rpm-ostree (1)
.PP
The full documentation for apt-ostree is maintained as a Texinfo manual.
If the info and apt-ostree programs are properly installed at your site,
the command
.IP
.B info apt-ostree
.PP
should give you access to the complete manual.