History

allencloud eb0a4426e2 better command `docker network create -h` output Signed-off-by: allencloud <allen.sun@daocloud.io>		2017-06-02 00:07:51 +00:00
..
Dockerfile	update go-md2man to v1.0.5	2017-06-02 00:07:47 +00:00
Dockerfile.5.md	Clarify warning against using build-time variables for secrets	2017-06-02 00:07:49 +00:00
README.md	updates to readme documents for manual page	2017-06-02 00:07:09 +00:00
docker-attach.1.md	Fix a couple of typos in the docs of `docker attach`	2017-06-02 00:07:42 +00:00
docker-build.1.md	Document valid chars in image name and tag	2017-06-02 00:07:39 +00:00
docker-commit.1.md	Document valid chars in image name and tag	2017-06-02 00:07:39 +00:00
docker-config-json.5.md	man: mv config-json.5 to docker-config-json.5	2017-06-02 00:07:42 +00:00
docker-cp.1.md	update docs/reference/commandline/cp.md	2017-06-02 00:07:40 +00:00
docker-create.1.md	Rename `--net` to `--network`	2017-06-02 00:07:50 +00:00
docker-diff.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-events.1.md	attach: replace interface with simple type	2017-06-02 00:07:41 +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	Add before and since filter to images	2017-06-02 00:07:40 +00:00
docker-import.1.md	Fix some flaws in man.	2017-06-02 00:07:30 +00:00
docker-info.1.md	Update docker info output example	2017-06-02 00:07:44 +00:00
docker-inspect.1.md	fix typos	2017-06-02 00:07:41 +00:00
docker-kill.1.md	Fix man pages	2017-06-02 00:07:16 +00:00
docker-load.1.md	Update docker-load documentation	2017-06-02 00:07:42 +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	Replace U+2018 and U+2019 with U+0027 in manpages	2017-06-02 00:07:39 +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	better command `docker network create -h` output	2017-06-02 00:07:51 +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	Add "driver" filter for network ls	2017-06-02 00:07:37 +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 support for filtering by network ID	2017-06-02 00:07:42 +00:00
docker-pull.1.md	Mention "docker login" in push/pull documentation	2017-06-02 00:07:34 +00:00
docker-push.1.md	Document valid chars in image name and tag	2017-06-02 00:07:39 +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	Rename `--net` to `--network`	2017-06-02 00:07:50 +00:00
docker-save.1.md	Update 'save' command help	2017-06-02 00:07:32 +00:00
docker-search.1.md	Add `--limit` option to `docker search`	2017-06-02 00:07:41 +00:00
docker-start.1.md	Implement configurable detach key	2017-06-02 00:07:22 +00:00
docker-stats.1.md	Change HumanSize to BytesSize for memory output in `docker stats`.	2017-06-02 00:07:35 +00:00
docker-stop.1.md	Fix man pages	2017-06-02 00:07:16 +00:00
docker-tag.1.md	Document valid chars in image name and tag	2017-06-02 00:07:39 +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	Soften limitation of update kernel memory	2017-06-02 00:07:49 +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	docs for labels on build, networks and volumes	2017-06-02 00:07:33 +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	Add man change for volume filter	2017-06-02 00:07:34 +00:00
docker-volume-rm.1.md	update docker volume man pages	2017-06-02 00:07:08 +00:00
docker-volume.1.md	make cmd short short consistency and change docs	2017-06-02 00:07:47 +00:00
docker-wait.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker.1.md	Update the `docker daemon` to `dockerd` for document	2017-06-02 00:07:37 +00:00
dockerd.8.md	man: add missing --add-runtime	2017-06-02 00:07:48 +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/).