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
Dan Walsh dc8259f0ac Add a parent man page for docker volumes command 
It is difficult to gather information about docker volumes command
without a parent man page.

This man page attempts to explain docker volumes and then references
the command man pages.

Signed-off-by: Dan Walsh <dwalsh@redhat.com>
2016-02-10 09:04:41 -05:00
..
config-json.5.md Fix typo in config-json man page 2016-02-05 09:52:01 -05:00
docker-attach.1.md Fix mention of at sign in docs 2016-02-05 16:47:57 -05:00
docker-build.1.md Fix docs for memory-swap 2015-12-30 09:23:35 +08:00
docker-commit.1.md
docker-cp.1.md
docker-create.1.md Merge pull request #19688 from crosbymichael/tmpfs-tar 2016-01-26 17:03:07 -08:00
docker-daemon.8.md Allow disabling of colored Docker logs via daemon flag. 2016-02-01 16:19:18 -05:00
docker-diff.1.md
docker-events.1.md Fix typos found across repository 2015-12-13 18:04:12 +02:00
docker-exec.1.md Implement configurable detach key 2016-01-03 23:03:39 +01:00
docker-export.1.md
docker-history.1.md remove =false from options that default to false in the docs 2015-12-23 07:11:35 -08:00
docker-images.1.md Correct old virtual size 2016-02-02 12:28:33 +00:00
docker-import.1.md
docker-info.1.md Added additional container information to "docker info". 2016-01-11 19:14:44 -05:00
docker-inspect.1.md Adding --format= flag 2016-02-06 09:39:20 -06:00
docker-kill.1.md
docker-load.1.md Correct old virtual size 2016-02-02 12:28:33 +00:00
docker-login.1.md
docker-logout.1.md
docker-logs.1.md remove =false from options that default to false in the docs 2015-12-23 07:11:35 -08: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: document options for default network driver 2016-01-28 11:49:07 +08:00
docker-network-disconnect.1.md Forced endpoint cleanup 2016-01-13 21:28:52 -08:00
docker-network-inspect.1.md Display internal flag on network inspect 2016-02-04 15:28:37 +08:00
docker-network-ls.1.md Add filter for network ls to hide predefined net 2015-12-23 13:26:40 +08:00
docker-network-rm.1.md
docker-pause.1.md
docker-port.1.md
docker-ps.1.md Added dead to docs for docker ps -f status=... 2016-01-21 16:44:33 -05:00
docker-pull.1.md Correct old virtual size 2016-02-02 12:28:33 +00:00
docker-push.1.md
docker-rename.1.md
docker-restart.1.md
docker-rm.1.md On container rm, don't remove named mountpoints 2016-01-25 15:51:28 -05:00
docker-rmi.1.md remove =false from options that default to false in the docs 2015-12-23 07:11:35 -08:00
docker-run.1.md Add note about legacy links 2016-02-02 18:06:09 +01:00
docker-save.1.md
docker-search.1.md remove =false from options that default to false in the docs 2015-12-23 07:11:35 -08:00
docker-start.1.md Implement configurable detach key 2016-01-03 23:03:39 +01:00
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 Deprecate -f flag from docker tag 2015-12-01 19:53:49 -08:00
docker-top.1.md Improvement of docker top Man Page 2015-12-02 18:54:52 +01:00
docker-unpause.1.md
docker-update.1.md Implemet docker update command 2015-12-28 19:19:26 +08:00
docker-version.1.md
docker-volume-create.1.md
docker-volume-inspect.1.md
docker-volume-ls.1.md
docker-volume-rm.1.md
docker-volume.1.md Add a parent man page for docker volumes command 2016-02-10 09:04:41 -05:00
docker-wait.1.md
docker.1.md man page fix: remove -e/--exec-drive=native related description 2016-01-07 14:21:01 -05:00
Dockerfile
Dockerfile.5.md docs: userguide: labels-custom-metadsata.md: update syntax for emtpy value labels 2015-12-19 09:04:29 +01:00
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/).