robojerk
a23b4e53fd
Some checks failed
Compile apt-layer (v2) / compile (push) Has been cancelled
- Added 20-daemon-integration.sh scriptlet for D-Bus and daemon lifecycle management - Updated 99-main.sh with new daemon subcommands (start, stop, status, install, uninstall, test, layer, deploy, upgrade, rollback) - Enhanced help and usage text for daemon integration - Fixed bash syntax errors in daemon integration scriptlet - Updated compile.sh to include daemon integration in build process - Updated .gitignore to exclude src/rpm-ostree/ reference source - Updated CHANGELOG.md and TODO.md to document daemon integration milestone - Removed src/rpm-ostree/ from git tracking (reference only, not committed)
5.8 KiB
5.8 KiB
Man Pages
This section contains the manual pages for rpm-ostree and related components. These man pages provide detailed command-line reference documentation for all rpm-ostree tools and configuration files.
Overview
The man pages provide comprehensive reference documentation for:
- Command-line tools: Complete syntax and options for all rpm-ostree commands
- Configuration files: Detailed configuration options and examples
- System services: Service units and their configuration
- File formats: Configuration file syntax and structure
Available Man Pages
Command-Line Tools
- rpm-ostree(1) - Main rpm-ostree command-line tool
- rpm-ostree-countme.service(8) - Usage statistics collection service
Configuration Files
- rpm-ostreed.conf(5) - Daemon configuration file
System Services
- rpm-ostreed-automatic.service(8) - Automatic updates service
- rpm-ostreed-automatic.timer(8) - Automatic updates timer
Man Page Sections
Section 1: User Commands
Commands that can be executed by any user:
- rpm-ostree(1): Main command-line interface
Section 5: File Formats
Configuration files and their formats:
- rpm-ostreed.conf(5): Daemon configuration
Section 8: System Administration
System administration commands and services:
- rpm-ostree-countme.service(8): Usage statistics service
- rpm-ostreed-automatic.service(8): Automatic updates service
- rpm-ostreed-automatic.timer(8): Automatic updates timer
Usage Examples
Quick Reference
# Show system status
rpm-ostree status
# Upgrade system
rpm-ostree upgrade --reboot
# Install package
rpm-ostree install package-name --reboot
# Rollback to previous deployment
rpm-ostree rollback --reboot
# Check for updates
rpm-ostree upgrade --check
Configuration Examples
# /etc/rpm-ostreed.conf
[Daemon]
AutomaticUpdatePolicy=check
IdleExitTimeout=60
LockLayering=false
Recommends=true
Service Management
# Enable automatic updates
systemctl enable rpm-ostreed-automatic.timer --now
# Check service status
systemctl status rpm-ostreed-automatic.service
# View service logs
journalctl -u rpm-ostreed-automatic.service
Command Categories
System Management
- status: Display system status and deployments
- upgrade: Download and deploy system updates
- rollback: Rollback to previous deployment
- deploy: Deploy specific version or commit
Package Management
- install: Install packages into layered deployment
- uninstall: Remove packages from layered deployment
- search: Search for available packages
- override: Override base packages
System Configuration
- kargs: Manage kernel arguments
- initramfs: Manage initramfs generation
- initramfs-etc: Add files to initramfs
- reload: Reload daemon configuration
Advanced Operations
- rebase: Switch to different base image
- apply-live: Apply changes to running system
- usroverlay: Mount writable overlay on /usr
- cleanup: Clean up deployments and cache
Database Operations
- db: Query RPM database in deployments
- refresh-md: Refresh repository metadata
Configuration Reference
Daemon Configuration
The rpm-ostreed.conf file controls daemon behavior:
- AutomaticUpdatePolicy: Controls automatic update behavior
- IdleExitTimeout: Time before daemon exits when idle
- LockLayering: Disable package layering operations
- Recommends: Install weak dependencies during layering
Automatic Updates
The automatic update system consists of:
- rpm-ostreed-automatic.service: Service that performs updates
- rpm-ostreed-automatic.timer: Timer that triggers updates
- Configuration: Controlled via
rpm-ostreed.conf
Related Documentation
External References
- ostree(1): OSTree command-line tool
- rpm(8): RPM package manager
- systemd.timer(5): Systemd timer units
Internal References
- Administrator Handbook: System administration guide
- Architecture Documentation: System architecture
- Contributing Guide: Development documentation
Man Page Format
Each man page follows the standard Unix man page format:
Structure
- Name: Command or file name and brief description
- Synopsis: Command syntax or file format
- Description: Detailed explanation
- Options: Command-line options and arguments
- Examples: Usage examples
- Files: Related files and directories
- See Also: Related commands and documentation
Formatting
- Bold text: Commands, options, and file names
- Italic text: Variables and placeholders
- Code blocks: Examples and configuration snippets
- Lists: Options and parameters
Contributing
Adding New Man Pages
- Create file: Add new man page file with appropriate section number
- Follow format: Use standard man page structure
- Include examples: Provide practical usage examples
- Cross-reference: Link to related documentation
Updating Existing Man Pages
- Check accuracy: Verify all information is current
- Add examples: Include practical usage examples
- Update references: Ensure all links are valid
- Test commands: Verify all examples work correctly
These man pages provide comprehensive reference documentation for all rpm-ostree components. They serve as the authoritative source for command-line usage and configuration.