diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 1 | ||||
| -rwxr-xr-x | docs/remote-docs.sh | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-build.1.md | 18 | ||||
| -rw-r--r-- | docs/source/markdown/podman-play-kube.1.md | 4 | ||||
| -rw-r--r-- | docs/source/markdown/podman-start.1.md | 4 | ||||
| -rw-r--r-- | docs/use-pagetitle.lua | 14 |
6 files changed, 39 insertions, 7 deletions
diff --git a/docs/README.md b/docs/README.md index 83f5c79a3..a00b8f39c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,6 +26,7 @@ link on that page. | ------------------------------------ | --------------------------- | | docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform | | docs/links-to-html.lua | pandoc filter to do aliases for html files | +| docs/use-pagetitle.lua | pandoc filter to set html document title | ## API Reference diff --git a/docs/remote-docs.sh b/docs/remote-docs.sh index 939c7264c..b1682e9cd 100755 --- a/docs/remote-docs.sh +++ b/docs/remote-docs.sh @@ -80,7 +80,10 @@ function html_fn() { local link=$(sed -e 's?.so man1/\(.*\)?\1?' <$dir/links/${file%.md}) markdown=$dir/$link.md fi - pandoc --ascii --lua-filter=docs/links-to-html.lua -o $TARGET/${file%%.*}.html $markdown + pandoc --ascii --standalone \ + --lua-filter=docs/links-to-html.lua \ + --lua-filter=docs/use-pagetitle.lua \ + -o $TARGET/${file%%.*}.html $markdown } # Run 'podman help' (possibly against a subcommand, e.g. 'podman help image') diff --git a/docs/source/markdown/podman-build.1.md b/docs/source/markdown/podman-build.1.md index 791e2d907..9fc4ffb5b 100644 --- a/docs/source/markdown/podman-build.1.md +++ b/docs/source/markdown/podman-build.1.md @@ -381,12 +381,6 @@ BUILDAH\_LAYERS environment variable. `export BUILDAH_LAYERS=true` Log output which would be sent to standard output and standard error to the specified file instead of to standard output and standard error. -#### **\-\-loglevel**=*number* - -Adjust the logging level up or down. Valid option values range from -2 to 3, -with 3 being roughly equivalent to using the global *--debug* option, and -values below 0 omitting even error messages which accompany fatal errors. - #### **\-\-manifest** "manifest" Name of the manifest list to which the image will be added. Creates the manifest list @@ -490,6 +484,18 @@ commands specified by the **RUN** instruction. Note: You can also override the default runtime by setting the BUILDAH\_RUNTIME environment variable. `export BUILDAH_RUNTIME=/usr/local/bin/runc` + +#### **\-\-secret**=**id=id,src=path** + +Pass secret information to be used in the Containerfile for building images +in a safe way that will not end up stored in the final image, or be seen in other stages. +The secret will be mounted in the container at the default location of `/run/secrets/id`. + +To later use the secret, use the --mount flag in a `RUN` instruction within a `Containerfile`: + +`RUN --mount=type=secret,id=mysecret cat /run/secrets/mysecret` + + #### **\-\-security-opt**=*option* Security Options diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md index 1074c27f8..ab2019139 100644 --- a/docs/source/markdown/podman-play-kube.1.md +++ b/docs/source/markdown/podman-play-kube.1.md @@ -70,6 +70,10 @@ Assign a static ip address to the pod. This option can be specified several time Set logging driver for all created containers. +#### **\-\-mac-address**=*MAC address* + +Assign a static mac address to the pod. This option can be specified several times when play kube creates more than one pod. + #### **\-\-network**=*networks*, **\-\-net** A comma-separated list of the names of CNI networks the pod should join. diff --git a/docs/source/markdown/podman-start.1.md b/docs/source/markdown/podman-start.1.md index 1822eab34..626e6e368 100644 --- a/docs/source/markdown/podman-start.1.md +++ b/docs/source/markdown/podman-start.1.md @@ -38,6 +38,10 @@ to run containers such as CRI-O, the last started container could be from either Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true* when attaching, *false* otherwise. +#### **\-\-all** + +Start all the containers created by Podman, default is only running containers. + ## EXAMPLE podman start mywebserver diff --git a/docs/use-pagetitle.lua b/docs/use-pagetitle.lua new file mode 100644 index 000000000..ebc92641d --- /dev/null +++ b/docs/use-pagetitle.lua @@ -0,0 +1,14 @@ +local List = require("pandoc.List") + +function Meta(m) + -- Use pagetitle instead of title (prevents pandoc inserting a <H1> title) + m.pagetitle = m.title + m.title = nil + + if m.pagetitle ~= nil and m.pagetitle.t == "MetaInlines" then + -- Add suffix to match the Sphinx HTML documentation + List.extend(m.pagetitle, {pandoc.Str" \u{2014} Podman documentation"}) + end + + return m +end |