Browse code

Add docs for `--memory-swap`.

Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)

Jessica Frazelle authored on 2015/01/20 09:16:36
Showing 2 changed files
... ...
@@ -28,6 +28,7 @@ docker-run - Run a command in a new container
28 28
 [**--link**[=*[]*]]
29 29
 [**--lxc-conf**[=*[]*]]
30 30
 [**-m**|**--memory**[=*MEMORY*]]
31
+[**--memory-swap**[=*MEMORY-SWAP]]
31 32
 [**--mac-address**[=*MAC-ADDRESS*]]
32 33
 [**--name**[=*NAME*]]
33 34
 [**--net**[=*"bridge"*]]
... ...
@@ -191,6 +192,11 @@ actual limit may be rounded up to a multiple of the operating system's page
191 191
 size, if it is not already. The memory limit should be formatted as follows:
192 192
 `<number><optional unit>`, where unit = b, k, m or g.
193 193
 
194
+**--memory-swap**=""
195
+    Total memory usage (memory + swap)
196
+
197
+    Set '-1' to disable swap (format: <number><optional unit>, where unit = b, k, m or g)
198
+
194 199
 **--mac-address**=""
195 200
    Container MAC address (e.g. 92:d0:c6:0a:29:33)
196 201
 
... ...
@@ -1605,6 +1605,7 @@ removed before the image is removed.
1605 1605
       --link=[]                  Add link to another container in the form of name:alias
1606 1606
       --lxc-conf=[]              (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
1607 1607
       -m, --memory=""            Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
1608
+      -memory-swap=""            Total memory usage (memory + swap), set '-1' to disable swap (format: <number><optional unit>, where unit = b, k, m or g)
1608 1609
       --mac-address=""           Container MAC address (e.g. 92:d0:c6:0a:29:33)
1609 1610
       --name=""                  Assign a name to the container
1610 1611
       --net="bridge"             Set the Network mode for the container