1
0
mirror of https://gitlab.alpinelinux.org/alpine/cloud/tiny-cloud.git synced 2025-12-15 11:22:43 +03:00

Merge branch 'man-pages' into 'main'

Draft: docs: add initial manpage for tiny-cloud.8

See merge request alpine/cloud/tiny-cloud!106
This commit is contained in:
Natanael Copa 2025-09-08 02:59:49 +00:00
commit 730c658055

58
docs/tiny-cloud.8.scd Normal file
View File

@ -0,0 +1,58 @@
TINY-CLOUD(1)
# NAME
tiny-cloud - perform critical initialization tasks for cloud instances
# SYNOPSIS
*tiny-cloud* [-h | --help] { boot | early | main | final | --bootstrap {complete|incomplete|status} | --enable | --disable }
# DESCRIPTION
*tiny-cloud* performs critical initialization tasks for cloud instaces during
their first boot. *tiny-cloud* is designed to run in different stages during
first boot.
# COMMANDS
*boot*
Initiate the boot process of the cloud instance.
*early*
Perform early-stage operations in the boot process.
*main*
Execute main-stage operations during the boot process.
*final*
Conduct final-stage operations, completing the boot process.
# OPTIONS
*-h, --help*
Display help information.
*--bootstrap* {_complete|incomplete|status_}
Manage the bootstrap state of the instance.
_complete_
Mark the bootstrap process as complete.
_incomplete_
Mark the bootstrap process as incomplete.
_status_
Display the current status of the bootstrap process.
*--enable*
Enable the cloud instance, allowing it to be managed or accessed.
*--disable*
Disable the cloud instance, preventing it from being managed or accessed.
# EXIT STATUS
*tiny-cloud* exists 0 on success and >0 on error.