Browse code

updates to readme documents for manual page

Signed-off-by: Mike Brown <brownwm@us.ibm.com>

Mike Brown authored on 2015/09/15 06:10:33
Showing 2 changed files
... ...
@@ -286,9 +286,9 @@ aws cloudfront  create-invalidation --profile docs.docker.com --distribution-id
286 286
 
287 287
 ### Generate the man pages 
288 288
 
289
-For information on generating man pages (short for manual page), see [the man
290
-page directory](https://github.com/docker/docker/tree/master/docker) in this
291
-project.
289
+For information on generating man pages (short for manual page), see the README.md
290
+document in [the man page directory](https://github.com/docker/docker/tree/master/docker)
291
+in this project.
292 292
 
293 293
 
294 294
 
... ...
@@ -13,7 +13,8 @@ environment. This uses `go-md2man`, a pure Go Markdown to man page generator.
13 13
 
14 14
 ## Building the md2man image
15 15
 
16
-There is a `Dockerfile` provided in the `docker/man` directory.
16
+There is a `Dockerfile` provided in the `/man` directory of your
17
+'docker/docker' fork.
17 18
 
18 19
 Using this `Dockerfile`, create a Docker image tagged `docker/md2man`:
19 20
 
... ...
@@ -21,13 +22,12 @@ Using this `Dockerfile`, create a Docker image tagged `docker/md2man`:
21 21
 
22 22
 ## Utilizing the image
23 23
 
24
-Once the image is built, run a container using the image with *volumes*:
25
-
26
-    docker run -v /<path-to-git-dir>/docker/man:/docs:rw \
27
-    -w /docs -i docker/md2man /docs/md2man-all.sh
24
+From within the `/man` directory run the following command:
28 25
 
26
+    docker run -v $(pwd):/man -w /man -i docker/md2man ./md2man-all.sh
27
+    
29 28
 The `md2man` Docker container will process the Markdown files and generate
30
-the man pages inside the `docker/man/man1` directory using
29
+the man pages inside the `/man/man1` directory of your fork using
31 30
 Docker volumes. For more information on Docker volumes see the man page for
32 31
 `docker run` and also look at the article [Sharing Directories via Volumes]
33 32
 (https://docs.docker.com/use/working_with_volumes/).