mirror of https://github.com/docker/docs.git synced 2026-04-12 06:19:22 +07:00

Files

Sebastiaan van Stijn 4118e0c9ee Improve flag help consistency, and update docs

This adds the `--live-restore` option to the documentation.

Also synched usage description in the documentation
with the actual description, and re-phrased some
flag descriptions to be a bit more consistent.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 64a8317a5a306dffd0ec080d9ec5b4ceb2479a01)
Signed-off-by: Tibor Vass <tibor@docker.com>

2016-07-25 23:15:24 -07:00

docker-attach.1.md

Fix a couple of typos in the docs of docker attach

2016-06-06 19:06:50 -07: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-config-json.5.md

man: mv config-json.5 to docker-config-json.5

2016-06-03 15:28:19 +02:00

docker-cp.1.md

update docs/reference/commandline/cp.md

2016-05-24 11:09:38 +00:00

docker-create.1.md

Improve flag help consistency, and update docs

2016-07-25 23:15:24 -07:00

docker-diff.1.md

…

docker-events.1.md

attach: replace interface with simple type

2016-06-03 16:40:43 -07:00

docker-exec.1.md

…

docker-export.1.md

…

docker-history.1.md

…

docker-images.1.md

Add before and since filter to images

2016-05-25 13:49:10 +02:00

docker-import.1.md

…

docker-info.1.md

Update docker info output example

2016-06-16 23:36:56 -07:00

docker-inspect.1.md

fix typos

2016-06-02 17:17:22 +08:00

docker-kill.1.md

…

docker-load.1.md

Update docker-load documentation

2016-06-08 17:40:37 +02:00

docker-login.1.md

…

docker-logout.1.md

…

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

…

docker-network-create.1.md

better command docker network create -h output

2016-07-25 23:15:24 -07:00

docker-network-disconnect.1.md

…

docker-network-inspect.1.md

…

docker-network-ls.1.md

…

docker-network-rm.1.md

…

docker-pause.1.md

…

docker-port.1.md

…

docker-ps.1.md

add support for filtering by network ID

2016-06-07 16:50:31 +02:00

docker-pull.1.md

…

docker-push.1.md

Document valid chars in image name and tag

2016-05-21 19:49:19 +01:00

docker-rename.1.md

…

docker-restart.1.md

…

docker-rm.1.md

…

docker-rmi.1.md

…

docker-run.1.md

Improve flag help consistency, and update docs

2016-07-25 23:15:24 -07:00

docker-save.1.md

…

docker-search.1.md

Add --limit option to docker search

2016-06-02 19:12:20 -07:00

docker-start.1.md

…

docker-stats.1.md

…

docker-stop.1.md

…

docker-tag.1.md

Document valid chars in image name and tag

2016-05-21 19:49:19 +01:00

docker-top.1.md

…

docker-unpause.1.md

…

docker-update.1.md

…

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

make cmd short short consistency and change docs

2016-06-30 17:11:29 -07:00

docker-wait.1.md

…

docker.1.md

…

dockerd.8.md

Improve flag help consistency, and update docs

2016-07-25 23:15:24 -07:00

Dockerfile

update go-md2man to v1.0.5

2016-06-30 16:47:47 -07:00

Dockerfile.5.md

Clarify warning against using build-time variables for secrets

2016-07-12 15:50:21 -07: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/).