wmii/cmd/wm/wmii.1

76 lines
1.8 KiB
Groff

.TH WMII 1 wmii-4
.SH NAME
wmii \- window manager improved 2
.SH SYNOPSIS
.B wmii
.SH DESCRIPTION
.SS Overview
.B wmii
is a script that launches the wmii window manager and its various utilities and
makes sure that they are configured for use.
.SS Actions
An action is a shell script in the default setup, but it can actually be
any executable file. It is executed usually by selecting it from the
actions menu.
You can customize an action by copying it from the global action
directory CONFPREFIX/wmii-4 to $HOME/.wmii-4 and then editing the copy to
fit your needs. Of course you can also create your own actions there; make
sure that they are executable.
.P
Here is a list of the default actions:
.TP 2
quit
leave the window manager nicely
.TP 2
status
periodically print date and load average to the bar
.TP 2
welcome
display a welcome message that contains the wmii tutorial
.TP 2
wmiirc
configure wmii
.SS Configuration
If you feel the need to change the default configuration, then customize (as
described above) the
.B wmiirc
action. This action is executed at the end of the
.B wmii
script and does all the work of setting up the window manager, the key
bindings, the bar labels, etc.
.SH FILES
.TP
/tmp/ns.$USER.$DISPLAY/wmii
The wmii socket file which provides a 9P service.
.TP
CONFPREFIX/wmii-4
Global action directory.
.TP
$HOME/.wmii-4
User-specific action directory. Actions are first searched here.
.SH ENVIRONMENT
.TP
HOME, DISPLAY
See the section
.B FILES
above.
.P
The following variables are set and exported within
.B wmii
and thus can be used in actions:
.TP
PATH, OLD_PATH
.B wmii
adds the local and global actions directory to the front of the existing PATH.
The original value is saved in OLD_PATH.
.TP
WMII_ADDRESS
Socket file of
.BR wmiiwm (1).
Used by
.BR wmiir (1).
.SH SEE ALSO
.BR wmiiwm (1),
.BR wmiimenu (1),
.BR wmiir (1)