summaryrefslogtreecommitdiff
path: root/docs/source/markdown
diff options
context:
space:
mode:
authorAshley Cui <acui@redhat.com>2021-09-16 15:17:02 -0400
committerAshley Cui <acui@redhat.com>2021-09-17 13:33:56 -0400
commite3e9e5175fdb9cbec8bf0c603b8b336eaad7808c (patch)
tree1f875d2e91126c08fcbc52f207c14f619920bcf3 /docs/source/markdown
parent9119a578e782b92bd344f093f5491c318bc20d69 (diff)
downloadpodman-e3e9e5175fdb9cbec8bf0c603b8b336eaad7808c.tar.gz
podman-e3e9e5175fdb9cbec8bf0c603b8b336eaad7808c.tar.bz2
podman-e3e9e5175fdb9cbec8bf0c603b8b336eaad7808c.zip
Add username flag for machine ssh
allow users to specify what username to use when ssh-ing into the vm. If the username flag is set, the username will be the flag value. If the flag is not set and the the vm name is specified, the default user of the vm will be used. if the flag is not set, and the vm name is not specified, then the username of the default connection will be used. Signed-off-by: Ashley Cui <acui@redhat.com>
Diffstat (limited to 'docs/source/markdown')
-rw-r--r--docs/source/markdown/podman-machine-ssh.1.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-machine-ssh.1.md b/docs/source/markdown/podman-machine-ssh.1.md
index a5cf69107..c4c732819 100644
--- a/docs/source/markdown/podman-machine-ssh.1.md
+++ b/docs/source/markdown/podman-machine-ssh.1.md
@@ -4,7 +4,7 @@
podman\-machine\-ssh - SSH into a virtual machine
## SYNOPSIS
-**podman machine ssh** [*name*] [*command* [*arg* ...]]
+**podman machine ssh** [*options*] [*name*] [*command* [*arg* ...]]
## DESCRIPTION
@@ -21,6 +21,10 @@ with the virtual machine is established.
Print usage statement.
+#### **--username**=*name*
+
+Username to use when SSH-ing into the VM.
+
## EXAMPLES
To get an interactive session with the default virtual machine: