Skip to content

Files

Latest commit

8cfcd87 · Sep 16, 2015

History

History
This branch is 33402 commits behind moby/moby:master.

man

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jul 21, 2015
Sep 16, 2015
Sep 15, 2015
Jun 10, 2015
Sep 16, 2015
Aug 19, 2015
Sep 15, 2015
Sep 16, 2015
Jun 10, 2015
Jun 10, 2015
Aug 13, 2015
Jul 2, 2015
Aug 19, 2015
Aug 13, 2015
Aug 25, 2015
Jun 10, 2015
Sep 16, 2015
Jun 10, 2015
Jul 24, 2015
Jul 10, 2015
Jul 2, 2015
Sep 11, 2015
Jun 10, 2015
Jun 10, 2015
Aug 26, 2015
Sep 4, 2015
Jul 13, 2015
Jun 10, 2015
Jun 10, 2015
Jul 26, 2015
Jul 13, 2015
Sep 16, 2015
Jun 10, 2015
Jul 20, 2015
Jun 10, 2015
Jul 31, 2015
Sep 10, 2015
Sep 4, 2015
Jul 2, 2015
Jun 10, 2015
Jul 13, 2015
Sep 9, 2015
Sep 9, 2015
Sep 9, 2015
Sep 9, 2015
Jun 10, 2015
Sep 16, 2015
Jun 10, 2015

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