History

Iain MacDonald 64c20f3013 Additional typo corrections Signed-off-by: Iain MacDonald <ijmacd@gmail.com> Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>		2024-06-20 12:18:43 +02:00
..
src	Additional typo corrections	2024-06-20 12:18:43 +02:00
.gitignore	validate manpages target	2022-02-25 17:11:17 +01:00
Dockerfile.5.md	Correct typos in docs/ and man/	2024-06-06 02:15:23 +00:00
README.md	validate manpages target	2022-02-25 17:11:17 +01:00
docker-build.1.md	man/docker-build.1: typo in parameter variable: CID => IID	2024-02-16 11:10:06 +01: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	Permit '=' separator and '[ipv6]' in --add-host	2023-12-07 18:29:19 +00:00
docker.1.md	Removed all mentions of "please" from docs and messages	2024-06-11 16:53:40 +02:00
dockerd.8.md	Removed all mentions of "please" from docs and messages	2024-06-11 16:53:40 +02:00
generate.go	gofmt with go1.17	2022-03-26 20:21:00 +01:00
go.mod	update go-md2man to v2.0.4	2024-06-18 21:47:47 +02:00
tools.go	gofmt with go1.17	2022-03-26 20:21:00 +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