Mercurial > projects > xinhibit-applet

comparison data/xinhibit-applet.1.xml @ 5:1508a4c35c47

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rewrite the man page in DocBook 5 XML
author Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
date Thu, 08 Aug 2013 16:17:03 +0200
parents
children
comparison
equal deleted inserted replaced
4:54ecfe6a14cf 5:1508a4c35c47
1 <?xml version="1.0"?>
2 <!--
3
4 Copyright (C) 2013 Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
5
6 Permission is hereby granted, free of charge, to any person obtaining
7 a copy of this software and associated documentation files (the
8 "Software"), to deal in the Software without restriction, including
9 without limitation the rights to use, copy, modify, merge, publish,
10 distribute, sublicense, and/or sell copies of the Software, and to
11 permit persons to whom the Software is furnished to do so, subject to
12 the following conditions:
13
14 The above copyright notice and this permission notice shall be included
15 in all copies or substantial portions of the Software.
16
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24
25 -->
26 <refentry xmlns="http://docbook.org/ns/docbook" xml:lang="en">
27 <info>
28 <author>
29 <personname>
30 <firstname>Guido</firstname>
31 <surname>Berhoerster</surname>
32 </personname>
33 <email>guido+xinhibit-applet@berhoerster.name</email>
34 <personblurb/>
35 </author>
36 <date>30 April, 2013</date>
37 </info>
38 <refmeta>
39 <refentrytitle>xinhibit-applet</refentrytitle>
40 <manvolnum>1</manvolnum>
41 <refmiscinfo class="source"/>
42 <refmiscinfo class="version"/>
43 <refmiscinfo class="manual">User Commands</refmiscinfo>
44 </refmeta>
45 <refnamediv>
46 <refname>xinhibit-applet</refname>
47 <refpurpose>inhibit automatic power management</refpurpose>
48 </refnamediv>
49 <refsynopsisdiv>
50 <cmdsynopsis>
51 <command>xinhibit-applet</command>
52 <arg choice="opt">
53 <option>-d</option>
54 </arg>
55 <arg choice="opt">
56 <option>-h</option>
57 </arg>
58 <arg choice="opt">
59 <option>-V</option>
60 </arg>
61 <arg choice="opt">
62 <option>-?</option>
63 </arg>
64 <arg choice="opt">
65 <option>--debug</option>
66 </arg>
67 <arg choice="opt">
68 <option>--help</option>
69 </arg>
70 <arg choice="opt">
71 <option>--version</option>
72 </arg>
73 </cmdsynopsis>
74 </refsynopsisdiv>
75 <refsect1>
76 <title>Description</title>
77 <para><command>xinhibit-applet</command> provides an icon in the tray area
78 of the panel which allows to inhibit automatic power management of power
79 managers and screensavers.</para>
80 </refsect1>
81 <refsect1>
82 <title>Options</title>
83 <para>The following options are supported:</para>
84 <variablelist>
85 <varlistentry>
86 <term>
87 <option>-h</option>
88 </term>
89 <term>
90 <option>-?</option>
91 </term>
92 <term>
93 <option>--help</option>
94 </term>
95 <listitem>
96 <para>Print a summary of all command line options and exit.</para>
97 </listitem>
98 </varlistentry>
99 <varlistentry>
100 <term>
101 <option>-d</option>
102 </term>
103 <term>
104 <option>--debug</option>
105 </term>
106 <listitem>
107 <para>Enable debugging output.</para>
108 </listitem>
109 </varlistentry>
110 <varlistentry>
111 <term>
112 <option>-V</option>
113 </term>
114 <term>
115 <option>--version</option>
116 </term>
117 <listitem>
118 <para>Print the version number and exit.</para>
119 </listitem>
120 </varlistentry>
121 </variablelist>
122 </refsect1>
123 <refsect1>
124 <title>Exit Status</title>
125 <para>The following exit values are returned:</para>
126 <variablelist>
127 <varlistentry>
128 <term>0</term>
129 <listitem>
130 <para>Command successfully executed.</para>
131 </listitem>
132 </varlistentry>
133 <varlistentry>
134 <term>1</term>
135 <listitem>
136 <para>An error has occured.</para>
137 </listitem>
138 </varlistentry>
139 </variablelist>
140 </refsect1>
141 </refentry>