mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

History

Mary Anthony d5364c7114 Updating network commands: adding man pages Adding Related information blocks Final first draft pass: ready for review Review comments Entering comments from the gang Updating connect to include paused Signed-off-by: Mary Anthony <mary@docker.com>		2015-10-27 08:29:07 -07:00
..
docker-attach.1.md	various man page typos	2015-10-13 11:52:14 -04:00
docker-build.1.md	Add ability to add multiple tags with docker build	2015-10-24 00:59:56 +08:00
docker-commit.1.md
docker-cp.1.md
docker-create.1.md	Add Splunk logging driver #16207	2015-10-23 13:37:53 -07:00
docker-daemon.8.md	Document updates for cluster-store-opt	2015-10-12 08:05:02 -07:00
docker-diff.1.md
docker-events.1.md
docker-exec.1.md
docker-export.1.md	various man page typos	2015-10-13 11:52:14 -04:00
docker-history.1.md
docker-images.1.md
docker-import.1.md	various man page typos	2015-10-13 11:52:14 -04:00
docker-info.1.md	use Server Version	2015-10-14 17:46:59 -07:00
docker-inspect.1.md	Merge pull request #15796 from azurezk/add-size-to-inspect	2015-10-13 23:16:10 +02:00
docker-kill.1.md
docker-load.1.md
docker-login.1.md
docker-logout.1.md
docker-logs.1.md
docker-network-connect.1.md	Updating network commands: adding man pages	2015-10-27 08:29:07 -07:00
docker-network-create.1.md	Updating network commands: adding man pages	2015-10-27 08:29:07 -07:00
docker-network-disconnect.1.md	Updating network commands: adding man pages	2015-10-27 08:29:07 -07:00
docker-network-inspect.1.md	Updating network commands: adding man pages	2015-10-27 08:29:07 -07:00
docker-network-ls.1.md	Updating network commands: adding man pages	2015-10-27 08:29:07 -07:00
docker-network-rm.1.md	Updating network commands: adding man pages	2015-10-27 08:29:07 -07:00
docker-pause.1.md
docker-port.1.md
docker-ps.1.md
docker-pull.1.md
docker-push.1.md
docker-rename.1.md	various man page typos	2015-10-13 11:52:14 -04:00
docker-restart.1.md
docker-rm.1.md	various man page typos	2015-10-13 11:52:14 -04:00
docker-rmi.1.md
docker-run.1.md	Add Splunk logging driver #16207	2015-10-23 13:37:53 -07:00
docker-save.1.md
docker-search.1.md
docker-start.1.md
docker-stats.1.md	various man page typos	2015-10-13 11:52:14 -04:00
docker-stop.1.md
docker-tag.1.md
docker-top.1.md
docker-unpause.1.md
docker-version.1.md
docker-volume-create.1.md
docker-volume-inspect.1.md
docker-volume-ls.1.md
docker-volume-rm.1.md
docker-wait.1.md
docker.1.md
Dockerfile
Dockerfile.5.md	updating docs for EXPOSE option on run command; fixes #16634	2015-10-13 10:43:27 -05:00
md2man-all.sh
README.md

README.md

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