1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
.TH PODMAN-COMPOSE "1" "User Commands"
.SH NAME
podman-compose \- Define and run multi-container applications with Podman.
.SH DESCRIPTION
podman-compose [OPTIONS] COMMAND [ARG...]
.SH OPTIONS
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-version\fR
show version
.TP
\fB\-\-in\-pod\fR in_pod
pod creation
.TP
\fB\-\-pod\-args\fR pod_args
custom arguments to be passed to `podman pod`
.TP
\fB\-\-env\-file\fR env_file
Specify an alternate environment file
.TP
\fB\-f\fR file, \fB\-\-file\fR file
Specify an compose file (default: docker\-compose.yml) or '\-' to read from stdin.
.TP
\fB\-\-profile\fR profile
Specify a profile to enable
.TP
\fB\-p\fR PROJECT_NAME, \fB\-\-project\-name\fR PROJECT_NAME
Specify an alternate project name (default: directory name)
.TP
\fB\-\-podman\-path\fR PODMAN_PATH
Specify an alternate path to podman (default: use location in $PATH variable)
.TP
\fB\-\-podman\-args\fR args
custom global arguments to be passed to `podman`
.TP
\fB\-\-podman\-pull\-args\fR args
custom arguments to be passed to `podman pull`
.TP
\fB\-\-podman\-push\-args\fR args
custom arguments to be passed to `podman push`
.TP
\fB\-\-podman\-build\-args\fR args
custom arguments to be passed to `podman build`
.TP
\fB\-\-podman\-inspect\-args\fR args
custom arguments to be passed to `podman inspect`
.TP
\fB\-\-podman\-run\-args\fR args
custom arguments to be passed to `podman run`
.TP
\fB\-\-podman\-start\-args\fR args
custom arguments to be passed to `podman start`
.TP
\fB\-\-podman\-stop\-args\fR args
custom arguments to be passed to `podman stop`
.TP
\fB\-\-podman\-rm\-args\fR args
custom arguments to be passed to `podman rm`
.TP
\fB\-\-podman\-volume\-args\fR args
custom arguments to be passed to `podman volume`
.TP
\fB\-\-no\-ansi\fR
Do not print ANSI control characters
.TP
\fB\-\-no\-cleanup\fR
Do not stop and remove existing pod & containers
.TP
\fB\-\-dry\-run\fR
No action; perform a simulation of commands
.HP
\fB\-\-parallel\fR PARALLEL
.TP
\fB\-\-verbose\fR
Print debugging output
.SH COMMANDS
.SS help
show help
.SS version
show version
.SS wait
wait running containers to stop
.SS systemd
create systemd unit file and register its compose stacks
.TP
When first installed type `sudo podman\-compose systemd \fB\-a\fR create\-unit`
later you can add a compose stack by running `podman\-compose systemd \fB\-a\fR register`
then you can start/stop your stack with `systemctl \fB\-\-user\fR start podman\-compose@<PROJ>`
.SS pull
pull stack images
.SS push
push stack images
.SS build
build stack images
.SS up
Create and start the entire stack or some of its services
.SS down
tear down entire stack
.SS ps
show status of containers
.SS run
create a container similar to a service to run a one\-off command
.SS exec
execute a command in a running container
.SS start
start specific services
.SS stop
stop specific services
.SS restart
restart specific services
.SS logs
show logs from services
.SS config
displays the compose file
.SS port
Prints the public port for a port binding.
.SS pause
Pause all running containers
.SS unpause
Unpause all running containers
.SS kill
Kill one or more running containers with a specific signal
.SS stats
Display percentage of CPU, memory, network I/O, block I/O and PIDs for services.
.SS images
List images used by the created containers
.SH AUTHOR
This manual page was written by Athos Ribeiro <athos@debian.org> based on the help2man output.
|
