3c68bced361f48e5c4c040b472e9495f065b41a7
[lxde/lxpanel.git] / man / lxpanel.sgml
1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3 <!-- Process this file with docbook-to-man to generate an nroff manual
4      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
5      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6      less'.  A typical entry in a Makefile or Makefile.am is:
7
8 manpage.1: manpage.sgml
9         docbook-to-man $< > $@
10
11     
12         The docbook-to-man binary is found in the docbook-to-man package.
13         Please remember that if you create the nroff version in one of the
14         debian/rules file targets (such as build), you will need to include
15         docbook-to-man in your Build-Depends control field.
16
17   -->
18
19   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
20   <!ENTITY dhfirstname "<firstname>Ying-Chun</firstname>">
21   <!ENTITY dhsurname   "<surname>Liu</surname>">
22   <!-- Please adjust the date whenever revising the manpage. -->
23   <!ENTITY dhdate      "<date>March  2, 2008</date>">
24   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
25        allowed: see man(7), man(1). -->
26   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
27   <!ENTITY dhemail     "<email>grandpaul@gmail.com</email>">
28   <!ENTITY dhusername  "paulliu">
29   <!ENTITY dhucpackage "<refentrytitle>LXPANEL</refentrytitle>">
30   <!ENTITY dhpackage   "lxpanel">
31
32   <!ENTITY debian      "<productname>Debian</productname>">
33   <!ENTITY gnu         "<acronym>GNU</acronym>">
34   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
35 ]>
36
37 <refentry>
38   <refentryinfo>
39     <address>
40       &dhemail;
41     </address>
42     <author>
43       &dhfirstname;
44       &dhsurname;
45     </author>
46     <copyright>
47       <year>2008</year>
48       <holder>&dhusername;</holder>
49     </copyright>
50     &dhdate;
51   </refentryinfo>
52   <refmeta>
53     &dhucpackage;
54
55     &dhsection;
56   </refmeta>
57   <refnamediv>
58     <refname>&dhpackage;</refname>
59
60     <refpurpose>a lightweight GTK2-based panel for LXDE desk-
61        top.</refpurpose>
62   </refnamediv>
63   <refsynopsisdiv>
64     <cmdsynopsis>
65       <command>&dhpackage;</command>
66     </cmdsynopsis>
67   </refsynopsisdiv>
68   <refsect1>
69     <title>DESCRIPTION</title>
70
71     <para>This manual page documents briefly the
72       <command>&dhpackage;</command> command.</para>
73
74     <para><command>&dhpackage;</command> is a program that provides a panel
75     for desktop, usually for LXDE. It is lightweight GTK+ 2.x based desktop 
76     panel.
77     </para>
78    
79     <para>
80     <itemizedlist spacing='normal' mark='bullet'>
81     <title>Features</title>
82     <listitem><para>User-friendly application menu automatically generated from <filename>.desktop</filename>
83     files on the system.
84     </para></listitem>
85     <listitem><para>Launcher bar (small icons clicked to launch apps)</para></listitem>
86     <listitem><para>Task bar supporting urgency hint (can be flash when gaim gets new
87     incoming messages)</para></listitem>
88     <listitem><para>Notification area (system tray)</para></listitem>
89     <listitem><para>Digital clock</para></listitem>
90     <listitem><para>Run dialog (a dialog let you type a command and run, can be called
91     in external programs)</para></listitem>
92     <listitem><para>Net status icon plug-in (optional)</para></listitem>
93     <listitem><para>Volume control plug-in (optional)</para></listitem>
94     <listitem><para>lxpanelctl, an external controller let you control lxpanel in
95     other programs. For example, "lxpanelctl run" will show the Run
96     dialog in lxpanel, and "lxpanelctl menu" will show the application
97     menu. This is useful in key bindings provided by window managers.</para>
98     </listitem>
99     </itemizedlist>
100     </para>
101   </refsect1>
102   <refsect1>
103     <title>FILES</title>
104     <variablelist>
105      <varlistentry>
106        <term><filename>~/.config/lxpanel</filename></term>
107        <listitem>
108          <para>config file, can be edited by preference dialog.</para>
109        </listitem>
110       </varlistentry>
111     </variablelist>
112   </refsect1>
113   <refsect1>
114     <title>SEE ALSO</title>
115
116     <para>lxsession (1).</para>
117
118   </refsect1>
119   <refsect1>
120     <title>AUTHOR</title>
121
122     <para>This manual page was written by &dhusername; &dhemail; for
123       the &debian; system (but may be used by others).  Permission is
124       granted to copy, distribute and/or modify this document under
125       the terms of the &gnu; General Public License, Version 2 any 
126           later version published by the Free Software Foundation.
127     </para>
128         <para>
129           On Debian systems, the complete text of the GNU General Public
130           License can be found in /usr/share/common-licenses/GPL.
131         </para>
132
133   </refsect1>
134 </refentry>
135
136 <!-- Keep this comment at the end of the file
137 Local variables:
138 mode: sgml
139 sgml-omittag:t
140 sgml-shorttag:t
141 sgml-minimize-attributes:nil
142 sgml-always-quote-attributes:t
143 sgml-indent-step:2
144 sgml-indent-data:t
145 sgml-parent-document:nil
146 sgml-default-dtd-file:nil
147 sgml-exposed-tags:nil
148 sgml-local-catalogs:nil
149 sgml-local-ecat-files:nil
150 End:
151 -->
152
153