1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
moby--moby/docs/man
Tim Smith 69a75c673c Add daemon flag to specify public registry mirrors
Adds support for a --registry-mirror=scheme://<host>[:port]
daemon flag. The flag may be present multiple times. If
provided, mirrors are prepended to the list of endpoints used
for image pull. Note that only mirrors of the public
index.docker.io registry are supported, and image/tag resolution
is still performed via the official index.

Docker-DCO-1.1-Signed-off-by: Tim Smith <timbot@google.com> (github: timbot)
2014-09-09 19:03:38 +00:00
..
docker-attach.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-build.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-commit.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-cp.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-diff.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-events.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-export.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-history.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-images.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-import.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-info.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-inspect.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-kill.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-load.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-login.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-logout.1.md user facing documentation changes in master atm 2014-07-23 12:40:10 +10:00
docker-logs.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-pause.1.md re-jig the info into all the places 2014-07-16 09:42:46 +10:00
docker-port.1.md List all ports when calling docker port container 2014-08-29 18:31:51 +10:00
docker-ps.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-pull.1.md add a little documentation for docker pull 2014-09-03 18:32:41 +03:00
docker-push.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-restart.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-rm.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-rmi.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-run.1.md add -p PORT as a valid format specification 2014-09-09 11:16:02 +10:00
docker-save.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-search.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-start.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-stop.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-tag.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-top.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker-unpause.1.md re-jig the info into all the places 2014-07-16 09:42:46 +10:00
docker-version.1.md Update cli.md and man pages to match current cli 2014-07-03 10:22:20 +10:00
docker-wait.1.md Revert "--help option and help command should print to stdout not stderr" 2014-08-27 18:59:13 +00:00
docker.1.md Add daemon flag to specify public registry mirrors 2014-09-09 19:03:38 +00:00
Dockerfile Use pure go markdown processor to generate man files 2014-08-07 07:06:39 -04:00
Dockerfile.5.md Dockerfile documentation typo and content fix 2014-09-03 19:28:01 +09:00
md2man-all.sh Use pure go markdown processor to generate man files 2014-08-07 07:06:39 -04:00
README.md Use pure go markdown processor to generate man files 2014-08-07 07:06:39 -04:00

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.

File List

docker.md
docker-attach.md
docker-build.md
docker-commit.md
docker-cp.md
docker-diff.md
docker-events.md
docker-export.md
docker-history.md
docker-images.md
docker-import.md
docker-info.md
docker-inspect.md
docker-kill.md
docker-load.md
docker-login.md
docker-logs.md
docker-port.md
docker-ps.md
docker-pull.md
docker-push.md
docker-restart.md
docker-rmi.md
docker-rm.md
docker-run.md
docker-save.md
docker-search.md
docker-start.md
docker-stop.md
docker-tag.md
docker-top.md
docker-wait.md
Dockerfile
md2man-all.sh

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] (http://docs.docker.com/use/working_with_volumes/).