kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

Merge pull request #16291 from mikebrow/readme-updates-for-man-pages

Browse source 
updates to readme documents for manual page
This commit is contained in:
moxiegirl 2015-09-15 15:18:19 -07:00
commit 606c6e8f57
2 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/README.md
View file

@ -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.

12
man/README.md
View file

@ -13,7 +13,8 @@ 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`:
@ -21,13 +22,12 @@ Using this `Dockerfile`, create a Docker image tagged `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/).