Adding upstream version 0.9.0.
[debian/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" "February, 2016" "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 [ options ]
36 .SH "DESCRIPTION"
37 .PP
38 This manual page documents briefly the
39 \fBlxpanel\fR
40 command\&.
41 .PP
42 \fBlxpanel\fR
43 is a program that provides a panel for the desktop, usually for LXDE\&. It is a lightweight GTK+ 2\&.x based desktop panel\&.
44 .PP
45 .PP
46 \fBFeatures\fR
47 .sp
48 .RS 4
49 .ie n \{\
50 \h'-04'\(bu\h'+03'\c
51 .\}
52 .el \{\
53 .sp -1
54 .IP \(bu 2.3
55 .\}
56 User\-friendly application menu automatically generated from
57 \&.desktop
58 files on the system\&.
59 .RE
60 .sp
61 .RS 4
62 .ie n \{\
63 \h'-04'\(bu\h'+03'\c
64 .\}
65 .el \{\
66 .sp -1
67 .IP \(bu 2.3
68 .\}
69 Launcher bar (small icons clicked to launch apps)
70 .RE
71 .sp
72 .RS 4
73 .ie n \{\
74 \h'-04'\(bu\h'+03'\c
75 .\}
76 .el \{\
77 .sp -1
78 .IP \(bu 2.3
79 .\}
80 Task bar supporting ICCCM/EWMH `urgency\*(Aq hint (Pidgin IM windows can flash on new incoming messages)
81 .RE
82 .sp
83 .RS 4
84 .ie n \{\
85 \h'-04'\(bu\h'+03'\c
86 .\}
87 .el \{\
88 .sp -1
89 .IP \(bu 2.3
90 .\}
91 Notification area (system tray)
92 .RE
93 .sp
94 .RS 4
95 .ie n \{\
96 \h'-04'\(bu\h'+03'\c
97 .\}
98 .el \{\
99 .sp -1
100 .IP \(bu 2.3
101 .\}
102 Digital clock
103 .RE
104 .sp
105 .RS 4
106 .ie n \{\
107 \h'-04'\(bu\h'+03'\c
108 .\}
109 .el \{\
110 .sp -1
111 .IP \(bu 2.3
112 .\}
113 Run dialog (type command to run, without opening a terminal )
114 .RE
115 .sp
116 .RS 4
117 .ie n \{\
118 \h'-04'\(bu\h'+03'\c
119 .\}
120 .el \{\
121 .sp -1
122 .IP \(bu 2.3
123 .\}
124 Net status icon plug\-in (optional)
125 .RE
126 .sp
127 .RS 4
128 .ie n \{\
129 \h'-04'\(bu\h'+03'\c
130 .\}
131 .el \{\
132 .sp -1
133 .IP \(bu 2.3
134 .\}
135 Volume control plug\-in (optional)
136 .RE
137 .sp
138 .RS 4
139 .ie n \{\
140 \h'-04'\(bu\h'+03'\c
141 .\}
142 .el \{\
143 .sp -1
144 .IP \(bu 2.3
145 .\}
146 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\&.
147 .RE
148 .sp
149 .SH "OPTIONS"
150 .PP
151 This program follows the usual
152 GNU
153 command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&.
154 .PP
155 \fB\-h\fR \fB\-\-help\fR
156 .RS 4
157 Print help on the options\&.
158 .RE
159 .PP
160 \fB\-v\fR \fB\-\-version\fR
161 .RS 4
162 Print the program version\&.
163 .RE
164 .PP
165 \fB\-p \fR\fB\fINAME\fR\fR, \fB\-\-profile \fR\fB\fINAME\fR\fR
166 .RS 4
167 Set the profile to be loaded\&.
168 .RE
169 .SH "FILES"
170 .PP
171 ~/\&.config/lxpanel/\fIPROFILE\fR/
172 .RS 4
173 config files directory, can be edited by preference dialog\&.
174 .RE
175 .PP
176 ~/\&.config/lxpanel/\fIPROFILE\fR/gtkrc
177 .RS 4
178 optional GTK+ 2.0 RC file to alterate appearance, can be used to create custom panel style\&.
179 .RE
180 .SH "SEE ALSO"
181 .BR lxpanelctl (1)
182 .SH "AUTHOR"
183 .PP
184 The \fBlxpanel\fR is written by great LXDE developers team under lead of
185 Hong Jen Yee (PCMan) since 2006.
186 .PP
187 This manual page was written by paulliu (\fBYing\-Chun Liu\fR)
188 <grandpaul@gmail\&.com> for the Debian system (but may be used by others)\&.
189 Permission is granted to copy, distribute and/or modify this document under the terms of the
190 GNU 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-2\&.
193 .PP
194 Updated by Andriy Grytsenko (LStranger)\&.
195 .SH "COPYRIGHT"
196 .br
197 Copyright \(co 2008 paulliu
198 .br
199 Copyright \(co 2016 LStranger
200 .br