summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-machine-init.1.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/markdown/podman-machine-init.1.md')
-rw-r--r--docs/source/markdown/podman-machine-init.1.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-machine-init.1.md b/docs/source/markdown/podman-machine-init.1.md
new file mode 100644
index 000000000..5ff07de03
--- /dev/null
+++ b/docs/source/markdown/podman-machine-init.1.md
@@ -0,0 +1,53 @@
+% podman-machine-init(1)
+
+## NAME
+podman\-machine\-init - Initialize a new virtual machine
+
+## SYNOPSIS
+**podman machine init** [*options*] [*name*]
+
+## DESCRIPTION
+
+Initialize a new virtual machine for Podman.
+
+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.
+
+**podman machine init** initializes a new Linux virtual machine where containers are run.
+
+## OPTIONS
+
+#### **--cpus**=*number*
+
+Number of CPUs.
+
+#### **--ignition-path**
+
+Fully qualified path of the ignition file
+
+#### **--image-path**
+
+Fully qualified path of the uncompressed image file
+
+#### **--memory**, **-m**=*number*
+
+Memory (in MB).
+
+#### **--help**
+
+Print usage statement.
+
+## EXAMPLES
+
+```
+$ podman machine init myvm
+$ podman machine init --device=/dev/xvdc:rw myvm
+$ podman machine init --memory=1024 myvm
+```
+
+## SEE ALSO
+podman-machine (1)
+
+## HISTORY
+March 2021, Originally compiled by Ashley Cui <acui@redhat.com>