summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-machine.1.md
diff options
context:
space:
mode:
authorAshley Cui <acui@redhat.com>2021-03-04 15:29:12 -0500
committerbaude <bbaude@redhat.com>2021-03-25 08:41:11 -0500
commita861f6fd3ebe4fe0b63a1b550e6b99d7525228c0 (patch)
tree6d39e58da427d09e75ebbb440521d520342a0089 /docs/source/markdown/podman-machine.1.md
parentaf91f27d85f4104267eea493f8588f8c6a2d01e3 (diff)
downloadpodman-a861f6fd3ebe4fe0b63a1b550e6b99d7525228c0.tar.gz
podman-a861f6fd3ebe4fe0b63a1b550e6b99d7525228c0.tar.bz2
podman-a861f6fd3ebe4fe0b63a1b550e6b99d7525228c0.zip
Podman machine CLI and interface stub
Podman machine will be a mac-only command that manages the VM where containers are run. Currently, only the CLI is written and the interface function for the VM management is stub for future developement The podman machine cli is only built on mac builds. Signed-off-by: Ashley Cui <acui@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-machine.1.md')
-rw-r--r--docs/source/markdown/podman-machine.1.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-machine.1.md b/docs/source/markdown/podman-machine.1.md
new file mode 100644
index 000000000..167a6a9e9
--- /dev/null
+++ b/docs/source/markdown/podman-machine.1.md
@@ -0,0 +1,24 @@
+% podman-machine(1)
+
+## NAME
+podman\-machine - Manage Podman's virtual machine
+
+## SYNOPSIS
+**podman machine** *subcommand*
+
+## DESCRIPTION
+`podman machine` is a set of subcommands that manage Podman's virtual machine on MacOS.
+
+## SUBCOMMANDS
+
+| Command | Man Page | Description |
+| ------- | ------------------------------------------------------- | ----------------------------- |
+| create | [podman-machine-create(1)](podman-machine-create.1.md) | Create a new 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 |
+
+## SEE ALSO
+podman(1)
+
+## HISTORY
+March 2021, Originally compiled by Ashley Cui <acui@redhat.com>