aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-09-12 15:47:03 -0600
committerEd Santiago <santiago@redhat.com>2022-09-13 05:14:25 -0600
commitf30d4852efa8e7cc9b08f96edb9a023a370c52ab (patch)
tree5da2574afffbef6261f061131380858166daf0bd
parentc0dd0d696e333ad42a5fa3d9428fee27b1c30061 (diff)
downloadpodman-f30d4852efa8e7cc9b08f96edb9a023a370c52ab.tar.gz
podman-f30d4852efa8e7cc9b08f96edb9a023a370c52ab.tar.bz2
podman-f30d4852efa8e7cc9b08f96edb9a023a370c52ab.zip
Man pages: refactor common options: --ip
Between podman-create, run, and pod-create. The big difference is that I changed 'IP' to 'IPv4' in podman-pod-create, I believe that was an oversight in #12611. Signed-off-by: Ed Santiago <santiago@redhat.com>
-rw-r--r--docs/source/markdown/options/ip.md8
-rw-r--r--docs/source/markdown/podman-create.1.md.in9
-rw-r--r--docs/source/markdown/podman-pod-create.1.md.in9
-rw-r--r--docs/source/markdown/podman-run.1.md.in9
4 files changed, 11 insertions, 24 deletions
diff --git a/docs/source/markdown/options/ip.md b/docs/source/markdown/options/ip.md
new file mode 100644
index 000000000..8f251ee2e
--- /dev/null
+++ b/docs/source/markdown/options/ip.md
@@ -0,0 +1,8 @@
+#### **--ip**=*ipv4*
+
+Specify a static IPv4 address for the <<container|pod>>, for example **10.88.64.128**.
+This option can only be used if the <<container|pod>> is joined to only a single network - i.e., **--network=network-name** is used at most once -
+and if the <<container|pod>> is not joining another container's network namespace via **--network=container:_id_**.
+The address must be within the network's IP address pool (default **10.88.0.0/16**).
+
+To specify multiple static IP addresses per <<container|pod>>, set multiple networks using the **--network** option with a static IP address specified for each using the `ip` mode for that option.
diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in
index 6f6bb29e5..e2e7644f7 100644
--- a/docs/source/markdown/podman-create.1.md.in
+++ b/docs/source/markdown/podman-create.1.md.in
@@ -228,14 +228,7 @@ pod when that pod is not running.
Keep STDIN open even if not attached. The default is *false*.
-#### **--ip**=*ipv4*
-
-Specify a static IPv4 address for the container, for example **10.88.64.128**.
-This option can only be used if the container is joined to only a single network - i.e., **--network=network-name** is used at most once -
-and if the container is not joining another container's network namespace via **--network=container:_id_**.
-The address must be within the network's IP address pool (default **10.88.0.0/16**).
-
-To specify multiple static IP addresses per container, set multiple networks using the **--network** option with a static IP address specified for each using the `ip` mode for that option.
+@@option ip
#### **--ip6**=*ipv6*
diff --git a/docs/source/markdown/podman-pod-create.1.md.in b/docs/source/markdown/podman-pod-create.1.md.in
index f1fdc3e6b..e519518c1 100644
--- a/docs/source/markdown/podman-pod-create.1.md.in
+++ b/docs/source/markdown/podman-pod-create.1.md.in
@@ -99,14 +99,7 @@ The custom image that will be used for the infra container. Unless specified, P
@@option infra-name
-#### **--ip**=*ip*
-
-Specify a static IP address for the pod, for example **10.88.64.128**.
-This option can only be used if the pod is joined to only a single network - i.e., **--network=network-name** is used at most once -
-and if the pod is not joining another container's network namespace via **--network=container:_id_**.
-The address must be within the network's IP address pool (default **10.88.0.0/16**).
-
-To specify multiple static IP addresses per pod, set multiple networks using the **--network** option with a static IP address specified for each using the `ip` mode for that option.
+@@option ip
#### **--ip6**=*ipv6*
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index 53f7cfe99..c360c2e5d 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -249,14 +249,7 @@ Print usage statement
When set to **true**, keep stdin open even if not attached. The default is **false**.
-#### **--ip**=*ipv4*
-
-Specify a static IPv4 address for the container, for example **10.88.64.128**.
-This option can only be used if the container is joined to only a single network - i.e., **--network=network-name** is used at most once -
-and if the container is not joining another container's network namespace via **--network=container:_id_**.
-The address must be within the network's IP address pool (default **10.88.0.0/16**).
-
-To specify multiple static IP addresses per container, set multiple networks using the **--network** option with a static IP address specified for each using the `ip` mode for that option.
+@@option ip
#### **--ip6**=*ipv6*