History

CrazyMax 7dc35c03fc validate manpages target Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>		2022-02-25 17:11:17 +01:00
..
src	Updated docker attach example.	2021-06-26 18:11:19 -06:00
.gitignore	validate manpages target	2022-02-25 17:11:17 +01:00
Dockerfile.5.md	docs: rewrite reference docs for --stop-signal and --stop-timeout	2021-08-21 18:29:07 +02:00
README.md	validate manpages target	2022-02-25 17:11:17 +01:00
docker-build.1.md	Update man-page source MarkDown to work with go-md2man v2	2020-10-20 12:21:15 +02:00
docker-config-json.5.md	Update man-page source MarkDown to work with go-md2man v2	2020-10-20 12:21:15 +02:00
docker-run.1.md	create/run: remove default --stop-signal	2021-08-25 09:53:42 +02:00
docker.1.md	docs: man page: typo fix in docker_1	2021-10-01 06:46:38 +03:00
dockerd.8.md	Document `--validate` daemon option	2021-06-24 15:00:21 +00:00
generate.go	validate manpages target	2022-02-25 17:11:17 +01:00
go.mod	validate manpages target	2022-02-25 17:11:17 +01:00
tools.go	validate manpages target	2022-02-25 17:11:17 +01: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 -f docker.Makefile manpages