Skip to content

Commit

Permalink
Fix long option format on docs.podman.io
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Luap99 committed Mar 29, 2021
1 parent 7e4b13b commit bc48211
Show file tree
Hide file tree
Showing 113 changed files with 960 additions and 962 deletions.
6 changes: 1 addition & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,9 @@
# ones.
extensions = [
"sphinx_markdown_tables",
"recommonmark"
]

source_parsers = {
".md": "recommonmark.parser.CommonMarkParser",
}


# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

Expand Down
10 changes: 5 additions & 5 deletions docs/source/markdown/podman-attach.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/markdown/podman-auto-update.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Podman ships with a `podman-auto-update.service` systemd unit. This unit is tri

## OPTIONS

#### **--authfile**=*path*
#### **\-\-authfile**=*path*

Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.
Expand Down
Loading

0 comments on commit bc48211

Please sign in to comment.