docker
/
cli
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cli/man
History
Sebastiaan van Stijn 80bca8eb1d
man: rewrite to use cli-docs-tool manpage generator 
It's a wrapper around Cobra's generator, but handles some special
cases. While rewriting, also rewrite the generator code to align
with the mddocs/yamldocs counterpart in docs/generate/

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 		2025-03-25 17:07:40 +01:00
..
src docs, man: remove confusing example for "--isolation" 2025-01-02 12:15:08 +01: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 docs, man: remove confusing example for "--isolation" 2025-01-02 12:15:08 +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
generate.go man: rewrite to use cli-docs-tool manpage generator 2025-03-25 17:07:40 +01:00
tools.go docs: include required tools in source tree 2025-03-21 00:13:56 +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