beb71323b1
podman-generate and -play had the wrong NAMEs.
podman-restart and -volume-prune the wrong SYNOPSIS.
All the rest are varying degrees of minor:
- missing a space between the NAME and description
- multi-line SYNOPSIS that could be collapsed into one
- use of UPPER CASE in synopsis instead of *asterisks*
- improper use of **double asterisks** for options
- varlink and version were transposed in podman-1
- fixed inconsistencies between the description in
the man page and that in the parent manpage. These
are too numerous for me to fix all.
Added: script that could be used in CI to prevent future
such inconsistencies. It cannot be enabled yet because
there are still 35+ inconsistencies in need of cleaning.
This will be difficult to review on github. I suggest
pulling the PR and running 'git log -1 -p | cdif | less'
'cdif' is a handy tool for colorizing individual diffs between
lines:
http://kaz-utashiro.github.io/cdif/
There are other such tools; use your favorite. Comparing
without visual highlights may be painful.
I also encourage you to run hack/man-page-checker and suggest
more fixes for the problems it's finding.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2.4 KiB
% podman-pod-top(1)
NAME
podman-pod-top - Display the running processes of containers in a pod
SYNOPSIS
podman pod top [options] pod [format-descriptors]
DESCRIPTION
Display the running process of containers in a pod. 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.
OPTIONS
--help, -h
Print usage statement
--latest, -l
Instead of providing the pod name or ID, use the last created pod.
The latest option is not supported on the remote client.
FORMAT DESCRIPTORS
The following descriptors are supported in addition to the AIX format descriptors mentioned in ps (1):
args, capbnd, capeff, capinh, capprm, comm, etime, group, hgroup, hpid, huser, label, nice, pcpu, pgid, pid, ppid, rgroup, ruser, seccomp, state, time, tty, user, vsz
capbnd
Set of bounding capabilities. See capabilities (7) for more information.
capeff
Set of effective capabilities. See capabilities (7) for more information.
capinh
Set of inheritable capabilities. See capabilities (7) for more information.
capprm
Set of permitted capabilities. See capabilities (7) for more information.
hgroup
The corresponding effective group of a container process on the host.
hpid
The corresponding host PID of a container process.
huser
The corresponding effective user of a container process on the host.
label
Current security attributes of the process.
seccomp
Seccomp mode of the process (i.e., disabled, strict or filter). See seccomp (2) for more information.
state
Process state codes (e.g, R for running, S for sleeping). See proc(5) for more information.
EXAMPLES
By default, podman-top prints data similar to ps -ef:
$ podman pod top b031293491cc
USER PID PPID %CPU ELAPSED TTY TIME COMMAND
root 1 0 0.000 2h5m38.737137571s ? 0s top
root 8 0 0.000 2h5m15.737228361s ? 0s top
The output can be controlled by specifying format descriptors as arguments after the pod:
$ podman pod top -l pid seccomp args %C
PID SECCOMP COMMAND %CPU
1 filter top 0.000
1 filter /bin/sh 0.000
SEE ALSO
podman-pod(1), ps(1), seccomp(2), proc(5), capabilities(7)
HISTORY
August 2018, Originally compiled by Peter Hunt pehunt@redhat.com