summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Dempsky <matthew@cvs.openbsd.org>2014-06-27 21:06:34 +0000
committerMatthew Dempsky <matthew@cvs.openbsd.org>2014-06-27 21:06:34 +0000
commit2bd3363d1751c5e3b3a9b4a11362d576e8f0a0d2 (patch)
treebd9fa033e513effc90b0ef43374c207e382492a2
parentc32b75bffd068c180ad1fc053f192e902bbd4268 (diff)
Cleanup ioctl.2 slightly:
- Markup ioctl argument types with Fa - Be clearer that ioctl arguments are pointers to ints. Similar changes to follow for manual pages that describe device-specific ioctl commands. Discussed with jmc and schwarze.
-rw-r--r--lib/libc/sys/ioctl.214
1 files changed, 7 insertions, 7 deletions
diff --git a/lib/libc/sys/ioctl.2 b/lib/libc/sys/ioctl.2
index 80132765a1b..57a21a803d3 100644
--- a/lib/libc/sys/ioctl.2
+++ b/lib/libc/sys/ioctl.2
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ioctl.2,v 1.17 2014/01/21 03:15:45 schwarze Exp $
+.\" $OpenBSD: ioctl.2,v 1.18 2014/06/27 21:06:33 matthew Exp $
.\" $NetBSD: ioctl.2,v 1.5 1995/02/27 12:33:47 cgd Exp $
.\"
.\" Copyright (c) 1980, 1991, 1993
@@ -30,14 +30,14 @@
.\"
.\" @(#)ioctl.2 8.2 (Berkeley) 12/11/93
.\"
-.Dd $Mdocdate: January 21 2014 $
+.Dd $Mdocdate: June 27 2014 $
.Dt IOCTL 2
.Os
.Sh NAME
.Nm ioctl
.Nd control device
.Sh SYNOPSIS
-.Fd #include <sys/ioctl.h>
+.In sys/ioctl.h
.Ft int
.Fn ioctl "int d" "unsigned long request" "..."
.Sh DESCRIPTION
@@ -98,9 +98,9 @@ Some generic ioctls are not implemented for all types of file
descriptors.
These include:
.Bl -tag -width "xxxxxx"
-.It Dv FIONREAD "int"
+.It Dv FIONREAD Fa "int *"
Get the number of bytes that are immediately available for reading.
-.It Dv FIONBIO "int"
+.It Dv FIONBIO Fa "int *"
Set non-blocking I/O mode if the argument is non-zero.
In non-blocking mode,
.Xr read 2
@@ -111,7 +111,7 @@ calls return \-1 and set
to
.Er EAGAIN
immediately when no data is available.
-.It Dv FIOASYNC "int"
+.It Dv FIOASYNC Fa "int *"
Set asynchronous I/O mode if the argument is non-zero.
In asynchronous mode, the process or process group specified by
.Dv FIOSETOWN
@@ -122,7 +122,7 @@ The
.Dv SIGIO
signal will be delivered when data is available on the file
descriptor.
-.It Dv FIOSETOWN, FIOGETOWN "int"
+.It Dv FIOSETOWN, FIOGETOWN Fa "int *"
Set/get the process or the process group (if negative) that should receive
.Dv SIGIO
signals when data is available.