Merge pull request #503 from siretart/manpage-fixes

storage: Cleanup manpage formatting

Author: mtrmac

storage/docs/containers-storage-add-names.md

@@ -1,7 +1,7 @@
 # containers-storage-add-names 1 "August 2016"
 
 ## NAME
-containers-storage add-names - Add names to a layer/image/container
+containers-storage-add-names - Add names to a layer/image/container
 
 ## SYNOPSIS
 **containers-storage** **add-names** [*options* [...]] *layerOrImageOrContainerNameOrID*
@@ -19,7 +19,13 @@ is already used by another layer, image, or container, it is removed from that
 other layer, image, or container.
 
 ## EXAMPLE
-**containers-storage add-names -n my-awesome-container -n my-for-realsies-awesome-container f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec**
+
+```
+containers-storage add-names \
+ -n my-awesome-container \
+ -n my-for-realsies-awesome-container \
+ f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec
+```
 
 ## SEE ALSO
 containers-storage-get-names(1)

storage/docs/containers-storage-applydiff-using-staging-dir.md

@@ -1,7 +1,7 @@
 # containers-storage-applydiff-using-staging-dir 1 "September 2023"
 
 ## NAME
-containers-storage applydiff-using-staging-dir - Apply a layer diff to a layer using a staging directory
+containers-storage-applydiff-using-staging-dir - Apply a layer diff to a layer using a staging directory
 
 ## SYNOPSIS
 **containers-storage** **applydiff-using-staging-dir** *layerNameOrID* *source*
@@ -18,7 +18,9 @@ Differently than **apply-diff**, the command **applydiff-using-staging-dir**
 first creates a staging directory and then moves the final result to the destination.
 
 ## EXAMPLE
-**containers-storage applydiff-using-staging-dir 5891b5b522 /path/to/diff**
+```
+containers-storage applydiff-using-staging-dir 5891b5b522 /path/to/diff
+```
 
 ## SEE ALSO
 containers-storage-apply-diff(1)

storage/docs/containers-storage-applydiff.md

@@ -1,7 +1,7 @@
 # containers-storage-apply-diff 1 "August 2016"
 
 ## NAME
-containers-storage apply-diff - Apply a layer diff to a layer
+containers-storage-apply-diff - Apply a layer diff to a layer
 
 ## SYNOPSIS
 **containers-storage** **apply-diff** [*options* [...]] *layerNameOrID* [*referenceLayerNameOrID*]
@@ -24,7 +24,8 @@ Specifies the name of a file from which the diff should be read.  If this
 option is not used, the diff is read from standard input.
 
 ## EXAMPLE
-**containers-storage apply-diff -f 71841c97e320d6cde.tar.gz layer1**
+
+    containers-storage apply-diff -f 71841c97e320d6cde.tar.gz layer1
 
 ## SEE ALSO
 containers-storage-changes(1)

storage/docs/containers-storage-changes.md

@@ -1,7 +1,7 @@
 # containers-storage-changes 1 "August 2016"
 
 ## NAME
-containers-storage changes - Produce a list of changes in a layer
+containers-storage-changes - Produce a list of changes in a layer
 
 ## SYNOPSIS
 **containers-storage** **changes** *layerNameOrID* [*referenceLayerNameOrID*]
@@ -13,7 +13,8 @@ obtain a summary of which files have been added, deleted, or modified in the
 layer.
 
 ## EXAMPLE
-**containers-storage changes f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec**
+
+    containers-storage changes f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec
 
 ## SEE ALSO
 containers-storage-applydiff(1)

storage/docs/containers-storage-check.md

@@ -1,7 +1,7 @@
 # containers-storage-check 1 "September 2022"
 
 ## NAME
-containers-storage check - Check for and remove damaged layers/images/containers
+containers-storage-check - Check for and remove damaged layers/images/containers
 
 ## SYNOPSIS
 **containers-storage** **check** [-q] [-r [-f]]
@@ -28,7 +28,8 @@ currently skips verifying that a layer which was initialized using a diff can
 reproduce that diff if asked to.
 
 ## EXAMPLE
-**containers-storage check -r -f
+
+    containers-storage check -r -f
 
 ## SEE ALSO
 containers-storage(1)

storage/docs/containers-storage-composefs.md

@@ -15,7 +15,8 @@ use_composefs = "true"
 This value must be a "string bool", it cannot be a native TOML boolean.
 
 However at the current time, composefs requires zstd:chunked images, so first
-you must be sure that zstd:chunked is enabled. For more, see [zstd:chunked](containers-storage-zstd-chunked.md).
+you must be sure that zstd:chunked is enabled.
+For more, see [zstd:chunked](containers-storage-zstd-chunked.md).
 
 Additionally, not many images are in zstd:chunked format. In order to bridge this gap,
 `convert_images = "true"` can be specified which does a dynamic conversion; this adds
@@ -37,10 +38,12 @@ is implemented as an "option" for the `overlay` driver. Some file formats
 remain unchanged and are inherited from the overlay driver, even when
 composefs is in use. The primary differences are enumerated below.
 
-The `diff/` directory for each layer is no longer a plain unpacking of the tarball,
-but becomes an "object hash directory", where each filename is the sha256 of its contents. This `diff/`
-directory is the backing store for a `composefs-data/composefs.blob` created for
-each layer which is the composefs "superblock" containing all the non-regular-file content (i.e. metadata) from the tarball.
+The `diff/` directory for each layer is no longer a plain unpacking of the
+tarball, but becomes an "object hash directory", where each filename is the
+sha256 of its contents. This `diff/` directory is the backing store for a
+`composefs-data/composefs.blob` created for each layer which is the composefs
+"superblock" containing all the non-regular-file content (i.e. metadata) from
+the tarball.
 
 As with `zstd:chunked`, existing layers are scanned for matching objects, and reused
 (via hardlink or reflink as configured) if objects with a matching "full sha256" are
@@ -59,7 +62,7 @@ in the "default overlay" (unpacked) format will be reused as is.
 
 ## BUGS
 
-- https://github.com/containers/storage/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Fcomposefs
+https://github.com/containers/storage/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Fcomposefs
 
 ## FOOTNOTES
 The Containers Storage project is committed to inclusivity, a core value of open source.

storage/docs/containers-storage-config.md

@@ -1,7 +1,7 @@
 # containers-storage-config 1 "November 2024"
 
 ## NAME
-containers-storage config - Output the configuration for the storage library
+containers-storage-config - Output the configuration for the storage library
 
 ## SYNOPSIS
 **containers-storage** **config** [configurationFile]
@@ -12,7 +12,9 @@ current configuration with the contents of a specified configuration file
 loaded in, in a JSON format.
 
 ## EXAMPLE
-**containers-storage config**
+
+    containers-storage config
+
 
 ## SEE ALSO
 containers-storage-version(1)

storage/docs/containers-storage-container.md

@@ -1,7 +1,7 @@
 # containers-storage-container 1 "August 2016"
 
 ## NAME
-containers-storage container - Examine a single container
+containers-storage-container - Examine a single container
 
 ## SYNOPSIS
 **containers-storage** **container** *containerNameOrID*
@@ -11,8 +11,9 @@ Retrieve information about a container: any names it has, which image was used
 to create it, any names that image has, and the ID of the container's layer.
 
 ## EXAMPLE
-**containers-storage container f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec**
-**containers-storage container my-awesome-container**
+
+    containers-storage container f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec
+    containers-storage container my-awesome-container
 
 ## SEE ALSO
 containers-storage-containers(1)

storage/docs/containers-storage-containers.md

@@ -1,7 +1,7 @@
 # containers-storage-containers 1 "August 2016"
 
 ## NAME
-containers-storage containers - List known containers
+containers-storage-containers - List known containers
 
 ## SYNOPSIS
 **containers-storage** **containers**
@@ -10,7 +10,8 @@ containers-storage containers - List known containers
 Retrieves information about all known containers and lists their IDs and names.
 
 ## EXAMPLE
-**containers-storage containers**
+
+    containers-storage containers
 
 ## SEE ALSO
 containers-storage-container(1)

storage/docs/containers-storage-copy.md

@@ -1,7 +1,7 @@
 # containers-storage-copy 1 "April 2018"
 
 ## NAME
-containers-storage copy - Copy content into a layer
+containers-storage-copy - Copy content into a layer
 
 ## SYNOPSIS
 **containers-storage** **copy** [--chown UID[:GID]] [*sourceLayerNameOrID*:]/path [...] *targetLayerNameOrID*:/path
@@ -17,7 +17,8 @@ specified, the UID is used.  The owner IDs are mapped as appropriate for the
 target layer.
 
 ## EXAMPLE
-**containers-storage copy layer-with-mapping:/root/config.txt layer-with-different-mapping:/root/config.txt**
+
+    containers-storage copy layer-with-mapping:/root/config.txt layer-with-different-mapping:/root/config.txt
 
 ## SEE ALSO
 containers-storage(1)