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
Jessica Frazelle 69cf03700f
pids limit support 
update bash commpletion for pids limit

update check config for kernel

add docs for pids limit

add pids stats

add stats to docker client

Signed-off-by: Jessica Frazelle <acidburn@docker.com>
2016-03-08 07:55:01 -08: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 Fix man and commandline docs 2015-10-04 21:22:27 +02:00
docker-cp.1.md Adds clarification to behavior of missing directories. 2016-03-03 23:41:13 +00:00
docker-create.1.md pids limit support 2016-03-08 07:55:01 -08:00
docker-daemon.8.md daemon/logger: Add logging driver for Google Cloud Logging 2016-03-01 08:06:10 -08: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 various man page typos 2015-10-13 11:52:14 -04:00
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 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 Adding --format= flag 2016-02-06 09:39:20 -06:00
docker-kill.1.md Fix man pages 2015-11-10 09:33:55 +08:00
docker-load.1.md Correct old virtual size 2016-02-02 12:28:33 +00: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 Add docs for --ipv6 option, also add --internal as appropriate 2016-02-12 01:42:15 +00: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 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 Correct old virtual size 2016-02-02 12:28:33 +00:00
docker-push.1.md Modify man pages for image-naming 2015-07-13 15:49:41 -04:00
docker-rename.1.md various man page typos 2015-10-13 11:52:14 -04:00
docker-restart.1.md Fix man pages 2015-11-10 09:33:55 +08:00
docker-rm.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08: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 pids limit support 2016-03-08 07:55:01 -08: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 Fix man pages 2015-11-10 09:33:55 +08:00
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 Update RestartPolicy of container 2016-02-20 17:06:32 +08:00
docker-version.1.md add --format flag to docker version 2015-07-13 19:10:56 -04:00
docker-volume-create.1.md Support mount opts for local volume driver 2016-03-03 10:32:25 -05:00
docker-volume-inspect.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-volume-ls.1.md Fix man pages 2015-11-10 09:33:55 +08:00
docker-volume-rm.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-wait.1.md
docker.1.md Remove some references to "register" through login 2016-03-01 17:33:23 +01:00
Dockerfile Bump go-md2man to 1.0.3 2015-07-21 10:42:02 -04:00
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 updates to readme documents for manual page 2015-09-15 12:08:02 -05:00

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