Print this page 
11622 clean up rarer mandoc lint warnings
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man3c/nanosleep.3c
          +++ new/usr/src/man/man3c/nanosleep.3c
↓ open down ↓ 41 lines elided ↑ open up ↑ 
  42   42  .\"
  43   43  .\" Copyright 1989 AT&T
  44   44  .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  45   45  .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
  46   46  .\" Copyright 2016 Joyent, Inc.
  47   47  .\"
  48   48  .TH NANOSLEEP 3C "Mar 27, 2016"
  49   49  .SH NAME
  50   50  nanosleep, thrd_sleep \- high resolution sleep
  51   51  .SH SYNOPSIS
  52      -.LP
  53   52  .nf
  54   53  #include <time.h>
  55   54  
  56   55  \fBint\fR \fBnanosleep\fR(\fBconst struct timespec *\fR\fIrqtp\fR,
  57   56       \fBstruct timespec *\fR\fIrmtp\fR);
  58   57  .fi
  59   58  
  60   59  .nf
  61   60  #include <threads.h>
  62   61  
  63   62  \fBint\fR \fBthrd_sleep\fR(\fBconst struct timespec *\fR\fIrqtp\fR,
  64   63       \fBstruct timespec *\fR\fIrmtp\fR);
  65   64  
  66   65  .SH DESCRIPTION
  67      -.LP
  68   66  The \fBnanosleep()\fR and \fBthrd_sleep()\fR functions cause the current thread
  69   67  to be suspended from execution until either the time interval specified by the
  70   68  \fIrqtp\fR argument has elapsed or a signal is delivered to the calling thread
  71   69  and its action is to invoke a signal-catching function or to terminate the
  72   70  process. The suspension time may be longer than requested because the argument
  73   71  value is rounded up to an integer multiple of the sleep resolution or because of
  74   72  the scheduling of other activity by the system. But, except for the case of
  75   73  being interrupted by a signal, the suspension time will not be less than the
  76   74  time specified by \fIrqtp\fR, as measured by the system clock,
  77   75  \fBCLOCK_REALTIME\fR.
  78   76  .sp
  79   77  .LP
  80   78  The use of the \fBnanosleep()\fR and \fBthrd_sleep()\fR functions has no effect
  81   79  on the action or blockage of any signal.
  82   80  .SH RETURN VALUES
  83      -.LP
  84   81  If the \fBnanosleep()\fR or \fBthrd_sleep()\fR function returns because the
  85   82  requested time has elapsed, its return value is \fB0\fR.
  86   83  .sp
  87   84  .LP
  88   85  If the \fBnanosleep()\fR function returns because it has been interrupted by a
  89   86  signal, the function returns a value of \(mi1 and sets \fBerrno\fR to indicate
  90   87  the interruption. If the \fIrmtp\fR argument is non-\fINULL\fR, the
  91   88  \fBtimespec\fR structure referenced by it is updated to contain the amount of
  92   89  time remaining in the interval (the requested time minus the time actually
  93   90  slept). If the \fIrmtp\fR argument is \fINULL\fR, the remaining time is not
  94   91  returned.
  95   92  .sp
  96   93  .LP
  97   94  If \fBnanosleep()\fR fails, it returns \fB\(mi1\fR and sets \fBerrno\fR to
  98   95  indicate the error.
  99   96  .sp
 100   97  .LP
 101      -
 102   98  The
 103   99  .B thrd_sleep()
 104  100  function may fail for identical reasons as the
 105  101  .B nanosleep()
 106  102  function and returns \(mi1; however, the C11 standard does not define that
 107  103  .B errno
 108  104  should be set, therefore callers of \fBthrd_sleep()\fR cannot rely on
 109  105  .B errno
 110  106  being set or staying the same across a call to
 111  107  .B thrd_sleep() .
 112  108  
 113  109  .SH ERRORS
 114      -.LP
 115  110  The \fBnanosleep()\fR function will fail if:
 116  111  .sp
 117  112  .ne 2
 118  113  .na
 119  114  \fB\fBEINTR\fR\fR
 120  115  .ad
 121  116  .RS 10n
 122  117  The \fBnanosleep()\fR function was interrupted by a signal.
 123  118  .RE
 124  119
↓ open down ↓ 10 lines elided ↑ open up ↑ 
 135  130  .sp
 136  131  .ne 2
 137  132  .na
 138  133  \fB\fBENOSYS\fR\fR
 139  134  .ad
 140  135  .RS 10n
 141  136  The \fBnanosleep()\fR function is not supported by this implementation.
 142  137  .RE
 143  138  
 144  139  .SH ATTRIBUTES
 145      -.LP
 146  140  See \fBattributes\fR(5) for descriptions of the following attributes:
 147  141  .sp
 148  142  
 149  143  .sp
 150  144  .TS
 151  145  box;
 152  146  c | c
 153  147  l | l .
 154  148  ATTRIBUTE TYPE  ATTRIBUTE VALUE
 155  149  _
 156  150  Interface Stability     Committed
 157  151  _
 158  152  MT-Level        MT-Safe
 159  153  _
 160  154  Standard        See \fBstandards\fR(5).
 161  155  .TE
 162  156  
 163  157  .SH SEE ALSO
 164      -.LP
 165  158  \fBsleep\fR(3C), \fBtime.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX