DockerCLI/man
Sebastiaan van Stijn 10973d6ddf
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>
(cherry picked from commit 0a0037c6fd)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-09-28 14:15:48 +02:00
..
src builder: rephrase ENV section, remove examples for ENV key value without '=' 2020-09-28 14:15:48 +02:00
Dockerfile.5.md builder: rephrase ENV section, remove examples for ENV key value without '=' 2020-09-28 14:15:48 +02:00
README.md Make README less scabious 2017-06-02 00:10:02 +00:00
docker-build.1.md docs: add missing cache-from man docs 2017-06-02 00:11:05 +00: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 support --mount type=bind,bind-nonrecursive,... 2019-01-10 12:07:46 +09:00
docker.1.md Update the manuals of docker and dockerd 2017-06-02 00:10:46 +00:00
dockerd.8.md Update document links and title. 2018-05-22 21:13:41 +08:00
generate.go Introduce functional arguments to NewDockerCli for a more stable API. 2019-01-28 14:52:58 +01:00
import.go Run docs and man generation in CI 2017-06-14 14:59:48 -07:00
md2man-all.sh Convert script shebangs from "#!/bin/bash" to "#!/usr/bin/env bash" 2017-06-02 00:10:54 +00: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