diff options
| author | Ed Santiago <santiago@redhat.com> | 2022-09-13 13:49:24 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2022-09-14 08:15:46 -0600 |
| commit | b6c75a3cc572b9a8299aaad5af287ec82c424ba8 (patch) | |
| tree | e49313e885f46ae4cd6b10bcbe975f7fcf59b1fc /docs/source/markdown/options | |
| parent | e1b3d9811a5655f4468b2b56a93513418e6678a2 (diff) | |
| download | podman-b6c75a3cc572b9a8299aaad5af287ec82c424ba8.tar.gz podman-b6c75a3cc572b9a8299aaad5af287ec82c424ba8.tar.bz2 podman-b6c75a3cc572b9a8299aaad5af287ec82c424ba8.zip | |
Man pages: refactor common options: --preserve-fds, -it
Three simple options shared among podman-create, exec, run.
I mostly went with the podman-run versions. For --tty, this
means that create and exec get the long stdout/stderr note.
(The example, though, remains only in podman-run). For -i,
mostly boldspace changes.
For --preserve-fds, podman-exec now has the "not with remote"
note (which it didn't until now)
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/options')
| -rw-r--r-- | docs/source/markdown/options/interactive.md | 3 | ||||
| -rw-r--r-- | docs/source/markdown/options/preserve-fds.md | 5 | ||||
| -rw-r--r-- | docs/source/markdown/options/tty.md | 9 |
3 files changed, 17 insertions, 0 deletions
diff --git a/docs/source/markdown/options/interactive.md b/docs/source/markdown/options/interactive.md new file mode 100644 index 000000000..a28088368 --- /dev/null +++ b/docs/source/markdown/options/interactive.md @@ -0,0 +1,3 @@ +#### **--interactive**, **-i** + +When set to **true**, keep stdin open even if not attached. The default is **false**. diff --git a/docs/source/markdown/options/preserve-fds.md b/docs/source/markdown/options/preserve-fds.md new file mode 100644 index 000000000..61e33bdf4 --- /dev/null +++ b/docs/source/markdown/options/preserve-fds.md @@ -0,0 +1,5 @@ +#### **--preserve-fds**=*N* + +Pass down to the process N additional file descriptors (in addition to 0, 1, 2). +The total FDs will be 3+N. +(This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) diff --git a/docs/source/markdown/options/tty.md b/docs/source/markdown/options/tty.md new file mode 100644 index 000000000..04bd8af2c --- /dev/null +++ b/docs/source/markdown/options/tty.md @@ -0,0 +1,9 @@ +#### **--tty**, **-t** + +Allocate a pseudo-TTY. The default is **false**. + +When set to **true**, Podman will allocate a pseudo-tty and attach to the standard +input of the container. This can be used, for example, to run a throwaway +interactive shell. + +**NOTE**: The --tty flag prevents redirection of standard output. It combines STDOUT and STDERR, it can insert control characters, and it can hang pipes. This option should only be used when run interactively in a terminal. When feeding input to Podman, use -i only, not -it. |