aboutsummaryrefslogtreecommitdiff
path: root/lib/libc/sys/sigqueue.2
diff options
context:
space:
mode:
authorRuslan Ermilov <ru@FreeBSD.org>2005-11-18 11:53:23 +0000
committerRuslan Ermilov <ru@FreeBSD.org>2005-11-18 11:53:23 +0000
commit5507a2aed54ef3c74a24a0ed53f36abd9c4f48be (patch)
treefb5044fa597011929913a5962b2897535e889b94 /lib/libc/sys/sigqueue.2
parent78ad54210fe02edbec3bfe18db3a33088b7c06ff (diff)
downloadsrc-5507a2aed54ef3c74a24a0ed53f36abd9c4f48be.tar.gz
src-5507a2aed54ef3c74a24a0ed53f36abd9c4f48be.zip
Fix up markup etc. in recently born manpage.
Notes
Notes: svn path=/head/; revision=152570
Diffstat (limited to 'lib/libc/sys/sigqueue.2')
-rw-r--r--lib/libc/sys/sigqueue.269
1 files changed, 41 insertions, 28 deletions
diff --git a/lib/libc/sys/sigqueue.2 b/lib/libc/sys/sigqueue.2
index 3f5dbacd9ffc..e68a7f77f65e 100644
--- a/lib/libc/sys/sigqueue.2
+++ b/lib/libc/sys/sigqueue.2
@@ -1,4 +1,4 @@
-.\" Copyright (c) 2005 David Xu <davidxu@freebsd.org>
+.\" Copyright (c) 2005 David Xu <davidxu@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -27,12 +27,12 @@
.\"
.\" $FreeBSD$
.\"
-.Dd Nov 11, 2005
+.Dd November 11, 2005
.Dt SIGQUEUE 2
.Os
.Sh NAME
.Nm sigqueue
-.Nd queue a signal to a process (REALTIME)
+.Nd "queue a signal to a process (REALTIME)"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
@@ -42,7 +42,7 @@
.Sh DESCRIPTION
The
.Fn sigqueue
-function causes the signal specified by
+system call causes the signal specified by
.Fa signo
to be sent with the value specified by
.Fa value
@@ -51,18 +51,24 @@ to the process specified by
If
.Fa signo
is zero (the null signal), error checking is performed but
-no signal is actually sent. The null signal can be used to check the
-validity of pid.
+no signal is actually sent.
+The null signal can be used to check the
+validity of PID.
.Pp
The conditions required for a process to have permission to queue a
signal to another process are the same as for the
-.Fn kill
-function.
+.Xr kill 2
+system call.
The
.Fn sigqueue
-function queues a signal to a single process specified by the pid argument.
+system call queues a signal to a single process specified by the
+.Fa pid
+argument.
.Pp
-The sigqueue() function returns immediately. If the resources were
+The
+.Fn sigqueue
+system call returns immediately.
+If the resources were
available to queue the signal, the signal will be queued and sent to
the receiving process.
.Pp
@@ -76,31 +82,36 @@ is not blocked for the calling thread and if no other thread has
.Fa signo
unblocked or is waiting in a
.Fn sigwait
-function for
+system call for
.Fa signo ,
either
.Fa signo
or at least the pending, unblocked signal will be delivered to the
-calling thread before the
+calling thread before
.Fn sigqueue
-function returns. Should any multiple pending signals in the range
-SIGRTMIN to SIGRTMAX be selected for delivery, it is the lowest numbered
-one. The selection order between realtime and non-realtime signals, or
+returns.
+Should any multiple pending signals in the range
+.Dv SIGRTMIN
+to
+.Dv SIGRTMAX
+be selected for delivery, it is the lowest numbered
+one.
+The selection order between realtime and non-realtime signals, or
between multiple pending non-realtime signals, is unspecified.
.Sh RETURN VALUES
-Upon successful completion, the specified signal has been queued, and
-the
-.Fn sigqueue
-function returns a value of zero. Otherwise, the function returns a value
-of -1 and set errno to indicate the error.
+.Rv -std
.Sh ERRORS
The
.Fn sigqueue
+system call
will fail if:
.Bl -tag -width Er
.It Bq Er EAGAIN
-No resources are available to queue the signal. The process has already
-queued {SIGQUEUE_MAX} signals that are still pending at the receiver(s),
+No resources are available to queue the signal.
+The process has already
+queued
+.Brq Dv SIGQUEUE_MAX
+signals that are still pending at the receiver(s),
or a system-wide resource limit has been exceeded.
.It Bq Er EINVAL
The value of the
@@ -110,20 +121,22 @@ argument is an invalid or unsupported signal number.
The process does not have the appropriate privilege to send the signal
to the receiving process.
.It Bq Er ESRCH
-The process pid does not exist.
+The process
+.Fa pid
+does not exist.
.El
.Sh SEE ALSO
-.Xr sigwait 2 ,
-.Xr sigtimedwait 2 ,
-.Xr sigwaitinfo 2 ,
-.Xr sigqueue 2 ,
.Xr sigaction 2 ,
.Xr sigpending 2 ,
+.Xr sigqueue 2 ,
.Xr sigsuspend 2 ,
+.Xr sigtimedwait 2 ,
+.Xr sigwait 2 ,
+.Xr sigwaitinfo 2 ,
.Xr pause 3 ,
.Xr pthread_sigmask 3
.Sh STANDARDS
The
.Fn sigqueue
-function conforms to
+system call conforms to
.St -p1003.1-96 .