f38be070f0815fd96792d48d38d922b597cc85dd
[lxde/lxsession.git] / man / lxsession-logout.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>LXSESSION</refentrytitle>">
30   <!ENTITY dhpackage   "lxsession-logout">
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>program to logout from LXSession</refpurpose>
61   </refnamediv>
62   <refsynopsisdiv>
63     <cmdsynopsis>
64       <command>&dhpackage;</command>
65       <arg rep='repeat'><option>options</option></arg>
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 to logout 
75         from LXSession. It gives a good-looking logout dialog.
76     </para>
77    
78   </refsect1>
79
80   <refsect1>
81     <title>OPTIONS</title>
82
83     <para>These programs follow the usual &gnu; command line syntax,
84       with long options starting with two dashes (`-').  A summary of
85       options is included below.  
86     </para>
87
88     <variablelist>
89       <varlistentry>
90         <term>
91           <option>--prompt <replaceable>Your custom message</replaceable></option>
92         </term>
93         <listitem>
94           <para>Customize the logout message.</para>
95         </listitem>
96       </varlistentry>
97       <varlistentry>
98         <term>
99           <option>--banner <replaceable>Your logo</replaceable></option>
100         </term>
101         <listitem>
102           <para>Customize the logout logo.</para>
103         </listitem>
104       </varlistentry>
105       <varlistentry>
106         <term>
107           <option>--side left|top|right|bottom</option>
108         </term>
109         <listitem>
110           <para>The position of the logo.</para>
111         </listitem>
112       </varlistentry>
113     </variablelist>
114   </refsect1>
115
116
117   <refsect1>
118     <title>SEE ALSO</title>
119
120     <para>lxsession (1).</para>
121
122   </refsect1>
123   <refsect1>
124     <title>AUTHOR</title>
125
126     <para>This manual page was written by &dhusername; &dhemail; for
127       the &debian; system (but may be used by others).  Permission is
128       granted to copy, distribute and/or modify this document under
129       the terms of the &gnu; General Public License, Version 2 any 
130       later version published by the Free Software Foundation.
131     </para>
132     <para>
133           On Debian systems, the complete text of the GNU General Public
134           License can be found in /usr/share/common-licenses/GPL.
135     </para>
136
137   </refsect1>
138 </refentry>
139
140 <!-- Keep this comment at the end of the file
141 Local variables:
142 mode: sgml
143 sgml-omittag:t
144 sgml-shorttag:t
145 sgml-minimize-attributes:nil
146 sgml-always-quote-attributes:t
147 sgml-indent-step:2
148 sgml-indent-data:t
149 sgml-parent-document:nil
150 sgml-default-dtd-file:nil
151 sgml-exposed-tags:nil
152 sgml-local-catalogs:nil
153 sgml-local-ecat-files:nil
154 End:
155 -->