podman/docs/podman-container.1.md
W. Trevor King f2462ca59e docs: Follow man-pages(7) suggestions for SYNOPSIS
man-pages(7) has [1]:

> For commands, this shows the syntax of the command and its arguments
> (including options); boldface is used for as-is text and italics are
> used to indicate replaceable arguments. Brackets ([]) surround
> optional arguments, vertical bars (|) separate choices, and ellipses
> (...) can be repeated.

I've adjusted our SYNOPSIS entries to match that formatting, and
generally tried to make them more consistent with the precedent set by
the man-pages project.  Outside of the SYNOPSIS entry, I prefer using
backticks for literals, although in some places I've left the **
bolding to keep things visually similar to a nearby SYNOPSIS entry.

[1]: http://man7.org/linux/man-pages/man7/man-pages.7.html

Signed-off-by: W. Trevor King <wking@tremily.us>

Closes: #1027
Approved by: rhatdan
2018-07-04 09:40:37 +00:00

4.2 KiB

% podman-container "1"

NAME

podman-container - Manage containers

SYNOPSIS

podman container subcommand

DESCRIPTION

The container command allows you to manage containers

COMMANDS

Command Man Page Description
attach podman-attach(1) Attach to a running container.
cleanup podman-container-cleanup(1) Cleanup containers network and mountpoints.
commit podman-commit(1) Create new image based on the changed container.
create podman-create(1) Create a new container.
diff podman-diff(1) Inspect changes on a container or image's filesystem.
exec podman-exec(1) Execute a command in a running container.
export podman-export(1) Export a container's filesystem contents as a tar archive.
inspect podman-inspect(1) Display a container or image's configuration.
kill podman-kill(1) Kill the main process in one or more containers.
logs podman-logs(1) Display the logs of a container.
ls podman-ps(1) Prints out information about containers.
mount podman-mount(1) Mount a working container's root filesystem.
pause podman-pause(1) Pause one or more containers.
port podman-port(1) List port mappings for the container.
refresh podman-refresh(1) Refresh the state of all containers
restart podman-restart(1) Restart one or more containers.
rm podman-rm(1) Remove one or more containers.
run podman-run(1) Run a command in a container.
start podman-start(1) Starts one or more containers.
stats podman-stats(1) Display a live stream of one or more container's resource usage statistics.
stop podman-stop(1) Stop one or more running containers.
top podman-top(1) Display the running processes of a container.
umount podman-umount(1) Unmount a working container's root filesystem.
unmount podman-umount(1) Unmount a working container's root filesystem.
unpause podman-unpause(1) Unpause one or more containers.
wait podman-wait(1) Wait on one or more containers to stop and print their exit codes.

SEE ALSO

podman, podman-exec, podman-run