diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guix.texi | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index b0ab0c1db5b..9924f4771f2 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -50488,6 +50488,29 @@ cat $(herd configuration tor) This can come in as a handy debugging tool! @end deffn +@deffn {Procedure} shepherd-signal-action name signal @ +[#:documentation `Send signal @var{signal} to the running service`] @ +[#:message `Service has been asked to perform @var{name}`] +Return a shepherd action with @var{name} to send @var{signal} to the +running process. The optional @var{documentation} and @var{message} can be used +to customize the documentation and output message. + +Many daemons perform special actions after receiving a specific signal. + +For example the @command{syslogd} logger will reread its configuration file +after receiving @code{SIGHUP}. + +After adding +@lisp +(shepherd-signal-action 'reload SIGHUP)) +@end lisp + +the @code{reload} action will be available and can be used with +@example +herd reload syslogd +@end example +@end deffn + @defvar shepherd-root-service-type The service type for the Shepherd ``root service''---i.e., PID@tie{}1. |