Files
docker-cli/components/engine/man
Brian Goff 7e07ac8939 On container rm, don't remove named mountpoints
This makes it so when calling `docker run --rm`, or `docker rm -v`, only
volumes specified without a name, e.g. `docker run -v /foo` instead of
`docker run -v awesome:/foo` are removed.

Note that all volumes are named, some are named by the user, some get a
generated name. This is specifically about how the volume was specified
on `run`, assuming that if the user specified it with a name they expect
it to persist after the container is cleaned up.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
Upstream-commit: dd7d1c8a02d8693aa4f381f82c5bbdcad9a5ff58
Component: engine
2016-01-25 15:51:28 -05:00
..
2015-12-30 09:23:35 +08:00
2015-11-21 00:36:56 +08:00
2015-06-10 13:43:35 -07:00
2015-10-13 11:52:14 -04:00
2015-10-13 11:52:14 -04:00
2015-11-10 09:33:55 +08: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-10-13 11:52:14 -04:00
2015-11-10 09:33:55 +08:00
2016-01-14 08:44:41 -08:00
2015-06-10 13:43:35 -07:00
2015-11-10 09:33:55 +08:00
2015-11-10 09:33:55 +08:00
2015-11-10 09:33:55 +08: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

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/).