Ship man pages in the GIT and tarball, not just xml files.
[lxde/lxpanel.git] / man / lxpanel.xml
1 <?xml version="1.0"?>
2 <refentry
3 > <refentryinfo
4 > <address
5 > <email
6 >grandpaul@gmail.com</email>
7 </address>
8 <author
9 > <firstname
10 >Ying-Chun</firstname>
11 <surname
12 >Liu</surname>
13 </author>
14 <copyright
15 > <year
16 >2008</year>
17 <holder
18 >paulliu</holder>
19 </copyright>
20 <date
21 >March 2, 2008</date>
22 </refentryinfo>
23 <refmeta
24 > <refentrytitle
25 >LXPANEL</refentrytitle>
26 <refmiscinfo class="source">http://LXDE.org</refmiscinfo>
27
28 <manvolnum
29 >1</manvolnum>
30 </refmeta>
31 <refnamediv
32 > <refname
33 >lxpanel</refname>
34
35 <refpurpose
36 >a lightweight GTK2-based panel for the LXDE desktop.</refpurpose>
37 </refnamediv>
38 <refsynopsisdiv
39 > <cmdsynopsis
40 > <command
41 >lxpanel</command>
42 </cmdsynopsis>
43 </refsynopsisdiv>
44 <refsect1
45 > <title
46 >DESCRIPTION</title>
47
48 <para
49 >This manual page documents briefly the
50 <command
51 >lxpanel</command> command.</para>
52
53 <para
54 ><command
55 >lxpanel</command> is a program that provides a panel
56 for the desktop, usually for LXDE. It is a lightweight GTK+ 2.x based desktop
57 panel.
58 </para>
59
60 <para
61 > <itemizedlist
62 spacing="normal"
63 mark="bullet"
64 > <title
65 >Features</title>
66 <listitem
67 ><para
68 >User-friendly application menu automatically generated from <filename
69 >.desktop</filename>
70 files on the system.
71 </para>
72 </listitem>
73 <listitem
74 ><para
75 >Launcher bar (small icons clicked to launch apps)</para></listitem>
76 <listitem
77 ><para
78 >Task bar supporting ICCCM/EWMH `urgency' hint (Pidgin IM windows
79 can flash on new incoming messages)</para>
80 </listitem>
81 <listitem
82 ><para
83 >Notification area (system tray)</para></listitem>
84 <listitem
85 ><para
86 >Digital clock</para></listitem>
87 <listitem
88 ><para
89 >Run dialog (type command to run, without opening a terminal
90 )</para>
91 </listitem>
92 <listitem
93 ><para
94 >Net status icon plug-in (optional)</para></listitem>
95 <listitem
96 ><para
97 >Volume control plug-in (optional)</para></listitem>
98 <listitem
99 ><para
100 >lxpanelctl, an external controller lets you control lxpanel in
101 other programs. For example, "lxpanelctl run" will show the Run
102 dialog in lxpanel, and "lxpanelctl menu" will show the application
103 menu. This is useful in key bindings provided by window managers.</para>
104 </listitem>
105 </itemizedlist>
106 </para>
107 </refsect1>
108 <refsect1> <title>OPTIONS</title>
109
110 <para>This program follows the usual <acronym>GNU</acronym> command line syntax,
111 with long options starting with two dashes (`-'). A summary of
112 options is included below.
113 </para>
114
115 <variablelist>
116 <varlistentry> <term> <option>-h</option>
117 <option>--help</option>
118 </term>
119 <listitem> <para>Print help on the options.</para>
120 </listitem>
121 </varlistentry>
122 <varlistentry> <term> <option>-v</option>
123 <option>--version</option>
124 </term>
125 <listitem> <para>Print the program version.</para>
126 </listitem>
127 </varlistentry>
128 <varlistentry> <term>
129 <option>--log <replaceable>level</replaceable></option>
130 </term>
131 <listitem> <para>Set the logging level in the range 0 (silent) through 5 (verbose). </para>
132 </listitem>
133 </varlistentry>
134 <varlistentry> <term><option>-p <replaceable>NAME</replaceable></option></term>
135 <term> <option>--profile <replaceable>NAME</replaceable></option>
136 </term>
137 <listitem> <para>Set the profile to be loaded.</para>
138 </listitem>
139 </varlistentry>
140 </variablelist>
141 </refsect1>
142 <refsect1
143 > <title
144 >FILES</title>
145 <variablelist
146 > <varlistentry
147 > <term
148 ><filename
149 >~/.config/lxpanel/<replaceable>PROFILE</replaceable></filename></term>
150 <listitem
151 > <para
152 >config file, can be edited by preference dialog.</para>
153 </listitem>
154 </varlistentry>
155 </variablelist>
156 </refsect1>
157
158 <refsect1
159 > <title
160 >SEE ALSO</title>
161
162 <para
163 >lxsession (1), lxpanelctl (1).</para>
164
165 </refsect1>
166 <refsect1
167 > <title
168 >AUTHOR</title>
169
170 <para
171 >This manual page was written by paulliu <email
172 >grandpaul@gmail.com</email> for
173 the <productname
174 >Debian</productname> system (but may be used by others). Permission is
175 granted to copy, distribute and/or modify this document under
176 the terms of the <acronym
177 >GNU</acronym> General Public License, Version 2 any
178 later version published by the Free Software Foundation.
179 </para>
180 <para
181 > On Debian systems, the complete text of the GNU General Public
182 License can be found in /usr/share/common-licenses/GPL.
183 </para>
184
185 </refsect1></refentry>