diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/machine.rst | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-machine-create.1.md | 6 | ||||
| -rw-r--r-- | docs/source/markdown/podman-machine-remove.1.md (renamed from docs/source/markdown/podman-machine-destroy.1.md) | 14 | ||||
| -rw-r--r-- | docs/source/markdown/podman-machine-ssh.1.md | 10 | ||||
| -rw-r--r-- | docs/source/markdown/podman-machine.1.md | 2 |
5 files changed, 20 insertions, 14 deletions
diff --git a/docs/source/machine.rst b/docs/source/machine.rst index aefceb3a5..cf7f72cce 100644 --- a/docs/source/machine.rst +++ b/docs/source/machine.rst @@ -3,7 +3,7 @@ Machine :doc:`create <markdown/podman-machine-create.1>` Create a new virtual machine -:doc:`destroy <markdown/podman-machine-destroy.1>` Destroy a virtual machine +:doc:`remove <markdown/podman-machine-remove.1>` Remove a virtual machine :doc:`ssh <markdown/podman-machine-ssh.1>` SSH into a virtual machine :doc:`start <markdown/podman-machine-start.1>` Start a virtual machine :doc:`stop <markdown/podman-machine-stop.1>` Stop a virtual machine diff --git a/docs/source/markdown/podman-machine-create.1.md b/docs/source/markdown/podman-machine-create.1.md index 1e199bb77..eb498f2dd 100644 --- a/docs/source/markdown/podman-machine-create.1.md +++ b/docs/source/markdown/podman-machine-create.1.md @@ -4,7 +4,7 @@ podman\-machine\-create - Create a new virtual machine ## SYNOPSIS -**podman machine create** [*options*] *name* +**podman machine create** [*options*] [*name*] ## DESCRIPTION @@ -34,10 +34,6 @@ Fully qualified path of the uncompressed image file Memory (in MB). -#### **--name** - -Name to assign to the VM - #### **--help** Print usage statement. diff --git a/docs/source/markdown/podman-machine-destroy.1.md b/docs/source/markdown/podman-machine-remove.1.md index 7c5421418..07763741d 100644 --- a/docs/source/markdown/podman-machine-destroy.1.md +++ b/docs/source/markdown/podman-machine-remove.1.md @@ -1,17 +1,17 @@ -% podman-machine-destroy(1) +% podman-machine-remove(1) ## NAME -podman\-machine\-destroy - Destroy a virtual machine +podman\-machine\-remove - Remove a virtual machine ## SYNOPSIS -**podman machine destroy** [*options*] *name* +**podman machine remove** [*options*] *name* ## DESCRIPTION -Destroy a virtual machine and its related files. What is actually deleted +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 destroyed as is its image file on the filesystem. +generated for that VM are also removeed 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. @@ -42,10 +42,10 @@ deleted. ## EXAMPLES -Destroy a VM named "test1" +Remove a VM named "test1" ``` -$ podman machine destroy test1 +$ podman machine remove test1 The following files will be deleted: diff --git a/docs/source/markdown/podman-machine-ssh.1.md b/docs/source/markdown/podman-machine-ssh.1.md index ed35a38e4..bcecd1010 100644 --- a/docs/source/markdown/podman-machine-ssh.1.md +++ b/docs/source/markdown/podman-machine-ssh.1.md @@ -16,16 +16,26 @@ tied to the Linux kernel. ## OPTIONS +#### **--execute**, **-e** + +Execute the given command on the VM + #### **--help** Print usage statement. ## EXAMPLES +To get an interactive session with a VM called `myvm`: ``` $ podman machine ssh myvm ``` +To run a command on a VM called `myvm`: +``` +$ podman machine ssh -e myvm -- rpm -q podman +``` + ## SEE ALSO podman-machine (1) diff --git a/docs/source/markdown/podman-machine.1.md b/docs/source/markdown/podman-machine.1.md index b31d8f788..52f212cdd 100644 --- a/docs/source/markdown/podman-machine.1.md +++ b/docs/source/markdown/podman-machine.1.md @@ -14,7 +14,7 @@ podman\-machine - Manage Podman's virtual machine | Command | Man Page | Description | | ------- | ------------------------------------------------------- | ----------------------------- | | create | [podman-machine-create(1)](podman-machine-create.1.md) | Create a new virtual machine | -| destroy | [podman-machine-destroy(1)](podman-machine-destroy.1.md)| Destroy a virtual machine | +| remove | [podman-machine-destroy(1)](podman-machine-remove.1.md)| Remove a virtual machine | | ssh | [podman-machine-ssh.1.md(1)](podman-machine-ssh.1.md) | SSH into a virtual machine | | start | [podman-machine-start(1)](podman-machine-start.1.md) | Start a virtual machine | | stop | [podman-machine-stop(1)](podman-machine-stop.1.md) | Stop a virtual machine | |