diff --git a/docs/reference/commandline/inspect.md b/docs/reference/commandline/inspect.md index 7ccc7f7392..6232ec12b6 100644 --- a/docs/reference/commandline/inspect.md +++ b/docs/reference/commandline/inspect.md @@ -11,15 +11,16 @@ parent = "smn_cli" # inspect ```markdown -Usage: docker inspect [OPTIONS] CONTAINER|IMAGE|TASK [CONTAINER|IMAGE|TASK...] +Usage: docker inspect [OPTIONS] NAME|ID [NAME|ID...] -Return low-level information on a container, image or task +Return low-level information on one or multiple containers, images, volumes, +networks, nodes, services, or tasks identified by name or ID. -f, --format Format the output using the given go template --help Print usage -s, --size Display total file sizes if the type is container values are "image" or "container" or "task - --type Return JSON for specified type, (e.g image, container or task) + --type Return JSON for specified type ``` By default, this will render all results in a JSON array. If the container and diff --git a/man/docker-inspect.1.md b/man/docker-inspect.1.md index 6d7a54ad3b..3dbf600fde 100644 --- a/man/docker-inspect.1.md +++ b/man/docker-inspect.1.md @@ -2,23 +2,23 @@ % Docker Community % JUNE 2014 # NAME -docker-inspect - Return low-level information on a container or image +docker-inspect - Return low-level information on docker objects # SYNOPSIS **docker inspect** [**--help**] [**-f**|**--format**[=*FORMAT*]] [**-s**|**--size**] -[**--type**=*container*|*image*] -CONTAINER|IMAGE [CONTAINER|IMAGE...] +[**--type**=*container*|*image*|*network*|*node*|*service*|*task*|*volume*] +NAME|ID [NAME|ID...] # DESCRIPTION -This displays all the information available in Docker for a given -container or image. By default, this will render all results in a JSON -array. If the container and image have the same name, this will return -container JSON for unspecified type. If a format is specified, the given -template will be executed for each result. +This displays all the information available in Docker for one or multiple given +containers, images, volumes, networks, nodes, services, or tasks. By default, +this will render all results in a JSON array. If the container and image have +the same name, this will return container JSON for unspecified type. If a format +is specified, the given template will be executed for each result. # OPTIONS **--help** @@ -30,8 +30,9 @@ template will be executed for each result. **-s**, **--size** Display total file sizes if the type is container. -**--type**="*container*|*image*" - Return JSON for specified type, permissible values are "image" or "container" +**--type**=*container*|*image*|*network*|*node*|*service*|*task*|*volume* + Return JSON for specified type, permissible values are "image", "container", + "network", "node", "service", "task", and "volume". # EXAMPLES