DockerCLI/man
KGB33 1ca0b09336
Cleaned up formatting/typesetting.
Changed backticks to bold/italics, removed angle brackets.

Signed-off-by: Kelton Bassingthwaite <KeltonBassingthwaite@gmail.com>
(cherry picked from commit 2a167065d2)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-07 11:32:03 +01:00
..
src Cleaned up formatting/typesetting. 2023-01-07 11:32:03 +01:00
Dockerfile.5.md docs: rewrite reference docs for --stop-signal and --stop-timeout 2021-10-06 16:48:50 +02:00
README.md Make README less scabious 2017-06-02 00:10:02 +00: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 docs: rewrite reference docs for --stop-signal and --stop-timeout 2021-10-06 16:48:50 +02:00
docker.1.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
dockerd.8.md Fix the max-concurrent-downloads and max-concurrent-uploads configs documentation 2022-12-20 15:02:47 -03:00
generate.go man-pages: fix missing manual title in heading 2020-10-20 12:54:57 +02:00
import.go vendor: spf13/cobra v1.0.0, go-md2man v2.0.0, blackfriday v2.0.1 2020-05-04 17:00:46 +02:00
md2man-all.sh Rename bin/md2man to bin/go-md2man 2021-02-04 14:50:45 +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 manpages