Ship man pages in the GIT and tarball, not just xml files.
[lxde/lxpanel.git] / man / lxpanel.1
1 '\" t
2 .\"     Title: LXPANEL
3 .\"    Author: Ying-Chun Liu
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5 .\"      Date: March  2, 2008
6 .\"    Manual: http://LXDE.org
7 .\"    Source: http://LXDE.org
8 .\"  Language: English
9 .\"
10 .TH "LXPANEL" "1" "March 2, 2008" "http://LXDE\&.org" "http://LXDE.org"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 lxpanel \- a lightweight GTK2\-based panel for the LXDE desktop\&.
32 .SH "SYNOPSIS"
33 .HP \w'\fBlxpanel\fR\ 'u
34 \fBlxpanel\fR
35 .SH "DESCRIPTION"
36 .PP
37 This manual page documents briefly the
38 \fBlxpanel\fR
39 command\&.
40 .PP
41 \fBlxpanel\fR
42 is a program that provides a panel for the desktop, usually for LXDE\&. It is a lightweight GTK+ 2\&.x based desktop panel\&.
43 .PP
44 .PP
45 \fBFeatures\fR
46 .sp
47 .RS 4
48 .ie n \{\
49 \h'-04'\(bu\h'+03'\c
50 .\}
51 .el \{\
52 .sp -1
53 .IP \(bu 2.3
54 .\}
55 User\-friendly application menu automatically generated from
56 \&.desktop
57 files on the system\&.
58 .RE
59 .sp
60 .RS 4
61 .ie n \{\
62 \h'-04'\(bu\h'+03'\c
63 .\}
64 .el \{\
65 .sp -1
66 .IP \(bu 2.3
67 .\}
68 Launcher bar (small icons clicked to launch apps)
69 .RE
70 .sp
71 .RS 4
72 .ie n \{\
73 \h'-04'\(bu\h'+03'\c
74 .\}
75 .el \{\
76 .sp -1
77 .IP \(bu 2.3
78 .\}
79 Task bar supporting ICCCM/EWMH `urgency\*(Aq hint (Pidgin IM windows can flash on new incoming messages)
80 .RE
81 .sp
82 .RS 4
83 .ie n \{\
84 \h'-04'\(bu\h'+03'\c
85 .\}
86 .el \{\
87 .sp -1
88 .IP \(bu 2.3
89 .\}
90 Notification area (system tray)
91 .RE
92 .sp
93 .RS 4
94 .ie n \{\
95 \h'-04'\(bu\h'+03'\c
96 .\}
97 .el \{\
98 .sp -1
99 .IP \(bu 2.3
100 .\}
101 Digital clock
102 .RE
103 .sp
104 .RS 4
105 .ie n \{\
106 \h'-04'\(bu\h'+03'\c
107 .\}
108 .el \{\
109 .sp -1
110 .IP \(bu 2.3
111 .\}
112 Run dialog (type command to run, without opening a terminal )
113 .RE
114 .sp
115 .RS 4
116 .ie n \{\
117 \h'-04'\(bu\h'+03'\c
118 .\}
119 .el \{\
120 .sp -1
121 .IP \(bu 2.3
122 .\}
123 Net status icon plug\-in (optional)
124 .RE
125 .sp
126 .RS 4
127 .ie n \{\
128 \h'-04'\(bu\h'+03'\c
129 .\}
130 .el \{\
131 .sp -1
132 .IP \(bu 2.3
133 .\}
134 Volume control plug\-in (optional)
135 .RE
136 .sp
137 .RS 4
138 .ie n \{\
139 \h'-04'\(bu\h'+03'\c
140 .\}
141 .el \{\
142 .sp -1
143 .IP \(bu 2.3
144 .\}
145 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\&.
146 .RE
147 .sp
148 .SH "OPTIONS"
149 .PP
150 This program follows the usual
151 GNU
152 command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&.
153 .PP
154 \fB\-h\fR \fB\-\-help\fR
155 .RS 4
156 Print help on the options\&.
157 .RE
158 .PP
159 \fB\-v\fR \fB\-\-version\fR
160 .RS 4
161 Print the program version\&.
162 .RE
163 .PP
164 \fB\-\-log \fR\fB\fIlevel\fR\fR
165 .RS 4
166 Set the logging level in the range 0 (silent) through 5 (verbose)\&.
167 .RE
168 .PP
169 \fB\-p \fR\fB\fINAME\fR\fR, \fB\-\-profile \fR\fB\fINAME\fR\fR
170 .RS 4
171 Set the profile to be loaded\&.
172 .RE
173 .SH "FILES"
174 .PP
175 ~/\&.config/lxpanel/\fIPROFILE\fR
176 .RS 4
177 config file, can be edited by preference dialog\&.
178 .RE
179 .SH "SEE ALSO"
180 .PP
181 lxsession (1), lxpanelctl (1)\&.
182 .SH "AUTHOR"
183 .PP
184 This manual page was written by paulliu
185 grandpaul@gmail\&.com
186 for the
187 Debian
188 system (but may be used by others)\&. Permission is granted to copy, distribute and/or modify this document under the terms of the
189 GNU
190 General Public License, Version 2 any later version published by the Free Software Foundation\&.
191 .PP
192 On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL\&.
193 .SH "AUTHOR"
194 .PP
195 \fBYing\-Chun Liu\fR
196 .RS 4
197 Author.
198 .RE
199 .SH "COPYRIGHT"
200 .br
201 Copyright \(co 2008 paulliu
202 .br