Use .Dv for ioctls in several manual pages.
authorSascha Wildner <saw@online.de>
Sun, 22 Mar 2009 18:12:57 +0000 (19:12 +0100)
committerSascha Wildner <saw@online.de>
Sun, 22 Mar 2009 18:13:16 +0000 (19:13 +0100)
15 files changed:
share/man/man4/iic.4
share/man/man4/man4.i386/gsc.4
share/man/man4/netintro.4
share/man/man4/pf.4
share/man/man4/pty.4
share/man/man4/ses.4
share/man/man4/smb.4
share/man/man4/tap.4
share/man/man4/tty.4
share/man/man4/xpt.4
usr.bin/sasc/sasc.1
usr.sbin/i4b/isdnd/isdnd.8
usr.sbin/i4b/man/i4b.4
usr.sbin/i4b/man/i4btel.4
usr.sbin/ppp/ppp.8.m4

index 69ab3ce..8b4b893 100644 (file)
@@ -42,11 +42,11 @@ instance.
 In order to control I2C devices, use /dev/iic? with the
 following ioctls:
 .Pp
-.Bl -column "I2CRSTCARD" -compact
+.Bl -column ".Dv I2CRSTCARD" -compact
 .It Em Ioctl Ta Em Description
-.It Sy I2CSTART Ta "send start condition to the specified device (with 7-bit address) on the bus"
-.It Sy I2CSTOP Ta "send stop condition to the bus"
-.It Sy I2CRSTCARD Ta "reset the bus"
+.It Dv I2CSTART Ta "send start condition to the specified device (with 7-bit address) on the bus"
+.It Dv I2CSTOP Ta "send stop condition to the bus"
+.It Dv I2CRSTCARD Ta "reset the bus"
 .El
 .Pp
 You may also use read/write routines, then I2C start/stop handshake is
index 410439c..43ed7b2 100644 (file)
@@ -133,23 +133,23 @@ There is a utility, called
 that provides access to these
 requests from within shell.
 .Bl -tag -width Ds
-.It GSC_SRES int
+.It Dv GSC_SRES Vt int
 Set the
 .Em resolution
 value.
 If this call is made after the first
 read access to the device there will be no effect unless the device is
 closed and opened again.
-.It GSC_GRES int
+.It Dv GSC_GRES Vt int
 Get current resolution in dots per inch (dpi).
-.It GSC_SRESSSW void
+.It Dv GSC_SRESSW Vt void
 Set resolution value from selector switch.
 The driver must be in an
 open though untouched state otherwise the request will fail and
 .Xr errno 2
 is set to
 .Er EBUSY .
-.It GSC_SWIDTH int
+.It Dv GSC_SWIDTH Vt int
 Set the
 .Em width
 of the bitmap.
@@ -191,9 +191,9 @@ by only by the hardware switch.
 Any line that is longer than what is
 defined for the actual resolution will be undefined (usually white) on
 the right part that is exceeding the standard line.
-.It GSC_GWIDTH int
+.It Dv GSC_GWIDTH Vt int
 Get current width of the bitmap in pixels.
-.It GSC_SHEIGHT int
+.It Dv GSC_SHEIGHT Vt int
 Set the
 .Em height
 of the bitmap in
@@ -205,9 +205,9 @@ operation.
 When the limit is reached read will return 0. However, the
 device is turned off only when a close is performed (either
 explicitly or implicitly on exit of the calling process).
-.It GSC_GHEIGHT int
+.It Dv GSC_GHEIGHT Vt int
 Get the current height of the bitmap.
-.It GSC_SBLEN int
+.It Dv GSC_SBLEN Vt int
 Set the length of the buffer used internally to do the DMA transfer.
 The buffer length is supplied in lines of the bitmap.
 Since the buffer
@@ -226,9 +226,9 @@ if the buffer length turns out too high.
 It is generally wise to
 choose long buffers rather than go save in order to obtain better
 output.
-.It GSC_GBLEN int
+.It Dv GSC_GBLEN Vt int
 Get the current buffer length in lines.
-.It GSC_SBTIME int
+.It Dv GSC_SBTIME Vt int
 Set the timeout for the completion of reading one buffer.
 Since a
 handy scanner is a human/computer interface timeout values are usually
@@ -243,11 +243,13 @@ not cause you to scan faster for longer images.
 BLEN/BTIME is similar
 as MIN/TIME in
 .Xr termios 4 .
-.It GSC_GBTIME int
+.It Dv GSC_GBTIME Vt int
 Get the current buffer timeout.
 .El
 .Pp
-All ioctl requests that modify a parameter except GSC_SBTIME do not
+All ioctl requests that modify a parameter except
+.Dv GSC_SBTIME
+do not
 have an effect on an ongoing scan process, i.e. after the first read
 request that follows open.
 You must close the device and open it again
index c9a2af3..21391e4 100644 (file)
@@ -217,7 +217,7 @@ struct      ifreq {
 .Ed
 .Pp
 Calls which are now deprecated are:
-.Bl -tag -width SIOCGIFBRDADDR
+.Bl -tag -width ".Dv SIOCGIFBRDADDR"
 .It Dv SIOCSIFADDR
 Set interface address for protocol family.  Following the address
 assignment, the ``initialization'' routine for
@@ -234,7 +234,7 @@ retrieve other data are still fully supported
 and use the
 .Vt ifreq
 structure:
-.Bl -tag -width SIOCGIFBRDADDR
+.Bl -tag -width ".Dv SIOCGIFBRDADDR"
 .It Dv SIOCGIFADDR
 Get interface address for protocol family.
 .It Dv SIOCGIFDSTADDR
@@ -266,7 +266,7 @@ Attempt to destroy the specified interface.
 .El
 .Pp
 There are two requests that make use of a new structure:
-.Bl -tag -width SIOCGIFBRDADDR
+.Bl -tag -width ".Dv SIOCGIFBRDADDR"
 .It Dv SIOCAIFADDR
 An interface may have more than one address associated with it
 in some protocols.  This request provides a means to
index f104f65..187a050 100644 (file)
@@ -96,13 +96,21 @@ struct pfioc_pooladdr {
 Clears the buffer address pool
 and returns a
 .Va ticket
-for subsequent DIOCADDADDR, DIOCADDRULE and DIOCCHANGERULE calls.
+for subsequent
+.Dv DIOCADDADDR ,
+.Dv DIOCADDRULE
+and
+.Dv DIOCCHANGERULE
+calls.
 .It Dv DIOCADDADDR     Fa "struct pfioc_pooladdr"
 .Pp
 Adds pool address
 .Va addr
 to the buffer address pool to be used in the following
-DIOCADDRULE or DIOCCHANGERULE call.
+.Dv DIOCADDRULE
+or
+.Dv DIOCCHANGERULE
+call.
 All other members of the structure are ignored.
 .It Dv DIOCADDRULE     Fa "struct pfioc_rule"
 .Bd -literal
@@ -122,10 +130,15 @@ Adds
 at the end of the inactive ruleset.
 Requires
 .Va ticket
-obtained through preceding DIOCXBEGIN call, and
+obtained through preceding
+.Dv DIOCXBEGIN
+call, and
 .Va pool_ticket
-obtained through DIOCBEGINADDRS call.
-DIOCADDADDR must also be called if any pool addresses are required.
+obtained through
+.Dv DIOCBEGINADDRS
+call.
+.Dv DIOCADDADDR
+must also be called if any pool addresses are required.
 The optional
 .Va anchor
 and
@@ -148,7 +161,9 @@ struct pfioc_altq {
 .It Dv DIOCGETRULES    Fa "struct pfioc_rule"
 Returns
 .Va ticket
-for subsequent DIOCGETRULE calls and
+for subsequent
+.Dv DIOCGETRULE
+calls and
 .Va nr
 of rules in the active ruleset.
 .It Dv DIOCGETRULE     Fa "struct pfioc_rule"
@@ -158,11 +173,15 @@ number
 .Va nr
 using
 .Va ticket
-obtained through a preceding DIOCGETRULES call.
+obtained through a preceding
+.Dv DIOCGETRULES
+call.
 .It Dv DIOCGETADDRS    Fa "struct pfioc_pooladdr"
 Returns
 .Va ticket
-for subsequent DIOCGETADDR calls and
+for subsequent
+.Dv DIOCGETADDR
+calls and
 .Va nr
 of pool addresses in the rule specified with
 .Va r_action ,
@@ -183,11 +202,15 @@ and
 .Va ruleset
 using
 .Va ticket
-obtained through a preceding DIOCGETADDRS call.
+obtained through a preceding
+.Dv DIOCGETADDRS
+call.
 .It Dv DIOCGETALTQS    Fa "struct pfioc_altq"
 Returns
 .Va ticket
-for subsequent DIOCGETALTQ calls and
+for subsequent
+.Dv DIOCGETALTQ
+calls and
 .Va nr
 of queues in the active list.
 .It Dv DIOCGETALTQ     Fa "struct pfioc_altq"
@@ -197,7 +220,9 @@ number
 .Va nr
 using
 .Va ticket
-obtained through a preceding DIOCGETALTQS call.
+obtained through a preceding
+.Dv DIOCGETALTQS
+call.
 .It Dv DIOCGETQSTATS   Fa "struct pfioc_qstats"
 Returns statistics on a queue.
 .Bd -literal
@@ -326,8 +351,9 @@ The type of operation to be performed is indicated by
 must be set to the value obtained with PF_CHANGE_GET_TICKET
 for all actions except PF_CHANGE_GET_TICKET.
 .Va pool_ticket
-must be set to the value obtained with the DIOCBEGINADDRS call
-for all actions except PF_CHANGE_REMOVE and PF_CHANGE_GET_TICKET.
+must be set to the value obtained with the
+.Dv DIOCBEGINADDRS
+call for all actions except PF_CHANGE_REMOVE and PF_CHANGE_GET_TICKET.
 .Pp
 .Va anchor
 and
@@ -765,8 +791,9 @@ will be set by the kernel to the number of interfaces and drivers
 that have been cleared.
 .El
 .Sh EXAMPLES
-The following example demonstrates how to use the DIOCNATLOOK command
-to find the internal host/port of a NATed connection.
+The following example demonstrates how to use the
+.Dv DIOCNATLOOK
+command to find the internal host/port of a NATed connection.
 .Bd -literal
 #include <sys/types.h>
 #include <sys/socket.h>
index 70cbcf3..f89d783 100644 (file)
@@ -68,7 +68,7 @@ device.
 The following
 .Xr ioctl 2
 calls apply only to pseudo terminals:
-.Bl -tag -width TIOCREMOTE
+.Bl -tag -width ".Dv TIOCREMOTE"
 .It Dv TIOCSTOP
 Stops output to a terminal (e.g. like typing
 .Ql ^S ) .
index 1973384..46b985d 100644 (file)
@@ -80,7 +80,7 @@ devices.
 They are defined in the header file
 .In bus/cam/scsi/scsi_ses.h
 (\fIq.v.\fR).
-.Bl -tag -width SESIOC_GETENCSTAT
+.Bl -tag -width ".Dv SESIOC_GETENCSTAT"
 .It Dv SESIOC_GETNOBJ
 Used to find out how many
 .Nm
index 249a434..1267937 100644 (file)
@@ -44,20 +44,22 @@ following ioctls:
 .Pp
 .Bl -column "System Management Bus ioctls" -compact
 .It Em Ioctl Ta Em Description
-.It Sy SMB_QUICK_WRITE Ta "QuickWrite command"
-.It Sy SMB_QUICK_READ Ta "QuickRead command"
-.It Sy SMB_SENDB Ta "SendByte command"
-.It Sy SMB_RECVB Ta "ReceiveByte command"
-.It Sy SMB_WRITEB Ta "WriteByte command"
-.It Sy SMB_WRITEW Ta "WriteWord command"
-.It Sy SMB_READB Ta "ReadByte command"
-.It Sy SMB_READW Ta "ReadWord command"
-.It Sy SMB_PCALL Ta "ProcedureCall command"
-.It Sy SMB_BWRITE Ta "BlockWrite command"
-.It Sy SMB_BREAD Ta "BlockRead command"
+.It Dv SMB_QUICK_WRITE Ta "QuickWrite command"
+.It Dv SMB_QUICK_READ Ta "QuickRead command"
+.It Dv SMB_SENDB Ta "SendByte command"
+.It Dv SMB_RECVB Ta "ReceiveByte command"
+.It Dv SMB_WRITEB Ta "WriteByte command"
+.It Dv SMB_WRITEW Ta "WriteWord command"
+.It Dv SMB_READB Ta "ReadByte command"
+.It Dv SMB_READW Ta "ReadWord command"
+.It Dv SMB_PCALL Ta "ProcedureCall command"
+.It Dv SMB_BWRITE Ta "BlockWrite command"
+.It Dv SMB_BREAD Ta "BlockRead command"
 .El
 .Pp
-Using the write routine is equivalent to a SMB_WRITEW ioctl.
+Using the write routine is equivalent to a
+.Dv SMB_WRITEW
+ioctl.
 .Sh SEE ALSO
 .Xr smbus 4
 .Sh HISTORY
index 5aca382..2cf3f0c 100644 (file)
@@ -101,7 +101,7 @@ The following
 calls are supported
 (defined in
 .In net/tap/if_tap.h ) :
-.Bl -tag -width VMIO_SIOCSETMACADDR
+.Bl -tag -width ".Dv VMIO_SIOCSETMACADDR"
 .It Dv TAPSDEBUG
 The argument should be a pointer to an
 .Va int ;
@@ -229,7 +229,7 @@ control device is closed. Everything else is the same.
 In addition to the above mentioned,
 .Xr ioctl 2
 calls, there is one additional one for the VMware port.
-.Bl -tag -width VMIO_SIOCSETMACADDR
+.Bl -tag -width ".Dv VMIO_SIOCSETMACADDR"
 .It Dv VMIO_SIOCSIFFLAGS
 VMware
 .Dv SIOCSIFFLAGS .
index 7f8b4df..df20f6d 100644 (file)
@@ -158,7 +158,7 @@ file descriptor zero by the following code fragment:
        ioctl(0, TIOCSETD, &ldisc);
 .Ed
 .Ss Terminal File Request Descriptions
-.Bl -tag -width TIOCGWINSZ
+.Bl -tag -width ".Dv TIOCGWINSZ"
 .It Dv TIOCSETD Fa int *ldisc
 Change to the new line discipline pointed to by
 .Fa ldisc .
index 41d2cd1..4397daf 100644 (file)
@@ -58,7 +58,7 @@ per CAM transport layer instance.  Since there is currently only one CAM
 transport layer, there will only be one instance of this driver.
 .Sh IOCTLS
 .Bl -tag -width 01234567890123
-.It CAMIOCOMMAND
+.It Dv CAMIOCOMMAND
 This ioctl takes certain kinds of CAM CCBs and passes them through to the
 CAM transport layer for action.  Only the following CCB types are
 supported:
@@ -79,7 +79,7 @@ send them through a generic passthrough device rather than a passthrough
 device tied to a particular underlying
 .Tn SCSI
 device.
-.It CAMGETPASSTHRU
+.It Dv CAMGETPASSTHRU
 This ioctl takes an XPT_GDEVLIST CCB, and returns the passthrough device
 corresponding to the device in question.
 .El
index 470025b..9edd882 100644 (file)
@@ -61,7 +61,7 @@ is called with no option only the current settings are reported.
 .Pp
 The following options are available:
 .Bl -tag -width indent
-.It Fl s Bq ASC_SRESSW
+.It Fl s Bq Dv ASC_SRESSW
 Set the scanner with the values of the resolution selector switch.
 .It Fl q
 Operate in quiet mode, i.e. do not report any of the current settings.
@@ -75,17 +75,17 @@ several of them will refer the same device unit.
 The modifications are
 performed od the unit regardless of the device node by which it is
 accessed.
-.It Fl r Ar resolution Bq ASC_SRES
+.It Fl r Ar resolution Bq Dv ASC_SRES
 Set the resolution in dpi.
-.It Fl w Ar width Bq ASC_SWIDHT
+.It Fl w Ar width Bq Dv ASC_SWIDTH
 Set the width of the bitmap in pixels.
-.It Fl h Ar height Bq ASC_SHEIGHT
+.It Fl h Ar height Bq Dv ASC_SHEIGHT
 Set the height of the bitmap in lines of pixels.
-.It Fl b Ar len Bq ASC_SBLEN
+.It Fl b Ar len Bq Dv ASC_SBLEN
 Set the internal dma buffer to be
 .Ar len
 lines in size.
-.It Fl t Ar timeout Bq ASC_SBTIME
+.It Fl t Ar timeout Bq Dv ASC_SBTIME
 Set the timeout time for reading one dma buffer.
 .El
 .Sh FILES
index 89936af..96da432 100644 (file)
@@ -229,28 +229,28 @@ file
 .Pp
 Supported command and response messages (ioctls) to the kernel are:
 .Bl -tag -width Ds -compact -offset indent
-.It Ar I4B_CDID_REQ
+.It Dv I4B_CDID_REQ
 Request a unique Call Description IDentifier (cdid) which identifies
 uniquely a single interaction of the local D channel with the exchange.
-.It Ar I4B_CONNECT_REQ
+.It Dv I4B_CONNECT_REQ
 Actively request a call setup to a remote ISDN subscriber.
-.It Ar I4B_CONNECT_RESP
+.It Dv I4B_CONNECT_RESP
 Respond to an incoming call, either accept, reject or ignore it.
-.It Ar I4B_DISCONNECT_REQ
+.It Dv I4B_DISCONNECT_REQ
 Actively terminate a connection.
-.It Ar I4B_CTRL_INFO_REQ
+.It Dv I4B_CTRL_INFO_REQ
 Request information about an installed ISDN controller card.
-.It Ar I4B_DIALOUT_RESP
+.It Dv I4B_DIALOUT_RESP
 Give information about call setup to driver who requested dialing out.
-.It Ar I4B_TIMEOUT_UPD
+.It Dv I4B_TIMEOUT_UPD
 Update the kernels timeout value(s) in case of dynamically calculated
 shorthold mode timing changes.
-.It Ar I4B_UPDOWN_IND
+.It Dv I4B_UPDOWN_IND
 Inform the kernel userland drivers about interface soft up/down status
 changes.
-.It Ar I4B_CTRL_DOWNLOAD
+.It Dv I4B_CTRL_DOWNLOAD
 Download firmware to active card(s).
-.It Ar I4B_ACTIVE_DIAGNOSTIC
+.It Dv I4B_ACTIVE_DIAGNOSTIC
 Return diagnostic information from active cards.
 .El
 .Pp
@@ -287,14 +287,14 @@ to the
 utility.
 .Pp
 The daemon requests a new CDID from the kernel by using the
-.Em I4B_CDID_REQ
+.Dv I4B_CDID_REQ
 ioctl message, this CDID is now used in all interactions with the kernel
 to identify this single call until a disconnect occurs.
 .Pp
 After getting the CDID, the daemon looks up several additional information
 in its entry section of the configuration corresponding to that connection
 and issues a
-.Em I4B_CONNECT_REQ
+.Dv I4B_CONNECT_REQ
 ioctl message to the kernel.
 The kernel now dials the remote side and
 if the remote side accepts the call, the kernel sends a
@@ -303,11 +303,11 @@ to the daemon.
 .Pp
 The call is terminated by either the local side timing out or the remote
 side hanging up the connection or the local side actively sending a
-.Em I4B_DISCONNECT_REQ
+.Dv I4B_DISCONNECT_REQ
 ioctl message, both events are signaled to the
 .Nm
 by the kernel sending the
-.Em I4B_DISCONNECT_IND
+.Em MSG_DISCONNECT_IND
 message and the CDID corresponding to the call is no longer valid.
 .Ss INCOMING CALLS
 Incoming calls are signaled to the
@@ -321,7 +321,7 @@ With the information contained in this message, the
 searches the entry section of its configuration database and if a match is
 found, it accepts or rejects the call or, if no match is found, it ignores the
 call - all by issuing a
-.Em I4B_CONNECT_RESP
+.Dv I4B_CONNECT_RESP
 ioctl message with the appropriate parameters to the kernel.
 .Pp
 In case the daemon decided to accept the call, the kernel signals this
@@ -331,11 +331,11 @@ message to the daemon.
 .Pp
 The call is terminated by either the local side timing out or the remote
 side hanging up the connection or the local side actively sending a
-.Em I4B_DISCONNECT_REQ
+.Dv I4B_DISCONNECT_REQ
 ioctl message, both events are signaled to the
 .Nm
 by the kernel sending the
-.Em I4B_DISCONNECT_IND
+.Em MSG_DISCONNECT_IND
 message and the CDID corresponding to the call is no longer valid.
 .Sh SIGNALS
 Sending a HUP signal to
index e0bdfd6..dfda95b 100644 (file)
@@ -53,28 +53,28 @@ file
 The available ioctl's are:
 .Pp
 .Bl -tag -width Ds -compact -offset indent
-.It Ar I4B_CDID_REQ
+.It Dv I4B_CDID_REQ
 Request a unique Call Description IDentifier (cdid) which identifies
 uniquely a single interaction of the local D channel with the exchange.
-.It Ar I4B_CONNECT_REQ
+.It Dv I4B_CONNECT_REQ
 Actively request a call setup to a remote ISDN subscriber.
-.It Ar I4B_CONNECT_RESP
+.It Dv I4B_CONNECT_RESP
 Respond to an incoming call, either accept, reject or ignore it.
-.It Ar I4B_DISCONNECT_REQ
+.It Dv I4B_DISCONNECT_REQ
 Actively terminate a connection.
-.It Ar I4B_CTRL_INFO_REQ
+.It Dv I4B_CTRL_INFO_REQ
 Request information about an installed ISDN controller card.
-.It Ar I4B_DIALOUT_RESP
+.It Dv I4B_DIALOUT_RESP
 Give information about call setup to driver who requested dialing out.
-.It Ar I4B_TIMEOUT_UPD
+.It Dv I4B_TIMEOUT_UPD
 Update the kernels timeout value(s) in case of dynamically calculated
 shorthold mode timing changes.
-.It Ar I4B_UPDOWN_IND
+.It Dv I4B_UPDOWN_IND
 Inform the kernel userland drivers about interface soft up/down status
 changes.
-.It Ar I4B_CTRL_DOWNLOAD
+.It Dv I4B_CTRL_DOWNLOAD
 Download firmware to active card(s).
-.It Ar I4B_ACTIVE_DIAGNOSTIC
+.It Dv I4B_ACTIVE_DIAGNOSTIC
 Return diagnostic information from active cards.
 .El
 .Pp
index e62f2f2..eef0c53 100644 (file)
@@ -71,16 +71,19 @@ utility.
 The driver is able to process several ioctl's:
 .Pp
 .Bl -tag -width Ds -compact -offset indent
-.It Ar I4B_TEL_GETAUDIOFMT
+.It Dv I4B_TEL_GETAUDIOFMT
 get currently used audio format conversion.
-.It Ar I4B_TEL_SETAUDIOFMT
+.It Dv I4B_TEL_SETAUDIOFMT
 set currently used audio format conversion.
-.It Ar I4B_TEL_EMPTYINPUTQUEUE
+.It Dv I4B_TEL_EMPTYINPUTQUEUE
 clear the input queue.
 .El
 .Pp
-For the I4B_TEL_GETAUDIOFMT and I4B_TEL_SETAUDIOFMT, the following
-parameters are available:
+For the
+.Dv I4B_TEL_GETAUDIOFMT
+and
+.Dv I4B_TEL_SETAUDIOFMT ,
+the following parameters are available:
 .Pp
 .Bl -tag -width Ds -compact -offset indent
 .It Ar CVT_NONE
index 7648e59..25c8ca5 100644 (file)
@@ -4337,7 +4337,9 @@ is true for most
 NULL-modem cables), logs the fact and stops checking
 for carrier.
 .Pp
-As ptys don't support the TIOCMGET ioctl, the tty device will switch all
+As ptys don't support the
+.Dv TIOCMGET
+ioctl, the tty device will switch all
 carrier detection off when it detects that the device is a pty.
 .It ISDN (i4b) Devices
 Carrier is checked once per second for 6 seconds.