[Pommed-commits] r400 - trunk

[jblache at alioth.debian.org]

Author: jblache
Date: 2007-12-01 13:01:30 +0000 (Sat, 01 Dec 2007)
New Revision: 400

Modified:
   trunk/INSTALL
Log:
Document video switch helper feature in INSTALL.


Modified: trunk/INSTALL
===================================================================
--- trunk/INSTALL	2007-12-01 12:40:20 UTC (rev 399)
+++ trunk/INSTALL	2007-12-01 13:01:30 UTC (rev 400)
@@ -17,7 +17,7 @@
  - libdbus
  - libasound
  - libaudiofile
- - libofapi (aka oflib); see below
+ - libofapi aka oflib (PowerMac machines only, see below)
  - eject
 
 gpomme requires:
@@ -61,23 +61,40 @@
  - copy wmpomme somewhere in your PATH (/usr/bin)
 
 
-Using
------
+Using pommed
+------------
 
-pommed
-------
-
 Launch pommed at startup, a simple init script will do.
 
 
-gpomme
-------
+Using gpomme and wmpomme
+------------------------
 
-Launch gpomme at session startup, using whatever interface your desktop
-environment provides for that.
+ - gpomme: launch gpomme at session startup, using whatever interface your
+   desktop environment provides for that.
 
+ - wmpomme: run wmpomme and add it to your dock.
 
-wmpomme
--------
+Both gpomme and wmpomme are responsible for running a user-provided helper
+when the video switch button is pressed. This helper is responsible for
+activating/deactivating the external video output.
 
-Run wmpomme and add it to your dock.
+The helper can be set system-wide and overriden on a per-user basis:
+ - if $HOME/.videoswitch exists, is readable and executable by the running
+   user, it is executed;
+ - otherwise, if /etc/pommed/videoswitch exists, is readable and executable
+   by the running user, it is executed.
+
+The program is invoked without arguments, and argv[0] is "videoswitch".
+
+The videoswitch helper can be anything you want: shell script, perl/python
+script or a plain binary; anything executable. It is up to the script or
+program to perform any housekeeping/statekeeping that is necessary.
+
+If you want to run urandr or grandr, you can just symlink it as
+/etc/pommed/videoswitch or $HOME/.videoswitch.
+
+As different machines require different scripts, pommed can't ship a default
+script (there's no one-size-fits-all, unfortunately). If you write a nice
+script for your machine and would like to have it shipped with pommed as an
+example, mail it to me with a proper license and the machine model.