From d1187be8a34fea290b666d96c8bb6a54ab7ce56a Mon Sep 17 00:00:00 2001 From: Matt Heon Date: Thu, 12 Jun 2025 02:22:42 -0400 Subject: [PATCH] Bunch of trivial manpage fixes In a lot of places, `Example` -> `Examples` for consistency Plus similar trivial fixes Signed-off-by: Matt Heon --- .../markdown/podman-container-diff.1.md.in | 2 +- .../markdown/podman-container-inspect.1.md.in | 2 +- .../markdown/podman-container-restore.1.md | 2 +- docs/source/markdown/podman-diff.1.md.in | 2 +- docs/source/markdown/podman-farm-create.1.md | 8 +++----- docs/source/markdown/podman-image-diff.1.md | 2 +- docs/source/markdown/podman-image-mount.1.md | 2 +- docs/source/markdown/podman-images.1.md.in | 2 +- docs/source/markdown/podman-inspect.1.md.in | 2 +- docs/source/markdown/podman-load.1.md | 7 ------- docs/source/markdown/podman-manifest-add.1.md.in | 2 +- .../markdown/podman-manifest-annotate.1.md.in | 2 +- .../markdown/podman-manifest-inspect.1.md.in | 1 + .../source/markdown/podman-manifest-push.1.md.in | 2 +- docs/source/markdown/podman-manifest-rm.1.md | 16 +++++++--------- docs/source/markdown/podman-mount.1.md.in | 2 +- docs/source/markdown/podman-network-connect.1.md | 2 +- docs/source/markdown/podman-network-create.1.md | 2 +- docs/source/markdown/podman-network-rm.1.md | 2 +- docs/source/markdown/podman-pod-stats.1.md.in | 2 +- docs/source/markdown/podman-ps.1.md | 3 --- docs/source/markdown/podman-push.1.md.in | 2 +- docs/source/markdown/podman-rm.1.md.in | 2 +- docs/source/markdown/podman-rmi.1.md | 2 ++ docs/source/markdown/podman-save.1.md.in | 6 ------ docs/source/markdown/podman-search.1.md.in | 1 - 26 files changed, 31 insertions(+), 49 deletions(-) diff --git a/docs/source/markdown/podman-container-diff.1.md.in b/docs/source/markdown/podman-container-diff.1.md.in index d66d65644e..8d42518a49 100644 --- a/docs/source/markdown/podman-container-diff.1.md.in +++ b/docs/source/markdown/podman-container-diff.1.md.in @@ -25,7 +25,7 @@ Alter the output into a different format. The only valid format for **podman con @@option latest -## EXAMPLE +## EXAMPLES ``` # podman container diff container1 diff --git a/docs/source/markdown/podman-container-inspect.1.md.in b/docs/source/markdown/podman-container-inspect.1.md.in index cda408a15d..354f07df38 100644 --- a/docs/source/markdown/podman-container-inspect.1.md.in +++ b/docs/source/markdown/podman-container-inspect.1.md.in @@ -76,7 +76,7 @@ Valid placeholders for the Go template are listed below: In addition to normal output, display the total file size if the type is a container. -## EXAMPLE +## EXAMPLES Inspect the specified container and print its information in json format. ``` diff --git a/docs/source/markdown/podman-container-restore.1.md b/docs/source/markdown/podman-container-restore.1.md index 2cbb4c46f7..cc50e2be69 100644 --- a/docs/source/markdown/podman-container-restore.1.md +++ b/docs/source/markdown/podman-container-restore.1.md @@ -159,7 +159,7 @@ option is ignored. Defaults to not restoring *containers* with established TCP connections.\ The default is **false**. -## EXAMPLE +## EXAMPLES Restore the container "mywebserver". ``` # podman container restore mywebserver diff --git a/docs/source/markdown/podman-diff.1.md.in b/docs/source/markdown/podman-diff.1.md.in index 694d488a86..2d7d51abff 100644 --- a/docs/source/markdown/podman-diff.1.md.in +++ b/docs/source/markdown/podman-diff.1.md.in @@ -25,7 +25,7 @@ Alter the output into a different format. The only valid format for **podman di @@option latest -## EXAMPLE +## EXAMPLES Show container-modified files versus the container's image: ``` diff --git a/docs/source/markdown/podman-farm-create.1.md b/docs/source/markdown/podman-farm-create.1.md index 4ab7111ddf..63a6f39c99 100644 --- a/docs/source/markdown/podman-farm-create.1.md +++ b/docs/source/markdown/podman-farm-create.1.md @@ -13,16 +13,14 @@ Create a new farm with connections that Podman knows about which were added via An empty farm can be created without adding any connections to it. Add or remove connections from a farm via the *podman farm update* command. -## EXAMPLE +## EXAMPLES - - -Create the specified farm: +Create the specified farm with no connections: ``` $ podman farm create farm2 ``` -Create multiple farms: +Create a farm with connections: ``` $ podman farm create farm1 f37 f38 ``` diff --git a/docs/source/markdown/podman-image-diff.1.md b/docs/source/markdown/podman-image-diff.1.md index 7330111004..85e68de74f 100644 --- a/docs/source/markdown/podman-image-diff.1.md +++ b/docs/source/markdown/podman-image-diff.1.md @@ -23,7 +23,7 @@ The output is prefixed with the following symbols: Alter the output into a different format. The only valid format for **podman image diff** is `json`. -## EXAMPLE +## EXAMPLES Display image differences from images parent layer: ``` diff --git a/docs/source/markdown/podman-image-mount.1.md b/docs/source/markdown/podman-image-mount.1.md index 7df0eec415..cd86bca417 100644 --- a/docs/source/markdown/podman-image-mount.1.md +++ b/docs/source/markdown/podman-image-mount.1.md @@ -30,7 +30,7 @@ Mount all images. Print the mounted images in specified format (json). -## EXAMPLE +## EXAMPLES Mount multiple images. Note: In rootless mode, image mounting works only after executing the podman unshare command to enter the user namespace. ``` diff --git a/docs/source/markdown/podman-images.1.md.in b/docs/source/markdown/podman-images.1.md.in index 6c26107105..2072d84741 100644 --- a/docs/source/markdown/podman-images.1.md.in +++ b/docs/source/markdown/podman-images.1.md.in @@ -119,7 +119,7 @@ Lists only the image IDs. Sort by *created*, *id*, *repository*, *size* or *tag* (default: **created**) When sorting by *repository* it also sorts by the *tag* as second criteria to provide a stable output. -## EXAMPLE +## EXAMPLES List all non-dangling images in local storage: ``` diff --git a/docs/source/markdown/podman-inspect.1.md.in b/docs/source/markdown/podman-inspect.1.md.in index bc3dbcdb1a..587b6d3e5e 100644 --- a/docs/source/markdown/podman-inspect.1.md.in +++ b/docs/source/markdown/podman-inspect.1.md.in @@ -38,7 +38,7 @@ In addition to normal output, display the total file size if the type is a conta Return JSON for the specified type. Type can be 'container', 'image', 'volume', 'network', 'pod', or 'all' (default: all) (Only meaningful when invoked as *podman inspect*) -## EXAMPLE +## EXAMPLES Inspect the fedora image: ``` diff --git a/docs/source/markdown/podman-load.1.md b/docs/source/markdown/podman-load.1.md index 0d097e0afd..0b0672f335 100644 --- a/docs/source/markdown/podman-load.1.md +++ b/docs/source/markdown/podman-load.1.md @@ -17,13 +17,6 @@ The local client further supports loading an **oci-dir** or a **docker-dir** as The **quiet** option suppresses the progress output when set. Note: `:` is a restricted character and cannot be part of the file name. - -**podman [GLOBAL OPTIONS]** - -**podman load [GLOBAL OPTIONS]** - -**podman load [OPTIONS]** - ## OPTIONS #### **--help**, **-h** diff --git a/docs/source/markdown/podman-manifest-add.1.md.in b/docs/source/markdown/podman-manifest-add.1.md.in index db02b00c05..6f6f511927 100644 --- a/docs/source/markdown/podman-manifest-add.1.md.in +++ b/docs/source/markdown/podman-manifest-add.1.md.in @@ -139,7 +139,7 @@ configuration information. $ podman manifest add oci-archive:/tmp/myimage -## EXAMPLE +## EXAMPLES Add specified default image from source manifest list to destination manifest list: ``` diff --git a/docs/source/markdown/podman-manifest-annotate.1.md.in b/docs/source/markdown/podman-manifest-annotate.1.md.in index 38a186aeee..7f12cdfc10 100644 --- a/docs/source/markdown/podman-manifest-annotate.1.md.in +++ b/docs/source/markdown/podman-manifest-annotate.1.md.in @@ -50,7 +50,7 @@ associated with, at most, one subject. @@option variant.manifest -## EXAMPLE +## EXAMPLES Update arch and variant information to specified manifest list for image: ``` diff --git a/docs/source/markdown/podman-manifest-inspect.1.md.in b/docs/source/markdown/podman-manifest-inspect.1.md.in index fe0f2e3e97..cbf676eef7 100644 --- a/docs/source/markdown/podman-manifest-inspect.1.md.in +++ b/docs/source/markdown/podman-manifest-inspect.1.md.in @@ -9,6 +9,7 @@ podman\-manifest\-inspect - Display a manifest list or image index ## DESCRIPTION Displays the manifest list or image index stored using the specified image name. + ## RETURN VALUE A formatted JSON representation of the manifest list or image index. diff --git a/docs/source/markdown/podman-manifest-push.1.md.in b/docs/source/markdown/podman-manifest-push.1.md.in index c755fb02a4..47ced3c1b6 100644 --- a/docs/source/markdown/podman-manifest-push.1.md.in +++ b/docs/source/markdown/podman-manifest-push.1.md.in @@ -78,7 +78,7 @@ Sign the pushed images with a sigstore signature using a private key at the spec DESTINATION is the location the container image is pushed to. It supports all transports from `containers-transports(5)`. If no transport is specified, the `docker` (i.e., container registry) transport is used. For remote clients, including Mac and Windows (excluding WSL2) machines, `docker` is the only supported transport. -## EXAMPLE +## EXAMPLES Push manifest list to container registry: ``` diff --git a/docs/source/markdown/podman-manifest-rm.1.md b/docs/source/markdown/podman-manifest-rm.1.md index 0613db19fa..ed9125739d 100644 --- a/docs/source/markdown/podman-manifest-rm.1.md +++ b/docs/source/markdown/podman-manifest-rm.1.md @@ -15,17 +15,15 @@ Removes one or more locally stored manifest lists. If a specified manifest does not exist in the local storage, ignore it and do not throw an error. -## EXAMPLE +## EXAMPLES -podman manifest rm `` +``` +podman manifest rm listid +``` -podman manifest rm listid1 listid2 - -**storage.conf** (`/etc/containers/storage.conf`) - -storage.conf is the storage configuration file for all tools using containers/storage - -The storage configuration file specifies all of the available container storage options for tools using shared container storage. +``` +podman manifest rm --ignore listid1 listid2 +``` ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-manifest(1)](podman-manifest.1.md)**, **[containers-storage.conf(5)](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md)** diff --git a/docs/source/markdown/podman-mount.1.md.in b/docs/source/markdown/podman-mount.1.md.in index 48e6ce4c8d..882a6b93eb 100644 --- a/docs/source/markdown/podman-mount.1.md.in +++ b/docs/source/markdown/podman-mount.1.md.in @@ -39,7 +39,7 @@ Print the mounted containers in specified format (json). Do not truncate the output (default *false*). -## EXAMPLE +## EXAMPLES In rootful mode, Mount specified container. ``` diff --git a/docs/source/markdown/podman-network-connect.1.md b/docs/source/markdown/podman-network-connect.1.md index b1b2251539..efa1502744 100644 --- a/docs/source/markdown/podman-network-connect.1.md +++ b/docs/source/markdown/podman-network-connect.1.md @@ -26,7 +26,7 @@ Set a static ipv6 address for this container on this network. #### **--mac-address**=*address* Set a static mac address for this container on this network. -## EXAMPLE +## EXAMPLES Connect specified container to a named network: ``` diff --git a/docs/source/markdown/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md index 1a7511f12c..d96319c678 100644 --- a/docs/source/markdown/podman-network-create.1.md +++ b/docs/source/markdown/podman-network-create.1.md @@ -151,7 +151,7 @@ The subnet in CIDR notation. Can be specified multiple times to allocate more th The argument order of the **--subnet**, **--gateway** and **--ip-range** options must match. This is useful to set a static ipv4 and ipv6 subnet. -## EXAMPLE +## EXAMPLES Create a network with no options. ``` diff --git a/docs/source/markdown/podman-network-rm.1.md b/docs/source/markdown/podman-network-rm.1.md index 788eca6ea8..17772ef2da 100644 --- a/docs/source/markdown/podman-network-rm.1.md +++ b/docs/source/markdown/podman-network-rm.1.md @@ -19,7 +19,7 @@ running, the container is stopped and removed. Seconds to wait before forcibly stopping the running containers that are using the specified network. The --force option must be specified to use the --time option. Use -1 for infinite wait. -## EXAMPLE +## EXAMPLES Delete specified network: ``` diff --git a/docs/source/markdown/podman-pod-stats.1.md.in b/docs/source/markdown/podman-pod-stats.1.md.in index c9ebde8aeb..943e36c8cd 100644 --- a/docs/source/markdown/podman-pod-stats.1.md.in +++ b/docs/source/markdown/podman-pod-stats.1.md.in @@ -42,7 +42,7 @@ When using a Go template, precede the format with `table` to print headers. @@option no-stream -## EXAMPLE +## EXAMPLES List statistics about all pods without streaming: ``` diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md index 4689c9860d..a78b743c55 100644 --- a/docs/source/markdown/podman-ps.1.md +++ b/docs/source/markdown/podman-ps.1.md @@ -213,9 +213,6 @@ fd7b786b5c32 docker.io/library/alpine:latest buildah 2 hours ago storage f78620804e00 scratch buildah 2 hours ago storage working-container ``` -## ps -Print a list of containers - ## SEE ALSO **[podman(1)](podman.1.md)**, **[buildah(1)](https://github.com/containers/buildah/blob/main/docs/buildah.1.md)**, **[crio(8)](https://github.com/cri-o/cri-o/blob/main/docs/crio.8.md)** diff --git a/docs/source/markdown/podman-push.1.md.in b/docs/source/markdown/podman-push.1.md.in index f22aab8ec0..093182f048 100644 --- a/docs/source/markdown/podman-push.1.md.in +++ b/docs/source/markdown/podman-push.1.md.in @@ -102,7 +102,7 @@ Add a sigstore signature at the destination using a private key at the specified @@option tls-verify -## EXAMPLE +## EXAMPLES Push the specified image to a local directory: ``` diff --git a/docs/source/markdown/podman-rm.1.md.in b/docs/source/markdown/podman-rm.1.md.in index 3c3e798fce..b4dfc9f663 100644 --- a/docs/source/markdown/podman-rm.1.md.in +++ b/docs/source/markdown/podman-rm.1.md.in @@ -75,7 +75,7 @@ The --force option must be specified to use the --time option. Remove anonymous volumes associated with the container. This does not include named volumes created with **podman volume create**, or the **--volume** option of **podman run** and **podman create**. -## EXAMPLE +## EXAMPLES Remove container with a given name: ``` $ podman rm mywebserver diff --git a/docs/source/markdown/podman-rmi.1.md b/docs/source/markdown/podman-rmi.1.md index 4f07531c6f..e18435976d 100644 --- a/docs/source/markdown/podman-rmi.1.md +++ b/docs/source/markdown/podman-rmi.1.md @@ -32,6 +32,8 @@ If a specified image does not exist in the local storage, ignore it and do not t This option does not remove dangling parents of the specified image. +## EXAMPLES + Remove an image by its short ID ``` $ podman rmi c0ed59d05ff7 diff --git a/docs/source/markdown/podman-save.1.md.in b/docs/source/markdown/podman-save.1.md.in index 342c39718f..e5e96299f8 100644 --- a/docs/source/markdown/podman-save.1.md.in +++ b/docs/source/markdown/podman-save.1.md.in @@ -16,12 +16,6 @@ file using the **output** flag. The **quiet** flag suppresses the output when se To export the containers, use the **podman export**. Note: `:` is a restricted character and cannot be part of the file name. -**podman [GLOBAL OPTIONS]** - -**podman save [GLOBAL OPTIONS]** - -**podman save [OPTIONS] NAME[:TAG]** - ## OPTIONS @@option dir-compress diff --git a/docs/source/markdown/podman-search.1.md.in b/docs/source/markdown/podman-search.1.md.in index 9c171194d3..f999e6f728 100644 --- a/docs/source/markdown/podman-search.1.md.in +++ b/docs/source/markdown/podman-search.1.md.in @@ -98,7 +98,6 @@ Do not truncate the output (default *false*). Search for images containing the specified name, returning the first three images from each defined registry. ``` $ podman search --limit 3 fedora -NAME DESCRIPTION NAME DESCRIPTION registry.fedoraproject.org/f29/fedora-toolbox registry.fedoraproject.org/f30/fedora-toolbox