[Tkabber-dev] r114 - trunk/plugins/green

tkabber-svn at jabber.ru tkabber-svn at jabber.ru
Tue Jul 29 17:49:39 MSD 2008


Author: kostix
Date: 2008-07-29 17:49:39 +0400 (Tue, 29 Jul 2008)
New Revision: 114

Modified:
   trunk/plugins/green/INSTALL
   trunk/plugins/green/README
   trunk/plugins/green/swsusp-tkabber.tcl
Log:
green: Minor documentation updates.


Modified: trunk/plugins/green/INSTALL
===================================================================
--- trunk/plugins/green/INSTALL	2008-07-29 13:48:13 UTC (rev 113)
+++ trunk/plugins/green/INSTALL	2008-07-29 13:49:39 UTC (rev 114)
@@ -1,8 +1,13 @@
-Install tkwinpm Tcl extension which can be found at
+To use this plugin in Microsoft Windows install
+"winpm" Tcl extension which can be found at
 http://tkwinpm.googlecode.com.
 
-As usually, copy this directory under the ~/.tkabber/plugins directory
-so that you get a hierarchy like this:
+To install the plugin, as usually, copy this directory
+under the Tkabber's plugins directory (which is
+"~/.tkabber/plugins" on Unix,
+"%APPDATA%\Tkaber\plugins" on Windows and
+"~/Application/Application Support/Tkabber/plugins" on Mac OS)
+so that you get a hierarchy like this (Unix paths are shown):
   ~/.tkabber/plugins
   ~/.tkabber/plugins/green/
   ~/.tkabber/plugins/green/green.tcl
@@ -11,3 +16,7 @@
 Visit the Cutsomize->Plugins->Green group of settings.
 Consult the README file for the details about using this plugin.
 
+On Windows it will just work provided "winpm" Tcl extension is
+available for Tkabber; on X Window-based systems additional
+setup is required -- please consult the README file for details.
+

Modified: trunk/plugins/green/README
===================================================================
--- trunk/plugins/green/README	2008-07-29 13:48:13 UTC (rev 113)
+++ trunk/plugins/green/README	2008-07-29 13:49:39 UTC (rev 114)
@@ -20,7 +20,7 @@
 facilities the underlying OS provides. Currently this plugin
 supports Windows 2000 and above through the usage of external
 Tcl/Tk extension and X Window-based systems (namely, Linux)
-through the usage of special "actuator script".
+through the usage of special "activator script".
 
 In any case, this plugin should be installed as any other
 Tkabber plugin first.
@@ -65,7 +65,7 @@
 this is done via some specific shell scripts.
 
 To handle this kind of setup this plugin provides one special
-"actuator script" which uses the ability of Tcl/Tk programs
+"activator script" which uses the ability of Tcl/Tk programs
 running on the same X display to communicate by sending Tcl
 scripts to each other.
 
@@ -73,7 +73,7 @@
 the plugin directory. It's not required by the plugin itself and
 can be freely relocated, if needed.
 
-The actuator script accepts one mandatory command-line parameter
+The activator script accepts one mandatory command-line parameter
 which specifies the power management event to report; its
 acceptable values are "suspend" or "resume", which are
 self-explanatory.  It is up to the user to arrange for this
@@ -106,13 +106,13 @@
 
 * Since a Tk application can connect to just one display at a
   time, if you have several displays with running instances of
-  Tkabber you will need to arrange for the actuator script to
+  Tkabber you will need to arrange for the activator script to
   run several times -- one per display -- each time with
   appropriate environment settings (see above).
 
 * Tcl interpreters running instances of Tkabber are identified
   by "Tk application names" they register on the display.
-  The actuator script contacts those interpreters whose names
+  The activator script contacts those interpreters whose names
   match the "tkabber*" glob-style pattern. Usually this is
   exactly what is needed but if the script appears to work but
   its actions remain unnoticed by some instance of Tkabber,
@@ -122,9 +122,16 @@
   the "tkabber*" pattern, either fix the Tkabber startup script
   (via the "-name Tkabber" command line parameter to the wish
   Tcl/Tk shell, for instance) or adjust the pattern in the
-  actuator script.
+  activator script.
 
+* Do not rename (or symlink) the activator script so that its
+  new name matches the "tkabber*" glob-style pattern -- this
+  will cause the activator script to count itself as a running
+  instance of Tkabber which, in turn, will force it to try to
+  inform itself about the power management event being reported;
+  this will fail with an error.
 
+
 III. Configuration
 
 This plugin can be configured via the Customize interface of

Modified: trunk/plugins/green/swsusp-tkabber.tcl
===================================================================
--- trunk/plugins/green/swsusp-tkabber.tcl	2008-07-29 13:48:13 UTC (rev 113)
+++ trunk/plugins/green/swsusp-tkabber.tcl	2008-07-29 13:49:39 UTC (rev 114)
@@ -1,6 +1,6 @@
 #! /usr/bin/env wish
 # $Id$
-# This is an "actuator" script for the Tkabber "green" plugin
+# This is the "activator" script for the Tkabber "green" plugin
 # intended to work on X Window-based systems (namely, Linux).
 # It finds all the running instance of Tkabber on the current
 # display and directs the "green" plugin loaded in each of them



More information about the Tkabber-dev mailing list