man page macro and text revisions (-mdoc version 3)

[unix-history] / usr / src / lib / libc / sys / sigstack.2

diff --git a/usr/src/lib/libc/sys/sigstack.2 b/usr/src/lib/libc/sys/sigstack.2
index 41ec79f..6a2fa8f 100644 (file)
--- a/usr/src/lib/libc/sys/sigstack.2
+++ b/usr/src/lib/libc/sys/sigstack.2
@@ -1,66 +1,74 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"
 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"

-.\"    @(#)sigstack.2  6.4 (Berkeley) %G%
+.\"     @(#)sigstack.2 6.5 (Berkeley) %G%

 .\"
 .\"

-.TH SIGSTACK 2 ""
-.UC 5
-.SH NAME
-sigstack \- set and/or get signal stack context
-.SH SYNOPSIS
-.nf
-.B #include <signal.h>
-.PP
-.B struct sigstack {
-.B     caddr_t ss_sp;
-.B     int     ss_onstack;
-.B };
-.PP
-.B sigstack(ss, oss);
-.B struct sigstack *ss, *oss;
-.SH DESCRIPTION
-.I Sigstack
+.Dd 
+.Dt SIGSTACK 2
+.Os BSD 4.2
+.Sh NAME
+.Nm sigstack
+.Nd set and/or get signal stack context
+.Sh SYNOPSIS
+.Fd #include <sys/signal.h>
+.Bd -literal
+struct sigstack {
+       caddr_t ss_sp;
+       int     ss_onstack;
+};
+.Ed
+.Ft int
+.Fn sigstack "const struct sigstack *ss" "struct sigstack *oss"
+.Sh DESCRIPTION
+.Fn Sigstack

 allows users to define an alternate stack on which signals
 are to be processed.  If
 allows users to define an alternate stack on which signals
 are to be processed.  If

-.I ss
+.Fa ss

 is non-zero,
 it specifies a
 is non-zero,
 it specifies a

-.I "signal stack"
+.Em "signal stack"

 on which to deliver signals
 and tells the system if the process is currently executing
 on that stack.  When a signal's action indicates its handler
 should execute on the signal stack (specified with a
 on which to deliver signals
 and tells the system if the process is currently executing
 on that stack.  When a signal's action indicates its handler
 should execute on the signal stack (specified with a

-.IR sigvec (2)
+.Xr sigvec 2

 call), the system checks to see
 if the process is currently executing on that stack.  If the
 process is not currently executing on the signal stack,
 the system arranges a switch to the signal stack for the
 duration of the signal handler's execution. 
 If
 call), the system checks to see
 if the process is currently executing on that stack.  If the
 process is not currently executing on the signal stack,
 the system arranges a switch to the signal stack for the
 duration of the signal handler's execution. 
 If

-.I oss
+.Fa oss

 is non-zero, the current signal stack state is returned.
 is non-zero, the current signal stack state is returned.

-.SH NOTES
+.Sh NOTES

 Signal stacks are not ``grown'' automatically, as is
 done for the normal stack.  If the stack overflows
 unpredictable results may occur.
 Signal stacks are not ``grown'' automatically, as is
 done for the normal stack.  If the stack overflows
 unpredictable results may occur.

-.SH "RETURN VALUE
+.Sh RETURN VALUES

 Upon successful completion, a value of 0 is returned.
 Upon successful completion, a value of 0 is returned.

-Otherwise, a value of \-1 is returned and 
-.I errno
+Otherwise, a value of -1 is returned and 
+.Va errno

 is set to indicate the error.
 is set to indicate the error.

-.SH ERRORS
-.I Sigstack
+.Sh ERRORS
+.Fn Sigstack

 will fail and the signal stack context will remain unchanged
 if one of the following occurs.
 will fail and the signal stack context will remain unchanged
 if one of the following occurs.

-.TP 15
-[EFAULT]
+.Bl -tag -width [EFAULT]
+.It Bq Er EFAULT

 Either
 Either

-.I ss
+.Fa ss

 or
 or

-.I oss
+.Fa oss

 points to memory that is not a valid part of the process
 address space.
 points to memory that is not a valid part of the process
 address space.

-.SH "SEE ALSO"
-sigvec(2), setjmp(3)
+.El
+.Sh SEE ALSO
+.Xr sigvec 2 ,
+.Xr setjmp 3
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .