kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity
moby--moby/man
History
Sebastiaan van Stijn f646c041b8
Merge pull request #23282 from yongtang/06052016-docs-typo 
Fix a couple of typos in docker attach docs.
(cherry picked from commit cfcb470aad)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-06 20:37:24 +02:00
..
config-json.5.md docs: add $ before HOME 2016-03-12 14:11:01 +01:00
docker-attach.1.md Merge pull request #23282 from yongtang/06052016-docs-typo 2016-06-06 20:37:24 +02:00
docker-build.1.md docs for labels on build, networks and volumes 2016-03-31 18:35:01 -04:00
docker-commit.1.md
docker-cp.1.md Merge pull request #22900 from AkihiroSuda/fix22020 2016-05-25 21:33:55 +02:00
docker-create.1.md Add explicit flags for volume cp/no-cp 2016-03-21 20:38:44 -04:00
docker-daemon.8.md Fixes #21701 devicemapper docs 2016-04-13 17:20:27 +02:00
docker-diff.1.md
docker-events.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-exec.1.md Fix docs 2016-02-17 11:55:56 +08:00
docker-export.1.md
docker-history.1.md
docker-images.1.md Correct old virtual size 2016-02-02 12:28:33 +00:00
docker-import.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-info.1.md Add CgroupDriver to docker info 2016-03-02 20:07:06 +08:00
docker-inspect.1.md Merge pull request #23193 from allencloud/fix-typos 2016-06-06 20:35:13 +02:00
docker-kill.1.md
docker-load.1.md add docs for docker load --quiet 2016-03-25 13:43:07 -04:00
docker-login.1.md Remove email address field from login 2016-02-29 17:53:27 -08:00
docker-logout.1.md Remove some references to "register" through login 2016-03-01 17:33:23 +01:00
docker-logs.1.md Fix some typos in comments and strings 2016-02-22 20:27:15 +01:00
docker-network-connect.1.md Improve wording about re-assigning IP addresses 2016-01-27 17:11:12 +00:00
docker-network-create.1.md docs for labels on build, networks and volumes 2016-03-31 18:35:01 -04:00
docker-network-disconnect.1.md
docker-network-inspect.1.md Display internal flag on network inspect 2016-02-04 15:28:37 +08:00
docker-network-ls.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-network-rm.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-pause.1.md
docker-port.1.md
docker-ps.1.md Add mounts to docker ps. 2016-02-23 12:10:24 -05:00
docker-pull.1.md Mention "docker login" in push/pull documentation 2016-03-31 18:35:03 -04:00
docker-push.1.md Mention "docker login" in push/pull documentation 2016-03-31 18:35:03 -04:00
docker-rename.1.md
docker-restart.1.md
docker-rm.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-rmi.1.md
docker-run.1.md Merge pull request #23193 from allencloud/fix-typos 2016-06-06 20:35:13 +02:00
docker-save.1.md Update 'save' command help 2016-03-22 08:16:52 +01:00
docker-search.1.md
docker-start.1.md
docker-stats.1.md Change container name to id as actual results 2016-01-29 13:54:28 +08:00
docker-stop.1.md
docker-tag.1.md
docker-top.1.md
docker-unpause.1.md
docker-update.1.md Update RestartPolicy of container 2016-02-20 17:06:32 +08:00
docker-version.1.md
docker-volume-create.1.md docs for labels on build, networks and volumes 2016-03-31 18:35:01 -04:00
docker-volume-inspect.1.md
docker-volume-ls.1.md
docker-volume-rm.1.md
docker-volume.1.md Merge branch 'master' of github.com:docker/docker into volumeMan 2016-03-10 09:39:16 -05:00
docker-wait.1.md
docker.1.md When using systemd, pass expected cgroupsPath and cli options to runc. 2016-03-31 18:35:03 -04:00
Dockerfile
Dockerfile.5.md
md2man-all.sh
README.md

README.md

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