container/podman
container/podman
1
0
Fork 0
mirror of https://github.com/containers/podman synced 2024-10-21 09:45:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
podman/docs/podman-pause.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

429 B
Raw Blame History

% podman-pause "1"

NAME

podman-pause - Pause one or more containers

SYNOPSIS

podman pause [options] container ...

DESCRIPTION

Pauses all the processes in one or more containers. You may use container IDs or names as input.

EXAMPLE

podman pause mywebserver

podman pause 860a4b23

SEE ALSO

podman(1), podman-unpause(1)

HISTORY

September 2017, Originally compiled by Dan Walsh dwalsh@redhat.com