Skip to content

Commit

Permalink
Merge pull request moby#11880 from miwest929/feature/add_man_pages_docs
Browse files Browse the repository at this point in the history
Feature/add man pages docs
  • Loading branch information
moxiegirl committed Mar 29, 2015
2 parents 61069d8 + b490585 commit 1f27ebc
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 the 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/<path-to-git-dir>/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/

0 comments on commit 1f27ebc

Please sign in to comment.