From 971f9b29ba4cd37b5c61ac1282760505427a4d09 Mon Sep 17 00:00:00 2001
From: yar <yar@FreeBSD.org>
Date: Mon, 7 Aug 2006 07:28:47 +0000
Subject: [PATCH] Fix things I misadvised to Nate Lawson:

- "Ns No" is redundant, so reduce it to just "Ns";
- use Li to mark up CPU and system power states because here they are
  just strings to be typed literally (add more such mark-up as well);
- the best practice of typesetting tells us to use an en-dash to
  indicate a closed range; fortunately, groff_char(7) provides such a symbol.

In addition, consistently use a comma between independent clauses
coordinated by a conjunction.

Pointed out by:	ru (mark-up part)
MFC after:	3 days
---
 share/man/man4/acpi.4 | 72 ++++++++++++++++++++++++++-----------------
 1 file changed, 44 insertions(+), 28 deletions(-)

diff --git a/share/man/man4/acpi.4 b/share/man/man4/acpi.4
index f608cd647e6c..ddc2efc78089 100644
--- a/share/man/man4/acpi.4
+++ b/share/man/man4/acpi.4
@@ -71,7 +71,9 @@ The values are reset when
 is modified.
 .It Va hw.acpi.cpu.cx_lowest
 Lowest Cx state to use for idling the CPU.
-A scheduling algorithm will select states between C1 and this setting
+A scheduling algorithm will select states between
+.Li C1
+and this setting
 as system load dictates.
 To enable ACPI CPU idling control,
 .Va machdep.cpu_idle_hlt
@@ -79,12 +81,24 @@ must be set to 1.
 .It Va hw.acpi.cpu.cx_supported
 List of supported CPU idle states and their transition latency
 in microseconds.
-Each state has a type (e.g., C2).
-C1 is equivalent to the ia32 HLT instruction, C2 provides a deeper
-sleep with the same semantics, and C3 provides the deepest sleep
+Each state has a type (e.g.,
+.Li C2 ) .
+.Li C1
+is equivalent to the ia32
+.Li HLT
+instruction,
+.Li C2
+provides a deeper
+sleep with the same semantics, and
+.Li C3
+provides the deepest sleep
 but additionally requires bus mastering to be disabled.
-States greater than C3 provide even more power savings with the same
-semantics as the C3 state.
+States greater than
+.Li C3
+provide even more power savings with the same
+semantics as the
+.Li C3
+state.
 Deeper sleeps provide more power savings but increased transition
 latency when an interrupt occurs.
 .It Va hw.acpi.disable_on_reboot
@@ -99,15 +113,17 @@ Some newer systems require use of this register, while some only work
 with legacy rebooting support.
 .It Va hw.acpi.lid_switch_state
 Suspend state
-.Pq Dv S1 Ns No \- Ns Dv S5
+.Pq Li S1 Ns \[en] Ns Li S5
 to enter when the lid switch (i.e., a notebook screen) is closed.
-Default is NONE (do nothing).
+Default is
+.Dq Li NONE
+(do nothing).
 .It Va hw.acpi.power_button_state
 Suspend state
-.Pq Dv S1 Ns No \- Ns Dv S5
+.Pq Li S1 Ns \[en] Ns Li S5
 to enter when the power button is pressed.
 Default is
-.Dv S5
+.Li S5
 (power-off nicely).
 .It Va hw.acpi.reset_video
 Reset the video adapter from real mode during the resume path.
@@ -115,20 +131,20 @@ Some systems need this help, others have display problems if it is enabled.
 Default is 0 (disabled).
 .It Va hw.acpi.s4bios
 Indicate whether the system supports
-.Dv S4BIOS .
+.Li S4BIOS .
 This means that the BIOS can handle all the functions of suspending the
 system to disk.
 Otherwise, the OS is responsible for suspending to disk
-.Pq Dv S4OS .
+.Pq Li S4OS .
 Most current systems do not support
-.Dv S4BIOS .
+.Li S4BIOS .
 .It Va hw.acpi.sleep_button_state
 Suspend state
-.Pq Dv S1 Ns No \- Ns Dv S5
+.Pq Li S1 Ns \[en] Ns Li S5
 to enter when the sleep button is pressed.
 This is usually a special function button on the keyboard.
 Default is
-.Dv S3
+.Li S3
 (suspend-to-RAM).
 .It Va hw.acpi.sleep_delay
 Wait this number of seconds between preparing the system to suspend and
@@ -136,31 +152,31 @@ actually entering the suspend state.
 Default is 1 second.
 .It Va hw.acpi.supported_sleep_state
 Suspend states
-.Pq Dv S1 Ns No \- Ns Dv S5
+.Pq Li S1 Ns \[en] Ns Li S5
 supported by the BIOS.
 .Bl -tag -width indent
-.It Dv S1
+.It Li S1
 Quick suspend to RAM.
-The CPU enters a lower power state but most peripherals are left running.
-.It Dv S2
+The CPU enters a lower power state, but most peripherals are left running.
+.It Li S2
 Lower power state than
-.Dv S1 ,
+.Li S1 ,
 but with the same basic characteristics.
 Not supported by many systems.
-.It Dv S3
+.It Li S3
 Suspend to RAM.
-Most devices are powered off and the system stops running except for
+Most devices are powered off, and the system stops running except for
 memory refresh.
-.It Dv S4
+.It Li S4
 Suspend to disk.
-All devices are powered off and the system stops running.
+All devices are powered off, and the system stops running.
 When resuming, the system starts as if from a cold power on.
 Not yet supported by
 .Fx
 unless
-.Dv S4BIOS
+.Li S4BIOS
 is available.
-.It Dv S5
+.It Li S5
 System shuts down cleanly and powers off.
 .El
 .It Va hw.acpi.verbose
@@ -585,7 +601,7 @@ timer.
 Disable APIC mode with
 .Va hint.apic.0.disabled
 or don't use the
-.Dv C2
+.Li C2
 and
-.Dv C3
+.Li C3
 states if APIC mode is enabled.