diff options
author | Paul Holzinger <paul.holzinger@web.de> | 2020-11-10 14:59:34 +0100 |
---|---|---|
committer | Paul Holzinger <paul.holzinger@web.de> | 2020-11-10 15:27:08 +0100 |
commit | 52a869470530f3c6bf7820a2b63fa9e17f227a16 (patch) | |
tree | 84d2940f763b124c75dd124aecbf76ff3707f140 /docs/source/markdown/podman-exec.1.md | |
parent | da01191aa3526e3a77d9a055e23c318c26720785 (diff) | |
download | podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.tar.gz podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.tar.bz2 podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.zip |
Add anchors for flag names on docs.podman.io
Change the docs markdown so that flag names will be h4 headers.
Sphinx will automatically add anchors to headers. Add css to
make sure the flag names are not to big compared to the text.
The man pages also still renders fine but it looks a bit different.
Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source/markdown/podman-exec.1.md')
-rw-r--r-- | docs/source/markdown/podman-exec.1.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/source/markdown/podman-exec.1.md b/docs/source/markdown/podman-exec.1.md index f44a3d3d9..17d620cf8 100644 --- a/docs/source/markdown/podman-exec.1.md +++ b/docs/source/markdown/podman-exec.1.md @@ -13,39 +13,39 @@ podman\-exec - Execute a command in a running container ## OPTIONS -**--detach**, **-d** +#### **--detach**, **-d** Start the exec session, but do not attach to it. The command will run in the background and the exec session will be automatically removed when it completes. The **podman exec** command will print the ID of the exec session and exit immediately after it starts. -**--detach-keys**=*sequence* +#### **--detach-keys**=*sequence* Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*. -**--env**, **-e** +#### **--env**, **-e** You may specify arbitrary environment variables that are available for the command to be executed. -**--env-file**=*file* +#### **--env-file**=*file* Read in a line delimited file of environment variables. -**--interactive**, **-i**=*true|false* +#### **--interactive**, **-i**=*true|false* When set to true, keep stdin open even if not attached. The default is *false*. -**--latest**, **-l** +#### **--latest**, **-l** 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. The latest option is not supported on the remote client. -**--preserve-fds**=*N* +#### **--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. -**--privileged** +#### **--privileged** Give extended privileges to this container. The default is *false*. @@ -61,17 +61,17 @@ points, Apparmor/SELinux separation, and Seccomp filters are all disabled. Rootless containers cannot have more privileges than the account that launched them. -**--tty**, **-t** +#### **--tty**, **-t** Allocate a pseudo-TTY. -**--user**, **-u** +#### **--user**, **-u** Sets the username or UID used and optionally the groupname or GID for the specified command. The following examples are all valid: --user [user | user:group | uid | uid:gid | user:gid | uid:group ] -**--workdir**, **-w**=*path* +#### **--workdir**, **-w**=*path* Working directory inside the container |