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

21 lines
600 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-kill "8"
Add man pages in markdown format Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2016-03-03 08:18:17 +08:00
# NAME
runc kill - kill sends the specified signal (default: SIGTERM) to the container's init process
# 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 kill [command options] `<container-id>` `<signal>`
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 and
"`<signal>`" is the signal to be sent to the init process.
Add man pages in markdown format Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2016-03-03 08:18:17 +08:00
Add --all flag to kill This allows a user to send a signal to all the processes in the container within a single atomic action to avoid new processes being forked off before the signal can be sent. This is basically taking functionality that we already use being `delete` and exposing it ok the `kill` command by adding a flag. Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2016-11-08 07:22:27 +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
--all, -a send the specified signal to all processes inside the container
Add --all flag to kill This allows a user to send a signal to all the processes in the container within a single atomic action to avoid new processes being forked off before the signal can be sent. This is basically taking functionality that we already use being `delete` and exposing it ok the `kill` command by adding a flag. Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2016-11-08 07:22:27 +08:00
Add man pages in markdown format Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2016-03-03 08:18:17 +08:00
# EXAMPLE
For example, if the container id is "ubuntu01" the following will send a "KILL"
signal to the init process of the "ubuntu01" container:
# runc kill ubuntu01 KILL