summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-run.1.md.in
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-09-13 13:49:24 -0600
committerEd Santiago <santiago@redhat.com>2022-09-14 08:15:46 -0600
commitb6c75a3cc572b9a8299aaad5af287ec82c424ba8 (patch)
treee49313e885f46ae4cd6b10bcbe975f7fcf59b1fc /docs/source/markdown/podman-run.1.md.in
parente1b3d9811a5655f4468b2b56a93513418e6678a2 (diff)
downloadpodman-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/podman-run.1.md.in')
-rw-r--r--docs/source/markdown/podman-run.1.md.in19
1 files changed, 3 insertions, 16 deletions
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index d9dcd60f9..96605ee3f 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -245,9 +245,7 @@ Print usage statement
@@option init-path
-#### **--interactive**, **-i**
-
-When set to **true**, keep stdin open even if not attached. The default is **false**.
+@@option interactive
@@option ip
@@ -366,10 +364,7 @@ If a container is run with a pod, and the pod has an infra-container, the infra-
@@option pod-id-file.container
-#### **--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)
+@@option preserve-fds
@@option privileged
@@ -478,15 +473,7 @@ Sets whether the signals sent to the **podman run** command are proxied to the c
@@option tmpfs
-#### **--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. The default is **false**.
-
-**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.
+@@option tty
```
echo "asdf" | podman run --rm -i someimage /bin/cat