Files
docker-cli/components/engine/man
Vincent Demeester e191a06015 Add 'ancestor' ps filter for image
Makes it possible to filter containers by image, using
--filter=ancestor=busybox and get all the container running busybox
image and image based on busybox (to the bottom).

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: c1af0ac0820d1385fe2ee65593b0558840395c7b
Component: engine
2015-08-26 22:59:48 +02:00
..
2015-07-23 10:26:06 +08:00
2015-08-19 10:07:32 -04:00
2015-06-10 13:43:35 -07:00
2015-06-10 13:43:35 -07:00
2015-08-18 11:19:57 -04:00
2015-06-10 13:43:35 -07:00
2015-07-24 13:39:29 -07:00
2015-06-10 13:43:35 -07:00
2015-06-10 13:43:35 -07:00
2015-06-10 13:43:35 -07:00
2015-07-20 11:47:59 -04:00
2015-06-10 13:43:35 -07:00
2015-07-20 11:47:59 -04:00
2015-06-10 13:43:35 -07:00
2015-06-10 13:43:35 -07:00
2015-08-03 12:51:10 -04:00
2015-08-26 13:37:52 -04:00
2015-08-26 13:37:52 -04:00
2015-08-26 13:37:52 -04:00
2015-08-26 13:37:52 -04:00
2015-06-10 13:43:35 -07:00
2015-07-21 10:42:02 -04:00
2015-06-10 13:43:35 -07:00
2015-06-10 13:43:35 -07: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/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/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/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/).