." Text automatically generated by txt2man-1.4.7
.TH rbworkspace  "Februar 20, 2004" "" ""

.SH ABOUT

rbworkspace is a small ruby-script that could run
in background and will recognize any workspacechanges.
if the workspace changes it will fire an action to
do some stuff which is completly free. the defaultaction
is to display current workspace via osd_cat on the screen,
but one could do anything as an action.
.SH SYNOPSIS
.nf
.fam C

\fBrbworkspace\fP [-h] [-dkftm] [-l] [\fIscript\fP]
.fam T
.fi
.SH OPTIONS

.TP
.B
--help
-h        displays this small help
.TP
.B
--daemon
-d        start \fBrbworkspace\fP as a daemon
to run in background. this will
create a pidfile which could be
used to kill the process.
.TP
.B
--fifo
-f        create and use a fifofile. look
at the fifo section
.TP
.B
--kill
-k        kill a running \fBrbworkspace\fP
instance and exit.
.TP
.B
--load
-l        load a rubyscript to change the
action which is called on
workspace-changes
.TP
.B
--timeout
-t        set the given timeout
.TP
.B
--mode
-m        runs \fBrbworkspace\fP in one of these
modes:
.RS
.PP
"change" -> action is called
every ws-change
"timeout" -> action is called
every x seconds
"off" -> no action is called
.SH ACTIONS

examples / description for such a action-\fIscript\fP
.PP
-- action.rb -----------------------------------------
.PP
modules RBWS
.PP
.nf
.fam C
   def action(number, name, count)
     `echo #{number + 1}/#{count}`
   end
.fam T
.fi
end
.PP
-- end of action.rb ----------------------------------
.PP
to use this do a:
.PP
.nf
.fam C
   rbworkspace -l action.rb

.fam T
.fi
this will then echo the current workspace to the shell
where \fBrbworkspace\fP was started from. see the both
commited actionscripts too for do a lot more than just
echoing text :)
.SH FIFO

a fifo-file is created on demand to control \fBrbworkspace\fP.
with this facility one is able to load new modules, to
change the mode and to stop and exit \fBrbworkspace\fP by
sending commands to this fifo just through "echo" or
whatever. this file is placed at
.PP
.nf
.fam C
   ~/.rbworkspace.fifo

.fam T
.fi
commands:
.PP
.nf
.fam C
   exit | quit         : quit rbworkspace
   load action         : loads the current action
   mode                : set the mode to one of
                         "change" -> action each workspacechange
                         "timeout" -> action each amount of secs
                         "off" -> no actions at all
   timeout secs        : set the timeout in "timeout"-mode


.fam T
.fi
eg:
.PP
.nf
.fam C
   echo "load bgperws.rb" > ~/.rbworkspace.fifo

.nf
.fam C
     -> load a bgperws.rb - action that changes bg on each
     workspace

.fam T
.fi
.RS
echo "quit" > ~/.rbworkspace.fifo
.SH AUTHOR

\fBrbworkspace\fP was written 2003 by mathias gumz
<gumz at cs.uni-magdeburg.de>