Browse Source

Update docker manpage

Signed-off-by: Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
Ma Shimiao 10 years ago
parent
commit
fa1fa50160
1 changed files with 35 additions and 18 deletions
  1. 35 18
      docs/man/docker.1.md

+ 35 - 18
docs/man/docker.1.md

@@ -23,34 +23,29 @@ its own man page which explain usage and arguments.
 To see the man page for a command run **man docker <command>**.
 To see the man page for a command run **man docker <command>**.
 
 
 # OPTIONS
 # OPTIONS
-**-D**=*true*|*false*
-   Enable debug mode. Default is false.
-
-**--help**
+**-h**, **--help**
   Print usage statement
   Print usage statement
 
 
-**-H**, **--host**=[unix:///var/run/docker.sock]: tcp://[host:port] to bind or
-unix://[/path/to/socket] to use.
-   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.
-
 **--api-cors-header**=""
 **--api-cors-header**=""
   Set CORS headers in the remote API. Default is cors disabled. Give urls like "http://foo, http://bar, ...". Give "*" to allow all.
   Set CORS headers in the remote API. Default is cors disabled. Give urls like "http://foo, http://bar, ...". Give "*" to allow all.
 
 
-**-b**=""
+**-b**, **--bridge**=""
   Attach containers to a pre\-existing network bridge; use 'none' to disable container networking
   Attach containers to a pre\-existing network bridge; use 'none' to disable container networking
 
 
 **--bip**=""
 **--bip**=""
   Use the provided CIDR notation address for the dynamically created bridge (docker0); Mutually exclusive of \-b
   Use the provided CIDR notation address for the dynamically created bridge (docker0); Mutually exclusive of \-b
 
 
-**-d**=*true*|*false*
+**-D**, **--debug**=*true*|*false*
+  Enable debug mode. Default is false.
+
+**-d**, **--daemon**=*true*|*false*
   Enable daemon mode. Default is false.
   Enable daemon mode. Default is false.
 
 
 **--dns**=""
 **--dns**=""
   Force Docker to use specific DNS servers
   Force Docker to use specific DNS servers
 
 
-**-g**=""
-  Path to use as the root of the Docker runtime. Default is `/var/lib/docker`.
+**-e**, **--exec-driver**=""
+  Force Docker to use specific exec driver. Default is `native`.
 
 
 **--fixed-cidr**=""
 **--fixed-cidr**=""
   IPv4 subnet for fixed IPs (e.g., 10.20.0.0/16); this subnet must be nested in the bridge subnet (which is defined by \-b or \-\-bip)
   IPv4 subnet for fixed IPs (e.g., 10.20.0.0/16); this subnet must be nested in the bridge subnet (which is defined by \-b or \-\-bip)
@@ -58,6 +53,18 @@ unix://[/path/to/socket] to use.
 **--fixed-cidr-v6**=""
 **--fixed-cidr-v6**=""
   IPv6 subnet for global IPv6 addresses (e.g., 2a00:1450::/64)
   IPv6 subnet for global IPv6 addresses (e.g., 2a00:1450::/64)
 
 
+**-G**, **--group**=""
+  Group to assign the unix socket specified by -H when running in daemon mode.
+  use '' (the empty string) to disable setting of a group. Default is `docker`.
+
+**-g**, **--graph**=""
+  Path to use as the root of the Docker runtime. Default is `/var/lib/docker`.
+
+**-H**, **--host**=[unix:///var/run/docker.sock]: tcp://[host:port] to bind or
+unix://[/path/to/socket] to use.
+  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.
+
 **--icc**=*true*|*false*
 **--icc**=*true*|*false*
   Allow unrestricted inter\-container and Docker daemon host communication. If disabled, containers can still be linked together using **--link** option (see **docker-run(1)**). Default is true.
   Allow unrestricted inter\-container and Docker daemon host communication. If disabled, containers can still be linked together using **--link** option (see **docker-run(1)**). Default is true.
 
 
@@ -71,7 +78,7 @@ unix://[/path/to/socket] to use.
   Enable IP masquerading for bridge's IP range. Default is true.
   Enable IP masquerading for bridge's IP range. Default is true.
 
 
 **--iptables**=*true*|*false*
 **--iptables**=*true*|*false*
-  Disable Docker's addition of iptables rules. Default is true.
+  Enable Docker's addition of iptables rules. Default is true.
 
 
 **--ipv6**=*true*|*false*
 **--ipv6**=*true*|*false*
   Enable IPv6 support. Default is false. Docker will create an IPv6-enabled bridge with address fe80::1 which will allow you to create IPv6-enabled containers. Use together with `--fixed-cidr-v6` to provide globally routable IPv6 addresses. IPv6 forwarding will be enabled if not used with `--ip-forward=false`. This may collide with your host's current IPv6 settings. For more information please consult the documentation about "Advanced Networking - IPv6".
   Enable IPv6 support. Default is false. Docker will create an IPv6-enabled bridge with address fe80::1 which will allow you to create IPv6-enabled containers. Use together with `--fixed-cidr-v6` to provide globally routable IPv6 addresses. IPv6 forwarding will be enabled if not used with `--ip-forward=false`. This may collide with your host's current IPv6 settings. For more information please consult the documentation about "Advanced Networking - IPv6".
@@ -83,21 +90,28 @@ unix://[/path/to/socket] to use.
   Set key=value labels to the daemon (displayed in `docker info`)
   Set key=value labels to the daemon (displayed in `docker info`)
 
 
 **--mtu**=VALUE
 **--mtu**=VALUE
-  Set the containers network mtu. Default is `1500`.
+  Set the containers network mtu. Default is `0`.
 
 
-**-p**=""
+**-p**, **--pidfile**=""
   Path to use for daemon PID file. Default is `/var/run/docker.pid`
   Path to use for daemon PID file. Default is `/var/run/docker.pid`
 
 
 **--registry-mirror**=<scheme>://<host>
 **--registry-mirror**=<scheme>://<host>
   Prepend a registry mirror to be used for image pulls. May be specified multiple times.
   Prepend a registry mirror to be used for image pulls. May be specified multiple times.
 
 
-**-s**=""
+**-s**, **--storage-driver**=""
   Force the Docker runtime to use a specific storage driver.
   Force the Docker runtime to use a specific storage driver.
 
 
 **--storage-opt**=[]
 **--storage-opt**=[]
   Set storage driver options. See STORAGE DRIVER OPTIONS.
   Set storage driver options. See STORAGE DRIVER OPTIONS.
 
 
-**-v**=*true*|*false*
+**-tls**=*true*|*false*
+  Use TLS; implied by --tlsverify. Default is false.
+
+**-tlsverify**=*true*|*false*
+  Use TLS and verify the remote (daemon: verify client, client: verify daemon).
+  Default is false.
+
+**-v**, **--version**=*true*|*false*
   Print version information and quit. Default is false.
   Print version information and quit. Default is false.
 
 
 **--selinux-enabled**=*true*|*false*
 **--selinux-enabled**=*true*|*false*
@@ -198,6 +212,9 @@ inside it)
 **docker-start(1)**
 **docker-start(1)**
   Start a stopped container
   Start a stopped container
 
 
+**docker-stats(1)**
+  Display a live stream of one or more containers' resource usage statistics
+
 **docker-stop(1)**
 **docker-stop(1)**
   Stop a running container
   Stop a running container