diff options
| author | Ed Santiago <santiago@redhat.com> | 2022-09-14 15:12:32 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2022-09-26 07:25:10 -0600 |
| commit | 911ceb823a688396dd874cd763d0fa887cb2722c (patch) | |
| tree | 8feead08e207e87b7d63ddad2d4321bd72615e9f /docs | |
| parent | a00376111ef4d4275628c41d8424c223110cc626 (diff) | |
| download | podman-911ceb823a688396dd874cd763d0fa887cb2722c.tar.gz podman-911ceb823a688396dd874cd763d0fa887cb2722c.tar.bz2 podman-911ceb823a688396dd874cd763d0fa887cb2722c.zip | |
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 <santiago@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/.gitignore | 1 | ||||
| -rw-r--r-- | docs/source/markdown/options/sig-proxy.md | 3 | ||||
| -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.in | 4 | ||||
| -rw-r--r-- | docs/source/markdown/podman-start.1.md.in | 4 |
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 |