Merge pull request #233 from cgwalters/generate-markdown-docs

docs: Generate docs/man

docs/man/README.md

@@ -0,0 +1,6 @@
+# Auto-generated manpages
+
+These markdown files are automatically generated via
+`cargo xtask man2markdown`.
+
+Start with [bootc.md](bootc.md).

docs/man/bootc-edit.md

@@ -0,0 +1,34 @@
+# NAME
+
+bootc-edit - Change host specification
+
+# SYNOPSIS
+
+**bootc-edit** \[**-f**\|**\--filename**\] \[**\--quiet**\]
+\[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
+
+# DESCRIPTION
+
+Change host specification
+
+# OPTIONS
+
+**-f**, **\--filename**=*FILENAME*
+
+:   Use filename to edit system specification
+
+**\--quiet**
+
+:   Dont display progress
+
+**-h**, **\--help**
+
+:   Print help
+
+**-V**, **\--version**
+
+:   Print version
+
+# VERSION
+
+v0.1.0

docs/man/bootc-install-to-disk.md

@@ -0,0 +1,111 @@
+# NAME
+
+bootc-install-to-disk - Install to the target block device
+
+# SYNOPSIS
+
+**bootc-install-to-disk** \[**\--wipe**\] \[**\--block-setup**\]
+\[**\--filesystem**\] \[**\--root-size**\] \[**\--target-transport**\]
+\[**\--target-imgref**\] \[**\--target-no-signature-verification**\]
+\[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]
+\[**\--disable-selinux**\] \[**\--karg**\] \[**\--generic-image**\]
+\[**-h**\|**\--help**\] \[**-V**\|**\--version**\] \<*DEVICE*\>
+
+# DESCRIPTION
+
+Install to the target block device
+
+# OPTIONS
+
+**\--wipe**
+
+:   Automatically wipe all existing data on device
+
+**\--block-setup**=*BLOCK_SETUP* \[default: direct\]
+
+:   Target root block device setup.
+
+direct: Filesystem written directly to block device tpm2-luks: Bind
+unlock of filesystem to presence of the default tpm2 device.\
+
+\
+\[*possible values: *direct, tpm2-luks\]
+
+**\--filesystem**=*FILESYSTEM*
+
+:   Target root filesystem type\
+
+\
+\[*possible values: *xfs, ext4, btrfs\]
+
+**\--root-size**=*ROOT_SIZE*
+
+:   Size of the root partition (default specifier: M). Allowed
+    specifiers: M (mebibytes), G (gibibytes), T (tebibytes).
+
+By default, all remaining space on the disk will be used.
+
+**\--target-transport**=*TARGET_TRANSPORT* \[default: registry\]
+
+:   The transport; e.g. oci, oci-archive. Defaults to \`registry\`
+
+**\--target-imgref**=*TARGET_IMGREF*
+
+:   Specify the image to fetch for subsequent updates
+
+**\--target-no-signature-verification**
+
+:   Explicitly opt-out of requiring any form of signature verification
+
+**\--target-ostree-remote**=*TARGET_OSTREE_REMOTE*
+
+:   Enable verification via an ostree remote
+
+**\--skip-fetch-check**
+
+:   By default, the accessiblity of the target image will be verified
+    (just the manifest will be fetched). Specifying this option
+    suppresses the check; use this when you know the issues it might
+    find are addressed.
+
+Two main reasons this might fail:
+
+\- Forgetting \`\--target-no-signature-verification\` if needed - Using
+a registry which requires authentication, but not embedding the pull
+secret in the image.
+
+**\--disable-selinux**
+
+:   Disable SELinux in the target (installed) system.
+
+This is currently necessary to install \*from\* a system with SELinux
+disabled but where the target does have SELinux enabled.
+
+**\--karg**=*KARG*
+
+:   Add a kernel argument
+
+**\--generic-image**
+
+:   Perform configuration changes suitable for a \"generic\" disk image.
+    At the moment:
+
+\- All bootloader types will be installed - Changes to the system
+firmware will be skipped
+
+**-h**, **\--help**
+
+:   Print help (see a summary with -h)
+
+**-V**, **\--version**
+
+:   Print version
+
+\<*DEVICE*\>
+
+:   Target block device for installation. The entire device will be
+    wiped
+
+# VERSION
+
+v0.1.0

docs/man/bootc-install-to-filesystem.md

@@ -0,0 +1,122 @@
+# NAME
+
+bootc-install-to-filesystem - Install to the target filesystem
+
+# SYNOPSIS
+
+**bootc-install-to-filesystem** \[**\--root-mount-spec**\]
+\[**\--root-options**\] \[**\--boot-mount-spec**\] \[**\--replace**\]
+\[**\--target-transport**\] \[**\--target-imgref**\]
+\[**\--target-no-signature-verification**\]
+\[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]
+\[**\--disable-selinux**\] \[**\--karg**\] \[**\--generic-image**\]
+\[**-h**\|**\--help**\] \[**-V**\|**\--version**\] \<*ROOT_PATH*\>
+
+# DESCRIPTION
+
+Install to the target filesystem
+
+# OPTIONS
+
+**\--root-mount-spec**=*ROOT_MOUNT_SPEC*
+
+:   Source device specification for the root filesystem. For example,
+    UUID=2e9f4241-229b-4202-8429-62d2302382e1
+
+**\--root-options**=*ROOT_OPTIONS*
+
+:   Comma-separated mount options for the root filesystem. For example:
+    rw,prjquota
+
+**\--boot-mount-spec**=*BOOT_MOUNT_SPEC*
+
+:   Mount specification for the /boot filesystem.
+
+At the current time, a separate /boot is required. This restriction will
+be lifted in future versions. If not specified, the filesystem UUID will
+be used.
+
+**\--replace**=*REPLACE*
+
+:   Initialize the system in-place; at the moment, only one mode for
+    this is implemented. In the future, it may also be supported to set
+    up an explicit \"dual boot\" system\
+
+\
+*Possible values:*
+
+> -   wipe: Completely wipe the contents of the target filesystem. This
+>     cannot be done if the target filesystem is the one the system is
+>     booted from
+>
+> -   alongside: This is a destructive operation in the sense that the
+>     bootloader state will have its contents wiped and replaced.
+>     However, the running system (and all files) will remain in place
+>     until reboot
+
+**\--target-transport**=*TARGET_TRANSPORT* \[default: registry\]
+
+:   The transport; e.g. oci, oci-archive. Defaults to \`registry\`
+
+**\--target-imgref**=*TARGET_IMGREF*
+
+:   Specify the image to fetch for subsequent updates
+
+**\--target-no-signature-verification**
+
+:   Explicitly opt-out of requiring any form of signature verification
+
+**\--target-ostree-remote**=*TARGET_OSTREE_REMOTE*
+
+:   Enable verification via an ostree remote
+
+**\--skip-fetch-check**
+
+:   By default, the accessiblity of the target image will be verified
+    (just the manifest will be fetched). Specifying this option
+    suppresses the check; use this when you know the issues it might
+    find are addressed.
+
+Two main reasons this might fail:
+
+\- Forgetting \`\--target-no-signature-verification\` if needed - Using
+a registry which requires authentication, but not embedding the pull
+secret in the image.
+
+**\--disable-selinux**
+
+:   Disable SELinux in the target (installed) system.
+
+This is currently necessary to install \*from\* a system with SELinux
+disabled but where the target does have SELinux enabled.
+
+**\--karg**=*KARG*
+
+:   Add a kernel argument
+
+**\--generic-image**
+
+:   Perform configuration changes suitable for a \"generic\" disk image.
+    At the moment:
+
+\- All bootloader types will be installed - Changes to the system
+firmware will be skipped
+
+**-h**, **\--help**
+
+:   Print help (see a summary with -h)
+
+**-V**, **\--version**
+
+:   Print version
+
+\<*ROOT_PATH*\>
+
+:   Path to the mounted root filesystem.
+
+By default, the filesystem UUID will be discovered and used for
+mounting. To override this, use \`\--root-mount-spec\`.
+
+# VERSION
+
+v0.1.0

docs/man/bootc-install.md

@@ -0,0 +1,40 @@
+# NAME
+
+bootc-install - Install the running container to a target
+
+# SYNOPSIS
+
+**bootc-install** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
+\<*subcommands*\>
+
+# DESCRIPTION
+
+Install the running container to a target
+
+# OPTIONS
+
+**-h**, **\--help**
+
+:   Print help
+
+**-V**, **\--version**
+
+:   Print version
+
+# SUBCOMMANDS
+
+bootc-install-to-disk(8)
+
+:   Install to the target block device
+
+bootc-install-to-filesystem(8)
+
+:   Install to the target filesystem
+
+bootc-install-help(8)
+
+:   Print this message or the help of the given subcommand(s)
+
+# VERSION
+
+v0.1.0

docs/man/bootc-status.md

@@ -0,0 +1,38 @@
+# NAME
+
+bootc-status - Display status
+
+# SYNOPSIS
+
+**bootc-status** \[**\--json**\] \[**\--booted**\]
+\[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
+
+# DESCRIPTION
+
+Display status
+
+This will output a YAML-formatted object using a schema intended to
+match a Kubernetes resource that describes the state of the booted
+container. The exact API format is not currently declared stable.
+
+# OPTIONS
+
+**\--json**
+
+:   Output in JSON format
+
+**\--booted**
+
+:   Only display status for the booted deployment
+
+**-h**, **\--help**
+
+:   Print help (see a summary with -h)
+
+**-V**, **\--version**
+
+:   Print version
+
+# VERSION
+
+v0.1.0