9b0c8d23bd
Command flags (OPTIONS) in man pages have to date been in haphazard order. Sometimes that order is sensible, e.g., most-important options first, but more often they're just in arbitrary places. This makes life hard for users. Here, I update the man-page-check Makefile script so it checks and enforces alphabetical order in OPTIONS sections. Then -- the hard part -- update all existing man pages to conform to this requirement. Signed-off-by: Ed Santiago <santiago@redhat.com>
1.5 KiB
% 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
--force, -f
Stop and delete without confirmation.
--help
Print usage statement.
--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
$ podman machine rm -f test1
$
SEE ALSO
HISTORY
March 2021, Originally compiled by Ashley Cui acui@redhat.com