mirror of https://github.com/docker/cli.git
8ef8f41311
Mostly, this makes sure that literals (such as true, false, host, private, examples of options usage etc.) are typeset in bold, except for filenames, which are typeset in italic. While at it, - remove some default values from synopsis as it should not be there; - fix man pages references (page name in bold, volume number in regular). This is not a complete fix, but a step in the right direction. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> |
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||
| Dockerfile.5.md | ||
| README.md | ||
| docker-build.1.md | ||
| docker-config-json.5.md | ||
| docker-run.1.md | ||
| docker.1.md | ||
| dockerd.8.md | ||
| generate.go | ||
| go.mod | ||
| tools.go | ||
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 -f docker.Makefile manpages