Themes
[xdock.git] / README
blobb0070cfe96053f60f7506ee0fee28080ca8a863c
1 xdock
2 =====
4 __xdock__ is a software that emulates the Window Maker docks, with the following 
5 differences:
7 * __runs in any window manager__
8 * __client/server__ - it works in a client/server way, where a server sits in 
9                       the right side of the screen, and the docks are clients 
10                       that connect to that server;
11 * __easy to program__ - programming the Window Maker docks was a hard job. But 
12                         xdock provides a API that makes programming much easier!
14 Installing
15 ==========
17 Simple basic UNIX program installation:
19     $ ./configure
20     $ make
21     $ su
22     # make install
23     # ldconfig
25 Just remember that it requires both Imlib and Xlib to compile.
27 Running
28 =======
30 __xdock__ works as a client/server: the server is the main program, that sits
31 on the right side of the screen, and the clients are the docks, that connect
32 to the server.
34 To start a server, simply type:
36     xdockserver &
38 this will put the server in background. If your window manager already has a 
39 taskbar, you might want to skip a few pixels, typing:
41     xdockserver -y 32 &
43 Then, start a client, such as:
45     xdmemory &
47 that will start a example dock and connect it to the server.
49 Programming docks
50 =================
52 Programming docks is very simple. You can follow the tutorial 
53 (<http://xdock.sourceforge.net/tutorial.html>) and the API documentation is in
54 (<http://xdock.sourceforge.net/api.html>).