Browse code

update the docs to reflect the nice \n handling

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)

Sven Dowideit authored on 2014/05/07 08:40:49
Showing 2 changed files
... ...
@@ -809,33 +809,39 @@ Run a command in a new container
809 809
 
810 810
     Usage: docker run [OPTIONS] IMAGE[:TAG] [COMMAND] [ARG...]
811 811
 
812
-    -a, --attach=[]: Attach to stdin, stdout or stderr.
813
-    -c, --cpu-shares=0: CPU shares (relative weight)
814
-    --cidfile="": Write the container ID to the file
815
-    -d, --detach=false: Detached mode: Run container in the background, print new container id
816
-    --dns=[]: Set custom dns servers
817
-    --dns-search=[]: Set custom dns search domains
818
-    -e, --env=[]: Set environment variables
819
-    --entrypoint="": Overwrite the default entrypoint of the image
820
-    --env-file=[]: Read in a line delimited file of ENV variables
821
-    --expose=[]: Expose a port from the container without publishing it to your host
822
-    -h, --hostname="": Container host name
823
-    -i, --interactive=false: Keep stdin open even if not attached
824
-    --link=[]: Add link to another container (name:alias)
825
-    --lxc-conf=[]: (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
826
-    -m, --memory="": Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
827
-    --name="": Assign a name to the container
828
-    --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
829
-    -P, --publish-all=false: Publish all exposed ports to the host interfaces
830
-    -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)
831
-    --privileged=false: Give extended privileges to this container
832
-    --rm=false: Automatically remove the container when it exits (incompatible with -d)
833
-    --sig-proxy=true: Proxify all received signal to the process (even in non-tty mode)
834
-    -t, --tty=false: Allocate a pseudo-tty
835
-    -u, --user="": Username or UID
836
-    -v, --volume=[]: Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container)
837
-    --volumes-from=[]: Mount volumes from the specified container(s)
838
-    -w, --workdir="": Working directory inside the container
812
+    -a, --attach=[]            Attach to stdin, stdout or stderr.
813
+    -c, --cpu-shares=0         CPU shares (relative weight)
814
+    --cidfile=""               Write the container ID to the file
815
+    -d, --detach=false         Detached mode: Run container in the background, print new container id
816
+    --dns=[]                   Set custom dns servers
817
+    --dns-search=[]            Set custom dns search domains
818
+    -e, --env=[]               Set environment variables
819
+    --entrypoint=""            Overwrite the default entrypoint of the image
820
+    --env-file=[]              Read in a line delimited file of ENV variables
821
+    --expose=[]                Expose a port from the container without publishing it to your host
822
+    -h, --hostname=""          Container host name
823
+    -i, --interactive=false    Keep stdin open even if not attached
824
+    --link=[]                  Add link to another container (name:alias)
825
+    --lxc-conf=[]              (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
826
+    -m, --memory=""            Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
827
+    --name=""                  Assign a name to the container
828
+    --net="bridge"             Set the Network mode for the container
829
+                                 'bridge': creates a new network stack for the container on the docker bridge
830
+                                 'none': no networking for this container
831
+                                 'container:<name|id>': reuses another container network stack
832
+                                 'host': use the host network stack inside the contaner
833
+    -p, --publish=[]           Publish a container's port to the host
834
+                                 format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort
835
+                                 (use 'docker port' to see the actual mapping)
836
+    -P, --publish-all=false    Publish all exposed ports to the host interfaces
837
+    --privileged=false         Give extended privileges to this container
838
+    --rm=false                 Automatically remove the container when it exits (incompatible with -d)
839
+    --sig-proxy=true           Proxify all received signal to the process (even in non-tty mode)
840
+    -t, --tty=false            Allocate a pseudo-tty
841
+    -u, --user=""              Username or UID
842
+    -v, --volume=[]            Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container)
843
+    --volumes-from=[]          Mount volumes from the specified container(s)
844
+    -w, --workdir=""           Working directory inside the container
839 845
 
840 846
 The `docker run` command first `creates` a writeable container layer over the
841 847
 specified image, and then `starts` it using the specified command. That is,
... ...
@@ -138,6 +138,11 @@ PID files):
138 138
 
139 139
     --dns=[]      : Set custom dns servers for the container
140 140
     --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
141
+    --net="bridge"             Set the Network mode for the container
142
+                                 'bridge': creates a new network stack for the container on the docker bridge
143
+                                 'none': no networking for this container
144
+                                 'container:<name|id>': reuses another container network stack
145
+                                 'host': use the host network stack inside the contaner
141 146
 
142 147
 By default, all containers have networking enabled and they can make any
143 148
 outgoing connections. The operator can completely disable networking