diff options
author | Paul Holzinger <paul.holzinger@web.de> | 2020-11-10 14:59:34 +0100 |
---|---|---|
committer | Paul Holzinger <paul.holzinger@web.de> | 2020-11-10 15:27:08 +0100 |
commit | 52a869470530f3c6bf7820a2b63fa9e17f227a16 (patch) | |
tree | 84d2940f763b124c75dd124aecbf76ff3707f140 /docs/source/markdown/podman-generate-systemd.1.md | |
parent | da01191aa3526e3a77d9a055e23c318c26720785 (diff) | |
download | podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.tar.gz podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.tar.bz2 podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.zip |
Add anchors for flag names on docs.podman.io
Change the docs markdown so that flag names will be h4 headers.
Sphinx will automatically add anchors to headers. Add css to
make sure the flag names are not to big compared to the text.
The man pages also still renders fine but it looks a bit different.
Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source/markdown/podman-generate-systemd.1.md')
-rw-r--r-- | docs/source/markdown/podman-generate-systemd.1.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/source/markdown/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md index f95c57399..445888d30 100644 --- a/docs/source/markdown/podman-generate-systemd.1.md +++ b/docs/source/markdown/podman-generate-systemd.1.md @@ -14,42 +14,42 @@ _Note: If you use this command with the remote client, you would still have to p ## OPTIONS -**--files**, **-f** +#### **--files**, **-f** Generate files instead of printing to stdout. The generated files are named {container,pod}-{ID,name}.service and will be placed in the current working directory. Note: On a system with SELinux enabled, the generated files will inherit contexts from the current working directory. Depending on the SELinux setup, changes to the generated files using `restorecon`, `chcon`, or `semanage` may be required to allow systemd to access these files. Alternatively, use the `-Z` option when running `mv` or `cp`. -**--format**=*format* +#### **--format**=*format* Print the created units in specified format (json). If `--files` is specified the paths to the created files will be printed instead of the unit content. -**--name**, **-n** +#### **--name**, **-n** Use the name of the container for the start, stop, and description in the unit file -**--new** +#### **--new** Using this flag will yield unit files that do not expect containers and pods to exist. Instead, new containers and pods are created based on their configuration files. The unit files are created best effort and may need to be further edited; please review the generated files carefully before using them in production. -**--time**, **-t**=*value* +#### **--time**, **-t**=*value* Override the default stop timeout for the container with the given value. -**--restart-policy**=*policy* +#### **--restart-policy**=*policy* Set the systemd restart policy. The restart-policy must be one of: "no", "on-success", "on-failure", "on-abnormal", "on-watchdog", "on-abort", or "always". The default policy is *on-failure*. -**--container-prefix**=*prefix* +#### **--container-prefix**=*prefix* Set the systemd unit name prefix for containers. The default is *container*. -**--pod-prefix**=*prefix* +#### **--pod-prefix**=*prefix* Set the systemd unit name prefix for pods. The default is *pod*. -**--separator**=*separator* +#### **--separator**=*separator* Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is *-*. |