docs: update

Signed-off-by: Paweł Gronowski <[email protected]>
docker · Mar 1, 2024 · 7e76689 · 7e76689
1 parent 4ab7648
commit 7e76689
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/docs/reference/compose_attach.md b/docs/reference/compose_attach.md
@@ -11,7 +11,7 @@ Attach local standard input, output, and error streams to a service's running co
 | `--dry-run`     |          |         | Execute command in dry run mode                           |
 | `--index`       | `int`    | `0`     | index of the container if service has multiple replicas.  |
 | `--no-stdin`    |          |         | Do not attach STDIN                                       |
-| `--sig-proxy`   |          |         | Proxy all received signals to the process                 |
+| `--sig-proxy`   | `bool`   | `true`  | Proxy all received signals to the process                 |
 
 
 <!---MARKER_GEN_END-->
diff --git a/docs/reference/compose_exec.md b/docs/reference/compose_exec.md
@@ -11,7 +11,7 @@ Execute a command in a running container
 | `--dry-run`       |               |         | Execute command in dry run mode                                                  |
 | `-e`, `--env`     | `stringArray` |         | Set environment variables                                                        |
 | `--index`         | `int`         | `0`     | Index of the container if service has multiple replicas                          |
-| `-T`, `--no-TTY`  |               |         | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. |
+| `-T`, `--no-TTY`  | `bool`        | `true`  | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. |
 | `--privileged`    |               |         | Give extended privileges to the process                                          |
 | `-u`, `--user`    | `string`      |         | Run the command as this user                                                     |
 | `-w`, `--workdir` | `string`      |         | Path to workdir directory for this command                                       |

diff --git a/docs/reference/compose_ps.md b/docs/reference/compose_ps.md
@@ -12,7 +12,7 @@ List containers
 | [`--filter`](#filter) | `string`      |         | Filter services by a property (supported filters: status)                                                                                                                                                                                                                                                                                                                                                                            |
 | [`--format`](#format) | `string`      | `table` | Format output using a custom template:<br>'table':            Print output in table format with column headers (default)<br>'table TEMPLATE':   Print output in table format using the given Go template<br>'json':             Print in JSON format<br>'TEMPLATE':         Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
 | `--no-trunc`          |               |         | Don't truncate output                                                                                                                                                                                                                                                                                                                                                                                                                |
-| `--orphans`           |               |         | Include orphaned services (not declared by project)                                                                                                                                                                                                                                                                                                                                                                                  |
+| `--orphans`           | `bool`        | `true`  | Include orphaned services (not declared by project)                                                                                                                                                                                                                                                                                                                                                                                  |
 | `-q`, `--quiet`       |               |         | Only display IDs                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `--services`          |               |         | Display services                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | [`--status`](#status) | `stringArray` |         | Filter services by status. Values: [paused \| restarting \| removing \| running \| dead \| created \| exited]                                                                                                                                                                                                                                                                                                                        |

diff --git a/docs/reference/compose_run.md b/docs/reference/compose_run.md
@@ -14,10 +14,10 @@ Run a one-off command on a service
 | `--dry-run`             |               |         | Execute command in dry run mode                                                  |
 | `--entrypoint`          | `string`      |         | Override the entrypoint of the image                                             |
 | `-e`, `--env`           | `stringArray` |         | Set environment variables                                                        |
-| `-i`, `--interactive`   |               |         | Keep STDIN open even if not attached                                             |
+| `-i`, `--interactive`   | `bool`        | `true`  | Keep STDIN open even if not attached                                             |
 | `-l`, `--label`         | `stringArray` |         | Add or override a label                                                          |
 | `--name`                | `string`      |         | Assign a name to the container                                                   |
-| `-T`, `--no-TTY`        |               |         | Disable pseudo-TTY allocation (default: auto-detected)                           |
+| `-T`, `--no-TTY`        | `bool`        | `true`  | Disable pseudo-TTY allocation (default: auto-detected)                           |
 | `--no-deps`             |               |         | Don't start linked services                                                      |
 | `-p`, `--publish`       | `stringArray` |         | Publish a container's port(s) to the host                                        |
 | `--quiet-pull`          |               |         | Pull without printing progress information                                       |