Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: fix anchor links 

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2023-01-06 17:26:24 +01:00
parent 3613fcc864
commit 71e561780a
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
6 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/commandline/build.md
View File

@ -405,7 +405,7 @@ used in the build will be run with the [corresponding `docker run` flag](../run.
### <a name=ulimit></a> Set ulimits in container (--ulimit) ### <a name=ulimit></a> Set ulimits in container (--ulimit)
Using the `--ulimit` option with `docker build` will cause each build step's Using the `--ulimit` option with `docker build` will cause each build step's
container to be started using those [`--ulimit` flag values](run.md#set-ulimits-in-container---ulimit). container to be started using those [`--ulimit` flag values](run.md#ulimit).
### <a name=build-arg></a> Set build-time variables (--build-arg) ### <a name=build-arg></a> Set build-time variables (--build-arg)
@ -442,7 +442,7 @@ $ export HTTP_PROXY=http://10.20.30.2:1234
$ docker build --build-arg HTTP_PROXY . $ docker build --build-arg HTTP_PROXY .
``` ```
This is similar to how `docker run -e` works. Refer to the [`docker run` documentation](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) This is similar to how `docker run -e` works. Refer to the [`docker run` documentation](run.md#env)
for more information. for more information.
### <a name=security-opt></a> Optional security options (--security-opt) ### <a name=security-opt></a> Optional security options (--security-opt)

20
docs/reference/commandline/cli.md
View File

@ -154,16 +154,16 @@ These fields allow you to customize the default output format for some commands
if no `--format` flag is provided. if no `--format` flag is provided.
| Property | Description | | Property | Description |
|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `configFormat` | Custom default format for `docker config ls` output. Refer to the [**format the output** section in the `docker config ls` documentation](config_ls.md#format-the-output) for a list of supported formatting directives. | | `configFormat` | Custom default format for `docker config ls` output. Refer to the [**format the output** section in the `docker config ls` documentation](config_ls.md#format) for a list of supported formatting directives. |
| `imagesFormat` | Custom default format for `docker images` / `docker image ls` output. Refer to the [**format the output** section in the `docker images` documentation](images.md#format-the-output) for a list of supported formatting directives. | | `imagesFormat` | Custom default format for `docker images` / `docker image ls` output. Refer to the [**format the output** section in the `docker images` documentation](images.md#format) for a list of supported formatting directives. |
| `nodesFormat` | Custom default format for `docker node ls` output. Refer to the [**formatting** section in the `docker node ls` documentation](node_ls.md#formatting) for a list of supported formatting directives. | | `nodesFormat` | Custom default format for `docker node ls` output. Refer to the [**formatting** section in the `docker node ls` documentation](node_ls.md#format) for a list of supported formatting directives. |
| `pluginsFormat` | Custom default format for `docker plugin ls` output. Refer to the [**formatting** section in the `docker plugin ls` documentation](plugin_ls.md#formatting) for a list of supported formatting directives. | | `pluginsFormat` | Custom default format for `docker plugin ls` output. Refer to the [**formatting** section in the `docker plugin ls` documentation](plugin_ls.md#format) for a list of supported formatting directives. |
| `psFormat` | Custom default format for `docker ps` / `docker container ps` output. Refer to the [**formatting** section in the `docker ps` documentation](ps.md#formatting) for a list of supported formatting directives. | | `psFormat` | Custom default format for `docker ps` / `docker container ps` output. Refer to the [**formatting** section in the `docker ps` documentation](ps.md#format) for a list of supported formatting directives. |
| `secretFormat` | Custom default format for `docker secret ls` output. Refer to the [**format the output** section in the `docker secret ls` documentation](secret_ls.md#format-the-output) for a list of supported formatting directives. | | `secretFormat` | Custom default format for `docker secret ls` output. Refer to the [**format the output** section in the `docker secret ls` documentation](secret_ls.md#format) for a list of supported formatting directives. |
| `serviceInspectFormat` | Custom default format for `docker service inspect` output. Refer to the [**formatting** section in the `docker service inspect` documentation](service_inspect.md#formatting) for a list of supported formatting directives. | | `serviceInspectFormat` | Custom default format for `docker service inspect` output. Refer to the [**formatting** section in the `docker service inspect` documentation](service_inspect.md#format) for a list of supported formatting directives. |
| `servicesFormat` | Custom default format for `docker service ls` output. Refer to the [**formatting** section in the `docker service ls` documentation](service_ls.md#formatting) for a list of supported formatting directives. | | `servicesFormat` | Custom default format for `docker service ls` output. Refer to the [**formatting** section in the `docker service ls` documentation](service_ls.md#format) for a list of supported formatting directives. |
| `statsFormat` | Custom default format for `docker stats` output. Refer to the [**formatting** section in the `docker stats` documentation](stats.md#formatting) for a list of supported formatting directives. | | `statsFormat` | Custom default format for `docker stats` output. Refer to the [**formatting** section in the `docker stats` documentation](stats.md#format) for a list of supported formatting directives. |
### Custom HTTP headers ### Custom HTTP headers

2
docs/reference/commandline/cp.md
View File

@ -115,7 +115,7 @@ $ docker cp CONTAINER:/var/logs/app.log - | tar x -O | grep "ERROR"
### Corner cases ### Corner cases
It is not possible to copy certain system files such as resources under It is not possible to copy certain system files such as resources under
`/proc`, `/sys`, `/dev`, [tmpfs](run.md#mount-tmpfs---tmpfs), and mounts created by `/proc`, `/sys`, `/dev`, [tmpfs](run.md#tmpfs), and mounts created by
the user in the container. However, you can still copy such files by manually the user in the container. However, you can still copy such files by manually
running `tar` in `docker exec`. Both of the following examples do the same thing running `tar` in `docker exec`. Both of the following examples do the same thing
in different ways (consider `SRC_PATH` and `DEST_PATH` are directories): in different ways (consider `SRC_PATH` and `DEST_PATH` are directories):

2
docs/reference/commandline/export.md
View File

@ -26,7 +26,7 @@ with the container. If a volume is mounted on top of an existing directory in
the container, `docker export` will export the contents of the *underlying* the container, `docker export` will export the contents of the *underlying*
directory, not the contents of the volume. directory, not the contents of the volume.
Refer to [Backup, restore, or migrate data volumes](https://docs.docker.com/storage/volumes/#backup-restore-or-migrate-data-volumes) Refer to [Backup, restore, or migrate data volumes](https://docs.docker.com/storage/volumes/#back-up-restore-or-migrate-data-volumes)
in the user guide for examples on exporting data in a volume. in the user guide for examples on exporting data in a volume.
## Examples ## Examples

6
docs/reference/commandline/service_update.md
View File

@ -156,7 +156,7 @@ point, effectively removing the `test-data` volume. Each command returns the
service name. service name.
- The `--mount-add` flag takes the same parameters as the `--mount` flag on - The `--mount-add` flag takes the same parameters as the `--mount` flag on
`service create`. Refer to the [volumes and bind mounts](service_create.md#add-bind-mounts-volumes-or-memory-filesystems) `service create`. Refer to the [volumes and bind mounts](service_create.md#mount-add)
section in the `service create` reference for details. section in the `service create` reference for details.
- The `--mount-rm` flag takes the `target` path of the mount. - The `--mount-rm` flag takes the `target` path of the mount.
@ -184,7 +184,7 @@ myservice
Use the `--publish-add` or `--publish-rm` flags to add or remove a published Use the `--publish-add` or `--publish-rm` flags to add or remove a published
port for a service. You can use the short or long syntax discussed in the port for a service. You can use the short or long syntax discussed in the
[docker service create](service_create.md#publish-service-ports-externally-to-the-swarm--p---publish) [docker service create](service_create.md#publish)
reference. reference.
The following example adds a published service port to an existing service. The following example adds a published service port to an existing service.
@ -199,7 +199,7 @@ $ docker service update \
Use the `--network-add` or `--network-rm` flags to add or remove a network for Use the `--network-add` or `--network-rm` flags to add or remove a network for
a service. You can use the short or long syntax discussed in the a service. You can use the short or long syntax discussed in the
[docker service create](service_create.md#attach-a-service-to-an-existing-network---network) [docker service create](service_create.md#network)
reference. reference.
The following example adds a new alias name to an existing service already connected to network my-network: The following example adds a new alias name to an existing service already connected to network my-network:

2
docs/reference/commandline/stats.md
View File

@ -66,7 +66,7 @@ e5c383697914 test-1951.1.kay7x1lh1twk9c0oig50sd5tr 0.00%
4bda148efbc0 random.1.vnc8on831idyr42slu578u3cr 0.00% 1.672MiB / 1.952GiB 0.08% 110kB / 0B 578kB / 0B 2 4bda148efbc0 random.1.vnc8on831idyr42slu578u3cr 0.00% 1.672MiB / 1.952GiB 0.08% 110kB / 0B 578kB / 0B 2
``` ```
If you don't [specify a format string using `--format`](#formatting), the If you don't [specify a format string using `--format`](#format), the
following columns are shown. following columns are shown.
| Column name | Description | | Column name | Description |