summaryrefslogtreecommitdiff
path: root/docs/source/markdown
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-04-01 17:14:44 +0200
committerGitHub <noreply@github.com>2021-04-01 17:14:44 +0200
commit8b599c51268dc141bd963d8b5d3f25feadfcbb0e (patch)
tree6f6ade9a91ba306b3d27f7b8ae09da83830da7bd /docs/source/markdown
parent12881abc065afda5bf979accfead542d411f48d6 (diff)
parentf6438d36f3e52eb721f4223e767fd67b4c274d08 (diff)
downloadpodman-8b599c51268dc141bd963d8b5d3f25feadfcbb0e.tar.gz
podman-8b599c51268dc141bd963d8b5d3f25feadfcbb0e.tar.bz2
podman-8b599c51268dc141bd963d8b5d3f25feadfcbb0e.zip
Merge pull request #9894 from baude/machinesshfix
Remove --execute from podman machine ssh
Diffstat (limited to 'docs/source/markdown')
-rw-r--r--docs/source/markdown/podman-machine-ssh.1.md28
1 files changed, 18 insertions, 10 deletions
diff --git a/docs/source/markdown/podman-machine-ssh.1.md b/docs/source/markdown/podman-machine-ssh.1.md
index fa78f876a..30cbaf4bd 100644
--- a/docs/source/markdown/podman-machine-ssh.1.md
+++ b/docs/source/markdown/podman-machine-ssh.1.md
@@ -4,36 +4,44 @@
podman\-machine\-ssh - SSH into a virtual machine
## SYNOPSIS
-**podman machine ssh** [*options*] [*name*] [*command* [*arg* ...]]
+**podman machine ssh** [*name*] [*command* [*arg* ...]]
## DESCRIPTION
-SSH into a Podman-managed virtual machine.
+SSH into a Podman-managed virtual machine and optionally execute a command
+on the virtual machine. Unless using the default virtual machine, the
+first argument must be the virtual machine name. The optional command to
+execute can then follow. If no command is provided, an interactive session
+with the virtual machine is established.
-Podman on MacOS requires a virtual machine. This is because containers are Linux -
-containers do not run on any other OS because containers' core functionality are
-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 the default virtual machine:
+
+```
+$ podman machine ssh
+```
+
To get an interactive session with a VM called `myvm`:
```
$ podman machine ssh myvm
```
+To run a command on the default virtual machine:
+```
+$ podman machine ssh rpm -q podman
+```
+
To run a command on a VM called `myvm`:
```
-$ podman machine ssh -e myvm -- rpm -q podman
+$ podman machine ssh myvm rpm -q podman
```
## SEE ALSO