История

Sebastiaan van Stijn 3f1195e4ec update go-md2man to v2.0.3 full diff: https://github.com/cpuguy83/go-md2man/compare/v2.0.1...v2.0.3 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>		2023-10-11 18:26:14 +02:00
..
src	man: update links to Go documentation	2023-08-25 14:11:18 +02: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	adding -c option for docker run/build in manpages	2023-08-25 15:06:16 +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	Fix extremely minor typo in docker-run man page	2023-09-07 21:11:13 -07:00
docker.1.md	docs: man page: typo fix in docker_1	2021-10-01 06:46:38 +03:00
dockerd.8.md	docs: remove devicemapper	2023-05-30 14:13:36 +02:00
generate.go	gofmt with go1.17	2022-03-26 20:21:00 +01:00
go.mod	update go-md2man to v2.0.3	2023-10-11 18:26:14 +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