{{ .LinkTitle }} ({{ .Title }})
{{ else }}{{ .Title }}
{{ end }} {{ $data.short | .RenderString (dict "display" "block") }} {{ if $data.deprecated }}{{ end }} {{ if or $data.experimental $data.experimentalcli }}This command is deprecated
It may be removed in a future Docker version. For more information, see the Docker roadmap
{{ end }} {{ with $data.kubernetes }}This command is experimental
Experimental features are intended for testing and feedback as their functionality or design may change between releases without warning or can be removed entirely in a future release.
{{ partial "components/badge.html" (dict "color" "blue" "content" "Kubernetes") }} This command works with the Kubernetes orchestrator.
{{ end }} {{ with $data.swarm }}{{ partial "components/badge.html" (dict "color" "blue" "content" "Swarm") }} This command works with the Swarm orchestrator.
{{ end }} {{ with $data.usage }} {{ $heading := dict "level" 2 "text" "Usage" }} {{ partial "heading.html" $heading }} {{ $.Scratch.Add "headings" $heading }} {{ highlight (strings.Replace . "\t" "") "console" }} {{ end }} {{ with $data.aliases }} {{ $heading := dict "level" 2 "text" "Aliases" }} {{ partial "heading.html" $heading }} {{ $aliases := strings.Split . ", " }}The following commands are equivalent and redirect here:
-
{{ range $aliases }}
{{ . }}
{{ end }}
Option | Default | Description |
---|---|---|
{{ with .details_url }}
{{ with $short }}-{{ . }}, {{end}}--{{ $long }}
{{ else }}
{{ with $short }}-{{ . }}, {{end}}--{{ $long }}
{{ end }}
|
{{ $skipDefault := `[],map[],false,0,0s,default,'',""` }}
{{ with .default_value }}
{{ cond (in $skipDefault .) "" (printf "%s " . | safeHTML) }}
{{ end }}
|
{{ with .min_api_version }}
{{ partial "components/badge.html" (dict "color" "blue" "content" (printf "API %s+" .)) }}
{{ end }}
{{ with .deprecated }}
{{ partial "components/badge.html" (dict "color" "red" "content" "Deprecated") }}
{{ end }}
{{ with .experimental }}
{{ partial "components/badge.html" (dict "color" "amber" "content" "experimental (daemon)") }}
{{ end }}
{{ with .experimentalcli }}
{{ partial "components/badge.html" (dict "color" "amber" "content" "experimental (CLI)") }}
{{ end }}
{{ with .kubernetes }}
{{ partial "components/badge.html" (dict "color" "blue" "content" "Kubernetes") }}
{{ end }}
{{ with .swarm }}
{{ partial "components/badge.html" (dict "color" "blue" "content" "Swarm") }}
{{ end }}
{{ if .description }}
{{/* replace newlines in long desc with break tags */}}
{{ markdownify (strings.Replace .description "\n" " ") }} {{ end }} |