mdoc: minor Bl improvements.
This commit is contained in:
parent
b9c473b2ed
commit
9ee2158b55
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=236438
@ -70,7 +70,7 @@ or
|
|||||||
It is the bitwise-inclusive OR of zero or more of the following flags
|
It is the bitwise-inclusive OR of zero or more of the following flags
|
||||||
(see
|
(see
|
||||||
.Fn posix_spawn ) :
|
.Fn posix_spawn ) :
|
||||||
.Bl -tag -offset indent
|
.Bl -tag -width "POSIX_SPAWN_SETSCHEDPARAM" -offset indent
|
||||||
.It Dv POSIX_SPAWN_RESETIDS
|
.It Dv POSIX_SPAWN_RESETIDS
|
||||||
.It Dv POSIX_SPAWN_SETPGROUP
|
.It Dv POSIX_SPAWN_SETPGROUP
|
||||||
.It Dv POSIX_SPAWN_SETSIGDEF
|
.It Dv POSIX_SPAWN_SETSIGDEF
|
||||||
|
@ -196,7 +196,7 @@ SHA-512
|
|||||||
.Pp
|
.Pp
|
||||||
Other crypt formats may be easily added.
|
Other crypt formats may be easily added.
|
||||||
An example salt would be:
|
An example salt would be:
|
||||||
.Bl -tag -offset indent
|
.Bl -tag -width 6n -offset indent
|
||||||
.It Cm "$4$thesalt$rest"
|
.It Cm "$4$thesalt$rest"
|
||||||
.El
|
.El
|
||||||
.Ss "Traditional" crypt:
|
.Ss "Traditional" crypt:
|
||||||
|
@ -385,9 +385,9 @@ See
|
|||||||
This section contains a brief overview of the available functionality
|
This section contains a brief overview of the available functionality
|
||||||
in the ELF library.
|
in the ELF library.
|
||||||
Each function listed here is described further in its own manual page.
|
Each function listed here is described further in its own manual page.
|
||||||
.Bl -tag -width indent
|
.Bl -tag -width 2n
|
||||||
.It "Archive Access"
|
.It "Archive Access"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 17n -compact
|
||||||
.It Fn elf_getarsym
|
.It Fn elf_getarsym
|
||||||
Retrieve the archive symbol table.
|
Retrieve the archive symbol table.
|
||||||
.It Fn elf_getarhdr
|
.It Fn elf_getarhdr
|
||||||
@ -404,7 +404,7 @@ Random access inside an
|
|||||||
archive.
|
archive.
|
||||||
.El
|
.El
|
||||||
.It "Data Structures"
|
.It "Data Structures"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 17n -compact
|
||||||
.It Fn elf_getdata
|
.It Fn elf_getdata
|
||||||
Retrieve translated data for an ELF section.
|
Retrieve translated data for an ELF section.
|
||||||
.It Fn elf_getscn
|
.It Fn elf_getscn
|
||||||
@ -437,7 +437,7 @@ Allocate an Executable Header in an ELF object.
|
|||||||
Allocate or resize the Program Header Table in an ELF object.
|
Allocate or resize the Program Header Table in an ELF object.
|
||||||
.El
|
.El
|
||||||
.It "Data Translation"
|
.It "Data Translation"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 17n -compact
|
||||||
.It Fn elf32_xlatetof , Fn elf64_xlatetof
|
.It Fn elf32_xlatetof , Fn elf64_xlatetof
|
||||||
Translate an ELF data structure from its native representation to its
|
Translate an ELF data structure from its native representation to its
|
||||||
file representation.
|
file representation.
|
||||||
@ -446,14 +446,14 @@ Translate an ELF data structure from its file representation to a
|
|||||||
native representation.
|
native representation.
|
||||||
.El
|
.El
|
||||||
.It "Error Reporting"
|
.It "Error Reporting"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 17n -compact
|
||||||
.It Fn elf_errno
|
.It Fn elf_errno
|
||||||
Retrieve the current error.
|
Retrieve the current error.
|
||||||
.It Fn elf_errmsg
|
.It Fn elf_errmsg
|
||||||
Retrieve a human readable description of the current error.
|
Retrieve a human readable description of the current error.
|
||||||
.El
|
.El
|
||||||
.It "Initialization"
|
.It "Initialization"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 17n -compact
|
||||||
.It Fn elf_begin
|
.It Fn elf_begin
|
||||||
Opens an
|
Opens an
|
||||||
.Xr ar 1
|
.Xr ar 1
|
||||||
@ -468,7 +468,7 @@ archive or ELF object present in a memory area.
|
|||||||
Sets the operating version.
|
Sets the operating version.
|
||||||
.El
|
.El
|
||||||
.It "IO Control"
|
.It "IO Control"
|
||||||
.Bl -tag -width ".Fn elf_setshstrndx" -compact
|
.Bl -tag -width 17n -compact
|
||||||
.It Fn elf_cntl
|
.It Fn elf_cntl
|
||||||
Manage the association between and ELF descriptor and its underlying file.
|
Manage the association between and ELF descriptor and its underlying file.
|
||||||
.It Fn elf_flagdata
|
.It Fn elf_flagdata
|
||||||
@ -492,7 +492,7 @@ Recompute ELF object layout and optionally write the modified object
|
|||||||
back to the underlying file.
|
back to the underlying file.
|
||||||
.El
|
.El
|
||||||
.It "Queries"
|
.It "Queries"
|
||||||
.Bl -tag -width ".Fn elf_getshstrndx" -compact
|
.Bl -tag -width 17n -compact
|
||||||
.It Fn elf32_checksum , Fn elf64_checkum
|
.It Fn elf32_checksum , Fn elf64_checkum
|
||||||
Compute checksum of an ELF object.
|
Compute checksum of an ELF object.
|
||||||
.It Fn elf_getident
|
.It Fn elf_getident
|
||||||
|
@ -115,7 +115,7 @@ routines will signal an error if a GElf value is out of range
|
|||||||
for the underlying ELF data type.
|
for the underlying ELF data type.
|
||||||
.Ss Namespace use
|
.Ss Namespace use
|
||||||
The GElf interface uses the following symbols:
|
The GElf interface uses the following symbols:
|
||||||
.Bl -tag
|
.Bl -tag -width 8n
|
||||||
.It GElf_*
|
.It GElf_*
|
||||||
Class-independent data types.
|
Class-independent data types.
|
||||||
.It gelf_*
|
.It gelf_*
|
||||||
@ -125,16 +125,16 @@ For functions defined in the API set.
|
|||||||
This section provides an overview of the GElf programming APIs.
|
This section provides an overview of the GElf programming APIs.
|
||||||
Further information is provided in the manual page of each function
|
Further information is provided in the manual page of each function
|
||||||
listed here.
|
listed here.
|
||||||
.Bl -tag
|
.Bl -tag -width 2n
|
||||||
.It "Allocating ELF Data Structures"
|
.It "Allocating ELF Data Structures"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 19n -compact
|
||||||
.It Fn gelf_newehdr
|
.It Fn gelf_newehdr
|
||||||
Allocate a new ELF Executable Header.
|
Allocate a new ELF Executable Header.
|
||||||
.It Fn gelf_newphdr
|
.It Fn gelf_newphdr
|
||||||
Allocate a new ELF Program Header Table.
|
Allocate a new ELF Program Header Table.
|
||||||
.El
|
.El
|
||||||
.It "Data Translation"
|
.It "Data Translation"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 19n -compact
|
||||||
.It Fn gelf_xlatetof
|
.It Fn gelf_xlatetof
|
||||||
Translate the native representation of an ELF data structure to its
|
Translate the native representation of an ELF data structure to its
|
||||||
file representation.
|
file representation.
|
||||||
@ -143,7 +143,7 @@ Translate from the file representation of an ELF data structure to a
|
|||||||
native representation.
|
native representation.
|
||||||
.El
|
.El
|
||||||
.It "Retrieving ELF Data"
|
.It "Retrieving ELF Data"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 19n -compact
|
||||||
.It Fn gelf_getdyn
|
.It Fn gelf_getdyn
|
||||||
Retrieve an ELF
|
Retrieve an ELF
|
||||||
.Sy .dynamic
|
.Sy .dynamic
|
||||||
@ -162,7 +162,7 @@ Retrieve an ELF Section Header Table entry from the underlying ELF descriptor.
|
|||||||
Retrieve an ELF symbol table entry.
|
Retrieve an ELF symbol table entry.
|
||||||
.El
|
.El
|
||||||
.It Queries
|
.It Queries
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 19n -compact
|
||||||
.It Fn gelf_checksum
|
.It Fn gelf_checksum
|
||||||
Retrieves the ELF checksum for an ELF descriptor.
|
Retrieves the ELF checksum for an ELF descriptor.
|
||||||
.It Fn gelf_fsize
|
.It Fn gelf_fsize
|
||||||
@ -171,7 +171,7 @@ Retrieves the size of the file representation of an ELF type.
|
|||||||
Retrieves the ELF class of an ELF descriptor.
|
Retrieves the ELF class of an ELF descriptor.
|
||||||
.El
|
.El
|
||||||
.It "Updating ELF Data"
|
.It "Updating ELF Data"
|
||||||
.Bl -tag -compact -width ".Fn gelf_update_shdr"
|
.Bl -tag -width 19n -compact
|
||||||
.It Fn gelf_update_dyn
|
.It Fn gelf_update_dyn
|
||||||
Copy back an ELF
|
Copy back an ELF
|
||||||
.Sy .dynamic
|
.Sy .dynamic
|
||||||
|
@ -207,7 +207,8 @@ The variable
|
|||||||
.Dv iberr
|
.Dv iberr
|
||||||
provides an error code for the most recent library call.
|
provides an error code for the most recent library call.
|
||||||
The possible error codes are:
|
The possible error codes are:
|
||||||
.Bl -tag -offset indent -compact
|
.Pp
|
||||||
|
.Bl -tag -width 6n -offset indent -compact
|
||||||
.It EDVR
|
.It EDVR
|
||||||
System error
|
System error
|
||||||
.It ECIC
|
.It ECIC
|
||||||
@ -244,7 +245,8 @@ The variable
|
|||||||
.Dv ibsta
|
.Dv ibsta
|
||||||
contains the controller status.
|
contains the controller status.
|
||||||
This is an ORed status value, with the following individual bit names:
|
This is an ORed status value, with the following individual bit names:
|
||||||
.Bl -tag -offset indent -compact
|
.Pp
|
||||||
|
.Bl -tag -width 6n -offset indent -compact
|
||||||
.It ERR
|
.It ERR
|
||||||
Error
|
Error
|
||||||
.It TIMO
|
.It TIMO
|
||||||
@ -329,7 +331,8 @@ The lower 8 bits of
|
|||||||
are interpreted as an end-of-string character,
|
are interpreted as an end-of-string character,
|
||||||
.Li EOS .
|
.Li EOS .
|
||||||
This character can be ORed with the following values:
|
This character can be ORed with the following values:
|
||||||
.Bl -tag -compact -offset indent
|
.Pp
|
||||||
|
.Bl -tag -width 6n -compact -offset indent
|
||||||
.It Dv REOS
|
.It Dv REOS
|
||||||
When receiving a message byte on the bus that matches the
|
When receiving a message byte on the bus that matches the
|
||||||
.Li EOS
|
.Li EOS
|
||||||
@ -348,6 +351,7 @@ If set, include all 8 bits of the
|
|||||||
character in the comparison; if unset, compare only 7 bit ASCII
|
character in the comparison; if unset, compare only 7 bit ASCII
|
||||||
values.
|
values.
|
||||||
.El
|
.El
|
||||||
|
.Pp
|
||||||
Passing 0 as
|
Passing 0 as
|
||||||
.Fa eos
|
.Fa eos
|
||||||
will turn off any special character treatment, allowing for a fully
|
will turn off any special character treatment, allowing for a fully
|
||||||
|
@ -111,7 +111,7 @@ processor.
|
|||||||
Certain kinds of PMCs require that a log file be configured before
|
Certain kinds of PMCs require that a log file be configured before
|
||||||
they may be started.
|
they may be started.
|
||||||
These include:
|
These include:
|
||||||
.Bl -bullet -compact
|
.Bl -bullet
|
||||||
.It
|
.It
|
||||||
System scope sampling PMCs.
|
System scope sampling PMCs.
|
||||||
.It
|
.It
|
||||||
@ -120,6 +120,7 @@ Process scope sampling PMCs.
|
|||||||
Process scope counting PMCs that have been configured to report PMC
|
Process scope counting PMCs that have been configured to report PMC
|
||||||
readings on process context switches or process exits.
|
readings on process context switches or process exits.
|
||||||
.El
|
.El
|
||||||
|
.Pp
|
||||||
Up to one log file may be configured per owner process.
|
Up to one log file may be configured per owner process.
|
||||||
Events logged to a log file may be subsequently analyzed using the
|
Events logged to a log file may be subsequently analyzed using the
|
||||||
.Xr pmclog 3
|
.Xr pmclog 3
|
||||||
@ -129,6 +130,7 @@ The CPUs known to the PMC library are named by the
|
|||||||
.Vt "enum pmc_cputype"
|
.Vt "enum pmc_cputype"
|
||||||
enumeration.
|
enumeration.
|
||||||
Supported CPUs include:
|
Supported CPUs include:
|
||||||
|
.Pp
|
||||||
.Bl -tag -width "Li PMC_CPU_INTEL_CORE2" -compact
|
.Bl -tag -width "Li PMC_CPU_INTEL_CORE2" -compact
|
||||||
.It Li PMC_CPU_AMD_K7
|
.It Li PMC_CPU_AMD_K7
|
||||||
.Tn "AMD Athlon"
|
.Tn "AMD Athlon"
|
||||||
@ -185,6 +187,7 @@ PMC supported by this library are named by the
|
|||||||
.Vt enum pmc_class
|
.Vt enum pmc_class
|
||||||
enumeration.
|
enumeration.
|
||||||
Supported PMC kinds include:
|
Supported PMC kinds include:
|
||||||
|
.Pp
|
||||||
.Bl -tag -width "Li PMC_CLASS_IAF" -compact
|
.Bl -tag -width "Li PMC_CLASS_IAF" -compact
|
||||||
.It Li PMC_CLASS_IAF
|
.It Li PMC_CLASS_IAF
|
||||||
Fixed function hardware counters presents in CPUs conforming to the
|
Fixed function hardware counters presents in CPUs conforming to the
|
||||||
@ -232,6 +235,7 @@ the
|
|||||||
.Vt "enum pmc_caps"
|
.Vt "enum pmc_caps"
|
||||||
enumeration.
|
enumeration.
|
||||||
Supported capabilities include:
|
Supported capabilities include:
|
||||||
|
.Pp
|
||||||
.Bl -tag -width "Li PMC_CAP_INTERRUPT" -compact
|
.Bl -tag -width "Li PMC_CAP_INTERRUPT" -compact
|
||||||
.It Li PMC_CAP_CASCADE
|
.It Li PMC_CAP_CASCADE
|
||||||
The ability to cascade counters.
|
The ability to cascade counters.
|
||||||
@ -273,9 +277,9 @@ Operations on non-existent CPUs will return an error.
|
|||||||
This section contains a brief overview of the available functionality
|
This section contains a brief overview of the available functionality
|
||||||
in the PMC library.
|
in the PMC library.
|
||||||
Each function listed here is described further in its own manual page.
|
Each function listed here is described further in its own manual page.
|
||||||
.Bl -tag -width indent
|
.Bl -tag -width 2n
|
||||||
.It Administration
|
.It Administration
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 6n -compact
|
||||||
.It Fn pmc_disable , Fn pmc_enable
|
.It Fn pmc_disable , Fn pmc_enable
|
||||||
Administratively disable (enable) specific performance monitoring
|
Administratively disable (enable) specific performance monitoring
|
||||||
counter hardware.
|
counter hardware.
|
||||||
@ -283,7 +287,7 @@ Counters that are disabled will not be available to applications to
|
|||||||
use.
|
use.
|
||||||
.El
|
.El
|
||||||
.It "Convenience Functions"
|
.It "Convenience Functions"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 6n -compact
|
||||||
.It Fn pmc_event_names_of_class
|
.It Fn pmc_event_names_of_class
|
||||||
Returns a list of event names supported by a given PMC type.
|
Returns a list of event names supported by a given PMC type.
|
||||||
.It Fn pmc_name_of_capability
|
.It Fn pmc_name_of_capability
|
||||||
@ -308,13 +312,13 @@ constant to a human-readable name.
|
|||||||
Return a human-readable string describing a PMC's current state.
|
Return a human-readable string describing a PMC's current state.
|
||||||
.El
|
.El
|
||||||
.It "Library Initialization"
|
.It "Library Initialization"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 6n -compact
|
||||||
.It Fn pmc_init
|
.It Fn pmc_init
|
||||||
Initialize the library.
|
Initialize the library.
|
||||||
This function must be called before any other library function.
|
This function must be called before any other library function.
|
||||||
.El
|
.El
|
||||||
.It "Log File Handling"
|
.It "Log File Handling"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 6n -compact
|
||||||
.It Fn pmc_configure_logfile
|
.It Fn pmc_configure_logfile
|
||||||
Configure a log file for
|
Configure a log file for
|
||||||
.Xr hwpmc 4
|
.Xr hwpmc 4
|
||||||
@ -331,7 +335,7 @@ side of the stream.
|
|||||||
Append arbitrary user data to the current log file.
|
Append arbitrary user data to the current log file.
|
||||||
.El
|
.El
|
||||||
.It "PMC Management"
|
.It "PMC Management"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 6n -compact
|
||||||
.It Fn pmc_allocate , Fn pmc_release
|
.It Fn pmc_allocate , Fn pmc_release
|
||||||
Allocate (free) a PMC.
|
Allocate (free) a PMC.
|
||||||
.It Fn pmc_attach , Fn pmc_detach
|
.It Fn pmc_attach , Fn pmc_detach
|
||||||
@ -344,7 +348,7 @@ Start (stop) a software PMC.
|
|||||||
Set the reload value for a sampling PMC.
|
Set the reload value for a sampling PMC.
|
||||||
.El
|
.El
|
||||||
.It "Queries"
|
.It "Queries"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 6n -compact
|
||||||
.It Fn pmc_capabilities
|
.It Fn pmc_capabilities
|
||||||
Retrieve the capabilities for a given PMC.
|
Retrieve the capabilities for a given PMC.
|
||||||
.It Fn pmc_cpuinfo
|
.It Fn pmc_cpuinfo
|
||||||
@ -363,7 +367,7 @@ Return information about the state of a given CPU's PMCs.
|
|||||||
Determine the width of a hardware counter in bits.
|
Determine the width of a hardware counter in bits.
|
||||||
.El
|
.El
|
||||||
.It "x86 Architecture Specific API"
|
.It "x86 Architecture Specific API"
|
||||||
.Bl -tag -compact
|
.Bl -tag -width 6n -compact
|
||||||
.It Fn pmc_get_msr
|
.It Fn pmc_get_msr
|
||||||
Returns the processor model specific register number
|
Returns the processor model specific register number
|
||||||
associated with
|
associated with
|
||||||
|
@ -401,7 +401,7 @@ The callback type is defined by libusb20_tr_callback_t.
|
|||||||
.
|
.
|
||||||
.Fn libusb20_tr_set_flags
|
.Fn libusb20_tr_set_flags
|
||||||
is used to set various USB flags for the given USB transfer.
|
is used to set various USB flags for the given USB transfer.
|
||||||
.Bl -tag
|
.Bl -tag -width "LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK"
|
||||||
.It LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK
|
.It LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK
|
||||||
Report a short frame as error.
|
Report a short frame as error.
|
||||||
.It LIBUSB20_TRANSFER_MULTI_SHORT_NOT_OK
|
.It LIBUSB20_TRANSFER_MULTI_SHORT_NOT_OK
|
||||||
@ -709,13 +709,14 @@ This function returns zero if the device is still connected else a LIBUSB20_ERRO
|
|||||||
sets the power mode of the USB device.
|
sets the power mode of the USB device.
|
||||||
.
|
.
|
||||||
Valid power modes:
|
Valid power modes:
|
||||||
.Bl -tag
|
.Bl -tag -width "LIBUSB20_POWER_OFF"
|
||||||
.It LIBUSB20_POWER_OFF
|
.It LIBUSB20_POWER_OFF
|
||||||
.It LIBUSB20_POWER_ON
|
.It LIBUSB20_POWER_ON
|
||||||
.It LIBUSB20_POWER_SAVE
|
.It LIBUSB20_POWER_SAVE
|
||||||
.It LIBUSB20_POWER_SUSPEND
|
.It LIBUSB20_POWER_SUSPEND
|
||||||
.It LIBUSB20_POWER_RESUME
|
.It LIBUSB20_POWER_RESUME
|
||||||
.El
|
.El
|
||||||
|
.Pp
|
||||||
.
|
.
|
||||||
This function returns zero on success else a LIBUSB20_ERROR value is
|
This function returns zero on success else a LIBUSB20_ERROR value is
|
||||||
returned.
|
returned.
|
||||||
@ -793,7 +794,7 @@ Valid bus numbers start at zero.
|
|||||||
returns the current operation mode of the USB entity.
|
returns the current operation mode of the USB entity.
|
||||||
.
|
.
|
||||||
Valid return values are:
|
Valid return values are:
|
||||||
.Bl -tag
|
.Bl -tag -width "LIBUSB20_MODE_DEVICE"
|
||||||
.It LIBUSB20_MODE_HOST
|
.It LIBUSB20_MODE_HOST
|
||||||
.It LIBUSB20_MODE_DEVICE
|
.It LIBUSB20_MODE_DEVICE
|
||||||
.El
|
.El
|
||||||
@ -803,7 +804,7 @@ Valid return values are:
|
|||||||
.Fn libusb20_dev_get_speed
|
.Fn libusb20_dev_get_speed
|
||||||
returns the current speed of the given USB device.
|
returns the current speed of the given USB device.
|
||||||
.
|
.
|
||||||
.Bl -tag
|
.Bl -tag -width "LIBUSB20_SPEED_VARIABLE"
|
||||||
.It LIBUSB20_SPEED_UNKNOWN
|
.It LIBUSB20_SPEED_UNKNOWN
|
||||||
.It LIBUSB20_SPEED_LOW
|
.It LIBUSB20_SPEED_LOW
|
||||||
.It LIBUSB20_SPEED_FULL
|
.It LIBUSB20_SPEED_FULL
|
||||||
|
Loading…
Reference in New Issue
Block a user