summaryrefslogtreecommitdiff
path: root/docs/reference/commandline/volume_inspect.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/commandline/volume_inspect.md')
-rw-r--r--docs/reference/commandline/volume_inspect.md42
1 files changed, 22 insertions, 20 deletions
diff --git a/docs/reference/commandline/volume_inspect.md b/docs/reference/commandline/volume_inspect.md
index 98e0ee5abf..bbdc6bd3ee 100644
--- a/docs/reference/commandline/volume_inspect.md
+++ b/docs/reference/commandline/volume_inspect.md
@@ -25,32 +25,34 @@ Options:
--help Print usage
```
+## Description
+
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 for each result. Go's
[text/template](http://golang.org/pkg/text/template/) package describes all the
details of the format.
-Example output:
-
- $ docker volume create
- 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d
- $ docker volume inspect 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d
- [
- {
- "Name": "85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d",
- "Driver": "local",
- "Mountpoint": "/var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data",
- "Status": null
- }
- ]
-
- {% raw %}
- $ docker volume inspect --format '{{ .Mountpoint }}' 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d
- /var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data
- {% endraw %}
-
-## Related information
+## Examples
+
+```bash
+$ docker volume create
+85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d
+$ docker volume inspect 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d
+[
+ {
+ "Name": "85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d",
+ "Driver": "local",
+ "Mountpoint": "/var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data",
+ "Status": null
+ }
+]
+
+$ docker volume inspect --format '{{ .Mountpoint }}' 85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d
+/var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data
+```
+
+## Related commands
* [volume create](volume_create.md)
* [volume ls](volume_ls.md)