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

History

Tibor Vass e35f5a481a Merge pull request #17316 from rmb938/ipam_conf_options Add IPAM Config Options to match libnetwork		2016-01-14 16:30:03 -05:00
..
config-json.5.md	Creating a man page for the configuration file	2016-01-03 13:23:18 -08:00
docker-attach.1.md	Implement configurable detach key	2016-01-03 23:03:39 +01:00
docker-build.1.md	Fix docs for memory-swap	2015-12-30 09:23:35 +08:00
docker-commit.1.md
docker-cp.1.md
docker-create.1.md	Network scoped alias support	2016-01-14 08:44:41 -08:00
docker-daemon.8.md	Merge pull request #19123 from shishir-a412ed/rootfs_size_configurable	2016-01-13 13:22:08 -08:00
docker-diff.1.md
docker-events.1.md
docker-exec.1.md	Implement configurable detach key	2016-01-03 23:03:39 +01:00
docker-export.1.md
docker-history.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-images.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-import.1.md
docker-info.1.md	Added additional container information to "docker info".	2016-01-11 19:14:44 -05:00
docker-inspect.1.md	Add network ID to container inspect	2016-01-14 22:33:41 +08:00
docker-kill.1.md
docker-load.1.md
docker-login.1.md
docker-logout.1.md
docker-logs.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-network-connect.1.md	Add missing documentation for static IP options	2016-01-13 14:53:14 -08:00
docker-network-create.1.md	Add IPAM Config Options to match libnetwork	2016-01-14 14:32:25 -05:00
docker-network-disconnect.1.md	Forced endpoint cleanup	2016-01-13 21:28:52 -08:00
docker-network-inspect.1.md
docker-network-ls.1.md
docker-network-rm.1.md
docker-pause.1.md
docker-port.1.md
docker-ps.1.md	Improvement for docker subcommand's help messages	2016-01-01 12:27:28 +08:00
docker-pull.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-push.1.md
docker-rename.1.md
docker-restart.1.md
docker-rm.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-rmi.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-run.1.md	Network scoped alias support	2016-01-14 08:44:41 -08:00
docker-save.1.md
docker-search.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-start.1.md	Implement configurable detach key	2016-01-03 23:03:39 +01:00
docker-stats.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-stop.1.md
docker-tag.1.md
docker-top.1.md
docker-unpause.1.md
docker-update.1.md	Implemet docker update command	2015-12-28 19:19:26 +08:00
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	man page fix: remove -e/--exec-drive=native related description	2016-01-07 14:21:01 -05:00
Dockerfile
Dockerfile.5.md
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/).