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-remote.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-remote.1.md')
| -rw-r--r-- | docs/source/markdown/podman-remote.1.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/source/markdown/podman-remote.1.md b/docs/source/markdown/podman-remote.1.md index 1a6c7d3cc..3e20e1ded 100644 --- a/docs/source/markdown/podman-remote.1.md +++ b/docs/source/markdown/podman-remote.1.md @@ -25,15 +25,15 @@ The `containers.conf` file should be placed under `$HOME/.config/containers/cont ## GLOBAL OPTIONS -#### **--connection**=*name*, **-c** +#### **\-\-connection**=*name*, **-c** Remote connection name -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement -#### **--identity**=*path* +#### **\-\-identity**=*path* Path to ssh identity file. If the identity file has been encrypted, Podman prompts the user for the passphrase. If no identity file is provided and no user is given, Podman defaults to the user running the podman command. @@ -44,11 +44,11 @@ Identity value resolution precedence: - environment variable `CONTAINER_SSHKEY`, if `CONTAINER_HOST` is found - `containers.conf` -#### **--log-level**=*level* +#### **\-\-log-level**=*level* Log messages above specified level: debug, info, warn, error (default), fatal or panic -#### **--url**=*value* +#### **\-\-url**=*value* URL to access Podman service (default from `containers.conf`, rootless "unix://run/user/$UID/podman/podman.sock" or as root "unix://run/podman/podman.sock). @@ -67,7 +67,7 @@ URL value resolution precedence: - `containers.conf` - `unix://run/podman/podman.sock` -#### **--version** +#### **\-\-version** Print the version |