Commit 17ca06f8 authored by Richard Hughes's avatar Richard Hughes

Initial revision

Richard Hughes <>
This diff is collapsed.
This diff is collapsed.
Hacking the GNOME Power Manager
Coding Style
Coding style is supposed to be GNOME's.
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Basic Installation
These are generic installation instructions.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. (Caching is
disabled by default to prevent problems with accidental use of stale
cache files.)
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `' (or `') is used to create
`configure' by a program called `autoconf'. You only need
`' if you want to change it or regenerate `configure' using
a newer version of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.
Running `configure' takes awhile. While running, it prints some
messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
Some systems require unusual options for compilation or linking that
the `configure' script does not know about. Run `./configure --help'
for details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
If you have to use a `make' that does not support the `VPATH'
variable, you have to compile the package for one architecture at a
time in the source code directory. After you have installed the
package for one architecture, use `make distclean' before reconfiguring
for another architecture.
Installation Names
By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
There may be some features `configure' cannot figure out
automatically, but needs to determine by the type of machine the package
will run on. Usually, assuming the package is built to be run on the
_same_ architectures, `configure' can figure that out, but if it prints
a message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
where SYSTEM can have one of these forms:
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the `--target=TYPE' option to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
If you want to set default values for `configure' scripts to share,
you can create a site shell script called `' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/' if it exists, then
`PREFIX/etc/' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
will cause the specified gcc to be used as the C compiler (unless it is
overridden in the site shell script).
`configure' Invocation
`configure' recognizes the following options to control how it
Print a summary of the options to `configure', and exit.
Print the version of Autoconf used to generate the `configure'
script, and exit.
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
Alias for `--cache-file=config.cache'.
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.
SUBDIRS = src po
pkgdata_DATA = src/
schemadir = $(sysconfdir)/gconf/schemas
schema_in_files =
schema_DATA = $(
desktopdir = $(datadir)/applications
desktop_in_files =
desktop_DATA = $(
dbusconfdir = $(sysconfdir)/dbus-1/system.d
dbusconf_DATA = gnome-power.conf
man_MANS = \
gnome-power-manager.1 \
gnome-power.spec \ \ \
$(schema_in_files) \
$(desktop_in_files) \
$(pkgdata_DATA) \
$(dbusconf_DATA) \ \ \ \
gnome-power-manager.sgml \
gnome-power-preferences.sgml \
-GCONF_CONFIG_SOURCE=$(GCONF_SCHEMA_CONFIG_SOURCE) $(GCONFTOOL) --makefile-install-rule $(srcdir)/$(schema_DATA)
clean-local :
rm -f *~
rm -f *.1
rm -f manpage.*
gnome-power-manager.1: gnome-power-manager.sgml
docbook2man $? > $@
gnome-power-preferences.1: gnome-power-preferences.sgml
docbook2man $? > $@
intltool-extract \
intltool-merge \
intltool-update \
gnome-power-preferences.desktop \
aclocal.m4 \
config.guess \ \
config.sub \
configure \
depcomp \
install-sh \
libtool \ \
missing \
autom4te.cache/* \
2005-06-15 Richard Hughes <>
* Release of 0.0.4
2005-04-17 Richard Hughes <>
* Release of 0.0.3
2005-03-21 Richard Hughes <>
* Initial release of 0.0.2
GNOME Power Manager
A Power Manager for GNOME
GNOME Power Manager is a GNOME session daemon that acts as a policy agent on top of
the Project Utopia stack, which includes the kernel, hotplug, udev, and HAL. GNOME
Power Manager listens for HAL events and responds with user-configurable reactions.
Currently it supports UPS's, laptop batteries and AC adapters. Its goal is to be
architecture neutral and free of polling and other hacks.
Most of the code is actually in HAL for abstracting various power aware devices
(UPS's) and frameworks (ACPI, PMU, APM etc.) - so the desktop parts are fairly
lightweight and straightforward to write.
GNOME Power Manager comes in three parts:
- gnome-power-manager: the manager daemon itself
- gnome-power-preferences: the control panel program, for configuration
To build, GNOME Power Manager requires
- libgnomeui-2.0
- libglade-2.0
- libhal-0 (from HAL 0.5.00 or later)
- libdbus-1 (from D-BUS 0.30 or later)
- libdbus-glib-1 (from D-BUS 0.30 or later)
To run, gnome-power-manager requires hald to be running.
For more information, please see
=== Failing to install gconf schema? ===
The amended configure line is needed when installing to a local gconf root (non root)
./configure --prefix=/home/hughsie/root --with-gconf-source=xml::/home/hughsie/.gconf
* Get DBUS working
* Do long and short descriptions for schema policy
* Make pure GNOME/Glib
* get rid of clipboard.c and use glib functions.
* valgrind says Conditional jump or move depends on uninitialised value(s) on 209 (->present)
Document Error:
WARNING: failed to install schema `/schemas/apps/gnome-power/policy/button_sleep'
make maintainer-clean-recursive work
# Run this to generate all the initial makefiles, etc.
srcdir=`dirname $0`
test -z "$srcdir" && srcdir=.
echo "Running $ACLOCAL..."
echo "Running $AUTOHEADER..."
$AUTOHEADER || exit 1
echo "Running $AUTOCONF..."
$AUTOCONF || exit 1
echo "Running $LIBTOOLIZE --automake..."
$LIBTOOLIZE --automake || exit 1
echo "Running $AUTOMAKE..."
$AUTOMAKE -a || exit 1
$AUTOMAKE -a src/Makefile || exit 1
if test x$NOCONFIGURE = x; then
echo Running $srcdir/configure $conf_flags "$@" ...
$srcdir/configure $conf_flags "$@" \
&& echo Now type \`make\' to compile. || exit 1
echo Skipping configure process.
AC_INIT(gnome-power, 0.1.1)
PKG_CHECK_MODULES(GLIB, glib-2.0 gobject-2.0)
PKG_CHECK_MODULES(HAL, hal >= 0.5.0)
PKG_CHECK_MODULES(DBUS, dbus-glib-1 >= 0.30 dbus-1 >= 0.30 gthread-2.0)
PKG_CHECK_MODULES(GNOME, libgnomeui-2.0 libglade-2.0 libwnck-1.0 >= 2.1.5 gtk+-2.0 >= 2.6.0)
LDFLAGS="$LDFLAGS -ansi -Wall"
DBUS Interfaces for GNOME Power Manager
<h2>Client Methods:</h2>
<h3>bool isUserIdle ()</h3>
<p>Returns true is the user has been idle for the timeout set in gconf.</p>
<pre>status: stub</pre>
<h3>bool isRunningOnMains ()</h3>
<p>Returns true if we are running on mains (usefull for scripts)</p>
<pre>status: stub</pre>
<h3>bool isActive ()</h3>
<p>Returns true if we are running. Testing function.</p>
<pre>status: complete</pre>
<h2>Server Signals</h2>
<h3>mainsStatusChanged (bool isRunningOnMains)</h3>
<p>emitted when the mains power connection changes</p>
<pre>status: complete</pre>
<h3>userIdleStatusChanged (bool isIdle)</h3>
<p>emitted when the use is idle / no longer idle</p>
<pre>status: none</pre>
<h3>actionAboutToHappen (enum action)</h3>
<p>registered vetoers MUST respond to this signal using vetoACK, vetoNAK, vetoWait
with ten seconds otherwise they are kicked out as vetoers (to work around
broken apps)</p>
<pre>status: complete</pre>
<p>enum action is one of:
<h3>performingAction (enum action)</h3>
<p>Just a signal, no response is required, nor allowed.</p>
<pre>status: complete</pre>
<h2>Client Signals</h2>
<h3>vetoActionRegisterInterest (enum action, gchar localizedAppname)</h3>
<p>Used for signing up for vetoing a specific action</p>
<pre>status: complete</pre>
<h3>vetoActionUnregisterInterest (enum action)</h3>
<p>Used to unregister the applications interest in a specific action.
Note: GPM will automatically unregister clients that disconnect from the bus</p>
<pre>status: semi-complete, assumes ALL</pre>
<h3>vetoACK (enum action)</h3>
Vetoer allows a specific action to take place
<pre>status: complete</pre>
<h3>vetoNACK (enum action, gchar localizedReason)</h3>
<p>Vetoer doesn't allow a specific action to take place; g-p-m SHOULD display a
notification to the user that the action cannot take place and what the vetoing
application is.</p>
<pre>status: complete</pre>
<h3>vetoWait (enum action, int timeout, gchar localizedReason)</h3>
<p>Vetoer asks for a timeout of timeout ms before g-p-m should try to perform the
action again. It is legal for the vetoer to call vetoACK before the timeout.
If the (accumulated) delay amounts to more than one second, g-p-m SHOULD
display a notification about who is blocking the action.</p>
<pre>status: not present yet</pre>
On startup
vetoActionRegisterInterest (SCREENSAVE, "Totem media player")
And then when G-P-M wants to screensave, it issues totem with the question:
actionAboutToHappen (SCREENSAVE)
And if the video is playing fullscreen, then totem would reply:
vetoNACK (SCREENSAVE, "Fullscreen Video")
And GPM would not screen-save.
When totem had finished playing fullscreen it could do
VetoActionUnregisterInterest (SCREENSAVE)
If a document if unsaved:
vetoActionRegisterInterest (LOGOFF | SHUTDOWN | RESTART, "Abiword Word Processor")
When want to logoff:
actionAboutToHappen (LOGOFF)
vetoWait (LOGOFF, 500, "Saving temp. file so we can recover when we startup")
Save_abiword_document ()
When the document is fully saved:
VetoActionUnregisterInterest (ALL)
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY date "<date>11 July, 2005</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY package "gnome-power-manager">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
<holder>Richard Hughes</holder>
<refpurpose>gnome power manager userpace daemon</refpurpose>
<para>This manual page documents briefly the
<command>&package;</command> command.</para>
<para><command>&package;</command> is the backend program of the GNOME power management infrastructure</para>
<para>This program follows the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below. </para>
<para>Show summary of options.</para>
<para>Show extra debugging.</para>
<title>SEE ALSO</title>
<para>gnome-power-preferences (1).</para>
<para>The programs are documented fully on .</para>
<para>This manual page was written by Oliver Grawert <email></email> for
the <productname>Debian</productname> system.
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
[Desktop Entry]
_Name=GNOME Power Preferences
_Comment=Configure power management
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or is:
manpage.1: manpage.sgml