\input texinfo   @c -*-texinfo-*-

@c *********** Part 1: Header *********************************
@c %**start of header
@setfilename powersave.info
@settitle Powersave Documentation
@documentdescription
        @c This produces the HTML Meta Tag like:
        @c <meta name=description content="XXXXXXX">
        powersave, cpufreq, powernow, speedstep, suspend to disk,
        suspend to ram, smart battery, ACPI, userspace daemon,
        SUSE Linux, linux package
@end documentdescription
@c %**end of header

@c ****** Part 2: Summary Description and Copyright ***********
@ifinfo
This manual describes the functionalities of the powersave package

Copyright Thomas Renninger - SUSE Linux GmbH, 2005
@end ifinfo

@c *********** Part 3: Titlepage and Copyright ****************
@titlepage
@contents
@sp 10
@title Powersave Daemon Documentation / HOWTO
@author Thomas Renninger (mail@renninger.de)
@c The following two commands start the copyright page.
@page
@vskip 0pt plus 1filll
Copyright Thomas Renninger - SUSE Linux GmbH, 2005

The powersave daemon package and all its source code as well as this
documentation, is free software;
you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
@end titlepage



@c *********** Part 4: `Top' Node and Master Menu *************
@ifnottex
@node Top
@top Powersave Documentation / HOWTO

This packages was mainly intended for laptops. However more and more
features (proper suspend/standby, configure ACPI Buttons, processor
frequency scaling (also supported on multi processor machines), 
spinning down the hard disk, thermal management, ...) 
became available for workstations and even on servers.

This package unifies the control of power managing facilities on your
PC. It supports hardware based on ACPI, APM, IDE-disks and CPU
frequency scaling techniques. It takes over functionalities of the
apmd, acpid, ospmd and cpufreqd (now called cpuspeed) packages.
Therefore you should not install and you must not run daemons from
these packages when you run the powersave daemon.@*
One exception to this rule is acpid - since only one process can access
@code{/proc/acpi/event} and at least HAL and powersaved need ACPI events,
we use acpid as an "event distributor". To achieve this you should configure
acpid to not process any events, otherwise you will get undefined results
since powersaved also executes actions based on ACPI events. Just removing
everything in @code{/etc/acpi/events} and putting an empty file named
"default" in there should be enough for that.

If your PC does not contain all of the described hardware above (APM
and ACPI are mutal exclusive) you should still run this daemon to
manage power saving related tasks. The overhead is small and you will
be provided with a unique interface and configuration environment.  And
you can still use this tool if some hardware should change (e.g. booting
ACPI instead of APM when kernel provides better ACPI support). The
daemon will automatically detect your hardware and support available features.

Among others, the Powersave Daemon provides the following features:
@itemize
@item	Four predefined powersave schemes, each providing different
	settings which are fully configurable. Adding of customized
	schemes is also possible. The current scheme is automatically
	switched depending on the current power source.
	@itemize
	@item Powersave
	@item Performance
	@item Acoustic
	@item Presentation
	@end itemize
@item	Full support for cpu frequency scaling, either through kernel
	(ondemand governor) or within userspace. There are three
	predefined cpu policies.
	@itemize
	@item Dynamic
	@item Powersave
	@item Performance
	@end itemize
@item	Battery management. This includes warning the admin/user when
	a critical battery state is reached and automatic shut down of the
	system on specific events (fully configurable).
@item	Supporting Suspend to disk, Suspend to and ram and standby. This
	includes caring about setting up modules, services and a lot more.
@item	Automatic cpu throttling depending on the current cooling policy
@item	Full featured dbus implementation for communication with various
	clients like kpowersave, wmpowersave, or gkrellm-powersave. More
	to come...
@end itemize

Get the latest packages from @url{https://sourceforge.net/projects/powersave}

@section Code Documentation

If you are a developer and want to have a look at the code or the internal design, you may look at the
@url{autodocs/index.html, Doxygen documentation}.

@section Outdated Documentation and Bug Reporting

Be aware that this project is under developement. If you find outdated or incorrect documentation
or any bug, please drop us a mail on @email{powersave-devel@@forge.novell.com} (subscribe here:
@url{http://forge.novell.com/modules/xfmod/maillist/subscribe.php?group_id=1438&list=powersave-devel})

@end ifnottex

@menu

@section Topics

* Battery::
* Dynamic Processor Frequency Scaling:Cpufreq.
* ACPI Buttons:Buttons.
* Thermal Management:Thermal.
* Suspend::
* Suspend with Nvidia Graphic Cards:SuspendNvidia.
* Suspend To Ram:Suspend2Ram.
* Suspend Security:SuspendSec.
* Schemes::
* Powersave Events:Events.
* Mapping Scripts to Events:Scripts.
* Accessing Powersave Information via DBus:DBus.
* User Management - Security:Security.
* Internals::
* Overriding the DSDT:DSDT.
* Compiling and Installing the Sources:Compiling.
* Distributions:Distributions.
* Programs/Tools interacting with the Powersave Daemon:Clients.
* Version Specifics:Versions.
* Known Bugs:Bugs.
* Further Work ToDo:Todo.
* FAQ::
* How to track down ACPI Kernel/BIOS Problems:ACPI_Debugging.
* How to get linked to or extend this Document:Extend.
* Lists and Links:Lists.


@c * Index::
@end menu


@c *********** Part 5:  The Body of the Document **************

@node       Battery
@chapter    Battery
@include    README.battery

@node       Cpufreq
@chapter    Dynamic Processor Frequency Scaling
@include    README.cpufreq

@node       Buttons
@chapter    ACPI Buttons
@include    README.buttons

@node       Thermal
@chapter    Thermal Management
@include    README.thermal

@node       Suspend
@chapter    Suspend
@include    README.suspend

@node       SuspendNvidia
@chapter    Suspend with Nvidia Graphic Cards
@include    README.suspend-NVidia

@node       Suspend2Ram
@chapter    Suspend To Ram
@include    README.suspend2ram

@node       SuspendSec
@chapter    Suspend Security
@include    README.suspend-security

@node       Schemes
@chapter    Schemes
@include    README.schemes

@node       Events
@chapter    Powersave Events
@include    README.events

@node       Scripts
@chapter    Mapping Scripts to Events
@include    README.scripts

@node       DBus
@chapter    Powersave DBus specification
@include    README.dbus

@node       Security
@chapter    User Management - Security
@include    README.user_management

@node       Internals
@chapter    Internals
@include    README.internals

@node       DSDT
@chapter    Overriding the DSDT
@include    README.dsdt

@node       Compiling
@chapter    Compiling and Installing the Sources
@include    README.installation

@node       Distributions
@chapter    Distributions
@include    README.distributions

@node       Clients
@chapter    Programs/Tools interacting with the Powersave Daemon
@include    README.clients

@node       Versions
@chapter    Version Specifics
@include    README.versions

@node       Bugs
@chapter    Known Bugs
@include    README.bugs

@node       Todo
@chapter    Further Work ToDo
@include    README.todo

@node       FAQ
@chapter    FAQ
@include    README.faq

@node       ACPI_Debugging
@chapter    How to track down ACPI Kernel/BIOS Problems
@include    README.acpi_debugging

@node       Extend
@chapter    How to get linked to or extend this Document
@include    README.extend

@node       Lists
@chapter    Lists and Links
@include    README.lists

@c @node       Index
@c *********** Part 6: The End of the Document ****************


@c @unnumbered Index
@c @printindex cp
@bye
