misc-deps
/
racket-unix-signals
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Reorganise scribblings slightly

This commit is contained in:
Tony Garnock-Jones 2016-09-13 18:27:40 -04:00
parent 423f8617d2
commit 674c3a3b11
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
unix-signals/unix-signals.scrbl
View File

@ -26,20 +26,9 @@ All the functionality below can be accessed with a single
@(defmodule unix-signals) @(defmodule unix-signals)
@subsection{Mapping between signal names and signal numbers}
This library represents signal names as symbols all in upper-case; This library represents signal names as symbols all in upper-case;
for example, @racket['SIGUSR1] and @racket['SIGKILL]. for example, @racket['SIGUSR1] and @racket['SIGKILL].
@defproc[(lookup-signal-number [sym symbol?]) (opt/c fixnum?)]{
Returns a fixnum if the symbol name is defined, or @racket[#f] if not. }
@defproc[(lookup-signal-name [num fixnum?]) (opt/c symbol?)]{ Returns
a symbol naming the given signal number, if one is defined, or
@racket[#f] if not. Note that in cases where multiple C identifiers
map to a given signal number, an arbitrary choice among the
possibilities is returned. }
@subsection{Waiting for a signal} @subsection{Waiting for a signal}
To receive Unix signals using this library, call To receive Unix signals using this library, call
@ -97,3 +86,14 @@ for convenience.
boolean?]{ Calls @tt{kill(2)} to deliver the given signal to the boolean?]{ Calls @tt{kill(2)} to deliver the given signal to the
given process ID. All special cases for @racket[pid] from the given process ID. All special cases for @racket[pid] from the
@tt{kill(2)} manpage apply. } @tt{kill(2)} manpage apply. }
@subsection{Mapping between signal names and signal numbers}
@defproc[(lookup-signal-number [sym symbol?]) (opt/c fixnum?)]{
Returns a fixnum if the symbol name is defined, or @racket[#f] if not. }
@defproc[(lookup-signal-name [num fixnum?]) (opt/c symbol?)]{ Returns
a symbol naming the given signal number, if one is defined, or
@racket[#f] if not. Note that in cases where multiple C identifiers
map to a given signal number, an arbitrary choice among the
possibilities is returned. }