Assorted mdoc(7) fixes.

Approved by:	re (blanket)
This commit is contained in:
Ruslan Ermilov 2003-05-22 13:02:28 +00:00
parent db1e3a4f98
commit 3a5146d9e2
16 changed files with 98 additions and 89 deletions

View File

@ -57,7 +57,8 @@ The S-Boxes
can be in about can be in about
.if t 2\u\s71700\s10\d .if t 2\u\s71700\s10\d
.if n (2**1700) .if n (2**1700)
states. The states.
The
.Fn arc4random .Fn arc4random
function returns pseudo-random numbers in the range of 0 to function returns pseudo-random numbers in the range of 0 to
.if t 2\u\s731\s10\d\(mi1, .if t 2\u\s731\s10\d\(mi1,
@ -87,7 +88,7 @@ and
functions using functions using
.Fn arc4random : .Fn arc4random :
.Pp .Pp
.Dl #define foo4random() (arc4random() % ((unsigned)RAND_MAX + 1)) .Dl "#define foo4random() (arc4random() % ((unsigned)RAND_MAX + 1))"
.Sh SEE ALSO .Sh SEE ALSO
.Xr rand 3 , .Xr rand 3 ,
.Xr random 3 , .Xr random 3 ,

View File

@ -46,11 +46,11 @@
.Lb libc .Lb libc
.Sh SYNOPSIS .Sh SYNOPSIS
.In fstab.h .In fstab.h
.Ft struct fstab * .Ft "struct fstab *"
.Fn getfsent void .Fn getfsent void
.Ft struct fstab * .Ft "struct fstab *"
.Fn getfsspec "const char *spec" .Fn getfsspec "const char *spec"
.Ft struct fstab * .Ft "struct fstab *"
.Fn getfsfile "const char *file" .Fn getfsfile "const char *file"
.Ft int .Ft int
.Fn setfsent void .Fn setfsent void
@ -58,7 +58,7 @@
.Fn endfsent void .Fn endfsent void
.Ft void .Ft void
.Fn setfstab "const char *file" .Fn setfstab "const char *file"
.Ft const char * .Ft "const char *"
.Fn getfstab void .Fn getfstab void
.Sh DESCRIPTION .Sh DESCRIPTION
The The
@ -103,11 +103,11 @@ function sets the file to be used by subsequent operations.
The value set by The value set by
.Fn setfstab .Fn setfstab
does not persist across calls to does not persist across calls to
.Fn endfsent .Fn endfsent .
.Pp .Pp
The The
.Fn getfstab .Fn getfstab
function returns the name of the file that that will be used. function returns the name of the file that will be used.
.Pp .Pp
The The
.Fn getfsspec .Fn getfsspec
@ -145,17 +145,17 @@ The
function function
returns nothing. returns nothing.
.Sh ENVIRONMENT .Sh ENVIRONMENT
.Bl -tag -width PATH_FSTAB .Bl -tag -width ".Ev PATH_FSTAB"
.It Pa PATH_FSTAB .It Ev PATH_FSTAB
If the environment variable If the environment variable
.Pa PATH_FSTAB .Ev PATH_FSTAB
is set all operations are performed against the specified file. is set, all operations are performed against the specified file.
.Pa PATH_FSTAB .Ev PATH_FSTAB
will not be honored if the process environment or memory address space is will not be honored if the process environment or memory address space is
considred considred
.Dq tainted . .Dq tainted .
(See (See
.Fn issetugid .Xr issetugid 2
for more information.) for more information.)
.El .El
.Sh FILES .Sh FILES

View File

@ -194,7 +194,8 @@ The functions
and and
.Fn getpwuid_r .Fn getpwuid_r
return 0 if no error occurred, or an error number to indicate failure. return 0 if no error occurred, or an error number to indicate failure.
It is not an error if a matching entry is not found. (Thus, if It is not an error if a matching entry is not found.
(Thus, if
.Fa result .Fa result
is is
.Dv NULL .Dv NULL

View File

@ -75,13 +75,14 @@ The
.Fa int_map .Fa int_map
argument argument
is a bitmap which determines whether vm86 interrupts should be handled is a bitmap which determines whether vm86 interrupts should be handled
in vm86 mode, or reflected back to the process. If the in vm86 mode, or reflected back to the process.
If the
.Em Nth .Em Nth
bit is set, the interrupt will be reflected to the process, otherwise bit is set, the interrupt will be reflected to the process, otherwise
it will be dispatched by the vm86 interrupt table. it will be dispatched by the vm86 interrupt table.
.It Dv VM86_INTCALL .It Dv VM86_INTCALL
This allows calls to be made to vm86 interrupt handlers by the process. It This allows calls to be made to vm86 interrupt handlers by the process.
effectively simulates an INT instruction. It effectively simulates an INT instruction.
.Fa data .Fa data
should point to the following structure: should point to the following structure:
.Bd -literal .Bd -literal
@ -92,8 +93,8 @@ struct vm86_intcall_args {
.Ed .Ed
.Pp .Pp
.Fa intnum .Fa intnum
specifies the operand of INT for the simulated call. A value of 0x10, for specifies the operand of INT for the simulated call.
example, would often be used to call into the VGA BIOS. A value of 0x10, for example, would often be used to call into the VGA BIOS.
.Fa vmf .Fa vmf
is used to initialize CPU registers according to the calling convention for is used to initialize CPU registers according to the calling convention for
the interrupt handler. the interrupt handler.
@ -117,7 +118,8 @@ vm86 mode is entered by calling
.Xr sigreturn 2 .Xr sigreturn 2
with the correct machine context for vm86, and with the with the correct machine context for vm86, and with the
.Dv PSL_VM .Dv PSL_VM
bit set. Control returns to the process upon delivery of a signal. bit set.
Control returns to the process upon delivery of a signal.
.Sh RETURN VALUES .Sh RETURN VALUES
.Rv -std i386_vm86 .Rv -std i386_vm86
.Sh ERRORS .Sh ERRORS
@ -132,6 +134,7 @@ The kernel does not have vm86 support, or an invalid function was specified.
There is not enough memory to initialize the kernel data structures. There is not enough memory to initialize the kernel data structures.
.El .El
.Sh AUTHORS .Sh AUTHORS
.An -nosplit
This man page was written by This man page was written by
.An Jonathan Lemon , .An Jonathan Lemon ,
and updated by and updated by

View File

@ -177,7 +177,7 @@ The individual fields have the following meanings:
.Bl -tag -width mon_decimal_point .Bl -tag -width mon_decimal_point
.It Fa decimal_point .It Fa decimal_point
The decimal point character, except for currency values, The decimal point character, except for currency values,
can't be the empty string. cannot be an empty string.
.It Fa thousands_sep .It Fa thousands_sep
The separator between groups of digits The separator between groups of digits
before the decimal point, except for currency values. before the decimal point, except for currency values.

View File

@ -31,14 +31,17 @@
.Nm wcstof , .Nm wcstof ,
.Nm wcstod , .Nm wcstod ,
.Nm wcstold .Nm wcstold
.Nd "convert string to float, double or long double" .Nd convert string to
.Vt float , double
or
.Vt "long double"
.Sh LIBRARY .Sh LIBRARY
.Lb libc .Lb libc
.Sh SYNOPSIS .Sh SYNOPSIS
.In wchar.h .In wchar.h
.Ft float .Ft float
.Fn wcstof "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" .Fn wcstof "const wchar_t * restrict nptr" "wchar_t ** restrict endptr"
.Ft long double .Ft "long double"
.Fn wcstold "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" .Fn wcstold "const wchar_t * restrict nptr" "wchar_t ** restrict endptr"
.Ft double .Ft double
.Fn wcstod "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" .Fn wcstod "const wchar_t * restrict nptr" "wchar_t ** restrict endptr"
@ -53,13 +56,13 @@ functions are the wide-character versions of the
.Fn strtod .Fn strtod
and and
.Fn strtold .Fn strtold
functios. functions.
Refer to Refer to
.Xr strtod 3 .Xr strtod 3
for details. for details.
.Sh SEE ALSO .Sh SEE ALSO
.Xr strtod 3 , .Xr strtod 3 ,
.Xr wcstol 3 , .Xr wcstol 3
.Sh STANDARDS .Sh STANDARDS
The The
.Fn wcstof , .Fn wcstof ,

View File

@ -74,7 +74,8 @@ the caller of
.Pp .Pp
Each method has the function signature described by the typedef: Each method has the function signature described by the typedef:
.Pp .Pp
.Ft typedef "int \*(lp*nss_method\*(rp\*(lpvoid *retval, void *mdata, va_list *ap\*(rp" ; .Ft typedef int
.Fn \*(lp*nss_method\*(rp "void *retval" "void *mdata" "va_list *ap" ;
.Pp .Pp
.Va dtab .Va dtab
is an array of is an array of
@ -175,12 +176,12 @@ as a variable argument list of the type
.Ss Valid source types .Ss Valid source types
While there is support for arbitrary sources, the following While there is support for arbitrary sources, the following
#defines for commonly implemented sources are available: #defines for commonly implemented sources are available:
.Bl -column NS_COMPAT COMPAT -offset indent .Bl -column NSSRC_COMPAT compat -offset indent
.It Sy "#define value" .It Sy "#define value"
.It "NSSRC_FILES ""files""" .It Dv NSSRC_FILES Ta """files""
.It "NSSRC_DNS ""dns""" .It Dv NSSRC_DNS Ta """dns""
.It "NSSRC_NIS ""nis""" .It Dv NSSRC_NIS Ta """nis""
.It "NSSRC_COMPAT ""compat""" .It Dv NSSRC_COMPAT Ta """compat""
.El .El
.Pp .Pp
Refer to Refer to
@ -192,13 +193,13 @@ The
.Vt nss_method .Vt nss_method
functions must return one of the following values depending upon status functions must return one of the following values depending upon status
of the lookup: of the lookup:
.Bl -column "RETURN VALUE" "STATUS CODE" .Bl -column "Return value" "Status code"
.It Sy "Return value Status code" .It Sy "Return value Status code"
.It "NS_SUCCESS success" .It Dv NS_SUCCESS Ta success
.It "NS_NOTFOUND notfound" .It Dv NS_NOTFOUND Ta notfound
.It "NS_UNAVAIL unavail" .It Dv NS_UNAVAIL Ta unavail
.It "NS_TRYAGAIN tryagain" .It Dv NS_TRYAGAIN Ta tryagain
.It "NS_RETURN -none-" .It Dv NS_RETURN Ta -none-
.El .El
.Pp .Pp
Refer to Refer to
@ -208,12 +209,14 @@ for a complete description of each status code.
The The
.Fn nsdispatch .Fn nsdispatch
function returns the value of the method that caused the dispatcher to function returns the value of the method that caused the dispatcher to
terminate, or NS_NOTFOUND otherwise. terminate, or
.Dv NS_NOTFOUND
otherwise.
.Sh SEE ALSO .Sh SEE ALSO
.Xr hesiod 3 , .Xr hesiod 3 ,
.Xr stdarg 3 , .Xr stdarg 3 ,
.Xr yp 8 , .Xr nsswitch.conf 5 ,
.Xr nsswitch.conf 5 .Xr yp 8
.Sh HISTORY .Sh HISTORY
The The
.Fn nsdispatch .Fn nsdispatch
@ -232,10 +235,10 @@ Luke Mewburn
wrote this freely-distributable name-service switch implementation, wrote this freely-distributable name-service switch implementation,
using ideas from the using ideas from the
.Tn ULTRIX .Tn ULTRIX
"svc.conf\*(lp5\*(rp" svc.conf(5)
and and
.Tn Solaris .Tn Solaris
"nsswitch.conf\*(lp4\*(rp" nsswitch.conf(4)
manual pages. manual pages.
The The
.Fx .Fx

View File

@ -35,7 +35,7 @@
.Os .Os
.Sh NAME .Sh NAME
.Nm mac .Nm mac
.Nd Introduction to the MAC security API .Nd introduction to the MAC security API
.Sh LIBRARY .Sh LIBRARY
.Lb libc .Lb libc
.Sh SYNOPSIS .Sh SYNOPSIS

View File

@ -63,10 +63,10 @@ The
function function
returns 0 on success and \-1 on error. returns 0 on success and \-1 on error.
.Sh ERRORS .Sh ERRORS
.Bl -tag -width Er
The The
.Fn fputws .Fn fputws
function will fail if: function will fail if:
.Bl -tag -width Er
.It Bq Er EBADF .It Bq Er EBADF
The The
.Fa fp .Fa fp

View File

@ -52,7 +52,7 @@ string to floating point
.Fn strtod "const char * restrict nptr" "char ** restrict endptr" .Fn strtod "const char * restrict nptr" "char ** restrict endptr"
.Ft float .Ft float
.Fn strtof "const char * restrict nptr" "char ** restrict endptr" .Fn strtof "const char * restrict nptr" "char ** restrict endptr"
.Ft long double .Ft "long double"
.Fn strtold "const char * restrict nptr" "char ** restrict endptr" .Fn strtold "const char * restrict nptr" "char ** restrict endptr"
.Sh DESCRIPTION .Sh DESCRIPTION
These conversion These conversion
@ -63,7 +63,7 @@ to
.Vt double , .Vt double ,
.Vt float , .Vt float ,
and and
.Vt long double .Vt "long double"
representation, respectively. representation, respectively.
.Pp .Pp
The expected form of the string is an optional plus (``+'') or minus The expected form of the string is an optional plus (``+'') or minus
@ -160,10 +160,10 @@ These routines do not recognize the C99 ``NaN(...)'' syntax.
The author of this software is The author of this software is
.An David M. Gay . .An David M. Gay .
.Pp .Pp
.Bd -literal
Copyright (c) 1998 by Lucent Technologies Copyright (c) 1998 by Lucent Technologies
.br
All Rights Reserved All Rights Reserved
.Pp
Permission to use, copy, modify, and distribute this software and Permission to use, copy, modify, and distribute this software and
its documentation for any purpose and without fee is hereby its documentation for any purpose and without fee is hereby
granted, provided that the above copyright notice appear in all granted, provided that the above copyright notice appear in all
@ -173,7 +173,7 @@ documentation, and that the name of Lucent or any of its entities
not be used in advertising or publicity pertaining to not be used in advertising or publicity pertaining to
distribution of the software without specific, written prior distribution of the software without specific, written prior
permission. permission.
.Pp
LUCENT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, LUCENT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.
IN NO EVENT SHALL LUCENT OR ANY OF ITS ENTITIES BE LIABLE FOR ANY IN NO EVENT SHALL LUCENT OR ANY OF ITS ENTITIES BE LIABLE FOR ANY
@ -182,3 +182,4 @@ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE. THIS SOFTWARE.
.Ed

View File

@ -12,7 +12,7 @@
.Dt JAIL 2 .Dt JAIL 2
.Os .Os
.Sh NAME .Sh NAME
.Nm jail .Nm jail , jail_attach
.Nd imprison current process and future decendants .Nd imprison current process and future decendants
.Sh LIBRARY .Sh LIBRARY
.Lb libc .Lb libc
@ -59,21 +59,16 @@ The
.Fn jail_attach .Fn jail_attach
system call attaches the current process to an existing jail, system call attaches the current process to an existing jail,
identified by identified by
.Va jid . .Fa jid .
.Sh RETURN VALUES .Sh RETURN VALUES
If successful, If successful,
.Fn jail .Fn jail
returns a non-negative integer, termed the jail identifier (JID). returns a non-negative integer, termed the jail identifier (JID).
It returns -1 on failure, and sets It returns \-1 on failure, and sets
.Va errno .Va errno
to indicate the error. to indicate the error.
.Pp .Pp
If successful, .Rv -std jail_attach
.Fn jail_attach
returns 0.
It returns -1 on failure, and sets
.Va errno
to indicate the error.
.Sh PRISON? .Sh PRISON?
Once a process has been put in a prison, it and its decendants cannot escape Once a process has been put in a prison, it and its decendants cannot escape
the prison. the prison.

View File

@ -107,22 +107,22 @@ implementation of
.Fn sendfile .Fn sendfile
is "zero-copy", meaning that it has been optimized so that copying of the file data is avoided. is "zero-copy", meaning that it has been optimized so that copying of the file data is avoided.
.Sh TUNING .Sh TUNING
Internally this system call uses a special Internally, this system call uses a special
.Xr sendfile 2 .Xr sendfile 2
buffer buffer
.Pq Fa "struct sf_buf" .Pq Vt "struct sf_buf"
to handle sending file data to the client. to handle sending file data to the client.
If the sending socket is If the sending socket is
blocking and there are not enough sendfile buffers available, blocking, and there are not enough sendfile buffers available,
.Xr sendfile 2 .Xr sendfile 2
will block and report a state of will block and report a state of
.Dq sfbufa . .Dq Li sfbufa .
If the sending socket is non-blocking and there are not enough If the sending socket is non-blocking and there are not enough
sendfile buffers available, the call will block and wait for the sendfile buffers available, the call will block and wait for the
necessary buffers to become available before finishing the call. necessary buffers to become available before finishing the call.
.Pp .Pp
The number of The number of
.Fa sf_buf Ns 's .Vt sf_buf Ns 's
allocated should be proportional to the number of nmbclusters used to allocated should be proportional to the number of nmbclusters used to
send data to a client via send data to a client via
.Xr sendfile 2 . .Xr sendfile 2 .
@ -130,19 +130,21 @@ Tune accordingly to avoid blocking!
Busy installations that make extensive use of Busy installations that make extensive use of
.Xr sendfile 2 .Xr sendfile 2
may want to increase these values to be inline with their may want to increase these values to be inline with their
.Ar kern.ipc.nmbclusters .Va kern.ipc.nmbclusters
.Pq see Xr tuning 7 for details . (see
.Xr tuning 7
for details).
.Pp .Pp
The number of The number of
.Xr sendfile 2 .Xr sendfile 2
buffers in use is determined at boot time by either the buffers in use is determined at boot time by either the
.Em kern.ipc.nsfbufs .Va kern.ipc.nsfbufs
.Xr loader.conf 5 .Xr loader.conf 5
variable or the variable or the
.Em NSFBUFS .Dv NSFBUFS
kernel configuration tunable. kernel configuration tunable.
The number of sendfile buffers scales with The number of sendfile buffers scales with
.Em kern.maxusers . .Va kern.maxusers .
.Sh RETURN VALUES .Sh RETURN VALUES
.Rv -std sendfile .Rv -std sendfile
.Sh ERRORS .Sh ERRORS
@ -198,8 +200,8 @@ If specified, the number of bytes successfully sent will be returned in
.Xr open 2 , .Xr open 2 ,
.Xr send 2 , .Xr send 2 ,
.Xr socket 2 , .Xr socket 2 ,
.Xr tuning 7 , .Xr writev 2 ,
.Xr writev 2 .Xr tuning 7
.Sh HISTORY .Sh HISTORY
The The
.Fn sendfile .Fn sendfile

View File

@ -90,8 +90,8 @@ and into which information is placed concerning the file.
The time-related fields of The time-related fields of
.Fa struct stat .Fa struct stat
are as follows: are as follows:
.Bl -tag -width XXXst_mtime .Bl -tag -width ".Va st_birthtime"
.It st_atime .It Va st_atime
Time when file data last accessed. Time when file data last accessed.
Changed by the Changed by the
.Xr mknod 2 , .Xr mknod 2 ,
@ -99,7 +99,7 @@ Changed by the
and and
.Xr read 2 .Xr read 2
system calls. system calls.
.It st_mtime .It Va st_mtime
Time when file data last modified. Time when file data last modified.
Changed by the Changed by the
.Xr mknod 2 , .Xr mknod 2 ,
@ -107,7 +107,7 @@ Changed by the
and and
.Xr write 2 .Xr write 2
system calls. system calls.
.It st_ctime .It Va st_ctime
Time when file status was last changed (inode data modification). Time when file status was last changed (inode data modification).
Changed by the Changed by the
.Xr chmod 2 , .Xr chmod 2 ,
@ -120,7 +120,7 @@ Changed by the
and and
.Xr write 2 .Xr write 2
system calls. system calls.
.It st_birthtime .It Va st_birthtime
Time when the inode was created. Time when the inode was created.
.El .El
.Pp .Pp

View File

@ -40,7 +40,7 @@
.Nm devstat_selectdevs , .Nm devstat_selectdevs ,
.Nm devstat_buildmatch , .Nm devstat_buildmatch ,
.Nm devstat_compute_statistics , .Nm devstat_compute_statistics ,
.Nm devstat_compute_etime , .Nm devstat_compute_etime
.Nd device statistics utility library .Nd device statistics utility library
.Sh LIBRARY .Sh LIBRARY
.Lb libdevstat .Lb libdevstat
@ -553,7 +553,7 @@ and
.It DSM_MB_PER_SECOND_FREE .It DSM_MB_PER_SECOND_FREE
type: long double * type: long double *
.Pp .Pp
The average number of megabytesper second in the specified type of The average number of megabytes per second in the specified type of
transaction between the acquisition of transaction between the acquisition of
.Va previous .Va previous
and and
@ -600,7 +600,7 @@ acquisition of
and and
.Va current . .Va current .
.It DSM_BUSY_PCT .It DSM_BUSY_PCT
type long double * type: long double *
.Pp .Pp
The percentage of time the device had one or more transactions outstanding The percentage of time the device had one or more transactions outstanding
between the acquisition of between the acquisition of

View File

@ -444,7 +444,7 @@ Invalid URL
The accompanying error message includes a protocol-specific error code The accompanying error message includes a protocol-specific error code
and message, e.g. "File is not available (404 Not Found)" and message, e.g. "File is not available (404 Not Found)"
.Sh ENVIRONMENT .Sh ENVIRONMENT
.Bl -tag -width FETCH_BIND_ADDRESS .Bl -tag -width ".Ev FETCH_BIND_ADDRESS"
.It Ev FETCH_BIND_ADDRESS .It Ev FETCH_BIND_ADDRESS
Specifies a hostname or IP address to which sockets used for outgoing Specifies a hostname or IP address to which sockets used for outgoing
connections will be bound. connections will be bound.

View File

@ -65,13 +65,13 @@
.Fn hid_report_size "report_desc_t d" "hid_kind_t k" "int id" .Fn hid_report_size "report_desc_t d" "hid_kind_t k" "int id"
.Ft int .Ft int
.Fn hid_locate "report_desc_t d" "u_int usage" "hid_kind_t k" "hid_item_t *h" "int id" .Fn hid_locate "report_desc_t d" "u_int usage" "hid_kind_t k" "hid_item_t *h" "int id"
.Ft char * .Ft "char *"
.Fn hid_usage_page "int i" .Fn hid_usage_page "int i"
.Ft char * .Ft "char *"
.Fn hid_usage_in_page "u_int u" .Fn hid_usage_in_page "u_int u"
.Ft int .Ft int
.Fn hid_parse_usage_page "const char *" .Fn hid_parse_usage_page "const char *"
.Ft char * .Ft "char *"
.Fn hid_parse_usage_in_page "const char *" .Fn hid_parse_usage_in_page "const char *"
.Ft void .Ft void
.Fn hid_init "char *file" .Fn hid_init "char *file"
@ -83,7 +83,7 @@
The The
.Nm .Nm
library provides routines to extract data from USB Human Interface Devices. library provides routines to extract data from USB Human Interface Devices.
.Ss INTRODUCTION .Ss Introduction
USB HID devices send and receive data layed out in a device dependent way. USB HID devices send and receive data layed out in a device dependent way.
The The
.Nm .Nm
@ -94,7 +94,7 @@ which contains the data layout information and then use this information.
The routines can be divided into four parts: extraction of the descriptor, The routines can be divided into four parts: extraction of the descriptor,
parsing of the descriptor, translating to/from symbolic names, and parsing of the descriptor, translating to/from symbolic names, and
data manipulation. data manipulation.
.Ss DESCRIPTOR FUNCTIONS .Ss Descriptor Functions
A report descriptor can be obtained by calling A report descriptor can be obtained by calling
.Fn hid_get_report_desc .Fn hid_get_report_desc
with a file descriptor obtained by opening a with a file descriptor obtained by opening a
@ -114,7 +114,7 @@ If
.Fn hid_dispose_report_desc .Fn hid_dispose_report_desc
fails it will return fails it will return
.Dv NULL . .Dv NULL .
.Ss DESCRIPTOR PARSING FUNCTIONS .Ss Descriptor Parsing Functions
To parse the report descriptor the To parse the report descriptor the
.Fn hid_start_parse .Fn hid_start_parse
function should be called with a report descriptor and a set that function should be called with a report descriptor and a set that
@ -125,7 +125,7 @@ where
.Fa k .Fa k
is an item of type is an item of type
.Vt hid_kind_t . .Vt hid_kind_t .
The report id (if present) is given by The report ID (if present) is given by
.Fa id . .Fa id .
The function returns The function returns
.Dv NULL .Dv NULL
@ -164,7 +164,7 @@ function can be used.
It should be given the usage code of It should be given the usage code of
the item and its kind and it will fill the item and return the item and its kind and it will fill the item and return
non-zero if the item was found. non-zero if the item was found.
.Ss Name TRANSLATION FUNCTIONS .Ss Name Translation Functions
The function The function
.Fn hid_usage_page .Fn hid_usage_page
will return the symbolic name of a usage page, and the function will return the symbolic name of a usage page, and the function
@ -190,7 +190,7 @@ with the name of the table.
Passing Passing
.Dv NULL .Dv NULL
to this function will cause it to use the default table. to this function will cause it to use the default table.
.Ss Data EXTRACTION FUNCTIONS .Ss Data Extraction Functions
Given the data obtained from a HID device and an item in the Given the data obtained from a HID device and an item in the
report descriptor the report descriptor the
.Fn hid_get_data .Fn hid_get_data