Browse code

Merge pull request #24291 from vdemeester/docs-cli-reference-updates

Updates on cli reference documentation

Sebastiaan van Stijn authored on 2016/07/08 06:28:54
Showing 76 changed files
... ...
@@ -44,6 +44,7 @@ func NewCopyCommand(dockerCli *client.DockerCli) *cobra.Command {
44 44
 	docker cp [OPTIONS] SRC_PATH|- CONTAINER:DEST_PATH`,
45 45
 		Short: "Copy files/folders between a container and the local filesystem",
46 46
 		Long: strings.Join([]string{
47
+			"Copy files/folders between a container and the local filesystem\n",
47 48
 			"\nUse '-' as the source to read a tar archive from stdin\n",
48 49
 			"and extract it to a directory destination in a container.\n",
49 50
 			"Use '-' as the destination to stream a tar archive of a\n",
... ...
@@ -18,7 +18,7 @@ func NewTagCommand(dockerCli *client.DockerCli) *cobra.Command {
18 18
 	var opts tagOptions
19 19
 
20 20
 	cmd := &cobra.Command{
21
-		Use:   "tag IMAGE[:TAG] [REGISTRYHOST/][USERNAME/]NAME[:TAG]",
21
+		Use:   "tag IMAGE[:TAG] IMAGE[:TAG]",
22 22
 		Short: "Tag an image into a repository",
23 23
 		Args:  cli.ExactArgs(2),
24 24
 		RunE: func(cmd *cobra.Command, args []string) error {
... ...
@@ -10,14 +10,17 @@ parent = "smn_cli"
10 10
 
11 11
 # attach
12 12
 
13
-    Usage: docker attach [OPTIONS] CONTAINER
13
+```markdown
14
+Usage: docker attach [OPTIONS] CONTAINER
14 15
 
15
-    Attach to a running container
16
+Attach to a running container
16 17
 
17
-      --detach-keys="<sequence>"       Set up escape key sequence
18
-      --help                           Print usage
19
-      --no-stdin                       Do not attach STDIN
20
-      --sig-proxy=true                 Proxy all received signals to the process
18
+Options:
19
+      --detach-keys string   Override the key sequence for detaching a container
20
+      --help                 Print usage
21
+      --no-stdin             Do not attach STDIN
22
+      --sig-proxy            Proxy all received signals to the process (default true)
23
+```
21 24
 
22 25
 The `docker attach` command allows you to attach to a running container using
23 26
 the container's ID or name, either to view its ongoing output or to control it
... ...
@@ -10,32 +10,38 @@ parent = "smn_cli"
10 10
 
11 11
 # build
12 12
 
13
-    Usage: docker build [OPTIONS] PATH | URL | -
14
-
15
-    Build a new image from the source code at PATH
16
-
17
-      --build-arg=[]                  Set build-time variables
18
-      --cpu-shares                    CPU Shares (relative weight)
19
-      --cgroup-parent=""              Optional parent cgroup for the container
20
-      --cpu-period=0                  Limit the CPU CFS (Completely Fair Scheduler) period
21
-      --cpu-quota=0                   Limit the CPU CFS (Completely Fair Scheduler) quota
22
-      --cpuset-cpus=""                CPUs in which to allow execution, e.g. `0-3`, `0,1`
23
-      --cpuset-mems=""                MEMs in which to allow execution, e.g. `0-3`, `0,1`
24
-      --disable-content-trust=true    Skip image verification
25
-      -f, --file=""                   Name of the Dockerfile (Default is 'PATH/Dockerfile')
26
-      --force-rm                      Always remove intermediate containers
27
-      --help                          Print usage
28
-      --isolation=""                  Container isolation technology
29
-      --label=[]                      Set metadata for an image
30
-      -m, --memory=""                 Memory limit for all build containers
31
-      --memory-swap=""                A positive integer equal to memory plus swap. Specify -1 to enable unlimited swap.
32
-      --no-cache                      Do not use cache when building the image
33
-      --pull                          Always attempt to pull a newer version of the image
34
-      -q, --quiet                     Suppress the build output and print image ID on success
35
-      --rm=true                       Remove intermediate containers after a successful build
36
-      --shm-size=[]                   Size of `/dev/shm`. The format is `<number><unit>`. `number` must be greater than `0`.  Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`.
37
-      -t, --tag=[]                    Name and optionally a tag in the 'name:tag' format
38
-      --ulimit=[]                     Ulimit options
13
+```markdown
14
+Usage:  docker build [OPTIONS] PATH | URL | -
15
+
16
+Build an image from a Dockerfile
17
+
18
+Options:
19
+      --build-arg value         Set build-time variables (default [])
20
+      --cgroup-parent string    Optional parent cgroup for the container
21
+      --cpu-period int          Limit the CPU CFS (Completely Fair Scheduler) period
22
+      --cpu-quota int           Limit the CPU CFS (Completely Fair Scheduler) quota
23
+  -c, --cpu-shares int          CPU shares (relative weight)
24
+      --cpuset-cpus string      CPUs in which to allow execution (0-3, 0,1)
25
+      --cpuset-mems string      MEMs in which to allow execution (0-3, 0,1)
26
+      --disable-content-trust   Skip image verification (default true)
27
+  -f, --file string             Name of the Dockerfile (Default is 'PATH/Dockerfile')
28
+      --force-rm                Always remove intermediate containers
29
+      --help                    Print usage
30
+      --isolation string        Container isolation technology
31
+      --label value             Set metadata for an image (default [])
32
+  -m, --memory string           Memory limit
33
+      --memory-swap string      Swap limit equal to memory plus swap: '-1' to enable unlimited swap
34
+      --no-cache                Do not use cache when building the image
35
+      --pull                    Always attempt to pull a newer version of the image
36
+  -q, --quiet                   Suppress the build output and print image ID on success
37
+      --rm                      Remove intermediate containers after a successful build (default true)
38
+      --shm-size string         Size of /dev/shm, default value is 64MB.
39
+                                The format is `<number><unit>`. `number` must be greater than `0`.
40
+                                Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes),
41
+                                or `g` (gigabytes). If you omit the unit, the system uses bytes.
42
+  -t, --tag value               Name and optionally a tag in the 'name:tag' format (default [])
43
+      --ulimit value            Ulimit options (default [])
44
+```
39 45
 
40 46
 Builds Docker images from a Dockerfile and a "context". A build's context is
41 47
 the files located in the specified `PATH` or `URL`. The build process can refer
... ...
@@ -14,16 +14,31 @@ weight = -2
14 14
 To list available commands, either run `docker` with no parameters
15 15
 or execute `docker help`:
16 16
 
17
-    $ docker
18
-      Usage: docker [OPTIONS] COMMAND [arg...]
19
-             docker daemon [ --help | ... ]
20
-             docker [ --help | -v | --version ]
21
-
22
-        -H, --host=[]: The socket(s) to talk to the Docker daemon in the format of tcp://host:port/path, unix:///path/to/socket, fd://* or fd://socketfd.
23
-
24
-      A self-sufficient runtime for Linux containers.
25
-
26
-      ...
17
+```bash
18
+$ docker
19
+Usage: docker [OPTIONS] COMMAND [arg...]
20
+       docker [ --help | -v | --version ]
21
+
22
+A self-sufficient runtime for containers.
23
+
24
+Options:
25
+
26
+  --config=~/.docker              Location of client config files
27
+  -D, --debug                     Enable debug mode
28
+  -H, --host=[]                   Daemon socket(s) to connect to
29
+  -h, --help                      Print usage
30
+  -l, --log-level=info            Set the logging level
31
+  --tls                           Use TLS; implied by --tlsverify
32
+  --tlscacert=~/.docker/ca.pem    Trust certs signed only by this CA
33
+  --tlscert=~/.docker/cert.pem    Path to TLS certificate file
34
+  --tlskey=~/.docker/key.pem      Path to TLS key file
35
+  --tlsverify                     Use TLS and verify the remote
36
+  -v, --version                   Print version information and quit
37
+
38
+Commands:
39
+    attach    Attach to a running container
40
+    # […]
41
+```
27 42
 
28 43
 Depending on your Docker system configuration, you may be required to preface
29 44
 each `docker` command with `sudo`. To avoid having to use `sudo` with the
... ...
@@ -10,15 +10,18 @@ parent = "smn_cli"
10 10
 
11 11
 # commit
12 12
 
13
-    Usage: docker commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
14
-
15
-    Create a new image from a container's changes
16
-
17
-      -a, --author=""     Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
18
-      -c, --change=[]     Apply specified Dockerfile instructions while committing the image
19
-      --help              Print usage
20
-      -m, --message=""    Commit message
21
-      -p, --pause=true    Pause container during commit
13
+```markdown
14
+Usage:  docker commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
15
+
16
+Create a new image from a container's changes
17
+
18
+Options:
19
+  -a, --author string    Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
20
+  -c, --change value     Apply Dockerfile instruction to the created image (default [])
21
+      --help             Print usage
22
+  -m, --message string   Commit message
23
+  -p, --pause            Pause container during commit (default true)
24
+```
22 25
 
23 26
 It can be useful to commit a container's file changes or settings into a new
24 27
 image. This allows you debug a container by running an interactive shell, or to
... ...
@@ -10,13 +10,21 @@ parent = "smn_cli"
10 10
 
11 11
 # cp
12 12
 
13
-    Usage: docker cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH | -
14
-           docker cp [OPTIONS] SRC_PATH | - CONTAINER:DEST_PATH
13
+```markdown
14
+Usage:  docker cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH|-
15
+        docker cp [OPTIONS] SRC_PATH|- CONTAINER:DEST_PATH
15 16
 
16
-    Copy files/folders between a container and the local filesystem
17
+Copy files/folders between a container and the local filesystem
17 18
 
18
-      -L, --follow-link          Always follow symbol link in SRC_PATH
19
-      --help                     Print usage
19
+Use '-' as the source to read a tar archive from stdin
20
+and extract it to a directory destination in a container.
21
+Use '-' as the destination to stream a tar archive of a
22
+container source to stdout.
23
+
24
+Options:
25
+  -L, --follow-link   Always follow symbol link in SRC_PATH
26
+      --help          Print usage
27
+```
20 28
 
21 29
 The `docker cp` utility copies the contents of `SRC_PATH` to the `DEST_PATH`.
22 30
 You can copy from the container's file system to the local machine or the
... ...
@@ -12,95 +12,110 @@ parent = "smn_cli"
12 12
 
13 13
 Creates a new container.
14 14
 
15
-    Usage: docker create [OPTIONS] IMAGE [COMMAND] [ARG...]
16
-
17
-    Create a new container
18
-
19
-      -a, --attach=[]               Attach to STDIN, STDOUT or STDERR
20
-      --add-host=[]                 Add a custom host-to-IP mapping (host:ip)
21
-      --blkio-weight=0              Block IO weight (relative weight)
22
-      --blkio-weight-device=[]      Block IO weight (relative device weight, format: `DEVICE_NAME:WEIGHT`)
23
-      --cpu-shares=0                CPU shares (relative weight)
24
-      --cap-add=[]                  Add Linux capabilities
25
-      --cap-drop=[]                 Drop Linux capabilities
26
-      --cgroup-parent=""            Optional parent cgroup for the container
27
-      --cidfile=""                  Write the container ID to the file
28
-      --cpu-period=0                Limit CPU CFS (Completely Fair Scheduler) period
29
-      --cpu-quota=0                 Limit CPU CFS (Completely Fair Scheduler) quota
30
-      --cpuset-cpus=""              CPUs in which to allow execution (0-3, 0,1)
31
-      --cpuset-mems=""              Memory nodes (MEMs) in which to allow execution (0-3, 0,1)
32
-      --device=[]                   Add a host device to the container
33
-      --device-read-bps=[]          Limit read rate (bytes per second) from a device (e.g., --device-read-bps=/dev/sda:1mb)
34
-      --device-read-iops=[]         Limit read rate (IO per second) from a device (e.g., --device-read-iops=/dev/sda:1000)
35
-      --device-write-bps=[]         Limit write rate (bytes per second) to a device (e.g., --device-write-bps=/dev/sda:1mb)
36
-      --device-write-iops=[]        Limit write rate (IO per second) to a device (e.g., --device-write-iops=/dev/sda:1000)
37
-      --disable-content-trust=true  Skip image verification
38
-      --dns=[]                      Set custom DNS servers
39
-      --dns-opt=[]                  Set custom DNS options
40
-      --dns-search=[]               Set custom DNS search domains
41
-      -e, --env=[]                  Set environment variables
42
-      --entrypoint=""               Overwrite the default ENTRYPOINT of the image
43
-      --env-file=[]                 Read in a file of environment variables
44
-      --expose=[]                   Expose a port or a range of ports
45
-      --group-add=[]                Add additional groups to join
46
-      -h, --hostname=""             Container host name
15
+```markdown
16
+Usage:  docker create [OPTIONS] IMAGE [COMMAND] [ARG...]
17
+
18
+Create a new container
19
+
20
+Options:
21
+      --add-host value              Add a custom host-to-IP mapping (host:ip) (default [])
22
+  -a, --attach value                Attach to STDIN, STDOUT or STDERR (default [])
23
+      --blkio-weight value          Block IO (relative weight), between 10 and 1000
24
+      --blkio-weight-device value   Block IO weight (relative device weight) (default [])
25
+      --cap-add value               Add Linux capabilities (default [])
26
+      --cap-drop value              Drop Linux capabilities (default [])
27
+      --cgroup-parent string        Optional parent cgroup for the container
28
+      --cidfile string              Write the container ID to the file
29
+      --cpu-percent int             CPU percent (Windows only)
30
+      --cpu-period int              Limit CPU CFS (Completely Fair Scheduler) period
31
+      --cpu-quota int               Limit CPU CFS (Completely Fair Scheduler) quota
32
+  -c, --cpu-shares int              CPU shares (relative weight)
33
+      --cpuset-cpus string          CPUs in which to allow execution (0-3, 0,1)
34
+      --cpuset-mems string          MEMs in which to allow execution (0-3, 0,1)
35
+      --device value                Add a host device to the container (default [])
36
+      --device-read-bps value       Limit read rate (bytes per second) from a device (default [])
37
+      --device-read-iops value      Limit read rate (IO per second) from a device (default [])
38
+      --device-write-bps value      Limit write rate (bytes per second) to a device (default [])
39
+      --device-write-iops value     Limit write rate (IO per second) to a device (default [])
40
+      --disable-content-trust       Skip image verification (default true)
41
+      --dns value                   Set custom DNS servers (default [])
42
+      --dns-opt value               Set DNS options (default [])
43
+      --dns-search value            Set custom DNS search domains (default [])
44
+      --entrypoint string           Overwrite the default ENTRYPOINT of the image
45
+  -e, --env value                   Set environment variables (default [])
46
+      --env-file value              Read in a file of environment variables (default [])
47
+      --expose value                Expose a port or a range of ports (default [])
48
+      --group-add value             Add additional groups to join (default [])
49
+      --health-cmd string           Command to run to check health
50
+      --health-interval duration    Time between running the check
51
+      --health-retries int          Consecutive failures needed to report unhealthy
52
+      --health-timeout duration     Maximum time to allow one check to run
47 53
       --help                        Print usage
48
-      -i, --interactive             Keep STDIN open even if not attached
49
-      --ip=""                       Container IPv4 address (e.g. 172.30.100.104)
50
-      --ip6=""                      Container IPv6 address (e.g. 2001:db8::33)
51
-      --ipc=""                      IPC namespace to use
52
-      --isolation=""                Container isolation technology
53
-      --kernel-memory=""            Kernel memory limit
54
-      -l, --label=[]                Set metadata on the container (e.g., --label=com.example.key=value)
55
-      --label-file=[]               Read in a line delimited file of labels
56
-      --link=[]                     Add link to another container
57
-      --link-local-ip=[]            Container IPv4/IPv6 link-local addresses (e.g. 169.254.0.77, fe80::77)
58
-      --log-driver=""               Logging driver for container
59
-      --log-opt=[]                  Log driver specific options
60
-      -m, --memory=""               Memory limit
61
-      --mac-address=""              Container MAC address (e.g. 92:d0:c6:0a:29:33)
62
-      --memory-reservation=""       Memory soft limit
63
-      --memory-swap=""              A positive integer equal to memory plus swap. Specify -1 to enable unlimited swap.
64
-      --memory-swappiness=""        Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
65
-      --name=""                     Assign a name to the container
66
-      --net="bridge"                Connect a container to a network
54
+  -h, --hostname string             Container host name
55
+  -i, --interactive                 Keep STDIN open even if not attached
56
+      --io-maxbandwidth string      Maximum IO bandwidth limit for the system drive (Windows only)
57
+      --io-maxiops uint             Maximum IOps limit for the system drive (Windows only)
58
+      --ip string                   Container IPv4 address (e.g. 172.30.100.104)
59
+      --ip6 string                  Container IPv6 address (e.g. 2001:db8::33)
60
+      --ipc string                  IPC namespace to use
61
+      --isolation string            Container isolation technology
62
+      --kernel-memory string        Kernel memory limit
63
+  -l, --label value                 Set meta data on a container (default [])
64
+      --label-file value            Read in a line delimited file of labels (default [])
65
+      --link value                  Add link to another container (default [])
66
+      --link-local-ip value         Container IPv4/IPv6 link-local addresses (default [])
67
+      --log-driver string           Logging driver for container
68
+      --log-opt value               Log driver options (default [])
69
+      --mac-address string          Container MAC address (e.g. 92:d0:c6:0a:29:33)
70
+  -m, --memory string               Memory limit
71
+      --memory-reservation string   Memory soft limit
72
+      --memory-swap string          Swap limit equal to memory plus swap: '-1' to enable unlimited swap
73
+      --memory-swappiness int       Tune container memory swappiness (0 to 100) (default -1)
74
+      --name string                 Assign a name to the container
75
+      --net string                  Connect a container to a network (default "default")
67 76
                                     'bridge': create a network stack on the default Docker bridge
68 77
                                     'none': no networking
69 78
                                     'container:<name|id>': reuse another container's network stack
70 79
                                     'host': use the Docker host network stack
71 80
                                     '<network-name>|<network-id>': connect to a user-defined network
72
-      --net-alias=[]                Add network-scoped alias for the container
73
-      --oom-kill-disable            Whether to disable OOM Killer for the container or not
74
-      --oom-score-adj=0             Tune the host's OOM preferences for containers (accepts -1000 to 1000)
75
-      -P, --publish-all             Publish all exposed ports to random ports
76
-      -p, --publish=[]              Publish a container's port(s) to the host
77
-      --pid=""                      PID namespace to use
78
-      --pids-limit=-1                Tune container pids limit (set -1 for unlimited), kernel >= 4.3
81
+      --net-alias value             Add network-scoped alias for the container (default [])
82
+      --no-healthcheck              Disable any container-specified HEALTHCHECK
83
+      --oom-kill-disable            Disable OOM Killer
84
+      --oom-score-adj int           Tune host's OOM preferences (-1000 to 1000)
85
+      --pid string                  PID namespace to use
86
+      --pids-limit int              Tune container pids limit (set -1 for unlimited), kernel >= 4.3
79 87
       --privileged                  Give extended privileges to this container
88
+  -p, --publish value               Publish a container's port(s) to the host (default [])
89
+  -P, --publish-all                 Publish all exposed ports to random ports
80 90
       --read-only                   Mount the container's root filesystem as read only
81
-      --restart="no"                Restart policy (no, on-failure[:max-retry], always, unless-stopped)
82
-      --runtime=""                  Name of the runtime to be used for that container
83
-      --security-opt=[]             Security options
84
-      --stop-signal="SIGTERM"       Signal to stop a container
85
-      --shm-size=[]                 Size of `/dev/shm`. The format is `<number><unit>`. `number` must be greater than `0`.  Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`.
86
-      --storage-opt=[]              Set storage driver options per container
87
-      --sysctl[=*[]*]]              Configure namespaced kernel parameters at runtime
88
-      -t, --tty                     Allocate a pseudo-TTY
89
-      -u, --user=""                 Username or UID
90
-      --userns=""                   Container user namespace
91
+      --restart string              Restart policy to apply when a container exits (default "no")
92
+                                    Possible values are: no, on-failure[:max-retry], always, unless-stopped
93
+      --runtime string              Runtime to use for this container
94
+      --security-opt value          Security Options (default [])
95
+      --shm-size string             Size of /dev/shm, default value is 64MB.
96
+                                    The format is `<number><unit>`. `number` must be greater than `0`.
97
+                                    Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes),
98
+                                    or `g` (gigabytes). If you omit the unit, the system uses bytes.
99
+      --stop-signal string          Signal to stop a container, SIGTERM by default (default "SIGTERM")
100
+      --storage-opt value           Set storage driver options per container (default [])
101
+      --sysctl value                Sysctl options (default map[])
102
+      --tmpfs value                 Mount a tmpfs directory (default [])
103
+  -t, --tty                         Allocate a pseudo-TTY
104
+      --ulimit value                Ulimit options (default [])
105
+  -u, --user string                 Username or UID (format: <name|uid>[:<group|gid>])
106
+      --userns string               User namespace to use
91 107
                                     'host': Use the Docker host user namespace
92 108
                                     '': Use the Docker daemon user namespace specified by `--userns-remap` option.
93
-      --ulimit=[]                   Ulimit options
94
-      --uts=""                      UTS namespace to use
95
-      -v, --volume=[host-src:]container-dest[:<options>]
96
-                                    Bind mount a volume. The comma-delimited
109
+      --uts string                  UTS namespace to use
110
+  -v, --volume value                Bind mount a volume (default []). The comma-delimited
97 111
                                     `options` are [rw|ro], [z|Z],
98 112
                                     [[r]shared|[r]slave|[r]private], and
99 113
                                     [nocopy]. The 'host-src' is an absolute path
100 114
                                     or a name value.
101
-      --volume-driver=""            Container's volume driver
102
-      --volumes-from=[]             Mount volumes from the specified container(s)
103
-      -w, --workdir=""              Working directory inside the container
115
+      --volume-driver string        Optional volume driver for the container
116
+      --volumes-from value          Mount volumes from the specified container(s) (default [])
117
+  -w, --workdir string              Working directory inside the container
118
+```
104 119
 
105 120
 The `docker create` command creates a writeable container layer over the
106 121
 specified image and prepares it for running the specified command.  The
... ...
@@ -10,11 +10,14 @@ parent = "smn_cli"
10 10
 
11 11
 # diff
12 12
 
13
-    Usage: docker diff [OPTIONS] CONTAINER
13
+```markdown
14
+Usage:  docker diff CONTAINER
14 15
 
15
-    Inspect changes on a container's filesystem
16
+Inspect changes on a container's filesystem
16 17
 
17
-      --help              Print usage
18
+Options:
19
+      --help   Print usage
20
+```
18 21
 
19 22
 List the changed files and directories in a container᾿s filesystem
20 23
  There are 3 events that are listed in the `diff`:
... ...
@@ -10,14 +10,17 @@ parent = "smn_cli"
10 10
 
11 11
 # events
12 12
 
13
-    Usage: docker events [OPTIONS]
13
+```markdown
14
+Usage:  docker events [OPTIONS]
14 15
 
15
-    Get real time events from the server
16
+Get real time events from the server
16 17
 
17
-      -f, --filter=[]    Filter output based on conditions provided
18
-      --help             Print usage
19
-      --since=""         Show all events created since timestamp
20
-      --until=""         Stream events until this timestamp
18
+Options:
19
+  -f, --filter value   Filter output based on conditions provided (default [])
20
+      --help           Print usage
21
+      --since string   Show all events created since timestamp
22
+      --until string   Stream events until this timestamp
23
+```
21 24
 
22 25
 Docker containers report the following events:
23 26
 
... ...
@@ -10,17 +10,19 @@ parent = "smn_cli"
10 10
 
11 11
 # exec
12 12
 
13
-    Usage: docker exec [OPTIONS] CONTAINER COMMAND [ARG...]
14
-
15
-    Run a command in a running container
16
-
17
-      -d, --detach               Detached mode: run command in the background
18
-      --detach-keys              Specify the escape key sequence used to detach a container
19
-      --help                     Print usage
20
-      -i, --interactive          Keep STDIN open even if not attached
21
-      --privileged               Give extended Linux capabilities to the command
22
-      -t, --tty                  Allocate a pseudo-TTY
23
-      -u, --user=                Username or UID (format: <name|uid>[:<group|gid>])
13
+```markdown
14
+Usage:  docker exec [OPTIONS] CONTAINER COMMAND [ARG...]
15
+
16
+Run a command in a running container
17
+
18
+  -d, --detach         Detached mode: run command in the background
19
+  --detach-keys        Override the key sequence for detaching a container
20
+  --help               Print usage
21
+  -i, --interactive    Keep STDIN open even if not attached
22
+  --privileged         Give extended privileges to the command
23
+  -t, --tty            Allocate a pseudo-TTY
24
+  -u, --user           Username or UID (format: <name|uid>[:<group|gid>])
25
+```
24 26
 
25 27
 The `docker exec` command runs a new command in a running container.
26 28
 
... ...
@@ -10,12 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # export
12 12
 
13
-    Usage: docker export [OPTIONS] CONTAINER
13
+```markdown
14
+Usage:  docker export [OPTIONS] CONTAINER
14 15
 
15
-    Export the contents of a container's filesystem as a tar archive
16
+Export a container's filesystem as a tar archive
16 17
 
17
-      --help             Print usage
18
-      -o, --output=""    Write to a file, instead of STDOUT
18
+Options:
19
+      --help            Print usage
20
+  -o, --output string   Write to a file, instead of STDOUT
21
+```
19 22
 
20 23
 The `docker export` command does not export the contents of volumes associated
21 24
 with the container. If a volume is mounted on top of an existing directory in
... ...
@@ -10,14 +10,17 @@ parent = "smn_cli"
10 10
 
11 11
 # history
12 12
 
13
-    Usage: docker history [OPTIONS] IMAGE
13
+```markdown
14
+Usage:  docker history [OPTIONS] IMAGE
14 15
 
15
-    Show the history of an image
16
+Show the history of an image
16 17
 
17
-      -H, --human=true     Print sizes and dates in human readable format
18
-      --help               Print usage
19
-      --no-trunc           Don't truncate output
20
-      -q, --quiet          Only show numeric IDs
18
+Options:
19
+      --help       Print usage
20
+  -H, --human      Print sizes and dates in human readable format (default true)
21
+      --no-trunc   Don't truncate output
22
+  -q, --quiet      Only show numeric IDs
23
+```
21 24
 
22 25
 To see how the `docker:latest` image was built:
23 26
 
... ...
@@ -10,20 +10,24 @@ parent = "smn_cli"
10 10
 
11 11
 # images
12 12
 
13
-    Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
14
-
15
-    List images
16
-
17
-      -a, --all            Show all images (default hides intermediate images)
18
-      --digests            Show digests
19
-      -f, --filter=[]      Filter output based on these conditions:
20
-                           - dangling=(true|false)
21
-                           - label=<key> or label=<key>=<value>
22
-                           - before=(<image-name>[:tag]|<image-id>|<image@digest>)
23
-                           - since=(<image-name>[:tag]|<image-id>|<image@digest>)
24
-      --help               Print usage
25
-      --no-trunc           Don't truncate output
26
-      -q, --quiet          Only show numeric IDs
13
+```markdown
14
+Usage:  docker images [OPTIONS] [REPOSITORY[:TAG]]
15
+
16
+List images
17
+
18
+Options:
19
+  -a, --all             Show all images (default hides intermediate images)
20
+      --digests         Show digests
21
+  -f, --filter value    Filter output based on conditions provided (default [])
22
+                        - dangling=(true|false)
23
+                        - label=<key> or label=<key>=<value>
24
+                        - before=(<image-name>[:tag]|<image-id>|<image@digest>)
25
+                        - since=(<image-name>[:tag]|<image-id>|<image@digest>)
26
+      --format string   Pretty-print images using a Go template
27
+      --help            Print usage
28
+      --no-trunc        Don't truncate output
29
+  -q, --quiet           Only show numeric IDs
30
+```
27 31
 
28 32
 The default `docker images` will show all top level
29 33
 images, their repository and tags, and their size.
... ...
@@ -10,15 +10,16 @@ parent = "smn_cli"
10 10
 
11 11
 # import
12 12
 
13
-    Usage: docker import file|URL|- [REPOSITORY[:TAG]]
13
+```markdown
14
+Usage:  docker import [OPTIONS] file|URL|- [REPOSITORY[:TAG]]
14 15
 
15
-    Create an empty filesystem image and import the contents of the
16
-	tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) into it, then
17
-	optionally tag it.
16
+Import the contents from a tarball to create a filesystem image
18 17
 
19
-      -c, --change=[]     Apply specified Dockerfile instructions while importing the image
20
-      --help              Print usage
21
-      -m, --message=      Set commit message for imported image
18
+Options:
19
+  -c, --change value     Apply Dockerfile instruction to the created image (default [])
20
+      --help             Print usage
21
+  -m, --message string   Set commit message for imported image
22
+```
22 23
 
23 24
 You can specify a `URL` or `-` (dash) to take data directly from `STDIN`. The
24 25
 `URL` can point to an archive (.tar, .tar.gz, .tgz, .bzip, .tar.xz, or .txz)
... ...
@@ -10,13 +10,14 @@ parent = "smn_cli"
10 10
 
11 11
 # info
12 12
 
13
+```markdown
14
+Usage:  docker info
13 15
 
14
-    Usage: docker info [OPTIONS]
15
-
16
-    Display system-wide information
17
-
18
-      --help              Print usage
16
+Display system-wide information
19 17
 
18
+Options:
19
+      --help   Print usage
20
+```
20 21
 
21 22
 This command displays system wide information regarding the Docker installation.
22 23
 Information displayed includes the kernel version, number of containers and images.
... ...
@@ -10,15 +10,17 @@ parent = "smn_cli"
10 10
 
11 11
 # inspect
12 12
 
13
-    Usage: docker inspect [OPTIONS] CONTAINER|IMAGE|TASK [CONTAINER|IMAGE|TASK...]
13
+```markdown
14
+Usage:  docker inspect [OPTIONS] CONTAINER|IMAGE|TASK [CONTAINER|IMAGE|TASK...]
14 15
 
15
-    Return low-level information on a container or image or task
16
+Return low-level information on a container, image or task
16 17
 
17
-      -f, --format=""              Format the output using the given go template
18
-      --help                       Print usage
19
-      --type=container|image|task  Return JSON for specified type, permissible
20
-                                   values are "image" or "container" or "task"
21
-      -s, --size                   Display total file sizes if the type is container
18
+  -f, --format       Format the output using the given go template
19
+  --help             Print usage
20
+  -s, --size         Display total file sizes if the type is container
21
+                     values are "image" or "container" or "task
22
+  --type             Return JSON for specified type, (e.g image, container or task)
23
+```
22 24
 
23 25
 By default, this will render all results in a JSON array. If the container and
24 26
 image have the same name, this will return container JSON for unspecified type.
... ...
@@ -10,12 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # kill
12 12
 
13
-    Usage: docker kill [OPTIONS] CONTAINER [CONTAINER...]
13
+```markdown
14
+Usage:  docker kill [OPTIONS] CONTAINER [CONTAINER...]
14 15
 
15
-    Kill a running container using SIGKILL or a specified signal
16
+Kill one or more running container
16 17
 
17
-      --help                 Print usage
18
-      -s, --signal="KILL"    Signal to send to the container
18
+Options:
19
+      --help            Print usage
20
+  -s, --signal string   Signal to send to the container (default "KILL")
21
+```
19 22
 
20 23
 The main process inside the container will be sent `SIGKILL`, or any
21 24
 signal specified with option `--signal`.
... ...
@@ -10,14 +10,17 @@ parent = "smn_cli"
10 10
 
11 11
 # load
12 12
 
13
-    Usage: docker load [OPTIONS]
13
+```markdown
14
+Usage:  docker load [OPTIONS]
14 15
 
15
-    Load an image from a tar archive or STDIN and shows image names or
16
-    IDs imported.
16
+Load an image from a tar archive or STDIN
17 17
 
18
-      --help             Print usage
19
-      -i, --input=""     Read from a tar archive file, instead of STDIN. The tarball may be compressed with gzip, bzip, or xz
20
-      -q, --quiet        Suppress the load progress bar but still outputs the imported images
18
+Options:
19
+      --help           Print usage
20
+  -i, --input string   Read from tar archive file, instead of STDIN.
21
+                       The tarball may be compressed with gzip, bzip, or xz
22
+  -q, --quiet          Suppress the load output but still outputs the imported images
23
+```
21 24
 
22 25
 Loads a tarred repository from a file or the standard input stream.
23 26
 Restores both images and tags.
... ...
@@ -10,14 +10,17 @@ parent = "smn_cli"
10 10
 
11 11
 # login
12 12
 
13
-    Usage: docker login [OPTIONS] [SERVER]
13
+```markdown
14
+Usage:  docker login [OPTIONS] [SERVER]
14 15
 
15
-    Log in to a Docker registry server, if no server is
16
-	specified "https://index.docker.io/v1/" is the default.
16
+Log in to a Docker registry.
17
+If no server is specified, the default is defined by the daemon.
17 18
 
18
-      --help               Print usage
19
-      -p, --password=""    Password
20
-      -u, --username=""    Username
19
+Options:
20
+      --help              Print usage
21
+  -p, --password string   Password
22
+  -u, --username string   Username
23
+```
21 24
 
22 25
 If you want to login to a self-hosted registry you can specify this by
23 26
 adding the server name.
... ...
@@ -10,12 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # logout
12 12
 
13
-    Usage: docker logout [SERVER]
13
+```markdown
14
+Usage:  docker logout [SERVER]
14 15
 
15
-    Log out from a Docker registry, if no server is
16
-	specified "https://index.docker.io/v1/" is the default.
16
+Log out from a Docker registry.
17
+If no server is specified, the default is defined by the daemon.
17 18
 
18
-      --help          Print usage
19
+Options:
20
+      --help   Print usage
21
+```
19 22
 
20 23
 For example:
21 24
 
... ...
@@ -10,16 +10,19 @@ parent = "smn_cli"
10 10
 
11 11
 # logs
12 12
 
13
-    Usage: docker logs [OPTIONS] CONTAINER
14
-
15
-    Fetch the logs of a container
16
-
17
-      --details                 Show extra details provided to logs
18
-      -f, --follow              Follow log output
19
-      --help                    Print usage
20
-      --since=""                Show logs since timestamp
21
-      -t, --timestamps          Show timestamps
22
-      --tail="all"              Number of lines to show from the end of the logs
13
+```markdown
14
+Usage:  docker logs [OPTIONS] CONTAINER
15
+
16
+Fetch the logs of a container
17
+
18
+Options:
19
+      --details        Show extra details provided to logs
20
+  -f, --follow         Follow log output
21
+      --help           Print usage
22
+      --since string   Show logs since timestamp
23
+      --tail string    Number of lines to show from the end of the logs (default "all")
24
+  -t, --timestamps     Show timestamps
25
+```
23 26
 
24 27
 > **Note**: this command is available only for containers with `json-file` and
25 28
 > `journald` logging drivers.
... ...
@@ -10,16 +10,19 @@ parent = "smn_cli"
10 10
 
11 11
 # network connect
12 12
 
13
-    Usage:  docker network connect [OPTIONS] NETWORK CONTAINER
14
-
15
-    Connect a container to a network
16
-
17
-      --alias=[]         Add network-scoped alias for the container
18
-      --help             Print usage
19
-      --ip               IPv4 Address
20
-      --ip6              IPv6 Address
21
-      --link=[]          Add a link to another container
22
-      --link-local-ip=[] IPv4/IPv6 link-local addresses
13
+```markdown
14
+Usage:  docker network connect [OPTIONS] NETWORK CONTAINER
15
+
16
+Connect a container to a network
17
+
18
+Options:
19
+      --alias value           Add network-scoped alias for the container (default [])
20
+      --help                  Print usage
21
+      --ip string             IP Address
22
+      --ip6 string            IPv6 Address
23
+      --link value            Add link to another container (default [])
24
+      --link-local-ip value   Add a link-local address for the container (default [])
25
+```
23 26
 
24 27
 Connects a container to a network. You can connect a container by name
25 28
 or by ID. Once connected, the container can communicate with other containers in
... ...
@@ -10,13 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # network disconnect
12 12
 
13
-    Usage:  docker network disconnect [OPTIONS] NETWORK CONTAINER
13
+```markdown
14
+Usage:  docker network disconnect [OPTIONS] NETWORK CONTAINER
14 15
 
16
+Disconnect a container from a network
15 17
 
16
-    Disconnects a container from a network
17
-
18
-      -f, --force        Force the container to disconnect from a network
19
-      --help             Print usage
18
+Options:
19
+  -f, --force   Force the container to disconnect from a network
20
+      --help    Print usage
21
+```
20 22
 
21 23
 Disconnects a container from a network. The container must be running to disconnect it from the network.
22 24
 
... ...
@@ -10,12 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # network inspect
12 12
 
13
-    Usage:  docker network inspect [OPTIONS] NETWORK [NETWORK..]
13
+```markdown
14
+Usage:  docker network inspect [OPTIONS] NETWORK [NETWORK...]
14 15
 
15
-    Displays detailed information on a network
16
+Display detailed information on one or more networks
16 17
 
17
-      -f, --format=       Format the output using the given go template.
18
-      --help             Print usage
18
+Options:
19
+  -f, --format string   Format the output using the given go template
20
+      --help            Print usage
21
+```
19 22
 
20 23
 Returns information about one or more networks. By default, this command renders all results in a JSON object. For example, if you connect two containers to the default `bridge` network:
21 24
 
... ...
@@ -10,13 +10,20 @@ parent = "smn_cli"
10 10
 
11 11
 # docker network ls
12 12
 
13
-    Usage:  docker network ls [OPTIONS]
13
+```markdown
14
+Usage:  docker network ls [OPTIONS]
14 15
 
15
-    List networks
16
-      -f, --filter=[]       Filter output based on conditions provided
17
-      --help                Print usage
18
-      --no-trunc            Do not truncate the output
19
-      -q, --quiet           Only display numeric IDs
16
+List networks
17
+
18
+Aliases:
19
+  ls, list
20
+
21
+Options:
22
+  -f, --filter value   Provide filter values (i.e. 'dangling=true') (default [])
23
+      --help           Print usage
24
+      --no-trunc       Do not truncate the output
25
+  -q, --quiet          Only display volume names
26
+```
20 27
 
21 28
 Lists all the networks the Engine `daemon` knows about. This includes the
22 29
 networks that span across multiple hosts in a cluster, for example:
... ...
@@ -10,11 +10,17 @@ parent = "smn_cli"
10 10
 
11 11
 # network rm
12 12
 
13
-    Usage:  docker network rm [OPTIONS] NETWORK [NETWORK...]
13
+```markdown
14
+Usage:  docker network rm NETWORK [NETWORK]...
14 15
 
15
-    Deletes one or more networks
16
+Remove a network
16 17
 
17
-      --help             Print usage
18
+Aliases:
19
+  rm, remove
20
+
21
+Options:
22
+      --help   Print usage
23
+```
18 24
 
19 25
 Removes one or more networks by name or identifier. To remove a network,
20 26
 you must first disconnect any containers connected to it.
... ...
@@ -10,9 +10,14 @@ parent = "smn_cli"
10 10
 
11 11
 # node accept
12 12
 
13
-    Usage:  docker node accept NODE [NODE...]
13
+```markdown
14
+Usage:  docker node accept NODE [NODE...]
14 15
 
15
-    Accept a node in the swarm
16
+Accept a node in the swarm
17
+
18
+Options:
19
+      --help   Print usage
20
+```
16 21
 
17 22
 Accept a node into the swarm. This command targets a docker engine that is a manager in the swarm cluster.
18 23
 
... ...
@@ -10,9 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # node demote
12 12
 
13
-    Usage:  docker node demote NODE [NODE...]
13
+```markdown
14
+Usage:  docker node demote NODE [NODE...]
14 15
 
15
-    Demote a node as manager in the swarm
16
+Demote a node from manager in the swarm
17
+
18
+Options:
19
+      --help   Print usage
20
+
21
+```
16 22
 
17 23
 Demotes an existing manager so that it is no longer a manager. This command targets a docker engine that is a manager in the swarm cluster.
18 24
 
... ...
@@ -11,14 +11,16 @@ parent = "smn_cli"
11 11
 
12 12
 # node inspect
13 13
 
14
-    Usage: docker node inspect [OPTIONS] self|NODE [NODE...]
14
+```markdown
15
+Usage:  docker node inspect [OPTIONS] self|NODE [NODE...]
15 16
 
16
-    Display detailed information on one or more nodes
17
+Display detailed information on one or more nodes
17 18
 
18
-
19
-      -f, --format=       Format the output using the given go template.
20
-      --help              Print usage
21
-      -p, --pretty        Print the information in a human friendly format.
19
+Options:
20
+  -f, --format string   Format the output using the given go template
21
+      --help            Print usage
22
+  -p, --pretty          Print the information in a human friendly format.
23
+```
22 24
 
23 25
 Returns information about a node. By default, this command renders all results
24 26
 in a JSON array. You can specify an alternate format to execute a
... ...
@@ -11,17 +11,19 @@ parent = "smn_cli"
11 11
 
12 12
 # node ls
13 13
 
14
-    Usage:  docker node ls [OPTIONS]
14
+```markdown
15
+Usage:  docker node ls [OPTIONS]
15 16
 
16
-    List nodes in the swarm
17
+List nodes in the swarm
17 18
 
18
-    Aliases:
19
-      ls, list
19
+Aliases:
20
+  ls, list
20 21
 
21
-    Options:
22
-      -f, --filter value   Filter output based on conditions provided
23
-          --help           Print usage
24
-      -q, --quiet          Only display IDs
22
+Options:
23
+  -f, --filter value   Filter output based on conditions provided
24
+      --help           Print usage
25
+  -q, --quiet          Only display IDs
26
+```
25 27
 
26 28
 Lists all the nodes that the Docker Swarm manager knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section for more information about available filter options.
27 29
 
... ...
@@ -10,9 +10,14 @@ parent = "smn_cli"
10 10
 
11 11
 # node promote
12 12
 
13
-    Usage:  docker node promote NODE [NODE...]
13
+```markdown
14
+Usage:  docker node promote NODE [NODE...]
14 15
 
15
-    Promote a node as manager in the swarm
16
+Promote a node to a manager in the swarm
17
+
18
+Options:
19
+      --help   Print usage
20
+```
16 21
 
17 22
 Promotes a node that is pending a promotion to manager. This command targets a docker engine that is a manager in the swarm cluster.
18 23
 
... ...
@@ -11,17 +11,21 @@ parent = "smn_cli"
11 11
 
12 12
 # node rm
13 13
 
14
-	Usage:	docker node rm NODE [NODE...]
14
+```markdown
15
+Usage:  docker node rm NODE [NODE...]
15 16
 
16
-	Remove a node from the swarm
17
+Remove a node from the swarm
17 18
 
18
-	Aliases:
19
-	  rm, remove
19
+Aliases:
20
+  rm, remove
20 21
 
21
-	Options:
22
-	      --help   Print usage
22
+Options:
23
+      --help   Print usage
24
+```
25
+
26
+Removes specified nodes from a swarm. Rejects nodes with `Pending`
27
+membership from the swarm.
23 28
 
24
-Removes nodes that are specified. 
25 29
 
26 30
 Example output:
27 31
 
... ...
@@ -11,15 +11,17 @@ parent = "smn_cli"
11 11
 
12 12
 # node tasks
13 13
 
14
-    Usage:  docker node tasks [OPTIONS] NODE
14
+```markdown
15
+Usage:  docker node tasks [OPTIONS] self|NODE
15 16
 
16
-    List tasks running on a node
17
+List tasks running on a node
17 18
 
18
-    Options:
19
-      -a, --all            Display all instances
20
-      -f, --filter value   Filter output based on conditions provided
19
+Options:
20
+  -a, --all            Display all instances
21
+  -f, --filter value   Filter output based on conditions provided
21 22
       --help           Print usage
22
-      -n, --no-resolve     Do not map IDs to Names
23
+  -n, --no-resolve     Do not map IDs to Names
24
+```
23 25
 
24 26
 Lists all the tasks on a Node that Docker knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section for more information about available filter options.
25 27
 
... ...
@@ -11,16 +11,17 @@ parent = "smn_cli"
11 11
 
12 12
 ## update
13 13
 
14
-    Usage: docker node update [OPTIONS] Node
14
+```markdown
15
+Usage:  docker node update [OPTIONS] NODE
15 16
 
16
-    Update a node
17
+Update a node
17 18
 
18
-    Options:
19
+Options:
19 20
       --availability string   Availability of the node (active/pause/drain)
20 21
       --help                  Print usage
21 22
       --membership string     Membership of the node (accepted/rejected)
22 23
       --role string           Role of the node (worker/manager)
23
-
24
+```
24 25
 
25 26
 
26 27
 ## Related information
... ...
@@ -10,11 +10,14 @@ parent = "smn_cli"
10 10
 
11 11
 # pause
12 12
 
13
-    Usage: docker pause [OPTIONS] CONTAINER [CONTAINER...]
13
+```markdown
14
+Usage:  docker pause CONTAINER [CONTAINER...]
14 15
 
15
-    Pause all processes within a container
16
+Pause all processes within one or more containers
16 17
 
17
-      --help          Print usage
18
+Options:
19
+      --help   Print usage
20
+```
18 21
 
19 22
 The `docker pause` command uses the cgroups freezer to suspend all processes in
20 23
 a container. Traditionally, when suspending a process the `SIGSTOP` signal is
... ...
@@ -11,11 +11,14 @@ parent = "smn_cli"
11 11
 
12 12
 # plugin disable (experimental)
13 13
 
14
-    Usage: docker plugin disable PLUGIN
14
+```markdown
15
+Usage:  docker plugin disable PLUGIN
15 16
 
16
-    Disable a plugin
17
+Disable a plugin
17 18
 
18
-      --help             Print usage
19
+Options:
20
+      --help   Print usage
21
+```
19 22
 
20 23
 Disables a plugin. The plugin must be installed before it can be disabled,
21 24
 see [`docker plugin install`](plugin_install.md).
... ...
@@ -11,11 +11,14 @@ parent = "smn_cli"
11 11
 
12 12
 # plugin enable (experimental)
13 13
 
14
-    Usage: docker plugin enable PLUGIN
14
+```markdown
15
+Usage:  docker plugin enable PLUGIN
15 16
 
16
-    Enable a plugin
17
+Enable a plugin
17 18
 
18
-      --help             Print usage
19
+Options:
20
+      --help   Print usage
21
+```
19 22
 
20 23
 Enables a plugin. The plugin must be installed before it can be enabled,
21 24
 see [`docker plugin install`](plugin_install.md).
... ...
@@ -11,12 +11,14 @@ parent = "smn_cli"
11 11
 
12 12
 # plugin inspect (experimental)
13 13
 
14
-    Usage: docker plugin inspect PLUGIN
14
+```markdown
15
+Usage:  docker plugin inspect PLUGIN
15 16
 
16
-    Return low-level information about a plugin
17
-
18
-      --help              Print usage
17
+Inspect a plugin
19 18
 
19
+Options:
20
+      --help   Print usage
21
+```
20 22
 
21 23
 Returns information about a plugin. By default, this command renders all results
22 24
 in a JSON array.
... ...
@@ -11,11 +11,16 @@ parent = "smn_cli"
11 11
 
12 12
 # plugin install (experimental)
13 13
 
14
-    Usage: docker plugin install PLUGIN
14
+```markdown
15
+Usage:  docker plugin install PLUGIN [OPTIONS]
15 16
 
16
-    Install a plugin
17
+Install a plugin
17 18
 
18
-      --help             Print usage
19
+Options:
20
+      --disable                 do not enable the plugin on install
21
+      --grant-all-permissions   grant all permissions necessary to run the plugin
22
+      --help                    Print usage
23
+```
19 24
 
20 25
 Installs and enables a plugin. Docker looks first for the plugin on your Docker
21 26
 host. If the plugin does not exist locally, then the plugin is pulled from
... ...
@@ -11,14 +11,17 @@ parent = "smn_cli"
11 11
 
12 12
 # plugin ls (experimental)
13 13
 
14
-    Usage: docker plugin ls
14
+```markdown
15
+Usage:  docker plugin ls
15 16
 
16
-    List plugins
17
+List plugins
17 18
 
18
-      --help   Print usage
19
+Aliases:
20
+  ls, list
19 21
 
20
-    Aliases:
21
-      ls, list
22
+Options:
23
+      --help   Print usage
24
+```
22 25
 
23 26
 Lists all the plugins that are currently installed. You can install plugins
24 27
 using the [`docker plugin install`](plugin_install.md) command.
... ...
@@ -11,14 +11,17 @@ parent = "smn_cli"
11 11
 
12 12
 # plugin rm (experimental)
13 13
 
14
-    Usage: docker plugin rm PLUGIN
14
+```markdown
15
+Usage:  docker plugin rm PLUGIN
15 16
 
16
-    Remove a plugin
17
+Remove a plugin
17 18
 
18
-      --help             Print usage
19
+Aliases:
20
+  rm, remove
19 21
 
20
-    Aliases:
21
-      rm, remove
22
+Options:
23
+      --help   Print usage
24
+```
22 25
 
23 26
 Removes a plugin. You cannot remove a plugin if it is active, you must disable
24 27
 a plugin using the [`docker plugin disable`](plugin_disable.md) before removing
... ...
@@ -10,12 +10,14 @@ parent = "smn_cli"
10 10
 
11 11
 # port
12 12
 
13
-    Usage: docker port [OPTIONS] CONTAINER [PRIVATE_PORT[/PROTO]]
13
+```markdown
14
+Usage:  docker port CONTAINER [PRIVATE_PORT[/PROTO]]
14 15
 
15
-    List port mappings for the CONTAINER, or lookup the public-facing port that is
16
-	NAT-ed to the PRIVATE_PORT
16
+List port mappings or a specific mapping for the container
17 17
 
18
-      --help          Print usage
18
+Options:
19
+      --help   Print usage
20
+```
19 21
 
20 22
 You can find out all the ports mapped by not specifying a `PRIVATE_PORT`, or
21 23
 just a specific mapping:
... ...
@@ -10,28 +10,31 @@ parent = "smn_cli"
10 10
 
11 11
 # ps
12 12
 
13
-    Usage: docker ps [OPTIONS]
14
-
15
-    List containers
16
-
17
-      -a, --all             Show all containers (default shows just running)
18
-      -f, --filter=[]       Filter output based on these conditions:
19
-                            - exited=<int> an exit code of <int>
20
-                            - label=<key> or label=<key>=<value>
21
-                            - status=(created|restarting|running|paused|exited)
22
-                            - name=<string> a container's name
23
-                            - id=<ID> a container's ID
24
-                            - before=(<container-name>|<container-id>)
25
-                            - since=(<container-name>|<container-id>)
26
-                            - ancestor=(<image-name>[:tag]|<image-id>|<image@digest>) - containers created from an image or a descendant.
27
-                            - volume=(<volume-name>|<mount-point>)
28
-      --format=[]           Pretty-print containers using a Go template
29
-      --help                Print usage
30
-      -l, --latest          Show the latest created container (includes all states)
31
-      -n=-1                 Show n last created containers (includes all states)
32
-      --no-trunc            Don't truncate output
33
-      -q, --quiet           Only display numeric IDs
34
-      -s, --size            Display total file sizes
13
+```markdown
14
+Usage: docker ps [OPTIONS]
15
+
16
+List containers
17
+
18
+Options:
19
+  -a, --all             Show all containers (default shows just running)
20
+  -f, --filter value    Filter output based on conditions provided (default [])
21
+                        - exited=<int> an exit code of <int>
22
+                        - label=<key> or label=<key>=<value>
23
+                        - status=(created|restarting|running|paused|exited)
24
+                        - name=<string> a container's name
25
+                        - id=<ID> a container's ID
26
+                        - before=(<container-name>|<container-id>)
27
+                        - since=(<container-name>|<container-id>)
28
+                        - ancestor=(<image-name>[:tag]|<image-id>|<image@digest>)
29
+                          containers created from an image or a descendant.
30
+      --format string   Pretty-print containers using a Go template
31
+      --help            Print usage
32
+  -n, --last int        Show n last created containers (includes all states) (default -1)
33
+  -l, --latest          Show the latest created container (includes all states)
34
+      --no-trunc        Don't truncate output
35
+  -q, --quiet           Only display numeric IDs
36
+  -s, --size            Display total file sizes
37
+```
35 38
 
36 39
 Running `docker ps --no-trunc` showing 2 linked containers.
37 40
 
... ...
@@ -10,13 +10,16 @@ parent = "smn_cli"
10 10
 
11 11
 # pull
12 12
 
13
-    Usage: docker pull [OPTIONS] NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
13
+```markdown
14
+Usage:  docker pull [OPTIONS] NAME[:TAG|@DIGEST]
14 15
 
15
-    Pull an image or a repository from the registry
16
+Pull an image or a repository from a registry
16 17
 
17
-      -a, --all-tags                Download all tagged images in the repository
18
-      --disable-content-trust=true  Skip image verification
19
-      --help                        Print usage
18
+Options:
19
+  -a, --all-tags                Download all tagged images in the repository
20
+      --disable-content-trust   Skip image verification (default true)
21
+      --help                    Print usage
22
+```
20 23
 
21 24
 Most of your images will be created on top of a base image from the
22 25
 [Docker Hub](https://hub.docker.com) registry.
... ...
@@ -10,12 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # push
12 12
 
13
-    Usage: docker push [OPTIONS] NAME[:TAG]
13
+```markdown
14
+Usage:  docker push [OPTIONS] NAME[:TAG]
14 15
 
15
-    Push an image or a repository to the registry
16
+Push an image or a repository to a registry
16 17
 
17
-      --disable-content-trust=true   Skip image signing
18
-      --help                         Print usage
18
+Options:
19
+      --disable-content-trust   Skip image verification (default true)
20
+      --help                    Print usage
21
+```
19 22
 
20 23
 Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com)
21 24
 registry or to a self-hosted one.
... ...
@@ -10,10 +10,13 @@ parent = "smn_cli"
10 10
 
11 11
 # rename
12 12
 
13
-    Usage: docker rename [OPTIONS] OLD_NAME NEW_NAME
13
+```markdown
14
+Usage:  docker rename OLD_NAME NEW_NAME
14 15
 
15
-    Rename a container
16
+Rename a container
16 17
 
17
-      --help          Print usage
18
+Options:
19
+      --help   Print usage
20
+```
18 21
 
19 22
 The `docker rename` command allows the container to be renamed to a different name.
... ...
@@ -10,9 +10,12 @@ parent = "smn_cli"
10 10
 
11 11
 # restart
12 12
 
13
-    Usage: docker restart [OPTIONS] CONTAINER [CONTAINER...]
13
+```markdown
14
+Usage:  docker restart [OPTIONS] CONTAINER [CONTAINER...]
14 15
 
15
-    Restart a container
16
+Restart a container
16 17
 
17
-      --help             Print usage
18
-      -t, --time=10      Seconds to wait for stop before killing the container
18
+Options:
19
+      --help       Print usage
20
+  -t, --time int   Seconds to wait for stop before killing the container (default 10)
21
+```
... ...
@@ -10,14 +10,17 @@ parent = "smn_cli"
10 10
 
11 11
 # rm
12 12
 
13
-    Usage: docker rm [OPTIONS] CONTAINER [CONTAINER...]
13
+```markdown
14
+Usage:  docker rm [OPTIONS] CONTAINER [CONTAINER...]
14 15
 
15
-    Remove one or more containers
16
+Remove one or more containers
16 17
 
17
-      -f, --force            Force the removal of a running container (uses SIGKILL)
18
-      --help                 Print usage
19
-      -l, --link             Remove the specified link
20
-      -v, --volumes          Remove the volumes associated with the container
18
+Options:
19
+  -f, --force     Force the removal of a running container (uses SIGKILL)
20
+      --help      Print usage
21
+  -l, --link      Remove the specified link
22
+  -v, --volumes   Remove the volumes associated with the container
23
+```
21 24
 
22 25
 ## Examples
23 26
 
... ...
@@ -10,13 +10,16 @@ parent = "smn_cli"
10 10
 
11 11
 # rmi
12 12
 
13
-    Usage: docker rmi [OPTIONS] IMAGE [IMAGE...]
13
+```markdown
14
+Usage:  docker rmi [OPTIONS] IMAGE [IMAGE...]
14 15
 
15
-    Remove one or more images
16
+Remove one or more images
16 17
 
17
-      -f, --force          Force removal of the image
18
-      --help               Print usage
19
-      --no-prune           Do not delete untagged parents
18
+Options:
19
+  -f, --force      Force removal of the image
20
+      --help       Print usage
21
+      --no-prune   Do not delete untagged parents
22
+```
20 23
 
21 24
 You can remove an image using its short or long ID, its tag, or its digest. If
22 25
 an image has one or more tag referencing it, you must remove all of them before
... ...
@@ -10,109 +10,120 @@ parent = "smn_cli"
10 10
 
11 11
 # run
12 12
 
13
-    Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...]
14
-
15
-    Run a command in a new container
16
-
17
-      -a, --attach=[]               Attach to STDIN, STDOUT or STDERR
18
-      --add-host=[]                 Add a custom host-to-IP mapping (host:ip)
19
-      --blkio-weight=0              Block IO weight (relative weight)
20
-      --blkio-weight-device=[]      Block IO weight (relative device weight, format: `DEVICE_NAME:WEIGHT`)
21
-      --cpu-shares=0                CPU shares (relative weight)
22
-      --cap-add=[]                  Add Linux capabilities
23
-      --cap-drop=[]                 Drop Linux capabilities
24
-      --cgroup-parent=""            Optional parent cgroup for the container
25
-      --cidfile=""                  Write the container ID to the file
26
-      --cpu-percent=0               Limit percentage of CPU available for execution by the container. Windows daemon only.
27
-      --cpu-period=0                Limit CPU CFS (Completely Fair Scheduler) period
28
-      --cpu-quota=0                 Limit CPU CFS (Completely Fair Scheduler) quota
29
-      --cpuset-cpus=""              CPUs in which to allow execution (0-3, 0,1)
30
-      --cpuset-mems=""              Memory nodes (MEMs) in which to allow execution (0-3, 0,1)
31
-      -d, --detach                  Run container in background and print container ID
32
-      --detach-keys                 Specify the escape key sequence used to detach a container
33
-      --device=[]                   Add a host device to the container
34
-      --device-read-bps=[]          Limit read rate (bytes per second) from a device (e.g., --device-read-bps=/dev/sda:1mb)
35
-      --device-read-iops=[]         Limit read rate (IO per second) from a device (e.g., --device-read-iops=/dev/sda:1000)
36
-      --device-write-bps=[]         Limit write rate (bytes per second) to a device (e.g., --device-write-bps=/dev/sda:1mb)
37
-      --device-write-iops=[]        Limit write rate (IO per second) to a device (e.g., --device-write-bps=/dev/sda:1000)
38
-      --disable-content-trust=true  Skip image verification
39
-      --dns=[]                      Set custom DNS servers
40
-      --dns-opt=[]                  Set custom DNS options
41
-      --dns-search=[]               Set custom DNS search domains
42
-      -e, --env=[]                  Set environment variables
43
-      --entrypoint=""               Overwrite the default ENTRYPOINT of the image
44
-      --env-file=[]                 Read in a file of environment variables
45
-      --expose=[]                   Expose a port or a range of ports
46
-      --group-add=[]                Add additional groups to run as
47
-      -h, --hostname=""             Container host name
13
+```markdown
14
+Usage:  docker run [OPTIONS] IMAGE [COMMAND] [ARG...]
15
+
16
+Run a command in a new container
17
+
18
+Options:
19
+      --add-host value              Add a custom host-to-IP mapping (host:ip) (default [])
20
+  -a, --attach value                Attach to STDIN, STDOUT or STDERR (default [])
21
+      --blkio-weight value          Block IO (relative weight), between 10 and 1000
22
+      --blkio-weight-device value   Block IO weight (relative device weight) (default [])
23
+      --cap-add value               Add Linux capabilities (default [])
24
+      --cap-drop value              Drop Linux capabilities (default [])
25
+      --cgroup-parent string        Optional parent cgroup for the container
26
+      --cidfile string              Write the container ID to the file
27
+      --cpu-percent int             CPU percent (Windows only)
28
+      --cpu-period int              Limit CPU CFS (Completely Fair Scheduler) period
29
+      --cpu-quota int               Limit CPU CFS (Completely Fair Scheduler) quota
30
+  -c, --cpu-shares int              CPU shares (relative weight)
31
+      --cpuset-cpus string          CPUs in which to allow execution (0-3, 0,1)
32
+      --cpuset-mems string          MEMs in which to allow execution (0-3, 0,1)
33
+  -d, --detach                      Run container in background and print container ID
34
+      --detach-keys string          Override the key sequence for detaching a container
35
+      --device value                Add a host device to the container (default [])
36
+      --device-read-bps value       Limit read rate (bytes per second) from a device (default [])
37
+      --device-read-iops value      Limit read rate (IO per second) from a device (default [])
38
+      --device-write-bps value      Limit write rate (bytes per second) to a device (default [])
39
+      --device-write-iops value     Limit write rate (IO per second) to a device (default [])
40
+      --disable-content-trust       Skip image verification (default true)
41
+      --dns value                   Set custom DNS servers (default [])
42
+      --dns-opt value               Set DNS options (default [])
43
+      --dns-search value            Set custom DNS search domains (default [])
44
+      --entrypoint string           Overwrite the default ENTRYPOINT of the image
45
+  -e, --env value                   Set environment variables (default [])
46
+      --env-file value              Read in a file of environment variables (default [])
47
+      --expose value                Expose a port or a range of ports (default [])
48
+      --group-add value             Add additional groups to join (default [])
49
+      --health-cmd string           Command to run to check health
50
+      --health-interval duration    Time between running the check
51
+      --health-retries int          Consecutive failures needed to report unhealthy
52
+      --health-timeout duration     Maximum time to allow one check to run
48 53
       --help                        Print usage
49
-      -i, --interactive             Keep STDIN open even if not attached
50
-      --ip=""                       Container IPv4 address (e.g. 172.30.100.104)
51
-      --ip6=""                      Container IPv6 address (e.g. 2001:db8::33)
52
-      --ipc=""                      IPC namespace to use
53
-      --isolation=""                Container isolation technology
54
-      --kernel-memory=""            Kernel memory limit
55
-      -l, --label=[]                Set metadata on the container (e.g., --label=com.example.key=value)
56
-      --label-file=[]               Read in a file of labels (EOL delimited)
57
-      --link=[]                     Add link to another container
58
-      --link-local-ip=[]            Container IPv4/IPv6 link-local addresses (e.g. 169.254.0.77, fe80::77)
59
-      --log-driver=""               Logging driver for container
60
-      --log-opt=[]                  Log driver specific options
61
-      -m, --memory=""               Memory limit
62
-      --mac-address=""              Container MAC address (e.g. 92:d0:c6:0a:29:33)
63
-      --io-maxbandwidth=""          Maximum IO bandwidth limit for the system drive
54
+  -h, --hostname string             Container host name
55
+  -i, --interactive                 Keep STDIN open even if not attached
56
+      --io-maxbandwidth string      Maximum IO bandwidth limit for the system drive (Windows only)
64 57
                                     (Windows only). The format is `<number><unit>`.
65 58
                                     Unit is optional and can be `b` (bytes per second),
66 59
                                     `k` (kilobytes per second), `m` (megabytes per second),
67 60
                                     or `g` (gigabytes per second). If you omit the unit,
68 61
                                     the system uses bytes per second.
69 62
                                     --io-maxbandwidth and --io-maxiops are mutually exclusive options.
70
-      --io-maxiops=0                Maximum IO per second limit for the system drive (Windows only).
71
-                                    --io-maxbandwidth and --io-maxiops are mutually exclusive options.
72
-      --memory-reservation=""       Memory soft limit
73
-      --memory-swap=""              A positive integer equal to memory plus swap. Specify -1 to enable unlimited swap.
74
-      --memory-swappiness=""        Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
75
-      --name=""                     Assign a name to the container
76
-      --net="bridge"                Connect a container to a network
63
+      --io-maxiops uint             Maximum IOps limit for the system drive (Windows only)
64
+      --ip string                   Container IPv4 address (e.g. 172.30.100.104)
65
+      --ip6 string                  Container IPv6 address (e.g. 2001:db8::33)
66
+      --ipc string                  IPC namespace to use
67
+      --isolation string            Container isolation technology
68
+      --kernel-memory string        Kernel memory limit
69
+  -l, --label value                 Set meta data on a container (default [])
70
+      --label-file value            Read in a line delimited file of labels (default [])
71
+      --link value                  Add link to another container (default [])
72
+      --link-local-ip value         Container IPv4/IPv6 link-local addresses (default [])
73
+      --log-driver string           Logging driver for container
74
+      --log-opt value               Log driver options (default [])
75
+      --mac-address string          Container MAC address (e.g. 92:d0:c6:0a:29:33)
76
+  -m, --memory string               Memory limit
77
+      --memory-reservation string   Memory soft limit
78
+      --memory-swap string          Swap limit equal to memory plus swap: '-1' to enable unlimited swap
79
+      --memory-swappiness int       Tune container memory swappiness (0 to 100) (default -1).
80
+      --name string                 Assign a name to the container
81
+      --net string                  Connect a container to a network (default "default")
77 82
                                     'bridge': create a network stack on the default Docker bridge
78 83
                                     'none': no networking
79 84
                                     'container:<name|id>': reuse another container's network stack
80 85
                                     'host': use the Docker host network stack
81 86
                                     '<network-name>|<network-id>': connect to a user-defined network
82
-      --net-alias=[]                Add network-scoped alias for the container
83
-      --oom-kill-disable            Whether to disable OOM Killer for the container or not
84
-      --oom-score-adj=0             Tune the host's OOM preferences for containers (accepts -1000 to 1000)
85
-      -P, --publish-all             Publish all exposed ports to random ports
86
-      -p, --publish=[]              Publish a container's port(s) to the host
87
-      --pid=""                      PID namespace to use
88
-      --pids-limit=-1                Tune container pids limit (set -1 for unlimited), kernel >= 4.3
87
+      --net-alias value             Add network-scoped alias for the container (default [])
88
+      --no-healthcheck              Disable any container-specified HEALTHCHECK
89
+      --oom-kill-disable            Disable OOM Killer
90
+      --oom-score-adj int           Tune host's OOM preferences (-1000 to 1000)
91
+      --pid string                  PID namespace to use
92
+      --pids-limit int              Tune container pids limit (set -1 for unlimited)
89 93
       --privileged                  Give extended privileges to this container
94
+  -p, --publish value               Publish a container's port(s) to the host (default [])
95
+  -P, --publish-all                 Publish all exposed ports to random ports
90 96
       --read-only                   Mount the container's root filesystem as read only
91
-      --restart="no"                Restart policy (no, on-failure[:max-retry], always, unless-stopped)
97
+      --restart string              Restart policy to apply when a container exits (default "no")
98
+                                    Possible values are : no, on-failuer[:max-retry], always, unless-stopped
92 99
       --rm                          Automatically remove the container when it exits
93
-      --runtime=""                  Name of the runtime to be used for that container
94
-      --shm-size=[]                 Size of `/dev/shm`. The format is `<number><unit>`. `number` must be greater than `0`.  Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`.
95
-      --security-opt=[]             Security Options
96
-      --sig-proxy=true              Proxy received signals to the process
97
-      --stop-signal="SIGTERM"       Signal to stop a container
98
-      --storage-opt=[]              Set storage driver options per container
99
-      --sysctl[=*[]*]]              Configure namespaced kernel parameters at runtime
100
-      -t, --tty                     Allocate a pseudo-TTY
101
-      -u, --user=""                 Username or UID (format: <name|uid>[:<group|gid>])
102
-      --userns=""                   Container user namespace
100
+      --runtime string              Runtime to use for this container
101
+      --security-opt value          Security Options (default [])
102
+      --shm-size string             Size of /dev/shm, default value is 64MB.
103
+                                    The format is `<number><unit>`. `number` must be greater than `0`.
104
+                                    Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes),
105
+                                    or `g` (gigabytes). If you omit the unit, the system uses bytes.
106
+      --sig-proxy                   Proxy received signals to the process (default true)
107
+      --stop-signal string          Signal to stop a container, SIGTERM by default (default "SIGTERM")
108
+      --storage-opt value           Set storage driver options per container (default [])
109
+      --sysctl value                Sysctl options (default map[])
110
+      --tmpfs value                 Mount a tmpfs directory (default [])
111
+  -t, --tty                         Allocate a pseudo-TTY
112
+      --ulimit value                Ulimit options (default [])
113
+  -u, --user string                 Username or UID (format: <name|uid>[:<group|gid>])
114
+      --userns string               User namespace to use
103 115
                                     'host': Use the Docker host user namespace
104 116
                                     '': Use the Docker daemon user namespace specified by `--userns-remap` option.
105
-      --ulimit=[]                   Ulimit options
106
-      --uts=""                      UTS namespace to use
107
-      -v, --volume=[host-src:]container-dest[:<options>]
108
-                                    Bind mount a volume. The comma-delimited
117
+      --uts string                  UTS namespace to use
118
+  -v, --volume value                Bind mount a volume (default []). The comma-delimited
109 119
                                     `options` are [rw|ro], [z|Z],
110 120
                                     [[r]shared|[r]slave|[r]private], and
111 121
                                     [nocopy]. The 'host-src' is an absolute path
112 122
                                     or a name value.
113
-      --volume-driver=""            Container's volume driver
114
-      --volumes-from=[]             Mount volumes from the specified container(s)
115
-      -w, --workdir=""              Working directory inside the container
123
+      --volume-driver string        Optional volume driver for the container
124
+      --volumes-from value          Mount volumes from the specified container(s) (default [])
125
+  -w, --workdir string              Working directory inside the container
126
+```
116 127
 
117 128
 The `docker run` command first `creates` a writeable container layer over the
118 129
 specified image, and then `starts` it using the specified command. That is,
... ...
@@ -10,12 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # save
12 12
 
13
-    Usage: docker save [OPTIONS] IMAGE [IMAGE...]
13
+```markdown
14
+Usage:  docker save [OPTIONS] IMAGE [IMAGE...]
14 15
 
15
-    Save one or more images to a tar archive (streamed to STDOUT by default)
16
+Save one or more images to a tar archive (streamed to STDOUT by default)
16 17
 
17
-      --help             Print usage
18
-      -o, --output=""    Write to a file, instead of STDOUT
18
+Options:
19
+      --help            Print usage
20
+  -o, --output string   Write to a file, instead of STDOUT
21
+```
19 22
 
20 23
 Produces a tarred repository to the standard output stream.
21 24
 Contains all parent layers, and all tags + versions, or specified `repo:tag`, for
... ...
@@ -10,17 +10,20 @@ parent = "smn_cli"
10 10
 
11 11
 # search
12 12
 
13
-    Usage: docker search [OPTIONS] TERM
14
-
15
-    Search the Docker Hub for images
16
-
17
-      --filter=[]          Filter output based on these conditions:
18
-                           - is-automated=(true|false)
19
-                           - is-official=(true|false)
20
-                           - stars=<number> - image has at least 'number' stars
21
-      --help               Print usage
22
-      --limit=25           Maximum returned search results
23
-      --no-trunc           Don't truncate output
13
+```markdown
14
+Usage:  docker search [OPTIONS] TERM
15
+
16
+Search the Docker Hub for images
17
+
18
+Options:
19
+  -f, --filter value   Filter output based on conditions provided (default [])
20
+                       - is-automated=(true|false)
21
+                       - is-official=(true|false)
22
+                       - stars=<number> - image has at least 'number' stars
23
+      --help           Print usage
24
+      --limit int      Max number of search results (default 25)
25
+      --no-trunc       Don't truncate output
26
+```
24 27
 
25 28
 Search [Docker Hub](https://hub.docker.com) for images
26 29
 
... ...
@@ -12,7 +12,7 @@ parent = "smn_cli"
12 12
 # service create
13 13
 
14 14
 ```Markdown
15
-Usage:	docker service create [OPTIONS] IMAGE [COMMAND] [ARG...]
15
+Usage:  docker service create [OPTIONS] IMAGE [COMMAND] [ARG...]
16 16
 
17 17
 Create a new service
18 18
 
... ...
@@ -29,6 +29,7 @@ Options:
29 29
       --name string                  Service name
30 30
       --network value                Network attachments (default [])
31 31
   -p, --publish value                Publish a port as a node port (default [])
32
+      --registry-auth                Send registry authentication details to Swarm agents
32 33
       --replicas value               Number of tasks (default none)
33 34
       --reserve-cpu value            Reserve CPUs (default 0.000)
34 35
       --reserve-memory value         Reserve Memory (default 0 B)
... ...
@@ -12,7 +12,7 @@ parent = "smn_cli"
12 12
 # service inspect
13 13
 
14 14
 ```Markdown
15
-Usage:	docker service inspect [OPTIONS] SERVICE [SERVICE...]
15
+Usage:  docker service inspect [OPTIONS] SERVICE [SERVICE...]
16 16
 
17 17
 Display detailed information on one or more services
18 18
 
... ...
@@ -12,8 +12,6 @@ parent = "smn_cli"
12 12
 # service ls
13 13
 
14 14
 ```Markdown
15
-docker service ls --help
16
-
17 15
 Usage:	docker service ls [OPTIONS]
18 16
 
19 17
 List services
... ...
@@ -11,13 +11,14 @@ parent = "smn_cli"
11 11
 
12 12
 # service scale
13 13
 
14
-    Usage:	docker service scale SERVICE=REPLICAS [SERVICE=REPLICAS...]
14
+```markdown
15
+Usage:  docker service scale SERVICE=REPLICAS [SERVICE=REPLICAS...]
15 16
 
16
-    Scale one or multiple services
17
-
18
-    Options:
19
-          --help   Print usage
17
+Scale one or multiple services
20 18
 
19
+Options:
20
+      --help   Print usage
21
+```
21 22
 
22 23
 ## Examples
23 24
 
... ...
@@ -53,8 +53,8 @@ bk658fpbex0d57cqcwoe3jthu  redis.2   redis   redis:3.0.6  Running 9 seconds   Ru
53 53
 
54 54
 The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there
55 55
 is more than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`).
56
-Multiple filter flags are combined as an `OR` filter. For example, 
57
-`-f type=custom -f type=builtin` returns both `custom` and `builtin` networks.
56
+Multiple filter flags are combined as an `OR` filter. For example,
57
+`-f name=redis.1 -f name=redis.7` returns both `redis.1` and `redis.7` tasks.
58 58
 
59 59
 The currently supported filters are:
60 60
 
... ...
@@ -12,7 +12,7 @@ parent = "smn_cli"
12 12
 # service update
13 13
 
14 14
 ```Markdown
15
-Usage:	docker service update [OPTIONS] SERVICE
15
+Usage:  docker service update [OPTIONS] SERVICE
16 16
 
17 17
 Update a service
18 18
 
... ...
@@ -27,11 +27,11 @@ Options:
27 27
   -l, --label value                  Service labels (default [])
28 28
       --limit-cpu value              Limit CPUs (default 0.000)
29 29
       --limit-memory value           Limit Memory (default 0 B)
30
-      --mode string                  Service mode (replicated or global) (default "replicated")
31 30
   -m, --mount value                  Attach a mount to the service
32 31
       --name string                  Service name
33 32
       --network value                Network attachments (default [])
34 33
   -p, --publish value                Publish a port as a node port (default [])
34
+      --registry-auth                Send registry authentication details to Swarm agents
35 35
       --replicas value               Number of tasks (default none)
36 36
       --reserve-cpu value            Reserve CPUs (default 0.000)
37 37
       --reserve-memory value         Reserve Memory (default 0 B)
... ...
@@ -10,11 +10,14 @@ parent = "smn_cli"
10 10
 
11 11
 # start
12 12
 
13
-    Usage: docker start [OPTIONS] CONTAINER [CONTAINER...]
13
+```markdown
14
+Usage:  docker start [OPTIONS] CONTAINER [CONTAINER...]
14 15
 
15
-    Start one or more containers
16
+Start one or more stopped containers
16 17
 
17
-      -a, --attach               Attach STDOUT/STDERR and forward signals
18
-      --detach-keys              Specify the escape key sequence used to detach a container
19
-      --help                     Print usage
20
-      -i, --interactive          Attach container's STDIN
18
+Options:
19
+  -a, --attach               Attach STDOUT/STDERR and forward signals
20
+      --detach-keys string   Override the key sequence for detaching a container
21
+      --help                 Print usage
22
+  -i, --interactive          Attach container's STDIN
23
+```
... ...
@@ -10,13 +10,16 @@ parent = "smn_cli"
10 10
 
11 11
 # stats
12 12
 
13
-    Usage: docker stats [OPTIONS] [CONTAINER...]
13
+```markdown
14
+Usage:  docker stats [OPTIONS] [CONTAINER...]
14 15
 
15
-    Display a live stream of one or more containers' resource usage statistics
16
+Display a live stream of container(s) resource usage statistics
16 17
 
17
-      -a, --all          Show all containers (default shows just running)
18
-      --help             Print usage
19
-      --no-stream        Disable streaming stats and only pull the first result
18
+Options:
19
+  -a, --all         Show all containers (default shows just running)
20
+      --help        Print usage
21
+      --no-stream   Disable streaming stats and only pull the first result
22
+```
20 23
 
21 24
 The `docker stats` command returns a live data stream for running containers. To limit data to one or more specific containers, specify a list of container names or ids separated by a space. You can specify a stopped container but stopped containers do not return any data.
22 25
 
... ...
@@ -10,13 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # stop
12 12
 
13
-    Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
13
+```markdown
14
+Usage:  docker stop [OPTIONS] CONTAINER [CONTAINER...]
14 15
 
15
-    Stop a container by sending SIGTERM and then SIGKILL after a
16
-    grace period
16
+Stop one or more running containers
17 17
 
18
-      --help             Print usage
19
-      -t, --time=10      Seconds to wait for stop before killing it
18
+Options:
19
+      --help       Print usage
20
+  -t, --time int   Seconds to wait for stop before killing it (default 10)
21
+```
20 22
 
21 23
 The main process inside the container will receive `SIGTERM`, and after a grace
22 24
 period, `SIGKILL`.
... ...
@@ -11,17 +11,22 @@ parent = "smn_cli"
11 11
 
12 12
 # swarm init
13 13
 
14
-	Usage:	docker swarm init [OPTIONS]
15
-
16
-	Initialize a Swarm.
17
-
18
-	Options:
19
-	      --auto-accept value   Acceptance policy (default [worker,manager])
20
-	      --external-ca value   Specifications of one or more certificate signing endpoints
21
-	      --force-new-cluster   Force create a new cluster from current state.
22
-	      --help                Print usage
23
-	      --listen-addr value   Listen address (default 0.0.0.0:2377)
24
-	      --secret string       Set secret value needed to accept nodes into cluster
14
+```markdown
15
+Usage:  docker swarm init [OPTIONS]
16
+
17
+Initialize a Swarm
18
+
19
+Options:
20
+      --auto-accept value               Auto acceptance policy (worker, manager or none)
21
+      --cert-expiry duration            Validity period for node certificates (default 2160h0m0s)
22
+      --dispatcher-heartbeat duration   Dispatcher heartbeat period (default 5s)
23
+      --external-ca value               Specifications of one or more certificate signing endpoints
24
+      --force-new-cluster               Force create a new cluster from current state.
25
+      --help                            Print usage
26
+      --listen-addr value               Listen address (default 0.0.0.0:2377)
27
+      --secret string                   Set secret value needed to accept nodes into cluster
28
+      --task-history-limit int          Task history retention limit (default 10)
29
+```
25 30
 
26 31
 Initialize a Swarm cluster. The docker engine targeted by this command becomes a manager
27 32
 in the newly created one node Swarm cluster.
... ...
@@ -61,6 +66,15 @@ For example, the following initializes a cluster with auto-acceptance of workers
61 61
 $ docker swarm init --listen-addr 192.168.99.121:2377 --auto-accept worker
62 62
 ```
63 63
 
64
+### `--cert-expiry`
65
+
66
+This flag sets the validity period for node certificates.
67
+
68
+### `--dispatcher-heartbeat`
69
+
70
+This flags sets the frequency with which nodes are told to use as a
71
+period to report their health.
72
+
64 73
 ### `--external-ca value`
65 74
 
66 75
 This flag sets up the swarm to use an external CA to issue node certificates. The value takes
... ...
@@ -80,6 +94,10 @@ The node listens for inbound Swarm manager traffic on this IP:PORT
80 80
 
81 81
 Secret value needed to accept nodes into the Swarm
82 82
 
83
+### `--task-history-limit`
84
+
85
+This flag sets up task history retention limit.
86
+
83 87
 ## Related information
84 88
 
85 89
 * [swarm join](swarm_join.md)
... ...
@@ -11,15 +11,18 @@ parent = "smn_cli"
11 11
 
12 12
 # swarm join
13 13
 
14
-	Usage:	docker swarm join [OPTIONS] HOST:PORT
14
+```markdown
15
+Usage:  docker swarm join [OPTIONS] HOST:PORT
15 16
 
16
-	Join a Swarm as a node and/or manager.
17
+Join a Swarm as a node and/or manager
17 18
 
18
-	Options:
19
-	      --help                Print usage
20
-	      --listen-addr value   Listen address (default 0.0.0.0:2377)
21
-	      --manager             Try joining as a manager.
22
-	      --secret string       Secret for node acceptance
19
+Options:
20
+      --ca-hash string      Hash of the Root Certificate Authority certificate used for trusted join
21
+      --help                Print usage
22
+      --listen-addr value   Listen address (default 0.0.0.0:2377)
23
+      --manager             Try joining as a manager.
24
+      --secret string       Secret for node acceptance
25
+```
23 26
 
24 27
 Join a node to a Swarm cluster. If the `--manager` flag is specified, the docker engine
25 28
 targeted by this command becomes a `manager`. If it is not specified, it becomes a `worker`.
... ...
@@ -47,14 +50,18 @@ dkp8vy1dq1kxleu9g4u78tlag    worker1   Accepted    Ready   Active        Reachab
47 47
 dvfxp4zseq4s0rih1selh0d20 *  manager1  Accepted    Ready   Active        Reachable              Yes
48 48
 ```
49 49
 
50
-### `--manager`
50
+### `--ca-hash`
51 51
 
52
-Joins the node as a manager
52
+Hash of the Root Certificate Authority certificate used for trusted join.
53 53
 
54 54
 ### `--listen-addr value`
55 55
 
56 56
 The node listens for inbound Swarm manager traffic on this IP:PORT
57 57
 
58
+### `--manager`
59
+
60
+Joins the node as a manager
61
+
58 62
 ### `--secret string`
59 63
 
60 64
 Secret value required for nodes to join the swarm
... ...
@@ -11,12 +11,15 @@ parent = "smn_cli"
11 11
 
12 12
 # swarm leave
13 13
 
14
-	Usage:	docker swarm leave
14
+```markdown
15
+Usage:  docker swarm leave [OPTIONS]
15 16
 
16
-	Leave a Swarm swarm.
17
+Leave a Swarm
17 18
 
18
-	Options:
19
-	      --help   Print usage
19
+Options:
20
+      --force   Force leave ignoring warnings.
21
+      --help    Print usage
22
+```
20 23
 
21 24
 This command causes the node to leave the swarm.
22 25
 
... ...
@@ -11,17 +11,20 @@ parent = "smn_cli"
11 11
 
12 12
 # swarm update
13 13
 
14
-    Usage:  docker swarm update [OPTIONS]
15
-
16
-    Update the Swarm.
17
-
18
-    Options:
19
-          --auto-accept value               Auto acceptance policy (worker, manager or none)
20
-          --external-ca value               Specifications of one or more certificate signing endpoints
21
-          --dispatcher-heartbeat duration   Dispatcher heartbeat period (default 5s)
22
-          --help                            Print usage
23
-          --secret string                   Set secret value needed to accept nodes into cluster
24
-          --task-history-limit int          Task history retention limit (default 10)
14
+```markdown
15
+Usage:  docker swarm update [OPTIONS]
16
+
17
+Update the Swarm
18
+
19
+Options:
20
+      --auto-accept value               Auto acceptance policy (worker, manager or none)
21
+      --cert-expiry duration            Validity period for node certificates (default 2160h0m0s)
22
+      --dispatcher-heartbeat duration   Dispatcher heartbeat period (default 5s)
23
+      --external-ca value               Specifications of one or more certificate signing endpoints
24
+      --help                            Print usage
25
+      --secret string                   Set secret value needed to accept nodes into cluster
26
+      --task-history-limit int          Task history retention limit (default 10)
27
+```
25 28
 
26 29
 Updates a Swarm cluster with new parameter values. This command must target a manager node.
27 30
 
... ...
@@ -10,11 +10,14 @@ parent = "smn_cli"
10 10
 
11 11
 # tag
12 12
 
13
-    Usage: docker tag [OPTIONS] NAME[:TAG] NAME[:TAG]
13
+```markdown
14
+Usage:  docker tag IMAGE[:TAG] IMAGE[:TAG]
14 15
 
15
-    Tag an image into a repository
16
+Tag an image into a repository
16 17
 
17
-      --help               Print usage
18
+Options:
19
+      --help   Print usage
20
+```
18 21
 
19 22
 An image name is made up of slash-separated name components, optionally prefixed
20 23
 by a registry hostname. The hostname must comply with standard DNS rules, but
... ...
@@ -10,8 +10,11 @@ parent = "smn_cli"
10 10
 
11 11
 # top
12 12
 
13
-    Usage: docker top [OPTIONS] CONTAINER [ps OPTIONS]
13
+```markdown
14
+Usage:  docker top CONTAINER [ps OPTIONS]
14 15
 
15
-    Display the running processes of a container
16
+Display the running processes of a container
16 17
 
17
-      --help          Print usage
18
+Options:
19
+      --help   Print usage
20
+```
... ...
@@ -10,11 +10,14 @@ parent = "smn_cli"
10 10
 
11 11
 # unpause
12 12
 
13
-    Usage: docker unpause [OPTIONS] CONTAINER [CONTAINER...]
13
+```markdown
14
+Usage:  docker unpause CONTAINER [CONTAINER...]
14 15
 
15
-    Unpause all processes within a container
16
+Unpause all processes within one or more containers
16 17
 
17
-      --help          Print usage
18
+Options:
19
+      --help   Print usage
20
+```
18 21
 
19 22
 The `docker unpause` command uses the cgroups freezer to un-suspend all
20 23
 processes in a container.
... ...
@@ -10,22 +10,25 @@ parent = "smn_cli"
10 10
 
11 11
 ## update
12 12
 
13
-    Usage: docker update [OPTIONS] CONTAINER [CONTAINER...]
14
-
15
-    Update configuration of one or more containers
16
-
17
-      --help=false               Print usage
18
-      --blkio-weight=0           Block IO (relative weight), between 10 and 1000
19
-      --cpu-shares=0             CPU shares (relative weight)
20
-      --cpu-period=0             Limit the CPU CFS (Completely Fair Scheduler) period
21
-      --cpu-quota=0              Limit the CPU CFS (Completely Fair Scheduler) quota
22
-      --cpuset-cpus=""           CPUs in which to allow execution (0-3, 0,1)
23
-      --cpuset-mems=""           Memory nodes (MEMs) in which to allow execution (0-3, 0,1)
24
-      -m, --memory=""            Memory limit
25
-      --memory-reservation=""    Memory soft limit
26
-      --memory-swap=""           A positive integer equal to memory plus swap. Specify -1 to enable unlimited swap
27
-      --kernel-memory=""         Kernel memory limit: container must be stopped
28
-      --restart                  Restart policy to apply when a container exits
13
+```markdown
14
+Usage:  docker update [OPTIONS] CONTAINER [CONTAINER...]
15
+
16
+Update configuration of one or more containers
17
+
18
+Options:
19
+      --blkio-weight value          Block IO (relative weight), between 10 and 1000
20
+      --cpu-period int              Limit CPU CFS (Completely Fair Scheduler) period
21
+      --cpu-quota int               Limit CPU CFS (Completely Fair Scheduler) quota
22
+  -c, --cpu-shares int              CPU shares (relative weight)
23
+      --cpuset-cpus string          CPUs in which to allow execution (0-3, 0,1)
24
+      --cpuset-mems string          MEMs in which to allow execution (0-3, 0,1)
25
+      --help                        Print usage
26
+      --kernel-memory string        Kernel memory limit
27
+  -m, --memory string               Memory limit
28
+      --memory-reservation string   Memory soft limit
29
+      --memory-swap string          Swap limit equal to memory plus swap: '-1' to enable unlimited swap
30
+      --restart string              Restart policy to apply when a container exits
31
+```
29 32
 
30 33
 The `docker update` command dynamically updates container configuration.
31 34
 You can use this command to prevent containers from consuming too many resources
... ...
@@ -10,12 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # version
12 12
 
13
-    Usage: docker version [OPTIONS]
13
+```markdown
14
+Usage:  docker version [OPTIONS]
14 15
 
15
-    Show the Docker version information.
16
+Show the Docker version information
16 17
 
17
-      -f, --format=""    Format the output using the given go template
18
-      --help             Print usage
18
+Options:
19
+  -f, --format string   Format the output using the given go template
20
+      --help            Print usage
21
+```
19 22
 
20 23
 By default, this will render all version information in an easy to read
21 24
 layout. If a format is specified, the given template will be executed instead.
... ...
@@ -10,15 +10,18 @@ parent = "smn_cli"
10 10
 
11 11
 # volume create
12 12
 
13
-    Usage: docker volume create [OPTIONS]
13
+```markdown
14
+Usage:  docker volume create [OPTIONS]
14 15
 
15
-    Create a volume
16
+Create a volume
16 17
 
17
-      -d, --driver=local    Specify volume driver name
18
-      --help                Print usage
19
-      --label=[]            Set metadata for a volume
20
-      --name=               Specify volume name
21
-      -o, --opt=map[]       Set driver specific options
18
+Options:
19
+  -d, --driver string   Specify volume driver name (default "local")
20
+      --help            Print usage
21
+      --label value     Set metadata for a volume (default [])
22
+      --name string     Specify volume name
23
+  -o, --opt value       Set driver specific options (default map[])
24
+```
22 25
 
23 26
 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:
24 27
 
... ...
@@ -10,12 +10,15 @@ parent = "smn_cli"
10 10
 
11 11
 # volume inspect
12 12
 
13
-    Usage: docker volume inspect [OPTIONS] VOLUME [VOLUME...]
13
+```markdown
14
+Usage:  docker volume inspect [OPTIONS] VOLUME [VOLUME...]
14 15
 
15
-    Display detailed information on one or more volumes
16
+Display detailed information on one or more volumes
16 17
 
17
-      -f, --format=       Format the output using the given go template.
18
-      --help              Print usage
18
+Options:
19
+  -f, --format string   Format the output using the given go template
20
+      --help            Print usage
21
+```
19 22
 
20 23
 Returns information about a volume. By default, this command renders all results
21 24
 in a JSON array. You can specify an alternate format to execute a
... ...
@@ -10,16 +10,22 @@ parent = "smn_cli"
10 10
 
11 11
 # volume ls
12 12
 
13
-    Usage: docker volume ls [OPTIONS]
14
-
15
-    List volumes
16
-
17
-      -f, --filter=[]      Filter output based on these conditions:
18
-                           - dangling=<boolean> a volume if referenced or not
19
-                           - driver=<string> a volume's driver name
20
-                           - name=<string> a volume's name
21
-      --help               Print usage
22
-      -q, --quiet          Only display volume names
13
+```markdown
14
+Usage:  docker volume ls [OPTIONS]
15
+
16
+List volumes
17
+
18
+Aliases:
19
+  ls, list
20
+
21
+Options:
22
+  -f, --filter value   Provide filter values (i.e. 'dangling=true') (default [])
23
+                       - dangling=<boolean> a volume if referenced or not
24
+                       - driver=<string> a volume's driver name
25
+                       - name=<string> a volume's name
26
+      --help           Print usage
27
+  -q, --quiet          Only display volume names
28
+```
23 29
 
24 30
 Lists all the volumes Docker knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section for more information about available filter options.
25 31
 
... ...
@@ -10,11 +10,17 @@ parent = "smn_cli"
10 10
 
11 11
 # volume rm
12 12
 
13
-    Usage: docker volume rm [OPTIONS] VOLUME [VOLUME...]
13
+```markdown
14
+Usage:  docker volume rm VOLUME [VOLUME]...
14 15
 
15
-    Remove a volume
16
+Remove a volume
16 17
 
17
-      --help             Print usage
18
+Aliases:
19
+  rm, remove
20
+
21
+Options:
22
+      --help   Print usage
23
+```
18 24
 
19 25
 Removes one or more volumes. You cannot remove a volume that is in use by a container.
20 26
 
... ...
@@ -10,8 +10,11 @@ parent = "smn_cli"
10 10
 
11 11
 # wait
12 12
 
13
-    Usage: docker wait [OPTIONS] CONTAINER [CONTAINER...]
13
+```markdown
14
+Usage:  docker wait CONTAINER [CONTAINER...]
14 15
 
15
-    Block until a container stops, then print its exit code.
16
+Block until a container stops, then print its exit code
16 17
 
17
-      --help          Print usage
18
+Options:
19
+      --help   Print usage
20
+```