Skip to content

Commit 3fa5554

Browse files
committed
First take on man pages for all commands
Mostly based on what can be found in -h, but now there is something to build upon Signed-off-by: Martin Skøtt <[email protected]>
1 parent 861c178 commit 3fa5554

7 files changed

+98
-3
lines changed

docs/podman-bootc-completion.1.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11
% podman-bootc-completion 1
22

3-
## NAME
3+
## NAME
4+
podman-bootc-completion - Generate the autocompletion script for the specified shell
45

56
## SYNOPSIS
7+
**podman-bootc completion** *bash* | *fish* | *powershell* | *zsh* [*options*]
68

79
## DESCRIPTION
10+
**podman-bootc completion** generate shell completion scripts for a variety of shells.
11+
Supported shells are *bash*, *fish*, *powershell*, and *zsh*.
12+
13+
## OPTIONS
14+
15+
#### **--help**, **-h**
16+
Show details on how to use the script generated for the particular shell.
17+
18+
#### **--no-descriptions**
19+
Disable completion descriptions.
820

921
## SEE ALSO
1022

docs/podman-bootc-images.1.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
% podman-bootc-images 1
22

33
## NAME
4+
podman-bootc-images - List bootc images in the local containers store
45

56
## SYNOPSIS
7+
**podman-bootc images**
68

79
## DESCRIPTION
10+
**podman-bootc images** list bootc images in the containers store of the podman machine.
11+
The podman machine must be running to use this command.
812

913
## SEE ALSO
1014

docs/podman-bootc-list.1.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
% podman-bootc-list 1
22

33
## NAME
4+
podman-bootc-list - List installed OS Containers
45

56
## SYNOPSIS
7+
**podman-bootc list**
68

79
## DESCRIPTION
10+
**podman-bootc list** displays installed OS containers and their status.
11+
12+
The podman machine must be running to use this command.
813

914
## SEE ALSO
1015

docs/podman-bootc-rm.1.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
11
% podman-bootc-rm 1
22

33
## NAME
4+
podman-bootc-rm - Remove installed bootc VMs
45

56
## SYNOPSIS
7+
**podman-bootc rm** *id* [*options*]
68

79
## DESCRIPTION
10+
**podman-bootc rm** removes an installed bootc VM/container from the podman machine.
11+
12+
Use **[podman-bootc list](podman-bootc-list.1.md)** to find the IDs of installed VMs.
13+
14+
The podman machine must be running to use this command.
15+
16+
## OPTIONS
17+
18+
#### **--all**
19+
Removes all non-running bootc VMs
20+
21+
#### **--force**, **-f**
22+
Terminate a running VM
823

924
## SEE ALSO
1025

11-
**[podman-bootc(1)](podman-bootc.1.md)**
26+
**[podman-bootc(1)](podman-bootc.1.md)**, **[podman-bootc-list(1)](podman-bootc-list.1.md)**
1227

1328
## HISTORY
1429
Dec, 2024, Originally compiled by Martin Skøtt <[email protected]>

docs/podman-bootc-run.1.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,56 @@
11
% podman-bootc-run 1
22

33
## NAME
4+
podman-bootc-run - Run a bootc container as a VM
45

56
## SYNOPSIS
7+
**podman-bootc run** [*options*] *image* | *id*
68

79
## DESCRIPTION
10+
**podman-bootc run** creates a new virtual machine from a bootc container image or starts an existing one.
11+
It then creates an SSH connection to the VM using injected credentials (see *--background* to run in the background).
12+
13+
The podman machine must be running to use this command.
14+
15+
## OPTIONS
16+
17+
#### **--background**, **-B**
18+
Do not spawn SSH, run in background.
19+
20+
#### **--cloudinit**=**string**
21+
--cloud-init <cloud-init data directory>
22+
23+
#### **--disk-size**=**string**
24+
Allocate a disk image of this size in bytes; optionally accepts M, G, T suffixes
25+
26+
#### **--filesystem**=**string**
27+
Override the root filesystem, e.g. xfs, btrfs, ext4.
28+
29+
#### **--quiet**
30+
Suppress output from bootc disk creation and VM boot console
31+
32+
#### **--rm**
33+
Remove the VM and it's disk image when the SSH connection exits. Cannot be used with *--background*
34+
35+
#### **--root-size-max**=**string**
36+
Maximum size of root filesystem in bytes; optionally accepts M, G, T suffixes
37+
38+
#### **--user**, **-u**=**root** | *user name*
39+
User name of injected user, default: root
40+
41+
## EXAMPLES
42+
Create a virtual machine based on the latest bootable image from Fedora using XFS as the root filesystem.
43+
```
44+
$ podman-bootc run --filesystem=xfs quay.io/fedora/fedora-bootc:latest
45+
```
46+
47+
Start a previously created VM, using *podman-bootc list* to find its ID.
48+
```
49+
$ podman-bootc list
50+
ID REPO SIZE CREATED RUNNING SSH PORT
51+
d0300f628e13 quay.io/fedora/fedora-bootc:latest 10.7GB 4 minutes ago false 34173
52+
$ podman-bootc run d0300f628e13
53+
```
854

955
## SEE ALSO
1056

docs/podman-bootc-ssh.1.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
11
% podman-bootc-ssh 1
22

33
## NAME
4+
podman-bootc-ssh - SSH into an existing OS Container machine
45

56
## SYNOPSIS
7+
**podman-bootc ssh** *id* [*options*]
68

79
## DESCRIPTION
10+
**podman-bootc ssh** opens an SSH connection to a running OS container machine.
11+
12+
Use **[podman-bootc list](podman-bootc-list.1.md)** to find the IDs of installed VMs.
13+
14+
## OPTIONS
15+
16+
#### **--user**, **-u**=**root** | *user name*
17+
User name to use for connection, default: root
818

919
## SEE ALSO
1020

11-
**[podman-bootc(1)](podman-bootc.1.md)**
21+
**[podman-bootc(1)](podman-bootc.1.md)**, **[podman-bootc-list(1)](podman-bootc-list.1.md)**
1222

1323
## HISTORY
1424
Dec, 2024, Originally compiled by Martin Skøtt <[email protected]>

docs/podman-bootc-stop.1.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
% podman-bootc-stop 1
22

33
## NAME
4+
podman-bootc-stop - Stop an existing OS Container machine
45

56
## SYNOPSIS
7+
**podman-bootc stop** *id*
68

79
## DESCRIPTION
10+
**podman-bootc stop** stops a running OS container machine.
811

912
## SEE ALSO
1013

0 commit comments

Comments
 (0)