mirror of https://github.com/docker/cli.git
Fix man and commandline docs
- missing help option in `docs/reference/commandline/*.md` (some files have it, the other I fixed didn't) - missing `[OPTIONS]` in Usage description - missing options - formatting - start/stop idempotence Signed-off-by: Antonio Murdaca <amurdaca@redhat.com>
This commit is contained in:
parent
1b1a0a0835
commit
cbd33a2b27
|
@ -360,7 +360,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from search' -l no-trunc -d
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from search' -s s -l stars -d 'Only displays with at least x stars'
|
complete -c docker -A -f -n '__fish_seen_subcommand_from search' -s s -l stars -d 'Only displays with at least x stars'
|
||||||
|
|
||||||
# start
|
# start
|
||||||
complete -c docker -f -n '__fish_docker_no_subcommand' -a start -d 'Start a stopped container'
|
complete -c docker -f -n '__fish_docker_no_subcommand' -a start -d 'Start a container'
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from start' -s a -l attach -d "Attach container's STDOUT and STDERR and forward all signals to the process"
|
complete -c docker -A -f -n '__fish_seen_subcommand_from start' -s a -l attach -d "Attach container's STDOUT and STDERR and forward all signals to the process"
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from start' -l help -d 'Print usage'
|
complete -c docker -A -f -n '__fish_seen_subcommand_from start' -l help -d 'Print usage'
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from start' -s i -l interactive -d "Attach container's STDIN"
|
complete -c docker -A -f -n '__fish_seen_subcommand_from start' -s i -l interactive -d "Attach container's STDIN"
|
||||||
|
@ -373,7 +373,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from stats' -l no-stream -d
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from stats' -a '(__fish_print_docker_containers running)' -d "Container"
|
complete -c docker -A -f -n '__fish_seen_subcommand_from stats' -a '(__fish_print_docker_containers running)' -d "Container"
|
||||||
|
|
||||||
# stop
|
# stop
|
||||||
complete -c docker -f -n '__fish_docker_no_subcommand' -a stop -d 'Stop a running container'
|
complete -c docker -f -n '__fish_docker_no_subcommand' -a stop -d 'Stop a container'
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -l help -d 'Print usage'
|
complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -l help -d 'Print usage'
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -s t -l time -d 'Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.'
|
complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -s t -l time -d 'Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.'
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -a '(__fish_print_docker_containers running)' -d "Container"
|
complete -c docker -A -f -n '__fish_seen_subcommand_from stop' -a '(__fish_print_docker_containers running)' -d "Container"
|
||||||
|
|
|
@ -15,6 +15,7 @@ weight=1
|
||||||
|
|
||||||
Attach to a running container
|
Attach to a running container
|
||||||
|
|
||||||
|
--help=false Print usage
|
||||||
--no-stdin=false Do not attach STDIN
|
--no-stdin=false Do not attach STDIN
|
||||||
--sig-proxy=true Proxy all received signals to the process
|
--sig-proxy=true Proxy all received signals to the process
|
||||||
|
|
||||||
|
|
|
@ -15,21 +15,25 @@ weight=1
|
||||||
|
|
||||||
Build a new image from the source code at PATH
|
Build a new image from the source code at PATH
|
||||||
|
|
||||||
-f, --file="" Name of the Dockerfile (Default is 'PATH/Dockerfile')
|
--build-arg=[] Set build-time variables
|
||||||
--force-rm=false Always remove intermediate containers
|
-c, --cpu-shares CPU Shares (relative weight)
|
||||||
--build-arg=[] Set build-time variables
|
--cgroup-parent="" Optional parent cgroup for the container
|
||||||
--no-cache=false Do not use cache when building the image
|
--cpu-period=0 Limit the CPU CFS (Completely Fair Scheduler) period
|
||||||
--pull=false Always attempt to pull a newer version of the image
|
--cpu-quota=0 Limit the CPU CFS (Completely Fair Scheduler) quota
|
||||||
-q, --quiet=false Suppress the verbose output generated by the containers
|
--cpuset-cpus="" CPUs in which to allow execution, e.g. `0-3`, `0,1`
|
||||||
--rm=true Remove intermediate containers after a successful build
|
--cpuset-mems="" MEMs in which to allow execution, e.g. `0-3`, `0,1`
|
||||||
-t, --tag="" Repository name (and optionally a tag) for the image
|
--disable-content-trust=true Skip image verification
|
||||||
-m, --memory="" Memory limit for all build containers
|
-f, --file="" Name of the Dockerfile (Default is 'PATH/Dockerfile')
|
||||||
--memory-swap="" Total memory (memory + swap), `-1` to disable swap
|
--force-rm=false Always remove intermediate containers
|
||||||
-c, --cpu-shares CPU Shares (relative weight)
|
--help=false Print usage
|
||||||
--cpuset-mems="" MEMs in which to allow execution, e.g. `0-3`, `0,1`
|
-m, --memory="" Memory limit for all build containers
|
||||||
--cpuset-cpus="" CPUs in which to allow execution, e.g. `0-3`, `0,1`
|
--memory-swap="" Total memory (memory + swap), `-1` to disable swap
|
||||||
--cgroup-parent="" Optional parent cgroup for the container
|
--no-cache=false Do not use cache when building the image
|
||||||
--ulimit=[] Ulimit options
|
--pull=false Always attempt to pull a newer version of the image
|
||||||
|
-q, --quiet=false Suppress the verbose output generated by the containers
|
||||||
|
--rm=true Remove intermediate containers after a successful build
|
||||||
|
-t, --tag="" Repository name (and optionally a tag) for the image
|
||||||
|
--ulimit=[] Ulimit options
|
||||||
|
|
||||||
Builds Docker images from a Dockerfile and a "context". A build's context is
|
Builds Docker images from a Dockerfile and a "context". A build's context is
|
||||||
the files located in the specified `PATH` or `URL`. The build process can refer
|
the files located in the specified `PATH` or `URL`. The build process can refer
|
||||||
|
|
|
@ -17,6 +17,7 @@ weight=1
|
||||||
|
|
||||||
-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
|
||||||
-m, --message="" Commit message
|
-m, --message="" Commit message
|
||||||
-p, --pause=true Pause container during commit
|
-p, --pause=true Pause container during commit
|
||||||
|
|
||||||
|
|
|
@ -11,12 +11,12 @@ weight=1
|
||||||
|
|
||||||
# cp
|
# cp
|
||||||
|
|
||||||
Copy files/folders between a container and the local filesystem.
|
Usage: docker cp [OPTIONS] CONTAINER:PATH LOCALPATH|-
|
||||||
|
docker cp [OPTIONS] LOCALPATH|- CONTAINER:PATH
|
||||||
|
|
||||||
Usage: docker cp [options] CONTAINER:PATH LOCALPATH|-
|
Copy files/folders between a container and the local filesystem
|
||||||
docker cp [options] LOCALPATH|- CONTAINER:PATH
|
|
||||||
|
|
||||||
--help Print usage statement
|
--help=false Print usage
|
||||||
|
|
||||||
In the first synopsis form, the `docker cp` utility copies the contents of
|
In the first synopsis form, the `docker cp` utility copies the contents of
|
||||||
`PATH` from the filesystem of `CONTAINER` to the `LOCALPATH` (or stream as
|
`PATH` from the filesystem of `CONTAINER` to the `LOCALPATH` (or stream as
|
||||||
|
|
|
@ -30,6 +30,7 @@ Creates a new container.
|
||||||
--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)
|
||||||
--device=[] Add a host device to the container
|
--device=[] Add a host device to the container
|
||||||
|
--disable-content-trust=true Skip image verification
|
||||||
--dns=[] Set custom DNS servers
|
--dns=[] Set custom DNS servers
|
||||||
--dns-opt=[] Set custom DNS options
|
--dns-opt=[] Set custom DNS options
|
||||||
--dns-search=[] Set custom DNS search domains
|
--dns-search=[] Set custom DNS search domains
|
||||||
|
@ -37,6 +38,7 @@ Creates a new container.
|
||||||
--entrypoint="" Overwrite the default ENTRYPOINT of the image
|
--entrypoint="" Overwrite the default ENTRYPOINT of the image
|
||||||
--env-file=[] Read in a file of environment variables
|
--env-file=[] Read in a file of environment variables
|
||||||
--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
|
||||||
-h, --hostname="" Container host name
|
-h, --hostname="" Container host name
|
||||||
--help=false Print usage
|
--help=false Print usage
|
||||||
-i, --interactive=false Keep STDIN open even if not attached
|
-i, --interactive=false Keep STDIN open even if not attached
|
||||||
|
@ -54,7 +56,7 @@ Creates a new container.
|
||||||
--memory-swap="" Total memory (memory + swap), '-1' to disable swap
|
--memory-swap="" Total memory (memory + swap), '-1' to disable swap
|
||||||
--memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
|
--memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
|
||||||
--name="" Assign a name to the container
|
--name="" Assign a name to the container
|
||||||
--net="bridge" Set the Network mode for the container
|
--net="default" Set the Network mode for the container
|
||||||
--oom-kill-disable=false Whether to disable OOM Killer for the container or not
|
--oom-kill-disable=false Whether to disable OOM Killer for the container or not
|
||||||
-P, --publish-all=false Publish all exposed ports to random ports
|
-P, --publish-all=false 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
|
||||||
|
@ -65,7 +67,6 @@ Creates a new container.
|
||||||
--security-opt=[] Security options
|
--security-opt=[] Security options
|
||||||
--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=false Allocate a pseudo-TTY
|
||||||
--disable-content-trust=true Skip image verification
|
|
||||||
-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
|
||||||
|
|
|
@ -11,10 +11,12 @@ weight=1
|
||||||
|
|
||||||
# diff
|
# diff
|
||||||
|
|
||||||
Usage: docker diff CONTAINER
|
Usage: docker diff [OPTIONS] CONTAINER
|
||||||
|
|
||||||
Inspect changes on a container's filesystem
|
Inspect changes on a container's filesystem
|
||||||
|
|
||||||
|
--help=false 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`:
|
||||||
|
|
||||||
|
|
|
@ -16,6 +16,7 @@ weight=1
|
||||||
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
|
||||||
--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
|
||||||
|
|
||||||
|
|
|
@ -16,6 +16,7 @@ weight=1
|
||||||
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=false Detached mode: run command in the background
|
||||||
|
--help=false Print usage
|
||||||
-i, --interactive=false Keep STDIN open even if not attached
|
-i, --interactive=false Keep STDIN open even if not attached
|
||||||
--privileged=false Give extended Linux capabilities to the command
|
--privileged=false Give extended Linux capabilities to the command
|
||||||
-t, --tty=false Allocate a pseudo-TTY
|
-t, --tty=false Allocate a pseudo-TTY
|
||||||
|
|
|
@ -12,22 +12,12 @@ weight=1
|
||||||
# export
|
# export
|
||||||
|
|
||||||
Usage: docker export [OPTIONS] CONTAINER
|
Usage: docker export [OPTIONS] CONTAINER
|
||||||
|
|
||||||
Export the contents of a filesystem to a tar archive (streamed to STDOUT by default).
|
|
||||||
|
|
||||||
|
Export the contents of a container's filesystem as a tar archive
|
||||||
|
|
||||||
|
--help=false 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.
|
|
||||||
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
$ docker export red_panda > latest.tar
|
|
||||||
|
|
||||||
Or
|
|
||||||
|
|
||||||
$ docker export --output="latest.tar" red_panda
|
|
||||||
|
|
||||||
The `docker export` command does not export the contents of volumes associated
|
The `docker export` command does not export the contents of volumes associated
|
||||||
with the container. If a volume is mounted on top of an existing directory in
|
with the container. If a volume is mounted on top of an existing directory in
|
||||||
the container, `docker export` will export the contents of the *underlying*
|
the container, `docker export` will export the contents of the *underlying*
|
||||||
|
@ -36,3 +26,11 @@ directory, not the contents of the volume.
|
||||||
Refer to [Backup, restore, or migrate data
|
Refer to [Backup, restore, or migrate data
|
||||||
volumes](/userguide/dockervolumes/#backup-restore-or-migrate-data-volumes) in
|
volumes](/userguide/dockervolumes/#backup-restore-or-migrate-data-volumes) in
|
||||||
the user guide for examples on exporting data in a volume.
|
the user guide for examples on exporting data in a volume.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
$ docker export red_panda > latest.tar
|
||||||
|
|
||||||
|
Or
|
||||||
|
|
||||||
|
$ docker export --output="latest.tar" red_panda
|
||||||
|
|
|
@ -16,6 +16,7 @@ weight=1
|
||||||
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
|
||||||
--no-trunc=false Don't truncate output
|
--no-trunc=false Don't truncate output
|
||||||
-q, --quiet=false Only show numeric IDs
|
-q, --quiet=false Only show numeric IDs
|
||||||
|
|
||||||
|
|
|
@ -18,6 +18,7 @@ weight=1
|
||||||
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
|
||||||
-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
|
||||||
|
|
|
@ -12,10 +12,12 @@ weight=1
|
||||||
# info
|
# info
|
||||||
|
|
||||||
|
|
||||||
Usage: docker info
|
Usage: docker info [OPTIONS]
|
||||||
|
|
||||||
Display system-wide information
|
Display system-wide information
|
||||||
|
|
||||||
|
--help=false Print usage
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
$ docker -D info
|
$ docker -D info
|
||||||
|
|
|
@ -15,10 +15,10 @@ weight=1
|
||||||
|
|
||||||
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
|
||||||
--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"
|
||||||
|
|
||||||
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.
|
||||||
|
|
|
@ -15,6 +15,7 @@ weight=1
|
||||||
|
|
||||||
Kill a running container using SIGKILL or a specified signal
|
Kill a running container using SIGKILL or a specified signal
|
||||||
|
|
||||||
|
--help=false 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
|
||||||
|
|
|
@ -15,6 +15,7 @@ weight=1
|
||||||
|
|
||||||
Load an image from a tar archive or STDIN
|
Load an image from a tar archive or STDIN
|
||||||
|
|
||||||
|
--help=false 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.
|
||||||
|
|
|
@ -17,6 +17,7 @@ weight=1
|
||||||
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
|
||||||
-p, --password="" Password
|
-p, --password="" Password
|
||||||
-u, --username="" Username
|
-u, --username="" Username
|
||||||
|
|
||||||
|
|
|
@ -16,6 +16,8 @@ weight=1
|
||||||
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
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
$ docker logout localhost:8080
|
$ docker logout localhost:8080
|
||||||
|
|
|
@ -16,6 +16,7 @@ weight=1
|
||||||
Fetch the logs of a container
|
Fetch the logs of a container
|
||||||
|
|
||||||
-f, --follow=false Follow log output
|
-f, --follow=false Follow log output
|
||||||
|
--help=false Print usage
|
||||||
--since="" Show logs since timestamp
|
--since="" Show logs since timestamp
|
||||||
-t, --timestamps=false Show timestamps
|
-t, --timestamps=false 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
|
||||||
|
|
|
@ -11,10 +11,12 @@ weight=1
|
||||||
|
|
||||||
# pause
|
# pause
|
||||||
|
|
||||||
Usage: docker pause CONTAINER [CONTAINER...]
|
Usage: docker pause [OPTIONS] CONTAINER [CONTAINER...]
|
||||||
|
|
||||||
Pause all processes within a container
|
Pause all processes within a container
|
||||||
|
|
||||||
|
--help=false 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
|
||||||
used, which is observable by the process being suspended. With the cgroups freezer
|
used, which is observable by the process being suspended. With the cgroups freezer
|
||||||
|
|
|
@ -11,11 +11,13 @@ weight=1
|
||||||
|
|
||||||
# port
|
# port
|
||||||
|
|
||||||
Usage: docker port CONTAINER [PRIVATE_PORT[/PROTO]]
|
Usage: docker port [OPTIONS] CONTAINER [PRIVATE_PORT[/PROTO]]
|
||||||
|
|
||||||
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
|
||||||
|
|
||||||
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:
|
||||||
|
|
||||||
|
|
|
@ -18,13 +18,14 @@ weight=1
|
||||||
-a, --all=false Show all containers (default shows just running)
|
-a, --all=false Show all containers (default shows just running)
|
||||||
--before="" Show only container created before Id or Name
|
--before="" Show only container created before Id or Name
|
||||||
-f, --filter=[] Filter output based on conditions provided
|
-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, include non-running
|
-l, --latest=false Show the latest created container, include non-running
|
||||||
-n=-1 Show n last created containers, include non-running
|
-n=-1 Show n last created containers, include non-running
|
||||||
--no-trunc=false Don't truncate output
|
--no-trunc=false Don't truncate output
|
||||||
-q, --quiet=false Only display numeric IDs
|
-q, --quiet=false Only display numeric IDs
|
||||||
-s, --size=false Display total file sizes
|
-s, --size=false Display total file sizes
|
||||||
--since="" Show created since Id or Name, include non-running
|
--since="" Show created since Id or Name, include non-running
|
||||||
--format=[] Pretty-print containers using a Go template
|
|
||||||
|
|
||||||
Running `docker ps --no-trunc` showing 2 linked containers.
|
Running `docker ps --no-trunc` showing 2 linked containers.
|
||||||
|
|
||||||
|
|
|
@ -17,6 +17,7 @@ weight=1
|
||||||
|
|
||||||
-a, --all-tags=false Download all tagged images in the repository
|
-a, --all-tags=false 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
|
||||||
|
|
||||||
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.
|
||||||
|
|
|
@ -11,11 +11,12 @@ weight=1
|
||||||
|
|
||||||
# push
|
# push
|
||||||
|
|
||||||
Usage: docker push NAME[:TAG]
|
Usage: docker push [OPTIONS] NAME[:TAG]
|
||||||
|
|
||||||
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
|
||||||
|
|
||||||
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.
|
||||||
|
|
|
@ -11,8 +11,10 @@ weight=1
|
||||||
|
|
||||||
# rename
|
# rename
|
||||||
|
|
||||||
Usage: docker rename OLD_NAME NEW_NAME
|
Usage: docker rename [OPTIONS] OLD_NAME NEW_NAME
|
||||||
|
|
||||||
rename a existing container to a NEW_NAME
|
Rename a container
|
||||||
|
|
||||||
|
--help=false 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.
|
||||||
|
|
|
@ -15,5 +15,6 @@ weight=1
|
||||||
|
|
||||||
Restart a container
|
Restart a container
|
||||||
|
|
||||||
|
--help=false 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
|
||||||
|
|
||||||
|
|
|
@ -16,6 +16,7 @@ weight=1
|
||||||
Remove one or more containers
|
Remove one or more containers
|
||||||
|
|
||||||
-f, --force=false Force the removal of a running container (uses SIGKILL)
|
-f, --force=false Force the removal of a running container (uses SIGKILL)
|
||||||
|
--help=false Print usage
|
||||||
-l, --link=false Remove the specified link
|
-l, --link=false Remove the specified link
|
||||||
-v, --volumes=false Remove the volumes associated with the container
|
-v, --volumes=false Remove the volumes associated with the container
|
||||||
|
|
||||||
|
|
|
@ -16,9 +16,9 @@ weight=1
|
||||||
Remove one or more images
|
Remove one or more images
|
||||||
|
|
||||||
-f, --force=false Force removal of the image
|
-f, --force=false Force removal of the image
|
||||||
|
--help=false Print usage
|
||||||
--no-prune=false Do not delete untagged parents
|
--no-prune=false 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
|
||||||
before the image is removed.
|
before the image is removed.
|
||||||
|
|
|
@ -29,6 +29,7 @@ weight=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=false Run container in background and print container ID
|
||||||
--device=[] Add a host device to the container
|
--device=[] Add a host device to the container
|
||||||
|
--disable-content-trust=true Skip image verification
|
||||||
--dns=[] Set custom DNS servers
|
--dns=[] Set custom DNS servers
|
||||||
--dns-opt=[] Set custom DNS options
|
--dns-opt=[] Set custom DNS options
|
||||||
--dns-search=[] Set custom DNS search domains
|
--dns-search=[] Set custom DNS search domains
|
||||||
|
@ -54,7 +55,7 @@ weight=1
|
||||||
--memory-swap="" Total memory (memory + swap), '-1' to disable swap
|
--memory-swap="" Total memory (memory + swap), '-1' to disable swap
|
||||||
--memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
|
--memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
|
||||||
--name="" Assign a name to the container
|
--name="" Assign a name to the container
|
||||||
--net="bridge" Set the Network mode for the container
|
--net="default" Set the Network mode for the container
|
||||||
--oom-kill-disable=false Whether to disable OOM Killer for the container or not
|
--oom-kill-disable=false Whether to disable OOM Killer for the container or not
|
||||||
-P, --publish-all=false Publish all exposed ports to random ports
|
-P, --publish-all=false 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
|
||||||
|
@ -64,12 +65,11 @@ weight=1
|
||||||
--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=false Automatically remove the container when it exits
|
||||||
--security-opt=[] Security Options
|
--security-opt=[] Security Options
|
||||||
--stop-signal="SIGTERM" Signal to stop a container
|
|
||||||
--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
|
||||||
-t, --tty=false Allocate a pseudo-TTY
|
-t, --tty=false 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
|
||||||
--disable-content-trust=true Skip image verification
|
|
||||||
--uts="" UTS namespace to use
|
--uts="" UTS namespace to use
|
||||||
-v, --volume=[] Bind mount a volume
|
-v, --volume=[] Bind mount a volume
|
||||||
--volumes-from=[] Mount volumes from the specified container(s)
|
--volumes-from=[] Mount volumes from the specified container(s)
|
||||||
|
|
|
@ -15,6 +15,7 @@ weight=1
|
||||||
|
|
||||||
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
|
||||||
-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.
|
||||||
|
|
|
@ -16,6 +16,7 @@ weight=1
|
||||||
Search the Docker Hub for images
|
Search the Docker Hub for images
|
||||||
|
|
||||||
--automated=false Only show automated builds
|
--automated=false Only show automated builds
|
||||||
|
--help=false Print usage
|
||||||
--no-trunc=false Don't truncate output
|
--no-trunc=false Don't truncate output
|
||||||
-s, --stars=0 Only displays with at least x stars
|
-s, --stars=0 Only displays with at least x stars
|
||||||
|
|
||||||
|
|
|
@ -13,8 +13,9 @@ weight=1
|
||||||
|
|
||||||
Usage: docker start [OPTIONS] CONTAINER [CONTAINER...]
|
Usage: docker start [OPTIONS] CONTAINER [CONTAINER...]
|
||||||
|
|
||||||
Start one or more stopped containers
|
Start one or more containers
|
||||||
|
|
||||||
-a, --attach=false Attach STDOUT/STDERR and forward signals
|
-a, --attach=false Attach STDOUT/STDERR and forward signals
|
||||||
|
--help=false Print usage
|
||||||
-i, --interactive=false Attach container's STDIN
|
-i, --interactive=false Attach container's STDIN
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ weight=1
|
||||||
|
|
||||||
# stats
|
# stats
|
||||||
|
|
||||||
Usage: docker stats CONTAINER [CONTAINER...]
|
Usage: docker stats [OPTIONS] CONTAINER [CONTAINER...]
|
||||||
|
|
||||||
Display a live stream of one or more containers' resource usage statistics
|
Display a live stream of one or more containers' resource usage statistics
|
||||||
|
|
||||||
|
|
|
@ -13,10 +13,11 @@ weight=1
|
||||||
|
|
||||||
Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
|
Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
|
||||||
|
|
||||||
Stop a running 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
|
||||||
-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
|
||||||
period, `SIGKILL`.
|
period, `SIGKILL`.
|
||||||
|
|
|
@ -16,6 +16,7 @@ weight=1
|
||||||
Tag an image into a repository
|
Tag an image into a repository
|
||||||
|
|
||||||
-f, --force=false Force
|
-f, --force=false Force
|
||||||
|
--help=false 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/#contributing-to-docker-hub).
|
to [*Share Images via Repositories*](/userguide/dockerrepos/#contributing-to-docker-hub).
|
||||||
|
|
|
@ -11,6 +11,8 @@ weight=1
|
||||||
|
|
||||||
# top
|
# top
|
||||||
|
|
||||||
Usage: docker top CONTAINER [ps OPTIONS]
|
Usage: docker top [OPTIONS] CONTAINER [ps OPTIONS]
|
||||||
|
|
||||||
Display the running processes of a container
|
Display the running processes of a container
|
||||||
|
|
||||||
|
--help=false Print usage
|
||||||
|
|
|
@ -11,10 +11,12 @@ weight=1
|
||||||
|
|
||||||
# unpause
|
# unpause
|
||||||
|
|
||||||
Usage: docker unpause CONTAINER [CONTAINER...]
|
Usage: docker unpause [OPTIONS] CONTAINER [CONTAINER...]
|
||||||
|
|
||||||
Unpause all processes within a container
|
Unpause all processes within a container
|
||||||
|
|
||||||
|
--help=false 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.
|
||||||
|
|
||||||
|
|
|
@ -16,6 +16,7 @@ weight=1
|
||||||
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
|
||||||
|
|
||||||
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.
|
||||||
|
|
|
@ -14,10 +14,10 @@ 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=false Print usage
|
||||||
--name= Specify volume name
|
--name= Specify volume name
|
||||||
-o, --opt=map[] Set driver specific options
|
-o, --opt=map[] Set driver specific options
|
||||||
|
|
||||||
Creates a new volume that containers can consume and store data in. If a name is not specified, Docker generates a random name. You create a volume and then configure the container to use it, for example:
|
Creates a new volume that containers can consume and store data in. If a name is not specified, Docker generates a random name. You create a volume and then configure the container to use it, for example:
|
||||||
|
|
||||||
|
@ -25,7 +25,7 @@ Creates a new volume that containers can consume and store data in. If a name is
|
||||||
hello
|
hello
|
||||||
$ docker run -d -v hello:/world busybox ls /world
|
$ docker run -d -v hello:/world busybox ls /world
|
||||||
|
|
||||||
The mount is created inside the container's `/src` directory. Docker does not support relative paths for mount points inside the container.
|
The mount is created inside the container's `/src` directory. Docker does not support relative paths for mount points inside the container.
|
||||||
|
|
||||||
Multiple containers can use the same volume in the same time period. This is useful if two containers need access to shared data. For example, if one container writes and the other reads the data.
|
Multiple containers can use the same volume in the same time period. This is useful if two containers need access to shared data. For example, if one container writes and the other reads the data.
|
||||||
|
|
||||||
|
|
|
@ -14,8 +14,8 @@ 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=false 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 given template
|
in a JSON array. You can specify an alternate format to execute a given template
|
||||||
|
|
|
@ -14,9 +14,9 @@ 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=false Print usage
|
||||||
-q, --quiet=false Only display volume names
|
-q, --quiet=false 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=false 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.
|
||||||
|
|
||||||
|
|
|
@ -11,6 +11,8 @@ weight=1
|
||||||
|
|
||||||
# wait
|
# wait
|
||||||
|
|
||||||
Usage: docker wait CONTAINER [CONTAINER...]
|
Usage: docker wait [OPTIONS] CONTAINER [CONTAINER...]
|
||||||
|
|
||||||
Block until a container stops, then print its exit code.
|
Block until a container stops, then print its exit code.
|
||||||
|
|
||||||
|
--help=false Print usage
|
||||||
|
|
|
@ -6,9 +6,11 @@ docker-build - Build a new image from the source code at PATH
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker build**
|
**docker build**
|
||||||
|
[**--build-arg**[=*[]*]]
|
||||||
|
[**-c**|**--cpu-shares**[=*0*]]
|
||||||
|
[**--cgroup-parent**[=*CGROUP-PARENT*]]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
[**-f**|**--file**[=*PATH/Dockerfile*]]
|
[**-f**|**--file**[=*PATH/Dockerfile*]]
|
||||||
[**--build-arg**[=*[]*]]
|
|
||||||
[**--force-rm**[=*false*]]
|
[**--force-rm**[=*false*]]
|
||||||
[**--no-cache**[=*false*]]
|
[**--no-cache**[=*false*]]
|
||||||
[**--pull**[=*false*]]
|
[**--pull**[=*false*]]
|
||||||
|
@ -17,14 +19,11 @@ docker-build - Build a new image from the source code at PATH
|
||||||
[**-t**|**--tag**[=*TAG*]]
|
[**-t**|**--tag**[=*TAG*]]
|
||||||
[**-m**|**--memory**[=*MEMORY*]]
|
[**-m**|**--memory**[=*MEMORY*]]
|
||||||
[**--memory-swap**[=*MEMORY-SWAP*]]
|
[**--memory-swap**[=*MEMORY-SWAP*]]
|
||||||
[**-c**|**--cpu-shares**[=*0*]]
|
|
||||||
[**--cpu-period**[=*0*]]
|
[**--cpu-period**[=*0*]]
|
||||||
[**--cpu-quota**[=*0*]]
|
[**--cpu-quota**[=*0*]]
|
||||||
[**--cpuset-cpus**[=*CPUSET-CPUS*]]
|
[**--cpuset-cpus**[=*CPUSET-CPUS*]]
|
||||||
[**--cpuset-mems**[=*CPUSET-MEMS*]]
|
[**--cpuset-mems**[=*CPUSET-MEMS*]]
|
||||||
[**--cgroup-parent**[=*CGROUP-PARENT*]]
|
|
||||||
[**--ulimit**[=*[]*]]
|
[**--ulimit**[=*[]*]]
|
||||||
|
|
||||||
PATH | URL | -
|
PATH | URL | -
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
@ -34,9 +33,9 @@ directory to the Docker daemon. The contents of this directory would
|
||||||
be used by **ADD** commands found within the Dockerfile.
|
be used by **ADD** commands found within the Dockerfile.
|
||||||
|
|
||||||
Warning, this will send a lot of data to the Docker daemon depending
|
Warning, this will send a lot of data to the Docker daemon depending
|
||||||
on the contents of the current directory. The build is run by the Docker
|
on the contents of the current directory. The build is run by the Docker
|
||||||
daemon, not by the CLI, so the whole context must be transferred to the daemon.
|
daemon, not by the CLI, so the whole context must be transferred to the daemon.
|
||||||
The Docker CLI reports "Sending build context to Docker daemon" when the context is sent to
|
The Docker CLI reports "Sending build context to Docker daemon" when the context is sent to
|
||||||
the daemon.
|
the daemon.
|
||||||
|
|
||||||
When the URL to a tarball archive or to a single Dockerfile is given, no context is sent from
|
When the URL to a tarball archive or to a single Dockerfile is given, no context is sent from
|
||||||
|
|
|
@ -7,8 +7,8 @@ docker-commit - Create a new image from a container's changes
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker commit**
|
**docker commit**
|
||||||
[**-a**|**--author**[=*AUTHOR*]]
|
[**-a**|**--author**[=*AUTHOR*]]
|
||||||
[**--help**]
|
|
||||||
[**-c**|**--change**[=\[*DOCKERFILE INSTRUCTIONS*\]]]
|
[**-c**|**--change**[=\[*DOCKERFILE INSTRUCTIONS*\]]]
|
||||||
|
[**--help**]
|
||||||
[**-m**|**--message**[=*MESSAGE*]]
|
[**-m**|**--message**[=*MESSAGE*]]
|
||||||
[**-p**|**--pause**[=*true*]]
|
[**-p**|**--pause**[=*true*]]
|
||||||
CONTAINER [REPOSITORY[:TAG]]
|
CONTAINER [REPOSITORY[:TAG]]
|
||||||
|
|
|
@ -1,9 +1,6 @@
|
||||||
% DOCKER(1) Docker User Manuals
|
% DOCKER(1) Docker User Manuals
|
||||||
|
% Shishir Mahajan
|
||||||
% Shishir Mahajan
|
|
||||||
|
|
||||||
% SEPTEMBER 2015
|
% SEPTEMBER 2015
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
docker-daemon - Enable daemon mode
|
docker-daemon - Enable daemon mode
|
||||||
|
|
||||||
|
|
|
@ -8,16 +8,15 @@ docker-ps - List containers
|
||||||
**docker ps**
|
**docker ps**
|
||||||
[**-a**|**--all**[=*false*]]
|
[**-a**|**--all**[=*false*]]
|
||||||
[**--before**[=*BEFORE*]]
|
[**--before**[=*BEFORE*]]
|
||||||
[**--help**]
|
|
||||||
[**-f**|**--filter**[=*[]*]]
|
[**-f**|**--filter**[=*[]*]]
|
||||||
|
[**--format**=*"TEMPLATE"*]
|
||||||
|
[**--help**]
|
||||||
[**-l**|**--latest**[=*false*]]
|
[**-l**|**--latest**[=*false*]]
|
||||||
[**-n**[=*-1*]]
|
[**-n**[=*-1*]]
|
||||||
[**--no-trunc**[=*false*]]
|
[**--no-trunc**[=*false*]]
|
||||||
[**-q**|**--quiet**[=*false*]]
|
[**-q**|**--quiet**[=*false*]]
|
||||||
[**-s**|**--size**[=*false*]]
|
[**-s**|**--size**[=*false*]]
|
||||||
[**--since**[=*SINCE*]]
|
[**--since**[=*SINCE*]]
|
||||||
[**--format**=*"TEMPLATE"*]
|
|
||||||
|
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
||||||
|
@ -31,9 +30,6 @@ the running containers.
|
||||||
**--before**=""
|
**--before**=""
|
||||||
Show only containers created before Id or Name, including non-running containers.
|
Show only containers created before Id or Name, including non-running containers.
|
||||||
|
|
||||||
**--help**
|
|
||||||
Print usage statement
|
|
||||||
|
|
||||||
**-f**, **--filter**=[]
|
**-f**, **--filter**=[]
|
||||||
Provide filter values. Valid filters:
|
Provide filter values. Valid filters:
|
||||||
exited=<int> - containers with exit code of <int>
|
exited=<int> - containers with exit code of <int>
|
||||||
|
@ -44,6 +40,23 @@ the running containers.
|
||||||
ancestor=(<image-name>[:tag]|<image-id>|<image@digest>) - filters containers that were
|
ancestor=(<image-name>[:tag]|<image-id>|<image@digest>) - filters containers that were
|
||||||
created from the given image or a descendant.
|
created from the given image or a descendant.
|
||||||
|
|
||||||
|
**--format**=*"TEMPLATE"*
|
||||||
|
Pretty-print containers using a Go template.
|
||||||
|
Valid placeholders:
|
||||||
|
.ID - Container ID
|
||||||
|
.Image - Image ID
|
||||||
|
.Command - Quoted command
|
||||||
|
.CreatedAt - Time when the container was created.
|
||||||
|
.RunningFor - Elapsed time since the container was started.
|
||||||
|
.Ports - Exposed ports.
|
||||||
|
.Status - Container status.
|
||||||
|
.Size - Container disk size.
|
||||||
|
.Labels - All labels asigned to the container.
|
||||||
|
.Label - Value of a specific label for this container. For example `{{.Label "com.docker.swarm.cpu"}}`
|
||||||
|
|
||||||
|
**--help**
|
||||||
|
Print usage statement
|
||||||
|
|
||||||
**-l**, **--latest**=*true*|*false*
|
**-l**, **--latest**=*true*|*false*
|
||||||
Show only the latest created container, include non-running ones. The default is *false*.
|
Show only the latest created container, include non-running ones. The default is *false*.
|
||||||
|
|
||||||
|
@ -62,20 +75,6 @@ the running containers.
|
||||||
**--since**=""
|
**--since**=""
|
||||||
Show only containers created since Id or Name, include non-running ones.
|
Show only containers created since Id or Name, include non-running ones.
|
||||||
|
|
||||||
**--format**=*"TEMPLATE"*
|
|
||||||
Pretty-print containers using a Go template.
|
|
||||||
Valid placeholders:
|
|
||||||
.ID - Container ID
|
|
||||||
.Image - Image ID
|
|
||||||
.Command - Quoted command
|
|
||||||
.CreatedAt - Time when the container was created.
|
|
||||||
.RunningFor - Elapsed time since the container was started.
|
|
||||||
.Ports - Exposed ports.
|
|
||||||
.Status - Container status.
|
|
||||||
.Size - Container disk size.
|
|
||||||
.Labels - All labels asigned to the container.
|
|
||||||
.Label - Value of a specific label for this container. For example `{{.Label "com.docker.swarm.cpu"}}`
|
|
||||||
|
|
||||||
# EXAMPLES
|
# EXAMPLES
|
||||||
# Display all containers, including non-running
|
# Display all containers, including non-running
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
% Docker Community
|
% Docker Community
|
||||||
% JUNE 2014
|
% JUNE 2014
|
||||||
# NAME
|
# NAME
|
||||||
docker-start - Start one or more stopped containers
|
docker-start - Start one or more containers
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker start**
|
**docker start**
|
||||||
|
@ -13,7 +13,7 @@ CONTAINER [CONTAINER...]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
||||||
Start one or more stopped containers.
|
Start one or more containers.
|
||||||
|
|
||||||
# OPTIONS
|
# OPTIONS
|
||||||
**-a**, **--attach**=*true*|*false*
|
**-a**, **--attach**=*true*|*false*
|
||||||
|
@ -26,7 +26,7 @@ Start one or more stopped containers.
|
||||||
Attach container's STDIN. The default is *false*.
|
Attach container's STDIN. The default is *false*.
|
||||||
|
|
||||||
# See also
|
# See also
|
||||||
**docker-stop(1)** to stop a running container.
|
**docker-stop(1)** to stop a container.
|
||||||
|
|
||||||
# HISTORY
|
# HISTORY
|
||||||
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
% Docker Community
|
% Docker Community
|
||||||
% JUNE 2014
|
% JUNE 2014
|
||||||
# NAME
|
# NAME
|
||||||
docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after a grace period
|
docker-stop - Stop a container by sending SIGTERM and then SIGKILL after a grace period
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker stop**
|
**docker stop**
|
||||||
|
@ -11,7 +11,7 @@ docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after
|
||||||
CONTAINER [CONTAINER...]
|
CONTAINER [CONTAINER...]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
Stop a running container (Send SIGTERM, and then SIGKILL after
|
Stop a container (Send SIGTERM, and then SIGKILL after
|
||||||
grace period)
|
grace period)
|
||||||
|
|
||||||
# OPTIONS
|
# OPTIONS
|
||||||
|
|
|
@ -190,7 +190,7 @@ inside it)
|
||||||
See **docker-search(1)** for full documentation on the **search** command.
|
See **docker-search(1)** for full documentation on the **search** command.
|
||||||
|
|
||||||
**start**
|
**start**
|
||||||
Start a stopped container
|
Start a container
|
||||||
See **docker-start(1)** for full documentation on the **start** command.
|
See **docker-start(1)** for full documentation on the **start** command.
|
||||||
|
|
||||||
**stats**
|
**stats**
|
||||||
|
@ -198,7 +198,7 @@ inside it)
|
||||||
See **docker-stats(1)** for full documentation on the **stats** command.
|
See **docker-stats(1)** for full documentation on the **stats** command.
|
||||||
|
|
||||||
**stop**
|
**stop**
|
||||||
Stop a running container
|
Stop a container
|
||||||
See **docker-stop(1)** for full documentation on the **stop** command.
|
See **docker-stop(1)** for full documentation on the **stop** command.
|
||||||
|
|
||||||
**tag**
|
**tag**
|
||||||
|
|
Loading…
Reference in New Issue