mirror of
https://github.com/opencontainers/runc.git
synced 2025-10-07 16:31:38 +08:00

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>
672 B
672 B
% runc-kill "8"
NAME
runc-kill - send a specified signal to container
SYNOPSIS
runc kill [--all|-a] container-id [signal]
DESCRIPTION
By default, runc kill sends SIGTERM to the container's initial process only.
A different signal can be specified either by its name (with or without the SIG prefix), or its numeric value. Use kill(1) with -l option to list available signals.
OPTIONS
- --all|-a
- Send the signal to all processes inside the container.
EXAMPLES
The following will send a KILL signal to the init process of the ubuntu01 container:
# runc kill ubuntu01 KILL
SEE ALSO
runc(1).