Configuration dialog to the 'volume' plugin.
[lxde/lxpanel.git] / README
CommitLineData
2afc7a16
HJYP
1LXPanel is a lightweight X11 desktop panel.
2
6b697e41 3To build this program you need some development packages:
2e836237 4 libtool 2.2 or newer, intltool, libgtk 2.18 or newer,
f7a4447c 5 libfm-gtk 1.2 or newer, libwnck, libkeybinder.
6b697e41 6Optional development packages may be required to build some modules:
d607ba2e
AG
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).
6b697e41 12
f6dd866e
AG
13To install this program, three other packages are needed:
14 menu-cache, libfm-gtk, lxmenu-data.
f3afc111
HJYP
15Please install them before installing lxpanel.
16
2afc7a16
HJYP
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
822b8086 22 other programs. The best place to use lxpanelctl is by far
2afc7a16
HJYP
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
5cb62824
FC
29
30About Netstat and Netstatus plugins:
31
d907472a
JH
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)
5cb62824 35
d907472a
JH
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.
85973eb9 39
f6dd866e 40
85973eb9
MR
41About theming & lxpanel:
42
f7a4447c
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.
85973eb9
MR
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"
f7a4447c 56 *"window-manager"
85973eb9 57 *"ns-lock"
f7a4447c 58 *"cpufreq-icon"
85973eb9
MR
59 *possibly more, as yet unfound.
60
f7a4447c
AG
61There are also a substantial amount of others, but they use the icon naming specification.
62
f6dd866e 633. You can also set theme for any plugin specifically using it's widget name
7a5d57c2 64 which is equal to plugin type.
f6dd866e
AG
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
f6dd866e
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.