diff --git a/docs/reference/commandline/attach.md b/docs/reference/commandline/attach.md index d746190d6..5712c92f5 100644 --- a/docs/reference/commandline/attach.md +++ b/docs/reference/commandline/attach.md @@ -14,8 +14,8 @@ parent = "smn_cli" Attach to a running container - --help=false Print usage - --no-stdin=false Do not attach STDIN + --help Print usage + --no-stdin Do not attach STDIN --sig-proxy=true Proxy all received signals to the process The `docker attach` command allows you to attach to a running container using diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md index 0219be0fb..eab0cb7e3 100644 --- a/docs/reference/commandline/build.md +++ b/docs/reference/commandline/build.md @@ -23,14 +23,14 @@ parent = "smn_cli" --cpuset-mems="" MEMs in which to allow execution, e.g. `0-3`, `0,1` --disable-content-trust=true Skip image verification -f, --file="" Name of the Dockerfile (Default is 'PATH/Dockerfile') - --force-rm=false Always remove intermediate containers - --help=false Print usage + --force-rm Always remove intermediate containers + --help Print usage --isolation="" Container isolation technology -m, --memory="" Memory limit for all build containers --memory-swap="" Total memory (memory + swap), `-1` to disable swap - --no-cache=false Do not use cache when building the image - --pull=false Always attempt to pull a newer version of the image - -q, --quiet=false Suppress the build output and print image ID on success + --no-cache Do not use cache when building the image + --pull Always attempt to pull a newer version of the image + -q, --quiet Suppress the build output and print image ID on success --rm=true Remove intermediate containers after a successful build --shm-size=[] Size of `/dev/shm`. The format is ``. `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`. -t, --tag=[] Name and optionally a tag in the 'name:tag' format diff --git a/docs/reference/commandline/commit.md b/docs/reference/commandline/commit.md index 3f9228eef..49e37e416 100644 --- a/docs/reference/commandline/commit.md +++ b/docs/reference/commandline/commit.md @@ -16,7 +16,7 @@ parent = "smn_cli" -a, --author="" Author (e.g., "John Hannibal Smith ") -c, --change=[] Apply specified Dockerfile instructions while committing the image - --help=false Print usage + --help Print usage -m, --message="" Commit message -p, --pause=true Pause container during commit diff --git a/docs/reference/commandline/cp.md b/docs/reference/commandline/cp.md index 8a1a6264d..50179fb4c 100644 --- a/docs/reference/commandline/cp.md +++ b/docs/reference/commandline/cp.md @@ -15,8 +15,8 @@ parent = "smn_cli" Copy files/folders between a container and the local filesystem - -L, --follow-link=false Always follow symbol link in SRC_PATH - --help=false Print usage + -L, --follow-link Always follow symbol link in SRC_PATH + --help Print usage The `docker cp` utility copies the contents of `SRC_PATH` to the `DEST_PATH`. You can copy from the container's file system to the local machine or the diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index 9f7752fb8..d6a9cc53d 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -44,8 +44,8 @@ Creates a new container. --expose=[] Expose a port or a range of ports --group-add=[] Add additional groups to join -h, --hostname="" Container host name - --help=false Print usage - -i, --interactive=false Keep STDIN open even if not attached + --help Print usage + -i, --interactive Keep STDIN open even if not attached --ipc="" IPC namespace to use --isolation="" Container isolation technology --kernel-memory="" Kernel memory limit @@ -66,18 +66,18 @@ Creates a new container. 'container:': reuse another container's network stack 'host': use the Docker host network stack '|': connect to a user-defined network - --oom-kill-disable=false Whether to disable OOM Killer for the container or not + --oom-kill-disable Whether to disable OOM Killer for the container or not --oom-score-adj=0 Tune the host's OOM preferences for containers (accepts -1000 to 1000) - -P, --publish-all=false Publish all exposed ports to random ports + -P, --publish-all Publish all exposed ports to random ports -p, --publish=[] Publish a container's port(s) to the host --pid="" PID namespace to use - --privileged=false Give extended privileges to this container - --read-only=false Mount the container's root filesystem as read only + --privileged Give extended privileges to this container + --read-only Mount the container's root filesystem as read only --restart="no" Restart policy (no, on-failure[:max-retry], always, unless-stopped) --security-opt=[] Security options --stop-signal="SIGTERM" Signal to stop a container --shm-size=[] Size of `/dev/shm`. The format is ``. `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`. - -t, --tty=false Allocate a pseudo-TTY + -t, --tty Allocate a pseudo-TTY -u, --user="" Username or UID --ulimit=[] Ulimit options --uts="" UTS namespace to use diff --git a/docs/reference/commandline/daemon.md b/docs/reference/commandline/daemon.md index 3c2829518..1484b4e54 100644 --- a/docs/reference/commandline/daemon.md +++ b/docs/reference/commandline/daemon.md @@ -20,7 +20,7 @@ weight = -1 --authz-plugin=[] Set authorization plugins to load -b, --bridge="" Attach containers to a network bridge --bip="" Specify network bridge IP - -D, --debug=false Enable debug mode + -D, --debug Enable debug mode --default-gateway="" Container default gateway IPv4 address --default-gateway-v6="" Container default gateway IPv6 address --cluster-store="" URL of the distributed storage backend @@ -37,30 +37,30 @@ weight = -1 -G, --group="docker" Group for the unix socket -g, --graph="/var/lib/docker" Root of the Docker runtime -H, --host=[] Daemon socket(s) to connect to - --help=false Print usage + --help Print usage --icc=true Enable inter-container communication --insecure-registry=[] Enable insecure registry communication --ip=0.0.0.0 Default IP when binding container ports --ip-forward=true Enable net.ipv4.ip_forward --ip-masq=true Enable IP masquerading --iptables=true Enable addition of iptables rules - --ipv6=false Enable IPv6 networking + --ipv6 Enable IPv6 networking -l, --log-level="info" Set the logging level --label=[] Set key=value labels to the daemon --log-driver="json-file" Default driver for container logs --log-opt=[] Log driver specific options --mtu=0 Set the containers network MTU - --disable-legacy-registry=false Do not contact legacy registries + --disable-legacy-registry Do not contact legacy registries -p, --pidfile="/var/run/docker.pid" Path to use for daemon PID file --registry-mirror=[] Preferred Docker registry mirror -s, --storage-driver="" Storage driver to use - --selinux-enabled=false Enable selinux support + --selinux-enabled Enable selinux support --storage-opt=[] Set storage driver options - --tls=false Use TLS; implied by --tlsverify + --tls Use TLS; implied by --tlsverify --tlscacert="~/.docker/ca.pem" Trust certs signed only by this CA --tlscert="~/.docker/cert.pem" Path to TLS certificate file --tlskey="~/.docker/key.pem" Path to TLS key file - --tlsverify=false Use TLS and verify the remote + --tlsverify Use TLS and verify the remote --userland-proxy=true Use userland proxy for loopback traffic Options with [] may be specified multiple times. diff --git a/docs/reference/commandline/diff.md b/docs/reference/commandline/diff.md index 17e870d35..bda74eada 100644 --- a/docs/reference/commandline/diff.md +++ b/docs/reference/commandline/diff.md @@ -14,7 +14,7 @@ parent = "smn_cli" Inspect changes on a container's filesystem - --help=false Print usage + --help Print usage List the changed files and directories in a container᾿s filesystem There are 3 events that are listed in the `diff`: diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/events.md index d0e299a69..1af0e2337 100644 --- a/docs/reference/commandline/events.md +++ b/docs/reference/commandline/events.md @@ -15,7 +15,7 @@ parent = "smn_cli" Get real time events from the server -f, --filter=[] Filter output based on conditions provided - --help=false Print usage + --help Print usage --since="" Show all events created since timestamp --until="" Stream events until this timestamp diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/exec.md index 658292679..971a2f2d6 100644 --- a/docs/reference/commandline/exec.md +++ b/docs/reference/commandline/exec.md @@ -14,11 +14,11 @@ parent = "smn_cli" Run a command in a running container - -d, --detach=false Detached mode: run command in the background - --help=false Print usage - -i, --interactive=false Keep STDIN open even if not attached - --privileged=false Give extended Linux capabilities to the command - -t, --tty=false Allocate a pseudo-TTY + -d, --detach Detached mode: run command in the background + --help Print usage + -i, --interactive Keep STDIN open even if not attached + --privileged Give extended Linux capabilities to the command + -t, --tty Allocate a pseudo-TTY -u, --user= Username or UID (format: [:]) The `docker exec` command runs a new command in a running container. diff --git a/docs/reference/commandline/export.md b/docs/reference/commandline/export.md index 96bf54473..87b691cd4 100644 --- a/docs/reference/commandline/export.md +++ b/docs/reference/commandline/export.md @@ -14,7 +14,7 @@ parent = "smn_cli" Export the contents of a container's filesystem as a tar archive - --help=false Print usage + --help Print usage -o, --output="" Write to a file, instead of STDOUT The `docker export` command does not export the contents of volumes associated diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/history.md index 43edf3462..d8750d83c 100644 --- a/docs/reference/commandline/history.md +++ b/docs/reference/commandline/history.md @@ -15,9 +15,9 @@ parent = "smn_cli" Show the history of an image -H, --human=true Print sizes and dates in human readable format - --help=false Print usage - --no-trunc=false Don't truncate output - -q, --quiet=false Only show numeric IDs + --help Print usage + --no-trunc Don't truncate output + -q, --quiet Only show numeric IDs To see how the `docker:latest` image was built: diff --git a/docs/reference/commandline/images.md b/docs/reference/commandline/images.md index 2385bc97c..cfee5a4bb 100644 --- a/docs/reference/commandline/images.md +++ b/docs/reference/commandline/images.md @@ -14,12 +14,12 @@ parent = "smn_cli" List images - -a, --all=false Show all images (default hides intermediate images) - --digests=false Show digests + -a, --all Show all images (default hides intermediate images) + --digests Show digests -f, --filter=[] Filter output based on conditions provided - --help=false Print usage - --no-trunc=false Don't truncate output - -q, --quiet=false Only show numeric IDs + --help Print usage + --no-trunc Don't truncate output + -q, --quiet Only show numeric IDs The default `docker images` will show all top level images, their repository and tags, and their virtual size. diff --git a/docs/reference/commandline/import.md b/docs/reference/commandline/import.md index 4881f016d..3b36a52ba 100644 --- a/docs/reference/commandline/import.md +++ b/docs/reference/commandline/import.md @@ -17,7 +17,7 @@ parent = "smn_cli" optionally tag it. -c, --change=[] Apply specified Dockerfile instructions while importing the image - --help=false Print usage + --help Print usage -m, --message= Set commit message for imported image You can specify a `URL` or `-` (dash) to take data directly from `STDIN`. The diff --git a/docs/reference/commandline/info.md b/docs/reference/commandline/info.md index f489a9b77..c776ced58 100644 --- a/docs/reference/commandline/info.md +++ b/docs/reference/commandline/info.md @@ -15,7 +15,7 @@ parent = "smn_cli" Display system-wide information - --help=false Print usage + --help Print usage For example: diff --git a/docs/reference/commandline/inspect.md b/docs/reference/commandline/inspect.md index 31a34b20b..434f98989 100644 --- a/docs/reference/commandline/inspect.md +++ b/docs/reference/commandline/inspect.md @@ -15,10 +15,10 @@ parent = "smn_cli" Return low-level information on a container or image -f, --format="" Format the output using the given go template - --help=false Print usage + --help Print usage --type=container|image Return JSON for specified type, permissible values are "image" or "container" - -s, --size=false Display total file sizes if the type is container + -s, --size Display total file sizes if the type is container By default, this will render all results in a JSON array. If a format is specified, the given template will be executed for each result. diff --git a/docs/reference/commandline/kill.md b/docs/reference/commandline/kill.md index dabbabbe7..6f2025870 100644 --- a/docs/reference/commandline/kill.md +++ b/docs/reference/commandline/kill.md @@ -14,7 +14,7 @@ parent = "smn_cli" Kill a running container using SIGKILL or a specified signal - --help=false Print usage + --help Print usage -s, --signal="KILL" Signal to send to the container The main process inside the container will be sent `SIGKILL`, or any diff --git a/docs/reference/commandline/load.md b/docs/reference/commandline/load.md index 3a183f38e..c2536fbdb 100644 --- a/docs/reference/commandline/load.md +++ b/docs/reference/commandline/load.md @@ -14,7 +14,7 @@ parent = "smn_cli" Load an image from a tar archive or STDIN - --help=false Print usage + --help Print usage -i, --input="" Read from a tar archive file, instead of STDIN. The tarball may be compressed with gzip, bzip, or xz Loads a tarred repository from a file or the standard input stream. diff --git a/docs/reference/commandline/login.md b/docs/reference/commandline/login.md index c6e367c47..b79c18b2c 100644 --- a/docs/reference/commandline/login.md +++ b/docs/reference/commandline/login.md @@ -16,7 +16,7 @@ parent = "smn_cli" specified "https://index.docker.io/v1/" is the default. -e, --email="" Email - --help=false Print usage + --help Print usage -p, --password="" Password -u, --username="" Username diff --git a/docs/reference/commandline/logout.md b/docs/reference/commandline/logout.md index 36c85453f..a3bb40c65 100644 --- a/docs/reference/commandline/logout.md +++ b/docs/reference/commandline/logout.md @@ -15,7 +15,7 @@ parent = "smn_cli" Log out from a Docker registry, if no server is specified "https://index.docker.io/v1/" is the default. - --help=false Print usage + --help Print usage For example: diff --git a/docs/reference/commandline/logs.md b/docs/reference/commandline/logs.md index 601c475bd..91558ffa6 100644 --- a/docs/reference/commandline/logs.md +++ b/docs/reference/commandline/logs.md @@ -14,10 +14,10 @@ parent = "smn_cli" Fetch the logs of a container - -f, --follow=false Follow log output - --help=false Print usage + -f, --follow Follow log output + --help Print usage --since="" Show logs since timestamp - -t, --timestamps=false Show timestamps + -t, --timestamps Show timestamps --tail="all" Number of lines to show from the end of the logs > **Note**: this command is available only for containers with `json-file` and diff --git a/docs/reference/commandline/network_connect.md b/docs/reference/commandline/network_connect.md index b3b577345..ab78bf9d5 100644 --- a/docs/reference/commandline/network_connect.md +++ b/docs/reference/commandline/network_connect.md @@ -14,7 +14,7 @@ parent = "smn_cli" Connects a container to a network - --help=false Print usage + --help Print usage Connects a running container to a network. You can connect a container by name or by ID. Once connected, the container can communicate with other containers in diff --git a/docs/reference/commandline/network_create.md b/docs/reference/commandline/network_create.md index bdaafb4b5..0a9ac6f19 100644 --- a/docs/reference/commandline/network_create.md +++ b/docs/reference/commandline/network_create.md @@ -17,7 +17,7 @@ parent = "smn_cli" --aux-address=map[] Auxiliary ipv4 or ipv6 addresses used by network driver -d --driver=DRIVER Driver to manage the Network bridge or overlay. The default is bridge. --gateway=[] ipv4 or ipv6 Gateway for the master subnet - --help=false Print usage + --help Print usage --ip-range=[] Allocate container ip from a sub-range --ipam-driver=default IP Address Management Driver -o --opt=map[] Set custom network plugin options diff --git a/docs/reference/commandline/network_disconnect.md b/docs/reference/commandline/network_disconnect.md index bbb351d24..7fb7a7c42 100644 --- a/docs/reference/commandline/network_disconnect.md +++ b/docs/reference/commandline/network_disconnect.md @@ -14,7 +14,7 @@ parent = "smn_cli" Disconnects a container from a network - --help=false Print usage + --help Print usage Disconnects a container from a network. The container must be running to disconnect it from the network. diff --git a/docs/reference/commandline/network_inspect.md b/docs/reference/commandline/network_inspect.md index 0f6342f51..00b886d76 100644 --- a/docs/reference/commandline/network_inspect.md +++ b/docs/reference/commandline/network_inspect.md @@ -15,7 +15,7 @@ parent = "smn_cli" Displays detailed information on a network -f, --format= Format the output using the given go template. - --help=false Print usage + --help Print usage 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 a network: diff --git a/docs/reference/commandline/network_ls.md b/docs/reference/commandline/network_ls.md index b5ddbf409..06733cd3c 100644 --- a/docs/reference/commandline/network_ls.md +++ b/docs/reference/commandline/network_ls.md @@ -14,9 +14,9 @@ parent = "smn_cli" Lists all the networks created by the user -f, --filter=[] Filter output based on conditions provided - --help=false Print usage - --no-trunc=false Do not truncate the output - -q, --quiet=false Only display numeric IDs + --help Print usage + --no-trunc Do not truncate the output + -q, --quiet Only display numeric IDs Lists all the networks the Engine `daemon` knows about. This includes the networks that span across multiple hosts in a cluster, for example: diff --git a/docs/reference/commandline/network_rm.md b/docs/reference/commandline/network_rm.md index 14e74717e..516eb4ecf 100644 --- a/docs/reference/commandline/network_rm.md +++ b/docs/reference/commandline/network_rm.md @@ -14,7 +14,7 @@ parent = "smn_cli" Deletes one or more networks - --help=false Print usage + --help Print usage Removes one or more networks by name or identifier. To remove a network, you must first disconnect any containers connected to it. diff --git a/docs/reference/commandline/pause.md b/docs/reference/commandline/pause.md index 0e109478d..36d5416f4 100644 --- a/docs/reference/commandline/pause.md +++ b/docs/reference/commandline/pause.md @@ -14,7 +14,7 @@ parent = "smn_cli" Pause all processes within a container - --help=false Print usage + --help Print usage The `docker pause` command uses the cgroups freezer to suspend all processes in a container. Traditionally, when suspending a process the `SIGSTOP` signal is diff --git a/docs/reference/commandline/port.md b/docs/reference/commandline/port.md index 9fd6e8870..606969a17 100644 --- a/docs/reference/commandline/port.md +++ b/docs/reference/commandline/port.md @@ -15,7 +15,7 @@ parent = "smn_cli" List port mappings for the CONTAINER, or lookup the public-facing port that is NAT-ed to the PRIVATE_PORT - --help=false Print usage + --help Print usage You can find out all the ports mapped by not specifying a `PRIVATE_PORT`, or just a specific mapping: diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/ps.md index 371a4bb09..213648f1d 100644 --- a/docs/reference/commandline/ps.md +++ b/docs/reference/commandline/ps.md @@ -14,15 +14,15 @@ parent = "smn_cli" List containers - -a, --all=false Show all containers (default shows just running) + -a, --all Show all containers (default shows just running) -f, --filter=[] Filter output based on conditions provided --format=[] Pretty-print containers using a Go template - --help=false Print usage - -l, --latest=false Show the latest created container (includes all states) + --help Print usage + -l, --latest Show the latest created container (includes all states) -n=-1 Show n last created containers (includes all states) - --no-trunc=false Don't truncate output - -q, --quiet=false Only display numeric IDs - -s, --size=false Display total file sizes + --no-trunc Don't truncate output + -q, --quiet Only display numeric IDs + -s, --size Display total file sizes Running `docker ps --no-trunc` showing 2 linked containers. diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/pull.md index 460255ccd..02e0302aa 100644 --- a/docs/reference/commandline/pull.md +++ b/docs/reference/commandline/pull.md @@ -14,9 +14,9 @@ parent = "smn_cli" Pull an image or a repository from the registry - -a, --all-tags=false Download all tagged images in the repository + -a, --all-tags Download all tagged images in the repository --disable-content-trust=true Skip image verification - --help=false Print usage + --help Print usage Most of your images will be created on top of a base image from the [Docker Hub](https://hub.docker.com) registry. diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/push.md index c26169eb9..315d3ce37 100644 --- a/docs/reference/commandline/push.md +++ b/docs/reference/commandline/push.md @@ -15,7 +15,7 @@ parent = "smn_cli" Push an image or a repository to the registry --disable-content-trust=true Skip image signing - --help=false Print usage + --help Print usage Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com) registry or to a self-hosted one. diff --git a/docs/reference/commandline/rename.md b/docs/reference/commandline/rename.md index 667e0d84d..3e2b37038 100644 --- a/docs/reference/commandline/rename.md +++ b/docs/reference/commandline/rename.md @@ -14,6 +14,6 @@ parent = "smn_cli" Rename a container - --help=false Print usage + --help Print usage The `docker rename` command allows the container to be renamed to a different name. diff --git a/docs/reference/commandline/restart.md b/docs/reference/commandline/restart.md index 61292d3a5..5e6633c8c 100644 --- a/docs/reference/commandline/restart.md +++ b/docs/reference/commandline/restart.md @@ -14,5 +14,5 @@ parent = "smn_cli" Restart a container - --help=false Print usage + --help Print usage -t, --time=10 Seconds to wait for stop before killing the container diff --git a/docs/reference/commandline/rm.md b/docs/reference/commandline/rm.md index 943343a9a..3664f98cc 100644 --- a/docs/reference/commandline/rm.md +++ b/docs/reference/commandline/rm.md @@ -14,10 +14,10 @@ parent = "smn_cli" Remove one or more containers - -f, --force=false Force the removal of a running container (uses SIGKILL) - --help=false Print usage - -l, --link=false Remove the specified link - -v, --volumes=false Remove the volumes associated with the container + -f, --force Force the removal of a running container (uses SIGKILL) + --help Print usage + -l, --link Remove the specified link + -v, --volumes Remove the volumes associated with the container ## Examples diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/rmi.md index 09cffd0d2..69e8ef892 100644 --- a/docs/reference/commandline/rmi.md +++ b/docs/reference/commandline/rmi.md @@ -14,9 +14,9 @@ parent = "smn_cli" Remove one or more images - -f, --force=false Force removal of the image - --help=false Print usage - --no-prune=false Do not delete untagged parents + -f, --force Force removal of the image + --help Print usage + --no-prune Do not delete untagged parents You can remove an image using its short or long ID, its tag, or its digest. If an image has one or more tag or digest reference, you must remove all of them diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index 0aacf894d..89243c6bf 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -27,7 +27,7 @@ parent = "smn_cli" --cpu-quota=0 Limit CPU CFS (Completely Fair Scheduler) quota --cpuset-cpus="" CPUs in which to allow execution (0-3, 0,1) --cpuset-mems="" Memory nodes (MEMs) in which to allow execution (0-3, 0,1) - -d, --detach=false Run container in background and print container ID + -d, --detach Run container in background and print container ID --device=[] Add a host device to the container --device-read-bps=[] Limit read rate (bytes per second) from a device (e.g., --device-read-bps=/dev/sda:1mb) --device-read-iops=[] Limit read rate (IO per second) from a device (e.g., --device-read-iops=/dev/sda:1000) @@ -43,8 +43,8 @@ parent = "smn_cli" --expose=[] Expose a port or a range of ports --group-add=[] Add additional groups to run as -h, --hostname="" Container host name - --help=false Print usage - -i, --interactive=false Keep STDIN open even if not attached + --help Print usage + -i, --interactive Keep STDIN open even if not attached --ipc="" IPC namespace to use --isolation="" Container isolation technology --kernel-memory="" Kernel memory limit @@ -65,20 +65,20 @@ parent = "smn_cli" 'container:': reuse another container's network stack 'host': use the Docker host network stack '|': connect to a user-defined network - --oom-kill-disable=false Whether to disable OOM Killer for the container or not + --oom-kill-disable Whether to disable OOM Killer for the container or not --oom-score-adj=0 Tune the host's OOM preferences for containers (accepts -1000 to 1000) - -P, --publish-all=false Publish all exposed ports to random ports + -P, --publish-all Publish all exposed ports to random ports -p, --publish=[] Publish a container's port(s) to the host --pid="" PID namespace to use - --privileged=false Give extended privileges to this container - --read-only=false Mount the container's root filesystem as read only + --privileged Give extended privileges to this container + --read-only Mount the container's root filesystem as read only --restart="no" Restart policy (no, on-failure[:max-retry], always, unless-stopped) - --rm=false Automatically remove the container when it exits + --rm Automatically remove the container when it exits --shm-size=[] Size of `/dev/shm`. The format is ``. `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`. --security-opt=[] Security Options --sig-proxy=true Proxy received signals to the process --stop-signal="SIGTERM" Signal to stop a container - -t, --tty=false Allocate a pseudo-TTY + -t, --tty Allocate a pseudo-TTY -u, --user="" Username or UID (format: [:]) --ulimit=[] Ulimit options --uts="" UTS namespace to use diff --git a/docs/reference/commandline/save.md b/docs/reference/commandline/save.md index d384e8150..864d06cf4 100644 --- a/docs/reference/commandline/save.md +++ b/docs/reference/commandline/save.md @@ -14,7 +14,7 @@ parent = "smn_cli" Save an image(s) to a tar archive (streamed to STDOUT by default) - --help=false Print usage + --help Print usage -o, --output="" Write to a file, instead of STDOUT Produces a tarred repository to the standard output stream. diff --git a/docs/reference/commandline/search.md b/docs/reference/commandline/search.md index d9ddb47c5..beb4ef0a4 100644 --- a/docs/reference/commandline/search.md +++ b/docs/reference/commandline/search.md @@ -14,9 +14,9 @@ parent = "smn_cli" Search the Docker Hub for images - --automated=false Only show automated builds - --help=false Print usage - --no-trunc=false Don't truncate output + --automated Only show automated builds + --help Print usage + --no-trunc Don't truncate output -s, --stars=0 Only displays with at least x stars Search [Docker Hub](https://hub.docker.com) for images diff --git a/docs/reference/commandline/start.md b/docs/reference/commandline/start.md index 31365a91f..6e1b1d67b 100644 --- a/docs/reference/commandline/start.md +++ b/docs/reference/commandline/start.md @@ -14,6 +14,6 @@ parent = "smn_cli" Start one or more containers - -a, --attach=false Attach STDOUT/STDERR and forward signals - --help=false Print usage - -i, --interactive=false Attach container's STDIN + -a, --attach Attach STDOUT/STDERR and forward signals + --help Print usage + -i, --interactive Attach container's STDIN diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/stats.md index 18683e115..b3a2ed622 100644 --- a/docs/reference/commandline/stats.md +++ b/docs/reference/commandline/stats.md @@ -14,9 +14,9 @@ parent = "smn_cli" Display a live stream of one or more containers' resource usage statistics - -a, --all=false Show all containers (default shows just running) - --help=false Print usage - --no-stream=false Disable streaming stats and only pull the first result + -a, --all Show all containers (default shows just running) + --help Print usage + --no-stream Disable streaming stats and only pull the first result 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. diff --git a/docs/reference/commandline/stop.md b/docs/reference/commandline/stop.md index 04b498e1d..1fb376eaf 100644 --- a/docs/reference/commandline/stop.md +++ b/docs/reference/commandline/stop.md @@ -15,7 +15,7 @@ parent = "smn_cli" Stop a container by sending SIGTERM and then SIGKILL after a grace period - --help=false Print usage + --help Print usage -t, --time=10 Seconds to wait for stop before killing it The main process inside the container will receive `SIGTERM`, and after a grace diff --git a/docs/reference/commandline/tag.md b/docs/reference/commandline/tag.md index 83d237c77..c1ca5aa18 100644 --- a/docs/reference/commandline/tag.md +++ b/docs/reference/commandline/tag.md @@ -14,7 +14,7 @@ parent = "smn_cli" Tag an image into a repository - --help=false Print usage + --help Print usage You can group your images together using names and tags, and then upload them to [*Share Images via Repositories*](../../userguide/dockerrepos.md#contributing-to-docker-hub). diff --git a/docs/reference/commandline/top.md b/docs/reference/commandline/top.md index 3c78f6ae4..2bff2fdb4 100644 --- a/docs/reference/commandline/top.md +++ b/docs/reference/commandline/top.md @@ -14,4 +14,4 @@ parent = "smn_cli" Display the running processes of a container - --help=false Print usage + --help Print usage diff --git a/docs/reference/commandline/unpause.md b/docs/reference/commandline/unpause.md index 73248d458..641e37718 100644 --- a/docs/reference/commandline/unpause.md +++ b/docs/reference/commandline/unpause.md @@ -14,7 +14,7 @@ parent = "smn_cli" Unpause all processes within a container - --help=false Print usage + --help Print usage The `docker unpause` command uses the cgroups freezer to un-suspend all processes in a container. diff --git a/docs/reference/commandline/version.md b/docs/reference/commandline/version.md index 16b947ed2..14fac17e2 100644 --- a/docs/reference/commandline/version.md +++ b/docs/reference/commandline/version.md @@ -15,7 +15,7 @@ parent = "smn_cli" Show the Docker version information. -f, --format="" Format the output using the given go template - --help=false Print usage + --help Print usage By default, this will render all version information in an easy to read layout. If a format is specified, the given template will be executed instead. diff --git a/docs/reference/commandline/volume_create.md b/docs/reference/commandline/volume_create.md index b484724ff..744cfd1ff 100644 --- a/docs/reference/commandline/volume_create.md +++ b/docs/reference/commandline/volume_create.md @@ -15,7 +15,7 @@ parent = "smn_cli" Create a volume -d, --driver=local Specify volume driver name - --help=false Print usage + --help Print usage --name= Specify volume name -o, --opt=map[] Set driver specific options diff --git a/docs/reference/commandline/volume_inspect.md b/docs/reference/commandline/volume_inspect.md index 3912cce86..519f80c23 100644 --- a/docs/reference/commandline/volume_inspect.md +++ b/docs/reference/commandline/volume_inspect.md @@ -15,7 +15,7 @@ parent = "smn_cli" Inspect one or more volumes -f, --format= Format the output using the given go template. - --help=false Print usage + --help Print usage Returns information about a volume. By default, this command renders all results in a JSON array. You can specify an alternate format to execute a diff --git a/docs/reference/commandline/volume_ls.md b/docs/reference/commandline/volume_ls.md index 3368866e1..336195943 100644 --- a/docs/reference/commandline/volume_ls.md +++ b/docs/reference/commandline/volume_ls.md @@ -15,8 +15,8 @@ parent = "smn_cli" List volumes -f, --filter=[] Provide filter values (i.e. 'dangling=true') - --help=false Print usage - -q, --quiet=false Only display volume names + --help Print usage + -q, --quiet Only display volume names Lists all the volumes Docker knows about. You can filter using the `-f` or `--filter` flag. The filtering format is a `key=value` pair. To specify more than one filter, pass multiple flags (for example, `--filter "foo=bar" --filter "bif=baz"`) diff --git a/docs/reference/commandline/volume_rm.md b/docs/reference/commandline/volume_rm.md index 31ecc31fd..495e74655 100644 --- a/docs/reference/commandline/volume_rm.md +++ b/docs/reference/commandline/volume_rm.md @@ -14,7 +14,7 @@ parent = "smn_cli" Remove a volume - --help=false Print usage + --help Print usage Removes one or more volumes. You cannot remove a volume that is in use by a container. diff --git a/docs/reference/commandline/wait.md b/docs/reference/commandline/wait.md index cd91c0dde..5cd9a7b9f 100644 --- a/docs/reference/commandline/wait.md +++ b/docs/reference/commandline/wait.md @@ -14,4 +14,4 @@ parent = "smn_cli" Block until a container stops, then print its exit code. - --help=false Print usage + --help Print usage diff --git a/docs/reference/run.md b/docs/reference/run.md index 2689108fa..53ab5ea35 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -123,9 +123,9 @@ pretend to be a TTY (this is what most command line executables expect) and pass along signals. All of that is configurable: -a=[] : Attach to `STDIN`, `STDOUT` and/or `STDERR` - -t=false : Allocate a pseudo-tty + -t : Allocate a pseudo-tty --sig-proxy=true: Proxy all received signals to the process (non-TTY mode only) - -i=false : Keep STDIN open even if not attached + -i : Keep STDIN open even if not attached If you do not specify `-a` then Docker will [attach all standard streams]( https://github.com/docker/docker/blob/75a7f4d90cde0295bcfb7213004abce8d4779b75/commands.go#L1797). @@ -1239,7 +1239,7 @@ The following `run` command options work with container networking: --expose=[]: Expose a port or a range of ports inside the container. These are additional to those exposed by the `EXPOSE` instruction - -P=false : Publish all exposed ports to the host interfaces + -P : Publish all exposed ports to the host interfaces -p=[] : Publish a container᾿s port or a range of ports to the host format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort Both hostPort and containerPort can be specified as a diff --git a/man/docker-attach.1.md b/man/docker-attach.1.md index 96fb3756a..260593201 100644 --- a/man/docker-attach.1.md +++ b/man/docker-attach.1.md @@ -7,7 +7,7 @@ docker-attach - Attach to a running container # SYNOPSIS **docker attach** [**--help**] -[**--no-stdin**[=*false*]] +[**--no-stdin**] [**--sig-proxy**[=*true*]] CONTAINER diff --git a/man/docker-build.1.md b/man/docker-build.1.md index 52451c1d7..3decabe17 100644 --- a/man/docker-build.1.md +++ b/man/docker-build.1.md @@ -11,11 +11,11 @@ docker-build - Build a new image from the source code at PATH [**--cgroup-parent**[=*CGROUP-PARENT*]] [**--help**] [**-f**|**--file**[=*PATH/Dockerfile*]] -[**--force-rm**[=*false*]] +[**--force-rm**] [**--isolation**[=*default*]] -[**--no-cache**[=*false*]] -[**--pull**[=*false*]] -[**-q**|**--quiet**[=*false*]] +[**--no-cache**] +[**--pull**] +[**-q**|**--quiet**] [**--rm**[=*true*]] [**-t**|**--tag**[=*[]*]] [**-m**|**--memory**[=*MEMORY*]] diff --git a/man/docker-create.1.md b/man/docker-create.1.md index d473a624e..f35571a35 100644 --- a/man/docker-create.1.md +++ b/man/docker-create.1.md @@ -34,7 +34,7 @@ docker-create - Create a new container [**--group-add**[=*[]*]] [**-h**|**--hostname**[=*HOSTNAME*]] [**--help**] -[**-i**|**--interactive**[=*false*]] +[**-i**|**--interactive**] [**--ipc**[=*IPC*]] [**--isolation**[=*default*]] [**--kernel-memory**[=*KERNEL-MEMORY*]] @@ -50,18 +50,18 @@ docker-create - Create a new container [**--memory-swappiness**[=*MEMORY-SWAPPINESS*]] [**--name**[=*NAME*]] [**--net**[=*"bridge"*]] -[**--oom-kill-disable**[=*false*]] +[**--oom-kill-disable**] [**--oom-score-adj**[=*0*]] -[**-P**|**--publish-all**[=*false*]] +[**-P**|**--publish-all**] [**-p**|**--publish**[=*[]*]] [**--pid**[=*[]*]] -[**--privileged**[=*false*]] -[**--read-only**[=*false*]] +[**--privileged**] +[**--read-only**] [**--restart**[=*RESTART*]] [**--security-opt**[=*[]*]] [**--stop-signal**[=*SIGNAL*]] [**--shm-size**[=*[]*]] -[**-t**|**--tty**[=*false*]] +[**-t**|**--tty**] [**--tmpfs**[=*[CONTAINER-DIR[:]*]] [**-u**|**--user**[=*USER*]] [**--ulimit**[=*[]*]] diff --git a/man/docker-daemon.8.md b/man/docker-daemon.8.md index f06a05e92..904ae428a 100644 --- a/man/docker-daemon.8.md +++ b/man/docker-daemon.8.md @@ -13,11 +13,11 @@ docker-daemon - Enable daemon mode [**--cluster-store**[=*[]*]] [**--cluster-advertise**[=*[]*]] [**--cluster-store-opt**[=*map[]*]] -[**-D**|**--debug**[=*false*]] +[**-D**|**--debug**] [**--default-gateway**[=*DEFAULT-GATEWAY*]] [**--default-gateway-v6**[=*DEFAULT-GATEWAY-V6*]] [**--default-ulimit**[=*[]*]] -[**--disable-legacy-registry**[=*false*]] +[**--disable-legacy-registry**] [**--dns**[=*[]*]] [**--dns-opt**[=*[]*]] [**--dns-search**[=*[]*]] @@ -35,7 +35,7 @@ docker-daemon - Enable daemon mode [**--ip-forward**[=*true*]] [**--ip-masq**[=*true*]] [**--iptables**[=*true*]] -[**--ipv6**[=*false*]] +[**--ipv6**] [**-l**|**--log-level**[=*info*]] [**--label**[=*[]*]] [**--log-driver**[=*json-file*]] @@ -44,13 +44,13 @@ docker-daemon - Enable daemon mode [**-p**|**--pidfile**[=*/var/run/docker.pid*]] [**--registry-mirror**[=*[]*]] [**-s**|**--storage-driver**[=*STORAGE-DRIVER*]] -[**--selinux-enabled**[=*false*]] +[**--selinux-enabled**] [**--storage-opt**[=*[]*]] -[**--tls**[=*false*]] +[**--tls**] [**--tlscacert**[=*~/.docker/ca.pem*]] [**--tlscert**[=*~/.docker/cert.pem*]] [**--tlskey**[=*~/.docker/key.pem*]] -[**--tlsverify**[=*false*]] +[**--tlsverify**] [**--userland-proxy**[=*true*]] # DESCRIPTION diff --git a/man/docker-exec.1.md b/man/docker-exec.1.md index 5cfdb5434..388fe81b2 100644 --- a/man/docker-exec.1.md +++ b/man/docker-exec.1.md @@ -6,11 +6,11 @@ docker-exec - Run a command in a running container # SYNOPSIS **docker exec** -[**-d**|**--detach**[=*false*]] +[**-d**|**--detach**] [**--help**] -[**-i**|**--interactive**[=*false*]] -[**--privileged**[=*false*]] -[**-t**|**--tty**[=*false*]] +[**-i**|**--interactive**] +[**--privileged**] +[**-t**|**--tty**] [**-u**|**--user**[=*USER*]] CONTAINER COMMAND [ARG...] diff --git a/man/docker-history.1.md b/man/docker-history.1.md index 247d6503e..91edefe25 100644 --- a/man/docker-history.1.md +++ b/man/docker-history.1.md @@ -8,8 +8,8 @@ docker-history - Show the history of an image **docker history** [**--help**] [**-H**|**--human**[=*true*]] -[**--no-trunc**[=*false*]] -[**-q**|**--quiet**[=*false*]] +[**--no-trunc**] +[**-q**|**--quiet**] IMAGE # DESCRIPTION diff --git a/man/docker-images.1.md b/man/docker-images.1.md index 921a14168..75355ac5c 100644 --- a/man/docker-images.1.md +++ b/man/docker-images.1.md @@ -7,11 +7,11 @@ docker-images - List images # SYNOPSIS **docker images** [**--help**] -[**-a**|**--all**[=*false*]] -[**--digests**[=*false*]] +[**-a**|**--all**] +[**--digests**] [**-f**|**--filter**[=*[]*]] -[**--no-trunc**[=*false*]] -[**-q**|**--quiet**[=*false*]] +[**--no-trunc**] +[**-q**|**--quiet**] [REPOSITORY[:TAG]] # DESCRIPTION diff --git a/man/docker-inspect.1.md b/man/docker-inspect.1.md index c2e32cfd6..81f48ceed 100644 --- a/man/docker-inspect.1.md +++ b/man/docker-inspect.1.md @@ -8,7 +8,7 @@ docker-inspect - Return low-level information on a container or image **docker inspect** [**--help**] [**-f**|**--format**[=*FORMAT*]] -[**-s**|**--size**[=*false*]] +[**-s**|**--size**] [**--type**=*container*|*image*] CONTAINER|IMAGE [CONTAINER|IMAGE...] @@ -26,7 +26,7 @@ each result. **-f**, **--format**="" Format the output using the given Go template. -**-s**, **--size**=*false* +**-s**, **--size** Display total file sizes if the type is container. **--type**="*container*|*image*" diff --git a/man/docker-logs.1.md b/man/docker-logs.1.md index 7374e6cd4..21501dc51 100644 --- a/man/docker-logs.1.md +++ b/man/docker-logs.1.md @@ -6,10 +6,10 @@ docker-logs - Fetch the logs of a container # SYNOPSIS **docker logs** -[**-f**|**--follow**[=*false*]] +[**-f**|**--follow**] [**--help**] [**--since**[=*SINCE*]] -[**-t**|**--timestamps**[=*false*]] +[**-t**|**--timestamps**] [**--tail**[=*"all"*]] CONTAINER diff --git a/man/docker-ps.1.md b/man/docker-ps.1.md index 82a4ea20d..770cd2649 100644 --- a/man/docker-ps.1.md +++ b/man/docker-ps.1.md @@ -6,15 +6,15 @@ docker-ps - List containers # SYNOPSIS **docker ps** -[**-a**|**--all**[=*false*]] +[**-a**|**--all**] [**-f**|**--filter**[=*[]*]] [**--format**=*"TEMPLATE"*] [**--help**] -[**-l**|**--latest**[=*false*]] +[**-l**|**--latest**] [**-n**[=*-1*]] -[**--no-trunc**[=*false*]] -[**-q**|**--quiet**[=*false*]] -[**-s**|**--size**[=*false*]] +[**--no-trunc**] +[**-q**|**--quiet**] +[**-s**|**--size**] # DESCRIPTION diff --git a/man/docker-pull.1.md b/man/docker-pull.1.md index c4359fbda..9e0e2ca81 100644 --- a/man/docker-pull.1.md +++ b/man/docker-pull.1.md @@ -6,7 +6,7 @@ docker-pull - Pull an image or a repository from a registry # SYNOPSIS **docker pull** -[**-a**|**--all-tags**[=*false*]] +[**-a**|**--all-tags**] [**--help**] NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG] diff --git a/man/docker-rm.1.md b/man/docker-rm.1.md index af73b804c..d99c1d836 100644 --- a/man/docker-rm.1.md +++ b/man/docker-rm.1.md @@ -6,9 +6,9 @@ docker-rm - Remove one or more containers # SYNOPSIS **docker rm** -[**-f**|**--force**[=*false*]] -[**-l**|**--link**[=*false*]] -[**-v**|**--volumes**[=*false*]] +[**-f**|**--force**] +[**-l**|**--link**] +[**-v**|**--volumes**] CONTAINER [CONTAINER...] # DESCRIPTION diff --git a/man/docker-rmi.1.md b/man/docker-rmi.1.md index 01dc64f52..35bf8aac6 100644 --- a/man/docker-rmi.1.md +++ b/man/docker-rmi.1.md @@ -6,9 +6,9 @@ docker-rmi - Remove one or more images # SYNOPSIS **docker rmi** -[**-f**|**--force**[=*false*]] +[**-f**|**--force**] [**--help**] -[**--no-prune**[=*false*]] +[**--no-prune**] IMAGE [IMAGE...] # DESCRIPTION diff --git a/man/docker-run.1.md b/man/docker-run.1.md index 17c6e3268..e963d5277 100644 --- a/man/docker-run.1.md +++ b/man/docker-run.1.md @@ -19,7 +19,7 @@ docker-run - Run a command in a new container [**--cpu-quota**[=*0*]] [**--cpuset-cpus**[=*CPUSET-CPUS*]] [**--cpuset-mems**[=*CPUSET-MEMS*]] -[**-d**|**--detach**[=*false*]] +[**-d**|**--detach**] [**--device**[=*[]*]] [**--device-read-bps**[=*[]*]] [**--device-read-iops**[=*[]*]] @@ -35,7 +35,7 @@ docker-run - Run a command in a new container [**--group-add**[=*[]*]] [**-h**|**--hostname**[=*HOSTNAME*]] [**--help**] -[**-i**|**--interactive**[=*false*]] +[**-i**|**--interactive**] [**--ipc**[=*IPC*]] [**--isolation**[=*default*]] [**--kernel-memory**[=*KERNEL-MEMORY*]] @@ -51,20 +51,20 @@ docker-run - Run a command in a new container [**--memory-swappiness**[=*MEMORY-SWAPPINESS*]] [**--name**[=*NAME*]] [**--net**[=*"bridge"*]] -[**--oom-kill-disable**[=*false*]] +[**--oom-kill-disable**] [**--oom-score-adj**[=*0*]] -[**-P**|**--publish-all**[=*false*]] +[**-P**|**--publish-all**] [**-p**|**--publish**[=*[]*]] [**--pid**[=*[]*]] -[**--privileged**[=*false*]] -[**--read-only**[=*false*]] +[**--privileged**] +[**--read-only**] [**--restart**[=*RESTART*]] -[**--rm**[=*false*]] +[**--rm**] [**--security-opt**[=*[]*]] [**--stop-signal**[=*SIGNAL*]] [**--shm-size**[=*[]*]] [**--sig-proxy**[=*true*]] -[**-t**|**--tty**[=*false*]] +[**-t**|**--tty**] [**--tmpfs**[=*[CONTAINER-DIR[:]*]] [**-u**|**--user**[=*USER*]] [**--ulimit**[=*[]*]] diff --git a/man/docker-search.1.md b/man/docker-search.1.md index 0b205f4be..a95c02377 100644 --- a/man/docker-search.1.md +++ b/man/docker-search.1.md @@ -6,9 +6,9 @@ docker-search - Search the Docker Hub for images # SYNOPSIS **docker search** -[**--automated**[=*false*]] +[**--automated**] [**--help**] -[**--no-trunc**[=*false*]] +[**--no-trunc**] [**-s**|**--stars**[=*0*]] TERM diff --git a/man/docker-start.1.md b/man/docker-start.1.md index 2e1191b09..678f687f8 100644 --- a/man/docker-start.1.md +++ b/man/docker-start.1.md @@ -6,9 +6,9 @@ docker-start - Start one or more containers # SYNOPSIS **docker start** -[**-a**|**--attach**[=*false*]] +[**-a**|**--attach**] [**--help**] -[**-i**|**--interactive**[=*false*]] +[**-i**|**--interactive**] CONTAINER [CONTAINER...] # DESCRIPTION diff --git a/man/docker-stats.1.md b/man/docker-stats.1.md index 543a88837..c7fa7d504 100644 --- a/man/docker-stats.1.md +++ b/man/docker-stats.1.md @@ -6,9 +6,9 @@ docker-stats - Display a live stream of one or more containers' resource usage s # SYNOPSIS **docker stats** -[**-a**|**--all**[=*false*]] +[**-a**|**--all**] [**--help**] -[**--no-stream**[=*false*]] +[**--no-stream**] [CONTAINER...] # DESCRIPTION