summaryrefslogtreecommitdiffhomepage
path: root/README
blob: 721811f9c823fb8428abc48b13b998a04efc6f45 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
XMobar - a status bar for the XMonad Window Manager

ABOUT
-----

Xmobar is a minimal status bar for the XMonad Window Manager.

It was inspired by the Ion3 status bar, and supports similar features.
See xmobar.config-sample for a sample configuration.

Try it with:
xmobar xmobar.config-sample

INSTALLATION
------------

tar xvfz xmobar-0.1
runhaskell Setup.lhs configure --prefix=/usr/local
runhaskell Setup.lhs build
runhaskell Setup.lhs haddock (optional for building the code documentation)
runhaskell Setup.lhs install (possibly to be run as root)

Run with:
xmobar /path/to/config $

CONFIGURATION
-------------

See xmobar.config-sample for an example.

For the output template:

- %command% will execute command and print the output. The output may
  contain markups to change the characters' color.

- <fc=#FF0000>string</fc> will print "string" with #FF0000 color (red).

Other configuration options:

font: Name of the font to be used
bgColor: Backgroud color
fgColor: Default font color
xPos: x position (origin in the upper left corner) of the XMobar window 
yPos: y position
width: width of the XMobar window 
height: height
align: text alignment 
refresh: Refresh rate in tenth of seconds
commands: For setting the options of the programs to run (optional)
sepChar: The character to be used for indicating commands in the
         output template (default '%')
template: The output template 


AUTHOR
------

Andrea Rossato <andrea.rossato@unibz.it>


LINKS
-----

The XMobar home page:
http://gorgias.mine.nu/xmobar/

XMobars darcs repository:
http://gorgias.mine.nu/repos/xmobar/

The XMonad Window Manager
http://xmonad.org