docker
/
cli
зеркало из
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
cli/man
История
Sebastiaan van Stijn 676773a780 Fix incorrect aux-address examples and test 
The (host)name for aux-addresses should
be unique, otherwise later values overwrite
earlier values.

Before this change, the example command
would send this API request;

    {
      "Attachable": false,
      "CheckDuplicate": true,
      "Driver": "overlay",
      "EnableIPv6": false,
      "IPAM": {
        "Config": [
          {
            "Gateway": "192.168.0.100",
            "IPRange": "192.168.1.0/24",
            "Subnet": "192.168.0.0/16"
          },
          {
            "AuxiliaryAddresses": {
              "a": "192.170.1.5",
              "b": "192.170.1.6"
            },
            "Gateway": "192.170.0.100",
            "Subnet": "192.170.0.0/16"
          }
        ],
        "Driver": "default",
        "Options": {
        }
      },
      "Internal": false,
      "Labels": {
      },
      "Name": "my-multihost-network",
      "Options": {
      }
    }

After this change, the request looks
like this (all aux-addresses preserved);

    {
      "Attachable": false,
      "CheckDuplicate": true,
      "Driver": "overlay",
      "EnableIPv6": false,
      "IPAM": {
        "Config": [
          {
            "AuxiliaryAddresses": {
              "my-router": "192.168.1.5",
              "my-switch": "192.168.1.6"
            },
            "Gateway": "192.168.0.100",
            "IPRange": "192.168.1.0/24",
            "Subnet": "192.168.0.0/16"
          },
          {
            "AuxiliaryAddresses": {
              "my-printer": "192.170.1.5",
              "my-nas": "192.170.1.6"
            },
            "Gateway": "192.170.0.100",
            "Subnet": "192.170.0.0/16"
          }
        ],
        "Driver": "default",
        "Options": {
        }
      },
      "Internal": false,
      "Labels": {
      },
      "Name": "my-multihost-network",
      "Options": {
      }
    }

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 		2017-06-02 00:10:12 +00:00
..
Dockerfile Use the correct version of glide 2017-06-02 00:10:06 +00:00
Dockerfile.5.md Clarify warning against using build-time variables for secrets 2017-06-02 00:07:49 +00:00
Dockerfile.aarch64 Add a Dockerfile for generating manpages on aarch64 2017-06-02 00:10:06 +00:00
Dockerfile.armhf Use the correct version of glide 2017-06-02 00:10:06 +00:00
Dockerfile.ppc64le ppc64le: add support for building docker debs for xenial 2017-06-02 00:10:06 +00:00
Dockerfile.s390x Add a Dockerfile for generating manpages on s390x 2017-06-02 00:10:06 +00:00
README.md Make README less scabious 2017-06-02 00:10:02 +00:00
docker-attach.1.md Fix a couple of typos in the docs of `docker attach` 2017-06-02 00:07:42 +00:00
docker-build.1.md Document valid chars in image name and tag 2017-06-02 00:07:39 +00:00
docker-commit.1.md Document valid chars in image name and tag 2017-06-02 00:07:39 +00:00
docker-config-json.5.md man: mv config-json.5 to docker-config-json.5 2017-06-02 00:07:42 +00:00
docker-cp.1.md update docs/reference/commandline/cp.md 2017-06-02 00:07:40 +00:00
docker-create.1.md Update man page for `docker create` to add `--rm` flag 2017-06-02 00:10:08 +00:00
docker-diff.1.md
…
docker-events.1.md add `docker events --format` 2017-06-02 00:10:10 +00:00
docker-exec.1.md
…
docker-export.1.md
…
docker-history.1.md
…
docker-images.1.md fix the man page and zsh completion for `docker images` 2017-06-02 00:10:11 +00:00
docker-import.1.md
…
docker-info.1.md add `--format` flag to `docker info` 2017-06-02 00:10:05 +00:00
docker-inspect.1.md Refactor `docker inspect` to work on all types 2017-06-02 00:10:07 +00:00
docker-kill.1.md
…
docker-load.1.md Update docker-load documentation 2017-06-02 00:07:42 +00:00
docker-login.1.md fix docs about `sudo docker login` 2017-06-02 00:10:08 +00:00
docker-logout.1.md
…
docker-logs.1.md Replace U+2018 and U+2019 with U+0027 in manpages 2017-06-02 00:07:39 +00:00
docker-network-connect.1.md
…
docker-network-create.1.md Fix incorrect aux-address examples and test 2017-06-02 00:10:12 +00:00
docker-network-disconnect.1.md
…
docker-network-inspect.1.md Fix inspect network show gateway with mask 2017-06-02 00:10:04 +00:00
docker-network-ls.1.md Fix incorrect help output in `docker network ls` 2017-06-02 00:10:08 +00:00
docker-network-rm.1.md
…
docker-pause.1.md
…
docker-port.1.md
…
docker-ps.1.md add support for filtering by network ID 2017-06-02 00:07:42 +00:00
docker-pull.1.md
…
docker-push.1.md Synchronize push reference with man page 2017-06-02 00:10:10 +00:00
docker-rename.1.md Modify rename function usage 2017-06-02 00:10:09 +00:00
docker-restart.1.md Modify docker-restart.1.md 2017-06-02 00:10:08 +00:00
docker-rm.1.md
…
docker-rmi.1.md
…
docker-run.1.md Fix capitalization 2017-06-02 00:10:05 +00:00
docker-save.1.md
…
docker-search.1.md Add `--limit` option to `docker search` 2017-06-02 00:07:41 +00:00
docker-start.1.md
…
docker-stats.1.md Add documentation for docker stats --format 2017-06-02 00:10:11 +00:00
docker-stop.1.md
…
docker-tag.1.md Document valid chars in image name and tag 2017-06-02 00:07:39 +00:00
docker-top.1.md
…
docker-unpause.1.md
…
docker-update.1.md Forbid update restart policy of container with AutoRemove flag 2017-06-02 00:10:05 +00:00
docker-version.1.md
…
docker-wait.1.md
…
docker.1.md Modify restart function prompt 2017-06-02 00:10:07 +00:00
dockerd.8.md Update man page for dm.xfs_nospace_max_retries 2017-06-02 00:10:11 +00:00
generate.go Move api/client -> cli/command 2017-06-02 00:10:09 +00:00
generate.sh Add a script to generate man pages from cobra commands. 2017-06-02 00:07:51 +00:00
glide.lock update go-md2man to v1.0.6 2017-06-02 00:10:09 +00:00
glide.yaml Add a script to generate man pages from cobra commands. 2017-06-02 00:07:51 +00:00
md2man-all.sh
…

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