瀏覽代碼

Updated output from the docker cli help

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
SvenDowideit 10 年之前
父節點
當前提交
cb6b196ab4
共有 2 個文件被更改,包括 62 次插入44 次删除
  1. 10 1
      docs/man/docker-create.1.md
  2. 52 43
      docs/sources/reference/commandline/cli.md

+ 10 - 1
docs/man/docker-create.1.md

@@ -7,6 +7,7 @@ docker-create - Create a new container
 # SYNOPSIS
 **docker create**
 [**-a**|**--attach**[=*[]*]]
+[**--add-host**[=*[]*]]
 [**-c**|**--cpu-shares**[=*0*]]
 [**--cap-add**[=*[]*]]
 [**--cap-drop**[=*[]*]]
@@ -29,6 +30,7 @@ docker-create - Create a new container
 [**-P**|**--publish-all**[=*false*]]
 [**-p**|**--publish**[=*[]*]]
 [**--privileged**[=*false*]]
+[**--restart**[=*RESTART*]]
 [**-t**|**--tty**[=*false*]]
 [**-u**|**--user**[=*USER*]]
 [**-v**|**--volume**[=*[]*]]
@@ -40,6 +42,9 @@ docker-create - Create a new container
 **-a**, **--attach**=[]
    Attach to STDIN, STDOUT or STDERR.
 
+**--add-host**=[]
+   Add a custom host-to-IP mapping (host:ip)
+
 **-c**, **--cpu-shares**=0
    CPU shares (relative weight)
 
@@ -106,12 +111,15 @@ docker-create - Create a new container
 
 **-p**, **--publish**=[]
    Publish a container's port to the host
-                               format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort
+                               format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort
                                (use 'docker port' to see the actual mapping)
 
 **--privileged**=*true*|*false*
    Give extended privileges to this container. The default is *false*.
 
+**--restart**=""
+   Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
+
 **-t**, **--tty**=*true*|*false*
    Allocate a pseudo-TTY. The default is *false*.
 
@@ -129,3 +137,4 @@ docker-create - Create a new container
 
 # HISTORY
 August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+September 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

+ 52 - 43
docs/sources/reference/commandline/cli.md

@@ -49,27 +49,30 @@ expect an integer, and they can only be specified once.
 
 ## daemon
 
-    Usage of docker:
+    Usage: docker [OPTIONS] COMMAND [arg...]
+
+    A self-sufficient runtime for linux containers.
+
+    Options:
       --api-enable-cors=false                    Enable CORS headers in the remote API
       -b, --bridge=""                            Attach containers to a pre-existing network bridge
                                                    use 'none' to disable container networking
       --bip=""                                   Use this CIDR notation address for the network bridge's IP, not compatible with -b
-      --fixed-cidr=""                            IPv4 subnet for fixed IPs (ex: 10.20.0.0/16)
-                                                   this subnet must be nested in the bridge subnet (which is defined by -b or --bip)
       -D, --debug=false                          Enable debug mode
       -d, --daemon=false                         Enable daemon mode
       --dns=[]                                   Force Docker to use specific DNS servers
       --dns-search=[]                            Force Docker to use specific DNS search domains
       -e, --exec-driver="native"                 Force the Docker runtime to use a specific exec driver
+      --fixed-cidr=""                            IPv4 subnet for fixed IPs (ex: 10.20.0.0/16)
+                                                   this subnet must be nested in the bridge subnet (which is defined by -b or --bip)
       -G, --group="docker"                       Group to assign the unix socket specified by -H when running in daemon mode
                                                    use '' (the empty string) to disable setting of a group
       -g, --graph="/var/lib/docker"              Path to use as the root of the Docker runtime
-      -H, --host=[]                              The socket(s) to bind to in daemon mode
-                                                   specified using one or more tcp://host:port, unix:///path/to/socket, fd://* or fd://socketfd.
+      -H, --host=[]                              The socket(s) to bind to in daemon mode or connect to in client mode, specified using one or more tcp://host:port, unix:///path/to/socket, fd://* or fd://socketfd.
       --icc=true                                 Enable inter-container communication
       --ip=0.0.0.0                               Default IP address to use when binding container ports
       --ip-forward=true                          Enable net.ipv4.ip_forward
-      --ip-masq=true                             Enable IP masquerading for bridge's IP range.
+      --ip-masq=true                             Enable IP masquerading for bridge's IP range
       --iptables=true                            Enable Docker's addition of iptables rules
       --mtu=0                                    Set the containers network MTU
                                                    if no value is provided: default to the default route MTU or 1500 if no default route is available
@@ -85,6 +88,7 @@ expect an integer, and they can only be specified once.
       --tlsverify=false                          Use TLS and verify the remote (daemon: verify client, client: verify daemon)
       -v, --version=false                        Print version information and quit
 
+
 Options with [] may be specified multiple times.
 
 The Docker daemon is the persistent process that manages containers.
@@ -377,45 +381,50 @@ path.  Paths are relative to the root of the filesystem.
 
     Copy files/folders from the PATH to the HOSTPATH
 
-
 ## create
 
 Creates a new container.
 
-    Usage: docker create [OPTIONS] IMAGE[:TAG] [COMMAND] [ARG...]
-
-
-    -a, --attach=[]            Attach to STDIN, STDOUT, STDERR.
-    -c, --cpu-shares=0         CPU shares (relative weight)
-    --cidfile=""               Write the container ID to the file
-    --dns=[]                   Set custom DNS servers
-    --dns-search=[]            Set custom DNS search domains
-    -e, --env=[]               Set environment variables
-    --entrypoint=""            Overwrite the default entrypoint of the image
-    --env-file=[]              Read in a line delimited file of environment variables
-    --expose=[]                Expose a port from the container without publishing it to your host
-    -h, --hostname=""          Container host name
-    -i, --interactive=false    Keep `STDIN` open even if not attached
-    --link=[]                  Add link to another container (name:alias)
-    --lxc-conf=[]              (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
-    -m, --memory=""            Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
-    --name=""                  Assign a name to the container
-    --net="bridge"             Set the Network mode for the container
-                                 'bridge': creates a new network stack for the container on the docker bridge
-                                 'none': no networking for this container
-                                 'container:<name|id>': reuses another container network stack
-                                 'host': use the host network stack inside the container
-    -p, --publish=[]           Publish a container's port to the host
-                                 format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort
-                                 (use 'docker port' to see the actual mapping)
-    -P, --publish-all=false    Publish all exposed ports to the host interfaces
-    --privileged=false         Give extended privileges to this container
-    -t, --tty=false            Allocate a pseudo-TTY
-    -u, --user=""              Username or UID
-    -v, --volume=[]            Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container)
-    --volumes-from=[]          Mount volumes from the specified container(s)
-    -w, --workdir=""           Working directory inside the container
+    Usage: docker create [OPTIONS] IMAGE [COMMAND] [ARG...]
+
+    Create a new container
 
+      -a, --attach=[]            Attach to STDIN, STDOUT or STDERR.
+      --add-host=[]              Add a custom host-to-IP mapping (host:ip)
+      -c, --cpu-shares=0         CPU shares (relative weight)
+      --cap-add=[]               Add Linux capabilities
+      --cap-drop=[]              Drop Linux capabilities
+      --cidfile=""               Write the container ID to the file
+      --cpuset=""                CPUs in which to allow execution (0-3, 0,1)
+      --device=[]                Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc)
+      --dns=[]                   Set custom DNS servers
+      --dns-search=[]            Set custom DNS search domains
+      -e, --env=[]               Set environment variables
+      --entrypoint=""            Overwrite the default ENTRYPOINT of the image
+      --env-file=[]              Read in a line delimited file of environment variables
+      --expose=[]                Expose a port from the container without publishing it to your host
+      -h, --hostname=""          Container host name
+      -i, --interactive=false    Keep STDIN open even if not attached
+      --link=[]                  Add link to another container in the form of name:alias
+      --lxc-conf=[]              (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
+      -m, --memory=""            Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
+      --name=""                  Assign a name to the container
+      --net="bridge"             Set the Network mode for the container
+                                   'bridge': creates a new network stack for the container on the docker bridge
+                                   'none': no networking for this container
+                                   'container:<name|id>': reuses another container network stack
+                                   'host': use the host network stack inside the container.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
+      -P, --publish-all=false    Publish all exposed ports to the host interfaces
+      -p, --publish=[]           Publish a container's port to the host
+                                   format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort
+                                   (use 'docker port' to see the actual mapping)
+      --privileged=false         Give extended privileges to this container
+      --restart=""               Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
+      -t, --tty=false            Allocate a pseudo-TTY
+      -u, --user=""              Username or UID
+      -v, --volume=[]            Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
+      --volumes-from=[]          Mount volumes from the specified container(s)
+      -w, --workdir=""           Working directory inside the container
 
 The `docker create` command creates a writeable container layer over
 the specified image and prepares it for running the specified command.
@@ -509,11 +518,11 @@ You'll need two shells for this example.
 
 ## exec
 
-    Usage: docker exec CONTAINER COMMAND [ARG...]
+    Usage: docker exec [OPTIONS] CONTAINER COMMAND [ARG...]
 
     Run a command in an existing container
 
-      -d, --detach=false         Detached mode: run the process in the background and exit
+      -d, --detach=false         Detached mode: run command in the background
       -i, --interactive=false    Keep STDIN open even if not attached
       -t, --tty=false            Allocate a pseudo-TTY
 
@@ -1086,7 +1095,7 @@ removed before the image is removed.
       --cap-drop=[]              Drop Linux capabilities
       --cidfile=""               Write the container ID to the file
       --cpuset=""                CPUs in which to allow execution (0-3, 0,1)
-      -d, --detach=false         Detached mode: run container in the background and print new container ID
+      -d, --detach=false         Detached mode: run the container in the background and print the new container ID
       --device=[]                Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc)
       --dns=[]                   Set custom DNS servers
       --dns-search=[]            Set custom DNS search domains