11622 clean up rarer mandoc lint warnings
1 .\" 2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for 3 .\" permission to reproduce portions of its copyrighted documentation. 4 .\" Original documentation from The Open Group can be obtained online at 5 .\" http://www.opengroup.org/bookstore/. 6 .\" 7 .\" The Institute of Electrical and Electronics Engineers and The Open 8 .\" Group, have given us permission to reprint portions of their 9 .\" documentation. 10 .\" 11 .\" In the following statement, the phrase ``this text'' refers to portions 12 .\" of the system documentation. 13 .\" 14 .\" Portions of this text are reprinted and reproduced in electronic form 15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition, 16 .\" Standard for Information Technology -- Portable Operating System 17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6, 18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics 19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy 20 .\" between these versions and the original IEEE and The Open Group 21 .\" Standard, the original IEEE and The Open Group Standard is the referee 22 .\" document. The original Standard can be obtained online at 23 .\" http://www.opengroup.org/unix/online.html. 24 .\" 25 .\" This notice shall appear on any product containing this material. 26 .\" 27 .\" The contents of this file are subject to the terms of the 28 .\" Common Development and Distribution License (the "License"). 29 .\" You may not use this file except in compliance with the License. 30 .\" 31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 32 .\" or http://www.opensolaris.org/os/licensing. 33 .\" See the License for the specific language governing permissions 34 .\" and limitations under the License. 35 .\" 36 .\" When distributing Covered Code, include this CDDL HEADER in each 37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. 38 .\" If applicable, add the following below this CDDL HEADER, with the 39 .\" fields enclosed by brackets "[]" replaced with your own identifying 40 .\" information: Portions Copyright [yyyy] [name of copyright owner] 41 .\" 42 .\" 43 .\" Copyright 1989 AT&T 44 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved 45 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. 46 .\" Copyright 2016 Joyent, Inc. 47 .\" 48 .TH NANOSLEEP 3C "Mar 27, 2016" 49 .SH NAME 50 nanosleep, thrd_sleep \- high resolution sleep 51 .SH SYNOPSIS 52 .nf 53 #include <time.h> 54 55 \fBint\fR \fBnanosleep\fR(\fBconst struct timespec *\fR\fIrqtp\fR, 56 \fBstruct timespec *\fR\fIrmtp\fR); 57 .fi 58 59 .nf 60 #include <threads.h> 61 62 \fBint\fR \fBthrd_sleep\fR(\fBconst struct timespec *\fR\fIrqtp\fR, 63 \fBstruct timespec *\fR\fIrmtp\fR); 64 65 .SH DESCRIPTION 66 The \fBnanosleep()\fR and \fBthrd_sleep()\fR functions cause the current thread 67 to be suspended from execution until either the time interval specified by the 68 \fIrqtp\fR argument has elapsed or a signal is delivered to the calling thread 69 and its action is to invoke a signal-catching function or to terminate the 70 process. The suspension time may be longer than requested because the argument 71 value is rounded up to an integer multiple of the sleep resolution or because of 72 the scheduling of other activity by the system. But, except for the case of 73 being interrupted by a signal, the suspension time will not be less than the 74 time specified by \fIrqtp\fR, as measured by the system clock, 75 \fBCLOCK_REALTIME\fR. 76 .sp 77 .LP 78 The use of the \fBnanosleep()\fR and \fBthrd_sleep()\fR functions has no effect 79 on the action or blockage of any signal. 80 .SH RETURN VALUES 81 If the \fBnanosleep()\fR or \fBthrd_sleep()\fR function returns because the 82 requested time has elapsed, its return value is \fB0\fR. 83 .sp 84 .LP 85 If the \fBnanosleep()\fR function returns because it has been interrupted by a 86 signal, the function returns a value of \(mi1 and sets \fBerrno\fR to indicate 87 the interruption. If the \fIrmtp\fR argument is non-\fINULL\fR, the 88 \fBtimespec\fR structure referenced by it is updated to contain the amount of 89 time remaining in the interval (the requested time minus the time actually 90 slept). If the \fIrmtp\fR argument is \fINULL\fR, the remaining time is not 91 returned. 92 .sp 93 .LP 94 If \fBnanosleep()\fR fails, it returns \fB\(mi1\fR and sets \fBerrno\fR to 95 indicate the error. 96 .sp 97 .LP 98 The 99 .B thrd_sleep() 100 function may fail for identical reasons as the 101 .B nanosleep() 102 function and returns \(mi1; however, the C11 standard does not define that 103 .B errno 104 should be set, therefore callers of \fBthrd_sleep()\fR cannot rely on 105 .B errno 106 being set or staying the same across a call to 107 .B thrd_sleep() . 108 109 .SH ERRORS 110 The \fBnanosleep()\fR function will fail if: 111 .sp 112 .ne 2 113 .na 114 \fB\fBEINTR\fR\fR 115 .ad 116 .RS 10n 117 The \fBnanosleep()\fR function was interrupted by a signal. 118 .RE 119 120 .sp 121 .ne 2 122 .na 123 \fB\fBEINVAL\fR\fR 124 .ad 125 .RS 10n 126 The \fIrqtp\fR argument specified a nanosecond value less than zero or greater 127 than or equal to 1000 million. 128 .RE 129 130 .sp 131 .ne 2 132 .na 133 \fB\fBENOSYS\fR\fR 134 .ad 135 .RS 10n 136 The \fBnanosleep()\fR function is not supported by this implementation. 137 .RE 138 139 .SH ATTRIBUTES 140 See \fBattributes\fR(5) for descriptions of the following attributes: 141 .sp 142 143 .sp 144 .TS 145 box; 146 c | c 147 l | l . 148 ATTRIBUTE TYPE ATTRIBUTE VALUE 149 _ 150 Interface Stability Committed 151 _ 152 MT-Level MT-Safe 153 _ 154 Standard See \fBstandards\fR(5). 155 .TE 156 157 .SH SEE ALSO 158 \fBsleep\fR(3C), \fBtime.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) --- EOF ---