moby--moby/man/docker.1.md

71 lines
2.1 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 18:07:55 +00:00
% DOCKER(1) Docker User Manuals
% William Henry
% APRIL 2014
# NAME
docker \- Docker image and container command line interface
# SYNOPSIS
**docker** [OPTIONS] COMMAND [ARG...]
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 18:07:55 +00:00
**docker** [--help|-v|--version]
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 18:07:55 +00:00
# DESCRIPTION
**docker** is a client for interacting with the daemon (see **dockerd(8)**) through the CLI.
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 18:07:55 +00:00
The Docker CLI has over 30 commands. The commands are listed below and each has
its own man page which explain usage and arguments.
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 18:07:55 +00:00
To see the man page for a command run **man docker <command>**.
# OPTIONS
**--help**
Print usage statement
**--config**=""
Specifies the location of the Docker client configuration files. The default is '~/.docker'.
**-D**, **--debug**=*true*|*false*
Enable debug mode. Default is false.
**-H**, **--host**=[*unix:///var/run/docker.sock*]: tcp://[host]:[port][path] to bind or
unix://[/path/to/socket] to use.
The socket(s) to bind to in daemon mode specified using one or more
tcp://host:port/path, unix:///path/to/socket, fd://* or fd://socketfd.
If the tcp port is not specified, then it will default to either `2375` when
`--tls` is off, or `2376` when `--tls` is on, or `--tlsverify` is specified.
**-l**, **--log-level**="*debug*|*info*|*warn*|*error*|*fatal*"
Set the logging level. Default is `info`.
**--tls**=*true*|*false*
Use TLS; implied by --tlsverify. Default is false.
**--tlscacert**=*~/.docker/ca.pem*
Trust certs signed only by this CA.
**--tlscert**=*~/.docker/cert.pem*
Path to TLS certificate file.
**--tlskey**=*~/.docker/key.pem*
Path to TLS key file.
**--tlsverify**=*true*|*false*
Use TLS and verify the remote (daemon: verify client, client: verify daemon).
Default is false.
**-v**, **--version**=*true*|*false*
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 18:07:55 +00:00
Print version information and quit. Default is false.
# COMMANDS
Use "docker help" or "docker --help" to get an overview of available commands.
# EXAMPLES
For specific client examples please see the man page for the specific Docker
command. For example:
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 18:07:55 +00:00
man docker-run
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 18:07:55 +00:00
# HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.com source material and internal work.