Skip to content

Commit 57a97cd

Browse files
jmarrerojmarrero
authored
Merge pull request #233 from cgwalters/generate-markdown-docs
docs: Generate docs/man
2 parents 8dc32a3 + 6d992aa commit 57a97cd

11 files changed

+561
-1
lines changed

‎docs/man/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Auto-generated manpages
2+
3+
These markdown files are automatically generated via
4+
`cargo xtask man2markdown`.
5+
6+
Start with [bootc.md](bootc.md).

‎docs/man/bootc-edit.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# NAME
2+
3+
bootc-edit - Change host specification
4+
5+
# SYNOPSIS
6+
7+
**bootc-edit** \[**-f**\|**\--filename**\] \[**\--quiet**\]
8+
\[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
9+
10+
# DESCRIPTION
11+
12+
Change host specification
13+
14+
# OPTIONS
15+
16+
**-f**, **\--filename**=*FILENAME*
17+
18+
: Use filename to edit system specification
19+
20+
**\--quiet**
21+
22+
: Dont display progress
23+
24+
**-h**, **\--help**
25+
26+
: Print help
27+
28+
**-V**, **\--version**
29+
30+
: Print version
31+
32+
# VERSION
33+
34+
v0.1.0

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

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# NAME
2+
3+
bootc-install-to-disk - Install to the target block device
4+
5+
# SYNOPSIS
6+
7+
**bootc-install-to-disk** \[**\--wipe**\] \[**\--block-setup**\]
8+
\[**\--filesystem**\] \[**\--root-size**\] \[**\--target-transport**\]
9+
\[**\--target-imgref**\] \[**\--target-no-signature-verification**\]
10+
\[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]
11+
\[**\--disable-selinux**\] \[**\--karg**\] \[**\--generic-image**\]
12+
\[**-h**\|**\--help**\] \[**-V**\|**\--version**\] \<*DEVICE*\>
13+
14+
# DESCRIPTION
15+
16+
Install to the target block device
17+
18+
# OPTIONS
19+
20+
**\--wipe**
21+
22+
: Automatically wipe all existing data on device
23+
24+
**\--block-setup**=*BLOCK_SETUP* \[default: direct\]
25+
26+
: Target root block device setup.
27+
28+
direct: Filesystem written directly to block device tpm2-luks: Bind
29+
unlock of filesystem to presence of the default tpm2 device.\
30+
31+
\
32+
\[*possible values: *direct, tpm2-luks\]
33+
34+
**\--filesystem**=*FILESYSTEM*
35+
36+
: Target root filesystem type\
37+
38+
\
39+
\[*possible values: *xfs, ext4, btrfs\]
40+
41+
**\--root-size**=*ROOT_SIZE*
42+
43+
: Size of the root partition (default specifier: M). Allowed
44+
specifiers: M (mebibytes), G (gibibytes), T (tebibytes).
45+
46+
By default, all remaining space on the disk will be used.
47+
48+
**\--target-transport**=*TARGET_TRANSPORT* \[default: registry\]
49+
50+
: The transport; e.g. oci, oci-archive. Defaults to \`registry\`
51+
52+
**\--target-imgref**=*TARGET_IMGREF*
53+
54+
: Specify the image to fetch for subsequent updates
55+
56+
**\--target-no-signature-verification**
57+
58+
: Explicitly opt-out of requiring any form of signature verification
59+
60+
**\--target-ostree-remote**=*TARGET_OSTREE_REMOTE*
61+
62+
: Enable verification via an ostree remote
63+
64+
**\--skip-fetch-check**
65+
66+
: By default, the accessiblity of the target image will be verified
67+
(just the manifest will be fetched). Specifying this option
68+
suppresses the check; use this when you know the issues it might
69+
find are addressed.
70+
71+
Two main reasons this might fail:
72+
73+
\- Forgetting \`\--target-no-signature-verification\` if needed - Using
74+
a registry which requires authentication, but not embedding the pull
75+
secret in the image.
76+
77+
**\--disable-selinux**
78+
79+
: Disable SELinux in the target (installed) system.
80+
81+
This is currently necessary to install \*from\* a system with SELinux
82+
disabled but where the target does have SELinux enabled.
83+
84+
**\--karg**=*KARG*
85+
86+
: Add a kernel argument
87+
88+
**\--generic-image**
89+
90+
: Perform configuration changes suitable for a \"generic\" disk image.
91+
At the moment:
92+
93+
\- All bootloader types will be installed - Changes to the system
94+
firmware will be skipped
95+
96+
**-h**, **\--help**
97+
98+
: Print help (see a summary with -h)
99+
100+
**-V**, **\--version**
101+
102+
: Print version
103+
104+
\<*DEVICE*\>
105+
106+
: Target block device for installation. The entire device will be
107+
wiped
108+
109+
# VERSION
110+
111+
v0.1.0

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

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# NAME
2+
3+
bootc-install-to-filesystem - Install to the target filesystem
4+
5+
# SYNOPSIS
6+
7+
**bootc-install-to-filesystem** \[**\--root-mount-spec**\]
8+
\[**\--root-options**\] \[**\--boot-mount-spec**\] \[**\--replace**\]
9+
\[**\--target-transport**\] \[**\--target-imgref**\]
10+
\[**\--target-no-signature-verification**\]
11+
\[**\--target-ostree-remote**\] \[**\--skip-fetch-check**\]
12+
\[**\--disable-selinux**\] \[**\--karg**\] \[**\--generic-image**\]
13+
\[**-h**\|**\--help**\] \[**-V**\|**\--version**\] \<*ROOT_PATH*\>
14+
15+
# DESCRIPTION
16+
17+
Install to the target filesystem
18+
19+
# OPTIONS
20+
21+
**\--root-mount-spec**=*ROOT_MOUNT_SPEC*
22+
23+
: Source device specification for the root filesystem. For example,
24+
UUID=2e9f4241-229b-4202-8429-62d2302382e1
25+
26+
**\--root-options**=*ROOT_OPTIONS*
27+
28+
: Comma-separated mount options for the root filesystem. For example:
29+
rw,prjquota
30+
31+
**\--boot-mount-spec**=*BOOT_MOUNT_SPEC*
32+
33+
: Mount specification for the /boot filesystem.
34+
35+
At the current time, a separate /boot is required. This restriction will
36+
be lifted in future versions. If not specified, the filesystem UUID will
37+
be used.
38+
39+
**\--replace**=*REPLACE*
40+
41+
: Initialize the system in-place; at the moment, only one mode for
42+
this is implemented. In the future, it may also be supported to set
43+
up an explicit \"dual boot\" system\
44+
45+
\
46+
*Possible values:*
47+
48+
> - wipe: Completely wipe the contents of the target filesystem. This
49+
> cannot be done if the target filesystem is the one the system is
50+
> booted from
51+
>
52+
> - alongside: This is a destructive operation in the sense that the
53+
> bootloader state will have its contents wiped and replaced.
54+
> However, the running system (and all files) will remain in place
55+
> until reboot
56+
57+
**\--target-transport**=*TARGET_TRANSPORT* \[default: registry\]
58+
59+
: The transport; e.g. oci, oci-archive. Defaults to \`registry\`
60+
61+
**\--target-imgref**=*TARGET_IMGREF*
62+
63+
: Specify the image to fetch for subsequent updates
64+
65+
**\--target-no-signature-verification**
66+
67+
: Explicitly opt-out of requiring any form of signature verification
68+
69+
**\--target-ostree-remote**=*TARGET_OSTREE_REMOTE*
70+
71+
: Enable verification via an ostree remote
72+
73+
**\--skip-fetch-check**
74+
75+
: By default, the accessiblity of the target image will be verified
76+
(just the manifest will be fetched). Specifying this option
77+
suppresses the check; use this when you know the issues it might
78+
find are addressed.
79+
80+
Two main reasons this might fail:
81+
82+
\- Forgetting \`\--target-no-signature-verification\` if needed - Using
83+
a registry which requires authentication, but not embedding the pull
84+
secret in the image.
85+
86+
**\--disable-selinux**
87+
88+
: Disable SELinux in the target (installed) system.
89+
90+
This is currently necessary to install \*from\* a system with SELinux
91+
disabled but where the target does have SELinux enabled.
92+
93+
**\--karg**=*KARG*
94+
95+
: Add a kernel argument
96+
97+
**\--generic-image**
98+
99+
: Perform configuration changes suitable for a \"generic\" disk image.
100+
At the moment:
101+
102+
\- All bootloader types will be installed - Changes to the system
103+
firmware will be skipped
104+
105+
**-h**, **\--help**
106+
107+
: Print help (see a summary with -h)
108+
109+
**-V**, **\--version**
110+
111+
: Print version
112+
113+
\<*ROOT_PATH*\>
114+
115+
: Path to the mounted root filesystem.
116+
117+
By default, the filesystem UUID will be discovered and used for
118+
mounting. To override this, use \`\--root-mount-spec\`.
119+
120+
# VERSION
121+
122+
v0.1.0

‎docs/man/bootc-install.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# NAME
2+
3+
bootc-install - Install the running container to a target
4+
5+
# SYNOPSIS
6+
7+
**bootc-install** \[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
8+
\<*subcommands*\>
9+
10+
# DESCRIPTION
11+
12+
Install the running container to a target
13+
14+
# OPTIONS
15+
16+
**-h**, **\--help**
17+
18+
: Print help
19+
20+
**-V**, **\--version**
21+
22+
: Print version
23+
24+
# SUBCOMMANDS
25+
26+
bootc-install-to-disk(8)
27+
28+
: Install to the target block device
29+
30+
bootc-install-to-filesystem(8)
31+
32+
: Install to the target filesystem
33+
34+
bootc-install-help(8)
35+
36+
: Print this message or the help of the given subcommand(s)
37+
38+
# VERSION
39+
40+
v0.1.0

‎docs/man/bootc-status.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# NAME
2+
3+
bootc-status - Display status
4+
5+
# SYNOPSIS
6+
7+
**bootc-status** \[**\--json**\] \[**\--booted**\]
8+
\[**-h**\|**\--help**\] \[**-V**\|**\--version**\]
9+
10+
# DESCRIPTION
11+
12+
Display status
13+
14+
This will output a YAML-formatted object using a schema intended to
15+
match a Kubernetes resource that describes the state of the booted
16+
container. The exact API format is not currently declared stable.
17+
18+
# OPTIONS
19+
20+
**\--json**
21+
22+
: Output in JSON format
23+
24+
**\--booted**
25+
26+
: Only display status for the booted deployment
27+
28+
**-h**, **\--help**
29+
30+
: Print help (see a summary with -h)
31+
32+
**-V**, **\--version**
33+
34+
: Print version
35+
36+
# VERSION
37+
38+
v0.1.0

0 commit comments

Comments
 (0)