zishuo/runc
1
0
Fork 0
mirror of https://github.com/opencontainers/runc.git synced 2025-09-26 19:41:35 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
runc/man/runc-events.8.md
Kir Kolyshkin dfc0f0695a man/*: revamp 
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>
2021-06-16 12:42:06 -07:00

501 B
Raw Permalink Blame History

% runc-events "8"

NAME

runc-events - display container events and statistics.

SYNOPSIS

runc events [option ...] container-id

DESCRIPTION

The events command displays information about the container. By default, it works continuously, displaying stats every 5 seconds, and container events as they occur.

OPTIONS

--interval time
Set the stats collection interval. Default is 5s.
--stats
Show the container's stats once then exit.

SEE ALSO

runc(8).