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