Skip to content

Commit 5005c9b

Browse files
committed
docs: Sync man pages
We had the man pages in `.gitignore` incorrectly which confused updating them. Signed-off-by: Colin Walters <walters@verbum.org>
1 parent de51faf commit 5005c9b

7 files changed

Lines changed: 218 additions & 1 deletion

docs/.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
book/
2-
man/

docs/src/man/bcvk-ephemeral-ps.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# NAME
2+
3+
bcvk-ephemeral-ps - List ephemeral VM containers
4+
5+
# SYNOPSIS
6+
7+
**bcvk ephemeral ps** [*OPTIONS*]
8+
9+
# DESCRIPTION
10+
11+
List ephemeral VM containers
12+
13+
# OPTIONS
14+
15+
<!-- BEGIN GENERATED OPTIONS -->
16+
**--json**
17+
18+
Output as structured JSON instead of table format
19+
20+
<!-- END GENERATED OPTIONS -->
21+
22+
# EXAMPLES
23+
24+
TODO: Add practical examples showing how to use this command.
25+
26+
# SEE ALSO
27+
28+
**bcvk**(8)
29+
30+
# VERSION
31+
32+
<!-- VERSION PLACEHOLDER -->
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# NAME
2+
3+
bcvk-ephemeral-rm-all - Remove all ephemeral VM containers
4+
5+
# SYNOPSIS
6+
7+
**bcvk ephemeral rm-all** [*OPTIONS*]
8+
9+
# DESCRIPTION
10+
11+
Remove all ephemeral VM containers
12+
13+
# OPTIONS
14+
15+
<!-- BEGIN GENERATED OPTIONS -->
16+
**-f**, **--force**
17+
18+
Force removal without confirmation
19+
20+
<!-- END GENERATED OPTIONS -->
21+
22+
# EXAMPLES
23+
24+
TODO: Add practical examples showing how to use this command.
25+
26+
# SEE ALSO
27+
28+
**bcvk**(8)
29+
30+
# VERSION
31+
32+
<!-- VERSION PLACEHOLDER -->
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# NAME
2+
3+
bcvk-libvirt-base-disks - Manage base disk images used for VM cloning
4+
5+
# SYNOPSIS
6+
7+
**bcvk libvirt base-disks** [*OPTIONS*]
8+
9+
# DESCRIPTION
10+
11+
Manage base disk images used for VM cloning
12+
13+
<!-- BEGIN GENERATED OPTIONS -->
14+
<!-- END GENERATED OPTIONS -->
15+
16+
# EXAMPLES
17+
18+
TODO: Add practical examples showing how to use this command.
19+
20+
# SEE ALSO
21+
22+
**bcvk**(8)
23+
24+
# VERSION
25+
26+
<!-- VERSION PLACEHOLDER -->
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# NAME
2+
3+
bcvk-libvirt-list-volumes - List available bootc volumes with metadata
4+
5+
# SYNOPSIS
6+
7+
**bcvk libvirt list-volumes** [*OPTIONS*]
8+
9+
# DESCRIPTION
10+
11+
List available bootc volumes with metadata
12+
13+
# OPTIONS
14+
15+
<!-- BEGIN GENERATED OPTIONS -->
16+
**--pool**=*POOL*
17+
18+
Libvirt storage pool name to search
19+
20+
Default: default
21+
22+
**--json**
23+
24+
Output format (human-readable or JSON)
25+
26+
**--detailed**
27+
28+
Show detailed volume information
29+
30+
**--source-image**=*SOURCE_IMAGE*
31+
32+
Filter by source container image
33+
34+
**--all**
35+
36+
Show all volumes (not just bootc volumes)
37+
38+
<!-- END GENERATED OPTIONS -->
39+
40+
# EXAMPLES
41+
42+
TODO: Add practical examples showing how to use this command.
43+
44+
# SEE ALSO
45+
46+
**bcvk**(8)
47+
48+
# VERSION
49+
50+
<!-- VERSION PLACEHOLDER -->
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# NAME
2+
3+
bcvk-libvirt-rm-all - Remove multiple libvirt domains and their resources
4+
5+
# SYNOPSIS
6+
7+
**bcvk libvirt rm-all** [*OPTIONS*]
8+
9+
# DESCRIPTION
10+
11+
Remove multiple libvirt domains and their resources
12+
13+
# OPTIONS
14+
15+
<!-- BEGIN GENERATED OPTIONS -->
16+
**-f**, **--force**
17+
18+
Force removal without confirmation
19+
20+
**--stop**
21+
22+
Remove domains even if they're running
23+
24+
**--label**=*LABEL*
25+
26+
Filter domains by label (only remove domains with this label)
27+
28+
<!-- END GENERATED OPTIONS -->
29+
30+
# EXAMPLES
31+
32+
TODO: Add practical examples showing how to use this command.
33+
34+
# SEE ALSO
35+
36+
**bcvk**(8)
37+
38+
# VERSION
39+
40+
<!-- VERSION PLACEHOLDER -->
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# NAME
2+
3+
bcvk-libvirt-status - Show libvirt environment status and capabilities
4+
5+
# SYNOPSIS
6+
7+
**bcvk libvirt status** [*OPTIONS*]
8+
9+
# DESCRIPTION
10+
11+
Show libvirt environment status and capabilities
12+
13+
# OPTIONS
14+
15+
<!-- BEGIN GENERATED OPTIONS -->
16+
**--format**=*FORMAT*
17+
18+
Output format (yaml or json)
19+
20+
Possible values:
21+
- yaml
22+
- json
23+
24+
Default: yaml
25+
26+
<!-- END GENERATED OPTIONS -->
27+
28+
# EXAMPLES
29+
30+
TODO: Add practical examples showing how to use this command.
31+
32+
# SEE ALSO
33+
34+
**bcvk**(8)
35+
36+
# VERSION
37+
38+
<!-- VERSION PLACEHOLDER -->

0 commit comments

Comments
 (0)