aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-unpause.1.md.in
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-08-22 10:18:36 -0600
committerEd Santiago <santiago@redhat.com>2022-08-22 12:17:20 -0600
commit46f31361f88317d405d7f7b41c5d644328cd2e5b (patch)
tree3b9a4afd32e106865422d4f777689804454a29a3 /docs/source/markdown/podman-unpause.1.md.in
parentaefd0aed3990848e77b706d673c23108092594a0 (diff)
downloadpodman-46f31361f88317d405d7f7b41c5d644328cd2e5b.tar.gz
podman-46f31361f88317d405d7f7b41c5d644328cd2e5b.tar.bz2
podman-46f31361f88317d405d7f7b41c5d644328cd2e5b.zip
Man pages: refactor common options: --cidfile
There are two meanings: one writes a cidfile, the other reads. Split into two .md files. This can be reviewed with hack/markdown-preprocess-review . The main differences you'll see are all in cidfile.read: 1) I use the <<subcommand>> feature. This works nicely for kill, pause/unpause, and stop. It works less nicely for rm, because the man page will show "...and rm the container" (a human might prefer to see "REMOVE the container"). Given the benefit of this cleanup, I think this is a fine tradeoff. 2) I choose to include the "multiple times" text even on man pages where it wasn't present before. I tested to make sure it works. 3) The #### line I choose is IMHO the best one. Minor differences: * I believe the "remove the container" text in podman-kill and podman-stop is a copy/paste error. This PR fixes it. * The only differences between the cidfile.write texts is the #### line (my version is best) and a final period. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-unpause.1.md.in')
-rw-r--r--docs/source/markdown/podman-unpause.1.md.in83
1 files changed, 83 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-unpause.1.md.in b/docs/source/markdown/podman-unpause.1.md.in
new file mode 100644
index 000000000..7bd46e171
--- /dev/null
+++ b/docs/source/markdown/podman-unpause.1.md.in
@@ -0,0 +1,83 @@
+% podman-unpause(1)
+
+## NAME
+podman\-unpause - Unpause one or more containers
+
+## SYNOPSIS
+**podman unpause** [*options*]|[*container* ...]
+
+**podman container unpause** [*options*]|[*container* ...]
+
+## DESCRIPTION
+Unpauses the processes in one or more containers. You may use container IDs or names as input.
+
+## OPTIONS
+
+#### **--all**, **-a**
+
+Unpause all paused containers.
+
+@@option cidfile.read
+
+#### **--filter**, **-f**=*filter*
+
+Filter what containers unpause.
+Multiple filters can be given with multiple uses of the --filter flag.
+Filters with the same key work inclusive with the only exception being
+`label` which is exclusive. Filters with different keys always work exclusive.
+
+Valid filters are listed below:
+
+| **Filter** | **Description** |
+| --------------- | -------------------------------------------------------------------------------- |
+| id | [ID] Container's ID (accepts regex) |
+| name | [Name] Container's name (accepts regex) |
+| label | [Key] or [Key=Value] Label assigned to a container |
+| exited | [Int] Container's exit code |
+| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' |
+| ancestor | [ImageName] Image or descendant used to create container |
+| before | [ID] or [Name] Containers created before this container |
+| since | [ID] or [Name] Containers created since this container |
+| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
+| health | [Status] healthy or unhealthy |
+| pod | [Pod] name or full or partial ID of pod |
+| network | [Network] name or full ID of network |
+
+#### **--latest**, **-l**
+
+Instead of providing the container name or ID, use the last created container. If you use methods other than Podman
+to run containers such as CRI-O, the last started container could be from either of those methods. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
+
+## EXAMPLE
+
+Unpause container called 'mywebserver'
+```
+podman unpause mywebserver
+```
+
+Unpause container by a partial container ID.
+```
+podman unpause 860a4b23
+```
+
+Unpause all **paused** containers.
+```
+podman unpause --all
+```
+
+Unpause container using ID specified in a given files.
+```
+podman unpause --cidfile /home/user/cidfile-1
+podman unpause --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2
+```
+
+Unpause the latest container created by Podman.
+```
+podman unpause --latest
+```
+
+## SEE ALSO
+**[podman(1)](podman.1.md)**, **[podman-pause(1)](podman-pause.1.md)**
+
+## HISTORY
+September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>