From a6774de6827624db258915a61246fec0808d8a40 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Mon, 15 Jan 2024 11:27:58 +0100 Subject: [PATCH] docs: rename cli reference aliases to canonical Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- .../{attach.md => container_attach.md} | 0 .../{commit.md => container_commit.md} | 0 .../commandline/{cp.md => container_cp.md} | 0 .../{create.md => container_create.md} | 0 .../{diff.md => container_diff.md} | 0 .../{exec.md => container_exec.md} | 0 .../{export.md => container_export.md} | 0 .../{kill.md => container_kill.md} | 0 .../{logs.md => container_logs.md} | 0 .../commandline/{ps.md => container_ls.md} | 0 .../{pause.md => container_pause.md} | 0 .../{port.md => container_port.md} | 0 .../{rename.md => container_rename.md} | 0 .../{restart.md => container_restart.md} | 0 .../commandline/{rm.md => container_rm.md} | 0 .../commandline/{run.md => container_run.md} | 0 .../{start.md => container_start.md} | 0 .../{stats.md => container_stats.md} | 0 .../{stop.md => container_stop.md} | 0 .../commandline/{top.md => container_top.md} | 0 .../{unpause.md => container_unpause.md} | 0 .../{update.md => container_update.md} | 0 .../{wait.md => container_wait.md} | 0 .../commandline/{build.md => image_build.md} | 0 .../{history.md => image_history.md} | 0 .../{import.md => image_import.md} | 0 .../commandline/{load.md => image_load.md} | 0 .../commandline/{images.md => image_ls.md} | 0 .../commandline/{pull.md => image_pull.md} | 0 .../commandline/{push.md => image_push.md} | 0 .../commandline/{rmi.md => image_rm.md} | 0 .../commandline/{save.md => image_save.md} | 0 .../commandline/{tag.md => image_tag.md} | 0 docs/reference/commandline/index.md | 130 +++++++++--------- .../{events.md => system_events.md} | 0 .../commandline/{info.md => system_info.md} | 0 docs/reference/run.md | 12 +- 37 files changed, 70 insertions(+), 72 deletions(-) rename docs/reference/commandline/{attach.md => container_attach.md} (100%) rename docs/reference/commandline/{commit.md => container_commit.md} (100%) rename docs/reference/commandline/{cp.md => container_cp.md} (100%) rename docs/reference/commandline/{create.md => container_create.md} (100%) rename docs/reference/commandline/{diff.md => container_diff.md} (100%) rename docs/reference/commandline/{exec.md => container_exec.md} (100%) rename docs/reference/commandline/{export.md => container_export.md} (100%) rename docs/reference/commandline/{kill.md => container_kill.md} (100%) rename docs/reference/commandline/{logs.md => container_logs.md} (100%) rename docs/reference/commandline/{ps.md => container_ls.md} (100%) rename docs/reference/commandline/{pause.md => container_pause.md} (100%) rename docs/reference/commandline/{port.md => container_port.md} (100%) rename docs/reference/commandline/{rename.md => container_rename.md} (100%) rename docs/reference/commandline/{restart.md => container_restart.md} (100%) rename docs/reference/commandline/{rm.md => container_rm.md} (100%) rename docs/reference/commandline/{run.md => container_run.md} (100%) rename docs/reference/commandline/{start.md => container_start.md} (100%) rename docs/reference/commandline/{stats.md => container_stats.md} (100%) rename docs/reference/commandline/{stop.md => container_stop.md} (100%) rename docs/reference/commandline/{top.md => container_top.md} (100%) rename docs/reference/commandline/{unpause.md => container_unpause.md} (100%) rename docs/reference/commandline/{update.md => container_update.md} (100%) rename docs/reference/commandline/{wait.md => container_wait.md} (100%) rename docs/reference/commandline/{build.md => image_build.md} (100%) rename docs/reference/commandline/{history.md => image_history.md} (100%) rename docs/reference/commandline/{import.md => image_import.md} (100%) rename docs/reference/commandline/{load.md => image_load.md} (100%) rename docs/reference/commandline/{images.md => image_ls.md} (100%) rename docs/reference/commandline/{pull.md => image_pull.md} (100%) rename docs/reference/commandline/{push.md => image_push.md} (100%) rename docs/reference/commandline/{rmi.md => image_rm.md} (100%) rename docs/reference/commandline/{save.md => image_save.md} (100%) rename docs/reference/commandline/{tag.md => image_tag.md} (100%) rename docs/reference/commandline/{events.md => system_events.md} (100%) rename docs/reference/commandline/{info.md => system_info.md} (100%) diff --git a/docs/reference/commandline/attach.md b/docs/reference/commandline/container_attach.md similarity index 100% rename from docs/reference/commandline/attach.md rename to docs/reference/commandline/container_attach.md diff --git a/docs/reference/commandline/commit.md b/docs/reference/commandline/container_commit.md similarity index 100% rename from docs/reference/commandline/commit.md rename to docs/reference/commandline/container_commit.md diff --git a/docs/reference/commandline/cp.md b/docs/reference/commandline/container_cp.md similarity index 100% rename from docs/reference/commandline/cp.md rename to docs/reference/commandline/container_cp.md diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/container_create.md similarity index 100% rename from docs/reference/commandline/create.md rename to docs/reference/commandline/container_create.md diff --git a/docs/reference/commandline/diff.md b/docs/reference/commandline/container_diff.md similarity index 100% rename from docs/reference/commandline/diff.md rename to docs/reference/commandline/container_diff.md diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/container_exec.md similarity index 100% rename from docs/reference/commandline/exec.md rename to docs/reference/commandline/container_exec.md diff --git a/docs/reference/commandline/export.md b/docs/reference/commandline/container_export.md similarity index 100% rename from docs/reference/commandline/export.md rename to docs/reference/commandline/container_export.md diff --git a/docs/reference/commandline/kill.md b/docs/reference/commandline/container_kill.md similarity index 100% rename from docs/reference/commandline/kill.md rename to docs/reference/commandline/container_kill.md diff --git a/docs/reference/commandline/logs.md b/docs/reference/commandline/container_logs.md similarity index 100% rename from docs/reference/commandline/logs.md rename to docs/reference/commandline/container_logs.md diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/container_ls.md similarity index 100% rename from docs/reference/commandline/ps.md rename to docs/reference/commandline/container_ls.md diff --git a/docs/reference/commandline/pause.md b/docs/reference/commandline/container_pause.md similarity index 100% rename from docs/reference/commandline/pause.md rename to docs/reference/commandline/container_pause.md diff --git a/docs/reference/commandline/port.md b/docs/reference/commandline/container_port.md similarity index 100% rename from docs/reference/commandline/port.md rename to docs/reference/commandline/container_port.md diff --git a/docs/reference/commandline/rename.md b/docs/reference/commandline/container_rename.md similarity index 100% rename from docs/reference/commandline/rename.md rename to docs/reference/commandline/container_rename.md diff --git a/docs/reference/commandline/restart.md b/docs/reference/commandline/container_restart.md similarity index 100% rename from docs/reference/commandline/restart.md rename to docs/reference/commandline/container_restart.md diff --git a/docs/reference/commandline/rm.md b/docs/reference/commandline/container_rm.md similarity index 100% rename from docs/reference/commandline/rm.md rename to docs/reference/commandline/container_rm.md diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/container_run.md similarity index 100% rename from docs/reference/commandline/run.md rename to docs/reference/commandline/container_run.md diff --git a/docs/reference/commandline/start.md b/docs/reference/commandline/container_start.md similarity index 100% rename from docs/reference/commandline/start.md rename to docs/reference/commandline/container_start.md diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/container_stats.md similarity index 100% rename from docs/reference/commandline/stats.md rename to docs/reference/commandline/container_stats.md diff --git a/docs/reference/commandline/stop.md b/docs/reference/commandline/container_stop.md similarity index 100% rename from docs/reference/commandline/stop.md rename to docs/reference/commandline/container_stop.md diff --git a/docs/reference/commandline/top.md b/docs/reference/commandline/container_top.md similarity index 100% rename from docs/reference/commandline/top.md rename to docs/reference/commandline/container_top.md diff --git a/docs/reference/commandline/unpause.md b/docs/reference/commandline/container_unpause.md similarity index 100% rename from docs/reference/commandline/unpause.md rename to docs/reference/commandline/container_unpause.md diff --git a/docs/reference/commandline/update.md b/docs/reference/commandline/container_update.md similarity index 100% rename from docs/reference/commandline/update.md rename to docs/reference/commandline/container_update.md diff --git a/docs/reference/commandline/wait.md b/docs/reference/commandline/container_wait.md similarity index 100% rename from docs/reference/commandline/wait.md rename to docs/reference/commandline/container_wait.md diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/image_build.md similarity index 100% rename from docs/reference/commandline/build.md rename to docs/reference/commandline/image_build.md diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/image_history.md similarity index 100% rename from docs/reference/commandline/history.md rename to docs/reference/commandline/image_history.md diff --git a/docs/reference/commandline/import.md b/docs/reference/commandline/image_import.md similarity index 100% rename from docs/reference/commandline/import.md rename to docs/reference/commandline/image_import.md diff --git a/docs/reference/commandline/load.md b/docs/reference/commandline/image_load.md similarity index 100% rename from docs/reference/commandline/load.md rename to docs/reference/commandline/image_load.md diff --git a/docs/reference/commandline/images.md b/docs/reference/commandline/image_ls.md similarity index 100% rename from docs/reference/commandline/images.md rename to docs/reference/commandline/image_ls.md diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/image_pull.md similarity index 100% rename from docs/reference/commandline/pull.md rename to docs/reference/commandline/image_pull.md diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/image_push.md similarity index 100% rename from docs/reference/commandline/push.md rename to docs/reference/commandline/image_push.md diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/image_rm.md similarity index 100% rename from docs/reference/commandline/rmi.md rename to docs/reference/commandline/image_rm.md diff --git a/docs/reference/commandline/save.md b/docs/reference/commandline/image_save.md similarity index 100% rename from docs/reference/commandline/save.md rename to docs/reference/commandline/image_save.md diff --git a/docs/reference/commandline/tag.md b/docs/reference/commandline/image_tag.md similarity index 100% rename from docs/reference/commandline/tag.md rename to docs/reference/commandline/image_tag.md diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index 2dd4e7e4d0..2be6c2e160 100644 --- a/docs/reference/commandline/index.md +++ b/docs/reference/commandline/index.md @@ -20,72 +20,71 @@ read the [`dockerd`](dockerd.md) reference page. ### Docker management commands -| Command | Description | -|:----------------------|:-----------------------------------------------------| -| [dockerd](dockerd.md) | Launch the Docker daemon | -| [info](info.md) | Display system-wide information | -| [inspect](inspect.md) | Return low-level information on a container or image | -| [version](version.md) | Show the Docker version information | - +| Command | Description | +| :-------------------------------- | :--------------------------------------------------- | +| [dockerd](dockerd.md) | Launch the Docker daemon | +| [inspect](inspect.md) | Return low-level information on a container or image | +| [system events](system_events.md) | Get real-time events from the server | +| [system info](system_info.md) | Display system-wide information | +| [version](version.md) | Show the Docker version information | ### Image commands -| Command | Description | -|:------------------------------|:----------------------------------------------------------------| -| [build](build.md) | Build an image from a Dockerfile | -| [commit](commit.md) | Create a new image from a container's changes | -| [history](history.md) | Show the history of an image | -| [images](images.md) | List images | -| [import](import.md) | Import the contents from a tarball to create a filesystem image | -| [load](load.md) | Load an image from a tar archive or STDIN | -| [image prune](image_prune.md) | Remove unused images | -| [rmi](rmi.md) | Remove one or more images | -| [save](save.md) | Save images to a tar archive | -| [tag](tag.md) | Tag an image into a repository | +| Command | Description | +| :-------------------------------- | :-------------------------------------------------------------- | +| [image build](image_build.md) | Build an image from a Dockerfile | +| [image commit](image_commit.md) | Create a new image from a container's changes | +| [image history](image_history.md) | Show the history of an image | +| [image import](image_import.md) | Import the contents from a tarball to create a filesystem image | +| [image load](image_load.md) | Load an image from a tar archive or STDIN | +| [image ls](image_ls.md) | List images | +| [image prune](image_prune.md) | Remove unused images | +| [image rm](image_rm.md) | Remove one or more images | +| [image save](image_save.md) | Save images to a tar archive | +| [image tag](image_tag.md) | Tag an image into a repository | ### Container commands -| Command | Description | -|:--------------------------------------|:-----------------------------------------------------------------| -| [attach](attach.md) | Attach to a running container | -| [container prune](container_prune.md) | Remove all stopped containers | -| [cp](cp.md) | Copy files/folders from a container to a HOSTDIR or to STDOUT | -| [create](create.md) | Create a new container | -| [diff](diff.md) | Inspect changes on a container's filesystem | -| [events](events.md) | Get real time events from the server | -| [exec](exec.md) | Execute a command in a running container | -| [export](export.md) | Export a container's filesystem as a tar archive | -| [kill](kill.md) | Kill a running container | -| [logs](logs.md) | Fetch the logs of a container | -| [pause](pause.md) | Pause all processes within a container | -| [port](port.md) | List port mappings or a specific mapping for the container | -| [ps](ps.md) | List containers | -| [rename](rename.md) | Rename a container | -| [restart](restart.md) | Restart a running container | -| [rm](rm.md) | Remove one or more containers | -| [run](run.md) | Create and run a new container from an image | -| [start](start.md) | Start one or more stopped containers | -| [stats](stats.md) | Display a live stream of container(s) resource usage statistics | -| [stop](stop.md) | Stop a running container | -| [top](top.md) | Display the running processes of a container | -| [unpause](unpause.md) | Unpause all processes within a container | -| [update](update.md) | Update configuration of one or more containers | -| [wait](wait.md) | Block until a container stops, then print its exit code | +| Command | Description | +| :---------------------------------------- | :-------------------------------------------------------------- | +| [container attach](container_attach.md) | Attach to a running container | +| [container cp](container_cp.md) | Copy files/folders from a container to a HOSTDIR or to STDOUT | +| [container create](container_create.md) | Create a new container | +| [container diff](container_diff.md) | Inspect changes on a container's filesystem | +| [container exec](container_exec.md) | Execute a command in a running container | +| [container export](container_export.md) | Export a container's filesystem as a tar archive | +| [container kill](container_kill.md) | Kill a running container | +| [container logs](container_logs.md) | Fetch the logs of a container | +| [container ls](container_ls.md) | List containers | +| [container pause](container_pause.md) | Pause all processes within a container | +| [container port](container_port.md) | List port mappings or a specific mapping for the container | +| [container prune](container_prune.md) | Remove all stopped containers | +| [container rename](container_rename.md) | Rename a container | +| [container restart](container_restart.md) | Restart a running container | +| [container rm](container_rm.md) | Remove one or more containers | +| [container run](container_run.md) | Create and run a new container from an image | +| [container start](container_start.md) | Start one or more stopped containers | +| [container stats](container_stats.md) | Display a live stream of container(s) resource usage statistics | +| [container stop](container_stop.md) | Stop a running container | +| [container top](container_top.md) | Display the running processes of a container | +| [container unpause](container_unpause.md) | Unpause all processes within a container | +| [container update](container_update.md) | Update configuration of one or more containers | +| [container wait](container_wait.md) | Block until a container stops, then print its exit code | ### Hub and registry commands -| Command | Description | -|:--------------------|:------------------------------------------------------------------------| -| [login](login.md) | Log in to a registry | -| [logout](logout.md) | Log out from a registry | -| [pull](pull.md) | Download an image from a registry | -| [push](push.md) | Upload an image to a registry | -| [search](search.md) | Search Docker Hub for images | +| Command | Description | +| :------------------ | :-------------------------------- | +| [login](login.md) | Log in to a registry | +| [logout](logout.md) | Log out from a registry | +| [pull](pull.md) | Download an image from a registry | +| [push](push.md) | Upload an image to a registry | +| [search](search.md) | Search Docker Hub for images | ### Network and connectivity commands | Command | Description | -|:--------------------------------------------|:-------------------------------------------------------| +| :------------------------------------------ | :----------------------------------------------------- | | [network connect](network_connect.md) | Connect a container to a network | | [network create](network_create.md) | Create a new network | | [network disconnect](network_disconnect.md) | Disconnect a container from a network | @@ -97,7 +96,7 @@ read the [`dockerd`](dockerd.md) reference page. ### Shared data volume commands | Command | Description | -|:------------------------------------|:-----------------------------------------------------------------| +| :---------------------------------- | :--------------------------------------------------------------- | | [volume create](volume_create.md) | Creates a new volume where containers can consume and store data | | [volume inspect](volume_inspect.md) | Display information about a volume | | [volume ls](volume_ls.md) | Lists all the volumes Docker knows about | @@ -107,7 +106,7 @@ read the [`dockerd`](dockerd.md) reference page. ### Swarm node commands | Command | Description | -|:--------------------------------|:--------------------------------------------------------------| +| :------------------------------ | :------------------------------------------------------------ | | [node demote](node_demote.md) | Demotes an existing manager so that it is no longer a manager | | [node inspect](node_inspect.md) | Inspect a node in the swarm | | [node ls](node_ls.md) | List nodes in the swarm | @@ -119,19 +118,19 @@ read the [`dockerd`](dockerd.md) reference page. ### Swarm management commands | Command | Description | -|:----------------------------------------|:----------------------------------------------| +| :-------------------------------------- | :-------------------------------------------- | | [swarm init](swarm_init.md) | Initialize a swarm | +| [swarm join-token](swarm_join-token.md) | Display or rotate join tokens | | [swarm join](swarm_join.md) | Join a swarm as a manager node or worker node | | [swarm leave](swarm_leave.md) | Remove the current node from the swarm | -| [swarm join-token](swarm_join-token.md) | Display or rotate join tokens | -| [swarm unlock](swarm_unlock.md) | Unlock swarm | | [swarm unlock-key](swarm_unlock-key.md) | Manage the unlock key | +| [swarm unlock](swarm_unlock.md) | Unlock swarm | | [swarm update](swarm_update.md) | Update attributes of a swarm | ### Swarm service commands | Command | Description | -|:--------------------------------------|:----------------------------------------------------------------| +| :------------------------------------ | :-------------------------------------------------------------- | | [service create](service_create.md) | Create a new service | | [service inspect](service_inspect.md) | Inspect a service | | [service logs](service_logs.md) | Fetch the logs of a service or task | @@ -144,7 +143,7 @@ read the [`dockerd`](dockerd.md) reference page. ### Swarm secret commands | Command | Description | -|:-------------------------------------|:------------------------------------------------| +| :----------------------------------- | :---------------------------------------------- | | [secret create](secret_create.md) | Create a secret from a file or STDIN as content | | [secret inspect](service_inspect.md) | Inspect the specified secret | | [secret ls](secret_ls.md) | List secrets in the swarm | @@ -153,18 +152,18 @@ read the [`dockerd`](dockerd.md) reference page. ### Swarm stack commands | Command | Description | -|:------------------------------------|:--------------------------------------------------------| +| :---------------------------------- | :------------------------------------------------------ | +| [stack config](stack_config.md) | Output the Compose file after merges and interpolations | | [stack deploy](stack_deploy.md) | Deploy a new stack or update an existing stack | | [stack ls](stack_ls.md) | List stacks in the swarm | | [stack ps](stack_ps.md) | List the tasks in the stack | | [stack rm](stack_rm.md) | Remove the stack from the swarm | | [stack services](stack_services.md) | List the services in the stack | -| [stack config](stack_config.md) | Output the Compose file after merges and interpolations | ### Plugin commands | Command | Description | -|:------------------------------------|:------------------------------------------------| +| :---------------------------------- | :---------------------------------------------- | | [plugin create](plugin_create.md) | Create a plugin from a rootfs and configuration | | [plugin disable](plugin_disable.md) | Disable a plugin | | [plugin enable](plugin_enable.md) | Enable a plugin | @@ -178,13 +177,12 @@ read the [`dockerd`](dockerd.md) reference page. ### Context commands | Command | Description | -|:--------------------------------------|:-------------------------------| +| :------------------------------------ | :----------------------------- | | [context create](context_create.md) | Create a context | | [context export](context_export.md) | Export a context | | [context import](context_import.md) | Import a context | +| [context inspect](context_inspect.md) | Inspect one or more contexts | | [context ls](context_ls.md) | List contexts | | [context rm](context_rm.md) | Remove one or more contexts | | [context update](context_update.md) | Update a context | | [context use](context_use.md) | Set the current docker context | -| [context inspect](context_inspect.md) | Inspect one or more contexts | - diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/system_events.md similarity index 100% rename from docs/reference/commandline/events.md rename to docs/reference/commandline/system_events.md diff --git a/docs/reference/commandline/info.md b/docs/reference/commandline/system_info.md similarity index 100% rename from docs/reference/commandline/info.md rename to docs/reference/commandline/system_info.md diff --git a/docs/reference/run.md b/docs/reference/run.md index 9f6151b8f7..41fd2c0dc2 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -114,13 +114,13 @@ $ docker attach 0246aa4d1448 For more information about `docker run` flags related to foreground and background modes, see: -- [`docker run --detach`](commandline/run.md#detach): run container in background -- [`docker run --attach`](commandline/run.md#attach): attach to `stdin`, `stdout`, and `stderr` -- [`docker run --tty`](commandline/run.md#tty): allocate a pseudo-tty -- [`docker run --interactive`](commandline/run.md#interactive): keep `stdin` open even if not attached +- [`docker run --detach`](commandline/container_run.md#detach): run container in background +- [`docker run --attach`](commandline/container_run.md#attach): attach to `stdin`, `stdout`, and `stderr` +- [`docker run --tty`](commandline/container_run.md#tty): allocate a pseudo-tty +- [`docker run --interactive`](commandline/container_run.md#interactive): keep `stdin` open even if not attached For more information about re-attaching to a background container, see -[`docker attach`](commandline/attach.md). +[`docker attach`](commandline/container_attach.md). ## Container identification @@ -135,7 +135,7 @@ You can identify a container in three ways: The UUID identifier is a random ID assigned to the container by the daemon. The daemon generates a random string name for containers automatically. You can -also defined a custom name using [the `--name` flag](./commandline/run.md#name). +also defined a custom name using [the `--name` flag](./commandline/container_run.md#name). Defining a `name` can be a handy way to add meaning to a container. If you specify a `name`, you can use it when referring to the container in a user-defined network. This works for both background and foreground Docker