Commit graph

5 commits

Author SHA1 Message Date
baude b559c19c2f Make kill, pause, and unpause parallel.
Operations like kill, pause, and unpause -- which can operation on one or
more containers -- can greatly benefit from parallizing its main job (eq kill).

In the case of pauseand unpause, an --all option as was added. pause --all will
pause all **running** containers.  And unpause --all will unpause all **paused**
containers.

Signed-off-by: baude <bbaude@redhat.com>
2018-11-01 14:23:55 -05:00
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
Daniel J Walsh 71487466fb Cleanup man pages
Format md files to work properly when converted to man pages.
Add sed command to cleanup table in podman man page.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #842
Approved by: mheon
2018-05-30 13:49:45 +00:00
Daniel J Walsh 99d180efcc Modify man pages so they compile correctly in mandb
This fixes an issue where if you did
man -k podman-run

podman-run (1)    - (unknown subject)

Now you will see

man -k podman-run
podman-run (1)       - Run a command in a new container

More importantly

man -k containers | grep podman
podman (1)           - Simple management tool for containers and images
podman-kill (1)      - Kills one or more containers with a signal
podman-pause (1)     - Pause one or more containers
podman-ps (1)        - Prints out information about containers
podman-rm (1)        - Remove one or more containers
podman-start (1)     - Start one or more containers
podman-stats (1)     - Display a live stream of 1 or more containers' resource usage statistics
podman-stop (1)      - Stop one or more containers
podman-unpause (1)   - Unpause one or more containers
podman-wait (1)      - Waits on one or more containers to stop and prints exit code

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #676
Approved by: mheon
2018-04-26 13:46:14 +00:00
Daniel J Walsh 5770dc2640 Rename all references to kpod to podman
The decision is in, kpod is going to be named podman.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #145
Approved by: umohnani8
2017-12-18 16:46:05 +00:00