spiegel_podman/docs/source/markdown
Valentin Rothberg e596b17fbe add a podman-compose command
**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.

Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
2023-07-24 19:23:04 +02:00
..
links Install podman-systemd.unit man page, make quadlet discoverable 2023-02-03 08:42:20 -06:00
options Merge pull request #19098 from imphil/userns-docs 2023-07-14 13:12:42 +02:00
.gitignore add a podman-compose command 2023-07-24 19:23:04 +02:00
podman-attach.1.md.in Clean up more language for inclusiveness 2023-01-27 09:40:27 -05:00
podman-auto-update.1.md.in auto update: fix usage of --authfile 2023-07-05 08:30:39 +02:00
podman-build.1.md.in docs: podman-build --network add slirp and pasta 2023-07-13 16:31:17 +02:00
podman-commit.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-completion.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-compose.1.md.in add a podman-compose command 2023-07-24 19:23:04 +02:00
podman-container-checkpoint.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-container-cleanup.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-container-clone.1.md.in man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-container-diff.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-container-exists.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-container-inspect.1.md.in Address review feedback and add manpage notes 2023-06-06 11:04:59 -04:00
podman-container-prune.1.md Fix podman container prune docs for --filter 2023-07-13 12:04:13 -04:00
podman-container-restore.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-container-runlabel.1.md.in man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-container.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-cp.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-create.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-diff.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-events.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-exec.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-export.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-generate-spec.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-generate-systemd.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-generate.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-healthcheck-run.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-healthcheck.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-history.1.md man page --format xref: tighten the autocompletion check 2023-02-14 08:11:54 -07:00
podman-image-diff.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-image-exists.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-image-inspect.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-image-mount.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-image-prune.1.md Remove 'you' from man pages 2022-12-07 09:29:29 -05:00
podman-image-scp.1.md Remove 'you' from man pages 2022-12-07 09:29:29 -05:00
podman-image-sign.1.md.in Correct markdown in docs 2023-05-18 16:44:24 -07:00
podman-image-tree.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-image-trust.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-image-unmount.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-image.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-images.1.md.in Man pages: fix broken tables 2023-05-26 06:08:14 -06:00
podman-import.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-info.1.md libpod: Podman info output more network information 2023-06-13 11:19:29 +09:00
podman-init.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-inspect.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-kill.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-kube-apply.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-kube-down.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-kube-generate.1.md Add --podman-only flag to podman generate kube 2023-07-14 09:35:59 -04:00
podman-kube-play.1.md.in Add --no-trunc flag to maintain original annotation length 2023-07-10 18:02:53 -04:00
podman-kube.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-load.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-login.1.md.in Add secret support to podman login 2023-07-12 08:45:02 -04:00
podman-logout.1.md.in man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-logs.1.md.in Fix language, typos and markdown layout 2023-07-24 11:18:25 +02:00
podman-machine-info.1.md Add format to podman machine info 2023-03-15 16:15:59 -04:00
podman-machine-init.1.md.in Use bytes size consistently instead of human size 2023-07-06 14:51:06 +02:00
podman-machine-inspect.1.md Document podman-machine-default behavior 2023-05-15 14:23:17 -04:00
podman-machine-list.1.md.in Add user mode networking feature to Windows 2023-04-24 17:11:54 -05:00
podman-machine-os-apply.1.md Fix language, typos and markdown layout 2023-07-24 11:18:25 +02:00
podman-machine-os.1.md Introduce podman machine os apply 2023-02-15 14:48:12 -05:00
podman-machine-rm.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-machine-set.1.md.in man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-machine-ssh.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-machine-start.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-machine-stop.1.md Document podman-machine-default behavior 2023-05-15 14:23:17 -04:00
podman-machine.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-manifest-add.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-manifest-annotate.1.md.in Man pages: refactor common options: --annotation (manifest) 2022-10-12 08:54:04 -06:00
podman-manifest-create.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-manifest-exists.1.md source code comments and docs: fix typos, language, Markdown layout 2023-05-22 07:52:16 +02:00
podman-manifest-inspect.1.md.in manifest inspect: support authentication 2023-07-10 16:26:19 +02:00
podman-manifest-push.1.md.in Fix language, typos and markdown layout 2023-07-24 11:18:25 +02:00
podman-manifest-remove.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-manifest-rm.1.md Add links to all SEE ALSO sections 2021-11-10 09:29:21 -05:00
podman-manifest.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-mount.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-network-connect.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-network-create.1.md Fix language, typos and markdown layout 2023-07-24 11:18:25 +02:00
podman-network-disconnect.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-network-exists.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-network-inspect.1.md Add ability to set static routes 2023-06-12 10:31:59 +02:00
podman-network-ls.1.md.in Add ability to set static routes 2023-06-12 10:31:59 +02:00
podman-network-prune.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-network-reload.1.md.in Remove 'you' from man pages 2022-12-07 09:29:29 -05:00
podman-network-rm.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-network-update.1.md network: add support for podman network update and --network-dns-server 2023-01-12 20:19:14 +05:30
podman-network.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-pause.1.md.in filters: better handling of id= 2023-06-07 05:29:06 -06:00
podman-pod-clone.1.md.in man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-pod-create.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-pod-exists.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-pod-inspect.1.md.in Address review feedback and add manpage notes 2023-06-06 11:04:59 -04:00
podman-pod-kill.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-pod-logs.1.md.in man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-pod-pause.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-pod-prune.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-pod-ps.1.md.in filters: better handling of id= 2023-06-07 05:29:06 -06:00
podman-pod-restart.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-pod-rm.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-pod-start.1.md.in Remove 'you' from man pages 2022-12-07 09:29:29 -05:00
podman-pod-stats.1.md.in Remove 'you' from man pages 2022-12-07 09:29:29 -05:00
podman-pod-stop.1.md.in Remove 'you' from man pages 2022-12-07 09:29:29 -05:00
podman-pod-top.1.md.in top: do not depend on ps(1) in container 2023-07-10 13:32:55 +02:00
podman-pod-unpause.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-pod.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-port.1.md.in Remove 'you' from man pages 2022-12-07 09:29:29 -05:00
podman-ps.1.md filters: better handling of id= 2023-06-07 05:29:06 -06:00
podman-pull.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-push.1.md.in Fix language, typos and markdown layout 2023-07-24 11:18:25 +02:00
podman-remote.1.md Fix language, typos and markdown layout 2023-07-24 11:18:25 +02:00
podman-rename.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-restart.1.md.in filters: better handling of id= 2023-06-07 05:29:06 -06:00
podman-rm.1.md.in filters: better handling of id= 2023-06-07 05:29:06 -06:00
podman-rmi.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-run.1.md.in [CI:DOCS] Improve security in mysql examples 2023-05-17 19:44:05 +02:00
podman-save.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-search.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-secret-create.1.md Add secret support to podman login 2023-07-12 08:45:02 -04:00
podman-secret-exists.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-secret-inspect.1.md Display secret to user in inpspect 2023-06-28 13:14:49 -04:00
podman-secret-ls.1.md.in Display secret to user in inpspect 2023-06-28 13:14:49 -04:00
podman-secret-rm.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-secret.1.md Add support for secret exists 2023-04-03 15:33:50 +03:00
podman-start.1.md.in filters: better handling of id= 2023-06-07 05:29:06 -06:00
podman-stats.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-stop.1.md.in filters: better handling of id= 2023-06-07 05:29:06 -06:00
podman-system-connection-add.1.md Fix language, typos and markdown layout 2023-07-24 11:18:25 +02:00
podman-system-connection-default.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-system-connection-list.1.md man page --format xref: tighten the autocompletion check 2023-02-14 08:11:54 -07:00
podman-system-connection-remove.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-system-connection-rename.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-system-connection.1.md Fix language, typos and markdown layout 2023-07-24 11:18:25 +02:00
podman-system-df.1.md Add format to podman system df 2023-03-15 16:15:59 -04:00
podman-system-migrate.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-system-prune.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-system-renumber.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-system-reset.1.md system reset: show graphRoot/runRoot before removal 2023-04-26 16:02:59 +02:00
podman-system-service.1.md Ensure that we appropriately warn that TCP is insecure 2023-07-20 14:22:04 -04:00
podman-system.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-systemd.unit.5.md Merge pull request #19323 from eriksjolund/fix_language_typos_markdown_layout 2023-07-24 10:56:11 -04:00
podman-tag.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-top.1.md.in top: do not depend on ps(1) in container 2023-07-10 13:32:55 +02:00
podman-unmount.1.md.in Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-unpause.1.md.in filters: better handling of id= 2023-06-07 05:29:06 -06:00
podman-unshare.1.md [CI:DOCS] Add CNI deprecation notices to documentation 2023-01-19 08:09:32 -06:00
podman-untag.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-update.1.md.in man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-version.1.md [CI:DOCS] man pages: document some --format options 2022-09-15 09:59:32 -06:00
podman-volume-create.1.md source code comments and docs: fix typos, language, Markdown layout 2023-05-22 07:52:16 +02:00
podman-volume-exists.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-volume-export.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-volume-import.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-volume-inspect.1.md Address review feedback and add manpage notes 2023-06-06 11:04:59 -04:00
podman-volume-ls.1.md.in Add since as valid filter option for volume subcommands 2023-07-18 14:52:42 -04:00
podman-volume-mount.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-volume-prune.1.md Add since as valid filter option for volume subcommands 2023-07-18 14:52:42 -04:00
podman-volume-reload.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-volume-rm.1.md Remove future tense from man pages 2023-05-16 15:10:33 -04:00
podman-volume-unmount.1.md Fix manpage headers 2022-09-06 09:37:13 -07:00
podman-volume.1.md man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
podman-wait.1.md.in container wait: support health states 2023-06-23 14:16:32 +02:00
podman.1.md add a podman-compose command 2023-07-24 19:23:04 +02:00
podmansh.1.md Podmansh: Better error, increase timeout to 30s 2023-07-18 10:15:12 -04:00