Fixing spelling error in lxpanel.hints.5 manpage.
[debian/lxpanel.git] / debian / manpages / lxpanel.hints.5
1 .\" Information collected from source code
2 .TH lxpanel.hints 5 "October 2010" "M E Andersson" ""
3
4 .SH Name
5 lxpanel.hints \- Configuration hints for lxpanel plugins
6
7 .SH Description
8 .PP
9 This text collects some background information for configuration
10 of plugins available for \fBlxpanel\fR(1).
11 .PP
12 The templates below use keywords \fIboolean\fR, \fIinteger\fR,
13 and \fIstring\fR to denote the expected type of value for each
14 instance.  A few exceptions below are using explicit values in
15 order to clarify the common usage.
16 .
17 The plugins are introduced by name in a semi\-random fashion.
18 In practice a mixture of different stanzas \fIPlugin\fR are
19 written in the order that they are to produce in the actual
20 panel on the desktop.
21 .
22 .SH Available plugins
23 .
24 .P
25 .B menu
26 .IP
27 Plugin {
28     type = menu
29     Config {
30         name = \fIstring\fR
31         image = \fIstring\fR
32
33         system {
34         }
35
36         separator {
37         }
38
39         item {
40             command = \fIstring\fR
41             image = \fIstring\fR
42         }
43     }
44 .br
45 }
46
47 .P
48 .B dirmenu
49 .IP
50 Plugin {
51     type = dirmenu
52     Config {
53         name = \fIstring\fR
54         image = \fIstring\fR
55         path = \fIstring\fR
56     }
57 .br
58 }
59
60 .P
61 .B taskbar
62 .IP
63 Plugin {
64     type = taskbar
65
66     expand = \fIinteger\fR
67     Config {
68         tooltips = \fIboolean\fR
69         IconsOnly = \fIboolean\fR
70         ShowAllDeska = \fIboolean\fR
71         UseMouseWheel = \fIboolean\fR
72         UseUrgencyHint = \fIboolean\fR
73         FlatButton = \fIboolean\fR
74         GroupedTasks = \fIboolean\fR
75         MaxTaskWidth = \fIinteger\fR
76         spacing = \fIinteger\fR
77     }
78 .br
79 }
80
81 .P
82 .B launchbar
83 .IP
84 Plugin {
85     type = launchbar
86     Button {
87         id = \fIstring\fR
88         image = \fIstring\fR
89         tooltip = \fIstring\fR
90         action = \fIstring\fR
91         terminal = \fIboolean\fR
92     }
93     Button {
94         id = lxde\-logout.desktop
95     }
96 .br
97 }
98
99 .P
100 .B wincmd
101 .IP
102 Plugin {
103     type = wincmd
104     Config {
105         image = \fIstring\fR
106         Button1 = \fIstring\fR
107         Button2 = \fIstring\fR
108         Toggle = \fIstring\fR
109     }
110 .br
111 }
112
113 .P
114 .B space
115 .IP
116 Plugin {
117     type = space
118     Config {
119         Size = \fIinteger\fR
120     }
121 .br
122 }
123
124 .P
125 .B pager
126 .IP
127 Plugin {
128     type = pager
129 .br
130 }
131
132 .P
133 .B batt
134 .IP
135 Plugin {
136     type = batt
137     Config {
138         HideIfNoBattery = bool
139         AlarmCommand = \fIstring\fR
140         AlarmTime = \fIinteger\fR
141         BorderWidth = \fIinteger\fR
142         Size = \fIinteger\fR
143         BackgroundColor = \fIstring\fR
144         ChargingColor1 = \fIstring\fR
145         ChargingColor2 = \fIstring\fR
146         DischargingColor1 = \fIstring\fR
147         DischargingColor2 = \fIstring\fR
148     }
149 .br
150 }
151
152 .P
153 .B kbled
154 .IP
155 Plugin {
156     type = kbled
157     Config {
158         ShowCapsLock = \fIinteger\fR
159         ShowNumLock = \fIinteger\fR
160         ShowScrollLock = \fIinteger\fR
161     }
162 .br
163 }
164
165 .P
166 .B dclock
167 .IP
168 Plugin {
169     type = dclock
170     Config {
171         ClockFmt = \fIstring\fR
172         TooltipFmt = \fIstring\fR
173         Action = \fIstring\fR
174         BoldFont = \fIinteger\fR
175         IconOnly = \fIinteger\fR
176     }
177 .br
178 }
179
180 .P
181 .B cpu
182 .IP
183 Plugin {
184     type = cpu
185 .br
186 }
187
188 .P
189 .B cpufreq
190 .IP
191 Plugin {
192     type = cpufreq
193     Config {
194         Frequency = \fIinteger\fR
195         Governor = \fIstring\fR
196         Remember = \fIboolean\fR
197     }
198 .br
199 }
200
201 .P
202 .B thermal
203 .IP
204 Plugin {
205     type = thermal
206     Config {
207         NormalColor = \fIstring\fR
208         Warning1Color = \fIstring\fR
209         Warning2Color = \fIstring\fR
210         Sensor = \fIstring\fR
211         CustomLevels = \fIinteger\fR
212         Warning1Temp = \fIinteger\fR
213         Warning2Temp = \fIinteger\fR
214         AutomaticSensor = \fIinteger\fR
215     }
216 .br
217 }
218
219 .P
220 .B deskno
221 .IP
222 Plugin {
223     type = deskno
224     Config {
225         BoldFont = \fIinteger\fR
226         WMLabels = \fIinteger\fR
227     }
228 .br
229 }
230
231 .P
232 .B netstatus
233 .IP
234 Plugin {
235     type = netstatus
236     Config {
237         iface = \fIstring\fR
238         configtool = \fIstring\fR
239     }
240 .br
241 }
242
243 .P
244 .B xkb
245 .IP
246 Plugin {
247     type = xkb
248     Config {
249         DisplayType = \fIinteger\fR
250         PerAppLayout = \fIinteger\fR
251         DefaultGroup = \fIinteger\fR
252     }
253 .br
254 }
255 .
256 .SH "Configuration files"
257 .
258 .TP
259 \fI~/.config/lxpanel/"profile\-name"/panels/panel\fR
260 User specific panel specification. The name of the panel
261 is passed to \fBlxpanel\fR using the switch '\-\-profile'.
262 .
263 .TP
264 \fI/usr/share/lxpanel/profile/"profile\-name"/panels/panel\fR
265 .
266 .TP
267 \fI/usr/share/lxpanel/profile/default/panels/panel\fR
268 .
269 .SH See also
270 \fBlxpanel\fR(1), \fBlxpanelctl\fR(1)
271 .SH Bugs
272 There ought to be some.  Do point them out!
273 The Debian package maintainer will take necessary
274 steps and actions.
275
276 .SH Author
277 This text was compiled for Debian GNU/Linux by Mats Erik Andersson.
278 It may be used also by others, but the text underlies the same
279 licensing as \fBlxpanel\fR itself does.