Paul Holzinger bc48211924 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>

2021-03-29 14:38:25 +02:00

..

links

Fix missing podman-container-rename man page link

2021-01-15 12:57:33 +01:00

containers-mounts.conf.5.md

docs: Mention mounts.conf location for non-root users

2020-11-02 16:55:10 +01:00

podman-attach.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-auto-update.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-build.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-commit.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-completion.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-container-checkpoint.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-container-cleanup.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-container-exists.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-container-prune.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-container-restore.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-container-runlabel.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-container.1.md

Initial implementation of renaming containers

2021-01-14 18:29:28 -05:00

podman-cp.1.md

podman cp: ignore EPERMs in rootless mode

2021-03-09 09:02:14 +01:00

podman-create.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-diff.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-events.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-exec.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-export.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-generate-kube.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-generate-systemd.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-generate.1.md

podman-remote build does not support volumes

2021-03-08 13:46:42 -05:00

podman-healthcheck-run.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-healthcheck.1.md

Update document formatting and packaging code

2019-10-31 12:31:39 -05:00

podman-history.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-image-diff.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-image-exists.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-image-mount.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-image-prune.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-image-sign.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-image-tree.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-image-trust.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-image-unmount.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-image.1.md

Add missing pages for docs.podman.io

2020-08-10 19:35:23 -04:00

podman-images.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-import.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-info.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-init.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-inspect.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-kill.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-load.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-login.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-logout.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-logs.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-machine-init.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-machine-rm.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-machine-ssh.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-machine-start.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-machine-stop.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-machine.1.md

Podman machine enhancements

2021-03-27 10:08:11 -05:00

podman-manifest-add.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-manifest-annotate.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-manifest-create.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-manifest-exists.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-manifest-inspect.1.md

Manifest remove, push

2020-05-06 10:54:28 -04:00

podman-manifest-push.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-manifest-remove.1.md

Manifest remove, push

2020-05-06 10:54:28 -04:00

podman-manifest.1.md

podman manifest exists

2021-01-22 20:19:13 +01:00

podman-mount.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-network-connect.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-network-create.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-network-disconnect.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-network-exists.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-network-inspect.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-network-ls.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-network-prune.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-network-reload.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-network-rm.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-network.1.md

add network prune

2021-02-06 07:37:29 -06:00

podman-pause.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-play-kube.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-play.1.md

Update document formatting and packaging code

2019-10-31 12:31:39 -05:00

podman-pod-create.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-exists.1.md

Make man page headings more consistent

2020-10-16 15:06:33 -05:00

podman-pod-inspect.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-kill.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-pause.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-prune.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-ps.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-restart.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-rm.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-start.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-stats.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-stop.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-top.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod-unpause.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pod.1.md

Remove containers when pruning a stopped pod.

2019-11-26 13:19:31 -05:00

podman-port.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-ps.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-pull.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-push.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-remote.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-rename.1.md

Initial implementation of renaming containers

2021-01-14 18:29:28 -05:00

podman-restart.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-rm.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-rmi.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-run.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-save.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-search.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-secret-create.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-secret-inspect.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-secret-ls.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-secret-rm.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-secret.1.md

Implement Secrets

2021-02-09 09:13:21 -05:00

podman-start.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-stats.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-stop.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-system-connection-add.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-system-connection-default.1.md

[WIP] Refactor podman system connection

2020-07-22 15:25:44 -07:00

podman-system-connection-list.1.md

[WIP] Refactor podman system connection

2020-07-22 15:25:44 -07:00

podman-system-connection-remove.1.md

[WIP] Refactor podman system connection

2020-07-22 15:25:44 -07:00

podman-system-connection-rename.1.md

[WIP] Refactor podman system connection

2020-07-22 15:25:44 -07:00

podman-system-connection.1.md

podman-system-connection.1.md: fix copy/paste error

2021-02-24 11:09:19 -06:00

podman-system-df.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-system-migrate.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-system-prune.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-system-renumber.1.md

Switch references from libpod.conf to containers.conf

2020-07-20 15:09:54 -04:00

podman-system-reset.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-system-service.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-system.1.md

Repeat system pruning until there is nothing removed

2020-12-09 06:17:28 -05:00

podman-tag.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-top.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-unmount.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-unpause.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-unshare.1.md

Docs: consistency between man / --help

2020-06-24 10:39:10 -06:00

podman-untag.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-version.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-volume-create.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-volume-exists.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-volume-inspect.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-volume-ls.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-volume-prune.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-volume-rm.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman-volume.1.md

podman volume exists

2021-01-21 19:18:51 +01:00

podman-wait.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00

podman.1.md

Fix long option format on docs.podman.io

2021-03-29 14:38:25 +02:00