Browse code

Merge pull request #16744 from runcom/fix-mam-commandline

Fix man and commandline docs

Sebastiaan van Stijn authored on 2015/10/05 05:28:19
Showing 53 changed files
... ...
@@ -41,11 +41,11 @@ func (cli *DockerCli) forwardAllSignals(cid string) chan os.Signal {
41 41
 	return sigc
42 42
 }
43 43
 
44
-// CmdStart starts one or more stopped containers.
44
+// CmdStart starts one or more containers.
45 45
 //
46 46
 // Usage: docker start [OPTIONS] CONTAINER [CONTAINER...]
47 47
 func (cli *DockerCli) CmdStart(args ...string) error {
48
-	cmd := Cli.Subcmd("start", []string{"CONTAINER [CONTAINER...]"}, "Start one or more stopped containers", true)
48
+	cmd := Cli.Subcmd("start", []string{"CONTAINER [CONTAINER...]"}, "Start one or more containers", true)
49 49
 	attach := cmd.Bool([]string{"a", "-attach"}, false, "Attach STDOUT/STDERR and forward signals")
50 50
 	openStdin := cmd.Bool([]string{"i", "-interactive"}, false, "Attach container's STDIN")
51 51
 	cmd.Require(flag.Min, 1)
... ...
@@ -9,13 +9,13 @@ import (
9 9
 	flag "github.com/docker/docker/pkg/mflag"
10 10
 )
11 11
 
12
-// CmdStop stops one or more running containers.
12
+// CmdStop stops one or more containers.
13 13
 //
14 14
 // A running container is stopped by first sending SIGTERM and then SIGKILL if the container fails to stop within a grace period (the default is 10 seconds).
15 15
 //
16 16
 // Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
17 17
 func (cli *DockerCli) CmdStop(args ...string) error {
18
-	cmd := Cli.Subcmd("stop", []string{"CONTAINER [CONTAINER...]"}, "Stop a running container by sending SIGTERM and then SIGKILL after a\ngrace period", true)
18
+	cmd := Cli.Subcmd("stop", []string{"CONTAINER [CONTAINER...]"}, "Stop a container by sending SIGTERM and then SIGKILL after a\ngrace period", true)
19 19
 	nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Seconds to wait for stop before killing it")
20 20
 	cmd.Require(flag.Min, 1)
21 21
 
... ...
@@ -360,7 +360,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from search' -l no-trunc -d
360 360
 complete -c docker -A -f -n '__fish_seen_subcommand_from search' -s s -l stars -d 'Only displays with at least x stars'
361 361
 
362 362
 # start
363
-complete -c docker -f -n '__fish_docker_no_subcommand' -a start -d 'Start a stopped container'
363
+complete -c docker -f -n '__fish_docker_no_subcommand' -a start -d 'Start a container'
364 364
 complete -c docker -A -f -n '__fish_seen_subcommand_from start' -s a -l attach -d "Attach container's STDOUT and STDERR and forward all signals to the process"
365 365
 complete -c docker -A -f -n '__fish_seen_subcommand_from start' -l help -d 'Print usage'
366 366
 complete -c docker -A -f -n '__fish_seen_subcommand_from start' -s i -l interactive -d "Attach container's STDIN"
... ...
@@ -373,7 +373,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from stats' -l no-stream -d
373 373
 complete -c docker -A -f -n '__fish_seen_subcommand_from stats' -a '(__fish_print_docker_containers running)' -d "Container"
374 374
 
375 375
 # stop
376
-complete -c docker -f -n '__fish_docker_no_subcommand' -a stop -d 'Stop a running container'
376
+complete -c docker -f -n '__fish_docker_no_subcommand' -a stop -d 'Stop a container'
377 377
 complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -l help -d 'Print usage'
378 378
 complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -s t -l time -d 'Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.'
379 379
 complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -a '(__fish_print_docker_containers running)' -d "Container"
... ...
@@ -52,9 +52,9 @@ var dockerCommands = []command{
52 52
 	{"run", "Run a command in a new container"},
53 53
 	{"save", "Save an image(s) to a tar archive"},
54 54
 	{"search", "Search the Docker Hub for images"},
55
-	{"start", "Start one or more stopped containers"},
55
+	{"start", "Start one or more containers"},
56 56
 	{"stats", "Display a live stream of container(s) resource usage statistics"},
57
-	{"stop", "Stop a running container"},
57
+	{"stop", "Stop a container"},
58 58
 	{"tag", "Tag an image into a repository"},
59 59
 	{"top", "Display the running processes of a container"},
60 60
 	{"unpause", "Unpause all processes within a container"},
... ...
@@ -15,6 +15,7 @@ weight=1
15 15
 
16 16
     Attach to a running container
17 17
 
18
+      --help=false        Print usage
18 19
       --no-stdin=false    Do not attach STDIN
19 20
       --sig-proxy=true    Proxy all received signals to the process
20 21
 
... ...
@@ -15,21 +15,25 @@ weight=1
15 15
 
16 16
     Build a new image from the source code at PATH
17 17
 
18
-      -f, --file=""            Name of the Dockerfile (Default is 'PATH/Dockerfile')
19
-      --force-rm=false         Always remove intermediate containers
20
-      --build-arg=[]           Set build-time variables
21
-      --no-cache=false         Do not use cache when building the image
22
-      --pull=false             Always attempt to pull a newer version of the image
23
-      -q, --quiet=false        Suppress the verbose output generated by the containers
24
-      --rm=true                Remove intermediate containers after a successful build
25
-      -t, --tag=""             Repository name (and optionally a tag) for the image
26
-      -m, --memory=""          Memory limit for all build containers
27
-      --memory-swap=""         Total memory (memory + swap), `-1` to disable swap
28
-      -c, --cpu-shares         CPU Shares (relative weight)
29
-      --cpuset-mems=""         MEMs in which to allow execution, e.g. `0-3`, `0,1`
30
-      --cpuset-cpus=""         CPUs in which to allow execution, e.g. `0-3`, `0,1`
31
-      --cgroup-parent=""       Optional parent cgroup for the container
32
-      --ulimit=[]              Ulimit options
18
+      --build-arg=[]                  Set build-time variables
19
+      -c, --cpu-shares                CPU Shares (relative weight)
20
+      --cgroup-parent=""              Optional parent cgroup for the container
21
+      --cpu-period=0                  Limit the CPU CFS (Completely Fair Scheduler) period
22
+      --cpu-quota=0                   Limit the CPU CFS (Completely Fair Scheduler) quota
23
+      --cpuset-cpus=""                CPUs in which to allow execution, e.g. `0-3`, `0,1`
24
+      --cpuset-mems=""                MEMs in which to allow execution, e.g. `0-3`, `0,1`
25
+      --disable-content-trust=true    Skip image verification
26
+      -f, --file=""                   Name of the Dockerfile (Default is 'PATH/Dockerfile')
27
+      --force-rm=false                Always remove intermediate containers
28
+      --help=false                    Print usage
29
+      -m, --memory=""                 Memory limit for all build containers
30
+      --memory-swap=""                Total memory (memory + swap), `-1` to disable swap
31
+      --no-cache=false                Do not use cache when building the image
32
+      --pull=false                    Always attempt to pull a newer version of the image
33
+      -q, --quiet=false               Suppress the verbose output generated by the containers
34
+      --rm=true                       Remove intermediate containers after a successful build
35
+      -t, --tag=""                    Repository name (and optionally a tag) for the image
36
+      --ulimit=[]                     Ulimit options
33 37
 
34 38
 Builds Docker images from a Dockerfile and a "context". A build's context is
35 39
 the files located in the specified `PATH` or `URL`. The build process can refer
... ...
@@ -17,6 +17,7 @@ weight=1
17 17
 
18 18
       -a, --author=""     Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
19 19
       -c, --change=[]     Apply specified Dockerfile instructions while committing the image
20
+      --help=false        Print usage
20 21
       -m, --message=""    Commit message
21 22
       -p, --pause=true    Pause container during commit
22 23
 
... ...
@@ -11,12 +11,12 @@ weight=1
11 11
 
12 12
 # cp
13 13
 
14
-Copy files/folders between a container and the local filesystem.
14
+    Usage: docker cp [OPTIONS] CONTAINER:PATH LOCALPATH|-
15
+           docker cp [OPTIONS] LOCALPATH|- CONTAINER:PATH
15 16
 
16
-    Usage:  docker cp [options] CONTAINER:PATH LOCALPATH|-
17
-            docker cp [options] LOCALPATH|- CONTAINER:PATH
17
+    Copy files/folders between a container and the local filesystem
18 18
 
19
-    --help  Print usage statement
19
+      --help=false        Print usage
20 20
 
21 21
 In the first synopsis form, the `docker cp` utility copies the contents of
22 22
 `PATH` from the filesystem of `CONTAINER` to the `LOCALPATH` (or stream as
... ...
@@ -30,6 +30,7 @@ Creates a new container.
30 30
       --cpuset-cpus=""              CPUs in which to allow execution (0-3, 0,1)
31 31
       --cpuset-mems=""              Memory nodes (MEMs) in which to allow execution (0-3, 0,1)
32 32
       --device=[]                   Add a host device to the container
33
+      --disable-content-trust=true  Skip image verification
33 34
       --dns=[]                      Set custom DNS servers
34 35
       --dns-opt=[]                  Set custom DNS options
35 36
       --dns-search=[]               Set custom DNS search domains
... ...
@@ -37,6 +38,7 @@ Creates a new container.
37 37
       --entrypoint=""               Overwrite the default ENTRYPOINT of the image
38 38
       --env-file=[]                 Read in a file of environment variables
39 39
       --expose=[]                   Expose a port or a range of ports
40
+      --group-add=[]                Add additional groups to join
40 41
       -h, --hostname=""             Container host name
41 42
       --help=false                  Print usage
42 43
       -i, --interactive=false       Keep STDIN open even if not attached
... ...
@@ -54,7 +56,7 @@ Creates a new container.
54 54
       --memory-swap=""              Total memory (memory + swap), '-1' to disable swap
55 55
       --memory-swappiness=""        Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
56 56
       --name=""                     Assign a name to the container
57
-      --net="bridge"                Set the Network mode for the container
57
+      --net="default"               Set the Network mode for the container
58 58
       --oom-kill-disable=false      Whether to disable OOM Killer for the container or not
59 59
       -P, --publish-all=false       Publish all exposed ports to random ports
60 60
       -p, --publish=[]              Publish a container's port(s) to the host
... ...
@@ -65,7 +67,6 @@ Creates a new container.
65 65
       --security-opt=[]             Security options
66 66
       --stop-signal="SIGTERM"       Signal to stop a container
67 67
       -t, --tty=false               Allocate a pseudo-TTY
68
-      --disable-content-trust=true  Skip image verification
69 68
       -u, --user=""                 Username or UID
70 69
       --ulimit=[]                   Ulimit options
71 70
       --uts=""                      UTS namespace to use
... ...
@@ -11,10 +11,12 @@ weight=1
11 11
 
12 12
 # diff
13 13
 
14
-    Usage: docker diff CONTAINER
14
+    Usage: docker diff [OPTIONS] CONTAINER
15 15
 
16 16
     Inspect changes on a container's filesystem
17 17
 
18
+      --help=false        Print usage
19
+
18 20
 List the changed files and directories in a container᾿s filesystem
19 21
  There are 3 events that are listed in the `diff`:
20 22
 
... ...
@@ -16,6 +16,7 @@ weight=1
16 16
     Get real time events from the server
17 17
 
18 18
       -f, --filter=[]    Filter output based on conditions provided
19
+      --help=false       Print usage
19 20
       --since=""         Show all events created since timestamp
20 21
       --until=""         Stream events until this timestamp
21 22
 
... ...
@@ -16,6 +16,7 @@ weight=1
16 16
     Run a command in a running container
17 17
 
18 18
       -d, --detach=false         Detached mode: run command in the background
19
+      --help=false               Print usage
19 20
       -i, --interactive=false    Keep STDIN open even if not attached
20 21
       --privileged=false         Give extended Linux capabilities to the command
21 22
       -t, --tty=false            Allocate a pseudo-TTY
... ...
@@ -12,21 +12,11 @@ weight=1
12 12
 # export
13 13
 
14 14
     Usage: docker export [OPTIONS] CONTAINER
15
-    
16
-      Export the contents of a filesystem to a tar archive (streamed to STDOUT by default).
17 15
 
18
-      -o, --output=""    Write to a file, instead of STDOUT
19
-
20
-      Produces a tarred repository to the standard output stream.
21
-
22
-
23
- For example:
16
+    Export the contents of a container's filesystem as a tar archive
24 17
 
25
-    $ docker export red_panda > latest.tar
26
-
27
-   Or
28
-
29
-    $ docker export --output="latest.tar" red_panda
18
+      --help=false       Print usage
19
+      -o, --output=""    Write to a file, instead of STDOUT
30 20
 
31 21
 The `docker export` command does not export the contents of volumes associated
32 22
 with the container. If a volume is mounted on top of an existing directory in
... ...
@@ -36,3 +26,11 @@ directory, not the contents of the volume.
36 36
 Refer to [Backup, restore, or migrate data
37 37
 volumes](/userguide/dockervolumes/#backup-restore-or-migrate-data-volumes) in
38 38
 the user guide for examples on exporting data in a volume.
39
+
40
+## Examples
41
+
42
+    $ docker export red_panda > latest.tar
43
+
44
+Or
45
+
46
+    $ docker export --output="latest.tar" red_panda
... ...
@@ -16,6 +16,7 @@ weight=1
16 16
     Show the history of an image
17 17
 
18 18
       -H, --human=true     Print sizes and dates in human readable format
19
+      --help=false         Print usage
19 20
       --no-trunc=false     Don't truncate output
20 21
       -q, --quiet=false    Only show numeric IDs
21 22
 
... ...
@@ -18,6 +18,7 @@ weight=1
18 18
 	optionally tag it.
19 19
 
20 20
       -c, --change=[]     Apply specified Dockerfile instructions while importing the image
21
+      --help=false        Print usage
21 22
       -m, --message=      Set commit message for imported image
22 23
 
23 24
 You can specify a `URL` or `-` (dash) to take data directly from `STDIN`. The
... ...
@@ -12,10 +12,12 @@ weight=1
12 12
 # info
13 13
 
14 14
 
15
-    Usage: docker info
15
+    Usage: docker info [OPTIONS]
16 16
 
17 17
     Display system-wide information
18 18
 
19
+      --help=false        Print usage
20
+
19 21
 For example:
20 22
 
21 23
     $ docker -D info
... ...
@@ -15,10 +15,10 @@ weight=1
15 15
 
16 16
     Return low-level information on a container or image
17 17
 
18
-      -f, --format=""    Format the output using the given go template
19
-
20
-     --type=container|image  Return JSON for specified type, permissible 
21
-                             values are "image" or "container"
18
+      -f, --format=""         Format the output using the given go template
19
+      --help=false            Print usage
20
+      --type=container|image  Return JSON for specified type, permissible
21
+                              values are "image" or "container"
22 22
 
23 23
 By default, this will render all results in a JSON array. If a format is
24 24
 specified, the given template will be executed for each result.
... ...
@@ -15,6 +15,7 @@ weight=1
15 15
 
16 16
     Kill a running container using SIGKILL or a specified signal
17 17
 
18
+      --help=false           Print usage
18 19
       -s, --signal="KILL"    Signal to send to the container
19 20
 
20 21
 The main process inside the container will be sent `SIGKILL`, or any
... ...
@@ -15,6 +15,7 @@ weight=1
15 15
 
16 16
     Load an image from a tar archive or STDIN
17 17
 
18
+      --help=false       Print usage
18 19
       -i, --input=""     Read from a tar archive file, instead of STDIN. The tarball may be compressed with gzip, bzip, or xz
19 20
 
20 21
 Loads a tarred repository from a file or the standard input stream.
... ...
@@ -17,6 +17,7 @@ weight=1
17 17
 	specified "https://index.docker.io/v1/" is the default.
18 18
 
19 19
       -e, --email=""       Email
20
+      --help=false         Print usage
20 21
       -p, --password=""    Password
21 22
       -u, --username=""    Username
22 23
 
... ...
@@ -16,6 +16,8 @@ weight=1
16 16
     Log out from a Docker registry, if no server is
17 17
 	specified "https://index.docker.io/v1/" is the default.
18 18
 
19
+      --help=false    Print usage
20
+
19 21
 For example:
20 22
 
21 23
     $ docker logout localhost:8080
... ...
@@ -16,6 +16,7 @@ weight=1
16 16
     Fetch the logs of a container
17 17
 
18 18
       -f, --follow=false        Follow log output
19
+      --help=false              Print usage
19 20
       --since=""                Show logs since timestamp
20 21
       -t, --timestamps=false    Show timestamps
21 22
       --tail="all"              Number of lines to show from the end of the logs
... ...
@@ -11,10 +11,12 @@ weight=1
11 11
 
12 12
 # pause
13 13
 
14
-    Usage: docker pause CONTAINER [CONTAINER...]
14
+    Usage: docker pause [OPTIONS] CONTAINER [CONTAINER...]
15 15
 
16 16
     Pause all processes within a container
17 17
 
18
+      --help=false    Print usage
19
+
18 20
 The `docker pause` command uses the cgroups freezer to suspend all processes in
19 21
 a container. Traditionally, when suspending a process the `SIGSTOP` signal is
20 22
 used, which is observable by the process being suspended. With the cgroups freezer
... ...
@@ -11,11 +11,13 @@ weight=1
11 11
 
12 12
 # port
13 13
 
14
-    Usage: docker port CONTAINER [PRIVATE_PORT[/PROTO]]
14
+    Usage: docker port [OPTIONS] CONTAINER [PRIVATE_PORT[/PROTO]]
15 15
 
16 16
     List port mappings for the CONTAINER, or lookup the public-facing port that is
17 17
 	NAT-ed to the PRIVATE_PORT
18 18
 
19
+      --help=false    Print usage
20
+
19 21
 You can find out all the ports mapped by not specifying a `PRIVATE_PORT`, or
20 22
 just a specific mapping:
21 23
 
... ...
@@ -18,13 +18,14 @@ weight=1
18 18
       -a, --all=false       Show all containers (default shows just running)
19 19
       --before=""           Show only container created before Id or Name
20 20
       -f, --filter=[]       Filter output based on conditions provided
21
+      --format=[]           Pretty-print containers using a Go template
22
+      --help=false          Print usage
21 23
       -l, --latest=false    Show the latest created container, include non-running
22 24
       -n=-1                 Show n last created containers, include non-running
23 25
       --no-trunc=false      Don't truncate output
24 26
       -q, --quiet=false     Only display numeric IDs
25 27
       -s, --size=false      Display total file sizes
26 28
       --since=""            Show created since Id or Name, include non-running
27
-      --format=[]       Pretty-print containers using a Go template
28 29
 
29 30
 Running `docker ps --no-trunc` showing 2 linked containers.
30 31
 
... ...
@@ -17,6 +17,7 @@ weight=1
17 17
 
18 18
       -a, --all-tags=false          Download all tagged images in the repository
19 19
       --disable-content-trust=true  Skip image verification
20
+      --help=false                  Print usage
20 21
 
21 22
 Most of your images will be created on top of a base image from the
22 23
 [Docker Hub](https://hub.docker.com) registry.
... ...
@@ -11,11 +11,12 @@ weight=1
11 11
 
12 12
 # push
13 13
 
14
-    Usage: docker push NAME[:TAG]
14
+    Usage: docker push [OPTIONS] NAME[:TAG]
15 15
 
16 16
     Push an image or a repository to the registry
17 17
 
18
-    --disable-content-trust=true   Skip image signing
18
+      --disable-content-trust=true   Skip image signing
19
+      --help=false                   Print usage
19 20
 
20 21
 Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com)
21 22
 registry or to a self-hosted one.
... ...
@@ -11,8 +11,10 @@ weight=1
11 11
 
12 12
 # rename
13 13
 
14
-    Usage: docker rename OLD_NAME NEW_NAME
14
+    Usage: docker rename [OPTIONS] OLD_NAME NEW_NAME
15 15
 
16
-    rename a existing container to a NEW_NAME
16
+    Rename a container
17
+
18
+      --help=false    Print usage
17 19
 
18 20
 The `docker rename` command allows the container to be renamed to a different name.
... ...
@@ -15,5 +15,6 @@ weight=1
15 15
 
16 16
     Restart a container
17 17
 
18
+      --help=false       Print usage
18 19
       -t, --time=10      Seconds to wait for stop before killing the container
19 20
 
... ...
@@ -16,6 +16,7 @@ weight=1
16 16
     Remove one or more containers
17 17
 
18 18
       -f, --force=false      Force the removal of a running container (uses SIGKILL)
19
+      --help=false           Print usage
19 20
       -l, --link=false       Remove the specified link
20 21
       -v, --volumes=false    Remove the volumes associated with the container
21 22
 
... ...
@@ -16,9 +16,9 @@ weight=1
16 16
     Remove one or more images
17 17
 
18 18
       -f, --force=false    Force removal of the image
19
+      --help=false         Print usage
19 20
       --no-prune=false     Do not delete untagged parents
20 21
 
21
-
22 22
 You can remove an image using its short or long ID, its tag, or its digest. If
23 23
 an image has one or more tag or digest reference, you must remove all of them
24 24
 before the image is removed.
... ...
@@ -29,6 +29,7 @@ weight=1
29 29
       --cpuset-mems=""              Memory nodes (MEMs) in which to allow execution (0-3, 0,1)
30 30
       -d, --detach=false            Run container in background and print container ID
31 31
       --device=[]                   Add a host device to the container
32
+      --disable-content-trust=true  Skip image verification
32 33
       --dns=[]                      Set custom DNS servers
33 34
       --dns-opt=[]                  Set custom DNS options
34 35
       --dns-search=[]               Set custom DNS search domains
... ...
@@ -54,7 +55,7 @@ weight=1
54 54
       --memory-swap=""              Total memory (memory + swap), '-1' to disable swap
55 55
       --memory-swappiness=""        Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
56 56
       --name=""                     Assign a name to the container
57
-      --net="bridge"                Set the Network mode for the container
57
+      --net="default"               Set the Network mode for the container
58 58
       --oom-kill-disable=false      Whether to disable OOM Killer for the container or not
59 59
       -P, --publish-all=false       Publish all exposed ports to random ports
60 60
       -p, --publish=[]              Publish a container's port(s) to the host
... ...
@@ -64,12 +65,11 @@ weight=1
64 64
       --restart="no"                Restart policy (no, on-failure[:max-retry], always, unless-stopped)
65 65
       --rm=false                    Automatically remove the container when it exits
66 66
       --security-opt=[]             Security Options
67
-      --stop-signal="SIGTERM"       Signal to stop a container
68 67
       --sig-proxy=true              Proxy received signals to the process
68
+      --stop-signal="SIGTERM"       Signal to stop a container
69 69
       -t, --tty=false               Allocate a pseudo-TTY
70 70
       -u, --user=""                 Username or UID (format: <name|uid>[:<group|gid>])
71 71
       --ulimit=[]                   Ulimit options
72
-      --disable-content-trust=true  Skip image verification
73 72
       --uts=""                      UTS namespace to use
74 73
       -v, --volume=[]               Bind mount a volume
75 74
       --volumes-from=[]             Mount volumes from the specified container(s)
... ...
@@ -15,6 +15,7 @@ weight=1
15 15
 
16 16
     Save an image(s) to a tar archive (streamed to STDOUT by default)
17 17
 
18
+      --help=false       Print usage
18 19
       -o, --output=""    Write to a file, instead of STDOUT
19 20
 
20 21
 Produces a tarred repository to the standard output stream.
... ...
@@ -16,6 +16,7 @@ weight=1
16 16
     Search the Docker Hub for images
17 17
 
18 18
       --automated=false    Only show automated builds
19
+      --help=false         Print usage
19 20
       --no-trunc=false     Don't truncate output
20 21
       -s, --stars=0        Only displays with at least x stars
21 22
 
... ...
@@ -13,8 +13,9 @@ weight=1
13 13
 
14 14
     Usage: docker start [OPTIONS] CONTAINER [CONTAINER...]
15 15
 
16
-    Start one or more stopped containers
16
+    Start one or more containers
17 17
 
18 18
       -a, --attach=false         Attach STDOUT/STDERR and forward signals
19
+      --help=false               Print usage
19 20
       -i, --interactive=false    Attach container's STDIN
20 21
 
... ...
@@ -11,7 +11,7 @@ weight=1
11 11
 
12 12
 # stats
13 13
 
14
-    Usage: docker stats CONTAINER [CONTAINER...]
14
+    Usage: docker stats [OPTIONS] CONTAINER [CONTAINER...]
15 15
 
16 16
     Display a live stream of one or more containers' resource usage statistics
17 17
 
... ...
@@ -13,10 +13,11 @@ weight=1
13 13
 
14 14
     Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
15 15
 
16
-    Stop a running container by sending SIGTERM and then SIGKILL after a
16
+    Stop a container by sending SIGTERM and then SIGKILL after a
17 17
     grace period
18 18
 
19
+      --help=false       Print usage
19 20
       -t, --time=10      Seconds to wait for stop before killing it
20 21
 
21 22
 The main process inside the container will receive `SIGTERM`, and after a grace
22
-period, `SIGKILL`.
23 23
\ No newline at end of file
24
+period, `SIGKILL`.
... ...
@@ -16,6 +16,7 @@ weight=1
16 16
     Tag an image into a repository
17 17
 
18 18
       -f, --force=false    Force
19
+      --help=false         Print usage
19 20
 
20 21
 You can group your images together using names and tags, and then upload them
21 22
 to [*Share Images via Repositories*](/userguide/dockerrepos/#contributing-to-docker-hub).
... ...
@@ -11,6 +11,8 @@ weight=1
11 11
 
12 12
 # top
13 13
 
14
-    Usage: docker top CONTAINER [ps OPTIONS]
14
+    Usage: docker top [OPTIONS] CONTAINER [ps OPTIONS]
15 15
 
16
-    Display the running processes of a container
17 16
\ No newline at end of file
17
+    Display the running processes of a container
18
+
19
+      --help=false    Print usage
... ...
@@ -11,10 +11,12 @@ weight=1
11 11
 
12 12
 # unpause
13 13
 
14
-    Usage: docker unpause CONTAINER [CONTAINER...]
14
+    Usage: docker unpause [OPTIONS] CONTAINER [CONTAINER...]
15 15
 
16 16
     Unpause all processes within a container
17 17
 
18
+      --help=false    Print usage
19
+
18 20
 The `docker unpause` command uses the cgroups freezer to un-suspend all
19 21
 processes in a container.
20 22
 
... ...
@@ -16,6 +16,7 @@ weight=1
16 16
     Show the Docker version information.
17 17
 
18 18
       -f, --format=""    Format the output using the given go template
19
+      --help=false       Print usage
19 20
 
20 21
 By default, this will render all version information in an easy to read
21 22
 layout. If a format is specified, the given template will be executed instead.
... ...
@@ -14,10 +14,10 @@ parent = "smn_cli"
14 14
 
15 15
     Create a volume
16 16
 
17
-    -d, --driver=local    Specify volume driver name
18
-    --help=false          Print usage
19
-    --name=               Specify volume name
20
-    -o, --opt=map[]       Set driver specific options
17
+      -d, --driver=local    Specify volume driver name
18
+      --help=false          Print usage
19
+      --name=               Specify volume name
20
+      -o, --opt=map[]       Set driver specific options
21 21
 
22 22
 Creates a new volume that containers can consume and store data in. If a name is not specified, Docker generates a random name. You create a volume and then configure the container to use it, for example:
23 23
 
... ...
@@ -25,7 +25,7 @@ Creates a new volume that containers can consume and store data in. If a name is
25 25
   hello
26 26
   $ docker run -d -v hello:/world busybox ls /world
27 27
 
28
-The mount is created inside the container's `/src` directory. Docker does not support relative paths for mount points inside the container. 
28
+The mount is created inside the container's `/src` directory. Docker does not support relative paths for mount points inside the container.
29 29
 
30 30
 Multiple containers can use the same volume in the same time period. This is useful if two containers need access to shared data. For example, if one container writes and the other reads the data.
31 31
 
... ...
@@ -14,8 +14,8 @@ parent = "smn_cli"
14 14
 
15 15
     Inspect one or more volumes
16 16
 
17
-    -f, --format=       Format the output using the given go template.
18
-    --help=false        Print usage
17
+      -f, --format=       Format the output using the given go template.
18
+      --help=false        Print usage
19 19
 
20 20
 Returns information about a volume. By default, this command renders all results
21 21
 in a JSON array. You can specify an alternate format to execute a given template
... ...
@@ -14,9 +14,9 @@ parent = "smn_cli"
14 14
 
15 15
     List volumes
16 16
 
17
-    -f, --filter=[]      Provide filter values (i.e. 'dangling=true')
18
-    --help=false         Print usage
19
-    -q, --quiet=false    Only display volume names
17
+      -f, --filter=[]      Provide filter values (i.e. 'dangling=true')
18
+      --help=false         Print usage
19
+      -q, --quiet=false    Only display volume names
20 20
 
21 21
 Lists all the volumes Docker knows about. You can filter using the `-f` or `--filter` flag. The filtering format is a `key=value` pair. To specify more than one filter,  pass multiple flags (for example,  `--filter "foo=bar" --filter "bif=baz"`)
22 22
 
... ...
@@ -14,7 +14,7 @@ parent = "smn_cli"
14 14
 
15 15
     Remove a volume
16 16
 
17
-    --help=false       Print usage
17
+      --help=false       Print usage
18 18
 
19 19
 Removes one or more volumes. You cannot remove a volume that is in use by a container.
20 20
 
... ...
@@ -11,6 +11,8 @@ weight=1
11 11
 
12 12
 # wait
13 13
 
14
-    Usage: docker wait CONTAINER [CONTAINER...]
14
+    Usage: docker wait [OPTIONS] CONTAINER [CONTAINER...]
15 15
 
16
-    Block until a container stops, then print its exit code.
17 16
\ No newline at end of file
17
+    Block until a container stops, then print its exit code.
18
+
19
+      --help=false    Print usage
... ...
@@ -6,9 +6,11 @@ docker-build - Build a new image from the source code at PATH
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker build**
9
+[**--build-arg**[=*[]*]]
10
+[**-c**|**--cpu-shares**[=*0*]]
11
+[**--cgroup-parent**[=*CGROUP-PARENT*]]
9 12
 [**--help**]
10 13
 [**-f**|**--file**[=*PATH/Dockerfile*]]
11
-[**--build-arg**[=*[]*]]
12 14
 [**--force-rm**[=*false*]]
13 15
 [**--no-cache**[=*false*]]
14 16
 [**--pull**[=*false*]]
... ...
@@ -17,14 +19,11 @@ docker-build - Build a new image from the source code at PATH
17 17
 [**-t**|**--tag**[=*TAG*]]
18 18
 [**-m**|**--memory**[=*MEMORY*]]
19 19
 [**--memory-swap**[=*MEMORY-SWAP*]]
20
-[**-c**|**--cpu-shares**[=*0*]]
21 20
 [**--cpu-period**[=*0*]]
22 21
 [**--cpu-quota**[=*0*]]
23 22
 [**--cpuset-cpus**[=*CPUSET-CPUS*]]
24 23
 [**--cpuset-mems**[=*CPUSET-MEMS*]]
25
-[**--cgroup-parent**[=*CGROUP-PARENT*]]
26 24
 [**--ulimit**[=*[]*]]
27
-
28 25
 PATH | URL | -
29 26
 
30 27
 # DESCRIPTION
... ...
@@ -34,9 +33,9 @@ directory to the Docker daemon. The contents of this directory would
34 34
 be used by **ADD** commands found within the Dockerfile.
35 35
 
36 36
 Warning, this will send a lot of data to the Docker daemon depending
37
-on the contents of the current directory. The build is run by the Docker 
37
+on the contents of the current directory. The build is run by the Docker
38 38
 daemon, not by the CLI, so the whole context must be transferred to the daemon. 
39
-The Docker CLI reports "Sending build context to Docker daemon" when the context is sent to 
39
+The Docker CLI reports "Sending build context to Docker daemon" when the context is sent to
40 40
 the daemon.
41 41
 
42 42
 When the URL to a tarball archive or to a single Dockerfile is given, no context is sent from
... ...
@@ -7,8 +7,8 @@ docker-commit - Create a new image from a container's changes
7 7
 # SYNOPSIS
8 8
 **docker commit**
9 9
 [**-a**|**--author**[=*AUTHOR*]]
10
-[**--help**]
11 10
 [**-c**|**--change**[=\[*DOCKERFILE INSTRUCTIONS*\]]]
11
+[**--help**]
12 12
 [**-m**|**--message**[=*MESSAGE*]]
13 13
 [**-p**|**--pause**[=*true*]]
14 14
 CONTAINER [REPOSITORY[:TAG]]
... ...
@@ -1,9 +1,6 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-
3
-% Shishir Mahajan 
4
-
2
+% Shishir Mahajan
5 3
 % SEPTEMBER 2015
6
-
7 4
 # NAME
8 5
 docker-daemon - Enable daemon mode
9 6
 
... ...
@@ -8,16 +8,15 @@ docker-ps - List containers
8 8
 **docker ps**
9 9
 [**-a**|**--all**[=*false*]]
10 10
 [**--before**[=*BEFORE*]]
11
-[**--help**]
12 11
 [**-f**|**--filter**[=*[]*]]
12
+[**--format**=*"TEMPLATE"*]
13
+[**--help**]
13 14
 [**-l**|**--latest**[=*false*]]
14 15
 [**-n**[=*-1*]]
15 16
 [**--no-trunc**[=*false*]]
16 17
 [**-q**|**--quiet**[=*false*]]
17 18
 [**-s**|**--size**[=*false*]]
18 19
 [**--since**[=*SINCE*]]
19
-[**--format**=*"TEMPLATE"*]
20
-
21 20
 
22 21
 # DESCRIPTION
23 22
 
... ...
@@ -31,9 +30,6 @@ the running containers.
31 31
 **--before**=""
32 32
    Show only containers created before Id or Name, including non-running containers.
33 33
 
34
-**--help**
35
-  Print usage statement
36
-
37 34
 **-f**, **--filter**=[]
38 35
    Provide filter values. Valid filters:
39 36
                           exited=<int> - containers with exit code of <int>
... ...
@@ -44,6 +40,23 @@ the running containers.
44 44
                           ancestor=(<image-name>[:tag]|<image-id>|<image@digest>) - filters containers that were
45 45
                           created from the given image or a descendant.
46 46
 
47
+**--format**=*"TEMPLATE"*
48
+   Pretty-print containers using a Go template.
49
+   Valid placeholders:
50
+      .ID - Container ID
51
+      .Image - Image ID
52
+      .Command - Quoted command
53
+      .CreatedAt - Time when the container was created.
54
+      .RunningFor - Elapsed time since the container was started.
55
+      .Ports - Exposed ports.
56
+      .Status - Container status.
57
+      .Size - Container disk size.
58
+      .Labels - All labels asigned to the container.
59
+      .Label - Value of a specific label for this container. For example `{{.Label "com.docker.swarm.cpu"}}`
60
+
61
+**--help**
62
+  Print usage statement
63
+
47 64
 **-l**, **--latest**=*true*|*false*
48 65
    Show only the latest created container, include non-running ones. The default is *false*.
49 66
 
... ...
@@ -62,20 +75,6 @@ the running containers.
62 62
 **--since**=""
63 63
    Show only containers created since Id or Name, include non-running ones.
64 64
 
65
-**--format**=*"TEMPLATE"*
66
-   Pretty-print containers using a Go template.
67
-   Valid placeholders:
68
-      .ID - Container ID
69
-      .Image - Image ID
70
-      .Command - Quoted command
71
-      .CreatedAt - Time when the container was created.
72
-      .RunningFor - Elapsed time since the container was started.
73
-      .Ports - Exposed ports.
74
-      .Status - Container status.
75
-      .Size - Container disk size.
76
-      .Labels - All labels asigned to the container.
77
-      .Label - Value of a specific label for this container. For example `{{.Label "com.docker.swarm.cpu"}}`
78
-
79 65
 # EXAMPLES
80 66
 # Display all containers, including non-running
81 67
 
... ...
@@ -2,7 +2,7 @@
2 2
 % Docker Community
3 3
 % JUNE 2014
4 4
 # NAME
5
-docker-start - Start one or more stopped containers
5
+docker-start - Start one or more containers
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker start**
... ...
@@ -13,7 +13,7 @@ CONTAINER [CONTAINER...]
13 13
 
14 14
 # DESCRIPTION
15 15
 
16
-Start one or more stopped containers.
16
+Start one or more containers.
17 17
 
18 18
 # OPTIONS
19 19
 **-a**, **--attach**=*true*|*false*
... ...
@@ -26,7 +26,7 @@ Start one or more stopped containers.
26 26
    Attach container's STDIN. The default is *false*.
27 27
 
28 28
 # See also
29
-**docker-stop(1)** to stop a running container.
29
+**docker-stop(1)** to stop a container.
30 30
 
31 31
 # HISTORY
32 32
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
... ...
@@ -2,7 +2,7 @@
2 2
 % Docker Community
3 3
 % JUNE 2014
4 4
 # NAME
5
-docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after a grace period
5
+docker-stop - Stop a container by sending SIGTERM and then SIGKILL after a grace period
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker stop**
... ...
@@ -11,7 +11,7 @@ docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after
11 11
 CONTAINER [CONTAINER...]
12 12
 
13 13
 # DESCRIPTION
14
-Stop a running container (Send SIGTERM, and then SIGKILL after
14
+Stop a container (Send SIGTERM, and then SIGKILL after
15 15
  grace period)
16 16
 
17 17
 # OPTIONS
... ...
@@ -190,7 +190,7 @@ inside it)
190 190
   See **docker-search(1)** for full documentation on the **search** command.
191 191
 
192 192
 **start**
193
-  Start a stopped container
193
+  Start a container
194 194
   See **docker-start(1)** for full documentation on the **start** command.
195 195
 
196 196
 **stats**
... ...
@@ -198,7 +198,7 @@ inside it)
198 198
   See **docker-stats(1)** for full documentation on the **stats** command.
199 199
 
200 200
 **stop**
201
-  Stop a running container
201
+  Stop a container
202 202
   See **docker-stop(1)** for full documentation on the **stop** command.
203 203
 
204 204
 **tag**