Files

Wen Cheng Ma 9f64dc98bd Add Subnets info for user-defined network

* If user doesn't specify the subnets to create a network, it will pick
  subnets from inside preferred pool. This PR aims to inspect these subnets info

* Add integration tests for docker inspect the subnets.

* docker-py project is already synchronized.

* jenkins checks depend on https://github.com/docker/docker-py/pull/888

Fixes issue #18626

Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>

2017-06-02 00:07:24 +00:00

config-json.5.md

Creating a man page for the configuration file

2017-06-02 00:07:22 +00:00

docker-attach.1.md

Implement configurable detach key

2017-06-02 00:07:22 +00:00

docker-build.1.md

Fix docs for memory-swap

2017-06-02 00:07:21 +00:00

docker-commit.1.md

Fix man and commandline docs

2017-06-02 00:07:11 +00:00

docker-cp.1.md

Add '-L' option for cp

2017-06-02 00:07:18 +00:00

docker-create.1.md

Network scoped alias support

2017-06-02 00:07:24 +00:00

docker-daemon.8.md

Allow to set daemon and server configurations in a file.

2017-06-02 00:07:24 +00:00

docker-diff.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-events.1.md

Fix typos found across repository

2017-06-02 00:07:20 +00:00

docker-exec.1.md

Implement configurable detach key

2017-06-02 00:07:22 +00:00

docker-export.1.md

various man page typos

2017-06-02 00:07:12 +00:00

docker-history.1.md

remove =false from options that default to false in the docs

2017-06-02 00:07:21 +00:00

docker-images.1.md

remove =false from options that default to false in the docs

2017-06-02 00:07:21 +00:00

docker-import.1.md

various man page typos

2017-06-02 00:07:12 +00:00

docker-info.1.md

Added additional container information to "docker info".

2017-06-02 00:07:23 +00:00

docker-inspect.1.md

Add network ID to container inspect

2017-06-02 00:07:23 +00:00

docker-kill.1.md

Fix man pages

2017-06-02 00:07:16 +00:00

docker-load.1.md

Carry man page for 14637

2017-06-02 00:07:03 +00:00

docker-login.1.md

docker-login man/doc add security info

2017-06-02 00:07:17 +00:00

docker-logout.1.md

Unify docker commands' usage in man and help

2017-06-02 00:06:59 +00:00

docker-logs.1.md

remove =false from options that default to false in the docs

2017-06-02 00:07:21 +00:00

docker-network-connect.1.md

Add missing documentation for static IP options

2017-06-02 00:07:23 +00:00

docker-network-create.1.md

Add IPAM Config Options to match libnetwork

2017-06-02 00:07:24 +00:00

docker-network-disconnect.1.md

Forced endpoint cleanup

2017-06-02 00:07:23 +00:00

docker-network-inspect.1.md

Add Subnets info for user-defined network

2017-06-02 00:07:24 +00:00

docker-network-ls.1.md

Add filter for network ls to hide predefined net

2017-06-02 00:07:21 +00:00

docker-network-rm.1.md

Enhance docker network rm to delete multi net

2017-06-02 00:07:18 +00:00

docker-pause.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-port.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-ps.1.md

Improvement for docker subcommand's help messages

2017-06-02 00:07:22 +00:00

docker-pull.1.md

remove =false from options that default to false in the docs

2017-06-02 00:07:21 +00:00

docker-push.1.md

Modify man pages for image-naming

2017-06-02 00:07:01 +00:00

docker-rename.1.md

various man page typos

2017-06-02 00:07:12 +00:00

docker-restart.1.md

Fix man pages

2017-06-02 00:07:16 +00:00

docker-rm.1.md

remove =false from options that default to false in the docs

2017-06-02 00:07:21 +00:00

docker-rmi.1.md

remove =false from options that default to false in the docs

2017-06-02 00:07:21 +00:00

docker-run.1.md

Network scoped alias support

2017-06-02 00:07:24 +00:00

docker-save.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-search.1.md

remove =false from options that default to false in the docs

2017-06-02 00:07:21 +00:00

docker-start.1.md

Implement configurable detach key

2017-06-02 00:07:22 +00:00

docker-stats.1.md

remove =false from options that default to false in the docs

2017-06-02 00:07:21 +00:00

docker-stop.1.md

Fix man pages

2017-06-02 00:07:16 +00:00

docker-tag.1.md

Deprecate -f flag from docker tag

2017-06-02 00:07:18 +00:00

docker-top.1.md

Improvement of docker top Man Page

2017-06-02 00:07:18 +00:00

docker-unpause.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-update.1.md

Implemet docker update command

2017-06-02 00:07:21 +00:00

docker-version.1.md

add --format flag to docker version

2017-06-02 00:07:01 +00:00

docker-volume-create.1.md

Fix man pages

2017-06-02 00:07:16 +00:00

docker-volume-inspect.1.md

update docker volume man pages

2017-06-02 00:07:08 +00:00

docker-volume-ls.1.md

Fix man pages

2017-06-02 00:07:16 +00:00

docker-volume-rm.1.md

update docker volume man pages

2017-06-02 00:07:08 +00:00

docker-wait.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker.1.md

man page fix: remove -e/--exec-drive=native related description

2017-06-02 00:07:22 +00:00

Dockerfile

Bump go-md2man to 1.0.3

2017-06-02 00:07:02 +00:00

Dockerfile.5.md

docs: userguide: labels-custom-metadsata.md: update syntax for emtpy value labels

2017-06-02 00:07:21 +00:00

md2man-all.sh

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

README.md

updates to readme documents for manual page

2017-06-02 00:07:09 +00:00

README.md

Docker Documentation

This directory contains the Docker user manual in the Markdown format. Do not edit the man pages in the man1 directory. Instead, amend the Markdown (*.md) files.

Generating man pages from the Markdown files

The recommended approach for generating the man pages is via a Docker container using the supplied Dockerfile to create an image with the correct environment. This uses go-md2man, a pure Go Markdown to man page generator.

Building the md2man image

There is a Dockerfile provided in the /man directory of your 'docker/docker' fork.

Using this Dockerfile, create a Docker image tagged docker/md2man:

docker build -t docker/md2man .

Utilizing the image

From within the /man directory run the following command:

docker run -v $(pwd):/man -w /man -i docker/md2man ./md2man-all.sh

The md2man Docker container will process the Markdown files and generate the man pages inside the /man/man1 directory of your fork using Docker volumes. For more information on Docker volumes see the man page for docker run and also look at the article [Sharing Directories via Volumes] (https://docs.docker.com/use/working_with_volumes/).