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 5099255d87 Merge pull request #16722 from sallyom/man-docker-build-fix
add clarity in man/docker-build
2015-10-09 20:53:28 +02:00
..
docker-attach.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-build.1.md Merge pull request #16722 from sallyom/man-docker-build-fix 2015-10-09 20:53:28 +02:00
docker-commit.1.md Fix man and commandline docs 2015-10-04 21:22:27 +02:00
docker-cp.1.md typo 2015-09-15 11:58:20 +10:00
docker-create.1.md Add support for memory reservation 2015-09-23 14:02:45 +08:00
docker-daemon.8.md Merge pull request #16807 from jfrazelle/rename-flag 2015-10-07 10:40:32 -07:00
docker-diff.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-events.1.md Sync with remote API 2015-10-09 13:53:51 +02:00
docker-exec.1.md Updated test to check for exec --privileged side-effects 2015-08-13 16:37:20 +10:00
docker-export.1.md Unify docker commands' usage in man and help 2015-07-02 10:33:26 +08:00
docker-history.1.md add -H to SYNOPSIS man-history 2015-08-19 09:35:52 -04:00
docker-images.1.md Fix #8048 : make docker images repository:tag work 2015-08-13 08:50:09 +02:00
docker-import.1.md adding message option to the import subcommand 2015-08-25 02:55:04 +00:00
docker-info.1.md add docker server version to /info 2015-09-21 21:15:32 +08:00
docker-inspect.1.md Add support for DNS options 2015-09-16 14:06:45 -07:00
docker-kill.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-load.1.md Carry man page for 14637 2015-07-24 13:39:29 -07: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 Add log reading to the journald log driver 2015-09-11 16:50:03 -04:00
docker-pause.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-port.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-ps.1.md Fix man and commandline docs 2015-10-04 21:22:27 +02:00
docker-pull.1.md correct man docker-pull 2015-09-04 16:34:40 -04:00
docker-push.1.md Modify man pages for image-naming 2015-07-13 15:49:41 -04:00
docker-rename.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-restart.1.md docker restarts running OR stopped containers, docs edit rm "running" 2015-09-20 09:16:27 -04:00
docker-rm.1.md Fix docker-rm man page formatting 2015-07-26 04:18:48 +02:00
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 Merge pull request #16287 from mikebrow/16055-man-update-for-docker-run-with-host-volumes 2015-10-09 09:24:11 -07:00
docker-save.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-search.1.md typo man/search 2015-10-02 11:24:31 -04:00
docker-start.1.md Fix man and commandline docs 2015-10-04 21:22:27 +02:00
docker-stats.1.md Docker stats: display Block IO stats 2015-07-31 21:26:32 +08:00
docker-stop.1.md Fix man and commandline docs 2015-10-04 21:22:27 +02:00
docker-tag.1.md man docker-tag minor fixup 2015-09-04 10:10:03 -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 Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-version.1.md add --format flag to docker version 2015-07-13 19:10:56 -04:00
docker-volume-create.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-volume-inspect.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-volume-ls.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-volume-rm.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-wait.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker.1.md Fix man and commandline docs 2015-10-04 21:22:27 +02:00
Dockerfile Bump go-md2man to 1.0.3 2015-07-21 10:42:02 -04:00
Dockerfile.5.md incorporate doc review comments 2015-09-16 03:31:15 -07:00
md2man-all.sh Moving man pages out of docs 2015-06-10 13:43:35 -07:00
README.md updates to readme documents for manual page 2015-09-15 12:08:02 -05: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 /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/).