summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-pod-create.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2021-03-29 13:52:59 +0200
committerPaul Holzinger <paul.holzinger@web.de>2021-03-29 14:38:25 +0200
commitbc48211924bd8f88263149f8b5d047a52f8d1733 (patch)
tree9e9d01ba112981055b9d5351af35c38b3b3bc20e /docs/source/markdown/podman-pod-create.1.md
parent7e4b13b94699ee688c146afab727d2dec991376a (diff)
downloadpodman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.gz
podman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.bz2
podman-bc48211924bd8f88263149f8b5d047a52f8d1733.zip
Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash. I tested that this change is safe and still renders correctly on github and with the man pages. This commit also contains a small change to make it build locally. Assuming you have the dependencies installed you can do: ``` cd docs make html ``` Preview the html files in docs/build/html with `python -m http.server 8000 --directory build/html`. Fixes containers/podman.io#373 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.md48
1 files changed, 24 insertions, 24 deletions
diff --git a/docs/source/markdown/podman-pod-create.1.md b/docs/source/markdown/podman-pod-create.1.md
index 22eb07bf3..9ecde1ca3 100644
--- a/docs/source/markdown/podman-pod-create.1.md
+++ b/docs/source/markdown/podman-pod-create.1.md
@@ -15,71 +15,71 @@ containers added to it. The pod id is printed to STDOUT. You can then use
## OPTIONS
-#### **--add-host**=_host_:_ip_
+#### **\-\-add-host**=_host_:_ip_
Add a host to the /etc/hosts file shared between all containers in the pod.
-#### **--cgroup-parent**=*path*
+#### **\-\-cgroup-parent**=*path*
Path to cgroups under which the cgroup for the pod will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
-#### **--dns**=*ipaddr*
+#### **\-\-dns**=*ipaddr*
Set custom DNS servers in the /etc/resolv.conf file that will be shared between all containers in the pod. A special option, "none" is allowed which disables creation of /etc/resolv.conf for the pod.
-#### **--dns-opt**=*option*
+#### **\-\-dns-opt**=*option*
Set custom DNS options in the /etc/resolv.conf file that will be shared between all containers in the pod.
-#### **--dns-search**=*domain*
+#### **\-\-dns-search**=*domain*
Set custom DNS search domains in the /etc/resolv.conf file that will be shared between all containers in the pod.
-#### **--help**
+#### **\-\-help**
Print usage statement.
-#### **--hostname**=name
+#### **\-\-hostname**=name
Set a hostname to the pod
-#### **--infra**=**true**|**false**
+#### **\-\-infra**=**true**|**false**
Create an infra container and associate it with the pod. An infra container is a lightweight container used to coordinate the shared kernel namespace of a pod. Default: true.
-#### **--infra-conmon-pidfile**=*file*
+#### **\-\-infra-conmon-pidfile**=*file*
Write the pid of the infra container's **conmon** process to a file. As **conmon** runs in a separate process than Podman, this is necessary when using systemd to manage Podman containers and pods.
-#### **--infra-command**=*command*
+#### **\-\-infra-command**=*command*
The command that will be run to start the infra container. Default: "/pause".
-#### **--infra-image**=*image*
+#### **\-\-infra-image**=*image*
The image that will be created for the infra container. Default: "k8s.gcr.io/pause:3.1".
-#### **--ip**=*ipaddr*
+#### **\-\-ip**=*ipaddr*
Set a static IP for the pod's shared network.
-#### **--label**=*label*, **-l**
+#### **\-\-label**=*label*, **-l**
Add metadata to a pod (e.g., --label com.example.key=value).
-#### **--label-file**=*label*
+#### **\-\-label-file**=*label*
Read in a line delimited file of labels.
-#### **--mac-address**=*address*
+#### **\-\-mac-address**=*address*
Set a static MAC address for the pod's shared network.
-#### **--name**=*name*, **-n**
+#### **\-\-name**=*name*, **-n**
Assign a name to the pod.
-#### **--network**=*mode*, **--net**
+#### **\-\-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.
@@ -96,19 +96,19 @@ Set network mode for the pod. Supported values are
- **port_handler=rootlesskit**: Use rootlesskit for port forwarding. Default.
- **port_handler=slirp4netns**: Use the slirp4netns port forwarding.
-#### **--network-alias**=strings
+#### **\-\-network-alias**=strings
Add a DNS alias for the container. When the container is joined to a CNI network with support for the dnsname plugin, the container will be accessible through this name from other containers in the network.
-#### **--no-hosts**=**true**|**false**
+#### **\-\-no-hosts**=**true**|**false**
Disable creation of /etc/hosts for the pod.
-#### **--pod-id-file**=*path*
+#### **\-\-pod-id-file**=*path*
Write the pod ID to the file.
-#### **--publish**=*port*, **-p**
+#### **\-\-publish**=*port*, **-p**
Publish a port or range of ports from the pod to the host.
@@ -119,11 +119,11 @@ Use `podman port` to see the actual mapping: `podman port CONTAINER $CONTAINERPO
NOTE: This cannot be modified once the pod is created.
-#### **--replace**=**true**|**false**
+#### **\-\-replace**=**true**|**false**
If another pod with the same name already exists, replace and remove it. The default is **false**.
-#### **--share**=*namespace*
+#### **\-\-share**=*namespace*
A comma delimited list of kernel namespaces to share. If none or "" is specified, no namespaces will be shared. The namespaces to choose from are ipc, net, pid, uts.
@@ -133,7 +133,7 @@ UUID short identifier (“f78375b1c487”)
Name (“jonah”)
podman generates a UUID for each pod, and if a name is not assigned
-to the container with **--name** then a random string name will be generated
+to the container with **\-\-name** then a random string name will be generated
for it. The name is useful any place you need to identify a pod.
## EXAMPLES