André Martins 0ce42dcc96 Fixes #10457-Pause-and-unpause-accept-multi-containers		10 éve
..
Dockerfile	3f136dc0e0 Use pure go markdown processor to generate man files	11 éve
Dockerfile.5.md	f709da192c Fix docs so WORKDIR mentions it works for COPY and ADD too	10 éve
README.md	aceb735dba Remove File List	10 éve
docker-attach.1.md	e58fdaae05 Docker attach documentation didn't make sense to me	10 éve
docker-build.1.md	f0c9818eba docs: fix another typo in docker-build man page	10 éve
docker-commit.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-cp.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-create.1.md	0c0f0d5ab4 update docs for memory and memoryswap	10 éve
docker-diff.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-events.1.md	f750f17451 Update events format in man page	10 éve
docker-exec.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-export.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-history.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-images.1.md	18a2c77435 Add build --pull and evenets --filter flags to the docs for 1.4	10 éve
docker-import.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-info.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-inspect.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-kill.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-load.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-login.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-logout.1.md	5743cc3423 user facing documentation changes in master atm	11 éve
docker-logs.1.md	18a2c77435 Add build --pull and evenets --filter flags to the docs for 1.4	10 éve
docker-pause.1.md	0ce42dcc96 Fixes #10457-Pause-and-unpause-accept-multi-containers	10 éve
docker-port.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-ps.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-pull.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-push.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-rename.1.md	21a809d9ae rename a existing container	10 éve
docker-restart.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-rm.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-rmi.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-run.1.md	0c0f0d5ab4 update docs for memory and memoryswap	10 éve
docker-save.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-search.1.md	25a8602cba Merge pull request #9840 from nhsiehgit/searchapidocs	10 éve
docker-start.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-stats.1.md	2507e0b64f For now, docker stats appears to be libcontainer only	10 éve
docker-stop.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-tag.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-top.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker-unpause.1.md	0ce42dcc96 Fixes #10457-Pause-and-unpause-accept-multi-containers	10 éve
docker-version.1.md	b07f193822 Update cli.md and man pages to match current cli	11 éve
docker-wait.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 éve
docker.1.md	fcb975cfd1 Fix a small spelling error in the dm.blkdiscard docs	10 éve
md2man-all.sh	3f136dc0e0 Use pure go markdown processor to generate man files	11 éve

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.

README.md

Docker Documentation

Generating man pages from the Markdown files

Building the md2man image

Utilizing the image