github.com/eikeon/docker@v1.5.0-rc4/docs/man/README.md (about)

     1  Docker Documentation
     2  ====================
     3  
     4  This directory contains the Docker user manual in the Markdown format.
     5  Do *not* edit the man pages in the man1 directory. Instead, amend the
     6  Markdown (*.md) files.
     7  
     8  # File List
     9  
    10      docker.md
    11      docker-attach.md
    12      docker-build.md
    13      docker-commit.md
    14      docker-cp.md
    15      docker-diff.md
    16      docker-events.md
    17      docker-export.md
    18      docker-history.md
    19      docker-images.md
    20      docker-import.md
    21      docker-info.md
    22      docker-inspect.md
    23      docker-kill.md
    24      docker-load.md
    25      docker-login.md
    26      docker-logs.md
    27      docker-port.md
    28      docker-ps.md
    29      docker-pull.md
    30      docker-push.md
    31      docker-restart.md
    32      docker-rmi.md
    33      docker-rm.md
    34      docker-run.md
    35      docker-save.md
    36      docker-search.md
    37      docker-start.md
    38      docker-stop.md
    39      docker-tag.md
    40      docker-top.md
    41      docker-wait.md
    42      Dockerfile
    43      md2man-all.sh
    44  
    45  # Generating man pages from the Markdown files
    46  
    47  The recommended approach for generating the man pages is via a Docker
    48  container using the supplied `Dockerfile` to create an image with the correct
    49  environment. This uses `go-md2man`, a pure Go Markdown to man page generator.
    50  
    51  ## Building the md2man image
    52  
    53  There is a `Dockerfile` provided in the `docker/docs/man` directory.
    54  
    55  Using this `Dockerfile`, create a Docker image tagged `docker/md2man`:
    56  
    57      docker build -t docker/md2man .
    58  
    59  ## Utilizing the image
    60  
    61  Once the image is built, run a container using the image with *volumes*:
    62  
    63      docker run -v /<path-to-git-dir>/docker/docs/man:/docs:rw \
    64      -w /docs -i docker/md2man /docs/md2man-all.sh
    65  
    66  The `md2man` Docker container will process the Markdown files and generate
    67  the man pages inside the `docker/docs/man/man1` directory using
    68  Docker volumes. For more information on Docker volumes see the man page for
    69  `docker run` and also look at the article [Sharing Directories via Volumes]
    70  (http://docs.docker.com/use/working_with_volumes/).