summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-machine-list.1.md
diff options
context:
space:
mode:
authorAshley Cui <acui@redhat.com>2021-03-30 02:30:28 -0400
committerAshley Cui <acui@redhat.com>2021-03-30 14:56:21 -0400
commitef4e91a59eed957e56bf1536bc03df94cd096576 (patch)
tree4a72e690181c5e0bfada6e67424197b10d459b12 /docs/source/markdown/podman-machine-list.1.md
parent5e28b35aa511e699dffb2172458fda35ac01a4d2 (diff)
downloadpodman-ef4e91a59eed957e56bf1536bc03df94cd096576.tar.gz
podman-ef4e91a59eed957e56bf1536bc03df94cd096576.tar.bz2
podman-ef4e91a59eed957e56bf1536bc03df94cd096576.zip
Add podman machine list
podman machine list lists all virtual machines & indicates the default VM connection, if it exists. it also can take a --format flag arg as a go template. [NO TESTS NEEDED] Signed-off-by: Ashley Cui <acui@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-machine-list.1.md')
-rw-r--r--docs/source/markdown/podman-machine-list.1.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-machine-list.1.md b/docs/source/markdown/podman-machine-list.1.md
new file mode 100644
index 000000000..bd5608258
--- /dev/null
+++ b/docs/source/markdown/podman-machine-list.1.md
@@ -0,0 +1,50 @@
+% podman-machine-ls(1)
+
+## NAME
+podman\-machine\-list - List virtual machines
+
+## SYNOPSIS
+**podman machine list** [*options*]
+
+**podman machine ls** [*options*]
+
+## DESCRIPTION
+
+List Podman managed virtual machines.
+
+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 is
+tied to the Linux kernel.
+
+## OPTIONS
+
+#### **\-\-format**=*format*
+
+Format list output using a Go template.
+
+Valid placeholders for the Go template are listed below:
+
+| **Placeholder** | **Description** |
+| --------------- | ------------------------------- |
+| .Name | VM name |
+| .Created | Time since VM creation |
+| .LastUp | Time since the VM was last run |
+| .VMType | VM type |
+
+#### **\-\-help**
+
+Print usage statement.
+
+## EXAMPLES
+
+```
+$ podman machine list
+
+$ podman machine ls --format {{.Name}}\t{{.VMType}}\t{{.Created}}\t{{.LastUp}}\n
+```
+
+## SEE ALSO
+podman-machine(1)
+
+## HISTORY
+March 2021, Originally compiled by Ashley Cui <acui@redhat.com>