mirror of
https://github.com/opencontainers/runc.git
synced 2026-07-11 06:03:57 +08:00
Kir Kolyshkin
dfc0f0695a
Current runc man pages are ugly (no proper man page formatting) and very short (mostly just a copy-paste from the "runc <command> --help" output. They are also somewhat obsoleted as not all CLI updates were propagated to man/*. This commits makes the first step to solving this. In short: - added some more information about some options; - lots of formatting fixes; - use references to other man pages and web pages; - fix SYNOPSYS (formatting, mostly); - removed the repeated description of <container_id> from every page; - added SEE ALSO; - something else I forgot. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
858 B
858 B
% runc-ps "8"
NAME
runc-ps - display the processes inside a container
SYNOPSIS
runc ps [option ...] container-id [ps-option ...]
DESCRIPTION
The command ps is a wrapper around the stock ps(1) utility, which filters its output to only contain processes belonging to a specified container-id. Therefore, the PIDs shown are the host PIDs.
Any ps(1) options can be used, but some might break the filtering. In particular, if PID column is not available, an error is returned, and if there are columns with values containing spaces before the PID column, the result is undefined.
OPTIONS
- --format|-f table|json
- Output format. Default is table. The json format shows a mere array of PIDs belonging to a container; if used, all ps options are gnored.
SEE ALSO
runc-list(8), runc(8).