[src/trunk]: src/share/man/man9 Massively improve markup, fix a sentence and ...

[wiz <wiz%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/2bce8aefc881
branches:  trunk
changeset: 518907:2bce8aefc881
user:      wiz <wiz%NetBSD.org@localhost>
date:      Fri Dec 07 18:49:30 2001 +0000

description:
Massively improve markup, fix a sentence and two xrefs.

diffstat:

 share/man/man9/ioctl.9 |  255 ++++++++++++++++++++++++++++++++----------------
 1 files changed, 167 insertions(+), 88 deletions(-)

diffs (truncated from 320 to 300 lines):

diff -r ff8585235591 -r 2bce8aefc881 share/man/man9/ioctl.9
--- a/share/man/man9/ioctl.9    Fri Dec 07 15:14:29 2001 +0000
+++ b/share/man/man9/ioctl.9    Fri Dec 07 18:49:30 2001 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: ioctl.9,v 1.11 2001/09/13 17:19:55 atatat Exp $
+.\" $NetBSD: ioctl.9,v 1.12 2001/12/07 18:49:30 wiz Exp $
 .\"
 .\" Copyright (c) 1999  The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -34,7 +34,7 @@
 .\" ARISING IN ANY WAY  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd March 7, 1999
+.Dd December 7, 2001
 .Dt IOCTL 9
 .Os
 .Sh NAME
@@ -44,20 +44,21 @@
 .Fd #include <sys/ioctl.h>
 .Fd #include <sys/ioccom.h>
 .Ft int
-.Fn ioctl int, unsigned long, ...
+.Fn ioctl "int" "unsigned long" "..."
 .Sh DESCRIPTION
 .Nm
 are internally defined as
 .Bl -tag -width define
 .It #define FOOIOCTL   fun(t,n,pt)
 .El
-
+.Pp
 where the different variables and functions are:
 .Bl -tag -width FOOIOCTL
 .It Fn FOOIOCTL
-the name as the ioctl is later known in a as second argument to a
+the name which will later be given in the
 .Xr ioctl 2
-system call. E.g. ioctl(s,FOOIOCTL,...)
+system call as second argument, e.g.
+.Dl ioctl(s, FOOIOCTL, ...) .
 .It Fn fun
 a macro which can be one of
 .Bl -tag -width _IOWR
@@ -73,107 +74,185 @@
 .It _IOWR
 the call writes data to the kernel and wants information back.
 .El
-.It t
+.It Ar t
 This integer describes to which subsystem the ioctl applies.
-T
+.Ar t
 can be one of
-.Bl -tag -width 'a' -compact
-.It '1' pulse-per-second interface
-.It '4' Xr i4b 4
-.It 'a' ISO networking
-.It 'A' ac devices (hp300)
-.It 'A' Advanced Power Management (hpcmips, i386, sparc) Xr apm 4
-.It 'A' ADB devices (mac68k, macppc)
-.It 'A' Xr audio 4
-.It 'A' Xr i4btel 4
-.It 'b' Xr tb 4
-.It 'B' bell device (x68k)
-.It 'B' Xr bpf 4
-.It 'c' coda
-.It 'c' Xr cd 4
-.It 'c' Xr ch 4
-.It 'C' clock devices (amiga, atari, hp300, x68k)
-.It 'C' Xr i4bctl 4
-.It 'd' the disk subsystem
-.It 'E' Xr envsys 4
-.It 'f' files
-.It 'F' Sun-compatible framebuffers
-.It 'F' Xr ccd 4 \& and Xr vnd 4
-.It 'g' qdss framebuffers
-.It 'G' grf devices (amiga, atari, hp300, mac68k, x68k)
-.It 'h' HIL devices (hp300)
-.It 'H' HIL devices (hp300)
-.It 'H' HPc framebuffers
-.It 'i' a (pseudo) interface
-.It 'I' Xr ite 4 \& (mac68k)
-.It 'J' ISA joystick interface
-.It 'k' Sun-compatible (and other) keyboards
-.It 'K' Xr lkm 4
-.It 'l' leo devices (atari)
-.It 'm' Xr mtio 4
-.It 'M' mouse devices (atari)
-.It 'M' Xr mlx 4
-.It 'n' virtual console device (arm32)
-.It 'n' SMB networking
-.It 'O' OpenPROM and OpenFirmware
-.It 'p' power control (x68k)
-.It 'P' parallel port (amiga, x68k)
-.It 'P' profiling (arm32)
-.It 'P' printer/plotter interface (hp300)
-.It 'P' Xr magma 4 \& bpp (sparc)
-.It 'q' Xr altq 4
-.It 'q' pmax graphics devices
-.It 'Q' Xr altq 4
-.It 'Q' raw SCSI commands
-.It 'r' the routing subsystem
-.It 'r' Xr md 4
-.It 'R' Xr i4brbch 4
-.It 'R' Xr rnd 4
-.It 's' the socket layer
-.It 's' satlink devices
-.It 'S' SCSI disks (arc, hp300, pmax)
-.It 'S' watchdog devices (sh3)
-.It 'S' ISA speaker devices
-.It 'S' stic devices
-.It 'S' scanners
-.It 't' the tty layer
-.It 'u' user defined ???
-.It 'U' scsibus Pq Xr scsi 4
-.It 'v' Sun-compatible Dq firm events
-.It 'V' view device (amiga, atari)
-.It 'V' sram device (x68k)
-.It 'w' watchdog devices
-.It 'W' wt devices
-.It 'W' wscons devices
-.It 'x' bt8xx devices
-.It 'Z' ite devices (amiga, atari, x68k)
-.It 'Z' passthrough ioctls
+.Bl -tag -width xxxxx -compact
+.It '1'
+pulse-per-second interface
+.It '4'
+.Xr i4b 4
+.It 'a'
+ISO networking
+.It 'A'
+ac devices (hp300)
+.It 'A'
+Advanced Power Management (hpcmips, i386, sparc), see
+.Xr apm 4
+.It 'A'
+ADB devices (mac68k, macppc)
+.It 'A'
+.Xr audio 4
+.It 'A'
+.Xr i4btel 4
+.It 'b'
+.Xr \&tb 4
+.It 'B'
+bell device (x68k)
+.It 'B'
+.Xr bpf 4
+.It 'c'
+coda
+.It 'c'
+.Xr \&cd 4
+.It 'c'
+.Xr \&ch 4
+.It 'C'
+clock devices (amiga, atari, hp300, x68k)
+.It 'C'
+.Xr i4bctl 4
+.It 'd'
+the disk subsystem
+.It 'E'
+.Xr envsys 4
+.It 'f'
+files
+.It 'F'
+Sun-compatible framebuffers
+.It 'F'
+.Xr ccd 4
+and
+.Xr vnd 4
+.It 'g'
+qdss framebuffers
+.It 'G'
+grf devices (amiga, atari, hp300, mac68k, x68k)
+.It 'h'
+HIL devices (hp300)
+.It 'H'
+HIL devices (hp300)
+.It 'H'
+HPc framebuffers
+.It 'i'
+a (pseudo) interface
+.It 'I'
+.Xr ite 4
+(mac68k)
+.It 'J'
+ISA joystick interface
+.It 'k'
+Sun-compatible (and other) keyboards
+.It 'K'
+.Xr lkm 4
+.It 'l'
+leo devices (atari)
+.It 'm'
+.Xr mtio 4
+.It 'M'
+mouse devices (atari)
+.It 'M'
+.Xr mlx 4
+.It 'n'
+virtual console device (arm32)
+.It 'n'
+SMB networking
+.It 'O'
+OpenPROM and OpenFirmware
+.It 'p'
+power control (x68k)
+.It 'P'
+parallel port (amiga, x68k)
+.It 'P'
+profiling (arm32)
+.It 'P'
+printer/plotter interface (hp300)
+.It 'P'
+.Xr magma 4
+bpp (sparc)
+.It 'q'
+.Xr altq 9
+.It 'q'
+pmax graphics devices
+.It 'Q'
+.Xr altq 9
+.It 'Q'
+raw SCSI commands
+.It 'r'
+the routing subsystem
+.It 'r'
+.Xr \&md 4
+.It 'R'
+.Xr i4brbch 4
+.It 'R'
+.Xr rnd 4
+.It 's'
+the socket layer
+.It 's'
+satlink devices
+.It 'S'
+SCSI disks (arc, hp300, pmax)
+.It 'S'
+watchdog devices (sh3)
+.It 'S'
+ISA speaker devices
+.It 'S'
+stic devices
+.It 'S'
+scanners
+.It 't'
+the tty layer
+.It 'u'
+user defined ???
+.It 'U'
+scsibus (see
+.Xr scsi 4 )
+.It 'v'
+Sun-compatible
+.Dq firm events
+.It 'V'
+view device (amiga, atari)
+.It 'V'
+sram device (x68k)
+.It 'w'
+watchdog devices
+.It 'W'
+wt devices
+.It 'W'
+wscons devices
+.It 'x'
+bt8xx devices
+.It 'Z'
+ite devices (amiga, atari, x68k)
+.It 'Z'
+passthrough ioctls
 .El
-.It n
+.It Ar n
 This numbers the ioctl within the group. There may be only one
-.Fn n
+.Ar n
 for a given
-.Fn t .
+.Ar t .
 This is a unsigned 8 bit number.
-.It pt
+.It Ar pt
 This specifies the type of the passed parameter. This one gets internally
 transformed to the size of the parameter, so if you e.g. want to pass
 a structure, then you have to specify that structure and not a pointer
 to it or sizeof(struct foo)
 .El
-
+.Pp
 In order for the new ioctl to be known to the system it is installed
 in either <sys/ioctl.h> or one of the files that are reached from
 <sys/ioctl.h>.
 .Sh EXAMPLES
-
+.Bd -literal
    #define FOOIOCTL    _IOWR('i',23,int)