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
Andrea Luzzardi 61f8001c23 Expose # of CPUs and memory available on docker info.
Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2014-10-24 15:56:37 -07: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-create.1.md Add info on --device flag permissions ':rwm' 2014-10-13 17:41:12 +10: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 Add the 2 image events found using git grep 'Job("log"' 2014-09-26 11:55:36 +10:00
docker-exec.1.md Adding exec remote API documentation along with minor code cleanup. 2014-09-30 18:26:58 +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 Expose # of CPUs and memory available on docker info. 2014-10-24 15:56:37 -07: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 Print a status message when pull command is executed 2014-10-01 22:55:29 +00: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 info on --device flag permissions ':rwm' 2014-10-13 17:41:12 +10:00
docker-save.1.md 'an file' -> 'a file' grammar fix 2014-09-19 08:12:33 +08: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 Adding exec remote API documentation along with minor code cleanup. 2014-09-30 18:26:58 +00:00
Dockerfile Use pure go markdown processor to generate man files 2014-08-07 07:06:39 -04:00
Dockerfile.5.md Add support for copy/add with multiple src files 2014-09-18 20:12:13 -07: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/).