github.com/portworx/docker@v1.12.1/man/docker.1.md (about)

     1  % DOCKER(1) Docker User Manuals
     2  % William Henry
     3  % APRIL 2014
     4  # NAME
     5  docker \- Docker image and container command line interface
     6  
     7  # SYNOPSIS
     8  **docker** [OPTIONS] COMMAND [arg...]
     9  
    10  **docker** daemon [--help|...]
    11  
    12  **docker** [--help|-v|--version]
    13  
    14  # DESCRIPTION
    15  is a client for interacting with the daemon (see **dockerd(8)**) through the CLI.
    16  
    17  The Docker CLI has over 30 commands. The commands are listed below and each has
    18  its own man page which explain usage and arguments.
    19  
    20  To see the man page for a command run **man docker <command>**.
    21  
    22  # OPTIONS
    23  **--help**
    24    Print usage statement
    25  
    26  **--config**=""
    27    Specifies the location of the Docker client configuration files. The default is '~/.docker'.
    28  
    29  **-D**, **--debug**=*true*|*false*
    30    Enable debug mode. Default is false.
    31  
    32  **-H**, **--host**=[*unix:///var/run/docker.sock*]: tcp://[host]:[port][path] to bind or
    33  unix://[/path/to/socket] to use.
    34    The socket(s) to bind to in daemon mode specified using one or more
    35    tcp://host:port/path, unix:///path/to/socket, fd://* or fd://socketfd.
    36    If the tcp port is not specified, then it will default to either `2375` when
    37    `--tls` is off, or `2376` when `--tls` is on, or `--tlsverify` is specified.
    38  
    39  **-l**, **--log-level**="*debug*|*info*|*warn*|*error*|*fatal*"
    40    Set the logging level. Default is `info`.
    41  
    42  **--tls**=*true*|*false*
    43    Use TLS; implied by --tlsverify. Default is false.
    44  
    45  **--tlscacert**=*~/.docker/ca.pem*
    46    Trust certs signed only by this CA.
    47  
    48  **--tlscert**=*~/.docker/cert.pem*
    49    Path to TLS certificate file.
    50  
    51  **--tlskey**=*~/.docker/key.pem*
    52    Path to TLS key file.
    53  
    54  **--tlsverify**=*true*|*false*
    55    Use TLS and verify the remote (daemon: verify client, client: verify daemon).
    56    Default is false.
    57  
    58  **-v**, **--version**=*true*|*false*
    59    Print version information and quit. Default is false.
    60  
    61  # COMMANDS
    62  **attach**
    63    Attach to a running container
    64    See **docker-attach(1)** for full documentation on the **attach** command.
    65  
    66  **build**
    67    Build an image from a Dockerfile
    68    See **docker-build(1)** for full documentation on the **build** command.
    69  
    70  **commit**
    71    Create a new image from a container's changes
    72    See **docker-commit(1)** for full documentation on the **commit** command.
    73  
    74  **cp**
    75    Copy files/folders between a container and the local filesystem
    76    See **docker-cp(1)** for full documentation on the **cp** command.
    77  
    78  **create**
    79    Create a new container
    80    See **docker-create(1)** for full documentation on the **create** command.
    81  
    82  **diff**
    83    Inspect changes on a container's filesystem
    84    See **docker-diff(1)** for full documentation on the **diff** command.
    85  
    86  **events**
    87    Get real time events from the server
    88    See **docker-events(1)** for full documentation on the **events** command.
    89  
    90  **exec**
    91    Run a command in a running container
    92    See **docker-exec(1)** for full documentation on the **exec** command.
    93  
    94  **export**
    95    Stream the contents of a container as a tar archive
    96    See **docker-export(1)** for full documentation on the **export** command.
    97  
    98  **history**
    99    Show the history of an image
   100    See **docker-history(1)** for full documentation on the **history** command.
   101  
   102  **images**
   103    List images
   104    See **docker-images(1)** for full documentation on the **images** command.
   105  
   106  **import**
   107    Create a new filesystem image from the contents of a tarball
   108    See **docker-import(1)** for full documentation on the **import** command.
   109  
   110  **info**
   111    Display system-wide information
   112    See **docker-info(1)** for full documentation on the **info** command.
   113  
   114  **inspect**
   115    Return low-level information on a container or image
   116    See **docker-inspect(1)** for full documentation on the **inspect** command.
   117  
   118  **kill**
   119    Kill a running container (which includes the wrapper process and everything
   120  inside it)
   121    See **docker-kill(1)** for full documentation on the **kill** command.
   122  
   123  **load**
   124    Load an image from a tar archive
   125    See **docker-load(1)** for full documentation on the **load** command.
   126  
   127  **login**
   128    Log in to a Docker Registry
   129    See **docker-login(1)** for full documentation on the **login** command.
   130  
   131  **logout**
   132    Log the user out of a Docker Registry
   133    See **docker-logout(1)** for full documentation on the **logout** command.
   134  
   135  **logs**
   136    Fetch the logs of a container
   137    See **docker-logs(1)** for full documentation on the **logs** command.
   138  
   139  **pause**
   140    Pause all processes within a container
   141    See **docker-pause(1)** for full documentation on the **pause** command.
   142  
   143  **port**
   144    Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
   145    See **docker-port(1)** for full documentation on the **port** command.
   146  
   147  **ps**
   148    List containers
   149    See **docker-ps(1)** for full documentation on the **ps** command.
   150  
   151  **pull**
   152    Pull an image or a repository from a Docker Registry
   153    See **docker-pull(1)** for full documentation on the **pull** command.
   154  
   155  **push**
   156    Push an image or a repository to a Docker Registry
   157    See **docker-push(1)** for full documentation on the **push** command.
   158  
   159  **rename**
   160    Rename a container.
   161    See **docker-rename(1)** for full documentation on the **rename** command.
   162  
   163  **restart**
   164    Restart a container
   165    See **docker-restart(1)** for full documentation on the **restart** command.
   166  
   167  **rm**
   168    Remove one or more containers
   169    See **docker-rm(1)** for full documentation on the **rm** command.
   170  
   171  **rmi**
   172    Remove one or more images
   173    See **docker-rmi(1)** for full documentation on the **rmi** command.
   174  
   175  **run**
   176    Run a command in a new container
   177    See **docker-run(1)** for full documentation on the **run** command.
   178  
   179  **save**
   180    Save an image to a tar archive
   181    See **docker-save(1)** for full documentation on the **save** command.
   182  
   183  **search**
   184    Search for an image in the Docker index
   185    See **docker-search(1)** for full documentation on the **search** command.
   186  
   187  **start**
   188    Start a container
   189    See **docker-start(1)** for full documentation on the **start** command.
   190  
   191  **stats**
   192    Display a live stream of one or more containers' resource usage statistics
   193    See **docker-stats(1)** for full documentation on the **stats** command.
   194  
   195  **stop**
   196    Stop a container
   197    See **docker-stop(1)** for full documentation on the **stop** command.
   198  
   199  **tag**
   200    Tag an image into a repository
   201    See **docker-tag(1)** for full documentation on the **tag** command.
   202  
   203  **top**
   204    Lookup the running processes of a container
   205    See **docker-top(1)** for full documentation on the **top** command.
   206  
   207  **unpause**
   208    Unpause all processes within a container
   209    See **docker-unpause(1)** for full documentation on the **unpause** command.
   210  
   211  **version**
   212    Show the Docker version information
   213    See **docker-version(1)** for full documentation on the **version** command.
   214  
   215  **wait**
   216    Block until a container stops, then print its exit code
   217    See **docker-wait(1)** for full documentation on the **wait** command.
   218  
   219  
   220  # RUNTIME EXECUTION OPTIONS
   221  
   222  Use the **--exec-opt** flags to specify options to the execution driver.
   223  The following options are available:
   224  
   225  #### native.cgroupdriver
   226  Specifies the management of the container's `cgroups`. You can specify `cgroupfs`
   227  or `systemd`. If you specify `systemd` and it is not available, the system errors
   228  out.
   229  
   230  #### Client
   231  For specific client examples please see the man page for the specific Docker
   232  command. For example:
   233  
   234      man docker-run
   235  
   236  # HISTORY
   237  April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.com source material and internal work.