From 911ceb823a688396dd874cd763d0fa887cb2722c Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Wed, 14 Sep 2022 15:12:32 -0600 Subject: [PATCH] Man pages: Refactor common options: --sig-proxy Unusually, I discarded the podman-run version and went with the one common to attach and start. (The defaults are left out of the common file, because 'start' is different by necessity). Please review extra-carefully to make sure the new wording applies to podman-run, in particular the "non-TTY mode" words. Signed-off-by: Ed Santiago --- docs/source/markdown/.gitignore | 1 + docs/source/markdown/options/sig-proxy.md | 3 +++ .../markdown/{podman-attach.1.md => podman-attach.1.md.in} | 3 +-- docs/source/markdown/podman-run.1.md.in | 4 ++-- docs/source/markdown/podman-start.1.md.in | 4 ++-- 5 files changed, 9 insertions(+), 6 deletions(-) create mode 100644 docs/source/markdown/options/sig-proxy.md rename docs/source/markdown/{podman-attach.1.md => podman-attach.1.md.in} (94%) diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore index af4c5360b1..57a64e1c1c 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 0000000000..bb940aed3f --- /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 similarity index 94% rename from docs/source/markdown/podman-attach.1.md rename to docs/source/markdown/podman-attach.1.md.in index c073fccf86..427f764dcc 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 2109a0e337..1259f0e37e 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 6fa41018b2..a1ccc41209 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