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.
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.
There is a
Dockerfile provided in the
Dockerfile, create a Docker image tagged
docker build -t docker/md2man .
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
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/).