From 49a282eb1cba29b452512fd1228ea75fd396e48a Mon Sep 17 00:00:00 2001 From: yuexiao-wang Date: Sun, 18 Sep 2016 13:11:02 +0800 Subject: [PATCH] Modify short and flags for docker inspect Signed-off-by: yuexiao-wang --- docs/reference/commandline/inspect.md | 5 ++--- man/docker-inspect.1.md | 10 +++++----- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/reference/commandline/inspect.md b/docs/reference/commandline/inspect.md index f169f42b45..bb79dede16 100644 --- a/docs/reference/commandline/inspect.md +++ b/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/man/docker-inspect.1.md b/man/docker-inspect.1.md index 3dbf600fde..21d7ba678a 100644 --- a/man/docker-inspect.1.md +++ b/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