mirror of https://github.com/containers/podman.git
Merge pull request #8036 from xordspar0/heading-consistency
[CI:DOCS] Make man page headings more consistent
This commit is contained in:
commit
28d331d074
|
|
@ -17,7 +17,7 @@ was an issue accessing the local storage.
|
||||||
**-h**, **--help**
|
**-h**, **--help**
|
||||||
Print usage statement
|
Print usage statement
|
||||||
|
|
||||||
## Examples
|
## EXAMPLES
|
||||||
|
|
||||||
Check if an container called `webclient` exists in local storage (the container does actually exist).
|
Check if an container called `webclient` exists in local storage (the container does actually exist).
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ Do not provide an interactive prompt for container removal.
|
||||||
|
|
||||||
Print usage statement
|
Print usage statement
|
||||||
|
|
||||||
## Examples
|
## EXAMPLES
|
||||||
|
|
||||||
Remove all stopped containers from local storage
|
Remove all stopped containers from local storage
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -40,7 +40,7 @@ is used.
|
||||||
|
|
||||||
Any additional arguments will be appended to the command.
|
Any additional arguments will be appended to the command.
|
||||||
|
|
||||||
## OPTIONS:
|
## OPTIONS
|
||||||
**--authfile**=*path*
|
**--authfile**=*path*
|
||||||
|
|
||||||
Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
|
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,
|
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)
|
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.
|
Execute the run label of an image called foobar.
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -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).
|
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**
|
**--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
|
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.
|
random port is assigned by Podman in the specification.
|
||||||
|
|
||||||
## Examples
|
## EXAMPLES
|
||||||
|
|
||||||
Create Kubernetes Pod YAML for a container called `some-mariadb` .
|
Create Kubernetes Pod YAML for a container called `some-mariadb` .
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -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._
|
_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**
|
**--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 *-*.
|
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
|
### Generate and print a systemd unit file for a container
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -18,7 +18,7 @@ was an issue accessing the local storage.
|
||||||
|
|
||||||
Print usage statement
|
Print usage statement
|
||||||
|
|
||||||
## Examples
|
## EXAMPLES
|
||||||
|
|
||||||
Check if an image called `webclient` exists in local storage (the image does actually exist).
|
Check if an image called `webclient` exists in local storage (the image does actually exist).
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -30,7 +30,7 @@ Do not provide an interactive prompt for container removal.
|
||||||
|
|
||||||
Print usage statement
|
Print usage statement
|
||||||
|
|
||||||
## Examples ##
|
## EXAMPLES
|
||||||
|
|
||||||
Remove all dangling images from local storage
|
Remove all dangling images from local storage
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -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)
|
Note: HostPath volume types created by play kube will be given an SELinux private label (Z)
|
||||||
|
|
||||||
## OPTIONS:
|
## OPTIONS
|
||||||
|
|
||||||
**--authfile**=*path*
|
**--authfile**=*path*
|
||||||
|
|
||||||
|
|
@ -64,7 +64,7 @@ TLS verification will be used unless the target registry is listed as an insecur
|
||||||
|
|
||||||
Print usage statement
|
Print usage statement
|
||||||
|
|
||||||
## Examples
|
## EXAMPLES
|
||||||
|
|
||||||
Recreate the pod and containers as described in a file called `demo.yml`
|
Recreate the pod and containers as described in a file called `demo.yml`
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -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
|
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.
|
was an issue accessing the local storage.
|
||||||
|
|
||||||
## Examples ##
|
## EXAMPLES
|
||||||
|
|
||||||
Check if a pod called `web` exists in local storage (the pod does actually exist).
|
Check if a pod called `web` exists in local storage (the pod does actually exist).
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -30,7 +30,7 @@ Restart all containers that are already in the *running* state.
|
||||||
Timeout to wait before forcibly stopping the container.
|
Timeout to wait before forcibly stopping the container.
|
||||||
|
|
||||||
|
|
||||||
## EXAMPLES ##
|
## EXAMPLES
|
||||||
|
|
||||||
Restart the latest container
|
Restart the latest container
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue