Print this page
10533 Convert sockio(7I) to mandoc

Split Close
Expand all
Collapse all
          --- old/usr/src/man/man7i/sockio.7i
          +++ new/usr/src/man/man7i/sockio.7i
   1      -'\" te
        1 +.\"  Copyright (c) 2017, Joyent, Inc.
   2    2  .\"  Copyright 1989 AT&T  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3      -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4      -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5      -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6      -.TH SOCKIO 7I "Nov 8, 1996"
   7      -.SH NAME
   8      -sockio \- ioctls that operate directly on sockets
   9      -.SH SYNOPSIS
  10      -.LP
  11      -.nf
  12      -#include <sys/sockio.h>
  13      -.fi
  14      -
  15      -.SH DESCRIPTION
  16      -.sp
  17      -.LP
  18      -The \fBioctls\fR listed in this manual page apply directly to sockets,
  19      -independent of any underlying protocol. The \fBsetsockopt()\fR call (see
  20      -\fBgetsockopt\fR(3SOCKET)) is the primary method for operating on sockets,
  21      -rather than on the underlying protocol or network interface. \fBioctl\fRs for a
  22      -specific network interface or protocol are documented in the manual page for
  23      -that interface or protocol.
  24      -.sp
  25      -.ne 2
  26      -.na
  27      -\fB\fBSIOCSPGRP\fR\fR
  28      -.ad
  29      -.RS 15n
  30      -The argument is a pointer to an \fBint\fR. Set the process-group \fBID\fR that
  31      -will subsequently receive \fBSIGIO\fR or \fBSIGURG\fR signals for the socket
  32      -referred to by the descriptor passed to \fBioctl\fR to the value of that
  33      -\fBint\fR. The argument must be either positive (in which case it must  be a
  34      -process \fBID)\fR or negative (in which case it must be a process group).
  35      -.RE
  36      -
  37      -.sp
  38      -.ne 2
  39      -.na
  40      -\fB\fBSIOCGPGRP\fR\fR
  41      -.ad
  42      -.RS 15n
  43      -The argument is a pointer to an \fBint\fR. Set the value of that \fBint\fR to
  44      -the process-group \fBID\fR that is receiving \fBSIGIO\fR or \fBSIGURG\fR
  45      -signals for the socket referred to by the descriptor passed to \fBioctl\fR.
  46      -.RE
  47      -
  48      -.sp
  49      -.ne 2
  50      -.na
  51      -\fB\fBSIOCCATMARK\fR\fR
  52      -.ad
  53      -.RS 15n
  54      -The argument is a pointer to an \fBint\fR. Set the value of that \fBint\fR to
  55      -\fB1\fR if the read pointer for the socket referred to by the descriptor passed
  56      -to \fBioctl\fR points to a mark in the data stream for an out-of-band message.
  57      -Set the value of that \fBint\fR to \fB0\fR if the read pointer for the socket
  58      -referred to by the descriptor passed to \fBioctl\fR  does not point to a mark
  59      -in the data stream for an  out-of-band message.
  60      -.RE
  61      -
  62      -.SH SEE ALSO
  63      -.sp
  64      -.LP
  65      -\fBioctl\fR(2), \fBgetsockopt\fR(3SOCKET)
        3 +.\" The contents of this file are subject to the terms of the
        4 +.\" Common Development and Distribution License (the "License").
        5 +.\" You may not use this file except in compliance with the License.
        6 +.\"
        7 +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
        8 +.\" or http://www.opensolaris.org/os/licensing.
        9 +.\" See the License for the specific language governing permissions
       10 +.\" and limitations under the License.
       11 +.\"
       12 +.\" When distributing Covered Code, include this CDDL HEADER in each
       13 +.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
       14 +.\" If applicable, add the following below this CDDL HEADER, with the
       15 +.\" fields enclosed by brackets "[]" replaced with your own identifying
       16 +.\" information: Portions Copyright [yyyy] [name of copyright owner]
       17 +.Dd October 29, 2017
       18 +.Dt SOCKIO 7I
       19 +.Os
       20 +.Sh NAME
       21 +.Nm sockio
       22 +.Nd ioctls that operate directly on sockets
       23 +.Sh SYNOPSIS
       24 +.In sys/sockio.h
       25 +.Sh DESCRIPTION
       26 +The
       27 +.Sy ioctl Ns s
       28 +listed in this manual page apply directly to sockets,
       29 +independent of any underlying protocol.
       30 +The
       31 +.Xr setsockopt 3SOCKET
       32 +call
       33 +.Po
       34 +see
       35 +.Xr getsockopt 3SOCKET
       36 +.Pc
       37 +is the primary method for operating on sockets,
       38 +rather than on the underlying protocol or network interface.
       39 +.Sy ioctl Ns s
       40 +for a specific network interface or protocol are documented in the manual page
       41 +for that interface or protocol.
       42 +.Bl -tag -width SIOCCATMARK
       43 +.It Dv SIOCSPGRP
       44 +The argument is a pointer to an
       45 +.Vt int .
       46 +Set the process-group
       47 +.Sy ID
       48 +that will subsequently receive
       49 +.Dv SIGIO
       50 +or
       51 +.Dv SIGURG
       52 +signals for the socket
       53 +referred to by the descriptor passed to
       54 +.Sy ioctl
       55 +to the value of that
       56 +.Vt int .
       57 +The argument must be either positive (in which case it must be a
       58 +process
       59 +.Sy ID )
       60 +or negative (in which case it must be a process group).
       61 +.It Dv SIOCGPGRP
       62 +The argument is a pointer to an
       63 +.Vt int .
       64 +Get the value of that
       65 +.Vt int
       66 +to the process-group
       67 +.Sy ID
       68 +that is receiving
       69 +.Dv SIGIO
       70 +or
       71 +.Dv SIGURG
       72 +signals for the socket referred to by the descriptor passed to
       73 +.Sy ioctl .
       74 +.It Dv SIOCCATMARK
       75 +The argument is a pointer to an
       76 +.Vt int .
       77 +Set the value of that
       78 +.Vt int
       79 +to
       80 +.Sy 1
       81 +if the read pointer for the socket referred to by the descriptor passed
       82 +to
       83 +.Xr ioctl 2
       84 +points to a mark in the data stream for an out-of-band message.
       85 +Set the value of that
       86 +.Vt int
       87 +to
       88 +.Sy 0
       89 +if the read pointer for the socket
       90 +referred to by the descriptor passed to
       91 +.Sy ioctl
       92 +does not point to a mark
       93 +in the data stream for an out-of-band message.
       94 +.El
       95 +.Sh SEE ALSO
       96 +.Xr ioctl 2 ,
       97 +.Xr getsockopt 3SOCKET
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX