kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

remove =false from options that default to false in the docs

Browse source 
This re-aligns the docs with what the cmd line now does.

Signed-off-by: Doug Davis <dug@us.ibm.com>
This commit is contained in:
Doug Davis 2015-12-23 06:37:06 -08:00
parent 4432a89821
commit e6115a6c1c
69 changed files with 170 additions and 170 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/reference/commandline/attach.md
View file

@ -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

10
docs/reference/commandline/build.md
View file

@ -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

2
docs/reference/commandline/commit.md
View file

@ -16,7 +16,7 @@ parent = "smn_cli"
-a, --author="" Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
-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

4
docs/reference/commandline/cp.md
View file

@ -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

14
docs/reference/commandline/create.md
View file

@ -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

14
docs/reference/commandline/daemon.md
View file

@ -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.

2
docs/reference/commandline/diff.md
View file

@ -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`:

2
docs/reference/commandline/events.md
View file

@ -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

10
docs/reference/commandline/exec.md
View file

@ -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.

2
docs/reference/commandline/export.md
View file

@ -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

6
docs/reference/commandline/history.md
View file

@ -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:

10
docs/reference/commandline/images.md
View file

@ -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.

2
docs/reference/commandline/import.md
View file

@ -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

2
docs/reference/commandline/info.md
View file

@ -15,7 +15,7 @@ parent = "smn_cli"
Display system-wide information
--help=false Print usage
--help Print usage
For example:

4
docs/reference/commandline/inspect.md
View file

@ -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.

2
docs/reference/commandline/kill.md
View file

@ -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

2
docs/reference/commandline/load.md
View file

@ -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.

2
docs/reference/commandline/login.md
View file

@ -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

2
docs/reference/commandline/logout.md
View file

@ -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:

6
docs/reference/commandline/logs.md
View file

@ -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

2
docs/reference/commandline/network_connect.md
View file

@ -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

2
docs/reference/commandline/network_create.md
View file

@ -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

2
docs/reference/commandline/network_disconnect.md
View file

@ -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.

2
docs/reference/commandline/network_inspect.md
View file

@ -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:

6
docs/reference/commandline/network_ls.md
View file

@ -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:

2
docs/reference/commandline/network_rm.md
View file

@ -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.

2
docs/reference/commandline/pause.md
View file

@ -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

2
docs/reference/commandline/port.md
View file

@ -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:

12
docs/reference/commandline/ps.md
View file

@ -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.

4
docs/reference/commandline/pull.md
View file

@ -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.

2
docs/reference/commandline/push.md
View file

@ -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.

2
docs/reference/commandline/rename.md
View file

@ -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.

2
docs/reference/commandline/restart.md
View file

@ -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

8
docs/reference/commandline/rm.md
View file

@ -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

6
docs/reference/commandline/rmi.md
View file

@ -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

18
docs/reference/commandline/run.md
View file

@ -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:<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)
--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><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`.
--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: <name|uid>[:<group|gid>])
--ulimit=[] Ulimit options
--uts="" UTS namespace to use

2
docs/reference/commandline/save.md
View file

@ -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.

6
docs/reference/commandline/search.md
View file

@ -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

6
docs/reference/commandline/start.md
View file

@ -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

6
docs/reference/commandline/stats.md
View file

@ -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.

2
docs/reference/commandline/stop.md
View file

@ -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

2
docs/reference/commandline/tag.md
View file

@ -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).

2
docs/reference/commandline/top.md
View file

@ -14,4 +14,4 @@ parent = "smn_cli"
Display the running processes of a container
--help=false Print usage
--help Print usage

2
docs/reference/commandline/unpause.md
View file

@ -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.

2
docs/reference/commandline/version.md
View file

@ -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.

2
docs/reference/commandline/volume_create.md
View file

@ -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

2
docs/reference/commandline/volume_inspect.md
View file

@ -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

4
docs/reference/commandline/volume_ls.md
View file

@ -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"`)

2
docs/reference/commandline/volume_rm.md
View file

@ -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.

2
docs/reference/commandline/wait.md
View file

@ -14,4 +14,4 @@ parent = "smn_cli"
Block until a container stops, then print its exit code.
--help=false Print usage
--help Print usage

6
docs/reference/run.md
View file

@ -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

4
docs/userguide/usingdocker.md
View file

@ -70,8 +70,8 @@ To see usage for a specific command, specify the command with the `--help` flag:
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
> **Note:**

2
man/docker-attach.1.md
View file

@ -7,7 +7,7 @@ docker-attach - Attach to a running container
# SYNOPSIS
**docker attach**
[**--help**]
[**--no-stdin**[=*false*]]
[**--no-stdin**]
[**--sig-proxy**[=*true*]]
CONTAINER

8
man/docker-build.1.md
View file

@ -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*]]

12
man/docker-create.1.md
View file

@ -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[:<OPTIONS>]*]]
[**-u**|**--user**[=*USER*]]
[**--ulimit**[=*[]*]]

12
man/docker-daemon.8.md
View file

@ -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

8
man/docker-exec.1.md
View file

@ -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...]

4
man/docker-history.1.md
View file

@ -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

8
man/docker-images.1.md
View file

@ -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

4
man/docker-inspect.1.md
View file

@ -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*"

4
man/docker-logs.1.md
View file

@ -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

10
man/docker-ps.1.md
View file

@ -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

2
man/docker-pull.1.md
View file

@ -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]

6
man/docker-rm.1.md
View file

@ -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

4
man/docker-rmi.1.md
View file

@ -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

16
man/docker-run.1.md
View file

@ -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[:<OPTIONS>]*]]
[**-u**|**--user**[=*USER*]]
[**--ulimit**[=*[]*]]

4
man/docker-search.1.md
View file

@ -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

4
man/docker-start.1.md
View file

@ -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

4
man/docker-stats.1.md
View file

@ -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