From 5b7cf06c1d6a501a30cb062cdf3039b21f8540b7 Mon Sep 17 00:00:00 2001 From: ru Date: Mon, 18 Sep 2006 15:24:20 +0000 Subject: Markup fixes. --- share/man/man3/pthread_mutex_lock.3 | 2 +- share/man/man3/queue.3 | 2 +- share/man/man4/acpi.4 | 4 +- share/man/man4/adw.4 | 1 + share/man/man4/ataraid.4 | 2 +- share/man/man4/atkbd.4 | 2 +- share/man/man4/cpufreq.4 | 2 +- share/man/man4/da.4 | 2 +- share/man/man4/ddb.4 | 12 +-- share/man/man4/fast_ipsec.4 | 2 +- share/man/man4/hptmv.4 | 4 +- share/man/man4/if_bridge.4 | 5 +- share/man/man4/iic.4 | 12 +-- share/man/man4/ipsec.4 | 46 +++++++----- share/man/man4/isp.4 | 37 +++++----- share/man/man4/man4.i386/linux.4 | 2 +- share/man/man4/man4.sparc64/machfb.4 | 4 +- share/man/man4/mpt.4 | 12 ++- share/man/man4/ng_pppoe.4 | 6 +- share/man/man4/pty.4 | 47 +++++++----- share/man/man4/ral.4 | 2 +- share/man/man4/random.4 | 2 +- share/man/man4/smp.4 | 2 +- share/man/man4/uart.4 | 2 +- share/man/man4/umass.4 | 2 +- share/man/man5/devfs.5 | 14 ++-- share/man/man5/devfs.conf.5 | 2 +- share/man/man5/devfs.rules.5 | 2 +- share/man/man5/linprocfs.5 | 1 - share/man/man5/mailer.conf.5 | 29 ++++---- share/man/man5/make.conf.5 | 3 - share/man/man5/portsnap.conf.5 | 14 ++-- share/man/man5/rc.conf.5 | 78 ++++++++++++-------- share/man/man8/picobsd.8 | 5 +- share/man/man8/rc.8 | 2 +- share/man/man9/VFS_ROOT.9 | 3 +- share/man/man9/bus_dma.9 | 137 ++++++++++++++++++++--------------- share/man/man9/crypto.9 | 6 +- share/man/man9/ktr.9 | 2 +- share/man/man9/memguard.9 | 12 ++- share/man/man9/pfil.9 | 4 +- share/man/man9/sbuf.9 | 22 ++++-- share/man/man9/sleep.9 | 6 +- 43 files changed, 310 insertions(+), 248 deletions(-) (limited to 'share/man') diff --git a/share/man/man3/pthread_mutex_lock.3 b/share/man/man3/pthread_mutex_lock.3 index 10183e2..c20b1bc 100644 --- a/share/man/man3/pthread_mutex_lock.3 +++ b/share/man/man3/pthread_mutex_lock.3 @@ -27,7 +27,7 @@ .\" .\" $FreeBSD$ .\" -.Dd February 8, 2005 +.Dd January 31, 2006 .Dt PTHREAD_MUTEX_LOCK 3 .Os .Sh NAME diff --git a/share/man/man3/queue.3 b/share/man/man3/queue.3 index ce4e039..b92cf74 100644 --- a/share/man/man3/queue.3 +++ b/share/man/man3/queue.3 @@ -32,7 +32,7 @@ .\" @(#)queue.3 8.2 (Berkeley) 1/24/94 .\" $FreeBSD$ .\" -.Dd January 24, 1994 +.Dd March 24, 2006 .Dt QUEUE 3 .Os .Sh NAME diff --git a/share/man/man4/acpi.4 b/share/man/man4/acpi.4 index a668229..0b8db99 100644 --- a/share/man/man4/acpi.4 +++ b/share/man/man4/acpi.4 @@ -586,7 +586,7 @@ Many BIOS versions have serious bugs that may cause system instability, break suspend/resume, or prevent devices from operating properly due to IRQ routing problems. Upgrade your BIOS to the latest version available from the vendor before -deciding it's a problem with +deciding it is a problem with .Nm . .Pp The @@ -595,7 +595,7 @@ CPU idle power management drive conflicts with the local APIC (LAPIC) timer. Disable APIC mode with .Va hint.apic.0.disabled -or don't use the +or do not use the .Li C2 and .Li C3 diff --git a/share/man/man4/adw.4 b/share/man/man4/adw.4 index b290c3f..eae4a77 100644 --- a/share/man/man4/adw.4 +++ b/share/man/man4/adw.4 @@ -37,6 +37,7 @@ kernel configuration file: .Cd "device pci" .Cd "device scbus" .Cd "device adw" +.Ed .Sh DESCRIPTION This driver provides access to the 16bit .Tn SCSI diff --git a/share/man/man4/ataraid.4 b/share/man/man4/ataraid.4 index 8bd86f9..ee7446d 100644 --- a/share/man/man4/ataraid.4 +++ b/share/man/man4/ataraid.4 @@ -137,7 +137,7 @@ ATA RAID device nodes .Xr atacontrol 8 .Sh CAVEATS RAID5 is not supported at this time. -Code exists, but it neither uses nor maintains parity information. +Code exists, but it neither uses nor maintains parity information. .Sh AUTHORS .An -nosplit The diff --git a/share/man/man4/atkbd.4 b/share/man/man4/atkbd.4 index 0795d6c..590b7c1 100644 --- a/share/man/man4/atkbd.4 +++ b/share/man/man4/atkbd.4 @@ -51,7 +51,7 @@ driver, provides access to the AT 84 keyboard or the AT enhanced keyboard which is connected to the AT keyboard controller. .Pp This driver is required for the console driver -.Xr syscons 4 +.Xr syscons 4 . .Pp There can be only one .Nm diff --git a/share/man/man4/cpufreq.4 b/share/man/man4/cpufreq.4 index 5a466b8..50e83eb 100644 --- a/share/man/man4/cpufreq.4 +++ b/share/man/man4/cpufreq.4 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 03, 2006 +.Dd March 3, 2006 .Dt CPUFREQ 4 .Os .Sh NAME diff --git a/share/man/man4/da.4 b/share/man/man4/da.4 index aa6cc26..2ba8096 100644 --- a/share/man/man4/da.4 +++ b/share/man/man4/da.4 @@ -188,7 +188,7 @@ a replacement device, all accesses to the device will be discarded until the last file descriptor referencing the old device is closed. During this period, all new open attempts will be rejected. .Sh FILES -.Bl -tag -width /dev/da* -compact +.Bl -tag -width ".Pa /dev/da*" -compact .It Pa /dev/da* SCSI disk device nodes .El diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4 index 5754b89..8987d82 100644 --- a/share/man/man4/ddb.4 +++ b/share/man/man4/ddb.4 @@ -422,16 +422,13 @@ The support of the .Li u modifier depends on the machine. If not supported, incorrect information will be displayed. -.It Xo -.Cm show geom -.Op Ar addr -.Xc +.It Cm show geom Op Ar addr If the .Ar addr argument is not given, displays the entire GEOM topology. If the .Ar addr -is given, displays details about the given GEOM object (class, geom, provider +is given, displays details about the given GEOM object (class, geom, provider or consumer). .It Xo .Cm show map Ns Op Cm /f @@ -453,10 +450,7 @@ If the .Li f option is specified the complete object is printed. -.It Xo -.Cm show vnode -.Ar addr -.Xc +.It Cm show vnode Ar addr Displays details about the given vnode. .It Cm "show watches" Displays all watchpoints. diff --git a/share/man/man4/fast_ipsec.4 b/share/man/man4/fast_ipsec.4 index c743eab..0c693d3 100644 --- a/share/man/man4/fast_ipsec.4 +++ b/share/man/man4/fast_ipsec.4 @@ -90,7 +90,7 @@ The packets can be passed to a virtual interface, to perform packet filtering before outbound encryption and after decapsulation inbound. .Pp -To properly filter +To properly filter .Xr gif 4 tunnels with firewalls, add .Cd "options IPSEC_FILTERGIF" diff --git a/share/man/man4/hptmv.4 b/share/man/man4/hptmv.4 index 0ae152a..240a32f 100644 --- a/share/man/man4/hptmv.4 +++ b/share/man/man4/hptmv.4 @@ -68,8 +68,8 @@ driver only works on the i386 and amd64 platforms as it requires a binary blob object from the manufacturer which they only supply for these platforms. The .Nm -driver -.Em does not +driver does +.Em not work on i386 with .Xr pae 4 enabled. diff --git a/share/man/man4/if_bridge.4 b/share/man/man4/if_bridge.4 index f7c23f8..ca3afcb 100644 --- a/share/man/man4/if_bridge.4 +++ b/share/man/man4/if_bridge.4 @@ -101,9 +101,9 @@ variable using .Pp All the bridged member interfaces need to be up in order to pass network traffic. These can be enabled using -.Xr ifconfig 8 +.Xr ifconfig 8 or -.Va ifconfig_ Ns Ao Ar interface Ac Ns Va ="up" +.Va ifconfig_ Ns Ao Ar interface Ac Ns Li ="up" in .Xr rc.conf 5 . .Pp @@ -124,7 +124,6 @@ stream. This is useful for reconstructing the traffic for network taps that transmit the RX/TX signals out through two separate interfaces. .Sh PACKET FILTERING -.Pp Packet filtering can be used with any firewall package that hooks in via the .Xr pfil 9 framework. diff --git a/share/man/man4/iic.4 b/share/man/man4/iic.4 index 56f74bf..dc1ceb3 100644 --- a/share/man/man4/iic.4 +++ b/share/man/man4/iic.4 @@ -157,12 +157,6 @@ passed to last .Dv I2CSTART .Xr ioctl 2 to this device. -.Sh BUGS -Only the -.Dv I2CRDWR -.Xr ioctl 2 -is thread safe. -All other interfaces suffer from some kind of race. .Sh SEE ALSO .Xr ioctl 2 , .Xr read 2 , @@ -180,3 +174,9 @@ manual page was written by .An Nicolas Souchu and .An M. Warner Losh . +.Sh BUGS +Only the +.Dv I2CRDWR +.Xr ioctl 2 +is thread safe. +All other interfaces suffer from some kind of race. diff --git a/share/man/man4/ipsec.4 b/share/man/man4/ipsec.4 index 461b188..e2510c2 100644 --- a/share/man/man4/ipsec.4 +++ b/share/man/man4/ipsec.4 @@ -36,13 +36,14 @@ .Nm ipsec .Nd IP security protocol .Sh SYNOPSIS -.In sys/types.h -.In netinet/in.h -.In netinet6/ipsec.h .Cd "options IPSEC" .Cd "options IPSEC_DEBUG" .Cd "options IPSEC_ESP" .Cd "options IPSEC_FILTERGIF" +.Pp +.In sys/types.h +.In netinet/in.h +.In netinet6/ipsec.h .Sh DESCRIPTION .Nm is a security protocol implemented within the Internet Protocol layer @@ -53,7 +54,7 @@ is defined for both IPv4 and IPv6 and .Xr inet6 4 ) . .Nm -contains two protocols, +contains two protocols, ESP, the encapsulated security payload protocol and AH, the authentication header protocol. ESP prevents unauthorized parties from reading the payload of an IP packet @@ -70,9 +71,11 @@ and is designed for security gateways such as VPN endpoints. .Ss Kernel interface .Nm is controlled by a key management and policy engine, -that reside in the operating system kernel. Key management +that reside in the operating system kernel. +Key management is the process of associating keys with security associations, also -know as SAs. Policy management dictates when new security +know as SAs. +Policy management dictates when new security associations created or destroyed. .Pp The key management engine can be accessed from userland by using @@ -93,7 +96,8 @@ The kernel implements an extended version of the .Dv PF_KEY interface, and allows the programmer to define IPsec policies -which are similar to the per-packet filters. The +which are similar to the per-packet filters. +The .Xr setsockopt 2 interface is used to define per-socket behavior, and .Xr sysctl 3 @@ -107,14 +111,14 @@ should be implemented as daemon processes which call the .Nm APIs. .\" .Ss Policy management -IPsec policies can be managed in one of two ways, either by +IPsec policies can be managed in one of two ways, either by configuring per-socket policies using the -.Xr setsockopt 2 +.Xr setsockopt 2 system calls, or by configuring kernel level packet filter-based policies using the .Dv PF_KEY interface, via the -.Xr setkey 8 +.Xr setkey 8 command. In either case, IPsec policies must be specified using the syntax described in .Xr ipsec_set_policy 3 . @@ -129,18 +133,21 @@ command the option you can have the system use its default policy, explained below, for processing packets. The following sysctl variables are available for configuring the -system's IPsec behavior. The variables can have one of two values. +system's IPsec behavior. +The variables can have one of two values. A .Li 1 means .Dq Li use , which means that if there is a security association then use it but if -there is not then the packets are not processed by IPsec. The value +there is not then the packets are not processed by IPsec. +The value .Li 2 is synonymous with .Dq Li require , which requires that a security association must exist for the packets -to move, and not be dropped. These terms are defined in +to move, and not be dropped. +These terms are defined in .Xr ipsec_set_policy 8 . .Bl -column net.inet6.ipsec6.esp_trans_deflev integerxxx .It Sy "Name Type Changeable" @@ -155,7 +162,8 @@ to move, and not be dropped. These terms are defined in .El .Pp If the kernel does not find a matching, system wide, policy then the -default value is applied. The system wide default policy is specified +default value is applied. +The system wide default policy is specified by the following .Xr sysctl 8 variables. @@ -239,12 +247,13 @@ protocol acts as a plug-in to the and .Xr inet6 4 protocols and therefore supports most of the protocols defined upon -those IP-layer protocols. The +those IP-layer protocols. +The .Xr icmp 4 and -.Xr icmp6 4 +.Xr icmp6 4 protocols may behave differently with -.Nm +.Nm because .Nm can prevent @@ -325,5 +334,6 @@ and .Dv SADB_SPDDUMP operations on .Dv PF_KEY -sockets may fail due to lack of space. Increasing the socket buffer +sockets may fail due to lack of space. +Increasing the socket buffer size may alleviate this problem. diff --git a/share/man/man4/isp.4 b/share/man/man4/isp.4 index 7a3d2b4..609309e 100644 --- a/share/man/man4/isp.4 +++ b/share/man/man4/isp.4 @@ -141,40 +141,37 @@ The following options are switchable by setting values in .Pa /boot/device.hints . .Pp They are: -.Pp .Bl -tag -width indent .It Va hint.isp.0.disable A hint value to disable driver in kernel. .It Va hint.isp.0.fwload_disable A hint value to disable loading of firmware -.Cd ispfw(4) . +.Xr ispfw 4 . .It Va hint.isp.0.prefer_memmap -A hint value to use PCI Memory space instead of I/O space +A hint value to use PCI memory space instead of I/O space access for. .It Va hint.isp.0.prefer_iomap A hint value to use PCI I/O space instead of Memory space access for. .It Va hint.isp.0.ignore_nvram -A hint value to ignore board NVRAM settings for. Otherwise -use NVRAM settings. +A hint value to ignore board NVRAM settings for. +Otherwise use NVRAM settings. .It Va hint.isp.0.fullduplex A hint value to set full duplex mode. .It Va hint.isp.0.topology -A hint value to select topology of connection. Supported -values are: -.Pp -.Cd lport -(Prefer loopback and fallback to point to point). -.Pp -.Cd nport -(Prefer point to point and fallback to loopback). -.Pp -.Cd lport-only -(Loopback only). -.Pp -.Cd nport-only -(Point to point only). -.Pp +A hint value to select topology of connection. +Supported values are: +.Pp +.Bl -tag -width ".Li lport-only" -compact +.It Li lport +Prefer loopback and fallback to point to point. +.It Li nport +Prefer point to point and fallback to loopback. +.It Li lport-only +Loopback only. +.It Li nport-only +Point to point only. +.El .It Va hint.isp.0.portwwn This should be the full 64 bit World Wide Port Name you would like to use, overriding the value in NVRAM for the card. diff --git a/share/man/man4/man4.i386/linux.4 b/share/man/man4/man4.i386/linux.4 index 81ddbdc..de05a4d 100644 --- a/share/man/man4/man4.i386/linux.4 +++ b/share/man/man4/man4.i386/linux.4 @@ -67,7 +67,7 @@ Linux kernel operating system name. .It compat.linux.osrelease Linux kernel operating system release. Changing this to something else is discouraged on non-development systems, -because it may change the way linux programs work. +because it may change the way Linux programs work. Recent versions of GNU libc are known to use different syscalls depending on the value of this sysctl. .It compat.linux.oss_version diff --git a/share/man/man4/man4.sparc64/machfb.4 b/share/man/man4/man4.sparc64/machfb.4 index 88d4c77..7d0af11 100644 --- a/share/man/man4/man4.sparc64/machfb.4 +++ b/share/man/man4/man4.sparc64/machfb.4 @@ -149,10 +149,10 @@ driver at this time: .Tn ATI 3D Charger PCI .It .Tn Sun PGX 8-Bit Color Frame Buffer -(part no. 370-2256) +(part no.\& 370-2256) .It .Tn Sun PGX64 8/24-Bit Color Frame Buffer -(part no. 370-4362) +(part no.\& 370-4362) .El .Sh CAVEATS Font loading and mode switching are not implemented. diff --git a/share/man/man4/mpt.4 b/share/man/man4/mpt.4 index 8f300f5..cfe6320 100644 --- a/share/man/man4/mpt.4 +++ b/share/man/man4/mpt.4 @@ -80,8 +80,7 @@ LSI Logic LSI2x320-X .It LSI Logic AS1064, LSI Logic AS1068 -( -.Tn SAS/SATA ) +.Pq Tn SAS/SATA .It LSI Logic FC909 (1Gb/s @@ -146,11 +145,6 @@ can take on - no separate compilation is required. .%T "LSI Logic Website" .%O http://www.lsilogic.com/ .Re -.Sh BUGS -.Pp -This driver has been reported to have problems under the VMware ESX server. -.Pp -This driver does not yet work on big endian machines like Sparc64. .Sh HISTORY The .Nm @@ -169,3 +163,7 @@ by .An Matt Jacob Aq mjacob@FreeBSD.org and .An Justin Gibbs Aq gibbs@FreeBSD.org . +.Sh BUGS +This driver has been reported to have problems under the VMware ESX server. +.Pp +This driver does not yet work on big endian machines like Sparc64. diff --git a/share/man/man4/ng_pppoe.4 b/share/man/man4/ng_pppoe.4 index debea88..d654578 100644 --- a/share/man/man4/ng_pppoe.4 +++ b/share/man/man4/ng_pppoe.4 @@ -194,7 +194,7 @@ as a string. .Tn ASCII form of this message is .Qq Li pppoe_getmode . -The following keywords are can be returned: +The following keywords can be returned: .Bl -tag -width 3n .It Qq standard The node operates according to RFC 2516. @@ -218,11 +218,10 @@ This option is necessary for compatibility with D-Link DI-614+ and DI-624+ SOHO routers as clients, when serving only specific Service-Name. This compatibility option does not affect client mode. .El -.Pp .It Dv NGM_PPPOE_SETMODE Configure node to the specified mode. The string argument is required. -This command understands same keywords, that are returned by +This command understands the same keywords that are returned by the .Dv NGM_PPPOE_GETMODE command. .Tn ASCII @@ -230,7 +229,6 @@ form of this message is .Qq Li pppoe_setmode . For example, the following command will configure the node to initiate the next session in the proprietary 3Com mode: -.Pp .Bd -literal -offset indent ngctl msg fxp0:orphans pppoe_setmode '"3Com"' .Ed diff --git a/share/man/man4/pty.4 b/share/man/man4/pty.4 index ffc7183..0880d0c 100644 --- a/share/man/man4/pty.4 +++ b/share/man/man4/pty.4 @@ -177,39 +177,52 @@ mode, command operations may be detected with a .Xr select 2 for exceptional conditions. .El - -There is currently two pty systems available : the original BSD pty, and a +.Pp +There is currently two +.Nm +systems available: the original +.Bx Nm , +and a SysVR4 pts-like implementation. -You can switch between the two implementations by setting the +It is possible to switch between the two implementations by setting the .Va kern.pts.enable -sysctl. Setting it to 0 will use the BSD pty, to non-zero the pts -implementation. It defaults to 0. -You can set the maximum number of ptys which can be allocated at the same time -with the +sysctl. +Setting it to 0 will use the +.Bx Nm , +to non-zero the pts implementation. +It defaults to 0. +It is possible to set the maximum number of ptys +which can be allocated at the same time with the .Va kern.pts.max -sysctl. It defaults to 1000. +sysctl. +It defaults to 1000. It is not recommanded to use more than 1000 pseudo-terminals, as all software which use .Xr utmp 5 will not be able to handle pseudo-terminals with number superior to 999. - -The pts implementation also supports the +.Pp +The pts implementation also supports the .Dv TIOCGPTN .Xr ioctl 2 -call, which takes a pointer to an unsigned int as a parameter and provides the +call, which takes a pointer to an +.Vt "unsigned int" +as a parameter and provides the number of the pty. - .Sh FILES -.Bl -tag -width /dev/tty[p-sP-S][0-9a-v]x -compact -The files used by the BSD pseudo terminals implementation are : +The files used by the +.Bx +pseudo terminals implementation are: +.Pp +.Bl -tag -width ".Pa /dev/tty[p-sP-S][0-9a-v]" -compact .It Pa /dev/pty[p-sP-S][0-9a-v] master pseudo terminals .It Pa /dev/tty[p-sP-S][0-9a-v] slave pseudo terminals - .El -The files used by the pts implementation are : -.Bl -tag -width /dev/pts/[num]x -compact +.Pp +The files used by the pts implementation are: +.Pp +.Bl -tag -width ".Pa /dev/pts/[num]" -compact .It Pa /dev/ptmx control device, returns a file descriptor to a new master pseudo terminal when opened. diff --git a/share/man/man4/ral.4 b/share/man/man4/ral.4 index 78825a2..c60b6db 100644 --- a/share/man/man4/ral.4 +++ b/share/man/man4/ral.4 @@ -15,7 +15,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 05, 2006 +.Dd March 5, 2006 .Os .Dt RAL 4 .Sh NAME diff --git a/share/man/man4/random.4 b/share/man/man4/random.4 index c9344d8..cccd89c 100644 --- a/share/man/man4/random.4 +++ b/share/man/man4/random.4 @@ -128,7 +128,7 @@ A 0 (zero) value means hardware interrupts are not considered as an entropy source. Set the variable to 1 (one) if you wish to use them for entropy harvesting. -All hardware interrupt harvesting is setup by the +All hardware interrupt harvesting is set up by the individual device drivers. .Pp The diff --git a/share/man/man4/smp.4 b/share/man/man4/smp.4 index e0b20f2..c20745e 100644 --- a/share/man/man4/smp.4 +++ b/share/man/man4/smp.4 @@ -104,6 +104,6 @@ in .Bsx . .Pp .Fx 5.0 -also introduced support for SMP on the ia64, and sparc64 architectures. +also introduced support for SMP on the ia64 and sparc64 architectures. .Sh AUTHORS .An Steve Passe Aq fsmp@FreeBSD.org diff --git a/share/man/man4/uart.4 b/share/man/man4/uart.4 index 0099baf..ae2d456 100644 --- a/share/man/man4/uart.4 +++ b/share/man/man4/uart.4 @@ -129,7 +129,7 @@ device driver. .El .\" .Sh FILES -.Bl -tag -width /dev/ttyu?.init -compact +.Bl -tag -width ".Pa /dev/ttyu?.init" -compact .It Pa /dev/ttyu? for callin ports .It Pa /dev/ttyu?.init diff --git a/share/man/man4/umass.4 b/share/man/man4/umass.4 index da6e3cb..682bf8d 100644 --- a/share/man/man4/umass.4 +++ b/share/man/man4/umass.4 @@ -135,7 +135,7 @@ Panasonic USB2.0 Portable CD-RW Drive KXL-RW40AN (CDROM only) .It Panasonic floppy drive .It -Qware BeatZkey! Pro +Qware BeatZkey!\& Pro .It RATOC Systems USB2.0 Removable HDD Case U2-MDK1, U2-MDK1B .It diff --git a/share/man/man5/devfs.5 b/share/man/man5/devfs.5 index b8be967..d932425 100644 --- a/share/man/man5/devfs.5 +++ b/share/man/man5/devfs.5 @@ -69,13 +69,6 @@ The .Xr mknod 8 tool can be used to recover deleted device entries under .Nm . -.Sh EXAMPLES -To mount a -.Nm -volume located on -.Pa /dev : -.Pp -.Dl "mount -t devfs devfs /dev" .Sh FILES .Bl -tag -width /dev/XXXX -compact .It Pa /dev @@ -83,6 +76,13 @@ The normal .Nm mount point. .El +.Sh EXAMPLES +To mount a +.Nm +volume located on +.Pa /dev : +.Pp +.Dl "mount -t devfs devfs /dev" .Sh SEE ALSO .Xr devfs 8 , .Xr mount 8 diff --git a/share/man/man5/devfs.conf.5 b/share/man/man5/devfs.conf.5 index 83d1a66..9d83726 100644 --- a/share/man/man5/devfs.conf.5 +++ b/share/man/man5/devfs.conf.5 @@ -131,9 +131,9 @@ perm cd0 0660 .Ed .Sh SEE ALSO .Xr chmod 1 , +.Xr devd.conf 5 , .Xr devfs 5 , .Xr devfs.rules 5 , -.Xr devd.conf 5 , .Xr chown 8 .Sh AUTHORS This manual page was written by diff --git a/share/man/man5/devfs.rules.5 b/share/man/man5/devfs.rules.5 index 04fb6b4..3722cea 100644 --- a/share/man/man5/devfs.rules.5 +++ b/share/man/man5/devfs.rules.5 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd Jan 30, 2006 +.Dd January 30, 2006 .Dt DEVFS.RULES 5 .Os .Sh NAME diff --git a/share/man/man5/linprocfs.5 b/share/man/man5/linprocfs.5 index 0eecc17..a85afe9 100644 --- a/share/man/man5/linprocfs.5 +++ b/share/man/man5/linprocfs.5 @@ -12,7 +12,6 @@ .Bd -literal linproc /compat/linux/proc linprocfs rw 0 0 .Ed -.Pp .Sh DESCRIPTION The Linux process file system, or .Nm , diff --git a/share/man/man5/mailer.conf.5 b/share/man/man5/mailer.conf.5 index 213db6d..f17c44b 100644 --- a/share/man/man5/mailer.conf.5 +++ b/share/man/man5/mailer.conf.5 @@ -43,12 +43,12 @@ The file .Pa /etc/mail/mailer.conf contains a series of lines of the form .Pp -.Pa name -.Pa program +.Ar name +.Ar program .Op Ar arguments ... .Pp The first word of each line is the -.Pa name +.Ar name of a program invoking .Xr mailwrapper 8 . (For example, on a typical system @@ -60,29 +60,28 @@ as would and .Xr mailq 1 . Thus, -.Pa name +.Ar name might be -.Dq sendmail +.Dq Li sendmail or -.Dq newaliases +.Dq Li newaliases etc.) .Pp The second word of each line is the name of the -.Pa program +.Ar program to actually execute when the first name is invoked. .Pp The further .Ar arguments , if any, are passed to the -.Pa program , +.Ar program , followed by the arguments .Xr mailwrapper 8 was called with. .Pp The file may also contain comment lines, denoted by a -.Sq # +.Ql # mark in the first column of any line. -first column of any line. .Sh FILES /etc/mail/mailer.conf .Sh EXAMPLES @@ -111,9 +110,10 @@ mailq /usr/local/sbin/sendmail newaliases /usr/local/sbin/sendmail .Ed .Pp -This example shows the use of the mini_sendmail package from ports -in place of -.Xr sendmail 8 : +This example shows the use of the +.Nm mini_sendmail +package from ports in place of +.Xr sendmail 8 . Note the use of additional arguments. .Bd -literal -offset indent # Send outgoing mail to a smart relay using mini_sendmail @@ -127,8 +127,7 @@ send-mail /usr/local/bin/mini_sendmail -srelayhost .Xr mailwrapper 8 , .Xr sendmail 8 .Pp -.Xr postfix 1 -.Pq Pa ports/mail/postfix , +.Xr postfix 1 Pq Pa ports/mail/postfix , .Xr mini_sendmail 8 Pq Pa ports/mail/mini_sendmail .Sh HISTORY .Nm diff --git a/share/man/man5/make.conf.5 b/share/man/man5/make.conf.5 index 5d3d300..0129555 100644 --- a/share/man/man5/make.conf.5 +++ b/share/man/man5/make.conf.5 @@ -320,7 +320,6 @@ to update your ports with .Dq Li "make update" . .El .Ss "BUILDING THE KERNEL" -.Pp The following list provides a name and short description for variables that are only used doing a kernel build: .Bl -tag -width Ar @@ -392,7 +391,6 @@ This is applied .Va MODULES_OVERRIDE . .El .Ss "BUILDING THE WORLD" -.Pp The following list provides a name and short description for variables that are used during the world build: .Bl -tag -width Ar @@ -628,7 +626,6 @@ times. The value assigned is the highest optimization value used. .El .Ss "BUILDING DOCUMENTATION" -.Pp The following list provides a name and short description for variables that are used when building documentation. .Bl -tag -width ".Va PRINTERDEVICE" diff --git a/share/man/man5/portsnap.conf.5 b/share/man/man5/portsnap.conf.5 index ba632166..9204e83 100644 --- a/share/man/man5/portsnap.conf.5 +++ b/share/man/man5/portsnap.conf.5 @@ -30,7 +30,7 @@ .Os FreeBSD .Sh NAME .Nm portsnap.conf -.Nd configuration file for +.Nd configuration file for .Xr portsnap 8 .Sh DESCRIPTION The @@ -46,7 +46,7 @@ A line of the form specifies the source from which snapshots should be fetched. This is equivalent to the .Fl s Ar server -option to +option to .Xr portsnap 8 , and will be ignored if the command-line option is used. .Pp @@ -57,7 +57,7 @@ specifies the SHA-256 hash of the OpenSSL public key file belonging to an RSA keypair which is trusted to sign updates. This is equivalent to the .Fl k Ar KEY -option to +option to .Xr portsnap 8 , and will be ignored if the command-line option is used. .Pp @@ -94,7 +94,7 @@ Finally, a line of the form will instruct .Xr portsnap 8 to ignore parts of the ports tree with paths starting with -.Ar foo +.Ar foo or .Ar bar , which are interpreted as extended regular expressions by @@ -128,9 +128,9 @@ Any lines not of the above forms will be ignored. Default location of the portsnap configuration file. .El .Sh SEE ALSO -.Xr egrep 1 -.Xr fetch 1 -.Xr portsnap 8 +.Xr egrep 1 , +.Xr fetch 1 , +.Xr portsnap 8 , .Xr sha256 8 .Sh AUTHORS .An Colin Percival Aq cperciva@FreeBSD.org diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5 index 25b4a28..7e38ff5 100644 --- a/share/man/man5/rc.conf.5 +++ b/share/man/man5/rc.conf.5 @@ -69,7 +69,7 @@ See the variable below. .Pp Options are set with -.Dq Li name=value +.Dq Ar name Ns Li = Ns Ar value assignments that use .Xr sh 1 syntax. @@ -110,8 +110,10 @@ listed in the .Va local_startup variable (see below). Thus, the two likely candidates for this value are -mountcritlocal for the typical system, -and mountcritremote if the system needs remote file +.Pa mountcritlocal +for the typical system, and +.Pa mountcritremote +if the system needs remote file systems mounted to get access to the .Va local_startup directories; for example when @@ -121,7 +123,8 @@ For .Pa rc.conf within a .Xr jail 8 -NETWORKING is likely to be an appropriate value. +.Pa NETWORKING +is likely to be an appropriate value. Extreme care should be taken when changing this value, and before changing it one should ensure that there are adequate provisions to recover from a failed boot @@ -356,9 +359,9 @@ For the DHCP client, see the .Xr dhclient 8 manpage for a description of the command line options available. -.It Va dhclient_flags_ Ns Va iface +.It Va dhclient_flags_ Ns Aq Ar iface Additional flags to pass to the DHCP client program running on -.Va iface +.Ar iface only. When specified, this variable overrides .Va dhclient_flags . @@ -370,11 +373,11 @@ to start the DHCP client in background. This can cause trouble with applications depending on a working network, but it will provide a faster startup in many cases. -.It Va background_dhclient_ Ns Va iface +.It Va background_dhclient_ Ns Aq Ar iface When specified, this variable overrides the .Va background_dhclient variable for interface -.Va iface +.Ar iface only. .It Va synchronous_dhclient .Pq Bt bool @@ -1453,7 +1456,9 @@ This must match the location in .Xr named.conf 5 . .It Va named_uid .Pq Vt str -The user that the named process should be run as. +The user that the +.Xr named 8 +process should be run as. .It Va named_chrootdir .Pq Vt str The root directory for a name server run in a @@ -1721,7 +1726,7 @@ If set to run the .Xr pppoed 8 daemon at boot time to provide PPP over Ethernet services. -.It Va pppoed_ Ns Ar provider +.It Va pppoed_ Ns Aq Ar provider .Pq Vt str .Xr pppoed 8 listens to requests to this @@ -1783,11 +1788,11 @@ An option to set this up initially .Xr sysinstall 8 program when the system is first installed. .It Va ntpdate_config +.Pq Vt str Configuration file for .Xr ntpdate 8 . -.Pq Vt str -(default -.Pa /etc/ntp.conf ). +Default +.Pa /etc/ntp.conf . .It Va ntpdate_hosts .Pq Vt str A whitespace-separated list of NTP servers to synchronize with at startup. @@ -1827,8 +1832,8 @@ Path to Path to .Xr ntpd 8 configuration file. -(default -.Pa /etc/ntp.conf ) . +Default +.Pa /etc/ntp.conf . .It Va ntpd_flags .Pq Vt str If @@ -2877,8 +2882,7 @@ Set to the list of local 32-bit compatibility directories. The names of all files in the directories listed will be passed as arguments to -.Xr ldconfig 8 -.Fl 32 . +.Dq Nm ldconfig Fl 32 . .It Va kern_securelevel_enable .Pq Vt bool Set to @@ -3047,7 +3051,9 @@ When set to .Dq Li YES , sets .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable -to YES by default for every jail in +to +.Dq Li YES +by default for every jail in .Va jail_list . .It Va jail_devfs_ruleset .Pq Vt str @@ -3065,7 +3071,9 @@ When set to .Dq Li YES , sets .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable -to YES by default for every jail in +to +.Dq Li YES +by default for every jail in .Va jail_list . .It Va jail_fdescfs_enable .Pq Vt bool @@ -3076,7 +3084,9 @@ When set to .Dq Li YES , sets .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable -to YES by default for every jail in +to +.Dq Li YES +by default for every jail in .Va jail_list . .It Va jail_procfs_enable .Pq Vt bool @@ -3087,14 +3097,16 @@ When set to .Dq Li YES , sets .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable -to YES by default for every jail in +to +.Dq Li YES +by default for every jail in .Va jail_list . .It Va jail_exec_start .Pq Vt str Unset by default. When set, use as default value for .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start -for every jail in +for every jail in .Va jail_list . .It Va jail_exec_afterstart Ns Aq Ar N .Pq Vt str @@ -3139,7 +3151,7 @@ Note that the alias is created at jail startup and removed at jail shutdown. .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab .Pq Vt str Set to -.Pa /etc/fstab. Ns Ao Ar jname Ac +.Pa /etc/fstab. Ns Aq Ar jname by default. This is the file system information file to use for jail .Va jname . @@ -3198,9 +3210,9 @@ This is the command executed at jail startup. .Pq Vt str Unset by default. This is the command run as -.Ar N Ns +.Ar N Ns th command -after jail startup, where +after jail startup, where .Ar N is 1, 2, and so on. .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop @@ -3436,7 +3448,7 @@ The default is which causes log files flagged with a .Cm C to be created. -.It Va mdconfig_md Ns Ao Ar X Ac +.It Va mdconfig_md Ns Aq Ar X .Pq Vt str Arguments to .Xr mdconfig 8 @@ -3456,7 +3468,7 @@ for vnode backed .Xr md 4 devices. Note that -.Va mdconfig_md Ns Ao Ar X Ac +.Va mdconfig_md Ns Aq Ar X variables are evaluated until one variable is unset or null. .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs .Pq Vt str @@ -3505,11 +3517,11 @@ device .Ar X has been mounted. Note that the command is passed to -.Li eval +.Ic eval and that both -.Li _dev +.Va _dev and -.Li _mp +.Va _mp variables can be used to reference respectively the .Xr md 4 device and the mount point. @@ -3519,7 +3531,7 @@ device is .Li md0 , one could set the following: .Bd -literal -mdconfig_md0_cmd="tar xfzC /var/file.tgz \\${_mp}" +mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}" .Ed .It Va ramdisk_units .Pq Vt str @@ -3537,7 +3549,9 @@ in a .Va ramdisk_ Ns Ao Ar X Ac Ns Va _config variable. Note that this way to configure ramdisks has been deprecated -in favor of new mdconfig variables (see above). +in favor of new +.Va mdconfig_md* +variables (see above). .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _config .Pq Vt str Arguments to diff --git a/share/man/man8/picobsd.8 b/share/man/man8/picobsd.8 index b99462b..9f36eca 100644 --- a/share/man/man8/picobsd.8 +++ b/share/man/man8/picobsd.8 @@ -169,11 +169,12 @@ or root privileges to mount a filesystem. When run in interactive mode (the default without the .Fl n option), the script will let you configure the various parameters -used to build the PicoBSD image. An image is configured +used to build the PicoBSD image. +An image is configured using the files and directories described below. The base system contains a template, called .Pa bridge -for historical reasons, +for historical reasons, that can be used as a base for building various kinds of network appliances. .Pp diff --git a/share/man/man8/rc.8 b/share/man/man8/rc.8 index a5b19e6..4f1f1ce 100644 --- a/share/man/man8/rc.8 +++ b/share/man/man8/rc.8 @@ -123,7 +123,7 @@ Load the configuration files. .It Determine if booting in a jail, and add -.Dq nojail +.Dq Li nojail to the list of KEYWORDS to skip in .Xr rcorder 8 . .It diff --git a/share/man/man9/VFS_ROOT.9 b/share/man/man9/VFS_ROOT.9 index 7af1fe6..1aa0194 100644 --- a/share/man/man9/VFS_ROOT.9 +++ b/share/man/man9/VFS_ROOT.9 @@ -48,7 +48,8 @@ Its arguments are: .It Fa mp The file system. .It Fa flags -The lock type. Could be +The lock type. +Could be .Dv LK_EXCLUSIVE or .Dv LK_SHARED . diff --git a/share/man/man9/bus_dma.9 b/share/man/man9/bus_dma.9 index 0f738ac..9911b8b 100644 --- a/share/man/man9/bus_dma.9 +++ b/share/man/man9/bus_dma.9 @@ -133,7 +133,7 @@ abstracting machine dependent issues like setting up DMA mappings, handling cache issues, bus specific features and limitations. .Sh STRUCTURES AND TYPES -.Bl -tag -width compact +.Bl -tag -width indent .It Vt bus_dma_tag_t A machine-dependent (MD) opaque type that describes the characteristics of DMA transactions. @@ -143,11 +143,11 @@ This allows all devices along the path of DMA transactions to contribute to the constraints of those transactions. .It Vt bus_dma_filter_t Client specified address filter having the format: -.Bl -tag -width compact +.Bl -tag -width indent .It Ft int .Fn "client_filter" "void *filtarg" "bus_addr_t testaddr" .El -.sp +.Pp Address filters can be specified during tag creation to allow for devices whose DMA address restrictions cannot be specified by a single window. @@ -172,7 +172,7 @@ DMA segments. bus_addr_t ds_addr; bus_size_t ds_len; .Ed -.sp +.Pp The .Fa ds_addr field contains the device visible address of the DMA segment, and @@ -187,9 +187,12 @@ A machine-dependent opaque type describing an individual mapping. One map is used for each memory allocation that will be loaded. Maps can be reused once they have been unloaded. Multiple maps can be associated with one DMA tag. -While the value of the map may evaluate to NULL on some platforms under -certain conditions, it should never be assumed that it will be NULL in all -cases. +While the value of the map may evaluate to +.Dv NULL +on some platforms under certain conditions, +it should never be assumed that it will be +.Dv NULL +in all cases. .It Vt bus_dmamap_callback_t Client specified callback for receiving mapping information resulting from the load of a @@ -197,12 +200,12 @@ the load of a via .Fn bus_dmamap_load . Callbacks are of the format: -.Bl -tag -width compact +.Bl -tag -width indent .It Ft void .Fn "client_callback" "void *callback_arg" "bus_dma_segment_t *segs" \ "int nseg" "int error" .El -.sp +.Pp The .Fa callback_arg is the callback argument passed to dmamap load functions. @@ -227,14 +230,14 @@ via .Fn bus_dmamap_load_uio or .Fn bus_dmamap_load_mbuf . -.sp +.Pp Callback2s are of the format: -.Bl -tag -width compact +.Bl -tag -width indent .It Ft void .Fn "client_callback2" "void *callback_arg" "bus_dma_segment_t *segs" \ "int nseg" "bus_size_t mapsize" "int error" .El -.sp +.Pp Callback2's behavior is the same as .Vt bus_dmamap_callback_t with the addition that the length of the data mapped is provided via @@ -287,11 +290,11 @@ If the load operation does not need to be deferred, then it will not be called since the function loading the map should be holding the appropriate locks. This method is of the format: -.Bl -tag -width compact +.Bl -tag -width indent .It Ft void .Fn "lockfunc" "void *lockfunc_arg" "bus_dma_lock_op_t op" .El -.sp +.Pp Two .Vt lockfunc implementations are provided for convenience. @@ -304,27 +307,28 @@ passed into will generate a system panic if it is called. It is substituted into the tag when .Fa lockfunc -is passed as NULL to +is passed as +.Dv NULL +to .Fn bus_dma_tag_create . .It Vt bus_dma_lock_op_t Operations to be performed by the client-specified .Fn lockfunc . -.Bl -tag -width BUS_DMA_UNLOCK +.Bl -tag -width ".Dv BUS_DMA_UNLOCK" .It Dv BUS_DMA_LOCK Acquires and/or locks the client locking primitive. .It Dv BUS_DMA_UNLOCK Releases and/or unlocks the client locking primitive. .El .El -.sp .Sh FUNCTIONS -.Bl -tag -width compact +.Bl -tag -width indent .It Fn bus_dma_tag_create "parent" "alignment" "boundary" "lowaddr" \ "highaddr" "*filtfunc" "*filtfuncarg" "maxsize" "nsegments" "maxsegsz" \ "flags" "lockfunc" "lockfuncarg" "*dmat" Allocates a device specific DMA tag, and initializes it according to the arguments provided: -.Bl -tag -width *filtfuncarg -compact +.Bl -tag -width ".Fa filtfuncarg" .It Fa parent Indicates restrictions between the parent bridge, CPU memory, and the device. @@ -348,8 +352,7 @@ The boundary must be a power of 2 and must be no smaller than the maximum segment size. .Ql 0 indicates that there are no boundary restrictions. -.It Fa lowaddr -.It Fa highaddr +.It Fa lowaddr , highaddr Bounds of the window of bus address space that .Em cannot be directly accessed by the device. @@ -373,7 +376,9 @@ This area of is used to bounce requests that would otherwise conflict with the exclusion window. .It Fa filtfunc -Optional filter function (may be NULL) to be called for any attempt to +Optional filter function (may be +.Dv NULL ) +to be called for any attempt to map memory into the window described by .Fa lowaddr and @@ -388,7 +393,8 @@ The filter function will be called for every machine page that overlaps the exclusion window. .It Fa filtfuncarg Argument passed to all calls to the filter function for this tag. -May be NULL. +May be +.Dv NULL . .It Fa maxsize Maximum size, in bytes, of the sum of all segment lengths in a given DMA mapping associated with this tag. @@ -404,7 +410,7 @@ with .Fa dmat . .It Fa flags Are as follows: -.Bl -tag -width "BUS_DMA_ALLOCNOW" -compact +.Bl -tag -width ".Dv BUS_DMA_ALLOCNOW" .It Dv BUS_DMA_ALLOCNOW Pre-allocate enough resources to handle at least one map load operation on this tag. @@ -419,9 +425,13 @@ that resources will be allocated or reserved exclusively for this tag. It should be treated only as a minor optimization. .El .It Fa lockfunc -Optional lock manipulation function (may be NULL) to be called when busdma +Optional lock manipulation function (may be +.Dv NULL ) +to be called when busdma needs to manipulate a lock on behalf of the client. -If NULL is specified, +If +.Dv NULL +is specified, .Fn dflt_lock is used. .It Fa lockfuncarg @@ -452,7 +462,7 @@ on success. .It Fn bus_dmamap_create "dmat" "flags" "*mapp" Allocates and initializes a DMA map. Arguments are as follows: -.Bl -tag -width nsegments -compact +.Bl -tag -width ".Fa nsegments" .It Fa dmat DMA tag. .It Fa flags @@ -472,7 +482,7 @@ map or allocating mapping resources. .It Fn bus_dmamap_destroy "dmat" "map" Frees all resources associated with a given DMA map. Arguments are as follows: -.Bl -tag -width dmat -compact +.Bl -tag -width ".Fa dmat" .It Fa dmat DMA tag used to allocate .Fa map . @@ -494,7 +504,7 @@ associated with the DMA map .Fa map . This call will always return immediately and will not block for any reason. Arguments are as follows: -.Bl -tag -width buflen -compact +.Bl -tag -width ".Fa buflen" .It Fa dmat DMA tag used to allocate .Fa map . @@ -516,15 +526,15 @@ load returns, and code should be structured appropriately to handle this. See below for specific flags and error codes that control this behavior. .It Fa flags Are as follows: -.Bl -tag -width BUS_DMA_NOWAIT -compact -.It Er BUS_DMA_NOWAIT +.Bl -tag -width ".Dv BUS_DMA_NOWAIT" +.It Dv BUS_DMA_NOWAIT The load should not be deferred in case of insufficient mapping resources, and instead should return immediately with an appropriate error. .El .El .Pp Return values to the caller are as follows: -.Bl -tag -width EINPROGRESS -compact +.Bl -tag -width ".Er EINPROGRESS" .It 0 The callback has been called and completed. The status of the mapping has been delivered to the callback. @@ -537,7 +547,7 @@ be deferred until all callbacks have been processed. .It Er ENOMEM The load request has failed due to insufficient resources, and the caller specifically used the -.Fa BUS_DMA_NOWAIT +.Dv BUS_DMA_NOWAIT flag. .It Er EINVAL The load request was invalid. @@ -559,7 +569,7 @@ argument used to create the dma tag When the callback is called, it is presented with an error value indicating the disposition of the mapping. Error may be one of the following: -.Bl -tag -width EINPROGRESS -compact +.Bl -tag -width ".Er EINPROGRESS" .It 0 The mapping was successful and the .Fa dm_segs @@ -582,7 +592,7 @@ A argument is also passed to the callback routine, which contains the mbuf chain's packet header length. The -.Fa BUS_DMA_NOWAIT +.Dv BUS_DMA_NOWAIT flag is implied, thus no callback deferral will happen. .Pp Mbuf chains are assumed to be in kernel virtual address space. @@ -618,7 +628,7 @@ argument is also passed to the callback routine, which contains the size of i.e. .Fa uio->uio_resid . The -.Fa BUS_DMA_NOWAIT +.Dv BUS_DMA_NOWAIT flag is implied, thus no callback deferral will happen. Returns the same errors as .Fn bus_dmamap_load . @@ -639,7 +649,7 @@ Pages may be locked using .It Fn bus_dmamap_unload "dmat" "map" Unloads a DMA map. Arguments are as follows: -.Bl -tag -width dmam -compact +.Bl -tag -width ".Fa dmam" .It Fa dmat DMA tag used to allocate .Fa map . @@ -656,7 +666,7 @@ prior to unloading the map. Performs synchronization of a device visible mapping with the CPU visible memory referenced by that mapping. Arguments are as follows: -.Bl -tag -width dmat -compact +.Bl -tag -width ".Fa dmat" .It Fa dmat DMA tag used to allocate .Fa map . @@ -706,7 +716,7 @@ that is permanently loaded into the newly created returned via .Fa mapp . Arguments are as follows: -.Bl -tag -width alignment -compact +.Bl -tag -width ".Fa alignment" .It Fa dmat DMA tag describing the constraints of the DMA mapping. .It Fa vaddr @@ -714,7 +724,7 @@ Pointer to a pointer that will hold the returned KVA mapping of the allocated region. .It Fa flags Flags are defined as follows: -.Bl -tag -width BUS_DMA_NOWAIT -compact +.Bl -tag -width ".Dv BUS_DMA_NOWAIT" .It Dv BUS_DMA_WAITOK The routine can safely wait (sleep) for resources. .It Dv BUS_DMA_NOWAIT @@ -730,7 +740,9 @@ a CPU and a DMA engine, frequently. Use of this flag does not remove the requirement of using bus_dmamap_sync, but it may reduce the cost of performing these operations. -The BUS_DMA_COHERENT flag is currently implemented on sparc64 and arm. +The +.Dv BUS_DMA_COHERENT +flag is currently implemented on sparc64 and arm. .It Dv BUS_DMA_ZERO Causes the allocated memory to be set to all zeros. .El @@ -773,7 +785,7 @@ Frees memory previously allocated by Any mappings will be invalidated. Arguments are as follows: -.Bl -tag -width vaddr -compact +.Bl -tag -width ".Fa vaddr" .It Fa dmat DMA tag. .It Fa vaddr @@ -823,16 +835,23 @@ callback function is called from a deferred context instead of the driver context. This means that certain .Nm -functions must always be called with same lock held that is specified in the -tag. These functions include: -.Pp -.Bl -inset -offset indent -compact -.It bus_dmamap_load -.It bus_dmamap_load_uio -.It bus_dmamap_load_mbuf -.It bus_dmamap_load_mbuf_sg -.It bus_dmamap_unload -.It bus_dmamap_sync +functions must always be called with the same lock held that is specified in the +tag. +These functions include: +.Pp +.Bl -item -offset indent -compact +.It +.Fn bus_dmamap_load +.It +.Fn bus_dmamap_load_uio +.It +.Fn bus_dmamap_load_mbuf +.It +.Fn bus_dmamap_load_mbuf_sg +.It +.Fn bus_dmamap_unload +.It +.Fn bus_dmamap_sync .El .Pp There is one exception to this rule. @@ -846,13 +865,17 @@ Certain .Nm operations should not be called with the driver lock held, either because they are already protected by an internal lock, or because they might sleep -due to memory or resource allocation. The following functions must not be +due to memory or resource allocation. +The following functions must not be called with any non-sleepable locks held: .Pp -.Bl -inset -offset indent -compact -.It bus_dma_tag_create -.It bus_dmamap_create -.It bus_dmamem_alloc +.Bl -item -offset indent -compact +.It +.Fn bus_dma_tag_create +.It +.Fn bus_dmamap_create +.It +.Fn bus_dmamem_alloc .El .Pp All other functions do not have a locking protocol and can thus be diff --git a/share/man/man9/crypto.9 b/share/man/man9/crypto.9 index 97db9aa..da9db86 100644 --- a/share/man/man9/crypto.9 +++ b/share/man/man9/crypto.9 @@ -292,7 +292,9 @@ is an mbuf chain. .It Dv CRYPTO_F_IOV The buffer pointed to by .Va crp_buf -is an uio structure. +is an +.Vt uio +structure. .It Dv CRYPTO_F_REL Must return data in the same place. .It Dv CRYPTO_F_BATCH @@ -355,7 +357,7 @@ For MAC algorithms, this is where the result of the keyed hash will be inserted. .It Va crd_flags The following flags are defined: -.Bl -tag -width ".Dv CRD" +.Bl -tag -width 3n .It Dv CRD_F_ENCRYPT For encryption algorithms, this bit is set when encryption is required (when not set, decryption is performed). diff --git a/share/man/man9/ktr.9 b/share/man/man9/ktr.9 index a096c7f..19b91de 100644 --- a/share/man/man9/ktr.9 +++ b/share/man/man9/ktr.9 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd February 15, 2001 +.Dd December 27, 2005 .Dt KTR 9 .Os .Sh NAME diff --git a/share/man/man9/memguard.9 b/share/man/man9/memguard.9 index 1851407..72a41e5 100644 --- a/share/man/man9/memguard.9 +++ b/share/man/man9/memguard.9 @@ -48,19 +48,25 @@ and .Fn free for a particular malloc type. .Sh EXAMPLES -To use memguard for memory type compiled into the kernel, one has to add the +To use +.Nm +for memory type compiled into the kernel, one has to add the following line to the .Pa /boot/loader.conf : .Bd -literal -offset indent vm.memguard.desc= .Ed .Pp -Where memory_type is a short description of memory type to monitor. +Where +.Ar memory_type +is a short description of memory type to monitor. The short description of memory type is the second argument to .Xr MALLOC_DEFINE 9 , so one has to find it in the kernel source. .Pp -To use memguard for memory type defined in a kernel module, one has to set +To use +.Nm +for memory type defined in a kernel module, one has to set .Va vm.memguard.desc .Xr sysctl 8 variable before loading the module: diff --git a/share/man/man9/pfil.9 b/share/man/man9/pfil.9 index 11ce046..e0df8c9 100644 --- a/share/man/man9/pfil.9 +++ b/share/man/man9/pfil.9 @@ -200,8 +200,8 @@ The diverts .Dv AF_INET and -.DV AF_INET6 -traffic according to it's sysctl settings, but contrary to the above +.Dv AF_INET6 +traffic according to its sysctl settings, but contrary to the above statements, the data is provided in host byte order. .Pp When a diff --git a/share/man/man9/sbuf.9 b/share/man/man9/sbuf.9 index ca9aa85..1a752db 100644 --- a/share/man/man9/sbuf.9 +++ b/share/man/man9/sbuf.9 @@ -29,6 +29,7 @@ .Dt SBUF 9 .Os .Sh NAME +.Nm sbuf , .Nm sbuf_new , .Nm sbuf_clear , .Nm sbuf_setpos , @@ -92,7 +93,7 @@ .Fn sbuf_delete "struct sbuf *s" .Sh DESCRIPTION The -.Nm sbuf +.Nm family of functions allows one to safely allocate, construct and release bounded null-terminated strings in kernel space. Instead of arrays of characters, these functions operate on structures @@ -308,37 +309,46 @@ size of its storage buffer using or it is reinitialized to a sufficiently short string using .Fn sbuf_cpy . .Sh RETURN VALUES +The .Fn sbuf_new -returns +function returns .Dv NULL if it failed to allocate a storage buffer, and a pointer to the new .Fa sbuf otherwise. .Pp +The .Fn sbuf_setpos -returns \-1 if +function returns \-1 if .Fa pos was invalid, and zero otherwise. .Pp +The .Fn sbuf_cat , .Fn sbuf_cpy , .Fn sbuf_printf , .Fn sbuf_putc , and .Fn sbuf_trim +functions all return \-1 if the buffer overflowed, and zero otherwise. .Pp +The .Fn sbuf_overflowed +function returns a non-zero value if the buffer overflowed, and zero otherwise. .Pp +The .Fn sbuf_data and .Fn sbuf_len -return +functions return .Dv NULL and \-1, respectively, if the buffer overflowed. .Pp +The .Fn sbuf_copyin +function returns \-1 if copying string from userland failed, and number of bytes copied otherwise. .Sh SEE ALSO @@ -350,13 +360,13 @@ copied otherwise. .Xr printf 9 .Sh HISTORY The -.Nm sbuf +.Nm family of functions first appeared in .Fx 4.4 . .Sh AUTHORS .An -nosplit The -.Nm sbuf +.Nm family of functions was designed by .An Poul-Henning Kamp Aq phk@FreeBSD.org and implemented by diff --git a/share/man/man9/sleep.9 b/share/man/man9/sleep.9 index 1562c55a..db97565 100644 --- a/share/man/man9/sleep.9 +++ b/share/man/man9/sleep.9 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd December 17, 1998 +.Dd April 17, 2006 .Os .Dt SLEEP 9 .Sh NAME @@ -124,8 +124,8 @@ If .Fa timo is not 0, then the thread will sleep for at most -.Fa timo -\&/ hz seconds. +.Fa timo No / Va hz +seconds. If the .Va Giant lock is not held and -- cgit v1.1