.TH "DOCKER" "1" " Docker User Manuals" "William Henry" "APRIL 2014"  ""


.SH NAME
.PP
docker \- Docker image and container command line interface


.SH SYNOPSIS
.PP
\fBdocker\fP [OPTIONS] COMMAND [arg...]

.PP
\fBdocker\fP daemon [\-\-help|...]

.PP
\fBdocker\fP [\-\-help|\-v|\-\-version]


.SH DESCRIPTION
.PP
\fBdocker\fP has two distinct functions. It is used for starting the Docker
daemon and to run the CLI (i.e., to command the daemon to manage images,
containers etc.) So \fBdocker\fP is both a server, as a daemon, and a client
to the daemon, through the CLI.

.PP
To run the Docker daemon you can specify \fBdocker daemon\fP.
You can view the daemon options using \fBdocker daemon \-\-help\fP.
To see the man page for the daemon, run \fBman docker daemon\fP.

.PP
The Docker CLI has over 30 commands. The commands are listed below and each has
its own man page which explain usage and arguments.

.PP
To see the man page for a command run \fBman docker <command>\fP.


.SH OPTIONS
.PP
\fB\-\-help\fP
  Print usage statement

.PP
\fB\-\-config\fP=""
  Specifies the location of the Docker client configuration files. The default is '\~/.docker'.

.PP
\fB\-D\fP, \fB\-\-debug\fP=\fItrue\fP|\fIfalse\fP
  Enable debug mode. Default is false.

.PP
\fB\-H\fP, \fB\-\-host\fP=[\fIunix:///var/run/docker.sock\fP]: 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 \fB\fC2375\fR when
  \fB\fC\-\-tls\fR is off, or \fB\fC2376\fR when \fB\fC\-\-tls\fR is on, or \fB\fC\-\-tlsverify\fR is specified.

.PP
\fB\-l\fP, \fB\-\-log\-level\fP="\fIdebug\fP|\fIinfo\fP|\fIwarn\fP|\fIerror\fP|\fIfatal\fP"
  Set the logging level. Default is \fB\fCinfo\fR.

.PP
\fB\-\-tls\fP=\fItrue\fP|\fIfalse\fP
  Use TLS; implied by \-\-tlsverify. Default is false.

.PP
\fB\-\-tlscacert\fP=\fI\~/.docker/ca.pem\fP
  Trust certs signed only by this CA.

.PP
\fB\-\-tlscert\fP=\fI\~/.docker/cert.pem\fP
  Path to TLS certificate file.

.PP
\fB\-\-tlskey\fP=\fI\~/.docker/key.pem\fP
  Path to TLS key file.

.PP
\fB\-\-tlsverify\fP=\fItrue\fP|\fIfalse\fP
  Use TLS and verify the remote (daemon: verify client, client: verify daemon).
  Default is false.

.PP
\fB\-v\fP, \fB\-\-version\fP=\fItrue\fP|\fIfalse\fP
  Print version information and quit. Default is false.


.SH COMMANDS
.PP
\fBattach\fP
  Attach to a running container
  See \fBdocker\-attach(1)\fP for full documentation on the \fBattach\fP command.

.PP
\fBbuild\fP
  Build an image from a Dockerfile
  See \fBdocker\-build(1)\fP for full documentation on the \fBbuild\fP command.

.PP
\fBcommit\fP
  Create a new image from a container's changes
  See \fBdocker\-commit(1)\fP for full documentation on the \fBcommit\fP command.

.PP
\fBcp\fP
  Copy files/folders between a container and the local filesystem
  See \fBdocker\-cp(1)\fP for full documentation on the \fBcp\fP command.

.PP
\fBcreate\fP
  Create a new container
  See \fBdocker\-create(1)\fP for full documentation on the \fBcreate\fP command.

.PP
\fBdiff\fP
  Inspect changes on a container's filesystem
  See \fBdocker\-diff(1)\fP for full documentation on the \fBdiff\fP command.

.PP
\fBevents\fP
  Get real time events from the server
  See \fBdocker\-events(1)\fP for full documentation on the \fBevents\fP command.

.PP
\fBexec\fP
  Run a command in a running container
  See \fBdocker\-exec(1)\fP for full documentation on the \fBexec\fP command.

.PP
\fBexport\fP
  Stream the contents of a container as a tar archive
  See \fBdocker\-export(1)\fP for full documentation on the \fBexport\fP command.

.PP
\fBhistory\fP
  Show the history of an image
  See \fBdocker\-history(1)\fP for full documentation on the \fBhistory\fP command.

.PP
\fBimages\fP
  List images
  See \fBdocker\-images(1)\fP for full documentation on the \fBimages\fP command.

.PP
\fBimport\fP
  Create a new filesystem image from the contents of a tarball
  See \fBdocker\-import(1)\fP for full documentation on the \fBimport\fP command.

.PP
\fBinfo\fP
  Display system\-wide information
  See \fBdocker\-info(1)\fP for full documentation on the \fBinfo\fP command.

.PP
\fBinspect\fP
  Return low\-level information on a container or image
  See \fBdocker\-inspect(1)\fP for full documentation on the \fBinspect\fP command.

.PP
\fBkill\fP
  Kill a running container (which includes the wrapper process and everything
inside it)
  See \fBdocker\-kill(1)\fP for full documentation on the \fBkill\fP command.

.PP
\fBload\fP
  Load an image from a tar archive
  See \fBdocker\-load(1)\fP for full documentation on the \fBload\fP command.

.PP
\fBlogin\fP
  Register or login to a Docker Registry
  See \fBdocker\-login(1)\fP for full documentation on the \fBlogin\fP command.

.PP
\fBlogout\fP
  Log the user out of a Docker Registry
  See \fBdocker\-logout(1)\fP for full documentation on the \fBlogout\fP command.

.PP
\fBlogs\fP
  Fetch the logs of a container
  See \fBdocker\-logs(1)\fP for full documentation on the \fBlogs\fP command.

.PP
\fBpause\fP
  Pause all processes within a container
  See \fBdocker\-pause(1)\fP for full documentation on the \fBpause\fP command.

.PP
\fBport\fP
  Lookup the public\-facing port which is NAT\-ed to PRIVATE\_PORT
  See \fBdocker\-port(1)\fP for full documentation on the \fBport\fP command.

.PP
\fBps\fP
  List containers
  See \fBdocker\-ps(1)\fP for full documentation on the \fBps\fP command.

.PP
\fBpull\fP
  Pull an image or a repository from a Docker Registry
  See \fBdocker\-pull(1)\fP for full documentation on the \fBpull\fP command.

.PP
\fBpush\fP
  Push an image or a repository to a Docker Registry
  See \fBdocker\-push(1)\fP for full documentation on the \fBpush\fP command.

.PP
\fBrename\fP
  Rename a container.
  See \fBdocker\-rename(1)\fP for full documentation on the \fBrename\fP command.

.PP
\fBrestart\fP
  Restart a container
  See \fBdocker\-restart(1)\fP for full documentation on the \fBrestart\fP command.

.PP
\fBrm\fP
  Remove one or more containers
  See \fBdocker\-rm(1)\fP for full documentation on the \fBrm\fP command.

.PP
\fBrmi\fP
  Remove one or more images
  See \fBdocker\-rmi(1)\fP for full documentation on the \fBrmi\fP command.

.PP
\fBrun\fP
  Run a command in a new container
  See \fBdocker\-run(1)\fP for full documentation on the \fBrun\fP command.

.PP
\fBsave\fP
  Save an image to a tar archive
  See \fBdocker\-save(1)\fP for full documentation on the \fBsave\fP command.

.PP
\fBsearch\fP
  Search for an image in the Docker index
  See \fBdocker\-search(1)\fP for full documentation on the \fBsearch\fP command.

.PP
\fBstart\fP
  Start a container
  See \fBdocker\-start(1)\fP for full documentation on the \fBstart\fP command.

.PP
\fBstats\fP
  Display a live stream of one or more containers' resource usage statistics
  See \fBdocker\-stats(1)\fP for full documentation on the \fBstats\fP command.

.PP
\fBstop\fP
  Stop a container
  See \fBdocker\-stop(1)\fP for full documentation on the \fBstop\fP command.

.PP
\fBtag\fP
  Tag an image into a repository
  See \fBdocker\-tag(1)\fP for full documentation on the \fBtag\fP command.

.PP
\fBtop\fP
  Lookup the running processes of a container
  See \fBdocker\-top(1)\fP for full documentation on the \fBtop\fP command.

.PP
\fBunpause\fP
  Unpause all processes within a container
  See \fBdocker\-unpause(1)\fP for full documentation on the \fBunpause\fP command.

.PP
\fBversion\fP
  Show the Docker version information
  See \fBdocker\-version(1)\fP for full documentation on the \fBversion\fP command.

.PP
\fBwait\fP
  Block until a container stops, then print its exit code
  See \fBdocker\-wait(1)\fP for full documentation on the \fBwait\fP command.


.SH EXEC DRIVER OPTIONS
.PP
Use the \fB\-\-exec\-opt\fP flags to specify options to the execution driver.
The following options are available:

.SS native.cgroupdriver
.PP
Specifies the management of the container's \fB\fCcgroups\fR. You can specify
\fB\fCcgroupfs\fR or \fB\fCsystemd\fR. If you specify \fB\fCsystemd\fR and it is not available, the
system uses \fB\fCcgroupfs\fR.

.SS Client
.PP
For specific client examples please see the man page for the specific Docker
command. For example:

.PP
.RS

.nf
man docker\-run

.fi
.RE


.SH HISTORY
.PP
April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.com source material and internal work.