No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man4 / coretemp.4
blobe4466c451360d57b6afe849f0c0656280d145274
1 .\" $NetBSD: coretemp.4,v 1.3 2007/12/21 21:36:22 xtraeme Exp $
2 .\"-
3 .\" Copyright (c) 2007 Juan Romero Pardines.
4 .\" Copyright (c) 2007 Dag-Erling Coïdan Smørgrav
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD: src/share/man/man4/coretemp.4,v 1.4 2007/10/15 20:00:19 netchild Exp $
29 .\"
30 .Dd December 21, 2007
31 .Dt CORETEMP 4
32 .Os
33 .Sh NAME
34 .Nm coretemp
35 .Nd Intel Core on-die digital thermal sensor
36 .Sh SYNOPSIS
37 .Cd "options INTEL_CORETEMP"
38 .Sh DESCRIPTION
39 The
40 .Nm
41 driver provides support for the on-die digital thermal sensor present
42 on Intel Core and newer CPUs.
43 .Pp
44 The
45 .Nm
46 driver reports each core's temperature through the
47 .Xr envsys 4
48 API.
49 The driver has only 1 temperature sensor:
50 .Bl -column "Sensor" "Units" "Typical" -offset indent
51 .It Sy "Sensor" Ta Sy "Units" Ta Sy "Typical Use"
52 .It Li "sensor0" Ta "uK" Ta "cpuN temperature"
53 .El
54 .Sh EVENTS
55 The
56 .Nm
57 driver is able to send a
58 .Em critical
59 event to the
60 .Fa /etc/powerd/scripts/sensor_temperature
61 .Xr powerd 8
62 script (if running) when the temperature has reached a critical state.
63 .Sh SEE ALSO
64 .Xr envsys 4 ,
65 .Xr envstat 8 ,
66 .Xr powerd 8
67 .Sh HISTORY
68 The
69 .Nm
70 driver first appeared in
71 .Fx 7.0 .
72 And then was ported to
73 .Nx 5.0 .
74 .Sh AUTHORS
75 .An -nosplit
76 The
77 .Nm
78 driver was written by
79 .An Rui Paulo Aq rpaulo@FreeBSD.org
80 as part of a Google Summer of Code project.
81 It was adapted to
82 .Nx
84 .An Juan Romero Pardines .