Files
docker-cli/components/cli/man
Vivek Goyal 9e52d04ed0 docker-inspect: Extend docker inspect to export image/container metadata related to graph driver
Export image/container metadata stored in graph driver. Right now 3 fields
DeviceId, DeviceSize and DeviceName are being exported from devicemapper.
Other graph drivers can export fields as they see fit.

This data can be used to mount the thin device outside of docker and tools
can look into image/container and do some kind of inspection.

Signed-off-by: Vivek Goyal <vgoyal@redhat.com>
Upstream-commit: 147a754d4a
Component: cli
2017-06-02 00:06:58 +00:00
..
2017-06-02 00:06:58 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:58 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:57 +00:00
2017-06-02 00:06:58 +00:00

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 docker/docs/man directory.

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

docker build -t docker/md2man .

Utilizing the image

Once the image is built, run a container using the image with volumes:

docker run -v /<path-to-git-dir>/docker/docs/man:/docs:rw \
-w /docs -i docker/md2man /docs/md2man-all.sh

The md2man Docker container will process the Markdown files and generate the man pages inside the docker/docs/man/man1 directory 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/).