summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-pod-create.1.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2022-05-23 18:10:08 -0400
committerDaniel J Walsh <dwalsh@redhat.com>2022-05-24 13:17:02 -0400
commitdf394b5218dc3078f2d5f9ed83ca6e4f92e738c8 (patch)
tree8cf70a04db0b6cfc177f922efb1ab72c89326f97 /docs/source/markdown/podman-pod-create.1.md
parent2dc4f752c67e8e8c1035d6e2d689779cdc00004b (diff)
downloadpodman-df394b5218dc3078f2d5f9ed83ca6e4f92e738c8.tar.gz
podman-df394b5218dc3078f2d5f9ed83ca6e4f92e738c8.tar.bz2
podman-df394b5218dc3078f2d5f9ed83ca6e4f92e738c8.zip
Allow podman pod create to accept name argument
I am constantly attempting to add the podname to the last argument to podman pod create. Allowing this makes it match podman volume create and podman network create. It does not match podman container create, since podman container create arguments specify the arguments to run with the container. Still need to support the --name option for backwards compatibility. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-pod-create.1.md')
-rw-r--r--docs/source/markdown/podman-pod-create.1.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/source/markdown/podman-pod-create.1.md b/docs/source/markdown/podman-pod-create.1.md
index fa431b611..acccc832d 100644
--- a/docs/source/markdown/podman-pod-create.1.md
+++ b/docs/source/markdown/podman-pod-create.1.md
@@ -4,14 +4,15 @@
podman\-pod\-create - Create a new pod
## SYNOPSIS
-**podman pod create** [*options*]
+**podman pod create** [*options*] [*name*]
## DESCRIPTION
Creates an empty pod, or unit of multiple containers, and prepares it to have
-containers added to it. The pod id is printed to STDOUT. You can then use
-**podman create --pod `<pod_id|pod_name>` ...** to add containers to the pod, and
-**podman pod start `<pod_id|pod_name>`** to start the pod.
+containers added to it. The pod can be created with a specific name. If a name
+is not given a random name is generated. The pod id is printed to STDOUT. You
+can then use **podman create --pod `<pod_id|pod_name>` ...** to add containers
+to the pod, and **podman pod start `<pod_id|pod_name>`** to start the pod.
## OPTIONS
@@ -549,9 +550,11 @@ that data on the target.
```
$ podman pod create --name test
+$ podman pod create mypod
+
$ podman pod create --infra=false
-$ podman pod create --infra-command /top
+$ podman pod create --infra-command /top toppod
$ podman pod create --publish 8443:443