Re: est man page

Sean Bruno <seanbru_at_yahoo-inc.com> wrote
  in <1339531057.42366.2.camel_at_powernoodle.corp.yahoo.com>:

se> On Tue, 2012-06-05 at 14:13 -0700, Sean Bruno wrote:
se> > On Tue, 2012-06-05 at 11:55 -0700, Sean Bruno wrote:
se>
se>
se>
se> allrighty, after some doc reviews by Glen, I've thwacked together a
se> quick and dirty est(4).
se>
se> Any objections?
se>
se> http://people.freebsd.org/~sbruno/est_man.txt

 Looks good.  Attached a diff for some small fixes.

se> view via:
se> groff -S -P-h -Wall -mtty-char -man -Tascii est_man.txt | less

 % man $PWD/est_man.txt

 may be easier :)

-- Hiroki

.\"
.\" Copyright (c) 2012 Sean Bruno <sbruno_at_freebsd.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd June 12, 2012
.Dt EST 4
.Os
.Sh NAME
.Nm est
.Nd Enhanced Speedstep Technology
.Sh SYNOPSIS
To compile this capability into your kernel
place the following lines in your kernel
configuration file:
.Bd -ragged -offset indent
.Cd "device cpufreq"
.Ed
.Sh DESCRIPTION
The
.Nm
interface that provides support for the Intel Enhanced Speedstep Technology
.Pp
Note that the
.Nm
driver is automatically loaded by the
.Xr cpufreq 4
driver.
.Sh LOADER TUNABLES
The
.Nm
interface is intended to allow
.Xr cpufreq 4
to access and implement Intel Enhanced SpeedStep Technology via
.Xr acpi 4
and the acpi_perf interface accessors.
If the default settings are not optimal, the following sysctls can be
used to modify or monitor
.Nm
behavior.
.Bl -tag -width indent
.It hw.est.msr_info
Attempt to infer information from direct probing of the msr.
Should only be used in diagnostic cases.
.Pq default 0
.It hw.est.strict
Do not allow different cpus to be set to different frequencies.
It appears that this will only work on i386 systems.
.Pq default 0
.El
.Sh DIAGNOSTICS
.Bl -diag
.It "est%d: <Enhanced SpeedStep Frequency Control> on cpu%d"
.Pp
Indicates normal startup of this interface.
.It "est: CPU supports Enhanced Speedstep, but is not recognized."
.It "est: cpu_vendor GenuineIntel, msr 471c471c0600471c"
.It "device_attach: est2 attach returned 6"
.Pp
Indicates all attempts to attach to this interface have failed.
This usually indicates and improper BIOS setting restricting O/S
control of the CPU speeds.  Consult your BIOS documentation for
more details.
.El
.Sh COMPATIBILITY
.Nm
is only found on supported Intel CPUs.
.Sh SEE ALSO
.Xr cpufreq 4
.Sh SUPPORT
For general information and support,
go to the Intel 64 and IA-32 Architectures Software Developer
Manuals site.
.Pa http://www.intel.com/content/www/us/en/processors/architectures-software-developer-manuals.html
.Sh AUTHORS
.Pp
This manual page was written by
.An Sean Bruno Aq sbruno_at_FreeBSD.org .