mirror of
https://github.com/containers/podman.git
synced 2025-08-06 03:19:52 +08:00
Merge pull request #19297 from vrothberg/RUN-1865
add a podman-compose command
This commit is contained in:
1
docs/source/markdown/.gitignore
vendored
1
docs/source/markdown/.gitignore
vendored
@ -1,6 +1,7 @@
|
||||
podman-attach.1.md
|
||||
podman-auto-update.1.md
|
||||
podman-build.1.md
|
||||
podman-compose.1.md
|
||||
podman-container-clone.1.md
|
||||
podman-container-diff.1.md
|
||||
podman-container-inspect.1.md
|
||||
|
21
docs/source/markdown/podman-compose.1.md.in
Normal file
21
docs/source/markdown/podman-compose.1.md.in
Normal file
@ -0,0 +1,21 @@
|
||||
% podman-compose 1
|
||||
|
||||
## NAME
|
||||
podman\-compose - Run Compose workloads via an external compose provider
|
||||
|
||||
## SYNOPSIS
|
||||
**podman compose** [*options*] [*command* [*arg* ...]]
|
||||
|
||||
## DESCRIPTION
|
||||
**podman compose** is a thin wrapper around an external compose provider such as docker-compose or podman-compose. This means that `podman compose` is executing another tool that implements the compose functionality but sets up the environment in a way to let the compose provider communicate transparently with the local Podman socket. The specified options as well the command and argument are passed directly to the compose provider.
|
||||
|
||||
The default compose providers are `docker-compose` and `podman-compose`. If installed, `docker-compose` takes precedence since it is the original implementation of the Compose specification and is widely used on the supported platforms (i.e., Linux, Mac OS, Windows).
|
||||
|
||||
If you want to change the default behavior or have a custom installation path for your provider of choice, please change the `compose_provider` field in `containers.conf(5)`. You may also set the `PODMAN_COMPOSE_PROVIDER` environment variable.
|
||||
|
||||
## OPTIONS
|
||||
|
||||
To see supported options of the installed compose provider, please run `podman compose --help`.
|
||||
|
||||
## SEE ALSO
|
||||
**[podman(1)](podman.1.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**
|
@ -315,6 +315,7 @@ the exit codes follow the `chroot` standard, see below:
|
||||
| [podman-build(1)](podman-build.1.md) | Build a container image using a Containerfile. |
|
||||
| [podman-commit(1)](podman-commit.1.md) | Create new image based on the changed container. |
|
||||
| [podman-completion(1)](podman-completion.1.md) | Generate shell completion scripts |
|
||||
| [podman-compose(1)](podman-compose.1.md) | Run Compose workloads via an external compose provider. |
|
||||
| [podman-container(1)](podman-container.1.md) | Manage containers. |
|
||||
| [podman-cp(1)](podman-cp.1.md) | Copy files/folders between a container and the local filesystem. |
|
||||
| [podman-create(1)](podman-create.1.md) | Create a new container. |
|
||||
|
Reference in New Issue
Block a user