moby/docs/man
Jessie Frazelle 0d3da36a5f Merge pull request #11479 from falmp/patch-1
Fixed --read-only description indentation
2015-03-19 16:22:08 -07:00
..
docker-attach.1.md Docker attach documentation didn't make sense to me 2015-02-03 11:53:14 +10:00
docker-build.1.md Allow setting resource constrains for build 2015-03-18 20:57:13 -04:00
docker-commit.1.md Updating with Sven's comments and other tweaks 2015-03-16 21:49:33 -07:00
docker-cp.1.md Clarify behavior of docker cp 2015-03-16 12:44:28 -07:00
docker-create.1.md Adding documentation for '--cgroup-parent' option. 2015-03-19 02:34:15 +00:00
docker-diff.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-events.1.md Update events format in man page 2015-01-29 15:18:25 -08:00
docker-exec.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-export.1.md Modified docker export to allow an --output flag 2015-03-17 00:20:19 -07:00
docker-history.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-images.1.md Add ability to refer to image by name + digest 2015-03-17 10:10:42 +00:00
docker-import.1.md Updating with Sven's comments and other tweaks 2015-03-16 21:49:33 -07:00
docker-info.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-inspect.1.md Add labels documentation 2015-03-13 10:02:04 -07:00
docker-kill.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-load.1.md docs: add See Also for description of export/import and save/load 2015-03-04 20:21:38 -05:00
docker-login.1.md docs: add See Also for description of login/logout and start/stop 2015-03-01 01:36:00 -05:00
docker-logout.1.md docs: add See Also for description of login/logout and start/stop 2015-03-01 01:36:00 -05:00
docker-logs.1.md Fail docker logs on all logging drivers apart from 'json-file' 2015-03-13 15:02:09 -07:00
docker-pause.1.md Merge pull request #10468 from noironetworks/10457-Pause-and-unpause-accept-multi-containers 2015-02-19 15:16:05 -08:00
docker-port.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-ps.1.md Add labels documentation 2015-03-13 10:02:04 -07:00
docker-pull.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-push.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-rename.1.md rename a existing container 2015-01-13 03:27:17 +00:00
docker-restart.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-rm.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-rmi.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-run.1.md Merge pull request #11479 from falmp/patch-1 2015-03-19 16:22:08 -07:00
docker-save.1.md docs: add See Also for description of export/import and save/load 2015-03-04 20:21:38 -05:00
docker-search.1.md Merge pull request #9840 from nhsiehgit/searchapidocs 2015-01-15 17:40:04 -05:00
docker-start.1.md Fix docker start help message 2015-03-07 20:45:46 +08:00
docker-stats.1.md Implements stats for lxc driver 2015-02-23 10:16:52 +00:00
docker-stop.1.md docs: add See Also for description of login/logout and start/stop 2015-03-01 01:36:00 -05:00
docker-tag.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-top.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-unpause.1.md Merge pull request #10468 from noironetworks/10457-Pause-and-unpause-accept-multi-containers 2015-02-19 15:16:05 -08:00
docker-version.1.md Update cli.md and man pages to match current cli 2014-07-03 10:22:20 +10:00
docker-wait.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker.1.md Merge pull request #10568 from LK4D4/logging_drivers 2015-03-17 09:45:58 -07:00
Dockerfile Use pure go markdown processor to generate man files 2014-08-07 07:06:39 -04:00
Dockerfile.5.md Fixing it back 2015-03-17 10:07:09 -07:00
md2man-all.sh Use pure go markdown processor to generate man files 2014-08-07 07:06:39 -04:00
README.md Remove File List 2015-02-02 09:47:19 -02: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/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] (http://docs.docker.com/use/working_with_volumes/).