[Cpufreqd-devel] sources2/manpages cpufreqd.conf.5,1.18,1.19

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Update of /cvsroot/cpufreqd/sources2/manpages
In directory sc8-pr-cvs4.sourceforge.net:/tmp/cvs-serv11659/manpages

Modified Files:
	cpufreqd.conf.5 
Log Message:
update manpage with recent changes

Index: cpufreqd.conf.5
===================================================================
RCS file: /cvsroot/cpufreqd/sources2/manpages/cpufreqd.conf.5,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -r1.18 -r1.19

--- cpufreqd.conf.5	23 Apr 2006 18:46:47 -0000	1.18
+++ cpufreqd.conf.5	11 Jun 2006 20:21:36 -0000	1.19
@@ -31,10 +31,11 @@
 are preferred.
 
 \- in case of 2 or more rules having the same score the first one (as found in
-the configuration file) is kept and applied.
+the configuration file) or the one already applied if applicable is kept and
+set.
 
-\- each entry is handled by a single plugin that will determine if the state
-described matches the current state
+\- each directive is handled by a single plugin that will determine if the state
+described matches the current system state.
 
 \- if no rule matches the current system status, no action is performed.
 .RE
@@ -42,14 +43,14 @@
 What to keep in mind when writing rules:
 
 .RS
-\- the \-V switch is your (hopefully) friend, test your configuration slightly
+\- the \-V switch is (hopefully) your friend, test your configuration slightly
 increasing 
 .B cpufreqd
 verbosity and look what happens (\-V6 will report rules' scores, \-V7 will
 report which entry matched and which not).
 
 \- if you want a rule to be preferred over another just describe the system state
-more accurately
+more accurately.
 .RE
 
 A good approach to write cpufreqd rules is to first describe the basic
@@ -77,21 +78,14 @@
 
 .TP
 .B "enable_plugins"
-A list of plugins separated by comma.
+A list of plugins separated by comma. As of cpufreqd 2.1.0 this option is useless,
+cpufreqd will load all available plugins and remove those remaining unused
+after the configuration file is read.
 
 .TP
 .B "pidfile"
 Specifies the file to write as its process identification file.
 (default: /var/run/cpufreqd.pid)
-./"
-./".TP
-./".B "acpi_workaround"
-./"0 or 1 meaning disable and enable respectively. (default: 0) As some ACPI
-./"implementations are very cpu-consuming when reading the info file of system
-./"batteries. Cpufreqd implements a simple workaround that avoids reading that
-./"file except on initialisation or reinitialisation. This has the effect of
-./"needing to send an HUP signal if inserting a new battery, otherwise battery
-./"measurement won't be correct.
 
 .TP
 .B "enable_remote"
@@ -101,7 +95,7 @@
 .TP
 .B "remote_group"
 Make the socket readable and writeable to the specified group. Useful to allow
-simple users to tweak cpufreqd with cpufreqd-set and cpufreqd-set.
+simple users to tweak cpufreqd with cpufreqd-set and cpufreqd-get.
 
 .TP
 .B "double_check"
@@ -124,12 +118,12 @@
 .B "minfreq"
 An integer value representing the minimum frequency to set in
 /proc/cpufreq. This value can be both a percentage of the CPU full capacity or
-frequency in kHz.
+frequency in kHz. [REQUIRED]
 
 .TP
 .B "maxfreq"
 An integer value representing the maximum frequency to set. This value can be
-both a percentage of the CPU full capacity or frequency in kHz.
+both a percentage of the CPU full capacity or frequency in kHz. [REQUIRED]
 
 .TP
 .B "policy"
@@ -140,7 +134,7 @@
 
 .TP
 .B "other plugin entries"
-Other Profile options are enabled according to the enabled plugins.
+Other Profile directives are available according to the enabled plugins.
 
 .PP
 .SS "[Rule]"
@@ -155,20 +149,32 @@
 
 .TP
 .B "other plugin entries"
-Other Rule options are enabled according to the enabled plugins.
+Other Rule directives are available according to the enabled plugins.
 
 .SH PLUGINS
 .PP
 Plugins extend cpufreqd in order to be able to cope with the most exotic system
-paramters.  Currently available plugins are listed below along with the
+paramters. Currently available plugins are listed below along with the
 configration directives they provide and their configuration section description
 if available.
 
 .PP
-.SS "acpi_battery plugin"
-Monitors the battery level as reported by /proc/acpi/battery/*/state. If
-multiple batteries are present the battery level is computed summing all battery
-capacities. Available Rule entries:
+.SS "acpi plugin"
+This plugin includes all the acpi monitoring functionalities previously 
+available as separate plugins. It allows monitoring battery, temperature, ac
+and interacting with acpid to immediately react on ACPI events.
+.TP
+.B "Section [acpi]"
+.RS
+.B "acpid_socket"
+The path to Acpid open socket (default: /var/run/acpid.socket). When available cpufreqd
+will wake up immediately upon event arrival and battery and ac status updates are forced.
+.TP
+.B "battery_update_interval"
+The number of seconds that have to elapse before polling the battery again. In
+such period the battery value will be estimated based on reported power consumption
+(default: 30).
+.RE
 .TP
 .B "battery_interval"
 The rule will have a higher score if battery percentage is between the values
@@ -176,24 +182,13 @@
 battery_interval=10-100) or %s:%d-%d or %s:%d where the string represents the
 battery name that must match (look at 'ls /proc/acpi/battery' for available
 names).
-
-.PP
-.SS "acpi_ac plugin"
-Monitors the AC state as reported by /proc/acpi/ac_adapter/*/state.
-Available Rule entries:
 .TP
 .B "ac"
 Can be on or off.  The rule will have a higher score if the A/C adapter is on or
 off as defined in this setting.
-
-.PP
-.SS "acpi_temperature plugin"
-Monitors the temperature as reported by /proc/acpi/thermal_zone/*/temperature.
-Unfortunately as I don't currently have the necessary harware, if multiple
-thermal zones are reported a medium value is computed. Available Rule entries:
 .TP
 .B "acpi_temperature"
-The rule will have a higher score if the temperature percentage is corresponds
+The rule will have a higher score if the temperature percentage corresponds
 to the provided values. Can be of the form %d-%d or simply %d for a fixed value
 (e.g.: acpi_temperature=10-100) or %s:%d-%d or %s:%d where the string represents
 the thermal zone name that must match (look at 'ls /proc/acpi/thermal_zone' for
@@ -228,12 +223,18 @@
 Monitors the cpu usage. Available Rule entries:
 .TP
 .B "cpu_interval"
-The rule will have a higher score if cpu usage is between the values
-provided.  Must be of the form %d-%d (e.g.: cpu_interval=10-100). Rules with
-overlapping cpu_intervals are allowed. You can also specify the scale to
-calculate niced processes cpu usage with the form %d-%d,%f (e.g.:
-cpu_interval=70-100,1.5), default is 3, in this way niced processes will be
-considered 1/3 of their real value.
+The rule will have a higher score if cpu usage is between the values provided.
+Must be of the form %d-%d (e.g.: cpu_interval=10-100) or %d:%d-%d to monitor a
+specific cpu in SMP/SMT systems (e.g.: cpu_interval=1:50-100). Moreover you can
+combine multiple cpus giving multiple intervals on the same line separated by
+semicolon (';'), if any of them matches the full directive will match (e.g.:
+cpu_interval=0:50-100;1:0-60). Additionally you can use the strings "ALL" and
+"ANY" to request that all cpus or any cpu matches respectively (e.g.:
+cpu_interval=ANY:50-100).
+It is possible to specify the scale to calculate niced processes cpu usage with
+the form %d-%d,%f or %d:%d-%d,%f (e.g.: cpu_interval=1:70-100,1.5), default is
+3, in this way niced processes will be considered 1/3 of their real value.
+Rules with overlapping cpu_intervals are allowed.
 
 .PP
 .SS "programs plugin"
@@ -443,7 +444,7 @@
 name=hi_cpu
 ac=off
 battery_interval=40-100
-cpu_interval=70-100
+cpu_interval=ANY:70-100
 profile=hi
 [/Rule]
 
@@ -452,7 +453,7 @@
 [Rule] 
 name=overheat
 acpi_temperature=55-100
-cpu_interval=0-100
+cpu_interval=ANY:0-100
 battery_interval=40-100
 profile=medium
 [/Rule]
@@ -464,7 +465,7 @@
 ac=off
 battery_interval=0-100
 acpi_temperature=0-100
-cpu_interval=0-100
+cpu_interval=ANY:0-100
 programs=xine,mplayer
 profile=hi
 [/Rule]



