summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-generate-kube.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2021-03-29 13:52:59 +0200
committerPaul Holzinger <paul.holzinger@web.de>2021-03-29 14:38:25 +0200
commitbc48211924bd8f88263149f8b5d047a52f8d1733 (patch)
tree9e9d01ba112981055b9d5351af35c38b3b3bc20e /docs/source/markdown/podman-generate-kube.1.md
parent7e4b13b94699ee688c146afab727d2dec991376a (diff)
downloadpodman-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-generate-kube.1.md')
-rw-r--r--docs/source/markdown/podman-generate-kube.1.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/source/markdown/podman-generate-kube.1.md b/docs/source/markdown/podman-generate-kube.1.md
index 0e5a31ae6..90b4c59fb 100644
--- a/docs/source/markdown/podman-generate-kube.1.md
+++ b/docs/source/markdown/podman-generate-kube.1.md
@@ -18,11 +18,11 @@ Note that the generated Kubernetes YAML file can be used to re-run the deploymen
## OPTIONS
-#### **--filename**, **-f**=**filename**
+#### **\-\-filename**, **-f**=**filename**
Output to the given file, instead of STDOUT. If the file already exists, `generate kube` will refuse to replace it and return an error.
-#### **--service**, **-s**
+#### **\-\-service**, **-s**
Generate a Kubernetes service object in addition to the Pods. Used to generate a Service specification for the corresponding Pod output. In particular, if the object has portmap bindings, the service specification will include a NodePort declaration to expose the service. A
random port is assigned by Podman in the specification.