Skip to content

Commit a73ec8d

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 bef1147 commit a73ec8d

7 files changed

Lines changed: 282 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: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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+
List all running ephemeral VMs:
25+
26+
bcvk ephemeral ps
27+
28+
List ephemeral VMs with JSON output:
29+
30+
bcvk ephemeral ps --json
31+
32+
# SEE ALSO
33+
34+
**bcvk**(8)
35+
36+
# VERSION
37+
38+
<!-- VERSION PLACEHOLDER -->
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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+
Remove all ephemeral VMs (will prompt for confirmation):
25+
26+
bcvk ephemeral rm-all
27+
28+
Remove all ephemeral VMs without confirmation:
29+
30+
bcvk ephemeral rm-all --force
31+
32+
Clean up after testing workflow:
33+
34+
# Run some ephemeral test VMs
35+
bcvk ephemeral run -d --rm --name test1 quay.io/fedora/fedora-bootc:42
36+
bcvk ephemeral run -d --rm --name test2 quay.io/fedora/fedora-bootc:42
37+
38+
# Clean up all at once
39+
bcvk ephemeral rm-all -f
40+
41+
# SEE ALSO
42+
43+
**bcvk**(8)
44+
45+
# VERSION
46+
47+
<!-- VERSION PLACEHOLDER -->
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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+
# SEE ALSO
17+
18+
**bcvk**(8)
19+
20+
# VERSION
21+
22+
<!-- VERSION PLACEHOLDER -->
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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 as structured JSON instead of table format
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+
List all bootc volumes in the default pool:
43+
44+
bcvk libvirt list-volumes
45+
46+
Show detailed volume information:
47+
48+
bcvk libvirt list-volumes --detailed
49+
50+
Filter volumes by source container image:
51+
52+
bcvk libvirt list-volumes --source-image quay.io/fedora/fedora-bootc:42
53+
54+
List all volumes including non-bootc volumes:
55+
56+
bcvk libvirt list-volumes --all
57+
58+
Output as JSON for scripting:
59+
60+
bcvk libvirt list-volumes --json
61+
62+
# SEE ALSO
63+
64+
**bcvk**(8)
65+
66+
# VERSION
67+
68+
<!-- VERSION PLACEHOLDER -->
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
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+
Remove all stopped libvirt VMs (will prompt for confirmation):
33+
34+
bcvk libvirt rm-all
35+
36+
Remove all VMs without confirmation:
37+
38+
bcvk libvirt rm-all --force
39+
40+
Remove all VMs including running ones:
41+
42+
bcvk libvirt rm-all --stop --force
43+
44+
Remove all VMs with a specific label:
45+
46+
bcvk libvirt rm-all --label environment=test --force
47+
48+
Clean up test environment workflow:
49+
50+
# Create some test VMs
51+
bcvk libvirt run --name test1 --label purpose=testing quay.io/fedora/fedora-bootc:42
52+
bcvk libvirt run --name test2 --label purpose=testing quay.io/fedora/fedora-bootc:42
53+
54+
# Clean up only the test VMs
55+
bcvk libvirt rm-all --label purpose=testing -f
56+
57+
# SEE ALSO
58+
59+
**bcvk**(8)
60+
61+
# VERSION
62+
63+
<!-- VERSION PLACEHOLDER -->
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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+
Show libvirt environment status (default YAML format):
31+
32+
bcvk libvirt status
33+
34+
Show status in JSON format:
35+
36+
bcvk libvirt status --format json
37+
38+
# SEE ALSO
39+
40+
**bcvk**(8)
41+
42+
# VERSION
43+
44+
<!-- VERSION PLACEHOLDER -->

0 commit comments

Comments
 (0)