1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
moby--moby/docs/man/README.md

34 lines
1.2 KiB
Markdown
Raw Normal View History

Created all manual pages in Markdown. Container for conversion. Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) All Docker commands have a Markdown page. Dockerfile used to build a Fedora based pandoc container. md2man-all.sh is used inside the container. README.sh includes an explaination on how to build the fedora/pandoc image and how to run the container directly. Changes to be committed: new file: contrib/man/md/Dockerfile new file: contrib/man/md/README.md new file: contrib/man/md/docker-attach.md new file: contrib/man/md/docker-build.md new file: contrib/man/md/docker-commit.md new file: contrib/man/md/docker-cp.md new file: contrib/man/md/docker-diff.md new file: contrib/man/md/docker-events.md new file: contrib/man/md/docker-export.md new file: contrib/man/md/docker-history.md new file: contrib/man/md/docker-images.md new file: contrib/man/md/docker-import.md new file: contrib/man/md/docker-info.md new file: contrib/man/md/docker-inspect.md new file: contrib/man/md/docker-kill.md new file: contrib/man/md/docker-load.md new file: contrib/man/md/docker-login.md new file: contrib/man/md/docker-logs.md new file: contrib/man/md/docker-port.md new file: contrib/man/md/docker-ps.md new file: contrib/man/md/docker-pull.md new file: contrib/man/md/docker-push.md new file: contrib/man/md/docker-restart.md new file: contrib/man/md/docker-rm.md new file: contrib/man/md/docker-rmi.md new file: contrib/man/md/docker-run.md new file: contrib/man/md/docker-save.md new file: contrib/man/md/docker-search.md new file: contrib/man/md/docker-start.md new file: contrib/man/md/docker-stop.md new file: contrib/man/md/docker-tag.md new file: contrib/man/md/docker-top.md new file: contrib/man/md/docker-wait.md new file: contrib/man/md/docker.md new file: contrib/man/md/md2man-all.sh
2014-04-16 14:07:55 -04:00
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.
Created all manual pages in Markdown. Container for conversion. Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) All Docker commands have a Markdown page. Dockerfile used to build a Fedora based pandoc container. md2man-all.sh is used inside the container. README.sh includes an explaination on how to build the fedora/pandoc image and how to run the container directly. Changes to be committed: new file: contrib/man/md/Dockerfile new file: contrib/man/md/README.md new file: contrib/man/md/docker-attach.md new file: contrib/man/md/docker-build.md new file: contrib/man/md/docker-commit.md new file: contrib/man/md/docker-cp.md new file: contrib/man/md/docker-diff.md new file: contrib/man/md/docker-events.md new file: contrib/man/md/docker-export.md new file: contrib/man/md/docker-history.md new file: contrib/man/md/docker-images.md new file: contrib/man/md/docker-import.md new file: contrib/man/md/docker-info.md new file: contrib/man/md/docker-inspect.md new file: contrib/man/md/docker-kill.md new file: contrib/man/md/docker-load.md new file: contrib/man/md/docker-login.md new file: contrib/man/md/docker-logs.md new file: contrib/man/md/docker-port.md new file: contrib/man/md/docker-ps.md new file: contrib/man/md/docker-pull.md new file: contrib/man/md/docker-push.md new file: contrib/man/md/docker-restart.md new file: contrib/man/md/docker-rm.md new file: contrib/man/md/docker-rmi.md new file: contrib/man/md/docker-run.md new file: contrib/man/md/docker-save.md new file: contrib/man/md/docker-search.md new file: contrib/man/md/docker-start.md new file: contrib/man/md/docker-stop.md new file: contrib/man/md/docker-tag.md new file: contrib/man/md/docker-top.md new file: contrib/man/md/docker-wait.md new file: contrib/man/md/docker.md new file: contrib/man/md/md2man-all.sh
2014-04-16 14:07:55 -04:00
# Generating man pages from the Markdown files
Created all manual pages in Markdown. Container for conversion. Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) All Docker commands have a Markdown page. Dockerfile used to build a Fedora based pandoc container. md2man-all.sh is used inside the container. README.sh includes an explaination on how to build the fedora/pandoc image and how to run the container directly. Changes to be committed: new file: contrib/man/md/Dockerfile new file: contrib/man/md/README.md new file: contrib/man/md/docker-attach.md new file: contrib/man/md/docker-build.md new file: contrib/man/md/docker-commit.md new file: contrib/man/md/docker-cp.md new file: contrib/man/md/docker-diff.md new file: contrib/man/md/docker-events.md new file: contrib/man/md/docker-export.md new file: contrib/man/md/docker-history.md new file: contrib/man/md/docker-images.md new file: contrib/man/md/docker-import.md new file: contrib/man/md/docker-info.md new file: contrib/man/md/docker-inspect.md new file: contrib/man/md/docker-kill.md new file: contrib/man/md/docker-load.md new file: contrib/man/md/docker-login.md new file: contrib/man/md/docker-logs.md new file: contrib/man/md/docker-port.md new file: contrib/man/md/docker-ps.md new file: contrib/man/md/docker-pull.md new file: contrib/man/md/docker-push.md new file: contrib/man/md/docker-restart.md new file: contrib/man/md/docker-rm.md new file: contrib/man/md/docker-rmi.md new file: contrib/man/md/docker-run.md new file: contrib/man/md/docker-save.md new file: contrib/man/md/docker-search.md new file: contrib/man/md/docker-start.md new file: contrib/man/md/docker-stop.md new file: contrib/man/md/docker-tag.md new file: contrib/man/md/docker-top.md new file: contrib/man/md/docker-wait.md new file: contrib/man/md/docker.md new file: contrib/man/md/md2man-all.sh
2014-04-16 14:07:55 -04:00
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.
Created all manual pages in Markdown. Container for conversion. Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) All Docker commands have a Markdown page. Dockerfile used to build a Fedora based pandoc container. md2man-all.sh is used inside the container. README.sh includes an explaination on how to build the fedora/pandoc image and how to run the container directly. Changes to be committed: new file: contrib/man/md/Dockerfile new file: contrib/man/md/README.md new file: contrib/man/md/docker-attach.md new file: contrib/man/md/docker-build.md new file: contrib/man/md/docker-commit.md new file: contrib/man/md/docker-cp.md new file: contrib/man/md/docker-diff.md new file: contrib/man/md/docker-events.md new file: contrib/man/md/docker-export.md new file: contrib/man/md/docker-history.md new file: contrib/man/md/docker-images.md new file: contrib/man/md/docker-import.md new file: contrib/man/md/docker-info.md new file: contrib/man/md/docker-inspect.md new file: contrib/man/md/docker-kill.md new file: contrib/man/md/docker-load.md new file: contrib/man/md/docker-login.md new file: contrib/man/md/docker-logs.md new file: contrib/man/md/docker-port.md new file: contrib/man/md/docker-ps.md new file: contrib/man/md/docker-pull.md new file: contrib/man/md/docker-push.md new file: contrib/man/md/docker-restart.md new file: contrib/man/md/docker-rm.md new file: contrib/man/md/docker-rmi.md new file: contrib/man/md/docker-run.md new file: contrib/man/md/docker-save.md new file: contrib/man/md/docker-search.md new file: contrib/man/md/docker-start.md new file: contrib/man/md/docker-stop.md new file: contrib/man/md/docker-tag.md new file: contrib/man/md/docker-top.md new file: contrib/man/md/docker-wait.md new file: contrib/man/md/docker.md new file: contrib/man/md/md2man-all.sh
2014-04-16 14:07:55 -04:00
## Building the md2man image
Created all manual pages in Markdown. Container for conversion. Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) All Docker commands have a Markdown page. Dockerfile used to build a Fedora based pandoc container. md2man-all.sh is used inside the container. README.sh includes an explaination on how to build the fedora/pandoc image and how to run the container directly. Changes to be committed: new file: contrib/man/md/Dockerfile new file: contrib/man/md/README.md new file: contrib/man/md/docker-attach.md new file: contrib/man/md/docker-build.md new file: contrib/man/md/docker-commit.md new file: contrib/man/md/docker-cp.md new file: contrib/man/md/docker-diff.md new file: contrib/man/md/docker-events.md new file: contrib/man/md/docker-export.md new file: contrib/man/md/docker-history.md new file: contrib/man/md/docker-images.md new file: contrib/man/md/docker-import.md new file: contrib/man/md/docker-info.md new file: contrib/man/md/docker-inspect.md new file: contrib/man/md/docker-kill.md new file: contrib/man/md/docker-load.md new file: contrib/man/md/docker-login.md new file: contrib/man/md/docker-logs.md new file: contrib/man/md/docker-port.md new file: contrib/man/md/docker-ps.md new file: contrib/man/md/docker-pull.md new file: contrib/man/md/docker-push.md new file: contrib/man/md/docker-restart.md new file: contrib/man/md/docker-rm.md new file: contrib/man/md/docker-rmi.md new file: contrib/man/md/docker-run.md new file: contrib/man/md/docker-save.md new file: contrib/man/md/docker-search.md new file: contrib/man/md/docker-start.md new file: contrib/man/md/docker-stop.md new file: contrib/man/md/docker-tag.md new file: contrib/man/md/docker-top.md new file: contrib/man/md/docker-wait.md new file: contrib/man/md/docker.md new file: contrib/man/md/md2man-all.sh
2014-04-16 14:07:55 -04:00
There is a `Dockerfile` provided in the `docker/docs/man` directory.
Created all manual pages in Markdown. Container for conversion. Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) All Docker commands have a Markdown page. Dockerfile used to build a Fedora based pandoc container. md2man-all.sh is used inside the container. README.sh includes an explaination on how to build the fedora/pandoc image and how to run the container directly. Changes to be committed: new file: contrib/man/md/Dockerfile new file: contrib/man/md/README.md new file: contrib/man/md/docker-attach.md new file: contrib/man/md/docker-build.md new file: contrib/man/md/docker-commit.md new file: contrib/man/md/docker-cp.md new file: contrib/man/md/docker-diff.md new file: contrib/man/md/docker-events.md new file: contrib/man/md/docker-export.md new file: contrib/man/md/docker-history.md new file: contrib/man/md/docker-images.md new file: contrib/man/md/docker-import.md new file: contrib/man/md/docker-info.md new file: contrib/man/md/docker-inspect.md new file: contrib/man/md/docker-kill.md new file: contrib/man/md/docker-load.md new file: contrib/man/md/docker-login.md new file: contrib/man/md/docker-logs.md new file: contrib/man/md/docker-port.md new file: contrib/man/md/docker-ps.md new file: contrib/man/md/docker-pull.md new file: contrib/man/md/docker-push.md new file: contrib/man/md/docker-restart.md new file: contrib/man/md/docker-rm.md new file: contrib/man/md/docker-rmi.md new file: contrib/man/md/docker-run.md new file: contrib/man/md/docker-save.md new file: contrib/man/md/docker-search.md new file: contrib/man/md/docker-start.md new file: contrib/man/md/docker-stop.md new file: contrib/man/md/docker-tag.md new file: contrib/man/md/docker-top.md new file: contrib/man/md/docker-wait.md new file: contrib/man/md/docker.md new file: contrib/man/md/md2man-all.sh
2014-04-16 14:07:55 -04:00
Using this `Dockerfile`, create a Docker image tagged `docker/md2man`:
Created all manual pages in Markdown. Container for conversion. Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) All Docker commands have a Markdown page. Dockerfile used to build a Fedora based pandoc container. md2man-all.sh is used inside the container. README.sh includes an explaination on how to build the fedora/pandoc image and how to run the container directly. Changes to be committed: new file: contrib/man/md/Dockerfile new file: contrib/man/md/README.md new file: contrib/man/md/docker-attach.md new file: contrib/man/md/docker-build.md new file: contrib/man/md/docker-commit.md new file: contrib/man/md/docker-cp.md new file: contrib/man/md/docker-diff.md new file: contrib/man/md/docker-events.md new file: contrib/man/md/docker-export.md new file: contrib/man/md/docker-history.md new file: contrib/man/md/docker-images.md new file: contrib/man/md/docker-import.md new file: contrib/man/md/docker-info.md new file: contrib/man/md/docker-inspect.md new file: contrib/man/md/docker-kill.md new file: contrib/man/md/docker-load.md new file: contrib/man/md/docker-login.md new file: contrib/man/md/docker-logs.md new file: contrib/man/md/docker-port.md new file: contrib/man/md/docker-ps.md new file: contrib/man/md/docker-pull.md new file: contrib/man/md/docker-push.md new file: contrib/man/md/docker-restart.md new file: contrib/man/md/docker-rm.md new file: contrib/man/md/docker-rmi.md new file: contrib/man/md/docker-run.md new file: contrib/man/md/docker-save.md new file: contrib/man/md/docker-search.md new file: contrib/man/md/docker-start.md new file: contrib/man/md/docker-stop.md new file: contrib/man/md/docker-tag.md new file: contrib/man/md/docker-top.md new file: contrib/man/md/docker-wait.md new file: contrib/man/md/docker.md new file: contrib/man/md/md2man-all.sh
2014-04-16 14:07:55 -04:00
docker build -t docker/md2man .
Created all manual pages in Markdown. Container for conversion. Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) All Docker commands have a Markdown page. Dockerfile used to build a Fedora based pandoc container. md2man-all.sh is used inside the container. README.sh includes an explaination on how to build the fedora/pandoc image and how to run the container directly. Changes to be committed: new file: contrib/man/md/Dockerfile new file: contrib/man/md/README.md new file: contrib/man/md/docker-attach.md new file: contrib/man/md/docker-build.md new file: contrib/man/md/docker-commit.md new file: contrib/man/md/docker-cp.md new file: contrib/man/md/docker-diff.md new file: contrib/man/md/docker-events.md new file: contrib/man/md/docker-export.md new file: contrib/man/md/docker-history.md new file: contrib/man/md/docker-images.md new file: contrib/man/md/docker-import.md new file: contrib/man/md/docker-info.md new file: contrib/man/md/docker-inspect.md new file: contrib/man/md/docker-kill.md new file: contrib/man/md/docker-load.md new file: contrib/man/md/docker-login.md new file: contrib/man/md/docker-logs.md new file: contrib/man/md/docker-port.md new file: contrib/man/md/docker-ps.md new file: contrib/man/md/docker-pull.md new file: contrib/man/md/docker-push.md new file: contrib/man/md/docker-restart.md new file: contrib/man/md/docker-rm.md new file: contrib/man/md/docker-rmi.md new file: contrib/man/md/docker-run.md new file: contrib/man/md/docker-save.md new file: contrib/man/md/docker-search.md new file: contrib/man/md/docker-start.md new file: contrib/man/md/docker-stop.md new file: contrib/man/md/docker-tag.md new file: contrib/man/md/docker-top.md new file: contrib/man/md/docker-wait.md new file: contrib/man/md/docker.md new file: contrib/man/md/md2man-all.sh
2014-04-16 14:07:55 -04:00
## Utilizing the image
Once the image is built, run a container using the image with *volumes*:
Created all manual pages in Markdown. Container for conversion. Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) All Docker commands have a Markdown page. Dockerfile used to build a Fedora based pandoc container. md2man-all.sh is used inside the container. README.sh includes an explaination on how to build the fedora/pandoc image and how to run the container directly. Changes to be committed: new file: contrib/man/md/Dockerfile new file: contrib/man/md/README.md new file: contrib/man/md/docker-attach.md new file: contrib/man/md/docker-build.md new file: contrib/man/md/docker-commit.md new file: contrib/man/md/docker-cp.md new file: contrib/man/md/docker-diff.md new file: contrib/man/md/docker-events.md new file: contrib/man/md/docker-export.md new file: contrib/man/md/docker-history.md new file: contrib/man/md/docker-images.md new file: contrib/man/md/docker-import.md new file: contrib/man/md/docker-info.md new file: contrib/man/md/docker-inspect.md new file: contrib/man/md/docker-kill.md new file: contrib/man/md/docker-load.md new file: contrib/man/md/docker-login.md new file: contrib/man/md/docker-logs.md new file: contrib/man/md/docker-port.md new file: contrib/man/md/docker-ps.md new file: contrib/man/md/docker-pull.md new file: contrib/man/md/docker-push.md new file: contrib/man/md/docker-restart.md new file: contrib/man/md/docker-rm.md new file: contrib/man/md/docker-rmi.md new file: contrib/man/md/docker-run.md new file: contrib/man/md/docker-save.md new file: contrib/man/md/docker-search.md new file: contrib/man/md/docker-start.md new file: contrib/man/md/docker-stop.md new file: contrib/man/md/docker-tag.md new file: contrib/man/md/docker-top.md new file: contrib/man/md/docker-wait.md new file: contrib/man/md/docker.md new file: contrib/man/md/md2man-all.sh
2014-04-16 14:07:55 -04:00
docker run -v /<path-to-git-dir>/docker/docs/man:/docs:rw \
-w /docs -i docker/md2man /docs/md2man-all.sh
Created all manual pages in Markdown. Container for conversion. Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) All Docker commands have a Markdown page. Dockerfile used to build a Fedora based pandoc container. md2man-all.sh is used inside the container. README.sh includes an explaination on how to build the fedora/pandoc image and how to run the container directly. Changes to be committed: new file: contrib/man/md/Dockerfile new file: contrib/man/md/README.md new file: contrib/man/md/docker-attach.md new file: contrib/man/md/docker-build.md new file: contrib/man/md/docker-commit.md new file: contrib/man/md/docker-cp.md new file: contrib/man/md/docker-diff.md new file: contrib/man/md/docker-events.md new file: contrib/man/md/docker-export.md new file: contrib/man/md/docker-history.md new file: contrib/man/md/docker-images.md new file: contrib/man/md/docker-import.md new file: contrib/man/md/docker-info.md new file: contrib/man/md/docker-inspect.md new file: contrib/man/md/docker-kill.md new file: contrib/man/md/docker-load.md new file: contrib/man/md/docker-login.md new file: contrib/man/md/docker-logs.md new file: contrib/man/md/docker-port.md new file: contrib/man/md/docker-ps.md new file: contrib/man/md/docker-pull.md new file: contrib/man/md/docker-push.md new file: contrib/man/md/docker-restart.md new file: contrib/man/md/docker-rm.md new file: contrib/man/md/docker-rmi.md new file: contrib/man/md/docker-run.md new file: contrib/man/md/docker-save.md new file: contrib/man/md/docker-search.md new file: contrib/man/md/docker-start.md new file: contrib/man/md/docker-stop.md new file: contrib/man/md/docker-tag.md new file: contrib/man/md/docker-top.md new file: contrib/man/md/docker-wait.md new file: contrib/man/md/docker.md new file: contrib/man/md/md2man-all.sh
2014-04-16 14:07:55 -04:00
The `md2man` Docker container will process the Markdown files and generate
the man pages inside the `docker/docs/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/).