DockerCLI/man
robmry a682b8e655 Permit '=' separator and '[ipv6]' in --add-host
Fixes #4648

Make it easier to specify IPv6 addresses in the '--add-host' option by
permitting 'host=ip' in addition to 'host:ip', and allowing square
brackets around the address.

For example:

    --add-host=my-hostname:127.0.0.1
    --add-host=my-hostname:::1
    --add-host=my-hostname=::1
    --add-host=my-hostname:[::1]

To avoid compatibility problems, the CLI will replace an '=' separator
with ':', and strip brackets, before sending the request to the API.

Signed-off-by: Rob Murray <rob.murray@docker.com>
2023-12-07 18:29:19 +00:00
..
src docs/man: fix -name flag with single hyphen 2023-11-27 20:58:55 +01: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 Permit '=' separator and '[ipv6]' in --add-host 2023-12-07 18:29:19 +00: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 docs: man page: typo fix in docker_1 2021-10-01 06:46:38 +03:00
dockerd.8.md docs: add default-network-opt daemon option 2023-11-06 10:48:36 +01: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