Skip to content

Commit

Permalink
manpages-md: Resynchronize
Browse files Browse the repository at this point in the history
This is a manual invocation of `cargo xtask man2markdown`.
  • Loading branch information
cgwalters committed Jan 18, 2024
1 parent e536c9f commit e593ee7
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 10 deletions.
34 changes: 34 additions & 0 deletions manpages-md/bootc-install-print-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# NAME

bootc-install-print-configuration - Output JSON to stdout that contains
the merged installation configuration as it may be relevant to calling
processes using \`install to-filesystem\` that want to honor e.g.
\`root-fs-type\`

# SYNOPSIS

**bootc-install-print-configuration** \[**-h**\|**\--help**\]
\[**-V**\|**\--version**\]

# DESCRIPTION

Output JSON to stdout that contains the merged installation
configuration as it may be relevant to calling processes using \`install
to-filesystem\` that want to honor e.g. \`root-fs-type\`.

At the current time, the only output key is \`root-fs-type\` which is a
string-valued filesystem name suitable for passing to \`mkfs.\$type\`.

# OPTIONS

**-h**, **\--help**

: Print help (see a summary with -h)

**-V**, **\--version**

: Print version

# VERSION

v0.1.0
25 changes: 20 additions & 5 deletions manpages-md/bootc-install-to-disk.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ 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**\] \[**\--enforce-container-sigpolicy**\]
\[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]
\[**\--disable-selinux**\] \[**\--karg**\] \[**\--generic-image**\]
\[**-h**\|**\--help**\] \[**-V**\|**\--version**\] \<*DEVICE*\>
\[**\--filesystem**\] \[**\--root-size**\] \[**\--source-imgref**\]
\[**\--target-transport**\] \[**\--target-imgref**\]
\[**\--enforce-container-sigpolicy**\] \[**\--target-ostree-remote**\]
\[**\--skip-fetch-check**\] \[**\--disable-selinux**\] \[**\--karg**\]
\[**\--generic-image**\] \[**\--via-loopback**\] \[**-h**\|**\--help**\]
\[**-V**\|**\--version**\] \<*DEVICE*\>

# DESCRIPTION

Expand Down Expand Up @@ -45,6 +46,16 @@ unlock of filesystem to presence of the default tpm2 device.\

By default, all remaining space on the disk will be used.

**\--source-imgref**=*SOURCE_IMGREF*

: Install the system from an explicitly given source.

By default, bootc install and install-to-filesystem assumes that it runs
in a podman container, and it takes the container image to install from
the podmans container registry. If \--source-imgref is given, bootc uses
it as the installation source, instead of the behaviour explained in the
previous paragraph. See skopeo(1) for accepted formats.

**\--target-transport**=*TARGET_TRANSPORT* \[default: registry\]

: The transport; e.g. oci, oci-archive. Defaults to \`registry\`
Expand Down Expand Up @@ -94,6 +105,10 @@ disabled but where the target does have SELinux enabled.
\- All bootloader types will be installed - Changes to the system
firmware will be skipped

**\--via-loopback**

: Instead of targeting a block device, write to a file via loopback

**-h**, **\--help**

: Print help (see a summary with -h)
Expand Down
20 changes: 15 additions & 5 deletions manpages-md/bootc-install-to-filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ bootc-install-to-filesystem - Install to the target filesystem

**bootc-install-to-filesystem** \[**\--root-mount-spec**\]
\[**\--root-options**\] \[**\--boot-mount-spec**\] \[**\--replace**\]
\[**\--target-transport**\] \[**\--target-imgref**\]
\[**\--enforce-container-sigpolicy**\] \[**\--target-ostree-remote**\]
\[**\--skip-fetch-check**\] \[**\--disable-selinux**\] \[**\--karg**\]
\[**\--generic-image**\] \[**-h**\|**\--help**\]
\[**-V**\|**\--version**\] \<*ROOT_PATH*\>
\[**\--source-imgref**\] \[**\--target-transport**\]
\[**\--target-imgref**\] \[**\--enforce-container-sigpolicy**\]
\[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]
\[**\--disable-selinux**\] \[**\--karg**\] \[**\--generic-image**\]
\[**-h**\|**\--help**\] \[**-V**\|**\--version**\] \<*ROOT_PATH*\>

# DESCRIPTION

Expand Down Expand Up @@ -54,6 +54,16 @@ be used.
> However, the running system (and all files) will remain in place
> until reboot
**\--source-imgref**=*SOURCE_IMGREF*

: Install the system from an explicitly given source.

By default, bootc install and install-to-filesystem assumes that it runs
in a podman container, and it takes the container image to install from
the podmans container registry. If \--source-imgref is given, bootc uses
it as the installation source, instead of the behaviour explained in the
previous paragraph. See skopeo(1) for accepted formats.

**\--target-transport**=*TARGET_TRANSPORT* \[default: registry\]

: The transport; e.g. oci, oci-archive. Defaults to \`registry\`
Expand Down
6 changes: 6 additions & 0 deletions manpages-md/bootc-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ bootc-install-to-filesystem(8)

: Install to the target filesystem

bootc-install-print-configuration(8)

: Output JSON to stdout that contains the merged installation
configuration as it may be relevant to calling processes using
\`install to-filesystem\` that want to honor e.g. \`root-fs-type\`

bootc-install-help(8)

: Print this message or the help of the given subcommand(s)
Expand Down

0 comments on commit e593ee7

Please sign in to comment.