Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updates to readme documents for manual page 

Signed-off-by: Mike Brown <brownwm@us.ibm.com>
This commit is contained in:
Mike Brown 2015-09-14 16:10:33 -05:00 committed by Tibor Vass
parent aba3fa1040
commit ccb5d7469a
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 ### Generate the man pages
For information on generating man pages (short for manual page), see [the man For information on generating man pages (short for manual page), see the README.md
page directory](https://github.com/docker/docker/tree/master/docker) in this document in [the man page directory](https://github.com/docker/docker/tree/master/docker)
project. in this project.

10
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 ## 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`: 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 ## Utilizing the image
Once the image is built, run a container using the image with *volumes*: From within the `/man` directory run the following command:
docker run -v /<path-to-git-dir>/docker/man:/docs:rw \ docker run -v $(pwd):/man -w /man -i docker/md2man ./md2man-all.sh
-w /docs -i docker/md2man /docs/md2man-all.sh
The `md2man` Docker container will process the Markdown files and generate 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 volumes. For more information on Docker volumes see the man page for
`docker run` and also look at the article [Sharing Directories via Volumes] `docker run` and also look at the article [Sharing Directories via Volumes]
(https://docs.docker.com/use/working_with_volumes/). (https://docs.docker.com/use/working_with_volumes/).