History

Brian Goff eba678647b Add explicit flags for volume cp/no-cp This allows a user to specify explicitly to enable automatic copying of data from the container path to the volume path. This does not change the default behavior of automatically copying, but does allow a user to disable it at runtime. Signed-off-by: Brian Goff <cpuguy83@gmail.com>		2017-06-02 00:07:32 +00:00
..
Dockerfile	Bump go-md2man to 1.0.3	2017-06-02 00:07:02 +00:00
Dockerfile.5.md	docs: userguide: labels-custom-metadsata.md: update syntax for emtpy value labels	2017-06-02 00:07:21 +00:00
README.md	updates to readme documents for manual page	2017-06-02 00:07:09 +00:00
config-json.5.md	docs: add $ before HOME	2017-06-02 00:07:31 +00:00
docker-attach.1.md	Fix mention of at sign in docs	2017-06-02 00:07:28 +00:00
docker-build.1.md	Fix docs for memory-swap	2017-06-02 00:07:21 +00:00
docker-commit.1.md	Fix man and commandline docs	2017-06-02 00:07:11 +00:00
docker-cp.1.md	Adds clarification to behavior of missing directories.	2017-06-02 00:07:31 +00:00
docker-create.1.md	Add explicit flags for volume cp/no-cp	2017-06-02 00:07:32 +00:00
docker-daemon.8.md	Move ZFS options to correct place in man page	2017-06-02 00:07:32 +00:00
docker-diff.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-events.1.md	Fix some flaws in man.	2017-06-02 00:07:30 +00:00
docker-exec.1.md	Fix docs	2017-06-02 00:07:29 +00:00
docker-export.1.md	various man page typos	2017-06-02 00:07:12 +00:00
docker-history.1.md	remove =false from options that default to false in the docs	2017-06-02 00:07:21 +00:00
docker-images.1.md	Correct old virtual size	2017-06-02 00:07:27 +00:00
docker-import.1.md	Fix some flaws in man.	2017-06-02 00:07:30 +00:00
docker-info.1.md	Add CgroupDriver to docker info	2017-06-02 00:07:31 +00:00
docker-inspect.1.md	Adding --format= flag	2017-06-02 00:07:28 +00:00
docker-kill.1.md	Fix man pages	2017-06-02 00:07:16 +00:00
docker-load.1.md	Update 'save' command help	2017-06-02 00:07:32 +00:00
docker-login.1.md	Remove email address field from login	2017-06-02 00:07:30 +00:00
docker-logout.1.md	Remove some references to "register" through login	2017-06-02 00:07:30 +00:00
docker-logs.1.md	Fix some typos in comments and strings	2017-06-02 00:07:29 +00:00
docker-network-connect.1.md	Improve wording about re-assigning IP addresses	2017-06-02 00:07:27 +00:00
docker-network-create.1.md	Fix typo	2017-06-02 00:07:32 +00:00
docker-network-disconnect.1.md	Forced endpoint cleanup	2017-06-02 00:07:23 +00:00
docker-network-inspect.1.md	Display `internal` flag on `network inspect`	2017-06-02 00:07:28 +00:00
docker-network-ls.1.md	Fix some flaws in man.	2017-06-02 00:07:30 +00:00
docker-network-rm.1.md	Fix some flaws in man.	2017-06-02 00:07:30 +00:00
docker-pause.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-port.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-ps.1.md	Add mounts to docker ps.	2017-06-02 00:07:30 +00:00
docker-pull.1.md	Update Docker pull examples	2017-06-02 00:07:32 +00:00
docker-push.1.md	Modify man pages for image-naming	2017-06-02 00:07:01 +00:00
docker-rename.1.md	various man page typos	2017-06-02 00:07:12 +00:00
docker-restart.1.md	Fix man pages	2017-06-02 00:07:16 +00:00
docker-rm.1.md	Fix some flaws in man.	2017-06-02 00:07:30 +00:00
docker-rmi.1.md	remove =false from options that default to false in the docs	2017-06-02 00:07:21 +00:00
docker-run.1.md	Add explicit flags for volume cp/no-cp	2017-06-02 00:07:32 +00:00
docker-save.1.md	Update 'save' command help	2017-06-02 00:07:32 +00:00
docker-search.1.md	remove =false from options that default to false in the docs	2017-06-02 00:07:21 +00:00
docker-start.1.md	Implement configurable detach key	2017-06-02 00:07:22 +00:00
docker-stats.1.md	Change container name to id as actual results	2017-06-02 00:07:27 +00:00
docker-stop.1.md	Fix man pages	2017-06-02 00:07:16 +00:00
docker-tag.1.md	Deprecate -f flag from docker tag	2017-06-02 00:07:18 +00:00
docker-top.1.md	Improvement of docker top Man Page	2017-06-02 00:07:18 +00:00
docker-unpause.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-update.1.md	Update RestartPolicy of container	2017-06-02 00:07:29 +00:00
docker-version.1.md	add --format flag to `docker version`	2017-06-02 00:07:01 +00:00
docker-volume-create.1.md	Support mount opts for `local` volume driver	2017-06-02 00:07:31 +00:00
docker-volume-inspect.1.md	update docker volume man pages	2017-06-02 00:07:08 +00:00
docker-volume-ls.1.md	Fix man pages	2017-06-02 00:07:16 +00:00
docker-volume-rm.1.md	update docker volume man pages	2017-06-02 00:07:08 +00:00
docker-volume.1.md	Add a parent man page for docker volumes command	2017-06-02 00:07:31 +00:00
docker-wait.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker.1.md	Remove some references to "register" through login	2017-06-02 00:07:30 +00:00
md2man-all.sh	Moving man pages out of docs	2017-06-02 00:06:57 +00:00

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