History

Sally O'Malley bf09f5d572 Modify man pages for image-naming This PR adds recommendations in man pages to use only [a-z0-9-_.] when naming and tagging images. The purpose of this is to add consistency and to make image naming caps rules seem less arbitrary. This PR addresses confusion with: 1. BaseImage:Tagged (not allowed) 2. baseimage:Tagged (allowed) 3. baseimage/tagged:V1 (allowed) 4. baseimage/Tagged:V1 (not allowed) Signed-off-by: Sally O'Malley <somalley@redhat.com>		2017-06-02 00:07:01 +00:00
..
Dockerfile	Update man page Dockerfile to use go-md2man v1.0.1 and go-lang 1.4	2017-06-02 00:06:58 +00:00
Dockerfile.5.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
README.md	man: convert `docker/docs/man` to `docker/man`	2017-06-02 00:06:59 +00:00
docker-attach.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-build.1.md	Modify man pages for image-naming	2017-06-02 00:07:01 +00:00
docker-commit.1.md	Modify man pages for image-naming	2017-06-02 00:07:01 +00:00
docker-cp.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-create.1.md	Docs: fix commandline doc create.md and run.md	2017-06-02 00:07:01 +00:00
docker-diff.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-events.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-exec.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-export.1.md	Unify docker commands' usage in man and help	2017-06-02 00:06:59 +00:00
docker-history.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-images.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-import.1.md	work on #11094 allow import from local file	2017-06-02 00:06:58 +00:00
docker-info.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-inspect.1.md	Flag Addition: --type flag added for docker inspect command	2017-06-02 00:06:59 +00:00
docker-kill.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-load.1.md	Unify docker commands' usage in man and help	2017-06-02 00:06:59 +00:00
docker-login.1.md	update reference to config file	2017-06-02 00:07:01 +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	Moving man pages out of docs	2017-06-02 00:06:57 +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	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-pull.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-push.1.md	Modify man pages for image-naming	2017-06-02 00:07:01 +00:00
docker-rename.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-restart.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-rm.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +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	Docs: fix commandline doc create.md and run.md	2017-06-02 00:07:01 +00:00
docker-save.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-search.1.md	Robert P.J. Day found this problems in man pages	2017-06-02 00:07:01 +00:00
docker-start.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-stats.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-stop.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker-tag.1.md	Modify man pages for image-naming	2017-06-02 00:07:01 +00:00
docker-top.1.md	Unify docker commands' usage in man and help	2017-06-02 00:06:59 +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-wait.1.md	Moving man pages out of docs	2017-06-02 00:06:57 +00:00
docker.1.md	Add support for DOCKER_CONFIG/--config to specific config file dir	2017-06-02 00:07:01 +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 docker/man directory.

Using this Dockerfile, create a Docker image tagged docker/md2man:

docker build -t docker/md2man .

Utilizing the image

Once the image is built, run a container using the image with volumes:

docker run -v /<path-to-git-dir>/docker/man:/docs:rw \
-w /docs -i docker/md2man /docs/md2man-all.sh

The md2man Docker container will process the Markdown files and generate the man pages inside the docker/man/man1 directory 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/).