Skip to content

Commit

Permalink
Merge pull request moby#16291 from mikebrow/readme-updates-for-man-pages
Browse files Browse the repository at this point in the history
updates to readme documents for manual page
  • Loading branch information
moxiegirl committed Sep 15, 2015
2 parents be08271 + 96699e0 commit 606c6e8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,9 +286,9 @@ aws cloudfront create-invalidation --profile docs.docker.com --distribution-id

### Generate the man pages

For information on generating man pages (short for manual page), see [the man
page directory](https://github.com/docker/docker/tree/master/docker) in this
project.
For information on generating man pages (short for manual page), see the README.md
document in [the man page directory](https://github.com/docker/docker/tree/master/docker)
in this project.



Expand Down
12 changes: 6 additions & 6 deletions man/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ 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.
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

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
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 `docker/man/man1` directory using
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/).

0 comments on commit 606c6e8

Please sign in to comment.