1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
moby--moby/man
Michael Crosby d705dab1b1 Add --live-restore flag
This flags enables full support of daemonless containers in docker.  It
ensures that docker does not stop containers on shutdown or restore and
properly reconnects to the container when restarted.

This is not the default because of backwards compat but should be the
desired outcome for people running containers in prod.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2016-06-13 19:16:26 -07:00
..
config-json.5.md docs: add $ before HOME 2016-03-12 14:11:01 +01:00
docker-attach.1.md Fix mention of at sign in docs 2016-02-05 16:47:57 -05:00
docker-build.1.md Document valid chars in image name and tag 2016-05-21 19:49:19 +01:00
docker-commit.1.md Document valid chars in image name and tag 2016-05-21 19:49:19 +01:00
docker-cp.1.md update docs/reference/commandline/cp.md 2016-05-24 11:09:38 +00:00
docker-create.1.md Merge pull request #22774 from Microsoft/jjh/client 2016-05-23 11:29:50 -07:00
docker-diff.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-events.1.md Replace U+2018 and U+2019 with U+0027 in manpages 2016-05-20 20:15:57 +02: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 Add before and since filter to images 2016-05-25 13:49:10 +02:00
docker-import.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-info.1.md Updated docker-info output and documentation 2016-04-29 16:45:43 +02:00
docker-inspect.1.md Remove unneeded references to execDriver 2016-03-21 13:06:08 -07:00
docker-kill.1.md Fix man pages 2015-11-10 09:33:55 +08:00
docker-load.1.md add docs for docker load --quiet 2016-03-24 18:57:44 +01: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 Replace U+2018 and U+2019 with U+0027 in manpages 2016-05-20 20:15:57 +02: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 Update the docker daemon to dockerd for document 2016-04-29 09:06:02 +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 "driver" filter for network ls 2016-04-29 16:22:26 +02:00
docker-network-rm.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-pause.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-port.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
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-28 17:22:41 -07:00
docker-push.1.md Document valid chars in image name and tag 2016-05-21 19:49:19 +01: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 Merge pull request #22774 from Microsoft/jjh/client 2016-05-23 11:29:50 -07:00
docker-save.1.md Update 'save' command help 2016-03-22 08:16:52 +01:00
docker-search.1.md Add a --filter option to docker search 2016-05-20 13:41:28 +02:00
docker-start.1.md Implement configurable detach key 2016-01-03 23:03:39 +01:00
docker-stats.1.md Change HumanSize to BytesSize for memory output in docker stats. 2016-04-08 20:01:50 +00:00
docker-stop.1.md Fix man pages 2015-11-10 09:33:55 +08:00
docker-tag.1.md Document valid chars in image name and tag 2016-05-21 19:49:19 +01:00
docker-top.1.md Improvement of docker top Man Page 2015-12-02 18:54:52 +01:00
docker-unpause.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
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 docs for labels on build, networks and volumes 2016-03-25 11:16:19 -07:00
docker-volume-inspect.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-volume-ls.1.md Add man change for volume filter 2016-03-28 03:11:27 +00:00
docker-volume-rm.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
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 Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker.1.md Update the docker daemon to dockerd for document 2016-04-29 09:06:02 +08:00
dockerd.8.md Add --live-restore flag 2016-06-13 19:16:26 -07: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 Moving man pages out of docs 2015-06-10 13:43:35 -07:00
README.md updates to readme documents for manual page 2015-09-15 12:08:02 -05: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 /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/).