process(3lua): init man pages

Initialise man pages for the process module.
This commit is contained in:
Jeremy Baxter 2024-04-06 19:58:41 +13:00
parent 69f8fff3bd
commit 37d208a5d2
7 changed files with 156 additions and 0 deletions

View file

@ -0,0 +1,26 @@
PROCESS.SIGNUM(3lua) "3lua" "Callisto manual pages"
# NAME
*process.signum* - translate a signal's name into its numeric constant
# SYNOPSIS
*process.signum*(_sig_: *string*)
# DESCRIPTION
*process.signum* returns the numeric form of the signal name _sig_.
The returned integer will likely differ across platforms.
On many platforms, *SIGKILL* has the numeric value *9*;
therefore, on those platforms _process.signum("SIGKILL")_
would return *9*.
If _sig_ is not the name of a valid signal,
*process.signum* throws a Lua error.
# EXAMPLES
Print the value of *SIGUSR1*:
print("SIGUSR1 is " .. process.signum("SIGUSR1"))
# SEE ALSO
callisto(3lua), process(3lua)