d28ecea6ccb45deb2636ee9a56f6e526ebec2c52
[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 desktop.</refpurpose>
61   </refnamediv>
62   <refsynopsisdiv>
63     <cmdsynopsis>
64       <command>&dhpackage;</command>
65     </cmdsynopsis>
66   </refsynopsisdiv>
67   <refsect1>
68     <title>DESCRIPTION</title>
69
70     <para>This manual page documents briefly the
71       <command>&dhpackage;</command> command.</para>
72
73     <para><command>&dhpackage;</command> is a program that provides a panel
74     for desktop, usually for LXDE. It is lightweight GTK+ 2.x based desktop 
75     panel.
76     </para>
77    
78     <para>
79     <itemizedlist spacing='normal' mark='bullet'>
80         <title>Features</title>
81         <listitem><para>User-friendly application menu automatically generated from <filename>.desktop</filename>
82                 files on the system.
83                 </para>
84         </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>
88         </listitem>
89         <listitem><para>Notification area (system tray)</para></listitem>
90         <listitem><para>Digital clock</para></listitem>
91         <listitem><para>Run dialog (a dialog let you type a command and run, can be called
92                 in external programs)</para>
93         </listitem>
94         <listitem><para>Net status icon plug-in (optional)</para></listitem>
95         <listitem><para>Volume control plug-in (optional)</para></listitem>
96         <listitem><para>lxpanelctl, an external controller let you control lxpanel in
97                 other programs. For example, "lxpanelctl run" will show the Run
98                 dialog in lxpanel, and "lxpanelctl menu" will show the application
99                 menu. This is useful in key bindings provided by window managers.</para>
100         </listitem>
101     </itemizedlist>
102     </para>
103   </refsect1>
104   <refsect1>
105     <title>FILES</title>
106     <variablelist>
107      <varlistentry>
108        <term><filename>~/.config/lxpanel</filename></term>
109        <listitem>
110          <para>config file, can be edited by preference dialog.</para>
111        </listitem>
112       </varlistentry>
113     </variablelist>
114   </refsect1>
115   <refsect1>
116     <title>SEE ALSO</title>
117
118     <para>lxsession (1), lxpanelctl (1).</para>
119
120   </refsect1>
121   <refsect1>
122     <title>AUTHOR</title>
123
124     <para>This manual page was written by &dhusername; &dhemail; for
125       the &debian; system (but may be used by others).  Permission is
126       granted to copy, distribute and/or modify this document under
127       the terms of the &gnu; General Public License, Version 2 any 
128       later version published by the Free Software Foundation.
129     </para>
130     <para>
131           On Debian systems, the complete text of the GNU General Public
132           License can be found in /usr/share/common-licenses/GPL.
133     </para>
134
135   </refsect1>
136 </refentry>
137
138 <!-- Keep this comment at the end of the file
139 Local variables:
140 mode: sgml
141 sgml-omittag:t
142 sgml-shorttag:t
143 sgml-minimize-attributes:nil
144 sgml-always-quote-attributes:t
145 sgml-indent-step:2
146 sgml-indent-data:t
147 sgml-parent-document:nil
148 sgml-default-dtd-file:nil
149 sgml-exposed-tags:nil
150 sgml-local-catalogs:nil
151 sgml-local-ecat-files:nil
152 End:
153 -->