diff options
| author | Paul Holzinger <paul.holzinger@web.de> | 2021-03-29 13:52:59 +0200 |
|---|---|---|
| committer | Paul Holzinger <paul.holzinger@web.de> | 2021-03-29 14:38:25 +0200 |
| commit | bc48211924bd8f88263149f8b5d047a52f8d1733 (patch) | |
| tree | 9e9d01ba112981055b9d5351af35c38b3b3bc20e /docs/source/markdown/podman-attach.1.md | |
| parent | 7e4b13b94699ee688c146afab727d2dec991376a (diff) | |
| download | podman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.gz podman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.bz2 podman-bc48211924bd8f88263149f8b5d047a52f8d1733.zip | |
Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash.
I tested that this change is safe and still renders correctly on github
and with the man pages.
This commit also contains a small change to make it build locally.
Assuming you have the dependencies installed you can do:
```
cd docs
make html
```
Preview the html files in docs/build/html with
`python -m http.server 8000 --directory build/html`.
Fixes containers/podman.io#373
Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source/markdown/podman-attach.1.md')
| -rw-r--r-- | docs/source/markdown/podman-attach.1.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/source/markdown/podman-attach.1.md b/docs/source/markdown/podman-attach.1.md index c4a5eec50..eb770d07d 100644 --- a/docs/source/markdown/podman-attach.1.md +++ b/docs/source/markdown/podman-attach.1.md @@ -14,24 +14,24 @@ or name, either to view its ongoing output or to control it interactively. You can detach from the container (and leave it running) using a configurable key sequence. The default sequence is `ctrl-p,ctrl-q`. -Configure the keys sequence using the **--detach-keys** option, or specifying +Configure the keys sequence using the **\-\-detach-keys** option, or specifying it in the **containers.conf** file: see **containers.conf(5)** for more information. ## OPTIONS -#### **--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*. -#### **--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. (This option is not available with the remote Podman client) -#### **--no-stdin** +#### **\-\-no-stdin** Do not attach STDIN. The default is false. -#### **--sig-proxy**=*true*|*false* +#### **\-\-sig-proxy**=*true*|*false* Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*. |