Add command aliases to SYNOPSIS section

The files under docs/links reference another man page, e.g.
`man podman-container-list` displays `podman-ps(1)`. This adds
the alias to the in the displayed page's SYNOPSIS section.

Signed-off-by: Ryan Whalen <rj.whalen@gmail.com>
This commit is contained in:
Ryan Whalen 2019-08-31 16:58:52 -04:00
parent d266dbea15
commit 09f373283a
31 changed files with 75 additions and 0 deletions

View File

@ -6,6 +6,8 @@ podman\-attach - Attach to a running container
## SYNOPSIS
**podman attach** [*options*] *container*
**podman container attach** [*options*] *container*
## DESCRIPTION
The attach command allows you to attach to a running container using the container's ID
or name, either to view its ongoing output or to control it interactively.

View File

@ -6,6 +6,8 @@ podman\-build - Build a container image using a Dockerfile
## SYNOPSIS
**podman build** [*options*] *context*
**podman image build** [*options*] *context*
## DESCRIPTION
**podman build** Builds an image using instructions from one or more Dockerfiles and a specified build context directory.

View File

@ -6,6 +6,8 @@ podman\-commit - Create new image based on the changed container
## SYNOPSIS
**podman commit** [*options*] *container* *image*
**podman container commit** [*options*] *container* *image*
## DESCRIPTION
**podman commit** creates an image based on a changed container. The author of the
image can be set using the `--author` flag. Various image instructions can be

View File

@ -6,6 +6,8 @@ podman\-cp - Copy files/folders between a container and the local filesystem
## SYNOPSIS
**podman cp** [*options*] [*container*:]*src_path* [*container*:]*dest_path*
**podman container cp** [*options*] [*container*:]*src_path* [*container*:]*dest_path*
## DESCRIPTION
Copies the contents of **src_path** to the **dest_path**. You can copy from the container's filesystem to the local machine or the reverse, from the local filesystem to the container.
If - is specified for either the SRC_PATH or DEST_PATH, you can also stream a tar archive from STDIN or to STDOUT.

View File

@ -6,6 +6,8 @@ podman\-create - Create a new container
## SYNOPSIS
**podman create** [*options*] *image* [*command* [*arg* ...]]
**podman container create** [*options*] *image* [*command* [*arg* ...]]
## DESCRIPTION
Creates a writable container layer over the specified image and prepares it for

View File

@ -6,6 +6,8 @@ podman\-diff - Inspect changes on a container or image's filesystem
## SYNOPSIS
**podman diff** [*options*] *name*
**podman container diff** [*options*] *name*
## DESCRIPTION
Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer

View File

@ -6,6 +6,8 @@ podman\-exec - Execute a command in a running container
## SYNOPSIS
**podman exec** [*options*] *container* [*command* [*arg* ...]]
**podman container exec** [*options*] *container* [*command* [*arg* ...]]
## DESCRIPTION
**podman exec** executes a command in a running container.

View File

@ -6,6 +6,8 @@ podman\-export - Export a container's filesystem contents as a tar archive
## SYNOPSIS
**podman export** [*options*] *container*
**podman container export** [*options*] *container*
## DESCRIPTION
**podman export** exports the filesystem of a container and saves it as a tarball
on the local machine. **podman export** writes to STDOUT by default and can be

View File

@ -6,6 +6,8 @@ podman\-history - Show the history of an image
## SYNOPSIS
**podman history** [*options*] *image*[:*tag*|@*digest*]
**podman image history** [*options*] *image*[:*tag*|@*digest*]
## DESCRIPTION
**podman history** displays the history of an image by printing out information
about each layer used in the image. The information printed out for each layer

View File

@ -6,6 +6,10 @@ podman\-images - List images in local storage
## SYNOPSIS
**podman images** [*options*]
**podman image list** [*options*]
**podman image ls** [*options*]
## DESCRIPTION
Displays locally stored images, their names, and their IDs.

View File

@ -6,6 +6,8 @@ podman\-import - Import a tarball and save it as a filesystem image
## SYNOPSIS
**podman import** [*options*] *path* [*reference*]
**podman image import** [*options*] *path* [*reference*]
## DESCRIPTION
**podman import** imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz)
and saves it as a filesystem image. Remote tarballs can be specified using a URL.

View File

@ -6,6 +6,8 @@ podman\-init - Initialize one or more containers
## SYNOPSIS
**podman init** [*options*] *container* [*container*...]
**podman container init** [*options*] *container* [*container*...]
## DESCRIPTION
Initialize one or more containers.
You may use container IDs or names as input.

View File

@ -6,6 +6,8 @@ podman\-kill - Kill the main process in one or more containers
## SYNOPSIS
**podman kill** [*options*] [*container* ...]
**podman container kill** [*options*] [*container* ...]
## DESCRIPTION
The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal.

View File

@ -6,6 +6,8 @@ podman\-load - Load an image from a container image archive into container stora
## SYNOPSIS
**podman load** [*options*] [*name*[:*tag*]]
**podman image load** [*options*] [*name*[:*tag*]]
## DESCRIPTION
**podman load** loads an image from either an **oci-archive** or **docker-archive** stored on the local machine into container storage. **podman load** reads from stdin by default or a file if the **input** option is set.
You can also specify a name for the image if the archive does not contain a named reference, of if you want an additional name for the local image.

View File

@ -6,6 +6,8 @@ podman\-mount - Mount a working container's root filesystem
## SYNOPSIS
**podman mount** [*container* ...]
**podman container mount** [*container* ...]
## DESCRIPTION
Mounts the specified containers' root file system in a location which can be
accessed from the host, and returns its location.

View File

@ -6,6 +6,8 @@ podman\-pause - Pause one or more containers
## SYNOPSIS
**podman pause** [*options*] [*container*...]
**podman container pause** [*options*] [*container*...]
## DESCRIPTION
Pauses all the processes in one or more containers. You may use container IDs or names as input.

View File

@ -6,6 +6,8 @@ podman\-port - List port mappings for a container
## SYNOPSIS
**podman port** [*options*] *container* [*private-port*[/*proto*]]
**podman container port** [*options*] *container* [*private-port*[/*proto*]]
## DESCRIPTION
List port mappings for the *container* or lookup the public-facing port that is NAT-ed to the *private-port*.

View File

@ -6,6 +6,16 @@ podman\-ps - Prints out information about containers
## SYNOPSIS
**podman ps** [*options*]
**podman container list** [*options*]
**podman container ls** [*options*]
**podman container ps** [*options*]
**podman list** [*options*]
**podman ls** [*options*]
## DESCRIPTION
**podman ps** lists the running containers on the system. Use the **--all** flag to view
all the containers information. By default it lists:

View File

@ -6,6 +6,8 @@ podman\-pull - Pull an image from a registry
## SYNOPSIS
**podman pull** [*options*] *name*[:*tag*|@*digest*]
**podman image pull** [*options*] *name*[:*tag*|@*digest*]
## DESCRIPTION
Copies an image from a registry onto the local machine. **podman pull** pulls an
image from Docker Hub if a registry is not specified in the command line argument.

View File

@ -6,6 +6,8 @@ podman\-push - Push an image from local storage to elsewhere
## SYNOPSIS
**podman push** [*options*] *image* [*destination*]
**podman image push** [*options*] *image* [*destination*]
## DESCRIPTION
Pushes an image from local storage to a specified destination.
Push is mainly used to push images to registries, however **podman push**

View File

@ -6,6 +6,8 @@ podman\-restart - Restart one or more containers
## SYNOPSIS
**podman restart** [*options*] *container* ...
**podman container restart** [*options*] *container* ...
## DESCRIPTION
The restart command allows containers to be restarted using their ID or name.
Containers will be stopped if they are running and then restarted. Stopped

View File

@ -6,6 +6,8 @@ podman\-run - Run a command in a new container
## SYNOPSIS
**podman run** [*options*] *image* [*command* [*arg* ...]]
**podman container run** [*options*] *image* [*command* [*arg* ...]]
## DESCRIPTION
Run a process in a new container. **podman run** starts a process with its own

View File

@ -6,6 +6,8 @@ podman\-save - Save an image to a container archive
## SYNOPSIS
**podman save** [*options*] *name*[:*tag*]
**podman image save** [*options*] *name*[:*tag*]
## DESCRIPTION
**podman save** saves an image to either **docker-archive**, **oci-archive**, **oci-dir** (directory with oci manifest type), or **docker-dir** (directory with v2s2 manifest type) on the local machine,
default is **docker-archive**. **podman save** writes to STDOUT by default and can be redirected to a

View File

@ -6,6 +6,8 @@ podman\-start - Start one or more containers
## SYNOPSIS
**podman start** [*options*] *container* ...
**podman container start** [*options*] *container* ...
## DESCRIPTION
Start one or more containers. You may use container IDs or names as input. The *attach* and *interactive*
options cannot be used to override the *--tty* and *--interactive* options from when the container

View File

@ -6,6 +6,8 @@ podman\-stats - Display a live stream of one or more container's resource usage
## SYNOPSIS
**podman stats** [*options*] [*container*]
**podman container stats** [*options*] [*container*]
## DESCRIPTION
Display a live stream of one or more containers' resource usage statistics

View File

@ -6,6 +6,8 @@ podman\-stop - Stop one or more running containers
## SYNOPSIS
**podman stop** [*options*] *container* ...
**podman container stop** [*options*] *container* ...
## DESCRIPTION
Stops one or more containers. You may use container IDs or names as input. The **--timeout** switch
allows you to specify the number of seconds to wait before forcibly stopping the container after the stop command

View File

@ -6,6 +6,7 @@ podman\-tag - Add an additional name to a local image
## SYNOPSIS
**podman tag** *image*[:*tag*] *target-name*[:*tag*] [*options*]
**podman image tag** *image*[:*tag*] *target-name*[:*tag*] [*options*]
## DESCRIPTION
Assigns a new alias to an image. An alias refers to the entire image name, including the optional

View File

@ -6,6 +6,8 @@ podman\-top - Display the running processes of a container
## SYNOPSIS
**podman top** [*options*] *container* [*format-descriptors*]
**podman container top** [*options*] *container* [*format-descriptors*]
## DESCRIPTION
Display the running processes of the container. The *format-descriptors* are ps (1) compatible AIX format descriptors but extended to print additional information, such as the seccomp mode or the effective capabilities of a given process. The descriptors can either be passed as separated arguments or as a single comma-separated argument. Note that you can also specify options and or flags of ps(1); in this case, Podman will fallback to executing ps with the specified arguments and flags in the container.

View File

@ -6,6 +6,12 @@ podman\-umount - Unmount a working container's root filesystem
## SYNOPSIS
**podman umount** *container* [...]
**podman container umount** *container* [...]
**podman container unmount** *container* [...]
**podman unmount** *container* [...]
## DESCRIPTION
Unmounts the specified containers' root file system, if no other processes
are using it.

View File

@ -6,6 +6,8 @@ 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.

View File

@ -6,6 +6,8 @@ podman\-wait - Wait on one or more containers to stop and print their exit codes
## SYNOPSIS
**podman wait** [*options*] *container*
**podman container wait** [*options*] *container*
## DESCRIPTION
Waits on one or more containers to stop. The container can be referred to by its
name or ID. In the case of multiple containers, podman will wait on each consecutively.