summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-pod-create.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2020-11-12 20:32:30 +0100
committerPaul Holzinger <paul.holzinger@web.de>2020-11-12 21:46:17 +0100
commitf5a2e578ebdcc38468fc777018099a6cc732c0f0 (patch)
treeef624856aed5e15b9bcaa198fcfa25bfb43bff89 /docs/source/markdown/podman-pod-create.1.md
parent7774f63319be64a0a96fb7ec7c9f0b7c28faac03 (diff)
downloadpodman-f5a2e578ebdcc38468fc777018099a6cc732c0f0.tar.gz
podman-f5a2e578ebdcc38468fc777018099a6cc732c0f0.tar.bz2
podman-f5a2e578ebdcc38468fc777018099a6cc732c0f0.zip
Maintain consistent order of short and long flag names in docs
Make the order of short and long flag names in the documentation consistent. Also adjust the man page validaten script to only allow the `**--long**, **-s**` syntax. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source/markdown/podman-pod-create.1.md')
-rw-r--r--docs/source/markdown/podman-pod-create.1.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/source/markdown/podman-pod-create.1.md b/docs/source/markdown/podman-pod-create.1.md
index 6fd42f800..22eb07bf3 100644
--- a/docs/source/markdown/podman-pod-create.1.md
+++ b/docs/source/markdown/podman-pod-create.1.md
@@ -63,7 +63,7 @@ The image that will be created for the infra container. Default: "k8s.gcr.io/pau
Set a static IP for the pod's shared network.
-#### **-l**, **--label**=*label*
+#### **--label**=*label*, **-l**
Add metadata to a pod (e.g., --label com.example.key=value).
@@ -75,17 +75,17 @@ Read in a line delimited file of labels.
Set a static MAC address for the pod's shared network.
-#### **-n**, **--name**=*name*
+#### **--name**=*name*, **-n**
Assign a name to the pod.
-#### **--network**=*mode*
+#### **--network**=*mode*, **--net**
Set network mode for the pod. Supported values are
-- `bridge`: Create a network stack on the default bridge. This is the default for rootful containers.
-- `host`: Do not create a network namespace, all containers in the pod will use the host's network. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
+- **bridge**: Create a network stack on the default bridge. This is the default for rootful containers.
+- **host**: Do not create a network namespace, all containers in the pod will use the host's network. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
- Comma-separated list of the names of CNI networks the pod should join.
-- `slirp4netns[:OPTIONS,...]`: use slirp4netns to create a user network stack. This is the default for rootless containers. It is possible to specify these additional options:
+- **slirp4netns[:OPTIONS,...]**: use slirp4netns to create a user network stack. This is the default for rootless containers. It is possible to specify these additional options:
- **allow_host_loopback=true|false**: Allow the slirp4netns to reach the host loopback IP (`10.0.2.2`). Default is false.
- **cidr=CIDR**: Specify ip range to use for this network. (Default is `10.0.2.0/24`).
- **enable_ipv6=true|false**: Enable IPv6. Default is false. (Required for `outbound_addr6`).
@@ -108,7 +108,7 @@ Disable creation of /etc/hosts for the pod.
Write the pod ID to the file.
-#### **-p**, **--publish**=*port*
+#### **--publish**=*port*, **-p**
Publish a port or range of ports from the pod to the host.