Browse code

Add man pages generation instructions.

Signed-off-by: Michael West <mwest@mdsol.com>

Michael West authored on 2015/03/28 12:23:50
Showing 1 changed files
... ...
@@ -280,3 +280,24 @@ aws cloudfront  create-invalidation --profile docs.docker.com --distribution-id
280 280
 aws cloudfront  create-invalidation --profile docs.docker.com --distribution-id $DISTRIBUTION_ID --invalidation-batch '{"Paths":{"Quantity":1, "Items":["/v1.1/reference/api/docker_io_oauth_api/"]},"CallerReference":"6Mar2015sventest1"}'
281 281
 ```
282 282
 
283
+### Generate the man pages for Mac OSX
284
+
285
+When using Docker on Mac OSX the man pages will be missing by default. You can manually generate them by following these steps:
286
+
287
+1. Checkout the docker source. You must clone into your `/Users` directory because Boot2Docker can only share this path
288
+   with docker containers.
289
+
290
+        $ git clone https://github.com/docker/docker.git
291
+		
292
+2. Build the docker image.
293
+   
294
+        $ cd docker/docs/man
295
+        $ docker build -t docker/md2man .
296
+
297
+3. Build the man pages.
298
+
299
+        $ docker run -v /Users/<path-to-git-dir>/docker/docs/man:/docs:rw -w /docs -i docker/md2man /docs/md2man-all.sh
300
+
301
+4. Copy the generated man pages to `/usr/share/man`
302
+
303
+        $ cp -R man* /usr/share/man/