summaryrefslogtreecommitdiff
path: root/src/lib/libremessages.1.ronn
diff options
context:
space:
mode:
authorLuke Shumaker <LukeShu@sbcglobal.net>2014-03-05 10:57:57 -0500
committerLuke Shumaker <LukeShu@sbcglobal.net>2014-03-05 10:57:57 -0500
commit74f68d0149f2a94780c860b0775d1e880dbe9225 (patch)
treec6259aed18700a634666f12569d7b05080e6ec8f /src/lib/libremessages.1.ronn
parent64b427c2449eb45ec945afd09cced57c8a7d7e4e (diff)
teach libremessages:setup_traps to be able to use a custom signal handler
Diffstat (limited to 'src/lib/libremessages.1.ronn')
-rw-r--r--src/lib/libremessages.1.ronn9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/lib/libremessages.1.ronn b/src/lib/libremessages.1.ronn
index d4c35fc..d39dad0 100644
--- a/src/lib/libremessages.1.ronn
+++ b/src/lib/libremessages.1.ronn
@@ -69,9 +69,14 @@ Unless otherwise noted, these do not implicitly call `gettext`.
Joins all arguments with whitespace, and sets the terminal title
to that.
- * `setup_traps`:
+ * `setup_traps` [<HANDLER>]:
Sets traps on TERM, HUP, QUIT and INT signals, as sell as the ERR
- event, similar to makepkg.
+ event, similar to makepkg. If <HANDLER> is specified, instead of
+ using the default handler (which is good for most purposes), it
+ will call <HANDLER> with the arguments
+ `<HANDLER> <SIGNAL_NAME> <MESSAGE> [<MESSAGE_ARGS>...]`, where
+ <MESSAGE> is a `printf`(1)-formatted string, and <MESSAGE_ARGS>
+ are its arguments.
### PROSE ROUTINES