Files
docker-cli/components/engine/man
Daniel Hiltgen bed0f28df0 Document updates for cluster-store-opt
This updates the docs for the daemon based on the new cluster-store-opt
for TLS support.

Signed-off-by: Daniel Hiltgen <daniel.hiltgen@docker.com>
Upstream-commit: ab83cf37c9df38e058938ef762aaefbc85f98f7d
Component: engine
2015-10-12 08:05:02 -07:00
..
2015-09-15 11:58:20 +10:00
2015-06-10 13:43:35 -07:00
2015-10-09 13:53:51 +02: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-10-04 21:22:27 +02:00
2015-09-04 16:34:40 -04:00
2015-06-10 13:43:35 -07:00
2015-10-02 11:24:31 -04:00
2015-10-04 21:22:27 +02:00
2015-10-04 21:22:27 +02:00
2015-09-04 10:10:03 -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

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