mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

History

Qiang Huang 8799c4fc0f Implemet docker update command It's used for updating properties of one or more containers, we only support resource configs for now. It can be extended in the future. Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>		2015-12-28 19:19:26 +08:00
..
docker-attach.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-build.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-commit.1.md
docker-cp.1.md	Add '-L' option for `cp`	2015-11-21 00:36:56 +08:00
docker-create.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-daemon.8.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08: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	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08: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	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-import.1.md
docker-info.1.md
docker-inspect.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-kill.1.md
docker-load.1.md
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
docker-network-create.1.md	newtork -> network (minor spelling correction)	2015-12-01 15:26:36 -06:00
docker-network-disconnect.1.md
docker-network-inspect.1.md	Merge pull request #17481 from vdemeester/17446-network-inspect-format	2015-12-03 16:16:04 -05: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	Enhance `docker network rm` to delete multi net	2015-11-22 05:37:00 +08:00
docker-pause.1.md
docker-port.1.md
docker-ps.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-pull.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-push.1.md
docker-rename.1.md
docker-restart.1.md
docker-rm.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -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	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -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	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-stats.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -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-wait.1.md
docker.1.md
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/).