Skip to content

docs: clarify docker system df --format placeholders #7138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
locker95 wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −9
Open

docs: clarify docker system df --format placeholders #7138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions docs/reference/commandline/system_df.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,18 +76,24 @@ in systems where performance is critical.

### <a name="format"></a> Format the output (--format)

The formatting option (`--format`) pretty prints the disk usage output
using a Go template.
The formatting option (`--format`) pretty prints the **summary** disk usage
output using a Go template. Each summary line (Images, Containers, Local
Volumes, and Build Cache) is rendered once with the same template.

Valid placeholders for the Go template are listed below:

| Placeholder | Description |
|----------------|--------------------------------------------|
| `.Type` | `Images`, `Containers` and `Local Volumes` |
| `.TotalCount` | Total number of items |
| `.Active` | Number of active items |
| `.Size` | Available size |
| `.Reclaimable` | Reclaimable size |
| Placeholder | Description |
|----------------|-----------------------------------------------------------------------------|
| `.Type` | Resource kind: `Images`, `Containers`, `Local Volumes`, or `Build Cache` |
| `.TotalCount` | Total number of items of that type |
| `.Active` | Number of active items |
| `.Size` | Total size |
| `.Reclaimable` | Size that can be reclaimed (may include a percentage) |

These placeholders describe the **summary** rows only. Fields such as
`.ID`, `.Repository`, or `.Names` are not valid here (those apply to
commands like `docker image ls` or to `docker system df --verbose`,
which does not use `--format`).

When using the `--format` option, the `system df` command outputs
the data exactly as the template declares or, when using the
Expand Down
Loading