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

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

diff --git a/usr/src/lib/libc/sys/ioctl.2 b/usr/src/lib/libc/sys/ioctl.2
index 9fdd2dd..aca614d 100644 (file)
--- a/usr/src/lib/libc/sys/ioctl.2
+++ b/usr/src/lib/libc/sys/ioctl.2
@@ -1,65 +1,80 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1991 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)ioctl.2     6.3 (Berkeley) %G%
+.\" %sccs.include.redist.man%

 .\"
 .\"

-.TH IOCTL 2 ""
-.UC 4
-.SH NAME
-ioctl \- control device
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/ioctl.h>
-.PP
-.ft B
-ioctl(d, request, argp)
-int d;
-unsigned long request;
-char *argp;
-.fi
-.ft R
-.SH DESCRIPTION
-.I Ioctl
-performs a variety of functions
-on open descriptors.  In particular, many operating
+.\"     @(#)ioctl.2    6.4 (Berkeley) %G%
+.\"
+.Dd 
+.Dt IOCTL 2
+.Os BSD 4
+.Sh NAME
+.Nm ioctl
+.Nd control device
+.Sh SYNOPSIS
+.Fd #include <sys/ioctl.h>
+.Ft int
+.Fn ioctl "int d" "unsigned long request" "char *argp"
+.Sh DESCRIPTION
+The
+.Fn ioctl
+function manipulates the underlying device parameters of special files.
+In particular, many operating

 characteristics of character special files (e.g. terminals)
 may be controlled with
 characteristics of character special files (e.g. terminals)
 may be controlled with

-.I ioctl
+.Fn ioctl

 requests.
 requests.

-The writeups of various devices in section 4 discuss how
-.I ioctl
-applies to them.
-.PP
+The argument
+.Fa d
+must be an open file descriptor.
+.Pp

 An  ioctl
 An  ioctl

-.I request
-has encoded in it whether the argument is an \*(lqin\*(rq parameter
-or \*(lqout\*(rq parameter, and the size of the argument \fIargp\fP in bytes.
+.Fa request
+has encoded in it whether the argument is an
+.Dq in
+parameter
+or
+.Dq out
+parameter, and the size of the argument
+.Fa argp
+in bytes.

 Macros and defines used in specifying an ioctl
 Macros and defines used in specifying an ioctl

-.I request
+.Fa request

 are located in the file
 are located in the file

-.IR <sys/ioctl.h> .
-.SH "RETURN VALUE
-If an error has occurred, a value of \-1 is returned and
-.I errno
+.Ao Pa sys/ioctl.h Ac .
+.Sh RETURN VALUES
+If an error has occurred, a value of -1 is returned and
+.Va errno

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

-.SH ERRORS
-.I Ioctl
-will fail if one or more of the following are true:
-.TP 15
-[EBADF]
-\fID\fP is not a valid descriptor.
-.TP 15
-[ENOTTY]
-\fID\fP is not associated with a character
+.Sh ERRORS
+.Fn Ioctl
+will fail:
+.Bl -tag -width [ENOTTY]
+.It Bq Er EBADF
+.Fa d
+is not a valid descriptor.
+.It Bq Er ENOTTY
+.Fa d
+is not associated with a character

 special device.
 special device.

-.TP 15
-[ENOTTY]
+.It Bq Er ENOTTY

 The specified request does not apply to the kind
 The specified request does not apply to the kind

-of object that the descriptor \fId\fP references.
-.TP 15
-[EINVAL]
-\fIRequest\fP or \fIargp\fP is not valid.
-.SH "SEE ALSO"
-execve(2), fcntl(2), mt(4), tty(4), intro(4N)
+of object that the descriptor
+.Fa d
+references.
+.It Bq Er EINVAL
+.Fa Request
+or
+.Fa argp
+is not valid.
+.El
+.Sh SEE ALSO
+.Xr mt 1 ,
+.Xr execve 2 ,
+.Xr fcntl 2 ,
+.Xr tty 4 ,
+.Xr intro 4
+.Sh HISTORY
+An
+.Nm
+function call appeared in Version 7 AT&T UNIX.