summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Christiansen <xordspar0@gmail.com>2020-10-15 10:24:16 -0500
committerJordan Christiansen <xordspar0@gmail.com>2020-10-16 15:06:33 -0500
commit88bc133dac15faec73dfdaffc9d9de21790e3d36 (patch)
tree0f583290d533aa48a1b6e41c61abd31d40887ca7
parent9f98b3447c7a1c34d328a387993722e4e7113cd2 (diff)
downloadpodman-88bc133dac15faec73dfdaffc9d9de21790e3d36.tar.gz
podman-88bc133dac15faec73dfdaffc9d9de21790e3d36.tar.bz2
podman-88bc133dac15faec73dfdaffc9d9de21790e3d36.zip
Make man page headings more consistent
Signed-off-by: Jordan Christiansen <xordspar0@gmail.com>
-rw-r--r--docs/source/markdown/podman-container-exists.1.md2
-rw-r--r--docs/source/markdown/podman-container-prune.1.md2
-rw-r--r--docs/source/markdown/podman-container-runlabel.1.md4
-rw-r--r--docs/source/markdown/podman-generate-kube.1.md4
-rw-r--r--docs/source/markdown/podman-generate-systemd.1.md4
-rw-r--r--docs/source/markdown/podman-image-exists.1.md2
-rw-r--r--docs/source/markdown/podman-image-prune.1.md2
-rw-r--r--docs/source/markdown/podman-play-kube.1.md4
-rw-r--r--docs/source/markdown/podman-pod-exists.1.md2
-rw-r--r--docs/source/markdown/podman-restart.1.md2
10 files changed, 14 insertions, 14 deletions
diff --git a/docs/source/markdown/podman-container-exists.1.md b/docs/source/markdown/podman-container-exists.1.md
index d24df2fc8..3cc13e73a 100644
--- a/docs/source/markdown/podman-container-exists.1.md
+++ b/docs/source/markdown/podman-container-exists.1.md
@@ -17,7 +17,7 @@ was an issue accessing the local storage.
**-h**, **--help**
Print usage statement
-## Examples
+## EXAMPLES
Check if an container called `webclient` exists in local storage (the container does actually exist).
```
diff --git a/docs/source/markdown/podman-container-prune.1.md b/docs/source/markdown/podman-container-prune.1.md
index 8c05eeafe..d56a1e7f5 100644
--- a/docs/source/markdown/podman-container-prune.1.md
+++ b/docs/source/markdown/podman-container-prune.1.md
@@ -23,7 +23,7 @@ Do not provide an interactive prompt for container removal.
Print usage statement
-## Examples
+## EXAMPLES
Remove all stopped containers from local storage
```
diff --git a/docs/source/markdown/podman-container-runlabel.1.md b/docs/source/markdown/podman-container-runlabel.1.md
index 2abbf0b7f..f56fc7d7b 100644
--- a/docs/source/markdown/podman-container-runlabel.1.md
+++ b/docs/source/markdown/podman-container-runlabel.1.md
@@ -40,7 +40,7 @@ is used.
Any additional arguments will be appended to the command.
-## OPTIONS:
+## OPTIONS
**--authfile**=*path*
Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
@@ -87,7 +87,7 @@ Require HTTPS and verify certificates when contacting registries (default: true)
then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified,
TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf (Not available for remote commands)
-## Examples
+## EXAMPLES
Execute the run label of an image called foobar.
```
diff --git a/docs/source/markdown/podman-generate-kube.1.md b/docs/source/markdown/podman-generate-kube.1.md
index f4b4cd482..47d6e0445 100644
--- a/docs/source/markdown/podman-generate-kube.1.md
+++ b/docs/source/markdown/podman-generate-kube.1.md
@@ -12,7 +12,7 @@ of a pod or container name or ID.
Note that the generated Kubernetes YAML file can be used to re-run the deployment via podman-play-kube(1).
-## OPTIONS:
+## OPTIONS
**--filename**, **-f**=**filename**
@@ -23,7 +23,7 @@ Output to the given file, instead of STDOUT. If the file already exists, `genera
Generate a Kubernetes service object in addition to the Pods. Used to generate a Service specification for the corresponding Pod output. In particular, if the object has portmap bindings, the service specification will include a NodePort declaration to expose the service. A
random port is assigned by Podman in the specification.
-## Examples
+## EXAMPLES
Create Kubernetes Pod YAML for a container called `some-mariadb` .
```
diff --git a/docs/source/markdown/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md
index af8ea3c39..f95c57399 100644
--- a/docs/source/markdown/podman-generate-systemd.1.md
+++ b/docs/source/markdown/podman-generate-systemd.1.md
@@ -12,7 +12,7 @@ By default, the command will print the content of the unit files to stdout.
_Note: If you use this command with the remote client, you would still have to place the generated units on the remote system._
-## OPTIONS:
+## OPTIONS
**--files**, **-f**
@@ -53,7 +53,7 @@ Set the systemd unit name prefix for pods. The default is *pod*.
Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is *-*.
-## Examples
+## EXAMPLES
### Generate and print a systemd unit file for a container
diff --git a/docs/source/markdown/podman-image-exists.1.md b/docs/source/markdown/podman-image-exists.1.md
index 59f2145cc..877324cd1 100644
--- a/docs/source/markdown/podman-image-exists.1.md
+++ b/docs/source/markdown/podman-image-exists.1.md
@@ -18,7 +18,7 @@ was an issue accessing the local storage.
Print usage statement
-## Examples
+## EXAMPLES
Check if an image called `webclient` exists in local storage (the image does actually exist).
```
diff --git a/docs/source/markdown/podman-image-prune.1.md b/docs/source/markdown/podman-image-prune.1.md
index cf9e50366..d4fbe45c3 100644
--- a/docs/source/markdown/podman-image-prune.1.md
+++ b/docs/source/markdown/podman-image-prune.1.md
@@ -30,7 +30,7 @@ Do not provide an interactive prompt for container removal.
Print usage statement
-## Examples ##
+## EXAMPLES
Remove all dangling images from local storage
```
diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md
index 519b153f4..00ee7c1df 100644
--- a/docs/source/markdown/podman-play-kube.1.md
+++ b/docs/source/markdown/podman-play-kube.1.md
@@ -15,7 +15,7 @@ Ideally the input file would be one created by Podman (see podman-generate-kube(
Note: HostPath volume types created by play kube will be given an SELinux private label (Z)
-## OPTIONS:
+## OPTIONS
**--authfile**=*path*
@@ -64,7 +64,7 @@ TLS verification will be used unless the target registry is listed as an insecur
Print usage statement
-## Examples
+## EXAMPLES
Recreate the pod and containers as described in a file called `demo.yml`
```
diff --git a/docs/source/markdown/podman-pod-exists.1.md b/docs/source/markdown/podman-pod-exists.1.md
index cf2852934..4c8714341 100644
--- a/docs/source/markdown/podman-pod-exists.1.md
+++ b/docs/source/markdown/podman-pod-exists.1.md
@@ -12,7 +12,7 @@ of the pod may be used as input. Podman will return an exit code
of `0` when the pod is found. A `1` will be returned otherwise. An exit code of `125` indicates there
was an issue accessing the local storage.
-## Examples ##
+## EXAMPLES
Check if a pod called `web` exists in local storage (the pod does actually exist).
```
diff --git a/docs/source/markdown/podman-restart.1.md b/docs/source/markdown/podman-restart.1.md
index 87217f096..127aaa074 100644
--- a/docs/source/markdown/podman-restart.1.md
+++ b/docs/source/markdown/podman-restart.1.md
@@ -30,7 +30,7 @@ Restart all containers that are already in the *running* state.
Timeout to wait before forcibly stopping the container.
-## EXAMPLES ##
+## EXAMPLES
Restart the latest container
```