Add compilation notes into README file.
[lxde/lxpanel.git] / README
CommitLineData
2afc7a16
HJYP
1LXPanel is a lightweight X11 desktop panel.
2
6b697e41
AG
3To build this program you need some development packages:
4 libtool 2.2 or newer, intltool, libgtk 2.18 or newer, libmenu-cache,
5 libfm-gtk 1.2 or newer, wireless-tools, libxml-2.0, libwnck.
6Optional development packages may be required to build some modules:
7 libalsasound, libindicator 0.3.0.
8
f6dd866e
AG
9To install this program, three other packages are needed:
10 menu-cache, libfm-gtk, lxmenu-data.
f3afc111
HJYP
11Please install them before installing lxpanel.
12
2afc7a16
HJYP
13There are 2 programs contained in the package.
14
151. lxpanel: the panel
16
172. lxpanelctl: the controller of lxpanel, can be used to control lxpanel in
822b8086 18 other programs. The best place to use lxpanelctl is by far
2afc7a16
HJYP
19 the numerous key bindings provided by window managers.
20 When the key combination is pressed, call lxpanelctl to popup
21 system menu, or to open run dialog in lxpanel.
22 Run lxpanelctl without any argument to see what command it
23 currently recognizes.
24
5cb62824
FC
25
26About Netstat and Netstatus plugins:
27
d907472a
JH
281. netstatus was ported from netstatus panel applet of GNOME Project. This
29 plugin has good support on Linux/BSD/other UNIX, and it is released under
30 GNU GPL. (the same as LxDE)
5cb62824 31
d907472a
JH
322. netstat is a new plugin written by LxDE developers as the lightweight
33 replacement of netstatus plugin. It aims to be more usable and resource
34 efficient. At the current stage, netstat runs only on Linux.
85973eb9 35
f6dd866e 36
85973eb9
MR
37About theming & lxpanel:
38
391. In future, hardcoding should not be used for icon lookup. Instead, use Gtk's built-in functions to handle icon lookup. If necessary, provide a fallback (hardcoded) icon.
40
412. Current icon names that can be themed specifically for lxpanel include:
42 *"lxpanel-background"
43 *"clock"
44 *"capslock-on"
45 *"capslock-off"
46 *"numlock-on"
47 *"numlock-off"
48 *"scrllock-on"
49 *"scrllock-off"
50 *"wincmd"
51 *"ns-lock"
52 *possibly more, as yet unfound.
53
f6dd866e 543. You can also set theme for any plugin specifically using it's widget name
7a5d57c2 55 which is equal to plugin type.
f6dd866e
AG
56
574. There is a specific RC file which can be loaded by LXPanel, it can be placed
58 as ~/.config/lxpanel/$PROFILE/gtkrc, where $PROFILE is the profile used on
59 the LXPanel start.
60
85973eb9 61There are also a substantial amount of others, but they use the icon naming specification.
f6dd866e
AG
62
63
64About keyboard options translations in xkb plugin:
65
66The 'xkb' plugin can use translations from language packs that are present
67 in many distributions. To use it you should have language pack which
68 includes "xkeyboard-config" translations.