mirror of https://github.com/docker/cli.git
remove =false from options that default to false in the docs
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:
parent
ed4cf608e2
commit
421578fbd4
|
@ -14,8 +14,8 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Attach to a running container
|
Attach to a running container
|
||||||
|
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--no-stdin=false Do not attach STDIN
|
--no-stdin Do not attach STDIN
|
||||||
--sig-proxy=true Proxy all received signals to the process
|
--sig-proxy=true Proxy all received signals to the process
|
||||||
|
|
||||||
The `docker attach` command allows you to attach to a running container using
|
The `docker attach` command allows you to attach to a running container using
|
||||||
|
|
|
@ -23,14 +23,14 @@ parent = "smn_cli"
|
||||||
--cpuset-mems="" MEMs in which to allow execution, e.g. `0-3`, `0,1`
|
--cpuset-mems="" MEMs in which to allow execution, e.g. `0-3`, `0,1`
|
||||||
--disable-content-trust=true Skip image verification
|
--disable-content-trust=true Skip image verification
|
||||||
-f, --file="" Name of the Dockerfile (Default is 'PATH/Dockerfile')
|
-f, --file="" Name of the Dockerfile (Default is 'PATH/Dockerfile')
|
||||||
--force-rm=false Always remove intermediate containers
|
--force-rm Always remove intermediate containers
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--isolation="" Container isolation technology
|
--isolation="" Container isolation technology
|
||||||
-m, --memory="" Memory limit for all build containers
|
-m, --memory="" Memory limit for all build containers
|
||||||
--memory-swap="" Total memory (memory + swap), `-1` to disable swap
|
--memory-swap="" Total memory (memory + swap), `-1` to disable swap
|
||||||
--no-cache=false Do not use cache when building the image
|
--no-cache Do not use cache when building the image
|
||||||
--pull=false Always attempt to pull a newer version of the image
|
--pull Always attempt to pull a newer version of the image
|
||||||
-q, --quiet=false Suppress the build output and print image ID on success
|
-q, --quiet Suppress the build output and print image ID on success
|
||||||
--rm=true Remove intermediate containers after a successful build
|
--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`.
|
--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
|
-t, --tag=[] Name and optionally a tag in the 'name:tag' format
|
||||||
|
|
|
@ -16,7 +16,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
-a, --author="" Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
|
-a, --author="" Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
|
||||||
-c, --change=[] Apply specified Dockerfile instructions while committing the image
|
-c, --change=[] Apply specified Dockerfile instructions while committing the image
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-m, --message="" Commit message
|
-m, --message="" Commit message
|
||||||
-p, --pause=true Pause container during commit
|
-p, --pause=true Pause container during commit
|
||||||
|
|
||||||
|
|
|
@ -15,8 +15,8 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Copy files/folders between a container and the local filesystem
|
Copy files/folders between a container and the local filesystem
|
||||||
|
|
||||||
-L, --follow-link=false Always follow symbol link in SRC_PATH
|
-L, --follow-link Always follow symbol link in SRC_PATH
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
|
|
||||||
The `docker cp` utility copies the contents of `SRC_PATH` to the `DEST_PATH`.
|
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
|
You can copy from the container's file system to the local machine or the
|
||||||
|
|
|
@ -44,8 +44,8 @@ Creates a new container.
|
||||||
--expose=[] Expose a port or a range of ports
|
--expose=[] Expose a port or a range of ports
|
||||||
--group-add=[] Add additional groups to join
|
--group-add=[] Add additional groups to join
|
||||||
-h, --hostname="" Container host name
|
-h, --hostname="" Container host name
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-i, --interactive=false Keep STDIN open even if not attached
|
-i, --interactive Keep STDIN open even if not attached
|
||||||
--ipc="" IPC namespace to use
|
--ipc="" IPC namespace to use
|
||||||
--isolation="" Container isolation technology
|
--isolation="" Container isolation technology
|
||||||
--kernel-memory="" Kernel memory limit
|
--kernel-memory="" Kernel memory limit
|
||||||
|
@ -66,18 +66,18 @@ Creates a new container.
|
||||||
'container:<name|id>': reuse another container's network stack
|
'container:<name|id>': reuse another container's network stack
|
||||||
'host': use the Docker host network stack
|
'host': use the Docker host network stack
|
||||||
'<network-name>|<network-id>': connect to a user-defined network
|
'<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)
|
--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
|
-p, --publish=[] Publish a container's port(s) to the host
|
||||||
--pid="" PID namespace to use
|
--pid="" PID namespace to use
|
||||||
--privileged=false Give extended privileges to this container
|
--privileged Give extended privileges to this container
|
||||||
--read-only=false Mount the container's root filesystem as read only
|
--read-only Mount the container's root filesystem as read only
|
||||||
--restart="no" Restart policy (no, on-failure[:max-retry], always, unless-stopped)
|
--restart="no" Restart policy (no, on-failure[:max-retry], always, unless-stopped)
|
||||||
--security-opt=[] Security options
|
--security-opt=[] Security options
|
||||||
--stop-signal="SIGTERM" Signal to stop a container
|
--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`.
|
--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
|
-u, --user="" Username or UID
|
||||||
--ulimit=[] Ulimit options
|
--ulimit=[] Ulimit options
|
||||||
--uts="" UTS namespace to use
|
--uts="" UTS namespace to use
|
||||||
|
|
|
@ -20,7 +20,7 @@ weight = -1
|
||||||
--authz-plugin=[] Set authorization plugins to load
|
--authz-plugin=[] Set authorization plugins to load
|
||||||
-b, --bridge="" Attach containers to a network bridge
|
-b, --bridge="" Attach containers to a network bridge
|
||||||
--bip="" Specify network bridge IP
|
--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="" Container default gateway IPv4 address
|
||||||
--default-gateway-v6="" Container default gateway IPv6 address
|
--default-gateway-v6="" Container default gateway IPv6 address
|
||||||
--cluster-store="" URL of the distributed storage backend
|
--cluster-store="" URL of the distributed storage backend
|
||||||
|
@ -37,30 +37,30 @@ weight = -1
|
||||||
-G, --group="docker" Group for the unix socket
|
-G, --group="docker" Group for the unix socket
|
||||||
-g, --graph="/var/lib/docker" Root of the Docker runtime
|
-g, --graph="/var/lib/docker" Root of the Docker runtime
|
||||||
-H, --host=[] Daemon socket(s) to connect to
|
-H, --host=[] Daemon socket(s) to connect to
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--icc=true Enable inter-container communication
|
--icc=true Enable inter-container communication
|
||||||
--insecure-registry=[] Enable insecure registry communication
|
--insecure-registry=[] Enable insecure registry communication
|
||||||
--ip=0.0.0.0 Default IP when binding container ports
|
--ip=0.0.0.0 Default IP when binding container ports
|
||||||
--ip-forward=true Enable net.ipv4.ip_forward
|
--ip-forward=true Enable net.ipv4.ip_forward
|
||||||
--ip-masq=true Enable IP masquerading
|
--ip-masq=true Enable IP masquerading
|
||||||
--iptables=true Enable addition of iptables rules
|
--iptables=true Enable addition of iptables rules
|
||||||
--ipv6=false Enable IPv6 networking
|
--ipv6 Enable IPv6 networking
|
||||||
-l, --log-level="info" Set the logging level
|
-l, --log-level="info" Set the logging level
|
||||||
--label=[] Set key=value labels to the daemon
|
--label=[] Set key=value labels to the daemon
|
||||||
--log-driver="json-file" Default driver for container logs
|
--log-driver="json-file" Default driver for container logs
|
||||||
--log-opt=[] Log driver specific options
|
--log-opt=[] Log driver specific options
|
||||||
--mtu=0 Set the containers network MTU
|
--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
|
-p, --pidfile="/var/run/docker.pid" Path to use for daemon PID file
|
||||||
--registry-mirror=[] Preferred Docker registry mirror
|
--registry-mirror=[] Preferred Docker registry mirror
|
||||||
-s, --storage-driver="" Storage driver to use
|
-s, --storage-driver="" Storage driver to use
|
||||||
--selinux-enabled=false Enable selinux support
|
--selinux-enabled Enable selinux support
|
||||||
--storage-opt=[] Set storage driver options
|
--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
|
--tlscacert="~/.docker/ca.pem" Trust certs signed only by this CA
|
||||||
--tlscert="~/.docker/cert.pem" Path to TLS certificate file
|
--tlscert="~/.docker/cert.pem" Path to TLS certificate file
|
||||||
--tlskey="~/.docker/key.pem" Path to TLS key 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
|
--userland-proxy=true Use userland proxy for loopback traffic
|
||||||
|
|
||||||
Options with [] may be specified multiple times.
|
Options with [] may be specified multiple times.
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Inspect changes on a container's filesystem
|
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
|
List the changed files and directories in a container᾿s filesystem
|
||||||
There are 3 events that are listed in the `diff`:
|
There are 3 events that are listed in the `diff`:
|
||||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
||||||
Get real time events from the server
|
Get real time events from the server
|
||||||
|
|
||||||
-f, --filter=[] Filter output based on conditions provided
|
-f, --filter=[] Filter output based on conditions provided
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--since="" Show all events created since timestamp
|
--since="" Show all events created since timestamp
|
||||||
--until="" Stream events until this timestamp
|
--until="" Stream events until this timestamp
|
||||||
|
|
||||||
|
|
|
@ -14,11 +14,11 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Run a command in a running container
|
Run a command in a running container
|
||||||
|
|
||||||
-d, --detach=false Detached mode: run command in the background
|
-d, --detach Detached mode: run command in the background
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-i, --interactive=false Keep STDIN open even if not attached
|
-i, --interactive Keep STDIN open even if not attached
|
||||||
--privileged=false Give extended Linux capabilities to the command
|
--privileged Give extended Linux capabilities to the command
|
||||||
-t, --tty=false Allocate a pseudo-TTY
|
-t, --tty Allocate a pseudo-TTY
|
||||||
-u, --user= Username or UID (format: <name|uid>[:<group|gid>])
|
-u, --user= Username or UID (format: <name|uid>[:<group|gid>])
|
||||||
|
|
||||||
The `docker exec` command runs a new command in a running container.
|
The `docker exec` command runs a new command in a running container.
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Export the contents of a container's filesystem as a tar archive
|
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
|
-o, --output="" Write to a file, instead of STDOUT
|
||||||
|
|
||||||
The `docker export` command does not export the contents of volumes associated
|
The `docker export` command does not export the contents of volumes associated
|
||||||
|
|
|
@ -15,9 +15,9 @@ parent = "smn_cli"
|
||||||
Show the history of an image
|
Show the history of an image
|
||||||
|
|
||||||
-H, --human=true Print sizes and dates in human readable format
|
-H, --human=true Print sizes and dates in human readable format
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--no-trunc=false Don't truncate output
|
--no-trunc Don't truncate output
|
||||||
-q, --quiet=false Only show numeric IDs
|
-q, --quiet Only show numeric IDs
|
||||||
|
|
||||||
To see how the `docker:latest` image was built:
|
To see how the `docker:latest` image was built:
|
||||||
|
|
||||||
|
|
|
@ -14,12 +14,12 @@ parent = "smn_cli"
|
||||||
|
|
||||||
List images
|
List images
|
||||||
|
|
||||||
-a, --all=false Show all images (default hides intermediate images)
|
-a, --all Show all images (default hides intermediate images)
|
||||||
--digests=false Show digests
|
--digests Show digests
|
||||||
-f, --filter=[] Filter output based on conditions provided
|
-f, --filter=[] Filter output based on conditions provided
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--no-trunc=false Don't truncate output
|
--no-trunc Don't truncate output
|
||||||
-q, --quiet=false Only show numeric IDs
|
-q, --quiet Only show numeric IDs
|
||||||
|
|
||||||
The default `docker images` will show all top level
|
The default `docker images` will show all top level
|
||||||
images, their repository and tags, and their virtual size.
|
images, their repository and tags, and their virtual size.
|
||||||
|
|
|
@ -17,7 +17,7 @@ parent = "smn_cli"
|
||||||
optionally tag it.
|
optionally tag it.
|
||||||
|
|
||||||
-c, --change=[] Apply specified Dockerfile instructions while importing the image
|
-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
|
-m, --message= Set commit message for imported image
|
||||||
|
|
||||||
You can specify a `URL` or `-` (dash) to take data directly from `STDIN`. The
|
You can specify a `URL` or `-` (dash) to take data directly from `STDIN`. The
|
||||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Display system-wide information
|
Display system-wide information
|
||||||
|
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
|
|
|
@ -15,10 +15,10 @@ parent = "smn_cli"
|
||||||
Return low-level information on a container or image
|
Return low-level information on a container or image
|
||||||
|
|
||||||
-f, --format="" Format the output using the given go template
|
-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
|
--type=container|image Return JSON for specified type, permissible
|
||||||
values are "image" or "container"
|
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
|
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.
|
specified, the given template will be executed for each result.
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Kill a running container using SIGKILL or a specified signal
|
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
|
-s, --signal="KILL" Signal to send to the container
|
||||||
|
|
||||||
The main process inside the container will be sent `SIGKILL`, or any
|
The main process inside the container will be sent `SIGKILL`, or any
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Load an image from a tar archive or STDIN
|
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
|
-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.
|
Loads a tarred repository from a file or the standard input stream.
|
||||||
|
|
|
@ -16,7 +16,7 @@ parent = "smn_cli"
|
||||||
specified "https://index.docker.io/v1/" is the default.
|
specified "https://index.docker.io/v1/" is the default.
|
||||||
|
|
||||||
-e, --email="" Email
|
-e, --email="" Email
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-p, --password="" Password
|
-p, --password="" Password
|
||||||
-u, --username="" Username
|
-u, --username="" Username
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
||||||
Log out from a Docker registry, if no server is
|
Log out from a Docker registry, if no server is
|
||||||
specified "https://index.docker.io/v1/" is the default.
|
specified "https://index.docker.io/v1/" is the default.
|
||||||
|
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
|
|
|
@ -14,10 +14,10 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Fetch the logs of a container
|
Fetch the logs of a container
|
||||||
|
|
||||||
-f, --follow=false Follow log output
|
-f, --follow Follow log output
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--since="" Show logs since timestamp
|
--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
|
--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
|
> **Note**: this command is available only for containers with `json-file` and
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Connects a container to a network
|
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
|
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
|
or by ID. Once connected, the container can communicate with other containers in
|
||||||
|
|
|
@ -17,7 +17,7 @@ parent = "smn_cli"
|
||||||
--aux-address=map[] Auxiliary ipv4 or ipv6 addresses used by network driver
|
--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.
|
-d --driver=DRIVER Driver to manage the Network bridge or overlay. The default is bridge.
|
||||||
--gateway=[] ipv4 or ipv6 Gateway for the master subnet
|
--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
|
--ip-range=[] Allocate container ip from a sub-range
|
||||||
--ipam-driver=default IP Address Management Driver
|
--ipam-driver=default IP Address Management Driver
|
||||||
-o --opt=map[] Set custom network plugin options
|
-o --opt=map[] Set custom network plugin options
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Disconnects a container from a network
|
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.
|
Disconnects a container from a network. The container must be running to disconnect it from the network.
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
||||||
Displays detailed information on a network
|
Displays detailed information on a network
|
||||||
|
|
||||||
-f, --format= Format the output using the given go template.
|
-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:
|
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:
|
||||||
|
|
||||||
|
|
|
@ -14,9 +14,9 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Lists all the networks created by the user
|
Lists all the networks created by the user
|
||||||
-f, --filter=[] Filter output based on conditions provided
|
-f, --filter=[] Filter output based on conditions provided
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--no-trunc=false Do not truncate the output
|
--no-trunc Do not truncate the output
|
||||||
-q, --quiet=false Only display numeric IDs
|
-q, --quiet Only display numeric IDs
|
||||||
|
|
||||||
Lists all the networks the Engine `daemon` knows about. This includes the
|
Lists all the networks the Engine `daemon` knows about. This includes the
|
||||||
networks that span across multiple hosts in a cluster, for example:
|
networks that span across multiple hosts in a cluster, for example:
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Deletes one or more networks
|
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,
|
Removes one or more networks by name or identifier. To remove a network,
|
||||||
you must first disconnect any containers connected to it.
|
you must first disconnect any containers connected to it.
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Pause all processes within a container
|
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
|
The `docker pause` command uses the cgroups freezer to suspend all processes in
|
||||||
a container. Traditionally, when suspending a process the `SIGSTOP` signal is
|
a container. Traditionally, when suspending a process the `SIGSTOP` signal is
|
||||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
||||||
List port mappings for the CONTAINER, or lookup the public-facing port that is
|
List port mappings for the CONTAINER, or lookup the public-facing port that is
|
||||||
NAT-ed to the PRIVATE_PORT
|
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
|
You can find out all the ports mapped by not specifying a `PRIVATE_PORT`, or
|
||||||
just a specific mapping:
|
just a specific mapping:
|
||||||
|
|
|
@ -14,15 +14,15 @@ parent = "smn_cli"
|
||||||
|
|
||||||
List containers
|
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
|
-f, --filter=[] Filter output based on conditions provided
|
||||||
--format=[] Pretty-print containers using a Go template
|
--format=[] Pretty-print containers using a Go template
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-l, --latest=false Show the latest created container (includes all states)
|
-l, --latest Show the latest created container (includes all states)
|
||||||
-n=-1 Show n last created containers (includes all states)
|
-n=-1 Show n last created containers (includes all states)
|
||||||
--no-trunc=false Don't truncate output
|
--no-trunc Don't truncate output
|
||||||
-q, --quiet=false Only display numeric IDs
|
-q, --quiet Only display numeric IDs
|
||||||
-s, --size=false Display total file sizes
|
-s, --size Display total file sizes
|
||||||
|
|
||||||
Running `docker ps --no-trunc` showing 2 linked containers.
|
Running `docker ps --no-trunc` showing 2 linked containers.
|
||||||
|
|
||||||
|
|
|
@ -14,9 +14,9 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Pull an image or a repository from the registry
|
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
|
--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
|
Most of your images will be created on top of a base image from the
|
||||||
[Docker Hub](https://hub.docker.com) registry.
|
[Docker Hub](https://hub.docker.com) registry.
|
||||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
||||||
Push an image or a repository to the registry
|
Push an image or a repository to the registry
|
||||||
|
|
||||||
--disable-content-trust=true Skip image signing
|
--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)
|
Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com)
|
||||||
registry or to a self-hosted one.
|
registry or to a self-hosted one.
|
||||||
|
|
|
@ -14,6 +14,6 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Rename a container
|
Rename a container
|
||||||
|
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
|
|
||||||
The `docker rename` command allows the container to be renamed to a different name.
|
The `docker rename` command allows the container to be renamed to a different name.
|
||||||
|
|
|
@ -14,5 +14,5 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Restart a container
|
Restart a container
|
||||||
|
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-t, --time=10 Seconds to wait for stop before killing the container
|
-t, --time=10 Seconds to wait for stop before killing the container
|
||||||
|
|
|
@ -14,10 +14,10 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Remove one or more containers
|
Remove one or more containers
|
||||||
|
|
||||||
-f, --force=false Force the removal of a running container (uses SIGKILL)
|
-f, --force Force the removal of a running container (uses SIGKILL)
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-l, --link=false Remove the specified link
|
-l, --link Remove the specified link
|
||||||
-v, --volumes=false Remove the volumes associated with the container
|
-v, --volumes Remove the volumes associated with the container
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -14,9 +14,9 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Remove one or more images
|
Remove one or more images
|
||||||
|
|
||||||
-f, --force=false Force removal of the image
|
-f, --force Force removal of the image
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--no-prune=false Do not delete untagged parents
|
--no-prune Do not delete untagged parents
|
||||||
|
|
||||||
You can remove an image using its short or long ID, its tag, or its digest. If
|
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
|
an image has one or more tag or digest reference, you must remove all of them
|
||||||
|
|
|
@ -27,7 +27,7 @@ parent = "smn_cli"
|
||||||
--cpu-quota=0 Limit CPU CFS (Completely Fair Scheduler) quota
|
--cpu-quota=0 Limit CPU CFS (Completely Fair Scheduler) quota
|
||||||
--cpuset-cpus="" CPUs in which to allow execution (0-3, 0,1)
|
--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)
|
--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=[] 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-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)
|
--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
|
--expose=[] Expose a port or a range of ports
|
||||||
--group-add=[] Add additional groups to run as
|
--group-add=[] Add additional groups to run as
|
||||||
-h, --hostname="" Container host name
|
-h, --hostname="" Container host name
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-i, --interactive=false Keep STDIN open even if not attached
|
-i, --interactive Keep STDIN open even if not attached
|
||||||
--ipc="" IPC namespace to use
|
--ipc="" IPC namespace to use
|
||||||
--isolation="" Container isolation technology
|
--isolation="" Container isolation technology
|
||||||
--kernel-memory="" Kernel memory limit
|
--kernel-memory="" Kernel memory limit
|
||||||
|
@ -65,20 +65,20 @@ parent = "smn_cli"
|
||||||
'container:<name|id>': reuse another container's network stack
|
'container:<name|id>': reuse another container's network stack
|
||||||
'host': use the Docker host network stack
|
'host': use the Docker host network stack
|
||||||
'<network-name>|<network-id>': connect to a user-defined network
|
'<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)
|
--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
|
-p, --publish=[] Publish a container's port(s) to the host
|
||||||
--pid="" PID namespace to use
|
--pid="" PID namespace to use
|
||||||
--privileged=false Give extended privileges to this container
|
--privileged Give extended privileges to this container
|
||||||
--read-only=false Mount the container's root filesystem as read only
|
--read-only Mount the container's root filesystem as read only
|
||||||
--restart="no" Restart policy (no, on-failure[:max-retry], always, unless-stopped)
|
--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`.
|
--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
|
--security-opt=[] Security Options
|
||||||
--sig-proxy=true Proxy received signals to the process
|
--sig-proxy=true Proxy received signals to the process
|
||||||
--stop-signal="SIGTERM" Signal to stop a container
|
--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>])
|
-u, --user="" Username or UID (format: <name|uid>[:<group|gid>])
|
||||||
--ulimit=[] Ulimit options
|
--ulimit=[] Ulimit options
|
||||||
--uts="" UTS namespace to use
|
--uts="" UTS namespace to use
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Save an image(s) to a tar archive (streamed to STDOUT by default)
|
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
|
-o, --output="" Write to a file, instead of STDOUT
|
||||||
|
|
||||||
Produces a tarred repository to the standard output stream.
|
Produces a tarred repository to the standard output stream.
|
||||||
|
|
|
@ -14,9 +14,9 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Search the Docker Hub for images
|
Search the Docker Hub for images
|
||||||
|
|
||||||
--automated=false Only show automated builds
|
--automated Only show automated builds
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--no-trunc=false Don't truncate output
|
--no-trunc Don't truncate output
|
||||||
-s, --stars=0 Only displays with at least x stars
|
-s, --stars=0 Only displays with at least x stars
|
||||||
|
|
||||||
Search [Docker Hub](https://hub.docker.com) for images
|
Search [Docker Hub](https://hub.docker.com) for images
|
||||||
|
|
|
@ -14,6 +14,6 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Start one or more containers
|
Start one or more containers
|
||||||
|
|
||||||
-a, --attach=false Attach STDOUT/STDERR and forward signals
|
-a, --attach Attach STDOUT/STDERR and forward signals
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-i, --interactive=false Attach container's STDIN
|
-i, --interactive Attach container's STDIN
|
||||||
|
|
|
@ -14,9 +14,9 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Display a live stream of one or more containers' resource usage statistics
|
Display a live stream of one or more containers' resource usage statistics
|
||||||
|
|
||||||
-a, --all=false Show all containers (default shows just running)
|
-a, --all Show all containers (default shows just running)
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--no-stream=false Disable streaming stats and only pull the first result
|
--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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
||||||
Stop a container by sending SIGTERM and then SIGKILL after a
|
Stop a container by sending SIGTERM and then SIGKILL after a
|
||||||
grace period
|
grace period
|
||||||
|
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-t, --time=10 Seconds to wait for stop before killing it
|
-t, --time=10 Seconds to wait for stop before killing it
|
||||||
|
|
||||||
The main process inside the container will receive `SIGTERM`, and after a grace
|
The main process inside the container will receive `SIGTERM`, and after a grace
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Tag an image into a repository
|
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
|
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).
|
to [*Share Images via Repositories*](../../userguide/dockerrepos.md#contributing-to-docker-hub).
|
||||||
|
|
|
@ -14,4 +14,4 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Display the running processes of a container
|
Display the running processes of a container
|
||||||
|
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Unpause all processes within a container
|
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
|
The `docker unpause` command uses the cgroups freezer to un-suspend all
|
||||||
processes in a container.
|
processes in a container.
|
||||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
||||||
Show the Docker version information.
|
Show the Docker version information.
|
||||||
|
|
||||||
-f, --format="" Format the output using the given go template
|
-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
|
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.
|
layout. If a format is specified, the given template will be executed instead.
|
||||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
||||||
Create a volume
|
Create a volume
|
||||||
|
|
||||||
-d, --driver=local Specify volume driver name
|
-d, --driver=local Specify volume driver name
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
--name= Specify volume name
|
--name= Specify volume name
|
||||||
-o, --opt=map[] Set driver specific options
|
-o, --opt=map[] Set driver specific options
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
||||||
Inspect one or more volumes
|
Inspect one or more volumes
|
||||||
|
|
||||||
-f, --format= Format the output using the given go template.
|
-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
|
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
|
in a JSON array. You can specify an alternate format to execute a
|
||||||
|
|
|
@ -15,8 +15,8 @@ parent = "smn_cli"
|
||||||
List volumes
|
List volumes
|
||||||
|
|
||||||
-f, --filter=[] Provide filter values (i.e. 'dangling=true')
|
-f, --filter=[] Provide filter values (i.e. 'dangling=true')
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
-q, --quiet=false Only display volume names
|
-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"`)
|
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"`)
|
||||||
|
|
||||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Remove a volume
|
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.
|
Removes one or more volumes. You cannot remove a volume that is in use by a container.
|
||||||
|
|
||||||
|
|
|
@ -14,4 +14,4 @@ parent = "smn_cli"
|
||||||
|
|
||||||
Block until a container stops, then print its exit code.
|
Block until a container stops, then print its exit code.
|
||||||
|
|
||||||
--help=false Print usage
|
--help Print usage
|
||||||
|
|
|
@ -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:
|
and pass along signals. All of that is configurable:
|
||||||
|
|
||||||
-a=[] : Attach to `STDIN`, `STDOUT` and/or `STDERR`
|
-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)
|
--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
|
If you do not specify `-a` then Docker will [attach all standard
|
||||||
streams]( https://github.com/docker/docker/blob/75a7f4d90cde0295bcfb7213004abce8d4779b75/commands.go#L1797).
|
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.
|
--expose=[]: Expose a port or a range of ports inside the container.
|
||||||
These are additional to those exposed by the `EXPOSE` instruction
|
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
|
-p=[] : Publish a container᾿s port or a range of ports to the host
|
||||||
format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort
|
format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort
|
||||||
Both hostPort and containerPort can be specified as a
|
Both hostPort and containerPort can be specified as a
|
||||||
|
|
|
@ -7,7 +7,7 @@ docker-attach - Attach to a running container
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker attach**
|
**docker attach**
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**--no-stdin**[=*false*]]
|
[**--no-stdin**]
|
||||||
[**--sig-proxy**[=*true*]]
|
[**--sig-proxy**[=*true*]]
|
||||||
CONTAINER
|
CONTAINER
|
||||||
|
|
||||||
|
|
|
@ -11,11 +11,11 @@ docker-build - Build a new image from the source code at PATH
|
||||||
[**--cgroup-parent**[=*CGROUP-PARENT*]]
|
[**--cgroup-parent**[=*CGROUP-PARENT*]]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**-f**|**--file**[=*PATH/Dockerfile*]]
|
[**-f**|**--file**[=*PATH/Dockerfile*]]
|
||||||
[**--force-rm**[=*false*]]
|
[**--force-rm**]
|
||||||
[**--isolation**[=*default*]]
|
[**--isolation**[=*default*]]
|
||||||
[**--no-cache**[=*false*]]
|
[**--no-cache**]
|
||||||
[**--pull**[=*false*]]
|
[**--pull**]
|
||||||
[**-q**|**--quiet**[=*false*]]
|
[**-q**|**--quiet**]
|
||||||
[**--rm**[=*true*]]
|
[**--rm**[=*true*]]
|
||||||
[**-t**|**--tag**[=*[]*]]
|
[**-t**|**--tag**[=*[]*]]
|
||||||
[**-m**|**--memory**[=*MEMORY*]]
|
[**-m**|**--memory**[=*MEMORY*]]
|
||||||
|
|
|
@ -34,7 +34,7 @@ docker-create - Create a new container
|
||||||
[**--group-add**[=*[]*]]
|
[**--group-add**[=*[]*]]
|
||||||
[**-h**|**--hostname**[=*HOSTNAME*]]
|
[**-h**|**--hostname**[=*HOSTNAME*]]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**-i**|**--interactive**[=*false*]]
|
[**-i**|**--interactive**]
|
||||||
[**--ipc**[=*IPC*]]
|
[**--ipc**[=*IPC*]]
|
||||||
[**--isolation**[=*default*]]
|
[**--isolation**[=*default*]]
|
||||||
[**--kernel-memory**[=*KERNEL-MEMORY*]]
|
[**--kernel-memory**[=*KERNEL-MEMORY*]]
|
||||||
|
@ -50,18 +50,18 @@ docker-create - Create a new container
|
||||||
[**--memory-swappiness**[=*MEMORY-SWAPPINESS*]]
|
[**--memory-swappiness**[=*MEMORY-SWAPPINESS*]]
|
||||||
[**--name**[=*NAME*]]
|
[**--name**[=*NAME*]]
|
||||||
[**--net**[=*"bridge"*]]
|
[**--net**[=*"bridge"*]]
|
||||||
[**--oom-kill-disable**[=*false*]]
|
[**--oom-kill-disable**]
|
||||||
[**--oom-score-adj**[=*0*]]
|
[**--oom-score-adj**[=*0*]]
|
||||||
[**-P**|**--publish-all**[=*false*]]
|
[**-P**|**--publish-all**]
|
||||||
[**-p**|**--publish**[=*[]*]]
|
[**-p**|**--publish**[=*[]*]]
|
||||||
[**--pid**[=*[]*]]
|
[**--pid**[=*[]*]]
|
||||||
[**--privileged**[=*false*]]
|
[**--privileged**]
|
||||||
[**--read-only**[=*false*]]
|
[**--read-only**]
|
||||||
[**--restart**[=*RESTART*]]
|
[**--restart**[=*RESTART*]]
|
||||||
[**--security-opt**[=*[]*]]
|
[**--security-opt**[=*[]*]]
|
||||||
[**--stop-signal**[=*SIGNAL*]]
|
[**--stop-signal**[=*SIGNAL*]]
|
||||||
[**--shm-size**[=*[]*]]
|
[**--shm-size**[=*[]*]]
|
||||||
[**-t**|**--tty**[=*false*]]
|
[**-t**|**--tty**]
|
||||||
[**--tmpfs**[=*[CONTAINER-DIR[:<OPTIONS>]*]]
|
[**--tmpfs**[=*[CONTAINER-DIR[:<OPTIONS>]*]]
|
||||||
[**-u**|**--user**[=*USER*]]
|
[**-u**|**--user**[=*USER*]]
|
||||||
[**--ulimit**[=*[]*]]
|
[**--ulimit**[=*[]*]]
|
||||||
|
|
|
@ -13,11 +13,11 @@ docker-daemon - Enable daemon mode
|
||||||
[**--cluster-store**[=*[]*]]
|
[**--cluster-store**[=*[]*]]
|
||||||
[**--cluster-advertise**[=*[]*]]
|
[**--cluster-advertise**[=*[]*]]
|
||||||
[**--cluster-store-opt**[=*map[]*]]
|
[**--cluster-store-opt**[=*map[]*]]
|
||||||
[**-D**|**--debug**[=*false*]]
|
[**-D**|**--debug**]
|
||||||
[**--default-gateway**[=*DEFAULT-GATEWAY*]]
|
[**--default-gateway**[=*DEFAULT-GATEWAY*]]
|
||||||
[**--default-gateway-v6**[=*DEFAULT-GATEWAY-V6*]]
|
[**--default-gateway-v6**[=*DEFAULT-GATEWAY-V6*]]
|
||||||
[**--default-ulimit**[=*[]*]]
|
[**--default-ulimit**[=*[]*]]
|
||||||
[**--disable-legacy-registry**[=*false*]]
|
[**--disable-legacy-registry**]
|
||||||
[**--dns**[=*[]*]]
|
[**--dns**[=*[]*]]
|
||||||
[**--dns-opt**[=*[]*]]
|
[**--dns-opt**[=*[]*]]
|
||||||
[**--dns-search**[=*[]*]]
|
[**--dns-search**[=*[]*]]
|
||||||
|
@ -35,7 +35,7 @@ docker-daemon - Enable daemon mode
|
||||||
[**--ip-forward**[=*true*]]
|
[**--ip-forward**[=*true*]]
|
||||||
[**--ip-masq**[=*true*]]
|
[**--ip-masq**[=*true*]]
|
||||||
[**--iptables**[=*true*]]
|
[**--iptables**[=*true*]]
|
||||||
[**--ipv6**[=*false*]]
|
[**--ipv6**]
|
||||||
[**-l**|**--log-level**[=*info*]]
|
[**-l**|**--log-level**[=*info*]]
|
||||||
[**--label**[=*[]*]]
|
[**--label**[=*[]*]]
|
||||||
[**--log-driver**[=*json-file*]]
|
[**--log-driver**[=*json-file*]]
|
||||||
|
@ -44,13 +44,13 @@ docker-daemon - Enable daemon mode
|
||||||
[**-p**|**--pidfile**[=*/var/run/docker.pid*]]
|
[**-p**|**--pidfile**[=*/var/run/docker.pid*]]
|
||||||
[**--registry-mirror**[=*[]*]]
|
[**--registry-mirror**[=*[]*]]
|
||||||
[**-s**|**--storage-driver**[=*STORAGE-DRIVER*]]
|
[**-s**|**--storage-driver**[=*STORAGE-DRIVER*]]
|
||||||
[**--selinux-enabled**[=*false*]]
|
[**--selinux-enabled**]
|
||||||
[**--storage-opt**[=*[]*]]
|
[**--storage-opt**[=*[]*]]
|
||||||
[**--tls**[=*false*]]
|
[**--tls**]
|
||||||
[**--tlscacert**[=*~/.docker/ca.pem*]]
|
[**--tlscacert**[=*~/.docker/ca.pem*]]
|
||||||
[**--tlscert**[=*~/.docker/cert.pem*]]
|
[**--tlscert**[=*~/.docker/cert.pem*]]
|
||||||
[**--tlskey**[=*~/.docker/key.pem*]]
|
[**--tlskey**[=*~/.docker/key.pem*]]
|
||||||
[**--tlsverify**[=*false*]]
|
[**--tlsverify**]
|
||||||
[**--userland-proxy**[=*true*]]
|
[**--userland-proxy**[=*true*]]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
|
@ -6,11 +6,11 @@ docker-exec - Run a command in a running container
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker exec**
|
**docker exec**
|
||||||
[**-d**|**--detach**[=*false*]]
|
[**-d**|**--detach**]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**-i**|**--interactive**[=*false*]]
|
[**-i**|**--interactive**]
|
||||||
[**--privileged**[=*false*]]
|
[**--privileged**]
|
||||||
[**-t**|**--tty**[=*false*]]
|
[**-t**|**--tty**]
|
||||||
[**-u**|**--user**[=*USER*]]
|
[**-u**|**--user**[=*USER*]]
|
||||||
CONTAINER COMMAND [ARG...]
|
CONTAINER COMMAND [ARG...]
|
||||||
|
|
||||||
|
|
|
@ -8,8 +8,8 @@ docker-history - Show the history of an image
|
||||||
**docker history**
|
**docker history**
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**-H**|**--human**[=*true*]]
|
[**-H**|**--human**[=*true*]]
|
||||||
[**--no-trunc**[=*false*]]
|
[**--no-trunc**]
|
||||||
[**-q**|**--quiet**[=*false*]]
|
[**-q**|**--quiet**]
|
||||||
IMAGE
|
IMAGE
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
|
@ -7,11 +7,11 @@ docker-images - List images
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker images**
|
**docker images**
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**-a**|**--all**[=*false*]]
|
[**-a**|**--all**]
|
||||||
[**--digests**[=*false*]]
|
[**--digests**]
|
||||||
[**-f**|**--filter**[=*[]*]]
|
[**-f**|**--filter**[=*[]*]]
|
||||||
[**--no-trunc**[=*false*]]
|
[**--no-trunc**]
|
||||||
[**-q**|**--quiet**[=*false*]]
|
[**-q**|**--quiet**]
|
||||||
[REPOSITORY[:TAG]]
|
[REPOSITORY[:TAG]]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
|
@ -8,7 +8,7 @@ docker-inspect - Return low-level information on a container or image
|
||||||
**docker inspect**
|
**docker inspect**
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**-f**|**--format**[=*FORMAT*]]
|
[**-f**|**--format**[=*FORMAT*]]
|
||||||
[**-s**|**--size**[=*false*]]
|
[**-s**|**--size**]
|
||||||
[**--type**=*container*|*image*]
|
[**--type**=*container*|*image*]
|
||||||
CONTAINER|IMAGE [CONTAINER|IMAGE...]
|
CONTAINER|IMAGE [CONTAINER|IMAGE...]
|
||||||
|
|
||||||
|
@ -26,7 +26,7 @@ each result.
|
||||||
**-f**, **--format**=""
|
**-f**, **--format**=""
|
||||||
Format the output using the given Go template.
|
Format the output using the given Go template.
|
||||||
|
|
||||||
**-s**, **--size**=*false*
|
**-s**, **--size**
|
||||||
Display total file sizes if the type is container.
|
Display total file sizes if the type is container.
|
||||||
|
|
||||||
**--type**="*container*|*image*"
|
**--type**="*container*|*image*"
|
||||||
|
|
|
@ -6,10 +6,10 @@ docker-logs - Fetch the logs of a container
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker logs**
|
**docker logs**
|
||||||
[**-f**|**--follow**[=*false*]]
|
[**-f**|**--follow**]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**--since**[=*SINCE*]]
|
[**--since**[=*SINCE*]]
|
||||||
[**-t**|**--timestamps**[=*false*]]
|
[**-t**|**--timestamps**]
|
||||||
[**--tail**[=*"all"*]]
|
[**--tail**[=*"all"*]]
|
||||||
CONTAINER
|
CONTAINER
|
||||||
|
|
||||||
|
|
|
@ -6,15 +6,15 @@ docker-ps - List containers
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker ps**
|
**docker ps**
|
||||||
[**-a**|**--all**[=*false*]]
|
[**-a**|**--all**]
|
||||||
[**-f**|**--filter**[=*[]*]]
|
[**-f**|**--filter**[=*[]*]]
|
||||||
[**--format**=*"TEMPLATE"*]
|
[**--format**=*"TEMPLATE"*]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**-l**|**--latest**[=*false*]]
|
[**-l**|**--latest**]
|
||||||
[**-n**[=*-1*]]
|
[**-n**[=*-1*]]
|
||||||
[**--no-trunc**[=*false*]]
|
[**--no-trunc**]
|
||||||
[**-q**|**--quiet**[=*false*]]
|
[**-q**|**--quiet**]
|
||||||
[**-s**|**--size**[=*false*]]
|
[**-s**|**--size**]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@ docker-pull - Pull an image or a repository from a registry
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker pull**
|
**docker pull**
|
||||||
[**-a**|**--all-tags**[=*false*]]
|
[**-a**|**--all-tags**]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
|
NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
|
||||||
|
|
||||||
|
|
|
@ -6,9 +6,9 @@ docker-rm - Remove one or more containers
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker rm**
|
**docker rm**
|
||||||
[**-f**|**--force**[=*false*]]
|
[**-f**|**--force**]
|
||||||
[**-l**|**--link**[=*false*]]
|
[**-l**|**--link**]
|
||||||
[**-v**|**--volumes**[=*false*]]
|
[**-v**|**--volumes**]
|
||||||
CONTAINER [CONTAINER...]
|
CONTAINER [CONTAINER...]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
|
@ -6,9 +6,9 @@ docker-rmi - Remove one or more images
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker rmi**
|
**docker rmi**
|
||||||
[**-f**|**--force**[=*false*]]
|
[**-f**|**--force**]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**--no-prune**[=*false*]]
|
[**--no-prune**]
|
||||||
IMAGE [IMAGE...]
|
IMAGE [IMAGE...]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
|
@ -19,7 +19,7 @@ docker-run - Run a command in a new container
|
||||||
[**--cpu-quota**[=*0*]]
|
[**--cpu-quota**[=*0*]]
|
||||||
[**--cpuset-cpus**[=*CPUSET-CPUS*]]
|
[**--cpuset-cpus**[=*CPUSET-CPUS*]]
|
||||||
[**--cpuset-mems**[=*CPUSET-MEMS*]]
|
[**--cpuset-mems**[=*CPUSET-MEMS*]]
|
||||||
[**-d**|**--detach**[=*false*]]
|
[**-d**|**--detach**]
|
||||||
[**--device**[=*[]*]]
|
[**--device**[=*[]*]]
|
||||||
[**--device-read-bps**[=*[]*]]
|
[**--device-read-bps**[=*[]*]]
|
||||||
[**--device-read-iops**[=*[]*]]
|
[**--device-read-iops**[=*[]*]]
|
||||||
|
@ -35,7 +35,7 @@ docker-run - Run a command in a new container
|
||||||
[**--group-add**[=*[]*]]
|
[**--group-add**[=*[]*]]
|
||||||
[**-h**|**--hostname**[=*HOSTNAME*]]
|
[**-h**|**--hostname**[=*HOSTNAME*]]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**-i**|**--interactive**[=*false*]]
|
[**-i**|**--interactive**]
|
||||||
[**--ipc**[=*IPC*]]
|
[**--ipc**[=*IPC*]]
|
||||||
[**--isolation**[=*default*]]
|
[**--isolation**[=*default*]]
|
||||||
[**--kernel-memory**[=*KERNEL-MEMORY*]]
|
[**--kernel-memory**[=*KERNEL-MEMORY*]]
|
||||||
|
@ -51,20 +51,20 @@ docker-run - Run a command in a new container
|
||||||
[**--memory-swappiness**[=*MEMORY-SWAPPINESS*]]
|
[**--memory-swappiness**[=*MEMORY-SWAPPINESS*]]
|
||||||
[**--name**[=*NAME*]]
|
[**--name**[=*NAME*]]
|
||||||
[**--net**[=*"bridge"*]]
|
[**--net**[=*"bridge"*]]
|
||||||
[**--oom-kill-disable**[=*false*]]
|
[**--oom-kill-disable**]
|
||||||
[**--oom-score-adj**[=*0*]]
|
[**--oom-score-adj**[=*0*]]
|
||||||
[**-P**|**--publish-all**[=*false*]]
|
[**-P**|**--publish-all**]
|
||||||
[**-p**|**--publish**[=*[]*]]
|
[**-p**|**--publish**[=*[]*]]
|
||||||
[**--pid**[=*[]*]]
|
[**--pid**[=*[]*]]
|
||||||
[**--privileged**[=*false*]]
|
[**--privileged**]
|
||||||
[**--read-only**[=*false*]]
|
[**--read-only**]
|
||||||
[**--restart**[=*RESTART*]]
|
[**--restart**[=*RESTART*]]
|
||||||
[**--rm**[=*false*]]
|
[**--rm**]
|
||||||
[**--security-opt**[=*[]*]]
|
[**--security-opt**[=*[]*]]
|
||||||
[**--stop-signal**[=*SIGNAL*]]
|
[**--stop-signal**[=*SIGNAL*]]
|
||||||
[**--shm-size**[=*[]*]]
|
[**--shm-size**[=*[]*]]
|
||||||
[**--sig-proxy**[=*true*]]
|
[**--sig-proxy**[=*true*]]
|
||||||
[**-t**|**--tty**[=*false*]]
|
[**-t**|**--tty**]
|
||||||
[**--tmpfs**[=*[CONTAINER-DIR[:<OPTIONS>]*]]
|
[**--tmpfs**[=*[CONTAINER-DIR[:<OPTIONS>]*]]
|
||||||
[**-u**|**--user**[=*USER*]]
|
[**-u**|**--user**[=*USER*]]
|
||||||
[**--ulimit**[=*[]*]]
|
[**--ulimit**[=*[]*]]
|
||||||
|
|
|
@ -6,9 +6,9 @@ docker-search - Search the Docker Hub for images
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker search**
|
**docker search**
|
||||||
[**--automated**[=*false*]]
|
[**--automated**]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**--no-trunc**[=*false*]]
|
[**--no-trunc**]
|
||||||
[**-s**|**--stars**[=*0*]]
|
[**-s**|**--stars**[=*0*]]
|
||||||
TERM
|
TERM
|
||||||
|
|
||||||
|
|
|
@ -6,9 +6,9 @@ docker-start - Start one or more containers
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker start**
|
**docker start**
|
||||||
[**-a**|**--attach**[=*false*]]
|
[**-a**|**--attach**]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**-i**|**--interactive**[=*false*]]
|
[**-i**|**--interactive**]
|
||||||
CONTAINER [CONTAINER...]
|
CONTAINER [CONTAINER...]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
|
@ -6,9 +6,9 @@ docker-stats - Display a live stream of one or more containers' resource usage s
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker stats**
|
**docker stats**
|
||||||
[**-a**|**--all**[=*false*]]
|
[**-a**|**--all**]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**--no-stream**[=*false*]]
|
[**--no-stream**]
|
||||||
[CONTAINER...]
|
[CONTAINER...]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
Loading…
Reference in New Issue