Jessie Frazelle 0d3da36a5f Merge pull request #11479 from falmp/patch-1		10 anni fa
..
Dockerfile	3f136dc0e0 Use pure go markdown processor to generate man files	11 anni fa
Dockerfile.5.md	241579a34f Fixing it back	10 anni fa
README.md	aceb735dba Remove File List	10 anni fa
docker-attach.1.md	e58fdaae05 Docker attach documentation didn't make sense to me	10 anni fa
docker-build.1.md	e6ae89a45a Allow setting resource constrains for build	10 anni fa
docker-commit.1.md	6ddfe883dd Updating with Sven's comments and other tweaks	10 anni fa
docker-cp.1.md	9a78ed8f48 Clarify behavior of docker cp	10 anni fa
docker-create.1.md	f7dd1333b5 Adding documentation for '--cgroup-parent' option.	10 anni fa
docker-diff.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-events.1.md	f750f17451 Update events format in man page	10 anni fa
docker-exec.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-export.1.md	5ff122f797 Modified `docker export` to allow an --output flag	10 anni fa
docker-history.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-images.1.md	a2b0c9778f Add ability to refer to image by name + digest	10 anni fa
docker-import.1.md	6ddfe883dd Updating with Sven's comments and other tweaks	10 anni fa
docker-info.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-inspect.1.md	7d89e66dac Add labels documentation	10 anni fa
docker-kill.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-load.1.md	cbb149f52f docs: add See Also for description of export/import and save/load	10 anni fa
docker-login.1.md	41dc0e08d3 docs: add See Also for description of login/logout and start/stop	10 anni fa
docker-logout.1.md	41dc0e08d3 docs: add See Also for description of login/logout and start/stop	10 anni fa
docker-logs.1.md	bdf3a0295d Fail docker logs on all logging drivers apart from 'json-file'	10 anni fa
docker-pause.1.md	934535db9c Merge pull request #10468 from noironetworks/10457-Pause-and-unpause-accept-multi-containers	10 anni fa
docker-port.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-ps.1.md	7d89e66dac Add labels documentation	10 anni fa
docker-pull.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-push.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-rename.1.md	21a809d9ae rename a existing container	10 anni fa
docker-restart.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-rm.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-rmi.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-run.1.md	0d3da36a5f Merge pull request #11479 from falmp/patch-1	10 anni fa
docker-save.1.md	cbb149f52f docs: add See Also for description of export/import and save/load	10 anni fa
docker-search.1.md	25a8602cba Merge pull request #9840 from nhsiehgit/searchapidocs	10 anni fa
docker-start.1.md	3c37f88aff Fix docker start help message	10 anni fa
docker-stats.1.md	1a26ed09ee Implements stats for lxc driver	10 anni fa
docker-stop.1.md	41dc0e08d3 docs: add See Also for description of login/logout and start/stop	10 anni fa
docker-tag.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-top.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker-unpause.1.md	934535db9c Merge pull request #10468 from noironetworks/10457-Pause-and-unpause-accept-multi-containers	10 anni fa
docker-version.1.md	b07f193822 Update cli.md and man pages to match current cli	11 anni fa
docker-wait.1.md	a2b529ead2 --help option and help command should print to stdout not stderr	10 anni fa
docker.1.md	1ff5a91007 Merge pull request #10568 from LK4D4/logging_drivers	10 anni fa
md2man-all.sh	3f136dc0e0 Use pure go markdown processor to generate man files	11 anni fa

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.

README.md

Docker Documentation

Generating man pages from the Markdown files

Building the md2man image

Utilizing the image