DockerCLI/man
Sebastiaan van Stijn 0a0037c6fd
builder: rephrase ENV section, remove examples for ENV key value without '='
The `ENV key value` form can be ambiguous, for example, the following defines
a single env-variable (`ONE`) with value `"TWO= THREE=world"`:

    ENV ONE TWO= THREE=world

While we cannot deprecate/remove that syntax (as it would break existing
Dockerfiles), we should reduce exposure of the format in our examples.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-09-23 13:21:20 +02:00
..
src builder: rephrase ENV section, remove examples for ENV key value without '=' 2020-09-23 13:21:20 +02:00
Dockerfile.5.md builder: rephrase ENV section, remove examples for ENV key value without '=' 2020-09-23 13:21:20 +02:00
README.md Make README less scabious 2017-06-02 00:10:02 +00:00
docker-build.1.md man/docker-build.1:fix --memory-swamp and --network, removing = between long-form opts and values 2020-09-01 12:11:21 -04:00
docker-config-json.5.md man: mv config-json.5 to docker-config-json.5 2017-06-02 00:07:42 +00:00
docker-run.1.md docs: update for cgroup v2 and rootless 2020-06-24 19:24:54 +09:00
docker.1.md Update the manuals of docker and dockerd 2017-06-02 00:10:46 +00:00
dockerd.8.md docs: update for cgroup v2 and rootless 2020-06-24 19:24:54 +09:00
generate.go Introduce functional arguments to NewDockerCli for a more stable API. 2019-01-28 14:52:58 +01:00
import.go vendor: spf13/cobra v1.0.0, go-md2man v2.0.0, blackfriday v2.0.1 2020-05-04 17:00:46 +02:00
md2man-all.sh vendor: spf13/cobra v1.0.0, go-md2man v2.0.0, blackfriday v2.0.1 2020-05-04 17:00:46 +02:00

README.md

Docker Documentation

This directory contains scripts for generating the man pages. Many of the man pages are generated directly from the spf13/cobra Command definition. Some legacy pages are still generated from the markdown files in this directory. Do not edit the man pages in the man1 directory. Instead, update the Cobra command or amend the Markdown files for legacy pages.

Generate the man pages

From within the project root directory run:

make manpages