Adding upstream version 0.5.5.
[debian/lxpanel.git] / man / lxpanel.1
1 .\"     Title: LXPANEL
2 .\"    Author: Ying-Chun Liu
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4 .\"      Date: March  2, 2008
5 .\"    Manual: http://LXDE.org
6 .\"    Source: http://LXDE.org
7 .\"  Language: English
8 .\"
9 .TH "LXPANEL" "1" "March 2, 2008" "http://LXDE\&.org" "http://LXDE.org"
10 .\" -----------------------------------------------------------------
11 .\" * (re)Define some macros
12 .\" -----------------------------------------------------------------
13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 .\" toupper - uppercase a string (locale-aware)
15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16 .de toupper
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18 \\$*
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20 ..
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 .de SH-xref
25 .ie n \{\
26 .\}
27 .toupper \\$*
28 .el \{\
29 \\$*
30 .\}
31 ..
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35 .de1 SH
36 .\" put an extra blank line of space above the head in non-TTY output
37 .if t \{\
38 .sp 1
39 .\}
40 .sp \\n[PD]u
41 .nr an-level 1
42 .set-an-margin
43 .nr an-prevailing-indent \\n[IN]
44 .fi
45 .in \\n[an-margin]u
46 .ti 0
47 .HTML-TAG ".NH \\n[an-level]"
48 .it 1 an-trap
49 .nr an-no-space-flag 1
50 .nr an-break-flag 1
51 \." make the size of the head bigger
52 .ps +3
53 .ft B
54 .ne (2v + 1u)
55 .ie n \{\
56 .\" if n (TTY output), use uppercase
57 .toupper \\$*
58 .\}
59 .el \{\
60 .nr an-break-flag 0
61 .\" if not n (not TTY), use normal case (not uppercase)
62 \\$1
63 .in \\n[an-margin]u
64 .ti 0
65 .\" if not n (not TTY), put a border/line under subheading
66 .sp -.6
67 \l'\n(.lu'
68 .\}
69 ..
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73 .de1 SS
74 .sp \\n[PD]u
75 .nr an-level 1
76 .set-an-margin
77 .nr an-prevailing-indent \\n[IN]
78 .fi
79 .in \\n[IN]u
80 .ti \\n[SN]u
81 .it 1 an-trap
82 .nr an-no-space-flag 1
83 .nr an-break-flag 1
84 .ps \\n[PS-SS]u
85 \." make the size of the head bigger
86 .ps +2
87 .ft B
88 .ne (2v + 1u)
89 .if \\n[.$] \&\\$*
90 ..
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94 .de BB
95 .if t \{\
96 .sp -.5
97 .br
98 .in +2n
99 .ll -2n
100 .gcolor red
101 .di BX
102 .\}
103 ..
104 .de EB
105 .if t \{\
106 .if "\\$2"adjust-for-leading-newline" \{\
107 .sp -1
108 .\}
109 .br
110 .di
111 .in
112 .ll
113 .gcolor
114 .nr BW \\n(.lu-\\n(.i
115 .nr BH \\n(dn+.5v
116 .ne \\n(BHu+.5v
117 .ie "\\$2"adjust-for-leading-newline" \{\
118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119 .\}
120 .el \{\
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122 .\}
123 .in 0
124 .sp -.5v
125 .nf
126 .BX
127 .in
128 .sp .5v
129 .fi
130 .\}
131 ..
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135 .de BM
136 .if t \{\
137 .br
138 .ll -2n
139 .gcolor red
140 .di BX
141 .\}
142 ..
143 .de EM
144 .if t \{\
145 .br
146 .di
147 .ll
148 .gcolor
149 .nr BH \\n(dn
150 .ne \\n(BHu
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152 .in 0
153 .nf
154 .BX
155 .in
156 .fi
157 .\}
158 ..
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
163 .nh
164 .\" disable justification (adjust text to left margin only)
165 .ad l
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
169 .SH "Name"
170 lxpanel \- a lightweight GTK2\-based panel for the LXDE desktop\&.
171 .SH "Synopsis"
172 .fam C
173 .HP \w'\fBlxpanel\fR\ 'u
174 \fBlxpanel\fR
175 .fam
176 .SH "DESCRIPTION"
177 .PP
178 This manual page documents briefly the
179 \fBlxpanel\fR
180 command\&.
181 .PP
182 \fBlxpanel\fR
183 is a program that provides a panel for the desktop, usually for LXDE\&. It is a lightweight GTK+ 2\&.x based desktop panel\&.
184 .PP
185 .PP
186 \fBFeatures\fR
187 .sp
188 .RS 4
189 .ie n \{\
190 \h'-04'\(bu\h'+03'\c
191 .\}
192 .el \{\
193 .sp -1
194 .IP \(bu 2.3
195 .\}
196 User\-friendly application menu automatically generated from
197 \FC\&.desktop\F[]
198 files on the system\&.
199 .RE
200 .sp
201 .RS 4
202 .ie n \{\
203 \h'-04'\(bu\h'+03'\c
204 .\}
205 .el \{\
206 .sp -1
207 .IP \(bu 2.3
208 .\}
209 Launcher bar (small icons clicked to launch apps)
210 .RE
211 .sp
212 .RS 4
213 .ie n \{\
214 \h'-04'\(bu\h'+03'\c
215 .\}
216 .el \{\
217 .sp -1
218 .IP \(bu 2.3
219 .\}
220 Task bar supporting ICCCM/EWMH `urgency\' hint (Pidgin IM windows can flash on new incoming messages)
221 .RE
222 .sp
223 .RS 4
224 .ie n \{\
225 \h'-04'\(bu\h'+03'\c
226 .\}
227 .el \{\
228 .sp -1
229 .IP \(bu 2.3
230 .\}
231 Notification area (system tray)
232 .RE
233 .sp
234 .RS 4
235 .ie n \{\
236 \h'-04'\(bu\h'+03'\c
237 .\}
238 .el \{\
239 .sp -1
240 .IP \(bu 2.3
241 .\}
242 Digital clock
243 .RE
244 .sp
245 .RS 4
246 .ie n \{\
247 \h'-04'\(bu\h'+03'\c
248 .\}
249 .el \{\
250 .sp -1
251 .IP \(bu 2.3
252 .\}
253 Run dialog (type command to run, without opening a terminal )
254 .RE
255 .sp
256 .RS 4
257 .ie n \{\
258 \h'-04'\(bu\h'+03'\c
259 .\}
260 .el \{\
261 .sp -1
262 .IP \(bu 2.3
263 .\}
264 Net status icon plug\-in (optional)
265 .RE
266 .sp
267 .RS 4
268 .ie n \{\
269 \h'-04'\(bu\h'+03'\c
270 .\}
271 .el \{\
272 .sp -1
273 .IP \(bu 2.3
274 .\}
275 Volume control plug\-in (optional)
276 .RE
277 .sp
278 .RS 4
279 .ie n \{\
280 \h'-04'\(bu\h'+03'\c
281 .\}
282 .el \{\
283 .sp -1
284 .IP \(bu 2.3
285 .\}
286 lxpanelctl, an external controller lets you control lxpanel in other programs\&. For example, "lxpanelctl run" will show the Run dialog in lxpanel, and "lxpanelctl menu" will show the application menu\&. This is useful in key bindings provided by window managers\&.
287 .RE
288 .sp
289 .RE
290 .SH "OPTIONS"
291 .PP
292 This program follows the usual
293 GNU
294 command line syntax, with long options starting with two dashes (`\-\')\&. A summary of options is included below\&.
295 .PP
296 \fB\-h\fR \fB\-\-help\fR
297 .RS 4
298 Print help on the options\&.
299 .RE
300 .PP
301 \fB\-v\fR \fB\-\-version\fR
302 .RS 4
303 Print the program version\&.
304 .RE
305 .PP
306 \fB\-\-log \fR\fB\fIlevel\fR\fR
307 .RS 4
308 Set the logging level in the range 0 (silent) through 5 (verbose)\&.
309 .RE
310 .PP
311 \fB\-p \fR\fB\fINAME\fR\fR, \fB\-\-profile \fR\fB\fINAME\fR\fR
312 .RS 4
313 Set the profile to be loaded\&.
314 .RE
315 .SH "FILES"
316 .PP
317 \FC~/\&.config/lxpanel/\fIPROFILE\fR\F[]
318 .RS 4
319 config file, can be edited by preference dialog\&.
320 .RE
321 .SH "SEE ALSO"
322 .PP
323 lxsession (1), lxpanelctl (1)\&.
324 .SH "AUTHOR"
325 .PP
326 This manual page was written by paulliu
327 \FCgrandpaul@gmail\&.com\F[]
328 for the
329 Debian
330 system (but may be used by others)\&. Permission is granted to copy, distribute and/or modify this document under the terms of the
331 GNU
332 General Public License, Version 2 any later version published by the Free Software Foundation\&.
333 .PP
334 On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL\&.
335 .SH "Author"
336 .PP
337 \fBYing\-Chun Liu\fR
338 .RS 4
339 Author.
340 .RE
341 .SH "Copyright"
342 .br
343 Copyright \(co 2008 paulliu
344 .br