1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
moby--moby/man
Sebastiaan van Stijn 899f6f2a89 Merge pull request #14252 from sallyom/docs-use-lowercase
Modify man pages for image-naming
2015-07-14 18:34:36 +02:00
..
docker-attach.1.md
docker-build.1.md Modify man pages for image-naming 2015-07-13 15:49:41 -04:00
docker-commit.1.md Modify man pages for image-naming 2015-07-13 15:49:41 -04:00
docker-cp.1.md
docker-create.1.md Docs: fix commandline doc create.md and run.md 2015-07-14 09:26:59 +08:00
docker-diff.1.md
docker-events.1.md
docker-exec.1.md
docker-export.1.md Unify docker commands' usage in man and help 2015-07-02 10:33:26 +08:00
docker-history.1.md
docker-images.1.md
docker-import.1.md work on #11094 allow import from local file 2015-06-20 09:04:43 +02:00
docker-info.1.md
docker-inspect.1.md Flag Addition: --type flag added for docker inspect command 2015-07-01 12:14:01 -04:00
docker-kill.1.md
docker-load.1.md Unify docker commands' usage in man and help 2015-07-02 10:33:26 +08:00
docker-login.1.md update reference to config file 2015-07-10 18:55:47 +00:00
docker-logout.1.md Unify docker commands' usage in man and help 2015-07-02 10:33:26 +08:00
docker-logs.1.md
docker-pause.1.md
docker-port.1.md
docker-ps.1.md
docker-pull.1.md
docker-push.1.md Modify man pages for image-naming 2015-07-13 15:49:41 -04:00
docker-rename.1.md
docker-restart.1.md
docker-rm.1.md
docker-rmi.1.md Robert P.J. Day found this problems in man pages 2015-07-13 08:59:03 -04:00
docker-run.1.md Docs: fix commandline doc create.md and run.md 2015-07-14 09:26:59 +08:00
docker-save.1.md
docker-search.1.md Robert P.J. Day found this problems in man pages 2015-07-13 08:59:03 -04:00
docker-start.1.md
docker-stats.1.md
docker-stop.1.md
docker-tag.1.md Modify man pages for image-naming 2015-07-13 15:49:41 -04:00
docker-top.1.md Unify docker commands' usage in man and help 2015-07-02 10:33:26 +08:00
docker-unpause.1.md
docker-version.1.md add --format flag to docker version 2015-07-13 19:10:56 -04:00
docker-wait.1.md
docker.1.md Add support for DOCKER_CONFIG/--config to specific config file dir 2015-07-10 12:51:34 -07:00
Dockerfile
Dockerfile.5.md
md2man-all.sh
README.md man: convert docker/docs/man to docker/man 2015-06-24 23:31:12 +08: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.

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