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

16 lines
380 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-ps "8"
manual: add manual for ps command This patch add manual for ps command, and remove remove example for --format command, which is not necessary. Suggested-by: Aleksa Sarai <asarai@suse.de> Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>
2016-05-24 18:52:29 +08:00
# NAME
runc ps - ps displays the processes running inside a container
# 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 ps [command options] `<container-id>` [ps options]
manual: add manual for ps command This patch add manual for ps command, and remove remove example for --format command, which is not necessary. Suggested-by: Aleksa Sarai <asarai@suse.de> Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>
2016-05-24 18:52:29 +08:00
# 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
--format value, -f value select one of: table(default) or json
manual: add manual for ps command This patch add manual for ps command, and remove remove example for --format command, which is not necessary. Suggested-by: Aleksa Sarai <asarai@suse.de> Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>
2016-05-24 18:52:29 +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
The default format is table. The following will output the processes of a container
manual: add manual for ps command This patch add manual for ps command, and remove remove example for --format command, which is not necessary. Suggested-by: Aleksa Sarai <asarai@suse.de> Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>
2016-05-24 18:52:29 +08:00
in json format:
small cleanup for `runc ps` man pages Signed-off-by: CuiHaozhi <cuihaozhi@chinacloud.com.cn>
2017-02-23 15:34:49 +08:00
# runc ps -f json <container-id>