Skip to content

Commit

Permalink
man: Regenerate
Browse files Browse the repository at this point in the history
Signed-off-by: Colin Walters <walters@verbum.org>
  • Loading branch information
cgwalters committed Oct 11, 2024
1 parent 327d79c commit 442dd27
Show file tree
Hide file tree
Showing 14 changed files with 64 additions and 31 deletions.
2 changes: 1 addition & 1 deletion docs/src/man/bootc-container-lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ part of a build process; it will error if any problems are detected.

# VERSION

v0.1.13
v0.1.16
2 changes: 1 addition & 1 deletion docs/src/man/bootc-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ bootc-container-help(8)

# VERSION

v0.1.13
v0.1.16
2 changes: 1 addition & 1 deletion docs/src/man/bootc-edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Only changes to the \`spec\` section are honored.

# VERSION

v0.1.13
v0.1.16
2 changes: 1 addition & 1 deletion docs/src/man/bootc-install-print-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ string-valued filesystem name suitable for passing to \`mkfs.\$type\`.

# VERSION

v0.1.13
v0.1.16
9 changes: 7 additions & 2 deletions docs/src/man/bootc-install-to-disk.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ bootc-install-to-disk - Install to the target block device
\[**\--enforce-container-sigpolicy**\] \[**\--target-ostree-remote**\]
\[**\--skip-fetch-check**\] \[**\--disable-selinux**\] \[**\--karg**\]
\[**\--root-ssh-authorized-keys**\] \[**\--generic-image**\]
\[**\--via-loopback**\] \[**-h**\|**\--help**\] \<*DEVICE*\>
\[**\--stateroot**\] \[**\--via-loopback**\] \[**-h**\|**\--help**\]
\<*DEVICE*\>

# DESCRIPTION

Expand Down Expand Up @@ -129,6 +130,10 @@ boot.
\- All bootloader types will be installed - Changes to the system
firmware will be skipped

**\--stateroot**=*STATEROOT*

: The stateroot name to use. Defaults to \`default\`

**\--via-loopback**

: Instead of targeting a block device, write to a file via loopback
Expand All @@ -144,4 +149,4 @@ firmware will be skipped

# VERSION

v0.1.13
v0.1.16
10 changes: 7 additions & 3 deletions docs/src/man/bootc-install-to-existing-root.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ bootc-install-to-existing-root - Install to the host root filesystem
\[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]
\[**\--disable-selinux**\] \[**\--karg**\]
\[**\--root-ssh-authorized-keys**\] \[**\--generic-image**\]
\[**\--acknowledge-destructive**\] \[**-h**\|**\--help**\]
\[*ROOT_PATH*\]
\[**\--stateroot**\] \[**\--acknowledge-destructive**\]
\[**-h**\|**\--help**\] \[*ROOT_PATH*\]

# DESCRIPTION

Expand Down Expand Up @@ -115,6 +115,10 @@ boot.
\- All bootloader types will be installed - Changes to the system
firmware will be skipped

**\--stateroot**=*STATEROOT*

: The stateroot name to use. Defaults to \`default\`

**\--acknowledge-destructive**

: Accept that this is a destructive action and skip a warning timer
Expand All @@ -130,4 +134,4 @@ firmware will be skipped

# VERSION

v0.1.13
v0.1.16
8 changes: 6 additions & 2 deletions docs/src/man/bootc-install-to-filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ filesystem structure
\[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]
\[**\--disable-selinux**\] \[**\--karg**\]
\[**\--root-ssh-authorized-keys**\] \[**\--generic-image**\]
\[**-h**\|**\--help**\] \<*ROOT_PATH*\>
\[**\--stateroot**\] \[**-h**\|**\--help**\] \<*ROOT_PATH*\>

# DESCRIPTION

Expand Down Expand Up @@ -144,6 +144,10 @@ boot.
\- All bootloader types will be installed - Changes to the system
firmware will be skipped

**\--stateroot**=*STATEROOT*

: The stateroot name to use. Defaults to \`default\`

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

: Print help (see a summary with -h)
Expand All @@ -157,4 +161,4 @@ mounting. To override this, use \`\--root-mount-spec\`.

# VERSION

v0.1.13
v0.1.16
4 changes: 2 additions & 2 deletions docs/src/man/bootc-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ bootc-install - Install the running container to a target

Install the running container to a target.

\## Understanding installations
## Understanding installations

OCI containers are effectively layers of tarballs with JSON for
metadata; they cannot be booted directly. The \`bootc install\` flow is
Expand Down Expand Up @@ -61,4 +61,4 @@ bootc-install-help(8)

# VERSION

v0.1.13
v0.1.16
2 changes: 1 addition & 1 deletion docs/src/man/bootc-rollback.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ rollback invocation.

# VERSION

v0.1.13
v0.1.16
28 changes: 20 additions & 8 deletions docs/src/man/bootc-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,21 @@ bootc-status - Display status

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
system.
If standard output is a terminal, this will output a description of the
bootc system state. If standard output is not a terminal, output a
YAML-formatted object using a schema intended to match a Kubernetes
resource that describes the state of the booted system.

The exact API format is not currently declared stable.
## Parsing output via programs

Either the default YAML format or \`\--format=json\` can be used. Do not
attempt to explicitly parse the output of \`\--format=humanreadable\` as
it will very likely change over time.

## Programmatically detecting whether the system is deployed via bootc

Invoke e.g. \`bootc status \--json\`, and check if \`status.booted\` is
not \`null\`.

# OPTIONS

Expand All @@ -26,16 +36,18 @@ The exact API format is not currently declared stable.
\
*Possible values:*

> - humanreadable: Output in Human Readable format
>
> - yaml: Output in YAML format
>
> - json: Output in JSON format
**\--format-version**=*FORMAT_VERSION*

: The desired format version. There is currently one supported
version, which is version \`0\`. Pass this option to explicitly
request it; it is possible that multiple versions will be supported
in the future
version, which is exposed as both \`0\` and \`1\`. Pass this option
to explicitly request it; it is possible that another future version
2 or newer will be supported in the future

**\--booted**

Expand All @@ -47,4 +59,4 @@ The exact API format is not currently declared stable.

# VERSION

v0.1.13
v0.1.16
14 changes: 11 additions & 3 deletions docs/src/man/bootc-switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ bootc-switch - Target a new container image reference to boot

# SYNOPSIS

**bootc switch** \[**\--quiet**\] \[**\--transport**\]
**bootc switch** \[**\--quiet**\] \[**\--apply**\] \[**\--transport**\]
\[**\--enforce-container-sigpolicy**\] \[**\--ostree-remote**\]
\[**\--retain**\] \[**-h**\|**\--help**\] \<*TARGET*\>

Expand All @@ -15,7 +15,7 @@ Target a new container image reference to boot.
This is almost exactly the same operation as \`upgrade\`, but
additionally changes the container image reference instead.

\## Usage
## Usage

A common pattern is to have a management agent control operating system
updates via container image tags; for example,
Expand All @@ -30,6 +30,14 @@ updates via container image tags; for example,

: Dont display progress

**\--apply**

: Restart or reboot into the new target image.

Currently, this option always reboots. In the future this command will
detect the case where no kernel changes are queued, and perform a
userspace-only restart.

**\--transport**=*TRANSPORT* \[default: registry\]

: The transport; e.g. oci, oci-archive, containers-storage. Defaults
Expand Down Expand Up @@ -61,4 +69,4 @@ includes a default policy which requires signatures.

# VERSION

v0.1.13
v0.1.16
2 changes: 1 addition & 1 deletion docs/src/man/bootc-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ userspace-only restart.

# VERSION

v0.1.13
v0.1.16
8 changes: 4 additions & 4 deletions docs/src/man/bootc-usr-overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ will be discarded on reboot
Adds a transient writable overlayfs on \`/usr\` that will be discarded
on reboot.

\## Use cases
## Use cases

A common pattern is wanting to use tracing/debugging tools, such as
\`strace\` that may not be in the base image. A system package manager
such as \`apt\` or \`dnf\` can apply changes into this transient overlay
that will be discarded on reboot.

\## /etc and /var
## /etc and /var

However, this command has no effect on \`/etc\` and \`/var\` - changes
written there will persist. It is common for package installations to
modify these directories.

\## Unmounting
## Unmounting

Almost always, a system process will hold a reference to the open mount
point. You can however invoke \`umount -l /usr\` to perform a \"lazy
Expand All @@ -39,4 +39,4 @@ unmount\".

# VERSION

v0.1.13
v0.1.16
2 changes: 1 addition & 1 deletion docs/src/man/bootc.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ bootc-help(8)

# VERSION

v0.1.13
v0.1.16

0 comments on commit 442dd27

Please sign in to comment.