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
Doug Davis f4a3e8bef0 Fix COPY/ADD quoted/json form
Minor tweak to the quoted/json form and made man page look like the Dockerfile
docs.  W/o the `,` people may think there should be a space delimited list.

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-06-08 16:40:20 -07:00
..
docker-attach.1.md Docker attach documentation didn't make sense to me 2015-02-03 11:53:14 +10:00
docker-build.1.md Document missing build flags. 2015-05-21 15:02:00 -07:00
docker-commit.1.md Remove some unsupported instructions in the docs. 2015-04-20 16:48:17 +08:00
docker-cp.1.md Clarify behavior of docker cp 2015-03-16 12:44:28 -07:00
docker-create.1.md Add a "Created" state for new containers that haven't been run yet 2015-05-30 07:48:46 -07:00
docker-diff.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-events.1.md Allow duration strings as --since/--until 2015-06-02 21:02:47 +00:00
docker-exec.1.md Revert "Add docker exec run a command in privileged mode" 2015-05-26 14:12:16 -07:00
docker-export.1.md Fix spelling mistakes in documentation 2015-05-31 11:53:23 -07:00
docker-history.1.md Add -H|--human flag to docker history 2015-04-16 08:38:18 -07:00
docker-images.1.md mention dockviz alternative 2015-05-25 09:43:25 -07:00
docker-import.1.md Remove some unsupported instructions in the docs. 2015-04-20 16:48:17 +08:00
docker-info.1.md docker info show logging driver info 2015-04-01 16:05:14 +08:00
docker-inspect.1.md Remove PortSpecs from Config 2015-05-29 22:38:09 +02:00
docker-kill.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-load.1.md Removing sudo from command line examples 2015-03-26 11:12:37 -07:00
docker-login.1.md Docker Registry Server > Docker Registry 2015-04-18 19:19:48 -07:00
docker-logout.1.md Docker Registry Server > Docker Registry 2015-04-18 19:19:48 -07:00
docker-logs.1.md Allow duration strings as --since/--until 2015-06-02 21:02:47 +00:00
docker-pause.1.md Merge pull request #10468 from noironetworks/10457-Pause-and-unpause-accept-multi-containers 2015-02-19 15:16:05 -08:00
docker-port.1.md Fix examples in "docker port" man page. 2015-06-08 10:40:24 -04:00
docker-ps.1.md Add a "Created" state for new containers that haven't been run yet 2015-05-30 07:48:46 -07:00
docker-pull.1.md Updating with man pages for distribution 2015-04-01 21:02:19 -07:00
docker-push.1.md Updating with man pages for distribution 2015-04-01 21:02:19 -07:00
docker-rename.1.md rename a existing container 2015-01-13 03:27:17 +00:00
docker-restart.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-rm.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-rmi.1.md Updating with man pages for distribution 2015-04-01 21:02:19 -07:00
docker-run.1.md Updating after the pr went through 2015-06-01 09:20:31 -07:00
docker-save.1.md Removing sudo from command line examples 2015-03-26 11:12:37 -07:00
docker-search.1.md Updating with man pages for distribution 2015-04-01 21:02:19 -07:00
docker-start.1.md Fix docker start help message 2015-03-07 20:45:46 +08:00
docker-stats.1.md Allow pulling stats once and disconnecting. 2015-05-04 10:49:13 -04:00
docker-stop.1.md docs: add See Also for description of login/logout and start/stop 2015-03-01 01:36:00 -05:00
docker-tag.1.md Updating with man pages for distribution 2015-04-01 21:02:19 -07:00
docker-top.1.md Removing sudo from command line examples 2015-03-26 11:12:37 -07:00
docker-unpause.1.md Merge pull request #10468 from noironetworks/10457-Pause-and-unpause-accept-multi-containers 2015-02-19 15:16:05 -08: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 Removing sudo from command line examples 2015-03-26 11:12:37 -07:00
docker.1.md Add docs for ip-forward 2015-06-03 16:37:40 +08:00
Dockerfile Use pure go markdown processor to generate man files 2014-08-07 07:06:39 -04:00
Dockerfile.5.md Fix COPY/ADD quoted/json form 2015-06-08 16:40:20 -07:00
md2man-all.sh Use pure go markdown processor to generate man files 2014-08-07 07:06:39 -04:00
README.md HTTPS URLs for docs top-level & man pages 2015-04-11 13:43:26 -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.

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