jasder
/
runc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
runc/man/runc-events.8.md

18 lines
557 B
Markdown
Raw Normal View History

man: fix man-pages The man-pages are using pre-formatted section to display the options for all commands. The result on my system never looked correct: OPTIONS --bundle value, -b value path to the root [...] --console-socket value path to an AF_UNIX [...] The first line was always indented less than the other lines. This commit makes the option block a pre-formatted block (as intended???) by using 4 spaces instead of 3 spaces. In addition the man-pages did not specify their name and section correctly. This adds something like '% runc-run "8"' to all man-pages to have correct title 'runc-run(8)' instead of 'NAME()' and it also adds the section to the title: 'System Manager's Manual'. This also fixes the use of '>' and '<' at multiple places. The markdown source files were using "<container-id>" and similar which was (most of the time) rendered as '""'. On some systems it was rendered correctly. Signed-off-by: Adrian Reber <areber@redhat.com>
2019-08-07 02:11:13 +08:00
% runc-events "8"
Add man pages in markdown format Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2016-03-03 08:18:17 +08:00
# NAME
manual: Update runc-events.8.md with source --events argument's usage was updated by: commit:a62dbf48b0fe5e2e28e3cc9dc80a70d2ec5ebc25 We need to update manual together. This patch also removes last useless blank line in manual. Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>
2016-05-24 17:08:37 +08:00
runc events - display container events such as OOM notifications, cpu, memory, and IO usage statistics
Add man pages in markdown format Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2016-03-03 08:18:17 +08:00
# SYNOPSIS
man: fix man-pages The man-pages are using pre-formatted section to display the options for all commands. The result on my system never looked correct: OPTIONS --bundle value, -b value path to the root [...] --console-socket value path to an AF_UNIX [...] The first line was always indented less than the other lines. This commit makes the option block a pre-formatted block (as intended???) by using 4 spaces instead of 3 spaces. In addition the man-pages did not specify their name and section correctly. This adds something like '% runc-run "8"' to all man-pages to have correct title 'runc-run(8)' instead of 'NAME()' and it also adds the section to the title: 'System Manager's Manual'. This also fixes the use of '>' and '<' at multiple places. The markdown source files were using "<container-id>" and similar which was (most of the time) rendered as '""'. On some systems it was rendered correctly. Signed-off-by: Adrian Reber <areber@redhat.com>
2019-08-07 02:11:13 +08:00
runc events [command options] `<container-id>`
Add man pages in markdown format Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2016-03-03 08:18:17 +08:00
man: fix man-pages The man-pages are using pre-formatted section to display the options for all commands. The result on my system never looked correct: OPTIONS --bundle value, -b value path to the root [...] --console-socket value path to an AF_UNIX [...] The first line was always indented less than the other lines. This commit makes the option block a pre-formatted block (as intended???) by using 4 spaces instead of 3 spaces. In addition the man-pages did not specify their name and section correctly. This adds something like '% runc-run "8"' to all man-pages to have correct title 'runc-run(8)' instead of 'NAME()' and it also adds the section to the title: 'System Manager's Manual'. This also fixes the use of '>' and '<' at multiple places. The markdown source files were using "<container-id>" and similar which was (most of the time) rendered as '""'. On some systems it was rendered correctly. Signed-off-by: Adrian Reber <areber@redhat.com>
2019-08-07 02:11:13 +08:00
Where "`<container-id>`" is the name for the instance of the container.
Add man pages in markdown format Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2016-03-03 08:18:17 +08:00
# DESCRIPTION
The events command displays information about the container. By default the
information is displayed once every 5 seconds.
# OPTIONS
man: fix man-pages The man-pages are using pre-formatted section to display the options for all commands. The result on my system never looked correct: OPTIONS --bundle value, -b value path to the root [...] --console-socket value path to an AF_UNIX [...] The first line was always indented less than the other lines. This commit makes the option block a pre-formatted block (as intended???) by using 4 spaces instead of 3 spaces. In addition the man-pages did not specify their name and section correctly. This adds something like '% runc-run "8"' to all man-pages to have correct title 'runc-run(8)' instead of 'NAME()' and it also adds the section to the title: 'System Manager's Manual'. This also fixes the use of '>' and '<' at multiple places. The markdown source files were using "<container-id>" and similar which was (most of the time) rendered as '""'. On some systems it was rendered correctly. Signed-off-by: Adrian Reber <areber@redhat.com>
2019-08-07 02:11:13 +08:00
--interval value set the stats collection interval (default: 5s)
--stats display the container's stats then exit