From 78ad54210fe02edbec3bfe18db3a33088b7c06ff Mon Sep 17 00:00:00 2001 From: Ruslan Ermilov Date: Fri, 18 Nov 2005 10:56:28 +0000 Subject: [PATCH] -mdoc sweep. --- contrib/smbfs/mount_smbfs/mount_smbfs.8 | 4 +- share/man/man4/ath.4 | 5 +- share/man/man4/bpf.4 | 16 +- share/man/man4/cardbus.4 | 2 +- share/man/man4/dcons.4 | 4 +- share/man/man4/de.4 | 2 +- share/man/man4/ed.4 | 4 +- share/man/man4/em.4 | 4 +- share/man/man4/fwip.4 | 2 +- share/man/man4/geom.4 | 236 ++++++++++++++------- share/man/man4/hwpmc.4 | 4 +- share/man/man4/icmp.4 | 4 +- share/man/man4/if_bridge.4 | 6 +- share/man/man4/ip.4 | 14 +- share/man/man4/ipw.4 | 2 +- share/man/man4/mac_seeotheruids.4 | 2 +- share/man/man4/man4.i386/acpi_ibm.4 | 16 +- share/man/man4/man4.i386/arl.4 | 2 +- share/man/man4/man4.i386/cp.4 | 2 +- share/man/man4/man4.i386/cs.4 | 2 +- share/man/man4/man4.i386/cx.4 | 4 +- share/man/man4/man4.i386/ep.4 | 32 +-- share/man/man4/man4.i386/ex.4 | 4 +- share/man/man4/man4.i386/fe.4 | 2 +- share/man/man4/man4.i386/ie.4 | 2 +- share/man/man4/man4.i386/linux.4 | 10 +- share/man/man4/man4.i386/lnc.4 | 2 +- share/man/man4/man4.i386/ray.4 | 2 +- share/man/man4/man4.i386/vx.4 | 2 +- share/man/man4/ng_iface.4 | 6 +- share/man/man4/pccard.4 | 2 +- share/man/man4/pccbb.4 | 2 +- share/man/man4/txp.4 | 2 +- share/man/man4/wi.4 | 1 - share/man/man4/xe.4 | 2 +- share/man/man5/disktab.5 | 1 + share/man/man5/make.conf.5 | 8 +- share/man/man5/rc.conf.5 | 26 +-- share/man/man7/build.7 | 10 +- share/man/man8/diskless.8 | 2 +- share/man/man9/atomic.9 | 2 +- share/man/man9/bios.9 | 32 ++- share/man/man9/bus_dma.9 | 2 +- share/man/man9/device_add_child.9 | 4 +- share/man/man9/device_get_softc.9 | 2 +- share/man/man9/namei.9 | 2 +- share/man/man9/timeout.9 | 1 - usr.sbin/moused/moused.8 | 7 +- usr.sbin/ndp/ndp.8 | 23 +- usr.sbin/pkg_install/add/pkg_add.1 | 10 +- usr.sbin/pkg_install/version/pkg_version.1 | 2 +- usr.sbin/powerd/powerd.8 | 2 +- usr.sbin/sade/sade.8 | 2 +- usr.sbin/sysinstall/sysinstall.8 | 2 +- 54 files changed, 330 insertions(+), 218 deletions(-) diff --git a/contrib/smbfs/mount_smbfs/mount_smbfs.8 b/contrib/smbfs/mount_smbfs/mount_smbfs.8 index a9b812c93d5c..861f9f35b53d 100644 --- a/contrib/smbfs/mount_smbfs/mount_smbfs.8 +++ b/contrib/smbfs/mount_smbfs/mount_smbfs.8 @@ -157,8 +157,8 @@ It is possible to use for smbfs mounts: .Pp .Dl "//guest@samba/public /smb/public smbfs rw,noauto 0 0" -.Sh BUGS -Please report bugs to the author. .Sh AUTHORS .An Boris Popov Aq bp@butya.kz , .Aq bp@FreeBSD.org +.Sh BUGS +Please report bugs to the author. diff --git a/share/man/man4/ath.4 b/share/man/man4/ath.4 index e41611027203..9d53b8951469 100644 --- a/share/man/man4/ath.4 +++ b/share/man/man4/ath.4 @@ -58,8 +58,8 @@ if_ath_load="YES" The .Nm driver provides support for wireless network adapters based on -the Atheros AR5210, AR5211, and AR5212 programming api's. -These api's are used by a wide variety of chips; all chips with +the Atheros AR5210, AR5211, and AR5212 programming APIs. +These APIs are used by a wide variety of chips; all chips with a PCI and/or CardBus interface are supported. Chip-specific support is provided by the Atheros Hardware Access Layer (HAL), that is packaged separately. @@ -213,7 +213,6 @@ Create a host-based wireless bridge to fxp0: .Bd -literal -offset indent ifconfig ath0 inet up ssid my_ap media DS/11Mbps mediaopt hostap sysctl net.inet.ip.check_interface=0 -kldload if_bridge.ko ifconfig bridge0 create ifconfig bridge0 addm ath0 addm fxp0 .Ed diff --git a/share/man/man4/bpf.4 b/share/man/man4/bpf.4 index 2839dade7e10..9911a6398ada 100644 --- a/share/man/man4/bpf.4 +++ b/share/man/man4/bpf.4 @@ -22,7 +22,7 @@ .\" .\" $FreeBSD$ .\" -.Dd January 16, 1996 +.Dd August 23, 2005 .Dt BPF 4 .Os .Sh NAME @@ -258,8 +258,13 @@ for an explanation of the filter language. .It Dv BIOCSETWF .Pq Li "struct bpf_program" Sets the write filter program used by the kernel to control what type of -packets can be written to the interface. See the BIOCSETF command for more -information on the bpf filter program. +packets can be written to the interface. +See the +.Dv BIOCSETF +command for more +information on the +.Nm +filter program. .It Dv BIOCVERSION .Pq Li "struct bpf_version" Returns the major and minor version numbers of the filter language currently @@ -307,7 +312,10 @@ Set to one to see packets originating locally and remotely on the interface. This flag is initialized to one by default. .It Dv BIOCLOCK -Set the locked flag on the bpf descriptor. This prevents the execution of +Set the locked flag on the +.Nm +descriptor. +This prevents the execution of ioctl commands which could change the underlying operating parameters of the device. .El diff --git a/share/man/man4/cardbus.4 b/share/man/man4/cardbus.4 index 04b3e23d4939..1c3600a91683 100644 --- a/share/man/man4/cardbus.4 +++ b/share/man/man4/cardbus.4 @@ -41,7 +41,7 @@ The driver supports all cardbus bridges in the system. .Sh TUNABLES The driver supports the following tunable parameters, which may be -added to +added to .Pa /boot/loader.conf or set via the .Xr sysctl 8 diff --git a/share/man/man4/dcons.4 b/share/man/man4/dcons.4 index 694a2536b3af..a0dfa1b8adce 100644 --- a/share/man/man4/dcons.4 +++ b/share/man/man4/dcons.4 @@ -31,7 +31,7 @@ .Nm dcons .Nd dumb console device driver .Sh SYNOPSIS -To compile support for the driver into your kernel, +To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "options GDB" @@ -39,7 +39,7 @@ place the following lines in your kernel configuration file: .Cd "device dcons" .Ed .Pp -Alternatively, to load the driver at boot time, +Alternatively, to load the driver as a module at boot time, place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "options GDB" diff --git a/share/man/man4/de.4 b/share/man/man4/de.4 index 2179c50c3448..16b20ab09922 100644 --- a/share/man/man4/de.4 +++ b/share/man/man4/de.4 @@ -33,7 +33,7 @@ .Nd "DEC DC21x4x Ethernet device driver" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device de" diff --git a/share/man/man4/ed.4 b/share/man/man4/ed.4 index f3322f2de998..b600678bb0f6 100644 --- a/share/man/man4/ed.4 +++ b/share/man/man4/ed.4 @@ -399,6 +399,6 @@ As a result, it may throw out some good packets which have been received but not yet transferred from the card to main memory. .Pp The -.Nm -PC Card attachment supports the D-Link DMF650TX Lan/Modem card's ethernet +.Nm +PC Card attachment supports the D-Link DMF650TX LAN/Modem card's Ethernet port only at this time. diff --git a/share/man/man4/em.4 b/share/man/man4/em.4 index 7b1e8f117b5d..cd5722828eac 100644 --- a/share/man/man4/em.4 +++ b/share/man/man4/em.4 @@ -39,7 +39,7 @@ .Nd "Intel(R) PRO/1000 Gigabit Ethernet adapter driver" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device em" @@ -175,7 +175,7 @@ Intel PRO/1000 XT Server Adapter (82544) Tunables can be set at the .Xr loader 8 prompt before booting the kernel or stored in -.Pa /boot/loader.conf . +.Xr loader.conf 5 . .Bl -tag -width indent .It Va hw.em.rxd Number of receive descriptors allocated by the driver. diff --git a/share/man/man4/fwip.4 b/share/man/man4/fwip.4 index 4de39424362d..c2c9f05bb7eb 100644 --- a/share/man/man4/fwip.4 +++ b/share/man/man4/fwip.4 @@ -41,7 +41,7 @@ kernel configuration file: .Ed .Pp Alternatively, to load the driver as a -module at boot time, place the following line in +module at boot time, place the following lines in .Xr loader.conf 5 : .Bd -literal -offset indent firewire_load="YES" diff --git a/share/man/man4/geom.4 b/share/man/man4/geom.4 index 78c5584b7946..7ea24eb7a3a5 100644 --- a/share/man/man4/geom.4 +++ b/share/man/man4/geom.4 @@ -39,22 +39,31 @@ .Dt GEOM 4 .Sh NAME .Nm GEOM -.Nd modular disk I/O request transformation framework. +.Nd "modular disk I/O request transformation framework" .Sh DESCRIPTION -The GEOM framework provides an infrastructure in which "classes" +The +.Nm +framework provides an infrastructure in which +.Dq classes can perform transformations on disk I/O requests on their path from the upper kernel to the device drivers and back. .Pp -Transformations in a GEOM context range from the simple geometric +Transformations in a +.Nm +context range from the simple geometric displacement performed in typical disk partitioning modules over RAID algorithms and device multipath resolution to full blown cryptographic protection of the stored data. .Pp -Compared to traditional "volume management", GEOM differs from most +Compared to traditional +.Dq "volume management" , +.Nm +differs from most and in some cases all previous implementations in the following ways: .Bl -bullet .It -GEOM is extensible. +.Nm +is extensible. It is trivially simple to write a new class of transformation and it will not be given stepchild treatment. If @@ -62,10 +71,11 @@ someone for some reason wanted to mount IBM MVS diskpacks, a class recognizing and configuring their VTOC information would be a trivial matter. .It -GEOM is topologically agnostic. +.Nm +is topologically agnostic. Most volume management implementations have very strict notions of how classes can fit together, very often -one fixed hierarchy is provided for instance subdisk - plex - +one fixed hierarchy is provided, for instance, subdisk - plex - volume. .El .Pp @@ -74,34 +84,56 @@ than existing transformations. .Pp Fixed hierarchies are bad because they make it impossible to express the intent efficiently. -In the fixed hierarchy above it is not possible to mirror two +In the fixed hierarchy above, it is not possible to mirror two physical disks and then partition the mirror into subdisks, instead one is forced to make subdisks on the physical volumes and to mirror -these two and two resulting in a much more complex configuration. -GEOM on the other hand does not care in which order things are done, +these two and two, resulting in a much more complex configuration. +.Nm +on the other hand does not care in which order things are done, the only restriction is that cycles in the graph will not be allowed. -.Pp -.Sh "TERMINOLOGY and TOPOLOGY" -GEOM is quite object oriented and consequently the terminology +.Sh "TERMINOLOGY AND TOPOLOGY" +.Nm +is quite object oriented and consequently the terminology borrows a lot of context and semantics from the OO vocabulary: .Pp -A "class", represented by the data structure g_class implements one +A +.Dq class , +represented by the data structure +.Vt g_class +implements one particular kind of transformation. Typical examples are MBR disk partition, BSD disklabel, and RAID5 classes. .Pp -An instance of a class is called a "geom" and represented by the -data structure "g_geom". -In a typical i386 FreeBSD system, there +An instance of a class is called a +.Dq geom +and represented by the data structure +.Vt g_geom . +In a typical i386 +.Fx +system, there will be one geom of class MBR for each disk. .Pp -A "provider", represented by the data structure "g_provider", is -the front gate at which a geom offers service. -A provider is "a disk-like thing which appears in /dev" - a logical +A +.Dq provider , +represented by the data structure +.Vt g_provider , +is the front gate at which a geom offers service. +A provider is +.Do +a disk-like thing which appears in +.Pa /dev +.Dc - a logical disk in other words. -All providers have three main properties: name, sectorsize and size. +All providers have three main properties: +.Dq name , +.Dq sectorsize +and +.Dq size . .Pp -A "consumer" is the backdoor through which a geom connects to another +A +.Dq consumer +is the backdoor through which a geom connects to another geom provider and through which I/O requests are sent. .Pp The topological relationship between these entities are as follows: @@ -126,7 +158,7 @@ This rank number is assigned as follows: .Bl -enum .It -A geom with no attached consumers has rank=1 +A geom with no attached consumers has rank=1. .It A geom with attached consumers has a rank one higher than the highest rank of the geoms of the providers its consumers are @@ -137,46 +169,52 @@ In addition to the straightforward attach, which attaches a consumer to a provider, and detach, which breaks the bond, a number of special topological maneuvers exists to facilitate configuration and to improve the overall flexibility. -.Pp -.Em TASTING +.Bl -inset +.It Em TASTING is a process that happens whenever a new class or new provider -is created and it provides the class a chance to automatically configure an -instance on providers, which it recognize as its own. +is created, and it provides the class a chance to automatically configure an +instance on providers, which it recognizes as its own. A typical example is the MBR disk-partition class which will look for -the MBR table in the first sector and if found and validated it will +the MBR table in the first sector and, if found and validated, will instantiate a geom to multiplex according to the contents of the MBR. .Pp A new class will be offered to all existing providers in turn and a new provider will be offered to all classes in turn. .Pp Exactly what a class does to recognize if it should accept the offered -provider is not defined by GEOM, but the sensible set of options are: +provider is not defined by +.Nm , +but the sensible set of options are: .Bl -bullet .It Examine specific data structures on the disk. .It -Examine properties like sectorsize or mediasize for the provider. +Examine properties like +.Dq sectorsize +or +.Dq mediasize +for the provider. .It Examine the rank number of the provider's geom. .It Examine the method name of the provider's geom. .El -.Pp -.Em ORPHANIZATION +.It Em ORPHANIZATION is the process by which a provider is removed while it potentially is still being used. .Pp When a geom orphans a provider, all future I/O requests will -"bounce" on the provider with an error code set by the geom. +.Dq bounce +on the provider with an error code set by the geom. Any consumers attached to the provider will receive notification about the orphanization when the eventloop gets around to it, and they can take appropriate action at that time. .Pp A geom which came into being as a result of a normal taste operation -should selfdestruct unless it has a way to keep functioning lacking +should self-destruct unless it has a way to keep functioning lacking the orphaned provider. -Geoms like diskslicers should therefore selfdestruct whereas +Geoms like diskslicers should therefore self-destruct whereas RAID5 or mirror geoms will be able to continue, as long as they do not loose quorum. .Pp @@ -185,7 +223,8 @@ immediate change in the topology: any attached consumers are still attached, any opened paths are still open, any outstanding I/O requests are still outstanding. .Pp -The typical scenario is +The typical scenario is: +.Pp .Bl -bullet -offset indent -compact .It A device driver detects a disk has departed and orphans the provider for it. @@ -200,11 +239,13 @@ relevant pieces of the tree has heard the bad news. Eventually the buck stops when it reaches geom_dev at the top of the stack. .It -Geom_dev will call destroy_dev(9) to stop any more request from +Geom_dev will call +.Xr destroy_dev 9 +to stop any more request from coming in. It will sleep until all (if any) outstanding I/O requests have been returned. -It will explicitly close (ie: zero the access counts), a change +It will explicitly close (i.e.: zero the access counts), a change which will propagate all the way down through the mesh. It will then detach and destroy its geom. .It @@ -221,26 +262,41 @@ flexibility and robustness in handling disappearing devices. The one absolutely crucial detail to be aware is that if the device driver does not return all I/O requests, the tree will not unravel. -.Pp -.Em SPOILING +.It Em SPOILING is a special case of orphanization used to protect against stale metadata. It is probably easiest to understand spoiling by going through an example. .Pp -Imagine a disk, "da0" on top of which a MBR geom provides -"da0s1" and "da0s2" and on top of "da0s1" a BSD geom provides -"da0s1a" through "da0s1e", both the MBR and BSD geoms have +Imagine a disk, +.Pa da0 +on top of which an MBR geom provides +.Pa da0s1 +and +.Pa da0s2 , +and on top of +.Pa da0s1 +a BSD geom provides +.Pa da0s1a +through +.Pa da0s1e , +both the MBR and BSD geoms have autoconfigured based on data structures on the disk media. -Now imagine the case where "da0" is opened for writing and those -data structures are modified or overwritten: Now the geoms would +Now imagine the case where +.Pa da0 +is opened for writing and those +data structures are modified or overwritten: now the geoms would be operating on stale metadata unless some notification system can inform them otherwise. .Pp -To avoid this situation, when the open of "da0" for write happens, +To avoid this situation, when the open of +.Pa da0 +for write happens, all attached consumers are told about this, and geoms like -MBR and BSD will selfdestruct as a result. -When "da0" is closed again, it will be offered for tasting again +MBR and BSD will self-destruct as a result. +When +.Pa da0 +is closed again, it will be offered for tasting again and if the data structures for MBR and BSD are still there, new geoms will instantiate themselves anew. .Pp @@ -248,9 +304,13 @@ Now for the fine print: .Pp If any of the paths through the MBR or BSD module were open, they would have opened downwards with an exclusive bit rendering it -impossible to open "da0" for writing in that case and conversely +impossible to open +.Pa da0 +for writing in that case and conversely the requested exclusive bit would render it impossible to open a -path through the MBR geom while "da0" is open for writing. +path through the MBR geom while +.Pa da0 +is open for writing. .Pp From this it also follows that changing the size of open geoms can only be done with their cooperation. @@ -258,8 +318,7 @@ only be done with their cooperation. Finally: the spoiling only happens when the write count goes from zero to non-zero and the retasting only when the write count goes from non-zero to zero. -.Pp -.Em INSERT/DELETE +.It Em INSERT/DELETE are a very special operation which allows a new geom to be instantiated between a consumer and a provider attached to each other and to remove it again. @@ -277,8 +336,7 @@ We have now in essence moved a mounted file system from one disk to another while it was being used. At this point the mirror geom can be deleted from the path again, it has served its purpose. -.Pp -.Em CONFIGURE +.It Em CONFIGURE is the process where the administrator issues instructions for a particular class to instantiate itself. There are multiple @@ -287,24 +345,33 @@ specified with a level of override forcing for instance a BSD disklabel module to attach to a provider which was not found palatable during the TASTE operation. .Pp -Finally IO is the reason we even do this: it concerns itself with +Finally I/O is the reason we even do this: it concerns itself with sending I/O requests through the graph. -.Pp -.Em "I/O REQUESTS -represented by struct bio, originate at a consumer, +.It Em "I/O REQUESTS" +represented by +.Vt "struct bio" , +originate at a consumer, are scheduled on its attached provider, and when processed, returned to the consumer. -It is important to realize that the struct bio which -enters through the provider of a particular geom does not "come -out on the other side". +It is important to realize that the +.Vt "struct bio" +which enters through the provider of a particular geom does not +.Do +come out on the other side +.Dc . Even simple transformations like MBR and BSD will clone the -struct bio, modify the clone, and schedule the clone on their +.Vt "struct bio" , +modify the clone, and schedule the clone on their own consumer. -Note that cloning the struct bio does not involve cloning the -actual data area specified in the IO request. +Note that cloning the +.Vt "struct bio" +does not involve cloning the +actual data area specified in the I/O request. .Pp -In total four different IO requests exist in GEOM: read, write, -delete, and get attribute. +In total, four different I/O requests exist in +.Nm : +read, write, delete, and +.Dq "get attribute". .Pp Read and write are self explanatory. .Pp @@ -320,24 +387,32 @@ It is important to recognize that a delete indication is not a request and consequently there is no guarantee that the data actually will be erased or made unavailable unless guaranteed by specific geoms in the graph. -If "secure delete" semantics are required, a +If +.Dq "secure delete" +semantics are required, a geom should be pushed which converts delete indications into (a sequence of) write requests. .Pp -Get attribute supports inspection and manipulation +.Dq "Get attribute" +supports inspection and manipulation of out-of-band attributes on a particular provider or path. -Attributes are named by ascii strings and they will be discussed in +Attributes are named by +.Tn ASCII +strings and they will be discussed in a separate section below. +.El .Pp -(stay tuned while the author rests his brain and fingers: more to come.) +(Stay tuned while the author rests his brain and fingers: more to come.) .Sh DIAGNOSTICS -Several flags are provided for tracing GEOM operations and unlocking +Several flags are provided for tracing +.Nm +operations and unlocking protection mechanisms via the .Va kern.geom.debugflags sysctl. All of these flags are off by default, and great care should be taken in turning them on. -.Bl -tag -width FAIL +.Bl -tag -width indent .It 0x01 Pq Dv G_T_TOPOLOGY Provide tracing of topology change events. .It 0x02 Pq Dv G_T_BIO @@ -358,14 +433,23 @@ This appears to be unused at this time. Dump contents of gctl requests. .El .Sh HISTORY -This software was developed for the FreeBSD Project by Poul-Henning Kamp +This software was developed for the +.Fx +Project by +.An Poul-Henning Kamp and NAI Labs, the Security Research Division of Network Associates, Inc.\& -under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the +under DARPA/SPAWAR contract N66001-01-C-8035 +.Pq Dq CBOSS , +as part of the DARPA CHATS research program. .Pp -The first precursor for GEOM was a gruesome hack to Minix 1.2 and was +The first precursor for +.Nm +was a gruesome hack to Minix 1.2 and was never distributed. An earlier attempt to implement a less general scheme -in FreeBSD never succeeded. +in +.Fx +never succeeded. .Sh AUTHORS .An "Poul-Henning Kamp" Aq phk@FreeBSD.org diff --git a/share/man/man4/hwpmc.4 b/share/man/man4/hwpmc.4 index 67dc923c902e..ab54f3102d7a 100644 --- a/share/man/man4/hwpmc.4 +++ b/share/man/man4/hwpmc.4 @@ -35,7 +35,7 @@ .Cd "device hwpmc" .Pp Additionally, for i386 systems: -.Cd device apic +.Cd "device apic" .Sh DESCRIPTION The .Nm @@ -503,7 +503,7 @@ between the currently executing kernel and the module being loaded. .It "hwpmc: this kernel has not been compiled with 'options HWPMC_HOOKS'." The module loading process failed because the currently executing kernel was not configured with the required configuration option -.Cd HWPMC_HOOKS . +.Dv HWPMC_HOOKS . .It "hwpmc: tunable hashsize=%d must be greater than zero." A negative value was supplied for tunable .Va kern.hwpmc.hashsize . diff --git a/share/man/man4/icmp.4 b/share/man/man4/icmp.4 index 3d607873504a..73600d15d2d2 100644 --- a/share/man/man4/icmp.4 +++ b/share/man/man4/icmp.4 @@ -141,8 +141,8 @@ By default continue with normal source selection. .Pq Vt boolean Use the IP address of the interface the packet came through in for responses to packets which are not directly addressed to us. -If enabled this rule is processed before all others. -By default continue with normal source selection. +If enabled, this rule is processed before all others. +By default, continue with normal source selection. Enabling this option is particularly useful on routers because it makes external traceroutes show the actual path a packet has taken instead of the possibly different return path. diff --git a/share/man/man4/if_bridge.4 b/share/man/man4/if_bridge.4 index 545e514a1fc1..0dc4b05a5811 100644 --- a/share/man/man4/if_bridge.4 +++ b/share/man/man4/if_bridge.4 @@ -174,10 +174,10 @@ ifconfig bridge0 \e up .Ed .Sh SEE ALSO -.Xr ifconfig 8 , -.Xr ipfw 4 , .Xr ipf 4 , -.Xr pf 4 +.Xr ipfw 4 , +.Xr pf 4 , +.Xr ifconfig 8 .Sh HISTORY The .Nm diff --git a/share/man/man4/ip.4 b/share/man/man4/ip.4 index d5da6e1e6f65..e8bea4e01229 100644 --- a/share/man/man4/ip.4 +++ b/share/man/man4/ip.4 @@ -117,7 +117,7 @@ setsockopt(s, IPPROTO_IP, IP_TTL, &ttl, sizeof(ttl)); may be used to set the minimum acceptable TTL a packet must have when received on a socket. All packets with a lower TTL are silently dropped. -This option is only really useful when set to 255 preventing packets +This option is only really useful when set to 255, preventing packets from outside the directly connected networks reaching local listeners on sockets. .Pp @@ -125,15 +125,19 @@ on sockets. may be used to set the Don't Fragment flag on IP packets. Currently this option is respected only on .Xr udp 4 -and Raw +and raw .Xr ip 4 -sockets, unless the IP_HDRINCL option has been set. +sockets, unless the +.Dv IP_HDRINCL +option has been set. On .Xr tcp 4 -sockets the Don't Fragment flag is controlled by the Path +sockets, the Don't Fragment flag is controlled by the Path MTU Discovery option. Sending a packet larger than the MTU size of the egress interface, -determined by the destination address, returns an EMSGSIZE error. +determined by the destination address, returns an +.Er EMSGSIZE +error. .Pp If the .Dv IP_RECVDSTADDR diff --git a/share/man/man4/ipw.4 b/share/man/man4/ipw.4 index 82bde9a74521..ae19cc83ae7a 100644 --- a/share/man/man4/ipw.4 +++ b/share/man/man4/ipw.4 @@ -42,7 +42,7 @@ kernel configuration file: .Ed .Pp Alternatively, to load the driver as a -module at boot time, place the following line in +module at boot time, place the following lines in .Xr loader.conf 5 : .Bd -literal -offset indent if_ipw_load="YES" diff --git a/share/man/man4/mac_seeotheruids.4 b/share/man/man4/mac_seeotheruids.4 index dc0d30ec893e..4eeb7bba9eb6 100644 --- a/share/man/man4/mac_seeotheruids.4 +++ b/share/man/man4/mac_seeotheruids.4 @@ -30,7 +30,7 @@ .\" .\" $FreeBSD$ .\" -.Dd October 06, 2005 +.Dd October 6, 2005 .Os .Dt MAC_SEEOTHERUIDS 4 .Sh NAME diff --git a/share/man/man4/man4.i386/acpi_ibm.4 b/share/man/man4/man4.i386/acpi_ibm.4 index d2ef59cba1e8..2912a6397b1f 100644 --- a/share/man/man4/man4.i386/acpi_ibm.4 +++ b/share/man/man4/man4.i386/acpi_ibm.4 @@ -135,7 +135,7 @@ Access IBM Button .Ss Xr led 4 Ss Interface The .Nm -driver provides an +driver provides a .Xr led 4 interface for the Thinklight. The Thinklight can be made to blink by writing @@ -307,6 +307,13 @@ UltraBay battery .Pp Defaults for these sysctls can be set in .Xr sysctl.conf 5 . +.Sh FILES +.Bl -tag -width ".Pa /dev/led/thinklight" +.It Pa /dev/led/thinklight +Thinklight +.Xr led 4 +device node +.El .Sh EXAMPLES The following can be added to .Xr devd.conf 5 @@ -396,13 +403,6 @@ then fi exit 0 .Ed -.Sh FILES -.Bl -tag -width ".Pa /dev/led/thinklight" -.It Pa /dev/led/thinklight -Thinklight -.Xr led 4 -device node -.El .Sh SEE ALSO .Xr acpi 4 , .Xr sysctl.conf 5 , diff --git a/share/man/man4/man4.i386/arl.4 b/share/man/man4/man4.i386/arl.4 index 57a19bc4c725..d908c8ae0281 100644 --- a/share/man/man4/man4.i386/arl.4 +++ b/share/man/man4/man4.i386/arl.4 @@ -38,7 +38,7 @@ .Nd "Aironet Arlan 655 wireless network adapter driver" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device arl" diff --git a/share/man/man4/man4.i386/cp.4 b/share/man/man4/man4.i386/cp.4 index 894adfaf5a94..049bb0829749 100644 --- a/share/man/man4/man4.i386/cp.4 +++ b/share/man/man4/man4.i386/cp.4 @@ -21,7 +21,7 @@ .Nd "driver for synchronous Cronyx Tau-PCI WAN adapters" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device cp" diff --git a/share/man/man4/man4.i386/cs.4 b/share/man/man4/man4.i386/cs.4 index a09904cba12b..77551e8ad116 100644 --- a/share/man/man4/man4.i386/cs.4 +++ b/share/man/man4/man4.i386/cs.4 @@ -33,7 +33,7 @@ .Nd "Ethernet device driver" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device cs" diff --git a/share/man/man4/man4.i386/cx.4 b/share/man/man4/man4.i386/cx.4 index 4dcab79bdd58..00df603b5941 100644 --- a/share/man/man4/man4.i386/cx.4 +++ b/share/man/man4/man4.i386/cx.4 @@ -21,12 +21,12 @@ .Nd "driver for synchronous/asynchronous Cronyx Sigma WAN adapters" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device cx" .Ed -Pp +.Pp Alternatively, to load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : diff --git a/share/man/man4/man4.i386/ep.4 b/share/man/man4/man4.i386/ep.4 index 0ff55d62f98b..62e1b7209917 100644 --- a/share/man/man4/man4.i386/ep.4 +++ b/share/man/man4/man4.i386/ep.4 @@ -37,7 +37,7 @@ .Nd "Ethernet driver for 3Com Etherlink III (3c5x9) interfaces" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device ep" @@ -154,50 +154,50 @@ They are supported by the driver. .Sh DIAGNOSTICS .Bl -diag -.It ep0: reset (status: %x) +.It "ep0: reset (status: %x)" The driver has encountered a FIFO underrun or overrun. The driver will reset the card and the packet will be lost. This is not fatal. -.It ep0: eeprom failed to come ready +.It "ep0: eeprom failed to come ready" The eeprom failed to come ready. This probably means the card is wedged. -.It ep0: 3c509 in test mode. Erase pencil mark! +.It "ep0: 3c509 in test mode. Erase pencil mark!" This means that someone has scribbled with pencil in the test area on the card. Erase the pencil mark and reboot. (This is not a joke). -.It ep0: No I/O space?! +.It "ep0: No I/O space?!" The driver was unable to allocate the I/O space that it thinks should be there. Look for conflicts with other devices. -.It ep0: No irq?! +.It "ep0: No irq?!" The driver couldn't allocate the interrupt it wanted. Look for conflicts, although sharing interrupts for PC Card is normal. -.It ep0: No connectors! +.It "ep0: No connectors!" The driver queried the hardware for what ethernet attachment were present, but the hardware reported none that the driver recognized. -.It ep0: Unable to get Ethernet address! +.It "ep0: Unable to get Ethernet address!" The driver was unable to read the ethernet address from the EEPROM. This is likely the result of the card being wedged. -.It ep0: if_alloc() failed +.It "ep0: if_alloc() failed" The driver was unable to allocate a ifnet structure. This may happen in extremely low memory conditions. -.It ep0: strange connector type in EEPROM: assuming AUI +.It "ep0: strange connector type in EEPROM: assuming AUI" The driver does not know what to do with the information the EEPROM has about connectors, so it is assuming the worst. -.It ep0: unknown ID 0xXXXXXXXX +.It "ep0: unknown ID 0xXXXXXXXX" The driver has found an ID that it believes it supports, but doesn't have a specific identification string to present to the user. -.It ep0: <%s> at port 0x%03x in EISA mode +.It "ep0: <%s> at port 0x%03x in EISA mode" The 3C509 ISA card is in EISA mode. -This message appears to be purely informational. -.It ep0: <%s> at x0%03x in PnP mode +This message appears to be purely informational. +.It "ep0: <%s> at x0%03x in PnP mode" This card appears to be in Plug and Play mode. It should be probed as part of the plug and play phase of the ISA probes. -.It ep0: Invalid EEPROM checksum! +.It "ep0: Invalid EEPROM checksum!" The EEPROM has a bad checksum, so the driver is ignoring the card. -.It ep0: bus_setup_intr() failed! +.It "ep0: bus_setup_intr() failed!" The driver was unable to setup the interrupt handler. This should never happen. .El diff --git a/share/man/man4/man4.i386/ex.4 b/share/man/man4/man4.i386/ex.4 index 469b4565ddd6..3ffb3fcf661b 100644 --- a/share/man/man4/man4.i386/ex.4 +++ b/share/man/man4/man4.i386/ex.4 @@ -33,7 +33,7 @@ .Nd "Ethernet device driver for the Intel EtherExpress Pro/10 and Pro/10+" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device ex" @@ -104,7 +104,7 @@ The .Nm device driver was written by .An Javier Mart\('in Rueda . -The PC Card attachment was written by +The PC Card attachment was written by .An Mitsuru ISAWAKI and .An Warner Losh . diff --git a/share/man/man4/man4.i386/fe.4 b/share/man/man4/man4.i386/fe.4 index 0c99ad70f411..ff395e9e193e 100644 --- a/share/man/man4/man4.i386/fe.4 +++ b/share/man/man4/man4.i386/fe.4 @@ -30,7 +30,7 @@ .Nd "Fujitsu MB86960A/MB86965A based Ethernet adapters" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device fe" diff --git a/share/man/man4/man4.i386/ie.4 b/share/man/man4/man4.i386/ie.4 index ceb7b61cebcc..17d24d23ce61 100644 --- a/share/man/man4/man4.i386/ie.4 +++ b/share/man/man4/man4.i386/ie.4 @@ -33,7 +33,7 @@ .Nd "Ethernet device driver" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device ie" diff --git a/share/man/man4/man4.i386/linux.4 b/share/man/man4/man4.i386/linux.4 index 62107acef2d3..649027b6f262 100644 --- a/share/man/man4/man4.i386/linux.4 +++ b/share/man/man4/man4.i386/linux.4 @@ -108,10 +108,14 @@ regardless of whether the .Nm module is statically linked into the kernel or loaded as a module. -.Ed .Pp -Some linux scripts want to execute /lib/ld-linux.so.2. In order to do this, -you should turn the kern.elf32.can_exec_dyn sysctl(8) variable to 1. +Some Linux scripts want to execute +.Pa /lib/ld-linux.so.2 . +In order to do this, +you should turn the +.Va kern.elf32.can_exec_dyn +.Xr sysctl 8 +variable to 1. .Sh FILES .Bl -tag -width /compat/linux/proc -compact .It Pa /compat/linux diff --git a/share/man/man4/man4.i386/lnc.4 b/share/man/man4/man4.i386/lnc.4 index a6ce33298548..4b04d711ff85 100644 --- a/share/man/man4/man4.i386/lnc.4 +++ b/share/man/man4/man4.i386/lnc.4 @@ -33,7 +33,7 @@ .Nd "AMD Lance/PCnet Ethernet device driver" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device lnc" diff --git a/share/man/man4/man4.i386/ray.4 b/share/man/man4/man4.i386/ray.4 index a079d721b4c5..23eb168acc2d 100644 --- a/share/man/man4/man4.i386/ray.4 +++ b/share/man/man4/man4.i386/ray.4 @@ -38,7 +38,7 @@ .Nd "Raytheon Raylink/Webgear Aviator PCCard driver" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device ray" diff --git a/share/man/man4/man4.i386/vx.4 b/share/man/man4/man4.i386/vx.4 index 30dae91a4854..99d89e92dfed 100644 --- a/share/man/man4/man4.i386/vx.4 +++ b/share/man/man4/man4.i386/vx.4 @@ -38,7 +38,7 @@ .Nd "3Com EtherLink III / Fast EtherLink III (3c59x) Ethernet driver" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device vx" diff --git a/share/man/man4/ng_iface.4 b/share/man/man4/ng_iface.4 index 809e9e2a3d71..90563b84dc8d 100644 --- a/share/man/man4/ng_iface.4 +++ b/share/man/man4/ng_iface.4 @@ -149,11 +149,11 @@ However, is a special case, since it is not a physical interface with limited bandwidth. One should not turn ALTQ on .Nm -if the latter corresponds to some tunneled connection, e.g. PPPoE or PPTP. -In this case ALTQ should be configured on the interface, that is used to +if the latter corresponds to some tunneled connection, e.g.\& PPPoE or PPTP. +In this case, ALTQ should be configured on the interface that is used to transmit the encapsulated packets. In case when your graph ends up with some kind of serial line, either -synchronous or modem, then +synchronous or modem, the .Nm is the right place to turn ALTQ on. .Sh SEE ALSO diff --git a/share/man/man4/pccard.4 b/share/man/man4/pccard.4 index 1fb6ce005523..f955804978e2 100644 --- a/share/man/man4/pccard.4 +++ b/share/man/man4/pccard.4 @@ -41,7 +41,7 @@ The driver supports all PC Card bridges in the system. .Sh TUNABLES The driver supports the following tunable parameters, which may be -added to +added to .Pa /boot/loader.conf or set via the .Xr sysctl 8 diff --git a/share/man/man4/pccbb.4 b/share/man/man4/pccbb.4 index f39546aabfce..27ef584f8b10 100644 --- a/share/man/man4/pccbb.4 +++ b/share/man/man4/pccbb.4 @@ -166,7 +166,7 @@ Toshiba ToPIC100 .El .Sh TUNABLES The driver supports the following tunable parameters, which may be -added to +added to .Pa /boot/loader.conf or set via the .Xr sysctl 8 diff --git a/share/man/man4/txp.4 b/share/man/man4/txp.4 index a67445263085..64a19e876dff 100644 --- a/share/man/man4/txp.4 +++ b/share/man/man4/txp.4 @@ -34,7 +34,7 @@ .Nd "3Com 3XP Typhoon/Sidewinder (3CR990) Ethernet interface" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device txp" diff --git a/share/man/man4/wi.4 b/share/man/man4/wi.4 index c1004e01d8ad..40700407e99e 100644 --- a/share/man/man4/wi.4 +++ b/share/man/man4/wi.4 @@ -327,7 +327,6 @@ Create a host-based wireless bridge to fxp0 (Prism only): .Bd -literal -offset indent ifconfig wi0 inet up ssid my_ap media DS/11Mbps mediaopt hostap sysctl net.inet.ip.check_interface=0 -kldload if_bridge.ko ifconfig bridge0 create ifconfig bridge0 addm wi0 addm fxp0 .Ed diff --git a/share/man/man4/xe.4 b/share/man/man4/xe.4 index 2ad179b4def5..0935884badc9 100644 --- a/share/man/man4/xe.4 +++ b/share/man/man4/xe.4 @@ -33,7 +33,7 @@ .Nd "Xircom PCMCIA Ethernet device driver" .Sh SYNOPSIS To compile this driver into the kernel, -place the following lines in your +place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device xe" diff --git a/share/man/man5/disktab.5 b/share/man/man5/disktab.5 index 98bd783d4c7c..07e8a42302b4 100644 --- a/share/man/man5/disktab.5 +++ b/share/man/man5/disktab.5 @@ -137,6 +137,7 @@ file system, swap, etc) .El .Sh SEE ALSO .Xr getdiskbyname 3 , +.\" .Xr bsdlabel 5 , .Xr bsdlabel 8 , .Xr newfs 8 .Sh HISTORY diff --git a/share/man/man5/make.conf.5 b/share/man/man5/make.conf.5 index d44a604524ea..c70071890976 100644 --- a/share/man/man5/make.conf.5 +++ b/share/man/man5/make.conf.5 @@ -865,7 +865,11 @@ Build with support for the IEEE 802.1X protocol and with support for EAP-PEAP, EAP-TLS, EAP-LEAP, and EAP-TTLS protocols (usable only via 802.1X). -This option is ignored if NO_CRYPTO or NO_OPENSSL are configured. +This option is ignored if +.Va NO_CRYPT +or +.Va NO_OPENSSL +are set. .El .Sh FILES .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact @@ -883,7 +887,7 @@ This option is ignored if NO_CRYPTO or NO_OPENSSL are configured. .Xr environ 7 , .Xr ports 7 , .Xr lpd 8 , -.Xr sendmail 8 +.Xr sendmail 8 , .Xr wpa_supplicant 8 .Sh HISTORY The diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5 index 5076dc494813..9abb68439bdb 100644 --- a/share/man/man5/rc.conf.5 +++ b/share/man/man5/rc.conf.5 @@ -237,7 +237,7 @@ utility when the memory file system for .Pa /tmp is created. The default is -.Dq Li -S -M , +.Dq Li "-S -M" , which inhibits the use of softupdates on .Pa /tmp to waste as little space as possible @@ -269,7 +269,7 @@ utility when the memory file system for .Pa /var is created. The default is -.Dq Li -S -M , +.Dq Li "-S -M" , which inhibits the use of softupdates on .Pa /var to waste as little space as possible @@ -923,8 +923,8 @@ Refer to for more information. .It Va network_interfaces .Pq Vt str -Set to the list of network interfaces to configure on this host or -.Dq Li "AUTO" +Set to the list of network interfaces to configure on this host or +.Dq Li AUTO (the default) for all current interfaces. For example, if the only active network devices in the system are the loopback device @@ -954,10 +954,11 @@ Routing (CIDR) address notation, whose last byte can be a range like 192.168.0.5-23/24. In this case the address 192.168.0.5 will be configured with the netmask /24 and the addresses 192.168.0.6 to 192.168.0.23 with -the non-conflicting netmask /32 as explained in the ifconfig(8) +the non-conflicting netmask /32 as explained in the +.Xr ifconfig 8 alias section. With the interface in question being -.Li ed0, +.Li ed0 , an example could look like: .Bd -literal ipv4_addrs_ed0="192.168.0.1/24 192.168.1.1-5/28" @@ -1014,14 +1015,14 @@ variables. If the .Va ifconfig_ Ns Aq Ar interface contains the keyword -.Dq Li "NOAUTO" +.Dq Li NOAUTO then the interface will not be configured at boot or by .Pa /etc/pccard_ether when .Va network_interfaces is set to -.Dq Li "AUTO" . +.Dq Li AUTO . .Pp It is possible to bring up an interface with DHCP by adding .Dq Li DHCP @@ -1252,7 +1253,7 @@ Default flags to use by .Xr geli 8 when configuring disk encryption. Flags can be configured for every device separately by defining -.Va geli__flags +.Va geli_ Ns Ao Ar device Ac Ns Va _flags variable. .It Va geli_autodetach .Pq Vt str @@ -1261,14 +1262,14 @@ file systems are mounted. Default is .Dq Li YES . This can be changed for every device separately by defining -.Va geli__autodetach +.Va geli_ Ns Ao Ar device Ac Ns Va _autodetach variable. .It Va geli_swap_flags Options passed to the .Xr geli 8 utility when encrypted GEOM providers for swap partitions are created. The default is -.Dq Li -a aes -l 256 -s 4096 -d . +.Dq Li "-a aes -l 256 -s 4096 -d" . .It Va root_rw_mount .Pq Vt bool Set to @@ -3246,7 +3247,8 @@ This is configured via .Xr sysctl 8 variable .Va kern.init_shutdown_timeout -and defaults to 120 seconds. Setting the value of +and defaults to 120 seconds. +Setting the value of .Va rcshutdown_timeout to more than 120 seconds will have no effect until the .Xr sysctl 8 diff --git a/share/man/man7/build.7 b/share/man/man7/build.7 index 31f20e898f74..b1e1f2855d87 100644 --- a/share/man/man7/build.7 +++ b/share/man/man7/build.7 @@ -84,7 +84,7 @@ and release. .It Cm installworld Install everything built by .Cm buildworld . -.It Cm kernel-toolchain +.It Cm kernel-toolchain Rebuild the tools needed for kernel compilation. Use this if you did not do a buildworld first. .It Cm buildkernel @@ -100,7 +100,9 @@ followed by .Cm installkernel .It Cm delete-old Delete obsolete base system files and directories interactively. -When -DBATCH_DELETE_OLD_FILES is specified at the command line, +When +.Li -DBATCH_DELETE_OLD_FILES +is specified at the command line, the delete operation will be non-interactive. The variables .Va DESTDIR , TARGET_ARCH @@ -111,7 +113,9 @@ should be set as with .It Cm delete-old-libs Delete obsolete base system libraries interactively. This should only be used if no 3rd party software uses the libraries anymore. -When -DBATCH_DELETE_OLD_FILES is specified at the command line, +When +.Li -DBATCH_DELETE_OLD_FILES +is specified at the command line, the delete operation will be non-interactive. The variables .Va DESTDIR , TARGET_ARCH diff --git a/share/man/man8/diskless.8 b/share/man/man8/diskless.8 index 6822c68d1c1c..01b53d5df3e2 100644 --- a/share/man/man8/diskless.8 +++ b/share/man/man8/diskless.8 @@ -452,8 +452,8 @@ encryption keys. .Sh SEE ALSO .Xr ethers 5 , .Xr exports 5 , -.Xr bootpd 8 , .Xr make.conf 5 , +.Xr bootpd 8 , .Xr mountd 8 , .Xr nfsd 8 , .Xr pxeboot 8 , diff --git a/share/man/man9/atomic.9 b/share/man/man9/atomic.9 index 49334325946c..be5c74ea2e9e 100644 --- a/share/man/man9/atomic.9 +++ b/share/man/man9/atomic.9 @@ -23,7 +23,7 @@ .\" .\" $FreeBSD$ .\" -.Dd October 27, 2000 +.Dd September 27, 2005 .Os .Dt ATOMIC 9 .Sh NAME diff --git a/share/man/man9/bios.9 b/share/man/man9/bios.9 index a9b411338485..e7922aff8dff 100644 --- a/share/man/man9/bios.9 +++ b/share/man/man9/bios.9 @@ -24,7 +24,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd August 1, 1997 +.Dd August 9, 2005 .Dt BIOS 9 .Os .Sh NAME @@ -98,29 +98,39 @@ Searches a given BIOS memory range for one or more strings, and composes a printable concatenation of those found. The routine expects a structure describing the BIOS address .Fa range -(within 0xe0000 - 0xfffff), and a { NULL, 0, 0 } -terminated array of -.Fa bios_oem_signature +(within +.Li 0xe0000 +- +.Li 0xfffff ) , +and a { +.Dv NULL , Li 0 , 0 +} -terminated array of +.Vt bios_oem_signature structures which define the -.Fa anchor +.Va anchor string, an -.Fa offset +.Va offset from the beginning of the match (which may be negative), and -.Fa totlen +.Va totlen number of bytes to be collected from BIOS memory starting at that offset. Unmatched anchors are ignored, whereas matches are copied from BIOS memory starting at their corresponding -.Fa offset +.Vt offset with unprintable characters being replaced with space, and consecutive spaces -being suppressed. This composed string is stored in +being suppressed. +This composed string is stored in .Fa buffer up to the given .Fa maxlen -bytes (including trailing '\\0', and any trailing space surpressed). -If an error is encountered, i.e. trying to read out of said BIOS range, +bytes (including trailing +.Ql \e0 , +and any trailing space surpressed). +If an error is encountered, i.e.\& trying to read out of said BIOS range, other invalid input, or .Fa buffer overflow, a negative integer is returned, otherwise the -length of the composed string is returned. In particular, a return +length of the composed string is returned. +In particular, a return value of 0 means that none of the given anchor strings were found in the specified BIOS memory range. .It Fn BIOS_VADDRTOPADDR diff --git a/share/man/man9/bus_dma.9 b/share/man/man9/bus_dma.9 index 4b669b0dbaa6..c3e59cd373c4 100644 --- a/share/man/man9/bus_dma.9 +++ b/share/man/man9/bus_dma.9 @@ -60,7 +60,7 @@ .\" $FreeBSD$ .\" $NetBSD: bus_dma.9,v 1.25 2002/10/14 13:43:16 wiz Exp $ .\" -.Dd Aug 31, 2005 +.Dd August 31, 2005 .Dt BUS_DMA 9 .Os .Sh NAME diff --git a/share/man/man9/device_add_child.9 b/share/man/man9/device_add_child.9 index 51e7093a2389..a71330cf3a2c 100644 --- a/share/man/man9/device_add_child.9 +++ b/share/man/man9/device_add_child.9 @@ -111,9 +111,9 @@ devices. .Sh RETURN VALUES The new device if successful, NULL otherwise. .Sh SEE ALSO +.Xr device 9 , +.Xr device_find_children 9 , .Xr DEVICE_IDENTIFY 9 -.Xr device 9 -.Xr device_find_children 9 .Sh AUTHORS This manual page was written by .An Doug Rabson . diff --git a/share/man/man9/device_get_softc.9 b/share/man/man9/device_get_softc.9 index a31c5bed7187..76f94d448aff 100644 --- a/share/man/man9/device_get_softc.9 +++ b/share/man/man9/device_get_softc.9 @@ -60,8 +60,8 @@ tree that predate this function. .Sh RETURN VALUES The pointer to the driver-specific instance variable is returned. .Sh SEE ALSO -.Xr DEVICE_PROBE 9 , .Xr device 9 , +.Xr DEVICE_PROBE 9 , .Xr device_set_softc 9 , .Xr driver 9 .Sh AUTHORS diff --git a/share/man/man9/namei.9 b/share/man/man9/namei.9 index 7429a2790b78..01260c1fcd77 100644 --- a/share/man/man9/namei.9 +++ b/share/man/man9/namei.9 @@ -33,7 +33,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 27, 2003 +.Dd September 21, 2005 .Os .Dt NAMEI 9 .Sh NAME diff --git a/share/man/man9/timeout.9 b/share/man/man9/timeout.9 index d683e32f69af..195dce24bced 100644 --- a/share/man/man9/timeout.9 +++ b/share/man/man9/timeout.9 @@ -370,7 +370,6 @@ if (sc->sc_flags & SCFLG_CALLOUT_RUNNING) { } } .Ed -.Pp .It The .Fn callout_pending , diff --git a/usr.sbin/moused/moused.8 b/usr.sbin/moused/moused.8 index efab52d9577e..ed6ab56ff5e4 100644 --- a/usr.sbin/moused/moused.8 +++ b/usr.sbin/moused/moused.8 @@ -133,12 +133,13 @@ Set the report rate (reports/sec) of the device if supported. Enable .Dq Horizontal Virtual Scrolling . With this option set, holding the middle mouse -button down will cause motion to be interpreted as -horizontal scrolling. +button down will cause motion to be interpreted as +horizontal scrolling. Use the .Fl U option to set the distance the mouse must move before the scrolling mode is -activated. This option may be used with or without the +activated. +This option may be used with or without the .Fl V option. .It Fl I Ar file diff --git a/usr.sbin/ndp/ndp.8 b/usr.sbin/ndp/ndp.8 index 4d99527d781f..70f51560a6a6 100644 --- a/usr.sbin/ndp/ndp.8 +++ b/usr.sbin/ndp/ndp.8 @@ -78,11 +78,11 @@ The .Nm utility manipulates the address mapping table used by the Neighbor Discovery Protocol (NDP). -.Bl -tag -width Ds +.Bl -tag -width indent .It Fl a Dump the currently existing NDP entries. The following information will be printed: -.Bl -tag -width NeighborXX +.Bl -tag -width "Neighbor" .It Neighbor IPv6 address of the neighbor. .It Linklayer Address @@ -173,8 +173,7 @@ before .Fl foo in this case. .\" -.Pp -.Bl -tag -width Ds -compact +.Bl -tag -width indent .It Ic nud Turn on or off NUD (Neighbor Unreachability Detection) on the interface. @@ -197,9 +196,7 @@ For more details about the entire algorithm of source address selection, see the .Pa IMPLEMENTATION file supplied with the KAME kit. -.It Xo -.Ic disabled -.Xc +.It Ic disabled Disable IPv6 operation on the interface. When disabled, the interface discards any IPv6 packets received on or being sent to the interface. @@ -210,17 +207,11 @@ a certain failure of Duplicate Address Detection. While the flag can be set or cleared by hand with the .Nm command, it is not generally advisable to modify this flag manually. -.It Xo -.Ic basereachable=(number) -.Xc +.It Ic basereachable Ns Li = Ns Pq Ar number Specify the BaseReachbleTimer on the interface in millisecond. -.It Xo -.Ic retrans=(number) -.Xc +.It Ic retrans Ns Li = Ns Pq Ar number Specify the RetransTimer on the interface in millisecond. -.It Xo -.Ic curhlim=(number) -.Xc +.It Ic curhlim Ns Li = Ns Pq Ar number Specify the Cur Hop Limit on the interface. .El .It Fl n diff --git a/usr.sbin/pkg_install/add/pkg_add.1 b/usr.sbin/pkg_install/add/pkg_add.1 index 914900b3c15a..b92518c54e83 100644 --- a/usr.sbin/pkg_install/add/pkg_add.1 +++ b/usr.sbin/pkg_install/add/pkg_add.1 @@ -128,11 +128,12 @@ modes (see the .Fl M and .Fl S -options). If the +options). +If the .Fl p flag appears after any .Fl P -flag on the command line, it overrides it's effect, causing +flag on the command line, it overrides its effect, causing .Nm not to use the given .Ar prefix @@ -142,11 +143,12 @@ Does the same as the .Fl p option, except that the given .Ar prefix -is also used recursively for the dependency packages, if any. If the +is also used recursively for the dependency packages, if any. +If the .Fl P flag appears after any .Fl p -flag on the command line, it overrides it's effect, causing +flag on the command line, it overrides its effect, causing .Nm to use the given .Ar prefix diff --git a/usr.sbin/pkg_install/version/pkg_version.1 b/usr.sbin/pkg_install/version/pkg_version.1 index c48343a5de3a..0607ada5280e 100644 --- a/usr.sbin/pkg_install/version/pkg_version.1 +++ b/usr.sbin/pkg_install/version/pkg_version.1 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd Jul 27, 2005 +.Dd July 27, 2005 .Dt PKG_VERSION 1 .Os .Sh NAME diff --git a/usr.sbin/powerd/powerd.8 b/usr.sbin/powerd/powerd.8 index d3c5260691a6..4fa0fe6fda25 100644 --- a/usr.sbin/powerd/powerd.8 +++ b/usr.sbin/powerd/powerd.8 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd April 10, 2005 +.Dd November 6, 2005 .Dt POWERD 8 .Os .Sh NAME diff --git a/usr.sbin/sade/sade.8 b/usr.sbin/sade/sade.8 index ba65292ef8ed..aeb268e8e623 100644 --- a/usr.sbin/sade/sade.8 +++ b/usr.sbin/sade/sade.8 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd June 14, 2005 +.Dd July 17, 2005 .Dt SYSINSTALL 8 .Os .Sh NAME diff --git a/usr.sbin/sysinstall/sysinstall.8 b/usr.sbin/sysinstall/sysinstall.8 index ba65292ef8ed..aeb268e8e623 100644 --- a/usr.sbin/sysinstall/sysinstall.8 +++ b/usr.sbin/sysinstall/sysinstall.8 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd June 14, 2005 +.Dd July 17, 2005 .Dt SYSINSTALL 8 .Os .Sh NAME