svn commit: r366575 - in head: libexec/rtld-elf share/man/man4 share/man/man4/man4.i386 share/man/man4/man4.powerpc stand/defaults stand/forth tools/tools/ether_reflect tools/tools/vimage
Gordon Bergling
gbe at FreeBSD.org
Fri Oct 9 15:14:21 UTC 2020
Author: gbe (doc committer)
Date: Fri Oct 9 15:14:19 2020
New Revision: 366575
URL: https://svnweb.freebsd.org/changeset/base/366575
Log:
Fix a few mandoc issues
- whitespace at end of input line
- skipping paragraph macro: Pp at the end of Sh
- new sentence, new line
- consider using OS macro: Fx
- AUTHORS section without An macro
- skipping paragraph macro: Pp before Ss
Modified:
head/libexec/rtld-elf/rtld.1
head/share/man/man4/acpi_ibm.4
head/share/man/man4/man4.i386/glxiic.4
head/share/man/man4/man4.powerpc/smu.4
head/share/man/man4/ng_checksum.4
head/stand/defaults/loader.conf.5
head/stand/forth/beastie.4th.8
head/stand/forth/brand.4th.8
head/tools/tools/ether_reflect/ether_reflect.1
head/tools/tools/vimage/vimage.8
Modified: head/libexec/rtld-elf/rtld.1
==============================================================================
--- head/libexec/rtld-elf/rtld.1 Fri Oct 9 14:45:41 2020 (r366574)
+++ head/libexec/rtld-elf/rtld.1 Fri Oct 9 15:14:19 2020 (r366575)
@@ -360,7 +360,7 @@ In the direct execution mode,
.Nm
emulates verification of the binary execute permission for the
current user.
-This is done to avoid breaking user expectations in naively restricted
+This is done to avoid breaking user expectations in naively restricted
execution environments.
The verification only uses Unix
.Dv DACs ,
Modified: head/share/man/man4/acpi_ibm.4
==============================================================================
--- head/share/man/man4/acpi_ibm.4 Fri Oct 9 14:45:41 2020 (r366574)
+++ head/share/man/man4/acpi_ibm.4 Fri Oct 9 15:14:19 2020 (r366575)
@@ -274,7 +274,7 @@ Speaker volume.
.It Va dev.acpi_ibm.0.mute
Indicates, whether the speakers are muted or not.
.It Va dev.acpi_ibm.0.mic_mute
-Indicates, whether the microphone led (present on some model) is on or not.
+Indicates, whether the microphone led (present on some model) is on or not.
Note that this does not mean that the microphone input is muted.
.It Va dev.acpi_ibm.0.thinklight
Indicates, whether the ThinkLight keyboard light is activated or not.
@@ -452,8 +452,8 @@ case ${NOTIFY} in
if [ $LEVEL -eq 0 ]; then
sysctl dev.acpi_ibm.0.mic_led=1
mixer rec 0
- fi
- if [ $LEVEL -eq 1 ]; then
+ fi
+ if [ $LEVEL -eq 1 ]; then
sysctl dev.acpi_ibm.0.mic_led=0
mixer rec 30
fi
Modified: head/share/man/man4/man4.i386/glxiic.4
==============================================================================
--- head/share/man/man4/man4.i386/glxiic.4 Fri Oct 9 14:45:41 2020 (r366574)
+++ head/share/man/man4/man4.i386/glxiic.4 Fri Oct 9 15:14:19 2020 (r366575)
@@ -50,8 +50,8 @@ glxiic_load="YES"
The
.Nm
driver supports the System Management Bus controller of the Geode LX
-series CS5536 Companion Device. The Geode LX is a member of the AMD
-Geode family of integrated x86 system chips.
+series CS5536 Companion Device.
+The Geode LX is a member of the AMD Geode family of integrated x86 system chips.
.Pp
Although AMD refers to this device as a System Management Bus (SMBus)
controller, it is really an I2C controller (it lacks SMBus ALERT# and
@@ -70,17 +70,18 @@ and
tunable:
.Bl -tag -width indent
.It Va dev.glxiic.0.timeout
-This variable controls the I2C bus timeout in milliseconds. The
-default timeout is 35 milliseconds. A value of zero disables the
-timeout.
+This variable controls the I2C bus timeout in milliseconds.
+The default timeout is 35 milliseconds.
+A value of zero disables the timeout.
.El
.Sh CAVEAT
The
.Nm
driver uses the interrupt line number configured by the board firmware
-by default. If no interrupt line number has been configured by the
-board firmware (or to override the interrupt line number configured by
-board firmware), place the following line in
+by default.
+If no interrupt line number has been configured by the board firmware
+(or to override the interrupt line number configured by board firmware),
+place the following line in
.Xr device.hints 5 :
.Bd -ragged -offset indent
hint.glxiic.0.irq="10"
Modified: head/share/man/man4/man4.powerpc/smu.4
==============================================================================
--- head/share/man/man4/man4.powerpc/smu.4 Fri Oct 9 14:45:41 2020 (r366574)
+++ head/share/man/man4/man4.powerpc/smu.4 Fri Oct 9 15:14:19 2020 (r366575)
@@ -60,45 +60,47 @@ Apple System Management Unit
.Sh THERMAL MANAGEMENT
The
.Nm
-driver provides basic automatic thermal management. Without a userspace
-daemon providing more advanced control, the driver will attempt to maintain
-system temperatures in a conservative range through coarse-grained control of
-system cooling devices (see below). Automatic kernel-level thermal control
-will take over if more than 3 seconds elapses between userspace cooling
-setting adjustments.
+driver provides basic automatic thermal management.
+Without a userspace daemon providing more advanced control, the driver will
+attempt to maintain system temperatures in a conservative range through
+coarse-grained control of system cooling devices (see below).
+Automatic kernel-level thermal control will take over if more than 3
+seconds elapses between userspace cooling setting adjustments.
.Sh SYSCTL VARIABLES
The
.Nm
driver provides power management services and thermal readout through a
sysctl interface.
-The following sysctls can be used to control the
-power management behavior and to examine current system power and
-thermal conditions.
+The following sysctls can be used to control the power management behavior
+and to examine current system power and thermal conditions.
.Bl -tag -width indent
.It Va dev.smu.%d.server_mode
Restart after power failure behavior (1 causes system to reboot after power
cut, 0 causes system to remain off).
.It Va dev.smu.%d.target_temp
-Target system temperature, in degrees Celsius. The
+Target system temperature, in degrees Celsius.
+The
.Nm
driver will attempt to adjust fans to maintain the temperature of the
warmest component in the system at or below this level.
.It Va dev.smu.%d.critical_temp
-System critical temperature, in degrees Celsius. If any component in
-the system exceeds this temperature, the machine will be shut down within
-500 ms.
+System critical temperature, in degrees Celsius.
+If any component in the system exceeds this temperature, the machine
+will be shut down within 500 ms.
.It Va dev.smu.%d.fans.%s.minrpm
Minimum allowed speed for this fan.
.It Va dev.smu.%d.fans.%s.maxrpm
Maximum allowed speed for this fan.
.It Va dev.smu.%d.fans.%s.rpm
-Current speed for this fan. The fan speed can be adjusted by changing this
-sysctl. If more than 3 seconds elapses between fan speed adjustments, the
-kernel will resume automatic control of the fan.
+Current speed for this fan.
+The fan speed can be adjusted by changing this sysctl.
+If more than 3 seconds elapses between fan speed adjustments, the kernel will
+resume automatic control of the fan.
.It Va dev.smu.%d.sensors.%s
-Current reading from this sensor. Four sensor types are supported. Temperature
-sensors are in units of degrees Celsius, current sensors in milliamps, voltage
-sensors in millivolts, and power sensors in milliwatts.
+Current reading from this sensor.
+Four sensor types are supported.
+Temperature sensors are in units of degrees Celsius, current sensors in
+milliamps, voltage sensors in millivolts, and power sensors in milliwatts.
.El
.Sh LED INTERFACE
The
Modified: head/share/man/man4/ng_checksum.4
==============================================================================
--- head/share/man/man4/ng_checksum.4 Fri Oct 9 14:45:41 2020 (r366574)
+++ head/share/man/man4/ng_checksum.4 Fri Oct 9 15:14:19 2020 (r366575)
@@ -44,7 +44,8 @@ This node type has two hooks:
Packets received on this hook are processed according to settings specified
in config and then forwarded to the
.Ar out
-hook, if it exists and is connected. Otherwise they are reflected back to the
+hook, if it exists and is connected.
+Otherwise they are reflected back to the
.Ar in
hook.
.It Va out
@@ -58,13 +59,15 @@ This node type supports the generic control messages,
.It Dv NGM_CHECKSUM_SETDLT Pq Ic setdlt
Sets the data link type on the
.Va in
-hook. Currently, supported types are
+hook.
+Currently, supported types are
.Cm DLT_RAW
(raw IP datagrams) and
.Cm DLT_EN10MB
(Ethernet). DLT_ definitions can be found in the
.In net/bpf.h
-header. Currently used values are
+header.
+Currently used values are
.Cm DLT_EN10MB
= 1 and
.Cm DLT_RAW
@@ -74,7 +77,8 @@ This control message obtains the data link type on the
.Va in
hook.
.It Dv NGM_CHECKSUM_SETCONFIG Pq Ic setconfig
-Sets the node configuration. The following
+Sets the node configuration.
+The following
.Vt "struct ng_checksum_config"
must be supplied as an argument:
.Bd -literal -offset 4n
Modified: head/stand/defaults/loader.conf.5
==============================================================================
--- head/stand/defaults/loader.conf.5 Fri Oct 9 14:45:41 2020 (r366574)
+++ head/stand/defaults/loader.conf.5 Fri Oct 9 15:14:19 2020 (r366575)
@@ -38,7 +38,6 @@ it you can specify the kernel to be booted, parameters
it, and additional modules to be loaded; and generally set all variables
described in
.Xr loader 8 .
-.Pp
.Sh SYNTAX
Though
.Nm Ns 's
Modified: head/stand/forth/beastie.4th.8
==============================================================================
--- head/stand/forth/beastie.4th.8 Fri Oct 9 14:45:41 2020 (r366574)
+++ head/stand/forth/beastie.4th.8 Fri Oct 9 15:14:19 2020 (r366575)
@@ -103,7 +103,8 @@ The default behavior is to not delay.
The environment variables that effect its behavior are:
.Bl -tag -width bootfile -offset indent
.It Va loader_logo
-Selects the desired logo in the beastie boot menu. Possible values are:
+Selects the desired logo in the beastie boot menu.
+Possible values are:
.Dq Li fbsdbw ,
.Dq Li beastie ,
.Dq Li beastiebw ,
@@ -112,9 +113,11 @@ Selects the desired logo in the beastie boot menu. Pos
(default), and
.Dq Li none .
.It Va loader_logo_x
-Sets the desired column position of the logo. Default is 46.
+Sets the desired column position of the logo.
+Default is 46.
.It Va loader_logo_y
-Sets the desired row position of the logo. Default is 4.
+Sets the desired row position of the logo.
+Default is 4.
.It Va beastie_disable
If set to
.Dq YES ,
@@ -122,9 +125,10 @@ the beastie boot menu will be skipped.
The beastie boot menu is always skipped if running non-x86 hardware.
.It Va loader_delay
If set to a number higher than zero, introduces a delay before starting the
-beastie boot menu. During the delay the user can press either Ctrl-C to skip
-the menu or ENTER to proceed to the menu. The default is to not delay when
-loading the menu.
+beastie boot menu.
+During the delay the user can press either Ctrl-C to skip the menu or ENTER
+to proceed to the menu.
+The default is to not delay when loading the menu.
.El
.Sh FILES
.Bl -tag -width /boot/loader.4th -compact
Modified: head/stand/forth/brand.4th.8
==============================================================================
--- head/stand/forth/brand.4th.8 Fri Oct 9 14:45:41 2020 (r366574)
+++ head/stand/forth/brand.4th.8 Fri Oct 9 15:14:19 2020 (r366575)
@@ -81,14 +81,17 @@ The default values are 2 (x) and 1 (y).
The environment variables that effect its behavior are:
.Bl -tag -width bootfile -offset indent
.It Va loader_brand
-Selects the desired brand in the beastie boot menu. Possible values are:
+Selects the desired brand in the beastie boot menu.
+Possible values are:
.Dq Li fbsd
(default) or
.Dq Li none .
.It Va loader_brand_x
-Sets the desired column position of the brand. Default is 2.
+Sets the desired column position of the brand.
+Default is 2.
.It Va loader_brand_y
-Sets the desired row position of the brand. Default is 1.
+Sets the desired row position of the brand.
+Default is 1.
.El
.Sh FILES
.Bl -tag -width /boot/loader.4th -compact
Modified: head/tools/tools/ether_reflect/ether_reflect.1
==============================================================================
--- head/tools/tools/ether_reflect/ether_reflect.1 Fri Oct 9 14:45:41 2020 (r366574)
+++ head/tools/tools/ether_reflect/ether_reflect.1 Fri Oct 9 15:14:19 2020 (r366575)
@@ -45,11 +45,13 @@ command implements a simple ethernet packet reflector
.Xr PCAP 3
library and
.Xr bpf 4 ,
-the Berkeley Packet Filter. The program is useful primarily to test
-the low level round trip time of packets through an Ethernet interface
-and/or a switch. Network protocols, such as IP, and the network stack
-in general are never invoked, only the device driver that implements
-the particular interface is executed. As the
+the Berkeley Packet Filter.
+The program is useful primarily to test the low level round trip time
+of packets through an Ethernet interface and/or a switch.
+Network protocols, such as IP, and the network stack in general are never
+invoked, only the device driver that implements the particular interface
+is executed.
+As the
.Nm
command uses the
.Xr bpf 4
@@ -67,13 +69,14 @@ ether type for driver testing.
.It Fl i Ar interface
Network interface, which can be found with ifconfig(1).
.It Fl t Ar timeout
-The time, in milliseconds, to wait for a packet. Lower times decrease
-latency at the cost of CPU.
+The time, in milliseconds, to wait for a packet.
+Lower times decrease latency at the cost of CPU.
.It Fl p
-Set the device into promiscuous mode before testing. This is not
-usually necessary.
+Set the device into promiscuous mode before testing.
+This is not usually necessary.
.It Fl d
-Debug output. Print various small pieces of debug information.
+Debug output.
+Print various small pieces of debug information.
.El
.Sh EXAMPLES
The following is an example of a typical usage
@@ -84,7 +87,8 @@ command:
.Dl "ether_reflect -i em0 -t 1"
.Pp
Reflect all test packets, those with an ether type of 0x8822, which
-are seen on ineterface em0. The timeout is 1 millisecond.
+are seen on ineterface em0.
+The timeout is 1 millisecond.
.Pp
.Dl "ether_reflect -i em0 -a 00:00:00:aa:bb:cc -t 1"
.Pp
Modified: head/tools/tools/vimage/vimage.8
==============================================================================
--- head/tools/tools/vimage/vimage.8 Fri Oct 9 14:45:41 2020 (r366574)
+++ head/tools/tools/vimage/vimage.8 Fri Oct 9 15:14:19 2020 (r366575)
@@ -65,20 +65,17 @@ and
.
.Ss Overview
A virtual image or vimage is a jail with its own independent network
-stack instance. Every process, socket and network interface present
-in the system is always attached to one, and only one, virtual network
-stack instance (vnet).
-During system bootup sequence a default vnet
-is created to which all the configured interfaces and user processes
-are initially attached.
-Assuming that enough system resources are
-are available, a user with sufficient privileges can create and manage
-a hierarchy of subordinated virtual images.
+stack instance.
+Every process, socket and network interface present in the system is always
+attached to one, and only one, virtual network stack instance (vnet).
+During system bootup sequence a default vnet is created to which all the configured
+interfaces and user processes are initially attached.
+Assuming that enough system resources are are available, a user with sufficient
+privileges can create and manage a hierarchy of subordinated virtual images.
The
.Nm
command allows for creation, deletion and monitoring of virtual images,
-as well as for execution of arbitrary processes in a targeted virtual
-image.
+as well as for execution of arbitrary processes in a targeted virtual image.
.Ss Invocation
If invoked with no modifiers, the
.Nm
@@ -109,12 +106,13 @@ using the same syntax as with the -c form of the comma
Delete the virtual image
.Ar vname .
No processes and/or sockets should exist in the target virtual image
-in order for the delete request to succeed. Non-loopback interfaces
-residing in the target virtual image will be reassigned to the virtual
-image's parent.
+in order for the delete request to succeed.
+Non-loopback interfaces residing in the target virtual image
+will be reassigned to the virtual image's parent.
.It Fl l
-List the properties and statistics for virtual images one level
-below the current one in the hierarchy. If an optional argument
+List the properties and statistics for virtual images one level below
+the current one in the hierarchy.
+If an optional argument
.Ar vname
is provided, only the information regarding the target virtual image
.Ar vname
@@ -183,11 +181,12 @@ command exits 0 on success, and >0 if an error occurs.
.Xr jls 8
.Sh HISTORY
Network stack virtualization framework first appeared as a patchset
-against the FreeBSD 4.7 kernel in 2002, and was maintained outside
-of the main FreeBSD tree.
+against the
+.Fx 4.7
+kernel in 2002, and was maintained outside of the main FreeBSD tree.
As a result of a project sponsored by the FreeBSD Foundation and
-Stiching NLNet, integrated virtualized network stack first appeared
-in FreeBSD 8.0.
+Stiching NLNet, integrated virtualized network stack first appeared in
+.Fx 8.0 .
.Sh AUTHORS
.An Marko Zec Aq Mt zec at fer.hr
.Sh BUGS
More information about the svn-src-all
mailing list