Adding upstream version 0.8.0.
[debian/lxpanel.git] / README
CommitLineData
6cc5e1a6
DB
1LXPanel is a lightweight X11 desktop panel.
2
19ab5cea
AG
3To build this program you need some development packages:
4 libtool 2.2 or newer, intltool, libgtk 2.18 or newer,
f7ecd6ce 5 libfm-gtk 1.2 or newer, libwnck, libkeybinder.
19ab5cea
AG
6Optional development packages may be required to build some modules:
7 libmenu-cache,
8 libalsasound ('volumealsa' plugin isn't built if missing),
9 libindicator 0.3.0 ('indicator' plugin isn't built if missing),
10 wireless-tools (required to build 'netstat' plugin),
11 libxml-2.0 (required to build 'weather' plugin).
12
6b775dbb
AG
13To install this program, three other packages are needed:
14 menu-cache, libfm-gtk, lxmenu-data.
7486d297
DB
15Please install them before installing lxpanel.
16
6cc5e1a6
DB
17There are 2 programs contained in the package.
18
191. lxpanel: the panel
20
212. lxpanelctl: the controller of lxpanel, can be used to control lxpanel in
7486d297 22 other programs. The best place to use lxpanelctl is by far
6cc5e1a6
DB
23 the numerous key bindings provided by window managers.
24 When the key combination is pressed, call lxpanelctl to popup
25 system menu, or to open run dialog in lxpanel.
26 Run lxpanelctl without any argument to see what command it
27 currently recognizes.
28
29
30About Netstat and Netstatus plugins:
31
321. netstatus was ported from netstatus panel applet of GNOME Project. This
33 plugin has good support on Linux/BSD/other UNIX, and it is released under
34 GNU GPL. (the same as LxDE)
35
362. netstat is a new plugin written by LxDE developers as the lightweight
37 replacement of netstatus plugin. It aims to be more usable and resource
38 efficient. At the current stage, netstat runs only on Linux.
aaccad27 39
6b775dbb 40
aaccad27
AL
41About theming & lxpanel:
42
f7ecd6ce
AG
431. LXPanel tries to use as much themed icons as possible. Fallback icons
44 may be also provided if they are placed into $(datadir)/lxpanel/images
45 directory. Few plugins already provide their fallback icons.
aaccad27
AL
46
472. Current icon names that can be themed specifically for lxpanel include:
48 *"lxpanel-background"
49 *"clock"
50 *"capslock-on"
51 *"capslock-off"
52 *"numlock-on"
53 *"numlock-off"
54 *"scrllock-on"
55 *"scrllock-off"
f7ecd6ce 56 *"window-manager"
aaccad27 57 *"ns-lock"
f7ecd6ce 58 *"cpufreq-icon"
aaccad27
AL
59 *possibly more, as yet unfound.
60
f7ecd6ce
AG
61There are also a substantial amount of others, but they use the icon naming specification.
62
6b775dbb
AG
633. You can also set theme for any plugin specifically using it's widget name
64 which is equal to plugin type.
65
664. There is a specific RC file which can be loaded by LXPanel, it can be placed
67 as ~/.config/lxpanel/$PROFILE/gtkrc, where $PROFILE is the profile used on
68 the LXPanel start.
69
6b775dbb
AG
70
71About keyboard options translations in xkb plugin:
72
73The 'xkb' plugin can use translations from language packs that are present
74 in many distributions. To use it you should have language pack which
75 includes "xkeyboard-config" translations.