Clean.man

David Taylor (n9506769@garbo.nepean.uws.edu.au)
Tue, 13 Oct 1998 02:59:49 +1000 

This is a multi-part message in MIME format.
--------------C7728962EC779013DDB62035
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit

Here ya go.

I know it seems like I took a while to do it.  I just started looking
thru it an hour ago whilst I was online.  If there are any others you'd
like me to take a look at just let me know.

I love helping, it's the best way to learn.

Please let me know if there's more that needs to be done to this.  As
far as I could tell there were no new features added to Clean (I looked
in the ChangeLog and the FAQ).

-- 
Regards,
David Taylor

+============================================+
| University of Western Sydney - Nepean      |
| dtaylor@cit.nepean.uws.edu.au              |
| http://www.cit.nepean.uws.edu.au/~dtaylor/ |
+============================================+
--------------C7728962EC779013DDB62035
Content-Type: application/x-troff-man; name="Clean.man"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline; filename="Clean.man"

.\" t
.\" @(#)Clean.1		10/10/98
.TH Clean 1.5 "Oct 10 1998"
.UC
.SH NAME
\fBClean\fP \- the AfterStep desktop clutter reduction module
.SH SYNOPSIS
\fBClean\fP is spawned by AfterStep, so no command line invocation will work.
>From within the \fIautoexec\fP file Clean is spawned as follows:
.nf
.sp
        Module  "I"     Clean
.sp
.fi
or from within an afterstep menu file by 'Animate':
.nf
.sp
% cat "~/GNUstep/Library/AfterStep/start/Modules/Clean"
        Module "Clean" Clean
        MiniPixmap "mini-as.xpm"
.fi

.SH DESCRIPTION
The \fBClean\fP module performs actions on windows which have not had
the keyboard focus for a specific length of time. This is intended to
help alleviate the problem of leaving programs running in unused
portions of your desktop.

.SH INITIALIZATION
\fBClean\fP reads ~/GNUstep/Library/AfterStep/clean file when it starts up. 
Entries in this file describe the time-outs and the actions to take.  For
example, "*Clean 3600 Iconify".

If the \fBClean\fP executable is linked to another name, then another module 
can be started with a different configuration.  For example,

% "ln -s Clean OtherClutter"

Then another module called OtherClutter can be started. This way multiple
clutter-reduction programs can be used, each with a different name and
configuration.

.SH INVOCATION
\fBClean\fP can be invoked from the \fIautoexec\fP file and from a menu as 
shown earlier.  It can also be bound to a keystroke or a mouse button in a
similar fashion to that shown earlier for the menu.

.SH CONFIGURATION OPTIONS
\fBClean\fP reads ~/GNUstep/Library/AfterStep/clean file when it starts up,
and looks for lines similar to "*Clean 3600 Iconify". The format
of these lines is "*Clean [time] [command]", where command is any
AfterStep built-in command, and time is the time in seconds between 
when a window looses focus and when the command is executed. At most 
3 actions can be specified.


.SH AUTHORS
Robert Nation 
.nf
David Taylor <dtaylor@cit.nepean.uws.edu.au>


--------------C7728962EC779013DDB62035--