Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/man
History
Boaz Shuster fbb25d42f0 Change the quiet flag behavior in the build command 
Right now, the quiet (-q, --quiet) flag ignores the output
generated from within the container.

However, it ought to be quiet in a way that all kind
of diagnostic output should be ignored, unless the build
process fails.

This patch makes the quiet flag behave in the following way:
 1. If the build process succeeds, stdout contains the image ID
    and stderr is empty.
 2. If the build process fails, stdout is empty and stderr
    has the error message and the diagnostic output of that process.

If the quiet flag is not set, then everything goes to stdout
and error messages, if there are any, go to stderr.

Signed-off-by: Boaz Shuster <ripcurld.github@gmail.com>
 		2017-06-02 00:07:21 +00:00
..
Dockerfile Bump go-md2man to 1.0.3 2017-06-02 00:07:02 +00:00
Dockerfile.5.md docs: userguide: labels-custom-metadsata.md: update syntax for emtpy value labels 2017-06-02 00:07:21 +00:00
README.md updates to readme documents for manual page 2017-06-02 00:07:09 +00:00
docker-attach.1.md First pass at consolidating 2017-06-02 00:07:15 +00:00
docker-build.1.md Change the quiet flag behavior in the build command 2017-06-02 00:07:21 +00:00
docker-commit.1.md Fix man and commandline docs 2017-06-02 00:07:11 +00:00
docker-cp.1.md Add '-L' option for `cp` 2017-06-02 00:07:18 +00:00
docker-create.1.md Add capability to specify mount propagation per volume 2017-06-02 00:07:20 +00:00
docker-daemon.8.md Change authz plugin argument name 2017-06-02 00:07:20 +00:00
docker-diff.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-events.1.md Fix typos found across repository 2017-06-02 00:07:20 +00:00
docker-exec.1.md Updated test to check for `exec --privileged` side-effects 2017-06-02 00:07:05 +00:00
docker-export.1.md various man page typos 2017-06-02 00:07:12 +00:00
docker-history.1.md add -H to SYNOPSIS man-history 2017-06-02 00:07:06 +00:00
docker-images.1.md Fix #8048 : make `docker images repository:tag` work 2017-06-02 00:07:05 +00:00
docker-import.1.md various man page typos 2017-06-02 00:07:12 +00:00
docker-info.1.md Add pkg/parsers/architecture and pkg/platform 2017-06-02 00:07:17 +00:00
docker-inspect.1.md Add capability to specify mount propagation per volume 2017-06-02 00:07:20 +00:00
docker-kill.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-load.1.md Carry man page for 14637 2017-06-02 00:07:03 +00:00
docker-login.1.md docker-login man/doc add security info 2017-06-02 00:07:17 +00:00
docker-logout.1.md Unify docker commands' usage in man and help 2017-06-02 00:06:59 +00:00
docker-logs.1.md modifying docker --since and --until to support nanoseconds and time zones 2017-06-02 00:07:18 +00:00
docker-network-connect.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-network-create.1.md newtork -> network (minor spelling correction) 2017-06-02 00:07:19 +00:00
docker-network-disconnect.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-network-inspect.1.md Add format flag to network inspect 2017-06-02 00:07:19 +00:00
docker-network-ls.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-network-rm.1.md Enhance `docker network rm` to delete multi net 2017-06-02 00:07:18 +00:00
docker-pause.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-port.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-ps.1.md Fix typos found across repository 2017-06-02 00:07:20 +00:00
docker-pull.1.md correct man docker-pull 2017-06-02 00:07:08 +00:00
docker-push.1.md Modify man pages for image-naming 2017-06-02 00:07:01 +00:00
docker-rename.1.md various man page typos 2017-06-02 00:07:12 +00:00
docker-restart.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-rm.1.md various man page typos 2017-06-02 00:07:12 +00:00
docker-rmi.1.md Robert P.J. Day found this problems in man pages 2017-06-02 00:07:01 +00:00
docker-run.1.md Add capability to specify mount propagation per volume 2017-06-02 00:07:20 +00:00
docker-save.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-search.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-start.1.md Fix man and commandline docs 2017-06-02 00:07:11 +00:00
docker-stats.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-stop.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-tag.1.md Deprecate -f flag from docker tag 2017-06-02 00:07:18 +00:00
docker-top.1.md Improvement of docker top Man Page 2017-06-02 00:07:18 +00:00
docker-unpause.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-version.1.md add --format flag to `docker version` 2017-06-02 00:07:01 +00:00
docker-volume-create.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-volume-inspect.1.md update docker volume man pages 2017-06-02 00:07:08 +00:00
docker-volume-ls.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-volume-rm.1.md update docker volume man pages 2017-06-02 00:07:08 +00:00
docker-wait.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker.1.md Fix man pages 2017-06-02 00:07:16 +00:00
md2man-all.sh Moving man pages out of docs 2017-06-02 00:06:57 +00: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/).