From f7d75cc08a6ebdc50ea9b7473342fdf6e22dc848 Mon Sep 17 00:00:00 2001 From: Michael West Date: Fri, 27 Mar 2015 23:23:50 -0400 Subject: [PATCH 1/2] Add man pages generation instructions. Signed-off-by: Michael West --- docs/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/README.md b/docs/README.md index 5feb496a736ce..24f91e115bb48 100755 --- a/docs/README.md +++ b/docs/README.md @@ -280,3 +280,24 @@ aws cloudfront create-invalidation --profile docs.docker.com --distribution-id 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"}' ``` +### Generate the man pages for Mac OSX + +When using Docker on Mac OSX the man pages will be missing by default. You can manually generate them by following these steps: + +1. Checkout the docker source. You must clone into your `/Users` directory because Boot2Docker can only share this path + with docker containers. + + $ git clone https://github.com/docker/docker.git + +2. Build the docker image. + + $ cd docker/docs/man + $ docker build -t docker/md2man . + +3. Build the man pages. + + $ docker run -v /Users//docker/docs/man:/docs:rw -w /docs -i docker/md2man /docs/md2man-all.sh + +4. Copy the generated man pages to `/usr/share/man` + + $ cp -R man* /usr/share/man/ From b4905859d55cf756d3855c1deddb68a9509bdab4 Mon Sep 17 00:00:00 2001 From: Michael West Date: Fri, 27 Mar 2015 23:25:12 -0400 Subject: [PATCH 2/2] Add a missing definite article Signed-off-by: Michael West --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 24f91e115bb48..15fee1d364699 100755 --- a/docs/README.md +++ b/docs/README.md @@ -285,7 +285,7 @@ aws cloudfront create-invalidation --profile docs.docker.com --distribution-id When using Docker on Mac OSX the man pages will be missing by default. You can manually generate them by following these steps: 1. Checkout the docker source. You must clone into your `/Users` directory because Boot2Docker can only share this path - with docker containers. + with the docker containers. $ git clone https://github.com/docker/docker.git