tree: d2833503fbee6228841c75449fd1d130861afeca [path history] [tgz]
  1. Dockerfile
  2. Dockerfile.5.md
  3. README.md
  4. docker-attach.1.md
  5. docker-build.1.md
  6. docker-commit.1.md
  7. docker-cp.1.md
  8. docker-create.1.md
  9. docker-diff.1.md
  10. docker-events.1.md
  11. docker-exec.1.md
  12. docker-export.1.md
  13. docker-history.1.md
  14. docker-images.1.md
  15. docker-import.1.md
  16. docker-info.1.md
  17. docker-inspect.1.md
  18. docker-kill.1.md
  19. docker-load.1.md
  20. docker-login.1.md
  21. docker-logout.1.md
  22. docker-logs.1.md
  23. docker-pause.1.md
  24. docker-port.1.md
  25. docker-ps.1.md
  26. docker-pull.1.md
  27. docker-push.1.md
  28. docker-rename.1.md
  29. docker-restart.1.md
  30. docker-rm.1.md
  31. docker-rmi.1.md
  32. docker-run.1.md
  33. docker-save.1.md
  34. docker-search.1.md
  35. docker-start.1.md
  36. docker-stats.1.md
  37. docker-stop.1.md
  38. docker-tag.1.md
  39. docker-top.1.md
  40. docker-unpause.1.md
  41. docker-version.1.md
  42. docker-wait.1.md
  43. docker.1.md
  44. md2man-all.sh
man/README.md

Docker Documentation

This directory contains the Docker user manual in the Markdown format. Do not edit the man pages in the man1 directory. Instead, amend the Markdown (*.md) files.

Generating man pages from the Markdown files

The recommended approach for generating the man pages is via a Docker container using the supplied Dockerfile to create an image with the correct environment. This uses go-md2man, a pure Go Markdown to man page generator.

Building the md2man image

There is a Dockerfile provided in the docker/man directory.

Using this Dockerfile, create a Docker image tagged docker/md2man:

docker build -t docker/md2man .

Utilizing the image

Once the image is built, run a container using the image with volumes:

docker run -v /<path-to-git-dir>/docker/man:/docs:rw \
-w /docs -i docker/md2man /docs/md2man-all.sh

The md2man Docker container will process the Markdown files and generate the man pages inside the docker/man/man1 directory using Docker volumes. For more information on Docker volumes see the man page for docker run and also look at the article [Sharing Directories via Volumes] (https://docs.docker.com/use/working_with_volumes/).