Merge pull request moby#18874 from duglin/falseDocs

remove =false from options that default to false in the docs
ktraghavendra · Dec 23, 2015 · 8022d11 · 8022d11
2 parents 4432a89 + e6115a6
commit 8022d11
Show file tree

Hide file tree

Showing 69 changed files with 170 additions and 170 deletions.
diff --git 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
@@ -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><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`.
       -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
@@ -16,7 +16,7 @@ parent = "smn_cli"
 
       -a, --author=""     Author (e.g., "John Hannibal Smith <[email protected]>")
       -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
@@ -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
@@ -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:<name|id>': reuse another container's network stack
                                     'host': use the Docker host network stack
                                     '<network-name>|<network-id>': 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><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`.
-      -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
@@ -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
@@ -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
@@ -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
@@ -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: <name|uid>[:<group|gid>])
 
 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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.