diff --git a/components/engine/cli/command/system/inspect.go b/components/engine/cli/command/system/inspect.go index d7a24854e7..8732c467eb 100644 --- a/components/engine/cli/command/system/inspect.go +++ b/components/engine/cli/command/system/inspect.go @@ -25,9 +25,12 @@ func NewInspectCommand(dockerCli *command.DockerCli) *cobra.Command { var opts inspectOptions cmd := &cobra.Command{ - Use: "inspect [OPTIONS] CONTAINER|IMAGE|TASK [CONTAINER|IMAGE|TASK...]", - Short: "Return low-level information on a container, image or task", - Args: cli.RequiresMinArgs(1), + Use: "inspect [OPTIONS] NAME|ID [NAME|ID...]", + Short: strings.Join([]string{ + "Return low-level information on Docker object(s) (e.g. container, image, volume,", + "\nnetwork, node, service, or task) identified by name or ID", + }, ""), + Args: cli.RequiresMinArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.ids = args return runInspect(dockerCli, opts) diff --git a/components/engine/docs/reference/commandline/inspect.md b/components/engine/docs/reference/commandline/inspect.md index f169f42b45..bb79dede16 100644 --- a/components/engine/docs/reference/commandline/inspect.md +++ b/components/engine/docs/reference/commandline/inspect.md @@ -18,14 +18,13 @@ keywords: ["inspect, container, json"] ```markdown Usage: docker inspect [OPTIONS] NAME|ID [NAME|ID...] -Return low-level information on one or multiple containers, images, volumes, -networks, nodes, services, or tasks identified by name or ID. +Return low-level information on Docker object(s) (e.g. container, image, volume, +network, node, service, or task) identified by name or ID Options: -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 ``` diff --git a/components/engine/man/docker-inspect.1.md b/components/engine/man/docker-inspect.1.md index 3dbf600fde..21d7ba678a 100644 --- a/components/engine/man/docker-inspect.1.md +++ b/components/engine/man/docker-inspect.1.md @@ -14,8 +14,8 @@ NAME|ID [NAME|ID...] # DESCRIPTION -This displays all the information available in Docker for one or multiple given -containers, images, volumes, networks, nodes, services, or tasks. By default, +This displays the low-level information on Docker object(s) (e.g. container, +image, volume,network, node, service, or task) identified by name or ID. 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. @@ -25,14 +25,14 @@ is specified, the given template will be executed for each result. Print usage statement **-f**, **--format**="" - Format the output using the given Go template. + Format the output using the given Go template **-s**, **--size** - Display total file sizes if the type is container. + Display total file sizes if the type is 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". + "network", "node", "service", "task", and "volume" # EXAMPLES