Sfoglia il codice sorgente

Update stats cli reference documentation

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Vincent Demeester 8 anni fa
parent
commit
947464e2f1
2 ha cambiato i file con 9 aggiunte e 4 eliminazioni
  1. 7 4
      docs/reference/commandline/stats.md
  2. 2 0
      man/docker-stats.1.md

+ 7 - 4
docs/reference/commandline/stats.md

@@ -21,9 +21,10 @@ Usage:  docker stats [OPTIONS] [CONTAINER...]
 Display a live stream of container(s) resource usage statistics
 Display a live stream of container(s) resource usage statistics
 
 
 Options:
 Options:
-  -a, --all         Show all containers (default shows just running)
-      --help        Print usage
-      --no-stream   Disable streaming stats and only pull the first result
+  -a, --all             Show all containers (default shows just running)
+      --format string   Pretty-print images using a Go template
+      --help            Print usage
+      --no-stream       Disable streaming stats and only pull the first result
 ```
 ```
 
 
 The `docker stats` command returns a live data stream for running containers. To limit data to one or more specific containers, specify a list of container names or ids separated by a space. You can specify a stopped container but stopped containers do not return any data.
 The `docker stats` command returns a live data stream for running containers. To limit data to one or more specific containers, specify a list of container names or ids separated by a space. You can specify a stopped container but stopped containers do not return any data.
@@ -77,7 +78,9 @@ Valid placeholders for the Go template are listed below:
 
 
 Placeholder  | Description
 Placeholder  | Description
 ------------ | --------------------------------------------
 ------------ | --------------------------------------------
-`.Container` | Container name or ID
+`.Container` | Container name or ID (user input)
+`.Name`      | Container name
+`.ID`        | Container ID
 `.CPUPerc`   | CPU percentage
 `.CPUPerc`   | CPU percentage
 `.MemUsage`  | Memory usage
 `.MemUsage`  | Memory usage
 `.NetIO`     | Network IO
 `.NetIO`     | Network IO

+ 2 - 0
man/docker-stats.1.md

@@ -30,6 +30,8 @@ Display a live stream of one or more containers' resource usage statistics
    Pretty-print containers statistics using a Go template.
    Pretty-print containers statistics using a Go template.
    Valid placeholders:
    Valid placeholders:
       .Container - Container name or ID.
       .Container - Container name or ID.
+      .Name - Container name.
+      .ID - Container ID.
       .CPUPerc - CPU percentage.
       .CPUPerc - CPU percentage.
       .MemUsage - Memory usage.
       .MemUsage - Memory usage.
       .NetIO - Network IO.
       .NetIO - Network IO.