diff --git a/_data/engine-cli/docker_attach.yaml b/_data/engine-cli/docker_attach.yaml index 9ac2d504be..bd01b497f3 100644 --- a/_data/engine-cli/docker_attach.yaml +++ b/_data/engine-cli/docker_attach.yaml @@ -64,7 +64,7 @@ options: - option: sig-proxy default_value: "true" description: Proxy all received signals to the process -example: |- +examples: |- ### Attach to and detach from a running container ```bash diff --git a/_data/engine-cli/docker_build.yaml b/_data/engine-cli/docker_build.yaml index ffd5d9aa87..4942d317c7 100644 --- a/_data/engine-cli/docker_build.yaml +++ b/_data/engine-cli/docker_build.yaml @@ -184,7 +184,7 @@ options: - option: ulimit default_value: '[]' description: Ulimit options -example: |- +examples: |- ### Build with PATH ```bash diff --git a/_data/engine-cli/docker_commit.yaml b/_data/engine-cli/docker_commit.yaml index 9634808478..ff6c8416c3 100644 --- a/_data/engine-cli/docker_commit.yaml +++ b/_data/engine-cli/docker_commit.yaml @@ -36,7 +36,7 @@ options: shorthand: p default_value: "true" description: Pause container during commit -example: |- +examples: |- ### Commit a container ```bash diff --git a/_data/engine-cli/docker_create.yaml b/_data/engine-cli/docker_create.yaml index 2400fea6e7..b091b14e19 100644 --- a/_data/engine-cli/docker_create.yaml +++ b/_data/engine-cli/docker_create.yaml @@ -291,7 +291,7 @@ options: - option: workdir shorthand: w description: Working directory inside the container -example: |- +examples: |- ### Create and start a container ```bash diff --git a/_data/engine-cli/docker_deploy.yaml b/_data/engine-cli/docker_deploy.yaml index 882f12817c..59557b35f0 100644 --- a/_data/engine-cli/docker_deploy.yaml +++ b/_data/engine-cli/docker_deploy.yaml @@ -15,7 +15,7 @@ options: - option: with-registry-auth default_value: "false" description: Send registry authentication details to Swarm agents -example: |- +examples: |- ### Compose file The `deploy` command supports compose file version `3.0` and above. diff --git a/_data/engine-cli/docker_diff.yaml b/_data/engine-cli/docker_diff.yaml index a77ebaa29d..d0b9b7a2af 100644 --- a/_data/engine-cli/docker_diff.yaml +++ b/_data/engine-cli/docker_diff.yaml @@ -15,7 +15,7 @@ long: |- usage: docker diff CONTAINER pname: docker plink: docker.yaml -example: |- +examples: |- Inspect the changes to an `nginx` container: ```bash diff --git a/_data/engine-cli/docker_events.yaml b/_data/engine-cli/docker_events.yaml index 7bbc30ce15..ddcca7826b 100644 --- a/_data/engine-cli/docker_events.yaml +++ b/_data/engine-cli/docker_events.yaml @@ -145,7 +145,7 @@ options: description: Show all events created since timestamp - option: until description: Stream events until this timestamp -example: |- +examples: |- ### Basic example You'll need two shells for this example. diff --git a/_data/engine-cli/docker_exec.yaml b/_data/engine-cli/docker_exec.yaml index 959a83cc0c..63d4cfec01 100644 --- a/_data/engine-cli/docker_exec.yaml +++ b/_data/engine-cli/docker_exec.yaml @@ -34,7 +34,7 @@ options: - option: user shorthand: u description: 'Username or UID (format: [:])' -example: |- +examples: |- ### Run `docker exec` on a running container First, start a container. diff --git a/_data/engine-cli/docker_export.yaml b/_data/engine-cli/docker_export.yaml index 7f0ceaf4f9..ea2b3c0177 100644 --- a/_data/engine-cli/docker_export.yaml +++ b/_data/engine-cli/docker_export.yaml @@ -15,7 +15,7 @@ options: - option: output shorthand: o description: Write to a file, instead of STDOUT -example: |- +examples: |- ch of these commands has the same result. ```bash diff --git a/_data/engine-cli/docker_history.yaml b/_data/engine-cli/docker_history.yaml index 623708203a..95a134db26 100644 --- a/_data/engine-cli/docker_history.yaml +++ b/_data/engine-cli/docker_history.yaml @@ -16,7 +16,7 @@ options: shorthand: q default_value: "false" description: Only show numeric IDs -example: |- +examples: |- To see how the `docker:latest` image was built: ```bash diff --git a/_data/engine-cli/docker_images.yaml b/_data/engine-cli/docker_images.yaml index 1a048186f0..03ece53ddf 100644 --- a/_data/engine-cli/docker_images.yaml +++ b/_data/engine-cli/docker_images.yaml @@ -39,7 +39,7 @@ options: shorthand: q default_value: "false" description: Only show numeric IDs -example: |- +examples: |- ### List the most recently created images ```bash diff --git a/_data/engine-cli/docker_import.yaml b/_data/engine-cli/docker_import.yaml index a61fbeaa9f..ab24c0268f 100644 --- a/_data/engine-cli/docker_import.yaml +++ b/_data/engine-cli/docker_import.yaml @@ -24,7 +24,7 @@ options: - option: message shorthand: m description: Set commit message for imported image -example: |- +examples: |- ### Import from a remote location This will create a new untagged image. diff --git a/_data/engine-cli/docker_info.yaml b/_data/engine-cli/docker_info.yaml index 981f7c1473..ae96f478d3 100644 --- a/_data/engine-cli/docker_info.yaml +++ b/_data/engine-cli/docker_info.yaml @@ -25,7 +25,7 @@ options: - option: format shorthand: f description: Format the output using the given Go template -example: |- +examples: |- ### Show output The example below shows the output for a daemon running on Red Hat Enterprise Linux, diff --git a/_data/engine-cli/docker_inspect.yaml b/_data/engine-cli/docker_inspect.yaml index 51ba94061d..8f27800fa2 100644 --- a/_data/engine-cli/docker_inspect.yaml +++ b/_data/engine-cli/docker_inspect.yaml @@ -20,7 +20,7 @@ options: description: Display total file sizes if the type is container - option: type description: Return JSON for specified type -example: |- +examples: |- ### Get an instance's IP address For the most part, you can pick out any field from the JSON in a fairly diff --git a/_data/engine-cli/docker_load.yaml b/_data/engine-cli/docker_load.yaml index af2dcd96d8..c8b0446e39 100644 --- a/_data/engine-cli/docker_load.yaml +++ b/_data/engine-cli/docker_load.yaml @@ -14,7 +14,7 @@ options: shorthand: q default_value: "false" description: Suppress the load output -example: |- +examples: |- ```bash $ docker images diff --git a/_data/engine-cli/docker_logout.yaml b/_data/engine-cli/docker_logout.yaml index 625742eef3..082c8fcf44 100644 --- a/_data/engine-cli/docker_logout.yaml +++ b/_data/engine-cli/docker_logout.yaml @@ -4,7 +4,7 @@ long: Log out from a Docker registry usage: docker logout [SERVER] pname: docker plink: docker.yaml -example: |- +examples: |- ```bash $ docker logout localhost:8080 ``` diff --git a/_data/engine-cli/docker_pause.yaml b/_data/engine-cli/docker_pause.yaml index 6d0507b424..1552d106f1 100644 --- a/_data/engine-cli/docker_pause.yaml +++ b/_data/engine-cli/docker_pause.yaml @@ -14,7 +14,7 @@ long: |- usage: docker pause CONTAINER [CONTAINER...] pname: docker plink: docker.yaml -example: |- +examples: |- ```bash $ docker pause my_container ``` diff --git a/_data/engine-cli/docker_port.yaml b/_data/engine-cli/docker_port.yaml index 2a6452677a..00550b9ddb 100644 --- a/_data/engine-cli/docker_port.yaml +++ b/_data/engine-cli/docker_port.yaml @@ -4,7 +4,7 @@ long: List port mappings or a specific mapping for the container usage: docker port CONTAINER [PRIVATE_PORT[/PROTO]] pname: docker plink: docker.yaml -example: |- +examples: |- ### Show all mapped ports You can find out all the ports mapped by not specifying a `PRIVATE_PORT`, or diff --git a/_data/engine-cli/docker_ps.yaml b/_data/engine-cli/docker_ps.yaml index 4962c1ea37..0cf2bdf012 100644 --- a/_data/engine-cli/docker_ps.yaml +++ b/_data/engine-cli/docker_ps.yaml @@ -33,7 +33,7 @@ options: shorthand: s default_value: "false" description: Display total file sizes -example: |- +examples: |- ### Prevent truncating output Running `docker ps --no-trunc` showing 2 linked containers. diff --git a/_data/engine-cli/docker_pull.yaml b/_data/engine-cli/docker_pull.yaml index f5cdf1edb8..90ef2a1853 100644 --- a/_data/engine-cli/docker_pull.yaml +++ b/_data/engine-cli/docker_pull.yaml @@ -36,7 +36,7 @@ options: - option: disable-content-trust default_value: "true" description: Skip image verification -example: |- +examples: |- ### Pull an image from Docker Hub To download a particular image, or set of images (i.e., a repository), use diff --git a/_data/engine-cli/docker_push.yaml b/_data/engine-cli/docker_push.yaml index 7087d3ef89..3362444241 100644 --- a/_data/engine-cli/docker_push.yaml +++ b/_data/engine-cli/docker_push.yaml @@ -25,7 +25,7 @@ options: - option: disable-content-trust default_value: "true" description: Skip image signing -example: |- +examples: |- ### Push a new image to a registry First save the new image by finding the container ID (using [`docker ps`](ps.md)) diff --git a/_data/engine-cli/docker_rename.yaml b/_data/engine-cli/docker_rename.yaml index 243fed711c..d1af0fbd3c 100644 --- a/_data/engine-cli/docker_rename.yaml +++ b/_data/engine-cli/docker_rename.yaml @@ -4,7 +4,7 @@ long: The `docker rename` command renames a container. usage: docker rename CONTAINER NEW_NAME pname: docker plink: docker.yaml -example: |- +examples: |- ```bash $ docker rename my_container my_new_container ``` diff --git a/_data/engine-cli/docker_restart.yaml b/_data/engine-cli/docker_restart.yaml index 3d5e2d0f9b..2814a576eb 100644 --- a/_data/engine-cli/docker_restart.yaml +++ b/_data/engine-cli/docker_restart.yaml @@ -9,7 +9,7 @@ options: shorthand: t default_value: "10" description: Seconds to wait for stop before killing the container -example: |- +examples: |- ```bash $ docker restart my_container ``` diff --git a/_data/engine-cli/docker_rm.yaml b/_data/engine-cli/docker_rm.yaml index 52242280ba..aa30c51914 100644 --- a/_data/engine-cli/docker_rm.yaml +++ b/_data/engine-cli/docker_rm.yaml @@ -17,7 +17,7 @@ options: shorthand: v default_value: "false" description: Remove the volumes associated with the container -example: |- +examples: |- ### Remove a container This will remove the container referenced under the link diff --git a/_data/engine-cli/docker_rmi.yaml b/_data/engine-cli/docker_rmi.yaml index 883f0007f3..017cda4509 100644 --- a/_data/engine-cli/docker_rmi.yaml +++ b/_data/engine-cli/docker_rmi.yaml @@ -12,7 +12,7 @@ options: - option: no-prune default_value: "false" description: Do not delete untagged parents -example: |- +examples: |- You can remove an image using its short or long ID, its tag, or its digest. If an image has one or more tag referencing it, you must remove all of them before the image is removed. Digest references are removed automatically when an image diff --git a/_data/engine-cli/docker_run.yaml b/_data/engine-cli/docker_run.yaml index 182a35244b..fd197f1995 100644 --- a/_data/engine-cli/docker_run.yaml +++ b/_data/engine-cli/docker_run.yaml @@ -300,7 +300,7 @@ options: - option: workdir shorthand: w description: Working directory inside the container -example: |- +examples: |- ### Assign name and allocate pseudo-TTY (--name, -it) ```bash diff --git a/_data/engine-cli/docker_save.yaml b/_data/engine-cli/docker_save.yaml index f7af3dfdc2..5f63798c2f 100644 --- a/_data/engine-cli/docker_save.yaml +++ b/_data/engine-cli/docker_save.yaml @@ -11,7 +11,7 @@ options: - option: output shorthand: o description: Write to a file, instead of STDOUT -example: |- +examples: |- ### Create a backup that can then be used with `docker load`. ```bash diff --git a/_data/engine-cli/docker_search.yaml b/_data/engine-cli/docker_search.yaml index a9ab322265..90b39b767f 100644 --- a/_data/engine-cli/docker_search.yaml +++ b/_data/engine-cli/docker_search.yaml @@ -27,7 +27,7 @@ options: shorthand: s default_value: "0" description: Only displays with at least x stars -example: "### Search images by name\n\nThis example displays images with a name containing +examples: "### Search images by name\n\nThis example displays images with a name containing 'busybox':\n\n```none\n$ docker search busybox\n\nNAME DESCRIPTION \ STARS OFFICIAL AUTOMATED\nbusybox Busybox base image. 316 [OK] \nprogrium/busybox diff --git a/_data/engine-cli/docker_start.yaml b/_data/engine-cli/docker_start.yaml index 29858354ac..d75b08b6d6 100644 --- a/_data/engine-cli/docker_start.yaml +++ b/_data/engine-cli/docker_start.yaml @@ -19,7 +19,7 @@ options: shorthand: i default_value: "false" description: Attach container's STDIN -example: |- +examples: |- ```bash $ docker start my_container ``` diff --git a/_data/engine-cli/docker_stats.yaml b/_data/engine-cli/docker_stats.yaml index 042a8bc462..d8009ef45e 100644 --- a/_data/engine-cli/docker_stats.yaml +++ b/_data/engine-cli/docker_stats.yaml @@ -17,7 +17,7 @@ options: - option: no-stream default_value: "false" description: Disable streaming stats and only pull the first result -example: |- +examples: |- Running `docker stats` on all running containers against a Linux daemon. ```bash diff --git a/_data/engine-cli/docker_stop.yaml b/_data/engine-cli/docker_stop.yaml index 200c12bce2..c650227858 100644 --- a/_data/engine-cli/docker_stop.yaml +++ b/_data/engine-cli/docker_stop.yaml @@ -11,7 +11,7 @@ options: shorthand: t default_value: "10" description: Seconds to wait for stop before killing it -example: |- +examples: |- ```bash $ docker stop my_container ``` diff --git a/_data/engine-cli/docker_tag.yaml b/_data/engine-cli/docker_tag.yaml index 18aa72ea5f..e8554a7260 100644 --- a/_data/engine-cli/docker_tag.yaml +++ b/_data/engine-cli/docker_tag.yaml @@ -19,7 +19,7 @@ long: |- usage: docker tag SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] pname: docker plink: docker.yaml -example: |- +examples: |- ### Tag an image referenced by ID To tag a local image with ID "0e5574283393" into the "fedora" repository with diff --git a/_data/engine-cli/docker_unpause.yaml b/_data/engine-cli/docker_unpause.yaml index 58c5af87cb..9ef98f1efb 100644 --- a/_data/engine-cli/docker_unpause.yaml +++ b/_data/engine-cli/docker_unpause.yaml @@ -10,7 +10,7 @@ long: |- usage: docker unpause CONTAINER [CONTAINER...] pname: docker plink: docker.yaml -example: |- +examples: |- ```bash $ docker unpause my_container ``` diff --git a/_data/engine-cli/docker_update.yaml b/_data/engine-cli/docker_update.yaml index 1570a78127..a0145d1869 100644 --- a/_data/engine-cli/docker_update.yaml +++ b/_data/engine-cli/docker_update.yaml @@ -51,7 +51,7 @@ options: Swap limit equal to memory plus swap: '-1' to enable unlimited swap - option: restart description: Restart policy to apply when a container exits -example: |- +examples: |- The following sections illustrate ways to use this command. ### Update a container's cpu-shares diff --git a/_data/engine-cli/docker_version.yaml b/_data/engine-cli/docker_version.yaml index 8f79a436eb..a1e6a46570 100644 --- a/_data/engine-cli/docker_version.yaml +++ b/_data/engine-cli/docker_version.yaml @@ -13,7 +13,7 @@ options: - option: format shorthand: f description: Format the output using the given Go template -example: |- +examples: |- ### Default output ```bash diff --git a/_data/engine-cli/docker_volume_rm.yaml b/_data/engine-cli/docker_volume_rm.yaml index c6bd310b3f..8ad09f639b 100644 --- a/_data/engine-cli/docker_volume_rm.yaml +++ b/_data/engine-cli/docker_volume_rm.yaml @@ -12,7 +12,7 @@ options: shorthand: f default_value: "false" description: Force the removal of one or more volumes -example: |2 +examples: |2 $ docker volume rm hello hello diff --git a/_data/engine-cli/docker_wait.yaml b/_data/engine-cli/docker_wait.yaml index 21fa6882c7..f550aa2fe4 100644 --- a/_data/engine-cli/docker_wait.yaml +++ b/_data/engine-cli/docker_wait.yaml @@ -4,7 +4,7 @@ long: Block until one or more containers stop, then print their exit codes usage: docker wait CONTAINER [CONTAINER...] pname: docker plink: docker.yaml -example: |- +examples: |- Start a container in the background. ```bash