Print this page
11622 clean up rarer mandoc lint warnings

Split Close
Expand all
Collapse all
          --- old/usr/src/man/man3c/epoll_create.3c
          +++ new/usr/src/man/man3c/epoll_create.3c
   1    1  '\" te
   2    2  .\"  Copyright (c) 2014, Joyent, Inc. All Rights Reserved.
   3    3  .\"  This file and its contents are supplied under the terms of the
   4    4  .\"  Common Development and Distribution License ("CDDL"), version 1.0.
   5    5  .\"  You may only use this file in accordance with the terms of version
   6    6  .\"  1.0 of the CDDL.
   7      -.\" 
        7 +.\"
   8    8  .\"  A full copy of the text of the CDDL should have accompanied this
   9    9  .\"  source.  A copy of the CDDL is also available via the Internet at
  10   10  .\"  http://www.illumos.org/license/CDDL.
  11   11  .TH EPOLL_CREATE 3C "April 9, 2016"
  12   12  .SH NAME
  13   13  epoll_create, epoll_create1 \- create an epoll instance
  14   14  .SH SYNOPSIS
  15      -
  16      -.LP
  17   15  .nf
  18   16  #include <sys/epoll.h>
  19   17  
  20   18  \fBint\fR \fBepoll_create\fR(\fBint\fR \fIsize\fR);
  21   19  .fi
  22   20  
  23   21  .LP
  24   22  .nf
  25   23  \fBint\fR \fBepoll_create1\fR(\fBint\fR \fIflags\fR);
  26   24  .fi
  27   25  
  28   26  .SH DESCRIPTION
  29      -.LP
  30   27  The \fBepoll_create()\fR and \fBepoll_create1()\fR functions both create an
  31   28  \fBepoll\fR(5) instance that can be operated upon via \fBepoll_ctl\fR(3C),
  32   29  \fBepoll_wait\fR(3C) and \fBepoll_pwait\fR(3C).  \fBepoll\fR instances are
  33   30  represented as file descriptors, and should be closed via \fBclose\fR(2).
  34   31  
  35   32  The only difference between the two functions is their signature;
  36   33  \fBepoll_create()\fR takes a size argument that
  37   34  is vestigal and is only meaningful in as much as it must be greater than
  38   35  zero, while \fBepoll_create1()\fR takes a flags argument that can have
  39   36  any of the following values:
↓ open down ↓ 2 lines elided ↑ open up ↑
  42   39  .ne 2
  43   40  .na
  44   41  \fBEPOLL_CLOEXEC\fR
  45   42  .ad
  46   43  .RS 12n
  47   44  Instance should be closed upon an
  48   45  \fBexec\fR(2); see \fBopen\fR(2)'s description of \fBO_CLOEXEC\fR.
  49   46  .RE
  50   47  
  51   48  .SH RETURN VALUES
  52      -.LP
  53   49  Upon successful completion, 0 is returned. Otherwise, -1 is returned and errno
  54   50  is set to indicate the error.
  55   51  .SH ERRORS
  56      -.LP
  57   52  The \fBepoll_create()\fR and \fBepoll_create1()\fR functions will fail if:
  58   53  .sp
  59   54  .ne 2
  60   55  .na
  61   56  \fB\fBEINVAL\fR\fR
  62   57  .ad
  63   58  .RS 10n
  64   59  Either the \fIsize\fR is zero (\fBepoll_create()\fR) or the \fIflags\fR
  65   60  are invalid (\fBepoll_create1()\fR).
  66   61  .RE
↓ open down ↓ 12 lines elided ↑ open up ↑
  79   74  .ne 2
  80   75  .na
  81   76  \fB\fBENFILE\fR\fR
  82   77  .ad
  83   78  .RS 10n
  84   79  The maximum allowable number of files is currently open in the system.
  85   80  .RE
  86   81  
  87   82  .sp
  88   83  .SH NOTES
  89      -.LP
  90      -
  91   84  The \fBepoll\fR(5) facility is implemented for purposes of offering
  92   85  compatibility for Linux-borne applications; native
  93   86  applications should continue to prefer using event ports via the
  94   87  \fBport_create\fR(3C), \fBport_associate\fR(3C) and \fBport_get\fR(3C)
  95   88  interfaces.  See \fBepoll\fR(5) for compatibility details and restrictions.
  96   89  
  97   90  .SH SEE ALSO
  98      -.LP
  99   91  \fBepoll_ctl\fR(3C), \fBepoll_wait\fR(3C), \fBepoll\fR(5)
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX