diff options
author | baude <bbaude@redhat.com> | 2019-10-24 14:54:57 -0500 |
---|---|---|
committer | baude <bbaude@redhat.com> | 2019-10-31 12:31:39 -0500 |
commit | 52b92023edeba3a5e2c466d92d742e54b14a85cb (patch) | |
tree | 44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/podman-top.1.md | |
parent | 5af166ff513265b17aee92a9ce3a1522090d7dec (diff) | |
download | podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2 podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip |
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man
pages now exist in docs/source/man and the sphinx make files exists in
docs.
Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/podman-top.1.md')
-rw-r--r-- | docs/podman-top.1.md | 108 |
1 files changed, 0 insertions, 108 deletions
diff --git a/docs/podman-top.1.md b/docs/podman-top.1.md deleted file mode 100644 index 1410aa651..000000000 --- a/docs/podman-top.1.md +++ /dev/null @@ -1,108 +0,0 @@ -% podman-top(1) - -## NAME -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. - -## OPTIONS - -**--help**, **-h** - -Print usage statement - -**--latest**, **-l** - -Instead of providing the container name or ID, use the last created container. If you use methods other than Podman -to run containers such as CRI-O, the last started container could be from either of those methods. - -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 top f5a62a71b07 -USER PID PPID %CPU ELAPSED TTY TIME COMMAND -root 1 0 0.000 20.386825206s pts/0 0s sh -root 7 1 0.000 16.386882887s pts/0 0s sleep -root 8 1 0.000 11.386886562s pts/0 0s vi -``` - -The output can be controlled by specifying format descriptors as arguments after the container: - -``` -$ podman top -l pid seccomp args %C -PID SECCOMP COMMAND %CPU -1 filter sh 0.000 -8 filter vi /etc/ 0.000 -``` - -Podman will fallback to executing ps(1) in the container if an unknown descriptor is specified. - -``` -$ podman top -l -- aux -USER PID PPID %CPU ELAPSED TTY TIME COMMAND -root 1 0 0.000 1h2m12.497061672s ? 0s sleep 100000 -``` - -## SEE ALSO -podman(1), ps(1), seccomp(2), proc(5), capabilities(7) - -## HISTORY -July 2018, Introduce format descriptors by Valentin Rothberg <vrothberg@suse.com> - -December 2017, Originally compiled by Brent Baude <bbaude@redhat.com> |