summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-09-26 16:27:21 +0200
committerGitHub <noreply@github.com>2022-09-26 16:27:21 +0200
commita399e58cfb85a46d7931d61167c6101a3ca1a3f3 (patch)
tree7f5fab2e086e1c6dc946034387e942b6942f2778 /docs
parentcad59a12b9b390bbebbd64586dbb4028750858cc (diff)
parent911ceb823a688396dd874cd763d0fa887cb2722c (diff)
downloadpodman-a399e58cfb85a46d7931d61167c6101a3ca1a3f3.tar.gz
podman-a399e58cfb85a46d7931d61167c6101a3ca1a3f3.tar.bz2
podman-a399e58cfb85a46d7931d61167c6101a3ca1a3f3.zip
Merge pull request #15936 from edsantiago/docs_dedup_sigproxy
[CI:DOCS] Man pages: Refactor common options: --sig-proxy
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/.gitignore1
-rw-r--r--docs/source/markdown/options/sig-proxy.md3
-rw-r--r--docs/source/markdown/podman-attach.1.md.in (renamed from docs/source/markdown/podman-attach.1.md)3
-rw-r--r--docs/source/markdown/podman-run.1.md.in4
-rw-r--r--docs/source/markdown/podman-start.1.md.in4
5 files changed, 9 insertions, 6 deletions
diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore
index af4c5360b..57a64e1c1 100644
--- a/docs/source/markdown/.gitignore
+++ b/docs/source/markdown/.gitignore
@@ -1,3 +1,4 @@
+podman-attach.1.md
podman-auto-update.1.md
podman-build.1.md
podman-container-clone.1.md
diff --git a/docs/source/markdown/options/sig-proxy.md b/docs/source/markdown/options/sig-proxy.md
new file mode 100644
index 000000000..bb940aed3
--- /dev/null
+++ b/docs/source/markdown/options/sig-proxy.md
@@ -0,0 +1,3 @@
+#### **--sig-proxy**
+
+Proxy received signals to the container process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.
diff --git a/docs/source/markdown/podman-attach.1.md b/docs/source/markdown/podman-attach.1.md.in
index c073fccf8..427f764dc 100644
--- a/docs/source/markdown/podman-attach.1.md
+++ b/docs/source/markdown/podman-attach.1.md.in
@@ -28,9 +28,8 @@ The default is **false**.\
Do not attach STDIN. The default is **false**.
-#### **--sig-proxy**
+@@option sig-proxy
-Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.\
The default is **true**.
## EXAMPLES
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index 2109a0e33..1259f0e37 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -439,9 +439,9 @@ Note: Labeling can be disabled for all containers by setting **label=false** in
@@option shm-size
-#### **--sig-proxy**
+@@option sig-proxy
-Sets whether the signals sent to the **podman run** command are proxied to the container process. SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is **true**.
+The default is **true**.
@@option stop-signal
diff --git a/docs/source/markdown/podman-start.1.md.in b/docs/source/markdown/podman-start.1.md.in
index 6fa41018b..a1ccc4120 100644
--- a/docs/source/markdown/podman-start.1.md.in
+++ b/docs/source/markdown/podman-start.1.md.in
@@ -60,9 +60,9 @@ Valid filters are listed below:
Instead of providing the container name or ID, use the last created container. If you use methods other than Podman
to run containers such as CRI-O, the last started container could be from either of those methods. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
-#### **--sig-proxy**
+@@option sig-proxy
-Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true* when attaching, *false* otherwise.
+The default is **true** when attaching, **false** otherwise.
## EXAMPLE