32eff909b4
The old examples no longer worked due to changes in the client and Docker Hub. This updates the "docker pull" documentation and adds more examples and explanation of the features. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> |
||
|---|---|---|
| .. | ||
| Dockerfile | ||
| Dockerfile.5.md | ||
| README.md | ||
| config-json.5.md | ||
| docker-attach.1.md | ||
| docker-build.1.md | ||
| docker-commit.1.md | ||
| docker-cp.1.md | ||
| docker-create.1.md | ||
| docker-daemon.8.md | ||
| docker-diff.1.md | ||
| docker-events.1.md | ||
| docker-exec.1.md | ||
| docker-export.1.md | ||
| docker-history.1.md | ||
| docker-images.1.md | ||
| docker-import.1.md | ||
| docker-info.1.md | ||
| docker-inspect.1.md | ||
| 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 | ||
| docker-network-create.1.md | ||
| docker-network-disconnect.1.md | ||
| 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 | ||
| docker-pull.1.md | ||
| docker-push.1.md | ||
| docker-rename.1.md | ||
| docker-restart.1.md | ||
| docker-rm.1.md | ||
| docker-rmi.1.md | ||
| docker-run.1.md | ||
| docker-save.1.md | ||
| docker-search.1.md | ||
| docker-start.1.md | ||
| docker-stats.1.md | ||
| docker-stop.1.md | ||
| docker-tag.1.md | ||
| docker-top.1.md | ||
| docker-unpause.1.md | ||
| docker-update.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-volume.1.md | ||
| docker-wait.1.md | ||
| docker.1.md | ||
| md2man-all.sh | ||
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/).