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
Adrien Folie 5ba11e6890 update CLI & api docs
Docker-DCO-1.1-Signed-off-by: Adrien Folie <folie.adrien@gmail.com> (github: folieadrien)
2014-07-11 23:26:08 +00:00
..
docker-attach.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-build.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-commit.1.md removing an extraneous space 2014-07-09 14:54:49 +10:00
docker-cp.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-diff.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-events.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-export.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-history.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-images.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-import.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-info.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-inspect.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-kill.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-load.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-login.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-logs.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-pause.1.md Update cli.md and man pages to match current cli 2014-07-03 10:22:20 +10:00
docker-port.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-ps.1.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10:00
docker-pull.1.md missed these merge conflicts when manually rebasing too many files 2014-07-03 11:07:42 +10:00
docker-push.1.md missed these merge conflicts when manually rebasing too many files 2014-07-03 11:07:42 +10:00
docker-restart.1.md missed these merge conflicts when manually rebasing too many files 2014-07-03 11:07:42 +10:00
docker-rm.1.md update CLI & api docs 2014-07-11 23:26:08 +00:00
docker-rmi.1.md missed these merge conflicts when manually rebasing too many files 2014-07-03 11:07:42 +10:00
docker-run.1.md Fix typos 2014-07-09 23:14:06 -05:00
docker-save.1.md missed these merge conflicts when manually rebasing too many files 2014-07-03 11:07:42 +10:00
docker-search.1.md missed these merge conflicts when manually rebasing too many files 2014-07-03 11:07:42 +10:00
docker-start.1.md missed these merge conflicts when manually rebasing too many files 2014-07-03 11:07:42 +10:00
docker-stop.1.md missed these merge conflicts when manually rebasing too many files 2014-07-03 11:07:42 +10:00
docker-tag.1.md Fix typos 2014-07-09 23:14:06 -05:00
docker-top.1.md missed these merge conflicts when manually rebasing too many files 2014-07-03 11:07:42 +10:00
docker-unpause.1.md Update cli.md and man pages to match current cli 2014-07-03 10:22:20 +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 missed these merge conflicts when manually rebasing too many files 2014-07-03 11:07:42 +10:00
docker.1.md Error if Docker daemon starts with BTRFS graph driver and SELinux enabled 2014-07-03 08:11:18 -04:00
Dockerfile move the man pages to the docs/ dir 2014-06-24 13:07:42 +10:00
Dockerfile.5.md Fix typos 2014-07-09 23:14:06 -05:00
md2man-all.sh Fixed manpage generation script and README 2014-06-26 15:51:26 -04:00
README.md I'm going to wish I didn't do this 2014-07-03 10:31:56 +10: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, Docker will create a Fedora based container and isolate the Pandoc installation. This is a seamless process, saving you from dealing with Pandoc and dependencies on your own computer.

Building the Fedora / Pandoc image

There is a Dockerfile provided in the docker/docs/man directory.

Using this Dockerfile, create a Docker image tagged fedora/pandoc:

docker build  -t fedora/pandoc .

Utilizing the Fedora / Pandoc image

Once the image is built, run a container using the image with volumes:

docker run -v /<path-to-git-dir>/docker/docs/man:/pandoc:rw \
-w /pandoc -i fedora/pandoc /pandoc/md2man-all.sh

The Pandoc 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/).