Files
podman/docs/source/markdown/podman-machine-rm.1.md
Paul Holzinger bc48211924 Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash.
I tested that this change is safe and still renders correctly on github
and with the man pages.

This commit also contains a small change to make it build locally.
Assuming you have the dependencies installed you can do:
```
cd docs
make html
```
Preview the html files in docs/build/html with
`python -m http.server 8000 --directory build/html`.

Fixes containers/podman.io#373

Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
2021-03-29 14:38:25 +02:00

66 lines
1.4 KiB
Markdown

% podman-machine-rm(1)
## NAME
podman\-machine\-rm - Remove a virtual machine
## SYNOPSIS
**podman machine rm** [*options*] [*name*]
## DESCRIPTION
Remove a virtual machine and its related files. What is actually deleted
depends on the virtual machine type. For all virtual machines, the generated
SSH keys and the podman system connection are deleted. The ignition files
generated for that VM are also removed as is its image file on the filesystem.
Users get a display of what will be deleted and are required to confirm unless the option `--force`
is used.
## OPTIONS
#### **\-\-help**
Print usage statement.
#### **\-\-force**
Delete without confirmation
#### **\-\-save-ignition**
Do not delete the generated ignition file
#### **\-\-save-image**
Do not delete the VM image
#### **\-\-save-keys**
Do not delete the SSH keys for the VM. The system connection is always
deleted.
## EXAMPLES
Remove a VM named "test1"
```
$ podman machine rm test1
The following files will be deleted:
/home/user/.ssh/test1
/home/user/.ssh/test1.pub
/home/user/.config/containers/podman/machine/qemu/test1.ign
/home/user/.local/share/containers/podman/machine/qemu/test1_fedora-coreos-33.20210315.1.0-qemu.x86_64.qcow2
/home/user/.config/containers/podman/machine/qemu/test1.json
Are you sure you want to continue? [y/N] y
```
## SEE ALSO
podman-machine (1)
## HISTORY
March 2021, Originally compiled by Ashley Cui <acui@redhat.com>