diff options
author | ru <ru@FreeBSD.org> | 2006-09-30 15:14:49 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2006-09-30 15:14:49 +0000 |
commit | 02f942de1f0ea8f1c26b9ffe2abc02ac35ebb597 (patch) | |
tree | d27e95126f4cd8198120e290722ee68d707b4044 /share | |
parent | e0ee4f3488ff48a4f216cfe799739aff244b745f (diff) | |
download | FreeBSD-src-02f942de1f0ea8f1c26b9ffe2abc02ac35ebb597.zip FreeBSD-src-02f942de1f0ea8f1c26b9ffe2abc02ac35ebb597.tar.gz |
Revise markup.
Diffstat (limited to 'share')
-rw-r--r-- | share/man/man4/acpi_dock.4 | 2 | ||||
-rw-r--r-- | share/man/man4/amdsmb.4 | 6 | ||||
-rw-r--r-- | share/man/man4/audit.4 | 47 | ||||
-rw-r--r-- | share/man/man4/auditpipe.4 | 82 | ||||
-rw-r--r-- | share/man/man4/bce.4 | 80 | ||||
-rw-r--r-- | share/man/man4/enc.4 | 8 | ||||
-rw-r--r-- | share/man/man4/geom_fox.4 | 28 | ||||
-rw-r--r-- | share/man/man4/le.4 | 23 | ||||
-rw-r--r-- | share/man/man4/man4.i386/padlock.4 | 18 | ||||
-rw-r--r-- | share/man/man4/mfi.4 | 3 | ||||
-rw-r--r-- | share/man/man4/mxge.4 | 7 | ||||
-rw-r--r-- | share/man/man4/nfsmb.4 | 6 | ||||
-rw-r--r-- | share/man/man4/ng_tag.4 | 22 | ||||
-rw-r--r-- | share/man/man4/rr232x.4 | 9 | ||||
-rw-r--r-- | share/man/man4/sched_core.4 | 16 | ||||
-rw-r--r-- | share/man/man4/sched_ule.4 | 2 | ||||
-rw-r--r-- | share/man/man4/snd_emu10kx.4 | 75 | ||||
-rw-r--r-- | share/man/man4/stge.4 | 10 | ||||
-rw-r--r-- | share/man/man4/ufoma.4 | 42 |
19 files changed, 261 insertions, 225 deletions
diff --git a/share/man/man4/acpi_dock.4 b/share/man/man4/acpi_dock.4 index dda2295..1fda11d 100644 --- a/share/man/man4/acpi_dock.4 +++ b/share/man/man4/acpi_dock.4 @@ -25,7 +25,7 @@ .\" $FreeBSD$ .\" .Dd May 20, 2006 -.Dt EXAMPLE 4 +.Dt ACPI_DOCK 4 .Os .Sh NAME .Nm acpi_dock diff --git a/share/man/man4/amdsmb.4 b/share/man/man4/amdsmb.4 index ad0e9d5..eb02543 100644 --- a/share/man/man4/amdsmb.4 +++ b/share/man/man4/amdsmb.4 @@ -38,14 +38,14 @@ The .Nm driver provides access to the AMD-8111 SMBus 2.0 controller. +.Sh SEE ALSO +.Xr smb 4 , +.Xr smbus 4 .Sh HISTORY The .Nm driver first appeared in .Fx 6.2 . -.Sh SEE ALSO -.Xr smb 4 , -.Xr smbus 4 .Sh AUTHORS .An -nosplit The diff --git a/share/man/man4/audit.4 b/share/man/man4/audit.4 index 11e759c..bcdad54 100644 --- a/share/man/man4/audit.4 +++ b/share/man/man4/audit.4 @@ -39,7 +39,8 @@ of the Common Criteria (CC) Common Access Protection Profile (CAPP) evaluation. The .Fx -audit facility implements the de facto industry standard BSM API, file +.Nm +facility implements the de facto industry standard BSM API, file formats, and command line interface, first found in the Solaris operating system. Information on the user space implementation can be found in @@ -50,15 +51,21 @@ Audit support is enabled at boot, if present in the kernel, using an flag. The audit daemon, .Xr auditd 8 , -is responsible for configuring the kernel to perform audit, pushing +is responsible for configuring the kernel to perform +.Nm , +pushing configuration data from the various audit configuration files into the kernel. .Ss Audit Special Device -The kernel audit facility provides a special device, +The kernel +.Nm +facility provides a special device, .Pa /dev/audit , which is used by .Xr auditd 8 -to monitor for audit events, such as requests to cycle the log, low disk +to monitor for +.Nm +events, such as requests to cycle the log, low disk space conditions, and requests to terminate auditing. This device is not intended for use by applications. .Ss Audit Pipe Special Devices @@ -81,35 +88,45 @@ to track users and events in a fine-grained manner. .Xr setauid 2 , .Xr libbsm 3 , .Xr auditpipe 4 , -.Xr audit.log 5 , .Xr audit_class 5 , .Xr audit_control 5 , .Xr audit_event 5 , +.Xr audit.log 5 , .Xr audit_user 5 , .Xr audit_warn 5 , .Xr rc.conf 5 , .Xr audit 8 , .Xr auditd 8 +.Sh HISTORY +The +.Tn OpenBSM +implementation was created by McAfee Research, the security +division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004. +It was subsequently adopted by the TrustedBSD Project as the foundation for +the OpenBSM distribution. +.Pp +Support for kernel +.Nm +first appeared in +.Fx 6.2 . .Sh AUTHORS +.An -nosplit This software was created by McAfee Research, the security research division of McAfee, Inc., under contract to Apple Computer Inc. -Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc. +Additional authors include +.An Wayne Salamon , +.An Robert Watson , +and SPARTA Inc. .Pp The Basic Security Module (BSM) interface to audit records and audit event stream format were defined by Sun Microsystems. .Pp This manual page was written by .An Robert Watson Aq rwatson@FreeBSD.org . -.Sh HISTORY -The OpenBSM implementation was created by McAfee Research, the security -division of McAfee Inc., under contract to Apple Computer Inc. in 2004. -It was subsequently adopted by the TrustedBSD Project as the foundation for -the OpenBSM distribution. -.Pp -Support for kernel audit first appeared in -.Fx 6.2 . .Sh BUGS -The audit facility in +The +.Nm +facility in .Fx is considered experimental, and production deployment should occur only after careful consideration of the risks of deploying experimental software. diff --git a/share/man/man4/auditpipe.4 b/share/man/man4/auditpipe.4 index 9f77481..3a639dc 100644 --- a/share/man/man4/auditpipe.4 +++ b/share/man/man4/auditpipe.4 @@ -29,7 +29,7 @@ .Dt AUDITPIPE 4 .Sh NAME .Nm auditpipe -.Nd Pseudo-device for live audit event tracking +.Nd "pseudo-device for live audit event tracking" .Sh SYNOPSIS .Cd "options AUDIT" .Sh DESCRIPTION @@ -50,7 +50,7 @@ direct access to live BSM audit data for the purposes of real-time monitoring. Audit pipes are available via a clonable special device, .Pa /dev/auditpipe , -subject to the permissions on the device node, and provide a +subject to the permissions on the device node, and provide a .Qq tee of the audit event stream. As the device is clonable, more than one instance of the device may be opened @@ -64,7 +64,9 @@ Unlike audit data written to the audit trail, the reliability of record delivery is not guaranteed. In particular, when an audit pipe queue fills, records will be dropped. Audit pipe devices are blocking by default, but support non-blocking I/O, -asynchronous I/O using SIGIO, and polled operation via +asynchronous I/O using +.Dv SIGIO , +and polled operation via .Xr select 2 and .Xr poll 2 . @@ -74,28 +76,28 @@ preselection parameters independent of the global audit trail parameters. .Ss Audit Pipe Queue Ioctls The following ioctls retrieve and set various audit pipe record queue properties: -.Bl -tag -width AUDITPIPE_GET_MAXAUDITDATA -.It AUDITPIPE_GET_QLEN +.Bl -tag -width ".Dv AUDITPIPE_GET_MAXAUDITDATA" +.It Dv AUDITPIPE_GET_QLEN Query the current number of records available for reading on the pipe. -.It AUDITPIPE_GET_QLIMIT +.It Dv AUDITPIPE_GET_QLIMIT Retrieve the current maximum number of records that may be queued for reading on the pipe. -.It AUDITPIPE_SET_QLIMIT +.It Dv AUDITPIPE_SET_QLIMIT Set the current maximum number of records that may be queued for reading on the pipe. The new limit must fall between the queue limit minimum and queue limit maximum queryable using the following two ioctls. -.It AUDITPIPE_GET_QLIMIT_MIN +.It Dv AUDITPIPE_GET_QLIMIT_MIN Query the lowest possible maximum number of records that may be queued for reading on the pipe. -.It AUDITPIPE_GET_QLIMIT_MAX +.It Dv AUDITPIPE_GET_QLIMIT_MAX Query the highest possible maximum number of records that may be queued for reading on the pipe. -.It AUDITPIPE_FLUSH +.It Dv AUDITPIPE_FLUSH Flush all outstanding records on the audit pipe; useful after setting initial preselection properties to delete records queued during the configuration process which may not match the interests of the user process. -.It AUDITPIPE_GET_MAXAUDITDATA +.It Dv AUDITPIPE_GET_MAXAUDITDATA Query the maximum size of an audit record, which is a useful minimum size for a user space buffer intended to hold audit records read from the audit pipe. .El @@ -111,23 +113,23 @@ trail, as well as limit records presented to those of specific interest to the application. .Pp The following ioctls configure the preselection mode on an audit pipe: -.Bl -tag -width AUDITPIPE_GET_PRESELECT_MODE -.It AUDITPIPE_GET_PRESELECT_MODE +.Bl -tag -width ".Dv AUDITPIPE_GET_PRESELECT_MODE" +.It Dv AUDITPIPE_GET_PRESELECT_MODE Return the current preselect mode on the audit pipe. The ioctl argument should be of type .Vt int . -.It AUDITPIPE_SET_PRESELECT_MODE +.It Dv AUDITPIPE_SET_PRESELECT_MODE Set the current preselection mode on the audit pipe. The ioctl argument should be of type .Vt int . .El .Pp Possible preselection mode values are: -.Bl -tag -width AUDITPIPE_PRESELECT_MODE_TRAIL -.It AUDITPIPE_PRESELECT_MODE_TRAIL +.Bl -tag -width ".Dv AUDITPIPE_PRESELECT_MODE_TRAIL" +.It Dv AUDITPIPE_PRESELECT_MODE_TRAIL Use the global audit trail preselection parameters to select records for the audit pipe. -.It AUDITPIPE_PRESELECT_MODE_LOCAL +.It Dv AUDITPIPE_PRESELECT_MODE_LOCAL Use local audit pipe preselection; this model is similar to the global audit trail configuration model, consisting of global flags and naflags parameters, as well as a set of per-auid masks. @@ -143,47 +145,47 @@ The following ioctls configure the preselection parameters used when an audit pipe is configured for the .Dv AUDITPIPE_PRESELECT_MODE_LOCAL preselection mode. -.Bl -tag -width AUDITPIPE_GET_PRESELECT_NAFLAGS -.It AUDITPIPE_GET_PRESELECT_FLAGS +.Bl -tag -width ".Dv AUDITPIPE_GET_PRESELECT_NAFLAGS" +.It Dv AUDITPIPE_GET_PRESELECT_FLAGS Retrieve the current default preselection flags for attributable events on the pipe. These flags correspond to the -.Dv flags +.Va flags field in .Xr audit_control 5 . The ioctl argument should be of type .Vt u_int . -.It AUDITPIPE_SET_PRESELECT_FLAGS +.It Dv AUDITPIPE_SET_PRESELECT_FLAGS Set the current default preselection flags for attributable events on the pipe. These flags correspond to the -.Dv flags +.Va flags field in .Xr audit_control 5 . The ioctl argument should be of type .Vt u_int . -.It AUDITPIPE_GET_PRESELECT_NAFLAGS +.It Dv AUDITPIPE_GET_PRESELECT_NAFLAGS Retrieve the current default preselection flags for non-attributable events on the pipe. These flags correspond to the -.Dv naflags +.Va naflags field in .Xr audit_control 5 . The ioctl argument should be of type .Vt u_int . -.It AUDITPIPE_SET_PRESELECT_NAFLAGS +.It Dv AUDITPIPE_SET_PRESELECT_NAFLAGS Set the current default preselection flags for non-attributable events on the pipe. These flags correspond to the -.Dv naflags +.Va naflags field in .Xr audit_control 5 . The ioctl argument should be of type .Vt u_int . -.It AUDITPIPE_GET_PRESELECT_AUID +.It Dv AUDITPIPE_GET_PRESELECT_AUID Query the current preselection masks for a specific auid on the pipe. The ioctl argument should be of type -.Vt struct auditpipe_preselect . +.Vt "struct auditpipe_preselect" . The auid to query is specified via the .Va ap_auid field of type @@ -192,24 +194,26 @@ the mask will be returned via .Va ap_mask of type .Vt au_mask_t . -.It AUDITPIPE_SET_PRESELECT_AUID +.It Dv AUDITPIPE_SET_PRESELECT_AUID Set the current preselection masks for a specific auid on the pipe. Arguments are identical to -.Dv AUDITPIPE_GET_PRESELECT_AUID, +.Dv AUDITPIPE_GET_PRESELECT_AUID , except that the caller should properly initialize the .Va ap_mask field to hold the desired preselection mask. -.It AUDITPIPE_DELETE_PRESELECT_AUID +.It Dv AUDITPIPE_DELETE_PRESELECT_AUID Delete the current preselection mask for a specific auid on the pipe. Once called, events associated with the specified auid will use the default flags mask. The ioctl argument should be of type .Vt au_id_t . -.It AUDITPIPE_FLUSH_PRESELECT_AUID +.It Dv AUDITPIPE_FLUSH_PRESELECT_AUID Delete all auid specific preselection specifications. .El .Sh EXAMPLES +The .Xr praudit 1 +utility may be directly executed on .Pa /dev/auditpipe to review the default audit trail. @@ -220,20 +224,20 @@ to review the default audit trail. .Xr audit_control 5 , .Xr audit 8 , .Xr auditd 8 -.Sh AUTHORS -The audit pipe facility was designed and implemented by -.An Robert Watson Aq rwatson@FreeBSD.org . -.Pp -The Basic Security Module (BSM) interface to audit records and audit event -stream format were defined by Sun Microsystems. .Sh HISTORY The OpenBSM implementation was created by McAfee Research, the security -division of McAfee Inc., under contract to Apple Computer Inc. in 2004. +division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004. It was subsequently adopted by the TrustedBSD Project as the foundation for the OpenBSM distribution. .Pp Support for kernel audit first appeared in .Fx 6.2 . +.Sh AUTHORS +The audit pipe facility was designed and implemented by +.An Robert Watson Aq rwatson@FreeBSD.org . +.Pp +The Basic Security Module (BSM) interface to audit records and audit event +stream format were defined by Sun Microsystems. .Sh BUGS See the .Xr audit 4 diff --git a/share/man/man4/bce.4 b/share/man/man4/bce.4 index cb2667b..7819f72 100644 --- a/share/man/man4/bce.4 +++ b/share/man/man4/bce.4 @@ -1,31 +1,31 @@ -.\"Copyright (c) 2006 Broadcom Corporation -.\" David Christensen <davidch@broadcom.com>. All rights reserved. +.\" Copyright (c) 2006 Broadcom Corporation +.\" David Christensen <davidch@broadcom.com>. All rights reserved. .\" -.\"Redistribution and use in source and binary forms, with or without -.\"modification, are permitted provided that the following conditions -.\"are met: +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: .\" -.\"1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\"2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\"3. Neither the name of Broadcom Corporation nor the name of its contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written consent. +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of Broadcom Corporation nor the name of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written consent. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS' +.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF +.\" THE POSSIBILITY OF SUCH DAMAGE. .\" -.\"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS' -.\"AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\"IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\"ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS -.\"BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -.\"CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -.\"SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -.\"INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -.\"CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -.\"ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF -.\"THE POSSIBILITY OF SUCH DAMAGE. -\" .\" $FreeBSD$ .\" .Dd April 4, 2006 @@ -52,24 +52,32 @@ if_bce_load="YES" .Sh DESCRIPTION The .Nm -driver supports Broadcom's NetXtreme II product family, including the +driver supports Broadcom's NetXtreme II product family, including the BCM5706 and BCM5708 Ethernet controllers. .Pp -The NetXtreme II product family is composed of various Converged NIC (or CNIC) -Ethernet controllers which support a TCP Offload Engine (TOE), Remote DMA (RDMA), -and iSCSI acceleration, in addition to standard L2 Ethernet traffic, all on the +The NetXtreme II product family is composed of various Converged NIC (or CNIC) +Ethernet controllers which support a TCP Offload Engine (TOE), Remote DMA (RDMA), +and iSCSI acceleration, in addition to standard L2 Ethernet traffic, all on the same controller. -The following features are supported in the +The following features are supported in the .Nm -driver under FreeBSD: -.Bd -literal -offset indent +driver under +.Fx : +.Pp +.Bl -item -offset indent -compact +.It IP/TCP/UDP checksum offload +.It Jumbo frames (up to 9022 bytes) +.It VLAN tag stripping +.It Interrupt coalescing +.It 10/100/1000Mbps operation in full-duplex mode +.It 10/100Mbps operation in half-duplex mode -.Ed +.El .Pp The .Nm @@ -84,7 +92,7 @@ the autoselected mode by adding media options to Set 10Mbps operation. The .Xr ifconfig 8 -.Ic mediaopt +.Cm mediaopt option can also be used to select either .Cm full-duplex or @@ -94,7 +102,7 @@ modes. Set 100Mbps (Fast Ethernet) operation. The .Xr ifconfig 8 -.Ic mediaopt +.Cm mediaopt option can also be used to select either .Cm full-duplex or @@ -141,7 +149,7 @@ The driver has encountered a fatal initialization error. .It "bce%d: Unsupported controller revision (%c%d)" The driver does not support the controller revision in use. .It "bce%d: SerDes controllers are not supported!" -The driver does not currently support SerDes/Fiber versions of the +The driver does not currently support SerDes/Fiber versions of the NetXtreme II controller. .It "bce%d: Controller initialization failed!" The driver has encountered a fatal initialization error. diff --git a/share/man/man4/enc.4 b/share/man/man4/enc.4 index 5b61388..c507b03 100644 --- a/share/man/man4/enc.4 +++ b/share/man/man4/enc.4 @@ -63,21 +63,21 @@ or incoming packets after they have been similarly processed, via .Xr tcpdump 8 . .Pp The -.Dq enc0 +.Dq Li enc0 interface inherits all IPsec traffic. Thus all IPsec traffic can be filtered based on -.Dq enc0 , +.Dq Li enc0 , and all IPsec traffic could be seen by invoking .Xr tcpdump 8 on the -.Dq enc0 +.Dq Li enc0 interface. .Sh EXAMPLES To see all outgoing packets before they have been processed via .Xr fast_ipsec 4 , or all incoming packets after they have been similarly processed: .Pp -.Dl # tcpdump -i enc0 +.Dl "tcpdump -i enc0" .Sh SEE ALSO .Xr tcpdump 1 , .Xr bpf 4 , diff --git a/share/man/man4/geom_fox.4 b/share/man/man4/geom_fox.4 index 2c3d53d..027b73d 100644 --- a/share/man/man4/geom_fox.4 +++ b/share/man/man4/geom_fox.4 @@ -47,7 +47,7 @@ geom_fox_load="YES" .Ed .Sh DESCRIPTION The intent of the -.Nm +.Nm framework is to provide basic multipathing support to access direct access devices. Basic in the above sentence should be read as: @@ -88,7 +88,7 @@ fox device has been opened for writing. .Pp .Bl -bullet -compact .It -.Nm +.Nm needs a label on the disk as follows in order to work properly: .Bd -literal "0123456789abcdef0123456789abcdef" @@ -96,14 +96,14 @@ needs a label on the disk as follows in order to work properly: .Ed .Pp For the unique ID 16 bytes are available. -The -.Li GEOM::FOX +The +.Dq Li GEOM::FOX is the magic to mark a .Nm device. .Pp The actual labelling is accomplished by -.Bd -literal +.Bd -literal echo "GEOM::FOX someid" | dd of=/dev/da2 conv=sync .Ed .Pp @@ -190,8 +190,16 @@ You have to be very sure to provide a unique label for each of the devices. Safety belts are not provided. For FibreChannel devices it is suggested to use the Port WWN of the device. -The World Wide Name is guaranteed to be worldwide unique per the +The World Wide Name is guaranteed to be worldwide unique per the FibreChannel standard. +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An "Poul-Henning Kamp" Aq phk@FreeBSD.org . +This manual page was written by +.An "Wilko Bulte" Aq wilko@FreeBSD.org . .Sh BUGS The .Nm @@ -204,11 +212,3 @@ is completely obscure. Just remember that any sly fox has multiple exits from its hole. .Pp The examples provided are too FibreChannel-centric. -.Sh AUTHORS -.An -nosplit -The -.Nm -driver was written by -.An "Poul-Henning Kamp" Aq phk@FreeBSD.org . -This manual page was written by -.An "Wilko Bulte" Aq wilko@FreeBSD.org . diff --git a/share/man/man4/le.4 b/share/man/man4/le.4 index eaa9fb6..18c5d44 100644 --- a/share/man/man4/le.4 +++ b/share/man/man4/le.4 @@ -243,20 +243,18 @@ driver are: The .Nm driver supports the following media types with these chips: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It autoselect +.Bl -tag -width ".Cm 10base5/AUI" +.It Cm autoselect Enable autoselection of the media type. -.It 10baseT/UTP +.It Cm 10baseT/UTP Select UTP media. -.It 10base5/AUI +.It Cm 10base5/AUI Select AUI/BNC media. .El .Pp The following media option is supported with these media types: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It full-duplex +.Bl -tag -width ".Cm full-duplex" +.It Cm full-duplex Select full duplex operation. .El .Pp @@ -274,13 +272,12 @@ interfaces found in .Tn Sun Ultra 1 machines. The following media types are available with these: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It autoselect +.Bl -tag -width ".Cm 10base5/AUI" +.It Cm autoselect Enable autoselection of the media type. -.It 10baseT/UTP +.It Cm 10baseT/UTP Select UTP media. -.It 10base5/AUI +.It Cm 10base5/AUI Select AUI media. .El .Pp diff --git a/share/man/man4/man4.i386/padlock.4 b/share/man/man4/man4.i386/padlock.4 index 880b592..53882dc 100644 --- a/share/man/man4/man4.i386/padlock.4 +++ b/share/man/man4/man4.i386/padlock.4 @@ -53,12 +53,12 @@ All of the above processor series include a hardware random number generator. .Pp The .Nm -driver registers itself to accelerate AES operations and if available HMAC/SHA1 +driver registers itself to accelerate AES operations and, if available, HMAC/SHA1 and HMAC/SHA256 for .Xr crypto 4 . It also registers itself to accelerate other HMAC algorithms, although there is no hardware acceleration for those algorithms. -This is only needed, so +This is only needed so .Nm can work with .Xr fast_ipsec 4 . @@ -66,6 +66,13 @@ can work with The hardware random number generator supplies data for the kernel .Xr random 4 subsystem. +.Sh SEE ALSO +.Xr crypt 3 , +.Xr crypto 4 , +.Xr fast_ipsec 4 , +.Xr intro 4 , +.Xr random 4 , +.Xr crypto 9 .Sh HISTORY The .Nm @@ -75,13 +82,6 @@ The first .Fx release to include it was .Fx 6.0 . -.Sh SEE ALSO -.Xr crypt 3 , -.Xr crypto 4 , -.Xr fast_ipsec 4 , -.Xr intro 4 , -.Xr random 4 , -.Xr crypto 9 .Sh AUTHORS .An -nosplit The diff --git a/share/man/man4/mfi.4 b/share/man/man4/mfi.4 index 631f4f4..36f1ec1 100644 --- a/share/man/man4/mfi.4 +++ b/share/man/man4/mfi.4 @@ -63,7 +63,6 @@ a new driver. Older SCSI and SATA MegaRAID cards are supported by .Xr amr 4 and will not work with this driver. -.Pp .Sh HARDWARE The .Nm @@ -92,8 +91,6 @@ The .Nm driver first appeared in .Fx 6.1 . -.Pp -.El .Sh AUTHORS The .Nm diff --git a/share/man/man4/mxge.4 b/share/man/man4/mxge.4 index 85ef31b..af7332d 100644 --- a/share/man/man4/mxge.4 +++ b/share/man/man4/mxge.4 @@ -61,7 +61,8 @@ driver provides support for PCI Express 10 Gigabit Ethernet adapters based on the Myricom LANai Z8E chip. The driver supports Transmit/Receive checksum offload, Jumbo Frames as well as TCP segmentation offload (TSO). -For further hardware information, see http://www.myri.com +For further hardware information, see +.Pa http://www.myri.com/ . .Pp For questions related to hardware requirements, refer to the documentation supplied with your Myri10GE adapter. @@ -107,7 +108,7 @@ The default value is 30. This value determines whether or not the driver may omit doing a pio read in the interrupt handler which ensures that the interrupt line has been deasserted when using xPIC interrupts. -A non-zero value +A non-zero value may result in lower CPU overhead, however it may also result in spurious interrupts. The default value is 0. @@ -125,7 +126,7 @@ This is a fatal initialization error. .Sh SUPPORT For general information and support, go to the Myricom support website at: -.Pa http://www.myri.com/scs . +.Pa http://www.myri.com/scs/ . .Pp If an issue is identified with the released source code on the supported kernel with a supported adapter, email the specific information related to the diff --git a/share/man/man4/nfsmb.4 b/share/man/man4/nfsmb.4 index b2e932f..d6f39ce 100644 --- a/share/man/man4/nfsmb.4 +++ b/share/man/man4/nfsmb.4 @@ -38,14 +38,14 @@ The .Nm driver provides access to NVIDIA nForce2/3/4 SMBus 2.0 controllers. +.Sh SEE ALSO +.Xr smb 4 , +.Xr smbus 4 .Sh HISTORY The .Nm driver first appeared in .Fx 6.2 . -.Sh SEE ALSO -.Xr smb 4 , -.Xr smbus 4 .Sh AUTHORS .An -nosplit The diff --git a/share/man/man4/ng_tag.4 b/share/man/man4/ng_tag.4 index 32dfd1c..a94700c 100644 --- a/share/man/man4/ng_tag.4 +++ b/share/man/man4/ng_tag.4 @@ -316,17 +316,6 @@ variable: .Bd -literal -offset 4n sysctl net.inet.ip.fw.one_pass=0 .Ed -.Sh BUGS -For manipulating any tags with data payload (that is, all tags with non-zero -.Va tag_len ) -one should care about non-portable machine-dependent representation of -tags on the low level as byte stream. -Perhaps this should be done by another program rather than manually. -.Sh HISTORY -The -.Nm -node type was implemented in -.Fx 6.2 . .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_bpf 4 , @@ -334,5 +323,16 @@ node type was implemented in .Xr ipfw 8 , .Xr ngctl 8 , .Xr mbuf_tags 9 +.Sh HISTORY +The +.Nm +node type was implemented in +.Fx 6.2 . .Sh AUTHORS .An Vadim Goncharov Aq vadimnuclight@tpu.ru +.Sh BUGS +For manipulating any tags with data payload (that is, all tags with non-zero +.Va tag_len ) +one should care about non-portable machine-dependent representation of +tags on the low level as byte stream. +Perhaps this should be done by another program rather than manually. diff --git a/share/man/man4/rr232x.4 b/share/man/man4/rr232x.4 index ad47419..3ae5adc 100644 --- a/share/man/man4/rr232x.4 +++ b/share/man/man4/rr232x.4 @@ -25,7 +25,7 @@ .\" $FreeBSD$ .\" .Dd April 27, 2006 -.Dt rr232x 4 +.Dt RR232X 4 .Os .Sh NAME .Nm rr232x @@ -58,9 +58,7 @@ Additionally, if multiple controllers are present, arrays may be built out of drives that are attached to different controllers. Online management is provided by utilities that are available for free download from -.Rs -.%O http://www.highpoint-tech.com/ -.Re +.Pa http://www.highpoint-tech.com/ . .Sh HARDWARE The .Nm @@ -88,12 +86,11 @@ The .Nm driver first appeared in .Fx 6.1 . -.Pp .Sh AUTHORS .An -nosplit The .Nm driver was provided by -.An HighPoint Technologies, Inc . +.An "HighPoint Technologies, Inc" . This manual page was written by .An Scott Long Aq scottl@FreeBSD.org . diff --git a/share/man/man4/sched_core.4 b/share/man/man4/sched_core.4 index 4f2a095..9a97e91 100644 --- a/share/man/man4/sched_core.4 +++ b/share/man/man4/sched_core.4 @@ -29,7 +29,7 @@ .Dt SCHED_CORE 4 .Sh NAME .Nm sched_core -.Nd CORE Scheduler +.Nd CORE scheduler .Sh SYNOPSIS .Cd "options SCHED_CORE" .Sh DESCRIPTION @@ -40,12 +40,14 @@ is an experimental scheduler that provides a number of advanced scheduler features not present in .Xr sched_4bsd 4 , the default system scheduler, nor -.Xr sched_ule 4 where it is forked off. +.Xr sched_ule 4 +where it is forked off. These features address SMP and interactivity and include: .Pp .Bl -bullet -compact -offset indent .It -Nice value of timesharing processes is respected. Allocation of +Nice value of timesharing processes is respected. +Allocation of time slice and interaction detection algorithm are based on nice value. .It @@ -68,11 +70,11 @@ This read-only sysctl reports the name of the active scheduler. .It Va kern.sched.ipiwakeup.enabled (SMP specific) Whether to allow forwarding of wakeup to idle CPUs. .It Va kern.sched.ipiwakeup.requested -(SMP specific) Requests for forwarding of wakeup to idle CPUs. -(read-only). +(SMP specific) Requests for forwarding of wakeup to idle CPUs, +read-only. .It Va kern.sched.ipiwakeup.requested -(SMP specific) Completed forwarding of wakeup to idle CPUs. -(read-only). +(SMP specific) Completed forwarding of wakeup to idle CPUs, +read-only. .It Va kern.sched.ipiwakeup.usemask (SMP specific) Whether to use the mask of idle CPUs. .It Va kern.sched.ipiwakeup.useloop diff --git a/share/man/man4/sched_ule.4 b/share/man/man4/sched_ule.4 index a57bae3..7ff8232 100644 --- a/share/man/man4/sched_ule.4 +++ b/share/man/man4/sched_ule.4 @@ -29,7 +29,7 @@ .Dt SCHED_ULE 4 .Sh NAME .Nm sched_ule -.Nd ULE Scheduler +.Nd ULE scheduler .Sh SYNOPSIS .Cd "options SCHED_ULE" .Sh DESCRIPTION diff --git a/share/man/man4/snd_emu10kx.4 b/share/man/man4/snd_emu10kx.4 index cf0fac7..4cd733c 100644 --- a/share/man/man4/snd_emu10kx.4 +++ b/share/man/man4/snd_emu10kx.4 @@ -55,15 +55,16 @@ The .Nm bridge driver allows the generic audio driver .Xr sound 4 -to attach to the Creative sound cards based on EMU10K1, CA0100, CA0101, CA0102 +to attach to the Creative sound cards based on EMU10K1, CA0100, CA0101, CA0102 and CA0108 DSPs. .Pp +The .Nm sound cards have a PCM part, which is accessible through one to five .Xr pcm 4 -devices (see +devices (see .Sx MULTICHANNEL PLAYBACK -for details), and MPU401-compatible MIDI I/O controller, which is accessible +for details), and MPU401-compatible MIDI I/O controller, which is accessible through the midi device. Wave table synthesizer is not supported. .Sh HARDWARE @@ -86,7 +87,7 @@ of this chipset is not supported). .It Creative Sound Blaster Audigy 2 Value (CA0108 Chipset). PCM support is limited -to 48kHz/16 bit stereo (192kHz/24 bit part of this chipset is not supported).\& +to 48kHz/16 bit stereo (192kHz/24 bit part of this chipset is not supported). There is no MIDI support for this card. .El .Pp @@ -99,19 +100,22 @@ similar to some supported ones): .Pp .Bl -bullet -compact .It -Creative Sound Blaster Live!\& 24-Bit, identified by FreeBSD as -.Li Qq emu10k1x Soundblaster Live! 5.1 . +Creative Sound Blaster Live!\& 24-Bit, identified by +.Fx +as +.Qq Li "emu10k1x Soundblaster Live! 5.1" . .It -Creative Sound Blaster Audigy LS / ES, identified by FreeBSD as -.Li Qq CA0106-DAT Audigy LS . +Creative Sound Blaster Audigy LS / ES, identified by +.Fx +as +.Qq Li "CA0106-DAT Audigy LS" . .It All other cards with -DAT chipsets. .El .Sh MULTICHANNEL PLAYBACK -.Pp It is possible to build this driver with multichannel playback capabilites. If you enable the -.Dq Dv EMU10KX_MULTICHANNEL +.Dv EMU10KX_MULTICHANNEL option in your kernel configuration (or build it as a module) you will get up to five DSP devices, one for each sound card output. @@ -120,36 +124,38 @@ Only output can play and record sound from external sources (like line or S/PDIF inputs). .Sh OSS MIXER CONTROLS -.Pp -These are controls available through the standard OSS programming interface. +These are controls available through the standard OSS programming interface. You can use .Xr mixer 8 to change them. .Pp -On EMU10K1-based cards the OSS mixer directly controls the AC97 codec on card. +On EMU10K1-based cards the OSS mixer directly controls the AC97 codec on card. On newer cards the OSS mixer controls some parameters of the AC97 codec and some DSP-based mixer controls. -.Pp -"vol" mixer control is overall sound volume. -.Pp -"pcm" mixer control is PCM playback volume. +.Bl -inset +.It Qq vol +mixer control is overall sound volume. +.It Qq pcm +mixer control is PCM playback volume. It controls only front output volume in multichannel mode and all output volume in single chennel mode. -.Pp -"rec" mixer control acts very different on EMU10K1 and other cards. +.It Qq rec +mixer control acts very different on EMU10K1 and other cards. On EMU10K1 cards it controls the AC97 codec recording level. On non-EMU10K1 cards it controls the amount of AC97 "stereo mix" entering the DSP. -AC97 recording level and AC97 recording source are fixed +AC97 recording level and AC97 recording source are fixed on CA0100, CA0101, CA0102 and CA0108 cards. -AC97 recording level are always set to -maximum and recording source is always "stereo mix". +AC97 recording level are always set to +maximum and recording source is always +.Dq Li "stereo mix" . +.El .Pp Other OSS mixer controls do not work. .Sh PRIVATE DEVICE CONTROLS -.Pp You can control most of EMU10Kx operation and configuration parameters through -dev.emu10kx.X sysctls. +.Va dev.emu10kx. Ns Aq Ar X +sysctls. These .Xr sysctl 8 values are temporary and should not be relied @@ -159,21 +165,21 @@ upon. The following kernel configuration options control the .Nm driver. -.Bl -tag -width EMU10KX_MULTICHANNEL -.It Em EMU10KX_MULTICHANNEL +.Bl -tag -width ".Dv EMU10KX_MULTICHANNEL" +.It Dv EMU10KX_MULTICHANNEL This option enables .Sx MULTICHANNEL PLAYBACK for all instances of the .Nm driver. -.It Em EMU10KX_DEBUG +.It Dv EMU10KX_DEBUG This option enables additional debug messages. .El -.Pp .Sh FILES -.Bl -tag -width /dev/emu10kx? -compact +.Bl -tag -width ".Pa /dev/emu10kx?" -compact .It Pa /dev/emu10kx? -emu10kx management interface +.Nm +management interface .El .Sh SEE ALSO .Xr sound 4 @@ -183,12 +189,15 @@ The device driver first appeared in .Fx 7.0 . .Sh AUTHORS +.An -nosplit The PCM part of the driver is based on the .Xr snd_emu10k1 4 -SB Live! driver by Cameron Grant. +SB Live!\& driver by +.An "Cameron Grant" . The MIDI interface is based on the .Xr snd_emu10k1 4 -MIDI interface code by Mathew Kanner. +MIDI interface code by +.An "Mathew Kanner" . The .Nm device driver and this manual page were written by @@ -197,7 +206,7 @@ device driver and this manual page were written by 8kHz/8bit/mono recording does not work. 8kHz recording was removed from the driver capabilites. .Pp -The Driver does not detect lost S/PDIF signal and produces noise when S/PDIF +The driver does not detect lost S/PDIF signal and produces noise when S/PDIF is not connected and S/PDIF volume is not zero. .Pp The PCM driver cannot detect the presence of Live!Drive or AudigyDrive diff --git a/share/man/man4/stge.4 b/share/man/man4/stge.4 index 95ea0b9..a491189 100644 --- a/share/man/man4/stge.4 +++ b/share/man/man4/stge.4 @@ -77,7 +77,7 @@ The Sundance/Tamarack TC9021 supports TBI (ten bit interface) and GMII transceivers, which means it can be used with either copper or 1000baseX fiber applications. .Pp -The Sundance/Tamarack TC9021 also support jumbo frames, which can be +The Sundance/Tamarack TC9021 also supports jumbo frames, which can be configured via the interface MTU setting. Selecting an MTU larger than 1500 bytes with the .Xr ifconfig 8 @@ -139,7 +139,6 @@ Force half duplex operation. The .Nm driver also supports one special link option for 1000baseTX cards: -.Pp .Bl -tag -width ".Cm link0" .It Cm link0 With 1000baseTX cards, establishing a link between two ports requires @@ -152,7 +151,7 @@ The .Nm driver configures the ports as slaves by default. Setting the -.Ar link0 +.Cm link0 flag with .Xr ifconfig 8 will set a port as a master instead. @@ -192,12 +191,13 @@ variables and tunables: .Bl -tag -width indent .It Va dev.stge.%d.rxint_nframe -Number of frames between RxDMAComplete interrupt. +Number of frames between RxDMAComplete interrupts. The accepted range is 1 to 255, default value is 8 frames. The interface has to be brought down and up again before a change takes effect. .It Va dev.stge.%d.rxint_dmawait Maximum amount of time to wait in 1us increments before issuing -a Rx interrupt if number of frames received is less than rxint_nframe. +an Rx interrupt if the number of frames received is less than +.Va rxint_nframe . The accepted range is 0 to 4194, default value is 30 microseconds. The interface has to be brought down and up again before a change takes effect. .El diff --git a/share/man/man4/ufoma.4 b/share/man/man4/ufoma.4 index 52abf0e..7c9b1ae 100644 --- a/share/man/man4/ufoma.4 +++ b/share/man/man4/ufoma.4 @@ -47,7 +47,7 @@ by .Xr umodem 4 , but the .Nm -driver recognizes a specific usb descriptor that describes its role and +driver recognizes a specific USB descriptor that describes its role and interface structure, and it will negotiate its role when the device is open. They support a regular AT command set and the commands can either be multiplexed with the data stream @@ -60,9 +60,9 @@ The device is accessed through the driver which makes it behave like a .Xr tty 4 . .Sh SYSCTLS -This device often have a few interface sets and these interfaces -have its role, sometimes multiplexed. -These roles are identified with the following sysctl MIB's: +These devices often have a few interface sets and these interfaces +have their role, sometimes multiplexed. +These roles are identified with the following sysctl MIBs: .Bl -tag -width indent .It Va dev.ucom.%d.supportmode The modes which are supported by the interface. @@ -73,20 +73,19 @@ Mode to transit when the device is open next. .El The modes are as follows: .Bl -tag -width indent -.It modem +.It Li modem Accepts AT commands and go and pass packet communication data. -.It handsfree +.It Li handsfree Accepts AT commands but it does not pass data. -.It obex +.It Li obex Accepts OBEX frame which is used to exchange telephone book, etc. -.It vendor1 -.It vendor2 -Vendor specific data may passed. -.It deactivated -When a interface is recognized to the system and not used, the interface -will set to this mode. -.It unlinked -When a interface is not yet negotiated, the interface is in this mode. +.It Li vendor1 , vendor2 +Vendor specific data may be passed. +.It Li deactivated +When an interface is recognized by the system but not used, the interface +will be set to this mode. +.It Li unlinked +When an interface is not yet negotiated, the interface is in this mode. .El .Sh HARDWARE Devices supported by the @@ -102,10 +101,14 @@ KYOCERA PHS AH-K3001V (a.k.a Kyopon) SANYO Vodafone3G V801SA .El .Sh SEE ALSO -specification can be found at: +Specification can be found at: .Pp -http://www.nttdocomo.co.jp/corporate/technology/document/foma/index.html -http://www.mcpc-jp.org/doclist.htm +.Bl -item -compact +.It +.Pa http://www.nttdocomo.co.jp/corporate/technology/document/foma/index.html +.It +.Pa http://www.mcpc-jp.org/doclist.htm +.El .Pp .Xr tty 4 , .Xr ucom 4 , @@ -116,7 +119,8 @@ The .Nm driver appeared in -.Fx 7-CURRENT, partly from +.Fx 7.0 , +partly derived from the .Xr umodem 4 code. .Sh BUGS |